public class DateRangeItem extends CanvasItem
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.
id| Constructor and Description |
|---|
DateRangeItem() |
DateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
DateRangeItem(java.lang.String name) |
DateRangeItem(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
java.lang.Boolean |
getAllowRelativeDates()
Whether to allow the user to specify relative dates (via
RelativeDateItems) or whether dates are absolute (via DateItems). |
java.util.Date |
getFromDate()
Initial value for the "from" date.
|
FormItem |
getFromField()
|
java.lang.String |
getFromTitle()
The title for the
from part of the range. |
TitleOrientation |
getInnerTitleOrientation()
The title orientation for the to / from sub-items.
|
java.lang.String |
getInputFormat()
For fields of type
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item. |
java.lang.String |
getInvalidRangeErrorMessage()
Error message to display if the user enters a date range where the "To" field value is earlier than the "From" field
value.
|
static DateRangeItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.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 |
java.util.Date |
getToDate()
Initial value for the "to" date.
|
FormItem |
getToField()
|
java.lang.String |
getToTitle()
The title for the
to part of the range. |
java.lang.Boolean |
getValidateCriteria()
If this attribute is set to
true when 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.
|
java.lang.Boolean |
hasAdvancedCriteria()
Overridden to return true: dateRangeItems always generate AdvancedCriteria.
|
void |
setAllowRelativeDates(java.lang.Boolean allowRelativeDates)
Whether to allow the user to specify relative dates (via
RelativeDateItems) or whether dates are absolute (via DateItems). |
void |
setCanEditCriterionPredicate(FormItemCanEditCriterionPredicate predicate)
The default
canEditCriterion() predicate returns true if the specified criterion contains:
A single "lessOrEqual" or "greaterOrEqual" criterion on this
field An "and" type criterion containing a "lessOrEqual" and a "greaterOrEqual" criterion on this
field A single "equals" criterion. |
void |
setCriterionSetter(FormItemCriterionSetter setter)
The default
setCriterion() implementation applies the specified criterion to this item for editing. |
static void |
setDefaultProperties(DateRangeItem dateRangeItemProperties)
Class level method to set the default properties of this class.
|
void |
setFromDate(java.util.Date fromDate)
Initial value for the "from" date.
|
void |
setFromTitle(java.lang.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(java.lang.String inputFormat)
For fields of type
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item. |
void |
setInvalidRangeErrorMessage(java.lang.String invalidRangeErrorMessage)
Error message to display if the user enters a date range where the "To" field value is earlier than the "From" field
value.
|
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
void |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Allow dateRangeItems' values to show up in the form's values array, or if
DynamicForm.getValuesAsCriteria is called, for the
criterion to be included in the returned AdvancedCriteria object |
void |
setToDate(java.util.Date toDate)
Initial value for the "to" date.
|
void |
setToDate(java.lang.String toDate)
Initial value for the "to" date.
|
void |
setToDate(TimeUnit toDate)
Initial value for the "to" date.
|
void |
setToTitle(java.lang.String toTitle)
The title for the
to part of the range. |
void |
setValidateCriteria(java.lang.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.
|
java.lang.Boolean |
validateRange()
Validate both "to" and "from" date-fields.
|
addCanEditChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getMultiple, getOverflow, getPrompt, readOnlyDisplayChanged, setApplyPromptToCanvas, setAutoDestroy, setCanvas, setCriterionGetter, setDefaultProperties, setEditCriteriaInInnerForm, setMultiple, setOverflow, setPrompt, setupCanvasConstructor, storeValue, storeValue, storeValue_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, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipStaticValue, getClipTitle, 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, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, 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, getTextBoxStyle, 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, getWrapTitle, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanFocus, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setCriteriaField, setCriterion, setDataPath, setDateFormatter, 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, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, 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, setTextBoxStyle, 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, show, showIcon, showPicker, stopHover, updateState, validate, valueClippedgetRef, getRef, internalSetIDdoAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObjectpublic DateRangeItem()
public DateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public DateRangeItem(java.lang.String name)
public DateRangeItem(java.lang.String name,
java.lang.String title)
public static DateRangeItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject in class CanvasItempublic static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setAllowRelativeDates(java.lang.Boolean allowRelativeDates)
RelativeDateItems) or whether dates are absolute (via DateItems).allowRelativeDates - allowRelativeDates Default value is falsepublic java.lang.Boolean getAllowRelativeDates()
RelativeDateItems) or whether dates are absolute (via DateItems).public FormItem getFromField()
RelativeDateItem or DateItem according to allowRelativeDates.
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
public void setFromTitle(java.lang.String fromTitle)
from part of the range.fromTitle - . See String. Default value is "From"public java.lang.String getFromTitle()
from part of the range.Stringpublic void setInnerTitleOrientation(TitleOrientation innerTitleOrientation)
this.titleOrientation or this.form.titleOrientation.innerTitleOrientation - innerTitleOrientation Default value is nullpublic TitleOrientation getInnerTitleOrientation()
this.titleOrientation or this.form.titleOrientation.public void setInputFormat(java.lang.String inputFormat)
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item.setInputFormat in class FormIteminputFormat - . See DateInputFormat. Default value is nullFormItem.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat)public java.lang.String getInputFormat()
"date", if this is an editable field such as a TextItem, this property allows you to specify the inputFormat applied to the item.getInputFormat in class FormItemDateInputFormatFormItem.getDateFormatter()public void setInvalidRangeErrorMessage(java.lang.String invalidRangeErrorMessage)
invalidRangeErrorMessage - . See String. Default value is '"To" field value cannot be earlier than "From" field value.'public java.lang.String getInvalidRangeErrorMessage()
Stringpublic void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
DynamicForm.getValuesAsCriteria is called, for the
criterion to be included in the returned AdvancedCriteria objectsetShouldSaveValue in class CanvasItemshouldSaveValue - shouldSaveValue Default value is truepublic java.lang.Boolean getShouldSaveValue()
DynamicForm.getValuesAsCriteria is called, for the
criterion to be included in the returned AdvancedCriteria objectgetShouldSaveValue in class CanvasItempublic void setToDate(java.util.Date toDate)
toDate for this DateRangeItem.toDate - the date at which this item should end it's range. Default value is todaypublic java.util.Date getToDate()
public void setToDate(java.lang.String toDate)
toDate for this DateRangeItem.toDate - the date at which this item should end it's range. See RelativeDateString. Default value is todaypublic void setToDate(TimeUnit toDate)
toDate for this DateRangeItem.toDate - the date at which this item should end it's range. Default value is todaypublic FormItem getToField()
RelativeDateItem or DateItem according to allowRelativeDates.
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
public void setToTitle(java.lang.String toTitle)
to part of the range.toTitle - . See String. Default value is "To"public java.lang.String getToTitle()
to part of the range.Stringpublic void setValidateCriteria(java.lang.Boolean validateCriteria)
true when getCriteria is called, the item will validate the
"to" and "from" fields and return null if either field fails validation. See DateRangeItem.validateRangevalidateCriteria - validateCriteria Default value is falsepublic java.lang.Boolean getValidateCriteria()
true when getCriteria is called, the item will validate the
"to" and "from" fields and return null if either field fails validation. See DateRangeItem.validateRangepublic java.lang.Boolean hasAdvancedCriteria()
hasAdvancedCriteria in class CanvasItemCriteriaEditing overview and related methodspublic java.lang.Boolean validateRange()
public static void setDefaultProperties(DateRangeItem dateRangeItemProperties)
Note: This method is intended for setting default attributes only and will effect 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.
dateRangeItemProperties - properties that should be used as new defaults when instances of this class are createdpublic void setFromDate(java.util.Date fromDate)
fromDate for this DateRangeItem.fromDate - the date from which this item should start it's range. Default value is todaypublic java.util.Date getFromDate()
public DateRange getValue()
DateRange object that excludes start and end values if they aren't set.public void setValue(DateRange value)
DateRange object
that optionally includes both start and end values.value - the new value for this itempublic void setCanEditCriterionPredicate(FormItemCanEditCriterionPredicate predicate)
canEditCriterion() predicate returns true if the specified criterion contains:
FormItemCriterionGetter's
getCriterion() method will return this more complex criterion.setCanEditCriterionPredicate in class CanvasItempredicate - the predicate to determine the form items that can edit the criterion in questionFormItem.setCanEditCriterionPredicate,
CriteriaEditing overview and related methodspublic void setCriterionSetter(FormItemCriterionSetter setter)
setCriterion() implementation applies the specified criterion to this item for editing.
Applies any specified "greaterOrEqual" operator criterion or
sub-criterion to our fromField and any
specified "lessOrEqual" operator criterion or sub-criterion to our toField. Note that a single "equals" criterion can
also be passed. See setCanEditCriterionPredicate()
for more detail.
setCriterionSetter in class CanvasItemsetter - provides a method to update this field with the edited criterion