Module io.sf.carte.css4j

Package io.sf.carte.doc.style.css.om

Class StylableDocumentWrapper

java.lang.Object

io.sf.carte.doc.style.css.om.StylableDocumentWrapper

All Implemented Interfaces:

CSSDocument, CSSNode, Document, Node, DocumentStyle

public abstract class StylableDocumentWrapper
extends Object
implements CSSDocument

CSS-enabled wrapper for a DOM Document.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sf.carte.doc.style.css.CSSDocument

CSSDocument.ComplianceMode

Field Summary

Fields

Modifier and Type	Field	Description
protected Node	rawnode

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StylableDocumentWrapper(Document document)

Method Summary

Modifier and Type	Method	Description
Node	adoptNode(Node source)
Node	appendChild(Node newChild)
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
Attr	createAttribute(String name)
Attr	createAttributeNS(String namespaceURI, String qualifiedName)
CDATASection	createCDATASection(String data)
Comment	createComment(String data)
DocumentFragment	createDocumentFragment()
CSSElement	createElement(String tagName)	Creates an element of the type specified.
CSSElement	createElementNS(String namespaceURI, String qualifiedName)
EntityReference	createEntityReference(String name)
ProcessingInstruction	createProcessingInstruction(String target, String data)
Text	createTextNode(String data)
void	enableStyleSheetsForSet(String name)	Enables a style sheet set.
NamedNodeMap	getAttributes()
String	getBaseURI()
URL	getBaseURL()	Gets the base URL of this Document.
CSSCanvas	getCanvas()	Gets the document's canvas for the current target medium.
NodeList	getChildNodes()
String	getCompatMode()	Get the compatibility mode (compatMode) attribute.
CSSDocument.ComplianceMode	getComplianceMode()	Get the compliance mode of this document.
protected CSSNode	getCSSNode(Node node)
DocumentType	getDoctype()
CSSElement	getDocumentElement()	Get the child node which is the document element of this document.
String	getDocumentURI()
DOMConfiguration	getDomConfig()
CSSElement	getElementById(String elementId)
NodeList	getElementsByTagName(String tagname)
NodeList	getElementsByTagNameNS(String namespaceURI, String localName)
ErrorHandler	getErrorHandler()	Gets the document-level error handler.
Object	getFeature(String feature, String version)
CSSNode	getFirstChild()
DOMImplementation	getImplementation()
String	getInputEncoding()
CSSNode	getLastChild()
String	getLastStyleSheetSet()	Gets the style sheet set that was last selected.
String	getLocalName()
protected CSSNode	getMappedCSSNode(Node node)
String	getNamespaceURI()
CSSNode	getNextSibling()
String	getNodeName()
short	getNodeType()
String	getNodeValue()
CSSDocument	getOwnerDocument()
CSSNode	getParentNode()
String	getPrefix()
CSSNode	getPreviousSibling()
String	getReferrerPolicy()	Get the referrer policy obtained through the 'Referrer-Policy' header or a meta element.
String	getSelectedStyleSheetSet()	Gets the title of the currently selected style sheet set.
boolean	getStrictErrorChecking()
StyleDatabase	getStyleDatabase()	Gets the style database currently used to apply specific styles to this document.
DocumentCSSStyleSheet	getStyleSheet()	Gets the merged style sheet that applies to this document, resulting from the merge of the document's default style sheet, the document linked or embedded style sheets, and the non-important part of the user style sheet.
protected abstract DOMCSSStyleSheetFactory	getStyleSheetFactory()
StyleSheetList	getStyleSheets()	A list containing all the style sheets explicitly linked into or embedded in a document.
DOMStringList	getStyleSheetSets()	Gets the list of available alternate styles.
String	getTargetMedium()	This document's current target medium name.
String	getTextContent()
URL	getURL(String uri)	Gets an URL for the given URI, taking into account the Base URL if appropriate.
Object	getUserData(String key)
String	getXmlEncoding()
boolean	getXmlStandalone()
String	getXmlVersion()
boolean	hasAttributes()
boolean	hasChildNodes()
boolean	hasStyleIssues()	Has any of the linked or embedded style sheets any error or warning ?
Node	importNode(Node importedNode, boolean deep)
Node	insertBefore(Node newChild, Node refChild)
boolean	isAuthorizedOrigin(URL url)	Determine whether the retrieval of the given URL is authorized.
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isSafeOrigin(URL linkedURL)	Is the provided URL a safe origin to load certain external resources?
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
boolean	isVisitedURI(String href)	Has this URI been visited by the agent ?
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	normalize()
void	normalizeDocument()
void	rebuildCascade()	Forces the cascade to be rebuilt the next time that a computed style is obtained.
void	registerProperty(CSSPropertyDefinition definition)	Registers the definition of a custom property.
Node	removeChild(Node oldChild)
Node	renameNode(Node n, String namespaceURI, String qualifiedName)
Node	replaceChild(Node newChild, Node oldChild)
void	setDocumentURI(String documentURI)
abstract void	setLoadingTime(long time)	Set the time at which this document was loaded from origin.
void	setNodeValue(String nodeValue)
void	setPrefix(String prefix)
protected void	setReferrerPolicyHeader(String policy)
void	setSelectedStyleSheetSet(String name)	Selects a style sheet set, disabling the other non-persistent sheet sets.
void	setStrictErrorChecking(boolean strictErrorChecking)
void	setTargetMedium(String medium)	Set the medium that will be used to compute the styles of this document.
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
void	setXmlStandalone(boolean xmlStandalone)
void	setXmlVersion(String xmlVersion)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sf.carte.doc.style.css.CSSDocument

