com.yworks.yfiles.graph

Class FoldingLabelState

java.lang.Object

com.yworks.yfiles.graph.FoldingLabelState

public final class FoldingLabelState
extends Object

A data container representing the state of a label at a FolderNodeState or FoldingEdgeState.

When the properties of the state are changed, these changes are reflected immediately in the Views.

See Also:

FoldingLabelOwnerState.getLabels(), FoldingLabelOwnerState.addLabel(String, ILabelModelParameter, ILabelStyle, SizeD, Object), FoldingLabelOwnerState.remove(FoldingLabelState)

Method Summary

Modifier and Type	Method and Description
ILabel	asLabel() Returns an ILabel instance which represents this label state.
ILabelModelParameter	getLayoutParameter() The ILabelModelParameter used to describe the label's layout.
SizeD	getPreferredSize() The preferred size of the label.
ILabelStyle	getStyle() The style of this label.
Object	getTag() The tag of the label.
String	getText() The label's text.
void	setLayoutParameter(ILabelModelParameter value) The ILabelModelParameter used to describe the label's layout.
void	setPreferredSize(SizeD value) The preferred size of the label.
void	setStyle(ILabelStyle value) The style of this label.
void	setTag(Object value) The tag of the label.
void	setText(String value) The label's text.

Methods inherited from class java.lang.Object

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

Method Detail

asLabel

public final ILabel asLabel()

Returns an ILabel instance which represents this label state.

The returned label is not present in any graph but may be passed to IFoldingView.getViewItem(com.yworks.yfiles.graph.IModelItem) to get the label state's view label in the folding view graph.

Returns:

An ILabel instance which represents this label state.

getLayoutParameter

public final ILabelModelParameter getLayoutParameter()

The ILabelModelParameter used to describe the label's layout.

Returns:

The LayoutParameter.

See Also:

setLayoutParameter(ILabelModelParameter)

getPreferredSize

public final SizeD getPreferredSize()

The preferred size of the label.

Returns:

The PreferredSize.

See Also:

setPreferredSize(SizeD)

getStyle

public final ILabelStyle getStyle()

The style of this label.

Returns:

The Style.

See Also:

setStyle(ILabelStyle)

getTag

public final Object getTag()

The tag of the label.

Returns:

The Tag.

See Also:

setTag(Object)

getText

public final String getText()

The label's text.

Returns:

The Text.

See Also:

setText(String)

setLayoutParameter

public final void setLayoutParameter(ILabelModelParameter value)

The ILabelModelParameter used to describe the label's layout.

Parameters:

value - The LayoutParameter to set.

See Also:

getLayoutParameter()

setPreferredSize

public final void setPreferredSize(SizeD value)

The preferred size of the label.

Parameters:

value - The PreferredSize to set.

See Also:

getPreferredSize()

setStyle

public final void setStyle(ILabelStyle value)

The style of this label.

Parameters:

value - The Style to set.

See Also:

getStyle()

setTag

public final void setTag(Object value)

The tag of the label.

Parameters:

value - The Tag to set.

See Also:

getTag()

setText

public final void setText(String value)

The label's text.

Parameters:

value - The Text to set.

See Also:

getText()