com.sencha.gxt.cell.core.client.form

Class TriggerFieldCell<T>

java.lang.Object

<any>

com.sencha.gxt.cell.core.client.AbstractEventInputCell<T,FieldCell.FieldViewData>

com.sencha.gxt.cell.core.client.form.FieldCell<T>

com.sencha.gxt.cell.core.client.form.ValueBaseInputCell<T>

com.sencha.gxt.cell.core.client.form.TriggerFieldCell<T>

Type Parameters:

T - the cell model type

All Implemented Interfaces:

FocusableCell, ResizableCell, ParseErrorEvent.HasParseErrorHandlers

Direct Known Subclasses:

ComboBoxCell, DateCell, TwinTriggerFieldCell

public class TriggerFieldCell<T>
extends ValueBaseInputCell<T>

A base cell for an input field and a clickable trigger. The purpose of the trigger is defined by the derived class (e.g. displaying a drop down or modifying the value of the input field).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TriggerFieldCell.TriggerFieldAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.cell.core.client.form.ValueBaseInputCell

ValueBaseInputCell.ValueBaseFieldAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.cell.core.client.form.FieldCell

FieldCell.FieldAppearance, FieldCell.FieldAppearanceOptions, FieldCell.FieldViewData

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	finishEditOnEnter
protected static TriggerFieldCell<?>	focusedCell
protected boolean	mimicking

Fields inherited from class com.sencha.gxt.cell.core.client.form.ValueBaseInputCell

allowBlank, finishEditOnBlur, impl, name, propertyEditor

Fields inherited from class com.sencha.gxt.cell.core.client.form.FieldCell

bypassClearContext, focusContext, height, lastContext, lastParent, lastValue, lastValueUpdater, width

Constructor Summary

Constructors

Constructor and Description
TriggerFieldCell() Creates a new trigger cell instance.
TriggerFieldCell(TriggerFieldCell.TriggerFieldAppearance appearance) Creates a new trigger cell instance.

Method Summary

Modifier and Type	Method and Description
protected void	clearContext()
void	finishEditing(Element parent, T value, Object key, <any> valueUpdater)
TriggerFieldCell.TriggerFieldAppearance	getAppearance() Returns the cell's appearance.
protected void	handleFocusManagerExecute(Context context, XElement parent, T value, <any> updater) Called by the focusManager's onExecute method.
boolean	isEditable() Returns true if the field is editable.
boolean	isFinishEditOnEnter() Returns the finish on enter key state.
protected boolean	isFocusedWithTarget(Element parent, Element target) Checks if an element can be focused within the current parent.
boolean	isHideTrigger() Returns true if the trigger is hidden.
boolean	isMonitorTab() Returns true if tab key events are being monitored.
protected void	onBlur(Context context, XElement parent, T value, NativeEvent event, <any> valueUpdater)
void	onBrowserEvent(Context context, Element parent, T value, NativeEvent event, <any> valueUpdater)
protected void	onClick(Context context, XElement parent, NativeEvent event, T value, <any> updater)
protected void	onEnterKeyDown(Context context, Element parent, T value, NativeEvent event, <any> valueUpdater)
protected void	onFocus(Context context, XElement parent, T value, NativeEvent event, <any> valueUpdater)
protected void	onKeyDown(Context context, Element parent, T value, NativeEvent event, <any> valueUpdater)
protected void	onMouseDown(XElement parent, NativeEvent event)
protected void	onMouseOut(XElement parent, NativeEvent event)
protected void	onMouseOver(XElement parent, NativeEvent event)
protected void	onTap(TouchData t, Context context, Element parent, T value, <any> valueUpdater)
protected void	onTriggerClick(Context context, XElement parent, NativeEvent event, T value, <any> updater)
void	render(Context context, T value, SafeHtmlBuilder sb)
protected void	saveContext(Context context, Element parent, NativeEvent event, <any> valueUpdater, T value)
void	setEditable(XElement parent, boolean editable)
void	setFinishEditOnEnter(boolean finishEditOnEnter) Determines if the current edit should be completed when the enter key is pressed (defaults to true).
void	setHideTrigger(boolean hideTrigger) Controls the visibility of the cells trigger.
void	setMonitorTab(boolean monitorTab) True to monitor tab key events to force the bluring of the field (defaults to true).
void	setSize(XElement parent, int width, int height) Sets the size of the cell without requiring a redraw.
protected void	triggerBlur(Context context, XElement parent, T value, <any> valueUpdater)
protected boolean	validateBlur(Element target)

Methods inherited from class com.sencha.gxt.cell.core.client.form.ValueBaseInputCell

addParseErrorHandler, applyEmptyText, disable, enable, getCursorPos, getEmptyText, getFocusElement, getInputElement, getName, getPropertyEditor, getText, isAllowBlank, isClearValueOnParseError, isSelectOnFocus, onClick, onEmpty, onKeyUp, removeEmptyText, resetFocus, select, selectAll, setAllowBlank, setClearValueOnParseError, setCursorPos, setEmptyText, setName, setPropertyEditor, setSelectOnFocus, setText

Methods inherited from class com.sencha.gxt.cell.core.client.form.FieldCell

checkViewData, ensureViewData, getHeight, getWidth, handlesSelection, hasFocus, isDisabled, isReadOnly, onKeyPress, onMouseUp, onNavigationKey, onValid, redrawOnResize, setHeight, setReadOnly, setSize, setWidth

Methods inherited from class com.sencha.gxt.cell.core.client.AbstractEventInputCell

addCellGestureAdapter, addHandler, createHandlerManager, fireCancellableEvent, fireCancellableEvent, fireEvent, fireEvent, getCellGestureAdapter, getCellGestureAdapterCount, getConsumedEvents, isDisableEvents, onTouch, removeCellGestureAdapter, setDisableEvents

