|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.serialize.BaseMarkupSerializer
org.jasig.portal.serialize.HTMLSerializer
public class HTMLSerializer
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 BaseMarkupSerializer.serialize(Element)
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 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:
Serializer
Field Summary | |
---|---|
private static boolean |
_xhtml
True if serializing in XHTML format. |
private java.lang.String |
anchorId
|
static java.lang.String |
XHTMLNamespace
|
Fields inherited from class org.jasig.portal.serialize.BaseMarkupSerializer |
---|
_docTypePublicId, _docTypeSystemId, _format, _indenting, _prefixes, _printer, _started |
Constructor Summary | |
---|---|
|
HTMLSerializer()
Constructs a new serializer. |
protected |
HTMLSerializer(boolean xhtml,
OutputFormat format)
Constructs a new HTML/XHTML serializer depending on the value of xhtml. |
|
HTMLSerializer(OutputFormat format)
Constructs a new serializer. |
|
HTMLSerializer(java.io.OutputStream output,
OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
HTMLSerializer(java.io.Writer writer,
OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
---|---|
protected java.lang.String |
appendAnchorIfNecessary(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String attributeValue)
|
void |
characters(char[] chars,
int start,
int length)
|
protected void |
characters(java.lang.String text)
Called to print the text contents in the prevailing element format. |
void |
endElement(java.lang.String tagName)
|
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
|
void |
endElementIO(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
|
protected java.lang.String |
escapeURI(java.lang.String uri)
|
protected java.lang.String |
getEntityRef(int ch)
Returns the suitable entity reference for this character value, or null if no such entity exists. |
protected void |
serializeElement(org.w3c.dom.Element elem)
Called to serialize a DOM element. |
void |
setOutputFormat(OutputFormat format)
Specifies an output format for this serializer. |
void |
startAnchoring(java.lang.String anchorId)
Signify that the serializer should begin to append the anchor ID to URLs of its choosing. |
protected void |
startDocument(java.lang.String rootTagName)
Called to serialize the document's DOCTYPE by the root element. |
void |
startElement(java.lang.String tagName,
org.xml.sax.AttributeList attrs)
|
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
org.xml.sax.Attributes attrs)
|
void |
stopAnchoring()
Signify that anchoring is no longer desired by the serializer. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static boolean _xhtml
public static java.lang.String XHTMLNamespace
private java.lang.String anchorId
Constructor Detail |
---|
protected HTMLSerializer(boolean xhtml, OutputFormat format)
xhtml
- True if XHTML serializingpublic HTMLSerializer()
BaseMarkupSerializer.setOutputCharStream(Writer)
or BaseMarkupSerializer.setOutputByteStream(OutputStream)
first.
public HTMLSerializer(OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(Writer)
or BaseMarkupSerializer.setOutputByteStream(OutputStream)
first.
public HTMLSerializer(java.io.Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic HTMLSerializer(java.io.OutputStream output, OutputFormat format)
output
- The output stream to useformat
- The output format to use, null for the defaultMethod Detail |
---|
public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
setOutputFormat
in class BaseMarkupSerializer
format
- The output format to usepublic void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void endElementIO(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws java.io.IOException
java.io.IOException
public void characters(char[] chars, int start, int length) throws org.xml.sax.SAXException
characters
in interface org.xml.sax.ContentHandler
characters
in interface org.xml.sax.DocumentHandler
characters
in class BaseMarkupSerializer
org.xml.sax.SAXException
public void startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs) throws org.xml.sax.SAXException
startElement
in interface org.xml.sax.DocumentHandler
org.xml.sax.SAXException
public void endElement(java.lang.String tagName) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.DocumentHandler
org.xml.sax.SAXException
protected void startDocument(java.lang.String rootTagName) throws java.io.IOException
This method will check if it has not been called before (BaseMarkupSerializer._started
),
will serialize the document type declaration, and will serialize all
pre-root comments and PIs that were accumulated in the document
(see BaseMarkupSerializer.serializePreRoot()
). Pre-root will be serialized even if
this is not the first root element of the document.
java.io.IOException
protected void serializeElement(org.w3c.dom.Element elem) throws java.io.IOException
startElement(String, String, String, Attributes)
, endElement(String, String, String)
and serializing everything
inbetween, but better optimized.
serializeElement
in class BaseMarkupSerializer
elem
- The element to serialize
java.io.IOException
- An I/O exception occured while
serializingprotected void characters(java.lang.String text) throws java.io.IOException
BaseMarkupSerializer
characters
in class BaseMarkupSerializer
text
- The text to print
java.io.IOException
- An I/O exception occured while serializingprotected java.lang.String getEntityRef(int ch)
BaseMarkupSerializer
getEntityRef
in class BaseMarkupSerializer
ch
- Character value
protected java.lang.String escapeURI(java.lang.String uri)
public void startAnchoring(java.lang.String anchorId)
IAnchoringSerializer
startAnchoring
in interface IAnchoringSerializer
startAnchoring
in class BaseMarkupSerializer
anchorId
- the anchor identifierpublic void stopAnchoring()
IAnchoringSerializer
stopAnchoring
in interface IAnchoringSerializer
stopAnchoring
in class BaseMarkupSerializer
protected java.lang.String appendAnchorIfNecessary(java.lang.String elementName, java.lang.String attributeName, java.lang.String attributeValue)
appendAnchorIfNecessary
in class BaseMarkupSerializer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |