com.yworks.yfiles.view

Class EdgeHighlightIndicatorInstaller

java.lang.Object

com.yworks.yfiles.view.EdgeDecorationInstaller

com.yworks.yfiles.view.EdgeHighlightIndicatorInstaller

All Implemented Interfaces:

ICanvasObjectInstaller, IFocusIndicatorInstaller, IHighlightIndicatorInstaller, ISelectionIndicatorInstaller

public class EdgeHighlightIndicatorInstaller
extends EdgeDecorationInstaller

An specialized subclass of the EdgeSelectionIndicatorInstaller that can install the highlight rendering of an IEdge.

This will install an ICanvasObject that will render the path and the bends of an edge using a pen for the path and a drawing for the bends.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceKey	BEND_TEMPLATE_KEY A ResourceKey that will be used to find the IVisualTemplate that will be used to draw the bends of the edge.
static ResourceKey	PEN_KEY A ResourceKey that will be used to find the Pen that will be used to draw the path of the edge.

Constructor Summary

Constructors

Constructor and Description
EdgeHighlightIndicatorInstaller()

Method Summary

Modifier and Type	Method and Description
protected IVisualTemplate	getBendDrawing(CanvasControl canvas, IEdge edge) Callback method that retrieves the drawing of the bend for the context.
protected String	getDecoratorStyleClass(CanvasControl canvas, IEdge edge) Callback method that retrieves the style class for the context.
protected Pen	getPen(CanvasControl canvas, IEdge edge) Callback method that retrieves the pen for the context.

Methods inherited from class com.yworks.yfiles.view.EdgeDecorationInstaller

addCanvasObject

Methods inherited from class java.lang.Object

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

Field Detail

BEND_TEMPLATE_KEY

public static final ResourceKey BEND_TEMPLATE_KEY

A ResourceKey that will be used to find the IVisualTemplate that will be used to draw the bends of the edge.

PEN_KEY

public static final ResourceKey PEN_KEY

A ResourceKey that will be used to find the Pen that will be used to draw the path of the edge.

Constructor Detail

EdgeHighlightIndicatorInstaller

public EdgeHighlightIndicatorInstaller()

Method Detail

getBendDrawing

protected IVisualTemplate getBendDrawing(CanvasControl canvas,
                                         IEdge edge)

Callback method that retrieves the drawing of the bend for the context.

This implementation will use the BEND_TEMPLATE_KEY resource to find a IVisualTemplate instance. If null is yielded, a default drawing will be used.

Specified by:

getBendDrawing in class EdgeDecorationInstaller

Parameters:

canvas - The context for which the drawing shall be returned.

edge - The edge for which the rendering will be used.

Returns:

The drawing instance to use for the rendering of the bends in the given context.

getDecoratorStyleClass

protected String getDecoratorStyleClass(CanvasControl canvas,
                                        IEdge edge)

Description copied from class: EdgeDecorationInstaller

Callback method that retrieves the style class for the context.

Specified by:

getDecoratorStyleClass in class EdgeDecorationInstaller

Returns:

getPen

protected Pen getPen(CanvasControl canvas,
                     IEdge edge)

Callback method that retrieves the pen for the context.

This implementation will use the PEN_KEY resource to find a Pen instance. If null is yielded, a default pen will be used.

Specified by:

getPen in class EdgeDecorationInstaller

Parameters:

edge - The edge for which the rendering will be used.

canvas - The canvas for which the pen shall be returned.

Returns:

The pen instance to use for the rendering of the edge in the given context.