com.sencha.gxt.widget.core.client.button

Class ToggleButton

java.lang.Object

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

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

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<C>

com.sencha.gxt.widget.core.client.button.CellButtonBase<Boolean>

com.sencha.gxt.widget.core.client.button.ToggleButton

All Implemented Interfaces:

Editor<Boolean>, LeafValueEditor<Boolean>, HasAttachHandlers, HasResizeHandlers, HasValueChangeHandlers<Boolean>, HasHandlers, HasSafeHtml, EventListener, TakesValue<Boolean>, HasEnabled, HasHTML, HasText, HasValue<Boolean>, HasVisibility, IsWidget, HasKeyProvider<Boolean>, ArrowSelectEvent.HasArrowSelectHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeSelectEvent.HasBeforeSelectHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, SelectEvent.HasSelectHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasIcon, HasItemId

public class ToggleButton
extends CellButtonBase<Boolean>

A 2-state toggle button.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor

Editor.Ignore, Editor.Path

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ToggleButton() Creates a new toggle button.
ToggleButton(String text) Creates a new toggle button.
ToggleButton(ToggleButtonCell cell) Creates a new toggle button.

Method Summary

Methods

Modifier and Type	Method and Description
ToggleButtonCell	getCell() Get the Cell wrapped by this widget.
boolean	isAllowDepress() Returns the allow depress state.
void	setAllowDepress(boolean allowDepress) True to allow a toggle item to be depressed (defaults to true).

Methods inherited from class com.sencha.gxt.widget.core.client.button.CellButtonBase

addArrowSelectHandler, addBeforeSelectHandler, addSelectHandler, getArrowAlign, getHTML, getIcon, getIconAlign, getMenu, getMenuAlign, getMinWidth, getMouseEvents, getScale, getText, hideMenu, onBrowserEvent, setArrowAlign, setHTML, setHTML, setIcon, setIconAlign, setMenu, setMenuAlign, setMinWidth, setMouseEvents, setScale, setTabIndex, setText, showMenu

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

addValueChangeHandler, getElement, getKeyProvider, getValue, redraw, setValue, setValue, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

ToggleButton

public ToggleButton()

Creates a new toggle button.

ToggleButton

public ToggleButton(String text)

Creates a new toggle button.

Parameters:

text - the button text

ToggleButton

public ToggleButton(ToggleButtonCell cell)

Creates a new toggle button.

Parameters:

cell - the toggle button cell

Method Detail

getCell

public ToggleButtonCell getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class CellButtonBase<Boolean>

Returns:

the Cell being wrapped

isAllowDepress

public boolean isAllowDepress()

Returns the allow depress state.

Returns:

the allow depress state

setAllowDepress

public void setAllowDepress(boolean allowDepress)

True to allow a toggle item to be depressed (defaults to true).

Parameters:

allowDepress - true to allow depressing