com.github.ilyes4j.gwt.mdl.extensions.flips

Class Flip

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.FocusWidget

com.google.gwt.user.client.ui.ButtonBase

com.github.ilyes4j.gwt.mdl.components.toggles.CheckboxBase<ButtonType>

com.github.ilyes4j.gwt.mdl.extensions.flips.Flip

All Implemented Interfaces:

IUpgrade, HasRipple, IToggleFace<ButtonType>, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<Boolean>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<Boolean>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<Boolean>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.user.client.ui.HasDirectionalText, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<Boolean>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents

public class Flip
extends CheckboxBase<ButtonType>
implements IToggleFace<ButtonType>

A Flip is not an official mdl component but a cross breeding between a button and a toggle. A flip is a toggle with the look of button. It behaves exactly as the the Checkbox while providing the visual appearance of a button.

Author:

Mohamed Ilyes DIMASSI

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
	Flip() Creates a check box with no label.
protected	Flip(com.google.gwt.dom.client.Element elem)
	Flip(com.google.gwt.safehtml.shared.SafeHtml label) Creates a check box with the specified text label.
	Flip(com.google.gwt.safehtml.shared.SafeHtml label, com.google.gwt.i18n.shared.DirectionEstimator directionEstimator) Creates a check box with the specified text label.
	Flip(com.google.gwt.safehtml.shared.SafeHtml label, com.google.gwt.i18n.client.HasDirection.Direction dir) Creates a check box with the specified text label.
	Flip(String label) Creates a check box with the specified text label.
	Flip(String label, boolean asHTML) Creates a check box with the specified text label.
	Flip(String label, com.google.gwt.i18n.shared.DirectionEstimator directionEstimator) Creates a label with the specified text and a default direction estimator.
	Flip(String label, com.google.gwt.i18n.client.HasDirection.Direction dir) Creates a check box with the specified text label.

Method Summary

Methods

Modifier and Type	Method and Description
ButtonColor	getCheckedColor()
ButtonType	getFace()
ButtonColor	getUncheckedColor()
void	setCheckedColor(ButtonColor checked) Specify the color to be applied when the flip is in the unchecked state.
void	setEnabled(boolean enabled)
void	setFace(ButtonType flavor)
void	setUncheckedColor(ButtonColor unchecked) Specify the color to be applied when the flip is in the checked state.
void	setValue(Boolean value) Checks or unchecks the check box.

Methods inherited from class com.github.ilyes4j.gwt.mdl.components.toggles.CheckboxBase

addValueChangeHandler, asEditor, ensureDomEventHandlers, getContainer, getDirectionEstimator, getFormValue, getHTML, getInput, getLabel, getName, getRipple, getTabIndex, getText, getTextDirection, getToggle, getValue, getWordWrap, isChecked, isEnabled, isUpgraded, onEnsureDebugId, onLoad, onUnload, replaceInputElement, replaceInputElement, setAccessKey, setChecked, setDirectionEstimator, setDirectionEstimator, setFocus, setFormValue, setHTML, setHTML, setName, setRipple, setTabIndex, setText, setText, setValue, setWordWrap, upgrade

Methods inherited from class com.google.gwt.user.client.ui.ButtonBase

setHTML

Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.safehtml.client.HasSafeHtml

setHTML

Constructor Detail

Flip

public Flip()

Creates a check box with no label.

Flip

public Flip(com.google.gwt.safehtml.shared.SafeHtml label)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

Flip

public Flip(com.google.gwt.safehtml.shared.SafeHtml label,
    com.google.gwt.i18n.client.HasDirection.Direction dir)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

dir - the text's direction. Note that DEFAULT means direction should be inherited from the widget's parent element.

Flip

public Flip(com.google.gwt.safehtml.shared.SafeHtml label,
    com.google.gwt.i18n.shared.DirectionEstimator directionEstimator)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

directionEstimator - A DirectionEstimator object used for automatic direction adjustment.

Flip

public Flip(String label)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

Flip

public Flip(String label,
    com.google.gwt.i18n.client.HasDirection.Direction dir)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

dir - the text's direction. Note that DEFAULT means direction should be inherited from the widget's parent element.

Flip

public Flip(String label,
    com.google.gwt.i18n.shared.DirectionEstimator directionEstimator)

Creates a label with the specified text and a default direction estimator.

Parameters:

label - the check box's label

directionEstimator - A DirectionEstimator object used for automatic direction adjustment.

Flip

public Flip(String label,
    boolean asHTML)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

asHTML - true to treat the specified label as html

Flip

protected Flip(com.google.gwt.dom.client.Element elem)

Parameters:

elem - the input element

Method Detail

getFace

public ButtonType getFace()

Specified by:

getFace in interface IToggleFace<ButtonType>

Returns:

the toggle face applied on the component.

setFace

public void setFace(ButtonType flavor)

Specified by:

setFace in interface IToggleFace<ButtonType>

Parameters:

flavor - the toggle face to be applied.

setValue

public void setValue(Boolean value)

Description copied from class: CheckboxBase

Checks or unchecks the check box.

Note that this does not set the value property of the checkbox input element wrapped by this widget. For access to that property, see CheckboxBase.setFormValue(String)

Specified by:

setValue in interface com.google.gwt.user.client.TakesValue<Boolean>

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Boolean>

Overrides:

setValue in class CheckboxBase<ButtonType>

Parameters:

value - true to check, false to uncheck; null value implies false

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

setEnabled in class CheckboxBase<ButtonType>

setCheckedColor

public void setCheckedColor(ButtonColor checked)

Specify the color to be applied when the flip is in the unchecked state.

Parameters:

checked - the color option to be applied when the flip is checked

getCheckedColor

public ButtonColor getCheckedColor()

Returns:

the color option applied when the flip is checked

setUncheckedColor

public void setUncheckedColor(ButtonColor unchecked)

Specify the color to be applied when the flip is in the checked state.

Parameters:

unchecked - the color option to be applied when the flip is unchecked

getUncheckedColor

public ButtonColor getUncheckedColor()

Returns:

the color option applied when the flip is unchecked