Module io.sf.carte.css4j

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

Class AbstractCSSStyleSheet

java.lang.Object

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

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

All Implemented Interfaces:

ExtendedCSSStyleSheet<AbstractCSSRule>, Cloneable, CSSStyleSheet, StyleSheet

Direct Known Subclasses:

BaseCSSStyleSheet

public abstract class AbstractCSSStyleSheet
extends AbstractStyleSheet
implements ExtendedCSSStyleSheet<AbstractCSSRule>

Abstract class to be inherited by all CSS style sheets.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCSSStyleSheet(String title)

Method Summary

Modifier and Type	Method	Description
abstract void	addStyleSheet(AbstractCSSStyleSheet sheet)	Adds the rules contained by the supplied style sheet, if that sheet is not disabled.
abstract AbstractCSSStyleSheet	clone()	Clone this style sheet.
abstract FontFaceRule	createFontFaceRule()	Create a CSS Font Face rule compatible with this implementation.
abstract ImportRule	createImportRule(MediaQueryList mediaList, String href)	Create a CSS import rule compatible with this implementation.
abstract MediaRule	createMediaRule(MediaQueryList mediaList)	Create a CSS media rule.
abstract PageRule	createPageRule()	Create a CSS page rule compatible with this implementation.
abstract AbstractCSSStyleDeclaration	createStyleDeclaration()	Create a CSS style declaration compatible with this implementation.
protected abstract AbstractCSSStyleDeclaration	createStyleDeclaration(BaseCSSDeclarationRule rule)
abstract CSSStyleDeclarationRule	createStyleRule()	Create a CSS style rule.
abstract SupportsRule	createSupportsRule()	Create a CSSSupportsRule compatible with this implementation.
abstract UnknownRule	createUnknownRule()	Create a CSS unknown rule.
abstract ViewportRule	createViewportRule()	Create a CSSViewportRule compatible with this implementation.
abstract CSSRuleArrayList	getCssRules()	Gets the collection of all CSS rules contained within the style sheet.
protected abstract String	getNamespacePrefix(String uri)	Gets the namespace prefix associated to the given URI.
abstract byte	getOrigin()	Get the origin of this sheet.
abstract AbstractCSSRule	getOwnerRule()
abstract AbstractCSSStyleSheet	getParentStyleSheet()
abstract AbstractCSSStyleSheetFactory	getStyleSheetFactory()	Get the style sheet factory used to produce this sheet.
protected abstract boolean	hasDefaultNamespace()	Has this style sheet defined a default namespace ?
abstract boolean	loadStyleSheet(URL url, String referrerPolicy)	Load the styles from url into this style sheet.
URLConnection	openConnection(URL url, String referrerPolicy)	Open a non-interactive connection to the given URL.
static byte	parseRelAttribute(String relText)	Parses the rel attribute.
abstract boolean	parseStyleSheet(InputSource source)	Parses a style sheet.
abstract boolean	parseStyleSheet(InputSource source, boolean ignoreComments)	Parses a style sheet.
protected abstract void	registerNamespace(CSSNamespaceRule nsrule)
abstract void	setHref(String href)
protected abstract void	setParentStyleSheet(AbstractCSSStyleSheet parent)
protected abstract void	unregisterNamespace(String namespaceURI)

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

getDocumentErrorHandler, getTitle, setMedia, setTitle, toMinifiedString, toStyleString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.css.CSSStyleSheet

deleteRule, insertRule

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

addRule, createCounterStyleRule, createFontFeatureValuesRule, createKeyframesRule, createMarginRule, createNamespaceRule, getErrorHandler, getMedia, getRulesForProperty, getSelectorsForProperty, hasRuleErrorsOrWarnings

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

getDisabled, getHref, getOwnerNode, getTitle, getType, setDisabled

Constructor Details

AbstractCSSStyleSheet

protected AbstractCSSStyleSheet(String title)

Method Details

getCssRules

public abstract 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>

Returns:

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

getParentStyleSheet

public abstract AbstractCSSStyleSheet getParentStyleSheet()

Specified by:

getParentStyleSheet in interface StyleSheet

getOwnerRule

public abstract AbstractCSSRule getOwnerRule()

Specified by:

getOwnerRule in interface CSSStyleSheet

getStyleSheetFactory

public abstract AbstractCSSStyleSheetFactory getStyleSheetFactory()

Description copied from interface: ExtendedCSSStyleSheet

Get the style sheet factory used to produce this sheet.

Specified by:

getStyleSheetFactory in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

the style sheet factory.

parseStyleSheet

public abstract 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.

Even if a specific media is set at the InputSource, this method does not alter the sheet's current media attribute.

The comments preceding a rule will be available through AbstractCSSRule.getPrecedingComments().

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

Specified by:

parseStyleSheet in interface ExtendedCSSStyleSheet<AbstractCSSRule>

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 abstract 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.

Even if a specific media is set at the InputSource, this method does not alter the sheet's current media attribute.

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>

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.

addStyleSheet

public abstract 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>

Parameters:

sheet - the sheet whose rules are to be added.

loadStyleSheet

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

Load the styles from url into this style sheet.

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.

createFontFaceRule

public abstract FontFaceRule createFontFaceRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS Font Face rule compatible with this implementation.

Specified by:

createFontFaceRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

a CSS Font Face rule object.

createImportRule

public abstract 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>

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.

createMediaRule

public abstract MediaRule createMediaRule(MediaQueryList mediaList)

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS media rule.

Specified by:

createMediaRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Parameters:

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

Returns:

a CSS media rule.

createPageRule

public abstract PageRule createPageRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS page rule compatible with this implementation.

Specified by:

createPageRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

a CSS page rule.

createStyleRule

public abstract CSSStyleDeclarationRule createStyleRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS style rule.

Specified by:

createStyleRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

a CSS style rule.

createSupportsRule

public abstract SupportsRule createSupportsRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSSupportsRule compatible with this implementation.

Specified by:

createSupportsRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

a CSSSupportsRule object.

createUnknownRule

public abstract 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>

Returns:

a CSS unknown rule.

createViewportRule

public abstract ViewportRule createViewportRule()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSSViewportRule compatible with this implementation.

Specified by:

createViewportRule in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

a CSSViewportRule object.

createStyleDeclaration

public abstract AbstractCSSStyleDeclaration createStyleDeclaration()

Description copied from interface: ExtendedCSSStyleSheet

Create a CSS style declaration compatible with this implementation.

Specified by:

createStyleDeclaration in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Returns:

a CSS style declaration.

createStyleDeclaration

protected abstract AbstractCSSStyleDeclaration createStyleDeclaration(BaseCSSDeclarationRule rule)

registerNamespace

protected abstract void registerNamespace(CSSNamespaceRule nsrule)

unregisterNamespace

protected abstract void unregisterNamespace(String namespaceURI)

getNamespacePrefix

protected abstract String getNamespacePrefix(String uri)

Gets the namespace prefix associated to the given URI.

Parameters:

uri - the namespace URI string.

Returns:

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

hasDefaultNamespace

protected abstract boolean hasDefaultNamespace()

Has this style sheet defined a default namespace ?

Returns:

true if a default namespace was defined, false otherwise.

setHref

public abstract void setHref(String href)

getOrigin

public abstract byte getOrigin()

Get the origin of this sheet.

Returns:

the origin of this sheet.

clone

public abstract AbstractCSSStyleSheet clone()

Clone this style sheet.

Specified by:

clone in interface ExtendedCSSStyleSheet<AbstractCSSRule>

Specified by:

clone in class AbstractStyleSheet

Returns:

the cloned style sheet.

openConnection

public URLConnection openConnection(URL url,
 String referrerPolicy)
                             throws IOException

Description copied from class: AbstractStyleSheet

Open a non-interactive connection to the given URL.

If this sheet was obtained through a network connection, the returned connection should be opened by the same user agent (and appropriate credentials) that retrieved this sheet.

Specified by:

openConnection in class AbstractStyleSheet

Parameters:

url - the URL to connect to.

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

Returns:

the network connection.

Throws:

IOException - if an I/O problem occurs opening the connection.

setParentStyleSheet

protected abstract void setParentStyleSheet(AbstractCSSStyleSheet parent)

parseRelAttribute

public static byte parseRelAttribute(String relText)

Parses the rel attribute.

Parameters:

relText - the rel attribute.

Returns:

0 if rel refers to a style sheet, 1 if the sheet is alternate, -1 if it is not compatible with a style sheet.