java.lang.Object | ||
↳ | org.apache.xml.serialize.BaseMarkupSerializer | |
↳ | org.apache.xml.serialize.HTMLSerializer |
Known Direct Subclasses |
This class is deprecated.
This class was deprecated in Xerces 2.6.2. It is
recommended that new applications use JAXP's Transformation API
for XML (TrAX) for serializing HTML. See the Xerces documentation
for more information.
Implements an HTML/XHTML serializer supporting both DOM and SAX
pretty serializing. HTML/XHTML mode is determined in the
constructor. For usage instructions see Serializer
.
If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.
The serializer supports both DOM and SAX. DOM serializing is done
by calling serialize(Document)
and SAX serializing is done by firing
SAX events and using the serializer as a document handler.
If an I/O exception occurs while serializing, the serializer
will not throw an exception directly, but only throw it
at the end of serializing (either DOM or SAX's endDocument()
.
For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.
XHTML is slightly different than HTML:
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | XHTMLNamespace |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xml.serialize.BaseMarkupSerializer
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new serializer.
| |||||||||||
Constructs a new serializer.
| |||||||||||
Constructs a new serializer that writes to the specified writer
using the specified output format.
| |||||||||||
Constructs a new serializer that writes to the specified output
stream using the specified output format.
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new HTML/XHTML serializer depending on the value of
xhtml.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Specifies an output format for this serializer.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Called to print the text contents in the prevailing element format.
| |||||||||||
Returns the suitable entity reference for this character value,
or null if no such entity exists.
| |||||||||||
Called to serialize a DOM element.
| |||||||||||
Called to serialize the document's DOCTYPE by the root element.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xml.serialize.BaseMarkupSerializer
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.apache.xml.serialize.DOMSerializer
| |||||||||||
From interface
org.apache.xml.serialize.Serializer
| |||||||||||
From interface
org.xml.sax.ContentHandler
| |||||||||||
From interface
org.xml.sax.DTDHandler
| |||||||||||
From interface
org.xml.sax.DocumentHandler
| |||||||||||
From interface
org.xml.sax.ext.DeclHandler
| |||||||||||
From interface
org.xml.sax.ext.LexicalHandler
|
Constructs a new serializer. The serializer cannot be used without
calling setOutputCharStream(Writer)
or setOutputByteStream(OutputStream)
first.
Constructs a new serializer. The serializer cannot be used without
calling setOutputCharStream(Writer)
or setOutputByteStream(OutputStream)
first.
Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.
writer | The writer to use |
---|---|
format | The output format to use, null for the default |
Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.
output | The output stream to use |
---|---|
format | The output format to use, null for the default |
Constructs a new HTML/XHTML serializer depending on the value of
xhtml. The serializer cannot be used without calling
setOutputCharStream(Writer)
or setOutputByteStream(OutputStream)
first.
xhtml | True if XHTML serializing |
---|
SAXException |
---|
Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.
format | The output format to use |
---|
SAXException |
---|
Called to print the text contents in the prevailing element format. Since this method is capable of printing text as CDATA, it is used for that purpose as well. White space handling is determined by the current element state. In addition, the output format can dictate whether the text is printed as CDATA or unescaped.
text | The text to print |
---|
IOException |
---|
Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".
ch | Character value |
---|
Called to serialize a DOM element. Equivalent to calling startElement(String, String, String, Attributes)
, endElement(String)
and serializing everything
inbetween, but better optimized.
elem | The element to serialize |
---|
IOException |
---|
Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.
This method will check if it has not been called before (_started
),
will serialize the document type declaration, and will serialize all
pre-root comments and PIs that were accumulated in the document
(see serializePreRoot()
). Pre-root will be serialized even if
this is not the first root element of the document.
IOException |
---|