com.github.gwtbootstrap.client.ui

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.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.github.gwtbootstrap.client.ui.base.ComplexWidget

com.github.gwtbootstrap.client.ui.base.IconAnchor

com.github.gwtbootstrap.client.ui.Button

All Implemented Interfaces:

HasHref, HasIcon, HasStyle, HasType<ButtonType>, IsResponsive, 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.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

NavbarButton

public class Button
extends IconAnchor
implements com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.user.client.ui.HasEnabled, HasType<ButtonType>, 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

Button with optional icon.

UiBinder Usage:

 <b:Button icon="TRASH" type="ERROR" toggle="true" loadingText="I'm loading..." completeText="Oh hoh, I completed the action!">Delete</b:Button>
 

All arguments are optional.

Since:

2.0.4.0

Author:

Carlos Alexandro Becker, Dominik Mayer, Sven Jacobs

See Also:

Bootstrap documentation, ButtonGroup, ButtonToolbar, DropdownButton, SplitDropdownButton, NavbarButton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Button.LoadingStateBehavior A simple class to encapsulate the button state managing from the user.

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Field Summary

Fields inherited from class com.github.gwtbootstrap.client.ui.base.IconAnchor

icon

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Button() Creates an empty Button.
Button(com.google.gwt.event.dom.client.ClickHandler handler) Creates an Button with ClickHandler
Button(String caption) Creates a Button with the given caption.
Button(String caption, com.google.gwt.event.dom.client.ClickHandler handler) Create Button with click handler.
Button(String caption, IconType icon) Creates a Button with the given caption and icon.
Button(String caption, IconType icon, com.google.gwt.event.dom.client.ClickHandler handler) Creates a Button with the given caption and icon and ClickHandler.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDoubleClickHandler(com.google.gwt.event.dom.client.DoubleClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragEndHandler(com.google.gwt.event.dom.client.DragEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragHandler(com.google.gwt.event.dom.client.DragHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragStartHandler(com.google.gwt.event.dom.client.DragStartHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addGestureChangeHandler(com.google.gwt.event.dom.client.GestureChangeHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addGestureEndHandler(com.google.gwt.event.dom.client.GestureEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addGestureStartHandler(com.google.gwt.event.dom.client.GestureStartHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addKeyDownHandler(com.google.gwt.event.dom.client.KeyDownHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addKeyUpHandler(com.google.gwt.event.dom.client.KeyUpHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseWheelHandler(com.google.gwt.event.dom.client.MouseWheelHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchCancelHandler(com.google.gwt.event.dom.client.TouchCancelHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchEndHandler(com.google.gwt.event.dom.client.TouchEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchMoveHandler(com.google.gwt.event.dom.client.TouchMoveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchStartHandler(com.google.gwt.event.dom.client.TouchStartHandler handler)
void	click() Programmatic equivalent of the user clicking the button.
ButtonSize	getSize() Get Button Size
ButtonType	getType() Get Button Type
boolean	isEnabled() Whether the Button is enabled or disabled.
boolean	isToggle() Verify if the property "toggle" is set.
boolean	isToggled() Verify if the button is toggled.
void	setBlock(boolean block) Set element as a Block Level Button
void	setCompleteText(String text) Set a Loading Text to show when some action are completed with this button.
void	setDismiss(DismissType type) Buttons can act as a dismiss button when inside a Modal or Alert.
void	setEnabled(boolean enabled) Sets whether the Button is enabled or disabled.
void	setLoadingText(String text) Set a Loading Text to show when some action are in work with this button.
void	setSize(ButtonSize size) Sets the size of the Button.
void	setToggle(boolean toggle) Enable ou disable the data-toggle behavior.
void	setType(ButtonType type) Sets the type of the Button.
Button.LoadingStateBehavior	state() A simple DSL to change the button state to loading, complete, or reset it.

Methods inherited from class com.github.gwtbootstrap.client.ui.base.IconAnchor

getAnchorElement, getHref, getName, getTabIndex, getTarget, getTargetHistoryToken, getText, isActive, onAttach, onBrowserEvent, setAccessKey, setActive, setBaseIcon, setCaret, setCustomIconStyle, setEmptyHref, setFocus, setHref, setIcon, setIconPosition, setIconSize, setName, setTabIndex, setTarget, setTargetHistoryToken, setText

Methods inherited from class com.github.gwtbootstrap.client.ui.base.ComplexWidget

add, addStyle, insert, removeStyle, setHideOn, setShowOn, setStyle

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, setParent, sinkEvents

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, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

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.user.client.ui.HasWidgets

clear, iterator, remove

Constructor Detail

Button

public Button()

Creates an empty Button.

Button

public Button(com.google.gwt.event.dom.client.ClickHandler handler)

Creates an Button with ClickHandler

Parameters:

handler - Butotn ClickHandler

Button

public Button(String caption)

Creates a Button with the given caption.

Parameters:

caption - the caption of the Button

Button

public Button(String caption,
      com.google.gwt.event.dom.client.ClickHandler handler)

Create Button with click handler.

Parameters:

caption - the caption of the Button

handler - Button Click Handler

Button

public Button(String caption,
      IconType icon)

Creates a Button with the given caption and icon.

Parameters:

caption - the caption of the Button

icon - the Icon on the caption's left

Button

public Button(String caption,
      IconType icon,
      com.google.gwt.event.dom.client.ClickHandler handler)

Creates a Button with the given caption and icon and ClickHandler.

Parameters:

caption - the caption of the Button

icon - the Icon on the caption's left

handler - the ClickHandler of the Button.

Method Detail

setType

public void setType(ButtonType type)

Sets the type of the Button.

Different types give the button a different look.

Specified by:

setType in interface HasType<ButtonType>

Parameters:

type - the type of the Button.

setSize

public void setSize(ButtonSize size)

Sets the size of the Button.

Parameters:

size - the size of the Button.

isEnabled

public boolean isEnabled()

Whether the Button is enabled or disabled.

A disabled widget cannot be used.

Specified by:

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

Overrides:

isEnabled in class IconAnchor

Returns:

false if the Button is disabled.

setEnabled

public void setEnabled(boolean enabled)

Sets whether the Button is enabled or disabled.

A disabled widget cannot be used.

Specified by:

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

Overrides:

setEnabled in class IconAnchor

Parameters:

enabled - false if the Button should be disabled. Default: true

setToggle

public void setToggle(boolean toggle)

Enable ou disable the data-toggle behavior.

Parameters:

toggle - true will enable this behavior. false will disable it or do nothing if it never was enabled.

isToggle

public boolean isToggle()

Verify if the property "toggle" is set.

Returns:

true: if the data-toggle is equal 'button' false: otherwise

isToggled

public boolean isToggled()

Verify if the button is toggled.

Returns:

true: if yes (it will contain the "active" styleclass false: otherwise.

setLoadingText

public void setLoadingText(String text)

Set a Loading Text to show when some action are in work with this button.

Parameters:

text -

See Also:

Button.LoadingStateBehavior

setCompleteText

public void setCompleteText(String text)

Set a Loading Text to show when some action are completed with this button.

Parameters:

text -

See Also:

Button.LoadingStateBehavior

state

public Button.LoadingStateBehavior state()

A simple DSL to change the button state to loading, complete, or reset it.

Returns:

addClickHandler

public com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

Specified by:

addClickHandler in interface com.google.gwt.event.dom.client.HasClickHandlers

Overrides:

addClickHandler in class IconAnchor

addDoubleClickHandler

public com.google.gwt.event.shared.HandlerRegistration addDoubleClickHandler(com.google.gwt.event.dom.client.DoubleClickHandler handler)

Specified by:

addDoubleClickHandler in interface com.google.gwt.event.dom.client.HasDoubleClickHandlers

addDragEndHandler

public com.google.gwt.event.shared.HandlerRegistration addDragEndHandler(com.google.gwt.event.dom.client.DragEndHandler handler)

Specified by:

addDragEndHandler in interface com.google.gwt.event.dom.client.HasDragEndHandlers

addDragEnterHandler

public com.google.gwt.event.shared.HandlerRegistration addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)

Specified by:

addDragEnterHandler in interface com.google.gwt.event.dom.client.HasDragEnterHandlers

addDragLeaveHandler

public com.google.gwt.event.shared.HandlerRegistration addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)

Specified by:

addDragLeaveHandler in interface com.google.gwt.event.dom.client.HasDragLeaveHandlers

addDragHandler

public com.google.gwt.event.shared.HandlerRegistration addDragHandler(com.google.gwt.event.dom.client.DragHandler handler)

Specified by:

addDragHandler in interface com.google.gwt.event.dom.client.HasDragHandlers

addDragOverHandler

public com.google.gwt.event.shared.HandlerRegistration addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)

Specified by:

addDragOverHandler in interface com.google.gwt.event.dom.client.HasDragOverHandlers

addDragStartHandler

public com.google.gwt.event.shared.HandlerRegistration addDragStartHandler(com.google.gwt.event.dom.client.DragStartHandler handler)

Specified by:

addDragStartHandler in interface com.google.gwt.event.dom.client.HasDragStartHandlers

addDropHandler

public com.google.gwt.event.shared.HandlerRegistration addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)

Specified by:

addDropHandler in interface com.google.gwt.event.dom.client.HasDropHandlers

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

Specified by:

addFocusHandler in interface com.google.gwt.event.dom.client.HasFocusHandlers

addBlurHandler

public com.google.gwt.event.shared.HandlerRegistration addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)

Specified by:

addBlurHandler in interface com.google.gwt.event.dom.client.HasBlurHandlers

addGestureStartHandler

public com.google.gwt.event.shared.HandlerRegistration addGestureStartHandler(com.google.gwt.event.dom.client.GestureStartHandler handler)

Specified by:

addGestureStartHandler in interface com.google.gwt.event.dom.client.HasGestureStartHandlers

addGestureChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addGestureChangeHandler(com.google.gwt.event.dom.client.GestureChangeHandler handler)

Specified by:

addGestureChangeHandler in interface com.google.gwt.event.dom.client.HasGestureChangeHandlers

addGestureEndHandler

public com.google.gwt.event.shared.HandlerRegistration addGestureEndHandler(com.google.gwt.event.dom.client.GestureEndHandler handler)

Specified by:

addGestureEndHandler in interface com.google.gwt.event.dom.client.HasGestureEndHandlers

addKeyUpHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyUpHandler(com.google.gwt.event.dom.client.KeyUpHandler handler)

Specified by:

addKeyUpHandler in interface com.google.gwt.event.dom.client.HasKeyUpHandlers

addKeyDownHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyDownHandler(com.google.gwt.event.dom.client.KeyDownHandler handler)

Specified by:

addKeyDownHandler in interface com.google.gwt.event.dom.client.HasKeyDownHandlers

addKeyPressHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler handler)

Specified by:

addKeyPressHandler in interface com.google.gwt.event.dom.client.HasKeyPressHandlers

addMouseDownHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)

Specified by:

addMouseDownHandler in interface com.google.gwt.event.dom.client.HasMouseDownHandlers

Overrides:

addMouseDownHandler in class IconAnchor

addMouseUpHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler handler)

Specified by:

addMouseUpHandler in interface com.google.gwt.event.dom.client.HasMouseUpHandlers

addMouseOutHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)

Specified by:

addMouseOutHandler in interface com.google.gwt.event.dom.client.HasMouseOutHandlers

addMouseOverHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)

Specified by:

addMouseOverHandler in interface com.google.gwt.event.dom.client.HasMouseOverHandlers

addMouseMoveHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler handler)

Specified by:

addMouseMoveHandler in interface com.google.gwt.event.dom.client.HasMouseMoveHandlers

addMouseWheelHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseWheelHandler(com.google.gwt.event.dom.client.MouseWheelHandler handler)

Specified by:

addMouseWheelHandler in interface com.google.gwt.event.dom.client.HasMouseWheelHandlers

addTouchStartHandler

public com.google.gwt.event.shared.HandlerRegistration addTouchStartHandler(com.google.gwt.event.dom.client.TouchStartHandler handler)

Specified by:

addTouchStartHandler in interface com.google.gwt.event.dom.client.HasTouchStartHandlers

addTouchMoveHandler

public com.google.gwt.event.shared.HandlerRegistration addTouchMoveHandler(com.google.gwt.event.dom.client.TouchMoveHandler handler)

Specified by:

addTouchMoveHandler in interface com.google.gwt.event.dom.client.HasTouchMoveHandlers

addTouchEndHandler

public com.google.gwt.event.shared.HandlerRegistration addTouchEndHandler(com.google.gwt.event.dom.client.TouchEndHandler handler)

Specified by:

addTouchEndHandler in interface com.google.gwt.event.dom.client.HasTouchEndHandlers

addTouchCancelHandler

public com.google.gwt.event.shared.HandlerRegistration addTouchCancelHandler(com.google.gwt.event.dom.client.TouchCancelHandler handler)

Specified by:

addTouchCancelHandler in interface com.google.gwt.event.dom.client.HasTouchCancelHandlers

getType

public ButtonType getType()

Get Button Type

Returns:

Current Button Type

getSize

public ButtonSize getSize()

Get Button Size

Returns:

Current Button Size

setBlock

public void setBlock(boolean block)

Set element as a Block Level Button

Parameters:

block - true:Block Level false:Default

click

public void click()

Programmatic equivalent of the user clicking the button.

setDismiss

public void setDismiss(DismissType type)

Buttons can act as a dismiss button when inside a Modal or Alert.

UiBinder example:

 <b:Modal>
     <b:ModalFooter>
         <b:Button text="Close" dismiss="MODAL"/>
     </b:ModalFooter>
 </b:Modal>
 

See Bootstrap documentation.

Parameters:

type - Type of dismiss ("modal" or "alert")

Since:

2.3.2.0