Module io.sf.carte.css4j

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

Interface CSSElement

All Superinterfaces:

CSSNode, Element, ElementCSSInlineStyle, Node

All Known Implementing Classes:

DOMElement, HTMLElement

public interface CSSElement
extends Element, CSSNode, ElementCSSInlineStyle

Essentially adds CSS-related methods to the DOM's Element interface.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
void	exportHintsToStyle(CSSStyleDeclaration style)	Export this element's non-CSS presentational hints (if any) to the supplied CSSStyleDeclaration.
CSSComputedProperties	getComputedStyle(String pseudoElt)	Gets the computed style declaration that applies to this element.
String	getId()	Gets the id attribute of this element.
ExtendedCSSStyleDeclaration	getOverrideStyle(String pseudoElt)	Gets this element's override style declaration for a pseudo-element.
SelectorMatcher	getSelectorMatcher()	Gets a selector matcher associated to this element.
ExtendedCSSStyleDeclaration	getStyle()	The inline style.
boolean	hasOverrideStyle(String pseudoElt)	Check whether this element has an override style declaration for the given pseudo-element.
boolean	hasPresentationalHints()	Check whether this element has non-CSS presentational hints.
boolean	matches(String selectorString, String pseudoElement)	Does this element (with the provided pseudo-element, if any) match the provided selector string ?
boolean	matches(SelectorList selist, String pseudoElement)	Does this element (with the provided pseudo-element, if any) match the provided selector list ?

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

getOwnerDocument

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, 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

Method Details

getComputedStyle

CSSComputedProperties getComputedStyle(String pseudoElt)

Gets the computed style declaration that applies to this element.

Parameters:

pseudoElt - the pseudo-element name (null if no pseudo-element).

Returns:

the computed style declaration.

getId

String getId()

Gets the id attribute of this element.

Returns:

the id attribute, or the empty string if has no ID.

getOverrideStyle

ExtendedCSSStyleDeclaration getOverrideStyle(String pseudoElt)

Gets this element's override style declaration for a pseudo-element.

The getOverrideStyle method provides a mechanism through which a DOM author could effect immediate change to the style of an element without modifying the explicitly linked style sheets of a document or the inline style of elements.

The override style sheet comes after the author style sheet in the cascade algorithm.

Parameters:

pseudoElt - the pseudo-element, or null if none.

Returns:

the override style sheet for the given pseudo-element.

hasOverrideStyle

boolean hasOverrideStyle(String pseudoElt)

Check whether this element has an override style declaration for the given pseudo-element.

This method allows checking for override styles without the overhead of producing and retrieving one with getOverrideStyle(String) and checking its length.

Parameters:

pseudoElt - the pseudo-element, or null if none.

Returns:

true if this element has an override style declaration for pseudoElt.

getStyle

ExtendedCSSStyleDeclaration getStyle()

The inline style.

Specified by:

getStyle in interface ElementCSSInlineStyle

Returns:

the inline style specified by the style attribute, or null if that attribute is not present.

matches

boolean matches(String selectorString,
 String pseudoElement)
         throws DOMException

Does this element (with the provided pseudo-element, if any) match the provided selector string ?

Parameters:

selectorString - the selector string.

pseudoElement - the pseudo-element, or null if none.

Returns:

true if the element would be selected by the specified selector string, false otherwise.

Throws:

DOMException - SYNTAX_ERR if there was an error parsing the selector string.

matches

boolean matches(SelectorList selist,
 String pseudoElement)

Does this element (with the provided pseudo-element, if any) match the provided selector list ?

Parameters:

selist - the selector list.

pseudoElement - the pseudo-element, or null if none.

Returns:

true if the element would be selected by at least one selector in the specified list, false otherwise.

getSelectorMatcher

SelectorMatcher getSelectorMatcher()

Gets a selector matcher associated to this element.

Returns:

a selector matcher associated to this element.

hasPresentationalHints

boolean hasPresentationalHints()

Check whether this element has non-CSS presentational hints.

A document may contain non-CSS presentational hints (like the width attribute in HTML). This method can return true only if this specific element do contain such hints, which can be exported to a style declaration by using the exportHintsToStyle(CSSStyleDeclaration) method.

Returns:

true if this element has presentational hints.

exportHintsToStyle

void exportHintsToStyle(CSSStyleDeclaration style)
                 throws DOMException

Export this element's non-CSS presentational hints (if any) to the supplied CSSStyleDeclaration.

Parameters:

style - the style declaration to export to.

Throws:

DOMException