Packagecom.yworks.ui
Classpublic class GraphCanvasComponent
InheritanceGraphCanvasComponent Inheritance CanvasComponent Inheritance mx.core.UIComponent
Implements INodeBoundsChangedListener, IBendLocationChangedListener

An UIComponent that displays and animates IGraphs.

Default MXML PropertyinputMode



Public Properties
 PropertyDefined By
  animate : Boolean
This property defines whether invoking morphGraph will trigger an animated transition of the current graph to a different layout or if the layout will just change instantly.
GraphCanvasComponent
 InheritedautoDrag : Boolean
Gets or sets a property that causes the canvas to automatically pan the view when the mouse gets dragged within the autoDragInsets of the canvas.
CanvasComponent
 InheritedautoDragInsets : ImmutableRectangle
Gets or sets the auto drag insets.
CanvasComponent
 InheritedautoMouseWheelZoom : Boolean
Determines whether the mouse wheel should be used for zooming.
CanvasComponent
 InheritedbackgroundAlpha : Number
[write-only] Sets the alpha value of the canvas background color.
CanvasComponent
 InheritedbackgroundColor : uint
[write-only] Sets the background color of the canvas.
CanvasComponent
  backgroundGroup : ICanvasObjectGroup
Gets or sets the BackgroundGroup property.
GraphCanvasComponent
 InheritedbridgeManager : BridgeManager
CanvasComponent
 Inheritedcenter : Point
The world coordinate at the center of the canvas component.
CanvasComponent
  clipboard : GraphClipboard
The GraphClipboard associated with this control.
GraphCanvasComponent
  contentGroup : ICanvasObjectGroup
Gets or sets the contentGroup property.
GraphCanvasComponent
 InheritedcontentRect : Rectangle
Gets and sets the Rectangle in world coordinates that holds the contents.
CanvasComponent
 Inheritedcontext : ICanvasContext
[read-only] Returns an implementation of ICanvasContext that describes the state of this canvas control.
CanvasComponent
  currentItem : IModelItem
The "current" item, i.e.
GraphCanvasComponent
 Inheritedcursor : Cursor
Get or set the cursor instance that will be displayed for this canvas.
CanvasComponent
 InheriteddoubleClickSize : ISize
The size of the area within which the user must click twice for the two clicks to be considered a double-click.
CanvasComponent
 InheriteddoubleClickTime : int
The time that may elapse between two consecutive mouse clicks so the last click is still considered a double click.
CanvasComponent
 InheriteddragSize : ISize
The area in view coordinates the mouse may stay in before a movement is considered a drag.
CanvasComponent
 InheriteddragTime : int
The value of the drag time.
CanvasComponent
 Inheritededitable : Boolean
Property that sets the editable state of this canvas.
CanvasComponent
 InheritedenableMouseChildren : int
Determines whether to propagate mouse events to the children in the display list.
CanvasComponent
  focusGroup : ICanvasObjectGroup
Gets or sets the focusGroup property.
GraphCanvasComponent
  focusPaintManager : FocusPaintManager
Gets or sets the FocusPaintManager property.
GraphCanvasComponent
  graph : IGraph
The IGraph which contains the contents of this component.
GraphCanvasComponent
  graphModelManager : GraphModelManager
The graphModelManager property.
GraphCanvasComponent
 InheritedhasHorizontalScrollBar : Boolean
[read-only]
CanvasComponent
 InheritedhasVerticalScrollBar : Boolean
[read-only]
CanvasComponent
  highlightGroup : ICanvasObjectGroup
Gets or sets the highlightGroup property.
GraphCanvasComponent
  highlightPaintManager : HighlightPaintManager
Gets or sets the HighlightPaintManager property.
GraphCanvasComponent
 InheritedhitTestRadius : Number
Specifies the radius of the area around the mouse in view coordinates in which an IHitTestable may lie to be considered a valid hit.
CanvasComponent
 InheritedhorizontalLineScrollSize : Number
The amount to scroll when an arrow button of the horizontal scrollbar is pressed, in pixels.
CanvasComponent
 InheritedhorizontalPageScrollSize : Number
Specifies the amount to scroll when the horizontal scroll bar track is pressed, in pixels.
CanvasComponent
 InheritedhorizontalScrollPolicy : String
Specifies the visibility policy for the horizontal scrollbar.
CanvasComponent
 InheritedhorizontalScrollPosition : Number
The current position of the horizontal scroll bar.
CanvasComponent
 InheritedinputMode : IInputMode
Specifies the single IInputMode instance that shall be installed for this canvas.
CanvasComponent
 InheritedinputModeContext : IInputModeContext
The InputModeContext property.
CanvasComponent
 InheritedinputModeContextLookupChain : LookupChain
[read-only] Retrieves the LookupChain that can be used to decorate the lookup call in the inputModeContext.
CanvasComponent
  inputModeGroup : ICanvasObjectGroup
Gets or sets the InputModeGroup property.
GraphCanvasComponent
 InheritedinputModes : List
[read-only] Returns the internal list of currently installed IInputModes.
CanvasComponent
 InheritedlastCanvasMouseEvent : CanvasMouseEvent
[read-only] Gets the last CanvasMouseEvent that was dispatched by this instance.
CanvasComponent
 InheritedlimitedMinZoom : Number
[read-only] Returns the minimum zoom value for the current canvas size and viewport limits
CanvasComponent
 InheritedmaxHorizontalScrollPosition : Number
[read-only] If the canvas component currently has a horizontal scroll bar, returns the maxScrollPosition of the horizontal scroll bar.
CanvasComponent
 InheritedmaxVerticalScrollPosition : Number
[read-only] If the canvas component currently has a vertical scroll bar, returns the maxScrollPosition of the vertical scroll bar.
CanvasComponent
 InheritedmaxZoom : Number
The maxZoom property.
CanvasComponent
 InheritedminHorizontalScrollPosition : Number
[read-only] If the canvas component currently has a horizontal scroll bar, returns the minScrollPosition of the horizontal scroll bar.
CanvasComponent
 InheritedminVerticalScrollPosition : Number
[read-only] If the canvas component currently has a vertical scroll bar, returns the minScrollPosition of the vertical scroll bar.
CanvasComponent
 InheritedminZoom : Number
The minZoom property.
CanvasComponent
 InheritedmouseInterval : Number
Time interval in milliseconds after which a mouse move (MouseEvent.MOUSE_MOVE) is processed.
CanvasComponent
 InheritedmouseWheelZoomCenteredRecognizer : Function
The recognizer used to determine if the mouse event passed to the mouseWheelZoom method should trigger a zoom action that uses the center of the view port as fixed coordinate during zooming.
CanvasComponent
 InheritedmouseWheelZoomFactor : Number
The factor by which the zoom level changes when the mouse wheel is turned.
CanvasComponent
 InheritedmouseWheelZoomMouseLocationRecognizer : Function
The recognizer used to determine if the mouse event passed to the mouseWheelZoom method should trigger a zoom action that uses the current mouse location as fixed coordinate during zooming.
CanvasComponent
  replaceLabelsOnUpdate : Boolean
Whether the morphGraph function should replace all labels with new instances, or whether it should try to map labels to existing label instances (the default behavior).
GraphCanvasComponent
  selection : IGraphSelection
Gets or sets the selection model that is used for this control.
GraphCanvasComponent
  selectionGroup : ICanvasObjectGroup
Gets or sets the SelectionGroup property.
GraphCanvasComponent
  selectionPaintManager : SelectionPaintManager
Gets or sets the SelectionPaintManager property.
GraphCanvasComponent
  snapResultGroup : ICanvasObjectGroup
Gets or sets the snapResultGroup property.
GraphCanvasComponent
 InheritedtreeDirty : Boolean
Property that determines whether the whole canvasObjectTree is redrawn upon the next invocation of updateDisplayList().
CanvasComponent
 InheritedtreePartiallyDirty : Boolean
Property that determines whether the canvasObjectTree is redrawn partially upon the next invocation of updateDisplayList().
CanvasComponent
 InheritedverticalLineScrollSize : Number
The amount to scroll when an arrow button of the vertical scrollbar is pressed, in pixels.
CanvasComponent
 InheritedverticalPageScrollSize : Number
Specifies the amount to scroll when the vertical scroll bar track is pressed, in pixels.
CanvasComponent
 InheritedverticalScrollPolicy : String
Specifies the visibility policy for the vertical scrollbar.
CanvasComponent
 InheritedverticalScrollPosition : Number
The current position of the vertical scroll bar.
CanvasComponent
 InheritedviewPoint : Point
The current view point.
CanvasComponent
 InheritedviewPort : IRectangle
[read-only] Returns the currently visible viewing region in world coordinates.
CanvasComponent
 InheritedviewportLimiter : ViewportLimiter
Gets or sets the viewport limiter instance that can be used to limit the explorable region.
CanvasComponent
 Inheritedzoom : Number
