Package net.sf.saxon.event
Class HTMLIndenter
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.event.HTMLIndenter
- Direct Known Subclasses:
XHTMLIndenter
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, but may be set using the
indent-chars property
- Author:
- Michael Kay
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static String[]
protected static String[]
protected static final int
protected static final int
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(CharSequence chars, int locationId, int properties) Output character dataprotected int
classifyTag
(int nameCode) Classify an element name as inline, formatted, or both or neither.void
comment
(CharSequence chars, int locationId, int properties) Output a commentvoid
Output element end tagvoid
setOutputProperties
(Properties props) Set the properties for this indentervoid
startElement
(int nameCode, int typeCode, int locationId, int properties) Output element start tagMethods inherited from class net.sf.saxon.event.ProxyReceiver
attribute, close, endDocument, getConfiguration, getDocumentLocator, getNamePool, getUnderlyingReceiver, namespace, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, getPipelineConfiguration, getSystemId
-
Field Details
-
inlineTags
-
IS_INLINE
protected static final int IS_INLINE- See Also:
-
IS_FORMATTED
protected static final int IS_FORMATTED- See Also:
-
formattedTags
-
-
Constructor Details
-
HTMLIndenter
public HTMLIndenter()
-
-
Method Details
-
classifyTag
protected int classifyTag(int nameCode) Classify an element name as inline, formatted, or both or neither. This method is overridden in the XHTML indenter- Parameters:
nameCode
- the element name- Returns:
- a bit-significant integer containing flags IS_INLINE and/or IS_FORMATTED
-
setOutputProperties
Set the properties for this indenter -
startElement
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException Output element start tag- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- 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 aLocationProvider
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
-
endElement
Output element end tag- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classProxyReceiver
- Throws:
XPathException
-
characters
Output character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
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
- NO_SPECIAL_CHARACTERS
- Value contains no special characters
- WHITESPACE
- Text is all whitespace
- Throws:
XPathException
-
comment
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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. The following bits are defined:- CHECKED
- Comment is known to be legal (e.g. doesn't contain "--")
- Throws:
XPathException
-