Java Doc for HTMLSerializer.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » serialize » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.serialize 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jasig.portal.serialize.BaseMarkupSerializer
      org.jasig.portal.serialize.HTMLSerializer

All known Subclasses:   org.jasig.portal.serialize.XHTMLSerializer,  org.jasig.portal.serialize.CachingHTMLSerializer,
HTMLSerializer
public class HTMLSerializer extends BaseMarkupSerializer implements IAnchoringSerializer(Code)
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.serialize 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:

  • Element/attribute names are lower case and case matters
  • Attributes must specify value, even if empty string
  • Empty elements must have '/' in empty tag
  • Contents of SCRIPT and STYLE elements serialized as CDATA

version:
   $Revision: 42283 $ $Date: 2007-08-04 18:44:27 -0700 (Sat, 04 Aug 2007) $
author:
   Assaf Arkin
See Also:   Serializer


Field Summary
final public static  StringXHTMLNamespace
    

Constructor Summary
protected  HTMLSerializer(boolean xhtml, OutputFormat format)
     Constructs a new HTML/XHTML serializer depending on the value of xhtml.
public  HTMLSerializer()
     Constructs a new serializer.
public  HTMLSerializer(OutputFormat format)
     Constructs a new serializer.
public  HTMLSerializer(Writer writer, OutputFormat format)
     Constructs a new serializer that writes to the specified writer using the specified output format.
public  HTMLSerializer(OutputStream output, OutputFormat format)
     Constructs a new serializer that writes to the specified output stream using the specified output format.

Method Summary
protected  StringappendAnchorIfNecessary(String elementName, String attributeName, String attributeValue)
    
public  voidcharacters(char[] chars, int start, int length)
    
protected  voidcharacters(String text)
    
public  voidendElement(String namespaceURI, String localName, String rawName)
    
public  voidendElement(String tagName)
    
public  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.
public  voidsetOutputFormat(OutputFormat format)
    
public  voidsetXHTMLNamespace(String newNamespace)
    
public  booleanshouldNotExpandEndTagForEmptyElement(String elementName)
    
public  voidstartAnchoring(String anchorId)
    
protected  voidstartDocument(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._started ), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see HTMLSerializer.serializePreRoot ).

public  voidstartElement(String namespaceURI, String localName, String rawName, Attributes attrs)
    
public  voidstartElement(String tagName, AttributeList attrs)
    
public  voidstopAnchoring()
    

Field Detail
XHTMLNamespace
final public static String XHTMLNamespace(Code)




Constructor Detail
HTMLSerializer
protected HTMLSerializer(boolean xhtml, OutputFormat format)(Code)
Constructs a new HTML/XHTML serializer depending on the value of xhtml. The serializer cannot be used without calling HTMLSerializer.setOutputCharStream or HTMLSerializer.setOutputByteStream first.
Parameters:
  xhtml - True if XHTML serializing



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



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



HTMLSerializer
public HTMLSerializer(Writer writer, OutputFormat format)(Code)
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
Parameters:
  format - The output format to use, null for the default



HTMLSerializer
public HTMLSerializer(OutputStream output, OutputFormat format)(Code)
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
Parameters:
  format - The output format to use, null for the default




Method Detail
appendAnchorIfNecessary
protected String appendAnchorIfNecessary(String elementName, String attributeName, String attributeValue)(Code)



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



characters
protected void characters(String text) throws IOException(Code)



endElement
public void endElement(String namespaceURI, String localName, String rawName) throws SAXException(Code)



endElement
public void endElement(String tagName) throws SAXException(Code)



endElementIO
public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException(Code)



escapeURI
protected String escapeURI(String uri)(Code)



getEntityRef
protected String getEntityRef(int ch)(Code)



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



setOutputFormat
public void setOutputFormat(OutputFormat format)(Code)



setXHTMLNamespace
public void setXHTMLNamespace(String newNamespace)(Code)



shouldNotExpandEndTagForEmptyElement
public boolean shouldNotExpandEndTagForEmptyElement(String elementName)(Code)



startAnchoring
public void startAnchoring(String anchorId)(Code)



startDocument
protected void startDocument(String rootTagName) throws IOException(Code)
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._started ), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see HTMLSerializer.serializePreRoot ). 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) throws SAXException(Code)



startElement
public void startElement(String tagName, AttributeList attrs) throws SAXException(Code)



stopAnchoring
public void stopAnchoring()(Code)



Fields inherited from org.jasig.portal.serialize.BaseMarkupSerializer
protected String _docTypePublicId(Code)(Java Doc)
protected String _docTypeSystemId(Code)(Java Doc)
protected EncodingInfo _encodingInfo(Code)(Java Doc)
protected OutputFormat _format(Code)(Java Doc)
protected boolean _indenting(Code)(Java Doc)
protected Hashtable _prefixes(Code)(Java Doc)
protected Printer _printer(Code)(Java Doc)
protected boolean _started(Code)(Java Doc)
protected String anchorId(Code)(Java Doc)
protected Node fCurrentNode(Code)(Java Doc)
final protected DOMErrorImpl fDOMError(Code)(Java Doc)
protected DOMErrorHandler fDOMErrorHandler(Code)(Java Doc)
protected LSSerializerFilter fDOMFilter(Code)(Java Doc)
final protected StringBuffer fStrBuffer(Code)(Java Doc)
protected short features(Code)(Java Doc)
boolean html4compat(Code)(Java Doc)

