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

Class IconButton

java.lang.Object

Widget

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

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

All Implemented Interfaces:

HasGestureRecognizers, 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, HasItemId

Direct Known Subclasses:

ToolButton

public class IconButton
extends Component
implements BeforeSelectEvent.HasBeforeSelectHandlers, SelectEvent.HasSelectHandlers

A simple css styled button with 3 states: normal, over, and disabled.

Note: To change the icon style after construction use changeStyle(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IconButton.IconButtonAppearance
static class	IconButton.IconConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected IconButton.IconButtonAppearance	appearance
protected boolean	cancelBubble
protected IconButton.IconConfig	config

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

adjustSize, allowTextSelection, cacheSizes, contextMenu, contextMenuGestureRecognizer, dataMap, deferHeight, disableContextMenu, disabled, disabledStyle, disableEvents, ensureVisibilityOnSizing, focusManagerSupport, gestureRecognizers, height, hidden, hideMode, itemId, lastSize, layer, left, mask, maskMessage, monitorWindowResize, overElements, pageX, pageY, resizeHandler, shadow, shadowPosition, shim, stateful, stateId, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
IconButton(IconButton.IconButtonAppearance appearance, IconButton.IconConfig config) Creates a new icon button.
IconButton(IconButton.IconConfig config) Creates a new icon button.
IconButton(String style) Creates a new icon button.
IconButton(String style, SelectEvent.SelectHandler handler) Creates a new icon button.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addBeforeSelectHandler(BeforeSelectEvent.BeforeSelectHandler handler) Adds a BeforeSelectEvent.BeforeSelectHandler handler for BeforeSelectEvent events.
HandlerRegistration	addSelectHandler(SelectEvent.SelectHandler handler) Adds a SelectEvent.SelectHandler handler for SelectEvent events.
void	changeStyle(IconButton.IconConfig config) Changes the icon style.
void	changeStyle(String style) Changes the icon style.
IconButton.IconButtonAppearance	getAppearance()
void	onBrowserEvent(Event event)
protected void	onClick(Event e)
protected void	onDisable()
protected void	onEnable()
protected void	onKeyPress(Event ce)

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAdjustSize, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, makeVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onDetach, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, restoreVisible, setAdjustSize, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

config

protected IconButton.IconConfig config

cancelBubble

protected boolean cancelBubble

appearance

protected final IconButton.IconButtonAppearance appearance

Constructor Detail

IconButton

public IconButton(IconButton.IconButtonAppearance appearance,
                  IconButton.IconConfig config)

Creates a new icon button.

Parameters:

appearance - the icon button appearance

config - the icon configuration

IconButton

public IconButton(IconButton.IconConfig config)

Creates a new icon button.

Parameters:

config - the icon configuration

IconButton

public IconButton(String style)

Creates a new icon button. The 'over' style and 'disabled' style names determined by adding 'Over' and 'Disabled' to the base style name.

Parameters:

style - the base style

IconButton

public IconButton(String style,
                  SelectEvent.SelectHandler handler)

Creates a new icon button. The 'over' style and 'disabled' style names determined by adding '-over' and '-disabled' to the base style name.

Parameters:

style - the base style

handler - the select handler

Method Detail

addBeforeSelectHandler

public HandlerRegistration addBeforeSelectHandler(BeforeSelectEvent.BeforeSelectHandler handler)

Description copied from interface: BeforeSelectEvent.HasBeforeSelectHandlers

Adds a BeforeSelectEvent.BeforeSelectHandler handler for BeforeSelectEvent events.

Specified by:

addBeforeSelectHandler in interface BeforeSelectEvent.HasBeforeSelectHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addSelectHandler

public HandlerRegistration addSelectHandler(SelectEvent.SelectHandler handler)

Description copied from interface: SelectEvent.HasSelectHandlers

Adds a SelectEvent.SelectHandler handler for SelectEvent events.

Specified by:

addSelectHandler in interface SelectEvent.HasSelectHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

changeStyle

public void changeStyle(IconButton.IconConfig config)

Changes the icon style.

Parameters:

config - the config object

changeStyle

public void changeStyle(String style)

Changes the icon style.

Parameters:

style - the new icon style

getAppearance

public IconButton.IconButtonAppearance getAppearance()

onBrowserEvent

public void onBrowserEvent(Event event)

Overrides:

onBrowserEvent in class Component

onClick

protected void onClick(Event e)

onDisable

protected void onDisable()

Overrides:

onDisable in class Component

onEnable

protected void onEnable()

Overrides:

onEnable in class Component

onKeyPress

protected void onKeyPress(Event ce)