EditPane (Smart GWT EE API 5.1p (2022-05-28))

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.smartgwt.client.widgets.BaseWidget
    - - com.smartgwt.client.widgets.Canvas
      - com.smartgwt.client.tools.EditPane

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers
```
public class EditPane
extends Canvas
```
A container that allows drag and drop instantiation of visual components from a Palette, and direct manipulation of the position and size of those components.
Any drag onto an EditPane from a Palette will add an EditNode created from the dragged PaletteNode.
EditPane automatically creates an EditContext and provides several APIs and settings that are passthroughs to the underlying EditContext for convenience.

See Also:

DevTools overview and related methods

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
  com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary
- Fields inherited from class com.smartgwt.client.widgets.BaseWidget
  config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

EditPane()

EditPane(com.google.gwt.core.client.JavaScriptObject jsObj)

Constructors
Constructor and Description
`EditPane()`
`EditPane(com.google.gwt.core.client.JavaScriptObject jsObj)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EditNode`	`addFromPaletteNode(PaletteNode paletteNode)` Creates a new EditNode from a PaletteNode, using the `defaultPalette`.
`EditNode`	`addFromPaletteNode(PaletteNode paletteNode, EditNode parentNode)` Creates a new EditNode from a PaletteNode, using the `defaultPalette`.
`EditNode[]`	`addFromPaletteNodes(PaletteNode[] paletteNodes)` Add the supplied `PaletteNodes` to the parentNode, preserving internal references from one supplied PaletteNode to another.
`EditNode[]`	`addFromPaletteNodes(PaletteNode[] paletteNodes, EditNode parentNode)` Add the supplied `PaletteNodes` to the parentNode, preserving internal references from one supplied PaletteNode to another.
`EditNode`	`addNode(EditNode newNode)` Add a new `EditNode` to the EditContext, under the specified parent.
`EditNode`	`addNode(EditNode newNode, EditNode parentNode)`
`EditNode`	`addNode(EditNode newNode, EditNode parentNode, java.lang.Integer index)`
`EditNode`	`addNode(EditNode newNode, EditNode parentNode, java.lang.Integer index, java.lang.String parentProperty)`
`EditNode`	`addNode(EditNode newNode, EditNode parentNode, java.lang.Integer index, java.lang.String parentProperty, java.lang.Boolean skipParentComponentAdd)` Add a new `EditNode` to the EditContext, under the specified parent.
`void`	`addPaletteNodesFromJS(java.lang.String jsCode)` Add `PaletteNodes` from a JavaScript source representation.
`void`	`addPaletteNodesFromJS(java.lang.String jsCode, EditNode parentNode)`
`void`	`addPaletteNodesFromJS(java.lang.String jsCode, EditNode parentNode, java.lang.String[] globals)` Add `PaletteNodes` from a JavaScript source representation.
`void`	`addPaletteNodesFromJSON(java.lang.String jsonString)` Recreate `EditNodes` from a JSON representation of `PaletteNodes` (possibly created by calling `serializeAllEditNodesAsJSON()` or `serializeEditNodesAsJSON()`.
`void`	`addPaletteNodesFromJSON(java.lang.String jsonString, EditNode parentNode)`
`void`	`addPaletteNodesFromJSON(java.lang.String jsonString, EditNode parentNode, java.lang.String[] globals)`
`void`	`addPaletteNodesFromJSON(java.lang.String jsonString, EditNode parentNode, java.lang.String[] globals, Function callback)` Recreate `EditNodes` from a JSON representation of `PaletteNodes` (possibly created by calling `serializeAllEditNodesAsJSON()` or `serializeEditNodesAsJSON()`.
`void`	`addPaletteNodesFromXML(java.lang.String xmlString)` Recreate `EditNodes` from an XML representation of `PaletteNodes` (possibly created by calling `serializeAllEditNodes()` or `serializeEditNodes()`.
`void`	`addPaletteNodesFromXML(java.lang.String xmlString, EditNode parentNode)`
`void`	`addPaletteNodesFromXML(java.lang.String xmlString, EditNode parentNode, java.lang.String[] globals)`
`void`	`addPaletteNodesFromXML(java.lang.String xmlString, EditNode parentNode, java.lang.String[] globals, Function callback)` Recreate `EditNodes` from an XML representation of `PaletteNodes` (possibly created by calling `serializeAllEditNodes()` or `serializeEditNodes()`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
`protected com.google.gwt.core.client.JavaScriptObject`	`create()`
`void`	`destroyAll()` Removes all `EditNodes` from the EditContext, and calls `destroy()` on the `liveObjects`.
`void`	`enableEditing(EditNode editNode)` Enable edit mode for an `EditNode`.
`java.lang.Boolean`	`getAllowNestedDrops()` Controls whether components can be dropped into other components which support child components.
`java.lang.Boolean`	`getAutoEditNewNodes()` New nodes added to the editContext are automatically placed into edit mode if the new node's parent is in edit mode.
`java.lang.Boolean`	`getCanDragGroup()` Should the group selection box shown when `canGroupSelect` is true allow dragging the group as a whole?
`java.lang.Boolean`	`getCanGroupSelect()` Should a group selection outline covering the outermost bounding boxes of all selected components be shown in this container?
`Palette`	`getDefaultPalette()` `Palette` to use when an `EditNode` is being created directly by this EditContext, instead of being created due to a user interaction with a palette (eg dragging from a `TreePalette`, or clicking on `MenuPalette`).
`EditContext`	`getEditContext()` An EditContext is automatically created to manage EditMode behavior.
`EditContext`	`getEditContextProperties()` Properties to be applied to the `editContext` when created.
`Palette[]`	`getExtraPalettes()` Additional `Palettes` to consult for metadata when deserializing `Edit Nodes`.
`java.lang.Boolean`	`getHideGroupBorderOnDrag()` Should the group selection box shown when `canGroupSelect` is true be hidden during drag?
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`getLogicalStructure()` Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`static EditPane`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`void`	`getPaletteNodesFromXML(java.lang.String xmlString, PaletteNodeCallback callback)` Obtain `PaletteNodes` from an XML representation, but do not add them to the EditContext.
`java.lang.Boolean`	`getPersistCoordinates()` When enabled, changes to a `liveObject`'s position and size will be persisted to their `EditNodes` by default.
`Record`	`getRootComponent()` Root of data to edit.
`EditNode`	`getRootEditNode()` Returns the root `EditNode` of the EditContext typically created from `rootComponent`.
`PaletteNode[]`	`getSaveData()` Returns an Array of `PaletteNode`s representing all current `EditNode`s in this pane, suitable for saving and restoring via passing each paletteNode to `addNode()`.
`java.lang.String`	`getSelectedBorder()` Set the CSS border to be applied to the selection outline of the selected components.
`java.lang.String`	`getSelectedLabelBackgroundColor()` The background color for the selection outline label.
`java.lang.Boolean`	`getShowSelectedLabel()` Should the selection outline show a label for selected components? A component may also be highlighted with the selection outline and label to indicate the target of a drop.
`boolean`	`isNodeEditingOn(EditNode editNode)` Returns true if `editNode` is in edit mode.
`EditNode`	`makeEditNode(PaletteNode paletteNode)` Creates and returns an EditNode using the `defaultPalette`.
`void`	`removeAll()` Removes all `EditNodes` from the EditContext, but does not destroy the `liveObjects`.
`void`	`removeNode(EditNode editNode)` Removes `EditNode` from the EditContext.
`void`	`removeNodeProperties(EditNode editNode, java.lang.String[] properties)` Removes the specified properties from an editNode's serializable "defaults".
`void`	`reorderNode(EditNode parentNode, java.lang.Integer index, java.lang.Integer moveToIndex)` Moves an `EditNode` from one child index to another in the EditContext under the specified parent.
`java.lang.String`	`serializeAllEditNodes()` Serialize the tree of `EditNodes` to an XML representation of `PaletteNodes`.
`java.lang.String`	`serializeAllEditNodes(SerializationSettings settings)` Serialize the tree of `EditNodes` to an XML representation of `PaletteNodes`.
`java.lang.String`	`serializeAllEditNodesAsJSON()` Encode the tree of `EditNodes` to a JSON representation of `PaletteNodes`.
`java.lang.String`	`serializeAllEditNodesAsJSON(SerializationSettings settings)` Encode the tree of `EditNodes` to a JSON representation of `PaletteNodes`.
`java.lang.String`	`serializeEditNodes(EditNode[] nodes)` Serialize the provided `EditNodes` to an XML representation of `PaletteNodes`.
`java.lang.String`	`serializeEditNodes(EditNode[] nodes, SerializationSettings settings)` Serialize the provided `EditNodes` to an XML representation of `PaletteNodes`.
`java.lang.String`	`serializeEditNodesAsJSON(EditNode[] nodes)` Serialize the provided `EditNodes` to a JSON representation of `PaletteNodes`.
`java.lang.String`	`serializeEditNodesAsJSON(EditNode[] nodes, SerializationSettings settings)` Serialize the provided `EditNodes` to a JSON representation of `PaletteNodes`.
`void`	`setAllowNestedDrops(java.lang.Boolean allowNestedDrops)` Controls whether components can be dropped into other components which support child components.
`void`	`setAutoEditNewNodes(java.lang.Boolean autoEditNewNodes)` New nodes added to the editContext are automatically placed into edit mode if the new node's parent is in edit mode.
`void`	`setCanDragGroup(java.lang.Boolean canDragGroup)` Should the group selection box shown when `canGroupSelect` is true allow dragging the group as a whole?
`void`	`setCanGroupSelect(java.lang.Boolean canGroupSelect)` Should a group selection outline covering the outermost bounding boxes of all selected components be shown in this container?
`void`	`setDefaultPalette(Palette defaultPalette)` `Palette` to use when an `EditNode` is being created directly by this EditContext, instead of being created due to a user interaction with a palette (eg dragging from a `TreePalette`, or clicking on `MenuPalette`).
`static void`	`setDefaultProperties(EditPane editPaneProperties)` Class level method to set the default properties of this class.
`void`	`setEditContextProperties(EditContext editContextProperties)` Properties to be applied to the `editContext` when created.
`void`	`setExtraPalettes(Palette... extraPalettes)` Additional `Palettes` to consult for metadata when deserializing `Edit Nodes`.
`void`	`setHideGroupBorderOnDrag(java.lang.Boolean hideGroupBorderOnDrag)` Should the group selection box shown when `canGroupSelect` is true be hidden during drag?
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`setLogicalStructure(com.smartgwt.logicalstructure.widgets.tools.EditPaneLogicalStructure s)` Setter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`void`	`setNodeProperties(EditNode editNode, Canvas properties)` Update an editNode's serializable "defaults" with the supplied properties.
`void`	`setNodeProperties(EditNode editNode, Canvas properties, java.lang.Boolean skipLiveObjectUpdate)` Update an editNode's serializable "defaults" with the supplied properties.
`void`	`setPersistCoordinates(java.lang.Boolean persistCoordinates)` When enabled, changes to a `liveObject`'s position and size will be persisted to their `EditNodes` by default.
`void`	`setRootComponent(Record rootComponent)` Root of data to edit.
`void`	`setSelectedBorder(java.lang.String selectedBorder)` Set the CSS border to be applied to the selection outline of the selected components.
`void`	`setSelectedLabelBackgroundColor(java.lang.String selectedLabelBackgroundColor)` The background color for the selection outline label.
`void`	`setShowSelectedLabel(java.lang.Boolean showSelectedLabel)` Should the selection outline show a label for selected components? A component may also be highlighted with the selection outline and label to indicate the target of a drop.

Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, applyFactoryProperties, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Constructor Detail
  - EditPane
```
public EditPane()
```
  - EditPane
```
public EditPane(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static EditPane getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
```
    Changes the defaults for Canvas AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
```
    Changes the defaults for FormItem AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - create
```
protected com.google.gwt.core.client.JavaScriptObject create()
```
    Overrides:
    
    create in class Canvas
  - setAllowNestedDrops
```
public void setAllowNestedDrops(java.lang.Boolean allowNestedDrops)
                         throws java.lang.IllegalStateException
```
    Controls whether components can be dropped into other components which support child components.
    When enabled, during a drop interaction in which a PaletteNode or EditNode is the drop data, the Component Schema of the current candidate drop target is inspected to see whether that parent allows children of the type being dropped. If it does, the drop will result in a call to addNode() for a paletteNode or for an existing EditNode in the same tree.
    Specific components can disable nested drops by explicitly setting EditProxy.allowNestedDrops to false.
    This mode is enabled by default unless explicitly disabled by setting this property to false.
    
    Parameters:
    
    allowNestedDrops - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAllowNestedDrops
```
public java.lang.Boolean getAllowNestedDrops()
```
    Controls whether components can be dropped into other components which support child components.
    When enabled, during a drop interaction in which a PaletteNode or EditNode is the drop data, the Component Schema of the current candidate drop target is inspected to see whether that parent allows children of the type being dropped. If it does, the drop will result in a call to addNode() for a paletteNode or for an existing EditNode in the same tree.
    Specific components can disable nested drops by explicitly setting EditProxy.allowNestedDrops to false.
    This mode is enabled by default unless explicitly disabled by setting this property to false.
    
    Returns:
    
    Boolean
  - setAutoEditNewNodes
```
public void setAutoEditNewNodes(java.lang.Boolean autoEditNewNodes)
                         throws java.lang.IllegalStateException
```
    New nodes added to the editContext are automatically placed into edit mode if the new node's parent is in edit mode. To suppress this action set autoEditNewNodes to false.
    
    Parameters:
    
    autoEditNewNodes - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAutoEditNewNodes
```
public java.lang.Boolean getAutoEditNewNodes()
```
    New nodes added to the editContext are automatically placed into edit mode if the new node's parent is in edit mode. To suppress this action set autoEditNewNodes to false.
    
    Returns:
    
    Boolean
  - setCanDragGroup
```
public void setCanDragGroup(java.lang.Boolean canDragGroup)
                     throws java.lang.IllegalStateException
```
    Should the group selection box shown when canGroupSelect is true allow dragging the group as a whole?
    Treated as true if not set and canGroupSelect is true.
    
    Parameters:
    
    canDragGroup - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getCanDragGroup
```
public java.lang.Boolean getCanDragGroup()
```
    Should the group selection box shown when canGroupSelect is true allow dragging the group as a whole?
    Treated as true if not set and canGroupSelect is true.
    
    Returns:
    
    Boolean
  - setCanGroupSelect
```
public void setCanGroupSelect(java.lang.Boolean canGroupSelect)
                       throws java.lang.IllegalStateException
```
    Should a group selection outline covering the outermost bounding boxes of all selected components be shown in this container?
    Treated as true if not set and hoop selection is enabled (see EditProxy.canSelectChildren and selectionType.
    
    Parameters:
    
    canGroupSelect - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getCanGroupSelect
```
public java.lang.Boolean getCanGroupSelect()
```
    Should a group selection outline covering the outermost bounding boxes of all selected components be shown in this container?
    Treated as true if not set and hoop selection is enabled (see EditProxy.canSelectChildren and selectionType.
    
    Returns:
    
    Boolean
  - setDefaultPalette
```
public void setDefaultPalette(Palette defaultPalette)
                       throws java.lang.IllegalStateException
```
    Palette to use when an EditNode is being created directly by this EditContext, instead of being created due to a user interaction with a palette (eg dragging from a TreePalette, or clicking on MenuPalette).
    If no defaultPalette is provided, the EditContext uses an automatically created HiddenPalette.
    
    If this method is called after the component has been drawn/initialized: Palette to use when an EditNode is being created directly by this EditContext, instead of being created due to a user interaction with a palette (eg dragging from a TreePalette, or clicking on MenuPalette).
    If no defaultPalette is provided, the EditContext uses an automatically created HiddenPalette.
    
    Parameters:
    
    defaultPalette - the default Palette. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getDefaultPalette
```
public Palette getDefaultPalette()
```
    Palette to use when an EditNode is being created directly by this EditContext, instead of being created due to a user interaction with a palette (eg dragging from a TreePalette, or clicking on MenuPalette).
    If no defaultPalette is provided, the EditContext uses an automatically created HiddenPalette.
    
    Returns:
    
    Palette to use when an EditNode is being created directly by this EditContext, instead of being created due to a user interaction with a palette (eg dragging from a TreePalette, or clicking on MenuPalette).
    If no defaultPalette is provided, the EditContext uses an automatically created HiddenPalette.
  - getEditContext
```
public EditContext getEditContext()
                           throws java.lang.IllegalStateException
```
    An EditContext is automatically created to manage EditMode behavior. The public EditContext APIs exposed by the EditPane are passed through to this object.
    Additional editContext properties can be supplied as editContextProperties.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    Returns the EditContext instance managed by the EditPane.
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setEditContextProperties
```
public void setEditContextProperties(EditContext editContextProperties)
                              throws java.lang.IllegalStateException
```
    Properties to be applied to the editContext when created.
    
    Parameters:
    
    editContextProperties - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    SGWTProperties
  - getEditContextProperties
```
public EditContext getEditContextProperties()
```
    Properties to be applied to the editContext when created.
    
    Returns:
    
    EditContext
  - setExtraPalettes
```
public void setExtraPalettes(Palette... extraPalettes)
                      throws java.lang.IllegalStateException
```
    Additional Palettes to consult for metadata when deserializing Edit Nodes. Note that the defaultPalette is always consulted and need not be provided again here.
    
    Parameters:
    
    extraPalettes - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getExtraPalettes
```
public Palette[] getExtraPalettes()
```
    Additional Palettes to consult for metadata when deserializing Edit Nodes. Note that the defaultPalette is always consulted and need not be provided again here.
    
    Returns:
    
    Palette...
  - setHideGroupBorderOnDrag
```
public void setHideGroupBorderOnDrag(java.lang.Boolean hideGroupBorderOnDrag)
                              throws java.lang.IllegalStateException
```
    Should the group selection box shown when canGroupSelect is true be hidden during drag?
    Treated as true if not explicitly set to false.
    
    Parameters:
    
    hideGroupBorderOnDrag - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getHideGroupBorderOnDrag
```
public java.lang.Boolean getHideGroupBorderOnDrag()
```
    Should the group selection box shown when canGroupSelect is true be hidden during drag?
    Treated as true if not explicitly set to false.
    
    Returns:
    
    Boolean
  - setPersistCoordinates
```
public void setPersistCoordinates(java.lang.Boolean persistCoordinates)
                           throws java.lang.IllegalStateException
```
    When enabled, changes to a liveObject's position and size will be persisted to their EditNodes by default. This applies to both programmatic calls and user interaction (drag reposition or drag resize).
    This feature can be disabled by either setting this property or EditProxy.persistCoordinates to false. This property affects all nodes within the EditContext whereas the latter property affects children of a single node.
    In some use-cases, like VisualBuilder, coordinates should not be persisted except when a component explicitly enables this feature. By setting this property to null no component will persist coordinates of children unless EditProxy.persistCoordinates is explicitly set to true.
    
    Parameters:
    
    persistCoordinates - Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getPersistCoordinates
```
public java.lang.Boolean getPersistCoordinates()
```
    When enabled, changes to a liveObject's position and size will be persisted to their EditNodes by default. This applies to both programmatic calls and user interaction (drag reposition or drag resize).
    This feature can be disabled by either setting this property or EditProxy.persistCoordinates to false. This property affects all nodes within the EditContext whereas the latter property affects children of a single node.
    In some use-cases, like VisualBuilder, coordinates should not be persisted except when a component explicitly enables this feature. By setting this property to null no component will persist coordinates of children unless EditProxy.persistCoordinates is explicitly set to true.
    
    Returns:
    
    Boolean
  - setRootComponent
```
public void setRootComponent(Record rootComponent)
                      throws java.lang.IllegalStateException
```
    Root of data to edit. Must contain the "type" property, with the name of a valid schema or nothing will be able to be dropped on this EditContext. A "liveObject" property representing the rootComponent is also suggested. Otherwise, a live object will be created from the palette node.
    Can be retrieved at any time. Use getRootEditNode() to retrieve the EditNode created from the rootComponent.
    
    Parameters:
    
    rootComponent - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    DevTools overview and related methods
  - getRootComponent
```
public Record getRootComponent()
```
    Root of data to edit. Must contain the "type" property, with the name of a valid schema or nothing will be able to be dropped on this EditContext. A "liveObject" property representing the rootComponent is also suggested. Otherwise, a live object will be created from the palette node.
    Can be retrieved at any time. Use getRootEditNode() to retrieve the EditNode created from the rootComponent.
    
    Returns:
    
    Record
    
    See Also:
    
    DevTools overview and related methods
  - setSelectedBorder
```
public void setSelectedBorder(java.lang.String selectedBorder)
                       throws java.lang.IllegalStateException
```
    Set the CSS border to be applied to the selection outline of the selected components. This property is used when EditProxy.selectedAppearance is outlineMask or outlineEdges.
    This value is applied as a default to EditProxy.selectedBorder.
    
    Parameters:
    
    selectedBorder - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSelectedBorder
```
public java.lang.String getSelectedBorder()
```
    Set the CSS border to be applied to the selection outline of the selected components. This property is used when EditProxy.selectedAppearance is outlineMask or outlineEdges.
    This value is applied as a default to EditProxy.selectedBorder.
    
    Returns:
    
    String
  - setSelectedLabelBackgroundColor
```
public void setSelectedLabelBackgroundColor(java.lang.String selectedLabelBackgroundColor)
                                     throws java.lang.IllegalStateException
```
    The background color for the selection outline label. The default is defined on SelectionOutline.
    This value is applied as a default to EditProxy.selectedLabelBackgroundColor.
    NOTE: A selected component label is only supported when EditProxy.selectedAppearance is "outlineEdges".
    
    Parameters:
    
    selectedLabelBackgroundColor - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    EditContext.setShowSelectedLabel(java.lang.Boolean)
  - getSelectedLabelBackgroundColor
```
public java.lang.String getSelectedLabelBackgroundColor()
```
    The background color for the selection outline label. The default is defined on SelectionOutline.
    This value is applied as a default to EditProxy.selectedLabelBackgroundColor.
    NOTE: A selected component label is only supported when EditProxy.selectedAppearance is "outlineEdges".
    
    Returns:
    
    String
    
    See Also:
    
    EditContext.getShowSelectedLabel()
  - setShowSelectedLabel
```
public void setShowSelectedLabel(java.lang.Boolean showSelectedLabel)
                          throws java.lang.IllegalStateException
```
    Should the selection outline show a label for selected components? A component may also be highlighted with the selection outline and label to indicate the target of a drop. To suppress showing a label at any time set this property to false.
    To suppress labels during selection but still show them when targeted for a drop, see EditContext.showSelectedLabelOnSelect.
    NOTE: A selected component label is only supported when EditProxy.selectedAppearance is "outlineEdges".
    
    Parameters:
    
    showSelectedLabel - Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowSelectedLabel
```
public java.lang.Boolean getShowSelectedLabel()
```
    Should the selection outline show a label for selected components? A component may also be highlighted with the selection outline and label to indicate the target of a drop. To suppress showing a label at any time set this property to false.
    To suppress labels during selection but still show them when targeted for a drop, see EditContext.showSelectedLabelOnSelect.
    NOTE: A selected component label is only supported when EditProxy.selectedAppearance is "outlineEdges".
    
    Returns:
    
    Boolean
  - addFromPaletteNode
```
public EditNode addFromPaletteNode(PaletteNode paletteNode)
```
    Creates a new EditNode from a PaletteNode, using the defaultPalette. If you have an array of possibly inter-related PaletteNodes, then you should use addFromPaletteNodes() on the array instead, in order to preserve the relationships.
    
    Parameters:
    
    paletteNode - the palette node to use to create the new node
    
    Returns:
    
    the EditNode created from the paletteNode
    
    See Also:
    
    addFromPaletteNodes(com.smartgwt.client.tools.PaletteNode[])
  - addFromPaletteNode
```
public EditNode addFromPaletteNode(PaletteNode paletteNode,
                                   EditNode parentNode)
```
    Creates a new EditNode from a PaletteNode, using the defaultPalette. If you have an array of possibly inter-related PaletteNodes, then you should use addFromPaletteNodes() on the array instead, in order to preserve the relationships.
    
    Parameters:
    
    paletteNode - the palette node to use to create the new node
    
    parentNode - optional the parent node if the new node should appear under a specific parent
    
    Returns:
    
    the EditNode created from the paletteNode
    
    See Also:
    
    addFromPaletteNodes(com.smartgwt.client.tools.PaletteNode[])
  - addFromPaletteNodes
```
public EditNode[] addFromPaletteNodes(PaletteNode[] paletteNodes)
```
    Add the supplied PaletteNodes to the parentNode, preserving internal references from one supplied PaletteNode to another. This method should be used with an array of possibly inter-related PaletteNodes (for instance, those produced as a result of serialization via serializeAllEditNodes(), rather than calling addFromPaletteNode() on each individual PaletteNode.
    
    Parameters:
    
    paletteNodes - array of PaletteNodes
    
    Returns:
    
    an array of the EditNodes added to the parentNode
    
    See Also:
    
    addFromPaletteNode(com.smartgwt.client.tools.PaletteNode)
  - addFromPaletteNodes
```
public EditNode[] addFromPaletteNodes(PaletteNode[] paletteNodes,
                                      EditNode parentNode)
```
    Add the supplied PaletteNodes to the parentNode, preserving internal references from one supplied PaletteNode to another. This method should be used with an array of possibly inter-related PaletteNodes (for instance, those produced as a result of serialization via serializeAllEditNodes(), rather than calling addFromPaletteNode() on each individual PaletteNode.
    
    Parameters:
    
    paletteNodes - array of PaletteNodes
    
    parentNode - parent to add to (defaults to the root)
    
    Returns:
    
    an array of the EditNodes added to the parentNode
    
    See Also:
    
    addFromPaletteNode(com.smartgwt.client.tools.PaletteNode)
  - addNode
```
public EditNode addNode(EditNode newNode)
```
    Add a new EditNode to the EditContext, under the specified parent. If the parentNode is not provided it will be determined from EditContext.defaultParent.
    The EditContext will interrogate the parent and new nodes to determine what field within the parent allows a child of this type, and to find a method to add the newNode's liveObject to the parentNode's liveObject. The new relationship will then be stored in the tree of EditNodes.
    For example, when a Tab is dropped on a TabSet, the field TabSet.tabs is discovered as the correct target field via naming conventions, and the method TabSet.addTab() is likewise discovered as the correct method to add a Tab to a TabSet.
    
    Parameters:
    
    newNode - new node to be added
    
    Returns:
    
    newNodenode added
  - addNode
```
public EditNode addNode(EditNode newNode,
                        EditNode parentNode)
```
    See Also:
    
    addNode(com.smartgwt.client.tools.EditNode)
  - addNode
```
public EditNode addNode(EditNode newNode,
                        EditNode parentNode,
                        java.lang.Integer index)
```
    See Also:
    
    addNode(com.smartgwt.client.tools.EditNode)
  - addNode
```
public EditNode addNode(EditNode newNode,
                        EditNode parentNode,
                        java.lang.Integer index,
                        java.lang.String parentProperty)
```
    See Also:
    
    addNode(com.smartgwt.client.tools.EditNode)
  - addNode
```
public EditNode addNode(EditNode newNode,
                        EditNode parentNode,
                        java.lang.Integer index,
                        java.lang.String parentProperty,
                        java.lang.Boolean skipParentComponentAdd)
```
    Add a new EditNode to the EditContext, under the specified parent. If the parentNode is not provided it will be determined from EditContext.defaultParent.
    The EditContext will interrogate the parent and new nodes to determine what field within the parent allows a child of this type, and to find a method to add the newNode's liveObject to the parentNode's liveObject. The new relationship will then be stored in the tree of EditNodes.
    For example, when a Tab is dropped on a TabSet, the field TabSet.tabs is discovered as the correct target field via naming conventions, and the method TabSet.addTab() is likewise discovered as the correct method to add a Tab to a TabSet.
    
    Parameters:
    
    newNode - new node to be added
    
    parentNode - parent to add the new node under.
    
    index - index within the parent's children array
    
    parentProperty - the property of the liveParent to which the new node should be added, if not auto-discoverable from the schema
    
    skipParentComponentAdd - whether to skip adding the liveObject to the liveParent (default false)
    
    Returns:
    
    newNodenode added
  - addPaletteNodesFromJS
```
public void addPaletteNodesFromJS(java.lang.String jsCode)
```
    Add PaletteNodes from a JavaScript source representation.
    By default, components that have global IDs will not actually be allowed to take those global IDs - instead, only widgets that have one of the global IDs passed as the globals parameter will actually receive their global IDs. To override this behavior, pass the special value ALL_GLOBALS for the globals parameter.
    
    Parameters:
    
    jsCode - JavaScript code to eval.
  - addPaletteNodesFromJS
```
public void addPaletteNodesFromJS(java.lang.String jsCode,
                                  EditNode parentNode)
```
    See Also:
    
    addPaletteNodesFromJS(java.lang.String)
  - addPaletteNodesFromJS
```
public void addPaletteNodesFromJS(java.lang.String jsCode,
                                  EditNode parentNode,
                                  java.lang.String[] globals)
```
    Add PaletteNodes from a JavaScript source representation.
    By default, components that have global IDs will not actually be allowed to take those global IDs - instead, only widgets that have one of the global IDs passed as the globals parameter will actually receive their global IDs. To override this behavior, pass the special value ALL_GLOBALS for the globals parameter.
    
    Parameters:
    
    jsCode - JavaScript code to eval.
    
    parentNode - parent node (defaults to the root)
    
    globals - widgets to allow to take their global IDs
  - addPaletteNodesFromJSON
```
public void addPaletteNodesFromJSON(java.lang.String jsonString)
```
    Recreate EditNodes from a JSON representation of PaletteNodes (possibly created by calling serializeAllEditNodesAsJSON() or serializeEditNodesAsJSON().
    By default, components that have global IDs will not actually be allowed to take those global IDs - instead, only widgets that have one of the global IDs passed as the globals parameter will actually receive their global IDs. To override this behavior, pass the special value ALL_GLOBALS for the globals parameter.
    
    Parameters:
    
    jsonString - JSON string
    
    See Also:
    
    serializeAllEditNodesAsJSON(), serializeEditNodesAsJSON(com.smartgwt.client.tools.EditNode[])
  - addPaletteNodesFromJSON
```
public void addPaletteNodesFromJSON(java.lang.String jsonString,
                                    EditNode parentNode)
```
    See Also:
    
    addPaletteNodesFromJSON(java.lang.String)
  - addPaletteNodesFromJSON
```
public void addPaletteNodesFromJSON(java.lang.String jsonString,
                                    EditNode parentNode,
                                    java.lang.String[] globals)
```
    See Also:
    
    addPaletteNodesFromJSON(java.lang.String)
  - addPaletteNodesFromJSON
```
public void addPaletteNodesFromJSON(java.lang.String jsonString,
                                    EditNode parentNode,
                                    java.lang.String[] globals,
                                    Function callback)
```
    Recreate EditNodes from a JSON representation of PaletteNodes (possibly created by calling serializeAllEditNodesAsJSON() or serializeEditNodesAsJSON().
    By default, components that have global IDs will not actually be allowed to take those global IDs - instead, only widgets that have one of the global IDs passed as the globals parameter will actually receive their global IDs. To override this behavior, pass the special value ALL_GLOBALS for the globals parameter.
    
    Parameters:
    
    jsonString - JSON string
    
    parentNode - parent node (defaults to the root)
    
    globals - widgets to allow to take their global IDs
    
    callback - Callback to fire after nodes have been added
    
    See Also:
    
    serializeAllEditNodesAsJSON(), serializeEditNodesAsJSON(com.smartgwt.client.tools.EditNode[])
  - addPaletteNodesFromXML
```
public void addPaletteNodesFromXML(java.lang.String xmlString)
```
    Recreate EditNodes from an XML representation of PaletteNodes (possibly created by calling serializeAllEditNodes() or serializeEditNodes().
    By default, components that have global IDs will not actually be allowed to take those global IDs - instead, only widgets that have one of the global IDs passed as the globals parameter will actually receive their global IDs. To override this behavior, pass the special value ALL_GLOBALS for the globals parameter.
    
    Parameters:
    
    xmlString - XML string
    
    See Also:
    
    serializeAllEditNodes(), serializeEditNodes(com.smartgwt.client.tools.EditNode[])
  - addPaletteNodesFromXML
```
public void addPaletteNodesFromXML(java.lang.String xmlString,
                                   EditNode parentNode)
```
    See Also:
    
    addPaletteNodesFromXML(java.lang.String)
  - addPaletteNodesFromXML
```
public void addPaletteNodesFromXML(java.lang.String xmlString,
                                   EditNode parentNode,
                                   java.lang.String[] globals)
```
    See Also:
    
    addPaletteNodesFromXML(java.lang.String)
  - addPaletteNodesFromXML
```
public void addPaletteNodesFromXML(java.lang.String xmlString,
                                   EditNode parentNode,
                                   java.lang.String[] globals,
                                   Function callback)
```
    Recreate EditNodes from an XML representation of PaletteNodes (possibly created by calling serializeAllEditNodes() or serializeEditNodes().
    By default, components that have global IDs will not actually be allowed to take those global IDs - instead, only widgets that have one of the global IDs passed as the globals parameter will actually receive their global IDs. To override this behavior, pass the special value ALL_GLOBALS for the globals parameter.
    
    Parameters:
    
    xmlString - XML string
    
    parentNode - parent node (defaults to the root)
    
    globals - widgets to allow to take their global IDs
    
    callback - Callback to fire after nodes have been added
    
    See Also:
    
    serializeAllEditNodes(), serializeEditNodes(com.smartgwt.client.tools.EditNode[])
  - destroyAll
```
public void destroyAll()
```
    Removes all EditNodes from the EditContext, and calls destroy() on the liveObjects.
  - enableEditing
```
public void enableEditing(EditNode editNode)
```
    Enable edit mode for an EditNode. This is a shortcut for calling Canvas.setEditMode().
    
    Parameters:
    
    editNode - the EditNode on which to enable editing
    
    See Also:
    
    Canvas.setEditMode(boolean), isNodeEditingOn(com.smartgwt.client.tools.EditNode)
  - getPaletteNodesFromXML
```
public void getPaletteNodesFromXML(java.lang.String xmlString,
                                   PaletteNodeCallback callback)
```
    Obtain PaletteNodes from an XML representation, but do not add them to the EditContext.
    
    Parameters:
    
    xmlString - XML string
    
    callback - Callback used to return the PaletteNodes
    
    See Also:
    
    serializeAllEditNodes(), serializeEditNodes(com.smartgwt.client.tools.EditNode[])
  - getRootEditNode
```
public EditNode getRootEditNode()
```
    Returns the root EditNode of the EditContext typically created from rootComponent.
    
    Returns:
    
    the root EditNode
  - getSaveData
```
public PaletteNode[] getSaveData()
```
    Returns an Array of PaletteNodes representing all current EditNodes in this pane, suitable for saving and restoring via passing each paletteNode to addNode().
    
    Returns:
    
    paletteNodes suitable for saving for subsequent restoration
    
    See Also:
    
    EditContext.serializeAllEditNodes(), EditContext.serializeAllEditNodesAsJSON()
  - isNodeEditingOn
```
public boolean isNodeEditingOn(EditNode editNode)
```
    Returns true if editNode is in edit mode.
    
    Parameters:
    
    editNode - the EditNode
    
    Returns:
    
    true if node is in edit mode
  - makeEditNode
```
public EditNode makeEditNode(PaletteNode paletteNode)
```
    Creates and returns an EditNode using the defaultPalette. Does not add the newly created EditNode to an EditContext.
    
    Parameters:
    
    paletteNode - the palette node to use to create the new node
    
    Returns:
    
    the EditNode created from the paletteNode
  - removeAll
```
public void removeAll()
```
    Removes all EditNodes from the EditContext, but does not destroy the liveObjects.
  - removeNode
```
public void removeNode(EditNode editNode)
```
    Removes EditNode from the EditContext. The editNode liveObject is not destroyed.
    
    Parameters:
    
    editNode - node to be removed
  - removeNodeProperties
```
public void removeNodeProperties(EditNode editNode,
                                 java.lang.String[] properties)
```
    Removes the specified properties from an editNode's serializable "defaults". Note that the liveObject is not updated by this method. To set a property to null (rather than removing it), use setNodeProperties() instead.
    
    Parameters:
    
    editNode - the editNode to update
    
    properties - an array of property names to remove
    
    See Also:
    
    setNodeProperties(com.smartgwt.client.tools.EditNode, com.smartgwt.client.widgets.Canvas)
  - reorderNode
```
public void reorderNode(EditNode parentNode,
                        java.lang.Integer index,
                        java.lang.Integer moveToIndex)
```
    Moves an EditNode from one child index to another in the EditContext under the specified parent.
    No changes are made to the live objects.
    
    Parameters:
    
    parentNode - parent to reorder child nodes
    
    index - index within the parent's children array to be moved
    
    moveToIndex - index within the parent's children array at which to place moved node
  - serializeAllEditNodes
```
public java.lang.String serializeAllEditNodes()
```
    Serialize the tree of EditNodes to an XML representation of PaletteNodes. The result can be supplied to addPaletteNodesFromXML() to recreate the EditNodes.
    
    Returns:
    
    an XML representation of PaletteNodes which can be used to recreate the tree of EditNodes.
    
    See Also:
    
    addPaletteNodesFromXML(java.lang.String)
  - serializeAllEditNodes
```
public java.lang.String serializeAllEditNodes(SerializationSettings settings)
```
    Serialize the tree of EditNodes to an XML representation of PaletteNodes. The result can be supplied to addPaletteNodesFromXML() to recreate the EditNodes.
    
    Parameters:
    
    settings - Additional serialization settings
    
    Returns:
    
    an XML representation of PaletteNodes which can be used to recreate the tree of EditNodes.
    
    See Also:
    
    addPaletteNodesFromXML(java.lang.String)
  - serializeAllEditNodesAsJSON
```
public java.lang.String serializeAllEditNodesAsJSON()
```
    Encode the tree of EditNodes to a JSON representation of PaletteNodes. The result can be supplied to addPaletteNodesFromJSON() to recreate the EditNodes.
    
    Returns:
    
    a JSON representation of PaletteNodes which can be used to recreate the tree of EditNodes.
    
    See Also:
    
    addPaletteNodesFromJSON(java.lang.String)
  - serializeAllEditNodesAsJSON
```
public java.lang.String serializeAllEditNodesAsJSON(SerializationSettings settings)
```
    Encode the tree of EditNodes to a JSON representation of PaletteNodes. The result can be supplied to addPaletteNodesFromJSON() to recreate the EditNodes.
    
    Parameters:
    
    settings - Additional serialization settings
    
    Returns:
    
    a JSON representation of PaletteNodes which can be used to recreate the tree of EditNodes.
    
    See Also:
    
    addPaletteNodesFromJSON(java.lang.String)
  - serializeEditNodes
```
public java.lang.String serializeEditNodes(EditNode[] nodes)
```
    Serialize the provided EditNodes to an XML representation of PaletteNodes. Note that the EditNodes must have been added to this EditContext. The result can be supplied to addPaletteNodesFromXML() to recreate the EditNodes.
    
    Parameters:
    
    nodes - EditNodes to be serialized
    
    Returns:
    
    an XML representtion of the provided EditNodes
  - serializeEditNodes
```
public java.lang.String serializeEditNodes(EditNode[] nodes,
                                           SerializationSettings settings)
```
    Serialize the provided EditNodes to an XML representation of PaletteNodes. Note that the EditNodes must have been added to this EditContext. The result can be supplied to addPaletteNodesFromXML() to recreate the EditNodes.
    
    Parameters:
    
    nodes - EditNodes to be serialized
    
    settings - Additional serialization settings
    
    Returns:
    
    an XML representtion of the provided EditNodes
  - serializeEditNodesAsJSON
```
public java.lang.String serializeEditNodesAsJSON(EditNode[] nodes)
```
    Serialize the provided EditNodes to a JSON representation of PaletteNodes. Note that the EditNodes must have been added to this EditContext. The result can be supplied to addPaletteNodesFromJSON() to recreate the EditNodes.
    
    Parameters:
    
    nodes - EditNodes to be serialized
    
    Returns:
    
    a JSON representtion of the provided EditNodes
  - serializeEditNodesAsJSON
```
public java.lang.String serializeEditNodesAsJSON(EditNode[] nodes,
                                                 SerializationSettings settings)
```
    Serialize the provided EditNodes to a JSON representation of PaletteNodes. Note that the EditNodes must have been added to this EditContext. The result can be supplied to addPaletteNodesFromJSON() to recreate the EditNodes.
    
    Parameters:
    
    nodes - EditNodes to be serialized
    
    settings - Additional serialization settings
    
    Returns:
    
    a JSON representtion of the provided EditNodes
  - setNodeProperties
```
public void setNodeProperties(EditNode editNode,
                              Canvas properties)
```
    Update an editNode's serializable "defaults" with the supplied properties. If you wish to remove a property from the defaults (rather than setting it to null), then use removeNodeProperties() instead.
    
    Parameters:
    
    editNode - the editNode to update
    
    properties - the properties to apply
    
    See Also:
    
    removeNodeProperties(com.smartgwt.client.tools.EditNode, java.lang.String[])
  - setNodeProperties
```
public void setNodeProperties(EditNode editNode,
                              Canvas properties,
                              java.lang.Boolean skipLiveObjectUpdate)
```
    Update an editNode's serializable "defaults" with the supplied properties. If you wish to remove a property from the defaults (rather than setting it to null), then use removeNodeProperties() instead.
    
    Parameters:
    
    editNode - the editNode to update
    
    properties - the properties to apply
    
    skipLiveObjectUpdate - whether to skip updating the liveObject, e.g. if you have already updated the liveObject
    
    See Also:
    
    removeNodeProperties(com.smartgwt.client.tools.EditNode, java.lang.String[])
  - setDefaultProperties
```
public static void setDefaultProperties(EditPane editPaneProperties)
```
    Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.
    Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
    
    Parameters:
    
    editPaneProperties - properties that should be used as new defaults when instances of this class are created
    
    See Also:
    
    SGWTProperties
  - setLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.tools.EditPaneLogicalStructure s)
```
    Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
  - getLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
```
    Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
    
    Specified by:
    
    getLogicalStructure in interface LogicalStructure
    
    Overrides:
    
    getLogicalStructure in class Canvas

Class EditPane

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.widgets.Canvas

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Constructor Detail

EditPane

EditPane

Method Detail

getOrCreateRef

changeAutoChildDefaults

changeAutoChildDefaults

create

setAllowNestedDrops

getAllowNestedDrops

setAutoEditNewNodes

getAutoEditNewNodes

setCanDragGroup

getCanDragGroup

setCanGroupSelect

getCanGroupSelect

setDefaultPalette

getDefaultPalette

getEditContext

setEditContextProperties

getEditContextProperties

setExtraPalettes

getExtraPalettes

setHideGroupBorderOnDrag

getHideGroupBorderOnDrag

setPersistCoordinates

getPersistCoordinates

setRootComponent

getRootComponent

setSelectedBorder

getSelectedBorder

setSelectedLabelBackgroundColor

getSelectedLabelBackgroundColor

setShowSelectedLabel

getShowSelectedLabel

addFromPaletteNode

addFromPaletteNode

addFromPaletteNodes

addFromPaletteNodes

addNode

addNode

addNode

addNode

addNode

addPaletteNodesFromJS

addPaletteNodesFromJS

addPaletteNodesFromJS

addPaletteNodesFromJSON

addPaletteNodesFromJSON

addPaletteNodesFromJSON

addPaletteNodesFromJSON

addPaletteNodesFromXML

addPaletteNodesFromXML

addPaletteNodesFromXML

addPaletteNodesFromXML

destroyAll

enableEditing

getPaletteNodesFromXML

getRootEditNode

getSaveData

isNodeEditingOn

makeEditNode

removeAll

removeNode

removeNodeProperties

reorderNode