Module io.sf.carte.css4j

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

Class BaseCSSStyleSheet

java.lang.Object

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

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

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

All Implemented Interfaces:

ExtendedCSSStyleSheet<AbstractCSSRule>, Cloneable, CSSStyleSheet, StyleSheet

Direct Known Subclasses:

BaseDocumentCSSStyleSheet, DOMCSSStyleSheet

public abstract class BaseCSSStyleSheet
extends AbstractCSSStyleSheet

CSS Style Sheet Object Model implementation base class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseCSSStyleSheet(String title, MediaQueryList media, AbstractCSSRule ownerRule, byte origin)	Constructs a style sheet.

Method Summary

Modifier and Type	Method	Description
protected void	addLocalRule(CSSRule cssrule)	Inserts a local rule in the current insertion point (generally after the last rule).
void	addRule(AbstractCSSRule cssrule)	Inserts a rule in the current insertion point (generally after the last rule).
void	addStyleSheet(AbstractCSSStyleSheet sheet)	Adds the rules contained by the supplied style sheet, if that sheet is not disabled.
protected void	copyAllTo(BaseCSSStyleSheet myCopy)
protected void	copyFieldsTo(BaseCSSStyleSheet myCopy)
protected void	copyRulesTo(BaseCSSStyleSheet myCopy)
CounterStyleRule	createCounterStyleRule(String name)	Create a CSSCounterStyleRule compatible with this implementation.
FontFaceRule	createFontFaceRule()	Create a CSS Font Face rule compatible with this implementation.
FontFeatureValuesRule	createFontFeatureValuesRule(String[] fontFamily)	Create a CSSFontFeatureValuesRule compatible with this implementation.
ImportRule	createImportRule(MediaQueryList mediaList, String href)	Create a CSS import rule compatible with this implementation.
KeyframesRule	createKeyframesRule(String keyframesName)	Create a CSSKeyframesRule compatible with this implementation.
MarginRule	createMarginRule(String name)	Create a CSS margin rule compatible with this implementation.
MediaRule	createMediaRule(MediaQueryList mediaList)	Create a CSS media rule.
NamespaceRule	createNamespaceRule(String prefix, String namespaceUri)	Create a CSS namespace rule compatible with this implementation.
PageRule	createPageRule()	Create a CSS page rule compatible with this implementation.
BaseCSSStyleDeclaration	createStyleDeclaration()	Create a CSS style declaration compatible with this implementation.
protected BaseCSSStyleDeclaration	createStyleDeclaration(BaseCSSDeclarationRule rule)
StyleRule	createStyleRule()	Create a CSS style rule.
SupportsRule	createSupportsRule()	Create a CSSSupportsRule compatible with this implementation.
UnknownRule	createUnknownRule()	Create a CSS unknown rule.
ViewportRule	createViewportRule()	Create a CSSViewportRule compatible with this implementation.
void	deleteRule(int index)	Deletes a rule from the style sheet.
CSSRuleArrayList	getCssRules()	Gets the collection of all CSS rules contained within the style sheet.
boolean	getDisabled()
protected ErrorHandler	getDocumentErrorHandler()
SheetErrorHandler	getErrorHandler()	Gets the error handler for this style sheet.
String	getHref()
MediaQueryList	getMedia()	Get the destination media for this sheet.
protected String	getNamespacePrefix(String uri)	Gets the namespace prefix associated to the given URI.
byte	getOrigin()	Get the origin of this sheet.
Node	getOwnerNode()
AbstractCSSRule	getOwnerRule()
AbstractCSSStyleSheet	getParentStyleSheet()
CSSRuleArrayList	getRulesForProperty(String longhandPropertyName)	Returns a list of rules that apply to a style where the given longhand property is set (either explicitly or through a shorthand).
Selector[]	getSelectorsForProperty(String longhandPropertyName)	Returns an array of selectors that apply to a style where the given longhand property is set (either explicitly or through a shorthand).
Selector[]	getSelectorsForPropertyValue(String propertyName, String declaredValue)	Returns an array of selectors that apply to a style where the given property was explicitly set to the given declared value.
abstract BaseCSSStyleSheetFactory	getStyleSheetFactory()	Get the stylesheet factory used to produce this sheet.
protected String	getTargetMedium()
String	getType()
protected boolean	hasDefaultNamespace()	Has this style sheet defined a default namespace ?
boolean	hasRuleErrorsOrWarnings()	Check whether this sheet contains rules that have errors or warnings reported to their handlers.
int	insertRule(String rule, int index)	Used to insert a new rule into the style sheet.
boolean	loadStyleSheet(URL url, String referrerPolicy)	Load the styles from url into this style sheet.
boolean	parseStyleSheet(InputSource source)	Parses a style sheet.
boolean	parseStyleSheet(InputSource source, boolean ignoreComments)	Parses a style sheet.
protected void	registerNamespace(CSSNamespaceRule nsrule)
void	setDisabled(boolean disabled)
void	setHref(String href)
protected void	setMedia(MediaQueryList media)	Set the destination media for this sheet.
protected void	setParentStyleSheet(AbstractCSSStyleSheet parent)
String	toMinifiedString()	Returns a minified parsable representation of the rule list of this sheet.
String	toString()
String	toStyleString()	Returns a serialization of this style sheet in the form of a STYLE element with its attributes and content.
protected void	unregisterNamespace(String namespaceURI)

