com.yworks.yfiles.graph

Class FolderNodeState

java.lang.Object

com.yworks.yfiles.graph.FoldingLabelOwnerState

com.yworks.yfiles.graph.FolderNodeState

public final class FolderNodeState
extends FoldingLabelOwnerState

A data container representing the collapsed state of a node.

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

See Also:

FoldingManager.getFolderNodeState(INode)

Method Summary

Modifier and Type	Method and Description
FoldingLabelState	addLabel(String text, ILabelModelParameter layoutParameter, ILabelStyle style, SizeD preferredSize, Object tag) Adds a FoldingLabelState to this state.
INode	asNode() Returns an INode instance which represents this folder node state.
FoldingPortState	getFoldingPortState(IPort masterPort) Provides access to the folding state of a master port.
IRectangle	getLayout() The layout of the node.
IListEnumerable<FoldingPortState>	getPorts() The FoldingPortStates owned by this state.
INodeStyle	getStyle() The style of this node.
Object	getTag() The tag of the node.
void	remove(FoldingLabelState label) Removes the label from its owning FoldingLabelOwnerState.
void	setLayout(IRectangle value) The layout of the node.
void	setStyle(INodeStyle value) The style of this node.
void	setTag(Object value) The tag of the node.

Methods inherited from class com.yworks.yfiles.graph.FoldingLabelOwnerState

clearLabels, getLabels

Methods inherited from class java.lang.Object

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

Method Detail

addLabel

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

Description copied from class: FoldingLabelOwnerState

Adds a FoldingLabelState to this state.

Specified by:

addLabel in class FoldingLabelOwnerState

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.

asNode

public final INode asNode()

Returns an INode instance which represents this folder node state.

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

Returns:

An INode instance which represents this folder node state.

getFoldingPortState

public final FoldingPortState getFoldingPortState(IPort masterPort)

Provides access to the folding state of a master port.

This method can be used to query the folding state of a port at the folder which is represented by this state.

Parameters:

masterPort - The master port for which the state should be returned.

Returns:

A state holder implementation of the masterPort, which reflects the port in the node's collapsed state.

See Also:

FoldingPortState.getStyle(), FoldingPortState.getLocationParameter()

getLayout

public final IRectangle getLayout()

The layout of the node.

Returns:

The Layout.

See Also:

setLayout(IRectangle)

getPorts

public final IListEnumerable<FoldingPortState> getPorts()

The FoldingPortStates owned by this state.

Returns:

The Ports.

getStyle

public final INodeStyle getStyle()

The style of this node.

Returns:

The Style.

See Also:

setStyle(INodeStyle)

getTag

public final Object getTag()

The tag of the node.

Returns:

The Tag.

See Also:

setTag(Object)

remove

public void remove(FoldingLabelState label)

Description copied from class: FoldingLabelOwnerState

Removes the label from its owning FoldingLabelOwnerState.

Specified by:

remove in class FoldingLabelOwnerState

Parameters:

label - The label to remove.

setLayout

public final void setLayout(IRectangle value)

The layout of the node.

Parameters:

value - The Layout to set.

See Also:

getLayout()

setStyle

public final void setStyle(INodeStyle value)

The style of this node.

Parameters:

value - The Style to set.

See Also:

getStyle()

setTag

public final void setTag(Object value)

The tag of the node.

Parameters:

value - The Tag to set.

See Also:

getTag()