Class EditNode
- All Implemented Interfaces:
HasHandlers
EditContext. An EditNode is essentially a copy of a PaletteNode, initially with the same properties as the PaletteNode from which it was
generated. However unlike a PaletteNode, an EditNode always has a liveObject - the object created from the PaletteNode.defaults or other properties defined on a paletteNode.
Like a Palette, an EditContext may use properties such as PaletteNode.icon or PaletteNode.title to display EditNodes.
An EditContext generally offers some means of editing EditNodes and, as edits are made, updates defaults with the information required to re-create the component.
-
Field Summary
Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionProperties required to recreate the currentliveObject.Live version of the object created from thedefaults.Properties required to recreate the currentliveObject.Live version of the object created from thedefaults.Properties required to recreate the currentliveObject.Live version of the object created from thedefaults.Properties to be applied to theliveObject.editProxywhen created.Properties required to recreate the currentliveObject.Live version of the object created from thedefaults.Live version of the object created from thedefaults.static EditNodegetOrCreateRef(JavaScriptObject jsObj) getType()String of thecanvasLiveObject, for example, "ListGrid".Shortcut property to be applied to theliveObject.editProxywhen created.setCanDuplicate(Boolean canDuplicate) setCanvasDefaults(Canvas defaults) Properties required to recreate the currentliveObject.setCanvasLiveObject(Canvas liveObject) Live version of the object created from thedefaults.setDrawItemDefaults(DrawItem defaults) Properties required to recreate the currentliveObject.setDrawItemLiveObject(DrawItem liveObject) Live version of the object created from thedefaults.setDrawPaneDefaults(DrawPane defaults) Properties required to recreate the currentliveObject.setDrawPaneLiveObject(DrawPane liveObject) Live version of the object created from thedefaults.setEditProxyProperties(EditProxy editProxyProperties) Properties to be applied to theliveObject.editProxywhen created.setFormItemDefaults(FormItem defaults) Properties required to recreate the currentliveObject.setFormItemLiveObject(FormItem liveObject) Live version of the object created from thedefaults.String of thecanvasLiveObject, for example, "ListGrid".setUseEditMask(Boolean useEditMask) Shortcut property to be applied to theliveObject.editProxywhen created.Methods inherited from class com.smartgwt.client.tools.PaletteNode
getAlwaysUsePlaceholder, getEditNodeProperties, getIcon, getIdName, getIdPrefix, getPlaceholderImage, getPlaceholderProperties, getRecreateOnChange, getRequiredProperties, getTitle, setAlwaysUsePlaceholder, setEditNodeProperties, setIcon, setIdName, setIdPrefix, setPlaceholderImage, setPlaceholderProperties, setRecreateOnChange, setRequiredProperties, setTitleMethods inherited from class com.smartgwt.client.widgets.tree.TreeNode
getCanAcceptDrop, getCanDrag, getEnabled, getIconPadding, getName, getShowDropIcon, getShowOpenIcon, getShowSelectedIcon, setCanAcceptDrop, setCanDrag, setChildren, setEnabled, setIconPadding, setID, setIsFolder, setName, setParentID, setShowDropIcon, setShowOpenIcon, setShowSelectedIconMethods inherited from class com.smartgwt.client.widgets.grid.ListGridRecord
get_baseStyle, get_canEdit, get_canRemove, getBackgroundComponent, getCanExpand, getCanSelect, getCustomStyle, getDetailDS, getEmbeddedComponent, getEmbeddedComponentFields, getEmbeddedComponentPosition, getIncludeInSummary, getIsGridSummary, getIsGroupSummary, getIsSeparator, getLinkText, getShowRollOver, getSingleCellValue, set_baseStyle, set_canEdit, set_canRemove, setBackgroundComponent, setCanExpand, setCanSelect, setCustomStyle, setDetailDS, setEmbeddedComponent, setEmbeddedComponentFields, setEmbeddedComponentPosition, setIncludeInSummary, setIsGridSummary, setIsGroupSummary, setIsSeparator, setLinkText, setShowRollOver, setSingleCellValueMethods inherited from class com.smartgwt.client.data.Record
convertToRecordArray, copyAttributes, copyAttributesInto, getAttributeAsRecordArray, getAttributeAsRecordList, getPaletteDefaults, isARecord, toMapMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
-
Constructor Details
-
EditNode
public EditNode() -
EditNode
-
-
Method Details
-
getOrCreateRef
-
setCanDuplicate
- Overrides:
setCanDuplicatein classPaletteNode- Parameters:
canDuplicate- New canDuplicate value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getCanDuplicate
- Overrides:
getCanDuplicatein classPaletteNode- Returns:
- Current canDuplicate value. Default value is null
-
setCanvasDefaults
Properties required to recreate the currentliveObject.- Overrides:
setCanvasDefaultsin classPaletteNode- Parameters:
defaults- New defaults value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls- See Also:
-
getCanvasDefaults
Properties required to recreate the currentliveObject.- Overrides:
getCanvasDefaultsin classPaletteNode- Returns:
- Current defaults value. Default value is null
-
setCanvasLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
setCanvasLiveObjectin classPaletteNode- Parameters:
liveObject- New liveObject value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getCanvasLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
getCanvasLiveObjectin classPaletteNode- Returns:
- Current liveObject value. Default value is null
-
setDrawItemDefaults
Properties required to recreate the currentliveObject.- Overrides:
setDrawItemDefaultsin classPaletteNode- Parameters:
defaults- New defaults value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls- See Also:
-
getDrawItemDefaults
Properties required to recreate the currentliveObject.- Overrides:
getDrawItemDefaultsin classPaletteNode- Returns:
- Current defaults value. Default value is null
-
setDrawItemLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
setDrawItemLiveObjectin classPaletteNode- Parameters:
liveObject- New liveObject value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getDrawItemLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
getDrawItemLiveObjectin classPaletteNode- Returns:
- Current liveObject value. Default value is null
-
setDrawPaneDefaults
Properties required to recreate the currentliveObject.- Overrides:
setDrawPaneDefaultsin classPaletteNode- Parameters:
defaults- New defaults value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls- See Also:
-
getDrawPaneDefaults
Properties required to recreate the currentliveObject.- Overrides:
getDrawPaneDefaultsin classPaletteNode- Returns:
- Current defaults value. Default value is null
-
setDrawPaneLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
setDrawPaneLiveObjectin classPaletteNode- Parameters:
liveObject- New liveObject value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getDrawPaneLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
getDrawPaneLiveObjectin classPaletteNode- Returns:
- Current liveObject value. Default value is null
-
setEditProxyProperties
Properties to be applied to theliveObject.editProxywhen created.Note that the
editProxyis created the first time a component is placed into editMode, so anyeditProxyPropertiesmust be set before then.- Overrides:
setEditProxyPropertiesin classPaletteNode- Parameters:
editProxyProperties- New editProxyProperties value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls- See Also:
-
getEditProxyProperties
Properties to be applied to theliveObject.editProxywhen created.Note that the
editProxyis created the first time a component is placed into editMode, so anyeditProxyPropertiesmust be set before then.- Overrides:
getEditProxyPropertiesin classPaletteNode- Returns:
- Current editProxyProperties value. Default value is null
-
setFormItemDefaults
Properties required to recreate the currentliveObject.- Overrides:
setFormItemDefaultsin classPaletteNode- Parameters:
defaults- New defaults value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getFormItemDefaults
Properties required to recreate the currentliveObject.- Overrides:
getFormItemDefaultsin classPaletteNode- Returns:
- Current defaults value. Default value is null
-
setFormItemLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
setFormItemLiveObjectin classPaletteNode- Parameters:
liveObject- New liveObject value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getFormItemLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid.- Overrides:
getFormItemLiveObjectin classPaletteNode- Returns:
- Current liveObject value. Default value is null
-
setType
String of thecanvasLiveObject, for example, "ListGrid".- Overrides:
setTypein classPaletteNode- Parameters:
type- New type value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls- See Also:
-
getType
String of thecanvasLiveObject, for example, "ListGrid".- Overrides:
getTypein classPaletteNode- Returns:
- Current type value. Default value is null
- See Also:
-
setUseEditMask
Shortcut property to be applied to theliveObject.editProxywhen created.- Parameters:
useEditMask- New useEditMask value. Default value is null- Returns:
EditNodeinstance, for chaining setter calls
-
getUseEditMask
Shortcut property to be applied to theliveObject.editProxywhen created.- Returns:
- Current useEditMask value. Default value is null
-
getLiveObject
Live version of the object created from thedefaults. For example, iftypeis "ListGrid",liveObjectwould be a ListGrid. Use the more specific live object getter API, such asgetCanvasLiveObject()if you are sure of the type.- Overrides:
getLiveObjectin classPaletteNode- Returns:
- Object
- See Also:
-