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

Class DateField

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

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

All Implemented Interfaces:

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

public class DateField
extends TriggerField<Date>
implements ExpandEvent.HasExpandHandlers, CollapseEvent.HasCollapseHandlers

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

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

Constructor Summary

Constructors

Constructor and Description
DateField() Creates a new date field.
DateField(DateCell cell) Creates a new date field.
DateField(DateCell cell, DateTimePropertyEditor propertyEditor) Creates a new date field.
DateField(DateTimePropertyEditor propertyEditor) Creates a new date field.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addCollapseHandler(CollapseEvent.CollapseHandler handler) Adds a CollapseEvent.CollapseHandler handler for CollapseEvent events.
HandlerRegistration	addExpandHandler(ExpandEvent.ExpandHandler handler) Adds a ExpandEvent.ExpandHandler handler for ExpandEvent events.
DateCell	getCell() Get the Cell wrapped by this widget.
DatePicker	getDatePicker() Returns the field's date picker.
Date	getMaxValue() Returns the field's max value.
Date	getMinValue() Returns the field's minimum value.
DateTimePropertyEditor	getPropertyEditor() Returns the field's property editor.
void	setAutoValidate(boolean autoValidate) Sets whether the value is validated on each key press and when a date is selected via the picker (defaults to false).
void	setMaxValue(Date maxValue) The maximum date allowed.
void	setMinValue(Date minValue) The minimum date allowed.

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

addTriggerClickHandler, isEditable, isFinishEditOnEnter, isMonitorTab, setEditable, setFinishEditOnEnter, setHideTrigger, setMonitorTab

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

addChangeHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addParseErrorHandler, clear, getCurrentValue, getCursorPos, getDirection, getDirectionEstimator, getEmptyText, 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, 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, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, 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

Constructor Detail

DateField

public DateField()

Creates a new date field.

DateField

public DateField(DateCell cell)

Creates a new date field.

Parameters:

cell - the date cell

DateField

public DateField(DateCell cell,
         DateTimePropertyEditor propertyEditor)

Creates a new date field.

Parameters:

cell - the date cell

propertyEditor - the property editor

DateField

public DateField(DateTimePropertyEditor propertyEditor)

Creates a new date field.

Parameters:

propertyEditor - the property editor

Method Detail

setAutoValidate

public void setAutoValidate(boolean autoValidate)

Sets whether the value is validated on each key press and when a date is selected via the picker (defaults to false).

Overrides:

setAutoValidate in class Field<Date>

Parameters:

autoValidate - true to validate on each key press

getCell

public DateCell getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class TriggerField<Date>

Returns:

the Cell being wrapped

getDatePicker

public DatePicker getDatePicker()

Returns the field's date picker.

Returns:

the date picker

getMaxValue

public Date getMaxValue()

Returns the field's max value.

Returns:

the max value

getMinValue

public Date getMinValue()

Returns the field's minimum value.

Returns:

the minimum value

getPropertyEditor

public DateTimePropertyEditor getPropertyEditor()

Description copied from class: ValueBaseField

Returns the field's property editor.

Overrides:

getPropertyEditor in class ValueBaseField<Date>

Returns:

the property editor

setMaxValue

public void setMaxValue(Date maxValue)

The maximum date allowed. Adds a maximum date validator.

Parameters:

maxValue - the maximum value. Set maxValue to null to remove the maximum validation.

setMinValue

public void setMinValue(Date minValue)

The minimum date allowed. Adds a minimum date validator.

Parameters:

minValue - the minimum value. Set minValue to null to remove the minimum validation.

addExpandHandler

public HandlerRegistration addExpandHandler(ExpandEvent.ExpandHandler handler)

Description copied from interface: ExpandEvent.HasExpandHandlers

Adds a ExpandEvent.ExpandHandler handler for ExpandEvent events.

Specified by:

addExpandHandler in interface ExpandEvent.HasExpandHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addCollapseHandler

public HandlerRegistration addCollapseHandler(CollapseEvent.CollapseHandler handler)

Description copied from interface: CollapseEvent.HasCollapseHandlers

Adds a CollapseEvent.CollapseHandler handler for CollapseEvent events.

Specified by:

addCollapseHandler in interface CollapseEvent.HasCollapseHandlers

Parameters:

handler - the handler

Returns:

the registration for the event