com.github.ilyes4j.gwt.mdl.components.toggles

Class ToggleStyleOperator<T extends Enum<T>>

java.lang.Object

com.github.ilyes4j.gwt.mdl.components.toggles.ToggleStyleOperator<T>

Type Parameters:

T - the face options to choose from

All Implemented Interfaces:

IUpgrade, HasRipple, IToggleFace<T>

Direct Known Subclasses:

CheckBoxStyleOperator, FlipStyleOperator, RadioStyleOperator

public abstract class ToggleStyleOperator<T extends Enum<T>>
extends Object
implements HasRipple, IToggleFace<T>, IUpgrade

This class encapsulates the material side of toggle-based components. It only handles the material design styling of the toggle. Unfortunately, the standard GWT CheckBox internal structure is not flexible enough to accept the material styling. To build a fully functional material toggle, a Widget component must be implemented that provides the same features found in CheckBox while being structurally ready to support the material design. This widget would be responsible for building the DOM structure and wiring the events while ToggleStyleOperator adds the material look and feel by applying the appropriate CSS classes and behaviors to that component.

To easily switch between faces. ToggleStyleOperator is a generic class using an enumeration as a parameter. The parameter represents the face options that the toggle can choose from.

Under the hood, a set of CssSwitchers manages the switching between faces. Each CssSwitcher is responsible for the state of an element in the toggle. When the user sets a face for the toggle, the call is delegated to setFace(Enum) which in itself calls the CssSwitcher.setValue(Enum) for each part of the toggle.

Author:

Mohamed Ilyes DIMASSI

Constructor Summary

Constructors

Constructor and Description
ToggleStyleOperator(CssSwitcher<T> switchCtnr, CssSwitcher<T> switchInput, CssSwitcher<T> switchlabel) Make an instance of the style operator by providing the CssSwitcher set to be used to manage the CSS of the component.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract T	defaultFlavor() The sub-type must indicate the default class pack (= face) to enable the component to be initialized correctly by applying at least the default face for the first time.
T	getFace()
Ripple	getRipple() Returns whether this component have a ripple.
boolean	isUpgraded()
void	setEnabled(boolean enable) Sets whether the toggle is enabled.
void	setFace(T flavor) Setting a face for the toggle implies assigning a set of classes to the top level element, the input element and the label element.
void	setRipple(Ripple inputRipple) indicate whether this component should have a ripple.
void	setTarget(com.google.gwt.dom.client.Element eltCtnr, com.google.gwt.dom.client.Element eltInput, com.google.gwt.dom.client.Element eltLabel) Set the elements of the toggle on which the CSS classes will be applied to set the material look.
void	setValue(boolean check) Sets whether the toggle is checked.
void	upgrade() Causes the component to be upgraded.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToggleStyleOperator

public ToggleStyleOperator(CssSwitcher<T> switchCtnr,
                   CssSwitcher<T> switchInput,
                   CssSwitcher<T> switchlabel)

Make an instance of the style operator by providing the CssSwitcher set to be used to manage the CSS of the component.

Parameters:

switchCtnr - the container CSS manager

switchInput - the input CSS manager

switchlabel - the label CSS manager

Method Detail

setTarget

public final void setTarget(com.google.gwt.dom.client.Element eltCtnr,
             com.google.gwt.dom.client.Element eltInput,
             com.google.gwt.dom.client.Element eltLabel)

Set the elements of the toggle on which the CSS classes will be applied to set the material look.

Parameters:

eltCtnr - the upper level element

eltInput - the input element

eltLabel - the label element

setEnabled

public void setEnabled(boolean enable)

Sets whether the toggle is enabled.

Parameters:

enable - the new state of the toggle

setValue

public void setValue(boolean check)

Sets whether the toggle is checked.

Parameters:

check - the new state of the toggle check

defaultFlavor

protected abstract T defaultFlavor()

The sub-type must indicate the default class pack (= face) to enable the component to be initialized correctly by applying at least the default face for the first time.

Returns:

the default flavor

setFace

public void setFace(T flavor)

Setting a face for the toggle implies assigning a set of classes to the top level element, the input element and the label element.

Specified by:

setFace in interface IToggleFace<T extends Enum<T>>

Parameters:

flavor - the toggle flavor to be applied.

getFace

public T getFace()

Specified by:

getFace in interface IToggleFace<T extends Enum<T>>

Returns:

the toggle face applied on the component.

setRipple

public final void setRipple(Ripple inputRipple)

Description copied from interface: HasRipple

indicate whether this component should have a ripple.

Specified by:

setRipple in interface HasRipple

Parameters:

inputRipple - the ripple option to be applied to the component

getRipple

public final Ripple getRipple()

Description copied from interface: HasRipple

Returns whether this component have a ripple.

Specified by:

getRipple in interface HasRipple

Returns:

the ripple option applied to the component

upgrade

public void upgrade()

Description copied from interface: IUpgrade

Causes the component to be upgraded.

Specified by:

upgrade in interface IUpgrade

isUpgraded

public boolean isUpgraded()

Specified by:

isUpgraded in interface IUpgrade

Returns:

the upgrade state of the component