com.yworks.yfiles.graph

Interface INodeDefaults

All Known Implementing Classes:

NodeDefaults

public interface INodeDefaults

Interface used by IGraph and the like to declare and obtain the defaults for nodes and their labels or 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.getNodeDefaults(), IGraph.getGroupNodeDefaults()

Method Summary

Modifier and Type	Method and Description
ILabelDefaults	getLabelDefaults() Gets the defaults for labels at nodes.
IPortDefaults	getPortDefaults() Gets the defaults for ports at nodes.
SizeD	getSize() Gets the default node size.
INodeStyle	getStyle() Gets the style to use for nodes.
INodeStyle	getStyleInstance() Factory method that returns a style instance for use with newly created nodes.
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 nodes.
void	setPortDefaults(IPortDefaults value) Sets the defaults for ports at nodes.
void	setSize(SizeD value) Sets the default node size.
void	setStyle(INodeStyle value) Sets the style to use for nodes.
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 nodes.

Returns:

The label defaults.

See Also:

setLabelDefaults(ILabelDefaults)

getPortDefaults

IPortDefaults getPortDefaults()

Gets the defaults for ports at nodes.

Returns:

The port defaults.

See Also:

setPortDefaults(IPortDefaults)

getSize

SizeD getSize()

Gets the default node size.

The values of this size will be used by the IGraph.createNode(com.yworks.yfiles.geometry.PointD, INodeStyle, java.lang.Object) and IGraph.createNode(com.yworks.yfiles.geometry.PointD, INodeStyle, java.lang.Object) methods.

Returns:

The default size of newly created nodes.

See Also:

setSize(SizeD)

getStyle

INodeStyle getStyle()

Gets the style to use for nodes.

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(INodeStyle)

getStyleInstance

INodeStyle getStyleInstance()

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

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 nodes.

Parameters:

value - The label defaults.

See Also:

getLabelDefaults()

setPortDefaults

void setPortDefaults(IPortDefaults value)

Sets the defaults for ports at nodes.

Parameters:

value - The port defaults.

See Also:

getPortDefaults()

setSize

void setSize(SizeD value)

Sets the default node size.

The values of this size will be used by the IGraph.createNode(com.yworks.yfiles.geometry.PointD, INodeStyle, java.lang.Object) and IGraph.createNode(com.yworks.yfiles.geometry.PointD, INodeStyle, java.lang.Object) methods.

Parameters:

value - The default size of newly created nodes.

See Also:

getSize()

setStyle

void setStyle(INodeStyle value)

Sets the style to use for nodes.

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