|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.widgets.form.fields.FormItem
com.smartgwt.client.widgets.form.fields.SelectItem
public class SelectItem
FormItem that allows picking between several mutually exclusive options via a select list.
Options may be derived from a dataSource
or a valueMap
Note that to select the first option as a default value for the item,
defaultToFirstOption
may be set.
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
SelectItem()
|
|
SelectItem(com.google.gwt.core.client.JavaScriptObject jsObj)
|
|
SelectItem(java.lang.String name)
|
|
SelectItem(java.lang.String name,
java.lang.String title)
|
Method Summary | |
---|---|
void |
defaultDynamicValue()
Expression evaluated to determine the defaultValue when no value is
provided for this item. |
void |
fetchData()
Only applies to databound items (see optionDataSource ).Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria . |
void |
fetchData(DSCallback callback)
Only applies to databound items (see optionDataSource ).Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria . |
void |
fetchData(DSCallback callback,
DSRequest requestProperties)
Only applies to databound items (see optionDataSource ).Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria . |
java.lang.Boolean |
getAddUnknownValues()
If we're setting the value of a select item and the value isn't a legal value in the valueMap, whether we should allow the value (creating a new option for it) or reject it. |
java.lang.Boolean |
getAllowEmptyValue()
If set to true, always show an empty option in this item's pickList, allowing the user to clear the value (even if there is no empty entry in the valueMap for the item). |
java.lang.Boolean |
getAnimatePickList()
If true, when the pickList is shown, it will be shown via an animated reveal effect |
int |
getAnimationTime()
If this.animatePickList is true - this specifies the duration of the animation effect applied when showing the pickList |
java.lang.Boolean |
getAutoFetchData()
If this select item retrieves its options from a dataSource , should options
be fetched from the server when the item is first drawn, or should this fetch be
delayed until the user opens the pickList.
|
java.lang.String |
getControlStyle()
Base CSS class name for a form item's control box (surrounds text box and picker). |
java.lang.Boolean |
getDefaultToFirstOption()
Select the first option as the default value for this SelectItem. |
java.lang.Boolean |
getDefaultValue()
Static default value for this SelectItem. |
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 form item.
If unset, and optionDataSource is explicitly specified, this method
will return the title field for the optionDataSource
|
int |
getEmptyPickListHeight()
Height for an empty pick list (showing the empty message), if the pick list has no records and hideEmptyPickList is false . |
java.lang.String |
getEmptyPickListMessage()
Empty message to display in the pickList if hideEmptyPickList is false . |
java.lang.Integer |
getFetchDelay()
For a ComboBox or other pickList that accepts user-entered criteria, how many millseconds to wait after the last user keystroke before fetching data from the server. |
java.lang.Boolean |
getFilterLocally()
If filterLocally is set for this item, and this item is showing options
from a dataSource, fetch the entire set of options from the server, and use these values
to map the item value to the appropriate display value. |
int |
getHeight()
Default height for select items is 19px. |
java.lang.Boolean |
getHideEmptyPickList()
If this pickList contains no options, should it be hidden? If unset, default behavior is to allow the empty pickList to show if it is databound. |
java.lang.Boolean |
getMultiple()
If true, this selectItem will be displayed as a tall list of options, and the user will be able to select multiple options. |
static SelectItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
java.lang.Integer |
getPickerIconHeight()
If showPickerIcon is true for this item, this property governs the
size of the picker icon. |
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. |
java.lang.String |
getPickListBaseStyle()
Base Style for pickList cells. |
Criteria |
getPickListCriteria()
If this item has a databound pick-list (for example optionDataSource is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList. |
protected Criteria |
getPickListFilterCriteria()
Returns a set of filter criteria to be applied to the data displayed in the pickList when it is shown. |
int |
getPickListHeaderHeight()
If this pick list is showing multiple fields, this property determines the height of the column headers for those fields. |
int |
getPickListHeight()
Maximum height to show the pick list before it starts to scroll. |
java.lang.Integer |
getPickListWidth()
Default width to show the pickList. |
ListGridRecord |
getSelectedRecord()
Returns the entire record object associated with the current value for this item (or null if no matching record exists in the PickList data). |
java.lang.Boolean |
getShowAllOptions()
If true, even non-matching options will be shown, with configurable separatorRows in between. |
java.lang.Boolean |
getShowFocused()
When this item recieves focus, should it be re-styled to indicate it has focus? |
java.lang.Boolean |
getShowOptionsFromDataSource()
If this item is part of a databound form, and has a specified valueMap
by default we show the valueMap options in the pickList for the item.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource . |
java.lang.Boolean |
getShowOver()
When the user rolls over the select item, should the pickButton display it's Over state? |
java.lang.Boolean |
getShowPickerIcon()
Should we show a special 'picker' icon for this form item. |
java.lang.String |
getTextBoxStyle()
Base CSS class name for a form item's text box element. |
TextMatchStyle |
getTextMatchStyle()
When applying filter criteria to pickList data, what type of matching to use. |
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.
If unset, default behavior will return the name of this field.
|
java.lang.String |
getValueIconField()
For Databound formItems, this property determines which column valueIcons should show up in for this formItem's pickList.If unset valueIcons show up in the displayField column if specified, otherwise
the valueField column.In most cases only the displayField or valueField will be visible. |
java.lang.String[] |
getValues()
Returns the values of a SelectItem with multiple=true as an array of Strings. |
void |
setAddUnknownValues(java.lang.Boolean addUnknownValues)
If we're setting the value of a select item and the value isn't a legal value in the valueMap, whether we should allow the value (creating a new option for it) or reject it. |
void |
setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
If set to true, always show an empty option in this item's pickList, allowing the user to clear the value (even if there is no empty entry in the valueMap for the item). |
void |
setAnimatePickList(java.lang.Boolean animatePickList)
If true, when the pickList is shown, it will be shown via an animated reveal effect |
void |
setAnimationTime(int animationTime)
If this.animatePickList is true - this specifies the duration of the animation effect applied when showing the pickList |
void |
setAutoFetchData(java.lang.Boolean autoFetchData)
If this select item retrieves its options from a dataSource , should options
be fetched from the server when the item is first drawn, or should this fetch be
delayed until the user opens the pickList.
|
void |
setControlStyle(java.lang.String controlStyle)
Base CSS class name for a form item's control box (surrounds text box and picker). |
void |
setDefaultToFirstOption(java.lang.Boolean defaultToFirstOption)
Select the first option as the default value for this SelectItem. |
void |
setDefaultValue(java.lang.Boolean defaultValue)
Static default value for this SelectItem. |
void |
setDefaultValues(java.lang.Integer... defaultValues)
Default values used when no value is provided for this item. |
void |
setDefaultValues(java.lang.String... defaultValues)
Default values used when no value is provided for this item. |
void |
setDisplayField(java.lang.String displayField)
Specifies an alternative field from which display values should be retrieved for this item. |
void |
setEmptyPickListHeight(int emptyPickListHeight)
Height for an empty pick list (showing the empty message), if the pick list has no records and hideEmptyPickList is false . |
void |
setEmptyPickListMessage(java.lang.String emptyPickListMessage)
Empty message to display in the pickList if hideEmptyPickList is false . |
void |
setFetchDelay(java.lang.Integer fetchDelay)
For a ComboBox or other pickList that accepts user-entered criteria, how many millseconds to wait after the last user keystroke before fetching data from the server. |
void |
setFields(FormItemIcon pickerIconProperties)
|
void |
setFilterLocally(java.lang.Boolean filterLocally)
If filterLocally is set for this item, and this item is showing options
from a dataSource, fetch the entire set of options from the server, and use these values
to map the item value to the appropriate display value. |
void |
setHeight(int height)
Default height for select items is 19px. |
void |
setHideEmptyPickList(java.lang.Boolean hideEmptyPickList)
If this pickList contains no options, should it be hidden? If unset, default behavior is to allow the empty pickList to show if it is databound. |
void |
setMultiple(java.lang.Boolean multiple)
If true, this selectItem will be displayed as a tall list of options, and the user will be able to select multiple options. |
void |
setOptionDataSource(DataSource dataSource)
If set, this FormItem will derive data to show in the PickList by fetching records from the specified optionDataSource . |
void |
setPickerIconHeight(java.lang.Integer pickerIconHeight)
If showPickerIcon is true for this item, this property governs the
size of the picker icon. |
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 |
setPickListBaseStyle(java.lang.String pickListBaseStyle)
Base Style for pickList cells. |
void |
setPickListCriteria(Criteria pickListCriteria)
If this item has a databound pick-list (for example optionDataSource is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList. |
void |
setPickListCriteria(RPCRequest optionFilterContext)
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 filter operation on
the dataSource to obtain the set of options for the list. |
void |
setPickListFields(ListGridField... pickListFields)
This property allows the developer to specify which field[s] will be displayed in the drop down list of options. |
void |
setPickListHeaderHeight(int pickListHeaderHeight)
If this pick list is showing multiple fields, this property determines the height of the column headers for those fields. |
void |
setPickListHeight(int pickListHeight)
Maximum height to show the pick list before it starts to scroll. |
void |
setPickListWidth(java.lang.Integer pickListWidth)
Default width to show the pickList. |
void |
setSeparatorRows(ListGridRecord[] separatorRows)
|
void |
setShowAllOptions(java.lang.Boolean showAllOptions)
If true, even non-matching options will be shown, with configurable separatorRows in between. |
void |
setShowFocused(java.lang.Boolean showFocused)
When this item recieves focus, should it be re-styled to indicate it has focus? |
void |
setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)
If this item is part of a databound form, and has a specified valueMap
by default we show the valueMap options in the pickList for the item.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource . |
void |
setShowOver(java.lang.Boolean showOver)
When the user rolls over the select item, should the pickButton display it's Over state? |
void |
setShowPickerIcon(java.lang.Boolean showPickerIcon)
Should we show a special 'picker' icon for this form item. |
void |
setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class name for a form item's text box element. |
void |
setTextMatchStyle(TextMatchStyle textMatchStyle)
When applying filter criteria to pickList data, what type of matching to use. |
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 |
setValueIconField(java.lang.String valueIconField)
For Databound formItems, this property determines which column valueIcons should show up in for this formItem's pickList.If unset valueIcons show up in the displayField column if specified, otherwise
the valueField column.In most cases only the displayField or valueField will be visible. |
void |
showPicker()
Method to show a picker for this item. |
Methods inherited from class com.smartgwt.client.core.RefDataClass |
---|
getRef, getRef |
Methods inherited from class com.smartgwt.client.core.DataClass |
---|
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public SelectItem()
public SelectItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public SelectItem(java.lang.String name)
public SelectItem(java.lang.String name, java.lang.String title)
Method Detail |
---|
public static SelectItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setHeight(int height)
setHeight
in class FormItem
height
- height Default value is 19public int getHeight()
getHeight
in class FormItem
public void setAddUnknownValues(java.lang.Boolean addUnknownValues)
Exception: If the value is set to null
but there is no null entry in the
valueMap for this item, setting addUnknownValues
to true will not cause
a null option to show up at the top of the select item pickList. Whether an empty
option is shown in the pickList is governed by allowEmptyValue
instead.
Note : This is an advanced setting
addUnknownValues
- addUnknownValues Default value is truepublic java.lang.Boolean getAddUnknownValues()
Exception: If the value is set to null
but there is no null entry in the
valueMap for this item, setting addUnknownValues
to true will not cause
a null option to show up at the top of the select item pickList. Whether an empty
option is shown in the pickList is governed by allowEmptyValue
instead.
public void setDefaultValue(java.lang.Boolean defaultValue)
defaultToFirstOption
instead.
setDefaultValue
in class FormItem
defaultValue
- defaultValue Default value is nullpublic java.lang.Boolean getDefaultValue()
defaultToFirstOption
instead.
public void setDefaultToFirstOption(java.lang.Boolean defaultToFirstOption)
If options are derived from a dataSource, the first value returned by the server will be used, otherwise the first value in the valueMap. Note that setting this property to true will trigger a fetch at soon as the form is created, because the form will try to establish a default value at that time.
If enabled, this setting overrides defaultValue
and
defaultDynamicValue()
.
defaultToFirstOption
- defaultToFirstOption Default value is falsepublic java.lang.Boolean getDefaultToFirstOption()
If options are derived from a dataSource, the first value returned by the server will be used, otherwise the first value in the valueMap. Note that setting this property to true will trigger a fetch at soon as the form is created, because the form will try to establish a default value at that time.
If enabled, this setting overrides defaultValue
and
defaultDynamicValue()
.
public void setShowPickerIcon(java.lang.Boolean showPickerIcon)
pickerIconProperties
. By default they will be rendered inside the
Form Item's "control box" area, and will call showPicker()
when clicked.
setShowPickerIcon
in class FormItem
showPickerIcon
- showPickerIcon Default value is truepublic java.lang.Boolean getShowPickerIcon()
pickerIconProperties
. By default they will be rendered inside the
Form Item's "control box" area, and will call showPicker()
when clicked.
getShowPickerIcon
in class FormItem
public void setTextBoxStyle(java.lang.String textBoxStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
setTextBoxStyle
in class FormItem
textBoxStyle
- textBoxStyle Default value is "selectItemText", [IRA]public java.lang.String getTextBoxStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
getTextBoxStyle
in class FormItem
public void setControlStyle(java.lang.String controlStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
controlStyle
- controlStyle Default value is "selectItemControl", [IRA]public java.lang.String getControlStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
public void setPickerIconStyle(java.lang.String pickerIconStyle)
controlStyle
.
pickerIconStyle
- pickerIconStyle Default value is "selectItemPickerIcon", [IRA]public java.lang.String getPickerIconStyle()
controlStyle
.
public void setShowFocused(java.lang.Boolean showFocused)
Note : This is an advanced setting
setShowFocused
in class FormItem
showFocused
- showFocused Default value is true, [IRWA]public java.lang.Boolean getShowFocused()
getShowFocused
in class FormItem
public void setPickerIconWidth(java.lang.Integer pickerIconWidth)
showPickerIcon
is true for this item, this property governs the
size of the picker icon. If unset picker icon will be sized as a square to fit in the
avaliable height for the icon.
Note : This is an advanced setting
setPickerIconWidth
in class FormItem
pickerIconWidth
- 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 picker icon will be sized as a square to fit in the
avaliable height for the icon.
getPickerIconWidth
in class FormItem
public void setPickerIconHeight(java.lang.Integer pickerIconHeight)
showPickerIcon
is true for this item, this property governs the
size of the picker icon. If unset picker icon will be sized as a square to fit in the
avaliable height for the icon.
Note : This is an advanced setting
setPickerIconHeight
in class FormItem
pickerIconHeight
- 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 picker icon will be sized as a square to fit in the
avaliable height for the icon.
getPickerIconHeight
in class FormItem
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
setPickerIconSrc
in class FormItem
pickerIconSrc
- pickerIconSrc Default value is "[SKIN]/DynamicForm/SelectItem_PickButton_icon.gif"public java.lang.String getPickerIconSrc()
showPickerIcon
is true for this item, this property governs the
src of the picker icon image to be displayed.
getPickerIconSrc
in class FormItem
public void setShowOver(java.lang.Boolean showOver)
Over
state?
Note : This is an advanced setting
showOver
- showOver Default value is truepublic java.lang.Boolean getShowOver()
Over
state?
public void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
The empty value will be displayed with the
emptyDisplayValue
.
With a optionDataSource
, enabling
allowEmptyValue
disables data paging - all data matching the
pickListCriteria
will be requested.
allowEmptyValue
- allowEmptyValue Default value is falsepublic java.lang.Boolean getAllowEmptyValue()
The empty value will be displayed with the
emptyDisplayValue
.
With a optionDataSource
, enabling
allowEmptyValue
disables data paging - all data matching the
pickListCriteria
will be requested.
public void setAutoFetchData(java.lang.Boolean autoFetchData)
dataSource
, should options
be fetched from the server when the item is first drawn, or should this fetch be
delayed until the user opens the pickList.
The default is true in order to allow the user to select a value via keyboard input while keyboard focus is on the SelectItem but the pickList has not actually been shown.
Note : This is an advanced setting
autoFetchData
- autoFetchData Default value is truepublic java.lang.Boolean getAutoFetchData()
dataSource
, should options
be fetched from the server when the item is first drawn, or should this fetch be
delayed until the user opens the pickList.
The default is true in order to allow the user to select a value via keyboard input while keyboard focus is on the SelectItem but the pickList has not actually been shown.
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
DynamicForm.getValue(java.lang.String)
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.
setDisplayField
in interface PickList
setDisplayField
in class FormItem
displayField
- displayField Default value is nullpublic 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
DynamicForm.getValue(java.lang.String)
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.
getDisplayField
in interface PickList
getDisplayField
in class FormItem
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.
setValueField
in interface PickList
setValueField
in class FormItem
valueField
- 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.
getValueField
in interface PickList
getValueField
in class FormItem
public void setFilterLocally(java.lang.Boolean filterLocally)
filterLocally
is set for this item, and this item is showing options
from a dataSource, fetch the entire set of options from the server, and use these values
to map the item value to the appropriate display value. Also use "local"
type filtering on drop down list of options.
This means data will only be fetched once from the server, and then filtered on the client.
Note : This is an advanced setting
setFilterLocally
in interface PickList
setFilterLocally
in class FormItem
filterLocally
- filterLocally Default value is falsepublic java.lang.Boolean getFilterLocally()
filterLocally
is set for this item, and this item is showing options
from a dataSource, fetch the entire set of options from the server, and use these values
to map the item value to the appropriate display value. Also use "local"
type filtering on drop down list of options.
This means data will only be fetched once from the server, and then filtered on the client.
getFilterLocally
in interface PickList
getFilterLocally
in class FormItem
public void setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)
valueMap
by default we show the valueMap options in the pickList for the item.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource
.
Note : This is an advanced setting
setShowOptionsFromDataSource
in interface PickList
showOptionsFromDataSource
- showOptionsFromDataSource Default value is nullpublic java.lang.Boolean getShowOptionsFromDataSource()
valueMap
by default we show the valueMap options in the pickList for the item.
Setting this property to true will ensure that the options displayed in our pickList
are derived from the form's dataSource
.
getShowOptionsFromDataSource
in interface PickList
public void setMultiple(java.lang.Boolean multiple)
In this case the logical value of the formItem, as retrieved by
FormItem.getValue()
and set via FormItem.setValue(int)
, is
an Array of Strings reflecting the selected values.
Note: multiple:true
SelectItems do not currently support optionDataSource
binding. You can get around this by calling DataSource.fetchData() directly and creating
a valueMap for the item from the resulting array.
multiple
- multiple Default value is falsepublic java.lang.Boolean getMultiple()
In this case the logical value of the formItem, as retrieved by
FormItem.getValue()
and set via FormItem.setValue(int)
, is
an Array of Strings reflecting the selected values.
Note: multiple:true
SelectItems do not currently support optionDataSource
binding. You can get around this by calling DataSource.fetchData() directly and creating
a valueMap for the item from the resulting array.
public void defaultDynamicValue()
defaultValue
when no value is
provided for this item. To default to the first option use
defaultToFirstOption
instead.
public java.lang.String getDisplayFieldName()
displayField
for this form item.
If unset, and optionDataSource
is explicitly specified, this method
will return the title field for the optionDataSource
getDisplayFieldName
in interface PickList
getDisplayFieldName
in class FormItem
public java.lang.String getValueFieldName()
valueField
for this item.
If unset, default behavior will return the name
of this field.
getValueFieldName
in interface PickList
getValueFieldName
in class FormItem
optionDataSource
protected Criteria getPickListFilterCriteria()
public void setPickListFields(ListGridField... pickListFields)
Only applies to databound pickLists (see optionDataSource
, or picklists with custom data set up via the advanced com.smartgwt.client..PickList#getClientPickListData
method.
If this property is unset, we display the displayField
, if specified, otherwise the valueField
If there are multiple fields, column headers will be
shown for each field, the height of which can be customized via the pickListHeaderHeight
attribute.
Each field to display should be specified as a
ListGridField
object. Note that unlike in ListGrid
, dataSource fields marked as com.smartgwt.client.data.DataSourceField#setDis${isc.DocUtils.linkForRef('DataSourceField.display','display:true')}
will not be hidden by default in pickLists. To override this behavior, ensure that you specify an explicit value
for {@link com.smartgwt.client.widgets.grid.ListGridField#getShowIf showIf}
Note : This is an advanced setting
pickListFields
- pickListFields Default value is nullpublic void setPickListHeight(int pickListHeight)
setPickListHeight
in interface PickList
pickListHeight
- pickListHeight Default value is 300public int getPickListHeight()
getPickListHeight
in interface PickList
public void setEmptyPickListHeight(int emptyPickListHeight)
hideEmptyPickList
is false
.
setEmptyPickListHeight
in interface PickList
emptyPickListHeight
- emptyPickListHeight Default value is 100public int getEmptyPickListHeight()
hideEmptyPickList
is false
.
getEmptyPickListHeight
in interface PickList
public void setEmptyPickListMessage(java.lang.String emptyPickListMessage)
hideEmptyPickList
is false
. Note : This is an advanced setting
setEmptyPickListMessage
in interface PickList
emptyPickListMessage
- emptyPickListMessage Default value is nullpublic java.lang.String getEmptyPickListMessage()
hideEmptyPickList
is false
.
getEmptyPickListMessage
in interface PickList
public void setHideEmptyPickList(java.lang.Boolean hideEmptyPickList)
setHideEmptyPickList
in interface PickList
hideEmptyPickList
- hideEmptyPickList Default value is nullpublic java.lang.Boolean getHideEmptyPickList()
getHideEmptyPickList
in interface PickList
public void setPickListWidth(java.lang.Integer pickListWidth)
setPickListWidth
in interface PickList
pickListWidth
- pickListWidth Default value is nullpublic java.lang.Integer getPickListWidth()
getPickListWidth
in interface PickList
public void setPickListBaseStyle(java.lang.String pickListBaseStyle)
setPickListBaseStyle
in interface PickList
pickListBaseStyle
- pickListBaseStyle Default value is "pickListCell"public java.lang.String getPickListBaseStyle()
getPickListBaseStyle
in interface PickList
public void setAnimatePickList(java.lang.Boolean animatePickList)
Note : This is an advanced setting
setAnimatePickList
in interface PickList
animatePickList
- animatePickList Default value is nullpublic java.lang.Boolean getAnimatePickList()
getAnimatePickList
in interface PickList
public void setAnimationTime(int animationTime)
Note : This is an advanced setting
setAnimationTime
in interface PickList
animationTime
- animationTime Default value is 200public int getAnimationTime()
getAnimationTime
in interface PickList
public void setPickListHeaderHeight(int pickListHeaderHeight)
setPickListHeaderHeight
in interface PickList
pickListHeaderHeight
- pickListHeaderHeight Default value is 22public int getPickListHeaderHeight()
getPickListHeaderHeight
in interface PickList
public void setValueIconField(java.lang.String valueIconField)
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible. This property is typically only
required if custom pickListFields
have been specfied for this item. Note : This is an advanced setting
setValueIconField
in interface PickList
valueIconField
- valueIconField Default value is nullpublic java.lang.String getValueIconField()
valueIcons
should show up in for this formItem's pickList.displayField
column if specified, otherwise
the valueField
column.displayField
or valueField
will be visible. This property is typically only
required if custom pickListFields
have been specfied for this item.
getValueIconField
in interface PickList
public void setPickListCriteria(Criteria pickListCriteria)
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList. Note : This is an advanced setting
setPickListCriteria
in interface PickList
pickListCriteria
- pickListCriteria Default value is nullpublic Criteria getPickListCriteria()
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
getPickListCriteria
in interface PickList
public void setTextMatchStyle(TextMatchStyle textMatchStyle)
For a databound pickList (optionDataSource
set), textMatchStyle
is sent to the server as textMatchStyle
.
For a non-databound pickList,
textMatchStyle
is applied by com.smartgwt.client.widgets.form.fields.PickList#filterClientPickListData
.
setTextMatchStyle
in interface PickList
textMatchStyle
- textMatchStyle Default value is "startsWith"public TextMatchStyle getTextMatchStyle()
For a databound pickList (optionDataSource
set), textMatchStyle
is sent to the server as textMatchStyle
.
For a non-databound pickList,
textMatchStyle
is applied by com.smartgwt.client.widgets.form.fields.PickList#filterClientPickListData
.
getTextMatchStyle
in interface PickList
public void setShowAllOptions(java.lang.Boolean showAllOptions)
separatorRows
in between. Not valid for optionDataSource
.
setShowAllOptions
in interface PickList
showAllOptions
- showAllOptions Default value is nullpublic java.lang.Boolean getShowAllOptions()
separatorRows
in between. Not valid for optionDataSource
.
getShowAllOptions
in interface PickList
public void setPickListCriteria(RPCRequest optionFilterContext)
optionDataSource
, and this property is not null, this will be passed to
the datasource as RPCRequest
properties when performing the filter operation on
the dataSource to obtain the set of options for the list. Note : This is an advanced setting
optionFilterContext
- optionFilterContext Default value is nullpublic void setOptionDataSource(DataSource dataSource)
optionDataSource
. The fetched data will be used as a valueMap
by extracting the valueField
and
displayField
in the loaded records, to
derive one valueMap entry per record loaded from the optionDataSource. Multiple fields from the fetched data may
be shown in the pickList by setting pickListFields
. The data will be retrieved via a "fetch" operation on the DataSource, passing the pickListCriteria
(if set) as criteria, and passing optionFilterContext
(if set) as
DSRequest properties.
The fetch will be triggered when the pickList is first shown, or, you can set autoFetchData
to fetch when the FormItem is
first drawn. You can also call com.smartgwt.client..PickList#fetchData
at any time to manually trigger
a fetch.
Data paging is automatically enabled if the optionDataSource supports it. As the pickList is scrolled by the user, requests for additional data will be automatically issued.
For a pickList attached to a
ComboBoxItem, new fetches are issued as the user types, with criteria set as described under ComboBoxItem.getPickListFilterCriteria()
. If your dataSource is not
capable of filtering results by search criteria (eg the dataSource is backed by an XML flat file), you can set
filterLocally
to have the entire
dataset loaded up front and filtering performed in the browser. This disables data paging.
Setting
optionDataSource also enables the basic optionDataSource
behaviors, eg, fetching individual display values before the pickList is shown.
Note that
if a normal, static valueMap
is also
specified for the field (either directly in the form item or as part of the field definition in the dataSource),
it will be preferred to the data derived from the optionDataSource for whatever mappings are present.
Note : This is an advanced setting
setOptionDataSource
in class FormItem
optionDataSource
- optionDataSource Default value is nullpublic void setSeparatorRows(ListGridRecord[] separatorRows)
public void setDefaultValues(java.lang.String... defaultValues)
null
programatically, it will be reverted to the defaultValues
.
defaultValues
- the defaultValues. Default value is nullpublic void setDefaultValues(java.lang.Integer... defaultValues)
null
programatically, it will be reverted to the defaultValues
.
defaultValues
- the defaultValues. Default value is nullpublic void setFetchDelay(java.lang.Integer fetchDelay)
PickList
setFetchDelay
in interface PickList
fetchDelay
- the fetch delay. defaults to 200mspublic java.lang.Integer getFetchDelay()
PickList
getFetchDelay
in interface PickList
public java.lang.String[] getValues()
public void fetchData()
optionDataSource
).pickListCriteria
.
public void fetchData(DSCallback callback)
optionDataSource
).pickListCriteria
.
callback
- Callback to fire when the fetch completes. Callback will fire with 2 parameters:
item
a pointer to the form item and dsResponse
the DSResponse
returned by the server.public void fetchData(DSCallback callback, DSRequest requestProperties)
optionDataSource
).pickListCriteria
.
callback
- Callback to fire when the fetch completes. Callback will fire with 2
parameters: item
a pointer to the form item and
dsResponse
the DSResponse
returned by the
server.requestProperties
- properties to apply to the dsRequest for this fetch.public void setFields(FormItemIcon pickerIconProperties)
public void showPicker()
this.showPickerIcon
to true. May also be called programatically.
public ListGridRecord getSelectedRecord()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |