com.helger.css.decl

Class CSSKeyframesRule

java.lang.Object

com.helger.css.decl.CSSKeyframesRule

All Implemented Interfaces:

ICSSTopLevelRule, ICSSSourceLocationAware, ICSSVersionAware, ICSSWriteable, Serializable

@NotThreadSafe
public class CSSKeyframesRule
extends Object
implements ICSSTopLevelRule, ICSSVersionAware, ICSSSourceLocationAware

Represents a single @keyframes rule.
Example:
@keyframes identifier { 0% { top: 0; left: 0; } 30% { top: 50px; } }

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CSSKeyframesRule(String sDeclaration, String sAnimationName)

Method Summary

Modifier and Type	Method and Description
CSSKeyframesRule	addBlock(CSSKeyframesBlock aKeyframesBlock)
CSSKeyframesRule	addBlock(int nIndex, CSSKeyframesBlock aKeyframesBlock)
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<CSSKeyframesBlock>	getAllBlocks()
String	getAnimationName()
String	getAsCSSString(ICSSWriterSettings aSettings, int nIndentLevel) Get the contents of this object as a serialized CSS string for writing to an output.
CSSKeyframesBlock	getBlockAtIndex(int nBlockIndex)
int	getBlockCount()
String	getDeclaration()
ECSSVersion	getMinimumCSSVersion()
CSSSourceLocation	getSourceLocation()
boolean	hasBlocks()
int	hashCode()
static boolean	isValidDeclaration(String sDeclaration)
com.helger.commons.state.EChange	removeAllBlocks() Remove all blocks.
com.helger.commons.state.EChange	removeBlock(CSSKeyframesBlock aKeyframesBlock)
com.helger.commons.state.EChange	removeBlock(int nBlockIndex)
void	setSourceLocation(CSSSourceLocation aSourceLocation) Set the source location of the object, determined while parsing.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.css.ICSSWriteable

getAsCSSString, getAsCSSString

Constructor Detail

CSSKeyframesRule

public CSSKeyframesRule(@Nonnull @Nonempty
                        String sDeclaration,
                        @Nonnull @Nonempty
                        String sAnimationName)

Method Detail

isValidDeclaration

public static boolean isValidDeclaration(@Nonnull @Nonempty
                                         String sDeclaration)

getDeclaration

@Nonnull
 @Nonempty
public String getDeclaration()

Returns:

The rule declaration string used in the CSS. Neither null nor empty. Always starting with @ and ending with keyframes.

getAnimationName

@Nonnull
 @Nonempty
public String getAnimationName()

hasBlocks

public boolean hasBlocks()

getBlockCount

@Nonnegative
public int getBlockCount()

addBlock

@Nonnull
public CSSKeyframesRule addBlock(@Nonnull
                                           CSSKeyframesBlock aKeyframesBlock)

addBlock

@Nonnull
public CSSKeyframesRule addBlock(@Nonnegative
                                           int nIndex,
                                           @Nonnull
                                           CSSKeyframesBlock aKeyframesBlock)

removeBlock

@Nonnull
public com.helger.commons.state.EChange removeBlock(@Nonnull
                                                              CSSKeyframesBlock aKeyframesBlock)

removeBlock

@Nonnull
public com.helger.commons.state.EChange removeBlock(@Nonnegative
                                                              int nBlockIndex)

removeAllBlocks

@Nonnull
public com.helger.commons.state.EChange removeAllBlocks()

Remove all blocks.

Returns:

EChange.CHANGED if any block was removed, EChange.UNCHANGED otherwise. Never null.

Since:

3.7.3

getBlockAtIndex

@Nullable
public CSSKeyframesBlock getBlockAtIndex(@Nonnegative
                                                    int nBlockIndex)

getAllBlocks

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<CSSKeyframesBlock> getAllBlocks()

getAsCSSString

@Nonnull
 @Nonempty
public String getAsCSSString(@Nonnull
                                                   ICSSWriterSettings aSettings,
                                                   @Nonnegative
                                                   int nIndentLevel)

Description copied from interface: ICSSWriteable

Get the contents of this object as a serialized CSS string for writing to an output.

Specified by:

getAsCSSString in interface ICSSWriteable

Parameters:

aSettings - The settings to be used to format the output. May not be null.

nIndentLevel - The current indentation level

Returns:

The content of this object as CSS string. Never null.

getMinimumCSSVersion

@Nonnull
public ECSSVersion getMinimumCSSVersion()

Specified by:

getMinimumCSSVersion in interface ICSSVersionAware

Returns:

The minimum CSS version that is required to read or write this artifact. May not be null.

setSourceLocation

public void setSourceLocation(@Nullable
                              CSSSourceLocation aSourceLocation)

Description copied from interface: ICSSSourceLocationAware

Set the source location of the object, determined while parsing.

Specified by:

setSourceLocation in interface ICSSSourceLocationAware

Parameters:

aSourceLocation - The source location to use. May be null.

getSourceLocation

@Nullable
public CSSSourceLocation getSourceLocation()

Specified by:

getSourceLocation in interface ICSSSourceLocationAware

Returns:

The source location of this object when it was read by the parser. May be null if an object was not read but manually created.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object