com.yworks.yfiles.graph

Class EdgeDefaults

java.lang.Object

com.yworks.yfiles.graph.EdgeDefaults

All Implemented Interfaces:

IEdgeDefaults

public class EdgeDefaults
extends Object
implements IEdgeDefaults

A canonic implementation of the IEdgeDefaults interface.

Constructor Summary

Constructors

Constructor and Description
EdgeDefaults() Initializes a new instance of the EdgeDefaults class with default edge style and label and port defaults.

Method Summary

Modifier and Type	Method and Description
ILabelDefaults	getLabelDefaults() Gets the defaults for labels at edges.
IPortDefaults	getPortDefaults() Gets the defaults for ports at edges.
IEdgeStyle	getStyle() Gets the style to use for edges.
IEdgeStyle	getStyleInstance() Factory method that returns a style instance for use with newly created edges.
boolean	isStyleInstanceSharingEnabled() Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IEdgeDefaults.getStyleInstance().
void	setLabelDefaults(ILabelDefaults value) Sets the defaults for labels at edges.
void	setPortDefaults(IPortDefaults value) Sets the defaults for ports at edges.
void	setStyle(IEdgeStyle value) Sets the style to use for edges.
void	setStyleInstanceSharingEnabled(boolean value) Sets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IEdgeDefaults.getStyleInstance().

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeDefaults

public EdgeDefaults()

Initializes a new instance of the EdgeDefaults class with default edge style and label and port defaults.

Method Detail

getLabelDefaults

public final ILabelDefaults getLabelDefaults()

Description copied from interface: IEdgeDefaults

Gets the defaults for labels at edges.

Specified by:

getLabelDefaults in interface IEdgeDefaults

Returns:

The label defaults.

See Also:

IEdgeDefaults.setLabelDefaults(ILabelDefaults)

getPortDefaults

public final IPortDefaults getPortDefaults()

Description copied from interface: IEdgeDefaults

Gets the defaults for ports at edges.

Note that these are not the SourcePorts or TargetPorts, because conceptually they belong to the nodes (and their INodeDefaults), but rather for ports at edges to which other edges can connect.

Specified by:

getPortDefaults in interface IEdgeDefaults

Returns:

The port defaults.

See Also:

IEdgeDefaults.setPortDefaults(IPortDefaults)

getStyle

public final IEdgeStyle getStyle()

Description copied from interface: IEdgeDefaults

Gets the style to use for edges.

Depending on the setting of StyleInstanceSharingEnabled, the IEdgeDefaults.getStyleInstance() method should return a clone of this instance or the very same instance.

Specified by:

getStyle in interface IEdgeDefaults

Returns:

The style to use as a template.

See Also:

IEdgeDefaults.isStyleInstanceSharingEnabled(), IEdgeDefaults.setStyle(IEdgeStyle)

getStyleInstance

public IEdgeStyle getStyleInstance()

Description copied from interface: IEdgeDefaults

Factory method that returns a style instance for use with newly created edges.

Most implementations will yield either, a clone of or the Style property, if StyleInstanceSharingEnabled is enabled, but they might use more complicated logic, too.

Specified by:

getStyleInstance in interface IEdgeDefaults

Returns:

The style to use, which for most implementations is either a clone of or the Style property, if StyleInstanceSharingEnabled is enabled.

isStyleInstanceSharingEnabled

public final boolean isStyleInstanceSharingEnabled()

Description copied from interface: IEdgeDefaults

Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IEdgeDefaults.getStyleInstance().

Specified by:

isStyleInstanceSharingEnabled in interface IEdgeDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

IEdgeDefaults.getStyleInstance(), IEdgeDefaults.getStyle(), IEdgeDefaults.setStyleInstanceSharingEnabled(boolean)

setLabelDefaults

public final void setLabelDefaults(ILabelDefaults value)

Description copied from interface: IEdgeDefaults

Sets the defaults for labels at edges.

Specified by:

setLabelDefaults in interface IEdgeDefaults

Parameters:

value - The label defaults.

See Also:

IEdgeDefaults.getLabelDefaults()

setPortDefaults

public final void setPortDefaults(IPortDefaults value)

Description copied from interface: IEdgeDefaults

Sets the defaults for ports at edges.

Note that these are not the SourcePorts or TargetPorts, because conceptually they belong to the nodes (and their INodeDefaults), but rather for ports at edges to which other edges can connect.

Specified by:

setPortDefaults in interface IEdgeDefaults

Parameters:

value - The port defaults.

See Also:

IEdgeDefaults.getPortDefaults()

setStyle

public final void setStyle(IEdgeStyle value)

Description copied from interface: IEdgeDefaults

Sets the style to use for edges.

Depending on the setting of StyleInstanceSharingEnabled, the IEdgeDefaults.getStyleInstance() method should return a clone of this instance or the very same instance.

Specified by:

setStyle in interface IEdgeDefaults

Parameters:

value - The style to use as a template.

See Also:

IEdgeDefaults.isStyleInstanceSharingEnabled(), IEdgeDefaults.getStyle()

setStyleInstanceSharingEnabled

public final void setStyleInstanceSharingEnabled(boolean value)

Description copied from interface: IEdgeDefaults

Sets a value indicating whether the Style instance should be shared referentially or cloned upon a call to IEdgeDefaults.getStyleInstance().

Specified by:

setStyleInstanceSharingEnabled in interface IEdgeDefaults

Parameters:

value - true if the reference should be shared; false otherwise.

See Also:

IEdgeDefaults.getStyleInstance(), IEdgeDefaults.getStyle(), IEdgeDefaults.isStyleInstanceSharingEnabled()