Package net.sf.saxon.serialize
Class HTMLIndenter
java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.serialize.HTMLIndenter
- Direct Known Subclasses:
HTMLIndenterPE
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 Summary
FieldsFields 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
(UnicodeString chars, Location locationId, int properties) Output character dataint
classifyTag
(NodeName name) Classify an element name as inline, formatted, or both or neither.void
comment
(UnicodeString chars, Location locationId, int properties) Output a commentvoid
Output element end tagprotected int
Get the number of spaces to be used for indentationprotected int
Get the maximum length of lines, after which long lines will be word-wrappedvoid
processingInstruction
(String target, UnicodeString data, Location locationId, int properties) Output a processing instructionvoid
setOutputProperties
(Properties props) Set the properties for this indentervoid
startElement
(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Output element start tagMethods inherited from class net.sf.saxon.event.ProxyReceiver
append, close, endDocument, getNamePool, getNextReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument, usesTypeAnnotations
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend
-
Field Details
-
indentChars
protected char[] indentChars
-
-
Constructor Details
-
HTMLIndenter
-
-
Method Details
-
setOutputProperties
Set the properties for this indenter- Parameters:
props
- the serialization properties
-
classifyTag
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 interfaceReceiver
- Overrides:
startElement
in classProxyReceiver
- Parameters:
elemName
- the name of the element.type
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
endElement
Output element end tag- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classProxyReceiver
- 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 interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- 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 interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
comment
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- 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
-