com.smartgwt.client.widgets.form.fields
Class MiniDateRangeItem

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.form.fields.FormItem
                  extended by com.smartgwt.client.widgets.form.fields.StaticTextItem
                      extended by com.smartgwt.client.widgets.form.fields.MiniDateRangeItem
All Implemented Interfaces:
com.google.gwt.event.shared.HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPickerIconClickHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers

public class MiniDateRangeItem
extends StaticTextItem

Provides a compact interface for editing a date range, by providing a formatted, read-only display of the current selected date range with an icon to launch a DateRangeDialog to edit the range.


Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem
scClassName
 
Fields inherited from class com.smartgwt.client.core.RefDataClass
id
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
MiniDateRangeItem()
           
MiniDateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj)
           
MiniDateRangeItem(java.lang.String name)
           
MiniDateRangeItem(java.lang.String name, java.lang.String title)
           
 
Method Summary
 java.lang.Boolean allowRelativeDates()
          Whether the DateRangeDialog opened when the pickerIcon is clicked should display RelativeDateItems or DateItems.
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.Boolean getAutoValidate()
          If this attribute is set to true, the pop up date range dialog will automatically validate the user-entered "to" and "from" values on "OK"-click, and refuse to dismiss if these items contain invalid values.
 java.lang.Boolean getCanFocus()
          MiniDateRangeItems are marked as canFocus:true, and set up with properties such that focus will always go to the icon to launch the dateRange dialog.
 DateDisplayFormat getDateDisplayFormat()
          Format for displaying dates to the user.
 java.util.Date getFromDate()
          Initial value for the "from" date.
 java.lang.String getFromDateOnlyPrefix()
          The text to prepend to the formatted date when only a fromDate is supplied.
static MiniDateRangeItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 FormItemIcon getPickerIcon()
          Icon that launches a DateChooser for choosing an absolute date.
 java.lang.String getPickerIconPrompt()
          The prompt to show when the mouse is hovered over the pickerIcon.
 DateRangeDialog getRangeDialog()
          Pop-up DateRangeDialog for entering a date range.
 java.lang.Boolean getShouldSaveValue()
          Allow miniDateRangeItems' 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
 java.lang.String getTextBoxStyle()
          Base CSS class name for a form item's text box element.
 java.util.Date getToDate()
          Initial value for the "to" date.
 java.lang.String getToDateOnlyPrefix()
          The text to prepend to the formatted date when only a toDate is supplied.
 DateRange getValue()
          Retrieves the current value of this dateRangeItem.
 java.lang.Boolean hasAdvancedCriteria()
          Overridden to return true: dateRangeItems always generate AdvancedCriteria.
 void setAutoValidate(java.lang.Boolean autoValidate)
          If this attribute is set to true, the pop up date range dialog will automatically validate the user-entered "to" and "from" values on "OK"-click, and refuse to dismiss if these items contain invalid values.
 void setCanFocus(java.lang.Boolean canFocus)
          MiniDateRangeItems are marked as canFocus:true, and set up with properties such that focus will always go to the icon to launch the dateRange dialog.
 void setCriterionGetter(FormItemCriterionGetter getter)
          The default getCriterion() implementation returns the Criterion entered in the fields shown in the rangeDialog.
 void setDateDisplayFormat(DateDisplayFormat dateDisplayFormat)
          Format for displaying dates to the user.
