Class HTMLIndenter

All Implemented Interfaces:
Result, Receiver

public class HTMLIndenter extends ProxyReceiver
HTMLIndenter: This ProxyEmitter 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
Author:
Michael Kay
  • Field Details

    • formattedTags

      static final String[] formattedTags
  • Constructor Details

  • Method Details

    • startElement

      public void startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
      Output element start tag
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyReceiver
      Parameters:
      nameCode - integer code identifying the name of the element within the name pool.
      typeCode - integer code identifying the element's type within the name pool.
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - properties of the element node
      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(CharSequence chars, int locationId, int properties) throws XPathException
      Output character data
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyReceiver
      Parameters:
      chars - The characters
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      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
    • comment

      public void comment(CharSequence chars, int 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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Additional information about the comment.
      Throws:
      XPathException - if an error occurs
    • 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
    • getLineLength

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