The zoom factor for this canvas control.
CanvasComponent
 InheritedzoomIfCanvasHit : Boolean
Whether the mouse wheel triggers zooming whenever the mouse is over the canvas area (true) or whether the canvas needs focus to trigger zooming (false).
CanvasComponent
Protected Properties
 PropertyDefined By
 Inherited_viewPoint : Point
CanvasComponent
Public Methods
 MethodDefined By
  
Constructor.
GraphCanvasComponent
  
addCanvasObject(userObject:Object, descriptor:ICanvasObjectDescriptor = null, group:ICanvasObjectGroup = null):ICanvasObject
[override]
GraphCanvasComponent
 Inherited
Adds an IDisplayObjectCreator instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor.
CanvasComponent
 Inherited
Adds a new ICanvasObjectGroup to the root of the canvas object tree.
CanvasComponent
 Inherited
Adds a new ICanvasObjectGroup to the specified group in the current canvas object tree.
CanvasComponent
 Inherited
Deprecated Since 1.7: Please Use addDisplayObjectCreator
Adds an IPaintable instance to the scene graph using CanvasObjectDescriptor.Instance as the ICanvasObjectDescriptor.
CanvasComponent
  
canRedo():Boolean
Determines whether a call to redo() will succeed.
GraphCanvasComponent
  
canUndo():Boolean
Determines whether a call to undo() will succeed.
GraphCanvasComponent
 Inherited
collectCanvasObjects(x:Number, y:Number, elementFoundCallback:Function):void
Collects all canvas object instances that are hit at the given coordinate set.
CanvasComponent
  
copy():void
Copies the selected items into the clipboard.
GraphCanvasComponent
  
Factory method for the graph property.
GraphCanvasComponent
 Inherited
Creates a sprite containing a complete copy of the current canvas object tree.
CanvasComponent
  
cut():void
Cuts the selected items into the clipboard.
GraphCanvasComponent
 Inherited
decreaseZoom(factor:Number = 1.2):void
Descrease the current zoom level using the provided factor.
CanvasComponent
 Inherited
fitContent():void
Adjusts the view port to fully encompass the current content rectangle.
CanvasComponent
 Inherited
fitGraphBounds(margins:IRectangle = null):void
Updates the content rectangle and adjusts the viewport to encompass the contents.
CanvasComponent
 Inherited
Invalidates this canvas component and causes a repaint of all display objects that are visible in this canvas component.
CanvasComponent
 Inherited
getCanvasObject(worldX:Number, worldY:Number):ICanvasObject
Returns the top most canvas object instance that is hit at the given coordinate set.
CanvasComponent
 Inherited
getCanvasObjects(worldX:Number, worldY:Number):Iterable
Returns a list of all canvas objects in hit order at the given world coordinate location.
CanvasComponent
 Inherited
getCanvasRect():Rectangle
Returns a rectangle defined by the available space for displaying the CanvasObjectTree within this Component, in stage coordinates.
CanvasComponent
  
Returns a canvas group provider instance that yields focusGroup.
GraphCanvasComponent
  
Returns a canvas group provider instance that yields the highlightGroup.
GraphCanvasComponent
 Inherited
getHits(stageX:Number, stageY:Number, useShape:Boolean = true):Array
Returns an array of ICanvasObjects that are hit by the given coords.
CanvasComponent
  
Returns a canvas group provider instance that yields a SelectionGroup.
GraphCanvasComponent
  
Returns a canvas group provider instance that yields the snapResultGroup.
GraphCanvasComponent
  
Retrieves the UndoEngine associated with the current graph instance.
GraphCanvasComponent
 Inherited
increaseZoom(factor:Number = 1.2):void
Increase the current zoom level using the provided factor.
CanvasComponent
 Inherited
Forces a repaint of all canvas objects.
CanvasComponent
 Inherited
Forces a repaint of the dirty canvas objects.
CanvasComponent
 Inherited
[override] Marks a component so that its updateDisplayList() method gets called during a later screen update.
CanvasComponent
  
Invalidates the visual representation of a model item.
GraphCanvasComponent
 Inherited
isCanvasHit(target:DisplayObject, stageX:Number, stageY:Number):Boolean
Checks whether the point at stageX,stageY is within the canvas bounds and target is a child of the canvas.
CanvasComponent
 Inherited
iterateHits(x:Number, y:Number, root:ICanvasObjectGroup = null, filter:Function = null):Iterator
Iterates all hit elements in the canvas below the given group that are accepted by a given filter.
CanvasComponent
  
loadGraphFromURL(URL:String, ioHandler:IOHandler = null, theGraph:IGraph = null, callback:Function = null):void
Load a GraphML file from an URL, parse the GraphML file and display the graph.
GraphCanvasComponent
  
loadGraphFromXML(xml:XML, ioHandler:GraphMLIOHandler = null, theGraph:IGraph = null):void
Parse and display a graph from a GraphML file.
GraphCanvasComponent
 Inherited
lookup(type:Class):Object
CanvasComponent
  
morphGraph(newGraph:IGraph, copyMask:uint, localViewMode:Boolean = false):void
Morphs the graph from the current state to a different state.
GraphCanvasComponent
  
paste():void
Pastes the clipboard's contents into the actual graph.
GraphCanvasComponent
 Inherited
print(bitmap:Boolean = true, borderSize:uint = 5, backgroundFill:* = 0xFFFFFF, printRect:Rectangle = null, canvasSprite:Sprite = null):void
Prints the current canvas object tree or a pre-calculated copy of it.
CanvasComponent
  
redo():void
Redoes the last operation.
GraphCanvasComponent
 Inherited
setLimitedCenter(center:Point):void
Sets the provided center unless this would cause the viewport to exceed the limits of the viewportLimiter.
CanvasComponent
 Inherited
setLimitedViewpoint(vp:Point):void
Sets the provided viewpoint unless this would cause the viewport to exceed the limits of the viewportLimiter.
CanvasComponent
 Inherited
Sets the provided viewport unless this would cause the viewport to exceed the limits of the viewportLimiter.
CanvasComponent
 Inherited
setLimitedZoom(newZoom:Number):void
Sets the provided zoom value unless this would cause the viewport to exceed the limits of the viewportLimiter.
CanvasComponent
 Inherited
Converts a point in world coordinates to view coordinates.
CanvasComponent
 Inherited
Converts a point in view coordinates to world coordinates.
CanvasComponent
  
undo():void
Undoes the last operation.
GraphCanvasComponent
 Inherited
updateContentRect(margins:IRectangle = null):void
Updates the contentRect to encompass the bounds by all elements in the current scene graph upon the next invocation of updateDisplayList.
CanvasComponent
  
writeGraph(ioHandler:GraphMLIOHandler = null):XML
Convenience method that exports the graph to XML using the GraphML format.
GraphCanvasComponent
 Inherited
zoomTo(px:Number, py:Number, theZoom:Number):void
Sets the zoom level and view port center to the given values.
CanvasComponent
 Inherited
zoomToRect(rect:Rectangle, maxZoom:Number):void
Adjusts the view port to fit in the given rectangle.
CanvasComponent
Protected Methods
 MethodDefined By
 Inherited
Adjusts the mouse cursor based on the given mouse event and the cursor property.
CanvasComponent
  
copyRegisteredData(updateGraph:IGraph, copyMask:uint, localViewMode:Boolean = false):void
Copies data stored in registered IMappers from updateGraph's mapperRegistry to the mapper registry of the current graph instance.
GraphCanvasComponent
  
copyUserTag(item:Object, updateItem:Object, graphMorpher:GraphMorpher, copyMask:uint):void
GraphCanvasComponent
  
copyUserTags(newGraph:IGraph, graphMorpher:GraphMorpher, copyMask:uint, localViewMode:Boolean = false):void
GraphCanvasComponent
  
Factory method for the BackgroundGroup property.
GraphCanvasComponent
  
Factory method for the canvasObjectDependencyManager property.
GraphCanvasComponent
  
[override]
GraphCanvasComponent
  
Factory method for the contentGroup property.
GraphCanvasComponent
  
Factory method for the focusGroup property.
GraphCanvasComponent
  
Factory method for the focusPaintManager property.
GraphCanvasComponent
  
Creates the default instance to use if no custom instance has been set.
GraphCanvasComponent
  
Factory method for the GraphModelManager property.
GraphCanvasComponent
  
Factory method for the highlightGroup property.
GraphCanvasComponent
  
Factory method for the highlightPaintManager property.
GraphCanvasComponent
 Inherited
Factory method for the InputModeContext property.
CanvasComponent
  
Factory method for the inputModeGroup property.
GraphCanvasComponent
  
Creates an IOHandler that is used when a graph is loaded from an URL or from a XML instance.
GraphCanvasComponent
  
Factory method which will create the selection model that is used for this control.
GraphCanvasComponent
  
