com.gargoylesoftware.htmlunit.javascript.host.css

Class CSSStyleSheet

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.css.StyleSheet

com.gargoylesoftware.htmlunit.javascript.host.css.CSSStyleSheet

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

public class CSSStyleSheet
extends StyleSheet

A JavaScript object for CSSStyleSheet.

Author:

Marc Guillemot, Daniel Gredler, Ahmed Ashour, Ronald Brill, Guy Burton, Frank Danek, Carsten Steul

See Also:

MSDN doc, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
CSSStyleSheet() Creates a new empty stylesheet.
CSSStyleSheet(HTMLElement element, com.gargoylesoftware.css.dom.CSSStyleSheetImpl wrapped, String uri) Creates a new stylesheet representing the specified CSS stylesheet.
CSSStyleSheet(HTMLElement element, com.gargoylesoftware.css.parser.InputSource source, String uri) Creates a new stylesheet representing the CSS stylesheet for the specified input source.
CSSStyleSheet(HTMLElement element, String styleSheet, String uri) Creates a new stylesheet representing the CSS stylesheet for the specified input source.

Method Summary

Modifier and Type	Method and Description
int	addRule(String selector, String rule) Adds a new rule.
void	deleteRule(int position) Deletes an existing rule.
CSSRuleList	getCssRules() Returns the collection of rules defined in this style sheet.
String	getHref() Returns the URL of the stylesheet.
HTMLElement	getOwnerNode() Returns the owner node.
HTMLElement	getOwningElement() Returns the owner element, same as getOwnerNode().
CSSRuleList	getRules() Retrieves the collection of rules defined in this style sheet.
String	getUri() Returns this stylesheet's URI (used to resolved contained @import rules).
com.gargoylesoftware.css.dom.CSSStyleSheetImpl	getWrappedSheet() Returns the wrapped stylesheet.
int	insertRule(String rule, int position) Inserts a new rule.
boolean	isActive() Returns true if this stylesheet is active, based on the media types it is associated with (if any).
boolean	isEnabled() Returns true if this stylesheet is enabled.
static CSSStyleSheet	loadStylesheet(HTMLElement element, HtmlLink link, String url) Loads the stylesheet at the specified link or href.
void	modifyIfNecessary(ComputedCSSStyleDeclaration style, Element element, String pseudoElement) Modifies the specified style object by adding any style rules which apply to the specified element.
com.gargoylesoftware.css.parser.selector.SelectorList	parseSelectors(String source) Parses the selectors at the specified input source.
void	removeRule(int position) Deletes an existing rule.
static boolean	selects(BrowserVersion browserVersion, com.gargoylesoftware.css.parser.selector.Selector selector, DomElement element, String pseudoElement, boolean fromQuerySelectorAll) Returns true if the specified selector selects the specified element.
void	setEnabled(boolean enabled) Sets whether this sheet is enabled or not.
static void	validateSelectors(com.gargoylesoftware.css.parser.selector.SelectorList selectorList, int documentMode, DomNode domNode) Validates the list of selectors.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, put, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isReadOnlySettable, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

CSSStyleSheet

public CSSStyleSheet()

Creates a new empty stylesheet.

CSSStyleSheet

public CSSStyleSheet(HTMLElement element,
                     com.gargoylesoftware.css.parser.InputSource source,
                     String uri)

Creates a new stylesheet representing the CSS stylesheet for the specified input source.

Parameters:

element - the owning node

source - the input source which contains the CSS stylesheet which this stylesheet host object represents

uri - this stylesheet's URI (used to resolved contained @import rules)

CSSStyleSheet

public CSSStyleSheet(HTMLElement element,
                     String styleSheet,
                     String uri)

Creates a new stylesheet representing the CSS stylesheet for the specified input source.

Parameters:

element - the owning node

styleSheet - the source which contains the CSS stylesheet which this stylesheet host object represents

uri - this stylesheet's URI (used to resolved contained @import rules)

CSSStyleSheet

public CSSStyleSheet(HTMLElement element,
                     com.gargoylesoftware.css.dom.CSSStyleSheetImpl wrapped,
                     String uri)

Creates a new stylesheet representing the specified CSS stylesheet.

Parameters:

element - the owning node

wrapped - the CSS stylesheet which this stylesheet host object represents

uri - this stylesheet's URI (used to resolved contained @import rules)

