com.yworks.yfiles.graph

Class LabelDefaults

java.lang.Object

com.yworks.yfiles.graph.LabelDefaults

All Implemented Interfaces:

ILabelDefaults

public class LabelDefaults
extends Object
implements ILabelDefaults

A canonic implementation of the ILabelDefaults interface.

Constructor Summary

Constructors

Constructor and Description
LabelDefaults() Initializes a new instance of the LabelDefaults class using a trivial parameter.

Method Summary

Modifier and Type	Method and Description
ILabelModelParameter	getLayoutParameter() Gets the label model parameter to use for labels.
ILabelModelParameter	getLayoutParameterInstance(ILabelOwner owner) Factory method that returns a label model parameter instance for use with newly created labels.
ILabelStyle	getStyle() Gets the style to use for labels.
ILabelStyle	getStyleInstance(ILabelOwner owner) Factory method that returns a style instance for use with newly created labels.
boolean	isAutoAdjustingPreferredSizeEnabled() Gets a property that determines whether to automatically adjust the preferred size of a label.
boolean	isLayoutParameterInstanceSharingEnabled() Gets a value indicating whether the LayoutParameter instance should be shared referentially or cloned upon a call to ILabelDefaults.getLayoutParameterInstance(ILabelOwner).
boolean	isStyleInstanceSharingEnabled() Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to ILabelDefaults.getStyleInstance(ILabelOwner).
void	setAutoAdjustingPreferredSizeEnabled(boolean value) Sets a property that determines whether to automatically adjust the preferred size of a label.
void	setLayoutParameter(ILabelModelParameter value) Sets the label model parameter to use for labels.
void	setLayoutParameterInstanceSharingEnabled(boolean value) Sets a value indicating whether the LayoutParameter instance should be shared referentially or cloned upon a call to ILabelDefaults.getLayoutParameterInstance(ILabelOwner).
void	setStyle(ILabelStyle value) Sets the style to use for labels.
void	setStyleInstanceSharingEnabled(boolean value) Sets a value indicating whether the Style instance should be shared referentially or cloned upon a call to ILabelDefaults.getStyleInstance(ILabelOwner).

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelDefaults

public LabelDefaults()

Initializes a new instance of the LabelDefaults class using a trivial parameter.

Method Detail

getLayoutParameter

public final ILabelModelParameter getLayoutParameter()

Description copied from interface: ILabelDefaults

Gets the label model parameter to use for labels.

Depending on the setting of LayoutParameterInstanceSharingEnabled, the ILabelDefaults.getLayoutParameterInstance(ILabelOwner) method should return a clone of this instance or the very same instance.

Specified by:

getLayoutParameter in interface ILabelDefaults

Returns:

The parameter to use as a template.

See Also:

ILabelDefaults.isLayoutParameterInstanceSharingEnabled(), ILabelDefaults.getLayoutParameterInstance(ILabelOwner), ILabelDefaults.setLayoutParameter(ILabelModelParameter)

getLayoutParameterInstance

public ILabelModelParameter getLayoutParameterInstance(ILabelOwner owner)

Description copied from interface: ILabelDefaults

Factory method that returns a label model parameter instance for use with newly created labels.

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

Specified by:

getLayoutParameterInstance in interface ILabelDefaults

Parameters:

owner - The owner of the label that will be created.

Returns:

The parameter to use, which for most implementations is either a clone of or the LayoutParameter property, if LayoutParameterInstanceSharingEnabled is enabled.

getStyle

public final ILabelStyle getStyle()

Description copied from interface: ILabelDefaults

Gets the style to use for labels.

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

Specified by:

getStyle in interface ILabelDefaults

Returns:

The style to use as a template.

See Also:

ILabelDefaults.isStyleInstanceSharingEnabled(), ILabelDefaults.setStyle(ILabelStyle)

getStyleInstance

public ILabelStyle getStyleInstance(ILabelOwner owner)

Description copied from interface: ILabelDefaults

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

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 ILabelDefaults

Parameters:

owner - The owner of the label that will be created.

Returns:

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

isAutoAdjustingPreferredSizeEnabled

public final boolean isAutoAdjustingPreferredSizeEnabled()

Description copied from interface: ILabelDefaults

Gets a property that determines whether to automatically adjust the preferred size of a label.

On a call to IGraph.setLabelText(com.yworks.yfiles.graph.ILabel, java.lang.String) or IGraph.setStyle(com.yworks.yfiles.graph.ILabel, ILabelStyle), the preferred size of the label will automatically be adjusted to the preferred size that is suggested by the label's style renderer, if this property is set to true.

