com.yworks.yfiles.graph

Interface ILabelDefaults

All Known Implementing Classes:

LabelDefaults

public interface ILabelDefaults

Interface used by IGraph and the like to declare and obtain the defaults for labels.

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:

INodeDefaults.getLabelDefaults(), IEdgeDefaults.getLabelDefaults(), IGraph.getNodeDefaults(), IGraph.getEdgeDefaults(), IGraph.getGroupNodeDefaults()

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 getLayoutParameterInstance(ILabelOwner).
boolean	isStyleInstanceSharingEnabled() Gets a value indicating whether the Style instance should be shared referentially or cloned upon a call to 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 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 getStyleInstance(ILabelOwner).

Method Detail

getLayoutParameter

ILabelModelParameter getLayoutParameter()

Gets the label model parameter to use for labels.

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

Returns:

The parameter to use as a template.

See Also:

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

getLayoutParameterInstance

ILabelModelParameter getLayoutParameterInstance(ILabelOwner owner)

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.

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

ILabelStyle getStyle()

Gets the style to use for labels.

Depending on the setting of StyleInstanceSharingEnabled, the getStyleInstance(ILabelOwner) 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(ILabelStyle)

getStyleInstance

ILabelStyle getStyleInstance(ILabelOwner owner)

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.

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

boolean isAutoAdjustingPreferredSizeEnabled()

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.

Returns:

The AutoAdjustingPreferredSizeEnabled.

See Also:

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

isLayoutParameterInstanceSharingEnabled

boolean isLayoutParameterInstanceSharingEnabled()

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

Returns:

true if the reference should be shared; false otherwise.

See Also:

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

isStyleInstanceSharingEnabled

boolean isStyleInstanceSharingEnabled()

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

Returns:

true if the reference should be shared; false otherwise.

See Also:

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

setAutoAdjustingPreferredSizeEnabled

void setAutoAdjustingPreferredSizeEnabled(boolean value)

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.

Parameters:

value - The AutoAdjustingPreferredSizeEnabled to set.

See Also:

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

setLayoutParameter

void setLayoutParameter(ILabelModelParameter value)

Sets the label model parameter to use for labels.

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

Parameters:

value - The parameter to use as a template.

See Also:

isLayoutParameterInstanceSharingEnabled(), getLayoutParameterInstance(ILabelOwner), getLayoutParameter()

setLayoutParameterInstanceSharingEnabled

void setLayoutParameterInstanceSharingEnabled(boolean value)

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

Parameters:

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

See Also:

getLayoutParameterInstance(ILabelOwner), getLayoutParameter(), isLayoutParameterInstanceSharingEnabled()

setStyle

void setStyle(ILabelStyle value)

Sets the style to use for labels.

Depending on the setting of StyleInstanceSharingEnabled, the getStyleInstance(ILabelOwner) 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(ILabelOwner).

Parameters:

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

See Also:

getStyleInstance(ILabelOwner), getStyle(), isStyleInstanceSharingEnabled()