com.yworks.yfiles.graph.styles

Interface IArrow

All Known Implementing Classes:

Arrow

public interface IArrow

The interface for the visual representation of an arrow that is normally used to decorate the visual representation of an IEdge.

Instances of this class are used by IEdgeStyle implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static IArrow	CIRCLE A singleton IArrow instance that paints a simple circle-shaped black arrow.
static IArrow	CROSS A singleton IArrow instance that paints a simple cross-shaped black arrow.
static IArrow	DEFAULT A singleton IArrow instance that paints a default shaped black arrow.
static IArrow	DIAMOND A singleton IArrow instance that paints a simple diamond-shaped black arrow.
static IArrow	NONE A singleton IArrow instance that paints no arrow at all.
static IArrow	SHORT A singleton IArrow instance that paints a short black arrow.
static IArrow	SIMPLE A singleton IArrow instance that paints a simple black arrow.
static IArrow	TRIANGLE A singleton IArrow instance that paints a simple triangle-shaped black arrow.

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(IEdge edge, boolean atSource, PointD anchor, PointD directionVector) Gets an IBoundsProvider implementation that can yield this arrow's bounds if painted at the given location using the given direction for the given edge.
double	getCropLength() Gets the cropping length associated with this instance.
double	getLength() Returns the length of the arrow (the distance from the arrow's tip to the position where the visual representation of the edge's path should begin).
IVisualCreator	getVisualCreator(IEdge edge, boolean atSource, PointD anchor, PointD direction) Gets an IVisualCreator implementation that will paint this arrow at the given location using the given direction for the given edge.

Field Detail

CIRCLE

static final IArrow CIRCLE

A singleton IArrow instance that paints a simple circle-shaped black arrow.

CROSS

static final IArrow CROSS

A singleton IArrow instance that paints a simple cross-shaped black arrow.

DEFAULT

static final IArrow DEFAULT

A singleton IArrow instance that paints a default shaped black arrow.

DIAMOND

static final IArrow DIAMOND

A singleton IArrow instance that paints a simple diamond-shaped black arrow.

NONE

static final IArrow NONE

A singleton IArrow instance that paints no arrow at all.

SHORT

static final IArrow SHORT

A singleton IArrow instance that paints a short black arrow.

SIMPLE

static final IArrow SIMPLE

A singleton IArrow instance that paints a simple black arrow.

TRIANGLE

static final IArrow TRIANGLE

A singleton IArrow instance that paints a simple triangle-shaped black arrow.

Method Detail

getBoundsProvider

IBoundsProvider getBoundsProvider(IEdge edge,
                                  boolean atSource,
                                  PointD anchor,
                                  PointD directionVector)

Gets an IBoundsProvider implementation that can yield this arrow's bounds if painted at the given location using the given direction for the given edge.

Parameters:

edge - the edge this arrow belongs to

atSource - whether this will be the source arrow

anchor - the anchor point for the tip of the arrow

directionVector - the direction the arrow is pointing in

Returns:

an implementation of the IBoundsProvider interface that can subsequently be used to query the bounds. Clients will always call this method before using the implementation and may not cache the instance returned. This allows for applying the flyweight design pattern to implementations.

getCropLength

double getCropLength()

Gets the cropping length associated with this instance.

This value is used by IEdgeStyle implementations to let the edge appear to end shortly before its actual target.

Returns:

The CropLength.

getLength

double getLength()

Returns the length of the arrow (the distance from the arrow's tip to the position where the visual representation of the edge's path should begin).

Returns:

The Length.

getVisualCreator

IVisualCreator getVisualCreator(IEdge edge,
                                boolean atSource,
                                PointD anchor,
                                PointD direction)

Gets an IVisualCreator implementation that will paint this arrow at the given location using the given direction for the given edge.

Parameters:

edge - the edge this arrow belongs to

atSource - whether this will be the source arrow

anchor - the anchor point for the tip of the arrow

direction - the direction the arrow is pointing in

Returns:

an implementation of the IVisualCreator interface that can subsequently be used to perform the actual painting. Clients will always call this method before using the implementation and may not cache the instance returned. This allows for applying the flyweight design pattern to implementations.