com.smartgwt.client.widgets.form.fields
Class DateTimeItem

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.core.RefDataClass
              com.smartgwt.client.widgets.form.fields.FormItem
                  com.smartgwt.client.widgets.form.fields.DateItem
                      com.smartgwt.client.widgets.form.fields.DateTimeItem

All Implemented Interfaces:

HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers

public class DateTimeItem
extends DateItem

Subclass of DateItem for manipulating datetimes.

Field Summary

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

DateTimeItem()

DateTimeItem(JavaScriptObject jsObj)

DateTimeItem(String name)

DateTimeItem(String name, String title)

Method Summary

DateDisplayFormat	getDisplayFormat() This property can be used to customize the format in which datetimes are displayed. Should be set to a standard DateDisplayFormat or a function which will return a formatted date time string.
String	getInputFormat() If useTextField is true this property can be used to specify the input format for date strings.
static DateTimeItem	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getUseTextField() DateTimeItems show datetime values in a freeform text entry area.
void	setDisplayFormat(DateDisplayFormat displayFormat) This property can be used to customize the format in which datetimes are displayed. Should be set to a standard DateDisplayFormat or a function which will return a formatted date time string.
void	setInputFormat(String inputFormat) If useTextField is true this property can be used to specify the input format for date strings.
void	setUseTextField(Boolean useTextField) DateTimeItems show datetime values in a freeform text entry area.

Methods inherited from class com.smartgwt.client.widgets.form.fields.DateItem

deselectValue, deselectValue, getCenturyThreshold, getDateFormatter, getDaySelectorProperties, getDefaultChooserDate, getEndDate, getEnforceDate, getEnteredValue, getInvalidDateStringMessage, getMonthSelectorProperties, getPickerIconPrompt, getSelectionRange, getSelectorFormat, getStartDate, getTextAlign, getTextFieldProperties, getUseSharedPicker, getValueAsDate, getYearSelectorProperties, selectValue, setCenturyThreshold, setDateFormatter, setDaySelectorProperties, setDefaultChooserDate, setEditorValueFormatter, setEditorValueParser, setEndDate, setEnforceDate, setInvalidDateStringMessage, setMaskDateSeparator, setMonthSelectorProperties, setPickerIconPrompt, setSelectionRange, setSelectorFormat, setStartDate, setTextAlign, setTextFieldProperties, setUseMask, setUseSharedPicker, setYearSelectorProperties

Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem

addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, blurItem, canEditCriterion, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCellHeight, getCellStyle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFullDataPath, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPickerIconHeight, getPickerIconName, getPickerIconSrc, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getRect, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSelectedRecord, getSelectOnFocus, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWrapTitle, hasAdvancedCriteria, hide, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBrowserSpellCheck, setCanEdit, setCanFocus, setCellHeight, setCellStyle, setColSpan, setColSpan, setCriteriaField, setCriterion, setDataPath, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, setDisplayFormat, setEditorType, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconSrc, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSelectOnFocus, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldFetchMissingValue, show, showPicker, stopHover, updateState, validate

Methods inherited from class com.smartgwt.client.core.RefDataClass

getRef, getRef

Methods inherited from class com.smartgwt.client.core.DataClass

doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.smartgwt.client.core.JsObject

setJsObj

Methods inherited from class java.lang.Object

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

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

fireEvent

Constructor Detail

DateTimeItem

public DateTimeItem()

DateTimeItem

public DateTimeItem(JavaScriptObject jsObj)

DateTimeItem

public DateTimeItem(String name)

DateTimeItem

public DateTimeItem(String name,
                    String title)

Method Detail

getOrCreateRef

public static DateTimeItem getOrCreateRef(JavaScriptObject jsObj)

setDisplayFormat

public void setDisplayFormat(DateDisplayFormat displayFormat)

This property can be used to customize the format in which datetimes are displayed.
Should be set to a standard DateDisplayFormat or a function which will return a formatted date time string.

If unset, the standard shortDateTime format as set up in Date.setShortDatetimeDisplayFormat will be used.

NOTE: you may need to update the inputFormat to ensure the DateItem is able to parse user-entered date strings back into Dates

Overrides:

setDisplayFormat in class FormItem

Parameters:

displayFormat - displayFormat Default value is null

See Also:

setInputFormat(java.lang.String)

getDisplayFormat

public DateDisplayFormat getDisplayFormat()

This property can be used to customize the format in which datetimes are displayed.
Should be set to a standard DateDisplayFormat or a function which will return a formatted date time string.

If unset, the standard shortDateTime format as set up in Date.setShortDatetimeDisplayFormat will be used.

NOTE: you may need to update the inputFormat to ensure the DateItem is able to parse user-entered date strings back into Dates

Returns:

DateDisplayFormat

See Also:

getInputFormat()

setInputFormat

public void setInputFormat(String inputFormat)

If useTextField is true this property can be used to specify the input format for date strings. If unset, the input format will be determined based on the specified dateFormtter if possible (see DateItem.getInputFormat), otherwise picked up from the Date class (see Date.setInputFormat).

Should be set to a standard String

Note that the String property is sufficient to parse date or datetime strings specified in most standard date formats. However should an entirely custom parsing function be required developers can implement a custom DateItem.parseEditorValue method. apply a custom editorValueParser function.

Overrides:

setInputFormat in class DateItem

Parameters:

inputFormat - inputFormat Default value is null

See Also:

FormItem.setDisplayFormat(com.smartgwt.client.types.DateDisplayFormat)

getInputFormat

public String getInputFormat()

If useTextField is true this property can be used to specify the input format for date strings. If unset, the input format will be determined based on the specified dateFormtter if possible (see DateItem.getInputFormat), otherwise picked up from the Date class (see Date.setInputFormat).

Should be set to a standard String

Note that the String property is sufficient to parse date or datetime strings specified in most standard date formats. However should an entirely custom parsing function be required developers can implement a custom DateItem.parseEditorValue method. apply a custom editorValueParser function.

Overrides:

getInputFormat in class DateItem

Returns:

String

See Also:

com.smartgwt.client.widgets.form.fields.DateItem#getDisplayFormat

setUseTextField

public void setUseTextField(Boolean useTextField)

DateTimeItems show datetime values in a freeform text entry area.

Overrides:

setUseTextField in class DateItem

Parameters:

useTextField - useTextField Default value is true

See Also:

Basics overview and related methods

getUseTextField

public Boolean getUseTextField()

DateTimeItems show datetime values in a freeform text entry area.

Overrides:

getUseTextField in class DateItem

Returns:

Boolean

See Also:

Basics overview and related methods