Methods inherited from class io.sf.carte.doc.style.css.om.AbstractCSSStyleSheet

clone, openConnection, parseRelAttribute

Methods inherited from class io.sf.carte.doc.style.css.om.AbstractStyleSheet

getTitle, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.stylesheets.StyleSheet

getTitle

Constructor Details

BaseCSSStyleSheet

protected BaseCSSStyleSheet(String title,
 MediaQueryList media,
 AbstractCSSRule ownerRule,
 byte origin)

Constructs a style sheet.

Parameters:

title - the advisory title.

media - the media this sheet is for.

ownerRule - the owner rule.

origin - the sheet origin.

Method Details

copyAllTo

protected void copyAllTo(BaseCSSStyleSheet myCopy)

copyFieldsTo

protected void copyFieldsTo(BaseCSSStyleSheet myCopy)

copyRulesTo

protected void copyRulesTo(BaseCSSStyleSheet myCopy)

getStyleSheetFactory

public abstract BaseCSSStyleSheetFactory getStyleSheetFactory()

Get the stylesheet factory used to produce this sheet.

Specified by:

getStyleSheetFactory in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

getStyleSheetFactory in class AbstractCSSStyleSheet

Returns:

the stylesheet factory.

getOwnerRule

public AbstractCSSRule getOwnerRule()

Specified by:

getOwnerRule in interface CSSStyleSheet

Specified by:

getOwnerRule in class AbstractCSSStyleSheet

getOwnerNode

public Node getOwnerNode()

getMedia

public MediaQueryList getMedia()

Description copied from interface: ExtendedCSSStyleSheet

Get the destination media for this sheet.

Returns:

the media query list.

setMedia

protected void setMedia(MediaQueryList media)
                 throws DOMException

Description copied from class: AbstractStyleSheet

Set the destination media for this sheet.

Specified by:

setMedia in class AbstractStyleSheet

Parameters:

media - the destination media.

Throws:

DOMException - if the media is invalid.

getOrigin

public byte getOrigin()

Description copied from class: AbstractCSSStyleSheet

Get the origin of this sheet.

Specified by:

getOrigin in class AbstractCSSStyleSheet

Returns:

the origin of this sheet.

getCssRules

public CSSRuleArrayList getCssRules()

Description copied from interface: ExtendedCSSStyleSheet

Gets the collection of all CSS rules contained within the style sheet.

Specified by:

getCssRules in interface CSSStyleSheet

Specified by:

getCssRules in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

getCssRules in class AbstractCSSStyleSheet

Returns:

the list of all CSS rules contained within the style sheet.

insertRule

public int insertRule(String rule,
 int index)
               throws DOMException

Used to insert a new rule into the style sheet. The new rule now becomes part of the cascade.

