Class HTMLIndenter

All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
HTMLIndenterPE

public class HTMLIndenter extends ProxyReceiver
HTMLIndenter: This ProxyReceiver indents HTML elements, by adding whitespace character data where appropriate. The character data is never added when within an inline element. The string used for indentation defaults to three spaces
  • Field Details

    • indentChars

      protected char[] indentChars
  • Constructor Details

  • Method Details

    • setOutputProperties

      public void setOutputProperties(Properties props)
      Set the properties for this indenter
      Parameters:
      props - the serialization properties
    • classifyTag

      public int classifyTag(NodeName name)
      Classify an element name as inline, formatted, or both or neither. This method is overridden in the XHTML indenter
      Parameters:
      name - the element name
      Returns:
      a bit-significant integer containing flags IS_INLINE and/or IS_FORMATTED
    • startElement

      public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
      Output element start tag
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyReceiver
      Parameters:
      elemName - the name of the element.
      type - the type annotation of the element.
      attributes - the attributes of this element
      namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
      location - an object providing information about the module, line, and column where the node originated
      properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs
    • endElement

      public void endElement() throws XPathException
      Output element end tag
      Specified by:
      endElement in interface Receiver
      Overrides:
      endElement in class ProxyReceiver
      Throws:
      XPathException - if an error occurs
    • characters

      public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException
      Output character data
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyReceiver
      Parameters:
      chars - The characters
      locationId - provides information such as line number and system ID.
      properties - Bit significant value. The following bits are defined:
      DISABLE_ESCAPING
      Disable escaping for this text node
      USE_CDATA
      Output as a CDATA section
      Throws:
      XPathException - if an error occurs
    • processingInstruction

      public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException
      Output a processing instruction
      Specified by:
      processingInstruction in interface Receiver
      Overrides:
      processingInstruction in class ProxyReceiver
      Parameters:
      target - The PI name. This must be a legal name (it will not be checked).
      data - The data portion of the processing instruction
      locationId - provides information such as line number and system ID.
      properties - Additional information about the PI.
      Throws:
      XPathException - if an error occurs
    • comment

      public void comment(UnicodeString chars, Location locationId, int properties) throws XPathException
      Output a comment
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyReceiver
      Parameters:
      chars - The content of the comment
      locationId - provides information such as line number and system ID.
      properties - Additional information about the comment.
      Throws:
      XPathException - if an error occurs
    • getLineLength

      protected int getLineLength()
      Get the maximum length of lines, after which long lines will be word-wrapped
      Returns:
      the maximum line length
    • getIndentation

      protected int getIndentation()
      Get the number of spaces to be used for indentation
      Returns:
      the number of spaces to be added to the indentation for each level