com.yworks.yfiles.graph.styles

Class ArcEdgeStyle

java.lang.Object

com.yworks.yfiles.graph.styles.ArcEdgeStyle

All Implemented Interfaces:

IArrowOwner, IEdgeStyle, ICloneable, Cloneable

public class ArcEdgeStyle
extends Object
implements IEdgeStyle, IArrowOwner, Cloneable

Provides an arc representation for an edge.

The rendering does not take into account bends of an edge, instead the arc's height is determined as a fixed ratio or fixed height.

This style uses an ArcEdgeStyleRenderer for its visualization.

Constructor Summary

Constructors

Constructor and Description
ArcEdgeStyle() Creates a new instance using ArcEdgeStyleRenderer as renderer.
ArcEdgeStyle(ArcEdgeStyleRenderer renderer) Creates a new instance using the provided renderer.

Method Summary

Modifier and Type	Method and Description
ArcEdgeStyle	clone() Performs a Object.clone().
double	getHeight() Gets the "height" of the arc.
Pen	getPen() Gets the Pen that is used to draw the arc.
ArcEdgeStyleRenderer	getRenderer() Gets the renderer implementation that has been supplied to this instance in the constructor.
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.
boolean	isFixedHeightEnabled() Gets a value indicating whether this ArcEdgeStyle interprets the Height value as an absolute or relative value.
boolean	isHeightHandleProviderEnabled() Gets a value indicating whether the ArcEdgeStyleRenderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the Height of this instance.
void	setFixedHeightEnabled(boolean value) Sets a value indicating whether this ArcEdgeStyle interprets the Height value as an absolute or relative value.
void	setHeight(double value) Sets the "height" of the arc.
void	setHeightHandleProviderEnabled(boolean value) Sets a value indicating whether the ArcEdgeStyleRenderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the Height of this instance.
void	setPen(Pen value) Sets the Pen that is used to draw the arc.
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

ArcEdgeStyle

public ArcEdgeStyle()

Creates a new instance using ArcEdgeStyleRenderer as renderer.

ArcEdgeStyle

public ArcEdgeStyle(ArcEdgeStyleRenderer renderer)

Creates a new instance using the provided renderer.

Parameters:

renderer - The custom renderer for this style instance.

Method Detail

clone

public ArcEdgeStyle 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()

getHeight

public final double getHeight()

Gets the "height" of the arc.

Depending on the setting of FixedHeightEnabled, this value is interpreted differently: If FixedHeightEnabled is disabled, the height of the arc will depend on it's width. The width will be multiplied by this value to obtain the height. If the FixedHeightEnabled feature is enabled, this value will be interpreted as the absolute height.

The default value is 0.

Returns:

The height of the arc, either relative or absolute.

See Also:

setHeight(double)

getPen

public final Pen getPen()

Gets the Pen that is used to draw the arc.

The default value is Black.

Returns:

The Pen.

See Also:

setPen(Pen)

getRenderer

public final ArcEdgeStyleRenderer getRenderer()

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

Specified by:

getRenderer in interface IEdgeStyle

Returns:

The Renderer.

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.

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.

The default value is IArrow.NONE.

Specified by:

getTargetArrow in interface IArrowOwner

Returns:

The TargetArrow.

See Also:

setTargetArrow(IArrow)

isFixedHeightEnabled

public final boolean isFixedHeightEnabled()

Gets a value indicating whether this ArcEdgeStyle interprets the Height value as an absolute or relative value.

The default value is true.

Returns:

true if the height value should be interpreted as a fixed value, otherwise, false.

See Also:

getHeight(), setFixedHeightEnabled(boolean)

isHeightHandleProviderEnabled

public final boolean isHeightHandleProviderEnabled()

Gets a value indicating whether the ArcEdgeStyleRenderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the Height of this instance.

The default value is true.

Returns:

true(which is the default) if a handle should be provided; false otherwise.

See Also:

setHeightHandleProviderEnabled(boolean)

setFixedHeightEnabled

public final void setFixedHeightEnabled(boolean value)

Sets a value indicating whether this ArcEdgeStyle interprets the Height value as an absolute or relative value.

The default value is true.

Parameters:

value - true if the height value should be interpreted as a fixed value, otherwise, false.

See Also:

getHeight(), isFixedHeightEnabled()

setHeight

public final void setHeight(double value)

Sets the "height" of the arc.

Depending on the setting of FixedHeightEnabled, this value is interpreted differently: If FixedHeightEnabled is disabled, the height of the arc will depend on it's width. The width will be multiplied by this value to obtain the height. If the FixedHeightEnabled feature is enabled, this value will be interpreted as the absolute height.

The default value is 0.

Parameters:

value - The height of the arc, either relative or absolute.

See Also:

getHeight()

setHeightHandleProviderEnabled

public final void setHeightHandleProviderEnabled(boolean value)

Sets a value indicating whether the ArcEdgeStyleRenderer should provide an IHandle if queried for the IHandleProvider implementation that allows for adjusting the Height of this instance.

The default value is true.

Parameters:

value - true(which is the default) if a handle should be provided; false otherwise.

See Also:

isHeightHandleProviderEnabled()

setPen

public final void setPen(Pen value)

Sets the Pen that is used to draw the arc.

The default value is Black.

Parameters:

value - The Pen to set.

See Also:

getPen()

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.

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.

The default value is IArrow.NONE.

Parameters:

value - The TargetArrow to set.

See Also:

getTargetArrow()