Class FacetChartEditProxy
- All Implemented Interfaces:
HasHandlers
EditProxy that handles FacetCharts when editMode is enabled.- 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()Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator for entering label vs value entries.Ifinline editingfor this chart edits theFacetChart.data, character that can be used to enter literal separator chars (such as thedataSeparatorChar).Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator between values, or between pairs of label vs values.voidReturns the text based on the current component state to be edited inline.static FacetChartEditProxygetOrCreateRef(JavaScriptObject jsObj) setDataDisplaySeparatorChar(String dataDisplaySeparatorChar) Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator for entering label vs value entries.setDataEscapeChar(String dataEscapeChar) Ifinline editingfor this chart edits theFacetChart.data, character that can be used to enter literal separator chars (such as thedataSeparatorChar).setDataSeparatorChar(String dataSeparatorChar) Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator between values, or between pairs of label vs values.voidsetInlineEditText(String newValue) Save the new value into the component's state.Methods inherited from class com.smartgwt.client.tools.EditProxy
getAllowNestedDrops, getAutoMaskChildren, getBringToFrontOnSelect, getCanSelect, getCanSelectChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getEditMask, getHoopSelector, getInlineEditEvent, getInlineEditForm, getInlineEditInstructionLabel, getInlineEditInstructions, getInlineEditMultiline, getInlineEditOnDrop, getJsObj, getOrCreateJsObj, getPersistCoordinates, getSelectedAppearance, getSelectedBorder, getSelectedLabelBackgroundColor, getSelectedTintColor, getSelectedTintOpacity, getShowDragHandle, getSupportsInlineEdit, getUseCopyPasteShortcuts, getUseEditMask, isCreated, setAllowNestedDrops, setAutoMaskChildren, setBringToFrontOnSelect, setCanSelect, setCanSelectChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setInlineEditEvent, setInlineEditInstructions, setInlineEditMultiline, setInlineEditOnDrop, 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
-
FacetChartEditProxy
public FacetChartEditProxy() -
FacetChartEditProxy
-
-
Method Details
-
getOrCreateRef
-
create
-
setDataDisplaySeparatorChar
public FacetChartEditProxy setDataDisplaySeparatorChar(String dataDisplaySeparatorChar) throws IllegalStateException Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator for entering label vs value entries.With the default of ":", the following input defines four values with titles:
North:10, South:20, East:30, West:40The
dataEscapeCharcan be used to enter literal colon characters.- Parameters:
dataDisplaySeparatorChar- New dataDisplaySeparatorChar value. Default value is ":"- Returns:
FacetChartEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getDataDisplaySeparatorChar
Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator for entering label vs value entries.With the default of ":", the following input defines four values with titles:
North:10, South:20, East:30, West:40The
dataEscapeCharcan be used to enter literal colon characters.- Returns:
- Current dataDisplaySeparatorChar value. Default value is ":"
-
setDataEscapeChar
Ifinline editingfor this chart edits theFacetChart.data, character that can be used to enter literal separator chars (such as thedataSeparatorChar).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:
dataEscapeChar- New dataEscapeChar value. Default value is "\"- Returns:
FacetChartEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getDataEscapeChar
Ifinline editingfor this chart edits theFacetChart.data, character that can be used to enter literal separator chars (such as thedataSeparatorChar).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 dataEscapeChar value. Default value is "\"
-
setDataSeparatorChar
public FacetChartEditProxy setDataSeparatorChar(String dataSeparatorChar) throws IllegalStateException Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator between values, or between pairs of label vs values.The
dataEscapeCharcan be used to enter the separator char as part of a field name or value.- Parameters:
dataSeparatorChar- New dataSeparatorChar value. Default value is ","- Returns:
FacetChartEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getDataSeparatorChar
Ifinline editingfor this chart edits theFacetChart.data, character that should be used as a separator between values, or between pairs of label vs values.The
dataEscapeCharcan be used to enter the separator char as part of a field name or value.- Returns:
- Current dataSeparatorChar value. Default value is ","
-
getInlineEditText
public void getInlineEditText()Returns the text based on the current component state to be edited inline. Called by theEditProxy.inlineEditFormto obtain the starting edit value.- Overrides:
getInlineEditTextin classEditProxy
-
setInlineEditText
Save the new value into the component's state. Called by theEditProxy.inlineEditFormto commit the change.Updates the component's
facetsanddata.Lines starting with "--" or "==" are considered titles. A single title is used as the chart title. Titles are matched to the next series of data. If titles are provided for each series, a legend will be shown.
Series data can be entered as a list of values separated by commas (see
dataSeparatorChar) or as a valueMap-style list oflabel:valuepairs. The first data series defines the number of chart values and the titles, if provided.- Overrides:
setInlineEditTextin classEditProxy- Parameters:
newValue- the new component data
-