com.vaadin.client.ui

Class VButton

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.vaadin.client.ui.VButton

All Implemented Interfaces:

com.google.gwt.event.dom.client.ClickHandler, 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.EventHandler, 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.HasFocus, 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, HasErrorIndicatorElement

Direct Known Subclasses:

VColorPicker

public class VButton
extends com.google.gwt.user.client.ui.FocusWidget
implements com.google.gwt.event.dom.client.ClickHandler, HasErrorIndicatorElement

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

Modifier and Type	Field and Description
com.google.gwt.dom.client.Element	captionElement For internal use only.
static String	CLASSNAME
protected boolean	clickPending Helper flag to handle special-case where the button is moved from under mouse while clicking it.
int	clickShortcut For internal use only.
ApplicationConnection	client For internal use only.
Icon	icon For internal use only.
protected int	mousedownX
protected int	mousedownY
protected static int	MOVE_THRESHOLD
com.google.gwt.dom.client.Element	wrapper For internal use only.

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
VButton()

Method Summary

Modifier and Type	Method and Description
com.google.gwt.dom.client.Element	getErrorIndicatorElement() Gets the error indicator element.
boolean	isEnabled()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	onClick() Called internally when the user finishes clicking on this button.
void	onClick(com.google.gwt.event.dom.client.ClickEvent event)
void	setEnabled(boolean enabled) Sets whether this button is enabled.
void	setErrorIndicatorElementVisible(boolean visible) Sets the visibility of the error indicator element.
void	setHtml(String html)
void	setStyleName(String style)
void	setStylePrimaryName(String style)
void	setTabIndex(int index)
void	setText(String text)

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, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setFocus

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, onDetach, onLoad, onUnload, 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, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, 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

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

MOVE_THRESHOLD

protected static int MOVE_THRESHOLD

mousedownX

protected int mousedownX

mousedownY

protected int mousedownY

client

public ApplicationConnection client

For internal use only. May be removed or replaced in the future.

wrapper

public final com.google.gwt.dom.client.Element wrapper

For internal use only. May be removed or replaced in the future.

captionElement

public final com.google.gwt.dom.client.Element captionElement

For internal use only. May be removed or replaced in the future.

icon

public Icon icon

For internal use only. May be removed or replaced in the future.

clickPending

protected boolean clickPending

Helper flag to handle special-case where the button is moved from under mouse while clicking it. In this case mouse leaves the button without moving.

clickShortcut

public int clickShortcut

For internal use only. May be removed or replaced in the future.

Constructor Detail

VButton

public VButton()

Method Detail

setStyleName

public void setStyleName(String style)

Overrides:

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

setStylePrimaryName

public void setStylePrimaryName(String style)

Overrides:

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

setText

public void setText(String text)

setHtml

public void setHtml(String html)

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

onClick

public void onClick(com.google.gwt.event.dom.client.ClickEvent event)

Specified by:

onClick in interface com.google.gwt.event.dom.client.ClickHandler

onClick

public void onClick()

Called internally when the user finishes clicking on this button. The default behavior is to fire the click event to listeners. Subclasses that override #onClickStart() should override this method to restore the normal widget display.

To add custom code for a click event, override onClick(ClickEvent) instead of this.

For internal use only. May be removed or replaced in the future.

setEnabled

public final void setEnabled(boolean enabled)

Sets whether this button is enabled.

Specified by:

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

Overrides:

setEnabled in class com.google.gwt.user.client.ui.FocusWidget

Parameters:

enabled - true to enable the button, false to disable it

isEnabled

public final boolean isEnabled()

Specified by:

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

Overrides:

isEnabled in class com.google.gwt.user.client.ui.FocusWidget

setTabIndex

public final void setTabIndex(int index)

Specified by:

setTabIndex in interface com.google.gwt.user.client.ui.Focusable

Overrides:

setTabIndex in class com.google.gwt.user.client.ui.FocusWidget

getErrorIndicatorElement

public com.google.gwt.dom.client.Element getErrorIndicatorElement()

Description copied from interface: HasErrorIndicatorElement

Gets the error indicator element.

Specified by:

getErrorIndicatorElement in interface HasErrorIndicatorElement

Returns:

the error indicator element

setErrorIndicatorElementVisible

public void setErrorIndicatorElementVisible(boolean visible)

Description copied from interface: HasErrorIndicatorElement

Sets the visibility of the error indicator element.

Specified by:

setErrorIndicatorElementVisible in interface HasErrorIndicatorElement

Parameters:

visible - true to show the error indicator element, false to hide it