Specified by:

isAutoAdjustingPreferredSizeEnabled in interface ILabelDefaults

Returns:

The AutoAdjustingPreferredSizeEnabled.

See Also:

ILabelStyleRenderer.getPreferredSize(com.yworks.yfiles.graph.ILabel, ILabelStyle), ILabelDefaults.setAutoAdjustingPreferredSizeEnabled(boolean)

isLayoutParameterInstanceSharingEnabled

public final boolean isLayoutParameterInstanceSharingEnabled()

Description copied from interface: ILabelDefaults

Gets a value indicating whether the LayoutParameter instance should be shared referentially or cloned upon a call to ILabelDefaults.getLayoutParameterInstance(ILabelOwner).

Specified by:

isLayoutParameterInstanceSharingEnabled in interface ILabelDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

ILabelDefaults.getLayoutParameterInstance(ILabelOwner), ILabelDefaults.getLayoutParameter(), ILabelDefaults.setLayoutParameterInstanceSharingEnabled(boolean)

isStyleInstanceSharingEnabled

public final boolean isStyleInstanceSharingEnabled()

Description copied from interface: ILabelDefaults

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

Specified by:

isStyleInstanceSharingEnabled in interface ILabelDefaults

Returns:

true if the reference should be shared; false otherwise.

See Also:

ILabelDefaults.getStyleInstance(ILabelOwner), ILabelDefaults.getStyle(), ILabelDefaults.setStyleInstanceSharingEnabled(boolean)

setAutoAdjustingPreferredSizeEnabled

public final void setAutoAdjustingPreferredSizeEnabled(boolean value)

Description copied from interface: ILabelDefaults

Sets a property that determines whether to automatically adjust the preferred size of a label.

On a call to IGraph.setLabelText(com.yworks.yfiles.graph.ILabel, java.lang.String) or IGraph.setStyle(com.yworks.yfiles.graph.ILabel, ILabelStyle), the preferred size of the label will automatically be adjusted to the preferred size that is suggested by the label's style renderer, if this property is set to true.

Specified by:

setAutoAdjustingPreferredSizeEnabled in interface ILabelDefaults

Parameters:

value - The AutoAdjustingPreferredSizeEnabled to set.

See Also:

ILabelStyleRenderer.getPreferredSize(com.yworks.yfiles.graph.ILabel, ILabelStyle), ILabelDefaults.isAutoAdjustingPreferredSizeEnabled()

setLayoutParameter

public final void setLayoutParameter(ILabelModelParameter value)

Description copied from interface: ILabelDefaults

Sets the label model parameter to use for labels.

Depending on the setting of LayoutParameterInstanceSharingEnabled, the ILabelDefaults.getLayoutParameterInstance(ILabelOwner) method should return a clone of this instance or the very same instance.

Specified by:

setLayoutParameter in interface ILabelDefaults

Parameters:

value - The parameter to use as a template.

See Also:

ILabelDefaults.isLayoutParameterInstanceSharingEnabled(), ILabelDefaults.getLayoutParameterInstance(ILabelOwner), ILabelDefaults.getLayoutParameter()

setLayoutParameterInstanceSharingEnabled

public final void setLayoutParameterInstanceSharingEnabled(boolean value)

Description copied from interface: ILabelDefaults

Sets a value indicating whether the LayoutParameter instance should be shared referentially or cloned upon a call to ILabelDefaults.getLayoutParameterInstance(ILabelOwner).

Specified by:

setLayoutParameterInstanceSharingEnabled in interface ILabelDefaults

Parameters:

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

See Also:

ILabelDefaults.getLayoutParameterInstance(ILabelOwner), ILabelDefaults.getLayoutParameter(), ILabelDefaults.isLayoutParameterInstanceSharingEnabled()

setStyle

public final void setStyle(ILabelStyle value)

Description copied from interface: ILabelDefaults

Sets the style to use for labels.

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

Specified by:

setStyle in interface ILabelDefaults

Parameters:

value - The style to use as a template.

See Also:

ILabelDefaults.isStyleInstanceSharingEnabled(), ILabelDefaults.getStyle()

setStyleInstanceSharingEnabled

public final void setStyleInstanceSharingEnabled(boolean value)

Description copied from interface: ILabelDefaults

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

Specified by:

setStyleInstanceSharingEnabled in interface ILabelDefaults

Parameters:

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

See Also:

ILabelDefaults.getStyleInstance(ILabelOwner), ILabelDefaults.getStyle(), ILabelDefaults.isStyleInstanceSharingEnabled()