public class PickTreeItem extends CanvasItem
FormItem.CustomStateGetter, FormItem.StateCustomizerconfigOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultidfactoryCreated, factoryProperties| 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. |
Canvas |
getButton()
The visible button created by a PickTreeItem is an
com.smartgwt.client.types.AutoChild of type TreeMenuButton by default. |
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.
|
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
com.smartgwt.client.types.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) |
java.lang.String |
getPendingButtonStyle()
|
ReadOnlyDisplayAppearance |
getReadOnlyDisplay()
If
FormItem.canEdit is set to false,
how should this item be displayed to the user? |
java.lang.Boolean |
getShouldSaveValue()
Should this item's value be saved in the form's values and hence returned from
form.getValues()? |
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
|
boolean |
pendingStatusChanged(DynamicForm form,
FormItem item,
boolean pendingStatus,
java.lang.Object newValue,
java.lang.Object value)
Notification method called when
showPending is
enabled and this PickTreeItem should either clear or show its pending visual state. |
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 |
setDataProperties(Tree dataProperties)
For a
PickTreeItem that uses a DataSource, these properties will be passed
to the automatically-created ResultTree. |
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.
|
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 |
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
com.smartgwt.client.types.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 |
setPendingButtonStyle(java.lang.String pendingButtonStyle)
|
void |
setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
If
FormItem.canEdit is set to false,
how should this item be displayed to the user? |
void |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Should this item's value be saved in the form's values and hence returned from
form.getValues()? |
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, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getMultiple, getOverflow, getPrompt, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPosition_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisableIconsOnReadOnly, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyCanSelectText, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueDeselectedCSSText, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapHintText, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, setApplyAlignToText, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setAutoCompleteKeywords, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEditProxyConstructor, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapHintText, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedpublic 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 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. For usage tips on this
param, see SGWTProperties.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. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public Canvas getButton()
com.smartgwt.client.types.AutoChild of type TreeMenuButton by default.
This component is an AutoChild named "button". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
public void setCanSelectParentItems(java.lang.Boolean canSelectParentItems)
canSelectParentItems - New canSelectParentItems value. 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)
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.
setDisplayField in class FormItemdisplayField - New displayField value. Default value is nullFormItem.getDisplayFieldName(),
FormItem.invalidateDisplayValueCache(),
Databinding overview and related methodspublic java.lang.String getDisplayField()
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.
getDisplayField in class FormItemFormItem.getDisplayFieldName(),
FormItem.invalidateDisplayValueCache(),
Databinding overview and related methodspublic void setEmptyDisplayValue(java.lang.String emptyDisplayValue)
If the formItem has a databound pickList, and its
FormItem.displayField or FormItem.valueField (if the former isn't set) has an
undefined emptyCellValue field, that field will automatically be set using the emptyDisplayValue property.
If the
emptyDisplayValue is null (the default) then this item will use the standard title of the tree menu button that is shown
when no values are selected.
If this method is called after the component has been drawn/initialized:
Setter for emptyDisplayValue.
setEmptyDisplayValue in class FormItememptyDisplayValue - New emptyDisplayValue value. Default value is nullHTMLStringpublic java.lang.String getEmptyDisplayValue()
If the formItem has a databound pickList, and its
FormItem.displayField or FormItem.valueField (if the former isn't set) has an
undefined emptyCellValue field, that field will automatically be set using the emptyDisplayValue property.
If the emptyDisplayValue is null (the default) then this item will use the standard title of the tree menu button that is shown when no values are selected.
getEmptyDisplayValue in class FormItemHTMLStringpublic void setEmptyMenuMessage(java.lang.String emptyMenuMessage)
Note : This is an advanced setting
emptyMenuMessage - New emptyMenuMessage value. Default value is "No items to display"HTMLString,
Picktree Examplepublic java.lang.String getEmptyMenuMessage()
HTMLString,
Picktree Examplepublic void setLoadDataOnDemand(java.lang.Boolean loadDataOnDemand)
Note : This is an advanced setting
loadDataOnDemand - New loadDataOnDemand value. Default value is nullpublic java.lang.Boolean getLoadDataOnDemand()
public void setOptionDataSource(DataSource optionDataSource)
com.smartgwt.client.types.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. 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 FormItem.displayField is specified for a FormItem and
optionDataSource is unset, optionDataSource will default to the form's current DataSource
setOptionDataSource in class FormItemoptionDataSource - New optionDataSource value. Default value is nullFormItem.invalidateDisplayValueCache(),
List - Combo Box Examplepublic DataSource getOptionDataSource()
com.smartgwt.client.types.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. 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 FormItem.displayField is specified for a FormItem and
optionDataSource is unset, optionDataSource will default to the form's current DataSource
getOptionDataSource in class FormItemFormItem.invalidateDisplayValueCache(),
List - Combo Box Examplepublic void setPendingButtonStyle(java.lang.String pendingButtonStyle)
showPending is true, the
Button.baseStyle of the button when in the "Pending" visual state. If unset,
then the baseStyle of the button is not changed.
pendingButtonStyle - New pendingButtonStyle value. Default value is "buttonPending"CSSStyleNamepublic java.lang.String getPendingButtonStyle()
showPending is true, the
Button.baseStyle of the button when in the "Pending" visual state. If unset,
then the baseStyle of the button is not changed.
CSSStyleNamepublic void setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
FormItem.canEdit is set to false,
how should this item be displayed to the user? For PickTreeItems, this setting affects only the item's title - the
button itself will always appear disabled when canEdit is false, since buttons don't provide readOnly or
static appearances.
setReadOnlyDisplay in class FormItemreadOnlyDisplay - New readOnlyDisplay value. Default value is nullDynamicForm.setReadOnlyDisplay(com.smartgwt.client.types.ReadOnlyDisplayAppearance)public ReadOnlyDisplayAppearance getReadOnlyDisplay()
FormItem.canEdit is set to false,
how should this item be displayed to the user? For PickTreeItems, this setting affects only the item's title - the
button itself will always appear disabled when canEdit is false, since buttons don't provide readOnly or
static appearances.
getReadOnlyDisplay in class FormItemDynamicForm.getReadOnlyDisplay()public void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
form.getValues()? shouldSaveValue:false is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false item should
be given a value either via FormItem.defaultValue or by calling form.setValue(item,
value) or formItem.setValue(value). Providing a
value via form.values or form.setValues() will automatically switch the item to
shouldSaveValue:true.
Note that
setShouldSaveValue in class CanvasItemshouldSaveValue - New shouldSaveValue value. Default value is truepublic java.lang.Boolean getShouldSaveValue()
form.getValues()? shouldSaveValue:false is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false item should
be given a value either via FormItem.defaultValue or by calling form.setValue(item,
value) or formItem.setValue(value). Providing a
value via form.values or form.setValues() will automatically switch the item to
shouldSaveValue:true.
Note that
getShouldSaveValue in class CanvasItempublic void setValueField(java.lang.String valueField)
setValueField in class FormItemvalueField - New valueField value. Default value is nullpublic java.lang.String getValueField()
getValueField in class FormItempublic void fetchData()
optionDataSource).public boolean pendingStatusChanged(DynamicForm form, FormItem item, boolean pendingStatus, java.lang.Object newValue, java.lang.Object value)
showPending is
enabled and this PickTreeItem should either clear or show its pending visual state. The default
behavior is that the titleStyle and cellStyle are updated to include/exclude the "Pending"
suffix. In addition, when displayed in the pending state and a pendingButtonStyle is set, then the button's baseStyle is set to pendingButtonStyle. Returning
false will cancel this default behavior.
form - the managing DynamicForm instance.item - the form item itself (also available as "this").pendingStatus - true if the item should show its pending visual state; false otherwise.newValue - the current form item value.value - the value that would be restored by a call to DynamicForm.resetValues().false to cancel the default behavior.public static void setDefaultProperties(PickTreeItem pickTreeItemProperties)
Note: This method is intended for setting default attributes only and will affect 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. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
pickTreeItemProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic 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 nullpublic void setDataProperties(Tree dataProperties)
PickTreeItem that uses a DataSource, these properties will be passed
to the automatically-created ResultTree. This can be used for various customizations
such as modifying the automatically-chosen
parentIdField.dataProperties - dataProperties Default value is nullDatabinding overview and related methods