com.yworks.yfiles.graph

Class NodeDefaults

java.lang.Object

com.yworks.yfiles.graph.NodeDefaults

All Implemented Interfaces:

INodeDefaults

public class NodeDefaults
extends Object
implements INodeDefaults

A canonic implementation of the INodeDefaults interface.

Constructor Summary

Constructors

Constructor and Description
NodeDefaults() Initializes a new instance of the NodeDefaults class using default properties.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeDefaults

public NodeDefaults()

Initializes a new instance of the NodeDefaults class using default properties.

Method Detail

getLabelDefaults

public final ILabelDefaults getLabelDefaults()

Description copied from interface: INodeDefaults

Gets the defaults for labels at nodes.

Specified by:

getLabelDefaults in interface INodeDefaults

Returns:

The label defaults.

See Also:

INodeDefaults.setLabelDefaults(ILabelDefaults)

getPortDefaults

public final IPortDefaults getPortDefaults()

Description copied from interface: INodeDefaults

Gets the defaults for ports at nodes.

Specified by:

getPortDefaults in interface INodeDefaults

Returns:

The port defaults.

See Also:

INodeDefaults.setPortDefaults(IPortDefaults)

getSize

public final SizeD getSize()

Description copied from interface: INodeDefaults

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.

Specified by:

getSize in interface INodeDefaults

Returns:

The default size of newly created nodes.

See Also:

INodeDefaults.setSize(SizeD)

getStyle

public final INodeStyle getStyle()

Description copied from interface: INodeDefaults

Gets the style to use for nodes.

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

Specified by:

getStyle in interface INodeDefaults

Returns:

The style to use as a template.

See Also:

INodeDefaults.isStyleInstanceSharingEnabled(), INodeDefaults.setStyle(INodeStyle)

getStyleInstance

public INodeStyle getStyleInstance()

Description copied from interface: INodeDefaults

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.

Specified by:

getStyleInstance in interface INodeDefaults

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: INodeDefaults

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

Specified by:

isStyleInstanceSharingEnabled in interface INodeDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

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

setLabelDefaults

public final void setLabelDefaults(ILabelDefaults value)

Description copied from interface: INodeDefaults

Sets the defaults for labels at nodes.

Specified by:

setLabelDefaults in interface INodeDefaults

Parameters:

value - The label defaults.

See Also:

INodeDefaults.getLabelDefaults()

setPortDefaults

public final void setPortDefaults(IPortDefaults value)

Description copied from interface: INodeDefaults

Sets the defaults for ports at nodes.

Specified by:

setPortDefaults in interface INodeDefaults

Parameters:

value - The port defaults.

See Also:

INodeDefaults.getPortDefaults()

setSize

public final void setSize(SizeD value)

Description copied from interface: INodeDefaults

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.

Specified by:

setSize in interface INodeDefaults

Parameters:

value - The default size of newly created nodes.

See Also:

INodeDefaults.getSize()

setStyle

public final void setStyle(INodeStyle value)

Description copied from interface: INodeDefaults

Sets the style to use for nodes.

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

Specified by:

setStyle in interface INodeDefaults

Parameters:

value - The style to use as a template.

See Also:

INodeDefaults.isStyleInstanceSharingEnabled(), INodeDefaults.getStyle()

setStyleInstanceSharingEnabled

public final void setStyleInstanceSharingEnabled(boolean value)

Description copied from interface: INodeDefaults

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

Specified by:

setStyleInstanceSharingEnabled in interface INodeDefaults

Parameters:

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

See Also:

INodeDefaults.getStyleInstance(), INodeDefaults.getStyle(), INodeDefaults.isStyleInstanceSharingEnabled()