Packagecom.yworks.graph.drawing
Classpublic class OverviewGraphDisplayObjectCreator
InheritanceOverviewGraphDisplayObjectCreator Inheritance Object
Implements IDisplayObjectCreator

An IDisplayObjectCreator for use in a CanvasComponent that renders an IGraph instance in a sloppy overview style.



Public Properties
 PropertyDefined By
  overviewEdgeStyle : IEdgeStyle
The overview edge style.
OverviewGraphDisplayObjectCreator
  overviewGroupNodeStyle : INodeStyle
The overview group node style.
OverviewGraphDisplayObjectCreator
  overviewNodeStyle : INodeStyle
The overview node style.
OverviewGraphDisplayObjectCreator
Public Methods
 MethodDefined By
  
Creates a new instance for the given graph.
OverviewGraphDisplayObjectCreator
  
Creates a new DisplayObject from scratch.
OverviewGraphDisplayObjectCreator
  
updateDisplayObject(oldDisplayObject:DisplayObject, ctx:IDisplayObjectContext):DisplayObject
Updates the given DisplayObject or creates a new one.
OverviewGraphDisplayObjectCreator
Protected Methods
 MethodDefined By
  
Factory method that creates the overviewEdgeStyle
OverviewGraphDisplayObjectCreator
  
Factory method that creates the overviewGroupNodeStyle
OverviewGraphDisplayObjectCreator
  
Factory method that creates the overviewNodeStyle
OverviewGraphDisplayObjectCreator
  
Obtains the IDisplayObjectCreator for the given edge.
OverviewGraphDisplayObjectCreator
  
Obtains the IDisplayObjectCreator for the given group node.
OverviewGraphDisplayObjectCreator
  
Obtains the IDisplayObjectCreator for the given node.
OverviewGraphDisplayObjectCreator
  
Callback that returns and/or configures a edge style for the given edge to render.
OverviewGraphDisplayObjectCreator
  
Callback that returns and/or configures a node style for the given group node to render.
OverviewGraphDisplayObjectCreator
  
Callback that returns and/or configures a node style for the given node to render.
OverviewGraphDisplayObjectCreator
Property Detail
overviewEdgeStyleproperty
overviewEdgeStyle:IEdgeStyle

The overview edge style.


Implementation
    public function get overviewEdgeStyle():IEdgeStyle
    public function set overviewEdgeStyle(value:IEdgeStyle):void
overviewGroupNodeStyleproperty 
overviewGroupNodeStyle:INodeStyle

The overview group node style.


Implementation
    public function get overviewGroupNodeStyle():INodeStyle
    public function set overviewGroupNodeStyle(value:INodeStyle):void
overviewNodeStyleproperty 
overviewNodeStyle:INodeStyle

The overview node style.


Implementation
    public function get overviewNodeStyle():INodeStyle
    public function set overviewNodeStyle(value:INodeStyle):void
Constructor Detail
OverviewGraphDisplayObjectCreator()Constructor
public function OverviewGraphDisplayObjectCreator(graph:IGraph)

Creates a new instance for the given graph.

Parameters
graph:IGraph
Method Detail
createDisplayObject()method
public function createDisplayObject(ctx:IDisplayObjectContext):DisplayObject

Creates a new DisplayObject from scratch.

Parameters

ctx:IDisplayObjectContext — The context for which the display object is created.

Returns
DisplayObject — A DisplayObject.
createEdgeStyle()method 
protected function createEdgeStyle():IEdgeStyle

Factory method that creates the overviewEdgeStyle

Returns
IEdgeStyle — a simple edge style

See also

createGroupNodeStyle()method 
protected function createGroupNodeStyle():INodeStyle

Factory method that creates the overviewGroupNodeStyle

Returns
INodeStyle — a simple node style

See also

createNodeStyle()method 
protected function createNodeStyle():INodeStyle

Factory method that creates the overviewNodeStyle

Returns
INodeStyle — a simple node style

See also

getEdgeDisplayObjectCreator()method 
protected function getEdgeDisplayObjectCreator(ctx:IDisplayObjectContext, edge:IEdge):IDisplayObjectCreator

Obtains the IDisplayObjectCreator for the given edge.

Parameters

ctx:IDisplayObjectContext — the display object context.
 
edge:IEdge — The edge.

Returns
IDisplayObjectCreator — The display object creator that is obtained from the getDisplayObjectCreator() method of the getOverviewEdgeStyle's renderer.
getGroupNodeDisplayObjectCreator()method 
protected function getGroupNodeDisplayObjectCreator(ctx:IDisplayObjectContext, node:INode):IDisplayObjectCreator

Obtains the IDisplayObjectCreator for the given group node.

Parameters

ctx:IDisplayObjectContext — the display object context.
 
node:INode — The group node.

Returns
IDisplayObjectCreator — The display object creator that is obtained from the getDisplayObjectCreator() method of the getOverviewGroupNodeStyle's renderer.
getNodeDisplayObjectCreator()method 
protected function getNodeDisplayObjectCreator(ctx:IDisplayObjectContext, node:INode):IDisplayObjectCreator

Obtains the IDisplayObjectCreator for the given node.

Parameters

ctx:IDisplayObjectContext — the display object context.
 
node:INode — The node.

Returns
IDisplayObjectCreator — The display object creator that is obtained from the getDisplayObjectCreator() method of the getOverviewNodeStyle's renderer.
getOverviewEdgeStyle()method 
protected function getOverviewEdgeStyle(edge:IEdge):IEdgeStyle

Callback that returns and/or configures a edge style for the given edge to render.

Parameters

edge:IEdge — The edge to render.

Returns
IEdgeStyle — The style or null
getOverviewGroupNodeStyle()method 
protected function getOverviewGroupNodeStyle(node:INode):INodeStyle

Callback that returns and/or configures a node style for the given group node to render.

Parameters

node:INode — The node to render.

Returns
INodeStyle — The style or null
getOverviewNodeStyle()method 
protected function getOverviewNodeStyle(node:INode):INodeStyle

Callback that returns and/or configures a node style for the given node to render.

Parameters

node:INode — The node to render.

Returns
INodeStyle — The style or null
updateDisplayObject()method 
public function updateDisplayObject(oldDisplayObject:DisplayObject, ctx:IDisplayObjectContext):DisplayObject

Updates the given DisplayObject or creates a new one.

Implementors can decide whether they update the given display object or create a new one. Updating can mean re-rendering or updating size and/or coordinates.

Parameters

oldDisplayObject:DisplayObject — The display object to update.
 
ctx:IDisplayObjectContext — The context for which the display object should be updated.

Returns
DisplayObject — The updated display object or a completely new display object.