public class RelativeDateItem extends CanvasItem
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.
FormItem.CustomStateGetter, FormItem.StateCustomizerconfigOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultidfactoryCreated, factoryProperties| Constructor and Description |
|---|
RelativeDateItem() |
RelativeDateItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
RelativeDateItem(java.lang.String name) |
RelativeDateItem(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) |
void |
formatEditorValue()
RelativeDateItems do not make use of the standard
FormItem.formatEditorValue() and FormItem.parseEditorValue() methods. |
static java.util.Date |
getAbsoluteDate(RelativeDate relativeDate)
Converts a RelativeDate to a concrete Date.
|
static java.util.Date |
getAbsoluteDate(RelativeDate relativeDate,
java.util.Date baseDate)
Converts a RelativeDate to a concrete Date.
|
java.lang.Boolean |
getAllowAbsoluteDates()
When set to false, only relative dates can be entered - in this mode, the
date chooser icon is hidden and the value field is switched from a ComboBoxItem, which allows text-entry, to a SelectItem which does not. |
java.util.Date |
getBaseDate()
Base date for calculating the relative date entered by the user.
|
BlurbItem |
getCalculatedDateField()
Field that shows the current calculated date by adding the user-entered relative date to the
baseDate. |
int |
getCenturyThreshold()
Only used if we're showing the date in a text field.
|
java.lang.String |
getDaysAgoTitle()
The title to show for historical periods when the
TimeUnit is "day". |
java.lang.String |
getDaysFromNowTitle()
The title to show for future periods when the
TimeUnit is "day". |
int |
getDefaultQuantity()
Default quantity to show in the
quantityField. |
java.util.Date |
getEndDate()
Limits the range of the popup
DateChooser. |
void |
getEnteredValue()
Returns the raw text value typed into this items value text field
|
FiscalCalendar |
getFiscalCalendar()
Returns the
FiscalCalendar object that will be used by this item's DateChooser. |
java.lang.String |
getHoursAgoTitle()
The title to show for historical periods when the
TimeUnit is "hour". |
java.lang.String |
getHoursFromNowTitle()
The title to show for future periods when the
TimeUnit is "hour". |
java.lang.String |
getInputFormat()
Format for direct user input of date values.
|
int |
getMaxQuantity()
Maximum value to allow in the
quantityField. |
java.lang.String |
getMillisecondsAgoTitle()
The title to show for historical periods when the
TimeUnit is "millisecond". |
java.lang.String |
getMillisecondsFromNowTitle()
The title to show for future periods when the
TimeUnit is "millisecond". |
int |
getMinQuantity()
Minimum value to allow in the
quantityField. |
java.lang.String |
getMinutesAgoTitle()
The title to show for historical periods when the
TimeUnit is "minute". |
java.lang.String |
getMinutesFromNowTitle()
The title to show for future periods when the
TimeUnit is "minute". |
java.lang.String |
getMonthsAgoTitle()
The title to show for historical periods when the
TimeUnit is "month". |
java.lang.String |
getMonthsFromNowTitle()
The title to show for future periods when the
TimeUnit is "month". |
OperatorId |
getOperator()
What operator to use when the
FormItemCriterionGetter's getCriterion() method is called. |
static RelativeDateItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getPickerConstructor()
Smart GWT class for the
dateChooser autoChild displayed to allow the
user to directly select dates. |
FormItemIcon |
getPickerIcon()
Icon that launches a
DateChooser for choosing an absolute date. |
java.lang.String |
getPickerIconPrompt()
Prompt to show when the user hovers the mouse over the picker icon for this RelativeDateItem.
|
TimeItem |
getPickerTimeItemProperties()
A set of properties to apply to the
TimeItem displayed in the picker
when showPickerTimeItem is true. |
SpinnerItem |
getQuantityField()
Field allowing user to pick units of time, eg, number of days.
|
java.lang.String |
getQuartersAgoTitle()
The title to show for historical periods when the
TimeUnit is "quarter". |
java.lang.String |
getQuartersFromNowTitle()
The title to show for future periods when the
TimeUnit is "quarter". |
RelativeDateRangePosition |
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.
|
RelativeDate |
getRelativeDate()
Returns the RelativeDate for the current value.
|
java.lang.String |
getSecondsAgoTitle()
The title to show for historical periods when the
TimeUnit is "second". |
java.lang.String |
getSecondsFromNowTitle()
The title to show for future periods when the
TimeUnit is "second". |
java.lang.Boolean |
getShouldSaveValue()
Should this item's value be saved in the form's values and hence returned from
form.getValues()? |
java.lang.Boolean |
getShowCalculatedDateField()
Should the Calculated-Date be displayed to the right of the
pickerIcon. |
java.lang.Boolean |
getShowChooserFiscalYearPicker()
When set to true, show a button that allows the calendar to be navigated by fiscal year.
|
java.lang.Boolean |
getShowChooserIcon()
Should we show the icon that displays a date-chooser?
|
java.lang.Boolean |
getShowChooserWeekPicker()
When set to true, show a button that allows the calendar to be navigated by week or fiscal week, depending on the value
of
showChooserFiscalYearPicker. |
java.lang.Boolean |
getShowFutureOptions()
Should we show time-unit options in the future? If set to false, for each
timeUnitOption we will show only past
options [for example "N weeks ago"]. |
java.lang.Boolean |
getShowPastOptions()
Should we show time-unit options in the past? If set to false, for each
timeUnitOption we will show only future
options [for example "N weeks from now"]. |
java.lang.Boolean |
getShowPickerTimeItem()
If this item is editing a field of type
"datetime", should the DateChooser display the time
field, allowing the user to select a time? |
java.util.Date |
getStartDate()
Limits the range of the popup
DateChooser. |
TimeUnit[] |
getTimeUnitOptions()
List of time units that will be offered for relative dates.
|
java.lang.Boolean |
getUse24HourTime()
When showing the
DateChooser, should the time field be set to use 24-hour time? Has no effect for fields
of type "date" rather than "datetime", or if showPickerTimeItem is
false. |
java.lang.Boolean |
getUseSharedPicker()
When set to true (the default), use a single shared date-picker across all widgets that use one.
|
ComboBoxItem |
getValueFieldComboBox()
ComboBoxItem field where a user may choose among presets, time unit plus quantity, or direct entry of a date as text. |
int |
getValueFieldWidth()
The
width for the valueField in this item. |
java.lang.String |
getValueFieldWidthAsString()
The
width for the valueField in this item. |
java.lang.String |
getWeeksAgoTitle()
The title to show for historical periods when the
TimeUnit is "week". |
java.lang.String |
getWeeksFromNowTitle()
The title to show for future periods when the
TimeUnit is "week". |
java.lang.String |
getYearsAgoTitle()
The title to show for historical periods when the
TimeUnit is "year". |
java.lang.String |
getYearsFromNowTitle()
The title to show for future periods when the
TimeUnit is "year". |
void |
parseEditorValue()
RelativeDateItems do not make use of the standard
FormItem.formatEditorValue() and FormItem.parseEditorValue() methods. |
RelativeDateItem |
setAllowAbsoluteDates(java.lang.Boolean allowAbsoluteDates)
When set to false, only relative dates can be entered - in this mode, the
date chooser icon is hidden and the value field is switched from a ComboBoxItem, which allows text-entry, to a SelectItem which does not. |
RelativeDateItem |
setBaseDate(java.util.Date baseDate)
Base date for calculating the relative date entered by the user.
|
RelativeDateItem |
setCenturyThreshold(int centuryThreshold)
Only used if we're showing the date in a text field.
|
RelativeDateItem |
setDateFormatter(DateDisplayFormat dateFormatter)
Format for displaying dates in the
valueField and calculatedDateField. |
RelativeDateItem |
setDateFormatter(DateDisplayFormatter formatter)
Formatter function for displaying dates in the
valueField and calculatedDateField in some custom format. |
void |
setDateParser(DateParser parser)
Custom date parser function for direct user input of date values.
|
RelativeDateItem |
setDaysAgoTitle(java.lang.String daysAgoTitle)
The title to show for historical periods when the
TimeUnit is "day". |
RelativeDateItem |
setDaysFromNowTitle(java.lang.String daysFromNowTitle)
The title to show for future periods when the
TimeUnit is "day". |
static void |
setDefaultProperties(RelativeDateItem relativeDateItemProperties)
Class level method to set the default properties of this class.
|
RelativeDateItem |
setDefaultQuantity(int defaultQuantity)
Default quantity to show in the
quantityField. |
void |
setEditorValueFormatter(FormItemValueFormatter formatter)
RelativeDateItems do not make use of the standard FormItem.setEditorValueFormatter() and
FormItem.setEditorValueParser() methods.
|
void |
setEditorValueParser(FormItemValueParser parser)
RelativeDateItems do not make use of the standard FormItem.setEditorValueFormatter() and
FormItem.setEditorValueParser() methods.
|
RelativeDateItem |
setEndDate(java.util.Date endDate)
Limits the range of the popup
DateChooser. |
void |
setFiscalCalendar()
Sets the
FiscalCalendar object that will be used by this item's DateChooser. |
void |
setFiscalCalendar(FiscalCalendar fiscalCalendar)
Sets the
FiscalCalendar object that will be used by this item's DateChooser. |
RelativeDateItem |
setHoursAgoTitle(java.lang.String hoursAgoTitle)
The title to show for historical periods when the
TimeUnit is "hour". |
RelativeDateItem |
setHoursFromNowTitle(java.lang.String hoursFromNowTitle)
The title to show for future periods when the
TimeUnit is "hour". |
RelativeDateItem |
setInputFormat(java.lang.String inputFormat)
Format for direct user input of date values.
|
RelativeDateItem |
setMaxQuantity(int maxQuantity)
Maximum value to allow in the
quantityField. |
RelativeDateItem |
setMillisecondsAgoTitle(java.lang.String millisecondsAgoTitle)
The title to show for historical periods when the
TimeUnit is "millisecond". |
RelativeDateItem |
setMillisecondsFromNowTitle(java.lang.String millisecondsFromNowTitle)
The title to show for future periods when the
TimeUnit is "millisecond". |
RelativeDateItem |
setMinQuantity(int minQuantity)
Minimum value to allow in the
quantityField. |
RelativeDateItem |
setMinutesAgoTitle(java.lang.String minutesAgoTitle)
The title to show for historical periods when the
TimeUnit is "minute". |
RelativeDateItem |
setMinutesFromNowTitle(java.lang.String minutesFromNowTitle)
The title to show for future periods when the
TimeUnit is "minute". |
RelativeDateItem |
setMonthsAgoTitle(java.lang.String monthsAgoTitle)
The title to show for historical periods when the
TimeUnit is "month". |
RelativeDateItem |
setMonthsFromNowTitle(java.lang.String monthsFromNowTitle)
The title to show for future periods when the
TimeUnit is "month". |
RelativeDateItem |
setOperator(OperatorId operator)
What operator to use when the
FormItemCriterionGetter's getCriterion() method is called. |
RelativeDateItem |
setPickerConstructor(java.lang.String pickerConstructor)
Smart GWT class for the
dateChooser autoChild displayed to allow the
user to directly select dates. |
RelativeDateItem |
setPickerIconPrompt(java.lang.String pickerIconPrompt)
Prompt to show when the user hovers the mouse over the picker icon for this RelativeDateItem.
|
RelativeDateItem |
setPickerTimeItemProperties(TimeItem pickerTimeItemProperties)
A set of properties to apply to the
TimeItem displayed in the picker
when showPickerTimeItem is true. |
void |
setPresetOptions(java.util.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.
|
RelativeDateItem |
setQuartersAgoTitle(java.lang.String quartersAgoTitle)
The title to show for historical periods when the
TimeUnit is "quarter". |
RelativeDateItem |
setQuartersFromNowTitle(java.lang.String quartersFromNowTitle)
The title to show for future periods when the
TimeUnit is "quarter". |
RelativeDateItem |
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.
|
void |
setRangeRoundingGranularity(java.util.Map rangeRoundingGranularity)
A map from a granularity of time specified by a user to the granularity of time used for
rounding.
|
RelativeDateItem |
setSecondsAgoTitle(java.lang.String secondsAgoTitle)
The title to show for historical periods when the
TimeUnit is "second". |
RelativeDateItem |
setSecondsFromNowTitle(java.lang.String secondsFromNowTitle)
The title to show for future periods when the
TimeUnit is "second". |
RelativeDateItem |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Should this item's value be saved in the form's values and hence returned from
form.getValues()? |
RelativeDateItem |
setShowCalculatedDateField(java.lang.Boolean showCalculatedDateField)
Should the Calculated-Date be displayed to the right of the
pickerIcon. |
RelativeDateItem |
setShowChooserFiscalYearPicker(java.lang.Boolean showChooserFiscalYearPicker)
When set to true, show a button that allows the calendar to be navigated by fiscal year.
|
RelativeDateItem |
setShowChooserIcon(java.lang.Boolean showChooserIcon)
Should we show the icon that displays a date-chooser?
|
RelativeDateItem |
setShowChooserWeekPicker(java.lang.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
of
showChooserFiscalYearPicker. |
RelativeDateItem |
setShowFutureOptions(java.lang.Boolean showFutureOptions)
Should we show time-unit options in the future? If set to false, for each
timeUnitOption we will show only past
options [for example "N weeks ago"]. |
RelativeDateItem |
setShowPastOptions(java.lang.Boolean showPastOptions)
Should we show time-unit options in the past? If set to false, for each
timeUnitOption we will show only future
options [for example "N weeks from now"]. |
RelativeDateItem |
setShowPickerTimeItem(java.lang.Boolean showPickerTimeItem)
If this item is editing a field of type
"datetime", should the DateChooser display the time
field, allowing the user to select a time? |
RelativeDateItem |
setStartDate(java.util.Date startDate)
Limits the range of the popup
DateChooser. |
RelativeDateItem |
setTimeUnitOptions(TimeUnit... timeUnitOptions)
List of time units that will be offered for relative dates.
|
RelativeDateItem |
setUse24HourTime(java.lang.Boolean use24HourTime)
When showing the
DateChooser, should the time field be set to use 24-hour time? Has no effect for fields
of type "date" rather than "datetime", or if showPickerTimeItem is
false. |
RelativeDateItem |
setUseSharedPicker(java.lang.Boolean useSharedPicker)
When set to true (the default), use a single shared date-picker across all widgets that use one.
|
RelativeDateItem |
setValueFieldWidth(int valueFieldWidth)
The
width for the valueField in this item. |
RelativeDateItem |
setValueFieldWidth(java.lang.String valueFieldWidth)
The
width for the valueField in this item. |
RelativeDateItem |
setWeeksAgoTitle(java.lang.String weeksAgoTitle)
The title to show for historical periods when the
TimeUnit is "week". |
RelativeDateItem |
setWeeksFromNowTitle(java.lang.String weeksFromNowTitle)
The title to show for future periods when the
TimeUnit is "week". |
RelativeDateItem |
setYearsAgoTitle(java.lang.String yearsAgoTitle)
The title to show for historical periods when the
TimeUnit is "year". |
RelativeDateItem |
setYearsFromNowTitle(java.lang.String yearsFromNowTitle)
The title to show for future periods when the
TimeUnit is "year". |
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, updateCanvasTabPosition_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, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, 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, 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, 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, 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, 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, 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, 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, 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, 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, valueClippedgetRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedpublic RelativeDateItem()
public RelativeDateItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public RelativeDateItem(java.lang.String name)
public RelativeDateItem(java.lang.String name,
java.lang.String title)
public static RelativeDateItem 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.AutoChildUsagepublic 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.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public RelativeDateItem setAllowAbsoluteDates(java.lang.Boolean allowAbsoluteDates)
date chooser icon is hidden and the value field is switched from a ComboBoxItem, which allows text-entry, to a SelectItem which does not.allowAbsoluteDates - New allowAbsoluteDates value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getAllowAbsoluteDates()
date chooser icon is hidden and the value field is switched from a ComboBoxItem, which allows text-entry, to a SelectItem which does not.public RelativeDateItem setBaseDate(java.util.Date baseDate)
The default is to use the current date.
baseDate - New baseDate value. Default value is nullRelativeDateItem instance, for chaining setter callspublic java.util.Date getBaseDate()
The default is to use the current date.
public BlurbItem getCalculatedDateField()
baseDate.
This component is an AutoChild named "calculatedDateField". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public RelativeDateItem setCenturyThreshold(int centuryThreshold)
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
null to have the control retain your year-value as entered.
centuryThreshold - New centuryThreshold value. Default value is 25RelativeDateItem instance, for chaining setter callsAppearance overview and related methodspublic int getCenturyThreshold()
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
null to have the control retain your year-value as entered.
Appearance overview and related methodspublic RelativeDateItem setDaysAgoTitle(java.lang.String daysAgoTitle)
TimeUnit is "day".daysAgoTitle - New daysAgoTitle value. Default value is "N days ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getDaysAgoTitle()
TimeUnit is "day".public RelativeDateItem setDaysFromNowTitle(java.lang.String daysFromNowTitle)
TimeUnit is "day".daysFromNowTitle - New daysFromNowTitle value. Default value is "N days from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getDaysFromNowTitle()
TimeUnit is "day".public RelativeDateItem setDefaultQuantity(int defaultQuantity)
quantityField.defaultQuantity - New defaultQuantity value. Default value is 1RelativeDateItem instance, for chaining setter callspublic int getDefaultQuantity()
quantityField.public RelativeDateItem setEndDate(java.util.Date endDate)
DateChooser. The default of null causes the chooser's
Year-picker to offer a range that ends 10 years after the current selection.endDate - New endDate value. Default value is nullRelativeDateItem instance, for chaining setter callsAppearance overview and related methodspublic java.util.Date getEndDate()
DateChooser. The default of null causes the chooser's
Year-picker to offer a range that ends 10 years after the current selection.Appearance overview and related methodspublic RelativeDateItem setHoursAgoTitle(java.lang.String hoursAgoTitle)
TimeUnit is "hour".hoursAgoTitle - New hoursAgoTitle value. Default value is "N hours ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getHoursAgoTitle()
TimeUnit is "hour".public RelativeDateItem setHoursFromNowTitle(java.lang.String hoursFromNowTitle)
TimeUnit is "hour".hoursFromNowTitle - New hoursFromNowTitle value. Default value is "N hours from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getHoursFromNowTitle()
TimeUnit is "hour".public RelativeDateItem setInputFormat(java.lang.String inputFormat)
If unset, the input format will be determined based on the specified
displayFormat if possible, otherwise
picked up from the Date class (see DateUtil.setInputFormat()).
setInputFormat in class FormIteminputFormat - New inputFormat value. Default value is nullRelativeDateItem instance, for chaining setter callsDateInputFormatpublic java.lang.String getInputFormat()
If unset, the input format will be determined based on the specified
displayFormat if possible, otherwise
picked up from the Date class (see DateUtil.setInputFormat()).
getInputFormat in class FormItemDateItem.useTextField is true
this method returns a standard DateInputFormat, determining how values entered by the
user are to be converted to Javascript Date objects. If an explicit DateItem.inputFormat has been specified it will be
returned, otherwise, if a custom DateItem.dateFormatter or DateItem.format are
specified, the input format will be automatically derived from that property.
Otherwise, the global inputFormat is 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() and setEditorValueParser() APIs. Default value is null
DateInputFormatpublic RelativeDateItem setMaxQuantity(int maxQuantity)
quantityField. Increasing this value may result in date miscalculations for very large numbers, due to Javascript Date
limitations.maxQuantity - New maxQuantity value. Default value is 999999RelativeDateItem instance, for chaining setter callspublic int getMaxQuantity()
quantityField. Increasing this value may result in date miscalculations for very large numbers, due to Javascript Date
limitations.public RelativeDateItem setMillisecondsAgoTitle(java.lang.String millisecondsAgoTitle)
TimeUnit is "millisecond".millisecondsAgoTitle - New millisecondsAgoTitle value. Default value is "N milliseconds ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getMillisecondsAgoTitle()
TimeUnit is "millisecond".public RelativeDateItem setMillisecondsFromNowTitle(java.lang.String millisecondsFromNowTitle)
TimeUnit is "millisecond".millisecondsFromNowTitle - New millisecondsFromNowTitle value. Default value is "N milliseconds from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getMillisecondsFromNowTitle()
TimeUnit is "millisecond".public RelativeDateItem setMinQuantity(int minQuantity)
quantityField.minQuantity - New minQuantity value. Default value is 0RelativeDateItem instance, for chaining setter callspublic int getMinQuantity()
quantityField.public RelativeDateItem setMinutesAgoTitle(java.lang.String minutesAgoTitle)
TimeUnit is "minute".minutesAgoTitle - New minutesAgoTitle value. Default value is "N minutes ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getMinutesAgoTitle()
TimeUnit is "minute".public RelativeDateItem setMinutesFromNowTitle(java.lang.String minutesFromNowTitle)
TimeUnit is "minute".minutesFromNowTitle - New minutesFromNowTitle value. Default value is "N minutes from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getMinutesFromNowTitle()
TimeUnit is "minute".public RelativeDateItem setMonthsAgoTitle(java.lang.String monthsAgoTitle)
TimeUnit is "month".monthsAgoTitle - New monthsAgoTitle value. Default value is "N months ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getMonthsAgoTitle()
TimeUnit is "month".public RelativeDateItem setMonthsFromNowTitle(java.lang.String monthsFromNowTitle)
TimeUnit is "month".monthsFromNowTitle - New monthsFromNowTitle value. Default value is "N months from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getMonthsFromNowTitle()
TimeUnit is "month".public RelativeDateItem setOperator(OperatorId operator)
FormItemCriterionGetter's getCriterion() method is called.setOperator in class FormItemoperator - New operator value. Default value is "greaterThan"RelativeDateItem instance, for chaining setter callsCriteriaEditing overview and related methodspublic OperatorId getOperator()
FormItemCriterionGetter's getCriterion() method is called.getOperator in class FormItemCriteriaEditing overview and related methodspublic RelativeDateItem setPickerConstructor(java.lang.String pickerConstructor)
dateChooser autoChild displayed to allow the
user to directly select dates.pickerConstructor - New pickerConstructor value. Default value is "DateChooser"RelativeDateItem instance, for chaining setter callspublic java.lang.String getPickerConstructor()
dateChooser autoChild displayed to allow the
user to directly select dates.public FormItemIcon getPickerIcon()
DateChooser for choosing an absolute date.
This component is an AutoChild named "pickerIcon". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public RelativeDateItem setPickerIconPrompt(java.lang.String pickerIconPrompt)
setPickerIconPrompt in class FormItempickerIconPrompt - New pickerIconPrompt value. Default value is "Show Date Chooser"RelativeDateItem instance, for chaining setter callsHTMLStringpublic java.lang.String getPickerIconPrompt()
getPickerIconPrompt in class FormItemHTMLStringpublic RelativeDateItem setPickerTimeItemProperties(TimeItem pickerTimeItemProperties)
TimeItem displayed in the picker
when showPickerTimeItem is true.
Has no effect for fields of type "date".
Note : This is an advanced setting
pickerTimeItemProperties - New pickerTimeItemProperties value. Default value is nullRelativeDateItem instance, for chaining setter callspublic TimeItem getPickerTimeItemProperties()
TimeItem displayed in the picker
when showPickerTimeItem is true.
Has no effect for fields of type "date".
public SpinnerItem getQuantityField()
This component is an AutoChild named "quantityField". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public RelativeDateItem setQuartersAgoTitle(java.lang.String quartersAgoTitle)
TimeUnit is "quarter".quartersAgoTitle - New quartersAgoTitle value. Default value is "N quarters ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getQuartersAgoTitle()
TimeUnit is "quarter".public RelativeDateItem setQuartersFromNowTitle(java.lang.String quartersFromNowTitle)
TimeUnit is "quarter".quartersFromNowTitle - New quartersFromNowTitle value. Default value is "N quarters from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getQuartersFromNowTitle()
TimeUnit is "quarter".public RelativeDateItem setRangePosition(RelativeDateRangePosition rangePosition)
If unset "start" is assumed.
Note : This is an advanced setting
rangePosition - New rangePosition value. Default value is nullRelativeDateItem instance, for chaining setter callssetOperator(com.smartgwt.client.types.OperatorId),
setRangeRoundingGranularity(java.util.Map)public RelativeDateRangePosition getRangePosition()
If unset "start" is assumed.
getOperator(),
com.smartgwt.client.widgets.form.fields.RelativeDateItem#getRangeRoundingGranularitypublic RelativeDateItem setSecondsAgoTitle(java.lang.String secondsAgoTitle)
TimeUnit is "second".secondsAgoTitle - New secondsAgoTitle value. Default value is "N seconds ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getSecondsAgoTitle()
TimeUnit is "second".public RelativeDateItem setSecondsFromNowTitle(java.lang.String secondsFromNowTitle)
TimeUnit is "second".secondsFromNowTitle - New secondsFromNowTitle value. Default value is "N seconds from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getSecondsFromNowTitle()
TimeUnit is "second".public RelativeDateItem setShouldSaveValue(java.lang.Boolean shouldSaveValue)
form.getValues()? shouldSaveValue:false is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false item should
be given a value either via FormItem.defaultValue or by calling form.setValue(item,
value) or formItem.setValue(value). Providing a
value via form.values or form.setValues() will automatically switch the item to
shouldSaveValue:true.
Note that
setShouldSaveValue in class CanvasItemshouldSaveValue - New shouldSaveValue value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShouldSaveValue()
form.getValues()? shouldSaveValue:false is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false item should
be given a value either via FormItem.defaultValue or by calling form.setValue(item,
value) or formItem.setValue(value). Providing a
value via form.values or form.setValues() will automatically switch the item to
shouldSaveValue:true.
Note that
getShouldSaveValue in class CanvasItempublic RelativeDateItem setShowCalculatedDateField(java.lang.Boolean showCalculatedDateField)
pickerIcon.showCalculatedDateField - New showCalculatedDateField value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowCalculatedDateField()
pickerIcon.public RelativeDateItem setShowChooserFiscalYearPicker(java.lang.Boolean showChooserFiscalYearPicker)
showChooserFiscalYearPicker - New showChooserFiscalYearPicker value. Default value is falseRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowChooserFiscalYearPicker()
public RelativeDateItem setShowChooserIcon(java.lang.Boolean showChooserIcon)
showChooserIcon - New showChooserIcon value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowChooserIcon()
public RelativeDateItem setShowChooserWeekPicker(java.lang.Boolean showChooserWeekPicker)
showChooserFiscalYearPicker.showChooserWeekPicker - New showChooserWeekPicker value. Default value is falseRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowChooserWeekPicker()
showChooserFiscalYearPicker.public RelativeDateItem setShowFutureOptions(java.lang.Boolean showFutureOptions)
timeUnitOption we 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.
showFutureOptions - New showFutureOptions value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowFutureOptions()
timeUnitOption we 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.
public RelativeDateItem setShowPastOptions(java.lang.Boolean showPastOptions)
timeUnitOption we 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.
showPastOptions - New showPastOptions value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowPastOptions()
timeUnitOption we 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.
public RelativeDateItem setShowPickerTimeItem(java.lang.Boolean showPickerTimeItem)
"datetime", should the DateChooser display the time
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 dateFormatter has 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
showPickerTimeItem - New showPickerTimeItem value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getShowPickerTimeItem()
"datetime", should the DateChooser display the time
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 dateFormatter has 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.
public RelativeDateItem setStartDate(java.util.Date startDate)
DateChooser. The default of null causes the chooser's
Year-picker to offer a range that starts 10 years before the current selection.startDate - New startDate value. Default value is nullRelativeDateItem instance, for chaining setter callsAppearance overview and related methodspublic java.util.Date getStartDate()
DateChooser. The default of null causes the chooser's
Year-picker to offer a range that starts 10 years before the current selection.Appearance overview and related methodspublic RelativeDateItem setTimeUnitOptions(TimeUnit... timeUnitOptions)
Each available time unit option will cause two options
to appear in the valueField. For
example, if "day" is an available time unit option, there will be "N days ago" and "N days from now".
timeUnitOptions - New timeUnitOptions value. Default value is ["day", "week", "month"]RelativeDateItem instance, for chaining setter callssetShowPastOptions(java.lang.Boolean),
setShowFutureOptions(java.lang.Boolean),
setRangeRoundingGranularity(java.util.Map)public TimeUnit[] getTimeUnitOptions()
Each available time unit option will cause two options
to appear in the valueField. For
example, if "day" is an available time unit option, there will be "N days ago" and "N days from now".
getShowPastOptions(),
getShowFutureOptions(),
com.smartgwt.client.widgets.form.fields.RelativeDateItem#getRangeRoundingGranularitypublic RelativeDateItem setUse24HourTime(java.lang.Boolean use24HourTime)
DateChooser, should the time field be set to use 24-hour time? Has no effect for fields
of type "date" rather than "datetime", or if showPickerTimeItem is
false. Default is true.
use24HourTime - New use24HourTime value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getUse24HourTime()
DateChooser, should the time field be set to use 24-hour time? Has no effect for fields
of type "date" rather than "datetime", or if showPickerTimeItem is
false. Default is true.
public RelativeDateItem setUseSharedPicker(java.lang.Boolean useSharedPicker)
picker and pickerProperties for details
on setting up an unshared picker.useSharedPicker - New useSharedPicker value. Default value is trueRelativeDateItem instance, for chaining setter callspublic java.lang.Boolean getUseSharedPicker()
picker and pickerProperties for details
on setting up an unshared picker.public RelativeDateItem setValueFieldWidth(int valueFieldWidth)
width for the valueField in this item. Defaults to the
current default value for the width attribute on the DateTimeItem class
- 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 DateTimeItem class
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.
valueFieldWidth - New valueFieldWidth value. Default value is nullRelativeDateItem instance, for chaining setter callspublic int getValueFieldWidth()
width for the valueField in this item. Defaults to the
current default value for the width attribute on the DateTimeItem class
- 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 DateTimeItem class
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.
public RelativeDateItem setValueFieldWidth(java.lang.String valueFieldWidth)
width for the valueField in this item. Defaults to the
current default value for the width attribute on the DateTimeItem class
- 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 DateTimeItem class
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.
valueFieldWidth - New valueFieldWidth value. Default value is nullRelativeDateItem instance, for chaining setter callspublic java.lang.String getValueFieldWidthAsString()
width for the valueField in this item. Defaults to the
current default value for the width attribute on the DateTimeItem class
- 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 DateTimeItem class
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.
public RelativeDateItem setWeeksAgoTitle(java.lang.String weeksAgoTitle)
TimeUnit is "week".weeksAgoTitle - New weeksAgoTitle value. Default value is "N weeks ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getWeeksAgoTitle()
TimeUnit is "week".public RelativeDateItem setWeeksFromNowTitle(java.lang.String weeksFromNowTitle)
TimeUnit is "week".weeksFromNowTitle - New weeksFromNowTitle value. Default value is "N weeks from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getWeeksFromNowTitle()
TimeUnit is "week".public RelativeDateItem setYearsAgoTitle(java.lang.String yearsAgoTitle)
TimeUnit is "year".yearsAgoTitle - New yearsAgoTitle value. Default value is "N years ago"RelativeDateItem instance, for chaining setter callspublic java.lang.String getYearsAgoTitle()
TimeUnit is "year".public RelativeDateItem setYearsFromNowTitle(java.lang.String yearsFromNowTitle)
TimeUnit is "year".yearsFromNowTitle - New yearsFromNowTitle value. Default value is "N years from now"RelativeDateItem instance, for chaining setter callspublic java.lang.String getYearsFromNowTitle()
TimeUnit is "year".public void formatEditorValue()
FormItem.formatEditorValue() and FormItem.parseEditorValue() methods. Developers can
customize the display values for these items in the following ways:presetOptions map allows standard preset
RelativeDateString and RelativeDateShortcut values to be mapped to custom display valuestimeUnitOptions (e.g:"N days ago") may be customized via the per-time unit title attributes (daysFromNowTitle, daysAgoTitle, etc)dateFormatter and inputFormat may be used modify how date values
are displayed (both in the text entry box and in the calculatedDateFieldpublic void getEnteredValue()
public FiscalCalendar getFiscalCalendar()
FiscalCalendar object that will be used by this item's DateChooser.public void parseEditorValue()
FormItem.formatEditorValue() and FormItem.parseEditorValue() methods. Developers can
customize the display values for these items in the following ways:presetOptions map allows standard preset
RelativeDateString and RelativeDateShortcut values to be mapped to custom display valuestimeUnitOptions (e.g:"N days ago") may be customized via the per-time unit title attributes (daysFromNowTitle, daysAgoTitle, etc)dateFormatter and inputFormat may be used modify how date values
are displayed (both in the text entry box and in the calculatedDateFieldpublic void setFiscalCalendar()
FiscalCalendar object that will be used by this item's DateChooser. If
unset, the global fiscal calendar is used.public void setFiscalCalendar(FiscalCalendar fiscalCalendar)
FiscalCalendar object that will be used by this item's DateChooser. If
unset, the global fiscal calendar is used.fiscalCalendar - the fiscal calendar for this chooser, if set, or the global one otherwisepublic static void setDefaultProperties(RelativeDateItem relativeDateItemProperties)
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.
relativeDateItemProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic RelativeDate getRelativeDate()
public static java.util.Date getAbsoluteDate(RelativeDate relativeDate)
relativeDate - the relative date to convertpublic static java.util.Date getAbsoluteDate(RelativeDate relativeDate, java.util.Date baseDate)
relativeDate - the relative date to convertbaseDate - base value for conversion. Defaults to todaypublic void setPresetOptions(java.util.LinkedHashMap valueMap)
This is similar to a standard 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 #setTimeUnitOptions,time unit options.public void setRangeRoundingGranularity(java.util.Map rangeRoundingGranularity)
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:
RelativeDateItem fromDate = new RelativeDateItem("from");
fromDate.setRangePosition(RelativeDateRangePosition.START);
fromDate.setTimeUnitOptions(TimeUnit.DAY, TimeUnit.WEEK);
Map roundingMap = new HashMap();
roundingMap.put(TimeUnit.DAY, TimeUnit.DAY);
roundingMap.put(TimeUnit.WEEK, TimeUnit.WEEK);
fromDate.setRangeRoundingGranularity(roundingMap);
rangeRoundingGranularity - public RelativeDateItem setDateFormatter(DateDisplayFormat dateFormatter)
valueField and calculatedDateField. Defaults to the system-wide default established by Date.setShortDisplayFormat, or if this item
has its type specified as datetime, Date.setShortDatetimeDisplayFormat.setDateFormatter in class FormItemdateFormatter - dateFormatter Default value is nullRelativeDateItem
instance, for chaining setter callsFormItem.setTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat),
FormItem.setFormat(java.lang.String),
Appearance overview and related methodspublic RelativeDateItem setDateFormatter(DateDisplayFormatter formatter)
valueField and calculatedDateField in some custom format. Typically the setDateParser(DateParser) method should
also be applied to ensure dates can be both formatted and edited date strings parsed back into actual
date values.dateFormatter - dateFormatter Default value is nullRelativeDateItem
instance, for chaining setter callspublic void setDateParser(DateParser parser)
setDateFormatter(DateDisplayFormatter).
Note that setDateFormatter(DateDisplayFormat) and
setInputFormat(String) already
provide a mechanism for customizing the display format for date values displayed in this item.
public void setEditorValueParser(FormItemValueParser parser)
setEditorValueParser in class FormItemparser - the FormItemValueParserpublic void setEditorValueFormatter(FormItemValueFormatter formatter)
setEditorValueFormatter in class FormItemformatter - the FormItemValueFormatterpublic ComboBoxItem getValueFieldComboBox()
ComboBoxItem field where a user may choose among presets, time unit plus quantity, or direct entry of a date as text.
For an overview of how to use and configure AutoChildren, see Using AutoChildren.