Skip navigation links
A C E F G H I M N O P R S T U W X 

A

AbstractHTMLFilter - Class in org.xwiki.xml.html.filter
Abstract implementation of HTMLFilter providing utility methods for various common w3c dom operations.
AbstractHTMLFilter() - Constructor for class org.xwiki.xml.html.filter.AbstractHTMLFilter
 
applyTagTransformations(Map<String, String>) - Method in class org.htmlcleaner.TrimAttributeTagTransformation
 
ATTRIBUTE_ALIGN - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML align attribute name.
ATTRIBUTE_ALT - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML alt attribute name.
ATTRIBUTE_CLASS - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML class attribute name.
ATTRIBUTE_FONTCOLOR - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML font color attribute.
ATTRIBUTE_FONTFACE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML font face attribute.
ATTRIBUTE_FONTSIZE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML font size attribute.
ATTRIBUTE_HREF - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML href attribute name.
ATTRIBUTE_ID - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML id attribute name.
ATTRIBUTE_NAME - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML name attribute name.
ATTRIBUTE_REL - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML rel attribute.
ATTRIBUTE_ROWSPAN - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML rowspan table attribute.
ATTRIBUTE_SRC - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML src attribute name.
ATTRIBUTE_STYLE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML style attribute name.
ATTRIBUTE_TARGET - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML target attribute.

C

characters(char[], int, int) - Method in class org.xwiki.xml.ExtractHandler
 
characters(char[], int, int) - Method in class org.xwiki.xml.Sax2Dom
 
clean(Reader) - Method in interface org.xwiki.xml.html.HTMLCleaner
Transforms any HTML content into valid XHTML that can be fed to the XHTML Parser for example.
clean(Reader, HTMLCleanerConfiguration) - Method in interface org.xwiki.xml.html.HTMLCleaner
Transforms any HTML content into valid XHTML.
comment(char[], int, int) - Method in class org.xwiki.xml.Sax2Dom
 
createDOM(DocumentBuilder, TagNode) - Method in class org.htmlcleaner.XWikiDOMSerializer
Create the DOM given a rootNode and a document builder.
createDOMDocument() - Static method in class org.xwiki.xml.XMLUtils
Construct a new (empty) DOM Document and return it.
createXMLReader() - Method in interface org.xwiki.xml.XMLReaderFactory
 

E

ElementSelector - Interface in org.xwiki.xml.html.filter
Interface for defining element selections.
endCDATA() - Method in class org.xwiki.xml.Sax2Dom
 
endDocument() - Method in class org.xwiki.xml.ExtractHandler
 
endDocument() - Method in class org.xwiki.xml.Sax2Dom
 
endDTD() - Method in class org.xwiki.xml.Sax2Dom
 
endElement(String, String, String) - Method in class org.xwiki.xml.ExtractHandler
 
endElement(String, String, String) - Method in class org.xwiki.xml.Sax2Dom
 
endEntity(String) - Method in class org.xwiki.xml.Sax2Dom
 
endPrefixMapping(String) - Method in class org.xwiki.xml.Sax2Dom
 
EntityResolver - Interface in org.xwiki.xml
XWiki's wrapping of the EntityResolver interface so that we can create components that implement it.
escape(Object) - Static method in class org.xwiki.xml.XMLUtils
Escapes all the XML special characters in a String using numerical XML entities.
escapeAttributeEntities(String) - Method in class org.xwiki.xml.html.HTMLUtils.XWikiXMLOutputter
 
escapeAttributeValue(Object) - Static method in class org.xwiki.xml.XMLUtils
Escapes all the XML special characters and left curly bracket in a String using numerical XML entities, so that the resulting string can safely be used as an XML attribute value.
escapeElementContent(Object) - Static method in class org.xwiki.xml.XMLUtils
Escapes the XML special characters in a String using numerical XML entities, so that the resulting string can safely be used as an XML text node.
escapeElementEntities(String) - Method in class org.xwiki.xml.html.HTMLUtils.XWikiXMLOutputter
 
escapeXMLComment(String) - Static method in class org.xwiki.xml.XMLUtils
XML comment does not support some characters inside its content but there is no official escaping/unescaping for it so we made our own.
ExtractHandler - Class in org.xwiki.xml
Extracts a well-formed XML fragment by listening to SAX events.
ExtractHandler(int, int) - Constructor for class org.xwiki.xml.ExtractHandler
Creates a new instance.
extractXML(Node, int, int) - Static method in class org.xwiki.xml.XMLUtils
Extracts a well-formed XML fragment from the given DOM tree.

F

filter(Document, Map<String, String>) - Method in interface org.xwiki.xml.html.filter.HTMLFilter
Performs cleaning of the html code stored in Document.
filterChildren(Element, String) - Method in class org.xwiki.xml.html.filter.AbstractHTMLFilter
Utility method for filtering an element's children with a tagName.
filterDescendants(Element, String[]) - Method in class org.xwiki.xml.html.filter.AbstractHTMLFilter
Utility method for filtering an element's descendants by their tag names.
filterDescendants(Element, String[], ElementSelector) - Method in class org.xwiki.xml.html.filter.AbstractHTMLFilter
Utility method for filtering an element's descendants by their tag names and an ElementSelector.
formatXMLContent(String) - Static method in class org.xwiki.xml.XMLUtils
Parse and pretty print a XML content.

G

getDefaultConfiguration() - Method in interface org.xwiki.xml.html.HTMLCleaner
Allows getting the default configuration that will be used thus allowing the user to configure it like adding some more filters before or after or even remove some filters to completely control what filters will be executed.
getFilters() - Method in interface org.xwiki.xml.html.HTMLCleanerConfiguration
 
getParameters() - Method in interface org.xwiki.xml.html.HTMLCleanerConfiguration
 
getResult() - Method in class org.xwiki.xml.ExtractHandler
 
getRootElement() - Method in class org.xwiki.xml.Sax2Dom
 
getRootNode() - Method in class org.xwiki.xml.Sax2Dom
 
getXMLEventReader(Source) - Static method in class org.xwiki.xml.stax.StAXUtils
Extract or create an instance of XMLEventReader from the provided Source.
getXMLStreamReader(Source) - Static method in class org.xwiki.xml.stax.StAXUtils
Extract or create an instance of XMLStreamReader from the provided Source.
getXMLStreamReader(XMLInputFactory, Source) - Static method in class org.xwiki.xml.stax.StAXUtils
Extract or create an instance of XMLStreamReader from the provided Source.
getXMLStreamWriter(Result) - Static method in class org.xwiki.xml.stax.StAXUtils
Extract or create an instance of XMLStreamWriter from the provided Result.
getXMLStreamWriter(XMLOutputFactory, Result) - Static method in class org.xwiki.xml.stax.StAXUtils
Extract or create an instance of XMLStreamWriter from the provided Result.

H

hasAttribute(List<Element>, String, boolean) - Method in class org.xwiki.xml.html.filter.AbstractHTMLFilter
Utility method for checking if a list of elements have the same attribute set.
HTMLCleaner - Interface in org.xwiki.xml.html
Transforms any HTML content into valid XHTML that can be fed to the XHTML Parser for example.
HTMLCleanerConfiguration - Interface in org.xwiki.xml.html
Represents a configuration for the HTMLCleaner and allows to configure the cleaning parameters and cleaning filters to apply.
HTMLConstants - Interface in org.xwiki.xml.html
HTML Constants.
HTMLFilter - Interface in org.xwiki.xml.html.filter
Defines an interface for filters that will filter HTML documents.
HTMLUtils - Class in org.xwiki.xml.html
HTML Utility methods.
HTMLUtils.XWikiXMLOutputter - Class in org.xwiki.xml.html
JDOM's XMLOutputter class converts reserved XML characters (<, >, ' , &, \r and \n) into their entity format &lt;, &gt; &apos; &amp; &#xD; and \r\n.

I

ignorableWhitespace(char[], int, int) - Method in class org.xwiki.xml.Sax2Dom
 
isFinished() - Method in class org.xwiki.xml.ExtractHandler
 
isSelected(Element) - Method in interface org.xwiki.xml.html.filter.ElementSelector
 

M

moveChildren(Element, Element) - Method in class org.xwiki.xml.html.filter.AbstractHTMLFilter
Moves all child elements of the parent into destination element.

N

NAMESPACES_AWARE - Static variable in interface org.xwiki.xml.html.HTMLCleanerConfiguration
Cleaning property identifier which decides if parsing should omit/keep namespace information.

O

