com.helger.css.decl

Class CSSMediaRule

java.lang.Object

com.helger.css.decl.CSSMediaRule

All Implemented Interfaces:

ICSSTopLevelRule, ICSSSourceLocationAware, ICSSWriteable, Serializable

@NotThreadSafe
public class CSSMediaRule
extends Object
implements ICSSTopLevelRule, ICSSSourceLocationAware

Represents a single @media rule: a list of style rules only valid for certain media.
Example:
@media print { div#footer { display: none; } }

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CSSMediaRule()

Method Summary

Modifier and Type	Method and Description
CSSMediaRule	addMediaQuery(CSSMediaQuery aMediaQuery)
CSSMediaRule	addMediaQuery(int nIndex, CSSMediaQuery aMediaQuery)
CSSMediaRule	addRule(ICSSTopLevelRule aRule)
CSSMediaRule	addRule(int nIndex, ICSSTopLevelRule aRule)
boolean	equals(Object o)
List<CSSMediaQuery>	getAllMediaQueries()
List<ICSSTopLevelRule>	getAllRules()
String	getAsCSSString(ICSSWriterSettings aSettings, int nIndentLevel) Get the contents of this object as a serialized CSS string for writing to an output.
CSSMediaQuery	getMediaQueryAtIndex(int nMediumIndex)
int	getMediaQueryCount()
ICSSTopLevelRule	getRule(int nRuleIndex)
int	getRuleCount()
CSSSourceLocation	getSourceLocation()
int	hashCode()
boolean	hasMediaQueries()
boolean	hasRules()
com.helger.commons.state.EChange	removeAllMediaQueries() Remove all media queries.
com.helger.commons.state.EChange	removeAllRules() Remove all rules.
com.helger.commons.state.EChange	removeMediaQuery(CSSMediaQuery aMediaQuery)
com.helger.commons.state.EChange	removeMediaQuery(int nMediumIndex)
com.helger.commons.state.EChange	removeRule(ICSSTopLevelRule aRule)
com.helger.commons.state.EChange	removeRule(int nRuleIndex)
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

Constructor Detail

CSSMediaRule

public CSSMediaRule()

Method Detail

hasMediaQueries

public boolean hasMediaQueries()

getMediaQueryCount

@Nonnegative
public int getMediaQueryCount()

addMediaQuery

@Nonnull
public CSSMediaRule addMediaQuery(@Nonnull @Nonempty
                                            CSSMediaQuery aMediaQuery)

addMediaQuery

@Nonnull
public CSSMediaRule addMediaQuery(@Nonnegative
                                            int nIndex,
                                            @Nonnull @Nonempty
                                            CSSMediaQuery aMediaQuery)

removeMediaQuery

@Nonnull
public com.helger.commons.state.EChange removeMediaQuery(@Nonnull
                                                                   CSSMediaQuery aMediaQuery)

removeMediaQuery

@Nonnull
public com.helger.commons.state.EChange removeMediaQuery(@Nonnegative
                                                                   int nMediumIndex)

removeAllMediaQueries

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

Remove all media queries.

Returns:

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

Since:

3.7.3

getMediaQueryAtIndex

@Nullable
public CSSMediaQuery getMediaQueryAtIndex(@Nonnegative
                                                     int nMediumIndex)

getAllMediaQueries

@Nonnull
 @ReturnsMutableCopy
public List<CSSMediaQuery> getAllMediaQueries()

hasRules

public boolean hasRules()

getRuleCount

@Nonnegative
public int getRuleCount()

addRule

@Nonnull
public CSSMediaRule addRule(@Nonnull
                                      ICSSTopLevelRule aRule)

addRule

@Nonnull
public CSSMediaRule addRule(@Nonnegative
                                      int nIndex,
                                      @Nonnull
                                      ICSSTopLevelRule aRule)

removeRule

@Nonnull
public com.helger.commons.state.EChange removeRule(@Nonnull
                                                             ICSSTopLevelRule aRule)

removeRule

@Nonnull
public com.helger.commons.state.EChange removeRule(@Nonnegative
                                                             int nRuleIndex)

removeAllRules

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

Remove all rules.

Returns:

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

Since:

3.7.3

getRule

@Nullable
public ICSSTopLevelRule getRule(@Nonnegative
                                           int nRuleIndex)

getAllRules

@Nonnull
 @ReturnsMutableCopy
public List<ICSSTopLevelRule> getAllRules()

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.

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