Factory method for the SelectionGroup property.
GraphCanvasComponent
  
Factory method for the selectionPaintManager property.
GraphCanvasComponent
  
Factory method for the snapResultGroup property.
GraphCanvasComponent
 Inherited
disposeListeners(eventDispatcher:IEventDispatcher):void
Unregister all event listeners that were registered with the stage.
CanvasComponent
 Inherited
doEvent(e:Event = null):void
Delayed processing of a MouseEvent.MOUSE_MOVE.
CanvasComponent
 Inherited
When fitContent() is called, this method is invoked in the next updateDisplayList() execution to actually fit the content rectangle into the viewport.
CanvasComponent
 Inherited
initListeners(eventDispatcher:IEventDispatcher):void
Initialize all event listeners that should be registered with the stage.
CanvasComponent
 Inherited
inputModeContextLookup(type:Class):Object
Callback that is used by the default implementation of inputModeContext to resolve lookup calls.
CanvasComponent
 Inherited
measure():void
[override] Calculates the default size and the default minimum size of the component.
CanvasComponent
 Inherited
If the autoMouseWheelZoom property is set to true, this method will adjust the current zoom level.
CanvasComponent
 Inherited
onAdd(event:FlexEvent):void
Called when the component is added to the display list.
CanvasComponent
  
Called when an animation triggered by morphGraph ends.
GraphCanvasComponent
 Inherited
onAutoDragChanged(oldValue:Boolean, newValue:Boolean):void
Called when the autoDrag property changes.
CanvasComponent
 Inherited
Called when the autoDragInsets property changes.
CanvasComponent
  
onBackgroundGroupChanged(oldBackgroundGroup:ICanvasObjectGroup, newBackgroundGroup:ICanvasObjectGroup):void
Called when the backgroundGroup property value changes and after initialization of the field.
GraphCanvasComponent
 Inherited
Callback method that is called when the mouse has been clicked.
CanvasComponent
 Inherited
Callback method that is called when a mouse button has been pressed.
CanvasComponent
 Inherited
Callback method that is called when the mouse gets dragged.
CanvasComponent
 Inherited
Callback method that is called when the mouse has been moved and the mouse button has not been pressed.
CanvasComponent
 Inherited
Callback method that is called when a mouse button has been released.
CanvasComponent
 Inherited
Callback method that is called when the mouse wheel has been turned.
CanvasComponent
  
Called when the canvasObjectDependencyManager property value changes.
GraphCanvasComponent
  
onContentGroupChanged(oldContentGroup:ICanvasObjectGroup, newContentGroup:ICanvasObjectGroup):void
Called when the contentGroup property value changes and after initialization of the field.
GraphCanvasComponent
 Inherited
Callback that is invoked when the ContentRect property changes.
CanvasComponent
  
Called when the currentItem property changed.
GraphCanvasComponent
 Inherited
Callback that is called when the editable property changes.
CanvasComponent
  
onFocusGroupChanged(oldFocusGroup:ICanvasObjectGroup, newFocusGroup:ICanvasObjectGroup):void
Called when the focusGroup property value changes and after initialization of the field.
GraphCanvasComponent
  
onFocusPaintManagerChanged(oldFocusPaintManager:FocusPaintManager, newFocusPaintManager:FocusPaintManager):void
Called when the focusPaintManager property value changes and after initialization of the field.
GraphCanvasComponent
  
onGraphChanged(oldGraph:IGraph, newGraph:IGraph):void
Called when the graph property value changes and after initialization of the field.
GraphCanvasComponent
  
Called when the graph has to be repainted
GraphCanvasComponent
  
onGraphModelManagerChanged(oldGraphModelManager:GraphModelManager, newGraphModelManager:GraphModelManager):void
Called when the graphModelManager property value changes.
GraphCanvasComponent
  
onHighlightGroupChanged(oldHighlightGroup:ICanvasObjectGroup, newHighlightGroup:ICanvasObjectGroup):void
Called when the highlightGroup property value changes and after initialization of the field.
GraphCanvasComponent
  
onHighlightPaintManagerChanged(oldHighlightPaintManager:HighlightPaintManager, newHighlightPaintManager:HighlightPaintManager):void
Called when the highlightPaintManager property value changes and after initialization of the field.
GraphCanvasComponent
 Inherited
onHitTestRadiusChanged(oldValue:Number, newValue:Number):void
Callback that is invoked when the hitTestRadius property changed.
CanvasComponent
 Inherited
onInputModeChanged(oldValue:IInputMode, newValue:IInputMode):void
Callback that is invoked when the inputMode property changes.
CanvasComponent
 Inherited
onInputModeContextChanged(oldInputModeContext:IInputModeContext, newInputModeContext:IInputModeContext):void
Called when the inputModeContext property value changes and after initialization of the field.
CanvasComponent
  
onInputModeGroupChanged(oldInputModeGroup:ICanvasObjectGroup, newInputModeGroup:ICanvasObjectGroup):void
Called when the inputModeGroup property value changes and after initialization of the field.
GraphCanvasComponent
 Inherited
onMouseDown(evt:MouseEvent):void
Tries to gain the focus, if the canvas area was hit.
CanvasComponent
 Inherited
onMouseEvent(evt:MouseEvent):void
Deprecated: Use the various onCanvasMouseXXX hooks or event listeners for CanvasMouseEvents instead.
Called when this component receives a MouseEvent.
CanvasComponent
 Inherited
onMouseMove(evt:MouseEvent):void
Calls onCanvasMouseDragged or onCanvasMouseMoved with the corresponding CanvasMouseEvent.
CanvasComponent
 Inherited
onMouseUp(evt:MouseEvent):void
Calls onCanvasMouseUp and possibly onCanvasMouseClicked with the corresponding CanvasMouseEvent.
CanvasComponent
 Inherited
onMouseWheel(evt:MouseEvent):void
Calls onCanvasMouseWheel with the corresponding CanvasMouseEvent.
CanvasComponent
 Inherited
onRemove(event:FlexEvent):void
Called when the component is removed from the display list.
CanvasComponent
  
onSelectionChanged(oldGraphSelection:IGraphSelection, newGraphSelection:IGraphSelection):void
Called when the selection property value changes and after initialization of the field.
GraphCanvasComponent
  
onSelectionGroupChanged(oldSelectionGroup:ICanvasObjectGroup, newSelectionGroup:ICanvasObjectGroup):void
Called when the selectionGroup property value changes and after initialization of the field. Triggers the selectionGroupChanged event.
GraphCanvasComponent
  
onSelectionPaintManagerChanged(oldSelectionPaintManager:SelectionPaintManager, newSelectionPaintManager:SelectionPaintManager):void
Called when the selectionPaintManager property value changes and after initialization of the field.
GraphCanvasComponent
  
onSnapResultGroupChanged(oldSnapResultGroup:ICanvasObjectGroup, newSnapResultGroup:ICanvasObjectGroup):void
Called when the snapResultGroup property value changes and after initialization of the field.
GraphCanvasComponent
 Inherited
Callback that is invoked when the view port property changes.
CanvasComponent
 Inherited
processEvent(event:Event):void
Processes a mouse event.
CanvasComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
CanvasComponent
  
updateTree(partially:Boolean = false):void
[override]
GraphCanvasComponent
 Inherited
update the viewport bounds upon the next invocation of updateDisplayList.
CanvasComponent
Events
 Event Summary Defined By
 InheritedDispatched when the autoDrag property changes.CanvasComponent
 InheritedDispatched when the autoDragInsets property changes.CanvasComponent
  Dispatched when the backgroundModeGroup property changed.GraphCanvasComponent
 InheritedDispatched when the mouse is clicked.CanvasComponent
 InheritedDispatched when the mouse is double clicked.CanvasComponent
 InheritedDispatched when the mouse is pressed.CanvasComponent
 InheritedDispatched when the mouse is dragged.CanvasComponent
 InheritedDispatched when the mouse is moved.CanvasComponent
 InheritedDispatched when the mouse is released.CanvasComponent
 InheritedDispatched when the mousewheel moves.CanvasComponent
  Dispatched when the contentGroup property changed.GraphCanvasComponent
 InheritedDispatched when the contentRect property changes.CanvasComponent
  Dispatched when the currentItem property changed.GraphCanvasComponent
 InheritedDispatched when the editable property changes.CanvasComponent
  Dispatched when the focusGroup property changed.GraphCanvasComponent
  Dispatched when the focusPaintManager property changed.GraphCanvasComponent
  Dispatched when the graph property changed.GraphCanvasComponent
  Dispatched when the graphModelManager property changed.GraphCanvasComponent
  Dispatched when the highlightGroup property changed.GraphCanvasComponent
  Dispatched when the highlightPaintManager property changed.GraphCanvasComponent
 InheritedDispatched when the inputMode property changes.CanvasComponent
 InheritedDispatched when the inputModeContext property changes.CanvasComponent
  Dispatched when the inputModeGroup property changed.GraphCanvasComponent
 InheritedDispatched when the canvas has been invalidated.CanvasComponent
  Dispatched when an io error occurs while loading a graph from an URL.GraphCanvasComponent
  Dispatched just before a context menu is to be created for a graph item.GraphCanvasComponent
  Dispatched after the graph morphs to a different layout.GraphCanvasComponent
  Dispatched when an error occurs during a morph operation.GraphCanvasComponent
  Dispatched before the graph morphs to a different layout.GraphCanvasComponent
 InheritedDispatched when one of the scrollbars changes its scroll position.CanvasComponent
  Dispatched when a security error occurs while loading a graph from an URL.GraphCanvasComponent
  Dispatched when the selection property changed.GraphCanvasComponent
  Dispatched when the selectionGroup property changed.GraphCanvasComponent
  Dispatched when the selectionPaintManager property changed.GraphCanvasComponent
  Dispatched when the snapResultGroup property changed.GraphCanvasComponent
 InheritedDispatched when the canvas object tree is repainted.CanvasComponent
 InheritedDispatched when the viewPoint property changes.CanvasComponent
 InheritedDispatched when the viewPort property changes.CanvasComponent
 InheritedDispatched when the zoom property changes.CanvasComponent