Parameters:

rule - The parsable text representing the rule. For rule sets this contains both the selector and the style declaration. For at-rules, this specifies both the at-identifier and the rule content.

index - The index within the style sheet's rule list of the rule before which to insert the specified rule. If the specified index is equal to the length of the style sheet's rule collection, the rule will be added to the end of the style sheet.

Returns:

The index within the style sheet's rule collection of the newly inserted rule.

Throws:

DOMException - HIERARCHY_REQUEST_ERR: Raised if the rule cannot be inserted at the specified index e.g. if an @import rule is inserted after a standard rule set or other at-rule.
INDEX_SIZE_ERR: Raised if the specified index is not a valid insertion point.
NO_MODIFICATION_ALLOWED_ERR: Raised if this style sheet is readonly.
SYNTAX_ERR: Raised if the specified rule has a syntax error and is unparsable.

addRule

public void addRule(AbstractCSSRule cssrule)
             throws DOMException

Inserts a rule in the current insertion point (generally after the last rule).

Parameters:

cssrule - the rule to be inserted.

Throws:

DOMException - NAMESPACE_ERR if the rule could not be added due to a namespace-related error.

registerNamespace

protected void registerNamespace(CSSNamespaceRule nsrule)

Specified by:

registerNamespace in class AbstractCSSStyleSheet

unregisterNamespace

protected void unregisterNamespace(String namespaceURI)

Specified by:

unregisterNamespace in class AbstractCSSStyleSheet

addLocalRule

protected void addLocalRule(CSSRule cssrule)

Inserts a local rule in the current insertion point (generally after the last rule).

Parameters:

cssrule - the rule to be inserted.

deleteRule

public void deleteRule(int index)
                throws DOMException

Deletes a rule from the style sheet.

Parameters:

index - The index within the style sheet's rule list of the rule to remove.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if the specified index does not correspond to a rule in the style sheet's rule list.
NAMESPACE_ERR: Raised if the rule is a namespace rule and this style sheet contains style rules with that namespace.

addStyleSheet

public void addStyleSheet(AbstractCSSStyleSheet sheet)

Adds the rules contained by the supplied style sheet, if that sheet is not disabled.

If the provided sheet does not target all media, a media rule is created.

Specified by:

addStyleSheet in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

addStyleSheet in class AbstractCSSStyleSheet

Parameters:

sheet - the sheet whose rules are to be added.

createCounterStyleRule

public CounterStyleRule createCounterStyleRule(String name)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSCounterStyleRule compatible with this implementation.

Parameters:

name - the counter-style name.

Returns:

a CSSCounterStyleRule object.

createFontFaceRule

public FontFaceRule createFontFaceRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS Font Face rule compatible with this implementation.

Specified by:

createFontFaceRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createFontFaceRule in class AbstractCSSStyleSheet

Returns:

a CSS Font Face rule object.

createFontFeatureValuesRule

public FontFeatureValuesRule createFontFeatureValuesRule(String[] fontFamily)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSFontFeatureValuesRule compatible with this implementation.

Parameters:

fontFamily - the font family.

Returns:

a CSSFontFeatureValuesRule object.

createImportRule

public ImportRule createImportRule(MediaQueryList mediaList,
 String href)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS import rule compatible with this implementation.

Specified by:

createImportRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createImportRule in class AbstractCSSStyleSheet

Parameters:

mediaList - a list of media types for which the new import rule may be used.

href - the URI from which to import the sheet.

Returns:

a CSS import rule.

createKeyframesRule

public KeyframesRule createKeyframesRule(String keyframesName)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSKeyframesRule compatible with this implementation.

Parameters:

keyframesName - the name of the keyframes.

Returns:

a CSSKeyframesRule object.

createMarginRule

public MarginRule createMarginRule(String name)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS margin rule compatible with this implementation.

Parameters:

name - the margin rule name.

Returns:

a CSS margin rule.

createMediaRule

public MediaRule createMediaRule(MediaQueryList mediaList)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS media rule.

Specified by:

createMediaRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createMediaRule in class AbstractCSSStyleSheet

