public class FormItem extends RefDataClass implements HasBlurHandlers, HasChangeHandlers, HasChangedHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPickerIconClickHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers
values tracked by the form. FormItems do not render
themselves, instead, they are provided to a DynamicForm via DynamicForm.setItems()
See the DynamicForm documentation for details and sample code.
| Modifier and Type | Field and Description |
|---|---|
protected java.lang.String |
scClassName |
id| Constructor and Description |
|---|
FormItem() |
FormItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
FormItem(java.lang.String name) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
_getValue() |
com.google.gwt.event.shared.HandlerRegistration |
addBlurHandler(BlurHandler handler)
Add a blur handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addChangedHandler(ChangedHandler handler)
Add a changed handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addChangeHandler(ChangeHandler handler)
Add a change handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addClickHandler(ClickHandler handler)
Add a click handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDoubleClickHandler(DoubleClickHandler handler)
Add a doubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEditorEnterHandler(EditorEnterHandler handler)
Add a editorEnter handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addEditorExitHandler(EditorExitHandler handler)
Add a editorExit handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFocusHandler(FocusHandler handler)
Add a focus handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addIconClickHandler(IconClickHandler handler)
Add a iconClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addIconKeyPressHandler(IconKeyPressHandler handler)
Add a iconKeyPress handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addItemHoverHandler(ItemHoverHandler handler)
Add a itemHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addKeyDownHandler(KeyDownHandler handler)
Add a keyDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addKeyPressHandler(KeyPressHandler handler)
Add a keyPress handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addKeyUpHandler(KeyUpHandler handler)
Add a keyUp handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addPickerIconClickHandler(PickerIconClickHandler handler)
Add a pickerIconClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTitleClickHandler(TitleClickHandler handler)
Add a titleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTitleDoubleClickHandler(TitleDoubleClickHandler handler)
Add a titleDoubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTitleHoverHandler(TitleHoverHandler handler)
Add a titleHover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addValueHoverHandler(ValueHoverHandler handler)
Add a valueHover handler.
|
static <T extends RefDataClass> |
asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)
Returns the existing SGWT FormItem, or creates and returns one if none exist,
associated with the supplied
JavaScriptObject. |
void |
blurItem()
Takes focus from this form item's focusable element.
|
java.lang.Boolean |
canEditCriterion(Criterion criterion)
Calls the
canEditCriterion()
method of the FormItemCanEditCriterionPredicate
that is registered with this field. |
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) |
void |
clearValue()
Clear the value for this form item.
|
void |
disable()
Set this item to be disabled at runtime.
|
void |
enable()
Set this item to be enabled at runtime.
|
protected void |
error(java.lang.String message) |
protected void |
error(java.lang.String attribute,
java.lang.String value) |
protected void |
errorIfNotCreated(java.lang.String property) |
void |
focusInItem()
Move the keyboard focus into this item's focusable element
|
java.lang.String |
getAccessKey()
If specified this governs the HTML accessKey for the item.
|
Alignment |
getAlign()
Alignment of this item in its cell.
|
java.lang.Boolean |
getAllowExpressions()
For a form that produces filter criteria (see
form.getValuesAsCriteria()), allows the user to type in simple expressions to cause filtering with that operator. |
java.lang.Boolean |
getAlwaysFetchMissingValues()
If this form item has a specified
optionDataSource and fetchMissingValues
is true, when the item value changes, a fetch will be performed against the optionDataSource to retrieve the related
record if displayField is specified and the
new item value is not present in any valueMap explicitly specified on the item. |
java.lang.Boolean |
getApplyHeightToTextBox()
If
height is specified, should it be applied to the
item's text box element? |
java.lang.String |
getAriaRole()
ARIA role of this formItem.
|
java.lang.String |
getAttribute(java.lang.String attribute)
Returns attribute value as a String
|
java.lang.Boolean |
getAttributeAsBoolean(java.lang.String property)
Returns attribute value set as a Boolean.
|
java.lang.Boolean |
getAttributeAsBoolean(java.lang.String property,
boolean allowNull)
Returns attribute value set as a Boolean.
|
java.util.Date |
getAttributeAsDate(java.lang.String property)
Returns attribute value as a Date.
|
java.lang.Double |
getAttributeAsDouble(java.lang.String property)
Returns attribute as a Double.
|
java.lang.Float |
getAttributeAsFloat(java.lang.String property)
Returns attribute value as a Float.
|
java.lang.Integer |
getAttributeAsInt(java.lang.String property)
Returns attribute value as an Integer.
|
com.google.gwt.core.client.JavaScriptObject |
getAttributeAsJavaScriptObject(java.lang.String property)
Returns attribute value as a JavaScript Object.
|
java.lang.Object |
getAttributeAsObject(java.lang.String property,
com.google.gwt.core.client.JavaScriptObject convertToObject) |
java.lang.String |
getAttributeAsString(java.lang.String property)
Returns attribute value as a String.
|
java.lang.Boolean |
getBrowserSpellCheck()
If this browser supports spell-checking of text editing elements, do we want this enabled for this item? If unset the
property will be inherited from the containing form.
|
java.lang.Boolean |
getCanEdit()
Is this form item editable (canEdit:true) or read-only (canEdit:false)? Setting the form item to non-editable causes it
to render as read-only.
|
java.lang.Boolean |
getCanEditOpaqueValues()
If true, indicates that this FormItem is capable of editing "opaque" values, ie, objects that are more complex than
simple primitive types like numbers, strings and dates.
|
java.lang.Boolean |
getCanFocus()
Is this form item focusable? Setting this property to true on an otherwise non-focusable element such as a
StaticTextItem will cause the item to be included in the page's tab order and
respond to keyboard events. |
boolean |
getCanSelectText()
For items showing a text value, should the user be able to select the text in this item?
|
Canvas |
getCanvasAutoChild(java.lang.String autoChildName)
Returns the
Canvas AutoChild named autoChildName if already created. |
java.lang.Integer |
getCellHeight()
If specified, this property will govern the height of the cell in which this form item is rendered.
|
java.lang.String |
getCellStyle()
CSS style applied to the form item as a whole, including the text element, any icons, and any hint text for the item.
|
java.lang.Boolean |
getChangeOnKeypress()
Should this form item fire its
change handler
(and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing
(and the value stored) on every keypress. |
java.lang.String |
getClassName()
Returns the JavaScript class name.
|
java.lang.Boolean |
getClipStaticValue()
If this item is
read-only and is using readOnlyDisplay ReadOnlyDisplayAppearance.STATIC, should the item value be clipped if it overflows the
specified size of the item? If set, overrides the form-level clipStaticValue default. |
java.lang.Boolean |
getClipTitle()
If the title for this form item is showing, and is too large for the available space should the title be clipped?
|
com.google.gwt.core.client.JavaScriptObject |
getConfig()
Returns the FormItem's config object suitable for use in API's that set the editorType
|
Canvas |
getContainerWidget()
A Read-Only pointer to the Smart GWT canvas that holds this form item.
|
java.lang.String |
getControlStyle()
Base CSS class name for a form item's control box (surrounds text box and picker).
|
java.lang.String |
getCriteriaField()
|
Criterion |
getCriterion()
Calls the
getCriterion() method
of the FormItemCriterionGetter
that is registered with this field. |
Criterion |
getCriterion(TextMatchStyle textMatchStyle)
Calls the
getCriterion() method
of the FormItemCriterionGetter
that is registered with this field. |
java.lang.String |
getDataPath()
dataPath for this item.
|
DateDisplayFormat |
getDateFormatter()
Display format to use for date type values within this formItem.
|
java.lang.Integer |
getDecimalPad()
Applies only to fields of type "float" and enforces a minimum number of digits shown after the decimal point.
|
java.lang.Integer |
getDecimalPrecision()
Applies only to fields of type "float" and affects how many significant digits are shown.
|
java.lang.String |
getDefaultIconSrc()
Default icon image source.
|
java.lang.Boolean |
getDisabled()
Whether this item is disabled.
|
java.lang.Boolean |
getDisableIconsOnReadOnly()
If
canEdit is set to false, should icons be disabled by default? |
java.lang.String |
getDisplayField()
Specifies an alternative field from which display values should be retrieved for this item.
|
java.lang.String |
getDisplayFieldName()
Returns the
displayField for this item. |
java.lang.String |
getDisplayValue()
Returns this item's value with any valueMap applied to it - the value as currently displayed to the user.
|
java.lang.String |
getDisplayValue(java.lang.String value)
Returns this item's value with any valueMap applied to it - the value as currently displayed to the user.
|
com.google.gwt.core.client.JavaScriptObject |
getEditorTypeConfig() |
java.lang.String |
getEditPendingCSSText()
Custom CSS text to be applied to cells with pending edits that have not yet been submitted.
|
java.lang.String |
getEmptyDisplayValue()
Text to display when this form item has a null or undefined value.
|
java.lang.String |
getEmptyValueIcon()
This property allows the developer to specify an icon to display when this item has no value.
|
java.lang.Boolean |
getEndRow()
Whether this item should end the row it's in in the form layout
|
int |
getErrorIconHeight()
Height of the error icon, if we're showing icons when validation errors occur.
|
java.lang.String |
getErrorIconSrc()
URL of the image to show as an error icon, if we're showing icons when validation errors occur.
|
int |
getErrorIconWidth()
Height of the error icon, if we're showing icons when validation errors occur.
|
int |
getErrorMessageWidth()
When
showInlineErrors and showErrorText are both true and errorOrientation is "left" or "right",
errorMessageWidth is the amount to reduce the width of the editor to accommodate the error message and icon. |
java.lang.String |
getExportFormat()
FormatString used during exports for numeric or date formatting. |
java.lang.Boolean |
getFetchMissingValues()
If this form item has a specified
optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record. |
java.lang.String |
getFieldName()
Return the name for the this formItem.
|
java.lang.Boolean |
getFilterLocally()
If this form item is mapping data values to a display value by fetching records from a dataSource (see
optionDataSource, displayField and fetchMissingValues), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value. |
DynamicForm |
getForm()
A reference to the FormItem's DynamicForm.
|
java.lang.String |
getFormat()
FormatString for numeric or date formatting. |
FormItem |
getFormItemAutoChild(java.lang.String autoChildName)
Returns the
FormItem AutoChild named autoChildName if already created. |
java.lang.String |
getFullDataPath()
Return the fully-qualified dataPath for the this formItem (ie, the dataPath expressed in absolute terms from the root
of the hierarchy, rather than relative to the item's parent form).
|
java.lang.Integer |
getGlobalTabIndex()
TabIndex for the form item within the page.
|
int |
getHeight()
Height of the FormItem.
|
java.lang.String |
getHeightAsString()
Height of the FormItem.
|
java.lang.String |
getHint()
Specifies "hint" string to show next to the form item to indicate something to the user.
|
java.lang.String |
getHintStyle()
CSS class for the "hint" string.
|
Alignment |
getHoverAlign()
Text alignment for text displayed in this item's hover canvas, if shown.
|
java.lang.Integer |
getHoverDelay()
If specified, this is the number of milliseconds to wait between the user rolling over this form item, and triggering
any hover action for it.
If not specified this.form.itemHoverDelay will be used instead. |
java.lang.Integer |
getHoverHeight()
Option to specify a height for any hover shown for this item.
|
java.lang.Integer |
getHoverOpacity()
Opacity for any hover shown for this item
|
java.lang.String |
getHoverStyle()
Explicit CSS Style for any hover shown for this item.
|
VerticalAlignment |
getHoverVAlign()
Vertical text alignment for text displayed in this item's hover canvas, if shown.
|
java.lang.Integer |
getHoverWidth()
Option to specify a width for any hover shown for this item.
|
FormItemIcon |
getIcon(java.lang.String name)
Given an
name return a pointer to the icon
definition |
int |
getIconHeight()
Default height for form item icons
|
java.lang.Integer |
getIconHSpace()
Horizontal space (in px) to leave between form item icons.
|
Rectangle |
getIconPageRect(FormItemIcon icon) |
java.lang.String |
getIconPrompt()
Default prompt (and tooltip-text) for icons.
|
Rectangle |
getIconRect(FormItemIcon icon) |
VerticalAlignment |
getIconVAlign()
How should icons be aligned vertically for this form item.
|
int |
getIconWidth()
Default width for form item icons
|
java.lang.String |
getImageURLPrefix()
Prefix to apply to the beginning of any
valueIcons when determining the URL for the image. |
java.lang.String |
getImageURLSuffix()
Suffix to apply to the end of any
valueIcons when
determining the URL for the image. |
java.lang.Boolean |
getImplicitSave()
When true, indicates that changes to this item will cause an automatic save on a
delay, as well as when the entire form is submitted. |
java.lang.Boolean |
getImplicitSaveOnBlur()
If not set to false, form item values will be saved when this item's "editorExit" handler is fired as well as on a
delay and when the entire form is submitted.
|
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. |
int |
getLeft()
Left coordinate of this item in pixels.
|
java.lang.String |
getLoadingDisplayValue()
Value shown in field when
fetchMissingValues is active and a fetch is pending. |
java.lang.String |
getLocateItemBy()
When
AutoTest.getElement() is used to parse locator strings
generated by link{isc.AutoTest.getLocator()} for this form item, should the item be identified? By default if the item
has a name this will always be used, however for items with no name, the following options are available:
"title" use the title as an identifier within this form "value" use the value of
the item to identify it (often used for items with a static defaultValue such as HeaderItems
"index" use the index within the form's items array. |
java.lang.String |
getMultipleValueSeparator()
If this item is displaying multiple values, this property will be the string that separates those values for display
purposes.
|
java.lang.String |
getName()
Name for this form field.
|
OperatorId |
getOperator()
OperatorId to be used when DynamicForm.getValuesAsCriteria() is called. |
Criteria |
getOptionCriteria()
If this item has a specified
optionDataSource, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping |
RPCRequest |
getOptionFilterContext()
If this item has a specified
optionDataSource, and this property is
not null, this will be passed to the datasource as RPCRequest properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping |
java.lang.String |
getOptionOperationId()
If this item has a specified
optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to
pick up display value mapping. |
static FormItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
int |
getPageLeft()
Returns the drawn page-left coordinate of this form item in pixels.
|
Rectangle |
getPageRect()
Return the page-level coordinates of this object.
|
int |
getPageTop()
Returns the drawn page-top coordinate of this form item in pixels.
|
Canvas |
getPicker()
The component that will be displayed when
FormItem.showPicker() is called due to a click on the picker icon. |
java.lang.Integer |
getPickerIconHeight()
If
showPickerIcon is true for this item, this
property governs the size of the picker icon. |
java.lang.String |
getPickerIconName()
If
showPickerIcon is true, this attribute
specifies the name applied to the picker icon |
java.lang.String |
getPickerIconPrompt()
Prompt to show when the user hovers the mouse over the picker icon.
|
FormItemIcon |
getPickerIconProperties()
If
showPickerIcon is true for this item, this
block of properties will be applied to the pickerIcon. |
java.lang.String |
getPickerIconSrc()
If
showPickerIcon is true for this item, this
property governs the src of the picker icon image to
be displayed. |
java.lang.String |
getPickerIconStyle()
Base CSS class name for a form item's picker icon cell.
|
java.lang.Integer |
getPickerIconWidth()
If
showPickerIcon is true for this item, this
property governs the size of the picker icon. |
int |
getPixelHeight()
Returns the specified
height of this formItem in
pixels. |
int |
getPixelWidth()
Returns the specified
width of this formItem in
pixels. |
java.lang.String |
getPrintTextBoxStyle()
Base CSS class name for a form item's text box element when getting printable HTML for the form.
|
java.lang.String |
getPrintTitleStyle()
Base CSS stylename for a form item's title when generating print HTML for the item.
|
java.lang.String |
getPrompt()
This text is shown as a tooltip prompt when the cursor hovers over this item.
|
ReadOnlyDisplayAppearance |
getReadOnlyDisplay()
If this item is
read-only, how should this item be
displayed to the user? If set, overrides the form-level readOnlyDisplay default. |
java.lang.String |
getReadOnlyTextBoxStyle()
Base text box style to apply when this item is
read-only and is using readOnlyDisplay
ReadOnlyDisplayAppearance.STATIC. |
Rectangle |
getRect()
Return the coordinates of this object.
|
java.lang.Boolean |
getRedrawOnChange()
If true, this item will cause the entire form to be redrawn when the item's "elementChanged" event is done firing
|
java.lang.Boolean |
getRejectInvalidValueOnChange()
If validateOnChange is true, and validation fails for this item on change, with no suggested value, should we revert to
the previous value, or continue to display the bad value entered by the user.
|
java.lang.Boolean |
getRequired()
Whether a non-empty value is required for this field to pass validation.
|
java.lang.String |
getRequiredMessage()
The required message for required field errors.
|
int |
getRowSpan()
Number of rows that this item spans
|
java.lang.Boolean |
getSaveOnEnter()
Set this to true to allow the parent form to save it's data when 'Enter' is pressed on this formItem and
saveOnEnter is true on the parent form. |
java.lang.String |
getScClassName()
Get the name of the underlying SmartClient class
|
ListGridRecord |
getSelectedRecord()
Get the record returned from the
optionDataSource when fetchMissingValues
is true, and the missing value is fetched. |
java.lang.Boolean |
getSelectOnClick()
Allows the
selectOnClick behavior to be configured
on a per-FormItem basis. |
java.lang.Boolean |
getSelectOnFocus()
Allows the
selectOnFocus behavior to be configured
on a per-FormItem basis. |
java.lang.Boolean |
getShouldSaveValue()
Should this item's value be saved in the form's values and hence returned from
form.getValues()? |
boolean |
getShowClippedTitleOnHover()
If true and the title is clipped, then a hover containing the full title of this item is enabled.
|
java.lang.Boolean |
getShowClippedValueOnHover()
If true and the value is clipped, then a hover containing the full value of this item is enabled.
|
java.lang.Boolean |
getShowDisabled()
When this item is disabled, should it be re-styled to indicate its disabled state?
|
java.lang.Boolean |
getShowErrorIcon()
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). |
java.lang.Boolean |
getShowErrorStyle()
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). |
java.lang.Boolean |
getShowErrorText()
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). |
java.lang.Boolean |
getShowFocused()
When this item receives focus, should it be re-styled to indicate it has focus?
|
java.lang.Boolean |
getShowFocusedErrorState()
If set to true, when an item has errors and is focused, an "ErrorFocused" suffix will appear on the stylename.
|
java.lang.Boolean |
getShowFocusedIcons()
If we're showing icons, should we change their image source to the appropriate focused source when this item
has focus? Can be overridden on a per icon basis by the formItemIcon
showFocused property. |
java.lang.Boolean |
getShowFocusedPickerIcon()
If
showPickerIcon is true for this item,
should the picker icon show a focused image when the form item has focus? |
java.lang.Boolean |
getShowHint()
If a hint is defined for this form item, should it be shown?
|
java.lang.Boolean |
getShowIcons()
Set to false to suppress writing out any
icons for
this item. |
java.lang.Boolean |
getShowOverIcons()
If we're showing icons, should we change their image source to the appropriate over source when the user rolls
over (or puts focus onto) them? Can be overridden on a per icon basis by the formItemIcon
showOver
property. |
java.lang.Boolean |
getShowPickerIcon()
Should we show a special 'picker'
icon for this form item?
Picker icons are customizable via pickerIconProperties. |
boolean |
getShowRTL()
When this item is in RTL mode, should its style name include an "RTL" suffix?
|
java.lang.Boolean |
getShowTitle()
Should we show a title cell for this formItem?
|
java.lang.Boolean |
getShowValueIconOnly()
If
valueIcons is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying |
java.lang.Boolean |
getStartRow()
Whether this item should always start a new row in the form layout.
|
java.lang.Boolean |
getStopOnError()
Indicates that if validation fails, the user should not be allowed to exit the field - focus will be forced back into
the field until the error is corrected.
|
java.lang.Boolean |
getSuppressValueIcon()
If
valueIcons is set, this property may be set to
prevent the value icons from showing up next to the form items value |
java.lang.Boolean |
getSynchronousValidation()
If enabled, whenever validation is triggered and a request to the server is required, user interactivity will be blocked
until the request returns.
|
java.lang.Integer |
getTabIndex()
TabIndex for the form item within the form, which controls the order in which controls are visited when the user hits
the tab or shift-tab keys to navigate between items.
|
Alignment |
getTextAlign()
Alignment of the text / content within this form item.
|
java.lang.String |
getTextBoxStyle()
Base CSS class name for a form item's text box element.
|
TimeDisplayFormat |
getTimeFormatter()
Time-format to apply to date type values within this formItem.
|
java.lang.String |
getTitle()
User visible title for this form item.
|
Alignment |
getTitleAlign()
Alignment of this item's title in its cell.
|
int |
getTitleColSpan()
Number of columns that this item's title spans.
|
TitleOrientation |
getTitleOrientation()
On which side of this item should the title be placed.
|
java.lang.String |
getTitleStyle()
Base CSS class name for a form item's title.
|
VerticalAlignment |
getTitleVAlign()
Vertical alignment of this item's title in its cell.
|
java.lang.String |
getTooltip()
This text is shown as a tooltip prompt when the cursor hovers over this item.
|
int |
getTop()
Top coordinate of this item in pixels.
|
java.lang.String |
getType()
The DynamicForm picks a field renderer based on the type of the field (and sometimes other attributes of the
field).
|
java.lang.Boolean |
getValidateOnChange()
If true, form items will be validated when each item's "change" handler is fired as well as when the entire form is
submitted or validated.
|
java.lang.Boolean |
getValidateOnExit()
If true, form items will be validated when each item's "editorExit" handler is fired as well as when the entire form is
submitted or validated.
|
OperatorId[] |
getValidOperators()
Array of valid filtering operators (eg "greaterThan") that are legal for this FormItem.
|
VerticalAlignment |
getVAlign()
Vertical alignment of this item within its cell.
|
java.lang.Object |
getValue()
Return the value tracked by this form item.
|
RecordList |
getValueAsRecordList() |
java.lang.String |
getValueField()
If this form item maps data values to display values by retrieving the
displayField values from an optionDataSource, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.If unset, assumed to be the name of this form item. |
java.lang.String |
getValueFieldName()
Getter method to retrieve the
valueField for this
item. |
java.lang.Integer |
getValueIconHeight()
If
valueIcons is specified, use this property to
specify a height for the value icon written out. |
int |
getValueIconLeftPadding()
If we're showing a value icon, this attribute governs the amount of space between the icon and the start edge of the
form item cell.
|
int |
getValueIconRightPadding()
If we're showing a value icon, this attribute governs the amount of space between the icon and the value text.
|
int |
getValueIconSize()
If
valueIcons is specified, this property may be
used to specify both the width and height of the icon written out. |
java.lang.Integer |
getValueIconWidth()
If
valueIcons is specified, use this property to
specify a width for the value icon written out. |
java.lang.Boolean |
getVisible()
Whether this item is currently visible.
|
int |
getVisibleHeight()
Output the drawn height for this item in pixels.
|
int |
getVisibleWidth()
Output the drawn width for this item in pixels.
|
int |
getWidth()
Width of the FormItem.
|
java.lang.String |
getWidthAsString()
Width of the FormItem.
|
java.lang.Boolean |
getWrapTitle()
If specified determines whether this items title should wrap.
|
java.lang.Boolean |
hasAdvancedCriteria()
Does this form item produce an
AdvancedCriteria sub criterion object? If this method
returns true, DynamicForm.getValuesAsCriteria()
on the form containing this item will always return an AdvancedCriteria object, calling
FormItemCriterionGetter.getCriterion() on each item to retrieve the individual criteria. |
void |
hide()
Hide this form item.
|
void |
hideIcon(java.lang.String icon)
This method will hide some icon in this item's
icons
array, if it is currently visible. |
void |
invalidateDisplayValueCache()
If this item has a specified
displayField, the
value displayed to the user for this item may be derived from another field. |
protected boolean |
isCreated() |
java.lang.Boolean |
isDisabled()
Is this item disabled?
|
java.lang.Boolean |
isDrawn()
Returns true if this item has been written out into the DOM.
|
java.lang.Boolean |
isVisible()
Return true if the form item is currently visible.
|
void |
redraw()
Causes the FormItem to be redrawn immediately with the new properties.
|
void |
setAccessKey(java.lang.String accessKey)
If specified this governs the HTML accessKey for the item.
|
void |
setAlign(Alignment align)
Alignment of this item in its cell.
|
void |
setAllowExpressions(java.lang.Boolean allowExpressions)
For a form that produces filter criteria (see
form.getValuesAsCriteria()), allows the user to type in simple expressions to cause filtering with that operator. |
void |
setAlwaysFetchMissingValues(java.lang.Boolean alwaysFetchMissingValues)
If this form item has a specified
optionDataSource and fetchMissingValues
is true, when the item value changes, a fetch will be performed against the optionDataSource to retrieve the related
record if displayField is specified and the
new item value is not present in any valueMap explicitly specified on the item. |
void |
setApplyHeightToTextBox(java.lang.Boolean applyHeightToTextBox)
If
height is specified, should it be applied to the
item's text box element? |
void |
setAriaRole(java.lang.String ariaRole)
ARIA role of this formItem.
|
void |
setAriaState(java.lang.String stateName,
java.lang.Object stateValue)
Set a specific ARIA state mapping for this form item.
|
void |
setAttribute(java.lang.String attribute,
BaseClass value)
Set attribute value to a BaseClass.
|
void |
setAttribute(java.lang.String attribute,
BaseClass[] value)
Set attribute value to a BaseClass array.
|
void |
setAttribute(java.lang.String attribute,
boolean value)
Set attribute value to a boolean.
|
void |
setAttribute(java.lang.String attribute,
java.lang.Boolean value)
Set attribute value to a Boolean.
|
void |
setAttribute(java.lang.String attribute,
DataClass value)
Set attribute value to a DataClass.
|
void |
setAttribute(java.lang.String attribute,
DataClass[] value)
Set attribute value to a DataClass array.
|
void |
setAttribute(java.lang.String attribute,
java.util.Date value)
Set attribute value to a Date.
|
void |
setAttribute(java.lang.String attribute,
double value)
Set attribute value to a double.
|
void |
setAttribute(java.lang.String attribute,
java.lang.Double value)
Set attribute value to a Double.
|
void |
setAttribute(java.lang.String attribute,
double[] value)
Set attribute value to a double array.
|
void |
setAttribute(java.lang.String attribute,
java.lang.Float value)
Set attribute value to a Float.
|
void |
setAttribute(java.lang.String attribute,
int value)
Set attribute value to an int.
|
void |
setAttribute(java.lang.String attribute,
int[] value)
Set attribute value to an int array.
|
void |
setAttribute(java.lang.String attribute,
java.lang.Integer value)
Set attribute value to an Integer.
|
void |
setAttribute(java.lang.String attribute,
java.lang.Integer[] value)
Set attribute value to an Integer array.
|
void |
setAttribute(java.lang.String attribute,
com.google.gwt.core.client.JavaScriptObject value)
Set attribute value to a JavaScriptObject.
|
void |
setAttribute(java.lang.String attribute,
long value)
Set attribute value to a long.
|
void |
setAttribute(java.lang.String attribute,
java.util.Map value)
Set attribute value to a Map.
|
void |
setAttribute(java.lang.String attribute,
java.lang.String value)
Set attribute value to a String
|
void |
setAttribute(java.lang.String attribute,
java.lang.String[] value)
Set attribute value to a String array.
|
void |
setAttribute(java.lang.String attribute,
ValueEnum[] value)
Set attribute value to a ValueEnum array.
|
void |
setAutoChildConstructor(java.lang.String autoChildName,
java.lang.String className)
Sets the SmartClient constructor for the AutoChild named
autoChildName. |
void |
setAutoChildProperties(java.lang.String autoChildName,
Canvas properties)
Sets the properties for creating a
Canvas AutoChild named autoChildName. |
void |
setAutoChildProperties(java.lang.String autoChildName,
FormItem properties)
Sets the properties for creating a
FormItem AutoChild named autoChildName. |
void |
setAutoChildVisibility(java.lang.String autoChildName,
boolean visible)
Sets whether to create and show the AutoChild named
autoChildName. |
void |
setBrowserSpellCheck(java.lang.Boolean browserSpellCheck)
If this browser supports spell-checking of text editing elements, do we want this enabled for this item? If unset the
property will be inherited from the containing form.
|
void |
setCanEdit(java.lang.Boolean canEdit)
Is this form item editable (canEdit:true) or read-only (canEdit:false)? Setting the form item to non-editable causes it
to render as read-only.
|
void |
setCanEditCriterionPredicate(FormItemCanEditCriterionPredicate predicate)
When a dynamic form is editing an advanced criteria object via
DynamicForm.setValuesAsCriteria, this predicate is used
to determine which sub-criteria apply to which form item(s). |
void |
setCanEditOpaqueValues(java.lang.Boolean canEditOpaqueValues)
If true, indicates that this FormItem is capable of editing "opaque" values, ie, objects that are more complex than
simple primitive types like numbers, strings and dates.
|
void |
setCanFocus(java.lang.Boolean canFocus)
Is this form item focusable? Setting this property to true on an otherwise non-focusable element such as a
StaticTextItem will cause the item to be included in the page's tab order and
respond to keyboard events. |
void |
setCanSelectText(boolean canSelectText)
For items showing a text value, should the user be able to select the text in this item?
|
void |
setCellHeight(java.lang.Integer cellHeight)
If specified, this property will govern the height of the cell in which this form item is rendered.
|
void |
setCellStyle(java.lang.String cellStyle)
CSS style applied to the form item as a whole, including the text element, any icons, and any hint text for the item.
|
void |
setChangeOnKeypress(java.lang.Boolean changeOnKeypress)
Should this form item fire its
change handler
(and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing
(and the value stored) on every keypress. |
void |
setClipStaticValue(java.lang.Boolean clipStaticValue)
If this item is
read-only and is using readOnlyDisplay ReadOnlyDisplayAppearance.STATIC, should the item value be clipped if it overflows the
specified size of the item? If set, overrides the form-level clipStaticValue default. |
void |
setClipTitle(java.lang.Boolean clipTitle)
If the title for this form item is showing, and is too large for the available space should the title be clipped?
|
void |
setColSpan(int colSpan)
Number of columns that this item spans.
|
void |
setColSpan(java.lang.String colSpan)
Number of columns that this item spans.
|
void |
setControlStyle(java.lang.String controlStyle)
Base CSS class name for a form item's control box (surrounds text box and picker).
|
void |
setCriteriaField(java.lang.String criteriaField)
|
void |
setCriterion(Criterion criterion)
Calls the
setCriterion() method
of the FormItemCriterionSetter
that is registered with this field. |
void |
setCriterionGetter(FormItemCriterionGetter getter)
Provides a specialized criterion from this formItem when creating an AdvancedCriteria
via
DynamicForm.getValuesAsCriteria. |
void |
setCriterionSetter(FormItemCriterionSetter setter)
Set the method to update this form item to reflect a criterion object from within an AdvancedCriteria.
|
void |
setDataPath(java.lang.String dataPath)
dataPath for this item.
|
void |
setDateFormatter(DateDisplayFormat dateFormatter)
Display format to use for date type values within this formItem.
|
void |
setDecimalPad(java.lang.Integer decimalPad)
Applies only to fields of type "float" and enforces a minimum number of digits shown after the decimal point.
|
void |
setDecimalPrecision(java.lang.Integer decimalPrecision)
Applies only to fields of type "float" and affects how many significant digits are shown.
|
void |
setDefaultIconSrc(java.lang.String defaultIconSrc)
Default icon image source.
|
static void |
setDefaultProperties(FormItem formItemProperties)
Class level method to set the default properties of this class.
|
void |
setDefaultValue(java.lang.Boolean defaultValue)
Value used when no value is provided for this item.
|
void |
setDefaultValue(java.util.Date defaultValue)
Value used when no value is provided for this item.
|
void |
setDefaultValue(java.lang.Double defaultValue)
Value used when no value is provided for this item.
|
void |
setDefaultValue(java.lang.Float defaultValue)
Value used when no value is provided for this item.
|
void |
setDefaultValue(java.lang.Integer defaultValue)
Value used when no value is provided for this item.
|
void |
setDefaultValue(java.lang.Object value) |
void |
setDefaultValue(java.lang.String defaultValue)
Value used when no value is provided for this item.
|
void |
setDisabled(java.lang.Boolean disabled)
Whether this item is disabled.
|
void |
setDisableIconsOnReadOnly(java.lang.Boolean disableIconsOnReadOnly)
If
canEdit is set to false, should icons be disabled by default? |
void |
setDisplayField(java.lang.String displayField)
Specifies an alternative field from which display values should be retrieved for this item.
|
void |
setDisplayFormat(DateDisplayFormat displayFormat)
|
void |
setDisplayFormat(TimeFormatter displayFormat)
|
void |
setEditorProperties(FormItem editorProperties)
Set default properties to use when editing.
|
void |
setEditorType(java.lang.Class<? extends FormItem> editorType)
Set the FormItem subclass to use when editing.
|
void |
setEditorType(FormItem editorType)
Deprecated.
Renamed to
setEditorProperties(FormItem). You can also consider using
setEditorType(Class) or setEditorType(String) instead. |
void |
setEditorType(java.lang.String editorType)
Set the FormItem subclass to use when editing.
|
void |
setEditorValueFormatter(FormItemValueFormatter formatter)
An optional
FormItemValueFormatter to map this item's current data value to a
display value. |
void |
setEditorValueParser(FormItemValueParser valueParser)
An optional
FormItemValueParser to map a user-entered display value to a data
value for storage. |
void |
setEditPendingCSSText(java.lang.String editPendingCSSText)
Custom CSS text to be applied to cells with pending edits that have not yet been submitted.
|
void |
setEmptyDisplayValue(java.lang.String emptyDisplayValue)
Text to display when this form item has a null or undefined value.
|
void |
setEmptyValueIcon(java.lang.String emptyValueIcon)
This property allows the developer to specify an icon to display when this item has no value.
|
void |
setEndRow(java.lang.Boolean endRow)
Whether this item should end the row it's in in the form layout
|
void |
setErrorFormatter(FormItemErrorFormatter errorFormatter)
Register a custom error formatter for this FormItem.
|
void |
setErrorIconHeight(int errorIconHeight)
Height of the error icon, if we're showing icons when validation errors occur.
|
void |
setErrorIconSrc(java.lang.String errorIconSrc)
URL of the image to show as an error icon, if we're showing icons when validation errors occur.
|
void |
setErrorIconWidth(int errorIconWidth)
Height of the error icon, if we're showing icons when validation errors occur.
|
void |
setErrorMessageWidth(int errorMessageWidth)
When
showInlineErrors and showErrorText are both true and errorOrientation is "left" or "right",
errorMessageWidth is the amount to reduce the width of the editor to accommodate the error message and icon. |
void |
setErrorOrientation(FormErrorOrientation errorOrientation)
If
showInlineErrors is true, where
should the error icon and text appear relative to the form item itself. |
void |
setExportFormat(java.lang.String exportFormat)
FormatString used during exports for numeric or date formatting. |
void |
setFetchMissingValues(java.lang.Boolean fetchMissingValues)
If this form item has a specified
optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record. |
void |
setFilterLocally(java.lang.Boolean filterLocally)
If this form item is mapping data values to a display value by fetching records from a dataSource (see
optionDataSource, displayField and fetchMissingValues), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value. |
void |
setFormat(java.lang.String format)
FormatString for numeric or date formatting. |
void |
setGlobalTabIndex(java.lang.Integer globalTabIndex)
TabIndex for the form item within the page.
|
void |
setHeight(int height)
Height of the FormItem.
|
void |
setHeight(java.lang.String height)
Height of the FormItem.
|
void |
setHint(java.lang.String hint)
Specifies "hint" string to show next to the form item to indicate something to the user.
|
void |
setHintStyle(java.lang.String hintStyle)
CSS class for the "hint" string.
|
void |
setHoverAlign(Alignment hoverAlign)
Text alignment for text displayed in this item's hover canvas, if shown.
|
void |
setHoverDelay(java.lang.Integer hoverDelay)
If specified, this is the number of milliseconds to wait between the user rolling over this form item, and triggering
any hover action for it.
If not specified this.form.itemHoverDelay will be used instead. |
void |
setHoverHeight(java.lang.Integer hoverHeight)
Option to specify a height for any hover shown for this item.
|
void |
setHoverOpacity(java.lang.Integer hoverOpacity)
Opacity for any hover shown for this item
|
void |
setHoverStyle(java.lang.String hoverStyle)
Explicit CSS Style for any hover shown for this item.
|
void |
setHoverVAlign(VerticalAlignment hoverVAlign)
Vertical text alignment for text displayed in this item's hover canvas, if shown.
|
void |
setHoverWidth(java.lang.Integer hoverWidth)
Option to specify a width for any hover shown for this item.
|
void |
setIconHeight(int iconHeight)
Default height for form item icons
|
void |
setIconHSpace(java.lang.Integer iconHSpace)
Horizontal space (in px) to leave between form item icons.
|
void |
setIconPrompt(java.lang.String iconPrompt)
Default prompt (and tooltip-text) for icons.
|
void |
setIcons(FormItemIcon... icons)
An array of descriptor objects for icons to display in a line after this form item.
|
void |
setIconVAlign(VerticalAlignment iconVAlign)
How should icons be aligned vertically for this form item.
|
void |
setIconWidth(int iconWidth)
Default width for form item icons
|
void |
setImageURLPrefix(java.lang.String imageURLPrefix)
Prefix to apply to the beginning of any
valueIcons when determining the URL for the image. |
void |
setImageURLSuffix(java.lang.String imageURLSuffix)
Suffix to apply to the end of any
valueIcons when
determining the URL for the image. |
void |
setImplicitSave(java.lang.Boolean implicitSave)
When true, indicates that changes to this item will cause an automatic save on a
delay, as well as when the entire form is submitted. |
void |
setImplicitSaveOnBlur(java.lang.Boolean implicitSaveOnBlur)
If not set to false, form item values will be saved when this item's "editorExit" handler is fired as well as on a
delay and when the entire form is submitted.
|
void |
setInitHandler(FormItemInitHandler initHandler)
Specify a notification method to fire when this formItem is initialized in JavaScript.
|
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 |
setInputTransformer(FormItemInputTransformer inputTransformer)
The transformer is called when a FormItem's value is about to change as the result of user interaction.
|
void |
setItemHoverFormatter(FormItemHoverFormatter hoverFormatter)
The FormItemHoverFormatter should return the HTML to display in a hover canvas when the user holds the mousepointer over this item.
|
void |
setItemTitleHoverFormatter(FormItemHoverFormatter hoverFormatter)
The
FormItemHoverFormatter should return the HTML to display in a hover canvas
when the user holds the mouse pointer over this item's title and the title is clipped. |
void |
setItemValueHoverFormatter(FormItemHoverFormatter hoverFormatter)
The
FormItemHoverFormatter should return the HTML to display in a hover canvas
when the user holds the mouse pointer over this item's value and the value is clipped. |
void |
setLeft(int left)
Left coordinate of this item in pixels.
|
void |
setLoadingDisplayValue(java.lang.String loadingDisplayValue)
Value shown in field when
fetchMissingValues is active and a fetch is pending. |
void |
setLocateItemBy(java.lang.String locateItemBy)
When
AutoTest.getElement() is used to parse locator strings
generated by link{isc.AutoTest.getLocator()} for this form item, should the item be identified? By default if the item
has a name this will always be used, however for items with no name, the following options are available:
"title" use the title as an identifier within this form "value" use the value of
the item to identify it (often used for items with a static defaultValue such as HeaderItems
"index" use the index within the form's items array. |
void |
setMultipleValueSeparator(java.lang.String multipleValueSeparator)
If this item is displaying multiple values, this property will be the string that separates those values for display
purposes.
|
void |
setName(java.lang.String name)
Name for this form field.
|
void |
setNullProperty(java.lang.String property) |
void |
setOperator(OperatorId operator)
OperatorId to be used when DynamicForm.getValuesAsCriteria() is called. |
void |
setOptionCriteria(Criteria optionCriteria)
If this item has a specified
optionDataSource, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping |
void |
setOptionDataSource(DataSource dataSource) |
void |
setOptionFilterContext(RPCRequest rpcRequestProperties)
If this item has a specified
optionDataSource, and this property is
not null, this will be passed to the datasource as RPCRequest properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping |
void |
setOptionOperationId(java.lang.String optionOperationId)
If this item has a specified
optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to
pick up display value mapping. |
void |
setPickerIconHeight(java.lang.Integer pickerIconHeight)
If
showPickerIcon is true for this item, this
property governs the size of the picker icon. |
void |
setPickerIconName(java.lang.String pickerIconName)
If
showPickerIcon is true, this attribute
specifies the name applied to the picker icon |
void |
setPickerIconPrompt(java.lang.String pickerIconPrompt)
Prompt to show when the user hovers the mouse over the picker icon.
|
void |
setPickerIconProperties(FormItemIcon pickerIconProperties)
If
showPickerIcon is true for this item, this
block of properties will be applied to the pickerIcon. |
void |
setPickerIconSrc(java.lang.String pickerIconSrc)
If
showPickerIcon is true for this item, this
property governs the src of the picker icon image to
be displayed. |
void |
setPickerIconStyle(java.lang.String pickerIconStyle)
Base CSS class name for a form item's picker icon cell.
|
void |
setPickerIconWidth(java.lang.Integer pickerIconWidth)
If
showPickerIcon is true for this item, this
property governs the size of the picker icon. |
void |
setPrintTextBoxStyle(java.lang.String printTextBoxStyle)
Base CSS class name for a form item's text box element when getting printable HTML for the form.
|
void |
setPrintTitleStyle(java.lang.String printTitleStyle)
Base CSS stylename for a form item's title when generating print HTML for the item.
|
void |
setPrompt(java.lang.String prompt)
This text is shown as a tooltip prompt when the cursor hovers over this item.
|
void |
setProperty(java.lang.String property,
boolean value) |
void |
setProperty(java.lang.String property,
double value) |
void |
setProperty(java.lang.String property,
int value) |
void |
setProperty(java.lang.String property,
com.google.gwt.core.client.JavaScriptObject value) |
void |
setProperty(java.lang.String property,
java.lang.String value) |
void |
setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
If this item is
read-only, how should this item be
displayed to the user? If set, overrides the form-level readOnlyDisplay default. |
void |
setReadOnlyTextBoxStyle(java.lang.String readOnlyTextBoxStyle)
Base text box style to apply when this item is
read-only and is using readOnlyDisplay
ReadOnlyDisplayAppearance.STATIC. |
void |
setRedrawOnChange(java.lang.Boolean redrawOnChange)
If true, this item will cause the entire form to be redrawn when the item's "elementChanged" event is done firing
|
void |
setRejectInvalidValueOnChange(java.lang.Boolean rejectInvalidValueOnChange)
If validateOnChange is true, and validation fails for this item on change, with no suggested value, should we revert to
the previous value, or continue to display the bad value entered by the user.
|
void |
setRequired(java.lang.Boolean required)
Whether a non-empty value is required for this field to pass validation.
|
void |
setRequiredMessage(java.lang.String requiredMessage)
The required message for required field errors.
|
void |
setRowSpan(int rowSpan)
Number of rows that this item spans
|
void |
setSaveOnEnter(java.lang.Boolean saveOnEnter)
Set this to true to allow the parent form to save it's data when 'Enter' is pressed on this formItem and
saveOnEnter is true on the parent form. |
void |
setScClassName(java.lang.String scClassName)
Set the name of the underlying SmartClient class.
|
void |
setSelectOnClick(java.lang.Boolean selectOnClick)
Allows the
selectOnClick behavior to be configured
on a per-FormItem basis. |
void |
setSelectOnFocus(java.lang.Boolean selectOnFocus)
Allows the
selectOnFocus behavior to be configured
on a per-FormItem basis. |
void |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Should this item's value be saved in the form's values and hence returned from
form.getValues()? |
void |
setShowClippedTitleOnHover(boolean showClippedTitleOnHover)
If true and the title is clipped, then a hover containing the full title of this item is enabled.
|
void |
setShowClippedValueOnHover(java.lang.Boolean showClippedValueOnHover)
If true and the value is clipped, then a hover containing the full value of this item is enabled.
|
void |
setShowDisabled(java.lang.Boolean showDisabled)
When this item is disabled, should it be re-styled to indicate its disabled state?
If this method is called after the component has been drawn/initialized: Setter method for showDisabled |
void |
setShowErrorIcon(java.lang.Boolean showErrorIcon)
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). |
void |
setShowErrorStyle(java.lang.Boolean showErrorStyle)
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). |
void |
setShowErrorText(java.lang.Boolean showErrorText)
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). |
void |
setShowFocused(java.lang.Boolean showFocused)
When this item receives focus, should it be re-styled to indicate it has focus?
|
void |
setShowFocusedErrorState(java.lang.Boolean showFocusedErrorState)
If set to true, when an item has errors and is focused, an "ErrorFocused" suffix will appear on the stylename.
|
void |
setShowFocusedIcons(java.lang.Boolean showFocusedIcons)
If we're showing icons, should we change their image source to the appropriate focused source when this item
has focus? Can be overridden on a per icon basis by the formItemIcon
showFocused property. |
void |
setShowFocusedPickerIcon(java.lang.Boolean showFocusedPickerIcon)
If
showPickerIcon is true for this item,
should the picker icon show a focused image when the form item has focus? |
void |
setShowHint(java.lang.Boolean showHint)
If a hint is defined for this form item, should it be shown?
|
void |
setShowIcons(java.lang.Boolean showIcons)
Set to false to suppress writing out any
icons for
this item. |
void |
setShowIfCondition(FormItemIfFunction showIf)
Expression that's evaluated to see if an item should be dynamically hidden.
|
void |
setShowOverIcons(java.lang.Boolean showOverIcons)
If we're showing icons, should we change their image source to the appropriate over source when the user rolls
over (or puts focus onto) them? Can be overridden on a per icon basis by the formItemIcon
showOver
property. |
void |
setShowPickerIcon(java.lang.Boolean showPickerIcon)
Should we show a special 'picker'
icon for this form item?
Picker icons are customizable via pickerIconProperties. |
void |
setShowRTL(boolean showRTL)
When this item is in RTL mode, should its style name include an "RTL" suffix?
|
void |
setShowTitle(java.lang.Boolean showTitle)
Should we show a title cell for this formItem?
|
void |
setShowValueIconOnly(java.lang.Boolean showValueIconOnly)
If
valueIcons is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying |
void |
setStartRow(java.lang.Boolean startRow)
Whether this item should always start a new row in the form layout.
|
void |
setStopOnError(java.lang.Boolean stopOnError)
Indicates that if validation fails, the user should not be allowed to exit the field - focus will be forced back into
the field until the error is corrected.
|
void |
setSuppressValueIcon(java.lang.Boolean suppressValueIcon)
If
valueIcons is set, this property may be set to
prevent the value icons from showing up next to the form items value |
void |
setSynchronousValidation(java.lang.Boolean synchronousValidation)
If enabled, whenever validation is triggered and a request to the server is required, user interactivity will be blocked
until the request returns.
|
void |
setTabIndex(java.lang.Integer tabIndex)
TabIndex for the form item within the form, which controls the order in which controls are visited when the user hits
the tab or shift-tab keys to navigate between items.
|
void |
setTextAlign(Alignment textAlign)
Alignment of the text / content within this form item.
|
void |
setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class name for a form item's text box element.
|
void |
setTimeFormatter(TimeDisplayFormat timeFormatter)
Time-format to apply to date type values within this formItem.
|
void |
setTitle(java.lang.String title)
User visible title for this form item.
|
void |
setTitleAlign(Alignment titleAlign)
Alignment of this item's title in its cell.
|
void |
setTitleColSpan(int titleColSpan)
Number of columns that this item's title spans.
|
void |
setTitleHoverFormatter(FormItemHoverFormatter hoverFormatter)
Synonym for
setItemTitleHoverFormatter(FormItemHoverFormatter). |
void |
setTitleOrientation(TitleOrientation titleOrientation)
On which side of this item should the title be placed.
|
void |
setTitleStyle(java.lang.String titleStyle)
Base CSS class name for a form item's title.
|
void |
setTitleVAlign(VerticalAlignment titleVAlign)
Vertical alignment of this item's title in its cell.
|
void |
setTooltip(java.lang.String tooltip)
This text is shown as a tooltip prompt when the cursor hovers over this item.
|
void |
setTop(int top)
Top coordinate of this item in pixels.
|
void |
setType(java.lang.String type)
The DynamicForm picks a field renderer based on the type of the field (and sometimes other attributes of the
field).
|
void |
setValidateOnChange(java.lang.Boolean validateOnChange)
If true, form items will be validated when each item's "change" handler is fired as well as when the entire form is
submitted or validated.
|
void |
setValidateOnExit(java.lang.Boolean validateOnExit)
If true, form items will be validated when each item's "editorExit" handler is fired as well as when the entire form is
submitted or validated.
|
void |
setValidators(Validator... validators)
Validators for this form item.
|
void |
setValidOperators(OperatorId... validOperators)
Array of valid filtering operators (eg "greaterThan") that are legal for this FormItem.
|
void |
setVAlign(VerticalAlignment vAlign)
Vertical alignment of this item within its cell.
|
void |
setValue(boolean value)
Set the value of the form item.
|
void |
setValue(java.util.Date value)
Set the value of the form item.
|
void |
setValue(double value)
Set the value of the form item.
|
void |
setValue(int value)
Set the value of the form item.
|
void |
setValue(java.lang.Object value)
Set the value of the form item as an object.
|
void |
setValue(java.lang.String value)
Set the value of the form item.
|
void |
setValueField(java.lang.String valueField)
If this form item maps data values to display values by retrieving the
displayField values from an optionDataSource, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.If unset, assumed to be the name of this form item. |
void |
setValueFormatter(FormItemValueFormatter formatter)
Optional
FormItemValueFormatter, if provided, is evaluated to get the
display value to show for this form items underlying data value. |
void |
setValueHoverFormatter(FormItemHoverFormatter hoverFormatter)
Synonym for
setItemValueHoverFormatter(FormItemHoverFormatter). |
void |
setValueIconHeight(java.lang.Integer valueIconHeight)
If
valueIcons is specified, use this property to
specify a height for the value icon written out. |
void |
setValueIconLeftPadding(int valueIconLeftPadding)
If we're showing a value icon, this attribute governs the amount of space between the icon and the start edge of the
form item cell.
|
void |
setValueIconMapper(ValueIconMapper valueIconMapper)
Set the FormItem Value Icon mapper that allows the developer to specify the image source for an icon to be displayed for the current form item value.
|
void |
setValueIconRightPadding(int valueIconRightPadding)
If we're showing a value icon, this attribute governs the amount of space between the icon and the value text.
|
void |
setValueIcons(java.util.Map valueIcons)
Set the valueIcons for this item.
|
void |
setValueIconSize(int valueIconSize)
If
valueIcons is specified, this property may be
used to specify both the width and height of the icon written out. |
void |
setValueIconWidth(java.lang.Integer valueIconWidth)
If
valueIcons is specified, use this property to
specify a width for the value icon written out. |
void |
setValueMap(java.util.LinkedHashMap valueMap)
Set the valueMap for this item.
|
void |
setValueMap(java.lang.String... valueMap)
Set the valueMap for this item.
|
void |
setVisible(java.lang.Boolean visible)
Whether this item is currently visible.
|
void |
setWidth(int width)
Width of the FormItem.
|
void |
setWidth(java.lang.String width)
Width of the FormItem.
|
void |
setWrapTitle(java.lang.Boolean wrapTitle)
If specified determines whether this items title should wrap.
|
boolean |
shouldApplyHeightToTextBox()
If
height is specified, should it be applied to the
item's text box element? If this method returns false, the text box will not have an explicit height applied, though the
containing cell will be sized to accomodiate any specified height. |
java.lang.Boolean |
shouldFetchMissingValue(java.lang.Object newValue)
If this field has a specified
optionDataSource, should we perform a fetch against that dataSource to find the record that matches this field's value? |
java.lang.Boolean |
shouldSaveOnEnter()
Returns true if 'Enter' key presses in this formItem should allow a saveOnEnter: true parent form to save it's data.
|
boolean |
shouldStopKeyPressBubbling(java.lang.String keyName,
int characterValue)
Should some keypress event on this item be prevented from bubbling (such that the containing form and ancestors do not
receive the event).
|
void |
show()
Show this form item.
|
void |
showIcon(java.lang.String icon)
This method will show some icon in this item's
icons
array, if it is not already visible. |
void |
showPicker()
Method to show a picker for this item.
|
void |
stopHover()
This method is fired when the user rolls off this item (or the title for this item) and will clear any hover canvas
shown by the item.
|
void |
storeValue(java.lang.Object value)
Store (and optionally show) a value for this form item.
|
void |
storeValue(java.lang.Object value,
java.lang.Boolean showValue)
Store (and optionally show) a value for this form item.
|
void |
updateState()
Update the visual state of a FormItem to reflect any changes in state or any changes in style settings (eg
textBoxStyle). |
java.lang.Boolean |
validate()
Validate this item.
|
boolean |
valueClipped()
Is the value clipped?
|
getRef, getRef, internalSetIDdoAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObjectequals, getJsObj, hashCode, setJavaScriptObject, setJsObjpublic FormItem()
public FormItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public FormItem(java.lang.String name)
public static FormItem 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.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 setAccessKey(java.lang.String accessKey)
This should be set to a character - when a user hits the html accessKey modifier for the browser, plus this character, focus will be given to the item. The accessKey modifier can vary by browser and platform.
The following list of default behavior is for reference only, developers should also consult browser documentation for additional information.
Alt + accessKeyAlt+Shift +
accessKeyCtrl+Opt + accessKeyAlt + accessKeyCtrl+Opt + accessKeyaccessKey - Default value is nullFocus overview and related methodspublic java.lang.String getAccessKey()
This should be set to a character - when a user hits the html accessKey modifier for the browser, plus this character, focus will be given to the item. The accessKey modifier can vary by browser and platform.
The following list of default behavior is for reference only, developers should also consult browser documentation for additional information.
Alt + accessKeyAlt+Shift +
accessKeyCtrl+Opt + accessKeyAlt + accessKeyCtrl+Opt + accessKeyFocus overview and related methodspublic void setAlign(Alignment align)
textAlign (typically only applies to items showing
a "textBox", such as a TextItem or SelectItem, as well as text-only form item types such as StaticTextItem and HeaderItem).align - Default value is nullAppearance overview and related methodspublic Alignment getAlign()
textAlign (typically only applies to items showing
a "textBox", such as a TextItem or SelectItem, as well as text-only form item types such as StaticTextItem and HeaderItem).Appearance overview and related methodspublic void setAllowExpressions(java.lang.Boolean allowExpressions)
form.getValuesAsCriteria()), allows the user to type in simple expressions to cause filtering with that operator. For
example, entering ">5" means values greater than 5, and ">0 and <5" means values between 0 and 5. The
following table lists character sequences that can be entered as a prefix to a value, and the corresponding operator that will be used.
| Prefix | Operator |
| < | lessThan |
| > | greaterThan |
| <= | lessThanOrEqual |
| >= | greaterThanOrEqual |
| someValue...someValue | betweenInclusive |
| ! | notEqual |
| ^ | startsWith |
| | | endsWith |
| !^ | notStartsWith plus logical not |
| !@ | notEndsWith plus logical not |
| ~ | contains |
| !~ | notContains |
| # | isNull |
| !# | isNotNull |
| == | exact match (for fields where 'contains' is the default) |
Two further special notations are allowed:
In all cases, if an operator is disallowed for the field (via field.validOperators at either the dataSource or field
level), the operator character is ignored (treated as part of a literal value).
By default, the case-insensitive version of the operator is used (eg, startsWith will actually use "iStartsWith"). To avoid this, explicitly set item.operator (the default operator) to any case sensitive operator (eg "equals" or "contains") and case sensitive operators will be used for user-entered expressions.
Compound expressions (including "and" and "or") are allowed only for numeric or date/time types.
Note that if the user does not type a prefix or use other special notation as
described above, the operator specified via operator is used, or if formItem.operator is unspecified, a default operator chosen as described under
operator.
Also note that whatever you enter will be used literally, including any whitespace characters. For example if you input '== China ' then ' China ' will be the value.
The allowExpression behavior can be enabled for every field in a form via allowExpressions.
Finally, note that, like operator, enabling allowExpressions:true
causes form.getValuesAsCriteria()) to return
AdvancedCriteria.
allowExpressions - Default value is nullpublic java.lang.Boolean getAllowExpressions()
form.getValuesAsCriteria()), allows the user to type in simple expressions to cause filtering with that operator. For
example, entering ">5" means values greater than 5, and ">0 and <5" means values between 0 and 5. The
following table lists character sequences that can be entered as a prefix to a value, and the corresponding operator that will be used.
| Prefix | Operator |
| < | lessThan |
| > | greaterThan |
| <= | lessThanOrEqual |
| >= | greaterThanOrEqual |
| someValue...someValue | betweenInclusive |
| ! | notEqual |
| ^ | startsWith |
| | | endsWith |
| !^ | notStartsWith plus logical not |
| !@ | notEndsWith plus logical not |
| ~ | contains |
| !~ | notContains |
| # | isNull |
| !# | isNotNull |
| == | exact match (for fields where 'contains' is the default) |
Two further special notations are allowed:
In all cases, if an operator is disallowed for the field (via field.validOperators at either the dataSource or field
level), the operator character is ignored (treated as part of a literal value).
By default, the case-insensitive version of the operator is used (eg, startsWith will actually use "iStartsWith"). To avoid this, explicitly set item.operator (the default operator) to any case sensitive operator (eg "equals" or "contains") and case sensitive operators will be used for user-entered expressions.
Compound expressions (including "and" and "or") are allowed only for numeric or date/time types.
Note that if the user does not type a prefix or use other special notation as
described above, the operator specified via operator is used, or if formItem.operator is unspecified, a default operator chosen as described under
operator.
Also note that whatever you enter will be used literally, including any whitespace characters. For example if you input '== China ' then ' China ' will be the value.
The allowExpression behavior can be enabled for every field in a form via allowExpressions.
Finally, note that, like operator, enabling allowExpressions:true
causes form.getValuesAsCriteria()) to return
AdvancedCriteria.
public void setAlwaysFetchMissingValues(java.lang.Boolean alwaysFetchMissingValues)
optionDataSource and fetchMissingValues
is true, when the item value changes, a fetch will be performed against the optionDataSource to retrieve the related
record if displayField is specified and the
new item value is not present in any valueMap explicitly specified on the item. Setting this property to true means
that a fetch will occur against the optionDataSource to retrieve the related record even if displayField is unset, or the item has a valueMap
which explicitly contains this field's value.
An example of a use case where this might be set would be if FormItem.formatValue() or FormItem.formatEditorValue() were written to display
properties from the selected record.
Note
- for efficiency we cache the associated record once a fetch has been performed, meaning if the value changes, then
reverts to a previously seen value, we do not kick off an additional fetch even if this property is true. If necessary
this cache may be explicitly invalidated via a call to FormItem.invalidateDisplayValueCache()
Note : This is an advanced setting
alwaysFetchMissingValues - Default value is falsepublic java.lang.Boolean getAlwaysFetchMissingValues()
optionDataSource and fetchMissingValues
is true, when the item value changes, a fetch will be performed against the optionDataSource to retrieve the related
record if displayField is specified and the
new item value is not present in any valueMap explicitly specified on the item. Setting this property to true means
that a fetch will occur against the optionDataSource to retrieve the related record even if displayField is unset, or the item has a valueMap
which explicitly contains this field's value.
An example of a use case where this might be set would be if FormItem.formatValue() or FormItem.formatEditorValue() were written to display
properties from the selected record.
Note
- for efficiency we cache the associated record once a fetch has been performed, meaning if the value changes, then
reverts to a previously seen value, we do not kick off an additional fetch even if this property is true. If necessary
this cache may be explicitly invalidated via a call to FormItem.invalidateDisplayValueCache()
public void setApplyHeightToTextBox(java.lang.Boolean applyHeightToTextBox)
height is specified, should it be applied to the
item's text box element? If unset, behavior is determined as described in FormItem.shouldApplyHeightToTextBox()
Note : This is an advanced setting
applyHeightToTextBox - Default value is nullpublic java.lang.Boolean getApplyHeightToTextBox()
height is specified, should it be applied to the
item's text box element? If unset, behavior is determined as described in FormItem.shouldApplyHeightToTextBox()
public void setAriaRole(java.lang.String ariaRole)
Accessibility.
Note : This is an advanced setting
ariaRole - Default value is nullAccessibility overview and related methodspublic java.lang.String getAriaRole()
Accessibility.Accessibility overview and related methodspublic void setBrowserSpellCheck(java.lang.Boolean browserSpellCheck)
Notes:
- this property only applies to text based items
such as TextItem and TextAreaItem.
- this property is not supported on all browsers.
Note : This is an advanced setting
browserSpellCheck - Default value is nullDynamicForm.setBrowserSpellCheck(java.lang.Boolean)public java.lang.Boolean getBrowserSpellCheck()
Notes:
- this property only applies to text based items
such as TextItem and TextAreaItem.
- this property is not supported on all browsers.
DynamicForm.getBrowserSpellCheck()public void setCanEdit(java.lang.Boolean canEdit)
setCanEdit() method. Read-only appearance may be
specified via readOnlyDisplay. The default
setting for this value ("readOnly") differs from the disabled state in that the form item is not rendered
with disabled styling and most form items will allow copying of the contents while read-only but do not while disabled.
Note that for forms bound to a DataSource, if this property is not explicitly set
at the item level, its default value will match the canEditFieldAttribute on the associated
dataSource field.
Developers should also be aware that the readOnlyDisplay attribute is unrelated to the
readOnlyEditorType attribute. When a DynamicForm
is first bound to a dataSource, for canEdit:false
DataSourceFields, readOnlyEditorType will
determine what FormItemType should be created for the field. Once created, a
FormItem's type can not be changed. Setting canEdit
at runtime will simply change the appearance of the item to allow or disallow editing of the item.
If this method is called after the component has been drawn/initialized:
Is this form item editable (canEdit:true) or read-only (canEdit:false)? Setting the form item to non-editable causes it to render as read-only, using the appearance specified via readOnlyDisplay.
The default appearance for canEdit:false items (readOnlyDisplay:"readOnly") differs from the disabled state in that the form item is not rendered with disabled styling and most form items will allow copying of the contents while read-only but do not while disabled.
canEdit - Can this form item be edited?. Default value is nullsetCanEdit(java.lang.Boolean),
DynamicForm.setCanEdit(java.lang.Boolean)public java.lang.Boolean getCanEdit()
setCanEdit() method. Read-only appearance may be
specified via readOnlyDisplay. The default
setting for this value ("readOnly") differs from the disabled state in that the form item is not rendered
with disabled styling and most form items will allow copying of the contents while read-only but do not while disabled.
Note that for forms bound to a DataSource, if this property is not explicitly set
at the item level, its default value will match the canEditFieldAttribute on the associated
dataSource field.
Developers should also be aware that the readOnlyDisplay attribute is unrelated to the
readOnlyEditorType attribute. When a DynamicForm
is first bound to a dataSource, for canEdit:false
DataSourceFields, readOnlyEditorType will
determine what FormItemType should be created for the field. Once created, a
FormItem's type can not be changed. Setting canEdit
at runtime will simply change the appearance of the item to allow or disallow editing of the item.
This setting differs from the enabled/disabled state in that most form items will allow copying of the contents while read-only but do not while disabled.
setCanEdit(java.lang.Boolean),
DynamicForm.setCanEdit(java.lang.Boolean)public void setCanEditOpaqueValues(java.lang.Boolean canEditOpaqueValues)
SimpleType system to convert these opaque values into "atomic" values that can be
edited by the built-in editors like TextItem. However, sometimes you
to create a custom editor that knows how to edit a particular opaque type in a domain-specific way - for example, a
composite custom FormItem that allows the user to edit both a number and a currency code, both of which are needed to
make a proper monetary amount (for that particular application). When this value is set, the FormItem will manage the
opaque value directly, rather than it being filtered through calls to getAtomicValue() and storeAtomicValue(). Note, if you set this flag on a FormItem
that does not have the ability to edit an opaque value (which is something that must be custom-coded) then you will get
garbage in your editor, if not an outright crash.
Note : This is an advanced setting
canEditOpaqueValues - Default value is nullpublic java.lang.Boolean getCanEditOpaqueValues()
SimpleType system to convert these opaque values into "atomic" values that can be
edited by the built-in editors like TextItem. However, sometimes you
to create a custom editor that knows how to edit a particular opaque type in a domain-specific way - for example, a
composite custom FormItem that allows the user to edit both a number and a currency code, both of which are needed to
make a proper monetary amount (for that particular application). When this value is set, the FormItem will manage the
opaque value directly, rather than it being filtered through calls to getAtomicValue() and storeAtomicValue(). Note, if you set this flag on a FormItem
that does not have the ability to edit an opaque value (which is something that must be custom-coded) then you will get
garbage in your editor, if not an outright crash.public void setCanFocus(java.lang.Boolean canFocus)
StaticTextItem will cause the item to be included in the page's tab order and
respond to keyboard events.
Note : This is an advanced setting
canFocus - Default value is nullFocus overview and related methodspublic java.lang.Boolean getCanFocus()
StaticTextItem will cause the item to be included in the page's tab order and
respond to keyboard events.TextItems, TextAreaItems, etc), CanvasItems with a focusable canvas,
or items where canFocus was explicitly set to true.Focus overview and related methodspublic void setCanSelectText(boolean canSelectText)
canSelectText - Default value is truepublic boolean getCanSelectText()
public void setCellHeight(java.lang.Integer cellHeight)
itemLayout:"absolute".cellHeight - Default value is nullpublic java.lang.Integer getCellHeight()
itemLayout:"absolute".public void setCellStyle(java.lang.String cellStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
If this method is called after the component has been drawn/initialized:
Setter for cellStyle.
cellStyle - the new cellStyle value. See FormItemBaseStyle . Default value is "formCell"Appearance overview and related methodspublic java.lang.String getCellStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
FormItemBaseStyleAppearance overview and related methodspublic void setChangeOnKeypress(java.lang.Boolean changeOnKeypress)
change handler
(and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing
(and the value stored) on every keypress. Note: If false, the value returned by getValue will not reflect the value displayed in the form
item element as long as focus is in the form item element.
changeOnKeypress - Default value is truepublic java.lang.Boolean getChangeOnKeypress()
change handler
(and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing
(and the value stored) on every keypress. Note: If false, the value returned by getValue will not reflect the value displayed in the form
item element as long as focus is in the form item element.
public void setClipStaticValue(java.lang.Boolean clipStaticValue)
read-only and is using readOnlyDisplay ReadOnlyDisplayAppearance.STATIC, should the item value be clipped if it overflows the
specified size of the item? If set, overrides the form-level clipStaticValue default.clipStaticValue - Default value is nullDynamicForm.setClipStaticValue(java.lang.Boolean)public java.lang.Boolean getClipStaticValue()
read-only and is using readOnlyDisplay ReadOnlyDisplayAppearance.STATIC, should the item value be clipped if it overflows the
specified size of the item? If set, overrides the form-level clipStaticValue default.DynamicForm.getClipStaticValue()public void setClipTitle(java.lang.Boolean clipTitle)
Null by default - if set to true or false, overrides clipItemTitles.
clipTitle - Default value is nullpublic java.lang.Boolean getClipTitle()
Null by default - if set to true or false, overrides clipItemTitles.
public Canvas getContainerWidget()
DynamicForm containing the item but in some cases editable
components handle writing out form items directly. An example of this is Grid
Editing - when a listGrid shows per-field editors, the containerWidget for each item will be the listGrid
body. Note that even if the containerWidget is not a DynamicForm, a DynamicForm will still exist for
the item (available as form), allowing access to
standard APIs such as DynamicForm.getValues()
public void setControlStyle(java.lang.String controlStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
controlStyle - See FormItemBaseStyle . Default value is nullsetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getControlStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
FormItemBaseStylegetCellStyle(),
Appearance overview and related methodspublic void setCriteriaField(java.lang.String criteriaField)
operator, the name of the DataSource
field for the Criterion this FormItem generates. If not specified, defaults to name. Generally, because criteriaField
defaults to item.name, you don't need to specify it. However, if more than one FormItem specifies criteria
for the same DataSource field, they will need unique values for name but should set criteriaField to the name of DataSource field they
both target.
For example, if two DateItems are used to provide a min and max date for a single field called
"joinDate", set criteriaField to "joinDate" on
both fields but give the fields distinct names (eg "minDate" and "maxDate") and use those names for any programmatic
access, such as DynamicForm.setValue().
criteriaField - Default value is nullpublic java.lang.String getCriteriaField()
operator, the name of the DataSource
field for the Criterion this FormItem generates. If not specified, defaults to name. Generally, because criteriaField
defaults to item.name, you don't need to specify it. However, if more than one FormItem specifies criteria
for the same DataSource field, they will need unique values for name but should set criteriaField to the name of DataSource field they
both target.
For example, if two DateItems are used to provide a min and max date for a single field called
"joinDate", set criteriaField to "joinDate" on
both fields but give the fields distinct names (eg "minDate" and "maxDate") and use those names for any programmatic
access, such as DynamicForm.setValue().
public void setDataPath(java.lang.String dataPath)
dataPath - See DataPath . Default value is nullpublic java.lang.String getDataPath()
DataPathpublic void setDateFormatter(DateDisplayFormat dateFormatter)
Note that Fields of type "date",
"datetime" or "time" will be edited using a DateItem or TimeItem by
default, but this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a
custom editorType as well as data type.
The timeFormatter may also be used to format underlying
Date values as times (ommitting the date part entirely). If both dateFormatter and
timeFormatter are specified on an item, for fields specified as type "time" the timeFormatter will be used,
otherwise the dateFormatter
If item.dateFormatter and item.timeFormatter is
unspecified, date display format may be defined at the component level via dateFormatter, or for fields of type
"datetime" datetimeFormatter.
Otherwise the default is to use the system-wide default short date format, configured via Date.setShortDisplayFormat(). Specify any valid DateDisplayFormat to change the format used by this item.
Note that if this is a
freeform editable field, such a TextItem, with type specified as
"date" or "datetime" the system will automatically attempt to parse user entered values back
to a Date value, assuming the entered string matches the date format for the field. Developers may further customize
this via an explicit inputFormat or via entirely
custom setEditorValueFormatter and setEditorValueParser methods.
Note : This is an advanced setting
dateFormatter - Default value is nullsetTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat),
setFormat(java.lang.String),
Appearance overview and related methodspublic DateDisplayFormat getDateFormatter()
Note that Fields of type "date",
"datetime" or "time" will be edited using a DateItem or TimeItem by
default, but this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a
custom editorType as well as data type.
The timeFormatter may also be used to format underlying
Date values as times (ommitting the date part entirely). If both dateFormatter and
timeFormatter are specified on an item, for fields specified as type "time" the timeFormatter will be used,
otherwise the dateFormatter
If item.dateFormatter and item.timeFormatter is
unspecified, date display format may be defined at the component level via dateFormatter, or for fields of type
"datetime" datetimeFormatter.
Otherwise the default is to use the system-wide default short date format, configured via Date.setShortDisplayFormat(). Specify any valid DateDisplayFormat to change the format used by this item.
Note that if this is a
freeform editable field, such a TextItem, with type specified as
"date" or "datetime" the system will automatically attempt to parse user entered values back
to a Date value, assuming the entered string matches the date format for the field. Developers may further customize
this via an explicit inputFormat or via entirely
custom setEditorValueFormatter and setEditorValueParser methods.
getTimeFormatter(),
getFormat(),
Appearance overview and related methodspublic void setDecimalPad(java.lang.Integer decimalPad)
For example, a field value of 343.1, 343.104 and 343.09872677 would all be shown as 343.10 if decimalPad is 2.
The original unpadded value is always shown when the value is edited.
decimalPad - Default value is nullAppearance overview and related methodspublic java.lang.Integer getDecimalPad()
For example, a field value of 343.1, 343.104 and 343.09872677 would all be shown as 343.10 if decimalPad is 2.
The original unpadded value is always shown when the value is edited.
Appearance overview and related methodspublic void setDecimalPrecision(java.lang.Integer decimalPrecision)
For example, with decimalPrecision 3, if the field value is 343.672677, 343.673 is shown.
If the value is 125.2, 125.2 is shown -
decimalPrecision will not cause extra zeros to be added. Use decimalPad for this.
A number is always shown with its original precision when edited.
decimalPrecision - Default value is nullAppearance overview and related methodspublic java.lang.Integer getDecimalPrecision()
For example, with decimalPrecision 3, if the field value is 343.672677, 343.673 is shown.
If the value is 125.2, 125.2 is shown -
decimalPrecision will not cause extra zeros to be added. Use decimalPad for this.
A number is always shown with its original precision when edited.
Appearance overview and related methodspublic void setDefaultIconSrc(java.lang.String defaultIconSrc)
icon.src property.icon.showOver is true, this url will be modified by adding "_Over" to get an over state image for the icon.
Note : This is an advanced setting
defaultIconSrc - See SCImgURL . Default value is "[SKIN]/DynamicForm/default_formItem_icon.gif"public java.lang.String getDefaultIconSrc()
icon.src property.icon.showOver is true, this url will be modified by adding "_Over" to get an over state image for the icon.SCImgURLpublic void setDisabled(java.lang.Boolean disabled)
setDisabled() method. Note that if the
widget containing this formItem is disabled, the formItem will behave in a disabled manner regardless of the setting of
the item.disabled property. Note that not all items can be disabled, and not all browsers show an obvious disabled
style for native form elements.
If this method is called after the component has been drawn/initialized:
Set this item to be enabled or disabled at runtime.
disabled - true if this item should be disabled. Default value is falsesetDisabled(java.lang.Boolean),
Appearance overview and related methods,
Enable & Disable Examplepublic java.lang.Boolean getDisabled()
setDisabled() method. Note that if the
widget containing this formItem is disabled, the formItem will behave in a disabled manner regardless of the setting of
the item.disabled property. Note that not all items can be disabled, and not all browsers show an obvious disabled style for native form elements.
setDisabled(java.lang.Boolean),
Appearance overview and related methods,
Enable & Disable Examplepublic void setDisableIconsOnReadOnly(java.lang.Boolean disableIconsOnReadOnly)
canEdit is set to false, should icons be disabled by default? This may also be specified
at the icon level. See disableOnReadOnly.
disableIconsOnReadOnly - Default value is truepublic java.lang.Boolean getDisableIconsOnReadOnly()
canEdit is set to false, should icons be disabled by default? This may also be specified
at the icon level. See disableOnReadOnly.
public void setDisplayField(java.lang.String displayField)
The display field can be
either another field value in the same record or a field that must be retrieved from a related optionDataSource.
If this item is not
databound (optionDataSource is unset), or
bound to the same dataSource as the form as a whole, this item will call form.getValue() the form named after is implemented by picking
up the value of the specified field from the Form's values object.
Otherwise this item will attempt to map its
underlying value to a display value by retrieving a record from the optionDataSource where the valueField matches this item's value, and displaying the
displayField value from that record. Note that if optionDataSource is set and this value is
not set, FormItem.getDisplayFieldName()
will return the dataSource title field by default.
This essentially enables the specified
optionDataSource to be used as a server based valueMap.
displayField - Default value is nullinvalidateDisplayValueCache()public java.lang.String getDisplayField()
The display field can be
either another field value in the same record or a field that must be retrieved from a related optionDataSource.
If this item is not
databound (optionDataSource is unset), or
bound to the same dataSource as the form as a whole, this item will call form.getValue() the form named after is implemented by picking
up the value of the specified field from the Form's values object.
Otherwise this item will attempt to map its
underlying value to a display value by retrieving a record from the optionDataSource where the valueField matches this item's value, and displaying the
displayField value from that record. Note that if optionDataSource is set and this value is
not set, FormItem.getDisplayFieldName()
will return the dataSource title field by default.
This essentially enables the specified
optionDataSource to be used as a server based valueMap.
displayField for this item. This will typically be specified explicitly via the displayField attribute. However, if that property is
unset, and the valueField for this item is
hidden in the optionDataSource, this method
will return the title field for the optionDataSource.invalidateDisplayValueCache()public void setEditPendingCSSText(java.lang.String editPendingCSSText)
Note : This is an advanced setting
editPendingCSSText - Default value is "color:#0066CC;"Appearance overview and related methodspublic java.lang.String getEditPendingCSSText()
Appearance overview and related methodspublic void setEmptyDisplayValue(java.lang.String emptyDisplayValue)
If the formItem has a databound pickList, and its
displayField or valueField (if the former isn't set) has an undefined
emptyCellValue setting, that field's
emptyCellValue will automatically be set to the emptyDisplayValue.
emptyDisplayValue - Default value is ""public java.lang.String getEmptyDisplayValue()
If the formItem has a databound pickList, and its
displayField or valueField (if the former isn't set) has an undefined
emptyCellValue setting, that field's
emptyCellValue will automatically be set to the emptyDisplayValue.
public void setEmptyValueIcon(java.lang.String emptyValueIcon)
valueIcons)emptyValueIcon - Default value is nullpublic java.lang.String getEmptyValueIcon()
valueIcons)public void setEndRow(java.lang.Boolean endRow)
endRow - Default value is falseFormLayout overview and related methodspublic java.lang.Boolean getEndRow()
FormLayout overview and related methodspublic void setErrorIconHeight(int errorIconHeight)
errorIconHeight - Default value is 16setShowErrorIcon(java.lang.Boolean)public int getErrorIconHeight()
getShowErrorIcon()public void setErrorIconSrc(java.lang.String errorIconSrc)
errorIconSrc - See SCImgURL . Default value is "[SKIN]/DynamicForm/validation_error_icon.png"setShowErrorIcon(java.lang.Boolean)public java.lang.String getErrorIconSrc()
SCImgURLgetShowErrorIcon()public void setErrorIconWidth(int errorIconWidth)
errorIconWidth - Default value is 16setShowErrorIcon(java.lang.Boolean)public int getErrorIconWidth()
getShowErrorIcon()public void setErrorMessageWidth(int errorMessageWidth)
showInlineErrors and showErrorText are both true and errorOrientation is "left" or "right",
errorMessageWidth is the amount to reduce the width of the editor to accommodate the error message and icon.errorMessageWidth - Default value is 80Validation overview and related methodspublic int getErrorMessageWidth()
showInlineErrors and showErrorText are both true and errorOrientation is "left" or "right",
errorMessageWidth is the amount to reduce the width of the editor to accommodate the error message and icon.Validation overview and related methodspublic void setExportFormat(java.lang.String exportFormat)
FormatString used during exports for numeric or date formatting. See exportFormat.exportFormat - See FormatString . Default value is nullExportFormatting overview and related methodspublic java.lang.String getExportFormat()
FormatString used during exports for numeric or date formatting. See exportFormat.FormatStringExportFormatting overview and related methodspublic void setFetchMissingValues(java.lang.Boolean fetchMissingValues)
optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record. The
fetch occurs if the item value is non null on initial draw of the form or whenever setValue() is called. Once the fetch
completes, the returned record is available via the FormItem.getSelectedRecord() api.
By default, a
fetch will only occur if displayField is
specified, and the item does not have an explicit valueMap containing the data value as a key.
However you can also set alwaysFetchMissingValues to have a fetch
occur even if no displayField is specified. This ensures FormItem.getSelectedRecord() will return a record if
possible - useful for custom formatter functions, etc.
Note - for efficiency we cache the associated record once a
fetch has been performed, meaning if the value changes, then reverts to a previously seen value, we do not kick off an
additional fetch to pick up the display value for the previously seen data value. If necessary this cache may be
explicitly invalidated via a call to FormItem.invalidateDisplayValueCache()
Note : This is an advanced setting
fetchMissingValues - Default value is truesetOptionDataSource(com.smartgwt.client.data.DataSource),
getSelectedRecord(),
setFilterLocally(java.lang.Boolean)public java.lang.Boolean getFetchMissingValues()
optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record. The
fetch occurs if the item value is non null on initial draw of the form or whenever setValue() is called. Once the fetch
completes, the returned record is available via the FormItem.getSelectedRecord() api.
By default, a
fetch will only occur if displayField is
specified, and the item does not have an explicit valueMap containing the data value as a key.
However you can also set alwaysFetchMissingValues to have a fetch
occur even if no displayField is specified. This ensures FormItem.getSelectedRecord() will return a record if
possible - useful for custom formatter functions, etc.
Note - for efficiency we cache the associated record once a
fetch has been performed, meaning if the value changes, then reverts to a previously seen value, we do not kick off an
additional fetch to pick up the display value for the previously seen data value. If necessary this cache may be
explicitly invalidated via a call to FormItem.invalidateDisplayValueCache()
com.smartgwt.client.widgets.form.fields.FormItem#getOptionDataSource,
getSelectedRecord(),
getFilterLocally()public void setFilterLocally(java.lang.Boolean filterLocally)
optionDataSource, displayField and fetchMissingValues), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value. This avoids the need to perform fetches each
time setValue() is called with a new value. See also filterLocally for behavior on form items such as SelectItems that show pick-lists.
Note : This is an advanced setting
filterLocally - Default value is nullpublic java.lang.Boolean getFilterLocally()
optionDataSource, displayField and fetchMissingValues), setting this property to
true ensures that when the form item value is set, entire data-set from the dataSource is loaded at once and used as a
valueMap, rather than just loading the display value for the current value. This avoids the need to perform fetches each
time setValue() is called with a new value. See also filterLocally for behavior on form items such as SelectItems that show pick-lists.
public void setFormat(java.lang.String format)
FormatString for numeric or date formatting. See format.format - See FormatString . Default value is nullAppearance overview and related methodspublic java.lang.String getFormat()
FormatString for numeric or date formatting. See format.FormatStringAppearance overview and related methodspublic void setGlobalTabIndex(java.lang.Integer globalTabIndex)
item.tabIndex. Use of this API is extremely advanced and essentially implies taking over management of tab index assignment for all components on the page.
Note : This is an advanced setting
globalTabIndex - Default value is nullFocus overview and related methodspublic java.lang.Integer getGlobalTabIndex()
item.tabIndex. Use of this API is extremely advanced and essentially implies taking over management of tab index assignment for all components on the page.
Focus overview and related methodspublic void setHeight(int height)
FormLayout overview for details. If height is specified as a String, getHeight() will return -1. Use +sgwtLink{getHeightAsString()} in this case.
For form items having a picker icon (e.g. SelectItem, ComboBoxItem) and
SpinnerItems, if spriting is
enabled, it is not recommended to change the height of the form item from the default because the image sprites are set
up assuming a specific, fixed height of the item. If the item height must be changed, then the pickerIconStyle should be changed to a custom CSS
style name. Or, in the case of SpinnerItems, the baseStyle and src of the increaseIcon and decreaseIcon AutoChildren should be customized.
height - Default value is -1FormLayout overview and related methods,
Filling Examplepublic int getHeight()
FormLayout overview for details. If height is specified as a String, getHeight() will return -1. Use +sgwtLink{getHeightAsString()} in this case.
For form items having a picker icon (e.g. SelectItem, ComboBoxItem) and
SpinnerItems, if spriting is
enabled, it is not recommended to change the height of the form item from the default because the image sprites are set
up assuming a specific, fixed height of the item. If the item height must be changed, then the pickerIconStyle should be changed to a custom CSS
style name. Or, in the case of SpinnerItems, the baseStyle and src of the increaseIcon and decreaseIcon AutoChildren should be customized.
FormLayout overview and related methods,
Filling Examplepublic void setHeight(java.lang.String height)
FormLayout overview for details. If height is specified as a String, getHeight() will return -1. Use +sgwtLink{getHeightAsString()} in this case.
For form items having a picker icon (e.g. SelectItem, ComboBoxItem) and
SpinnerItems, if spriting is
enabled, it is not recommended to change the height of the form item from the default because the image sprites are set
up assuming a specific, fixed height of the item. If the item height must be changed, then the pickerIconStyle should be changed to a custom CSS
style name. Or, in the case of SpinnerItems, the baseStyle and src of the increaseIcon and decreaseIcon AutoChildren should be customized.
height - Default value is -1FormLayout overview and related methods,
Filling Examplepublic java.lang.String getHeightAsString()
FormLayout overview for details. If height is specified as a String, getHeight() will return -1. Use +sgwtLink{getHeightAsString()} in this case.
For form items having a picker icon (e.g. SelectItem, ComboBoxItem) and
SpinnerItems, if spriting is
enabled, it is not recommended to change the height of the form item from the default because the image sprites are set
up assuming a specific, fixed height of the item. If the item height must be changed, then the pickerIconStyle should be changed to a custom CSS
style name. Or, in the case of SpinnerItems, the baseStyle and src of the increaseIcon and decreaseIcon AutoChildren should be customized.
FormLayout overview and related methods,
Filling Examplepublic void setHint(java.lang.String hint)
hint - new hint for the item See HTMLString . Default value is nullsetHintStyle(java.lang.String),
Appearance overview and related methods,
Hints Examplepublic java.lang.String getHint()
HTMLStringgetHintStyle(),
Appearance overview and related methods,
Hints Examplepublic void setHintStyle(java.lang.String hintStyle)
hintStyle - new style for hint text. Default value is "formHint"setHint(java.lang.String),
Appearance overview and related methodspublic java.lang.String getHintStyle()
getHint(),
Appearance overview and related methodspublic void setHoverAlign(Alignment hoverAlign)
hoverAlign - Default value is nullDynamicForm.setItemHoverAlign(com.smartgwt.client.types.Alignment)public Alignment getHoverAlign()
DynamicForm.getItemHoverAlign()public void setHoverDelay(java.lang.Integer hoverDelay)
this.form.itemHoverDelay will be used instead.
Note : This is an advanced setting
hoverDelay - Default value is nullpublic java.lang.Integer getHoverDelay()
this.form.itemHoverDelay will be used instead.public void setHoverHeight(java.lang.Integer hoverHeight)
hoverHeight - Default value is nullDynamicForm.setItemHoverHeight(java.lang.Integer)public java.lang.Integer getHoverHeight()
DynamicForm.getItemHoverHeight()public void setHoverOpacity(java.lang.Integer hoverOpacity)
hoverOpacity - Default value is nullDynamicForm.setItemHoverOpacity(java.lang.Integer)public java.lang.Integer getHoverOpacity()
DynamicForm.getItemHoverOpacity()public void setHoverStyle(java.lang.String hoverStyle)
hoverStyle - See CSSStyleName . Default value is nullDynamicForm.setItemHoverStyle(java.lang.String)public java.lang.String getHoverStyle()
CSSStyleNameDynamicForm.getItemHoverStyle()public void setHoverVAlign(VerticalAlignment hoverVAlign)
hoverVAlign - Default value is nullDynamicForm.setItemHoverVAlign(java.lang.Integer)public VerticalAlignment getHoverVAlign()
DynamicForm.getItemHoverVAlign()public void setHoverWidth(java.lang.Integer hoverWidth)
hoverWidth - Default value is nullDynamicForm.setItemHoverWidth(java.lang.Integer)public java.lang.Integer getHoverWidth()
DynamicForm.getItemHoverWidth()public void setIconHeight(int iconHeight)
Note : This is an advanced setting
iconHeight - Default value is 20public int getIconHeight()
public void setIconHSpace(java.lang.Integer iconHSpace)
hspace.iconHSpace - Default value is 3public java.lang.Integer getIconHSpace()
hspace.public void setIconPrompt(java.lang.String iconPrompt)
Note : This is an advanced setting
iconPrompt - Default value is ""public java.lang.String getIconPrompt()
public void setIcons(FormItemIcon... icons)
icons - Default value is nullFormItemIcon,
Icons Examplepublic void setIconVAlign(VerticalAlignment iconVAlign)
Note : This is an advanced setting
iconVAlign - Default value is "bottom"public VerticalAlignment getIconVAlign()
public void setIconWidth(int iconWidth)
Note : This is an advanced setting
iconWidth - Default value is 20public int getIconWidth()
public void setImageURLPrefix(java.lang.String imageURLPrefix)
valueIcons when determining the URL for the image. Will not be applied if the valueIcon URL is absolute.
Note : This is an advanced setting
imageURLPrefix - Default value is nullpublic java.lang.String getImageURLPrefix()
valueIcons when determining the URL for the image. Will not be applied if the valueIcon URL is absolute.public void setImageURLSuffix(java.lang.String imageURLSuffix)
valueIcons when
determining the URL for the image. A common usage would be to specify a suffix of ".gif" in which case the
valueIcons property would map values to the names of images without the ".gif" extension.
Note : This is an advanced setting
imageURLSuffix - Default value is nullpublic java.lang.String getImageURLSuffix()
valueIcons when
determining the URL for the image. A common usage would be to specify a suffix of ".gif" in which case the
valueIcons property would map values to the names of images without the ".gif" extension.public void setImplicitSave(java.lang.Boolean implicitSave)
delay, as well as when the entire form is submitted.
Unless implicitSaveOnBlur is set to false on either this formItem or it's form changes will also be automatically saved on
editorExit.implicitSave - Default value is falsepublic java.lang.Boolean getImplicitSave()
delay, as well as when the entire form is submitted.
Unless implicitSaveOnBlur is set to false on either this formItem or it's form changes will also be automatically saved on
editorExit.public void setImplicitSaveOnBlur(java.lang.Boolean implicitSaveOnBlur)
implicitSaveOnBlur - Default value is falsepublic java.lang.Boolean getImplicitSaveOnBlur()
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.
Note : This is an advanced setting
inputFormat - See DateInputFormat . Default value is nullsetDateFormatter(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.DateInputFormatgetDateFormatter()public void setLeft(int left)
itemLayout:"absolute".
itemLayout:"absolute" only, set the left coordinate of this form item. Causes the form to redraw.
Note : This is an advanced setting
left - Default value is 0public int getLeft()
itemLayout:"absolute".public void setLoadingDisplayValue(java.lang.String loadingDisplayValue)
fetchMissingValues is active and a fetch is pending. The field is also read-only while fetch is pending. Set to
null to show actual value until display value is loaded.
loadingDisplayValue - Default value is "Loading..."public java.lang.String getLoadingDisplayValue()
fetchMissingValues is active and a fetch is pending. The field is also read-only while fetch is pending. Set to
null to show actual value until display value is loaded.
public void setLocateItemBy(java.lang.String locateItemBy)
AutoTest.getElement() is used to parse locator strings
generated by link{isc.AutoTest.getLocator()} for this form item, should the item be identified? By default if the item
has a name this will always be used, however for items with no name, the following options are available: "title" use the title as an identifier within this form"value" use the value of
the item to identify it (often used for items with a static defaultValue such as HeaderItems"index" use the index within the form's items array. Note : This is an advanced setting
locateItemBy - Default value is nullpublic java.lang.String getLocateItemBy()
AutoTest.getElement() is used to parse locator strings
generated by link{isc.AutoTest.getLocator()} for this form item, should the item be identified? By default if the item
has a name this will always be used, however for items with no name, the following options are available: "title" use the title as an identifier within this form"value" use the value of
the item to identify it (often used for items with a static defaultValue such as HeaderItems"index" use the index within the form's items array. public void setMultipleValueSeparator(java.lang.String multipleValueSeparator)
multipleValueSeparator - Default value is ', 'public java.lang.String getMultipleValueSeparator()
public void setOperator(OperatorId operator)
OperatorId to be used when DynamicForm.getValuesAsCriteria() is called.
item.operator can be used to create a form that offers search functions such as numeric range filtering,
without the more advanced user interface of the FilterBuilder. For example,
two SpinnerItems could be created with formItem.operator set to "greaterThan" and "lessThan" respectively
to enable filtering by a numeric range.
When item.operator is set for any FormItem in a form,
form.getValuesAsCriteria() will return an AdvancedCriteria object instead
of a normal Criteria object. Each FormItem will produce one Criterion affecting the DataSource field specified by criteriaField. The criteria produced by the FormItems
will be grouped under the logical operator provided by operator.
If operator is set for some fields but not others, the default operator is "equals" for
fields with a valueMap or an optionDataSource, and for fields of type "enum" (or of a type that inherits from "enum").
The default operator for all other fields is controlled by defaultSearchOperator.
Note:
formItem.operator is only supported for a form that has a dataSource. In a form with no DataSource, setting
formItem.operator will have no effect.
operator - Default value is nullCriteriaEditing overview and related methodspublic OperatorId getOperator()
OperatorId to be used when DynamicForm.getValuesAsCriteria() is called.
item.operator can be used to create a form that offers search functions such as numeric range filtering,
without the more advanced user interface of the FilterBuilder. For example,
two SpinnerItems could be created with formItem.operator set to "greaterThan" and "lessThan" respectively
to enable filtering by a numeric range.
When item.operator is set for any FormItem in a form,
form.getValuesAsCriteria() will return an AdvancedCriteria object instead
of a normal Criteria object. Each FormItem will produce one Criterion affecting the DataSource field specified by criteriaField. The criteria produced by the FormItems
will be grouped under the logical operator provided by operator.
If operator is set for some fields but not others, the default operator is "equals" for
fields with a valueMap or an optionDataSource, and for fields of type "enum" (or of a type that inherits from "enum").
The default operator for all other fields is controlled by defaultSearchOperator.
Note:
formItem.operator is only supported for a form that has a dataSource. In a form with no DataSource, setting
formItem.operator will have no effect.
CriteriaEditing overview and related methodspublic void setOptionOperationId(java.lang.String optionOperationId)
optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to
pick up display value mapping.
Note : This is an advanced setting
optionOperationId - Default value is nullpublic java.lang.String getOptionOperationId()
optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to
pick up display value mapping.public Canvas getPicker()
FormItem.showPicker() is called due to a click on the picker icon. Can be specified directly as a
Canvas, or created automatically via the com.smartgwt.client.types.AutoChild pattern.
Note that the picker
is not automatically destroyed with the FormItem that uses it, in order to allow recycling of picker components. To
destroy a single-use picker, override Canvas.destroy().
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
public void setPickerIconHeight(java.lang.Integer pickerIconHeight)
showPickerIcon is true for this item, this
property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconHeight from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconHeight must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
Note : This is an advanced setting
pickerIconHeight - Default value is nullpublic java.lang.Integer getPickerIconHeight()
showPickerIcon is true for this item, this
property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconHeight from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconHeight must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
public void setPickerIconName(java.lang.String pickerIconName)
showPickerIcon is true, this attribute
specifies the name applied to the picker icon
Note : This is an advanced setting
pickerIconName - Default value is "picker"public java.lang.String getPickerIconName()
showPickerIcon is true, this attribute
specifies the name applied to the picker iconpublic void setPickerIconPrompt(java.lang.String pickerIconPrompt)
pickerIconPrompt - See HTMLString . Default value is nullpublic java.lang.String getPickerIconPrompt()
HTMLStringpublic void setPickerIconProperties(FormItemIcon pickerIconProperties)
showPickerIcon is true for this item, this
block of properties will be applied to the pickerIcon. Allows for advanced customization of this icon.
Note : This is an advanced setting
pickerIconProperties - Default value is nullpublic FormItemIcon getPickerIconProperties()
showPickerIcon is true for this item, this
block of properties will be applied to the pickerIcon. Allows for advanced customization of this icon.public void setPickerIconSrc(java.lang.String pickerIconSrc)
showPickerIcon is true for this item, this
property governs the src of the picker icon image to
be displayed.
Note : This is an advanced setting
pickerIconSrc - See SCImgURL . Default value is ""public java.lang.String getPickerIconSrc()
showPickerIcon is true for this item, this
property governs the src of the picker icon image to
be displayed.SCImgURLpublic void setPickerIconStyle(java.lang.String pickerIconStyle)
controlStyle.pickerIconStyle - See FormItemBaseStyle . Default value is nullsetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getPickerIconStyle()
controlStyle.FormItemBaseStylegetCellStyle(),
Appearance overview and related methodspublic void setPickerIconWidth(java.lang.Integer pickerIconWidth)
showPickerIcon is true for this item, this
property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconWidth from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconWidth must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
Note : This is an advanced setting
pickerIconWidth - Default value is nullpublic java.lang.Integer getPickerIconWidth()
showPickerIcon is true for this item, this
property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconWidth from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconWidth must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
public void setPrintTextBoxStyle(java.lang.String printTextBoxStyle)
textBoxStyle will be used instead. Note that focused
styling will never be displayed while printing, though error and disabled styling will.printTextBoxStyle - See FormItemBaseStyle . Default value is nullPrinting overview and related methodspublic java.lang.String getPrintTextBoxStyle()
textBoxStyle will be used instead. Note that focused
styling will never be displayed while printing, though error and disabled styling will.FormItemBaseStylePrinting overview and related methodspublic void setPrintTitleStyle(java.lang.String printTitleStyle)
titleStyle will be used instead.printTitleStyle - See FormItemBaseStyle . Default value is nullPrinting overview and related methodspublic java.lang.String getPrintTitleStyle()
titleStyle will be used instead.FormItemBaseStylePrinting overview and related methodspublic void setPrompt(java.lang.String prompt)
prompt for this itemprompt - new prompt for the item.. Default value is nullBasics overview and related methodspublic java.lang.String getPrompt()
Basics overview and related methodspublic void setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
read-only, how should this item be
displayed to the user? If set, overrides the form-level readOnlyDisplay default.
readOnlyDisplay.readOnlyDisplay - new readOnlyDisplay value.. Default value is nullDynamicForm.setReadOnlyDisplay(com.smartgwt.client.types.ReadOnlyDisplayAppearance)public ReadOnlyDisplayAppearance getReadOnlyDisplay()
read-only, how should this item be
displayed to the user? If set, overrides the form-level readOnlyDisplay default.DynamicForm.getReadOnlyDisplay()public void setReadOnlyTextBoxStyle(java.lang.String readOnlyTextBoxStyle)
read-only and is using readOnlyDisplay
ReadOnlyDisplayAppearance.STATIC. If set, overrides the form-level readOnlyTextBoxStyle default.readOnlyTextBoxStyle - See FormItemBaseStyle . Default value is nullDynamicForm.setReadOnlyTextBoxStyle(java.lang.String)public java.lang.String getReadOnlyTextBoxStyle()
read-only and is using readOnlyDisplay
ReadOnlyDisplayAppearance.STATIC. If set, overrides the form-level readOnlyTextBoxStyle default.FormItemBaseStyleDynamicForm.getReadOnlyTextBoxStyle()public void setRedrawOnChange(java.lang.Boolean redrawOnChange)
redrawOnChange - Default value is falsepublic java.lang.Boolean getRedrawOnChange()
public void setRejectInvalidValueOnChange(java.lang.Boolean rejectInvalidValueOnChange)
Note : This is an advanced setting
rejectInvalidValueOnChange - Default value is falsepublic java.lang.Boolean getRejectInvalidValueOnChange()
public void setRequired(java.lang.Boolean required)
If the user does not fill in the required
field, the error message to be shown will be taken from these properties in the following order: requiredMessage, requiredMessage, requiredMessage, requiredField.
Note: if specified on a
FormItem, required is only enforced on the client. required should generally be specified on
a DataSourceField.
If this method is called after the component has been drawn/initialized:
Setter to mark this formItem as required, or not required at runtime. Note that an alternative approach to updating the required flag directly would be to simply use a requiredIf type validator.
Note that this method will not re-validate this item by default or clear any existing validation errors. If desired, this may be achieved by calling FormItem.validate() or DynamicForm.clearErrors().
required - new required value.. Default value is nullValidation overview and related methods,
Show & Hide Examplepublic java.lang.Boolean getRequired()
If the user does not fill in the required
field, the error message to be shown will be taken from these properties in the following order: requiredMessage, requiredMessage, requiredMessage, requiredField.
Note: if specified on a
FormItem, required is only enforced on the client. required should generally be specified on
a DataSourceField.
Validation overview and related methods,
Show & Hide Examplepublic void setRequiredMessage(java.lang.String requiredMessage)
requiredMessage - Default value is nullValidation overview and related methodspublic java.lang.String getRequiredMessage()
Validation overview and related methodspublic void setRowSpan(int rowSpan)
rowSpan - Default value is 1FormLayout overview and related methodspublic int getRowSpan()
FormLayout overview and related methodspublic void setSaveOnEnter(java.lang.Boolean saveOnEnter)
saveOnEnter is true on the parent form.saveOnEnter - Default value is nullpublic java.lang.Boolean getSaveOnEnter()
saveOnEnter is true on the parent form.public void setSelectOnClick(java.lang.Boolean selectOnClick)
selectOnClick behavior to be configured
on a per-FormItem basis. Normally all items in a form default to the value of selectOnClick.selectOnClick - Default value is nullFocus overview and related methodspublic java.lang.Boolean getSelectOnClick()
selectOnClick behavior to be configured
on a per-FormItem basis. Normally all items in a form default to the value of selectOnClick.Focus overview and related methodspublic void setSelectOnFocus(java.lang.Boolean selectOnFocus)
selectOnFocus behavior to be configured
on a per-FormItem basis. Normally all items in a form default to the value of selectOnFocus.selectOnFocus - Default value is nullFocus overview and related methodspublic java.lang.Boolean getSelectOnFocus()
selectOnFocus behavior to be configured
on a per-FormItem basis. Normally all items in a form default to the value of selectOnFocus.Focus overview and related methodspublic void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
form.getValues()? shouldSaveValue:false is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false item should
be given a value either via defaultValue or by
calling form.setValue(item, value) or formItem.setValue(value). Providing a value via form.values or form.setValues() will automatically switch the item to
shouldSaveValue:true.
Note that
shouldSaveValue - Default value is truepublic java.lang.Boolean getShouldSaveValue()
form.getValues()? shouldSaveValue:false is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false item should
be given a value either via defaultValue or by
calling form.setValue(item, value) or formItem.setValue(value). Providing a value via form.values or form.setValues() will automatically switch the item to
shouldSaveValue:true.
Note that
public void setShowClippedTitleOnHover(boolean showClippedTitleOnHover)
A
TitleHoverEvent is fired before the hover is displayed, allowing the hover to be canceled if desired. The
HTML shown in the hover can be customized by setting a FormItemHoverFormatter on either this
FormItem or the DynamicForm. See setItemTitleHoverFormatter().
showClippedTitleOnHover - Default value is truepublic boolean getShowClippedTitleOnHover()
A
TitleHoverEvent is fired before the hover is displayed, allowing the hover to be canceled if desired. The
HTML shown in the hover can be customized by setting a FormItemHoverFormatter on either this
FormItem or the DynamicForm. See setItemTitleHoverFormatter().
public void setShowClippedValueOnHover(java.lang.Boolean showClippedValueOnHover)
A
ValueHoverEvent is fired before the hover is displayed, allowing the hover to be canceled if desired. The
HTML shown in the hover can be customized by setting a FormItemHoverFormatter on either this
FormItem or the DynamicForm. See setItemValueHoverFormatter().
showClippedValueOnHover - Default value is truepublic java.lang.Boolean getShowClippedValueOnHover()
A
ValueHoverEvent is fired before the hover is displayed, allowing the hover to be canceled if desired. The
HTML shown in the hover can be customized by setting a FormItemHoverFormatter on either this
FormItem or the DynamicForm. See setItemValueHoverFormatter().
public void setShowDisabled(java.lang.Boolean showDisabled)
showDisabled
Note : This is an advanced setting
showDisabled - new showDisabled setting. Default value is truesetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.Boolean getShowDisabled()
getCellStyle(),
Appearance overview and related methodspublic void setShowErrorIcon(java.lang.Boolean showErrorIcon)
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). To
instead display all errors at the top of the form, set showInlineErrors:false.
showErrorIcons, showErrorText and showErrorStyle are all boolean properties, and
can be set on a DynamicForm to control the behavior form-wide, or set on individual FormItems.
The HTML displayed
next to a form item with errors is generated by FormItem.getErrorHTML(). The default implementation of that method respects showErrorIcons and
showErrorText as follows:
showErrorIcons, or showErrorIcon at the FormItem
level controls whether an error icon should appear next to fields which have validation errors. The icon's appearance
is governed by errorIconSrc, errorIconWidth and errorIconHeight
showErrorText
determines whether the text of the validation error should be displayed next to fields which have validation errors. The
attribute showTitlesWithErrorMessages may be set to prefix error messages with the form item's title + ":" (may be
desired if the item has showTitle set to false).
errorOrientation controls where the error
HTML should appear relative to form items. Therefore the combination of showErrorText:false and errorOrientation:"left" creates a
compact validation error display consisting of just an icon, to the left of the item with the error message available
via a hover (similar appearance to ListGrid validation error display).
In addition to this,
showErrorStyle determines whether fields with validation errors should have special styling applied to
them. See FormItemBaseStyle for a discussion for how error styling is calculated.
showErrorIcon - Default value is nullAppearance overview and related methodspublic java.lang.Boolean getShowErrorIcon()
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). To
instead display all errors at the top of the form, set showInlineErrors:false.
showErrorIcons, showErrorText and showErrorStyle are all boolean properties, and
can be set on a DynamicForm to control the behavior form-wide, or set on individual FormItems.
The HTML displayed
next to a form item with errors is generated by FormItem.getErrorHTML(). The default implementation of that method respects showErrorIcons and
showErrorText as follows:
showErrorIcons, or showErrorIcon at the FormItem
level controls whether an error icon should appear next to fields which have validation errors. The icon's appearance
is governed by errorIconSrc, errorIconWidth and errorIconHeight
showErrorText
determines whether the text of the validation error should be displayed next to fields which have validation errors. The
attribute showTitlesWithErrorMessages may be set to prefix error messages with the form item's title + ":" (may be
desired if the item has showTitle set to false).
errorOrientation controls where the error
HTML should appear relative to form items. Therefore the combination of showErrorText:false and errorOrientation:"left" creates a
compact validation error display consisting of just an icon, to the left of the item with the error message available
via a hover (similar appearance to ListGrid validation error display).
In addition to this,
showErrorStyle determines whether fields with validation errors should have special styling applied to
them. See FormItemBaseStyle for a discussion for how error styling is calculated.
Appearance overview and related methodspublic void setShowErrorStyle(java.lang.Boolean showErrorStyle)
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). To
instead display all errors at the top of the form, set showInlineErrors:false.
showErrorIcons, showErrorText and showErrorStyle are all boolean properties, and
can be set on a DynamicForm to control the behavior form-wide, or set on individual FormItems.
The HTML displayed
next to a form item with errors is generated by FormItem.getErrorHTML(). The default implementation of that method respects showErrorIcons and
showErrorText as follows:
showErrorIcons, or showErrorIcon at the FormItem
level controls whether an error icon should appear next to fields which have validation errors. The icon's appearance
is governed by errorIconSrc, errorIconWidth and errorIconHeight
showErrorText
determines whether the text of the validation error should be displayed next to fields which have validation errors. The
attribute showTitlesWithErrorMessages may be set to prefix error messages with the form item's title + ":" (may be
desired if the item has showTitle set to false).
errorOrientation controls where the error
HTML should appear relative to form items. Therefore the combination of showErrorText:false and errorOrientation:"left" creates a
compact validation error display consisting of just an icon, to the left of the item with the error message available
via a hover (similar appearance to ListGrid validation error display).
In addition to this,
showErrorStyle determines whether fields with validation errors should have special styling applied to
them. See FormItemBaseStyle for a discussion for how error styling is calculated.
showErrorStyle - Default value is nullsetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.Boolean getShowErrorStyle()
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). To
instead display all errors at the top of the form, set showInlineErrors:false.
showErrorIcons, showErrorText and showErrorStyle are all boolean properties, and
can be set on a DynamicForm to control the behavior form-wide, or set on individual FormItems.
The HTML displayed
next to a form item with errors is generated by FormItem.getErrorHTML(). The default implementation of that method respects showErrorIcons and
showErrorText as follows:
showErrorIcons, or showErrorIcon at the FormItem
level controls whether an error icon should appear next to fields which have validation errors. The icon's appearance
is governed by errorIconSrc, errorIconWidth and errorIconHeight
showErrorText
determines whether the text of the validation error should be displayed next to fields which have validation errors. The
attribute showTitlesWithErrorMessages may be set to prefix error messages with the form item's title + ":" (may be
desired if the item has showTitle set to false).
errorOrientation controls where the error
HTML should appear relative to form items. Therefore the combination of showErrorText:false and errorOrientation:"left" creates a
compact validation error display consisting of just an icon, to the left of the item with the error message available
via a hover (similar appearance to ListGrid validation error display).
In addition to this,
showErrorStyle determines whether fields with validation errors should have special styling applied to
them. See FormItemBaseStyle for a discussion for how error styling is calculated.
getCellStyle(),
Appearance overview and related methodspublic void setShowErrorText(java.lang.Boolean showErrorText)
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). To
instead display all errors at the top of the form, set showInlineErrors:false.
showErrorIcons, showErrorText and showErrorStyle are all boolean properties, and
can be set on a DynamicForm to control the behavior form-wide, or set on individual FormItems.
The HTML displayed
next to a form item with errors is generated by FormItem.getErrorHTML(). The default implementation of that method respects showErrorIcons and
showErrorText as follows:
showErrorIcons, or showErrorIcon at the FormItem
level controls whether an error icon should appear next to fields which have validation errors. The icon's appearance
is governed by errorIconSrc, errorIconWidth and errorIconHeight
showErrorText
determines whether the text of the validation error should be displayed next to fields which have validation errors. The
attribute showTitlesWithErrorMessages may be set to prefix error messages with the form item's title + ":" (may be
desired if the item has showTitle set to false).
errorOrientation controls where the error
HTML should appear relative to form items. Therefore the combination of showErrorText:false and errorOrientation:"left" creates a
compact validation error display consisting of just an icon, to the left of the item with the error message available
via a hover (similar appearance to ListGrid validation error display).
In addition to this,
showErrorStyle determines whether fields with validation errors should have special styling applied to
them. See FormItemBaseStyle for a discussion for how error styling is calculated.
showErrorText - Default value is nullAppearance overview and related methodspublic java.lang.Boolean getShowErrorText()
showErrorIcons, showErrorText, and showErrorStyle control how validation errors are
displayed when they are displayed inline in the form (next to the form item where there is a validation error). To
instead display all errors at the top of the form, set showInlineErrors:false.
showErrorIcons, showErrorText and showErrorStyle are all boolean properties, and
can be set on a DynamicForm to control the behavior form-wide, or set on individual FormItems.
The HTML displayed
next to a form item with errors is generated by FormItem.getErrorHTML(). The default implementation of that method respects showErrorIcons and
showErrorText as follows:
showErrorIcons, or showErrorIcon at the FormItem
level controls whether an error icon should appear next to fields which have validation errors. The icon's appearance
is governed by errorIconSrc, errorIconWidth and errorIconHeight
showErrorText
determines whether the text of the validation error should be displayed next to fields which have validation errors. The
attribute showTitlesWithErrorMessages may be set to prefix error messages with the form item's title + ":" (may be
desired if the item has showTitle set to false).
errorOrientation controls where the error
HTML should appear relative to form items. Therefore the combination of showErrorText:false and errorOrientation:"left" creates a
compact validation error display consisting of just an icon, to the left of the item with the error message available
via a hover (similar appearance to ListGrid validation error display).
In addition to this,
showErrorStyle determines whether fields with validation errors should have special styling applied to
them. See FormItemBaseStyle for a discussion for how error styling is calculated.
Appearance overview and related methodspublic void setShowFocused(java.lang.Boolean showFocused)
Note : This is an advanced setting
showFocused - Default value is falsesetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.Boolean getShowFocused()
getCellStyle(),
Appearance overview and related methodspublic void setShowFocusedErrorState(java.lang.Boolean showFocusedErrorState)
Note : This is an advanced setting
showFocusedErrorState - Default value is falsesetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.Boolean getShowFocusedErrorState()
getCellStyle(),
Appearance overview and related methodspublic void setShowFocusedIcons(java.lang.Boolean showFocusedIcons)
showFocused property.
Note : This is an advanced setting
showFocusedIcons - Default value is nullpublic java.lang.Boolean getShowFocusedIcons()
showFocused property.public void setShowFocusedPickerIcon(java.lang.Boolean showFocusedPickerIcon)
showPickerIcon is true for this item,
should the picker icon show a focused image when the form item has focus?showFocusedPickerIcon - Default value is falsepublic java.lang.Boolean getShowFocusedPickerIcon()
showPickerIcon is true for this item,
should the picker icon show a focused image when the form item has focus?public void setShowHint(java.lang.Boolean showHint)
Note : This is an advanced setting
showHint - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowHint()
Appearance overview and related methodspublic void setShowIcons(java.lang.Boolean showIcons)
icons for
this item.
Note : This is an advanced setting
showIcons - Default value is truepublic java.lang.Boolean getShowIcons()
icons for
this item.public void setShowOverIcons(java.lang.Boolean showOverIcons)
showOver
property.
Note : This is an advanced setting
showOverIcons - Default value is nullpublic java.lang.Boolean getShowOverIcons()
showOver
property.public void setShowPickerIcon(java.lang.Boolean showPickerIcon)
icon for this form item?
Picker icons are customizable via pickerIconProperties. By default they will be rendered inside the form item's "control box" area, and will call FormItem.showPicker() when clicked.showPickerIcon - Default value is nullpublic java.lang.Boolean getShowPickerIcon()
icon for this form item?
Picker icons are customizable via pickerIconProperties. By default they will be rendered inside the form item's "control box" area, and will call FormItem.showPicker() when clicked.public void setShowRTL(boolean showRTL)
Note : This is an advanced setting
showRTL - Default value is falsesetCellStyle(java.lang.String),
Appearance overview and related methodspublic boolean getShowRTL()
getCellStyle(),
Appearance overview and related methodspublic void setShowTitle(java.lang.Boolean showTitle)
Note: the default value of this attribute is overridden by some subclasses.
showTitle - Default value is truepublic java.lang.Boolean getShowTitle()
Note: the default value of this attribute is overridden by some subclasses.
public void setShowValueIconOnly(java.lang.Boolean showValueIconOnly)
valueIcons is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displaying
Note : This is an advanced setting
showValueIconOnly - Default value is nullpublic java.lang.Boolean getShowValueIconOnly()
valueIcons is set, this property may be set to
show the valueIcon only and prevent the standard form item element or text from displayingpublic void setStartRow(java.lang.Boolean startRow)
startRow - Default value is falseFormLayout overview and related methodspublic java.lang.Boolean getStartRow()
FormLayout overview and related methodspublic void setStopOnError(java.lang.Boolean stopOnError)
This property defaults to stopOnError if unset.
Enabling this property also
implies validateOnExit is automatically
enabled. If there are server-based validators on this item, setting this property also implies that synchronousValidation is forced on.
stopOnError - Default value is nullpublic java.lang.Boolean getStopOnError()
This property defaults to stopOnError if unset.
Enabling this property also
implies validateOnExit is automatically
enabled. If there are server-based validators on this item, setting this property also implies that synchronousValidation is forced on.
public void setSuppressValueIcon(java.lang.Boolean suppressValueIcon)
valueIcons is set, this property may be set to
prevent the value icons from showing up next to the form items value
Note : This is an advanced setting
suppressValueIcon - Default value is nullpublic java.lang.Boolean getSuppressValueIcon()
valueIcons is set, this property may be set to
prevent the value icons from showing up next to the form items valuepublic void setSynchronousValidation(java.lang.Boolean synchronousValidation)
If false, the form will try to avoid blocking user interaction until it is strictly required. That is until the user attempts to use a FormItem whose state could be affected by a server request that has not yet returned.
synchronousValidation - Default value is nullpublic java.lang.Boolean getSynchronousValidation()
If false, the form will try to avoid blocking user interaction until it is strictly required. That is until the user attempts to use a FormItem whose state could be affected by a server request that has not yet returned.
public void setTabIndex(java.lang.Integer tabIndex)
tabIndex is automatically assigned as the order that items
appear in the items list.
To specify the tabindex of
an item within the page as a whole (not just this form), use globalTabIndex instead.
If this method is called after the component has been drawn/initialized:
Setter for tabIndex.
tabIndex - new tabIndex for the item. Default value is nullFocus overview and related methodspublic java.lang.Integer getTabIndex()
tabIndex is automatically assigned as the order that items
appear in the items list.
To specify the tabindex of
an item within the page as a whole (not just this form), use globalTabIndex instead.
Focus overview and related methodspublic void setTextAlign(Alignment textAlign)
align may be used to control alignment of the entire form
item within its cell. textAlign may not apply to all form item types; typically it applies only to items showing a
"textBox", such as a TextItem or SelectItem, as well as text-only form item types such as StaticTextItem and HeaderItem.
If this item has icons, then textAlign will
default to Alignment.LEFT (Alignment.RIGHT in
RTL mode).
textAlign - Default value is nullAppearance overview and related methodspublic Alignment getTextAlign()
align may be used to control alignment of the entire form
item within its cell. textAlign may not apply to all form item types; typically it applies only to items showing a
"textBox", such as a TextItem or SelectItem, as well as text-only form item types such as StaticTextItem and HeaderItem.
If this item has icons, then textAlign will
default to Alignment.LEFT (Alignment.RIGHT in
RTL mode).
Appearance overview and related methodspublic void setTextBoxStyle(java.lang.String textBoxStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
textBoxStyle - See FormItemBaseStyle . Default value is nullsetCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getTextBoxStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
FormItemBaseStylegetCellStyle(),
Appearance overview and related methodspublic void setTimeFormatter(TimeDisplayFormat timeFormatter)
"time" though if no explicit dateFormatter is specified it will be respected for other fields as well. If unspecified, a timeFormatter may be
defined at the component level and will be
respected by fields of type "time".
Note : This is an advanced setting
timeFormatter - Default value is nullsetFormat(java.lang.String),
Appearance overview and related methodspublic TimeDisplayFormat getTimeFormatter()
"time" though if no explicit dateFormatter is specified it will be respected for other fields as well. If unspecified, a timeFormatter may be
defined at the component level and will be
respected by fields of type "time".
getFormat(),
Appearance overview and related methodspublic void setTitle(java.lang.String title)
title - Default value is nullBasics overview and related methodspublic java.lang.String getTitle()
Basics overview and related methodspublic void setTitleAlign(Alignment titleAlign)
If null, dynamically set according to text direction.
titleAlign - Default value is nullpublic Alignment getTitleAlign()
If null, dynamically set according to text direction.
public void setTitleColSpan(int titleColSpan)
This setting only applies for items that are showing a title and
whose TitleOrientation is either "left" or "right".
titleColSpan - Default value is 1FormLayout overview and related methodspublic int getTitleColSpan()
This setting only applies for items that are showing a title and
whose TitleOrientation is either "left" or "right".
FormLayout overview and related methodspublic void setTitleOrientation(TitleOrientation titleOrientation)
TitleOrientation lists valid
options. Note that titles on the left or right take up a cell in tabular form layouts, but titles on top do not.
titleOrientation - Default value is Canvas.LEFTDynamicForm.setTitleOrientation(com.smartgwt.client.types.TitleOrientation)public TitleOrientation getTitleOrientation()
TitleOrientation lists valid
options. Note that titles on the left or right take up a cell in tabular form layouts, but titles on top do not.
DynamicForm.getTitleOrientation()public void setTitleStyle(java.lang.String titleStyle)
FormItemBaseStyle so
will pick up stateful suffixes on focus, disabled state change etc. by default. Note the appearance of the title is
also affected by titlePrefix/titleSuffix and requiredTitlePrefix/requiredTitleSuffix.
titleStyle - See FormItemBaseStyle . Default value is "formTitle"setCellStyle(java.lang.String)public java.lang.String getTitleStyle()
FormItemBaseStyle so
will pick up stateful suffixes on focus, disabled state change etc. by default. Note the appearance of the title is
also affected by titlePrefix/titleSuffix and requiredTitlePrefix/requiredTitleSuffix.
FormItemBaseStylegetCellStyle()public void setTitleVAlign(VerticalAlignment titleVAlign)
titleOrientation is "left" or
"right".titleVAlign - Default value is Canvas.CENTERpublic VerticalAlignment getTitleVAlign()
titleOrientation is "left" or
"right".public void setTop(int top)
itemLayout:"absolute".
itemLayout:"absolute" only, set the top coordinate of this form item. Causes the form to redraw.
Note : This is an advanced setting
top - Default value is 0public int getTop()
itemLayout:"absolute".public void setValidateOnChange(java.lang.Boolean validateOnChange)
Note that this property can also be set at the form level or on each validator; If true at
the form or field level, validators not explicitly set with validateOnChange:false will be fired on change
- displaying errors and rejecting the change on validation failure.
validateOnChange - Default value is falseDynamicForm.setValidateOnChange(java.lang.Boolean)public java.lang.Boolean getValidateOnChange()
Note that this property can also be set at the form level or on each validator; If true at
the form or field level, validators not explicitly set with validateOnChange:false will be fired on change
- displaying errors and rejecting the change on validation failure.
DynamicForm.getValidateOnChange()public void setValidateOnExit(java.lang.Boolean validateOnExit)
Note that this property can also be set at the form level. If true at either level the validator will be fired on editorExit.
validateOnExit - Default value is falseDynamicForm.setValidateOnExit(java.lang.Boolean)public java.lang.Boolean getValidateOnExit()
Note that this property can also be set at the form level. If true at either level the validator will be fired on editorExit.
DynamicForm.getValidateOnExit()public void setValidators(Validator... validators)
Note: these validators will only be run on the client; to do real client-server validation, validators must be specified on the DataSource.
validators - Default value is nullpublic void setValidOperators(OperatorId... validOperators)
Applies only to
form/formItem when allowExpressions is
true, allowing the user to input expressions.
validOperators - Default value is nullpublic OperatorId[] getValidOperators()
Applies only to
form/formItem when allowExpressions is
true, allowing the user to input expressions.
public void setVAlign(VerticalAlignment vAlign)
FormItem.shouldApplyHeightToTextBox() is
true, for this to have a visible effect, the cell height must exceed the specified height of the item, either due to an
explicit cellHeight specification, or due to the
row being expanded by another taller item. Has no effect if itemLayout is set to "absolute" for the form.
vAlign - Default value is Canvas.CENTERpublic VerticalAlignment getVAlign()
FormItem.shouldApplyHeightToTextBox() is
true, for this to have a visible effect, the cell height must exceed the specified height of the item, either due to an
explicit cellHeight specification, or due to the
row being expanded by another taller item. Has no effect if itemLayout is set to "absolute" for the form.
public void setValueField(java.lang.String valueField)
displayField values from an optionDataSource, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name of this form item.valueField - Default value is nullpublic java.lang.String getValueField()
displayField values from an optionDataSource, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name of this form item.valueField for this
item. If unset, default behavior will return the name
of this field.public void setValueIconHeight(java.lang.Integer valueIconHeight)
valueIcons is specified, use this property to
specify a height for the value icon written out.valueIconHeight - Default value is nullsetValueIconWidth(java.lang.Integer),
setValueIconSize(int)public java.lang.Integer getValueIconHeight()
valueIcons is specified, use this property to
specify a height for the value icon written out.getValueIconWidth(),
getValueIconSize()public void setValueIconLeftPadding(int valueIconLeftPadding)
NOTE: In RTL mode, the valueIconLeftPadding is applied to the right of the value icon.
valueIconLeftPadding - Default value is 0setValueIcons(java.util.Map)public int getValueIconLeftPadding()
NOTE: In RTL mode, the valueIconLeftPadding is applied to the right of the value icon.
com.smartgwt.client.widgets.form.fields.FormItem#getValueIconspublic void setValueIconRightPadding(int valueIconRightPadding)
NOTE: In RTL mode, the valueIconRightPadding is applied to the left of the value icon.
valueIconRightPadding - Default value is 3setValueIcons(java.util.Map)public int getValueIconRightPadding()
NOTE: In RTL mode, the valueIconRightPadding is applied to the left of the value icon.
com.smartgwt.client.widgets.form.fields.FormItem#getValueIconspublic void setValueIconSize(int valueIconSize)
valueIcons is specified, this property may be
used to specify both the width and height of the icon written out. Note that valueIconWidth and valueIconHeight take precedence over this value, if
specified.valueIconSize - Default value is 16setValueIconWidth(java.lang.Integer),
setValueIconHeight(java.lang.Integer)public int getValueIconSize()
valueIcons is specified, this property may be
used to specify both the width and height of the icon written out. Note that valueIconWidth and valueIconHeight take precedence over this value, if
specified.getValueIconWidth(),
getValueIconHeight()public void setValueIconWidth(java.lang.Integer valueIconWidth)
valueIcons is specified, use this property to
specify a width for the value icon written out.valueIconWidth - Default value is nullsetValueIconHeight(java.lang.Integer),
setValueIconSize(int)public java.lang.Integer getValueIconWidth()
valueIcons is specified, use this property to
specify a width for the value icon written out.getValueIconHeight(),
getValueIconSize()public void setVisible(java.lang.Boolean visible)
visible can only be set on creation. After creation, use
FormItem.show() and FormItem.hide() to manipulate visibility.
visible - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getVisible()
visible can only be set on creation. After creation, use
FormItem.show() and FormItem.hide() to manipulate visibility.
Appearance overview and related methodspublic void setWidth(int width)
column spanning item). If width is specified as a String, getWidth() will return -1. Use +sgwtLink{getWidthAsString()} in this case.
See the FormLayout overview for details.
width - Default value is -1FormLayout overview and related methods,
Spanning Examplepublic int getWidth()
column spanning item). If width is specified as a String, getWidth() will return -1. Use +sgwtLink{getWidthAsString()} in this case.
See the FormLayout overview for details.
FormLayout overview and related methods,
Spanning Examplepublic void setWidth(java.lang.String width)
column spanning item). If width is specified as a String, getWidth() will return -1. Use +sgwtLink{getWidthAsString()} in this case.
See the FormLayout overview for details.
width - Default value is -1FormLayout overview and related methods,
Spanning Examplepublic java.lang.String getWidthAsString()
column spanning item). If width is specified as a String, getWidth() will return -1. Use +sgwtLink{getWidthAsString()} in this case.
See the FormLayout overview for details.
FormLayout overview and related methods,
Spanning Examplepublic void setWrapTitle(java.lang.Boolean wrapTitle)
wrapItemTitles at the DynamicForm level.wrapTitle - Default value is nullpublic java.lang.Boolean getWrapTitle()
wrapItemTitles at the DynamicForm level.public com.google.gwt.event.shared.HandlerRegistration addBlurHandler(BlurHandler handler)
Called when this FormItem loses focus.
addBlurHandler in interface HasBlurHandlershandler - the blur handlerHandlerRegistration used to remove this handlerpublic void blurItem()
Focus overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addChangeHandler(ChangeHandler handler)
Called when a FormItem's value is about to change as the result of user interaction. This method fires after the user performed an action that would change the value of this field, but before the element itself is changed.
Returning
false cancels the change. Note that if what you want to do is transform the user's input, for example,
automatically change separator characters to a standard separator character, you should implement transformInput rather than using a combination of
change() and setValue() to accomplish the same thing. Returning false from change is intended for
rejecting input entirely, such as typing invalid characters.
Note that if you ask the form for the current value in this handler, you will get the old value because the change has not yet been committed. The new value is available as a parameter to this method.
addChangeHandler in interface HasChangeHandlershandler - the change handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addChangedHandler(ChangedHandler handler)
Called when a FormItem's value has been changed as the result of user interaction. This method fires after the newly specified value has been stored.
addChangedHandler in interface HasChangedHandlershandler - the changed handlerHandlerRegistration used to remove this handlerpublic void clearValue()
Note that if a default value is specified, value will be set to that default value, otherwise value will be cleared, (and removed from the containing form's values).
public com.google.gwt.event.shared.HandlerRegistration addClickHandler(ClickHandler handler)
Called when this FormItem is clicked on.
Note: click() is available on StaticTextItem, BlurbItems,
ButtonItem, and derivatives. Other form items (such as HiddenItem) do not support click().
addClickHandler in interface HasClickHandlershandler - the click handlerHandlerRegistration used to remove this handlerpublic void disable()
public com.google.gwt.event.shared.HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler)
Called when this FormItem is double-clicked.
addDoubleClickHandler in interface HasDoubleClickHandlershandler - the doubleClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEditorEnterHandler(EditorEnterHandler handler)
Notification method fired when the user enters this formItem. Differs from FormItem.focus() in that while focus and
blur may fire multiple as the user navigates sub elements of an item (such as interacting with a pick
list), editorEnter will typically fire once when the user starts to edit this item as a whole, and once
when the user moves onto a different item or component
addEditorEnterHandler in interface HasEditorEnterHandlershandler - the editorEnter handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addEditorExitHandler(EditorExitHandler handler)
Notification method fired when the user leaves this formItem. Differs from FormItem.blur() in that while focus and
blur may fire multiple as the user navigates sub elements of an item (such as interacting with a pick
list), editorEnter will typically fire once when the user starts to edit this item as a whole, and
editorExit fires once when the user moves onto a different item or component
addEditorExitHandler in interface HasEditorExitHandlershandler - the editorExit handlerHandlerRegistration used to remove this handlerpublic void enable()
public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(FocusHandler handler)
Called when this FormItem receives focus.
addFocusHandler in interface HasFocusHandlershandler - the focus handlerHandlerRegistration used to remove this handlerpublic void focusInItem()
Focus overview and related methodspublic java.lang.String getDisplayFieldName()
displayField for this item. This will typically be specified explicitly via the displayField attribute. However, if that property is
unset, and the valueField for this item is
hidden in the optionDataSource, this method
will return the title field for the optionDataSource.public java.lang.String getFieldName()
Drawing overview and related methodspublic java.lang.String getFullDataPath()
name that specifies no dataPath, on a form that specifies a dataPath of /order/items, this
method will return /order/items/namepublic FormItemIcon getIcon(java.lang.String name)
name return a pointer to the icon
definitionname - specified namepublic int getPageLeft()
Positioning overview and related methodspublic int getPageTop()
Positioning overview and related methodspublic int getPixelHeight()
height of this formItem in
pixels. For heights specified as a percentage value or "*", the pixel height may not be available prior
to the item being drawn. In cases where the height has not yet been resolved to a pixel value, this method will return
-1.public int getPixelWidth()
width of this formItem in
pixels. For widths specified as a percentage value or "*", the pixel width may not be available prior to
the item being drawn. In cases where the width has not yet been resolved to a pixel value, this method will return
-1.public ListGridRecord getSelectedRecord()
optionDataSource when fetchMissingValues
is true, and the missing value is fetched. fetchMissingValues kicks off the fetch when the
form item is initialized with a non null value or when setValue() is called on the item. Note that this method will
return null before the fetch completes, or if no record is found in the optionDataSource matching the underlying value.
public java.lang.String getValueFieldName()
valueField for this
item. If unset, default behavior will return the name
of this field.optionDataSourcepublic java.lang.Boolean hasAdvancedCriteria()
AdvancedCriteria sub criterion object? If this method
returns true, DynamicForm.getValuesAsCriteria()
on the form containing this item will always return an AdvancedCriteria object, calling
FormItemCriterionGetter.getCriterion() on each item to retrieve the individual criteria. Default
implementation will return true if operator is explicitly specified.
CriteriaEditing overview and related methodspublic void hide()
public void hideIcon(java.lang.String icon)
icons
array, if it is currently visible. Note that once this method has been called, andy previously specified FormItemIcon.showIf() will be discarded.icon - Name of the icon to be hidden.public com.google.gwt.event.shared.HandlerRegistration addIconClickHandler(IconClickHandler handler)
Notification method called when the user clicks on a form item icon.
The icon's FormItemIcon.formItemClick() method if any
is called first. Then, if the clicked icon is the picker icon, the FormItem.pickerIconClick() method is
called. Then, this method is called.
addIconClickHandler in interface HasIconClickHandlershandler - the iconClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addIconKeyPressHandler(IconKeyPressHandler handler)
StringMethod. Default action to fire when an icon has keyboard focus and the user types a key. May be
overridden by setting keyPress on the form item icon directly.
addIconKeyPressHandler in interface HasIconKeyPressHandlershandler - the iconKeyPress handlerHandlerRegistration used to remove this handlerpublic void invalidateDisplayValueCache()
displayField, the
value displayed to the user for this item may be derived from another field. The display field can be either another
field value in the same record or a field that must be retrieved from a related optionDataSource if fetchMissingValues is true. In this latter case,
we perform a fetch against the option dataSource when the item value changes in order to determine the display value to
show (and we make the associated record available via FormItem.getSelectedRecord()).
We cache this data on the form item, so if the item value changes to a new value, then reverts to a previously-seen value, the display value and selected record are already available without the need for an additional fetch. The cached values will also be kept in synch with the dataSource data assuming it is modified via standard add, update or delete operations.
This method explicitly invalidates this cache of optionDataSource data, and if the item value is non null and fetchMissingValues is still true, re-fetches the data.
public java.lang.Boolean isDisabled()
getDisabled(),
Enable overview and related methodspublic java.lang.Boolean isDrawn()
Drawing overview and related methodspublic java.lang.Boolean isVisible()
Canvas API, it indicates visibility settings only and so will return true
for an item that is not drawn.Visibility overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addItemHoverHandler(ItemHoverHandler handler)
Optional stringMethod to fire when the user hovers over this item. Call com.smartgwt.client.widgets.form.fields.events.ItemHoverEvent#cancel() from within ItemHoverHandler.onItemHover(com.smartgwt.client.widgets.form.fields.events.ItemHoverEvent) to suppress default behavior of showing a
hover canvas containing the HTML returned by formItem.itemHoverHTML() / form.itemHoverHTML().
addItemHoverHandler in interface HasItemHoverHandlershandler - the itemHover handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addKeyDownHandler(KeyDownHandler handler)
StringMethod fired in response to a keydown while focused in this form item.
addKeyDownHandler in interface HasKeyDownHandlershandler - the keyDown handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addKeyPressHandler(KeyPressHandler handler)
StringMethod fired when the user presses a key while focused in this form item.
addKeyPressHandler in interface HasKeyPressHandlershandler - the keyPress handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addKeyUpHandler(KeyUpHandler handler)
StringMethod fired in response to a keyup while focused in this form item.
addKeyUpHandler in interface HasKeyUpHandlershandler - the keyUp handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addPickerIconClickHandler(PickerIconClickHandler handler)
Notification method called when the picker
icon is clicked.
addPickerIconClickHandler in interface HasPickerIconClickHandlershandler - the pickerIconClick handlerHandlerRegistration used to remove this handlerpublic boolean shouldApplyHeightToTextBox()
height is specified, should it be applied to the
item's text box element? If this method returns false, the text box will not have an explicit height applied, though the
containing cell will be sized to accomodiate any specified height. This is used in cases where the text box does not
have distinctive styling (for example in standard StaticTextItems). As
the textBox has no explicit height, it fits the content. Since the text box is not visually distinct to the user, this
makes vAlign behave as expected with the text value
of the item being vertically aligned within the cell.
Default implementation will return applyHeightToTextBox if explicitly set
otherwise false if readOnlyDisplay is set to "static" and the item is not editable, otherwise true.
public java.lang.Boolean shouldFetchMissingValue(java.lang.Object newValue)
optionDataSource, should we perform a fetch against that dataSource to find the record that matches this field's value?
If the value is non-null, this method is called when the item is first rendered or whenever the value is changed
via a call to FormItem.setValue(). If it returns
true, a fetch will be dispatched against the optionDataSource to get the record matching the value
When the fetch
completes, if a record was found that matches the data value (and the form item value has not subsequently changed
again), the item will be re-rendered to reflect any changes to the display value, and the record matching the value
will be available via this.getSelectedRecord().
Default behavior will return false if this.fetchMissingValues is set to false.
Otherwise it will return true if this.alwaysFetchMissingValues is set to true, or if a displayField is specified for this item and the item
value is not already present in the item's valueMap.
newValue - The new data value of the item.public java.lang.Boolean shouldSaveOnEnter()
saveOnEnter or false if that property is unset.public boolean shouldStopKeyPressBubbling(java.lang.String keyName,
int characterValue)
This method is called after standard item keypress handlers when the user presses a key while focused in this item. Returning true will suppress bubbling of the event to the containing form. This is useful to avoid having the form react to key events which "have meaning" to the focused item.
Default implementation varies by item type. In short character keys are suppressed for all editable fields, as are keys which will modify the current state of the field ("Arrow" keys for moving around free form text editors, etc).
Note that when this method returns true,
no keyPress event will fire on the form for the key
pressed. However developers will still receive the separate DynamicForm.itemKeyPress() event.
keyName - name of the key pressedcharacterValue - If this was a character key, this is the numeric value for the characterpublic void show()
public void showIcon(java.lang.String icon)
icons
array, if it is not already visible. Note that once this method has been called, andy previously specified FormItemIcon.showIf() will be discarded. Note that if the form item's showIcons property is set to false, no icons will be displayed for the item. In this case this method will not cause the icon to be displayed.
icon - Name of the icon to be shown.public void showPicker()
pickerIcon. May also be called programmatically.
Default implementation lazily creates and shows the Picker Autochild. May be overridden to implement some custom
picker for this item.
public void stopHover()
public void storeValue(java.lang.Object value)
This method will fire standard FormItem.change() and DynamicForm.itemChanged() handlers, and store the
value passed in such that subsequent calls to FormItem.getValue() or DynamicForm.getValue() will return
the new value for this item.
This method is intended to provide a way for custom formItems - most commonly canvasItems - to provide a new interface to the user, allowing them
to manipulate the item's value, for example in an embedded canvas, or a pop-up dialog launched from an icon, etc. Developers should call this method when the user
interacts with this custom interface in order to store the changed value.
shouldSaveValue for CanvasItems is false by
default. Custom CanvasItems will need to override shouldSaveValue to true if the values stored via this API should be
included in the form's getValues() and saved with the
form when saveData() is called.
If you cannot easily
detect interactions that should change the value as the user performs them, a workaround is to call
storeValue right before the form saves.
Note that this method is not designed for customizing a value
which is already being saved by a standard user interaction. For example you should not call this method from a change handler. Other APIs such as FormItem.transformInput() exist for this.
value - value to save for this itempublic void storeValue(java.lang.Object value,
java.lang.Boolean showValue)
This method will fire standard FormItem.change() and DynamicForm.itemChanged() handlers, and store the
value passed in such that subsequent calls to FormItem.getValue() or DynamicForm.getValue() will return
the new value for this item.
This method is intended to provide a way for custom formItems - most commonly canvasItems - to provide a new interface to the user, allowing them
to manipulate the item's value, for example in an embedded canvas, or a pop-up dialog launched from an icon, etc. Developers should call this method when the user
interacts with this custom interface in order to store the changed value.
shouldSaveValue for CanvasItems is false by
default. Custom CanvasItems will need to override shouldSaveValue to true if the values stored via this API should be
included in the form's getValues() and saved with the
form when saveData() is called.
If you cannot easily
detect interactions that should change the value as the user performs them, a workaround is to call
storeValue right before the form saves.
Note that this method is not designed for customizing a value
which is already being saved by a standard user interaction. For example you should not call this method from a change handler. Other APIs such as FormItem.transformInput() exist for this.
value - value to save for this itemshowValue - Should the formItem be updated to display the new value?public com.google.gwt.event.shared.HandlerRegistration addTitleClickHandler(TitleClickHandler handler)
Notification method fired when the user clicks the title for this item
addTitleClickHandler in interface HasTitleClickHandlershandler - the titleClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addTitleDoubleClickHandler(TitleDoubleClickHandler handler)
Notification method fired when the user double-clicks the title for this item
addTitleDoubleClickHandler in interface HasTitleDoubleClickHandlershandler - the titleDoubleClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addTitleHoverHandler(TitleHoverHandler handler)
Optional stringMethod to fire when the user hovers over this item's title. Call com.smartgwt.client.widgets.form.fields.events.TitleHoverEvent#cancel() from within TitleHoverHandler.onTitleHover(com.smartgwt.client.widgets.form.fields.events.TitleHoverEvent) to suppress default behavior of showing a
hover canvas containing the HTML returned by formItem.titleHoverHTML() /
form.titleHoverHTML().
addTitleHoverHandler in interface HasTitleHoverHandlershandler - the titleHover handlerHandlerRegistration used to remove this handlerpublic void updateState()
textBoxStyle). Calls to
updateState() normally occur automatically as a consequence of focus changes, items becoming disabled, etc.
This method is advanced and intended only for use in workarounds.
public java.lang.Boolean validate()
public boolean valueClipped()
The form item must have value clipping enabled. If a form item type supports the clipValue
attribute, then clipValue must be true. TextItems and derivatives (e.g.
SpinnerItem) automatically clip their values.
public com.google.gwt.event.shared.HandlerRegistration addValueHoverHandler(ValueHoverHandler handler)
Optional stringMethod to fire when the user hovers over this item's value. Call com.smartgwt.client.widgets.form.fields.events.ValueHoverEvent#cancel() from within ValueHoverHandler.onValueHover(com.smartgwt.client.widgets.form.fields.events.ValueHoverEvent) to suppress default behavior of showing a
hover canvas containing the HTML returned by FormItem.valueHoverHTML() / DynamicForm.valueHoverHTML().
addValueHoverHandler in interface HasValueHoverHandlershandler - the valueHover handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(FormItem formItemProperties)
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.
formItemProperties - properties that should be used as new defaults when instances of this class are createdpublic java.lang.String getScClassName()
public void setScClassName(java.lang.String scClassName)
scClassName - the SmartClient classpublic static <T extends RefDataClass> T asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)
JavaScriptObject. If
the supplied object is not a SmartClient FormItem, a warning will be logged and null
returned; otherwise the FormItem will be returned as the appropriate subtype of SGWT
FormItem.jsObj - SmartClient FormItem whose wrapper is wantedpublic java.lang.String getClassName()
public void setInitHandler(FormItemInitHandler initHandler)
initHandler - public void setAttribute(java.lang.String attribute,
java.lang.String value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.util.Map value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
BaseClass[] value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
DataClass[] value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.util.Date value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
ValueEnum[] value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
DataClass value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
BaseClass value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
com.google.gwt.core.client.JavaScriptObject value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.lang.String[] value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
boolean value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.lang.Boolean value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
int value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.lang.Integer value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
long value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.lang.Float value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
double value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.lang.Double value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
int[] value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
java.lang.Integer[] value)
DataClasssetAttribute in class DataClasspublic void setAttribute(java.lang.String attribute,
double[] value)
DataClasssetAttribute in class DataClasspublic java.lang.String getAttribute(java.lang.String attribute)
DataClassgetAttribute in class DataClasspublic java.lang.String getAttributeAsString(java.lang.String property)
DataClassgetAttributeAsString in class DataClasspublic java.util.Date getAttributeAsDate(java.lang.String property)
DataClassgetAttributeAsDate in class DataClasspublic java.lang.Double getAttributeAsDouble(java.lang.String property)
DataClassgetAttributeAsDouble in class DataClasspublic com.google.gwt.core.client.JavaScriptObject getAttributeAsJavaScriptObject(java.lang.String property)
DataClassgetAttributeAsJavaScriptObject in class DataClasspublic java.lang.Integer getAttributeAsInt(java.lang.String property)
DataClassgetAttributeAsInt in class DataClasspublic java.lang.Float getAttributeAsFloat(java.lang.String property)
DataClassgetAttributeAsFloat in class DataClasspublic java.lang.Boolean getAttributeAsBoolean(java.lang.String property)
DataClassgetAttributeAsBoolean will return Boolean false
if the attribute value is null or not a Boolean. Use the two parameter
variant of this API DataClass.getAttributeAsBoolean(String, boolean) if you want
null returned for null attribute values.getAttributeAsBoolean in class DataClassproperty - the property namepublic java.lang.Boolean getAttributeAsBoolean(java.lang.String property,
boolean allowNull)
DataClassnull
or not a Boolean, the return value depends upon allowNull. If
allowNull is true, null will be returned; otherwise Boolean
false will be returned. For a simpler approach that never returns
null, use the one parameter variant of this API
DataClass.getAttributeAsBoolean(String).getAttributeAsBoolean in class DataClassproperty - the property nameallowNull - whether to allow nullpublic java.lang.Object getAttributeAsObject(java.lang.String property,
com.google.gwt.core.client.JavaScriptObject convertToObject)
public void setNullProperty(java.lang.String property)
public void setProperty(java.lang.String property,
java.lang.String value)
public void setProperty(java.lang.String property,
boolean value)
public void setProperty(java.lang.String property,
int value)
public void setProperty(java.lang.String property,
double value)
public void setProperty(java.lang.String property,
com.google.gwt.core.client.JavaScriptObject value)
protected final void error(java.lang.String attribute,
java.lang.String value)
throws java.lang.IllegalStateException
java.lang.IllegalStateExceptionprotected final void errorIfNotCreated(java.lang.String property)
throws java.lang.IllegalStateException
java.lang.IllegalStateExceptionprotected final void error(java.lang.String message)
throws java.lang.IllegalStateException
java.lang.IllegalStateExceptionpublic void setAutoChildConstructor(java.lang.String autoChildName,
java.lang.String className)
autoChildName.autoChildName - the name of the AutoChildclassName - the SmartClient class name to use when constructing the AutoChild.AutoChildUsagepublic void setAutoChildProperties(java.lang.String autoChildName,
Canvas properties)
Canvas AutoChild named autoChildName.
properties must not have already been created (properties.isCreated()
must be false).
NOTE: Overrides at override points are not applied to AutoChildren created from
properties; that is, if the Java Class of properties
overrides a Smart GWT override point, the custom method implementation will not be called.
java.lang.IllegalStateException - if properties has been created.public void setAutoChildProperties(java.lang.String autoChildName,
FormItem properties)
FormItem AutoChild named autoChildName.
properties must not have already been created (properties.isCreated()
must be false).
NOTE: Overrides at override points are not applied to AutoChildren created from
properties; that is, if the Java Class of properties
overrides a Smart GWT override point, the custom method implementation will not be called.
java.lang.IllegalStateException - if properties has been created.public void setAutoChildVisibility(java.lang.String autoChildName,
boolean visible)
autoChildName.
NOTE: This API is not valid for all AutoChildren because some AutoChildren cannot be hidden without destroying the main functions of the component.
autoChildName - name of an AutoChildvisible - whether to show the AutoChildpublic final Canvas getCanvasAutoChild(java.lang.String autoChildName)
Canvas AutoChild named autoChildName if already created.autoChildName - name of an AutoChild to return.java.lang.RuntimeException - if no AutoChild named autoChildName has been created
or the AutoChild is not a SmartClient Canvas object.public final FormItem getFormItemAutoChild(java.lang.String autoChildName)
FormItem AutoChild named autoChildName if already created.autoChildName - name of an AutoChild to return.java.lang.RuntimeException - if no AutoChild named autoChildName has been created
or the AutoChild is not a SmartClient FormItem object.public void setOptionDataSource(DataSource dataSource)
public void setName(java.lang.String name)
The FormItem's name determines the name of the property it edits within the form. Must be
unique within the form as well as a valid JavaScript identifier, as specified by ECMA-262
Section 7.6 (the StringUtil.isValidID(String) function can
be used to test whether a name is a valid JavaScript identifier).
name - name Default value is nullpublic java.lang.String getName()
The FormItem's name determines the name of the property it edits within the form. Must be
unique within the form as well as a valid JavaScript identifier, as specified by ECMA-262
Section 7.6 (the StringUtil.isValidID(String) function can
be used to test whether a name is a valid JavaScript identifier).
public void setErrorOrientation(FormErrorOrientation errorOrientation)
showInlineErrors is true, where
should the error icon and text appear relative to the form item itself. Valid options are "top",
"bottom", "left" or "right".errorOrientation.errorOrientation - errorOrientation Default value is nullpublic void setType(java.lang.String type)
type - type Default value is "text"public void setColSpan(java.lang.String colSpan)
The colSpan setting does not include the title shown
for items with showTitle:true, so the
effective colSpan is one higher than this setting for items that are showing a title and whose
TitleOrientation is either "left" or "right".
colSpan - colSpan Default value is 1public void setColSpan(int colSpan)
The colSpan setting does not include the title shown
for items with showTitle set to true, so the
effective colSpan is one higher than this setting for items that are showing a title and whose
TitleOrientation is either "left" or "right".
colSpan - colSpan Default value is 1public java.lang.String getType()
public void setDefaultValue(java.lang.String defaultValue)
null programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.defaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.lang.Integer defaultValue)
null programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.defaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.util.Date defaultValue)
null programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.defaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.lang.Boolean defaultValue)
null programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.defaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.lang.Float defaultValue)
null programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.defaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.lang.Double defaultValue)
null programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.defaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.lang.Object value)
public void setValueMap(java.lang.String... valueMap)
valueMap - the value mappublic void setValueMap(java.util.LinkedHashMap valueMap)
valueMap - the value mappublic void setValueIcons(java.util.Map valueIcons)
valueIcons - mapping of logical values for this item to icon src URLspublic void setEditorProperties(FormItem editorProperties)
The type of FormItem to use for editing is normally derived automatically from
type, which is the
data type of the field, by the rules explained
here.
Note: When you supply a custom FormItem via setEditorProperties(), you're really providing properties which are then used to create
multiple FormItems (eg, in grids, forms and trees) and there's an underlying limitation here where event handlers have to be written to
dynamically receive the actual FormItem rather than relying on "this" (because there's more than one "this").
This means you need to follow the special rules indicated for
DataSourceField.setEditorProperties(FormItem).
As an alternative, you can use setEditorType(String) or
setEditorType(Class) to avoid these limitations, if you register
the FormItem subclass with the reflection mechanism.
editorProperties - FormItem with the properties you want to set as defaults.public void setEditorType(FormItem editorType)
setEditorProperties(FormItem). You can also consider using
setEditorType(Class) or setEditorType(String) instead.setEditorProperties(FormItem).editorType - FormItem with the properties you want to set as defaultspublic void setEditorType(java.lang.String editorType)
The type of FormItem
to use for editing is normally derived automatically from the
type,
which is the data type of the field, by the rules explained
here.
Note: The editorType must be registered for use with the
reflection mechanism.
By doing so, you avoid the limitations of setEditorProperties(FormItem).
editorType - the fully-qualified class name of a FormItem subclass.java.lang.IllegalArgumentException - if the editorType class has not been registered for use with the
reflection mechanism,
or if it does not inherit from
FormItem.public void setEditorType(java.lang.Class<? extends FormItem> editorType)
The type of FormItem
to use for editing is normally derived automatically from the
type,
which is the data type of the field, by the rules explained
here.
Note: The editorType must be registered for use with the
reflection mechanism.
By doing so, you avoid the limitations of setEditorProperties(FormItem).
editorType - a FormItem subclass.java.lang.IllegalArgumentException - if the editorType class has not been registered for use with the
reflection mechanism,
or if it does not inherit from
FormItem.public void setValue(int value)
value - the form item valuepublic void setValue(double value)
value - the form item valuepublic void setValue(java.util.Date value)
value - the form item valuepublic void setValue(java.lang.String value)
value - the form item valuepublic void setValue(boolean value)
value - the form item valuepublic void setValue(java.lang.Object value)
FormItemValueParser and FormItemValueFormatter
API's for custom value parsing and formatting.value - the form item valuepublic java.lang.String getDisplayValue()
public java.lang.String getDisplayValue(java.lang.String value)
public int getVisibleHeight()
public int getVisibleWidth()
public Rectangle getPageRect()
public Rectangle getRect()
public void redraw()
setRedrawOnChange(Boolean)public Rectangle getIconRect(FormItemIcon icon)
public Rectangle getIconPageRect(FormItemIcon icon)
public com.google.gwt.core.client.JavaScriptObject getConfig()
public com.google.gwt.core.client.JavaScriptObject getEditorTypeConfig()
public void setTooltip(java.lang.String tooltip)
setPrompt(java.lang.String).tooltip - tooltip Default value is nullpublic java.lang.String getTooltip()
getPrompt()public void setOptionFilterContext(RPCRequest rpcRequestProperties)
optionDataSource, and this property is
not null, this will be passed to the datasource as RPCRequest properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
Note : This is an advanced setting
rpcRequestProperties - optionFilterContext Default value is nullpublic RPCRequest getOptionFilterContext()
optionDataSource, and this property is
not null, this will be passed to the datasource as RPCRequest properties when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mappingpublic void setOptionCriteria(Criteria optionCriteria)
optionDataSource, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mapping
Note : This is an advanced setting
optionCriteria - optionCriteria Default value is nullpublic Criteria getOptionCriteria()
optionDataSource, and this property may be used
to specify criteria to pass to the datasource when
performing the fetch operation on the dataSource to obtain a data-value to display-value
mappingpublic void setShowIfCondition(FormItemIfFunction showIf)
showIf - the showIf handlerFormItem#setRedrawOnChange(boolean)public void setErrorFormatter(FormItemErrorFormatter errorFormatter)
errorFormatter - the error formatter.public void setInputTransformer(FormItemInputTransformer inputTransformer)
change event.inputTransformer - the input transformerpublic void setItemHoverFormatter(FormItemHoverFormatter hoverFormatter)
hoverFormatter - the hover formatterpublic void setItemTitleHoverFormatter(FormItemHoverFormatter hoverFormatter)
FormItemHoverFormatter should return the HTML to display in a hover canvas
when the user holds the mouse pointer over this item's title and the title is clipped. Return
null to suppress the hover canvas altogether.hoverFormatter - the hover formatterDynamicForm.titleClipped(com.smartgwt.client.widgets.form.fields.FormItem)public void setTitleHoverFormatter(FormItemHoverFormatter hoverFormatter)
setItemTitleHoverFormatter(FormItemHoverFormatter).hoverFormatter - the hover formatterpublic void setItemValueHoverFormatter(FormItemHoverFormatter hoverFormatter)
FormItemHoverFormatter should return the HTML to display in a hover canvas
when the user holds the mouse pointer over this item's value and the value is clipped. Return
null to suppress the hover canvas altogether.hoverFormatter - the hover formattervalueClipped()public void setValueHoverFormatter(FormItemHoverFormatter hoverFormatter)
setItemValueHoverFormatter(FormItemHoverFormatter).hoverFormatter - the hover formatterpublic DynamicForm getForm()
Note that you must treat this as a read-only reference to the from
public java.lang.Object getValue()
List or RecordList instance
is returned.
Note that for FormItems that have a ValueMap or where a formatter has been defined, getValue()
returns the underlying value of the FormItem, not the displayed value.
public java.lang.Object _getValue()
public RecordList getValueAsRecordList()
public void setValueFormatter(FormItemValueFormatter formatter)
FormItemValueFormatter, if provided, is evaluated to get the
display value to show for this form items underlying data value. This provides a way to perform a more complex data
to display value manipulation than a simple valueMap. Note that this method will not be applied to values displayed in a free-form text entry field (such as a
TextItem or TextAreaItem), where an equivalent parser method would be required to convert a
user-entered value back into a data value. Use setEditorValueFormatter(com.smartgwt.client.widgets.form.FormItemValueFormatter) and setEditorValueParser(com.smartgwt.client.widgets.form.FormItemValueParser) instead for these cases.
formatter - the FormItemValueFormatterpublic void setEditorValueFormatter(FormItemValueFormatter formatter)
FormItemValueFormatter to map this item's current data value to a
display value. Note that this only applies to items which show a free-form entry area, such as a TextItem or TextAreaItem. For
display values which will not be directly manipulated by the user, use setValueFormatter(com.smartgwt.client.widgets.form.FormItemValueFormatter) instead.
See also setEditorValueParser(com.smartgwt.client.widgets.form.FormItemValueParser).
formatter - the FormItemValueFormatterpublic void setEditorValueParser(FormItemValueParser valueParser)
FormItemValueParser to map a user-entered display value to a data
value for storage. This method only applies to form items which show a free-form text entry area, such at the TextItem or TextAreaItem.
See also com.smartgwt.client.widgets.form.fields.FormItem#formatEditorValue
valueParser - the FormItemValueParserpublic void setValueIconMapper(ValueIconMapper valueIconMapper)
setValueIcons(java.util.Map).valueIconMapper - the valueIconMapperpublic void setDisplayFormat(DateDisplayFormat displayFormat)
"date" or "time" will be edited using a DateItem or TimeItem by
default. However this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a
custom editorType as well as data type.
For fields of type "date", set
this property to a valid DateDisplayFormat to specify how the date should be
formatted.
For fields of type "time", set this property to a valid timeFormatter to specify how the time should be formatted.
Note that if
dateFormatter or timeFormatter are specified they will take precedence
over this setting.
If this field is of type "date" and is editable, the inputFormat may be used to specify how user-edited date
strings will be parsed.
Note : This is an advanced setting
displayFormat - displayFormat Default value is nullsetInputFormat(java.lang.String),
setDateFormatter(com.smartgwt.client.types.DateDisplayFormat),
setTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat)public void setDisplayFormat(TimeFormatter displayFormat)
"date" or "time" will be edited using a DateItem or TimeItem by
default. However this can be overridden - for canEdit:false fields, a StaticTextItem is used by default, and the developer can always specify a
custom editorType as well as data type.
For fields of type "date", set
this property to a valid DateDisplayFormat to specify how the date should be
formatted.
For fields of type "time", set this property to a valid timeFormatter to specify how the time should be formatted.
Note that if
dateFormatter or timeFormatter are specified they will take precedence
over this setting.
If this field is of type "date" and is editable, the inputFormat may be used to specify how user-edited date
strings will be parsed.
Note : This is an advanced setting
displayFormat - displayFormat Default value is nullsetInputFormat(java.lang.String),
setDateFormatter(com.smartgwt.client.types.DateDisplayFormat),
setTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat)public void setCanEditCriterionPredicate(FormItemCanEditCriterionPredicate predicate)
DynamicForm.setValuesAsCriteria, this predicate is used
to determine which sub-criteria apply to which form item(s). This method will be called on each item, and passed the
sub-criterion of the AdvancedCriteria object. It should return true if the item can edit the criterion, otherwise false.
If it returns true, setValuesAsCriteria() will call FormItemCriterionSetter.setCriterion from
the registered FormItemCriterionSetter
to actually apply the criterion to
the form item, and DynamicForm.getValuesAsCriteria can subsequently retrieve the edited criterion by calling FormItemCriterionGetter.getCriterion from
the registered FormItemCriterionGetter.
Default implementation will
return true if the criterion fieldName and operator match the fieldName and operator (or
default operator) for this item.
predicate - the predicate to determine the form items that can edit the criterion in questionCriteriaEditing overview and related methodspublic final java.lang.Boolean canEditCriterion(Criterion criterion)
canEditCriterion()
method of the FormItemCanEditCriterionPredicate
that is registered with this field.criterion - sub-criterion from an AdvancedCriteria objectCriteriaEditing overview and related methodspublic void setCriterionGetter(FormItemCriterionGetter getter)
DynamicForm.getValuesAsCriteria. This API is provided to allow you to specify a more complex criterion than the "field-operator-value" criterions that are built-in. Note that the built-in behavior is generally quite flexible and powerful enough for most requirements. An example of a case where you might want to override this method is if you wanted to implement a date range selection (ie, date > x AND date < y) on a form that was combining its other criteria fields with an "or" operator.
Note that this method is part of the criteria editing subsystem: if overridden, it is likely that you will want to also
override FormItem.hasAdvancedCriteria to
ensure this method is called by the form, and to support editing of existing advanced criteria you may also need to
set the FormItemCanEditCriterionPredicate
and the FormItemCriterionSetter.
The default implementation
will return a criterion including the form item value, fieldName and specified operator, or a default operator derived from the form item
data type if no explicit operator is specified.
getter - provides a method to get a criterion object based on this field's current edited value(s).CriteriaEditing overview and related methodspublic final Criterion getCriterion()
getCriterion() method
of the FormItemCriterionGetter
that is registered with this field.CriteriaEditing overview and related methodspublic final Criterion getCriterion(TextMatchStyle textMatchStyle)
getCriterion() method
of the FormItemCriterionGetter
that is registered with this field.textMatchStyle - If passed assume the textMatchStyle will be used when performing a fetch operation with these criteria. This may
impact the criterion's operator property.CriteriaEditing overview and related methodspublic void setCriterionSetter(FormItemCriterionSetter setter)
DynamicForm.setValuesAsCriteria when the
registered FormItemCanEditCriterionPredicate
returns true for this item.
Default implementation simply calls FormItem.setValue with the value of the criterion passed in
setter - provides a method to update this field with the edited criterionpublic final void setCriterion(Criterion criterion)
setCriterion() method
of the FormItemCriterionSetter
that is registered with this field.criterion - criterion to editpublic void setAriaState(java.lang.String stateName,
java.lang.Object stateValue)
throws java.lang.IllegalStateException
com.smartgwt.docs.Accessibility.stateName - stateValue - java.lang.IllegalStateException - ARIA state cannot be changed after the form item has been created.