openConnection

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getAttributes, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Details

rawnode

protected Node rawnode

Constructor Details

StylableDocumentWrapper

protected StylableDocumentWrapper(Document document)

Method Details

getStyleSheetFactory

protected abstract DOMCSSStyleSheetFactory getStyleSheetFactory()

getCompatMode

public String getCompatMode()

Get the compatibility mode (compatMode) attribute.

Specified by:

getCompatMode in interface CSSDocument

Returns:

the string "BackCompat" if document’s mode is QUIRKS, otherwise "CSS1Compat".

getComplianceMode

public CSSDocument.ComplianceMode getComplianceMode()

Description copied from interface: CSSDocument

Get the compliance mode of this document.

The styling in this document operate under a compliance mode. Two modes are supported: STRICT and QUIRKS.

QUIRKS and STRICT differ in the matching of class and ID selectors, and the default user agent sheet is slightly different.

Specified by:

getComplianceMode in interface CSSDocument

Returns:

the compliance mode.

getOwnerDocument

public CSSDocument getOwnerDocument()

Description copied from interface: CSSNode

Specified by:

getOwnerDocument in interface CSSNode

Specified by:

getOwnerDocument in interface Node

getMappedCSSNode

protected CSSNode getMappedCSSNode(Node node)

getCSSNode

protected CSSNode getCSSNode(Node node)

getDoctype

public DocumentType getDoctype()

Specified by:

getDoctype in interface Document

getImplementation

public DOMImplementation getImplementation()

Specified by:

getImplementation in interface Document

isVisitedURI

public boolean isVisitedURI(String href)

Description copied from interface: CSSDocument

Has this URI been visited by the agent ?

Specified by:

isVisitedURI in interface CSSDocument

Parameters:

href - the URI.

Returns:

true if visited, false if not visited or the agent does not support history.

setLoadingTime

public abstract void setLoadingTime(long time)

Set the time at which this document was loaded from origin.

Parameters:

time - the time of loading, in milliseconds.

getDocumentElement

public CSSElement getDocumentElement()

Description copied from interface: CSSDocument

Get the child node which is the document element of this document.

Specified by:

getDocumentElement in interface CSSDocument

Specified by:

getDocumentElement in interface Document

Returns:

