public class

ToggleButton

extends CustomButton
implements IsEditor<E extends Editor<?>> HasValue<T>

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.CustomButton
					↳	com.google.gwt.user.client.ui.ToggleButton

Class Overview

A ToggleButton is a stylish stateful button which allows the user to toggle between up and down states.

CSS Style Rules

.gwt-ToggleButton-up/down/up-hovering/down-hovering/up-disabled/down-disabled {.html-face}

Example

{@example com.google.gwt.examples.ToggleButtonExample}

Summary

[Expand]

Inherited Constants

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

Public Constructors
	ToggleButton() Constructor for `ToggleButton`.
	ToggleButton(Image upImage) Constructor for `ToggleButton`.
	ToggleButton(Image upImage, ClickHandler handler) Constructor for `ToggleButton`.
	ToggleButton(Image upImage, ClickListener listener) This constructor is deprecated. Use `ToggleButton(Image, ClickHandler)` instead
	ToggleButton(Image upImage, Image downImage) Constructor for `ToggleButton`.
	ToggleButton(Image upImage, Image downImage, ClickHandler handler) Constructor for `ToggleButton`.
	ToggleButton(Image upImage, Image downImage, ClickListener listener) This constructor is deprecated. Use `ToggleButton(Image, Image, ClickHandler)` instead
	ToggleButton(String upText) Constructor for `ToggleButton`.
	ToggleButton(String upText, ClickHandler handler) Constructor for `ToggleButton`.
	ToggleButton(String upText, ClickListener listener) This constructor is deprecated. Use `ToggleButton(String, ClickHandler)` instead
	ToggleButton(String upText, String downText) Constructor for `ToggleButton`.
	ToggleButton(String upText, String downText, ClickHandler handler) Constructor for `ToggleButton`.

Public Methods
HandlerRegistration	addValueChangeHandler(ValueChangeHandler<Boolean> handler)
LeafValueEditor<Boolean>	asEditor() Returns the Editor encapsulated by the view object.
Boolean	getValue() Determines whether this button is currently down.
boolean	isDown() Is this button down?
void	setDown(boolean down) Sets whether this button is down. Does not fire `ValueChangeEvent`.
void	setValue(Boolean value, boolean fireEvents) Sets whether this button is down, firing `ValueChangeEvent` if appropriate.
void	setValue(Boolean value) Sets whether this button is down.

Protected Methods
void	onClick() Called when the user finishes clicking on this button.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.CustomButton

final CustomButton.Face	getDownDisabledFace() Gets the downDisabled face of the button.
final CustomButton.Face	getDownFace() Gets the down face of the button.
final CustomButton.Face	getDownHoveringFace() Gets the downHovering face of the button.
String	getHTML() Gets the current face's html.
int	getTabIndex() Gets the tab index.
String	getText() Gets the current face's text.
final CustomButton.Face	getUpDisabledFace() Gets the upDisabled face of the button.
final CustomButton.Face	getUpFace() Gets the up face of the button.
final CustomButton.Face	getUpHoveringFace() Gets the upHovering face of the button.
boolean	isDown() Is this button down?
void	onAttach() Overridden on attach to ensure that a button face has been chosen before the button is displayed.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onClick() Called when the user finishes clicking on this button.
void	onClickCancel() Called when the user aborts a click in progress; for example, by dragging the mouse outside of the button before releasing the mouse button.
void	onClickStart() Called when the user begins to click on this button.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	setAccessKey(char key) Sets the widget's 'access key'.
void	setDown(boolean down) Sets whether this button is down.
final void	setEnabled(boolean enabled) Sets whether this button is enabled.
void	setFocus(boolean focused) Explicitly focus/unfocus this widget.
void	setHTML(SafeHtml html) Sets this object's contents via known-safe HTML.
void	setHTML(String html) Sets the current face's html.
void	setTabIndex(int index) Sets the widget's position in the tab index.
void	setText(String text) Sets the current face's text.

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

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

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

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

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

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.editor.client.IsEditor

From interface com.google.gwt.event.dom.client.HasBlurHandlers

From interface com.google.gwt.event.dom.client.HasClickHandlers

From interface com.google.gwt.event.dom.client.HasDoubleClickHandlers

From interface com.google.gwt.event.dom.client.HasFocusHandlers

From interface com.google.gwt.event.dom.client.HasGestureChangeHandlers

From interface com.google.gwt.event.dom.client.HasGestureEndHandlers

From interface com.google.gwt.event.dom.client.HasGestureStartHandlers

From interface com.google.gwt.event.dom.client.HasKeyDownHandlers

From interface com.google.gwt.event.dom.client.HasKeyPressHandlers

From interface com.google.gwt.event.dom.client.HasKeyUpHandlers

From interface com.google.gwt.event.dom.client.HasMouseDownHandlers

From interface com.google.gwt.event.dom.client.HasMouseMoveHandlers

From interface com.google.gwt.event.dom.client.HasMouseOutHandlers

From interface com.google.gwt.event.dom.client.HasMouseOverHandlers

From interface com.google.gwt.event.dom.client.HasMouseUpHandlers

From interface com.google.gwt.event.dom.client.HasMouseWheelHandlers

From interface com.google.gwt.event.dom.client.HasTouchCancelHandlers

From interface com.google.gwt.event.dom.client.HasTouchEndHandlers

From interface com.google.gwt.event.dom.client.HasTouchMoveHandlers

From interface com.google.gwt.event.dom.client.HasTouchStartHandlers

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasValueChangeHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.safehtml.client.HasSafeHtml

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.TakesValue