Methods inherited from org.jasig.portal.serialize.BaseMarkupSerializer
protected String appendAnchorIfNecessary(String elementName, String attributeName, String attributeValue)(Code)(Java Doc)
public ContentHandler asContentHandler() throws IOException(Code)(Java Doc)
public DOMSerializer asDOMSerializer() throws IOException(Code)(Java Doc)
public DocumentHandler asDocumentHandler() throws IOException(Code)(Java Doc)
public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException(Code)(Java Doc)
public void characters(char[] chars, int start, int length) throws SAXException(Code)(Java Doc)
protected void characters(String text) throws IOException(Code)(Java Doc)
protected void checkUnboundNamespacePrefixedNode(Node node) throws IOException(Code)(Java Doc)
public void comment(char[] chars, int start, int length) throws SAXException(Code)(Java Doc)
public void comment(String text) throws IOException(Code)(Java Doc)
protected ElementState content() throws IOException(Code)(Java Doc)
public void elementDecl(String name, String model) throws SAXException(Code)(Java Doc)
public void endCDATA()(Code)(Java Doc)
public void endDTD()(Code)(Java Doc)
public void endDocument() throws SAXException(Code)(Java Doc)
public void endEntity(String name)(Code)(Java Doc)
public void endNonEscaping()(Code)(Java Doc)
public void endPrefixMapping(String prefix) throws SAXException(Code)(Java Doc)
public void endPreserving()(Code)(Java Doc)
protected ElementState enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace)(Code)(Java Doc)
public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException(Code)(Java Doc)
protected void fatalError(String message) throws IOException(Code)(Java Doc)
protected ElementState getElementState()(Code)(Java Doc)
abstract protected String getEntityRef(int ch)(Code)(Java Doc)
protected String getPrefix(String namespaceURI)(Code)(Java Doc)
public void ignorableWhitespace(char[] chars, int start, int length) throws SAXException(Code)(Java Doc)
public void internalEntityDecl(String name, String value) throws SAXException(Code)(Java Doc)
protected boolean isDocumentState()(Code)(Java Doc)
protected ElementState leaveElementState()(Code)(Java Doc)
protected DOMError modifyDOMError(String message, short severity, String type, Node node)(Code)(Java Doc)
public void notationDecl(String name, String publicId, String systemId) throws SAXException(Code)(Java Doc)
protected void prepare() throws IOException(Code)(Java Doc)
protected void printCDATAText(String text) throws IOException(Code)(Java Doc)
protected void printDoctypeURL(String url) throws IOException(Code)(Java Doc)
protected void printEscaped(int ch) throws IOException(Code)(Java Doc)
protected void printEscaped(String source) throws IOException(Code)(Java Doc)
final void printHex(int ch) throws IOException(Code)(Java Doc)
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException(Code)(Java Doc)
protected void printText(String text, boolean preserveSpace, boolean unescaped) throws IOException(Code)(Java Doc)
final public void processingInstruction(String target, String code) throws SAXException(Code)(Java Doc)
public void processingInstructionIO(String target, String code) throws IOException(Code)(Java Doc)
public boolean reset()(Code)(Java Doc)
public void serialize(Element elem) throws IOException(Code)(Java Doc)
public void serialize(DocumentFragment frag) throws IOException(Code)(Java Doc)
public void serialize(Document doc) throws IOException(Code)(Java Doc)
abstract protected void serializeElement(Element elem) throws IOException(Code)(Java Doc)
protected void serializeNode(Node node) throws IOException(Code)(Java Doc)
protected void serializePreRoot() throws IOException(Code)(Java Doc)
public void setDocumentLocator(Locator locator)(Code)(Java Doc)
public void setOutputByteStream(OutputStream output)(Code)(Java Doc)
public void setOutputCharStream(Writer writer)(Code)(Java Doc)
public void setOutputFormat(OutputFormat format)(Code)(Java Doc)
public void skippedEntity(String name) throws SAXException(Code)(Java Doc)
public void startAnchoring(String anchorId)(Code)(Java Doc)
public void startCDATA()(Code)(Java Doc)
final public void startDTD(String name, String publicId, String systemId) throws SAXException(Code)(Java Doc)
public void startDocument() throws SAXException(Code)(Java Doc)
public void startEntity(String name)(Code)(Java Doc)
public void startNonEscaping()(Code)(Java Doc)
public void startPrefixMapping(String prefix, String uri) throws SAXException(Code)(Java Doc)
public void startPreserving()(Code)(Java Doc)
public void stopAnchoring()(Code)(Java Doc)
protected void surrogates(int high, int low) throws IOException(Code)(Java Doc)
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.