public class EditPane extends Canvas
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.
DevTools overview and related methodsconfig, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
EditPane() |
EditPane(com.google.gwt.core.client.JavaScriptObject jsObj) |
| 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) |
EditNode |
addNode(EditNode newNode,
EditNode parentNode,
java.lang.Integer index,
java.lang.String parentProperty,
java.lang.Boolean skipParentComponentAdd,
java.lang.Boolean forceSingularFieldReplace)
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. |
void |
copyEditNodes(EditNode... editNode)
Copies the passed editNode or editNodes to an internal "clipboard" space, for later application via
pasteEditNodes(). |
void |
copyEditNodes(EditNode editNode)
Copies the passed editNode or editNodes to an internal "clipboard" space, for later application via
pasteEditNodes(). |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
destroyAll()
|
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. |
Tree |
getEditNodeTree()
Gets the tree of editNodes being edited by this editContext.
|
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. |
void |
getNodeProperty(EditNode editNode,
java.lang.String name)
Returns the specified property from the editNode's serializable "defaults".
|
static EditPane |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
void |
getPaletteNodesFromJS(java.lang.String jsCode,
PaletteNodeCallback callback)
Obtain
PaletteNodes from a JavaScript source representation. |
void |
getPaletteNodesFromJS(java.lang.String jsCode,
PaletteNodeCallback callback,
java.lang.String[] globals)
Obtain
PaletteNodes from a JavaScript source representation. |
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
PaletteNodes representing all current EditNodes 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.
|
java.lang.Boolean |
getUseCopyPasteShortcuts()
|
boolean |
isNodeEditingOn(EditNode editNode)
Returns true if
editNode is in edit mode. |
EditNode |
makeEditNode(PaletteNode paletteNode)
Creates and returns an EditNode using the
defaultPalette. |
PaletteNode |
makePaletteNode(EditNode editNode)
|
Tree |
makePaletteNodeTree(EditNode editNode)
Creates a
Tree of PaletteNodes
from an EditNode in this context's editNodeTree, by using makePaletteNode() on the passed EditNode and its
descendents within the editNodeTree. |
void |
pasteEditNodes()
"Pastes"
editNodes previously captured via copyEditNodes(). |
void |
pasteEditNodes(EditNode targetEditNode)
"Pastes"
editNodes previously captured via copyEditNodes(). |
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. |
EditPane |
setAllowNestedDrops(java.lang.Boolean allowNestedDrops)
Controls whether components can be dropped into other components which support child components.
|
EditPane |
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.
|
EditPane |
setCanDragGroup(java.lang.Boolean canDragGroup)
Should the group selection box shown when
canGroupSelect
is true allow dragging the group as a whole? |
EditPane |
setCanGroupSelect(java.lang.Boolean canGroupSelect)
Should a group selection outline covering the outermost bounding boxes of all selected components be shown in this
container?
|
EditPane |
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.
|
EditPane |
setEditContextProperties(EditContext editContextProperties)
Properties to be applied to the
editContext when created. |
EditPane |
setExtraPalettes(Palette... extraPalettes)
Additional
Palettes to consult for metadata when deserializing Edit Nodes. |
EditPane |
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.
|
EditPane |
setPersistCoordinates(java.lang.Boolean persistCoordinates)
When enabled, changes to a
liveObject's position and size will
be persisted to their EditNodes by default. |
EditPane |
setRootComponent(Record rootComponent)
Root of data to edit.
|
EditPane |
setSelectedBorder(java.lang.String selectedBorder)
Set the CSS border to be applied to the selection outline of the selected components.
|
EditPane |
setSelectedLabelBackgroundColor(java.lang.String selectedLabelBackgroundColor)
The background color for the selection outline label.
|
EditPane |
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.
|
EditPane |
setUseCopyPasteShortcuts(java.lang.Boolean useCopyPasteShortcuts)
|
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, 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, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, 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, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic EditPane()
public EditPane(com.google.gwt.core.client.JavaScriptObject jsObj)
public static EditPane getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.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.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.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.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public EditPane setAllowNestedDrops(java.lang.Boolean allowNestedDrops) throws java.lang.IllegalStateException
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.
allowNestedDrops - New allowNestedDrops value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAllowNestedDrops()
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.
public EditPane setAutoEditNewNodes(java.lang.Boolean autoEditNewNodes) throws java.lang.IllegalStateException
autoEditNewNodes to false.autoEditNewNodes - New autoEditNewNodes value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoEditNewNodes()
autoEditNewNodes to false.public EditPane setCanDragGroup(java.lang.Boolean canDragGroup) throws java.lang.IllegalStateException
canGroupSelect
is true allow dragging the group as a whole? Treated as true if not set and canGroupSelect is true.
canDragGroup - New canDragGroup value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanDragGroup()
canGroupSelect
is true allow dragging the group as a whole? Treated as true if not set and canGroupSelect is true.
public EditPane setCanGroupSelect(java.lang.Boolean canGroupSelect) throws java.lang.IllegalStateException
Treated as true if not set and hoop selection is enabled (see EditProxy.canSelectChildren and selectionType.
canGroupSelect - New canGroupSelect value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanGroupSelect()
Treated as true if not set and hoop selection is enabled (see EditProxy.canSelectChildren and selectionType.
public EditPane 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.
defaultPalette - the default Palette. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic 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.
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. Default value is null
public EditContext getEditContext() throws java.lang.IllegalStateException
Additional editContext properties can be supplied as editContextProperties.
This component is an AutoChild named "editContext". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
EditContext instance managed by the EditPane. Default value is nulljava.lang.IllegalStateException - if this widget has not yet been rendered.public EditPane setEditContextProperties(EditContext editContextProperties) throws java.lang.IllegalStateException
editContext when created.editContextProperties - New editContextProperties value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdSGWTPropertiespublic EditContext getEditContextProperties()
editContext when created.public EditPane setExtraPalettes(Palette... extraPalettes) throws java.lang.IllegalStateException
Palettes to consult for metadata when deserializing Edit Nodes. Note that the defaultPalette is always consulted and need not be provided again
here.extraPalettes - New extraPalettes value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic Palette[] getExtraPalettes()
Palettes to consult for metadata when deserializing Edit Nodes. Note that the defaultPalette is always consulted and need not be provided again
here.public EditPane setHideGroupBorderOnDrag(java.lang.Boolean hideGroupBorderOnDrag) throws java.lang.IllegalStateException
canGroupSelect
is true be hidden during drag? Treated as true if not explicitly set to false.
hideGroupBorderOnDrag - New hideGroupBorderOnDrag value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getHideGroupBorderOnDrag()
canGroupSelect
is true be hidden during drag? Treated as true if not explicitly set to false.
public EditPane setPersistCoordinates(java.lang.Boolean persistCoordinates) throws java.lang.IllegalStateException
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 Reify, 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.
persistCoordinates - New persistCoordinates value. Default value is trueEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getPersistCoordinates()
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 Reify, 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.
public EditPane setRootComponent(Record rootComponent) throws java.lang.IllegalStateException
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.
rootComponent - New rootComponent value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdDevTools overview and related methodspublic Record getRootComponent()
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.
DevTools overview and related methodspublic EditPane setSelectedBorder(java.lang.String selectedBorder) throws java.lang.IllegalStateException
EditProxy.selectedAppearance is outlineMask or
outlineEdges. This value is applied as a default to EditProxy.selectedBorder.
selectedBorder - New selectedBorder value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getSelectedBorder()
EditProxy.selectedAppearance is outlineMask or
outlineEdges. This value is applied as a default to EditProxy.selectedBorder.
public EditPane setSelectedLabelBackgroundColor(java.lang.String selectedLabelBackgroundColor) throws java.lang.IllegalStateException
SelectionOutline. This value is applied as a default to EditProxy.selectedLabelBackgroundColor.
NOTE: A
selected component label is only supported when EditProxy.selectedAppearance is "outlineEdges".
selectedLabelBackgroundColor - New selectedLabelBackgroundColor value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdEditContext.setShowSelectedLabel(java.lang.Boolean)public java.lang.String getSelectedLabelBackgroundColor()
SelectionOutline. This value is applied as a default to EditProxy.selectedLabelBackgroundColor.
NOTE: A
selected component label is only supported when EditProxy.selectedAppearance is "outlineEdges".
EditContext.getShowSelectedLabel()public EditPane setShowSelectedLabel(java.lang.Boolean showSelectedLabel) throws java.lang.IllegalStateException
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".
showSelectedLabel - New showSelectedLabel value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowSelectedLabel()
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".
public EditPane setUseCopyPasteShortcuts(java.lang.Boolean useCopyPasteShortcuts) throws java.lang.IllegalStateException
EditProxy.useCopyPasteShortcuts on the EditProxy for the root editNode. This works whether there is currently a root
editNode or one is added later.useCopyPasteShortcuts - New useCopyPasteShortcuts value. Default value is nullEditPane instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseCopyPasteShortcuts()
EditProxy.useCopyPasteShortcuts on the EditProxy for the root editNode. This works whether there is currently a root
editNode or one is added later.public EditNode addFromPaletteNode(PaletteNode paletteNode)
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.paletteNode - the palette node to use to create the new nodeaddFromPaletteNodes(com.smartgwt.client.tools.PaletteNode[])public EditNode addFromPaletteNode(PaletteNode paletteNode, EditNode parentNode)
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.paletteNode - the palette node to use to create the new nodeparentNode - optional the parent node if the new node should appear under a specific parentaddFromPaletteNodes(com.smartgwt.client.tools.PaletteNode[])public EditNode[] addFromPaletteNodes(PaletteNode[] paletteNodes)
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.paletteNodes - array of PaletteNodesaddFromPaletteNode(com.smartgwt.client.tools.PaletteNode)public EditNode[] addFromPaletteNodes(PaletteNode[] paletteNodes, EditNode parentNode)
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.paletteNodes - array of PaletteNodesparentNode - parent to add to (defaults to the root)addFromPaletteNode(com.smartgwt.client.tools.PaletteNode)public EditNode addNode(EditNode newNode)
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.
newNode - new node to be addedpublic EditNode addNode(EditNode newNode, EditNode parentNode, java.lang.Integer index, java.lang.String parentProperty)
public EditNode addNode(EditNode newNode, EditNode parentNode, java.lang.Integer index, java.lang.String parentProperty, java.lang.Boolean skipParentComponentAdd)
public EditNode addNode(EditNode newNode, EditNode parentNode, java.lang.Integer index, java.lang.String parentProperty, java.lang.Boolean skipParentComponentAdd, java.lang.Boolean forceSingularFieldReplace)
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.
newNode - new node to be addedparentNode - parent to add the new node under.index - index within the parent's children arrayparentProperty - the property of the liveParent to which the new node should be added, if not
auto-discoverable from the schemaskipParentComponentAdd - whether to skip adding the liveObject to the liveParent (default false)forceSingularFieldReplace - whether to replace existing single field node if newNode liveObject is the
same (default false)public void addPaletteNodesFromJS(java.lang.String jsCode)
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.
jsCode - JavaScript code to eval.public void addPaletteNodesFromJS(java.lang.String jsCode,
EditNode parentNode)
addPaletteNodesFromJS(java.lang.String)public void addPaletteNodesFromJS(java.lang.String jsCode,
EditNode parentNode,
java.lang.String[] globals)
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.
jsCode - JavaScript code to eval.parentNode - parent node (defaults to the root)globals - widgets to allow to take their global IDspublic void addPaletteNodesFromJSON(java.lang.String jsonString)
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.
jsonString - JSON string representing an array of PaletteNodesaddFromPaletteNodes(com.smartgwt.client.tools.PaletteNode[]),
serializeAllEditNodesAsJSON(),
serializeEditNodesAsJSON(com.smartgwt.client.tools.EditNode[])public void addPaletteNodesFromJSON(java.lang.String jsonString,
EditNode parentNode)
public void addPaletteNodesFromJSON(java.lang.String jsonString,
EditNode parentNode,
java.lang.String[] globals)
public void addPaletteNodesFromJSON(java.lang.String jsonString,
EditNode parentNode,
java.lang.String[] globals,
Function callback)
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.
jsonString - JSON string representing an array of PaletteNodesparentNode - parent to add to (defaults to the root)globals - widgets to allow to take their global IDscallback - Callback to fire after nodes have been addedaddFromPaletteNodes(com.smartgwt.client.tools.PaletteNode[]),
serializeAllEditNodesAsJSON(),
serializeEditNodesAsJSON(com.smartgwt.client.tools.EditNode[])public void addPaletteNodesFromXML(java.lang.String xmlString)
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.
xmlString - XML stringserializeAllEditNodes(),
serializeEditNodes(com.smartgwt.client.tools.EditNode[])public void addPaletteNodesFromXML(java.lang.String xmlString,
EditNode parentNode)
addPaletteNodesFromXML(java.lang.String)public void addPaletteNodesFromXML(java.lang.String xmlString,
EditNode parentNode,
java.lang.String[] globals)
addPaletteNodesFromXML(java.lang.String)public void addPaletteNodesFromXML(java.lang.String xmlString,
EditNode parentNode,
java.lang.String[] globals,
Function callback)
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.
xmlString - XML stringparentNode - parent node (defaults to the root)globals - widgets to allow to take their global IDscallback - Callback to fire after nodes have been addedserializeAllEditNodes(),
serializeEditNodes(com.smartgwt.client.tools.EditNode[])public void copyEditNodes(EditNode editNode)
pasteEditNodes().editNode - public void copyEditNodes(EditNode... editNode)
pasteEditNodes().editNode - public void destroyAll()
public void enableEditing(EditNode editNode)
EditNode. This is a shortcut for calling Canvas.setEditMode().editNode - the EditNode on which to enable editingCanvas.setEditMode(boolean),
isNodeEditingOn(com.smartgwt.client.tools.EditNode)public Tree getEditNodeTree()
Note: the returned tree is read-only and must only be modified by calling
methods on EditContext like EditContext.addNode() or EditContext.setNodeProperties().
public void getNodeProperty(EditNode editNode, java.lang.String name)
editNode - the editNode to queryname - the property name to querysetNodeProperties(com.smartgwt.client.tools.EditNode, com.smartgwt.client.widgets.Canvas)public void getPaletteNodesFromJS(java.lang.String jsCode,
PaletteNodeCallback callback)
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.
jsCode - JavaScript code to eval.callback - Callback used to return the PaletteNodespublic void getPaletteNodesFromJS(java.lang.String jsCode,
PaletteNodeCallback callback,
java.lang.String[] globals)
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.
jsCode - JavaScript code to eval.callback - Callback used to return the PaletteNodesglobals - widgets to allow to take their global IDspublic void getPaletteNodesFromXML(java.lang.String xmlString,
PaletteNodeCallback callback)
PaletteNodes from an XML representation, but do not add them to the
EditContext.xmlString - XML stringcallback - Callback used to return the PaletteNodesserializeAllEditNodes(),
serializeEditNodes(com.smartgwt.client.tools.EditNode[])public EditNode getRootEditNode()
EditNode of the EditContext typically created from rootComponent.public PaletteNode[] getSaveData()
PaletteNodes representing all current EditNodes in this pane, suitable for saving and restoring via passing each paletteNode to
addNode().EditContext.serializeAllEditNodes(),
EditContext.serializeAllEditNodesAsJSON()public boolean isNodeEditingOn(EditNode editNode)
editNode is in edit mode.editNode - the EditNodepublic EditNode makeEditNode(PaletteNode paletteNode)
defaultPalette.
Does not add the newly created EditNode to an EditContext.paletteNode - the palette node to use to create the new nodepublic PaletteNode makePaletteNode(EditNode editNode)
PaletteNode from an EditNode in this
context's editNodeTree. This essentially creates a new
PaletteNode with the EditNode.defaults from the passed editNode. The returned paletteNode could then be used with
EditContext.addFromPaletteNode() to effectively create
a copy of the original editNode - specifically a new editNode with a new EditNode.liveObject created from the same defaults.
However note
that makePaletteNode() does not copy descendant nodes - use makePaletteNodeTree() for that.
May return null if the
passed editNode cannot validly by transformed into a paletteNode, for example if EditNode.canDuplicate was set false.
editNode - the editNode to use to make a paletteNodepublic Tree makePaletteNodeTree(EditNode editNode)
Tree of PaletteNodes
from an EditNode in this context's editNodeTree, by using makePaletteNode() on the passed EditNode and its
descendents within the editNodeTree. The root node of
the returned Tree will be a PaletteNode derived from the passed
EditNode.
editNode - root editNode to make Tree of PaletteNodes frompublic void pasteEditNodes()
editNodes previously captured via copyEditNodes(). New editNodes will be added as root-level nodes of the editNodeTree unless a targetEditNode is passed.
public void pasteEditNodes(EditNode targetEditNode)
editNodes previously captured via copyEditNodes(). New editNodes will be added as root-level nodes of the editNodeTree unless a targetEditNode is passed.
targetEditNode - public void removeAll()
EditNodes from the EditContext, but does not destroy the liveObjects.public void removeNode(EditNode editNode)
EditNode from the EditContext. The editNode liveObject is not
destroyed.editNode - node to be removedpublic void removeNodeProperties(EditNode editNode, java.lang.String[] properties)
liveObject is not updated by this method. To set a property to
null (rather than removing it), use setNodeProperties()
instead.editNode - the editNode to updateproperties - an array of property names to removesetNodeProperties(com.smartgwt.client.tools.EditNode, com.smartgwt.client.widgets.Canvas)public void reorderNode(EditNode parentNode, java.lang.Integer index, java.lang.Integer moveToIndex)
EditNode from one child index to another in the EditContext under the
specified parent. No changes are made to the live objects.
parentNode - parent to reorder child nodesindex - index within the parent's children array to be movedmoveToIndex - index within the parent's children array at which to place moved nodepublic java.lang.String serializeAllEditNodes()
EditNodes to an XML representation of PaletteNodes. The result can be supplied to addPaletteNodesFromXML() to recreate the EditNodes.addPaletteNodesFromXML(java.lang.String)public java.lang.String serializeAllEditNodes(SerializationSettings settings)
EditNodes to an XML representation of PaletteNodes. The result can be supplied to addPaletteNodesFromXML() to recreate the EditNodes.settings - Additional serialization settingsaddPaletteNodesFromXML(java.lang.String)public java.lang.String serializeAllEditNodesAsJSON()
EditNodes to a JSON representation of PaletteNodes. The result can be supplied to addPaletteNodesFromJSON() to recreate the EditNodes.addPaletteNodesFromJSON(java.lang.String)public java.lang.String serializeAllEditNodesAsJSON(SerializationSettings settings)
EditNodes to a JSON representation of PaletteNodes. The result can be supplied to addPaletteNodesFromJSON() to recreate the EditNodes.settings - Additional serialization settingsaddPaletteNodesFromJSON(java.lang.String)public java.lang.String serializeEditNodes(EditNode[] nodes)
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.nodes - EditNodes to be serializedpublic java.lang.String serializeEditNodes(EditNode[] nodes, SerializationSettings settings)
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.nodes - EditNodes to be serializedsettings - Additional serialization settingspublic java.lang.String serializeEditNodesAsJSON(EditNode[] nodes)
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.nodes - EditNodes to be serializedpublic java.lang.String serializeEditNodesAsJSON(EditNode[] nodes, SerializationSettings settings)
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.nodes - EditNodes to be serializedsettings - Additional serialization settingspublic void setNodeProperties(EditNode editNode, Canvas properties)
removeNodeProperties() instead.editNode - the editNode to updateproperties - the properties to applyremoveNodeProperties(com.smartgwt.client.tools.EditNode, java.lang.String[]),
getNodeProperty(com.smartgwt.client.tools.EditNode, java.lang.String)public void setNodeProperties(EditNode editNode, Canvas properties, java.lang.Boolean skipLiveObjectUpdate)
removeNodeProperties() instead.editNode - the editNode to updateproperties - the properties to applyskipLiveObjectUpdate - whether to skip updating the liveObject, e.g. if you have
already updated the liveObjectremoveNodeProperties(com.smartgwt.client.tools.EditNode, java.lang.String[]),
getNodeProperty(com.smartgwt.client.tools.EditNode, java.lang.String)public static void setDefaultProperties(EditPane editPaneProperties)
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.
editPaneProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.tools.EditPaneLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class Canvas