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

Class TriggerFieldCell<T>

java.lang.Object

com.google.gwt.cell.client.AbstractCell<C>

com.google.gwt.cell.client.AbstractEditableCell<C,V>

com.google.gwt.cell.client.AbstractInputCell<T,V>

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:

Cell<T>, 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

Nested classes/interfaces inherited from interface com.google.gwt.cell.client.Cell

Cell.Context

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

Methods

Modifier and Type	Method and Description
void	finishEditing(Element parent, T value, Object key, ValueUpdater<T> valueUpdater)
TriggerFieldCell.TriggerFieldAppearance	getAppearance() Returns the cell's appearance.
boolean	isEditable() Returns true if the field is editable.
boolean	isFinishEditOnEnter() Returns the finish on enter key state.
boolean	isHideTrigger() Returns true if the trigger is hidden.
boolean	isMonitorTab() Returns true if tab key events are being monitored.
void	onBrowserEvent(Cell.Context context, Element parent, T value, NativeEvent event, ValueUpdater<T> valueUpdater)
void	render(Cell.Context context, T value, SafeHtmlBuilder sb)
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.

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

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

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

getHeight, getWidth, handlesSelection, isDisabled, isReadOnly, onValid, redrawOnResize, setHeight, setReadOnly, setSize, setWidth

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

addHandler, fireEvent, isDisableEvents, setDisableEvents

Methods inherited from class com.google.gwt.cell.client.AbstractInputCell

isEditing

Methods inherited from class com.google.gwt.cell.client.AbstractEditableCell

clearViewData, getViewData, setViewData

Methods inherited from class com.google.gwt.cell.client.AbstractCell

dependsOnSelection, getConsumedEvents, setValue

Methods inherited from class java.lang.Object

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

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,
                 ValueUpdater<T> 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(Cell.Context context,
                  Element parent,
                  T value,
                  NativeEvent event,
                  ValueUpdater<T> valueUpdater)

Specified by:

onBrowserEvent in interface Cell<T>

Overrides:

onBrowserEvent in class FieldCell<T>

render

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

Specified by:

render in interface Cell<T>

Specified by:

render in class AbstractCell<T>

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