org.htmlcleaner - package org.htmlcleaner
 
org.xwiki.xml - package org.xwiki.xml
 
org.xwiki.xml.html - package org.xwiki.xml.html
 
org.xwiki.xml.html.filter - package org.xwiki.xml.html.filter
 
org.xwiki.xml.stax - package org.xwiki.xml.stax
 

P

parse(LSInput) - Static method in class org.xwiki.xml.XMLUtils
Parse a DOM Document from a source.
printDocType(Writer, DocType) - Method in class org.xwiki.xml.html.HTMLUtils.XWikiXMLOutputter
 
printElement(Writer, Element, int, XMLOutputter.NamespaceStack) - Method in class org.xwiki.xml.html.HTMLUtils.XWikiXMLOutputter
 
processingInstruction(String, String) - Method in class org.xwiki.xml.Sax2Dom
 

R

replaceWithChildren(Element) - Method in class org.xwiki.xml.html.filter.AbstractHTMLFilter
Replaces the given Element with it's children.
RESTRICTED - Static variable in interface org.xwiki.xml.html.HTMLCleanerConfiguration
Cleaning in restricted mode (&lt;script&gt; and &lt;style&gt; should not be allowed for example).

S

Sax2Dom - Class in org.xwiki.xml
Convert SAX events into a Document.
Sax2Dom() - Constructor for class org.xwiki.xml.Sax2Dom
Default constructor.
Sax2Dom(Node) - Constructor for class org.xwiki.xml.Sax2Dom
 
SAXEventWriter - Class in org.xwiki.xml.stax
Receive and convert StAX events to SAX events.
SAXEventWriter(ContentHandler) - Constructor for class org.xwiki.xml.stax.SAXEventWriter
 
sendEvent(XMLEvent) - Method in class org.xwiki.xml.stax.SAXEventWriter
 
serialize(Node) - Static method in class org.xwiki.xml.XMLUtils
Serialize a DOM Node into a string, including the XML declaration at the start.
serialize(Node, boolean) - Static method in class org.xwiki.xml.XMLUtils
Serialize a DOM Node into a string, with an optional XML declaration at the start.
setDocumentLocator(Locator) - Method in class org.xwiki.xml.Sax2Dom
 
setFilters(List<HTMLFilter>) - Method in interface org.xwiki.xml.html.HTMLCleanerConfiguration
 
setParameters(Map<String, String>) - Method in interface org.xwiki.xml.html.HTMLCleanerConfiguration
 
skipElement(XMLStreamReader) - Static method in class org.xwiki.xml.stax.StAXUtils
Go to the end of the current element.
skippedEntity(String) - Method in class org.xwiki.xml.Sax2Dom
 
startCDATA() - Method in class org.xwiki.xml.Sax2Dom
 
startDocument() - Method in class org.xwiki.xml.ExtractHandler
 
startDocument() - Method in class org.xwiki.xml.Sax2Dom
 
startDTD(String, String, String) - Method in class org.xwiki.xml.Sax2Dom
 
startElement(String, String, String, Attributes) - Method in class org.xwiki.xml.ExtractHandler
 
startElement(String, String, String, Attributes) - Method in class org.xwiki.xml.Sax2Dom
 
startEntity(String) - Method in class org.xwiki.xml.Sax2Dom
 
startPrefixMapping(String, String) - Method in class org.xwiki.xml.Sax2Dom
 
StAXUtils - Class in org.xwiki.xml.stax
Various tools related to StAX API.
stripFirstElementInside(Document, String, String) - Static method in class org.xwiki.xml.html.HTMLUtils
Remove the first element inside a parent element and copy the element's children in the parent.
stripHTMLEnvelope(Document) - Static method in class org.xwiki.xml.html.HTMLUtils
Strip the HTML envelope if it exists.

T

