com.sencha.gxt.widget.core.client.cell

Class CellComponent<C>

java.lang.Object

Widget

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

com.sencha.gxt.widget.core.client.cell.CellComponent<C>

Type Parameters:

C - the type that the Cell represents

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

CellButtonBase, CellField, ColorPalette, Field, ProgressBar

public class CellComponent<C>
extends Component

A Component that wraps a Cell.

It is important to note that a single cell instance should not be used in a single CellComponent instance.

Subclasses should be aware that redraw() calls are deferred before the component is "rendered". The component is rendered when getElement is called for the first time, typically, when the component is added to a panel or container. To force a redraw use redraw(boolean).

Field Summary

Fields

Modifier and Type	Field and Description
protected <any>	valueUpdater The ValueUpdater used to trigger value update events.

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

Modifier	Constructor and Description
protected	CellComponent(<any> cell) Construct a new CellWidget with the specified cell and an initial value of null.
protected	CellComponent(<any> cell, <any> keyProvider) Construct a new CellWidget with the specified cell and key provider, and an initial value of null.
protected	CellComponent(<any> cell, C initialValue) Construct a new CellWidget with the specified cell and initial value.
protected	CellComponent(<any> cell, C initialValue, <any> keyProvider) Construct a new CellWidget with the specified cell, initial value, and key provider.
protected	CellComponent(<any> cell, C initialValue, <any> keyProvider, boolean inlineBlock) Creates a new cell component.
protected	CellComponent(<any> cell, C initialValue, <any> keyProvider, Element elem) Creates a CellWidget with the specified cell, initial value, key provider, using the specified element as the wrapper around the cell.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addValueChangeHandler(<any> handler)
protected Context	createContext() Get the Context for the cell.
<any>	getCell() Get the Cell wrapped by this widget.
XElement	getElement() Gets a handle to the object's underlying DOM element.
protected XElement	getFocusEl()
protected Object	getKey(C value) Get the key for the specified value.
<any>	getKeyProvider()
C	getValue()
void	onBrowserEvent(Event event)
protected void	onDisable()
protected void	onEnable()
protected void	onRedraw()
protected void	onResize(int width, int height) Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
void	redraw() Redraw the widget.
protected boolean	redraw(boolean force)
protected void	setKeyProvider(<any> keyProvider)
void	setValue(C value)
void	setValue(C value, boolean fireEvents)
void	setValue(C value, boolean fireEvents, boolean redraw) Sets this object's value and optionally redraw the widget.

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

valueUpdater

protected final <any> valueUpdater

The ValueUpdater used to trigger value update events.

Constructor Detail

CellComponent

protected CellComponent(<any> cell)

Construct a new CellWidget with the specified cell and an initial value of null.

Parameters:

cell - the cell to wrap

CellComponent

protected CellComponent(<any> cell,
                        C initialValue)

Construct a new CellWidget with the specified cell and initial value.

Parameters:

cell - the cell to wrap

initialValue - the initial value of the Cell

CellComponent

protected CellComponent(<any> cell,
                        C initialValue,
                        <any> keyProvider)

Construct a new CellWidget with the specified cell, initial value, and key provider.

Parameters:

cell - the cell to wrap

initialValue - the initial value of the Cell

keyProvider - the key provider used to get keys from values

CellComponent

protected CellComponent(<any> cell,
                        C initialValue,
                        <any> keyProvider,
                        boolean inlineBlock)

Creates a new cell component.

Parameters:

cell - the cell

initialValue - the initial value

keyProvider - the key provider

inlineBlock - true for inline block

CellComponent

protected CellComponent(<any> cell,
                        C initialValue,
                        <any> keyProvider,
                        Element elem)

Creates a CellWidget with the specified cell, initial value, key provider, using the specified element as the wrapper around the cell.

Parameters:

cell - the cell to wrap

initialValue - the initial value of the Cell

keyProvider - the key provider used to get keys from values

elem - the browser element to use

CellComponent

protected CellComponent(<any> cell,
                        <any> keyProvider)

Construct a new CellWidget with the specified cell and key provider, and an initial value of null.

Parameters:

cell - the cell to wrap

keyProvider - the key provider used to get keys from values

Method Detail

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(<any> handler)

getCell

public <any> getCell()

Get the Cell wrapped by this widget.

Returns:

the Cell being wrapped

getElement

public XElement getElement()

Description copied from class: Component

Gets a handle to the object's underlying DOM element. This method should not be overridden. It is non-final solely to support legacy code that depends upon overriding it. If it is overridden, the subclass implementation must not return a different element than was previously set using #setElement(com.google.gwt.dom.client.Element).

Overrides:

getElement in class Component

Returns:

the object's browser element

getKeyProvider

public <any> getKeyProvider()

getValue

public C getValue()

onBrowserEvent

public void onBrowserEvent(Event event)

Overrides:

onBrowserEvent in class Component

redraw

public void redraw()

Redraw the widget.

redraw

protected boolean redraw(boolean force)

onRedraw

protected void onRedraw()

setValue

public void setValue(C value)

This method will redraw the widget if the new value does not equal the existing value.

setValue

public void setValue(C value,
                     boolean fireEvents)

This method will redraw the widget if the new value does not equal the existing value.

setValue

public void setValue(C value,
                     boolean fireEvents,
                     boolean redraw)

Sets this object's value and optionally redraw the widget. Fires ValueChangeEvent when fireEvents is true and the new value does not equal the existing value. Redraws the widget when redraw is true and the new value does not equal the existing value.

Parameters:

value - the object's new value

fireEvents - fire events if true and value is new

redraw - redraw the widget if true and value is new

createContext

protected Context createContext()

Get the Context for the cell.

getFocusEl

protected XElement getFocusEl()

Overrides:

getFocusEl in class Component

getKey

protected Object getKey(C value)

Get the key for the specified value.

Parameters:

value - the value

Returns:

the key

onDisable

protected void onDisable()

Overrides:

onDisable in class Component

onEnable

protected void onEnable()

Overrides:

onEnable in class Component

onResize

protected void onResize(int width,
                        int height)

Description copied from class: Component

Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:

onResize in class Component

Parameters:

width - the width

height - the height

setKeyProvider

protected void setKeyProvider(<any> keyProvider)