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

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.StaticTextItem
                      com.smartgwt.client.widgets.form.fields.MiniDateRangeItem

All Implemented Interfaces:

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

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.core.JsObject

jsObj

Constructor Summary

MiniDateRangeItem()

MiniDateRangeItem(JavaScriptObject jsObj)

MiniDateRangeItem(String name)

MiniDateRangeItem(String name, String title)

Method Summary

Boolean	allowRelativeDates() Whether the DateRangeDialog opened when the pickerIcon is clicked should display RelativeDateItems or DateItems.
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.
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.
Date	getFromDate() Initial value for the "from" date.
String	getFromDateOnlyPrefix() The text to prepend to the formatted date when only a fromDate is supplied.
static MiniDateRangeItem	getOrCreateRef(JavaScriptObject jsObj)
FormItemIcon	getPickerIcon() Icon that launches a DateChooser for choosing an absolute date.
String	getPickerIconPrompt() The prompt to show when the mouse is hovered over the pickerIcon.
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
String	getTextBoxStyle() Base CSS class name for a form item's text box element.
Date	getToDate() Initial value for the "to" date.
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.
Boolean	hasAdvancedCriteria() Overridden to return true: dateRangeItems always generate AdvancedCriteria.
void	setAutoValidate(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(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.
void	setFromDate(Date fromDate) Initial value for the "from" date.
void	setFromDateOnlyPrefix(String fromDateOnlyPrefix) The text to prepend to the formatted date when only a fromDate is supplied.
void	setJavaScriptObject(JavaScriptObject jsObj)
void	setPickerIcon(FormItemIcon pickerIcon) Icon that launches a DateChooser for choosing an absolute date.
void	setPickerIconPrompt(String pickerIconPrompt) The prompt to show when the mouse is hovered over the pickerIcon.
void	setShouldSaveValue(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(String textBoxStyle) Base CSS class name for a form item's text box element.
void	setToDate(Date toDate) Initial value for the "to" date.
void	setToDateOnlyPrefix(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

getClipValue, getDateFormatter, getEscapeHTML, getWrap, setClipValue, setDateFormatter, 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, blurItem, canEditCriterion, clearValue, convertToFormItemArray, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCellHeight, getCellStyle, getClassName, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, 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, getInputFormat, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPickerIconHeight, getPickerIconName, getPickerIconSrc, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, 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, 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, setCanEditCriterionPredicate, setCellHeight, setCellStyle, setColSpan, setColSpan, setCriteriaField, setCriterion, setCriterionSetter, setDataPath, 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, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconSrc, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, 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, 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

MiniDateRangeItem

public MiniDateRangeItem()

MiniDateRangeItem

public MiniDateRangeItem(JavaScriptObject jsObj)

MiniDateRangeItem

public MiniDateRangeItem(String name)

MiniDateRangeItem

public MiniDateRangeItem(String name,
                         String title)

Method Detail

getOrCreateRef

public static MiniDateRangeItem getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class StaticTextItem

setAutoValidate

public void setAutoValidate(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 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(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 - canFocus Default value is true

See Also:

Focus overview and related methods

getCanFocus

public 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 - 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(String fromDateOnlyPrefix)

The text to prepend to the formatted date when only a fromDate is supplied.

Parameters:

fromDateOnlyPrefix - . See String. Default value is "Since"

getFromDateOnlyPrefix

public String getFromDateOnlyPrefix()

The text to prepend to the formatted date when only a fromDate is supplied.

Returns:

. See String

setPickerIcon

public void setPickerIcon(FormItemIcon pickerIcon)

Icon that launches a DateChooser for choosing an absolute date.

Parameters:

pickerIcon - 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(String pickerIconPrompt)

The prompt to show when the mouse is hovered over the pickerIcon.

Overrides:

setPickerIconPrompt in class FormItem

Parameters:

pickerIconPrompt - . See String. Default value is "Show Date Chooser"

getPickerIconPrompt

public String getPickerIconPrompt()

The prompt to show when the mouse is hovered over the pickerIcon.

Overrides:

getPickerIconPrompt in class FormItem

Returns:

. See String

setShouldSaveValue

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

getShouldSaveValue

public 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(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 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(String toDateOnlyPrefix)

The text to prepend to the formatted date when only a toDate is supplied.

Parameters:

toDateOnlyPrefix - . See String. Default value is "Before"

getToDateOnlyPrefix

public String getToDateOnlyPrefix()

The text to prepend to the formatted date when only a toDate is supplied.

Returns:

. See String

allowRelativeDates

public Boolean allowRelativeDates()

Whether the DateRangeDialog opened when the pickerIcon is clicked should display RelativeDateItems or DateItems.

Returns:

true

hasAdvancedCriteria

public Boolean hasAdvancedCriteria()

Overridden to return true: dateRangeItems always generate AdvancedCriteria.

Overrides:

hasAdvancedCriteria in class FormItem

Returns:

true

See Also:

CriteriaEditing overview and related methods

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

setToDate

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