public class DetailViewerEditProxy extends CanvasEditProxy
EditProxy that handles DetailViewer
components when editMode is enabled.Dashboards & Tools Framework Overviewconfig, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
DetailViewerEditProxy() |
DetailViewerEditProxy(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getDataDisplaySeparatorChar()
If
inline editing for this viewer edits the
DetailViewer.data, character that should be used as a
separator for
entering com.smartgwt.client.types.ValueMap-style entries that map from a field name to a value. |
java.lang.String |
getDataEscapeChar()
If
inline editing for this viewer edits the DetailViewer.data, character that can be used to enter literal
separator chars (such as the dataSeparatorChar) or literal leading or trailing whitespace. |
java.lang.String |
getDataSeparatorChar()
If
inline editing for this viewer edits the DetailViewer.data, character that should be used as a separator
between values, or between pairs of field name vs values if the user is entering such a com.smartgwt.client.types.ValueMap using the dataDisplaySeparatorChar. |
void |
getInlineEditText()
Returns the text based on the current component state to be edited inline.
|
static DetailViewerEditProxy |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
DetailViewerEditProxy |
setDataDisplaySeparatorChar(java.lang.String dataDisplaySeparatorChar)
If
inline editing for this viewer edits the
DetailViewer.data, character that should be used as a
separator for
entering com.smartgwt.client.types.ValueMap-style entries that map from a field name to a value. |
DetailViewerEditProxy |
setDataEscapeChar(java.lang.String dataEscapeChar)
If
inline editing for this viewer edits the DetailViewer.data, character that can be used to enter literal
separator chars (such as the dataSeparatorChar) or literal leading or trailing whitespace. |
DetailViewerEditProxy |
setDataSeparatorChar(java.lang.String dataSeparatorChar)
If
inline editing for this viewer edits the DetailViewer.data, character that should be used as a separator
between values, or between pairs of field name vs values if the user is entering such a com.smartgwt.client.types.ValueMap using the dataDisplaySeparatorChar. |
void |
setInlineEditText(java.lang.String newValue)
Save the new value into the component's state.
|
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, startInlineEditingaddDynamicProperty, 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, setScClassNamepublic DetailViewerEditProxy()
public DetailViewerEditProxy(com.google.gwt.core.client.JavaScriptObject jsObj)
public static DetailViewerEditProxy getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
create in class CanvasEditProxypublic DetailViewerEditProxy setDataDisplaySeparatorChar(java.lang.String dataDisplaySeparatorChar) throws java.lang.IllegalStateException
inline editing for this viewer edits the
DetailViewer.data, character that should be used as a
separator for
entering com.smartgwt.client.types.ValueMap-style entries that map from a field name to a value.
With the default of ":", the following input:
1:Fixed, 2:Won't Fix, 3:Resolved
Would be assumed to be a mapping like this (expressed in JSON):
{
"1" : "Fixed",
"2" : "Won't Fix",
"3" : "Resolved"
}
Any entry without a separator char has an implied value of null.
For example, for this input:
Fixed:Reported Fixed, WontFix:Won't Fix, Resolved
The resulting data would be:
{
"Fixed" : "Reported Fixed",
"WontFix" : "Won't Fix",
"Resolved" : null
}
The dataEscapeChar can be used to enter
literal colon characters.
Set dataDisplaySeparatorChar to null to prevent entry of values
- user input will always be treated as just a list of legal field names.
dataDisplaySeparatorChar - New dataDisplaySeparatorChar value. Default value is ":"DetailViewerEditProxy instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getDataDisplaySeparatorChar()
inline editing for this viewer edits the
DetailViewer.data, character that should be used as a
separator for
entering com.smartgwt.client.types.ValueMap-style entries that map from a field name to a value.
With the default of ":", the following input:
1:Fixed, 2:Won't Fix, 3:Resolved
Would be assumed to be a mapping like this (expressed in JSON):
{
"1" : "Fixed",
"2" : "Won't Fix",
"3" : "Resolved"
}
Any entry without a separator char has an implied value of null.
For example, for this input:
Fixed:Reported Fixed, WontFix:Won't Fix, Resolved
The resulting data would be:
{
"Fixed" : "Reported Fixed",
"WontFix" : "Won't Fix",
"Resolved" : null
}
The dataEscapeChar can be used to enter
literal colon characters.
Set dataDisplaySeparatorChar to null to prevent entry of values
- user input will always be treated as just a list of legal field names.
public DetailViewerEditProxy setDataEscapeChar(java.lang.String dataEscapeChar) throws java.lang.IllegalStateException
inline editing for this viewer edits the DetailViewer.data, character that can be used to enter literal
separator chars (such as the dataSeparatorChar) 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.
dataEscapeChar - New dataEscapeChar value. Default value is "\"DetailViewerEditProxy instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getDataEscapeChar()
inline editing for this viewer edits the DetailViewer.data, character that can be used to enter literal
separator chars (such as the dataSeparatorChar) 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.
public DetailViewerEditProxy setDataSeparatorChar(java.lang.String dataSeparatorChar) throws java.lang.IllegalStateException
inline editing for this viewer edits the DetailViewer.data, character that should be used as a separator
between values, or between pairs of field name vs values if the user is entering such a com.smartgwt.client.types.ValueMap using the dataDisplaySeparatorChar. If EditProxy.inlineEditMultiline is enabled, newlines will be
used as value separators and the dataSeparatorChar
The dataEscapeChar can be used to enter the separator
char as part of a field name or value.
dataSeparatorChar - New dataSeparatorChar value. Default value is ","DetailViewerEditProxy instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getDataSeparatorChar()
inline editing for this viewer edits the DetailViewer.data, character that should be used as a separator
between values, or between pairs of field name vs values if the user is entering such a com.smartgwt.client.types.ValueMap using the dataDisplaySeparatorChar. If EditProxy.inlineEditMultiline is enabled, newlines will be
used as value separators and the dataSeparatorChar
The dataEscapeChar can be used to enter the separator
char as part of a field name or value.
public void getInlineEditText()
EditProxy.inlineEditForm to obtain the starting edit value.
Returns the component's data one-field-per-line as specified in dataDisplaySeparatorChar.
getInlineEditText in class EditProxypublic void setInlineEditText(java.lang.String newValue)
EditProxy.inlineEditForm to commit the change. Updates the
component's data and fields.
setInlineEditText in class EditProxynewValue - the new component data