Parameters:

mediaList - a list of media types for the new rule.

Returns:

a CSS media rule.

createNamespaceRule

public NamespaceRule createNamespaceRule(String prefix,
 String namespaceUri)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS namespace rule compatible with this implementation.

Parameters:

prefix - the namespace prefix.

namespaceUri - the namespace URI.

Returns:

a CSS namespace rule.

createPageRule

public PageRule createPageRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS page rule compatible with this implementation.

Specified by:

createPageRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createPageRule in class AbstractCSSStyleSheet

Returns:

a CSS page rule.

createStyleRule

public StyleRule createStyleRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS style rule.

Specified by:

createStyleRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createStyleRule in class AbstractCSSStyleSheet

Returns:

a CSS style rule.

createSupportsRule

public SupportsRule createSupportsRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSSupportsRule compatible with this implementation.

Specified by:

createSupportsRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createSupportsRule in class AbstractCSSStyleSheet

Returns:

a CSSSupportsRule object.

createViewportRule

public ViewportRule createViewportRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSViewportRule compatible with this implementation.

Specified by:

createViewportRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createViewportRule in class AbstractCSSStyleSheet

Returns:

a CSSViewportRule object.

createUnknownRule

public UnknownRule createUnknownRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS unknown rule.

Its contents can be set with CSSRule.setCssText(String). Be careful to set a text that is compatible with a CSS rule, with an ending semicolon or balanced curly brackets, otherwise its serialization may break the style sheet serialization.

Specified by:

createUnknownRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createUnknownRule in class AbstractCSSStyleSheet

Returns:

a CSS unknown rule.

createStyleDeclaration

protected BaseCSSStyleDeclaration createStyleDeclaration(BaseCSSDeclarationRule rule)

Specified by:

createStyleDeclaration in class AbstractCSSStyleSheet

createStyleDeclaration

public BaseCSSStyleDeclaration createStyleDeclaration()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS style declaration compatible with this implementation.

Specified by:

createStyleDeclaration in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

createStyleDeclaration in class AbstractCSSStyleSheet

Returns:

a CSS style declaration.

hasRuleErrorsOrWarnings

public boolean hasRuleErrorsOrWarnings()

Description copied from interface: ExtendedCSSStyleSheet

Check whether this sheet contains rules that have errors or warnings reported to their handlers.

Returns:

true if this sheet contains rules that have errors or warnings.

getErrorHandler

public SheetErrorHandler getErrorHandler()

Description copied from interface: ExtendedCSSStyleSheet

Gets the error handler for this style sheet.

Returns:

the error handler.

getDocumentErrorHandler

protected ErrorHandler getDocumentErrorHandler()

Specified by:

getDocumentErrorHandler in class AbstractStyleSheet

getType

public String getType()

getNamespacePrefix

protected String getNamespacePrefix(String uri)

Gets the namespace prefix associated to the given URI.

Specified by:

getNamespacePrefix in class AbstractCSSStyleSheet

Parameters:

uri - the namespace URI string.

Returns:

the namespace prefix, or null if the URI is not known.

hasDefaultNamespace

protected boolean hasDefaultNamespace()

Has this style sheet defined a default namespace ?

Specified by:

hasDefaultNamespace in class AbstractCSSStyleSheet

Returns:

true if a default namespace was defined, false otherwise.

getDisabled

public boolean getDisabled()

setDisabled

public void setDisabled(boolean disabled)

getParentStyleSheet

public AbstractCSSStyleSheet getParentStyleSheet()

Specified by:

getParentStyleSheet in interface StyleSheet

Specified by:

getParentStyleSheet in class AbstractCSSStyleSheet

setParentStyleSheet

protected void setParentStyleSheet(AbstractCSSStyleSheet parent)

Specified by:

setParentStyleSheet in class AbstractCSSStyleSheet

getHref

public String getHref()

setHref

public void setHref(String href)

Specified by:

setHref in class AbstractCSSStyleSheet

loadStyleSheet

public boolean loadStyleSheet(URL url,
 String referrerPolicy)
                       throws DOMException,
