org.xwiki.rendering.wikimodel.xhtml.filter

Class XHTMLWhitespaceXMLFilter

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

org.xwiki.rendering.wikimodel.xhtml.filter.DefaultXMLFilter

org.xwiki.rendering.wikimodel.xhtml.filter.XHTMLWhitespaceXMLFilter

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler, XMLFilter, XMLReader

public class XHTMLWhitespaceXMLFilter
extends DefaultXMLFilter

Removes non-semantic whitespaces in XML elements. See http://www.w3.org/TR/html4/struct/text.html#h-9.1 for more details. Possible use cases:

• UC1: Any white spaces group is removed if it's before a non inline (see NONINLINE_ELEMENTS) element or at the beginning of the document.
• UC2: Any white spaces group is removed if it's after a non inline (see NONINLINE_ELEMENTS) element or at the end of the document.
• UC3: Inside inline content any white spaces group become a single space.
• UC5: Non visible element (comments, CDATA and NONVISIBLE_ELEMENTS) are invisibles and does not cut a white space group. text(sp)(sp)text becomes text(sp)text
• UC5: Visible empty element like img count as text when grouping white spaces
• UC6: Semantic comment count as text when grouping white spaces

Since:

4.0M1

Version:

$Id: 9c6406cf9f165b870dcbdc63b3ff0633f1f4bec6 $

Field Summary

Fields inherited from class org.xwiki.rendering.wikimodel.xhtml.filter.DefaultXMLFilter

SAX_LEXICAL_HANDLER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
XHTMLWhitespaceXMLFilter()
XHTMLWhitespaceXMLFilter(XMLReader reader)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendInlineEvent(org.xwiki.rendering.wikimodel.xhtml.filter.XHTMLWhitespaceXMLFilter.Event event) Append an inline element.
void	characters(char[] ch, int start, int length)
protected void	cleanContentExtraWhiteSpaces() UC3: Replace group of white spaces by a single space.
void	comment(char[] ch, int start, int length)
void	endCDATA()
void	endDocument()
void	endElement(String uri, String localName, String qName)
protected void	endEmptyVisibleElement()
protected void	endNonVisibleElement() Flush previous content and print current one.
protected void	flushContent() Flush previous content and print current one.
protected void	flushContent(boolean trimTrailing) Flush previous content and print current one.
protected StringBuffer	getContent()
protected boolean	isSemanticComment(String comment) We remove spaces around non semantic comments.
protected void	sendCharacters(char[] ch)
protected void	sendCharacters(char[] ch, int start, int length)
protected void	sendInlineEvent(org.xwiki.rendering.wikimodel.xhtml.filter.XHTMLWhitespaceXMLFilter.Event event)
protected void	sendPreviousContent(boolean trimTrailing)
protected boolean	shouldRemoveWhiteSpaces()
void	startCDATA()
void	startElement(String uri, String localName, String qName, Attributes atts)
protected void	startEmptyVisibleElement()
protected void	startNonVisibleElement() Append an non visible element.
protected void	trimLeadingWhiteSpaces()
protected String	trimLeadingWhiteSpaces(CharSequence content)
protected void	trimTrailingWhiteSpaces()
protected String	trimTrailingWhiteSpaces(CharSequence content)

Methods inherited from class org.xwiki.rendering.wikimodel.xhtml.filter.DefaultXMLFilter

endDTD, endEntity, getProperty, parse, setProperty, startDTD, startEntity

Methods inherited from class org.xml.sax.helpers.XMLFilterImpl

endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, ignorableWhitespace, notationDecl, parse, processingInstruction, resolveEntity, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

XHTMLWhitespaceXMLFilter

public XHTMLWhitespaceXMLFilter()

XHTMLWhitespaceXMLFilter

public XHTMLWhitespaceXMLFilter(XMLReader reader)

Method Detail

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.XMLFilterImpl

Throws:

SAXException

startElement

public void startElement(String uri,
                String localName,
                String qName,
                Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.XMLFilterImpl

Throws:

SAXException

endElement

public void endElement(String uri,
              String localName,
              String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.XMLFilterImpl

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class DefaultXMLFilter

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class DefaultXMLFilter

Throws:

SAXException

comment

public void comment(char[] ch,
           int start,
           int length)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class DefaultXMLFilter

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.XMLFilterImpl

Throws:

SAXException

shouldRemoveWhiteSpaces

protected boolean shouldRemoveWhiteSpaces()

sendPreviousContent

protected void sendPreviousContent(boolean trimTrailing)
                            throws SAXException

Throws:

SAXException

sendInlineEvent

protected void sendInlineEvent(org.xwiki.rendering.wikimodel.xhtml.filter.XHTMLWhitespaceXMLFilter.Event event)
                        throws SAXException

Throws:

SAXException

flushContent

protected void flushContent()
                     throws SAXException

Flush previous content and print current one.

Throws:

SAXException

flushContent

protected void flushContent(boolean trimTrailing)
                     throws SAXException

Flush previous content and print current one.

Throws:

SAXException

appendInlineEvent

protected void appendInlineEvent(org.xwiki.rendering.wikimodel.xhtml.filter.XHTMLWhitespaceXMLFilter.Event event)
                          throws SAXException

Append an inline element. Inline elements ending with a space are stacked waiting for a non space character or the end of the inline content.

Throws:

SAXException

startEmptyVisibleElement

protected void startEmptyVisibleElement()
                                 throws SAXException

Throws:

SAXException

endEmptyVisibleElement

protected void endEmptyVisibleElement()
                               throws SAXException

Throws:

SAXException

startNonVisibleElement

protected void startNonVisibleElement()
                               throws SAXException

Append an non visible element.

Throws:

SAXException

endNonVisibleElement

protected void endNonVisibleElement()
                             throws SAXException

Flush previous content and print current one.

Throws:

SAXException

sendCharacters

protected void sendCharacters(char[] ch)
                       throws SAXException

Throws:

SAXException

sendCharacters

protected void sendCharacters(char[] ch,
                  int start,
                  int length)
                       throws SAXException

Throws:

SAXException

cleanContentExtraWhiteSpaces

protected void cleanContentExtraWhiteSpaces()

UC3: Replace group of white spaces by a single space.

trimLeadingWhiteSpaces

protected void trimLeadingWhiteSpaces()

trimLeadingWhiteSpaces

protected String trimLeadingWhiteSpaces(CharSequence content)

trimTrailingWhiteSpaces

protected void trimTrailingWhiteSpaces()

trimTrailingWhiteSpaces

protected String trimTrailingWhiteSpaces(CharSequence content)

getContent

protected StringBuffer getContent()

isSemanticComment

protected boolean isSemanticComment(String comment)

We remove spaces around non semantic comments.

Parameters:

comment - the comment to evaluate

Returns:

true if the comment is a semantic one