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
-
- All Implemented Interfaces:
javax.xml.transform.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 Summary
Fields Modifier and Type Field Description protected char[]indentChars-
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description HTMLIndenter(Receiver next, java.lang.String method)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Output character dataintclassifyTag(NodeName name)Classify an element name as inline, formatted, or both or neither.voidcomment(java.lang.CharSequence chars, Location locationId, int properties)Output a commentvoidendElement()Output element end tagprotected intgetIndentation()Get the number of spaces to be used for indentationprotected intgetLineLength()Get the maximum length of lines, after which long lines will be word-wrappedvoidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Output a processing instructionvoidsetOutputProperties(java.util.Properties props)Set the properties for this indentervoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Output element start tag-
Methods 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
-
-
-
-
Constructor Detail
-
HTMLIndenter
public HTMLIndenter(Receiver next, java.lang.String method)
-
-
Method Detail
-
setOutputProperties
public void setOutputProperties(java.util.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:
startElementin interfaceReceiver- Overrides:
startElementin 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
public void endElement() throws XPathExceptionOutput element end tag- Specified by:
endElementin interfaceReceiver- Overrides:
endElementin classProxyReceiver- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionOutput character data- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin 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(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionOutput a processing instruction- Specified by:
processingInstructionin interfaceReceiver- Overrides:
processingInstructionin 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
public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionOutput a comment- Specified by:
commentin interfaceReceiver- Overrides:
commentin 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
-
-