com.yworks.yfiles.graph

Interface IEdgeDefaults

All Known Implementing Classes:

EdgeDefaults

public interface IEdgeDefaults

Interface used by IGraph to declare and obtain the defaults for edges and their labels and ports.

Note that changing these defaults does not change properties of already created model items. Rather, only items created after the change are affected.

See Also:

IGraph.getEdgeDefaults()

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 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 getStyleInstance().

Method Detail

getLabelDefaults

ILabelDefaults getLabelDefaults()

Gets the defaults for labels at edges.

Returns:

The label defaults.

See Also:

setLabelDefaults(ILabelDefaults)

getPortDefaults

IPortDefaults getPortDefaults()

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.

Returns:

The port defaults.

See Also:

setPortDefaults(IPortDefaults)

getStyle

IEdgeStyle getStyle()

Gets the style to use for edges.

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

Returns:

The style to use as a template.

See Also:

isStyleInstanceSharingEnabled(), setStyle(IEdgeStyle)

getStyleInstance

IEdgeStyle getStyleInstance()

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.

Returns:

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

isStyleInstanceSharingEnabled

boolean isStyleInstanceSharingEnabled()

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

Returns:

true if the reference should be shared; false otherwise.

See Also:

getStyleInstance(), getStyle(), setStyleInstanceSharingEnabled(boolean)

setLabelDefaults

void setLabelDefaults(ILabelDefaults value)

Sets the defaults for labels at edges.

Parameters:

value - The label defaults.

See Also:

getLabelDefaults()

setPortDefaults

void setPortDefaults(IPortDefaults value)

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.

Parameters:

value - The port defaults.

See Also:

getPortDefaults()

setStyle

void setStyle(IEdgeStyle value)

Sets the style to use for edges.

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

Parameters:

value - The style to use as a template.

See Also:

isStyleInstanceSharingEnabled(), getStyle()

setStyleInstanceSharingEnabled

void setStyleInstanceSharingEnabled(boolean value)

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

Parameters:

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

See Also:

getStyleInstance(), getStyle(), isStyleInstanceSharingEnabled()