|
|||||||||
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.CanvasItem
com.smartgwt.client.widgets.form.fields.PickTreeItem
public class PickTreeItem
FormItem that allows picking a value from a hierarchical data model.
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
PickTreeItem()
|
|
PickTreeItem(JavaScriptObject jsObj)
|
|
PickTreeItem(String name)
|
|
PickTreeItem(String name,
String title)
|
Method Summary | |
---|---|
Boolean |
getCanSelectParentItems()
If true, clicking or pressing Enter on a menu item that has a submenu will select that item (with standard behavior of hiding the menus, calling click handlers, etc) instead of showing the submenu. |
DataSource |
getDataSource()
The DataSource that this component should bind to for default fields and for performing DSRequest . |
String |
getDisplayField()
Specifies an alternative field from which display values should be retrieved for this item. If this item is not databound ( dataSource is unset), this is
implemented by picking up the value of the specified field from the valueTree .Otherwise this item will attempt to map its underlying value to a display value by retrieving a record from the dataSource where the valueField matches this item's value, and displaying
the displayField value from that record. |
String |
getEmptyMenuMessage()
This message will be displayed as a single, disabled option in any empty menu/submenu created from this item's data tree. |
Boolean |
getLoadDataOnDemand()
If this is a databound item, should the load our set of possible options be loaded on demand (as submenus are displayed), or upfront? |
static PickTreeItem |
getOrCreateRef(JavaScriptObject jsObj)
|
String |
getValueField()
Which field in the tree-data should be returned as this item's value? If unspecified, the path will be used |
void |
setCanSelectParentItems(Boolean canSelectParentItems)
If true, clicking or pressing Enter on a menu item that has a submenu will select that item (with standard behavior of hiding the menus, calling click handlers, etc) instead of showing the submenu. |
void |
setDataSource(DataSource dataSource)
If specified, the tree of possible options will be derived from the dataSource as a ResultTree, rather than using this.valueTree. |
void |
setDisplayField(String displayField)
Specifies an alternative field from which display values should be retrieved for this item. If this item is not databound ( dataSource is unset), this is
implemented by picking up the value of the specified field from the valueTree .Otherwise this item will attempt to map its underlying value to a display value by retrieving a record from the dataSource where the valueField matches this item's value, and displaying
the displayField value from that record. |
void |
setEmptyMenuMessage(String emptyMenuMessage)
This message will be displayed as a single, disabled option in any empty menu/submenu created from this item's data tree. |
void |
setLoadDataOnDemand(Boolean loadDataOnDemand)
If this is a databound item, should the load our set of possible options be loaded on demand (as submenus are displayed), or upfront? |
void |
setValueField(String valueField)
Which field in the tree-data should be returned as this item's value? If unspecified, the path will be used |
void |
setValueTree(Tree valueTree)
A Tree of options from which the user can select. |
Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem |
---|
getCanvas, setCanvas |
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 |
Constructor Detail |
---|
public PickTreeItem()
public PickTreeItem(JavaScriptObject jsObj)
public PickTreeItem(String name)
public PickTreeItem(String name, String title)
Method Detail |
---|
public static PickTreeItem getOrCreateRef(JavaScriptObject jsObj)
public void setLoadDataOnDemand(Boolean loadDataOnDemand)
Note : This is an advanced setting
loadDataOnDemand
- loadDataOnDemand Default value is nullpublic Boolean getLoadDataOnDemand()
public void setDisplayField(String displayField)
dataSource
is unset), this is
implemented by picking up the value of the specified field from the valueTree
.dataSource
where the valueField
matches this item's value, and displaying
the displayField
value from that record.
setDisplayField
in class FormItem
displayField
- displayField Default value is nullpublic String getDisplayField()
dataSource
is unset), this is
implemented by picking up the value of the specified field from the valueTree
.dataSource
where the valueField
matches this item's value, and displaying
the displayField
value from that record.
getDisplayField
in class FormItem
public void setValueField(String valueField)
setValueField
in class FormItem
valueField
- valueField Default value is nullpublic String getValueField()
getValueField
in class FormItem
public void setEmptyMenuMessage(String emptyMenuMessage)
Note : This is an advanced setting
emptyMenuMessage
- emptyMenuMessage Default value is "No items to display"public String getEmptyMenuMessage()
public void setCanSelectParentItems(Boolean canSelectParentItems)
canSelectParentItems
- canSelectParentItems Default value is nullpublic Boolean getCanSelectParentItems()
public void setDataSource(DataSource dataSource)
loadDataOnDemand
. Note : This is an advanced setting
dataSource
- dataSource Default value is nullpublic DataSource getDataSource()
DSRequest
. Can be specified as either a DataSource instance or the String ID of a DataSource.
public void setValueTree(Tree valueTree)
Tree
of options from which the user can select.
valueTree
- valueTree Default value is null
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |