public class MiniDateRangeItem extends StaticTextItem
DateRangeDialog
to edit the range.FormItem.CustomStateGetter, FormItem.StateCustomizer
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
id
factoryCreated, factoryProperties
Constructor and Description |
---|
MiniDateRangeItem() |
MiniDateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
MiniDateRangeItem(java.lang.String name) |
MiniDateRangeItem(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 the
DateRangeDialog opened when the pickerIcon is clicked should display RelativeDateItem s or DateItem s. |
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.
|
java.lang.Boolean |
getCanTabToIcons()
MiniDateRangeItems rely on their icon being able to receive focus for normal user interaction as they have no other
focusable element.
|
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.
|
MiniDateRangeItem |
setAllowRelativeDates(java.lang.Boolean allowRelativeDates)
Whether the
DateRangeDialog opened when the pickerIcon is clicked should display RelativeDateItem s or DateItem s. |
MiniDateRangeItem |
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. |
MiniDateRangeItem |
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.
|
MiniDateRangeItem |
setCanTabToIcons(java.lang.Boolean canTabToIcons)
MiniDateRangeItems rely on their icon being able to receive focus for normal user interaction as they have no other
focusable element.
|
void |
setCriterionGetter(FormItemCriterionGetter getter)
The default
getCriterion() implementation returns the Criterion entered in the fields shown in the rangeDialog . |
MiniDateRangeItem |
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.
|
MiniDateRangeItem |
setFromDateOnlyPrefix(java.lang.String fromDateOnlyPrefix)
The text to prepend to the formatted date when only a
fromDate is supplied. |
MiniDateRangeItem |
setPickerIcon(FormItemIcon pickerIcon)
Icon that launches a
DateChooser for choosing an absolute date. |
MiniDateRangeItem |
setPickerIconPrompt(java.lang.String pickerIconPrompt)
The prompt to show when the mouse is hovered over the
pickerIcon . |
MiniDateRangeItem |
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 |
MiniDateRangeItem |
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.
|
MiniDateRangeItem |
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.
|
getApplyAlignToText, getApplyHeightToTextBox, getCanSelectText, getClipValue, getDateFormatter, getEditProxyConstructor, getEscapeHTML, getWrap, setApplyAlignToText, setApplyHeightToTextBox, setCanSelectText, setClipValue, setDateFormatter, setDefaultProperties, setEditProxyConstructor, setEscapeHTML, setWrap
_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, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultiple, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyCanSelectText, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, 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, getTextFormula, 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, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, 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, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCriterionSetter, setCustomStateGetter, setDataPath, 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, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultiple, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, 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, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, 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, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClipped
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public MiniDateRangeItem()
public MiniDateRangeItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public MiniDateRangeItem(java.lang.String name)
public MiniDateRangeItem(java.lang.String name, java.lang.String title)
public static MiniDateRangeItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public 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. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public 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. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public MiniDateRangeItem setAllowRelativeDates(java.lang.Boolean allowRelativeDates)
DateRangeDialog
opened when the pickerIcon
is clicked should display RelativeDateItem
s or DateItem
s.allowRelativeDates
- New allowRelativeDates value. Default value is trueMiniDateRangeItem
instance, for chaining setter callspublic java.lang.Boolean getAllowRelativeDates()
DateRangeDialog
opened when the pickerIcon
is clicked should display RelativeDateItem
s or DateItem
s.public MiniDateRangeItem setAutoValidate(java.lang.Boolean autoValidate)
"OK"
-click, and refuse to dismiss if these items contain invalid values.
autoValidate
autoValidate
- New auto-validate setting. Default value is trueMiniDateRangeItem
instance, for chaining setter callspublic java.lang.Boolean getAutoValidate()
"OK"
-click, and refuse to dismiss if these items contain invalid values.public MiniDateRangeItem setCanFocus(java.lang.Boolean canFocus)
setCanFocus
in class FormItem
canFocus
- New canFocus value. Default value is trueMiniDateRangeItem
instance, for chaining setter callsFocus overview and related methods
public java.lang.Boolean getCanFocus()
getCanFocus
in class FormItem
Focus overview and related methods
public MiniDateRangeItem setCanTabToIcons(java.lang.Boolean canTabToIcons)
canTabToIcons
is overridden to achieve this even if the property has been set to
false
at the form level
.
Note : This is an advanced setting
setCanTabToIcons
in class FormItem
canTabToIcons
- New canTabToIcons value. Default value is trueMiniDateRangeItem
instance, for chaining setter callspublic java.lang.Boolean getCanTabToIcons()
canTabToIcons
is overridden to achieve this even if the property has been set to
false
at the form level
.getCanTabToIcons
in class FormItem
public MiniDateRangeItem setDateDisplayFormat(DateDisplayFormat dateDisplayFormat)
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
.
dateDisplayFormat
- New dateDisplayFormat value. Default value is nullMiniDateRangeItem
instance, for chaining setter callspublic DateDisplayFormat getDateDisplayFormat()
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
.
public MiniDateRangeItem setFromDateOnlyPrefix(java.lang.String fromDateOnlyPrefix)
fromDate
is supplied.fromDateOnlyPrefix
- New fromDateOnlyPrefix value. Default value is "Since"MiniDateRangeItem
instance, for chaining setter callspublic java.lang.String getFromDateOnlyPrefix()
fromDate
is supplied.public MiniDateRangeItem setPickerIcon(FormItemIcon pickerIcon)
DateChooser
for choosing an absolute date.pickerIcon
- New pickerIcon value. Default value is nullMiniDateRangeItem
instance, for chaining setter callspublic FormItemIcon getPickerIcon()
DateChooser
for choosing an absolute date.public MiniDateRangeItem setPickerIconPrompt(java.lang.String pickerIconPrompt)
pickerIcon
.setPickerIconPrompt
in class FormItem
pickerIconPrompt
- New pickerIconPrompt value. Default value is "Show Date Chooser"MiniDateRangeItem
instance, for chaining setter callsHTMLString
public java.lang.String getPickerIconPrompt()
pickerIcon
.getPickerIconPrompt
in class FormItem
HTMLString
public DateRangeDialog getRangeDialog()
DateRangeDialog
for entering a date range.
This component is an AutoChild named "rangeDialog". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MiniDateRangeItem setShouldSaveValue(java.lang.Boolean shouldSaveValue)
DynamicForm.getValuesAsCriteria()
is called, for the
criterion to be included in the returned AdvancedCriteria objectsetShouldSaveValue
in class FormItem
shouldSaveValue
- New shouldSaveValue value. Default value is trueMiniDateRangeItem
instance, for chaining setter callspublic java.lang.Boolean getShouldSaveValue()
DynamicForm.getValuesAsCriteria()
is called, for the
criterion to be included in the returned AdvancedCriteria objectgetShouldSaveValue
in class FormItem
public MiniDateRangeItem setTextBoxStyle(java.lang.String textBoxStyle)
See FormItemStyling
for an
overview of formItem styling, and the CompoundFormItem_skinning
discussion for special
skinning considerations.
If the textBoxStyle
is changed at runtime, updateState()
must be called to update the visual state of
this item.
setTextBoxStyle
in class StaticTextItem
textBoxStyle
- New textBoxStyle value. Default value is "textItem"MiniDateRangeItem
instance, for chaining setter callsFormItem.setCellStyle(java.lang.String)
,
FormItemBaseStyle
,
FormItemStyling overview and related methods
public java.lang.String getTextBoxStyle()
See FormItemStyling
for an
overview of formItem styling, and the CompoundFormItem_skinning
discussion for special
skinning considerations.
If the textBoxStyle
is changed at runtime, updateState()
must be called to update the visual state of
this item.
getTextBoxStyle
in class StaticTextItem
FormItem.getCellStyle()
,
FormItemBaseStyle
,
FormItemStyling overview and related methods
public MiniDateRangeItem setToDateOnlyPrefix(java.lang.String toDateOnlyPrefix)
toDate
is supplied.toDateOnlyPrefix
- New toDateOnlyPrefix value. Default value is "Before"MiniDateRangeItem
instance, for chaining setter callspublic java.lang.String getToDateOnlyPrefix()
toDate
is supplied.public java.lang.Boolean hasAdvancedCriteria()
hasAdvancedCriteria
in class FormItem
CriteriaEditing overview and related methods
public static void setDefaultProperties(MiniDateRangeItem miniDateRangeItemProperties)
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.
miniDateRangeItemProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public 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 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 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 setCriterionGetter(FormItemCriterionGetter getter)
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.
setCriterionGetter
in class FormItem
getter
- provides a method to get a criterion object based on this field's current edited value(s).FormItem.setCriterionGetter(com.smartgwt.client.widgets.form.FormItemCriterionGetter)
,
CriteriaEditing overview and related methods