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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.button.Button
                  com.extjs.gxt.ui.client.widget.button.ToggleButton

All Implemented Interfaces:

Observable, com.google.gwt.user.client.EventListener

public class ToggleButton
extends Button

A 2-state toggle button.

Events:

Toggle : ButtonEvent(button)

Fires when the "pressed" state of this button changes.

• button : this

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

buttonTemplate

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, SelectionListener listener)
Creates a new toggle button.

Method Summary

boolean	isPressed() Returns true if the button is pressed.
void	toggle() Toggles the current state.
void	toggle(boolean state) Sets the current pressed state.

Methods inherited from class com.extjs.gxt.ui.client.widget.button.Button

addSelectionListener, getIconStyle, getMenu, getMenuAlign, getMinWidth, getMouseEvents, getText, getType, hideMenu, onComponentEvent, removeSelectionListener, setIconStyle, setMenu, setMenuAlign, setMinWidth, setMouseEvents, setTabIndex, setText, setType, showMenu

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addPlugin, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isVisible, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setHeight, setId, setIntStyleAttribute, setItemId, setPixelSize, setSize, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWidth, show, sinkEvents, toString

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

getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, 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 listener)

Creates a new toggle button.

Parameters:

text - the button text

listener - a selection listener

Method Detail

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