Class RelativeDateItem
- All Implemented Interfaces:
HasHandlers,HasBlurHandlers,HasCanEditChangedHandlers,HasChangedHandlers,HasChangeHandlers,HasClickHandlers,HasDoubleClickHandlers,HasEditorEnterHandlers,HasEditorExitHandlers,HasFocusHandlers,HasIconClickHandlers,HasIconKeyPressHandlers,HasItemHoverHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasKeyUpHandlers,HasPendingStatusChangedHandlers,HasPickerIconClickHandlers,HasReadOnlyDisplayChangedHandlers,HasShowContextMenuHandlers,HasShowValueHandlers,HasTitleClickHandlers,HasTitleDoubleClickHandlers,HasTitleHoverHandlers,HasValueHoverHandlers,HasValueIconClickHandlers
The RelativeDateItem consists of a ComboBoxItem where the user may directly choose one of several preset options, choose to enter a quantity and time unit (eg "4 months ago" or "3 years from now") or directly type in an
absolute date value (7/18/2009).
This item can work with logical dates or datetimes, depending on the specified
data-type. For detailed information on working with dates,
times and datetimes, see the Date and Time Format and Storage
overview.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.smartgwt.client.widgets.form.fields.FormItem
FormItem.CustomStateGetter, FormItem.StateCustomizer -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultFields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
ConstructorsConstructorDescriptionRelativeDateItem(JavaScriptObject jsObj) RelativeDateItem(String name) RelativeDateItem(String name, String title) -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.static voidchangePickerIconDefaults(FormItemIcon defaults) voidRelativeDateItems do not make use of the standardFormItem.formatEditorValue()andFormItem.parseEditorValue()methods.static DategetAbsoluteDate(RelativeDate relativeDate) Converts a RelativeDate to a concrete Date.static DategetAbsoluteDate(RelativeDate relativeDate, Date baseDate) Converts a RelativeDate to a concrete Date.When set to false, only relative dates can be entered - in this mode, thedate chooser iconis hidden and thevalue fieldis switched from aComboBoxItem, which allows text-entry, to aSelectItemwhich does not.Base date for calculating the relative date entered by the user.Field that shows the current calculated date by adding the user-entered relative date to thebaseDate.intOnly used if we're showing the date in a text field.The title to show for historical periods when theTimeUnitis "day".The title to show for future periods when theTimeUnitis "day".intDefault quantity to show in thequantityField.Limits the range of the popupDateChooser.voidReturns the raw text value typed into this items value text fieldReturns theFiscalCalendarobject that will be used by this item's DateChooser.The title to show for historical periods when theTimeUnitis "hour".The title to show for future periods when theTimeUnitis "hour".Format for direct user input of date values.intMaximum value to allow in thequantityField.The title to show for historical periods when theTimeUnitis "millisecond".The title to show for future periods when theTimeUnitis "millisecond".intMinimum value to allow in thequantityField.The title to show for historical periods when theTimeUnitis "minute".The title to show for future periods when theTimeUnitis "minute".The title to show for historical periods when theTimeUnitis "month".The title to show for future periods when theTimeUnitis "month".What operator to use when theFormItemCriterionGetter'sgetCriterion()method is called.static RelativeDateItemgetOrCreateRef(JavaScriptObject jsObj) Smart GWT class for thedateChooserautoChild displayed to allow the user to directly select dates.Icon that launches aDateChooserfor choosing an absolute date.Prompt to show when the user hovers the mouse over the picker icon for this RelativeDateItem.A set of properties to apply to theTimeItemdisplayed in the picker whenshowPickerTimeItemis true.Field allowing user to pick units of time, eg, number of days.The title to show for historical periods when theTimeUnitis "quarter".The title to show for future periods when theTimeUnitis "quarter".Does this item's relative date value refer to the start or end of the chosen date? Useful when using this item to generate filter criteria, such as the from or to value for an inclusive range.Returns the RelativeDate for the current value.The title to show for historical periods when theTimeUnitis "second".The title to show for future periods when theTimeUnitis "second".Should this item's value be saved in the form's values and hence returned fromform.getValues()?Should the Calculated-Date be displayed to the right of thepickerIcon.When set to true, show a button that allows the calendar to be navigated by fiscal year.Should we show the icon that displays a date-chooser?When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowChooserFiscalYearPicker.Should we show time-unit options in the future? If set to false, for eachtimeUnitOptionwe will show only past options [for example "N weeks ago"].Should we show time-unit options in the past? If set to false, for eachtimeUnitOptionwe will show only future options [for example "N weeks from now"].If this item is editing a field of type"datetime", should theDateChooserdisplay thetime field, allowing the user to select a time?Limits the range of the popupDateChooser.TimeUnit[]List of time units that will be offered for relative dates.When showing theDateChooser, should thetime fieldbe set to use 24-hour time? Has no effect for fields of type"date"rather than"datetime", or ifshowPickerTimeItemisfalse.When set to true (the default), use a single shared date-picker across all widgets that use one.ComboBoxItemfield where a user may choose amongpresets,time unitplusquantity, or direct entry of a date as text.intThewidthfor thevalueFieldin this item.Thewidthfor thevalueFieldin this item.The title to show for historical periods when theTimeUnitis "week".The title to show for future periods when theTimeUnitis "week".The title to show for historical periods when theTimeUnitis "year".The title to show for future periods when theTimeUnitis "year".voidRelativeDateItems do not make use of the standardFormItem.formatEditorValue()andFormItem.parseEditorValue()methods.setAllowAbsoluteDates(Boolean allowAbsoluteDates) When set to false, only relative dates can be entered - in this mode, thedate chooser iconis hidden and thevalue fieldis switched from aComboBoxItem, which allows text-entry, to aSelectItemwhich does not.setBaseDate(Date baseDate) Base date for calculating the relative date entered by the user.setCenturyThreshold(int centuryThreshold) Only used if we're showing the date in a text field.setDateFormatter(DateDisplayFormat dateFormatter) Format for displaying dates in thevalueFieldandcalculatedDateField.setDateFormatter(DateDisplayFormatter formatter) Formatter function for displaying dates in thevalueFieldandcalculatedDateFieldin some custom format.voidsetDateParser(DateParser parser) Custom date parser function for direct user input of date values.setDaysAgoTitle(String daysAgoTitle) The title to show for historical periods when theTimeUnitis "day".setDaysFromNowTitle(String daysFromNowTitle) The title to show for future periods when theTimeUnitis "day".static voidsetDefaultProperties(RelativeDateItem relativeDateItemProperties) Class level method to set the default properties of this class.setDefaultQuantity(int defaultQuantity) Default quantity to show in thequantityField.voidsetEditorValueFormatter(FormItemValueFormatter formatter) RelativeDateItems do not make use of the standard FormItem.setEditorValueFormatter() and FormItem.setEditorValueParser() methods.voidRelativeDateItems do not make use of the standard FormItem.setEditorValueFormatter() and FormItem.setEditorValueParser() methods.setEndDate(Date endDate) Limits the range of the popupDateChooser.voidSets theFiscalCalendarobject that will be used by this item's DateChooser.voidsetFiscalCalendar(FiscalCalendar fiscalCalendar) Sets theFiscalCalendarobject that will be used by this item's DateChooser.setGenerateValidator(Boolean generateValidator) setHoursAgoTitle(String hoursAgoTitle) The title to show for historical periods when theTimeUnitis "hour".setHoursFromNowTitle(String hoursFromNowTitle) The title to show for future periods when theTimeUnitis "hour".setInputFormat(String inputFormat) Format for direct user input of date values.setMaxQuantity(int maxQuantity) Maximum value to allow in thequantityField.setMillisecondsAgoTitle(String millisecondsAgoTitle) The title to show for historical periods when theTimeUnitis "millisecond".setMillisecondsFromNowTitle(String millisecondsFromNowTitle) The title to show for future periods when theTimeUnitis "millisecond".setMinQuantity(int minQuantity) Minimum value to allow in thequantityField.setMinutesAgoTitle(String minutesAgoTitle) The title to show for historical periods when theTimeUnitis "minute".setMinutesFromNowTitle(String minutesFromNowTitle) The title to show for future periods when theTimeUnitis "minute".setMonthsAgoTitle(String monthsAgoTitle) The title to show for historical periods when theTimeUnitis "month".setMonthsFromNowTitle(String monthsFromNowTitle) The title to show for future periods when theTimeUnitis "month".setOperator(OperatorId operator) What operator to use when theFormItemCriterionGetter'sgetCriterion()method is called.setPickerConstructor(String pickerConstructor) Smart GWT class for thedateChooserautoChild displayed to allow the user to directly select dates.setPickerIconPrompt(String pickerIconPrompt) Prompt to show when the user hovers the mouse over the picker icon for this RelativeDateItem.setPickerTimeItemProperties(TimeItem pickerTimeItemProperties) A set of properties to apply to theTimeItemdisplayed in the picker whenshowPickerTimeItemis true.voidsetPresetOptions(LinkedHashMap valueMap) Set up a set of standard relative dates such as "today" or "tomorrow" that the user can choose directly from the valueField of this item.setQuartersAgoTitle(String quartersAgoTitle) The title to show for historical periods when theTimeUnitis "quarter".setQuartersFromNowTitle(String quartersFromNowTitle) The title to show for future periods when theTimeUnitis "quarter".setRangePosition(RelativeDateRangePosition rangePosition) Does this item's relative date value refer to the start or end of the chosen date? Useful when using this item to generate filter criteria, such as the from or to value for an inclusive range.voidsetRangeRoundingGranularity(Map rangeRoundingGranularity) A map from a granularity of time specified by a user to the granularity of time used for rounding.setSecondsAgoTitle(String secondsAgoTitle) The title to show for historical periods when theTimeUnitis "second".setSecondsFromNowTitle(String secondsFromNowTitle) The title to show for future periods when theTimeUnitis "second".setShouldSaveValue(Boolean shouldSaveValue) Should this item's value be saved in the form's values and hence returned fromform.getValues()?setShowCalculatedDateField(Boolean showCalculatedDateField) Should the Calculated-Date be displayed to the right of thepickerIcon.setShowChooserFiscalYearPicker(Boolean showChooserFiscalYearPicker) When set to true, show a button that allows the calendar to be navigated by fiscal year.setShowChooserIcon(Boolean showChooserIcon) Should we show the icon that displays a date-chooser?setShowChooserWeekPicker(Boolean showChooserWeekPicker) When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowChooserFiscalYearPicker.setShowFutureOptions(Boolean showFutureOptions) Should we show time-unit options in the future? If set to false, for eachtimeUnitOptionwe will show only past options [for example "N weeks ago"].setShowPastOptions(Boolean showPastOptions) Should we show time-unit options in the past? If set to false, for eachtimeUnitOptionwe will show only future options [for example "N weeks from now"].setShowPickerTimeItem(Boolean showPickerTimeItem) If this item is editing a field of type"datetime", should theDateChooserdisplay thetime field, allowing the user to select a time?setStartDate(Date startDate) Limits the range of the popupDateChooser.setTimeUnitOptions(TimeUnit... timeUnitOptions) List of time units that will be offered for relative dates.setUse24HourTime(Boolean use24HourTime) When showing theDateChooser, should thetime fieldbe set to use 24-hour time? Has no effect for fields of type"date"rather than"datetime", or ifshowPickerTimeItemisfalse.setUseSharedPicker(Boolean useSharedPicker) When set to true (the default), use a single shared date-picker across all widgets that use one.setValueFieldWidth(int valueFieldWidth) Thewidthfor thevalueFieldin this item.setValueFieldWidth(String valueFieldWidth) Thewidthfor thevalueFieldin this item.setWeeksAgoTitle(String weeksAgoTitle) The title to show for historical periods when theTimeUnitis "week".setWeeksFromNowTitle(String weeksFromNowTitle) The title to show for future periods when theTimeUnitis "week".setYearsAgoTitle(String yearsAgoTitle) The title to show for historical periods when theTimeUnitis "year".setYearsFromNowTitle(String yearsFromNowTitle) The title to show for future periods when theTimeUnitis "year".Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getMultiple, getOverflow, getPrompt, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPositionMethods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
_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, checkFormItemType, 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, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanHover, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDefaultValue, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconBaseStyle, 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, getMultipleValueSeparator, getName, getNullOriginalValueText, 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, getReadOnlyCanSelectText, getReadOnlyControlStyle, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorIconInline, 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, getTextAlign, 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, getWrapHintText, getWrapStaticValue, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, 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, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCustomStateGetter, setDataPath, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditPendingCSSText, setEditProxyConstructor, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconBaseStyle, 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, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyControlStyle, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorIconInline, 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, setTextAlign, setTextBoxStyle, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setUseObjectFactoryForTypeFallback, 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, setWrapHintText, setWrapStaticValue, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClippedMethods inherited from class com.smartgwt.client.data.Field
getCanExport, getExportTitle, getPrimaryKey, getSortByField, setCanExport, setExportTitle, setPrimaryKey, setSortByFieldMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
RelativeDateItem
public RelativeDateItem() -
RelativeDateItem
-
RelativeDateItem
-
RelativeDateItem
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
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, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
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, seeSGWTProperties.- See Also:
-
changePickerIconDefaults
-
setAllowAbsoluteDates
When set to false, only relative dates can be entered - in this mode, thedate chooser iconis hidden and thevalue fieldis switched from aComboBoxItem, which allows text-entry, to aSelectItemwhich does not.- Parameters:
allowAbsoluteDates- New allowAbsoluteDates value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getAllowAbsoluteDates
When set to false, only relative dates can be entered - in this mode, thedate chooser iconis hidden and thevalue fieldis switched from aComboBoxItem, which allows text-entry, to aSelectItemwhich does not.- Returns:
- Current allowAbsoluteDates value. Default value is true
-
setBaseDate
Base date for calculating the relative date entered by the user.The default is to use the current date.
- Parameters:
baseDate- New baseDate value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getBaseDate
Base date for calculating the relative date entered by the user.The default is to use the current date.
- Returns:
- Current baseDate value. Default value is null
-
getCalculatedDateField
Field that shows the current calculated date by adding the user-entered relative date to thebaseDate.This component is an AutoChild named "calculatedDateField". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current calculatedDateField value. Default value is null
-
setCenturyThreshold
Only used if we're showing the date in a text field. When parsing a date, if the year is specified with 1 or 2 digits and is less than the centuryThreshold, then the year will be assumed to be 20xx; otherwise it will be interpreted according to default browser behavior, which will consider it to be 19xx.By default, the centuryThreshold is calculated as the current year + 25.
If you need to allow 1 and 2 digit years, set this attribute to
nullto have the control retain your year-value as entered.- Parameters:
centuryThreshold- New centuryThreshold value. Default value is 25- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getCenturyThreshold
public int getCenturyThreshold()Only used if we're showing the date in a text field. When parsing a date, if the year is specified with 1 or 2 digits and is less than the centuryThreshold, then the year will be assumed to be 20xx; otherwise it will be interpreted according to default browser behavior, which will consider it to be 19xx.By default, the centuryThreshold is calculated as the current year + 25.
If you need to allow 1 and 2 digit years, set this attribute to
nullto have the control retain your year-value as entered.- Returns:
- Current centuryThreshold value. Default value is 25
- See Also:
-
setDaysAgoTitle
The title to show for historical periods when theTimeUnitis "day".- Parameters:
daysAgoTitle- New daysAgoTitle value. Default value is "N days ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getDaysAgoTitle
The title to show for historical periods when theTimeUnitis "day".- Returns:
- Current daysAgoTitle value. Default value is "N days ago"
-
setDaysFromNowTitle
The title to show for future periods when theTimeUnitis "day".- Parameters:
daysFromNowTitle- New daysFromNowTitle value. Default value is "N days from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getDaysFromNowTitle
The title to show for future periods when theTimeUnitis "day".- Returns:
- Current daysFromNowTitle value. Default value is "N days from now"
-
setDefaultQuantity
Default quantity to show in thequantityField.- Parameters:
defaultQuantity- New defaultQuantity value. Default value is 1- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getDefaultQuantity
public int getDefaultQuantity()Default quantity to show in thequantityField.- Returns:
- Current defaultQuantity value. Default value is 1
-
setEndDate
Limits the range of the popupDateChooser.If unset, the item's popup
DateChooseris limited byDateChooser.endYear.Note that changing this attribute after the item is drawn may result in item-validation.
- Parameters:
endDate- New endDate value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getEndDate
Limits the range of the popupDateChooser.If unset, the item's popup
DateChooseris limited byDateChooser.endYear.Note that changing this attribute after the item is drawn may result in item-validation.
- Returns:
- Current endDate value. Default value is null
- See Also:
-
setGenerateValidator
When this item has astartDateorendDatespecified, should it automatically generate a client-sidedateRange validatorto enforce them?When true, the default, the item will generate a dateRange validator automatically if the developer hasn't installed one but has set either date-range value.
If a dateRange validator already exists, this attribute is non-functional - no automatic validator is generated, and no checks are made that the values in the developer-provided validator match the item's current start or end dates.
Note that the validator generated by this attribute exists only on the FormItem, so it doesn't do any server enforcement and doesn't cause validation to happen in any other circumstance (eg, an unrelated grid used for editing). For consistent and pervasive enforcement, the validator should be declared on the
DataSourceField.- Parameters:
generateValidator- New generateValidator value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getGenerateValidator
When this item has astartDateorendDatespecified, should it automatically generate a client-sidedateRange validatorto enforce them?When true, the default, the item will generate a dateRange validator automatically if the developer hasn't installed one but has set either date-range value.
If a dateRange validator already exists, this attribute is non-functional - no automatic validator is generated, and no checks are made that the values in the developer-provided validator match the item's current start or end dates.
Note that the validator generated by this attribute exists only on the FormItem, so it doesn't do any server enforcement and doesn't cause validation to happen in any other circumstance (eg, an unrelated grid used for editing). For consistent and pervasive enforcement, the validator should be declared on the
DataSourceField.- Returns:
- Current generateValidator value. Default value is true
-
setHoursAgoTitle
The title to show for historical periods when theTimeUnitis "hour".- Parameters:
hoursAgoTitle- New hoursAgoTitle value. Default value is "N hours ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getHoursAgoTitle
The title to show for historical periods when theTimeUnitis "hour".- Returns:
- Current hoursAgoTitle value. Default value is "N hours ago"
-
setHoursFromNowTitle
The title to show for future periods when theTimeUnitis "hour".- Parameters:
hoursFromNowTitle- New hoursFromNowTitle value. Default value is "N hours from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getHoursFromNowTitle
The title to show for future periods when theTimeUnitis "hour".- Returns:
- Current hoursFromNowTitle value. Default value is "N hours from now"
-
setInputFormat
Format for direct user input of date values.If unset, the input format will be determined based on the specified
dateFormatterif possible, otherwise picked up from the Date class (seeDateUtil.setInputFormat()).- Overrides:
setInputFormatin classFormItem- Parameters:
inputFormat- New inputFormat value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getInputFormat
Format for direct user input of date values.If unset, the input format will be determined based on the specified
dateFormatterif possible, otherwise picked up from the Date class (seeDateUtil.setInputFormat()).- Overrides:
getInputFormatin classFormItem- Returns:
- If
DateItem.useTextFieldistruethis method returns a standardDateInputFormat, determining how values entered by the user are to be converted to Javascript Date objects.If an explicit
DateItem.inputFormathas been specified it will be returned, otherwise, if a customDateItem.dateFormatterorDateItem.formatare specified, the input format will be automatically derived from that property.Otherwise, the global
inputFormatis used.Note that the inputFormat will ignore any separator characters and padding of values. However if necessary entirely custom date formatting and parsing may be achieved via the
setEditorValueFormatter()andsetEditorValueParser()APIs. Default value is null - See Also:
-
setMaxQuantity
Maximum value to allow in thequantityField. Increasing this value may result in date miscalculations for very large numbers, due to Javascript Date limitations.- Parameters:
maxQuantity- New maxQuantity value. Default value is 999999- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMaxQuantity
public int getMaxQuantity()Maximum value to allow in thequantityField. Increasing this value may result in date miscalculations for very large numbers, due to Javascript Date limitations.- Returns:
- Current maxQuantity value. Default value is 999999
-
setMillisecondsAgoTitle
The title to show for historical periods when theTimeUnitis "millisecond".- Parameters:
millisecondsAgoTitle- New millisecondsAgoTitle value. Default value is "N milliseconds ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMillisecondsAgoTitle
The title to show for historical periods when theTimeUnitis "millisecond".- Returns:
- Current millisecondsAgoTitle value. Default value is "N milliseconds ago"
-
setMillisecondsFromNowTitle
The title to show for future periods when theTimeUnitis "millisecond".- Parameters:
millisecondsFromNowTitle- New millisecondsFromNowTitle value. Default value is "N milliseconds from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMillisecondsFromNowTitle
The title to show for future periods when theTimeUnitis "millisecond".- Returns:
- Current millisecondsFromNowTitle value. Default value is "N milliseconds from now"
-
setMinQuantity
Minimum value to allow in thequantityField.- Parameters:
minQuantity- New minQuantity value. Default value is 0- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMinQuantity
public int getMinQuantity()Minimum value to allow in thequantityField.- Returns:
- Current minQuantity value. Default value is 0
-
setMinutesAgoTitle
The title to show for historical periods when theTimeUnitis "minute".- Parameters:
minutesAgoTitle- New minutesAgoTitle value. Default value is "N minutes ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMinutesAgoTitle
The title to show for historical periods when theTimeUnitis "minute".- Returns:
- Current minutesAgoTitle value. Default value is "N minutes ago"
-
setMinutesFromNowTitle
The title to show for future periods when theTimeUnitis "minute".- Parameters:
minutesFromNowTitle- New minutesFromNowTitle value. Default value is "N minutes from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMinutesFromNowTitle
The title to show for future periods when theTimeUnitis "minute".- Returns:
- Current minutesFromNowTitle value. Default value is "N minutes from now"
-
setMonthsAgoTitle
The title to show for historical periods when theTimeUnitis "month".- Parameters:
monthsAgoTitle- New monthsAgoTitle value. Default value is "N months ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMonthsAgoTitle
The title to show for historical periods when theTimeUnitis "month".- Returns:
- Current monthsAgoTitle value. Default value is "N months ago"
-
setMonthsFromNowTitle
The title to show for future periods when theTimeUnitis "month".- Parameters:
monthsFromNowTitle- New monthsFromNowTitle value. Default value is "N months from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getMonthsFromNowTitle
The title to show for future periods when theTimeUnitis "month".- Returns:
- Current monthsFromNowTitle value. Default value is "N months from now"
-
setOperator
What operator to use when theFormItemCriterionGetter'sgetCriterion()method is called.- Overrides:
setOperatorin classFormItem- Parameters:
operator- New operator value. Default value is "greaterThan"- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getOperator
What operator to use when theFormItemCriterionGetter'sgetCriterion()method is called.- Overrides:
getOperatorin classFormItem- Returns:
- Current operator value. Default value is "greaterThan"
- See Also:
-
setPickerConstructor
Smart GWT class for thedateChooserautoChild displayed to allow the user to directly select dates.- Parameters:
pickerConstructor- New pickerConstructor value. Default value is "DateChooser"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getPickerConstructor
Smart GWT class for thedateChooserautoChild displayed to allow the user to directly select dates.- Returns:
- Current pickerConstructor value. Default value is "DateChooser"
-
getPickerIcon
Icon that launches aDateChooserfor choosing an absolute date.This component is an AutoChild named "pickerIcon". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current pickerIcon value. Default value is null
-
setPickerIconPrompt
Prompt to show when the user hovers the mouse over the picker icon for this RelativeDateItem. May be overridden for localization of your application.- Overrides:
setPickerIconPromptin classFormItem- Parameters:
pickerIconPrompt- New pickerIconPrompt value. Default value is "Show Date Chooser"- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getPickerIconPrompt
Prompt to show when the user hovers the mouse over the picker icon for this RelativeDateItem. May be overridden for localization of your application.- Overrides:
getPickerIconPromptin classFormItem- Returns:
- Current pickerIconPrompt value. Default value is "Show Date Chooser"
- See Also:
-
setPickerTimeItemProperties
A set of properties to apply to theTimeItemdisplayed in the picker whenshowPickerTimeItemis true.Has no effect for fields of type
"date".Note : This is an advanced setting
- Parameters:
pickerTimeItemProperties- New pickerTimeItemProperties value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getPickerTimeItemProperties
A set of properties to apply to theTimeItemdisplayed in the picker whenshowPickerTimeItemis true.Has no effect for fields of type
"date".- Returns:
- Current pickerTimeItemProperties value. Default value is null
-
getQuantityField
Field allowing user to pick units of time, eg, number of days.This component is an AutoChild named "quantityField". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current quantityField value. Default value is null
-
setQuartersAgoTitle
The title to show for historical periods when theTimeUnitis "quarter".- Parameters:
quartersAgoTitle- New quartersAgoTitle value. Default value is "N quarters ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getQuartersAgoTitle
The title to show for historical periods when theTimeUnitis "quarter".- Returns:
- Current quartersAgoTitle value. Default value is "N quarters ago"
-
setQuartersFromNowTitle
The title to show for future periods when theTimeUnitis "quarter".- Parameters:
quartersFromNowTitle- New quartersFromNowTitle value. Default value is "N quarters from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getQuartersFromNowTitle
The title to show for future periods when theTimeUnitis "quarter".- Returns:
- Current quartersFromNowTitle value. Default value is "N quarters from now"
-
setRangePosition
Does this item's relative date value refer to the start or end of the chosen date? Useful when using this item to generate filter criteria, such as the from or to value for an inclusive range.If unset "start" is assumed.
Note : This is an advanced setting
- Parameters:
rangePosition- New rangePosition value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getRangePosition
Does this item's relative date value refer to the start or end of the chosen date? Useful when using this item to generate filter criteria, such as the from or to value for an inclusive range.If unset "start" is assumed.
- Returns:
- Current rangePosition value. Default value is null
- See Also:
-
getOperator()com.smartgwt.client.widgets.form.fields.RelativeDateItem#getRangeRoundingGranularity
-
setSecondsAgoTitle
The title to show for historical periods when theTimeUnitis "second".- Parameters:
secondsAgoTitle- New secondsAgoTitle value. Default value is "N seconds ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getSecondsAgoTitle
The title to show for historical periods when theTimeUnitis "second".- Returns:
- Current secondsAgoTitle value. Default value is "N seconds ago"
-
setSecondsFromNowTitle
The title to show for future periods when theTimeUnitis "second".- Parameters:
secondsFromNowTitle- New secondsFromNowTitle value. Default value is "N seconds from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getSecondsFromNowTitle
The title to show for future periods when theTimeUnitis "second".- Returns:
- Current secondsFromNowTitle value. Default value is "N seconds from now"
-
setShouldSaveValue
Should this item's value be saved in the form's values and hence returned fromform.getValues()?shouldSaveValue:falseis used to mark formItems which do not correspond to the underlying data model and should not save a value into the form'svalues. Example includes visual separators, password re-type fields, or checkboxes used to show/hide other form items.A
shouldSaveValue:falseitem should be given a value either viaFormItem.defaultValueor by callingform.setValue(item, value)orformItem.setValue(value). Providing a value viaform.valuesorform.setValues()will automatically switch the item toshouldSaveValue:true.Note that
- if an item is shouldSaveValue true, but has no name, a warning is logged, and shouldSaveValue will be set to false.
- Overrides:
setShouldSaveValuein classCanvasItem- Parameters:
shouldSaveValue- New shouldSaveValue value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShouldSaveValue
Should this item's value be saved in the form's values and hence returned fromform.getValues()?shouldSaveValue:falseis used to mark formItems which do not correspond to the underlying data model and should not save a value into the form'svalues. Example includes visual separators, password re-type fields, or checkboxes used to show/hide other form items.A
shouldSaveValue:falseitem should be given a value either viaFormItem.defaultValueor by callingform.setValue(item, value)orformItem.setValue(value). Providing a value viaform.valuesorform.setValues()will automatically switch the item toshouldSaveValue:true.Note that
- if an item is shouldSaveValue true, but has no name, a warning is logged, and shouldSaveValue will be set to false.
- Overrides:
getShouldSaveValuein classCanvasItem- Returns:
- Current shouldSaveValue value. Default value is true
-
setShowCalculatedDateField
Should the Calculated-Date be displayed to the right of thepickerIcon.- Parameters:
showCalculatedDateField- New showCalculatedDateField value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowCalculatedDateField
Should the Calculated-Date be displayed to the right of thepickerIcon.- Returns:
- Current showCalculatedDateField value. Default value is true
-
setShowChooserFiscalYearPicker
When set to true, show a button that allows the calendar to be navigated by fiscal year.- Parameters:
showChooserFiscalYearPicker- New showChooserFiscalYearPicker value. Default value is false- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowChooserFiscalYearPicker
When set to true, show a button that allows the calendar to be navigated by fiscal year.- Returns:
- Current showChooserFiscalYearPicker value. Default value is false
-
setShowChooserIcon
Should we show the icon that displays a date-chooser?- Parameters:
showChooserIcon- New showChooserIcon value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowChooserIcon
Should we show the icon that displays a date-chooser?- Returns:
- Current showChooserIcon value. Default value is true
-
setShowChooserWeekPicker
When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowChooserFiscalYearPicker.- Parameters:
showChooserWeekPicker- New showChooserWeekPicker value. Default value is false- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowChooserWeekPicker
When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value ofshowChooserFiscalYearPicker.- Returns:
- Current showChooserWeekPicker value. Default value is false
-
setShowFutureOptions
Should we show time-unit options in the future? If set to false, for eachtimeUnitOptionwe will show only past options [for example "N weeks ago"].Note: this does not change the
presetOptions, which show up in addition to the time-unit options ("N days from now", etc). The default preset options include both past and future presets so developers may wish to modify the presets to ensure only future options are available.- Parameters:
showFutureOptions- New showFutureOptions value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowFutureOptions
Should we show time-unit options in the future? If set to false, for eachtimeUnitOptionwe will show only past options [for example "N weeks ago"].Note: this does not change the
presetOptions, which show up in addition to the time-unit options ("N days from now", etc). The default preset options include both past and future presets so developers may wish to modify the presets to ensure only future options are available.- Returns:
- Current showFutureOptions value. Default value is true
-
setShowPastOptions
Should we show time-unit options in the past? If set to false, for eachtimeUnitOptionwe will show only future options [for example "N weeks from now"].Note: this does not change the
presetOptions, which show up in addition to the time-unit options ("N days from now", etc). The default preset options include both past and future presets so developers may wish to modify the presets to ensure only past options are available.- Parameters:
showPastOptions- New showPastOptions value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowPastOptions
Should we show time-unit options in the past? If set to false, for eachtimeUnitOptionwe will show only future options [for example "N weeks from now"].Note: this does not change the
presetOptions, which show up in addition to the time-unit options ("N days from now", etc). The default preset options include both past and future presets so developers may wish to modify the presets to ensure only past options are available.- Returns:
- Current showPastOptions value. Default value is true
-
setShowPickerTimeItem
If this item is editing a field of type"datetime", should theDateChooserdisplay thetime field, allowing the user to select a time?One case where developers will wish to suppress this time-field from being displayed is if a custom
dateFormatterhas been specified which does not display the time portion of the selected date. In this case any value selected from the DateChooser's time field will be discarded when the picker is dismissed, making it a confusing UI for the end user.Has no effect if the field type is
"date"- in this case the picker will never show the time field.Note : This is an advanced setting
- Parameters:
showPickerTimeItem- New showPickerTimeItem value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getShowPickerTimeItem
If this item is editing a field of type"datetime", should theDateChooserdisplay thetime field, allowing the user to select a time?One case where developers will wish to suppress this time-field from being displayed is if a custom
dateFormatterhas been specified which does not display the time portion of the selected date. In this case any value selected from the DateChooser's time field will be discarded when the picker is dismissed, making it a confusing UI for the end user.Has no effect if the field type is
"date"- in this case the picker will never show the time field.- Returns:
- Current showPickerTimeItem value. Default value is true
-
setStartDate
Limits the range of the popupDateChooser.If unset, the item's popup
DateChooseris limited byDateChooser.startYear.Note that changing this attribute after the item is drawn may result in item-validation.
- Parameters:
startDate- New startDate value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getStartDate
Limits the range of the popupDateChooser.If unset, the item's popup
DateChooseris limited byDateChooser.startYear.Note that changing this attribute after the item is drawn may result in item-validation.
- Returns:
- Current startDate value. Default value is null
- See Also:
-
setTimeUnitOptions
List of time units that will be offered for relative dates.Each available time unit option will cause two options to appear in the
valueField. For example, if "day" is an availabletime unitoption, there will be"N days ago"and"N days from now".- Parameters:
timeUnitOptions- New timeUnitOptions value. Default value is ["day", "week", "month"]- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
getTimeUnitOptions
List of time units that will be offered for relative dates.Each available time unit option will cause two options to appear in the
valueField. For example, if "day" is an availabletime unitoption, there will be"N days ago"and"N days from now".- Returns:
- Current timeUnitOptions value. Default value is ["day", "week", "month"]
- See Also:
-
getShowPastOptions()getShowFutureOptions()com.smartgwt.client.widgets.form.fields.RelativeDateItem#getRangeRoundingGranularity
-
setUse24HourTime
When showing theDateChooser, should thetime fieldbe set to use 24-hour time? Has no effect for fields of type"date"rather than"datetime", or ifshowPickerTimeItemisfalse.Default is true.
- Parameters:
use24HourTime- New use24HourTime value. Default value is true- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getUse24HourTime
When showing theDateChooser, should thetime fieldbe set to use 24-hour time? Has no effect for fields of type"date"rather than"datetime", or ifshowPickerTimeItemisfalse.Default is true.
- Returns:
- Current use24HourTime value. Default value is true
-
setValueFieldWidth
Thewidthfor thevalueFieldin this item. Defaults to the current default value for the width attribute on theDateTimeItemclass - this is assumed to be just wide enough to show a full datetime string, in the current global datetime format.Setting the width globally on the
DateTimeItemclass results in all text-based datetime entry fields assuming the same default width - this caters for custom date-time formatters that need differing amounts of space.- Parameters:
valueFieldWidth- New valueFieldWidth value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getValueFieldWidth
public int getValueFieldWidth()Thewidthfor thevalueFieldin this item. Defaults to the current default value for the width attribute on theDateTimeItemclass - this is assumed to be just wide enough to show a full datetime string, in the current global datetime format.Setting the width globally on the
DateTimeItemclass results in all text-based datetime entry fields assuming the same default width - this caters for custom date-time formatters that need differing amounts of space.Note : This method will return -1 if the underlying SmartClient JavaScript attribute value cannot be expressed as a(n) int. In that case, other getters, similarly-named but ending in
AsString,AsCanvas, etc., may be provided.- Returns:
- Current valueFieldWidth value. Default value is null
-
setValueFieldWidth
Thewidthfor thevalueFieldin this item. Defaults to the current default value for the width attribute on theDateTimeItemclass - this is assumed to be just wide enough to show a full datetime string, in the current global datetime format.Setting the width globally on the
DateTimeItemclass results in all text-based datetime entry fields assuming the same default width - this caters for custom date-time formatters that need differing amounts of space.- Parameters:
valueFieldWidth- New valueFieldWidth value. Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getValueFieldWidthAsString
Thewidthfor thevalueFieldin this item. Defaults to the current default value for the width attribute on theDateTimeItemclass - this is assumed to be just wide enough to show a full datetime string, in the current global datetime format.Setting the width globally on the
DateTimeItemclass results in all text-based datetime entry fields assuming the same default width - this caters for custom date-time formatters that need differing amounts of space.- Returns:
- Current valueFieldWidth value. Default value is null
-
setWeeksAgoTitle
The title to show for historical periods when theTimeUnitis "week".- Parameters:
weeksAgoTitle- New weeksAgoTitle value. Default value is "N weeks ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getWeeksAgoTitle
The title to show for historical periods when theTimeUnitis "week".- Returns:
- Current weeksAgoTitle value. Default value is "N weeks ago"
-
setWeeksFromNowTitle
The title to show for future periods when theTimeUnitis "week".- Parameters:
weeksFromNowTitle- New weeksFromNowTitle value. Default value is "N weeks from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getWeeksFromNowTitle
The title to show for future periods when theTimeUnitis "week".- Returns:
- Current weeksFromNowTitle value. Default value is "N weeks from now"
-
setYearsAgoTitle
The title to show for historical periods when theTimeUnitis "year".- Parameters:
yearsAgoTitle- New yearsAgoTitle value. Default value is "N years ago"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getYearsAgoTitle
The title to show for historical periods when theTimeUnitis "year".- Returns:
- Current yearsAgoTitle value. Default value is "N years ago"
-
setYearsFromNowTitle
The title to show for future periods when theTimeUnitis "year".- Parameters:
yearsFromNowTitle- New yearsFromNowTitle value. Default value is "N years from now"- Returns:
RelativeDateIteminstance, for chaining setter calls
-
getYearsFromNowTitle
The title to show for future periods when theTimeUnitis "year".- Returns:
- Current yearsFromNowTitle value. Default value is "N years from now"
-
formatEditorValue
public void formatEditorValue()RelativeDateItems do not make use of the standardFormItem.formatEditorValue()andFormItem.parseEditorValue()methods. Developers can customize the display values for these items in the following ways:- The
presetOptionsmap allows standard preset RelativeDateString and RelativeDateShortcut values to be mapped to custom display values - The text
displayed for each of the
timeUnitOptions(e.g:"N days ago") may be customized via the per-time unit title attributes (daysFromNowTitle,daysAgoTitle, etc) - The
dateFormatterandinputFormatmay be used modify how date values are displayed (both in the text entry box and in thecalculatedDateField
- The
-
getEnteredValue
public void getEnteredValue()Returns the raw text value typed into this items value text field -
getFiscalCalendar
Returns theFiscalCalendarobject that will be used by this item's DateChooser.- Returns:
- the fiscal calendar for this chooser, if set, or the global one otherwise
-
parseEditorValue
public void parseEditorValue()RelativeDateItems do not make use of the standardFormItem.formatEditorValue()andFormItem.parseEditorValue()methods. Developers can customize the display values for these items in the following ways:- The
presetOptionsmap allows standard preset RelativeDateString and RelativeDateShortcut values to be mapped to custom display values - The text
displayed for each of the
timeUnitOptions(e.g:"N days ago") may be customized via the per-time unit title attributes (daysFromNowTitle,daysAgoTitle, etc) - The
dateFormatterandinputFormatmay be used modify how date values are displayed (both in the text entry box and in thecalculatedDateField
- The
-
setFiscalCalendar
public void setFiscalCalendar()Sets theFiscalCalendarobject that will be used by this item's DateChooser. If unset, theglobal fiscal calendaris used. -
setFiscalCalendar
Sets theFiscalCalendarobject that will be used by this item's DateChooser. If unset, theglobal fiscal calendaris used.- Parameters:
fiscalCalendar- the fiscal calendar for this chooser, if set, or the global one otherwise
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties of the class instance passed to this function. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.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.
- Parameters:
relativeDateItemProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
getRelativeDate
Returns the RelativeDate for the current value.- Returns:
- the RelativeDate for the current value or null if not set
-
getAbsoluteDate
Converts a RelativeDate to a concrete Date.- Parameters:
relativeDate- the relative date to convert- Returns:
- resulting absolute date value
-
getAbsoluteDate
Converts a RelativeDate to a concrete Date.- Parameters:
relativeDate- the relative date to convertbaseDate- base value for conversion. Defaults to today- Returns:
- resulting absolute date value
-
setPresetOptions
Set up a set of standard relative dates such as "today" or "tomorrow" that the user can choose directly from the valueField of this item.This is similar to a standard {@link FormItem::setValueMap(), valueMap} - the parameter passed in should be a HashMap mapping RelativeDate strings to display values. The default set of preset options (expressed in JSON) are:
{ "$today" : "Today", "$yesterday" : "Yesterday", "$tomorrow" : "Tomorrow", "-1w" : "Current day of last week", "+1w" : "Current day of next week", "-1m" : "Current day of last month", "+1m" : "Current day of next month" }In addition to these presets, options are shown for each of the {@link #setTimeUnitOptions,time unit options}. -
setRangeRoundingGranularity
A map from a granularity of time specified by a user to the granularity of time used for rounding.A relative date such as "n days from now" is normally shifted to the end of the day when used as a range endpoint, and the beginning of the day when used as the beginning of a range. (The rounding direction on some item can be specified via +link{relativeDateItem.rangePosition}). This causes the intuitive behavior that "from yesterday to today" is from the beginning of yesterday to the end of today, and that "from today until 5 days from now" includes the entirety of Friday if today is Monday.
This same rule can be applied to any time granularity, such that "from now until 20 minutes from now" is up to 5:32 if it is now 5:11:34, and "from now until 2 months from now" means end of June if it is mid-April.
User intuitions about where this rounding is expected for any given time period tend to vary based on what kind of event is being discussed and subtle phrasing differences (consider "up to one year from now", "until next year", "within the next couple of years"). The defaults behaviors are:
- for days, weeks and months round to day end/beginning
- for hours, round to minute end/beginning
- for minutes and seconds, round to second end/beginning
For example the following config code would produce an item where the user could select only day or week values, and the selected value would be rounded to the beginning of the day if a day was selected, or the beginning of the week if a week was selected:RelativeDateItem fromDate = new RelativeDateItem("from"); fromDate.setRangePosition(RelativeDateRangePosition.START); fromDate.setTimeUnitOptions(TimeUnit.DAY, TimeUnit.WEEK); Map<TimeUnit,TimeUnit> roundingMap = new HashMap<TimeUnit,TimeUnit>(); roundingMap.put(TimeUnit.DAY, TimeUnit.DAY); roundingMap.put(TimeUnit.WEEK, TimeUnit.WEEK); fromDate.setRangeRoundingGranularity(roundingMap);- Parameters:
rangeRoundingGranularity-
-
setDateFormatter
Format for displaying dates in thevalueFieldandcalculatedDateField. Defaults to the system-wide default established by Date.setShortDisplayFormat, or if this item has its type specified as datetime, Date.setShortDatetimeDisplayFormat.- Overrides:
setDateFormatterin classFormItem- Parameters:
dateFormatter- dateFormatter Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls- See Also:
-
setDateFormatter
Formatter function for displaying dates in thevalueFieldandcalculatedDateFieldin some custom format. Typically thesetDateParser(DateParser)method should also be applied to ensure dates can be both formatted and edited date strings parsed back into actual date values.- Parameters:
dateFormatter- dateFormatter Default value is null- Returns:
RelativeDateIteminstance, for chaining setter calls
-
setDateParser
Custom date parser function for direct user input of date values. Typically used in conjunction withsetDateFormatter(DateDisplayFormatter).Note that
setDateFormatter(DateDisplayFormat)andsetInputFormat(String)already provide a mechanism for customizing the display format for date values displayed in this item. -
setEditorValueParser
RelativeDateItems do not make use of the standard FormItem.setEditorValueFormatter() and FormItem.setEditorValueParser() methods. Developers can customize the display values for these items in the following ways:- The RelativeDateItem.presetOptions map allows standard preset RelativeDateString and RelativeDateShortcut values to be mapped to custom display values
- The text displayed for each of the RelativeDateItem.timeUnitOptions (e.g:"N days ago") may be customized via the per-time unit title attributes (RelativeDateItem.daysFromNowTitle, RelativeDateItem.daysAgoTitle, etc)
- setDateFormatter and setInputFormat / setDateParser may be used modify how date values are displayed (both in the text entry box and in the calculatedDateField)
- Overrides:
setEditorValueParserin classFormItem- Parameters:
parser- the FormItemValueParser
-
setEditorValueFormatter
RelativeDateItems do not make use of the standard FormItem.setEditorValueFormatter() and FormItem.setEditorValueParser() methods. Developers can customize the display values for these items in the following ways:- The RelativeDateItem.presetOptions map allows standard preset RelativeDateString and RelativeDateShortcut values to be mapped to custom display values
- The text displayed for each of the RelativeDateItem.timeUnitOptions (e.g:"N days ago") may be customized via the per-time unit title attributes (RelativeDateItem.daysFromNowTitle, RelativeDateItem.daysAgoTitle, etc)
- setDateFormatter and setInputFormat / setDateParser may be used modify how date values are displayed (both in the text entry box and in the calculatedDateField)
- Overrides:
setEditorValueFormatterin classFormItem- Parameters:
formatter- the FormItemValueFormatter
-
getValueFieldComboBox
ComboBoxItemfield where a user may choose amongpresets,time unitplusquantity, or direct entry of a date as text.For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- ComboBoxItem
-