com.yworks.yfiles.view

Class OverviewGraphVisualCreator

java.lang.Object

com.yworks.yfiles.view.OverviewGraphVisualCreator

All Implemented Interfaces:

IVisualCreator

public class OverviewGraphVisualCreator
extends Object
implements IVisualCreator

An IVisualCreator for use in a CanvasControl that renders a IGraph instance in a sloppy overview style.

Constructor Summary

Constructors

Constructor and Description
OverviewGraphVisualCreator(IGraph graph) Creates a new instance for the given graph.

Method Summary

Modifier and Type	Method and Description
Node	createVisual(IRenderContext context) This method is called by the framework to create a Node that will be included into the IRenderContext.
IEdgeStyle	getEdgeStyle() Gets the overview edge style.
protected IEdgeStyle	getEdgeStyle(IEdge edge) Callback that returns and/or configures a edge style for the given node to render.
protected IVisualCreator	getEdgeVisualCreator(IRenderContext context, IEdge edge) Obtains the IVisualCreator for the given edge.
INodeStyle	getGroupNodeStyle() Gets the overview group node style.
protected INodeStyle	getGroupNodeStyle(INode node) Callback that returns and/or configures a group node style for the given node to render.
protected IVisualCreator	getGroupNodeVisualCreator(IRenderContext context, INode node) Obtains the IVisualCreator for the given group node.
INodeStyle	getNodeStyle() Gets the overview node style.
protected INodeStyle	getNodeStyle(INode node) Callback that returns and/or configures a node style for the given node to render.
protected IVisualCreator	getNodeVisualCreator(IRenderContext context, INode node) Obtains the IVisualCreator for the given node.
void	setEdgeStyle(IEdgeStyle value) Sets the overview edge style.
void	setGroupNodeStyle(INodeStyle value) Sets the overview group node style.
void	setNodeStyle(INodeStyle value) Sets the overview node style.
Node	updateVisual(IRenderContext context, Node oldVisual) This method updates or replaces a previously created Node for inclusion in the IRenderContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverviewGraphVisualCreator

public OverviewGraphVisualCreator(IGraph graph)

Creates a new instance for the given graph.

Method Detail

createVisual

public final Node createVisual(IRenderContext context)

Description copied from interface: IVisualCreator

This method is called by the framework to create a Node that will be included into the IRenderContext.

CanvasControl uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used.

Returns:

The visual to include in the canvas object visual tree. This may be null.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

getEdgeStyle

public final IEdgeStyle getEdgeStyle()

Gets the overview edge style.

Returns:

The overview edge style.

See Also:

setEdgeStyle(IEdgeStyle)

getEdgeStyle

protected IEdgeStyle getEdgeStyle(IEdge edge)

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

Parameters:

edge - The edge to render.

Returns:

The style or null

getEdgeVisualCreator

protected IVisualCreator getEdgeVisualCreator(IRenderContext context,
                                              IEdge edge)

Obtains the IVisualCreator for the given edge.

Parameters:

context - The context.

edge - The edge.

Returns:

The visual creator that is obtained from the getEdgeStyle(IEdge)'s IEdgeStyleRenderer.getVisualCreator(IEdge, IEdgeStyle) method.

getGroupNodeStyle

public final INodeStyle getGroupNodeStyle()

Gets the overview group node style.

Returns:

The overview node style.

See Also:

setGroupNodeStyle(INodeStyle)

getGroupNodeStyle

protected INodeStyle getGroupNodeStyle(INode node)

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

Parameters:

node - The group node to render.

Returns:

The style or null

getGroupNodeVisualCreator

protected IVisualCreator getGroupNodeVisualCreator(IRenderContext context,
                                                   INode node)

Obtains the IVisualCreator for the given group node.

Parameters:

context - The context.

node - The group node.

Returns:

The visual creator that is obtained from the getGroupNodeStyle(INode)'s INodeStyleRenderer.getVisualCreator(INode, INodeStyle) method.

getNodeStyle

public final INodeStyle getNodeStyle()

Gets the overview node style.

Returns:

The overview node style.

See Also:

setNodeStyle(INodeStyle)

getNodeStyle

protected INodeStyle getNodeStyle(INode node)

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

Parameters:

node - The node to render.

Returns:

The style or null

getNodeVisualCreator

protected IVisualCreator getNodeVisualCreator(IRenderContext context,
                                              INode node)

Obtains the IVisualCreator for the given node.

Parameters:

context - The context.

node - The node.

Returns:

The visual creator that is obtained from the getNodeStyle(INode)'s INodeStyleRenderer.getVisualCreator(INode, INodeStyle) method.

setEdgeStyle

public final void setEdgeStyle(IEdgeStyle value)

Sets the overview edge style.

Parameters:

value - The overview edge style.

See Also:

getEdgeStyle()

setGroupNodeStyle

public final void setGroupNodeStyle(INodeStyle value)

Sets the overview group node style.

Parameters:

value - The overview node style.

See Also:

getGroupNodeStyle()

setNodeStyle

public final void setNodeStyle(INodeStyle value)

Sets the overview node style.

Parameters:

value - The overview node style.

See Also:

getNodeStyle()

updateVisual

public final Node updateVisual(IRenderContext context,
                               Node oldVisual)

Description copied from interface: IVisualCreator

This method updates or replaces a previously created Node for inclusion in the IRenderContext.

The CanvasControl uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to IVisualCreator.createVisual(IRenderContext). Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used in.

oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.

Returns:

oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl