public class DateRangeItem extends CanvasItem
RelativeDateItems (if allowRelativeDates is true) or two DateItems. The item's data type is expected to be one of "date" or "datetime" and
dictates whether the dates in the range include a time portion. If unset and the item's form is databound, the data
type is detected from the associated dataSource field. If there is no
such field, or the form is not databound, the default data type value is "date".
DateRangeItem is just a
convenience relative to using two RelativeDateItem or DateItem controls in a form, then using FormItem.operator and FormItem.criteriaField to cause them to produce a
date range. If you need more control over layout, validation, event handling or any other aspect of appearance or
behavior, stop using DateRangeItem and use two DateItem/RelativeDateItem controls directly instead.
FormItem.CustomStateGetter, FormItem.StateCustomizerconfigOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultidfactoryCreated, factoryProperties| Constructor and Description |
|---|
DateRangeItem() |
DateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
DateRangeItem(java.lang.String name) |
DateRangeItem(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
java.lang.String |
getAbsoluteDateTimeItemConstructor()
The
FormItem class to create when allowRelativeDates is false, and the DateRangeItem's type is "datetime". |
java.lang.String |
getAbsoluteItemConstructor()
The
FormItem class to create when allowRelativeDates is false, but the DateRangeItem does not have type "datetime". |
java.lang.Boolean |
getAllowRelativeDates()
Whether to allow the user to specify relative dates (via
RelativeDateItems) or whether dates are absolute (via DateItems). |
DynamicForm |
getDateRangeForm()
DynamicForm com.smartgwt.client.types.AutoChild automatically created
by the dateRangeItem and applied to the item as this.canvas. |
DateFieldLayout |
getFieldLayout()
|
UserFormula |
getFormula()
Not applicable to a DateRangeItem.
|
java.util.Date |
getFromDate()
Initial value for the "from" date.
|
FormItem |
getFromField()
|
java.lang.String |
getFromTitle()
The title for the
from part of the range. |
TitleOrientation |
getInnerTitleOrientation()
The title orientation for the to / from sub-items.
|
java.lang.String |
getInputFormat()
For fields of type
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item. |
java.lang.String |
getInvalidRangeErrorMessage()
Error message to display if the user enters a date range where the "To" field value is earlier than the "From" field
value.
|
static DateRangeItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getRelativeItemConstructor()
The
FormItem class to create when allowRelativeDates is true. |
java.lang.Boolean |
getShouldSaveValue()
Allow dateRangeItems' values to show up in the form's values array, or if
DynamicForm.getValuesAsCriteria() is called, for the
criterion to be included in the returned AdvancedCriteria object |
UserSummary |
getTextFormula()
Not applicable to a DateRangeItem.
|
java.util.Date |
getToDate()
Initial value for the "to" date.
|
java.lang.String |
getToDateAsString()
Initial value for the "to" date.
|
TimeUnit |
getToDateAsTimeUnit()
Initial value for the "to" date.
|
FormItem |
getToField()
|
java.lang.String |
getToTitle()
The title for the
to part of the range. |
java.lang.Boolean |
getValidateCriteria()
If this attribute is set to
true when getCriterion() is called, the item will validate the "to" and "from" fields and return null if either
field fails validation. |
DateRange |
getValue()
Retrieves the current value of this dateRangeItem.
|
java.lang.Boolean |
hasAdvancedCriteria()
Overridden to return true: dateRangeItems always generate AdvancedCriteria.
|
DateRangeItem |
setAllowRelativeDates(java.lang.Boolean allowRelativeDates)
Whether to allow the user to specify relative dates (via
RelativeDateItems) or whether dates are absolute (via DateItems). |
void |
setCanEditCriterionPredicate(FormItemCanEditCriterionPredicate predicate)
The default
canEditCriterion() predicate returns true if the specified criterion contains:
A single "lessOrEqual" or "greaterOrEqual" criterion on this
field An "and" type criterion containing a "lessOrEqual" and a "greaterOrEqual" criterion on this
field A single "equals" criterion. |
void |
setCriterionSetter(FormItemCriterionSetter setter)
The default
setCriterion() implementation applies the specified criterion to this item for editing. |
static void |
setDefaultProperties(DateRangeItem dateRangeItemProperties)
Class level method to set the default properties of this class.
|
DateRangeItem |
setFieldLayout(DateFieldLayout fieldLayout)
|
DateRangeItem |
setFormula(UserFormula formula)
Not applicable to a DateRangeItem.
|
void |
setFromDate(java.util.Date fromDate)
Initial value for the "from" date.
|
DateRangeItem |
setFromTitle(java.lang.String fromTitle)
The title for the
from part of the range. |
DateRangeItem |
setInnerTitleOrientation(TitleOrientation innerTitleOrientation)
The title orientation for the to / from sub-items.
|
DateRangeItem |
setInputFormat(java.lang.String inputFormat)
For fields of type
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item. |
DateRangeItem |
setInvalidRangeErrorMessage(java.lang.String invalidRangeErrorMessage)
Error message to display if the user enters a date range where the "To" field value is earlier than the "From" field
value.
|
DateRangeItem |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Allow dateRangeItems' values to show up in the form's values array, or if
DynamicForm.getValuesAsCriteria() is called, for the
criterion to be included in the returned AdvancedCriteria object |
DateRangeItem |
setTextFormula(UserSummary textFormula)
Not applicable to a DateRangeItem.
|
DateRangeItem |
setToDate(java.util.Date toDate)
Initial value for the "to" date.
|
DateRangeItem |
setToDate(java.lang.String toDate)
Initial value for the "to" date.
|
DateRangeItem |
setToDate(TimeUnit toDate)
Initial value for the "to" date.
|
DateRangeItem |
setToTitle(java.lang.String toTitle)
The title for the
to part of the range. |
DateRangeItem |
setValidateCriteria(java.lang.Boolean validateCriteria)
If this attribute is set to
true when getCriterion() is called, the item will validate the "to" and "from" fields and return null if either
field fails validation. |
void |
setValue(DateRange value)
Sets the value for this dateRangeItem.
|
java.lang.Boolean |
validateRange()
Validate both "to" and "from" date-fields.
|
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getMultiple, getOverflow, getPrompt, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanvas, setCriterionGetter, 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, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getLeft, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyCanSelectText, 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, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapHintText, 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, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEditProxyConstructor, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, 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, 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, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedpublic DateRangeItem()
public DateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public DateRangeItem(java.lang.String name)
public DateRangeItem(java.lang.String name,
java.lang.String title)
public static DateRangeItem 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 java.lang.String getAbsoluteDateTimeItemConstructor()
FormItem class to create when allowRelativeDates is false, and the DateRangeItem's type is "datetime".FieldTypepublic java.lang.String getAbsoluteItemConstructor()
FormItem class to create when allowRelativeDates is false, but the DateRangeItem does not have type "datetime".FieldTypepublic DateRangeItem setAllowRelativeDates(java.lang.Boolean allowRelativeDates)
RelativeDateItems) or whether dates are absolute (via DateItems).allowRelativeDates - New allowRelativeDates value. Default value is falseDateRangeItem instance, for chaining setter callspublic java.lang.Boolean getAllowRelativeDates()
RelativeDateItems) or whether dates are absolute (via DateItems).public DynamicForm getDateRangeForm()
DynamicForm com.smartgwt.client.types.AutoChild automatically created
by the dateRangeItem and applied to the item as this.canvas. This DynamicForm contains the "from" and "to" fields the user will interact with to actually select a
date-range. Note that as a standard autoChild, developers may customize this form by modifying
dateRangeProperties.
This component is an AutoChild named "dateRangeForm". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public DateRangeItem setFieldLayout(DateFieldLayout fieldLayout)
toField and
fromField in the dateRangeForm. Note that we don't recommend
"horizontal" placement for mobile, and we also don't recommend it for allowRelativeDates mode, since RelativeDateItem changes width drastically during editing, which causes a lot
of unpleasant side-to-side shifting of controls.
fieldLayout - New fieldLayout value. Default value is "vertical"DateRangeItem instance, for chaining setter callspublic DateFieldLayout getFieldLayout()
toField and
fromField in the dateRangeForm. Note that we don't recommend
"horizontal" placement for mobile, and we also don't recommend it for allowRelativeDates mode, since RelativeDateItem changes width drastically during editing, which causes a lot
of unpleasant side-to-side shifting of controls.
public DateRangeItem setFormula(UserFormula formula)
setFormula in class FormItemformula - New formula value. Default value is nullDateRangeItem instance, for chaining setter callsFormulaFields overview and related methodspublic UserFormula getFormula()
getFormula in class FormItemFormulaFields overview and related methodspublic FormItem getFromField()
RelativeDateItem or DateItem according to allowRelativeDates.
This component is an AutoChild named "fromField". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public DateRangeItem setFromTitle(java.lang.String fromTitle)
from part of the range.fromTitle - New fromTitle value. Default value is "From"DateRangeItem instance, for chaining setter callspublic java.lang.String getFromTitle()
from part of the range.public DateRangeItem setInnerTitleOrientation(TitleOrientation innerTitleOrientation)
this.titleOrientation or this.form.titleOrientation.innerTitleOrientation - New innerTitleOrientation value. Default value is nullDateRangeItem instance, for chaining setter callspublic TitleOrientation getInnerTitleOrientation()
this.titleOrientation or this.form.titleOrientation.public DateRangeItem setInputFormat(java.lang.String inputFormat)
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item.setInputFormat in class FormIteminputFormat - New inputFormat value. Default value is nullDateRangeItem instance, for chaining setter callsFormItem.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat),
DateInputFormatpublic java.lang.String getInputFormat()
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item.getInputFormat in class FormItemFormItem.getDateFormatter(),
DateInputFormatpublic DateRangeItem setInvalidRangeErrorMessage(java.lang.String invalidRangeErrorMessage)
invalidRangeErrorMessage - New invalidRangeErrorMessage value. Default value is "'To' field value cannot be earlier than 'From' field value."DateRangeItem instance, for chaining setter callspublic java.lang.String getInvalidRangeErrorMessage()
public java.lang.String getRelativeItemConstructor()
FormItem class to create when allowRelativeDates is true.public DateRangeItem setShouldSaveValue(java.lang.Boolean shouldSaveValue)
DynamicForm.getValuesAsCriteria() is called, for the
criterion to be included in the returned AdvancedCriteria objectsetShouldSaveValue in class CanvasItemshouldSaveValue - New shouldSaveValue value. Default value is trueDateRangeItem instance, for chaining setter callspublic java.lang.Boolean getShouldSaveValue()
DynamicForm.getValuesAsCriteria() is called, for the
criterion to be included in the returned AdvancedCriteria objectgetShouldSaveValue in class CanvasItempublic DateRangeItem setTextFormula(UserSummary textFormula)
setTextFormula in class FormItemtextFormula - New textFormula value. Default value is nullDateRangeItem instance, for chaining setter callsFormulaFields overview and related methodspublic UserSummary getTextFormula()
getTextFormula in class FormItemFormulaFields overview and related methodspublic DateRangeItem setToDate(java.util.Date toDate)
toDate for this DateRangeItem.toDate - the date at which this item should end it's range. Default value is todayDateRangeItem instance, for chaining setter callspublic java.util.Date getToDate()
public DateRangeItem setToDate(java.lang.String toDate)
toDate for this DateRangeItem.toDate - the date at which this item should end it's range. Default value is todayDateRangeItem instance, for chaining setter callsRelativeDateStringpublic java.lang.String getToDateAsString()
RelativeDateStringpublic DateRangeItem setToDate(TimeUnit toDate)
toDate for this DateRangeItem.toDate - the date at which this item should end it's range. Default value is todayDateRangeItem instance, for chaining setter callsRelativeDateStringpublic TimeUnit getToDateAsTimeUnit()
RelativeDateStringpublic FormItem getToField()
RelativeDateItem or DateItem according to allowRelativeDates.
This component is an AutoChild named "toField". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public DateRangeItem setToTitle(java.lang.String toTitle)
to part of the range.toTitle - New toTitle value. Default value is "To"DateRangeItem instance, for chaining setter callspublic java.lang.String getToTitle()
to part of the range.public DateRangeItem setValidateCriteria(java.lang.Boolean validateCriteria)
true when getCriterion() is called, the item will validate the "to" and "from" fields and return null if either
field fails validation. See validateRange()validateCriteria - New validateCriteria value. Default value is falseDateRangeItem instance, for chaining setter callspublic java.lang.Boolean getValidateCriteria()
true when getCriterion() is called, the item will validate the "to" and "from" fields and return null if either
field fails validation. See validateRange()public java.lang.Boolean hasAdvancedCriteria()
hasAdvancedCriteria in class CanvasItemCriteriaEditing overview and related methodspublic java.lang.Boolean validateRange()
public static void setDefaultProperties(DateRangeItem dateRangeItemProperties)
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.
dateRangeItemProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic void setFromDate(java.util.Date fromDate)
fromDate for this DateRangeItem.fromDate - the date from which this item should start it's range. Default value is todaypublic java.util.Date getFromDate()
public DateRange getValue()
DateRange object that excludes start and end values if they aren't set.public void setValue(DateRange value)
DateRange object
that optionally includes both start and end values.value - the new value for this itempublic void setCanEditCriterionPredicate(FormItemCanEditCriterionPredicate predicate)
canEditCriterion() predicate returns true if the specified criterion contains:
FormItemCriterionGetter's
getCriterion() method will return this more complex criterion.setCanEditCriterionPredicate in class CanvasItempredicate - the predicate to determine the form items that can edit the criterion in questionFormItem.setCanEditCriterionPredicate,
CriteriaEditing overview and related methodspublic void setCriterionSetter(FormItemCriterionSetter setter)
setCriterion() implementation applies the specified criterion to this item for editing.
Applies any specified "greaterOrEqual" operator criterion or
sub-criterion to our fromField and any
specified "lessOrEqual" operator criterion or sub-criterion to our toField. Note that a single "equals" criterion can
also be passed. See setCanEditCriterionPredicate()
for more detail.
setCriterionSetter in class CanvasItemsetter - provides a method to update this field with the edited criterion