the document element.

createElement

public CSSElement createElement(String tagName)
                         throws DOMException

Description copied from interface: CSSDocument

Creates an element of the type specified.

The presence of IMPLIED attributes is implementation-dependent.

Specified by:

createElement in interface CSSDocument

Specified by:

createElement in interface Document

Parameters:

tagName - the tag name of the element to create.

Returns:

the new CSSElement.

Throws:

DOMException - INVALID_CHARACTER_ERR if the name is not an XML valid name.

createDocumentFragment

public DocumentFragment createDocumentFragment()

Specified by:

createDocumentFragment in interface Document

createTextNode

public Text createTextNode(String data)

Specified by:

createTextNode in interface Document

createComment

public Comment createComment(String data)

Specified by:

createComment in interface Document

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Specified by:

createCDATASection in interface Document

Throws:

DOMException

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
 String data)
                                                  throws DOMException

Specified by:

createProcessingInstruction in interface Document

Throws:

DOMException

createAttribute

public Attr createAttribute(String name)
                     throws DOMException

Specified by:

createAttribute in interface Document

Throws:

DOMException

createEntityReference

public EntityReference createEntityReference(String name)
                                      throws DOMException

Specified by:

createEntityReference in interface Document

Throws:

DOMException

importNode

public Node importNode(Node importedNode,
 boolean deep)
                throws DOMException

Specified by:

importNode in interface Document

Throws:

DOMException

createElementNS

public CSSElement createElementNS(String namespaceURI,
 String qualifiedName)
                           throws DOMException

Description copied from interface: CSSDocument

Specified by:

createElementNS in interface CSSDocument

Specified by:

createElementNS in interface Document

Throws:

DOMException

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
 String qualifiedName)
                       throws DOMException

Specified by:

createAttributeNS in interface Document

Throws:

DOMException

getElementsByTagName

public NodeList getElementsByTagName(String tagname)

Specified by:

getElementsByTagName in interface Document

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
 String localName)

Specified by:

getElementsByTagNameNS in interface Document

getElementById

public CSSElement getElementById(String elementId)

Description copied from interface: CSSDocument

Specified by:

getElementById in interface CSSDocument

Specified by:

getElementById in interface Document

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface Document

getXmlEncoding

public String getXmlEncoding()

Specified by:

getXmlEncoding in interface Document

getXmlStandalone

public boolean getXmlStandalone()

Specified by:

getXmlStandalone in interface Document

setXmlStandalone

public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException

Specified by:

setXmlStandalone in interface Document

Throws:

DOMException

getXmlVersion

public String getXmlVersion()

Specified by:

getXmlVersion in interface Document

setXmlVersion

public void setXmlVersion(String xmlVersion)
                   throws DOMException

Specified by:

setXmlVersion in interface Document

Throws:

DOMException

getStrictErrorChecking

public boolean getStrictErrorChecking()

Specified by:

getStrictErrorChecking in interface Document

setStrictErrorChecking

public void setStrictErrorChecking(boolean strictErrorChecking)

Specified by:

setStrictErrorChecking in interface Document

getDocumentURI

public String getDocumentURI()

Specified by:

getDocumentURI in interface Document

setDocumentURI

public void setDocumentURI(String documentURI)

Specified by:

setDocumentURI in interface Document

adoptNode

public Node adoptNode(Node source)
               throws DOMException

Specified by:

adoptNode in interface Document

Throws:

DOMException

cloneNode

public Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

getDomConfig

public DOMConfiguration getDomConfig()

Specified by:

getDomConfig in interface Document

normalizeDocument

public void normalizeDocument()

Specified by:

normalizeDocument in interface Document

renameNode

public Node renameNode(Node n,
 String namespaceURI,
 String qualifiedName)
                throws DOMException

Specified by:

renameNode in interface Document

Throws:

DOMException

registerProperty

public void registerProperty(CSSPropertyDefinition definition)

Description copied from interface: CSSDocument

Registers the definition of a custom property.

Specified by:

registerProperty in interface CSSDocument

Parameters:

definition - the definition.

See Also:

• CSSStyleSheetFactory.createPropertyDefinition(String, CSSValueSyntax, boolean, CSSLexicalValue)

getStyleSheets

public StyleSheetList getStyleSheets()

A list containing all the style sheets explicitly linked into or embedded in a document. For HTML documents, this includes external style sheets, included via the HTML LINK element, and inline STYLE elements. In XML, this includes external style sheets, included via style sheet processing instructions (see [XML StyleSheet]).

Specified by:

getStyleSheets in interface CSSDocument

Specified by:

getStyleSheets in interface DocumentStyle

getStyleSheet

public DocumentCSSStyleSheet getStyleSheet()

Gets the merged style sheet that applies to this document, resulting from the merge of the document's default style sheet, the document linked or embedded style sheets, and the non-important part of the user style sheet. Does not include overriden styles nor the 'important' part of the user-defined style sheet.

The style sheet is lazily built.

Specified by:

getStyleSheet in interface CSSDocument

Returns:

the merged style sheet that applies to this document.

getStyleSheetSets

public DOMStringList getStyleSheetSets()

Gets the list of available alternate styles.

Specified by:

getStyleSheetSets in interface CSSDocument

Returns:

the list of available alternate style titles.

getSelectedStyleSheetSet

public String getSelectedStyleSheetSet()

Gets the title of the currently selected style sheet set.

Specified by:

getSelectedStyleSheetSet in interface CSSDocument

Returns:

the title of the currently selected style sheet, the empty string if none is selected, or null if there are style sheets from different style sheet sets that have their style sheet disabled flag unset.

setSelectedStyleSheetSet

public void setSelectedStyleSheetSet(String name)

Selects a style sheet set, disabling the other non-persistent sheet sets. If the name is the empty string, all non-persistent sheets will be disabled. Otherwise, if the name does not match any of the sets, does nothing.

Specified by:

setSelectedStyleSheetSet in interface CSSDocument

Parameters:

name - the case-sensitive name of the set to select.

getLastStyleSheetSet

public String getLastStyleSheetSet()

Gets the style sheet set that was last selected.

Specified by:

getLastStyleSheetSet in interface CSSDocument

Returns:

the last selected style sheet set, or null if none.

enableStyleSheetsForSet

public void enableStyleSheetsForSet(String name)

Enables a style sheet set. If the name does not match any of the sets, does nothing.

Specified by:

enableStyleSheetsForSet in interface CSSDocument

Parameters:

name - the case-sensitive name of the set to enable.

getStyleDatabase

public StyleDatabase getStyleDatabase()

Gets the style database currently used to apply specific styles to this document.

Specified by:

getStyleDatabase in interface CSSDocument

Returns:

the style database, or null if no style database has been selected.

getTargetMedium

public String getTargetMedium()

This document's current target medium name.

Specified by:

getTargetMedium in interface CSSDocument

Returns:

the target medium name of this document.

setTargetMedium

public void setTargetMedium(String medium)
                     throws CSSMediaException

Set the medium that will be used to compute the styles of this document.

Specified by:

setTargetMedium in interface CSSDocument

Parameters:

medium - the name of the target medium, like 'screen' or 'print'.

Throws:

CSSMediaException - if the document is unable to target the given medium.

getCanvas

public CSSCanvas getCanvas()

Gets the document's canvas for the current target medium.

Specified by:

getCanvas in interface CSSDocument

Returns:

the canvas, or null if no target medium has been set, or the DeviceFactory does not support canvas for the target medium.

rebuildCascade

public void rebuildCascade()

Description copied from interface: CSSDocument

Forces the cascade to be rebuilt the next time that a computed style is obtained.

This method should be called after you modify the styles in a way that is not detected by the library (like modifying a value).

Specified by:

rebuildCascade in interface CSSDocument

getErrorHandler

