com.extjs.gxt.ui.client.widget.form
Class DateField

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<java.util.Date>
                              extended by com.extjs.gxt.ui.client.widget.form.DateField
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

public class DateField
extends TriggerField<java.util.Date>

Provides a date input field with a DatePicker dropdown and automatic date validation.

Inherited Events:
Field Focus
Field Blur
Field Change
Field Invalid
Field Valid
Field KeyPress
Field SpecialKey
TriggerField TriggerClick


Nested Class Summary
 class DateField.DateFieldMessages
          DateField error messages.
 
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
 
Fields inherited from class com.extjs.gxt.ui.client.widget.form.TriggerField
focusEventPreview, mimicing, trigger, 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
DateField()
          Creates a new date field.
 
Method Summary
protected  void expand()
           
 DatePicker getDatePicker()
          Returns the field's date picker.
 java.util.Date getMaxValue()
          Returns the field's max value.
 DateField.DateFieldMessages getMessages()
          Returns the field's messages.
 java.util.Date getMinValue()
          Returns the field's min value.
 DateTimePropertyEditor getPropertyEditor()
          Returns the field's property editor.
 boolean isFormatValue()
          Returns true if formatting is enabled.
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 onTriggerClick(ComponentEvent ce)
           
 void setFormatValue(boolean formatValue)
          True to format the user entered value using the field's property editor after passing validation (defaults to false).
 void setMaxValue(java.util.Date maxValue)
          Sets the field's max value.
 void setMinValue(java.util.Date minValue)
          The maximum date allowed.
protected  boolean validateBlur(DomEvent e, com.google.gwt.user.client.Element target)
           
protected  boolean validateValue(java.lang.String value)
          Subclasses should provide the validation implementation by overriding this.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.TriggerField
adjustInputSize, afterRender, beforeBlur, getTriggerStyle, isEditable, isHideTrigger, isMonitorTab, mimicBlur, onBlur, onClick, onDisable, onEnable, onFocus, onResize, setEditable, setHideTrigger, setMonitorTab, setReadOnly, setTriggerStyle, triggerBlur
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.TextField
applyEmptyText, getAllowBlank, getCursorPos, getFocusEl, getInputEl, getMaxLength, getMinLength, getRegex, getSelectedText, getSelectionLength, getSelectOnFocus, getStyleEl, getValidator, isPassword, onComponentEvent, removeEmptyText, select, selectAll, setAllowBlank, setAriaState, setCursorPos, setEmptyText, setMaxLength, setMinLength, setPassword, setRegex, setSelectionRange, setSelectOnFocus, setValidator, setValue
 
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, 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
 

Constructor Detail

DateField

public DateField()
Creates a new date field.

Method Detail

getDatePicker

public DatePicker getDatePicker()
Returns the field's date picker.

Returns:
the date picker

getMaxValue

public java.util.Date getMaxValue()
Returns the field's max value.

Returns:
the max value

getMessages

public DateField.DateFieldMessages getMessages()
Description copied from class: Field
Returns the field's messages.

Overrides:
getMessages in class TextField<java.util.Date>
Returns:
the messages

getMinValue

public java.util.Date getMinValue()
Returns the field's min value.

Returns:
the min value

getPropertyEditor

public DateTimePropertyEditor getPropertyEditor()
Description copied from class: Field
Returns the field's property editor.

Overrides:
getPropertyEditor in class Field<java.util.Date>
Returns:
the property editor

isFormatValue

public boolean isFormatValue()
Returns true if formatting is enabled.

Returns:
the format value state

setFormatValue

public void setFormatValue(boolean formatValue)
True to format the user entered value using the field's property editor after passing validation (defaults to false). Format value should not be enabled when auto validating.

Parameters:
formatValue - true to format the user value

setMaxValue

public void setMaxValue(java.util.Date maxValue)
Sets the field's max value.

Parameters:
maxValue - the max value

setMinValue

public void setMinValue(java.util.Date minValue)
The maximum date allowed.

Parameters:
minValue - the max value

expand

protected void expand()

onKeyDown

protected void onKeyDown(FieldEvent fe)
Overrides:
onKeyDown in class TriggerField<java.util.Date>

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 TriggerField<java.util.Date>
Parameters:
target - the target element
index - the insert location

onTriggerClick

protected void onTriggerClick(ComponentEvent ce)
Overrides:
onTriggerClick in class TriggerField<java.util.Date>

validateBlur

protected boolean validateBlur(DomEvent e,
                               com.google.gwt.user.client.Element target)
Overrides:
validateBlur in class TriggerField<java.util.Date>

validateValue

protected boolean validateValue(java.lang.String value)
Description copied from class: Field
Subclasses should provide the validation implementation by overriding this.

Overrides:
validateValue in class TextField<java.util.Date>
Parameters:
value - the value to validate
Returns:
true for valid