Package org.ametys.core.cocoon
Class XHTMLSerializer
-
- All Implemented Interfaces:
Poolable
,Recyclable
,Component
,Configurable
,LogEnabled
,Serviceable
,Serializer
,SitemapOutputComponent
,XMLConsumer
,XMLConsumer
,ContentHandler
,LexicalHandler
,Locator
public class XHTMLSerializer extends XHTMLSerializer implements LogEnabled, Serviceable
Inherits from cocoon's serializers block XHTMLSerializer.The following configuration can be used:
<omit-xml-declaration>yes|no</omit-xml-declaration> <tags-to-collapse>input,meta</tags-to-collapse> <namespace-allowed></namespace-allowed> <namespace-allowed>http://www.w3.org/XML/1998/namespace</namespace-allowed> <namespace-allowed>http://www.w3.org/1999/xhtml</namespace-allowed>
Empty tags are not collapsed except the ones configured withtags-to-collapse
.
If there is no such configuration, default tags to collaspe are:- input
- img
- meta
- link
- hr
- br
namespace-allowed
, by default the only following namespaces are allowed:- "" (empty namespace)
- "http://www.w3.org/XML/1998/namespace"
- "http://www.w3.org/1999/xhtml"
- "http://www.w3.org/2000/svg"
- "http://www.w3.org/1998/Math/MathML"
script
tags will be exported in a single comment.omit-xml-declaration
is set toyes
by default for compatibility purpose (IE 6). Ifomit-xml-declaration
is set tono
,Content-Type
meta tag will be dropped if present.- Since:
- 1.1.5 this serializer is JAXP compliant with the processing instruction
javax.xml.transform.*-output-escaping processing
. - See Also:
Result
-
-
Field Summary
Fields Modifier and Type Field Description protected XHTMLSerializerExtensionPoint
_xhtmlSerializerExtensionPoint
The XHTMLSerializerExtensionPoint instance-
Fields inherited from class org.apache.cocoon.components.serializers.XHTMLSerializer
doctype_default, encodeCharacters, XHTML1_DOCTYPE_FRAMESET, XHTML1_DOCTYPE_STRICT, XHTML1_DOCTYPE_TRANSITIONAL, XHTML1_NAMESPACE, XHTML5_DOCTYPE
-
Fields inherited from class org.apache.cocoon.components.serializers.XMLSerializer
doctype
-
Fields inherited from class org.apache.cocoon.components.serializers.EncodingSerializer
ATTRIBUTE_LENGTH, ATTRIBUTE_LOCAL, ATTRIBUTE_NSURI, ATTRIBUTE_QNAME, ATTRIBUTE_VALUE, charset, indentPerLevel, namespaces
-
Fields inherited from interface org.apache.cocoon.serialization.Serializer
ROLE
-
-
Constructor Summary
Constructors Constructor Description XHTMLSerializer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
characters(char[] ch, int start, int length)
void
charactersImpl(char[] data, int start, int length)
void
comment(char[] data, int start, int length)
void
configure(Configuration conf)
void
enableLogging(Logger logger)
void
endElement(String nsuri, String local, String qual)
void
endElementImpl(String uri, String local, String qual)
void
endPrefixMapping(String prefix)
void
ignorableWhitespace(char[] data, int start, int length)
void
processingInstruction(String target, String data)
void
recycle()
void
service(ServiceManager manager)
void
startElement(String nsuri, String local, String qual, Attributes attributes)
void
startElementImpl(String uri, String local, String qual, String[][] lNamespaces, String[][] attributes)
void
startPrefixMapping(String prefix, String uri)
-
Methods inherited from class org.apache.cocoon.components.serializers.XHTMLSerializer
body, encode, getMimeType, head, isCdataElement
-
Methods inherited from class org.apache.cocoon.components.serializers.XMLSerializer
closeElement, endCDATA, endDocument, endDTD, endEntity, skippedEntity, startCDATA, startDocument, startDTD, startEntity
-
Methods inherited from class org.apache.cocoon.components.serializers.EncodingSerializer
encode, encode, flush, getColumnNumber, getLineNumber, getLocation, getPublicId, getSystemId, setDocumentLocator, setOutputStream, shouldSetContentLength, write, write, write, write, write, writeIndent, writeln, writeln
-
-
-
-
Field Detail
-
_xhtmlSerializerExtensionPoint
protected XHTMLSerializerExtensionPoint _xhtmlSerializerExtensionPoint
The XHTMLSerializerExtensionPoint instance
-
-
Constructor Detail
-
XHTMLSerializer
public XHTMLSerializer()
-
-
Method Detail
-
enableLogging
public void enableLogging(Logger logger)
- Specified by:
enableLogging
in interfaceLogEnabled
-
service
public void service(ServiceManager manager) throws ServiceException
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
configure
public void configure(Configuration conf) throws ConfigurationException
- Specified by:
configure
in interfaceConfigurable
- Overrides:
configure
in classXHTMLSerializer
- Throws:
ConfigurationException
-
startPrefixMapping
public void startPrefixMapping(String prefix, String uri) throws SAXException
- Specified by:
startPrefixMapping
in interfaceContentHandler
- Overrides:
startPrefixMapping
in classEncodingSerializer
- Throws:
SAXException
-
startElement
public void startElement(String nsuri, String local, String qual, Attributes attributes) throws SAXException
- Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classEncodingSerializer
- Throws:
SAXException
-
startElementImpl
public void startElementImpl(String uri, String local, String qual, String[][] lNamespaces, String[][] attributes) throws SAXException
- Overrides:
startElementImpl
in classXHTMLSerializer
- Throws:
SAXException
-
characters
public void characters(char[] ch, int start, int length) throws SAXException
- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classEncodingSerializer
- Throws:
SAXException
-
charactersImpl
public void charactersImpl(char[] data, int start, int length) throws SAXException
- Overrides:
charactersImpl
in classXMLSerializer
- Throws:
SAXException
-
ignorableWhitespace
public void ignorableWhitespace(char[] data, int start, int length) throws SAXException
- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Overrides:
ignorableWhitespace
in classXMLSerializer
- Throws:
SAXException
-
comment
public void comment(char[] data, int start, int length) throws SAXException
- Specified by:
comment
in interfaceLexicalHandler
- Overrides:
comment
in classXMLSerializer
- Throws:
SAXException
-
processingInstruction
public void processingInstruction(String target, String data) throws SAXException
- Specified by:
processingInstruction
in interfaceContentHandler
- Overrides:
processingInstruction
in classXMLSerializer
- Throws:
SAXException
-
endElement
public void endElement(String nsuri, String local, String qual) throws SAXException
- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classEncodingSerializer
- Throws:
SAXException
-
endElementImpl
public void endElementImpl(String uri, String local, String qual) throws SAXException
- Overrides:
endElementImpl
in classXHTMLSerializer
- Throws:
SAXException
-
endPrefixMapping
public void endPrefixMapping(String prefix) throws SAXException
- Specified by:
endPrefixMapping
in interfaceContentHandler
- Overrides:
endPrefixMapping
in classEncodingSerializer
- Throws:
SAXException
-
recycle
public void recycle()
- Specified by:
recycle
in interfaceRecyclable
- Overrides:
recycle
in classXMLSerializer
-
-