com.yworks.yfiles.graph.styles

Class AbstractEdgeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.AbstractEdgeStyle

All Implemented Interfaces:

IEdgeStyle, ICloneable, Cloneable

public abstract class AbstractEdgeStyle
extends Object
implements IEdgeStyle, Cloneable

An abstract base class that makes it possible to easily implement a custom IEdgeStyle.

The only method that needs to be implemented by subclasses is createVisual(IRenderContext, IEdge), however to improve rendering performance it is highly recommended to implement at least updateVisual(IRenderContext, Node, IEdge), too.

This implementation differs from the straightforward IEdgeStyle implementation in that there is no visible separation between the style and its IEdgeStyleRenderer. Instead the renderer used by the base class is fixed and delegates all calls back to the style instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEdgeStyle() Initializes a new instance of the AbstractEdgeStyle class.

Method Summary

Modifier and Type	Method and Description
protected void	addArrows(IRenderContext context, VisualGroup group, IEdge edge, GeneralPath edgePath, IArrow sourceArrow, IArrow targetArrow) Convenience method that adds the arrows to a given container.
AbstractEdgeStyle	clone() Creates a new object that is a copy of the current instance.
protected abstract Node	createVisual(IRenderContext context, IEdge edge) Callback that creates the visual.
protected GeneralPath	cropPath(IEdge edge, IArrow sourceArrow, IArrow targetArrow, GeneralPath path) Convenience method that crops the edge's path at the nodes.
protected RectD	getBounds(ICanvasContext context, IEdge edge) Gets the bounds of the visual for the edge in the given context.
protected GeneralPath	getPath(IEdge edge) Gets the path of the edge.
IEdgeStyleRenderer	getRenderer() Gets the renderer implementation for this instance.
protected int	getSegmentCount(IEdge edge) Gets the number of segments of the edge.
protected Tangent	getSourceArrowAnchor(GeneralPath path, IArrow arrow) Convenience method that calculates the source arrow anchor and direction for a a given arrow and path.
protected Tangent	getTangent(IEdge edge, double ratio) Gets the tangent to the edge at the specified ratio and the corresponding touch point.
protected Tangent	getTangent(IEdge edge, int segmentIndex, double ratio) Gets the tangent to the edge at the specified ratio of a segment of the edge and the corresponding touch point.
protected Tangent	getTargetArrowAnchor(GeneralPath path, IArrow arrow) Convenience method that calculates the target arrow anchor and direction for a a given arrow and path.
protected boolean	isHit(IInputModeContext context, PointD location, IEdge edge) Determines whether the visual representation of the edge has been hit at the given location.
protected boolean	isInBox(IInputModeContext context, RectD rectangle, IEdge edge) Determines whether the visualization for the specified edge is included in the marquee selection.
protected boolean	isVisible(ICanvasContext context, RectD rectangle, IEdge edge) Determines whether the visualization for the specified edge is visible in the context.
protected Object	lookup(IEdge edge, Class type) Performs the ILookup.lookup(Class) operation for the IEdgeStyleRenderer.getContext(IEdge, IEdgeStyle) that has been queried from the Renderer.
protected void	updateArrows(IRenderContext context, VisualGroup group, IEdge edge, GeneralPath edgePath, IArrow sourceArrow, IArrow targetArrow) Convenience method that updates the arrows in a given container.
protected Node	updateVisual(IRenderContext context, Node oldVisual, IEdge edge) Callback that updates the visual previously created by createVisual(IRenderContext, IEdge).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEdgeStyle

protected AbstractEdgeStyle()

Initializes a new instance of the AbstractEdgeStyle class.

Method Detail

addArrows

protected void addArrows(IRenderContext context,
                         VisualGroup group,
                         IEdge edge,
                         GeneralPath edgePath,
                         IArrow sourceArrow,
                         IArrow targetArrow)

Convenience method that adds the arrows to a given container.

Parameters:

context - The context for the rendering.

group - The container to which the arrows should be added.

edge - The edge that is being rendered.

edgePath - The edge path.

sourceArrow - The source arrow.

targetArrow - The target arrow.

clone

public AbstractEdgeStyle clone()

Creates a new object that is a copy of the current instance.

Immutable subclasses should consider returning this.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A new object that is a copy of this instance using Object.clone().

See Also:

Object.clone()

createVisual

protected abstract Node createVisual(IRenderContext context,
                                     IEdge edge)

Callback that creates the visual.

This method is called in response to a IVisualCreator.createVisual(IRenderContext) call to the instance that has been queried from the Renderer.

Parameters:

context - The render context.

edge - The edge to which this style instance is assigned.

Returns:

The visual as required by the IVisualCreator.createVisual(IRenderContext) interface.

See Also:

updateVisual(IRenderContext, Node, IEdge)

cropPath

protected GeneralPath cropPath(IEdge edge,
                               IArrow sourceArrow,
                               IArrow targetArrow,
                               GeneralPath path)

Convenience method that crops the edge's path at the nodes.

This implementation uses the IEdgePathCropper instances found in the ILookup.lookup(Class) of the source and target port of the edge to perform the actual cropping.

Parameters:

edge - The edge that is being rendered.

path - The path that should be cropped.

sourceArrow - The source arrow instance.

targetArrow - The target arrow instance.

Returns:

The cropped path. This is can be either the same instance of the given path or a newly created instance.

getBounds

protected RectD getBounds(ICanvasContext context,
                          IEdge edge)

Gets the bounds of the visual for the edge in the given context.

This method is called in response to a IBoundsProvider.getBounds(ICanvasContext) call to the instance that has been queried from the Renderer. This implementation simply yields a rectangle containing. the locations of the source port and the target port of the edge and the locations of all its bends.

Parameters:

context - The canvas context.

edge - The edge to which this style instance is assigned.

Returns:

The visual bounds of the visual representation.

getPath

protected GeneralPath getPath(IEdge edge)

Gets the path of the edge.

Parameters:

edge - The edge.

Returns:

The path.

getRenderer

public final IEdgeStyleRenderer getRenderer()

Gets the renderer implementation for this instance.

The private implementation will delegate all API calls back to this instance.

Specified by:

getRenderer in interface IEdgeStyle

Returns:

The Renderer.

getSegmentCount

protected int getSegmentCount(IEdge edge)

Gets the number of segments of the edge.

Parameters:

edge - The edge.

Returns:

The segment count.

getSourceArrowAnchor

protected Tangent getSourceArrowAnchor(GeneralPath path,
                                       IArrow arrow)

Convenience method that calculates the source arrow anchor and direction for a a given arrow and path.

Parameters:

path - The path of the edge.

arrow - The arrow.

Returns:

The anchor and directional vector of the arrow, if any exist.

getTangent

protected Tangent getTangent(IEdge edge,
                             double ratio)

Gets the tangent to the edge at the specified ratio and the corresponding touch point.

Parameters:

edge - The edge.

ratio - A value between 0 and 1 inclusively that indicates a ratio from the beginning to the end of the path of the edge.

Returns:

The tangent, if any exists.

getTangent

protected Tangent getTangent(IEdge edge,
                             int segmentIndex,
                             double ratio)

Gets the tangent to the edge at the specified ratio of a segment of the edge and the corresponding touch point.

Parameters:

edge - The edge.

segmentIndex - Index of the segment of the edge.

ratio - A value between 0 and 1 inclusively that indicates a ratio from the beginning to the end of the segment of the edge.

Returns:

The tangent, if any exists.

getTargetArrowAnchor

protected Tangent getTargetArrowAnchor(GeneralPath path,
                                       IArrow arrow)

Convenience method that calculates the target arrow anchor and direction for a a given arrow and path.

Parameters:

path - The path of the edge.

arrow - The arrow.

Returns:

The anchor and directional vector of the arrow, if any exist.

isHit

protected boolean isHit(IInputModeContext context,
                        PointD location,
                        IEdge edge)

Determines whether the visual representation of the edge has been hit at the given location.

This method is called in response to a IHitTestable.isHit(IInputModeContext, PointD) call to the instance that has been queried from the Renderer.

This implementation returns the result of the PointD.hitsPolyline(java.lang.Iterable, double) method of class PointD with the polygonal line defined by the source port, the target port and the bends of the edge and the HitTestRadius of the canvas context.

Parameters:

context - The input mode context.

location - The point to test.

edge - The edge to which this style instance is assigned.

Returns:

true if the specified edge representation is hit; false otherwise.

See Also:

PointD.hitsPolyline(java.lang.Iterable, double)

isInBox

protected boolean isInBox(IInputModeContext context,
                          RectD rectangle,
                          IEdge edge)

Determines whether the visualization for the specified edge is included in the marquee selection.

This method is called in response to a IMarqueeTestable.isInBox(IInputModeContext, RectD) call to the instance that has been queried from the Renderer.

This implementation returns the result of the RectD.intersectsPolyline(java.lang.Iterable) method of class RectD with the polygonal line defined by the source port, the target port and the bends of the edge.

Parameters:

context - The input mode context.

rectangle - The marquee selection box.

edge - The edge to which this style instance is assigned.

Returns:

true if the specified edge is visible is selected by the marquee rectangle; false otherwise.

isVisible

protected boolean isVisible(ICanvasContext context,
                            RectD rectangle,
                            IEdge edge)

Determines whether the visualization for the specified edge is visible in the context.

This method is called in response to a IVisibilityTestable.isVisible(ICanvasContext, RectD) call to the instance that has been queried from the Renderer. This implementation simply tests whether the bounds intersect the clip.

Parameters:

context - The canvas context.

rectangle - The clipping rectangle.

edge - The edge to which this style instance is assigned.

Returns:

true if the specified edge is visible in the clipping rectangle; false otherwise.

lookup

protected Object lookup(IEdge edge,
                        Class type)

Performs the ILookup.lookup(Class) operation for the IEdgeStyleRenderer.getContext(IEdge, IEdgeStyle) that has been queried from the Renderer.

This implementation yields null for everything but:

• IHitTestable
• IVisualCreator
• IBoundsProvider
• IVisibilityTestable
• IMarqueeTestable
• ILookup
• IPathGeometry

For these interfaces an implementation will be returned that delegates to the methods in this instance.

Parameters:

edge - The edge to use for the context lookup.

type - The type to query.

Returns:

An implementation of the type or null.

updateArrows

protected void updateArrows(IRenderContext context,
                            VisualGroup group,
                            IEdge edge,
                            GeneralPath edgePath,
                            IArrow sourceArrow,
                            IArrow targetArrow)

Convenience method that updates the arrows in a given container.

Parameters:

context - The context for the rendering.

group - The container to which the arrows should be added.

edge - The edge that is being rendered.

edgePath - The edge path.

sourceArrow - The source arrow.

targetArrow - The target arrow.

updateVisual

protected Node updateVisual(IRenderContext context,
                            Node oldVisual,
                            IEdge edge)

Callback that updates the visual previously created by createVisual(IRenderContext, IEdge).

This method is called in response to a IVisualCreator.updateVisual(IRenderContext, Node) call to the instance that has been queried from the Renderer. This implementation simply delegates to createVisual(IRenderContext, IEdge) so subclasses should override to improve rendering performance.

Parameters:

context - The render context.

oldVisual - The visual that has been created in the call to createVisual(IRenderContext, IEdge).

edge - The edge to which this style instance is assigned.

Returns:

The visual as required by the IVisualCreator.createVisual(IRenderContext) interface.

See Also:

createVisual(IRenderContext, IEdge)