Module io.sf.carte.css4j.dom4j

Package io.sf.carte.doc.dom4j

Class XHTMLDocumentFactory

java.lang.Object

org.dom4j.DocumentFactory

org.dom4j.dom.DOMDocumentFactory

io.sf.carte.doc.dom4j.XHTMLDocumentFactory

All Implemented Interfaces:

Serializable, DOMImplementation

Direct Known Subclasses:

DOM4JUserAgent.AgentXHTMLDocumentFactory

public class XHTMLDocumentFactory
extends DOMDocumentFactory

DocumentFactory for CSS-styled XHTML documents.

This factory creates XHTMLDocuments and other objects with support for CSS style sheets.

It is possible to produce elements with the ability to cache its own computed style, if you call setStyleCache(true). Although the performance benefit is generally not noticeable, in some corner cases it could enhance performance for applications that may call the getComputedStyle() method of a single stylable element many times. Due to the generally negligible performance gain, cache is off by default.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.dom4j.DocumentFactory

cache

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XHTMLDocumentFactory()
	XHTMLDocumentFactory(EnumSet<Parser.Flag> enumSet)

Method Summary

Modifier and Type	Method	Description
Attribute	createAttribute(Element owner, QName qname, String value)
XHTMLDocument	createDocument()
XHTMLDocument	createDocument(String namespaceURI, String qualifiedName, DocumentType docType)
protected XHTMLDocument	createDocument(DOMDocumentType documentType)
XHTMLDocument	createDocument(Element rootElement)
CSSStylableElement	createElement(String name)
CSSStylableElement	createElement(QName qname)
CSSStylableElement	createElement(QName qname, int attributeCount)
Object	getFeature(String feature, String version)	Deprecated.
static XHTMLDocumentFactory	getInstance()	Gets the instance of the document factory.
BaseCSSStyleSheetFactory	getStyleSheetFactory()	Gets the CSS style sheet factory.
boolean	isStyleCacheOn()	Indicates whether the stylable elements currently produced by this factory are cache-enabled or not.
void	setStyleCache(boolean onOff)	Can turn on or off the per-Element style caching capability (by default is off).

Methods inherited from class org.dom4j.dom.DOMDocumentFactory

asDocumentType, createCDATA, createComment, createDocType, createDocumentType, createEntity, createEntity, createNamespace, createProcessingInstruction, createProcessingInstruction, createText, hasFeature

Methods inherited from class org.dom4j.DocumentFactory

createAttribute, createDocument, createElement, createPattern, createQName, createQName, createQName, createQName, createQNameCache, createSingleton, createXPath, createXPath, createXPathFilter, createXPathFilter, getQNames, getXPathNamespaceURIs, init, intern, setXPathNamespaceURIs

Methods inherited from class java.lang.Object

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

Constructor Details

XHTMLDocumentFactory

protected XHTMLDocumentFactory()

XHTMLDocumentFactory

public XHTMLDocumentFactory(EnumSet<Parser.Flag> enumSet)

Method Details

getInstance

public static XHTMLDocumentFactory getInstance()

Gets the instance of the document factory.

Returns:

the XHTML (DOM4J-derived) document factory instance.

getStyleSheetFactory

public BaseCSSStyleSheetFactory getStyleSheetFactory()

Gets the CSS style sheet factory.

Returns:

the CSS style sheet factory.

isStyleCacheOn

public boolean isStyleCacheOn()

Indicates whether the stylable elements currently produced by this factory are cache-enabled or not.

Returns:

true if the per-element cache is enabled, false otherwise.

setStyleCache

public void setStyleCache(boolean onOff)

Can turn on or off the per-Element style caching capability (by default is off).

Only applications that repeatedly call the CSSStylableElement.getComputedStyle() method on the same Element should turn it on.

Parameters:

onOff - set to true to turn on the cache capability, to false to turn it off.

createElement

public CSSStylableElement createElement(String name)

Overrides:

createElement in class DocumentFactory

createElement

public CSSStylableElement createElement(QName qname)

Overrides:

createElement in class DOMDocumentFactory

createElement

public CSSStylableElement createElement(QName qname,
 int attributeCount)

Overrides:

createElement in class DOMDocumentFactory

createDocument

public XHTMLDocument createDocument()

Overrides:

createDocument in class DOMDocumentFactory

createDocument

public XHTMLDocument createDocument(Element rootElement)

Overrides:

createDocument in class DocumentFactory

createDocument

protected XHTMLDocument createDocument(DOMDocumentType documentType)

createDocument

public XHTMLDocument createDocument(String namespaceURI,
 String qualifiedName,
 DocumentType docType)
                             throws DOMException

Specified by:

createDocument in interface DOMImplementation

Overrides:

createDocument in class DOMDocumentFactory

Throws:

DOMException

createAttribute

public Attribute createAttribute(Element owner,
 QName qname,
 String value)

Overrides:

createAttribute in class DOMDocumentFactory

getFeature

@Deprecated
public Object getFeature(String feature,
 String version)

Deprecated.

Specified by:

getFeature in interface DOMImplementation

Overrides:

getFeature in class DOMDocumentFactory