The base class proxy between the diagram and the layout algorithms. It enables loading graph description from the diagrammer of the Diagrammer (DiagramView class)
and also affects graph elements properties on the Diagram elements of the correspondant diagram. This class enables to maintain abstraction between
the Diagrammer and the Graph layout while maintaining high performance and synchronization level between them.
This class is a base class for KDLProxy, which is the class to used for using layout algorithm with DiagramView.
animatedOrganicLayout:AnimatedForceDirectedLayout [read-only]Implementation
public function get animatedOrganicLayout():AnimatedForceDirectedLayout
public var animationDuration:uint = 1000
balloonLayout:BalloonLayout [read-only]Implementation
public function get balloonLayout():BalloonLayout
centerPoint:Point [read-write]Implementation
public function get centerPoint():Point
public function set centerPoint(value:Point):void
circularLayout:SingleCycleCircularLayout [read-only]Implementation
public function get circularLayout():SingleCycleCircularLayout
constraintManager:ConstraintManager [read-only]
Implementation
public function get constraintManager():ConstraintManager
protected var _constraintNodes:Dictionary
defaultLayout:int [read-write]Implementation
public function get defaultLayout():int
public function set defaultLayout(value:int):void
protected var _edgeLinkMap:Dictionary
edgeLinkMap:Dictionary [read-write]
Implementation
public function get edgeLinkMap():Dictionary
public function set edgeLinkMap(value:Dictionary):void
protected var _exportSuccess:Boolean = false
exportSuccess:Boolean [read-only]
Export status
Implementation
public function get exportSuccess():Boolean
protected var _finishTime:int
protected var _graph:IGraph
graph:IGraph [read-write]
Implementation
public function get graph():IGraph
public function set graph(value:IGraph):void
protected var _groupProxies:Dictionary
groupProxies:Dictionary [read-write]
Included group proxies to be handled by this Diagram Proxy
Implementation
public function get groupProxies():Dictionary
public function set groupProxies(value:Dictionary):void
hierarchicalLayout:HierarchicalLayout [read-only]Implementation
public function get hierarchicalLayout():HierarchicalLayout
layoutConstaints:XML [read-only]
Implementation
public function get layoutConstaints():XML
layoutConstraints:XML [write-only]Implementation
public function set layoutConstraints(value:XML):void
layoutOnDiagramChanged:Boolean [read-write]Implementation
public function get layoutOnDiagramChanged():Boolean
public function set layoutOnDiagramChanged(value:Boolean):void
protected var _linkEdgeMap:Dictionary
linkEdgeMap:Dictionary [read-write]
Implementation
public function get linkEdgeMap():Dictionary
public function set linkEdgeMap(value:Dictionary):void
mindMapLayout:MindMapLayout [read-only]Implementation
public function get mindMapLayout():MindMapLayout
protected var _nodeSpriteMap:Dictionary
nodeSpriteMap:Dictionary [read-write]
Implementation
public function get nodeSpriteMap():Dictionary
public function set nodeSpriteMap(value:Dictionary):void
protected var _numberOfIteration:int
organicLayout:StaticGEMLayout [read-only]Implementation
public function get organicLayout():StaticGEMLayout
orthogonalLayout:OrthogonalLayout [read-only]Implementation
public function get orthogonalLayout():OrthogonalLayout
radialLayout:RadialLayout [read-only]Implementation
public function get radialLayout():RadialLayout
renderer:Object [read-write]
Implementation
public function get renderer():Object
public function set renderer(value:Object):void
protected var _selectedProxy:DiagramProxy
selectedProxy:DiagramProxy [read-only]
Selected Proxy in the DiagramView (the proxy of a selected group in the DiagramView)
Implementation
public function get selectedProxy():DiagramProxy
source:Object [read-write]
Implementation
public function get source():Object
public function set source(value:Object):void
protected var _spriteNodeMap:Dictionary
spriteNodeMap:Dictionary [read-write]
Implementation
public function get spriteNodeMap():Dictionary
public function set spriteNodeMap(value:Dictionary):void
protected var _startTime:int
storedParameters:Array [read-only]
User defined layout parameters
Implementation
public function get storedParameters():Array
protected var _storedParametersMap:Array
sugiyamaLayout:SugiyamaLayout [read-only]Implementation
public function get sugiyamaLayout():SugiyamaLayout
protected var _topLevelProxy:DiagramProxy
topLevelProxy:DiagramProxy [read-only]
Implementation
public function get topLevelProxy():DiagramProxy
protected var _tweeners:Array
tweeners:Array [read-write]
Animation tweeners
Implementation
public function get tweeners():Array
public function set tweeners(value:Array):void
public function DiagramProxy(topLevelProxy:DiagramProxy, centerPoint:Point = null)
Builds a DiagramProxy instance that is used as an interface between graph layout and DiagramView
Parameters
| topLevelProxy:DiagramProxy — DiagramView from which the DiagramProxy is initialised and updated
|
| |
| centerPoint:Point (default = null) |
public function addDiagramGroupAsMetaNode(group:DiagramGroup, withExternalLinks:Boolean = true):IGraph
Adds a metanode as a graph to the general graph description of this DiagramProxy from a DiagramGroup instance and returns it.
Parameters
| group:DiagramGroup — DiagramGroup from which the graph (metanode) properties are set.
|
| |
| withExternalLinks:Boolean (default = true) |
Returns
| IGraph — Added Meta Node.
|
public function addDiagramLinkAsEdge(link:DiagramLink, customGraph:IGraph = null, customEdgeLinkMap:Dictionary = null, customLinkEdgeMap:Dictionary = null, customSpriteNodeMap:Dictionary = null):IEdge
Adds a edge to the graph description of this DiagramProxy from a DiagramEdge instance and returns it.
Parameters
| link:DiagramLink — DiagramEdge from which the edge properties are set.
|
| |
| customGraph:IGraph (default = null) |
| |
| customEdgeLinkMap:Dictionary (default = null) |
| |
| customLinkEdgeMap:Dictionary (default = null) |
| |
| customSpriteNodeMap:Dictionary (default = null) |
Returns
public function addDiagramSpriteAsNode(sprite:DiagramSprite, customGraph:IGraph = null, customNodeSpriteMap:Dictionary = null, customSpriteNodeMap:Dictionary = null, customConstraintManager:ConstraintManager = null, customConstraintNodes:Dictionary = null):INode
Adds a node to the graph description of this DiagramProxy from a DiagramSprite instance and returns it.
Parameters
| sprite:DiagramSprite — DiagramSprite from which the node properties are set.
|
| |
| customGraph:IGraph (default = null) |
| |
| customNodeSpriteMap:Dictionary (default = null) |
| |
| customSpriteNodeMap:Dictionary (default = null) |
| |
| customConstraintManager:ConstraintManager (default = null) |
| |
| customConstraintNodes:Dictionary (default = null) |
Returns
public function addItem(dob:DiagramObject):void
Adds an item (a DiagramObject) to this DiagramProxy (graph and renderer references)
Parameters
public function affilateItem(dob:DiagramObject):voidParameters
public function animateGroupLinks(edges:Array, customTweeners:Array = null, withAnimation:Boolean = true):void
Animates Group In/Out Links
Parameters
| edges:Array — Graph representation of the group
|
| |
| customTweeners:Array (default = null) |
| |
| withAnimation:Boolean (default = true) |
public function doAnimatedTransition(outEdges:Array = null, customGraph:IGraph = null, customNodeSpriteMap:Dictionary = null, customEdgeLinkMap:Dictionary = null, customTweeners:Array = null, withAnimation:Boolean = true, doTransition:Boolean = true):void
Performs an animated transition from old sprites position to new positions grabbed from the graph (usually after layout)
Parameters
| outEdges:Array (default = null) |
| |
| customGraph:IGraph (default = null) |
| |
| customNodeSpriteMap:Dictionary (default = null) |
| |
| customEdgeLinkMap:Dictionary (default = null) |
| |
| customTweeners:Array (default = null) |
| |
| withAnimation:Boolean (default = true) |
| |
| doTransition:Boolean (default = true) |
public function exportGraph(layoutType:int):void
Parameters
protected function getEdgeTypeFromLinkType(linkType:DiagramLinkType):int
Returns an Edge type given a DiagramLinkType
Parameters
Returns
protected function getIntermediatePoint(point1:Point, point2:Point, isHorizontal:Boolean):Point
Determines the intermediate point that links two points in an orthogonal fashion
Parameters
| point1:Point — Source Point
|
| |
| point2:Point — Target Point
|
| |
| isHorizontal:Boolean — Source Segment direction
|
Returns
| Point — Intermediate Point
|
public function getLayoutFromType(layoutType:int, customGraph:IGraph = null):Layout
Returns a Layout subclass instance according to a layoutType from the Constants class.
Parameters
| layoutType:int — Layout type reference according to the Constants definition.
|
| |
| customGraph:IGraph (default = null) |
Returns
| Layout — Layout subclass.
|
protected function getLinkTypeFromEdge(edgeType:int):DiagramLinkType
Returns a DiagramLinkType according to an edgeType int (from the Constants class)
Parameters
Returns
public function getObjectProxy(dob:DiagramObject):DiagramProxyParameters
Returns
public function handleDragFinished(event:DiagramDragEvent):void
Finalizes a drag operation
Parameters
public function handleDragging(event:DiagramDragEvent):void
Handles a drag operation in the rendrer layer and performs required computation
Parameters
public function handleDragStarted(event:DiagramDragEvent):voidParameters
public function importGraph():IGraph
Returns
protected function initLayouts():void
public function layoutSelection(layoutType:uint, sprites:Array, customOutEdges:Array = null, withAnimation:Boolean = false, doTransition:Boolean = true, tweeners:Array = null, minX:Number = 0, minY:Number = 0):IGraphParameters
| layoutType:uint |
| |
| sprites:Array |
| |
| customOutEdges:Array (default = null) |
| |
| withAnimation:Boolean (default = false) |
| |
| doTransition:Boolean (default = true) |
| |
| tweeners:Array (default = null) |
| |
| minX:Number (default = 0) |
| |
| minY:Number (default = 0) |
Returns
public function removeGroupElementReferences(group:DiagramGroup):void
Removes a DiagramGroup references from this DiagramProxy
Parameters
| group:DiagramGroup — DiagramGroup of which references will be deleted
|
public function removeItem(dob:DiagramObject):void
Removes an item (a DiagramObject) to this DiagramProxy (graph and renderer references)
Parameters
public function removeLinkElementReferences(link:DiagramLink):void
Removes a DiagramLink references from this DiagramProxy
Parameters
| link:DiagramLink — DiagramLink of which references will be deleted
|
public function removeSpriteElementReferences(sprite:DiagramSprite):void
Removes a DiagramSprite references from this DiagramProxy
Parameters
| sprite:DiagramSprite — DiagramSprite of which references will be deleted
|
public function ungroupGroupElement(group:DiagramGroup):void
Inflicts an ungroup operation in the Diagram to the graph structure and Renderer-GraphLayout maps.
Parameters
protected function updateDiagramLinkFromEdge(edge:IEdge, customGraph:IGraph = null, customEdgeLinkMap:Dictionary = null, customTweeners:Array = null, withAnimation:Boolean = true):void
Updates the DiagramLink referenced by a edge (via the map _edgeLinkMap) by applying the edge properties on it (path).
It redraws the DiagramLink according to the Edge content.
Parameters
| edge:IEdge — Edge from which the DiagramLink will be updated.
|
| |
| customGraph:IGraph (default = null) |
| |
| customEdgeLinkMap:Dictionary (default = null) |
| |
| customTweeners:Array (default = null) |
| |
| withAnimation:Boolean (default = true) |
protected function updateDiagramSpriteFromNode(node:INode, customGraph:IGraph = null, customNodeSpriteMap:Dictionary = null, customTweeners:Array = null, withAnimation:Boolean = true, update:Boolean = false):void
Updates the DiagramSprite referenced by a node (via the map _nodeSpriteMap) by applying the node properties on it (placement and size).
It redraws the DiagramSprite according to the Node content.
Parameters
| node:INode — Node from which the DiagramSprite will be updated.
|
| |
| customGraph:IGraph (default = null) |
| |
| customNodeSpriteMap:Dictionary (default = null) |
| |
| customTweeners:Array (default = null) |
| |
| withAnimation:Boolean (default = true) |
| |
| update:Boolean (default = false) |
protected function updateEdgeExtremities(edge:IEdge, customGraph:IGraph = null, customEdgeLinkMap:Dictionary = null):void
Updates Edge Extremities given its extremity nodes position.
Parameters
| edge:IEdge — Edge to update.
|
| |
| customGraph:IGraph (default = null) |
| |
| customEdgeLinkMap:Dictionary (default = null) |
protected function updateEdgePointsFromLink(edge:IEdge, link:DiagramLink):void
Updates edge points from a DiagramLink
Parameters
| edge:IEdge — Edge to be updated
|
| |
| link:DiagramLink — DiagramLink from which updates are grabbed
|
protected function updateEdgesFromLinks(customGraph:IGraph = null, customedgeLinkMap:Dictionary = null, customNodeSpriteMap:Dictionary = null, customGroupProxies:Dictionary = null):void
Updates graph nodes from their respective sprites
Parameters
| customGraph:IGraph (default = null) |
| |
| customedgeLinkMap:Dictionary (default = null) |
| |
| customNodeSpriteMap:Dictionary (default = null) |
| |
| customGroupProxies:Dictionary (default = null) |
protected function updateNodePropertiesFromSprite(node:INode, sprite:DiagramObject):void
Updates node properties (size and position) from a given DiagramSprite
Parameters
| node:INode — Node to be updated
|
| |
| sprite:DiagramObject — DiagramSprite from which updates are grabbed
|
protected function updateNodesFromSprites(customGraph:IGraph = null, customNodeSpriteMap:Dictionary = null, customGroupProxies:Dictionary = null):void
Updates graph nodes from their respective sprites
Parameters
| customGraph:IGraph (default = null) |
| |
| customNodeSpriteMap:Dictionary (default = null) |
| |
| customGroupProxies:Dictionary (default = null) |
public function updateReferences(dob:DiagramObject):voidParameters
public function updateRendererFromGraph(element:IGraphItem, withAnimation:Boolean = true, update:Boolean = false):void
inheritDoc
Parameters
| element:IGraphItem |
| |
| withAnimation:Boolean (default = true) |
| |
| update:Boolean (default = false) |
