Package com.smartgwt.client.widgets.form.fields

# Class DateRangeItem

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.data.Field
com.smartgwt.client.widgets.form.fields.FormItem
com.smartgwt.client.widgets.form.fields.CanvasItem
com.smartgwt.client.widgets.form.fields.DateRangeItem

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`

public class DateRangeItem extends CanvasItem
Allows a user to select an absolute or relative range of dates via two `RelativeDateItem`s (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.

- ## 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, warnOnEditorTypeConversionDefault`

  ### Fields inherited from class com.smartgwt.client.core.RefDataClass

  `id`

  ### Fields inherited from class com.smartgwt.client.core.DataClass

  `factoryCreated, factoryProperties`

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

  `jsObj`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DateRangeItem()`
  `DateRangeItem(JavaScriptObject jsObj)`
  `DateRangeItem(String name)`
  `DateRangeItem(String name, String title)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static void`
  `changeAutoChildDefaults(String autoChildName, Canvas defaults)`
  Changes the defaults for Canvas AutoChildren named `autoChildName`.
  `static void`
  `changeAutoChildDefaults(String autoChildName, FormItem defaults)`
  Changes the defaults for FormItem AutoChildren named `autoChildName`.
  `static void`
  `changePickerIconDefaults(FormItemIcon defaults)`
  `String`
  `getAbsoluteDateTimeItemConstructor()`
  The `FormItem` class to create when `allowRelativeDates` is false, and the `DateRangeItem`'s type is "datetime".
  `String`
  `getAbsoluteItemConstructor()`
  The `FormItem` class to create when `allowRelativeDates` is false, but the `DateRangeItem` does not have type "datetime".
  `Boolean`
  `getAllowRelativeDates()`
  Whether to allow the user to specify relative dates (via `RelativeDateItem`s) or whether dates are absolute (via `DateItem`s).
  `DynamicForm`
  `getDateRangeForm()`
  `DynamicForm` `com.smartgwt.client.types.AutoChild` automatically created by the dateRangeItem and applied to the item as `this.canvas`.
  `DateFieldLayout`
  `getFieldLayout()`
  Controls the placement of the `toField` and `fromField` in the `dateRangeForm`.
  `UserFormula`
  `getFormula()`
  Not applicable to a DateRangeItem.
  `Date`
  `getFromDate()`
  Initial value for the "from" date.
  `FormItem`
  `getFromField()`
  The field for the "from" date - a `RelativeDateItem` or `DateItem` according to `allowRelativeDates`.
  `String`
  `getFromTitle()`
  The title for the `from` part of the range.
  `TitleOrientation`
  `getInnerTitleOrientation()`
  The title orientation for the to / from sub-items.
  `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.
  `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(JavaScriptObject jsObj)`
  `String`
  `getRelativeItemConstructor()`
  The `FormItem` class to create when `allowRelativeDates` is true.
  `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.
  `Date`
  `getToDate()`
  Initial value for the "to" date.
  `String`
  `getToDateAsString()`
  Initial value for the "to" date.
  `TimeUnit`
  `getToDateAsTimeUnit()`
  Initial value for the "to" date.
  `FormItem`
  `getToField()`
  The field for the "to" date - a `RelativeDateItem` or `DateItem` according to `allowRelativeDates`.
  `String`
  `getToTitle()`
  The title for the `to` part of the range.
  `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.
  `Boolean`
  `hasAdvancedCriteria()`
  Overridden to return true: dateRangeItems always generate AdvancedCriteria.
  `DateRangeItem`
  `setAllowRelativeDates(Boolean allowRelativeDates)`
  Whether to allow the user to specify relative dates (via `RelativeDateItem`s) or whether dates are absolute (via `DateItem`s).
  `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)`
  Controls the placement of the `toField` and `fromField` in the `dateRangeForm`.
  `DateRangeItem`
  `setFormula(UserFormula formula)`
  Not applicable to a DateRangeItem.
  `void`
  `setFromDate(Date fromDate)`
  Initial value for the "from" date.
  `DateRangeItem`
  `setFromTitle(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(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(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(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(TimeUnit toDate)`
  Initial value for the "to" date.
  `DateRangeItem`
  `setToDate(String toDate)`
  Initial value for the "to" date.
  `DateRangeItem`
  `setToDate(Date toDate)`
  Initial value for the "to" date.
  `DateRangeItem`
  `setToTitle(String toTitle)`
  The title for the `to` part of the range.
  `DateRangeItem`
  `setValidateCriteria(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.
  `Boolean`
  `validateRange()`
  Validate both "to" and "from" date-fields.

  ### 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, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanvas, setCriterionGetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPosition`

  ### Methods 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, getExtraControlTableCSS, getExtraTextBoxCSS, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, 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, 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, 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, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, 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, 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, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setExtraControlTableCSS, setExtraTextBoxCSS, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, 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, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, 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, 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, valueClipped`

  ### Methods inherited from class com.smartgwt.client.data.Field

  `getCanExport, getExportTitle, getPrimaryKey, getSortByField, setCanExport, setExportTitle, setPrimaryKey, setSortByField`

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

  `getRef, getRef, internalSetID`

  ### Methods 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, setFactoryCreated`

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

  `equals, getJsObj, hashCode, setJsObj`

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

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

  `fireEvent`

