Class GridEditProxy
- All Implemented Interfaces:
HasHandlers
- 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()Can new formula fields be created from header context menu? OverridesListGrid.canAddFormulaFieldswhen in edit mode.Can new summary fields be created from header context menu? OverridesListGrid.canAddSummaryFieldswhen in edit mode.Can highlights be edited from header context menu? OverridesListGrid.canEditHiliteswhen in edit mode.Can records be grouped from header context menu? OverridesListGrid.canGroupBywhen in edit mode.Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.Indicates whether fields in this listGrid can be resized by dragging header fields.Controls whether formula fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode).Controls whether highlights created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode).Controls whether summary fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode).voidReturns the text based on the current component state to be edited inline.static GridEditProxygetOrCreateRef(JavaScriptObject jsObj) Should changes to which fields arefrozenbe persisted?Should changes to grid field order be persisted?Should changes to grid field visibility be persisted?Should changes to filter criteria by end user editing of criteria in thefilter editorby persisted?Should changes to grid grouping (including both grouping and ungrouping the grid) be persisted?Should changes to which fields are sorted be persisted?setCanAddFormulaFields(Boolean canAddFormulaFields) Can new formula fields be created from header context menu? OverridesListGrid.canAddFormulaFieldswhen in edit mode.setCanAddSummaryFields(Boolean canAddSummaryFields) Can new summary fields be created from header context menu? OverridesListGrid.canAddSummaryFieldswhen in edit mode.setCanEditHilites(Boolean canEditHilites) Can highlights be edited from header context menu? OverridesListGrid.canEditHiliteswhen in edit mode.setCanGroupBy(Boolean canGroupBy) Can records be grouped from header context menu? OverridesListGrid.canGroupBywhen in edit mode.setCanReorderFields(Boolean canReorderFields) Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields.setCanResizeFields(Boolean canResizeFields) Indicates whether fields in this listGrid can be resized by dragging header fields.setGenerateEditableFormulas(Boolean generateEditableFormulas) Controls whether formula fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode).setGenerateEditableHilites(Boolean generateEditableHilites) Controls whether highlights created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode).setGenerateEditableSummaries(Boolean generateEditableSummaries) Controls whether summary fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode).voidsetInlineEditText(String newValue) Save the new value into the component's state.setSaveFieldFrozenState(Boolean saveFieldFrozenState) Should changes to which fields arefrozenbe persisted?setSaveFieldOrder(Boolean saveFieldOrder) Should changes to grid field order be persisted?setSaveFieldVisibility(Boolean saveFieldVisibility) Should changes to grid field visibility be persisted?setSaveFilterCriteria(Boolean saveFilterCriteria) Should changes to filter criteria by end user editing of criteria in thefilter editorby persisted?setSaveGroupBy(Boolean saveGroupBy) Should changes to grid grouping (including both grouping and ungrouping the grid) be persisted?setSaveSort(Boolean saveSort) Should changes to which fields are sorted be persisted?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
-
GridEditProxy
public GridEditProxy() -
GridEditProxy
-
-
Method Details
-
getOrCreateRef
-
create
- Overrides:
createin classLayoutEditProxy
-
setCanAddFormulaFields
public GridEditProxy setCanAddFormulaFields(Boolean canAddFormulaFields) throws IllegalStateException Can new formula fields be created from header context menu? OverridesListGrid.canAddFormulaFieldswhen in edit mode.- Parameters:
canAddFormulaFields- New canAddFormulaFields value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanAddFormulaFields
Can new formula fields be created from header context menu? OverridesListGrid.canAddFormulaFieldswhen in edit mode.- Returns:
- Current canAddFormulaFields value. Default value is true
-
setCanAddSummaryFields
public GridEditProxy setCanAddSummaryFields(Boolean canAddSummaryFields) throws IllegalStateException Can new summary fields be created from header context menu? OverridesListGrid.canAddSummaryFieldswhen in edit mode.- Parameters:
canAddSummaryFields- New canAddSummaryFields value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanAddSummaryFields
Can new summary fields be created from header context menu? OverridesListGrid.canAddSummaryFieldswhen in edit mode.- Returns:
- Current canAddSummaryFields value. Default value is true
-
setCanEditHilites
Can highlights be edited from header context menu? OverridesListGrid.canEditHiliteswhen in edit mode.- Parameters:
canEditHilites- New canEditHilites value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanEditHilites
Can highlights be edited from header context menu? OverridesListGrid.canEditHiliteswhen in edit mode.- Returns:
- Current canEditHilites value. Default value is true
-
setCanGroupBy
Can records be grouped from header context menu? OverridesListGrid.canGroupBywhen in edit mode.- Parameters:
canGroupBy- New canGroupBy value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanGroupBy
Can records be grouped from header context menu? OverridesListGrid.canGroupBywhen in edit mode.- Returns:
- Current canGroupBy value. Default value is true
-
setCanReorderFields
Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields. OverridesListGrid.canReorderFieldswhen in edit mode.- Parameters:
canReorderFields- New canReorderFields value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanReorderFields
Indicates whether fields in this listGrid can be reordered by dragging and dropping header fields. OverridesListGrid.canReorderFieldswhen in edit mode.- Returns:
- Current canReorderFields value. Default value is true
-
setCanResizeFields
Indicates whether fields in this listGrid can be resized by dragging header fields. OverridesListGrid.canResizeFieldswhen in edit mode.- Parameters:
canResizeFields- New canResizeFields value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanResizeFields
Indicates whether fields in this listGrid can be resized by dragging header fields. OverridesListGrid.canResizeFieldswhen in edit mode.- Returns:
- Current canResizeFields value. Default value is true
-
setGenerateEditableFormulas
public GridEditProxy setGenerateEditableFormulas(Boolean generateEditableFormulas) throws IllegalStateException Controls whether formula fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode). SeeListGridField.canEditFormula.- Parameters:
generateEditableFormulas- New generateEditableFormulas value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getGenerateEditableFormulas
Controls whether formula fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode). SeeListGridField.canEditFormula.- Returns:
- Current generateEditableFormulas value. Default value is true
-
setGenerateEditableHilites
public GridEditProxy setGenerateEditableHilites(Boolean generateEditableHilites) throws IllegalStateException Controls whether highlights created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode). SeeHilite.canEdit.- Parameters:
generateEditableHilites- New generateEditableHilites value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getGenerateEditableHilites
Controls whether highlights created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode). SeeHilite.canEdit.- Returns:
- Current generateEditableHilites value. Default value is true
-
setGenerateEditableSummaries
public GridEditProxy setGenerateEditableSummaries(Boolean generateEditableSummaries) throws IllegalStateException Controls whether summary fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode). SeeListGridField.canEditSummary.- Parameters:
generateEditableSummaries- New generateEditableSummaries value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getGenerateEditableSummaries
Controls whether summary fields created while in edit mode are editable by end users at runtime (when the grid is no longer in edit mode). SeeListGridField.canEditSummary.- Returns:
- Current generateEditableSummaries value. Default value is true
-
setSaveFieldFrozenState
public GridEditProxy setSaveFieldFrozenState(Boolean saveFieldFrozenState) throws IllegalStateException Should changes to which fields arefrozenbe persisted?Note that changes are saved directly into the ListGridFields not via fieldState or viewState settings. EditNodes will also be introduced for fields as needed if they do not already exist.
Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Parameters:
saveFieldFrozenState- New saveFieldFrozenState value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSaveFieldFrozenState
Should changes to which fields arefrozenbe persisted?Note that changes are saved directly into the ListGridFields not via fieldState or viewState settings. EditNodes will also be introduced for fields as needed if they do not already exist.
Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Returns:
- Current saveFieldFrozenState value. Default value is true
-
setSaveFieldOrder
Should changes to grid field order be persisted?Note that changes are saved directly into the ListGridFields not via fieldState or viewState settings. EditNodes will also be introduced for fields as needed if they do not already exist.
Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Parameters:
saveFieldOrder- New saveFieldOrder value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSaveFieldOrder
Should changes to grid field order be persisted?Note that changes are saved directly into the ListGridFields not via fieldState or viewState settings. EditNodes will also be introduced for fields as needed if they do not already exist.
Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Returns:
- Current saveFieldOrder value. Default value is true
-
setSaveFieldVisibility
public GridEditProxy setSaveFieldVisibility(Boolean saveFieldVisibility) throws IllegalStateException Should changes to grid field visibility be persisted?Note that changes are saved directly into the ListGridFields not via fieldState or viewState settings. EditNodes will also be introduced for fields as needed if they do not already exist.
Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Parameters:
saveFieldVisibility- New saveFieldVisibility value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSaveFieldVisibility
Should changes to grid field visibility be persisted?Note that changes are saved directly into the ListGridFields not via fieldState or viewState settings. EditNodes will also be introduced for fields as needed if they do not already exist.
Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Returns:
- Current saveFieldVisibility value. Default value is true
-
setSaveFilterCriteria
Should changes to filter criteria by end user editing of criteria in thefilter editorby persisted?Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Parameters:
saveFilterCriteria- New saveFilterCriteria value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSaveFilterCriteria
Should changes to filter criteria by end user editing of criteria in thefilter editorby persisted?Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Returns:
- Current saveFilterCriteria value. Default value is true
-
setSaveGroupBy
Should changes to grid grouping (including both grouping and ungrouping the grid) be persisted?Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Parameters:
saveGroupBy- New saveGroupBy value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSaveGroupBy
Should changes to grid grouping (including both grouping and ungrouping the grid) be persisted?Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Returns:
- Current saveGroupBy value. Default value is true
-
setSaveSort
Should changes to which fields are sorted be persisted?Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Parameters:
saveSort- New saveSort value. Default value is true- Returns:
GridEditProxyinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSaveSort
Should changes to which fields are sorted be persisted?Only valid with
SelectedAppearancesettings that allow direct interactivity (such as "outlineEdges").- Returns:
- Current saveSort value. Default value is true
-
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.Returns the grid's wiki-style data - see
MockDataSource.mockDatafor a description of this format.- Overrides:
getInlineEditTextin classEditProxy
-
setInlineEditText
Save the new value into the component's state. Called by theEditProxy.inlineEditFormto commit the change.Updates the grid's data and field configuration.
- Overrides:
setInlineEditTextin classEditProxy- Parameters:
newValue- the new grid configuration
-