com.yworks.yfiles.view

Class DashStyle

java.lang.Object

com.yworks.yfiles.view.DashStyle

All Implemented Interfaces:

ICloneable, Cloneable

public class DashStyle
extends Object

A container for Dashes and an Offset.

Constructor Summary

Constructors

Constructor and Description
DashStyle() Initializes a new instance of the DashStyle class using an empty Dashes and zero Offset.
DashStyle(double[] dashes, double offset) Initializes a new instance of the DashStyle class using the provided dashes and offset.

Method Summary

Modifier and Type	Method and Description
com.yworks.yfiles.view.Freezable	clone() Clones this instance by returning a Object.clone() or this in case this instance is already frozen.
void	freeze() Freezes this instance.
protected void	freezeCore() Callback that needs to be overridden by subclasses to actually freeze the instance.
static DashStyle	getDash() Gets the dash style with a single dash.
static DashStyle	getDashDot() Gets the dash style with a single dash and dot.
static DashStyle	getDashDotDot() Gets the dash style with a single dash and two dots.
List<Double>	getDashes() Gets the dashes.
static DashStyle	getDot() Gets the dash style with a single dot.
double	getOffset() Gets the offset.
static DashStyle	getSolid() Gets the solid dash style with no dashes.
boolean	isCanFreeze() Determines whether this instance is not yet frozen.
boolean	isFrozen() Gets a value indicating whether this instance is frozen.
void	setDashes(List<Double> value) Sets the dashes.
void	setOffset(double value) Sets the offset.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashStyle

public DashStyle()

Initializes a new instance of the DashStyle class using an empty Dashes and zero Offset.

DashStyle

public DashStyle(double[] dashes,
                 double offset)

Initializes a new instance of the DashStyle class using the provided dashes and offset.

Parameters:

dashes - The dashes.

offset - The offset.

Method Detail

getDash

public static DashStyle getDash()

Gets the dash style with a single dash.

Returns:

The dash style.

getDashDot

public static DashStyle getDashDot()

Gets the dash style with a single dash and dot.

Returns:

The dash style.

getDashDotDot

public static DashStyle getDashDotDot()

Gets the dash style with a single dash and two dots.

Returns:

The dash style.

getDashes

public final List<Double> getDashes()

Gets the dashes.

Returns:

The dashes.

See Also:

setDashes(List)

getDot

public static DashStyle getDot()

Gets the dash style with a single dot.

Returns:

The dash style.

getOffset

public final double getOffset()

Gets the offset.

Returns:

The offset.

See Also:

setOffset(double)

getSolid

public static DashStyle getSolid()

Gets the solid dash style with no dashes.

Returns:

The solid dashstyle.

setDashes

public final void setDashes(List<Double> value)

Sets the dashes.

Parameters:

value - The dashes.

See Also:

getDashes()

setOffset

public final void setOffset(double value)

Sets the offset.

Parameters:

value - The offset.

See Also:

getOffset()

clone

public com.yworks.yfiles.view.Freezable clone()

Clones this instance by returning a Object.clone() or this in case this instance is already frozen.

Specified by:

clone in interface ICloneable

Overrides:

clone in class Object

Returns:

An instance of the same type as this instance.

See Also:

Object.clone()

freeze

public final void freeze()

Freezes this instance.

freezeCore

protected void freezeCore()

Callback that needs to be overridden by subclasses to actually freeze the instance.

isCanFreeze

public final boolean isCanFreeze()

Determines whether this instance is not yet frozen.

Returns:

The CanFreeze.

isFrozen

public final boolean isFrozen()

Gets a value indicating whether this instance is frozen.

Returns:

true if this instance is frozen; otherwise, false.