Public Constants
 ConstantDefined By
 InheritedAUTO_DRAG_CHANGED : String = autoDragChanged
[static] Dispatched when the autoDrag property changes.
CanvasComponent
 InheritedAUTO_DRAG_INSETS_CHANGED : String = autoDragInsetsChanged
[static] Dispatched when the autoDragInsets property changes.
CanvasComponent
  BACKGROUND_GROUP_CHANGED : String = backgroundGroupChanged
[static]
GraphCanvasComponent
  CONTENT_GROUP_CHANGED : String = contentGroupChanged
[static]
GraphCanvasComponent
 InheritedCONTENT_RECT_CHANGED : String = contentRectChanged
[static] Dispatched when the contentRect property changes.
CanvasComponent
  CURRENT_ITEM_CHANGED : String = currentItemChanged
[static]
GraphCanvasComponent
 InheritedEDITABLE_CHANGED : String = editableChanged
[static] Dispatched when the editable property changes.
CanvasComponent
  FOCUS_GROUP_CHANGED : String = highlightGroupChanged
[static]
GraphCanvasComponent
  FOCUS_PAINT_MANAGER_CHANGED : String = focusPaintManagerChanged
[static]
GraphCanvasComponent
  GRAPH_CHANGED : String = graphChanged
[static]
GraphCanvasComponent
  GRAPH_MODEL_MANAGER_CHANGED : String = graphModelManagerChanged
[static]
GraphCanvasComponent
  HIGHLIGHT_GROUP_CHANGED : String = highlightGroupChanged
[static]
GraphCanvasComponent
  HIGHLIGHT_PAINT_MANAGER_CHANGED : String = highlightPaintManagerChanged
[static]
GraphCanvasComponent
 InheritedINPUT_MODE_CHANGED : String = inputModeChanged
[static] Dispatched when the inputMode property changes.
CanvasComponent
 InheritedINPUT_MODE_CONTEXT_CHANGED : String = inputModeContextChanged
[static] Dispatched when the inputModeContext property changes.
CanvasComponent
  INPUT_MODE_GROUP_CHANGED : String = inputModeGroupChanged
[static]
GraphCanvasComponent
 InheritedINVALIDATED : String = invalidated
[static] Dispatched when the canvas has been invalidated.
CanvasComponent
 InheritedMOUSE_CHILDREN_ALWAYS : int = 1
[static] Mouse events will always be propagated to child DisplayObjects.
CanvasComponent
 InheritedMOUSE_CHILDREN_AUTO : int = -1
[static] Mouse events will only be propagated to child DisplayObjects if they may need interactivity.
CanvasComponent
 InheritedMOUSE_CHILDREN_NEVER : int = 0
[static] Mouse events will never be propagated to child DisplayObjects.
CanvasComponent
  OPTION_COPY_ALL : uint = 0xFFFFFFFF
[static] Option constant for the morphGraph function that will cause the morphing function to copy everything that can be copied.
GraphCanvasComponent
  OPTION_COPY_EDGE_DATA : uint = 2
[static] Option constant for the morphGraph function that will cause the morphing function to copy all data associated with edges using the mapper registry.
GraphCanvasComponent
  OPTION_COPY_EDGE_LABEL_USER_TAGS : uint = 1024
[static] Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with edge labels using ITagOwner instances provided by the label's lookup.
GraphCanvasComponent
  OPTION_COPY_EDGE_STYLE : uint = 8
[static] Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with edges.
GraphCanvasComponent
  OPTION_COPY_EDGE_USER_TAGS : uint = 256
[static] Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with edges using ITagOwner instances provided by the edge's lookup.
GraphCanvasComponent
  OPTION_COPY_GRAPH_DATA : uint = 64
[static] Option constant for the morphGraph function that will cause the morphing function to copy all data associated with the graph instance using the mapper registry.
GraphCanvasComponent
  OPTION_COPY_LABELS : uint = 4096
[static] Option constant for the morphGraph function that will cause the morphing function to copy the labels without copying the styles.
GraphCanvasComponent
  OPTION_COPY_LABEL_STYLE : uint = 32
[static] Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with labels.
GraphCanvasComponent
  OPTION_COPY_NODE_AND_EDGE_DATA : uint = 3
[static] Option constant for the morphGraph function that will cause the morphing function to copy all data associated with both nodes and edges using the mapper registry.
GraphCanvasComponent
  OPTION_COPY_NODE_DATA : uint = 1
[static] Option constant for the morphGraph function that will cause the morphing function to copy all data associated with nodes using the mapper registry.
GraphCanvasComponent
  OPTION_COPY_NODE_LABEL_USER_TAGS : uint = 512
[static] Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with node labels using ITagOwner instances provided by the label's lookup.
GraphCanvasComponent
  OPTION_COPY_NODE_STYLE : uint = 4
[static] Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with nodes.
GraphCanvasComponent
  OPTION_COPY_NODE_USER_TAGS : uint = 128
[static] Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with nodes using ITagOwner instances provided by the node's lookup.
GraphCanvasComponent
  OPTION_COPY_NONE : uint = 0
[static] Option constant for the morphGraph function that will prevent the morphing function from copying any data associated with graph items by the mapper registry.
GraphCanvasComponent
  OPTION_COPY_PORT_DATA : uint = 0x10000
[static] Option constant for the morphGraph function that will cause the morphing function to copy all data associated with ports using the mapper registry.
GraphCanvasComponent
  OPTION_COPY_PORT_MODEL : uint = 8192
[static] Option constant for the morphGraph function that will cause the morphing function to copy the port location models.
GraphCanvasComponent
  OPTION_COPY_PORT_STYLE : uint = 16
[static] Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with ports.
GraphCanvasComponent
  OPTION_COPY_PORT_USER_TAGS : uint = 2048
[static] Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with ports using ITagOwner instances provided by the port's lookup.
GraphCanvasComponent
  OPTION_COPY_TABLE_LAYOUT : uint = 0x4000
[static] Option constant for the morphGraph function that will cause the morphing function to copy the layout of ITables.
GraphCanvasComponent
  OPTION_COPY_TABLES : uint = 0xC000
[static] Option constant for the morphGraph function that will cause the morphing function to copy the style and layout of ITables.
GraphCanvasComponent
  OPTION_COPY_TABLE_STYLE : uint = 0x8000
[static] Option constant for the morphGraph function that will cause the morphing function to copy the style of ITables.
GraphCanvasComponent
  OPTION_COPY_USER_TAGS : uint = 3968
[static] Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with all graph items using ITagOwner instances provided by the item's lookup.
GraphCanvasComponent
  SELECTION_CHANGED : String = selectionChanged
[static]
GraphCanvasComponent
  SELECTION_GROUP_CHANGED : String = selectionGroupChanged
[static]
GraphCanvasComponent
  SELECTION_PAINT_MANAGER_CHANGED : String = selectionPaintManagerChanged
[static]
GraphCanvasComponent
  SNAP_RESULT_GROUP_CHANGED : String = snapResultGroupChanged
[static]
GraphCanvasComponent
 InheritedVIEWPORT_CHANGED : String = viewPortChanged
[static] Kept for backward compatibility.
CanvasComponent
Property Detail
animateproperty
animate:Boolean

This property defines whether invoking morphGraph will trigger an animated transition of the current graph to a different layout or if the layout will just change instantly.

This property can be used as the source for data binding.


Implementation
    public function get animate():Boolean
    public function set animate(value:Boolean):void
backgroundGroupproperty 
backgroundGroup:ICanvasObjectGroup

Gets or sets the BackgroundGroup property.