public ErrorHandler getErrorHandler()

Description copied from interface: CSSDocument

Gets the document-level error handler.

Specified by:

getErrorHandler in interface CSSDocument

Returns:

the error handler.

hasStyleIssues

public boolean hasStyleIssues()

Has any of the linked or embedded style sheets any error or warning ?

Specified by:

hasStyleIssues in interface CSSDocument

Returns:

true if any of the linked or embedded style sheets has any NSAC or rule error or warning, false otherwise.

getBaseURL

public URL getBaseURL()

Gets the base URL of this Document.

If the Document's head element has a base child element, the base URI is computed using the value of the href attribute of the base element. Otherwise, it is taken from the value of the getDocumentURI method.

Specified by:

getBaseURL in interface CSSDocument

Returns:

the base URL, or null if no base URL could be determined.

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

getURL

public URL getURL(String uri)
           throws MalformedURLException

Gets an URL for the given URI, taking into account the Base URL if appropriate.

Specified by:

getURL in interface CSSDocument

Parameters:

uri - the uri.

Returns:

the absolute URL.

Throws:

MalformedURLException - if the uri was wrong.

isSafeOrigin

public boolean isSafeOrigin(URL linkedURL)

Is the provided URL a safe origin to load certain external resources?

Specified by:

isSafeOrigin in interface CSSDocument

Parameters:

linkedURL - the URL of the external resource.

Returns:

true if is a safe origin, false otherwise.

isAuthorizedOrigin

public boolean isAuthorizedOrigin(URL url)

Determine whether the retrieval of the given URL is authorized.

If the URL's protocol is not http nor https and document's base URL's scheme is neither file nor jar, it is denied.

Specified by:

isAuthorizedOrigin in interface CSSDocument

Parameters:

url - the URL to check.

Returns:

true if allowed.

getReferrerPolicy

public String getReferrerPolicy()

Get the referrer policy obtained through the 'Referrer-Policy' header or a meta element.

Specified by:

getReferrerPolicy in interface CSSDocument

Returns:

the referrer policy, or the empty string if none was specified.

setReferrerPolicyHeader

protected void setReferrerPolicyHeader(String policy)

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeValue

public String getNodeValue()
                    throws DOMException

Specified by:

getNodeValue in interface Node

Throws:

DOMException

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Specified by:

setNodeValue in interface Node

Throws:

DOMException

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getParentNode

public CSSNode getParentNode()

Specified by:

getParentNode in interface Node

getChildNodes

public NodeList getChildNodes()

Specified by:

getChildNodes in interface Node

getFirstChild

public CSSNode getFirstChild()

Specified by:

getFirstChild in interface Node

getLastChild

public CSSNode getLastChild()

Specified by:

getLastChild in interface Node

getPreviousSibling

public CSSNode getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

getNextSibling

public CSSNode getNextSibling()

Specified by:

getNextSibling in interface Node

getAttributes

public NamedNodeMap getAttributes()

Specified by:

getAttributes in interface Node

insertBefore

public Node insertBefore(Node newChild,
 Node refChild)
                  throws DOMException

Specified by:

insertBefore in interface Node

Throws:

DOMException

replaceChild

public Node replaceChild(Node newChild,
 Node oldChild)
                  throws DOMException

Specified by:

replaceChild in interface Node

Throws:

DOMException

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Specified by:

removeChild in interface Node

Throws:

DOMException

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Specified by:

appendChild in interface Node

Throws:

DOMException

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface Node

normalize

public void normalize()

Specified by:

normalize in interface Node

isSupported

public boolean isSupported(String feature,
 String version)

Specified by:

isSupported in interface Node

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface Node

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Node

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Specified by:

setPrefix in interface Node

Throws:

DOMException

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

getFeature

public Object getFeature(String feature,
 String version)

Specified by:

getFeature in interface Node

setUserData

public Object setUserData(String key,
 Object data,
 UserDataHandler handler)

Specified by:

setUserData in interface Node

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node