static void setDefaultProperties(MiniDateRangeItem miniDateRangeItemProperties)
          Class level method to set the default properties of this class.
 void setFromDate(java.util.Date fromDate)
          Initial value for the "from" date.
 void setFromDateOnlyPrefix(java.lang.String fromDateOnlyPrefix)
          The text to prepend to the formatted date when only a fromDate is supplied.
 void setPickerIcon(FormItemIcon pickerIcon)
          Icon that launches a DateChooser for choosing an absolute date.
 void setPickerIconPrompt(java.lang.String pickerIconPrompt)
          The prompt to show when the mouse is hovered over the pickerIcon.
 void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
          Allow miniDateRangeItems' 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 setTextBoxStyle(java.lang.String textBoxStyle)
          Base CSS class name for a form item's text box element.
 void setToDate(java.util.Date toDate)
          Initial value for the "to" date.
 void setToDateOnlyPrefix(java.lang.String toDateOnlyPrefix)
          The text to prepend to the formatted date when only a toDate is supplied.
 void setValue(DateRange value)
          Sets the value for this dateRangeItem.
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.StaticTextItem
getApplyHeightToTextBox, getCanSelectText, getClipValue, getDateFormatter, getEscapeHTML, getWrap, setApplyHeightToTextBox, setCanSelectText, setClipValue, setDateFormatter, setDefaultProperties, setEscapeHTML, setWrap
 
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, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getDataPath, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHeight, getHeightAsString, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyClipValue, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValueAsRecordList, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWidthAsString, getWrapTitle, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCellHeight, setCellStyle, setChangeOnKeypress, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCriterionSetter, setDataPath, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setExportFormat, setFetchMissingValues, setFilterLocally, setFormat, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyClipValue, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClipped
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetID
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject
 
Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, setJavaScriptObject, 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 Detail

MiniDateRangeItem

public MiniDateRangeItem()

MiniDateRangeItem

public MiniDateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj)

MiniDateRangeItem

public MiniDateRangeItem(java.lang.String name)

MiniDateRangeItem

public MiniDateRangeItem(java.lang.String name,
                         java.lang.String title)
Method Detail

getOrCreateRef

public static MiniDateRangeItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.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.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.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.
See Also:
AutoChildUsage

changePickerIconDefaults

public static void changePickerIconDefaults(FormItemIcon defaults)

setAutoValidate

public void setAutoValidate(java.lang.Boolean autoValidate)
If this attribute is set to true, the pop up date range dialog will automatically validate the user-entered "to" and "from" values on "OK"-click, and refuse to dismiss if these items contain invalid values.

If this method is called after the component has been drawn/initialized: Setter for autoValidate

Parameters:
autoValidate - New auto-validate setting.. Default value is true

getAutoValidate

public java.lang.Boolean getAutoValidate()
If this attribute is set to true, the pop up date range dialog will automatically validate the user-entered "to" and "from" values on "OK"-click, and refuse to dismiss if these items contain invalid values.

Returns:
Boolean

setCanFocus

public void setCanFocus(java.lang.Boolean canFocus)
MiniDateRangeItems are marked as canFocus:true, and set up with properties such that focus will always go to the icon to launch the dateRange dialog. Set canFocus to false to suppress this behavior.

Overrides:
setCanFocus in class FormItem
Parameters:
canFocus - Default value is true
See Also:
Focus overview and related methods

getCanFocus

public java.lang.Boolean getCanFocus()
MiniDateRangeItems are marked as canFocus:true, and set up with properties such that focus will always go to the icon to launch the dateRange dialog. Set canFocus to false to suppress this behavior.

Overrides:
getCanFocus in class FormItem
Returns:
Boolean
See Also:
Focus overview and related methods

setDateDisplayFormat

public void setDateDisplayFormat(DateDisplayFormat dateDisplayFormat)
Format for displaying dates to the user.

If this attribute is unset, the display value is formatted intelligently according to the dates involved. For example, if both dates appear in the same month, the value will be formatted as

Month date1 - date2, Year

and, if in different months of the same year,

Month1 date1 - Month2 date2, Year.

If either date-value is unset, the display-value is formatted according to fromDateOnlyPrefix and toDateOnlyPrefix.

Parameters:
dateDisplayFormat - Default value is null

getDateDisplayFormat

public DateDisplayFormat getDateDisplayFormat()
Format for displaying dates to the user.

If this attribute is unset, the display value is formatted intelligently according to the dates involved. For example, if both dates appear in the same month, the value will be formatted as

Month date1 - date2, Year

and, if in different months of the same year,

Month1 date1 - Month2 date2, Year.

If either date-value is unset, the display-value is formatted according to fromDateOnlyPrefix and toDateOnlyPrefix.

Returns:
DateDisplayFormat

setFromDateOnlyPrefix

public void setFromDateOnlyPrefix(java.lang.String fromDateOnlyPrefix)
The text to prepend to the formatted date when only a fromDate is supplied.

Parameters:
fromDateOnlyPrefix - Default value is "Since"

getFromDateOnlyPrefix