From interface com.google.gwt.user.client.ui.Focusable

From interface com.google.gwt.user.client.ui.HasEnabled

From interface com.google.gwt.user.client.ui.HasHTML

From interface com.google.gwt.user.client.ui.HasText

From interface com.google.gwt.user.client.ui.HasValue

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.SourcesClickEvents

From interface com.google.gwt.user.client.ui.SourcesFocusEvents

From interface com.google.gwt.user.client.ui.SourcesKeyboardEvents

From interface com.google.gwt.user.client.ui.SourcesMouseEvents

Public Constructors

public ToggleButton ()

Constructor for ToggleButton.

public ToggleButton (Image upImage)

Constructor for ToggleButton. The supplied image is used to construct the default face.

Parameters

upImage	image for the default face of the button

public ToggleButton (Image upImage, ClickHandler handler)

Constructor for ToggleButton. The supplied image is used to construct the default face of the button.

Parameters

upImage	image for the default (up) face of the button
handler	the click handler

public ToggleButton (Image upImage, ClickListener listener)

This constructor is deprecated.
Use ToggleButton(Image, ClickHandler) instead

Constructor for ToggleButton. The supplied image is used to construct the default face of the button.

Parameters

upImage	image for the default (up) face of the button
listener	the click listener

public ToggleButton (Image upImage, Image downImage)

Constructor for ToggleButton.

Parameters

upImage	image for the default(up) face of the button
downImage	image for the down face of the button

public ToggleButton (Image upImage, Image downImage, ClickHandler handler)

Constructor for ToggleButton.

Parameters

upImage	image for the default(up) face of the button
downImage	image for the down face of the button
handler	the click handler

public ToggleButton (Image upImage, Image downImage, ClickListener listener)

This constructor is deprecated.
Use ToggleButton(Image, Image, ClickHandler) instead

Constructor for ToggleButton.

Parameters

upImage	image for the default(up) face of the button
downImage	image for the down face of the button
listener	clickListener

public ToggleButton (String upText)

Constructor for ToggleButton. The supplied text is used to construct the default face of the button.

Parameters

upText	the text for the default (up) face of the button.

public ToggleButton (String upText, ClickHandler handler)

Constructor for ToggleButton. The supplied text is used to construct the default face of the button.

Parameters

upText	the text for the default (up) face of the button
handler	the click handler

public ToggleButton (String upText, ClickListener listener)

This constructor is deprecated.
Use ToggleButton(String, ClickHandler) instead

Constructor for ToggleButton. The supplied text is used to construct the default face of the button.

Parameters

upText	the text for the default (up) face of the button
listener	the click listener

public ToggleButton (String upText, String downText)

Constructor for ToggleButton.

Parameters

upText	the text for the default (up) face of the button
downText	the text for down face of the button

public ToggleButton (String upText, String downText, ClickHandler handler)

Constructor for ToggleButton.

Parameters

upText	the text for the default (up) face of the button
downText	the text for down face of the button
handler	the click handler

Public Methods

public HandlerRegistration addValueChangeHandler (ValueChangeHandler<Boolean> handler)

public LeafValueEditor<Boolean> asEditor ()

Returns the Editor encapsulated by the view object.

Returns

an Editor of type E

public Boolean getValue ()

Determines whether this button is currently down.

Returns

true if the button is pressed, false otherwise. Will not return null

public boolean isDown ()

Is this button down?

Returns

true if the button is down

public void setDown (boolean down)

Sets whether this button is down. Does not fire ValueChangeEvent. (If you want the event to fire, use setValue(Boolean, boolean))

Parameters

down	`true` to press the button, `false` otherwise

public void setValue (Boolean value, boolean fireEvents)

Sets whether this button is down, firing ValueChangeEvent if appropriate.

Parameters

value	true to press the button, false otherwise; null value implies false
fireEvents	If true, and value has changed, fire a `ValueChangeEvent`

public void setValue (Boolean value)

Sets whether this button is down.

Parameters

value	true to press the button, false otherwise; null value implies false

Protected Methods

protected void onClick ()

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

Interfaces

Classes

Annotations

Enums

Exceptions

ToggleButton

Class Overview

CSS Style Rules

Example

Summary

Public Constructors

public ToggleButton ()

public ToggleButton (Image upImage)

Parameters

public ToggleButton (Image upImage, ClickHandler handler)

Parameters

public ToggleButton (Image upImage, ClickListener listener)

Parameters

public ToggleButton (Image upImage, Image downImage)

Parameters

public ToggleButton (Image upImage, Image downImage, ClickHandler handler)

Parameters

public ToggleButton (Image upImage, Image downImage, ClickListener listener)

Parameters

public ToggleButton (String upText)

Parameters

public ToggleButton (String upText, ClickHandler handler)

Parameters

public ToggleButton (String upText, ClickListener listener)

Parameters

public ToggleButton (String upText, String downText)

Parameters

public ToggleButton (String upText, String downText, ClickHandler handler)

Parameters

Public Methods

public HandlerRegistration addValueChangeHandler (ValueChangeHandler<Boolean> handler)

public LeafValueEditor<Boolean> asEditor ()

Returns

public Boolean getValue ()

Returns

public boolean isDown ()

Returns

public void setDown (boolean down)

Parameters

public void setValue (Boolean value, boolean fireEvents)

Parameters

public void setValue (Boolean value)

Parameters

Protected Methods

protected void onClick ()