|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PickList
Interface to show a drop-down list of pickable options. Used by the SelectItem
and ComboBoxItem
classes.
Method Summary | |
---|---|
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.String |
getDisplayField()
Specifies an alternative field from which display values should be retrieved for this item. If this item is not databound ( optionDataSource is
unset), or bound to the same dataSource as the form as a whole, this 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.This essentially enables the specified optionDataSource to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}. |
java.lang.String |
getDisplayFieldName()
Returns the displayField for this form
item. |
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 |
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.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. |
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. |
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. |
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. |
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 |
setDisplayField(java.lang.String displayField)
Specifies an alternative field from which display values should be retrieved for this item. If this item is not databound ( optionDataSource is
unset), or bound to the same dataSource as the form as a whole, this 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.This essentially enables the specified optionDataSource to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}. |
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 |
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 |
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 |
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. |
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. |
Method Detail |
---|
void setPickListHeight(int pickListHeight)
pickListHeight
- pickListHeight Default value is 300int getPickListHeight()
void setEmptyPickListHeight(int emptyPickListHeight)
hideEmptyPickList
is false
.
emptyPickListHeight
- emptyPickListHeight Default value is 100int getEmptyPickListHeight()
hideEmptyPickList
is false
.
void setEmptyPickListMessage(java.lang.String emptyPickListMessage)
hideEmptyPickList
is false
. Note : This is an advanced setting
emptyPickListMessage
- emptyPickListMessage Default value is nulljava.lang.String getEmptyPickListMessage()
hideEmptyPickList
is false
.
void setHideEmptyPickList(java.lang.Boolean hideEmptyPickList)
hideEmptyPickList
- hideEmptyPickList Default value is nulljava.lang.Boolean getHideEmptyPickList()
void setPickListWidth(java.lang.Integer pickListWidth)
pickListWidth
- pickListWidth Default value is nulljava.lang.Integer getPickListWidth()
void setPickListBaseStyle(java.lang.String pickListBaseStyle)
pickListBaseStyle
- pickListBaseStyle Default value is "pickListCell"java.lang.String getPickListBaseStyle()
void setAnimatePickList(java.lang.Boolean animatePickList)
Note : This is an advanced setting
animatePickList
- animatePickList Default value is nulljava.lang.Boolean getAnimatePickList()
void setAnimationTime(int animationTime)
Note : This is an advanced setting
animationTime
- animationTime Default value is 200int getAnimationTime()
void setPickListHeaderHeight(int pickListHeaderHeight)
pickListHeaderHeight
- pickListHeaderHeight Default value is 22int getPickListHeaderHeight()
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. Note : This is an advanced setting
valueField
- valueField Default value is nulljava.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.
void setDisplayField(java.lang.String displayField)
optionDataSource
is
unset), or bound to the same dataSource as the form as a whole, this is implemented by picking up the value of
the specified field from the Form's values object.optionDataSource
where the valueField
matches this item's value, and displaying the displayField
value from that record.optionDataSource
to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}.
displayField
- displayField Default value is nulljava.lang.String getDisplayField()
optionDataSource
is
unset), or bound to the same dataSource as the form as a whole, this is implemented by picking up the value of
the specified field from the Form's values object.optionDataSource
where the valueField
matches this item's value, and displaying the displayField
value from that record.optionDataSource
to be used as a server based
${isc.DocUtils.linkForRef('group:valueMap')}.
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
valueIconField
- valueIconField Default value is nulljava.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.
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
pickListCriteria
- pickListCriteria Default value is nullCriteria getPickListCriteria()
optionDataSource
is set) this property can be used to provide static filter criteria when retrieving the data
for the pickList.
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
showOptionsFromDataSource
- showOptionsFromDataSource Default value is nulljava.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
.
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.Note : This is an advanced setting
filterLocally
- filterLocally Default value is falsejava.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.
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
.
textMatchStyle
- textMatchStyle Default value is "startsWith"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
.
void setShowAllOptions(java.lang.Boolean showAllOptions)
separatorRows
in between. Not valid for optionDataSource
.
showAllOptions
- showAllOptions Default value is nulljava.lang.Boolean getShowAllOptions()
separatorRows
in between. Not valid for optionDataSource
.
java.lang.String getValueFieldName()
valueField
for this item. If unset, default behavior will return the name
of this field.
optionDataSource
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
void setFetchDelay(java.lang.Integer fetchDelay)
fetchDelay
- the fetch delay. defaults to 200msjava.lang.Integer getFetchDelay()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |