Module io.sf.carte.css4j

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

Class PropertyRule

java.lang.Object

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

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

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

All Implemented Interfaces:

CSSDeclarationRule, CSSPropertyDefinition, CSSPropertyRule, CSSRule, Serializable, CSSRule

public class PropertyRule
extends BaseCSSDeclarationRule
implements CSSPropertyRule

CSS @property rule implementation.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface io.sf.carte.doc.style.css.CSSRule

COUNTER_STYLE_RULE, CUSTOM_MEDIA_RULE, DOCUMENT_RULE, FONT_FACE_RULE, FONT_FEATURE_VALUES_RULE, IMPORT_RULE, KEYFRAME_RULE, KEYFRAMES_RULE, MARGIN_RULE, MEDIA_RULE, NAMESPACE_RULE, NESTED_DECLARATIONS, PAGE_RULE, PROPERTY_RULE, REGION_STYLE_RULE, STYLE_RULE, SUPPORTS_RULE, UNKNOWN_RULE, VIEWPORT_RULE

Fields inherited from interface org.w3c.dom.css.CSSRule

CHARSET_RULE

Constructor Summary

Constructors

Constructor	Description
PropertyRule(AbstractCSSStyleSheet parentSheet, int origin)

Method Summary

Modifier and Type	Method	Description
PropertyRule	clone(AbstractCSSStyleSheet parentSheet)	Obtain a clone of this rule whose parent sheet is parentSheet.
protected Parser	createSACParser()
void	enablePrecedingComments()	If this rule does not contain a preceding comment list, create one.
void	enableTrailingComments()	If this rule does not contain a trailing comment list, create one.
boolean	equals(Object obj)
String	getCssText()
LexicalUnit	getInitialValue()	The initial value associated with the @property rule.
String	getMinifiedCssText()	A minified parsable textual representation of the rule.
String	getName()	Gets the (unescaped) custom property name.
int	getOrigin()	Get the origin of this rule (user agent sheet, author, user).
AbstractCSSRule	getParentRule()	If this rule is contained inside another rule, return that rule.
AbstractCSSStyleSheet	getParentStyleSheet()	Get the style sheet that contains this rule.
StringList	getPrecedingComments()	Get a list of the comments that preceded this rule, if any.
protected StyleFormattingContext	getStyleFormattingContext()
CSSValueSyntax	getSyntax()	The syntax associated with the @property rule.
StringList	getTrailingComments()	Get a list of the comments that immediately follow this rule, if any.
short	getType()
protected URL	getURL(String uri)	Gets an URL for the given URI, taking into account the parent CSS Base URL if appropriate.
int	hashCode()
boolean	inherits()	Whether the property inherits or not.
void	setParentRule(AbstractCSSRule parent)	Sets the parent CSS rule, in case this rule is contained by another.
void	writeCssText(SimpleWriter wri, StyleFormattingContext context)	Write a serialization of this rule to the given simple writer, according to the given context.

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

getStyle, getStyleDeclarationErrorHandler, setStyleDeclarationErrorHandler

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

clone, setCssText, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getParentRule, getParentStyleSheet, getPrecedingComments, getTrailingComments, setCssText

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

getType

Constructor Details

PropertyRule

public PropertyRule(AbstractCSSStyleSheet parentSheet,
 int origin)

Method Details

getName

public String getName()

Gets the (unescaped) custom property name.

Specified by:

getName in interface CSSPropertyDefinition

Specified by:

getName in interface CSSPropertyRule

Returns:

the custom property name.

inherits

public boolean inherits()

Description copied from interface: CSSPropertyRule

Whether the property inherits or not.

Specified by:

inherits in interface CSSPropertyDefinition

Specified by:

inherits in interface CSSPropertyRule

Returns:

true if the property inherits.

getInitialValue

public LexicalUnit getInitialValue()

Description copied from interface: CSSPropertyRule

The initial value associated with the @property rule.

Specified by:

getInitialValue in interface CSSPropertyDefinition

Specified by:

getInitialValue in interface CSSPropertyRule

Returns:

the initial value, or null if none was specified.

getSyntax

public CSSValueSyntax getSyntax()

Description copied from interface: CSSPropertyRule

The syntax associated with the @property rule.

Specified by:

getSyntax in interface CSSPropertyDefinition

Specified by:

getSyntax in interface CSSPropertyRule

Returns:

the syntax, or null if invalid.

getCssText

public String getCssText()

Specified by:

getCssText in interface CSSRule

Overrides:

getCssText in class BaseCSSDeclarationRule