TAG_A - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <a> tag name.
TAG_ABBR - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <abbr> tag name.
TAG_ACRONYM - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <acronym> tag name.
TAG_ADDRESS - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <address> tag name.
TAG_B - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <b> tag name.
TAG_BLOCKQUOTE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <blockquote> tag name.
TAG_BODY - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <body@gt; tag name.
TAG_BR - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <br> tag name.
TAG_CENTER - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <center> tag name.
TAG_CITE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <cite> tag name.
TAG_CODE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <code> tag name.
TAG_DEL - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <del> tag name.
TAG_DFN - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <dfn> tag name.
TAG_DIV - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <div> tag name.
TAG_DL - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <dl> tag name.
TAG_EM - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <em> tag name.
TAG_FIELDSET - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <fieldset> tag name.
TAG_FONT - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <font> tag name.
TAG_FORM - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <form> tag name.
TAG_H1 - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <h1> tag name.
TAG_H2 - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <h2> tag name.
TAG_H3 - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <h3> tag name.
TAG_H4 - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <h4> tag name.
TAG_H5 - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <h5> tag name.
TAG_H6 - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <h6> tag name.
TAG_HEAD - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <head@gt; tag name.
TAG_HR - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <hr> tag name.
TAG_HTML - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <html@gt; tag name.
TAG_I - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <i> tag name.
TAG_IMG - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <img> tag name.
TAG_INS - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <ins> tag name.
TAG_KBD - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <kbd> tag name.
TAG_LI - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <li> tag name.
TAG_NOSCRIPT - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <noscript> tag name.
TAG_OL - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <ol> tag name.
TAG_P - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <p> tag name.
TAG_PRE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <pre> tag name.
TAG_Q - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <q> tag name.
TAG_S - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <s> tag name.
TAG_SAMP - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <samp> tag name.
TAG_SCRIPT - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <script> tag name.
TAG_SPAN - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <span> tag name.
TAG_STRIKE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <strike> tag name.
TAG_STRONG - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <strong> tag name.
TAG_STYLE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <style> tag name.
TAG_TABLE - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <table> tag name.
TAG_TD - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <td> tag name.
TAG_TH - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <th> tag name.
TAG_TR - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <tr> tag name.
TAG_U - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <u> tag name.
TAG_UL - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <ul> tag name.
TAG_VAR - Static variable in interface org.xwiki.xml.html.HTMLConstants
HTML <var> tag name.
toString(Document) - Static method in class org.xwiki.xml.html.HTMLUtils
 
toString(Document, boolean, boolean) - Static method in class org.xwiki.xml.html.HTMLUtils
 
transform(Source, Source) - Static method in class org.xwiki.xml.XMLUtils
Apply an XSLT transformation to a Document.
TrimAttributeTagTransformation - Class in org.htmlcleaner
This class allows to transform all tags attribute to trim their value from leading space, except for input value.
TrimAttributeTagTransformation(String, String) - Constructor for class org.htmlcleaner.TrimAttributeTagTransformation
Create a TagTransformation from source tag to target tag.

U

unescape(Object) - Static method in class org.xwiki.xml.XMLUtils
Unescape encoded special XML characters.
unescapeXMLComment(String) - Static method in class org.xwiki.xml.XMLUtils
XML comment does not support some characters inside its content but there is no official escaping/unescaping for it so we made our own.
USE_CHARACTER_REFERENCES - Static variable in interface org.xwiki.xml.html.HTMLCleanerConfiguration
Cleaning property that controls whether the output HTML should use character references rather than entity references.

W

WHITE_SPACE_CHARS - Static variable in interface org.xwiki.xml.html.HTMLConstants
White space characters.

X

XML_PREFIX - Static variable in class org.xwiki.xml.Sax2Dom
"xml" namespace prefix.
XMLNS_PREFIX - Static variable in class org.xwiki.xml.Sax2Dom
"xmlns" namespace prefix.
XMLNS_STRING - Static variable in class org.xwiki.xml.Sax2Dom
"xmlns" namespace prefix with :.
XMLNS_URI - Static variable in class org.xwiki.xml.Sax2Dom
"xmlns" URL.
XMLReaderFactory - Interface in org.xwiki.xml
Factory to create optimised XMLReader.
XMLUtils - Class in org.xwiki.xml
XML Utility methods.
XWikiDOMSerializer - Class in org.htmlcleaner
Generate a W3C Document from a SF's HTML Cleaner TagNode.
XWikiDOMSerializer(CleanerProperties) - Constructor for class org.htmlcleaner.XWikiDOMSerializer
 
XWikiXMLOutputter(Format, boolean) - Constructor for class org.xwiki.xml.html.HTMLUtils.XWikiXMLOutputter
 
A C E F G H I M N O P R S T U W X 
Skip navigation links

Copyright © 2004–2019 XWiki. All rights reserved.