com.sencha.gxt.widget.core.client.form

Class TriggerField<T>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

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

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

com.sencha.gxt.widget.core.client.form.Field<T>

com.sencha.gxt.widget.core.client.form.ValueBaseField<T>

com.sencha.gxt.widget.core.client.form.TriggerField<T>

Type Parameters:

T - the field type

All Implemented Interfaces:

Editor<T>, HasEditorDelegate<T>, HasEditorErrors<T>, LeafValueEditor<T>, ValueAwareEditor<T>, HasChangeHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasAttachHandlers, HasResizeHandlers, HasValueChangeHandlers<T>, HasHandlers, AutoDirectionHandler.Target, HasDirection, HasDirectionEstimator, EventListener, TakesValue<T>, HasEnabled, HasName, HasText, HasValue<T>, HasVisibility, IsWidget, HasKeyProvider<T>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, ParseErrorEvent.HasParseErrorHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, TriggerClickEvent.HasTriggerClickHandlers, ValidEvent.HasValidHandlers, HasErrorHandler, IsField<T>, HasFocusSupport, HasItemId

Direct Known Subclasses:

ComboBox, DateField, StoreFilterField, TwinTriggerField

public abstract class TriggerField<T>
extends ValueBaseField<T>
implements TriggerClickEvent.HasTriggerClickHandlers

An abstract base class 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/interfaces inherited from class com.sencha.gxt.widget.core.client.form.Field

Field.FieldStyles

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection

HasDirection.Direction

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addTriggerClickHandler(TriggerClickEvent.TriggerClickHandler handler) Adds a TriggerClickEvent.TriggerClickHandler handler for TriggerClickEvent events.
TriggerFieldCell<T>	getCell() Get the Cell wrapped by this widget.
boolean	isEditable() Returns true if the field is editable.
boolean	isFinishEditOnEnter() Returns the finish on enter key state.
boolean	isMonitorTab() Returns true if tab key events are being monitored.
void	setEditable(boolean editable) Allow or prevent the user from directly editing the field text (defaults to true).
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) Sets the visibility of the trigger.
void	setMonitorTab(boolean monitorTab) True to monitor tab key events to force the bluring of the field (defaults to true).

Methods inherited from class com.sencha.gxt.widget.core.client.form.ValueBaseField

addChangeHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addParseErrorHandler, clear, getCurrentValue, getCursorPos, getDirection, getDirectionEstimator, getEmptyText, getPropertyEditor, getSelectedText, getSelectionLength, getText, getValueOrThrow, isAllowBlank, isClearValueOnParseError, isCurrentValid, isCurrentValid, isReadOnly, isSelectOnFocus, select, selectAll, setAllowBlank, setClearValueOnParseError, setCursorPos, setDirection, setDirectionEstimator, setDirectionEstimator, setEmptyText, setId, setPropertyEditor, setReadOnly, setSelectionRange, setSelectOnFocus, setTabIndex, setText, setValue, validateCurrent

Methods inherited from class com.sencha.gxt.widget.core.client.form.Field

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, clearInvalid, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getName, getOriginalValue, getValidateOnBlur, getValidationDelay, getValidators, isAutoValidate, isEditing, isValid, isValid, markInvalid, onBrowserEvent, onPropertyChange, removeValidator, reset, setAutoValidate, setDelegate, setErrorSupport, setName, setOriginalValue, setValidateOnBlur, setValidationDelay, setValue, showErrors, validate, validate

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

getElement, getKeyProvider, getValue, redraw, setValue

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface com.google.gwt.user.client.TakesValue

getValue

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Methods inherited from interface com.google.gwt.user.client.ui.HasValue

getValue, setValue

Method Detail

addTriggerClickHandler

public HandlerRegistration addTriggerClickHandler(TriggerClickEvent.TriggerClickHandler handler)

Description copied from interface: TriggerClickEvent.HasTriggerClickHandlers

Adds a TriggerClickEvent.TriggerClickHandler handler for TriggerClickEvent events.

Specified by:

addTriggerClickHandler in interface TriggerClickEvent.HasTriggerClickHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getCell

public TriggerFieldCell<T> getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class ValueBaseField<T>

Returns:

the Cell being wrapped

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

isMonitorTab

public boolean isMonitorTab()

Returns true if tab key events are being monitored.

Returns:

true if monitoring

setEditable

public void setEditable(boolean editable)

Allow or prevent the user from directly editing the field text (defaults to true). If false is passed, the user will only be able to select from the items defined in the dropdown list.

Parameters:

editable - true to allow the user to directly edit the field text

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 field will be blurred causing TriggerFieldCell.finishEditing(Element, Object, Object, ValueUpdater) to be called.

Parameters:

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

setHideTrigger

public void setHideTrigger(boolean hideTrigger)

Sets the visibility of the trigger.

Parameters:

hideTrigger - true to hide the trigger

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