com.github.ilyes4j.gwt.mdl.components

Class CssSwitcher<T extends Enum<T>>

java.lang.Object

com.github.ilyes4j.gwt.mdl.components.CssSwitcher<T>

Type Parameters:

T - the Enumeration type to manage by the switcher

Direct Known Subclasses:

ButtonColorSwitcher, ButtonTypeSwitcher, FloatSwitcher, InputCheckSwitcher, InputFlipSwitcher, InputRadioSwitcher, LabelCheckSwitcher, LabelFlipSwitcher, LabelRadioSwitcher, MainCheckSwitcher, MainRadioSwitcher, MenuAnchorSwitcher, RippleSwitcher, TooltipPositionSwitcher, TooltipStyleSwitcher

public abstract class CssSwitcher<T extends Enum<T>>
extends Object

A switcher have two major purposes :

1. Remove the boiler plate code from CSS enumerators.

   The switcher defines the CSS class that corresponds to each enumeration constant which avoid polluting the enumeration with the same boilerplate code for storing and accessing the corresponding CSS class.

2. Manage switching between CSS classes inside components.

Inside the component, the switcher manages the switching between the CSS classes. The switcher is responsible for applying the appropriate CSS class and then removing the previously set CSS class when a new class is applied.

How to use the switcher

1. Define a sub-type that appoint the enumeration to be handled
2. Knowing the enumeration to be managed enables the sub-type to define a static Map member to hold the mapping between the enumeration constants and the CSS class related to the enumerations.
3. The sub-type defines an implementation of getMappings() that returns the mappings stored in the static member defined earlier. The mappings can be defined in a static block or during the first invocation of the method. But either way, there should always be a single copy of the mappings to optimize memory consumption.

Author:

Mohamed Ilyes DIMASSI

Constructor Summary

Constructors

Constructor and Description
CssSwitcher()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Map<T,String>	getMappings() The mapping is defined in sub-types to enable the switcher to pick the appropriate CSS class for a given enumeration option.
com.google.gwt.dom.client.Element	getTarget()
T	getValue()
void	setTarget(com.google.gwt.dom.client.Element inputTarget) The element managed by the CSS switcher.
void	setValue(T inputValue)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CssSwitcher

public CssSwitcher()

Method Detail

setTarget

public final void setTarget(com.google.gwt.dom.client.Element inputTarget)

The element managed by the CSS switcher.

Parameters:

inputTarget - the DOM element managed by the CSS switcher

getTarget

public final com.google.gwt.dom.client.Element getTarget()

Returns:

the DOM element managed by the CSS switcher

setValue

public final void setValue(T inputValue)

Parameters:

inputValue - the enumeration option to be set

getValue

public final T getValue()

Returns:

the stored enumeration option

toString

public final String toString()

Overrides:

toString in class Object

Returns:

the CSS class associated to the current enumeration option

getMappings

protected abstract Map<T,String> getMappings()

The mapping is defined in sub-types to enable the switcher to pick the appropriate CSS class for a given enumeration option.

Returns:

the association between an Enum constant and the corresponding CSS class literal