com.github.ilyes4j.gwt.mdl.components.buttons

Class Button

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.google.gwt.user.client.ui.Button

com.github.ilyes4j.gwt.mdl.components.buttons.Button

All Implemented Interfaces:

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.shared.HasHandlers, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, 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.HasText, com.google.gwt.user.client.ui.HasVisibility, 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

Direct Known Subclasses:

ImgButton

public class Button
extends com.google.gwt.user.client.ui.Button

A Material Button, can take many shapes. Its appearance is controlled by a handful of properties but not all are available at the same time. For example a Fab button can't have all the colors available for a Raised button. Thereby, a button should not be setup using its constructor. Instead a builder was implemented to assist in setting up the appropriate options for the 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

Constructor and Description
Button() Setup an instance by applying the basic properties shared by all material buttons.

Method Summary

Methods

Modifier and Type	Method and Description
void	addStyleName(String inputStyleName) Safely adds a new css selector to the button.
static Button	createFab(ButtonFabColor color, Ripple ripple, String icon) Setup a fab material button.
static Button	createFlat(ButtonColor color, Ripple ripple, String text) A flat button is very similar to a raised button.
static Button	createIcon(ButtonColor color, Ripple ripple, String icon) Setup an icon material button.
static Button	createMiniFab(ButtonFabColor color, Ripple ripple, String icon) Setup a mini fab material button.
static Button	createRaised(ButtonColor color, Ripple ripple, String text) Setup a raised material button.
ButtonColor	getColor() Returns the coloring option of the button.
ButtonFabColor	getFabColor() Returns the coloring option of the button.
Ripple	getRipple() Returns the ripple option of the button.
String	getText() Returns the text of the button, if the button is not flat nor raised, the returned value is unpredictable.
ButtonType	getType() Return the material button type provided by one of the options in ButtonType.
void	setColor(ButtonColor inputColor) Setup the coloring option of the button.
void	setFabColor(ButtonFabColor inputFabColor) Setup the coloring option of the button.
void	setIcon(String icon) Add an icon to the button.
void	setRipple(Ripple inputRipple) Setup the ripple option of the button.
void	setText(String text) Set the text to be displayed on the button.
void	setType(ButtonType inputType) The material button type indicates how it renders and what options can be applied to tweak its appearance.
void	upgrade() apply javascript behaviors and effects on the button.

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

click, getButtonElement, wrap

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

getHTML, setHTML, 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, getTabIndex, isEnabled, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setEnabled, setFocus, setTabIndex

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, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, 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

Constructor Detail

Button

public Button()

Setup an instance by applying the basic properties shared by all material buttons.

Method Detail

createRaised

public static Button createRaised(ButtonColor color,
                  Ripple ripple,
                  String text)

Setup a raised material button.

A raised button is a rectangular and elevated button that has a text for content. It can have a ripple and one of the three available background colors (translucent, primary or accented theme color).

Parameters:

color - the background color, should be one of the options provided by ButtonColor

ripple - determines whether the button has a ripple, should be one of the options provided by Ripple

text - a text for the button

Returns:

a raised button.

createFlat

public static Button createFlat(ButtonColor color,
                Ripple ripple,
                String text)

A flat button is very similar to a raised button. It uses the same options as the raised button but renders differently. The provided color act on the text rather than the background.

Parameters:

color - The text color should be one of the options provided by ButtonColor

ripple - determines whether the button has a ripple, should be one of the options provided by Ripple

text - a text for the button

Returns:

a flat button.

createFab

public static Button createFab(ButtonFabColor color,
               Ripple ripple,
               String icon)

Setup a fab material button.

A fab button is a round and elevated Button with a material icon. It can have a ripple and one from only two possible background colors (translucent or mdl accent theme color)

Parameters:

color - the background color, should be one of the options provided by ButtonFabColor

ripple - determines whether the button has a ripple, one of the options provided by Ripple

icon - a material icon font code

Returns:

a fab button

createIcon

public static Button createIcon(ButtonColor color,
                Ripple ripple,
                String icon)

Setup an icon material button.

A material icon button is at the cross road of flat and mini fab buttons.

Parameters:

color - the icon color. Should be one of the options provided by ButtonColor

ripple - determines whether the button has a ripple, one of the options provided by Ripple

icon - a material icon font code

Returns:

A raised button.

createMiniFab

public static Button createMiniFab(ButtonFabColor color,
                   Ripple ripple,
                   String icon)

Setup a mini fab material button.

A mini fab is identical to a fab button except that it is tinier.

Parameters:

color - the background color, should be one of the options provided by ButtonFabColor

ripple - determines whether the button has a ripple, one of the options provided by Ripple

icon - a material icon font code

Returns:

A raised button.

setIcon

public final void setIcon(String icon)

Add an icon to the button.

Parameters:

icon - a material icon font code

upgrade

public final void upgrade()

apply javascript behaviors and effects on the button.

getType

public final ButtonType getType()

Return the material button type provided by one of the options in ButtonType.

Returns:

one of the options provided by ButtonType

setType

public final void setType(ButtonType inputType)

The material button type indicates how it renders and what options can be applied to tweak its appearance. The type is determined by one of the options provided by ButtonType.

Parameters:

inputType - one of the options provided by ButtonType

getColor

public final ButtonColor getColor()

Returns the coloring option of the button. The returned result is unpredictable if the button type is not Flat, Raised or Icon.

Returns:

one of the options provided by ButtonColor

setColor

public final void setColor(ButtonColor inputColor)

Setup the coloring option of the button. The result is unpredictable if the button type is not Flat, Raised or Icon.

Parameters:

inputColor - one of the options provided by ButtonColor

getFabColor

public final ButtonFabColor getFabColor()

Returns the coloring option of the button. The returned result is unpredictable if the button type is not Fab or a Mini Fab.

Returns:

one of the options provided by ButtonFabColor

setFabColor

public final void setFabColor(ButtonFabColor inputFabColor)

Setup the coloring option of the button. The result is unpredictable if the button type is Fab or Mini Fab.

Parameters:

inputFabColor - one of the options provided by ButtonFabColor

getRipple

public final Ripple getRipple()

Returns the ripple option of the button.

Returns:

one of the options provided by Ripple

setRipple

public final void setRipple(Ripple inputRipple)

Setup the ripple option of the button.

Parameters:

inputRipple - one of the options provided by Ripple

addStyleName

public final void addStyleName(String inputStyleName)

Safely adds a new css selector to the button. Should be removed and MdlGwtUtils.addStyle(UIObject, Object) should be used instead.

Overrides:

addStyleName in class com.google.gwt.user.client.ui.UIObject

Parameters:

inputStyleName - the css selector to be applied safely

setText

public final void setText(String text)

Set the text to be displayed on the button.

If the button is not flat nor raised, the behavior of this method is unpredictable.

The super type implementation of this method simply overrides anything inside the button and replaces it with the text provided as input.

Considering that the button element can have ripples in addition to text, setting a text for the button cannot be achieved by writing over the button's content. By embedding the text inside a container, it is possible to target the text without damaging other context inside the button.

Specified by:

setText in interface com.google.gwt.user.client.ui.HasText

Overrides:

setText in class com.google.gwt.user.client.ui.ButtonBase

Parameters:

text - the text to be set for the button

getText

public final String getText()

Returns the text of the button, if the button is not flat nor raised, the returned value is unpredictable.

Specified by:

getText in interface com.google.gwt.user.client.ui.HasText

Overrides:

getText in class com.google.gwt.user.client.ui.ButtonBase

Returns:

the button's text