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

Class ButtonBase

java.lang.Object

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

All Implemented Interfaces:

IUpgrade, HasRipple

public class ButtonBase
extends Object
implements HasRipple, IUpgrade

All behaviors expected from a material button are here. An instance of this type is not a component of its own. Instead, it acts on a target component to attach the required behaviors to it. This ensures an extra flexibility when creating material buttons.

It wouldn't be possible to reuse the material button logic in button-like components if that logic is tied to the Button component.

Author:

Mohamed Ilyes DIMASSI

Constructor Summary

Constructors

Constructor and Description
ButtonBase(com.google.gwt.dom.client.Element inputElement) Setup an instance of a material button and provide the target Element to be decorated with the material button behavior.

Method Summary

Methods

Modifier and Type	Method and Description
ButtonColor	getColor() 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.
boolean	isUpgraded()
void	setColor(ButtonColor inputColor) 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. 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.
void	setType(ButtonType inputType) The material button type indicates how it renders and what options can be applied to tweak its appearance.
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

ButtonBase

public ButtonBase(com.google.gwt.dom.client.Element inputElement)

Setup an instance of a material button and provide the target Element to be decorated with the material button behavior.

Parameters:

inputElement - the target element to which apply the material button behavior

Method Detail

setIcon

public final void setIcon(String icon)

Add an icon to the button.

Parameters:

icon - a material icon font code

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

getRipple

public final Ripple getRipple()

Returns the ripple option of the button.

Specified by:

getRipple in interface HasRipple

Returns:

one of the options provided by Ripple

setRipple

public final void setRipple(Ripple inputRipple)

Setup the ripple option of the button.

Specified by:

setRipple in interface HasRipple

Parameters:

inputRipple - one of the options provided by Ripple

upgrade

public final 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

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.

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.

Returns:

the button's text