org.fujion.ancillary

Class CssClasses

java.lang.Object

org.fujion.ancillary.CssClasses

public class CssClasses
extends Object

Manages CSS classes for a component. There are two semantic extensions to CSS class names:

1. A "-" character preceding a class name indicates that it is to be removed.
2. A group name may precede a class name, separated by a ":" character. When a class with a group name is added, any previous class associated with that group will be removed. A group name with no following class name simply removes the class currently associated with that group. This facilitates managing classes that are mutually exclusive.

Constructor Summary

Constructors

Constructor and Description
CssClasses()

Method Summary

Modifier and Type	Method and Description
boolean	add(String... values) Adds multiple class names.
boolean	hasChanged() Returns true if the state has changed since last being reset.
boolean	isEmpty() Returns true if no classes are present.
CssClasses	parse(String value) Parses a space-delimited list of class names.
boolean	remove(String... values) Removes multiple class names.
boolean	toggle(String yesValue, String noValue, boolean condition) Toggles the presence of two mutually exclusive classes based on a condition.
String	toString()
String	toString(boolean clearChanged) Returns a space-delimited list of classes.

Methods inherited from class java.lang.Object

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

Constructor Detail

CssClasses

public CssClasses()

Method Detail

parse

public CssClasses parse(String value)

Parses a space-delimited list of class names. Any existing classes and groups are removed.

Parameters:

value - Space-delimited list of class names.

Returns:

Returns this instance for chaining.

add

public boolean add(String... values)

Adds multiple class names.

Parameters:

values - Class names to be added.

Returns:

True if the state changed as a result of the operation.

remove

public boolean remove(String... values)

Removes multiple class names.

Parameters:

values - Class names to be removed.

Returns:

True if the state changed as a result of the operation.

toggle

public boolean toggle(String yesValue,
                      String noValue,
                      boolean condition)

Toggles the presence of two mutually exclusive classes based on a condition.

Parameters:

yesValue - Classes to be added if the condition is true, or removed if false.

noValue - Classes to be added if the condition is false, or removed if true.

condition - The condition value.

Returns:

True if the state changed as a result of the operation.

hasChanged

public boolean hasChanged()

Returns true if the state has changed since last being reset.

Returns:

True if the state has changed.

isEmpty

public boolean isEmpty()

Returns true if no classes are present.

Returns:

True if no classes are present.

toString

public String toString(boolean clearChanged)

Returns a space-delimited list of classes.

Parameters:

clearChanged - If true, clear the changed flag.

Returns:

A space-delimited list of classes.

toString

public String toString()

Overrides:

toString in class Object