com.yworks.yfiles.graph

Class FoldingLabelOwnerState

java.lang.Object

com.yworks.yfiles.graph.FoldingLabelOwnerState

Direct Known Subclasses:

FolderNodeState, FoldingEdgeState

public abstract class FoldingLabelOwnerState
extends Object

An abstract base class for data containers representing the state of model items which can own labels.

Developers should not extend this class. Only instances of its subclasses FolderNodeState and FoldingEdgeState are supported.

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

See Also:

FolderNodeState, FoldingEdgeState, FoldingLabelState

Constructor Summary

Constructors

Constructor and Description
FoldingLabelOwnerState()

Method Summary

Modifier and Type	Method and Description
abstract FoldingLabelState	addLabel(String text, ILabelModelParameter layoutParameter, ILabelStyle style, SizeD preferredSize, Object tag) Adds a FoldingLabelState to this state.
void	clearLabels() Removes all Labels.
IListEnumerable<FoldingLabelState>	getLabels() The FoldingLabelStates owned by this state.
abstract void	remove(FoldingLabelState label) Removes the label from its owning FoldingLabelOwnerState.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoldingLabelOwnerState

public FoldingLabelOwnerState()

Method Detail

addLabel

public abstract FoldingLabelState addLabel(String text,
                                           ILabelModelParameter layoutParameter,
                                           ILabelStyle style,
                                           SizeD preferredSize,
                                           Object tag)

Adds a FoldingLabelState to this state.

Parameters:

text - The text of the new label.

layoutParameter - The layout parameter of the new label.

style - The style of the new label.

preferredSize - The preferred size of the label.

tag - The tag of the label.

Returns:

The newly added FoldingLabelState.

clearLabels

public final void clearLabels()

Removes all Labels.

getLabels

public final IListEnumerable<FoldingLabelState> getLabels()

The FoldingLabelStates owned by this state.

Returns:

The Labels.

remove

public abstract void remove(FoldingLabelState label)

Removes the label from its owning FoldingLabelOwnerState.

Parameters:

label - The label to remove.