com.extjs.gxt.ui.client.widget.toolbar
Class ToggleToolItem

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.toolbar.ToolItem
                  com.extjs.gxt.ui.client.widget.toolbar.TextToolItem
                      com.extjs.gxt.ui.client.widget.toolbar.ToggleToolItem

All Implemented Interfaces:

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

public class ToggleToolItem
extends TextToolItem

A 2-state tool bar item.

Events:

Toggle : ToolBarEvent(toolBar, item, event)

Fires when the "pressed" state changes.

• toolBar : the parent tolbar
• item : this
• event : the dom event

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

boolean

pressed True to start pressed.

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

DEBUG_ID_PREFIX

Constructor Summary

ToggleToolItem()
Creates a new toggle tool item.

ToggleToolItem(java.lang.String text)
Creates a new toggle tool item.

Method Summary

boolean	isPressed() Returns true if the item 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.toolbar.TextToolItem

addSelectionListener, getIconStyle, getMenu, getText, getToolBar, getToolTip, removeSelectionListener, setIconStyle, setMenu, setText, setToolTip, setToolTip

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

addListener, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, hide, hideToolTip, isEnabled, isRendered, isVisible, onBrowserEvent, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setHeight, setId, setIntStyleAttribute, setItemId, setPixelSize, setSize, setStyleAttribute, setStyleName, setTitle, setVisible, setWidth, show, 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, sinkEvents, unsinkEvents

Methods inherited from class java.lang.Object

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

Field Detail

pressed

public boolean pressed

True to start pressed.

Constructor Detail

ToggleToolItem

public ToggleToolItem()

Creates a new toggle tool item.

ToggleToolItem

public ToggleToolItem(java.lang.String text)

Creates a new toggle tool item.

Parameters:

text - the item's text

Method Detail

isPressed

public boolean isPressed()

Returns true if the item 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