|
|||||||||
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.ComboBoxItem
public class ComboBoxItem
The Combobox is a text input field which can show a list of options via a drop-down PickList.
The set of options will be filtered based on the current value in the text field, so only
options that match what has been typed so far will be displayed.
The set of options can be derived from a ValueMap or dynamically retrieved from a
dataSource. See the com.smartgwt.client..PickList
interface for further settings.
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 | |
---|---|
ComboBoxItem()
|
|
ComboBoxItem(com.google.gwt.core.client.JavaScriptObject jsObj)
|
|
ComboBoxItem(java.lang.String name)
|
|
ComboBoxItem(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()
|
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 |
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 combo box retrieves its options from a dataSource , should options
be fetched from the server when the item is first written out, or should this fetch be
delayed until the user opens the pickList. |
java.lang.Boolean |
getCompleteOnTab()
If true, when the pickList is showing, the user can select the current value by hitting the Tab key. |
java.lang.Boolean |
getDefaultToFirstOption()
Select the first option as the default value for this ComboBoxItem. |
java.lang.Boolean |
getDefaultValue()
Static default value for this ComboBoxItem. |
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. |
java.lang.Boolean |
getFilterWithValue()
Read-only property set by the ComboBoxItem to indicate whether we should use the current typed-in value as part of the filter criteria returned by getPickListFilterCriteria() . |
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. |
static ComboBoxItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
java.lang.Integer |
getPickerIconHeight()
Don't specify an explicit height for the picker icon - instead have it size to match the height of the combo box item. |
java.lang.String |
getPickerIconSrc()
Src for 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 filter criteria for options displayed for this item. |
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 |
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 |
getShowPickerIcon()
Show the picker icon for the combo box |
java.lang.Boolean |
getShowPickListOnKeypress()
Should the list of options be displayed whenever the user types into the the combo-box textArea, or only when the user clicks on the pick button or uses the explicit Alt+Arrow Down key combo? |
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. |
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 combo box retrieves its options from a dataSource , should options
be fetched from the server when the item is first written out, or should this fetch be
delayed until the user opens the pickList. |
void |
setCompleteOnTab(java.lang.Boolean completeOnTab)
If true, when the pickList is showing, the user can select the current value by hitting the Tab key. |
void |
setDefaultToFirstOption(java.lang.Boolean defaultToFirstOption)
Select the first option as the default value for this ComboBoxItem. |
void |
setDefaultValue(java.lang.Boolean defaultValue)
Static default value for this ComboBoxItem. |
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 |
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 |
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 |
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)
Don't specify an explicit height for the picker icon - instead have it size to match the height of the combo box item. |
void |
setPickerIconSrc(java.lang.String pickerIconSrc)
Src for 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)
|
void |
setPickListFields(ListGridField... pickListFields)
|
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)
Array of records to show between matching and non-matching rows in the PickList. |
void |
setShowAllOptions(java.lang.Boolean showAllOptions)
If true, even non-matching options will be shown, with configurable separatorRows in between. |
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 |
setShowPickerIcon(java.lang.Boolean showPickerIcon)
Show the picker icon for the combo box |
void |
setShowPickListOnKeypress(java.lang.Boolean showPickListOnKeypress)
Should the list of options be displayed whenever the user types into the the combo-box textArea, or only when the user clicks on the pick button or uses the explicit Alt+Arrow Down key combo? |
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. |
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 ComboBoxItem()
public ComboBoxItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public ComboBoxItem(java.lang.String name)
public ComboBoxItem(java.lang.String name, java.lang.String title)
Method Detail |
---|
public static ComboBoxItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
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)
defaultValue
and defaultDynamicValue()
|.
defaultToFirstOption
- defaultToFirstOption Default value is falsepublic java.lang.Boolean getDefaultToFirstOption()
defaultValue
and defaultDynamicValue()
|.
public void setShowPickerIcon(java.lang.Boolean showPickerIcon)
Note : This is an advanced setting
setShowPickerIcon
in class FormItem
showPickerIcon
- showPickerIcon Default value is truepublic java.lang.Boolean getShowPickerIcon()
getShowPickerIcon
in class FormItem
public void setPickerIconHeight(java.lang.Integer pickerIconHeight)
setPickerIconHeight
in class FormItem
pickerIconHeight
- pickerIconHeight Default value is nullpublic java.lang.Integer getPickerIconHeight()
getPickerIconHeight
in class FormItem
public void setPickerIconSrc(java.lang.String pickerIconSrc)
Note : This is an advanced setting
setPickerIconSrc
in class FormItem
pickerIconSrc
- pickerIconSrc Default value is "[SKIN]/DynamicForm/ComboBoxItem_PickButton_icon.gif"public java.lang.String getPickerIconSrc()
getPickerIconSrc
in class FormItem
public void setShowPickListOnKeypress(java.lang.Boolean showPickListOnKeypress)
Alt+Arrow Down
key combo?
showPickListOnKeypress
- showPickListOnKeypress Default value is truepublic java.lang.Boolean getShowPickListOnKeypress()
Alt+Arrow Down
key combo?
public void setCompleteOnTab(java.lang.Boolean completeOnTab)
Tab
key.
completeOnTab
- completeOnTab Default value is nullpublic java.lang.Boolean getCompleteOnTab()
Tab
key.
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.
Note : This is an advanced setting
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 setAutoFetchData(java.lang.Boolean autoFetchData)
dataSource
, should options
be fetched from the server when the item is first written out, or should this fetch be
delayed until the user opens the pickList.
Note : This is an advanced setting
autoFetchData
- autoFetchData Default value is falsepublic java.lang.Boolean getAutoFetchData()
dataSource
, should options
be fetched from the server when the item is first written out, or should this fetch be
delayed until the user opens the pickList.
public java.lang.Boolean getFilterWithValue()
getPickListFilterCriteria()
. You can check this flag in order to
mimic the ComboBoxItem's default behavior if you provide a custom implementation of
getPickListFilterCriteria()
.
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 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 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 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 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 setPickListCriteria(RPCRequest optionFilterContext)
public 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 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 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
dataSource
- optionDataSource Default value is nullpublic void setSeparatorRows(ListGridRecord[] separatorRows)
Not valid for optionDataSource
.
separatorRows
- separatorRows Default value is [{isSeparator:true}]public void fetchData()
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 setPickListFields(ListGridField... pickListFields)
public ListGridRecord getSelectedRecord()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |