org.xwiki.xml.html

Class HTMLUtils.XWikiXMLOutputter

java.lang.Object

org.jdom.output.XMLOutputter

org.xwiki.xml.html.HTMLUtils.XWikiXMLOutputter

All Implemented Interfaces:

Cloneable

Enclosing class:

HTMLUtils

public static class HTMLUtils.XWikiXMLOutputter
extends org.jdom.output.XMLOutputter

JDOM's XMLOutputter class converts reserved XML characters (<, >, ' , &, \r and \n) into their entity format (<, > ' & and \r\n). However since we're using HTML Cleaner (http://htmlcleaner.sourceforge.net/) and since it's buggy for character escapes we have turned off character escaping for it and thus we need to perform selective escaping here.

Moreover, since we support HTML5, we need to expand empty elements on some elements and not on the others. For example: <span></span> is valid meanwhile <br> </br> is not. See OMIT_ELEMENT_EXPANDING_SET for the list of elements to not expand.

Nested Class Summary

Nested classes/interfaces inherited from class org.jdom.output.XMLOutputter

org.jdom.output.XMLOutputter.NamespaceStack

Field Summary

Fields inherited from class org.jdom.output.XMLOutputter

currentFormat, preserveFormat

Constructor Summary

Constructors

Constructor and Description
HTMLUtils.XWikiXMLOutputter(org.jdom.output.Format format, boolean omitDocType)

Method Summary

Methods

Modifier and Type	Method and Description
String	escapeAttributeEntities(String text)
String	escapeElementEntities(String text)
protected void	printDocType(Writer out, org.jdom.DocType docType)
protected void	printElement(Writer out, org.jdom.Element element, int level, org.jdom.output.XMLOutputter.NamespaceStack namespaces)

Methods inherited from class org.jdom.output.XMLOutputter

clone, getFormat, output, output, output, output, output, output, output, output, output, output, output, output, output, output, output, output, output, output, outputElementContent, outputElementContent, outputString, outputString, outputString, outputString, outputString, outputString, outputString, outputString, outputString, printAttributes, printCDATA, printComment, printDeclaration, printEntityRef, printProcessingInstruction, printText, setFormat, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HTMLUtils.XWikiXMLOutputter

public HTMLUtils.XWikiXMLOutputter(org.jdom.output.Format format,
                           boolean omitDocType)

Parameters:

format - the JDOM class used to control output formats, see Format

omitDocType - if true then omit the document type when printing the W3C Document

See Also:

XMLOutputter.XMLOutputter(Format)

Method Detail

escapeElementEntities

public String escapeElementEntities(String text)

Overrides:

escapeElementEntities in class org.jdom.output.XMLOutputter

escapeAttributeEntities

public String escapeAttributeEntities(String text)

Overrides:

escapeAttributeEntities in class org.jdom.output.XMLOutputter

printDocType

protected void printDocType(Writer out,
                org.jdom.DocType docType)
                     throws IOException

Overrides:

printDocType in class org.jdom.output.XMLOutputter

Throws:

IOException

printElement

protected void printElement(Writer out,
                org.jdom.Element element,
                int level,
                org.jdom.output.XMLOutputter.NamespaceStack namespaces)
                     throws IOException

Overrides:

printElement in class org.jdom.output.XMLOutputter

Throws:

IOException