The background group is the ICanvasObjectGroup that should be used by the application code to put background elements in. If the field has not yet been initialized upon first access, the factory method createBackgroundGroup will be called. Upon change the onBackgroundGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get backgroundGroup():ICanvasObjectGroup
    public function set backgroundGroup(value:ICanvasObjectGroup):void

See also

clipboardproperty 
clipboard:GraphClipboard

The GraphClipboard associated with this control.

If no instance has been configured with this control, a default implementation will be used.

This property can be used as the source for data binding.


Implementation
    public function get clipboard():GraphClipboard
    public function set clipboard(value:GraphClipboard):void

See also

contentGroupproperty 
contentGroup:ICanvasObjectGroup

Gets or sets the contentGroup property.

This is the canvas object group that should be used by the application code to put actual content in. If the field has not yet been initialized upon first access, the factory method createContentGroup will be called. Upon change the onContentGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get contentGroup():ICanvasObjectGroup
    public function set contentGroup(value:ICanvasObjectGroup):void
currentItemproperty 
currentItem:IModelItem

The "current" item, i.e. the item which has the focus.

The current item by default is given focus indication using the focusPaintManager. If a GraphEditorInputMode is installed the currentItem is the last item which was clicked by the mouse, depending on the focusableItems settings of the input mode. Also, the current item can be changed using the keyboard by the NavigationInputMode.

This property can be used as the source for data binding.


Implementation
    public function get currentItem():IModelItem
    public function set currentItem(value:IModelItem):void

See also

currentMorpherproperty 
currentMorpher:GraphMorpher


Implementation
    yworks_internal function get currentMorpher():GraphMorpher
    yworks_internal function set currentMorpher(value:GraphMorpher):void
focusGroupproperty 
focusGroup:ICanvasObjectGroup

Gets or sets the focusGroup property.

If the field has not yet been initialized upon first access, the factory method createFocusGroup will be called. Upon change the onFocusGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get focusGroup():ICanvasObjectGroup
    public function set focusGroup(value:ICanvasObjectGroup):void

See also

focusPaintManagerproperty 
focusPaintManager:FocusPaintManager

Gets or sets the FocusPaintManager property.

If the field has not yet been initialized upon first access, the factory method createFocusPaintManager() will be called. Upon change the onFocusPaintManagerChanged() method will be called.

This property can be used as the source for data binding.


Implementation
    public function get focusPaintManager():FocusPaintManager
    public function set focusPaintManager(value:FocusPaintManager):void

See also

graphproperty 
graph:IGraph

The IGraph which contains the contents of this component.

A GraphEvent.GRAPH_CHANGED will be fired, if a new IGraph instance will be installed.

This property can be used as the source for data binding.


Implementation
    public function get graph():IGraph
    public function set graph(value:IGraph):void
graphModelManagerproperty 
graphModelManager:GraphModelManager

The graphModelManager property.

Upon change, the onGraphModelManagerChanged method is called.

This property can be used as the source for data binding.


Implementation
    public function get graphModelManager():GraphModelManager
    public function set graphModelManager(value:GraphModelManager):void
highlightGroupproperty 
highlightGroup:ICanvasObjectGroup

Gets or sets the highlightGroup property.

If the field has not yet been initialized upon first access, the factory method createHighlightGroup will be called. Upon change the onHighlightGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get highlightGroup():ICanvasObjectGroup
    public function set highlightGroup(value:ICanvasObjectGroup):void

See also

highlightPaintManagerproperty 
highlightPaintManager:HighlightPaintManager

Gets or sets the HighlightPaintManager property.

If the field has not yet been initialized upon first access, the factory method createHighlightPaintManager() will be called. Upon change the onHighlightPaintManagerChanged() method will be called.

This property can be used as the source for data binding.


Implementation
    public function get highlightPaintManager():HighlightPaintManager
    public function set highlightPaintManager(value:HighlightPaintManager):void

See also

inputModeGroupproperty 
inputModeGroup:ICanvasObjectGroup

Gets or sets the InputModeGroup property.

This is the canvas object group where the IInputModes should add their temporary content to. This group by default is in front of the contentGroup. If the field has not yet been initialized upon first access, the factory method createInputModeGroup will be called. Upon change the onInputModeGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get inputModeGroup():ICanvasObjectGroup
    public function set inputModeGroup(value:ICanvasObjectGroup):void
replaceLabelsOnUpdateproperty 
replaceLabelsOnUpdate:Boolean

Whether the morphGraph function should replace all labels with new instances, or whether it should try to map labels to existing label instances (the default behavior).

If the labels are replaced, selected labels will be descelected. Therefore, this property should only be enabled if there are problems with the label mapping.

The default value is false.


Implementation
    public function get replaceLabelsOnUpdate():Boolean
    public function set replaceLabelsOnUpdate(value:Boolean):void

See also

selectionproperty 
selection:IGraphSelection

Gets or sets the selection model that is used for this control.

The selection model instance needs to be adjusted, normally if the IGraph instance is changed.

If the field has not yet been initialized upon first access, the factory method createSelection will be called. Upon change the onSelectionChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get selection():IGraphSelection
    public function set selection(value:IGraphSelection):void
selectionGroupproperty 
selectionGroup:ICanvasObjectGroup

Gets or sets the SelectionGroup property.

The selection group is the ICanvasObjectGroup that should be used by the application code to put the selection visualization in. If the field has not yet been initialized upon first access, the factory method createSelectionGroup will be called. Upon change the onSelectionGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get selectionGroup():ICanvasObjectGroup
    public function set selectionGroup(value:ICanvasObjectGroup):void
selectionPaintManagerproperty 
selectionPaintManager:SelectionPaintManager

Gets or sets the SelectionPaintManager property.

If the field has not yet been initialized upon first access, the factory method createSelectionPaintManager will be called. Upon change the onSelectionPaintManagerChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get selectionPaintManager():SelectionPaintManager
    public function set selectionPaintManager(value:SelectionPaintManager):void
snapResultGroupproperty 
snapResultGroup:ICanvasObjectGroup

Gets or sets the snapResultGroup property.

If the field has not yet been initialized upon first access, the factory method createSnapResultGroup will be called. Upon change the onSnapResultGroupChanged method will be called.

This property can be used as the source for data binding.


Implementation
    public function get snapResultGroup():ICanvasObjectGroup
    public function set snapResultGroup(value:ICanvasObjectGroup):void

See also

Constructor Detail
GraphCanvasComponent()Constructor
public function GraphCanvasComponent()

Constructor.

Method Detail
addCanvasObject()method
override public function addCanvasObject(userObject:Object, descriptor:ICanvasObjectDescriptor = null, group:ICanvasObjectGroup = null):ICanvasObject

Parameters

userObject:Object
 
descriptor:ICanvasObjectDescriptor (default = null)
 
group:ICanvasObjectGroup (default = null)

Returns
ICanvasObject
canRedo()method 
public function canRedo():Boolean

Determines whether a call to redo() will succeed.

Delegates to the graph's UndoEngine

Returns
Booleantrue if a redo operation is possible.
canUndo()method 
public function canUndo():Boolean

Determines whether a call to undo() will succeed.

Delegates to the graph's UndoEngine

Returns
Booleantrue if an undo operation is possible.
copy()method 
public function copy():void

Copies the selected items into the clipboard.

Delegates to the clipboard's GraphClipboard.copy method using GraphClipboard.createSelectionFilter as the subset to copy.

See also

copyRegisteredData()method 
protected function copyRegisteredData(updateGraph:IGraph, copyMask:uint, localViewMode:Boolean = false):void

Copies data stored in registered IMappers from updateGraph's mapperRegistry to the mapper registry of the current graph instance.

Important: If the copyMask has one or more of the options OPTION_COPY_NODE_DATA, OPTION_COPY_EDGE_DATA, or OPTION_COPY_GRAPH_DATA set it is mandatory that for each mapper which is registered in the current graph a corresponding mapper has to be registered at the updateGraph. Otherwise, a GraphMorphErrorEvent will be dispatched.

Parameters

updateGraph:IGraph — A IGraph instance the represents a new state of the graph currently shown in this canvas.
 
copyMask:uint (default = NaN) — A bit mask that specifies for which graph items the data should be copied.
 
localViewMode:Boolean (default = false) — If the graph shown in this canvas is a folded graph, this parameter determines whether only the local view should be updated (true) or whether the master graph should be changed (false).

See also

copyUserTag()method 
protected function copyUserTag(item:Object, updateItem:Object, graphMorpher:GraphMorpher, copyMask:uint):void

Parameters

item:Object
 
updateItem:Object
 
graphMorpher:GraphMorpher
 
copyMask:uint

copyUserTags()method 
protected function copyUserTags(newGraph:IGraph, graphMorpher:GraphMorpher, copyMask:uint, localViewMode:Boolean = false):void

Parameters

newGraph:IGraph
 
graphMorpher:GraphMorpher
 
copyMask:uint
 
