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.widgets.form.fields.FormItem
                  com.smartgwt.client.widgets.form.fields.CanvasItem
                      com.smartgwt.client.widgets.form.fields.DateRangeItem

All Implemented Interfaces:

HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPickerIconClickHandlers, HasShowValueHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers

public class DateRangeItem
extends CanvasItem

Allows a user to select an absolute or relative range of dates via two RelativeDateItems (if allowRelativeDates is true) or two DateItems.

DateRangeItem is just a convenience relative to using two RelativeDateItem or DateItem controls in a form, then using operator and 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.

Field Summary

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

jsObj

Constructor Summary

DateRangeItem()

DateRangeItem(JavaScriptObject jsObj)

DateRangeItem(String name)

DateRangeItem(String name, String title)

Method Summary

Boolean	getAllowRelativeDates() Whether to allow the user to specify relative dates (via RelativeDateItems) or whether dates are absolute (via DateItems).
Date	getFromDate() Initial value for the "from" date.
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)
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
Date	getToDate() Initial value for the "to" date.
String	getToTitle() The title for the to part of the range.
Boolean	getValidateCriteria() If this attribute is set to true when getCriteria 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.
void	setAllowRelativeDates(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.
void	setFromDate(Date fromDate) Initial value for the "from" date.
void	setFromTitle(String fromTitle) The title for the from part of the range.
void	setInnerTitleOrientation(TitleOrientation innerTitleOrientation) The title orientation for the to / from sub-items.
void	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.
void	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.
void	setJavaScriptObject(JavaScriptObject jsObj)
void	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
void	setToDate(Date toDate) Initial value for the "to" date.
void	setToDate(String toDate) Initial value for the "to" date.
void	setToDate(TimeUnit toDate) Initial value for the "to" date.
void	setToTitle(String toTitle) The title for the to part of the range.
void	setValidateCriteria(Boolean validateCriteria) If this attribute is set to true when getCriteria 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

addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getOverflow, getPrompt, setApplyPromptToCanvas, setAutoDestroy, setCanvas, setCriterionGetter, setEditCriteriaInInnerForm, setOverflow, setPrompt, setupCanvasConstructor, storeValue, storeValue, storeValue

Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem

_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, blurItem, canEditCriterion, clearValue, convertToFormItemArray, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCellHeight, getCellStyle, getClassName, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFullDataPath, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconSrc, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getSelectedRecord, getSelectOnFocus, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWrapTitle, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBrowserSpellCheck, setCanEdit, setCanFocus, setCellHeight, setCellStyle, setColSpan, setColSpan, setCriteriaField, setCriterion, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconSrc, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setSelectOnFocus, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldFetchMissingValue, shouldSaveOnEnter, show, showIcon, showPicker, stopHover, updateState, validate

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

getRef, getRef

Methods inherited from class com.smartgwt.client.core.DataClass

doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

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

setJsObj

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

fireEvent

Constructor Detail

DateRangeItem

public DateRangeItem()

DateRangeItem

public DateRangeItem(JavaScriptObject jsObj)

DateRangeItem

public DateRangeItem(String name)

DateRangeItem

public DateRangeItem(String name,
                     String title)

Method Detail

getOrCreateRef

public static DateRangeItem getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class CanvasItem

setAllowRelativeDates

public void setAllowRelativeDates(Boolean allowRelativeDates)

Whether to allow the user to specify relative dates (via RelativeDateItems) or whether dates are absolute (via DateItems).

Parameters:

allowRelativeDates - allowRelativeDates Default value is false

getAllowRelativeDates

public Boolean getAllowRelativeDates()

Whether to allow the user to specify relative dates (via RelativeDateItems) or whether dates are absolute (via DateItems).

Returns:

Boolean

setFromTitle

public void setFromTitle(String fromTitle)

The title for the from part of the range.

Parameters:

fromTitle - . See String. Default value is "From"

getFromTitle

public String getFromTitle()

The title for the from part of the range.

Returns:

. See String

setInnerTitleOrientation

public void 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 - innerTitleOrientation Default value is null

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:

TitleOrientation

setInputFormat

public void 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 - . See DateInputFormat. Default value is null

See Also:

FormItem.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat)

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:

. See DateInputFormat

See Also:

FormItem.getDateFormatter()

setInvalidRangeErrorMessage

public void 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 - . See String. Default value is '"To" field value cannot be earlier than "From" field value.'

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:

. See String

setShouldSaveValue

public void 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 - shouldSaveValue Default value is true

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:

Boolean

setToDate

public void 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

getToDate

public Date getToDate()

Initial value for the "to" date.

Returns:

java.util.Date

setToDate

public void 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. See RelativeDateString. Default value is today

setToDate

public void 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

setToTitle

public void setToTitle(String toTitle)

The title for the to part of the range.

Parameters:

toTitle - . See String. Default value is "To"

getToTitle

public String getToTitle()

The title for the to part of the range.

Returns:

. See String

setValidateCriteria

public void setValidateCriteria(Boolean validateCriteria)

If this attribute is set to true when getCriteria is called, the item will validate the "to" and "from" fields and return null if either field fails validation. See DateRangeItem.validateRange

Parameters:

validateCriteria - validateCriteria Default value is false

getValidateCriteria

public Boolean getValidateCriteria()

If this attribute is set to true when getCriteria is called, the item will validate the "to" and "from" fields and return null if either field fails validation. See DateRangeItem.validateRange

Returns:

Boolean

hasAdvancedCriteria

public Boolean hasAdvancedCriteria()

Overridden to return true: dateRangeItems always generate AdvancedCriteria.

Overrides:

hasAdvancedCriteria in class CanvasItem

Returns:

true

See Also:

CriteriaEditing overview and related methods

validateRange

public Boolean validateRange()

Validate both "to" and "from" date-fields.

Returns:

false if either to or from field contains an invalid date value.

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