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

Class CellButtonBase<C>

java.lang.Object

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<C>

All Implemented Interfaces:

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

Direct Known Subclasses:

TextButton, ToggleButton

public class CellButtonBase<C>
extends CellComponent<C>
implements HasIcon, BeforeSelectEvent.HasBeforeSelectHandlers, SelectEvent.HasSelectHandlers, ArrowSelectEvent.HasArrowSelectHandlers

Field Summary

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

valueUpdater

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

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
CellButtonBase()
CellButtonBase(ButtonCell<C> cell)
CellButtonBase(ButtonCell<C> cell, C initialValue)

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addArrowSelectHandler(ArrowSelectEvent.ArrowSelectHandler handler) Adds a ArrowSelectEvent.ArrowSelectHandler handler for ArrowSelectEvent events.
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.
protected Context	createContext() Get the Context for the cell.
ButtonCell.ButtonArrowAlign	getArrowAlign() Returns the button's arrow alignment.
ButtonCell<C>	getCell() Get the Cell wrapped by this widget.
String	getHTML()
ImageResource	getIcon() Returns the icon.
ButtonCell.IconAlign	getIconAlign() Returns the button's icon alignment.
Menu	getMenu() Returns the button's menu (if it has one).
Style.AnchorAlignment	getMenuAlign() Returns the button's menu alignment.
int	getMinWidth() Returns the button's minimum width.
boolean	getMouseEvents() Returns false if mouse over effect is disabled.
ButtonCell.ButtonScale	getScale() Returns the button's scale.
String	getText()
void	hideMenu() Hide this button's menu (if it has one).
void	onBrowserEvent(Event event)
protected void	onClick(Event event)
protected void	onRedraw()
protected void	onUnload()
void	setArrowAlign(ButtonCell.ButtonArrowAlign arrowAlign) Sets the arrow alignment (defaults to RIGHT).
void	setHTML(SafeHtml html)
void	setIcon(ImageResource icon) Sets the icon.
void	setIconAlign(ButtonCell.IconAlign iconAlign) Sets the icon alignment (defaults to LEFT).
void	setMenu(Menu menu) Sets the button's menu.
void	setMenuAlign(Style.AnchorAlignment menuAlign) Sets the position to align the menu to, see XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) for more details (defaults to 'tl-bl?', pre-render).
void	setMinWidth(int minWidth) Sets he minimum width for this button (used to give a set of buttons a common width)
void	setMouseEvents(boolean handleMouseEvents) False to disable visual cues on mouseover, mouseout and mousedown (defaults to true).
void	setScale(ButtonCell.ButtonScale scale) Sets the button's scale.
void	setTabIndex(int tabIndex) Sets the component's tab index.
void	setText(String text)
void	showMenu() Show this button's menu (if it has one).

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

addValueChangeHandler, getElement, getFocusEl, getKey, getKeyProvider, getValue, onDisable, onEnable, onResize, redraw, redraw, setKeyProvider, setValue, setValue, setValue

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, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onDetach, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, 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

Constructor Detail

CellButtonBase

public CellButtonBase()

CellButtonBase

public CellButtonBase(ButtonCell<C> cell)

CellButtonBase

public CellButtonBase(ButtonCell<C> cell,
                      C initialValue)

Method Detail

addArrowSelectHandler

public HandlerRegistration addArrowSelectHandler(ArrowSelectEvent.ArrowSelectHandler handler)

Description copied from interface: ArrowSelectEvent.HasArrowSelectHandlers

Adds a ArrowSelectEvent.ArrowSelectHandler handler for ArrowSelectEvent events.

Specified by:

addArrowSelectHandler in interface ArrowSelectEvent.HasArrowSelectHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

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

getArrowAlign

public ButtonCell.ButtonArrowAlign getArrowAlign()

Returns the button's arrow alignment.

Returns:

the arrow alignment

getCell

public ButtonCell<C> getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class CellComponent<C>

Returns:

the Cell being wrapped

getHTML

public String getHTML()

getIcon

public ImageResource getIcon()

Description copied from interface: HasIcon

Returns the icon.

Specified by:

getIcon in interface HasIcon

Returns:

the icon

getIconAlign

public ButtonCell.IconAlign getIconAlign()

Returns the button's icon alignment.

Returns:

the icon alignment

getMenu

public Menu getMenu()

Returns the button's menu (if it has one).

Returns:

the menu

getMenuAlign

public Style.AnchorAlignment getMenuAlign()

Returns the button's menu alignment.

Returns:

the menu alignment

getMinWidth

public int getMinWidth()

Returns the button's minimum width.

Returns:

the minWidth the minimum width

getMouseEvents

public boolean getMouseEvents()

Returns false if mouse over effect is disabled.

Returns:

false if mouse effects disabled

getScale

public ButtonCell.ButtonScale getScale()

Returns the button's scale.

Returns:

the button scale

getText

public String getText()

hideMenu

public void hideMenu()

Hide this button's menu (if it has one).

onBrowserEvent

public void onBrowserEvent(Event event)

Overrides:

onBrowserEvent in class CellComponent<C>

onRedraw

protected void onRedraw()

Overrides:

onRedraw in class CellComponent<C>

onUnload

protected void onUnload()

Overrides:

onUnload in class Component

setArrowAlign

public void setArrowAlign(ButtonCell.ButtonArrowAlign arrowAlign)

Sets the arrow alignment (defaults to RIGHT).

Parameters:

arrowAlign - the arrow alignment

setHTML

public void setHTML(SafeHtml html)

setIcon

public void setIcon(ImageResource icon)

Description copied from interface: HasIcon

Sets the icon.

Specified by:

setIcon in interface HasIcon

Parameters:

icon - the icon

setIconAlign

public void setIconAlign(ButtonCell.IconAlign iconAlign)

Sets the icon alignment (defaults to LEFT).

Parameters:

iconAlign - the icon alignment

setMenu

public void setMenu(Menu menu)

Sets the button's menu.

Parameters:

menu - the menu

setMenuAlign

public void setMenuAlign(Style.AnchorAlignment menuAlign)

Sets the position to align the menu to, see XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) for more details (defaults to 'tl-bl?', pre-render).

Parameters:

menuAlign - the menu alignment

setMinWidth

public void setMinWidth(int minWidth)

Sets he minimum width for this button (used to give a set of buttons a common width)

Parameters:

minWidth - the minimum width

setMouseEvents

public void setMouseEvents(boolean handleMouseEvents)

False to disable visual cues on mouseover, mouseout and mousedown (defaults to true).

Parameters:

handleMouseEvents - false to disable mouse over changes

setScale

public void setScale(ButtonCell.ButtonScale scale)

Sets the button's scale.

Parameters:

scale - the scale

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from class: Component

Sets the component's tab index. Subclasses may override this to set the tab index on a specific element for better focus behavior - they are also responsible for setting the tabIndex field.

Overrides:

setTabIndex in class Component

Parameters:

tabIndex - the tab index

setText

public void setText(String text)

showMenu

public void showMenu()

Show this button's menu (if it has one).

createContext

protected Context createContext()

Description copied from class: CellComponent

Get the Context for the cell.

Overrides:

createContext in class CellComponent<C>

onClick

protected void onClick(Event event)