Class FormItemEditProxy
- All Implemented Interfaces:
HasHandlers
- Direct Known Subclasses:
CheckboxItemEditProxy,DateItemEditProxy,FileItemEditProxy,SelectItemEditProxy,TextItemEditProxy,ToolbarItemEditProxy
- See Also:
-
Field Summary
Fields inherited from class com.smartgwt.client.core.BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()static FormItemEditProxygetOrCreateRef(JavaScriptObject jsObj) Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator for enteringcom.smartgwt.client.types.ValueMaps that map from a stored value to a user-displayed value.Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to enter literal separator chars (such as thevalueMapSeparatorChar) or literal leading or trailing whitespace.Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to mark the default selected option.Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator between values, or between pairs of stored vs display values if the user is entering such acom.smartgwt.client.types.ValueMapusing thevalueMapDisplaySeparatorChar.setValueMapDisplaySeparatorChar(String valueMapDisplaySeparatorChar) Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator for enteringcom.smartgwt.client.types.ValueMaps that map from a stored value to a user-displayed value.setValueMapEscapeChar(String valueMapEscapeChar) Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to enter literal separator chars (such as thevalueMapSeparatorChar) or literal leading or trailing whitespace.setValueMapSelectedChar(String valueMapSelectedChar) Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to mark the default selected option.setValueMapSeparatorChar(String valueMapSeparatorChar) Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator between values, or between pairs of stored vs display values if the user is entering such acom.smartgwt.client.types.ValueMapusing thevalueMapDisplaySeparatorChar.Methods inherited from class com.smartgwt.client.tools.EditProxy
getAllowNestedDrops, getAutoMaskChildren, getBringToFrontOnSelect, getCanSelect, getCanSelectChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getEditMask, getHoopSelector, getInlineEditEvent, getInlineEditForm, getInlineEditInstructionLabel, getInlineEditInstructions, getInlineEditMultiline, getInlineEditOnDrop, getInlineEditText, getJsObj, getOrCreateJsObj, getPersistCoordinates, getSelectedAppearance, getSelectedBorder, getSelectedLabelBackgroundColor, getSelectedTintColor, getSelectedTintOpacity, getShowDragHandle, getSupportsInlineEdit, getUseCopyPasteShortcuts, getUseEditMask, isCreated, setAllowNestedDrops, setAutoMaskChildren, setBringToFrontOnSelect, setCanSelect, setCanSelectChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setInlineEditEvent, setInlineEditInstructions, setInlineEditMultiline, setInlineEditOnDrop, setInlineEditText, setJavaScriptObject, setPersistCoordinates, setSelectedAppearance, setSelectedBorder, setSelectedLabelBackgroundColor, setSelectedTintColor, setSelectedTintOpacity, setShowDragHandle, setSupportsInlineEdit, setUseCopyPasteShortcuts, setUseEditMask, showSelectedAppearance, startInlineEditing, startInlineEditingMethods inherited from class com.smartgwt.client.core.BaseClass
addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName
-
Constructor Details
-
FormItemEditProxy
public FormItemEditProxy() -
FormItemEditProxy
-
-
Method Details
-
getOrCreateRef
-
create
-
setValueMapDisplaySeparatorChar
public FormItemEditProxy setValueMapDisplaySeparatorChar(String valueMapDisplaySeparatorChar) throws IllegalStateException Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator for enteringcom.smartgwt.client.types.ValueMaps that map from a stored value to a user-displayed value.With the default of ":", the following input:
1:Fixed, 2:Won't Fix, 3:ResolvedWould be assumed to be a mapping like this (expressed in JSON):{ "1" : "Fixed", "2" : "Won't Fix", "3" : "Resolved" }If the input has inconsistent use of the separator char, the input will be assumed to be stored-to-displayed mapping if the separator char is present in a majority of values, and any values that lack a separator will use the same value for storage and display. For example, for this input:
Fixed:Reported Fixed, WontFix:Won't Fix, ResolvedThe resultingvalueMapwould be:{ "Fixed" : "Reported Fixed", "WontFix" : "Won't Fix", "Resolved" : "Resolved" }The
valueMapEscapeCharcan be used to enter literal colon characters.Set
valueMapDisplaySeparatorCharto null to prevent entry of stored vs displayed values - user input will always be treated as just a list of legal values.- Parameters:
valueMapDisplaySeparatorChar- New valueMapDisplaySeparatorChar value. Default value is ":"- Returns:
FormItemEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getValueMapDisplaySeparatorChar
Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator for enteringcom.smartgwt.client.types.ValueMaps that map from a stored value to a user-displayed value.With the default of ":", the following input:
1:Fixed, 2:Won't Fix, 3:ResolvedWould be assumed to be a mapping like this (expressed in JSON):{ "1" : "Fixed", "2" : "Won't Fix", "3" : "Resolved" }If the input has inconsistent use of the separator char, the input will be assumed to be stored-to-displayed mapping if the separator char is present in a majority of values, and any values that lack a separator will use the same value for storage and display. For example, for this input:
Fixed:Reported Fixed, WontFix:Won't Fix, ResolvedThe resultingvalueMapwould be:{ "Fixed" : "Reported Fixed", "WontFix" : "Won't Fix", "Resolved" : "Resolved" }The
valueMapEscapeCharcan be used to enter literal colon characters.Set
valueMapDisplaySeparatorCharto null to prevent entry of stored vs displayed values - user input will always be treated as just a list of legal values.- Returns:
- Current valueMapDisplaySeparatorChar value. Default value is ":"
-
setValueMapEscapeChar
public FormItemEditProxy setValueMapEscapeChar(String valueMapEscapeChar) throws IllegalStateException Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to enter literal separator chars (such as thevalueMapSeparatorChar) or literal leading or trailing whitespace.Repeat this character twice to enter it literally. For example, with the default of "\", inputting "\\" would result in a literal backslash in the value.
- Parameters:
valueMapEscapeChar- New valueMapEscapeChar value. Default value is "\"- Returns:
FormItemEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getValueMapEscapeChar
Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to enter literal separator chars (such as thevalueMapSeparatorChar) or literal leading or trailing whitespace.Repeat this character twice to enter it literally. For example, with the default of "\", inputting "\\" would result in a literal backslash in the value.
- Returns:
- Current valueMapEscapeChar value. Default value is "\"
-
setValueMapSelectedChar
public FormItemEditProxy setValueMapSelectedChar(String valueMapSelectedChar) throws IllegalStateException Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to mark the default selected option. Can appear before or after a value, for example, with this input:Fixed,Won't Fix,Resolved*"Resolved" would be the default selected value.If multiple values are marked selected for a SelectItem,
SelectItem.multiplewill automatically be set.The
valueMapEscapeCharcan be used to allow thevalueMapSelectedCharto appear at the beginning or end of a valueMap value.- Parameters:
valueMapSelectedChar- New valueMapSelectedChar value. Default value is "*"- Returns:
FormItemEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getValueMapSelectedChar
Ifinline editingfor this FormItem edits theFormItem.valueMap, character that can be used to mark the default selected option. Can appear before or after a value, for example, with this input:Fixed,Won't Fix,Resolved*"Resolved" would be the default selected value.If multiple values are marked selected for a SelectItem,
SelectItem.multiplewill automatically be set.The
valueMapEscapeCharcan be used to allow thevalueMapSelectedCharto appear at the beginning or end of a valueMap value.- Returns:
- Current valueMapSelectedChar value. Default value is "*"
-
setValueMapSeparatorChar
public FormItemEditProxy setValueMapSeparatorChar(String valueMapSeparatorChar) throws IllegalStateException Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator between values, or between pairs of stored vs display values if the user is entering such acom.smartgwt.client.types.ValueMapusing thevalueMapDisplaySeparatorChar.If
EditProxy.inlineEditMultilineis enabled, newlines will be used as value separators and thevalueMapSeparatorCharThe
valueMapEscapeCharcan be used to enter the separator char as part of a valueMap value.- Parameters:
valueMapSeparatorChar- New valueMapSeparatorChar value. Default value is ","- Returns:
FormItemEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getValueMapSeparatorChar
Ifinline editingfor this FormItem edits theFormItem.valueMap, character that should be used as a separator between values, or between pairs of stored vs display values if the user is entering such acom.smartgwt.client.types.ValueMapusing thevalueMapDisplaySeparatorChar.If
EditProxy.inlineEditMultilineis enabled, newlines will be used as value separators and thevalueMapSeparatorCharThe
valueMapEscapeCharcan be used to enter the separator char as part of a valueMap value.- Returns:
- Current valueMapSeparatorChar value. Default value is ","
-