public class DateTimeItem extends DateItem
DateItem subclass
for editing regular datetime
values, where date and time elements are relevant.
The item edits datetimes directly as text-values, formatted according to your locale and settings such as DateItem.dateFormatter
.
To edit logical-Date values
, see DateItem
, and to edit logical-time values
, see TimeItem
. For relative-date
features
, see RelativeDateItem
.
For detailed information on working
with dates, times and datetimes, see the Date and Time Format and
Storage overview
.
FormItem.CustomStateGetter, FormItem.StateCustomizer
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
id
factoryCreated, factoryProperties
Constructor and Description |
---|
DateTimeItem() |
DateTimeItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
DateTimeItem(java.lang.String name) |
DateTimeItem(java.lang.String name,
java.lang.String title) |
Modifier and Type | Method and Description |
---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
java.lang.String |
getBrowserInputType()
If
useTextField is true and
browserInputType is set to "datetime", then a native HTML5 local
datetime input is used in place of a text input. |
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. |
java.lang.String |
getInputFormat()
If
DateItem.useTextField is true
this property can be used to specify the input format for date strings. |
static DateTimeItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getUseTextField()
This property defaults to true in DateTimeItems and cannot be altered, since editing is via
formatted text-entry only. |
DateTimeItem |
setBrowserInputType(java.lang.String browserInputType)
If
useTextField is true and
browserInputType is set to "datetime", then a native HTML5 local
datetime input is used in place of a text input. |
static void |
setDefaultProperties(DateTimeItem dateTimeItemProperties)
Class level method to set the default properties of this class.
|
DateTimeItem |
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. |
DateTimeItem |
setInputFormat(java.lang.String inputFormat)
If
DateItem.useTextField is true
this property can be used to specify the input format for date strings. |
deselectValue, deselectValue, getAutoUseTextField, getCenturyThreshold, getDateFormatter, getDaySelector, getDaySelectorProperties, getDefaultChooserDate, getEditProxyConstructor, getEndDate, getEnforceDate, getEnforceValueRange, getEnteredValue, getFiscalCalendar, getInvalidDateStringMessage, getItemTitleAlign, getItemTitleOrientation, getMonthSelector, getMonthSelectorProperties, getPickerDefaults, getPickerIconPrompt, getPickerProperties, getPickerTimeItemProperties, getSelectionRange, getSelectorFormat, getShowChooserFiscalYearPicker, getShowChooserWeekPicker, getShowHintInField, getShowItemTitles, getShowPickerTimeItem, getStartDate, getTextAlign, getTextField, getTextFieldProperties, getUse24HourTime, getUsePlaceholderForHint, getUseSharedPicker, getValueAsDate, getWrapHintText, getYearSelector, getYearSelectorProperties, pendingStatusChanged, selectValue, setAutoUseTextField, setCenturyThreshold, setDateFormatter, setDaySelectorProperties, setDefaultChooserDate, setDefaultProperties, setEditorValueFormatter, setEditorValueParser, setEditProxyConstructor, setEndDate, setEnforceDate, setEnforceValueRange, setFiscalCalendar, setFiscalCalendar, setInvalidDateStringMessage, setItemTitleAlign, setItemTitleOrientation, setMaskDateSeparator, setMonthSelectorProperties, setPickerDefaults, setPickerIconPrompt, setPickerProperties, setPickerTimeItemProperties, setSelectionRange, setSelectorFormat, setShowChooserFiscalYearPicker, setShowChooserWeekPicker, setShowHintInField, setShowItemTitles, setShowPickerTimeItem, setStartDate, setTextAlign, setTextFieldProperties, setUse24HourTime, setUseMask, setUsePlaceholderForHint, setUseSharedPicker, setUseTextField, setWrapHintText, setYearSelectorProperties
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultiple, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyCanSelectText, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowImageAsURL, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextBoxStyle, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsFloat, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, setApplyAlignToText, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setAutoCompleteKeywords, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setCustomStateGetter, setDataPath, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultiple, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowImageAsURL, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextBoxStyle, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClipped
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public DateTimeItem()
public DateTimeItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public DateTimeItem(java.lang.String name)
public DateTimeItem(java.lang.String name, java.lang.String title)
public static DateTimeItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public DateTimeItem setBrowserInputType(java.lang.String browserInputType)
useTextField
is true and
browserInputType is set to "datetime", then a native HTML5 local
datetime input is used in place of a text input. The use of a native HTML5 datetime input causes certain
features to be disabled. Input masks, the picker icon, and a custom datetimeFormatter
are not supported. In-field hints
are currently supported in Chrome/Chromium/Opera 15 and iOS 5.0+, but future browser changes might force this support to
be removed. Therefore, it is safest to not use in-field hints (set showHintInField to false) in conjunction
with a native HTML5 datetime input. In-field hints are not supported in Opera 12 when using a native HTML5 datetime
input. If in-field hints are not supported in the browser, then showHintInField has no effect and any hint will be shown
to the side of the input.
NOTES:
Note : This is an advanced setting
setBrowserInputType
in class DateItem
browserInputType
- New browserInputType value. Default value is nullDateTimeItem
instance, for chaining setter callspublic java.lang.String getBrowserInputType()
useTextField
is true and
browserInputType is set to "datetime", then a native HTML5 local
datetime input is used in place of a text input. The use of a native HTML5 datetime input causes certain
features to be disabled. Input masks, the picker icon, and a custom datetimeFormatter
are not supported. In-field hints
are currently supported in Chrome/Chromium/Opera 15 and iOS 5.0+, but future browser changes might force this support to
be removed. Therefore, it is safest to not use in-field hints (set showHintInField to false) in conjunction
with a native HTML5 datetime input. In-field hints are not supported in Opera 12 when using a native HTML5 datetime
input. If in-field hints are not supported in the browser, then showHintInField has no effect and any hint will be shown
to the side of the input.
NOTES:
getBrowserInputType
in class DateItem
public DateTimeItem setDisplayFormat(DateDisplayFormat displayFormat)
DateDisplayFormat
or a function which will return a formatted date time string. If
unset, the standard shortDateTime format as set up in DateUtil.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
setDisplayFormat
in class FormItem
displayFormat
- New displayFormat value. Default value is nullDateTimeItem
instance, for chaining setter callssetInputFormat(java.lang.String)
public DateDisplayFormat getDisplayFormat()
DateDisplayFormat
or a function which will return a formatted date time string. If
unset, the standard shortDateTime format as set up in DateUtil.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
getInputFormat()
public DateTimeItem setInputFormat(java.lang.String inputFormat)
DateItem.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 DateItem.dateFormatter
if possible (see DateItem.getInputFormat()
),
otherwise picked up from the Date class (see DateUtil.setInputFormat()
). Should be set to a standard DateInputFormat
Note
that the DateInputFormat
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
apply a custom editorValueParser
function.
This attribute does not have an effect if a native HTML5
date input is being used. See DateItem.browserInputType
.
setInputFormat
in class DateItem
inputFormat
- New inputFormat value. Default value is nullDateTimeItem
instance, for chaining setter callsFormItem.setDisplayFormat(com.smartgwt.client.types.DateDisplayFormat)
,
DateInputFormat
public java.lang.String getInputFormat()
DateItem.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 DateItem.dateFormatter
if possible (see DateItem.getInputFormat()
),
otherwise picked up from the Date class (see DateUtil.setInputFormat()
). Should be set to a standard DateInputFormat
Note
that the DateInputFormat
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
apply a custom editorValueParser
function.
This attribute does not have an effect if a native HTML5
date input is being used. See DateItem.browserInputType
.
getInputFormat
in class DateItem
com.smartgwt.client.widgets.form.fields.DateItem#getDisplayFormat
,
DateInputFormat
public java.lang.Boolean getUseTextField()
formatted
text-entry only.getUseTextField
in class DateItem
Basics overview and related methods
public static void setDefaultProperties(DateTimeItem dateTimeItemProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
dateTimeItemProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties