com.extjs.gxt.ui.client.widget.button
Class ToggleButton

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.button.Button
                      extended by com.extjs.gxt.ui.client.widget.button.ToggleButton
All Implemented Interfaces:
Observable, IconSupport, 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.IsWidget

public class ToggleButton
extends Button

A 2-state toggle button.

Events:
Toggle : ButtonEvent(button)
Fires when the "pressed" state of this button changes.


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 inherited from class com.extjs.gxt.ui.client.widget.button.Button
buttonEl, buttonSelector, icon, menu, scale, template, text
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ToggleButton()
          Creates a new toggle button.
ToggleButton(java.lang.String text)
          Creates a new toggle button.
ToggleButton(java.lang.String text, com.google.gwt.user.client.ui.AbstractImagePrototype icon)
          Creates a new toggle button with the given text and icon.
ToggleButton(java.lang.String text, SelectionListener<ButtonEvent> listener)
          Creates a new toggle button.
 
Method Summary
 java.lang.String getToggleGroup()
          Returns the toggle group name.
 boolean isAllowDepress()
           
 boolean isPressed()
          Returns true if the button is pressed.
protected  void onClick(ComponentEvent ce)
           
protected  void onFocus(ComponentEvent ce)
           
protected  void onMouseDown(ComponentEvent ce)
           
protected  void onMouseOver(ComponentEvent ce)
           
protected  void onMouseUp(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element parent, int pos)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 void setAllowDepress(boolean allowDepress)
          True to allow a toggle item to be depressed (default to true).
 void setToggleGroup(java.lang.String toggleGroup)
          Optionally, set the the button's toggle group name.
 void toggle()
          Toggles the current state.
 void toggle(boolean state)
          Sets the current pressed state.
protected  void toggle(boolean state, boolean silent)
          Sets the current pressed state.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.button.Button
addSelectionListener, afterRender, alignIcon, autoWidth, createComponentEvent, getArrowAlign, getFocusEl, getIcon, getIconAlign, getMenu, getMenuAlign, getMenuClass, getMinWidth, getMouseEvents, getScale, getText, getType, hideMenu, notifyShow, onBlur, onComponentEvent, onDetach, onDisable, onEnable, onKeyPress, onMenuHide, onMenuShow, onMouseOut, onResize, removeSelectionListener, setAriaState, setArrowAlign, setIcon, setIconAlign, setIconStyle, setMenu, setMenuAlign, setMinWidth, setMouseEvents, setScale, setTabIndex, setText, setType, showMenu
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, doDetachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, onAttach, onBrowserEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
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, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ToggleButton

public ToggleButton()
Creates a new toggle button.


ToggleButton

public ToggleButton(java.lang.String text)
Creates a new toggle button.

Parameters:
text - the button text

ToggleButton

public ToggleButton(java.lang.String text,
                    SelectionListener<ButtonEvent> listener)
Creates a new toggle button.

Parameters:
text - the button text
listener - a selection listener

ToggleButton

public ToggleButton(java.lang.String text,
                    com.google.gwt.user.client.ui.AbstractImagePrototype icon)
Creates a new toggle button with the given text and icon.

Parameters:
text - the button text
icon - the icon
Method Detail

getToggleGroup

public java.lang.String getToggleGroup()
Returns the toggle group name.

Returns:
the toggle group name

isAllowDepress

public boolean isAllowDepress()

isPressed

public boolean isPressed()
Returns true if the button is pressed.

Returns:
the pressed state

toggle

public void toggle()
Toggles the current state.


toggle

public void toggle(boolean state)
Sets the current pressed state.

Parameters:
state - true to set pressed state

setAllowDepress

public void setAllowDepress(boolean allowDepress)
True to allow a toggle item to be depressed (default to true).

Parameters:
allowDepress - true to allow depressing

setToggleGroup

public void setToggleGroup(java.lang.String toggleGroup)
Optionally, set the the button's toggle group name.

Parameters:
toggleGroup - the toggle group name

onClick

protected void onClick(ComponentEvent ce)
Overrides:
onClick in class Button

onFocus

protected void onFocus(ComponentEvent ce)
Overrides:
onFocus in class Button

onMouseDown

protected void onMouseDown(ComponentEvent ce)
Overrides:
onMouseDown in class Button

onMouseOver

protected void onMouseOver(ComponentEvent ce)
Overrides:
onMouseOver in class Button

onMouseUp

protected void onMouseUp(ComponentEvent ce)
Overrides:
onMouseUp in class Button

onRender

protected void onRender(com.google.gwt.user.client.Element parent,
                        int pos)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Button
Parameters:
parent - the target element
pos - the insert location

toggle

protected void toggle(boolean state,
                      boolean silent)
Sets the current pressed state.

Parameters:
state - true to set pressed state
silent - true to not fire the toggle event