getMinifiedCssText

public String getMinifiedCssText()

Description copied from class: AbstractCSSRule

A minified parsable textual representation of the rule. This reflects the current state of the rule and not its initial value.

Specified by:

getMinifiedCssText in interface CSSRule

Overrides:

getMinifiedCssText in class BaseCSSDeclarationRule

Returns:

the minified textual representation of the rule.

writeCssText

public void writeCssText(SimpleWriter wri,
 StyleFormattingContext context)
                  throws IOException

Description copied from interface: CSSRule

Write a serialization of this rule to the given simple writer, according to the given context.

Specified by:

writeCssText in interface CSSRule

Overrides:

writeCssText in class BaseCSSDeclarationRule

Parameters:

wri - the simple writer object.

context - the formatting context.

Throws:

IOException - if an error happened while writing.

hashCode

public int hashCode()

Overrides:

hashCode in class BaseCSSDeclarationRule

equals

public boolean equals(Object obj)

Overrides:

equals in class BaseCSSDeclarationRule

clone

public PropertyRule clone(AbstractCSSStyleSheet parentSheet)

Description copied from class: AbstractCSSRule

Obtain a clone of this rule whose parent sheet is parentSheet.

Overrides:

clone in class BaseCSSDeclarationRule

Parameters:

parentSheet - the parent sheet for the new rule.

Returns:

a clone of this rule with the given parent sheet.

getType

public short getType()

Specified by:

getType in interface CSSRule

Specified by:

getType in class AbstractCSSRule

getParentStyleSheet

public AbstractCSSStyleSheet getParentStyleSheet()

Description copied from interface: CSSRule

Get the style sheet that contains this rule.

Specified by:

getParentStyleSheet in interface CSSRule

Specified by:

getParentStyleSheet in interface CSSRule

Specified by:

getParentStyleSheet in class AbstractCSSRule

Returns:

the style sheet, or null if no sheet contains this rule.

createSACParser

protected Parser createSACParser()
                          throws DOMException

Throws:

DOMException

getParentRule

public AbstractCSSRule getParentRule()

Description copied from interface: CSSRule

If this rule is contained inside another rule, return that rule. If it is not nested inside any other rules, return null.

Specified by:

getParentRule in interface CSSRule

Specified by:

getParentRule in interface CSSRule

Specified by:

getParentRule in class AbstractCSSRule

Returns:

the containing rule, if any, otherwise null.

setParentRule

public void setParentRule(AbstractCSSRule parent)

Sets the parent CSS rule, in case this rule is contained by another.

Specified by:

setParentRule in class AbstractCSSRule

Parameters:

parent - the parent rule.

getOrigin

public int getOrigin()

Description copied from class: AbstractCSSRule

Get the origin of this rule (user agent sheet, author, user).

Specified by:

getOrigin in class AbstractCSSRule

Returns:

the origin of this rule.

enablePrecedingComments

public void enablePrecedingComments()

Description copied from class: AbstractCSSRule

If this rule does not contain a preceding comment list, create one.

If this rule already has a preceding comment list, does nothing.

Specified by:

enablePrecedingComments in class AbstractCSSRule

getPrecedingComments

public StringList getPrecedingComments()

Description copied from interface: CSSRule

Get a list of the comments that preceded this rule, if any.

Returns:

the list of comments, or null if there were no preceding comments or the parsing was specified to ignore comments.

See Also:

• CSSStyleSheet.parseStyleSheet(java.io.Reader, short)

enableTrailingComments

public void enableTrailingComments()

Description copied from class: AbstractCSSRule

If this rule does not contain a trailing comment list, create one.

If this rule already has a trailing comment list, does nothing.

Specified by:

enableTrailingComments in class AbstractCSSRule

getTrailingComments

public StringList getTrailingComments()

Description copied from interface: CSSRule

Get a list of the comments that immediately follow this rule, if any.

If the parsing mode was COMMENTS_PRECEDING, or was COMMENTS_AUTO and the next comment happens after a newline character, it shall be assigned to the next rule as a preceding comment.

Returns:

the list of comments, or null if there were no trailing comments or the parsing was specified to ignore comments.

See Also:

• CSSStyleSheet.parseStyleSheet(java.io.Reader, short)

getStyleFormattingContext

protected StyleFormattingContext getStyleFormattingContext()

getURL

protected URL getURL(String uri)
              throws MalformedURLException

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

Parameters:

uri - the uri.

Returns:

the absolute URL.

Throws:

MalformedURLException - if the URL could not be built.