uPortal 2.4.1
API Documentation

org.jasig.portal.serialize
Class HTMLSerializer

java.lang.Object
  extended byorg.jasig.portal.serialize.BaseMarkupSerializer
      extended byorg.jasig.portal.serialize.HTMLSerializer
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.DocumentHandler, DOMSerializer, org.xml.sax.DTDHandler, IAnchoringSerializer, org.xml.sax.ext.LexicalHandler, Serializer
Direct Known Subclasses:
CachingHTMLSerializer, CachingXHTMLSerializer, XHTMLSerializer

public class HTMLSerializer
extends BaseMarkupSerializer
implements IAnchoringSerializer

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:

Version:
$Revision: 1.6.2.1 $ $Date: 2004/11/02 20:41:47 $
Author:
Assaf Arkin
See Also:
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

XHTMLNamespace

public static java.lang.String XHTMLNamespace
Constructor Detail

HTMLSerializer

public HTMLSerializer()
Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(Writer) or BaseMarkupSerializer.setOutputByteStream(OutputStream) first.


HTMLSerializer

public HTMLSerializer(OutputFormat format)
Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(Writer) or BaseMarkupSerializer.setOutputByteStream(OutputStream) first.


HTMLSerializer

public HTMLSerializer(java.io.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(java.io.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

setOutputFormat

public void setOutputFormat(OutputFormat format)
Description copied from interface: Serializer
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.

Specified by:
setOutputFormat in interface Serializer
Overrides:
setOutputFormat in class BaseMarkupSerializer

startElement

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
Specified by:
startElement in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException
Specified by:
endElement in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException

endElementIO

public void endElementIO(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName)
                  throws java.io.IOException
Throws:
java.io.IOException

characters

public void characters(char[] chars,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
Specified by:
characters in interface org.xml.sax.ContentHandler
Overrides:
characters in class BaseMarkupSerializer
Throws:
org.xml.sax.SAXException

startElement

public void startElement(java.lang.String tagName,
                         org.xml.sax.AttributeList attrs)
                  throws org.xml.sax.SAXException
Specified by:
startElement in interface org.xml.sax.DocumentHandler
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException
Specified by:
endElement in interface org.xml.sax.DocumentHandler
Throws:
org.xml.sax.SAXException

startAnchoring

public void startAnchoring(java.lang.String anchorId)
Description copied from interface: IAnchoringSerializer
Signify that the serializer should begin to append the anchor ID to URLs of its choosing.

Specified by:
startAnchoring in interface IAnchoringSerializer
Parameters:
anchorId - the anchor identifier

stopAnchoring

public void stopAnchoring()
Description copied from interface: IAnchoringSerializer
Signify that anchoring is no longer desired by the serializer.

Specified by:
stopAnchoring in interface IAnchoringSerializer

uPortal 2.4.1
API Documentation