org.apache.xml.serialize

Class HTMLSerializer

public class HTMLSerializer extends BaseMarkupSerializer

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 HTMLSerializer 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 org.xml.sax.DocumentHandler#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:

Version: $Revision: 1.28 $ $Date: 2004/09/06 22:57:13 $

Author: Assaf Arkin

See Also: Serializer

Field Summary
static StringXHTMLNamespace
Constructor Summary
protected HTMLSerializer(boolean xhtml, OutputFormat format)
Constructs a new HTML/XHTML serializer depending on the value of xhtml.
HTMLSerializer()
Constructs a new serializer.
HTMLSerializer(OutputFormat format)
Constructs a new serializer.
HTMLSerializer(Writer writer, OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format.
HTMLSerializer(OutputStream output, OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format.
Method Summary
voidcharacters(char[] chars, int start, int length)
protected voidcharacters(String text)
voidendElement(String namespaceURI, String localName, String rawName)
voidendElement(String tagName)
voidendElementIO(String namespaceURI, String localName, String rawName)
protected StringescapeURI(String uri)
protected StringgetEntityRef(int ch)
protected voidserializeElement(Element elem)
Called to serialize a DOM element.
voidsetOutputFormat(OutputFormat format)
voidsetXHTMLNamespace(String newNamespace)
protected voidstartDocument(String rootTagName)
Called to serialize the document's DOCTYPE by the root element.
voidstartElement(String namespaceURI, String localName, String rawName, Attributes attrs)
voidstartElement(String tagName, AttributeList attrs)

Field Detail

XHTMLNamespace

public static final String XHTMLNamespace

Constructor Detail

HTMLSerializer

protected HTMLSerializer(boolean xhtml, OutputFormat format)
Constructs a new HTML/XHTML serializer depending on the value of xhtml. The serializer cannot be used without calling HTMLSerializer or HTMLSerializer first.

Parameters: xhtml True if XHTML serializing

HTMLSerializer

public HTMLSerializer()
Constructs a new serializer. The serializer cannot be used without calling HTMLSerializer or HTMLSerializer first.

HTMLSerializer

public HTMLSerializer(OutputFormat format)
Constructs a new serializer. The serializer cannot be used without calling HTMLSerializer or HTMLSerializer first.

HTMLSerializer

public HTMLSerializer(Writer writer, OutputFormat format)
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.

Parameters: writer The writer to use format The output format to use, null for the default

HTMLSerializer

public HTMLSerializer(OutputStream output, OutputFormat format)
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.

Parameters: output The output stream to use format The output format to use, null for the default

Method Detail

characters

public void characters(char[] chars, int start, int length)

characters

protected void characters(String text)

endElement

public void endElement(String namespaceURI, String localName, String rawName)

endElement

public void endElement(String tagName)

endElementIO

public void endElementIO(String namespaceURI, String localName, String rawName)

escapeURI

protected String escapeURI(String uri)

getEntityRef

protected String getEntityRef(int ch)

serializeElement

protected void serializeElement(Element elem)
Called to serialize a DOM element. Equivalent to calling HTMLSerializer, HTMLSerializer and serializing everything inbetween, but better optimized.

setOutputFormat

public void setOutputFormat(OutputFormat format)

setXHTMLNamespace

public void setXHTMLNamespace(String newNamespace)

startDocument

protected void startDocument(String rootTagName)
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 (HTMLSerializer), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see HTMLSerializer). Pre-root will be serialized even if this is not the first root element of the document.

startElement

public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs)

startElement

public void startElement(String tagName, AttributeList attrs)
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.