public class PickTreeItem extends CanvasItem
id| Constructor and Description |
|---|
PickTreeItem() |
PickTreeItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
PickTreeItem(java.lang.String name) |
PickTreeItem(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
void |
fetchData()
Only applies to databound items (see
optionDataSource).Performs a fetch type operation on this item's DataSource to retrieve/refresh the tree of data displayed as rows in this items menu. |
java.lang.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. |
java.lang.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. |
java.lang.String |
getEmptyDisplayValue()
Text to display when this form item has a null or undefined value.
|
java.lang.String |
getEmptyMenuMessage()
This message will be displayed as a single, disabled option in any empty menu/submenu created from this item's data
tree.
|
java.lang.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?
|
DataSource |
getOptionDataSource()
If set, this FormItem will map stored values to display values as though a ValueMap were specified, by fetching records
from the specified
optionDataSource and extracting the valueField and displayField in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. |
static PickTreeItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
ReadOnlyDisplayAppearance |
getReadOnlyDisplay()
If
canEdit is set to false, how should
this item be displayed to the user? |
java.lang.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(java.lang.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.
|
static void |
setDefaultProperties(PickTreeItem pickTreeItemProperties)
Class level method to set the default properties of this class.
|
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 ( 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 |
setEmptyDisplayValue(java.lang.String emptyDisplayValue)
Text to display when this form item has a null or undefined value.
|
void |
setEmptyMenuMessage(java.lang.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 |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
void |
setLoadDataOnDemand(java.lang.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 |
setOptionDataSource(DataSource optionDataSource)
If set, this FormItem will map stored values to display values as though a ValueMap were specified, by fetching records
from the specified
optionDataSource and extracting the valueField and displayField in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. |
void |
setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
If
canEdit is set to false, how should
this item be displayed to the user? |
void |
setValueField(java.lang.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. |
addCanEditChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getMultiple, getOverflow, getPrompt, getShouldSaveValue, hasAdvancedCriteria, readOnlyDisplayChanged, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setMultiple, setOverflow, setPrompt, setShouldSaveValue, setupCanvasConstructor, storeValue, storeValue, storeValue_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWrapTitle, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanFocus, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setCriteriaField, setCriterion, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, show, showIcon, showPicker, stopHover, updateState, validate, valueClippedgetRef, getRef, internalSetIDdoAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObjectpublic PickTreeItem()
public PickTreeItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public PickTreeItem(java.lang.String name)
public PickTreeItem(java.lang.String name,
java.lang.String title)
public static PickTreeItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject in class CanvasItempublic static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setCanSelectParentItems(java.lang.Boolean canSelectParentItems)
canSelectParentItems - canSelectParentItems Default value is nullSelection overview and related methods,
Editing Examplepublic java.lang.Boolean getCanSelectParentItems()
Selection overview and related methods,
Editing Examplepublic void setDisplayField(java.lang.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 FormItemdisplayField - . See String. Default value is nullFormItem.invalidateDisplayValueCache()public java.lang.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 FormItemStringFormItem.invalidateDisplayValueCache()public void setEmptyDisplayValue(java.lang.String emptyDisplayValue)
If the formItem has a databound pickList, and its
displayField or valueField (if the former isn't set) has an undefined
emptyCellValue setting, that field's
emptyCellValue will automatically be set to the emptyDisplayValue.
If this method is called after the component has been drawn/initialized:
Setter for emptyDisplayValue.
setEmptyDisplayValue in class FormItememptyDisplayValue - . See String. Default value is nullpublic java.lang.String getEmptyDisplayValue()
If the formItem has a databound pickList, and its
displayField or valueField (if the former isn't set) has an undefined
emptyCellValue setting, that field's
emptyCellValue will automatically be set to the emptyDisplayValue.
getEmptyDisplayValue in class FormItemStringpublic void setEmptyMenuMessage(java.lang.String emptyMenuMessage)
Note : This is an advanced setting
emptyMenuMessage - . See String. Default value is "No items to display"public java.lang.String getEmptyMenuMessage()
Stringpublic void setLoadDataOnDemand(java.lang.Boolean loadDataOnDemand)
Note : This is an advanced setting
loadDataOnDemand - loadDataOnDemand Default value is nullpublic java.lang.Boolean getLoadDataOnDemand()
public void setOptionDataSource(DataSource optionDataSource)
optionDataSource and extracting the valueField and displayField in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. With the default setting of fetchMissingValues, fetches will be
initiated against the optionDataSource any time the FormItem has a non-null value and no corresponding display value is
available. This includes when the form is first initialized, as well as any subsequent calls to FormItem.setValue, such as may happen when DynamicForm.editRecord is called. Retrieved values are
automatically cached by the FormItem.
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.
In a databound form, if displayField is specified for a FormItem and
optionDataSource is unset, optionDataSource will default to the form's current DataSource
setOptionDataSource in class FormItemoptionDataSource - optionDataSource Default value is nullpublic DataSource getOptionDataSource()
optionDataSource and extracting the valueField and displayField in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. With the default setting of fetchMissingValues, fetches will be
initiated against the optionDataSource any time the FormItem has a non-null value and no corresponding display value is
available. This includes when the form is first initialized, as well as any subsequent calls to FormItem.setValue, such as may happen when DynamicForm.editRecord is called. Retrieved values are
automatically cached by the FormItem.
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.
In a databound form, if displayField is specified for a FormItem and
optionDataSource is unset, optionDataSource will default to the form's current DataSource
public void setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
canEdit is set to false, how should
this item be displayed to the user? The default value for PickTreeItems is disabled - note that
readOnly and static appearances have no effect for PickTreeItems.
setReadOnlyDisplay in class FormItemreadOnlyDisplay - readOnlyDisplay Default value is "disabled"DynamicForm.setReadOnlyDisplay(com.smartgwt.client.types.ReadOnlyDisplayAppearance)public ReadOnlyDisplayAppearance getReadOnlyDisplay()
canEdit is set to false, how should
this item be displayed to the user? The default value for PickTreeItems is disabled - note that
readOnly and static appearances have no effect for PickTreeItems.
getReadOnlyDisplay in class FormItemDynamicForm.getReadOnlyDisplay()public void setValueField(java.lang.String valueField)
setValueField in class FormItemvalueField - . See String. Default value is nullpublic java.lang.String getValueField()
getValueField in class FormItemStringpublic void fetchData()
optionDataSource).public static void setDefaultProperties(PickTreeItem pickTreeItemProperties)
Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.
pickTreeItemProperties - properties that should be used as new defaults when instances of this class are createdpublic 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.