com.yworks.yfiles.graph.styles

Class PolylineEdgeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.PolylineEdgeStyle

All Implemented Interfaces:

IArrowOwner, IEdgeStyle, ICloneable, Cloneable

public class PolylineEdgeStyle
extends Object
implements IEdgeStyle, IArrowOwner, Cloneable

A polygonal IEdgeStyle where straight line segments are used to connect the bends.

Constructor Summary

Constructors

Constructor and Description
PolylineEdgeStyle() Creates a new instance using PolylineEdgeStyleRenderer as renderer.
PolylineEdgeStyle(PolylineEdgeStyleRenderer renderer) Creates a new instance using the provided renderer.

Method Summary

Modifier and Type	Method and Description
PolylineEdgeStyle	clone() Performs a Object.clone().
Pen	getPen() Gets the Pen for the line.
PolylineEdgeStyleRenderer	getRenderer() Gets the renderer implementation that has been supplied to this instance in the constructor.
double	getSmoothingLength() Gets the smoothing length used for creating smooth bends.
IArrow	getSourceArrow() Gets the visual arrow at the source end of edges that use this style.
IArrow	getTargetArrow() Gets the visual arrow at the target end of edges that use this style.
void	setPen(Pen value) Sets the Pen for the line.
void	setSmoothingLength(double value) Sets the smoothing length used for creating smooth bends.
void	setSourceArrow(IArrow value) Sets the visual arrow at the source end of edges that use this style.
void	setTargetArrow(IArrow value) Sets the visual arrow at the target end of edges that use this style.

Methods inherited from class java.lang.Object

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

Constructor Detail

PolylineEdgeStyle

public PolylineEdgeStyle()

Creates a new instance using PolylineEdgeStyleRenderer as renderer.

PolylineEdgeStyle

public PolylineEdgeStyle(PolylineEdgeStyleRenderer renderer)

Creates a new instance using the provided renderer.

Parameters:

renderer - The custom renderer for this style instance.

Method Detail

clone

public PolylineEdgeStyle clone()

Performs a Object.clone().

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

A copy of this object.

See Also:

Object.clone()

getPen

public final Pen getPen()

Gets the Pen for the line.

The default value is Black.

Returns:

The Pen.

See Also:

setPen(Pen)

getRenderer

public final PolylineEdgeStyleRenderer getRenderer()

Gets the renderer implementation that has been supplied to this instance in the constructor.

Specified by:

getRenderer in interface IEdgeStyle

Returns:

The Renderer.

getSmoothingLength

public final double getSmoothingLength()

Gets the smoothing length used for creating smooth bends.

A value of 0.0d will disable smoothing.

The default value is 0.

Returns:

The SmoothingLength.

See Also:

setSmoothingLength(double)

getSourceArrow

public final IArrow getSourceArrow()

Gets the visual arrow at the source end of edges that use this style.

Arrow instances may be shared between multiple style instances.

This property may not be null. To have no source arrow set, use IArrow.NONE instead.

The default value is IArrow.NONE.

Specified by:

getSourceArrow in interface IArrowOwner

Returns:

The SourceArrow.

See Also:

setSourceArrow(IArrow)

getTargetArrow

public final IArrow getTargetArrow()

Gets the visual arrow at the target end of edges that use this style.

Arrow instances may be shared between multiple style instances.

This property may not be null. To have no target arrow set, use IArrow.NONE instead.

The default value is IArrow.NONE.

Specified by:

getTargetArrow in interface IArrowOwner

Returns:

The TargetArrow.

See Also:

setTargetArrow(IArrow)

setPen

public final void setPen(Pen value)

Sets the Pen for the line.

The default value is Black.

Parameters:

value - The Pen to set.

See Also:

getPen()

setSmoothingLength

public final void setSmoothingLength(double value)

Sets the smoothing length used for creating smooth bends.

A value of 0.0d will disable smoothing.

The default value is 0.

Parameters:

value - The SmoothingLength to set.

See Also:

getSmoothingLength()

setSourceArrow

public final void setSourceArrow(IArrow value)

Sets the visual arrow at the source end of edges that use this style.

Arrow instances may be shared between multiple style instances.

This property may not be null. To have no source arrow set, use IArrow.NONE instead.

The default value is IArrow.NONE.

Parameters:

value - The SourceArrow to set.

See Also:

getSourceArrow()

setTargetArrow

public final void setTargetArrow(IArrow value)

Sets the visual arrow at the target end of edges that use this style.

Arrow instances may be shared between multiple style instances.

This property may not be null. To have no target arrow set, use IArrow.NONE instead.

The default value is IArrow.NONE.

Parameters:

value - The TargetArrow to set.

See Also:

getTargetArrow()