localViewMode:Boolean (default = false)

createBackgroundGroup()method 
protected function createBackgroundGroup():ICanvasObjectGroup

Factory method for the BackgroundGroup property. This method will be called upon first access to the backgroundGroup property.

Returns
ICanvasObjectGroup — a new instance of ICanvasObjectGroup

See also

createCanvasObjectDependencyManager()method 
protected function createCanvasObjectDependencyManager():CanvasObjectDependencyManager

Factory method for the canvasObjectDependencyManager property.

Returns
CanvasObjectDependencyManager — A new instance of com.yworks.canvas.CanvasObjectDependencyManager
createChildren()method 
override protected function createChildren():void

createContentGroup()method 
protected function createContentGroup():ICanvasObjectGroup

Factory method for the contentGroup property. This method will be called upon first access to the contentGroup property.

Returns
ICanvasObjectGroup
createFocusGroup()method 
protected function createFocusGroup():ICanvasObjectGroup

Factory method for the focusGroup property. This method will be called upon first access to the focusGroup property.

Returns
ICanvasObjectGroup — A new instance of ICanvasObjectGroup
createFocusPaintManager()method 
protected function createFocusPaintManager():FocusPaintManager

Factory method for the focusPaintManager property. This method will be called upon first access to the focusPaintManager property.

Returns
FocusPaintManager — A new instance of FocusPaintManager

See also

createGraph()method 
public function createGraph():IGraph

Factory method for the graph property.

If a graph is assigned to this canvas, the default settings (defaultNodeStyle,defaultNodeLabelModelParameter,.. of the assigned graph instance will be copied to the created graph.

Returns
IGraph — A new instance of com.yworks.graph.model.DefaultGraph.
createGraphClipboard()method 
protected function createGraphClipboard():GraphClipboard

Creates the default instance to use if no custom instance has been set.

Returns
GraphClipboard — A default GraphClipboard instance.

See also

createGraphModelManager()method 
protected function createGraphModelManager():GraphModelManager

Factory method for the GraphModelManager property.

Returns
GraphModelManager — A new instance of com.yworks.graph.model.GraphModelManager
createHighlightGroup()method 
protected function createHighlightGroup():ICanvasObjectGroup

Factory method for the highlightGroup property. This method will be called upon first access to the highlightGroup property.

Returns
ICanvasObjectGroup — A new instance of ICanvasObjectGroup
createHighlightPaintManager()method 
protected function createHighlightPaintManager():HighlightPaintManager

Factory method for the highlightPaintManager property. This method will be called upon first access to the highlightPaintManager property.

Returns
HighlightPaintManager — A new instance of HighlightPaintManager

See also

createInputModeGroup()method 
protected function createInputModeGroup():ICanvasObjectGroup

Factory method for the inputModeGroup property. This method will be called upon first access to the inputModeGroup property.

Returns
ICanvasObjectGroup — A canvas object group describing the input mode group
createIOHandler()method 
protected function createIOHandler():IOHandler

Creates an IOHandler that is used when a graph is loaded from an URL or from a XML instance.

This implementation creates a plain, unconfigured GraphMLIOHandler instance that will only read/write structural information.

Returns
IOHandler — a new, unconfigured GraphMLIOHandler instance.
createSelection()method 
protected function createSelection():IGraphSelection

Factory method which will create the selection model that is used for this control.

Returns
IGraphSelection — The newly created selection model.
createSelectionGroup()method 
protected function createSelectionGroup():ICanvasObjectGroup

Factory method for the SelectionGroup property. This method will be called upon first access to the selectionGroup property.

Returns
ICanvasObjectGroup — A new instance of ICanvasObjectGroup
createSelectionPaintManager()method 
protected function createSelectionPaintManager():SelectionPaintManager

Factory method for the selectionPaintManager property.

This method will be called upon first access to the selectionPaintManager property.

Returns
SelectionPaintManager — the newly created SelectionPaintManager instance.
createSnapResultGroup()method 
protected function createSnapResultGroup():ICanvasObjectGroup

Factory method for the snapResultGroup property. This method will be called upon first access to the snapResultGroup property.

Returns
ICanvasObjectGroup — A new instance of ICanvasObjectGroup
cut()method 
public function cut():void

Cuts the selected items into the clipboard.

Delegates to the clipboard's GraphClipboard.cut method using GraphClipboard.createSelectionFilter as the subset to cut.

See also

getFocusGroupProvider()method 
public function getFocusGroupProvider():ICanvasGroupProvider

Returns a canvas group provider instance that yields focusGroup.

Returns
ICanvasGroupProvider
getHighlightGroupProvider()method 
public function getHighlightGroupProvider():ICanvasGroupProvider

Returns a canvas group provider instance that yields the highlightGroup.

Returns
ICanvasGroupProvider

See also

getSelectionGroupProvider()method 
public function getSelectionGroupProvider():ICanvasGroupProvider

Returns a canvas group provider instance that yields a SelectionGroup.

Returns
ICanvasGroupProvider — A canvas group provider instance that yields a SelectionGroup.
getSnapResultGroupProvider()method 
public function getSnapResultGroupProvider():ICanvasGroupProvider

Returns a canvas group provider instance that yields the snapResultGroup.

Returns
ICanvasGroupProvider

See also

getUndoEngine()method 
public function getUndoEngine():UndoEngine

Retrieves the UndoEngine associated with the current graph instance.

Returns
UndoEngine — The instance or null.
invalidateItem()method 
public function invalidateItem(item:IModelItem):void

Invalidates the visual representation of a model item.

This will trigger a repaint of the provided item.

Parameters

item:IModelItem — a model item that is visually represented in this canvas component.

See also

loadGraphFromURL()method 
public function loadGraphFromURL(URL:String, ioHandler:IOHandler = null, theGraph:IGraph = null, callback:Function = null):void

Load a GraphML file from an URL, parse the GraphML file and display the graph.

Parameters

URL:String — An URL pointing to a graphml file.
 
ioHandler:IOHandler (default = null) — A pre-configured io handler. If null, an IOHandler is created using createIOHandler.
 
theGraph:IGraph (default = null) — A graph instance that is to be populated with the graph structure.
 
callback:Function (default = null) — A callback function that is invoked after the graph has been loaded by the the IOHandler, but before the graph instance of the canvas has been replaced with the loaded graph. The callback function has to expect a single parameter of type com.yworks.graph.model.GraphEvent.

loadGraphFromXML()method 
public function loadGraphFromXML(xml:XML, ioHandler:GraphMLIOHandler = null, theGraph:IGraph = null):void

Parse and display a graph from a GraphML file.

Parameters

xml:XML — The xml object containing the graph in GraphML format.
 
ioHandler:GraphMLIOHandler (default = null) — A pre-configured io handler. If null, an IOHandler is created using createIOHandler.
 
theGraph:IGraph (default = null) — A graph instance that is to be populated with the graph structure.

morphGraph()method 
public function morphGraph(newGraph:IGraph, copyMask:uint, localViewMode:Boolean = false):void

Morphs the graph from the current state to a different state. Note that newGraph will not replace this.graph. Instead, this.graph will just be updated to reflect the new state.

Whether the transition is animated is controlled by the animate property.

The mapping from graph items in the current graph to graph items in the newGraph is implemented by using IMappers from the graph's mapperRegistries with the key com.yworks.graph.model.DefaultGraph.MAPPER_KEY_NODE_2_ID. If no IMapper with this key is set for any of the graphs, the current graph will simply be replaced by the newGraph.

If no corresponding graph item is found in the newGraph for a graph item that is present in the current graph, this item will be removed from the current graph. If no corresponding graph item is found in the current graph for an item that is present in the newGraph, this item will be inserted into the current graph.

Important: If the copyMask has one or more of the options OPTION_COPY_NODE_DATA, OPTION_COPY_EDGE_DATA, or OPTION_COPY_GRAPH_DATA set it is mandatory that for each mapper which is registered in the current graph a corresponding mapper is registered at the newGraph. Otherwise, a GraphMorphErrorEvent will be dispatched.

Parameters

newGraph:IGraph — a graph that represents a different state of the graph currently displayed.
 
copyMask:uint (default = NaN) — A bitmask that specifies the graph item types for which registered data should be updated.
 
localViewMode:Boolean (default = false) — If the graph shown in this canvas is a folded graph, this parameter determines whether only the local view should be updated (true) or whether the master graph should be changed (false).

See also

onAnimationEnd()method 
protected function onAnimationEnd(evt:GraphMorphEvent):void

Called when an animation triggered by morphGraph ends.

Parameters

evt:GraphMorphEvent

onBackgroundGroupChanged()method 
protected function onBackgroundGroupChanged(oldBackgroundGroup:ICanvasObjectGroup, newBackgroundGroup:ICanvasObjectGroup):void

Called when the backgroundGroup property value changes and after initialization of the field. Triggers the "backgroundGroupChanged" event.

Parameters

oldBackgroundGroup:ICanvasObjectGroup — the old value, which may be null the first time
 
newBackgroundGroup:ICanvasObjectGroup — the new value

onCanvasObjectDependencyManagerChanged()method 
protected function onCanvasObjectDependencyManagerChanged(oldValue:CanvasObjectDependencyManager, newValue:CanvasObjectDependencyManager):void

Called when the canvasObjectDependencyManager property value changes.

Parameters

oldValue:CanvasObjectDependencyManager — The old value.
 
newValue:CanvasObjectDependencyManager — The new value.

onContentGroupChanged()method 
protected function onContentGroupChanged(oldContentGroup:ICanvasObjectGroup, newContentGroup:ICanvasObjectGroup):void

Called when the contentGroup property value changes and after initialization of the field.

Triggers the contentGroupChanged event.

Parameters

oldContentGroup:ICanvasObjectGroup — the old value
 
newContentGroup:ICanvasObjectGroup — the new value

onCurrentItemChanged()method 
protected function onCurrentItemChanged(oldItem:IModelItem, newItem:IModelItem):void

Called when the currentItem property changed.

This implementation updates the focusPaintManager's focusedItem and fires the currentItemChangedEvent.

Parameters

oldItem:IModelItem — The current item before it was changed.
 
newItem:IModelItem — The new current item.

onFocusGroupChanged()method 
protected function onFocusGroupChanged(oldFocusGroup:ICanvasObjectGroup, newFocusGroup:ICanvasObjectGroup):void

Called when the focusGroup property value changes and after initialization of the field. Triggers the focusGroupChanged event.

Parameters

oldFocusGroup:ICanvasObjectGroup — The old value, which may be null the first time
 
newFocusGroup:ICanvasObjectGroup — The new value

onFocusPaintManagerChanged()method 
protected function onFocusPaintManagerChanged(oldFocusPaintManager:FocusPaintManager, newFocusPaintManager:FocusPaintManager):void

Called when the focusPaintManager property value changes and after initialization of the field. Triggers the focusPaintManagerChanged event.

Parameters

oldFocusPaintManager:FocusPaintManager — the old value, which may be null the first time
 
newFocusPaintManager:FocusPaintManager — the new value

onGraphChanged()method 
protected function onGraphChanged(oldGraph:IGraph, newGraph:IGraph):void

Called when the graph property value changes and after initialization of the field.

Parameters

oldGraph:IGraph — The old value, may be null.
 
newGraph:IGraph — The new value.

onGraphInvalidated()method 
protected function onGraphInvalidated(evt:InvalidateEvent):void

Called when the graph has to be repainted

Parameters

evt:InvalidateEvent — The InvalidateEvent

onGraphModelManagerChanged()method 
protected function onGraphModelManagerChanged(oldGraphModelManager:GraphModelManager, newGraphModelManager:GraphModelManager):void

Called when the graphModelManager property value changes.

Triggers the graphModelManagerChanged event.

Parameters

oldGraphModelManager:GraphModelManager — The old value.
 
newGraphModelManager:GraphModelManager — The new value.

onHighlightGroupChanged()method 
protected function onHighlightGroupChanged(oldHighlightGroup:ICanvasObjectGroup, newHighlightGroup:ICanvasObjectGroup):void

Called when the highlightGroup property value changes and after initialization of the field. Triggers the highlightGroupChanged event.

Parameters

oldHighlightGroup:ICanvasObjectGroup — The old value, which may be null the first time
 
newHighlightGroup:ICanvasObjectGroup — The new value

onHighlightPaintManagerChanged()method 
protected function onHighlightPaintManagerChanged(oldHighlightPaintManager:HighlightPaintManager, newHighlightPaintManager:HighlightPaintManager):void

Called when the highlightPaintManager property value changes and after initialization of the field. Triggers the highlightPaintManagerChanged event.

Parameters

oldHighlightPaintManager:HighlightPaintManager — the old value, which may be null the first time
 
newHighlightPaintManager:HighlightPaintManager — the new value

onInputModeGroupChanged()method 
protected function onInputModeGroupChanged(oldInputModeGroup:ICanvasObjectGroup, newInputModeGroup:ICanvasObjectGroup):void

Called when the inputModeGroup property value changes and after initialization of the field.

Triggers the inputModeGroupChanged event.

Parameters

oldInputModeGroup:ICanvasObjectGroup — The old input mode group
 
newInputModeGroup:ICanvasObjectGroup — The new input mode group

onSelectionChanged()method 
protected function onSelectionChanged(oldGraphSelection:IGraphSelection, newGraphSelection:IGraphSelection):void

Called when the selection property value changes and after initialization of the field. Triggers a PropertyChangeEvent.

Parameters

oldGraphSelection:IGraphSelection — the old value, which may be null the first time
 
newGraphSelection:IGraphSelection — the new value

onSelectionGroupChanged()method 
protected function onSelectionGroupChanged(oldSelectionGroup:ICanvasObjectGroup, newSelectionGroup:ICanvasObjectGroup):void

Called when the selectionGroup property value changes and after initialization of the field. Triggers the selectionGroupChanged event.

Parameters

oldSelectionGroup:ICanvasObjectGroup — the old value.
 
newSelectionGroup:ICanvasObjectGroup — the new value.

onSelectionPaintManagerChanged()method 
protected function onSelectionPaintManagerChanged(oldSelectionPaintManager:SelectionPaintManager, newSelectionPaintManager:SelectionPaintManager):void

Called when the selectionPaintManager property value changes and after initialization of the field.

Triggers the selectionPaintManagerChanged event.

Parameters

oldSelectionPaintManager:SelectionPaintManager — The old value.
 
newSelectionPaintManager:SelectionPaintManager — The new value.

onSnapResultGroupChanged()method 
protected function onSnapResultGroupChanged(oldSnapResultGroup:ICanvasObjectGroup, newSnapResultGroup:ICanvasObjectGroup):void

Called when the snapResultGroup property value changes and after initialization of the field. Triggers the snapResultGroupChanged event.

Parameters

oldSnapResultGroup:ICanvasObjectGroup — The old value, which may be null the first time
 
newSnapResultGroup:ICanvasObjectGroup — The new value

paste()method 
public function paste():void

Pastes the clipboard's contents into the actual graph.

Delegates to the clipboard's GraphClipboard.pasteSelection method.

See also

redo()method 
public function redo():void

Redoes the last operation.

This method will only succeed, if the DefaultGraph.undoEngineEnabled property is set to true on the currently displayed graph.

undo()method 
public function undo():void

Undoes the last operation.

This method will only succeed, if the DefaultGraph.undoEngineEnabled property is set to true on the currently displayed graph.

updateTree()method 
override protected function updateTree(partially:Boolean = false):void

Parameters

partially:Boolean (default = false)

writeGraph()method 
public function writeGraph(ioHandler:GraphMLIOHandler = null):XML

Convenience method that exports the graph to XML using the GraphML format.

Parameters

ioHandler:GraphMLIOHandler (default = null) — The io handler to use for export. If null, a handler is created using createIOHandler().

Returns
XML — An XML containing the GraphML data.

See also

Event Detail
backgroundGroupChanged Event
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.BACKGROUND_GROUP_CHANGED

Dispatched when the backgroundModeGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

contentGroupChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.CONTENT_GROUP_CHANGED

Dispatched when the contentGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

currentItemChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.CURRENT_ITEM_CHANGED

Dispatched when the currentItem property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

focusGroupChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.FOCUS_GROUP_CHANGED

Dispatched when the focusGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

focusPaintManagerChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.FOCUS_PAINT_MANAGER_CHANGED

Dispatched when the focusPaintManager property changed.

graphChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.GRAPH_CHANGED

Dispatched when the graph property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

graphModelManagerChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.GRAPH_MODEL_MANAGER_CHANGED

Dispatched when the graphModelManager property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

highlightGroupChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.HIGHLIGHT_GROUP_CHANGED

Dispatched when the highlightGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

highlightPaintManagerChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.HIGHLIGHT_PAINT_MANAGER_CHANGED

Dispatched when the highlightPaintManager property changed.

inputModeGroupChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.INPUT_MODE_GROUP_CHANGED

Dispatched when the inputModeGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

ioError Event  
Event Object Type: flash.events.IOErrorEvent
IOErrorEvent.type property = IOErrorEvent.IO_ERROR

Dispatched when an io error occurs while loading a graph from an URL.

menuSelect Event  
Event Object Type: com.yworks.canvas.input.ModelItemContextMenuEvent
ModelItemContextMenuEvent.type property = ContextMenuEvent.MENU_SELECT

Dispatched just before a context menu is to be created for a graph item.

The item property of the event is set to the graph model item for which the context menu is created.

The kind property of the event is set to a com.yworks.canvas.input.ModelItemMouseEventKind, indicating what kind of model item is affected.

See also

com.yworks.canvas.input.AbstractPopupMode
morphEnd Event  
Event Object Type: com.yworks.graph.anim.GraphMorphEvent
GraphMorphEvent.type property = com.yworks.graph.anim.GraphMorphEvent.MORPH_END

Dispatched after the graph morphs to a different layout.

morphError Event  
Event Object Type: com.yworks.graph.anim.GraphMorphErrorEvent
GraphMorphErrorEvent.type property = com.yworks.graph.anim.GraphMorphErrorEvent.MORPH_ERROR

Dispatched when an error occurs during a morph operation.

morphStart Event  
Event Object Type: com.yworks.graph.anim.GraphMorphEvent
GraphMorphEvent.type property = com.yworks.graph.anim.GraphMorphEvent.MORPH_START

Dispatched before the graph morphs to a different layout.

This event can be used to configure the com.yworks.graph.anim.GraphMorpher before the animation starts.

securityError Event  
Event Object Type: flash.events.SecurityErrorEvent
SecurityErrorEvent.type property = SecurityErrorEvent.SECURITY_ERROR

Dispatched when a security error occurs while loading a graph from an URL.

selectionChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.SELECTION_CHANGED

Dispatched when the selection property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

Note that the selection property reflects the selection model. To get an event when an item of the graph is selected, a listener for a SelectionEvent.SELECT event has to be registered on the IGraphSelection instance which can be accessed by the selection property.

See also

selectionGroupChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.SELECTION_GROUP_CHANGED

Dispatched when the selectionGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

selectionPaintManagerChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.SELECTION_PAINT_MANAGER_CHANGED

Dispatched when the selectionPaintManager property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

snapResultGroupChanged Event  
Event Object Type: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = com.yworks.ui.GraphCanvasComponent.SNAP_RESULT_GROUP_CHANGED

Dispatched when the snapResultGroup property changed.

If the new value of the property is null, the kind of the event will be PropertyChangeEventKind.DELETE. Else, the kind will be PropertyChangeEventKind.UPDATE.

Constant Detail
BACKGROUND_GROUP_CHANGEDConstant
public static const BACKGROUND_GROUP_CHANGED:String = backgroundGroupChanged

CONTENT_GROUP_CHANGEDConstant 
public static const CONTENT_GROUP_CHANGED:String = contentGroupChanged

CURRENT_ITEM_CHANGEDConstant 
public static const CURRENT_ITEM_CHANGED:String = currentItemChanged

FOCUS_GROUP_CHANGEDConstant 
public static const FOCUS_GROUP_CHANGED:String = highlightGroupChanged

FOCUS_PAINT_MANAGER_CHANGEDConstant 
public static const FOCUS_PAINT_MANAGER_CHANGED:String = focusPaintManagerChanged

GRAPH_CHANGEDConstant 
public static const GRAPH_CHANGED:String = graphChanged

GRAPH_MODEL_MANAGER_CHANGEDConstant 
public static const GRAPH_MODEL_MANAGER_CHANGED:String = graphModelManagerChanged

HIGHLIGHT_GROUP_CHANGEDConstant 
public static const HIGHLIGHT_GROUP_CHANGED:String = highlightGroupChanged

HIGHLIGHT_PAINT_MANAGER_CHANGEDConstant 
public static const HIGHLIGHT_PAINT_MANAGER_CHANGED:String = highlightPaintManagerChanged

INPUT_MODE_GROUP_CHANGEDConstant 
public static const INPUT_MODE_GROUP_CHANGED:String = inputModeGroupChanged

OPTION_COPY_ALLConstant 
public static const OPTION_COPY_ALL:uint = 0xFFFFFFFF

Option constant for the morphGraph function that will cause the morphing function to copy everything that can be copied.

OPTION_COPY_EDGE_DATAConstant 
public static const OPTION_COPY_EDGE_DATA:uint = 2

Option constant for the morphGraph function that will cause the morphing function to copy all data associated with edges using the mapper registry.

OPTION_COPY_EDGE_LABEL_USER_TAGSConstant 
public static const OPTION_COPY_EDGE_LABEL_USER_TAGS:uint = 1024

Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with edge labels using ITagOwner instances provided by the label's lookup.

See also

OPTION_COPY_EDGE_STYLEConstant 
public static const OPTION_COPY_EDGE_STYLE:uint = 8

Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with edges.

OPTION_COPY_EDGE_USER_TAGSConstant 
public static const OPTION_COPY_EDGE_USER_TAGS:uint = 256

Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with edges using ITagOwner instances provided by the edge's lookup.

See also

OPTION_COPY_GRAPH_DATAConstant 
public static const OPTION_COPY_GRAPH_DATA:uint = 64

Option constant for the morphGraph function that will cause the morphing function to copy all data associated with the graph instance using the mapper registry.

OPTION_COPY_LABEL_STYLEConstant 
public static const OPTION_COPY_LABEL_STYLE:uint = 32

Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with labels.

OPTION_COPY_LABELSConstant 
public static const OPTION_COPY_LABELS:uint = 4096

Option constant for the morphGraph function that will cause the morphing function to copy the labels without copying the styles.

OPTION_COPY_NODE_AND_EDGE_DATAConstant 
public static const OPTION_COPY_NODE_AND_EDGE_DATA:uint = 3

Option constant for the morphGraph function that will cause the morphing function to copy all data associated with both nodes and edges using the mapper registry.

OPTION_COPY_NODE_DATAConstant 
public static const OPTION_COPY_NODE_DATA:uint = 1

Option constant for the morphGraph function that will cause the morphing function to copy all data associated with nodes using the mapper registry.

OPTION_COPY_NODE_LABEL_USER_TAGSConstant 
public static const OPTION_COPY_NODE_LABEL_USER_TAGS:uint = 512

Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with node labels using ITagOwner instances provided by the label's lookup.

See also

OPTION_COPY_NODE_STYLEConstant 
public static const OPTION_COPY_NODE_STYLE:uint = 4

Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with nodes.

OPTION_COPY_NODE_USER_TAGSConstant 
public static const OPTION_COPY_NODE_USER_TAGS:uint = 128

Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with nodes using ITagOwner instances provided by the node's lookup.

See also

OPTION_COPY_NONEConstant 
public static const OPTION_COPY_NONE:uint = 0

Option constant for the morphGraph function that will prevent the morphing function from copying any data associated with graph items by the mapper registry.

OPTION_COPY_PORT_DATAConstant 
public static const OPTION_COPY_PORT_DATA:uint = 0x10000

Option constant for the morphGraph function that will cause the morphing function to copy all data associated with ports using the mapper registry.

OPTION_COPY_PORT_MODELConstant 
public static const OPTION_COPY_PORT_MODEL:uint = 8192

Option constant for the morphGraph function that will cause the morphing function to copy the port location models. If this option is not set, the port location will be updated using the existing port model.

OPTION_COPY_PORT_STYLEConstant 
public static const OPTION_COPY_PORT_STYLE:uint = 16

Option constant for the morphGraph function that will cause the morphing function to copy all styles associated with ports.

OPTION_COPY_PORT_USER_TAGSConstant 
public static const OPTION_COPY_PORT_USER_TAGS:uint = 2048

Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with ports using ITagOwner instances provided by the port's lookup.

Node that the yFiles Java architecture doesn't provide port objects. Therefore, the roundtrip of port user tags with a yFiles Java server component is not possible.

See also

OPTION_COPY_TABLE_LAYOUTConstant 
public static const OPTION_COPY_TABLE_LAYOUT:uint = 0x4000

Option constant for the morphGraph function that will cause the morphing function to copy the layout of ITables.

OPTION_COPY_TABLE_STYLEConstant 
public static const OPTION_COPY_TABLE_STYLE:uint = 0x8000

Option constant for the morphGraph function that will cause the morphing function to copy the style of ITables.

OPTION_COPY_TABLESConstant 
public static const OPTION_COPY_TABLES:uint = 0xC000

Option constant for the morphGraph function that will cause the morphing function to copy the style and layout of ITables.

OPTION_COPY_USER_TAGSConstant 
public static const OPTION_COPY_USER_TAGS:uint = 3968

Option constant for the morphGraph function that will cause the morphing function to copy the user tags associated with all graph items using ITagOwner instances provided by the item's lookup.

See also

SELECTION_CHANGEDConstant 
public static const SELECTION_CHANGED:String = selectionChanged

SELECTION_GROUP_CHANGEDConstant 
public static const SELECTION_GROUP_CHANGED:String = selectionGroupChanged

SELECTION_PAINT_MANAGER_CHANGEDConstant 
public static const SELECTION_PAINT_MANAGER_CHANGED:String = selectionPaintManagerChanged

SNAP_RESULT_GROUP_CHANGEDConstant 
public static const SNAP_RESULT_GROUP_CHANGED:String = snapResultGroupChanged