com.extjs.gxt.ui.client.widget.form
Class TriggerField<D>

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.form.Field<D>
                      extended by com.extjs.gxt.ui.client.widget.form.TextField<D>
                          extended by com.extjs.gxt.ui.client.widget.form.TriggerField<D>
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget
Direct Known Subclasses:
ComboBox, DateField, StoreFilterField, TwinTriggerField

public class TriggerField<D>
extends TextField<D>

Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default).

Events:
TriggerClick : FieldEvent(field, event)
Fires after the trigger is clicked.
Inherited Events:
Field Focus
Field Blur
Field Change
Field Invalid
Field Valid
Field KeyPress
Field SpecialKey


Nested Class Summary
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.TextField
TextField.TextFieldMessages
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field
Field.FieldImages, Field.FieldMessages
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  BaseEventPreview focusEventPreview
           
protected  boolean mimicing
           
protected  El trigger
           
protected  java.lang.String triggerStyle
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.form.TextField
emptyStyle, impl, input, validator
 
Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field
autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
TriggerField()
           
 
Method Summary
protected  Size adjustInputSize()
           
protected  void afterRender()
          Called after the component has been rendered and is attached for the first time.
protected  void beforeBlur()
           
 java.lang.String getTriggerStyle()
          Returns the trigger style.
 boolean isEditable()
          Returns true if the combo is editable.
 boolean isHideTrigger()
          Returns true if the trigger is hidden.
 boolean isMonitorTab()
          Returns true if tab key events are being monitored.
protected  void mimicBlur(PreviewEvent e, com.google.gwt.user.client.Element target)
           
protected  void onBlur(ComponentEvent ce)
           
protected  void onClick(ComponentEvent ce)
           
protected  void onDisable()
           
protected  void onEnable()
           
protected  void onFocus(ComponentEvent ce)
           
protected  void onKeyDown(FieldEvent fe)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void onResize(int width, int height)
          Called after the component 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.
protected  void onTriggerClick(ComponentEvent ce)
           
 void setEditable(boolean editable)
          Allow or prevent the user from directly editing the field text.
 void setHideTrigger(boolean hideTrigger)
          True to hide the trigger (defaults to false, pre-render).
 void setMonitorTab(boolean monitorTab)
          True to monitor tab key events to force the bluring of the field (defaults to true).
 void setReadOnly(boolean readOnly)
          Sets the field's read only state.
 void setTriggerStyle(java.lang.String triggerStyle)
          Sets the trigger style name.
protected  void triggerBlur(ComponentEvent ce)
           
protected  boolean validateBlur(DomEvent ce, com.google.gwt.user.client.Element target)
           
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.TextField
applyEmptyText, getAllowBlank, getCursorPos, getFocusEl, getInputEl, getMaxLength, getMessages, getMinLength, getRegex, getSelectedText, getSelectionLength, getSelectOnFocus, getStyleEl, getValidator, isPassword, onComponentEvent, removeEmptyText, select, selectAll, setAllowBlank, setAriaState, setCursorPos, setEmptyText, setMaxLength, setMinLength, setPassword, setRegex, setSelectionRange, setSelectOnFocus, setValidator, setValue, validateValue
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field
addInputStyleName, addKeyListener, alignErrorIcon, clear, clearInvalid, createComponentEvent, doDetachChildren, findLabelElement, fireChangeEvent, fireKey, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getRawValue, getValidateOnBlur, getValidationDelay, getValue, initValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, isValid, markInvalid, onDetach, onHide, onKeyPress, onKeyUp, onShow, removeInputStyleName, removeKeyListener, reset, setAutoValidate, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setInputStyleAttribute, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setRawValue, setTabIndex, setValidateOnBlur, setValidationDelay, updateOriginalValue, validate, validate
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onAttach, onBrowserEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

focusEventPreview

protected BaseEventPreview focusEventPreview

trigger

protected El trigger

triggerStyle

protected java.lang.String triggerStyle

mimicing

protected boolean mimicing
Constructor Detail

TriggerField

public TriggerField()
Method Detail

getTriggerStyle

public java.lang.String getTriggerStyle()
Returns the trigger style.

Returns:
the trigger style

isEditable

public boolean isEditable()
Returns true if the combo is editable.

Returns:
true if editable

isHideTrigger

public boolean isHideTrigger()
Returns true if the trigger is hidden.

Returns:
the hide trigger state

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

setHideTrigger

public void setHideTrigger(boolean hideTrigger)
True to hide the trigger (defaults to false, pre-render).

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

setTriggerStyle

public void setTriggerStyle(java.lang.String triggerStyle)
Sets the trigger style name.

Parameters:
triggerStyle -

setReadOnly

public void setReadOnly(boolean readOnly)
Description copied from class: Field
Sets the field's read only state.

Overrides:
setReadOnly in class Field<D>
Parameters:
readOnly - the read only state

adjustInputSize

protected Size adjustInputSize()
Overrides:
adjustInputSize in class TextField<D>

afterRender

protected void afterRender()
Description copied from class: Component
Called after the component has been rendered and is attached for the first time. At this time, the component will be part of the DOM which is required when retrieving location and offsets.

Overrides:
afterRender in class Field<D>

beforeBlur

protected void beforeBlur()

mimicBlur

protected void mimicBlur(PreviewEvent e,
                         com.google.gwt.user.client.Element target)

onKeyDown

protected void onKeyDown(FieldEvent fe)
Overrides:
onKeyDown in class Field<D>

onBlur

protected void onBlur(ComponentEvent ce)
Overrides:
onBlur in class TextField<D>

onClick

protected void onClick(ComponentEvent ce)
Overrides:
onClick in class Field<D>

onDisable

protected void onDisable()
Overrides:
onDisable in class Field<D>

onEnable

protected void onEnable()
Overrides:
onEnable in class Field<D>

onFocus

protected void onFocus(ComponentEvent ce)
Overrides:
onFocus in class TextField<D>

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class TextField<D>
Parameters:
target - the target element
index - the insert location

onResize

protected void onResize(int width,
                        int height)
Description copied from class: BoxComponent
Called after the component 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 TextField<D>
Parameters:
width - the width
height - the height

onTriggerClick

protected void onTriggerClick(ComponentEvent ce)

triggerBlur

protected void triggerBlur(ComponentEvent ce)

validateBlur

protected boolean validateBlur(DomEvent ce,
                               com.google.gwt.user.client.Element target)