Module io.sf.carte.css4j

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

Class KeyframesRule

java.lang.Object

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

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

All Implemented Interfaces:

CSSKeyframesRule, ExtendedCSSRule, CSSRule

public class KeyframesRule
extends AbstractCSSRule
implements CSSKeyframesRule

Implementation of CSSKeyframesRule.

Field Summary

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

CHARSET_RULE, FONT_FACE_RULE, IMPORT_RULE, MEDIA_RULE, PAGE_RULE, STYLE_RULE, UNKNOWN_RULE

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

COUNTER_STYLE_RULE, CUSTOM_MEDIA_RULE, DOCUMENT_RULE, FONT_FEATURE_VALUES_RULE, KEYFRAME_RULE, KEYFRAMES_RULE, MARGIN_RULE, NAMESPACE_RULE, REGION_STYLE_RULE, SUPPORTS_RULE, VIEWPORT_RULE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyframesRule(AbstractCSSStyleSheet parentSheet, byte origin)

Method Summary

Modifier and Type	Method	Description
void	appendRule(String rule)	Appends a new rule into this keyframes rule collection.
KeyframesRule	clone(AbstractCSSStyleSheet parentSheet)	Obtain a clone of this rule whose parent sheet is parentSheet.
protected Parser	createSACParser()
void	deleteRule(String select)	Deletes the last declared CSSKeyframeRule matching the specified keyframe selector from this keyframes rule collection.
void	enablePrecedingComments(int initialSize)	If this rule does not contain a preceding comment list, create one with the given initial capacity.
boolean	equals(Object obj)
CSSKeyframeRule	findRule(String select)	The findRule returns the last declared CSSKeyframeRule matching the specified keyframe selector.
CSSRuleArrayList	getCssRules()	Gets the list of keyframe rules.
String	getCssText()
String	getMinifiedCssText()	A minified parsable textual representation of the rule.
String	getName()	Gets the name of the keyframes.
byte	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.
List<String>	getPrecedingComments()	Get a list of the comments that preceded this rule, if any.
protected StyleFormattingContext	getStyleFormattingContext()
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()
void	setCssText(String cssText)
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.AbstractCSSRule

toString

Methods inherited from class java.lang.Object

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

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

getType

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

getParentRule, getParentStyleSheet

Constructor Details

KeyframesRule

protected KeyframesRule(AbstractCSSStyleSheet parentSheet,
 byte origin)

Method Details

getName

public String getName()

Description copied from interface: CSSKeyframesRule

Gets the name of the keyframes.

Specified by:

getName in interface CSSKeyframesRule

Returns:

the name of the keyframes.

getCssRules

public CSSRuleArrayList getCssRules()

Description copied from interface: CSSKeyframesRule

Gets the list of keyframe rules.

Specified by:

getCssRules in interface CSSKeyframesRule

Returns:

the list of keyframe rules.

appendRule

public void appendRule(String rule)
                throws DOMException

Appends a new rule into this keyframes rule collection.

According to the specification this method does not throw exceptions, but for this library's use cases it seems reasonable to check for syntax errors.

Specified by:

appendRule in interface CSSKeyframesRule

Parameters:

rule - The parsable text representing the rule.

Throws:

DOMException - if there was a problem parsing the rule.

deleteRule

public void deleteRule(String select)

Description copied from interface: CSSKeyframesRule

Deletes the last declared CSSKeyframeRule matching the specified keyframe selector from this keyframes rule collection. If no matching rule exists, the method does nothing.

The number and order of the values in the specified keyframe selector must match those of the targeted keyframe rule(s). The match is not sensitive to white space around the values in the list.

Specified by:

deleteRule in interface CSSKeyframesRule

Parameters:

select - The keyframe selector of the rule to be deleted: a comma-separated list of keywords or percentage values between 0% and 100%.

findRule

public CSSKeyframeRule findRule(String select)
                         throws DOMException

Description copied from interface: CSSKeyframesRule

The findRule returns the last declared CSSKeyframeRule matching the specified keyframe selector. If no matching rule exists, the method does nothing.

Specified by:

findRule in interface CSSKeyframesRule

Parameters:

select - The keyframe selector of the rule to be deleted: a comma-separated list of keywords or percentage values between 0% and 100%.

Returns:

the found rule, or null if no rule was found.

Throws:

DOMException

getCssText

public String getCssText()

Specified by:

getCssText in interface CSSRule

Specified by:

getCssText in class AbstractCSSRule

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 ExtendedCSSRule

Returns:

the minified textual representation of the rule.

writeCssText

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

Description copied from interface: ExtendedCSSRule

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

Specified by:

writeCssText in interface ExtendedCSSRule

Specified by:

writeCssText in class AbstractCSSRule

Parameters:

wri - the simple writer object.

context - the formatting context.

Throws:

IOException - if an error happened while writing.

setCssText

public void setCssText(String cssText)
                throws DOMException

Specified by:

setCssText in interface CSSRule

Overrides:

setCssText in class AbstractCSSRule

Throws:

DOMException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public KeyframesRule clone(AbstractCSSStyleSheet parentSheet)

Description copied from class: AbstractCSSRule

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

Specified by:

clone in interface ExtendedCSSRule

Specified by:

clone in class AbstractCSSRule

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: ExtendedCSSRule

Get the style sheet that contains this rule.

Specified by:

getParentStyleSheet in interface CSSRule

Specified by:

getParentStyleSheet in interface ExtendedCSSRule

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: ExtendedCSSRule

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 ExtendedCSSRule

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 byte 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(int initialSize)

Description copied from class: AbstractCSSRule

If this rule does not contain a preceding comment list, create one with the given initial capacity.

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

Specified by:

enablePrecedingComments in class AbstractCSSRule

Parameters:

initialSize - the initial capacity.

getPrecedingComments

public List<String> getPrecedingComments()

Description copied from class: AbstractCSSRule

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

Specified by:

getPrecedingComments in class AbstractCSSRule

Returns:

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

See Also:

• AbstractCSSStyleSheet.parseStyleSheet(org.w3c.css.sac.InputSource, boolean)

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 uri was wrong.