net.sf.saxon.event
Class HTMLIndenter

java.lang.Object
  extended by net.sf.saxon.event.ProxyReceiver
      extended by net.sf.saxon.event.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 four spaces, but may be set using the indent-chars property Author Michael Kay (michael.h.kay@ntlworld.com)


Field Summary
 
Fields inherited from class net.sf.saxon.event.ProxyReceiver
baseReceiver, namePool, systemId
 
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
 
Constructor Summary
HTMLIndenter()
           
 
Method Summary
 void characters(CharSequence chars, int properties)
          Output character data
 void comment(CharSequence chars, int properties)
          Output a comment
 void endElement()
          Output element end tag
 void setOutputProperties(Properties props)
          Set the properties for this indenter
 void startElement(int nameCode, int typeCode, int properties)
          Output element start tag
 
Methods inherited from class net.sf.saxon.event.ProxyReceiver
attribute, endDocument, getNamePool, getSystemId, getUnderlyingReceiver, namespace, processingInstruction, setDocumentLocator, setNamePool, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTMLIndenter

public HTMLIndenter()
Method Detail

setOutputProperties

public void setOutputProperties(Properties props)
Set the properties for this indenter


startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws TransformerException
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.
Throws:
TransformerException

endElement

public void endElement()
                throws TransformerException
Output element end tag

Specified by:
endElement in interface Receiver
Overrides:
endElement in class ProxyReceiver
Throws:
TransformerException

characters

public void characters(CharSequence chars,
                       int properties)
                throws TransformerException
Output character data

Specified by:
characters in interface Receiver
Overrides:
characters in class ProxyReceiver
Parameters:
chars - The characters
properties - Bit significant value. The following bits are defined:
DISABLE_ESCAPING
Disable escaping for this text node
USE_CDATA
Output as a CDATA section
NO_SPECIAL_CHARACTERS
Value contains no special characters
WHITESPACE
Text is all whitespace
Throws:
TransformerException

comment

public void comment(CharSequence chars,
                    int properties)
             throws TransformerException
Output a comment

Specified by:
comment in interface Receiver
Overrides:
comment in class ProxyReceiver
Parameters:
chars - The content of the comment
properties - Additional information about the comment. The following bits are defined:
CHECKED
Comment is known to be legal (e.g. doesn't contain "--")
Throws:
TransformerException