com.yworks.yfiles.graph

Class FoldingPortState

java.lang.Object

com.yworks.yfiles.graph.FoldingPortState

public abstract class FoldingPortState
extends Object

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

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

See Also:

FoldingEdgeState.getSourcePort(), FoldingEdgeState.getTargetPort(), FolderNodeState.getPorts(), FolderNodeState.getFoldingPortState(IPort)

Method Summary

Modifier and Type	Method and Description
abstract IPort	asPort() Returns an IPort instance which represents this port state.
IPortLocationModelParameter	getLocationParameter() The IPortLocationModelParameter describing the position of this port.
IPortStyle	getStyle() The style of this port.
abstract Object	getTag() The tag of the port.
void	setLocationParameter(IPortLocationModelParameter value) The IPortLocationModelParameter describing the position of this port.
void	setStyle(IPortStyle value) The style of this port.
abstract void	setTag(Object value) The tag of the port.

Methods inherited from class java.lang.Object

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

Method Detail

asPort

public abstract IPort asPort()

Returns an IPort instance which represents this port state.

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

Returns:

An IPort instance which represents this port state.

getLocationParameter

public IPortLocationModelParameter getLocationParameter()

The IPortLocationModelParameter describing the position of this port.

Returns:

The LocationParameter.

See Also:

setLocationParameter(IPortLocationModelParameter)

getStyle

public IPortStyle getStyle()

The style of this port.

Returns:

The Style.

See Also:

setStyle(IPortStyle)

getTag

public abstract Object getTag()

The tag of the port.

Returns:

The Tag.

See Also:

setTag(Object)

setLocationParameter

public void setLocationParameter(IPortLocationModelParameter value)

The IPortLocationModelParameter describing the position of this port.

Parameters:

value - The LocationParameter to set.

See Also:

getLocationParameter()

setStyle

public void setStyle(IPortStyle value)

The style of this port.

Parameters:

value - The Style to set.

See Also:

getStyle()

setTag

public abstract void setTag(Object value)

The tag of the port.

Parameters:

value - The Tag to set.

See Also:

getTag()