Methods inherited from class java.lang.Object

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

Field Detail

focusedCell

protected static TriggerFieldCell<?> focusedCell

finishEditOnEnter

protected boolean finishEditOnEnter

mimicking

protected boolean mimicking

Constructor Detail

TriggerFieldCell

public TriggerFieldCell()

Creates a new trigger cell instance.

TriggerFieldCell

public TriggerFieldCell(TriggerFieldCell.TriggerFieldAppearance appearance)

Creates a new trigger cell instance.

Parameters:

appearance - the appearance

Method Detail

finishEditing

public void finishEditing(Element parent,
                          T value,
                          Object key,
                          <any> valueUpdater)

Overrides:

finishEditing in class FieldCell<T>

getAppearance

public TriggerFieldCell.TriggerFieldAppearance getAppearance()

Description copied from class: ValueBaseInputCell

Returns the cell's appearance.

Overrides:

getAppearance in class ValueBaseInputCell<T>

Returns:

the appearance

isEditable

public boolean isEditable()

Returns true if the field is editable.

Returns:

true if editable

isFinishEditOnEnter

public boolean isFinishEditOnEnter()

Returns the finish on enter key state.

Returns:

true if editing finished on enter key

isHideTrigger

public boolean isHideTrigger()

Returns true if the trigger is hidden.

Returns:

true if hidden

isMonitorTab

public boolean isMonitorTab()

Returns true if tab key events are being monitored.

Returns:

true if monitoring

onBrowserEvent

public void onBrowserEvent(Context context,
                           Element parent,
                           T value,
                           NativeEvent event,
                           <any> valueUpdater)

Overrides:

onBrowserEvent in class FieldCell<T>

render

public void render(Context context,
                   T value,
                   SafeHtmlBuilder sb)

setEditable

public void setEditable(XElement parent,
                        boolean editable)

setFinishEditOnEnter

public void setFinishEditOnEnter(boolean finishEditOnEnter)

Determines if the current edit should be completed when the enter key is pressed (defaults to true). When enabled, the cell will be blurred causing #finishEditing(Element, Object, Object, ValueUpdater) to be called.

Parameters:

finishEditOnEnter - true to call #finishEditing(Element, Object, Object, ValueUpdater) when enter key is pressed

setHideTrigger

public void setHideTrigger(boolean hideTrigger)

Controls the visibility of the cells trigger.

Parameters:

hideTrigger - true to hide

setMonitorTab

public void setMonitorTab(boolean monitorTab)

True to monitor tab key events to force the bluring of the field (defaults to true).

Parameters:

monitorTab - true to monitor tab key events

setSize

public void setSize(XElement parent,
                    int width,
                    int height)

Description copied from interface: ResizableCell

Sets the size of the cell without requiring a redraw. This method is called by CellComponent when ResizableCell.redrawOnResize() returns false.

Specified by:

setSize in interface ResizableCell

Overrides:

setSize in class FieldCell<T>

Parameters:

parent - the parent element

width - the width

height - the height

handleFocusManagerExecute

protected void handleFocusManagerExecute(Context context,
                                         XElement parent,
                                         T value,
                                         <any> updater)

Called by the focusManager's onExecute method.

clearContext

protected void clearContext()

Overrides:

clearContext in class FieldCell<T>

isFocusedWithTarget

protected boolean isFocusedWithTarget(Element parent,
                                      Element target)

Checks if an element can be focused within the current parent. Allows subclasses to let external elements take the focus and still consider this field to be focused.

Parameters:

parent - the parent element of the active cell

target - the element which may have or receive focus

Returns:

true of this cell can still have logical focus if the target has dom focus

onBlur

protected void onBlur(Context context,
                      XElement parent,
                      T value,
                      NativeEvent event,
                      <any> valueUpdater)

Overrides:

onBlur in class ValueBaseInputCell<T>

onClick

protected void onClick(Context context,
                       XElement parent,
                       NativeEvent event,
                       T value,
                       <any> updater)

onTap

protected void onTap(TouchData t,
                     Context context,
                     Element parent,
                     T value,
                     <any> valueUpdater)

Overrides:

onTap in class ValueBaseInputCell<T>

onEnterKeyDown

protected void onEnterKeyDown(Context context,
                              Element parent,
                              T value,
                              NativeEvent event,
                              <any> valueUpdater)

onFocus

protected void onFocus(Context context,
                       XElement parent,
                       T value,
                       NativeEvent event,
                       <any> valueUpdater)

Overrides:

onFocus in class ValueBaseInputCell<T>

onKeyDown

protected void onKeyDown(Context context,
                         Element parent,
                         T value,
                         NativeEvent event,
                         <any> valueUpdater)

Overrides:

onKeyDown in class FieldCell<T>

onMouseDown

protected void onMouseDown(XElement parent,
                           NativeEvent event)

Overrides:

onMouseDown in class ValueBaseInputCell<T>

onMouseOut

protected void onMouseOut(XElement parent,
                          NativeEvent event)

Overrides:

onMouseOut in class FieldCell<T>

onMouseOver

protected void onMouseOver(XElement parent,
                           NativeEvent event)

Overrides:

onMouseOver in class FieldCell<T>

onTriggerClick

protected void onTriggerClick(Context context,
                              XElement parent,
                              NativeEvent event,
                              T value,
                              <any> updater)

saveContext

protected void saveContext(Context context,
                           Element parent,
                           NativeEvent event,
                           <any> valueUpdater,
                           T value)

Overrides:

saveContext in class FieldCell<T>

triggerBlur

protected void triggerBlur(Context context,
                           XElement parent,
                           T value,
                           <any> valueUpdater)

validateBlur

protected boolean validateBlur(Element target)