Method Detail

getWrappedSheet

public com.gargoylesoftware.css.dom.CSSStyleSheetImpl getWrappedSheet()

Returns the wrapped stylesheet.

Returns:

the wrapped stylesheet

modifyIfNecessary

public void modifyIfNecessary(ComputedCSSStyleDeclaration style,
                              Element element,
                              String pseudoElement)

Modifies the specified style object by adding any style rules which apply to the specified element.

Parameters:

style - the style to modify

element - the element to which style rules must apply in order for them to be added to the specified style

pseudoElement - a string specifying the pseudo-element to match (may be null)

loadStylesheet

public static CSSStyleSheet loadStylesheet(HTMLElement element,
                                           HtmlLink link,
                                           String url)

Loads the stylesheet at the specified link or href.

Parameters:

element - the parent DOM element

link - the stylesheet's link (may be null if a url is specified)

url - the stylesheet's url (may be null if a link is specified)

Returns:

the loaded stylesheet

selects

public static boolean selects(BrowserVersion browserVersion,
                              com.gargoylesoftware.css.parser.selector.Selector selector,
                              DomElement element,
                              String pseudoElement,
                              boolean fromQuerySelectorAll)

Returns true if the specified selector selects the specified element.

Parameters:

browserVersion - the browser version

selector - the selector to test

element - the element to test

pseudoElement - the pseudo element to match, (can be null)

fromQuerySelectorAll - whether this is called from DomNode.querySelectorAll(String)

Returns:

true if it does apply, false if it doesn't apply

parseSelectors

public com.gargoylesoftware.css.parser.selector.SelectorList parseSelectors(String source)

Parses the selectors at the specified input source. If anything at all goes wrong, this method returns an empty selector list.

Parameters:

source - the source from which to retrieve the selectors to be parsed

Returns:

the selectors parsed from the specified input source

getOwnerNode

public HTMLElement getOwnerNode()

Returns the owner node.

Returns:

the owner node

getOwningElement

public HTMLElement getOwningElement()

Returns the owner element, same as getOwnerNode().

Returns:

the owner element

getRules

public CSSRuleList getRules()

Retrieves the collection of rules defined in this style sheet.

Returns:

the collection of rules defined in this style sheet

getCssRules

public CSSRuleList getCssRules()

Returns the collection of rules defined in this style sheet.

Returns:

the collection of rules defined in this style sheet

getHref

public String getHref()

Returns the URL of the stylesheet.

Returns:

the URL of the stylesheet

insertRule

public int insertRule(String rule,
                      int position)

Inserts a new rule.

Parameters:

rule - the CSS rule

position - the position at which to insert the rule

Returns:

the position of the inserted rule

See Also:

DOM level 2

deleteRule

public void deleteRule(int position)

Deletes an existing rule.

Parameters:

position - the position of the rule to be deleted

See Also:

DOM level 2

addRule

public int addRule(String selector,
                   String rule)

Adds a new rule.

Parameters:

selector - the selector name

rule - the rule

Returns:

always return -1 as of MSDN documentation

See Also:

MSDN

removeRule

public void removeRule(int position)

Deletes an existing rule.

Parameters:

position - the position of the rule to be deleted

See Also:

MSDN

getUri

public String getUri()

Returns this stylesheet's URI (used to resolved contained @import rules).

Returns:

this stylesheet's URI (used to resolved contained @import rules)

isActive

public boolean isActive()

Returns true if this stylesheet is active, based on the media types it is associated with (if any).

Returns:

true if this stylesheet is active, based on the media types it is associated with (if any)

isEnabled

public boolean isEnabled()

Returns true if this stylesheet is enabled.

Returns:

true if this stylesheet is enabled

setEnabled

public void setEnabled(boolean enabled)

Sets whether this sheet is enabled or not.

Parameters:

enabled - enabled or not

validateSelectors

public static void validateSelectors(com.gargoylesoftware.css.parser.selector.SelectorList selectorList,
                                     int documentMode,
                                     DomNode domNode)
                              throws com.gargoylesoftware.css.parser.CSSException

Validates the list of selectors.

Parameters:

selectorList - the selectors

documentMode - see Document.getDocumentMode()

domNode - the dom node the query should work on

Throws:

com.gargoylesoftware.css.parser.CSSException - if a selector is invalid