- ## Constructor Details

  - ### DateRangeItem

    public DateRangeItem()

  - ### DateRangeItem

    public DateRangeItem(JavaScriptObject jsObj)

  - ### DateRangeItem

    public DateRangeItem(String name)

  - ### DateRangeItem

    public DateRangeItem(String name, String title)

- ## Method Details

  - ### getOrCreateRef

    public static DateRangeItem getOrCreateRef(JavaScriptObject jsObj)

  - ### changeAutoChildDefaults

    public static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
    Changes the defaults for Canvas AutoChildren named `autoChildName`.
    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, see `SGWTProperties`.
    See Also:
      - `AutoChildUsage`

  - ### changeAutoChildDefaults

    public static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
    Changes the defaults for FormItem AutoChildren named `autoChildName`.
    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, see `SGWTProperties`.
    See Also:
      - `AutoChildUsage`

  - ### changePickerIconDefaults

    public static void changePickerIconDefaults(FormItemIcon defaults)

  - ### getAbsoluteDateTimeItemConstructor

    public String getAbsoluteDateTimeItemConstructor()
    The `FormItem` class to create when `allowRelativeDates` is false, and the `DateRangeItem`'s type is "datetime".
    Returns:
      Current absoluteDateTimeItemConstructor value. Default value is "DateTimeItem"
    See Also:
      - `FieldType`

  - ### getAbsoluteItemConstructor

    public String getAbsoluteItemConstructor()
    The `FormItem` class to create when `allowRelativeDates` is false, but the `DateRangeItem` does not have type "datetime".
    Returns:
      Current absoluteItemConstructor value. Default value is "DateItem"
    See Also:
      - `FieldType`

  - ### setAllowRelativeDates

    public DateRangeItem setAllowRelativeDates(Boolean allowRelativeDates)
    Whether to allow the user to specify relative dates (via `RelativeDateItem`s) or whether dates are absolute (via `DateItem`s).
    Parameters:
      `allowRelativeDates` - New allowRelativeDates value. Default value is false
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getAllowRelativeDates

    public Boolean getAllowRelativeDates()
    Whether to allow the user to specify relative dates (via `RelativeDateItem`s) or whether dates are absolute (via `DateItem`s).
    Returns:
      Current allowRelativeDates value. Default value is false

  - ### getDateRangeForm

    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`.

    Returns:
      Current dateRangeForm value. Default value is null

  - ### setFieldLayout

    public DateRangeItem setFieldLayout(DateFieldLayout fieldLayout)
    Controls the placement of the `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.

    Parameters:
      `fieldLayout` - New fieldLayout value. Default value is "vertical"
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getFieldLayout

    public DateFieldLayout getFieldLayout()
    Controls the placement of the `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.

    Returns:
      Current fieldLayout value. Default value is "vertical"

  - ### setFormula

    public DateRangeItem setFormula(UserFormula formula)
    Not applicable to a DateRangeItem.
    Overrides:
      `setFormula` in class `FormItem`
    Parameters:
      `formula` - New formula value. Default value is null
    Returns:
      `DateRangeItem` instance, for chaining setter calls
    See Also:
      - `FormulaFields overview and related methods`

  - ### getFormula

    public UserFormula getFormula()
    Not applicable to a DateRangeItem.
    Overrides:
      `getFormula` in class `FormItem`
    Returns:
      Current formula value. Default value is null
    See Also:
      - `FormulaFields overview and related methods`

  - ### getFromField

    public FormItem getFromField()
    The field for the "from" date - a `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`.

    Returns:
      Current fromField value. Default value is null

  - ### setFromTitle

    public DateRangeItem setFromTitle(String fromTitle)
    The title for the `from` part of the range.
    Parameters:
      `fromTitle` - New fromTitle value. Default value is "From"
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getFromTitle

    public String getFromTitle()
    The title for the `from` part of the range.
    Returns:
      Current fromTitle value. Default value is "From"

  - ### setInnerTitleOrientation

    public DateRangeItem setInnerTitleOrientation(TitleOrientation innerTitleOrientation)
    The title orientation for the to / from sub-items. If unset this will be derived from `this.titleOrientation` or `this.form.titleOrientation`.
    Parameters:
      `innerTitleOrientation` - New innerTitleOrientation value. Default value is null
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getInnerTitleOrientation

    public TitleOrientation getInnerTitleOrientation()
    The title orientation for the to / from sub-items. If unset this will be derived from `this.titleOrientation` or `this.form.titleOrientation`.
    Returns:
      Current innerTitleOrientation value. Default value is null

  - ### setInputFormat

    public DateRangeItem setInputFormat(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.
    Overrides:
      `setInputFormat` in class `FormItem`
    Parameters:
      `inputFormat` - New inputFormat value. Default value is null
    Returns:
      `DateRangeItem` instance, for chaining setter calls
    See Also:
      - `FormItem.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat)`
      - `DateInputFormat`

  - ### getInputFormat

    public 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.
    Overrides:
      `getInputFormat` in class `FormItem`
    Returns:
      Current inputFormat value. Default value is null
    See Also:
      - `FormItem.getDateFormatter()`
      - `DateInputFormat`

  - ### setInvalidRangeErrorMessage

    public DateRangeItem setInvalidRangeErrorMessage(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.
    Parameters:
      `invalidRangeErrorMessage` - New invalidRangeErrorMessage value. Default value is "'To' field value cannot be earlier than 'From' field value."
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getInvalidRangeErrorMessage

    public 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.
    Returns:
      Current invalidRangeErrorMessage value. Default value is "'To' field value cannot be earlier than 'From' field value."

  - ### getRelativeItemConstructor

    public String getRelativeItemConstructor()
    The `FormItem` class to create when `allowRelativeDates` is true.
    Returns:
      Current relativeItemConstructor value. Default value is "RelativeDateItem"

  - ### setShouldSaveValue

    public DateRangeItem setShouldSaveValue(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
    Overrides:
      `setShouldSaveValue` in class `CanvasItem`
    Parameters:
      `shouldSaveValue` - New shouldSaveValue value. Default value is true
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getShouldSaveValue

    public 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
    Overrides:
      `getShouldSaveValue` in class `CanvasItem`
    Returns:
      Current shouldSaveValue value. Default value is true

  - ### setTextFormula

    public DateRangeItem setTextFormula(UserSummary textFormula)
    Not applicable to a DateRangeItem.
    Overrides:
      `setTextFormula` in class `FormItem`
    Parameters:
      `textFormula` - New textFormula value. Default value is null
    Returns:
      `DateRangeItem` instance, for chaining setter calls
    See Also:
      - `FormulaFields overview and related methods`

  - ### getTextFormula

    public UserSummary getTextFormula()
    Not applicable to a DateRangeItem.
    Overrides:
      `getTextFormula` in class `FormItem`
    Returns:
      Current textFormula value. Default value is null
    See Also:
      - `FormulaFields overview and related methods`

  - ### setToDate

    public DateRangeItem setToDate(Date toDate)
    Initial value for the "to" date.
    If this method is called after the component has been drawn/initialized: Sets the `toDate` for this DateRangeItem.
    Parameters:
      `toDate` - the date at which this item should end it's range. Default value is today
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getToDate

    public Date getToDate()
    Initial value for the "to" date.
    Returns:
      Current toDate value. Default value is today

  - ### setToDate

    public DateRangeItem setToDate(String toDate)
    Initial value for the "to" date.
    If this method is called after the component has been drawn/initialized: Sets the `toDate` for this DateRangeItem.
    Parameters:
      `toDate` - the date at which this item should end it's range. Default value is today
    Returns:
      `DateRangeItem` instance, for chaining setter calls
    See Also:
      - `RelativeDateString`

  - ### getToDateAsString

    public String getToDateAsString()
    Initial value for the "to" date.
    Returns:
      Current toDate value. Default value is today
    See Also:
      - `RelativeDateString`

  - ### setToDate

    public DateRangeItem setToDate(TimeUnit toDate)
    Initial value for the "to" date.
    If this method is called after the component has been drawn/initialized: Sets the `toDate` for this DateRangeItem.
    Parameters:
      `toDate` - the date at which this item should end it's range. Default value is today
    Returns:
      `DateRangeItem` instance, for chaining setter calls
    See Also:
      - `RelativeDateString`

  - ### getToDateAsTimeUnit

    public TimeUnit getToDateAsTimeUnit()
    Initial value for the "to" date.
    Returns:
      Current toDate value. Default value is today
    See Also:
      - `RelativeDateString`

  - ### getToField

    public FormItem getToField()
    The field for the "to" date - a `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`.

    Returns:
      Current toField value. Default value is null

  - ### setToTitle

    public DateRangeItem setToTitle(String toTitle)
    The title for the `to` part of the range.
    Parameters:
      `toTitle` - New toTitle value. Default value is "To"
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getToTitle

    public String getToTitle()
    The title for the `to` part of the range.
    Returns:
      Current toTitle value. Default value is "To"

  - ### setValidateCriteria

    public DateRangeItem setValidateCriteria(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. See `validateRange()`
    Parameters:
      `validateCriteria` - New validateCriteria value. Default value is false
    Returns:
      `DateRangeItem` instance, for chaining setter calls

  - ### getValidateCriteria

    public 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. See `validateRange()`
    Returns:
      Current validateCriteria value. Default value is false

  - ### hasAdvancedCriteria

    public Boolean hasAdvancedCriteria()
    Overridden to return true: dateRangeItems always generate AdvancedCriteria.
    Overrides:
      `hasAdvancedCriteria` in class `CanvasItem`
    Returns:
      true
    See Also:
      - `Criteria Editing`

  - ### validateRange

    public Boolean validateRange()
    Validate both "to" and "from" date-fields.
    Returns:
      false if either to or from field contains an invalid date value.

  - ### setDefaultProperties

    public static void setDefaultProperties(DateRangeItem dateRangeItemProperties)
    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:
      `dateRangeItemProperties` - properties that should be used as new defaults when instances of this class are created
    See Also:
      - `SGWTProperties`

  - ### setFromDate

    public void setFromDate(Date fromDate)
    Initial value for the "from" date. Sets the `fromDate` for this DateRangeItem.
    Parameters:
      `fromDate` - the date from which this item should start it's range. Default value is today

  - ### getFromDate

    public Date getFromDate()
    Initial value for the "from" date.
    Returns:
      java.util.Date

  - ### getValue

    public DateRange getValue()
    Retrieves the current value of this dateRangeItem. The return value is a `DateRange` object that excludes start and end values if they aren't set.
    Overrides:
      `getValue` in class `FormItem`
    Returns:
      the current value of this item

  - ### setValue

    public void setValue(DateRange value)
    Sets the value for this dateRangeItem. The value parameter is a `DateRange` object that optionally includes both start and end values.
    Parameters:
      `value` - the new value for this item

  - ### setCanEditCriterionPredicate

    public 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. Internally, this will be converted into a range by constructing an "and" type criterion containing both a "lessOrEqual" and a "greaterOrEqual" criterion on this field. Note that subsequent calls to the `FormItemCriterionGetter`'s `getCriterion()` method will return this more complex criterion.
    Overrides:
      `setCanEditCriterionPredicate` in class `CanvasItem`
    Parameters:
      `predicate` - the predicate to determine the form items that can edit the criterion in question
    See Also:
      - `FormItem.setCanEditCriterionPredicate`
      - `CriteriaEditing overview and related methods`

  - ### setCriterionSetter

    public void setCriterionSetter(FormItemCriterionSetter setter)
    The default `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.

    Overrides:
      `setCriterionSetter` in class `CanvasItem`
    Parameters:
      `setter` - provides a method to update this field with the edited criterion