IOException

Load the styles from url into this style sheet.

Specified by:

loadStyleSheet in class AbstractCSSStyleSheet

Parameters:

url - the url to load the style sheet from.

referrerPolicy - the content of the referrerpolicy content attribute, if any, or the empty string.

Returns:

true if the SAC parser reported no errors or fatal errors, false otherwise.

Throws:

DOMException - if there is a serious problem parsing the style sheet.

IOException - if a problem appears fetching the url contents.

getRulesForProperty

public CSSRuleArrayList getRulesForProperty(String longhandPropertyName)

Returns a list of rules that apply to a style where the given longhand property is set (either explicitly or through a shorthand).

Grouping rules are scanned too, regardless of the medium or condition.

Parameters:

longhandPropertyName - the longhand property name.

Returns:

the list of rules, or null if no rules declare that property, or the property is a shorthand.

getSelectorsForProperty

public Selector[] getSelectorsForProperty(String longhandPropertyName)

Returns an array of selectors that apply to a style where the given longhand property is set (either explicitly or through a shorthand).

Grouping rules are scanned too, regardless of the medium or condition.

Parameters:

longhandPropertyName - the longhand property name.

Returns:

the array of selectors, or null if no rules declare that property, or the property is a shorthand.

getSelectorsForPropertyValue

public Selector[] getSelectorsForPropertyValue(String propertyName,
 String declaredValue)

Returns an array of selectors that apply to a style where the given property was explicitly set to the given declared value.

Media rules are scanned too, regardless of the specific medium.

Beware that using this method with computed instead of declared values may not give the expected results.

Parameters:

propertyName - the property name.

declaredValue - the property's declared value.

Returns:

the array of selectors, or null if no rules contain that property-value pair.

getTargetMedium

protected String getTargetMedium()

toMinifiedString

public String toMinifiedString()

Description copied from class: AbstractStyleSheet

Returns a minified parsable representation of the rule list of this sheet.

Specified by:

toMinifiedString in class AbstractStyleSheet

Returns:

a minified parsable representation of the rule list of this sheet.

toString

public String toString()

Overrides:

toString in class Object

toStyleString

public String toStyleString()

Description copied from class: AbstractStyleSheet

Returns a serialization of this style sheet in the form of a STYLE element with its attributes and content.

Specified by:

toStyleString in class AbstractStyleSheet

Returns:

an HTML STYLE element representing this style sheet.

parseStyleSheet

public boolean parseStyleSheet(InputSource source)
                        throws DOMException,
IOException

Parses a style sheet. If the style sheet is not empty, the rules from the parsed source will be added at the end of the rule list, with the same origin as the rule with a highest precedence origin.

To create a sheet, see CSSStyleSheetFactory.createStyleSheet(String,MediaQueryList)

Specified by:

parseStyleSheet in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

parseStyleSheet in class AbstractCSSStyleSheet

Parameters:

source - the SAC input source.

Returns:

true if the SAC parser reported no errors or fatal errors, false otherwise.

Throws:

DOMException - if a problem is found parsing the sheet.

IOException - if a problem is found reading the sheet.

parseStyleSheet

public boolean parseStyleSheet(InputSource source,
 boolean ignoreComments)
                        throws DOMException,
IOException

Parses a style sheet.

If the style sheet is not empty, the rules from the parsed source will be added at the end of the rule list, with the same origin as the rule with a highest precedence origin.

If ignoreComments is false, the comments preceding a rule will be available through AbstractCSSRule.getPrecedingComments().

This method resets the state of this sheet's error handler.

To create a sheet, see CSSStyleSheetFactory.createStyleSheet(String,MediaQueryList)

Specified by:

parseStyleSheet in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

parseStyleSheet in class AbstractCSSStyleSheet

Parameters:

source - the SAC input source.

ignoreComments - true if comments have to be ignored.

Returns:

true if the SAC parser reported no errors or fatal errors, false otherwise.

Throws:

DOMException - if a problem is found parsing the sheet.

IOException - if a problem is found reading the sheet.