public java.lang.String getFromDateOnlyPrefix()
The text to prepend to the formatted date when only a fromDate is supplied.

Returns:
String

setPickerIcon

public void setPickerIcon(FormItemIcon pickerIcon)
Icon that launches a DateChooser for choosing an absolute date.

Parameters:
pickerIcon - Default value is null

getPickerIcon

public FormItemIcon getPickerIcon()
Icon that launches a DateChooser for choosing an absolute date.

Returns:
FormItemIcon

setPickerIconPrompt

public void setPickerIconPrompt(java.lang.String pickerIconPrompt)
The prompt to show when the mouse is hovered over the pickerIcon.

Overrides:
setPickerIconPrompt in class FormItem
Parameters:
pickerIconPrompt - Default value is "Show Date Chooser"

getPickerIconPrompt

public java.lang.String getPickerIconPrompt()
The prompt to show when the mouse is hovered over the pickerIcon.

Overrides:
getPickerIconPrompt in class FormItem
Returns:
String

getRangeDialog

public DateRangeDialog getRangeDialog()
Pop-up DateRangeDialog for entering a date range.

For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:
DateRangeDialog

setShouldSaveValue

public void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Allow miniDateRangeItems' 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 FormItem
Parameters:
shouldSaveValue - Default value is true

getShouldSaveValue

public java.lang.Boolean getShouldSaveValue()
Allow miniDateRangeItems' 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 FormItem
Returns:
Boolean

setTextBoxStyle

public void setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class name for a form item's text box element.

NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.

Overrides:
setTextBoxStyle in class StaticTextItem
Parameters:
textBoxStyle - See FormItemBaseStyle . Default value is "textItem"
See Also:
FormItem.setCellStyle(java.lang.String), Appearance overview and related methods

getTextBoxStyle

public java.lang.String getTextBoxStyle()
Base CSS class name for a form item's text box element.

NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.

Overrides:
getTextBoxStyle in class StaticTextItem
Returns:
See FormItemBaseStyle
See Also:
FormItem.getCellStyle(), Appearance overview and related methods

setToDateOnlyPrefix

public void setToDateOnlyPrefix(java.lang.String toDateOnlyPrefix)
The text to prepend to the formatted date when only a toDate is supplied.

Parameters:
toDateOnlyPrefix - Default value is "Before"

getToDateOnlyPrefix

public java.lang.String getToDateOnlyPrefix()
The text to prepend to the formatted date when only a toDate is supplied.

Returns:
String

allowRelativeDates

public java.lang.Boolean allowRelativeDates()
Whether the DateRangeDialog opened when the pickerIcon is clicked should display RelativeDateItems or DateItems.

Returns:
true

hasAdvancedCriteria

public java.lang.Boolean hasAdvancedCriteria()
Overridden to return true: dateRangeItems always generate AdvancedCriteria.

Overrides:
hasAdvancedCriteria in class FormItem
Returns:
true
See Also:
CriteriaEditing overview and related methods

setDefaultProperties

public static void setDefaultProperties(MiniDateRangeItem miniDateRangeItemProperties)
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:
miniDateRangeItemProperties - properties that should be used as new defaults when instances of this class are created

setFromDate

public void setFromDate(java.util.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 java.util.Date getFromDate()
Initial value for the "from" date.

Returns:
java.util.Date

setToDate

public void setToDate(java.util.Date toDate)
Initial value for the "to" date. 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 java.util.Date getToDate()
Initial value for the "to" 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

setCriterionGetter

public void setCriterionGetter(FormItemCriterionGetter getter)
The default getCriterion() implementation returns the Criterion entered in the fields shown in the rangeDialog.

If both dates are entered, a Criterion with an "and" operator and both "greaterOrEqual" and "lessOrEqual" sub-criteria will be returned. If either date is omitted, only the "greaterOrEqual" (from date) or "lessOrEqual" (to date) Criterion is returned.

Overrides:
setCriterionGetter in class FormItem
Parameters:
getter - provides a method to get a criterion object based on this field's current edited value(s).
See Also:
FormItem.setCriterionGetter(com.smartgwt.client.widgets.form.FormItemCriterionGetter), CriteriaEditing overview and related methods