|
uPortal 2.4.1 API Documentation |
|||||||||
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
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 | |
static java.lang.String |
XHTMLNamespace
|
Constructor Summary | |
HTMLSerializer()
Constructs a new serializer. |
|
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 | |
void |
characters(char[] chars,
int start,
int length)
|
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)
|
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. |
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 org.jasig.portal.serialize.BaseMarkupSerializer |
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, comment, comment, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, externalEntityDecl, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, processingInstructionIO, reset, serialize, serialize, serialize, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, unparsedEntityDecl |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String XHTMLNamespace
Constructor Detail |
public 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
public 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 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
public void startAnchoring(java.lang.String anchorId)
IAnchoringSerializer
startAnchoring
in interface IAnchoringSerializer
anchorId
- the anchor identifierpublic void stopAnchoring()
IAnchoringSerializer
stopAnchoring
in interface IAnchoringSerializer
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |