C

FoldingPortState
abstract

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

Remarks

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

This class cannot be instantiated

Examples

Ports at folder nodes should be retrieved from the ports collection of its owner.

const state = manager.getFolderNodeState(masterNode)
const portState = state.ports.get(0)
portState.locationParameter = FreeNodePortLocationModel.TOP

The source and target ports of an edge should be retrieved from the sourcePort and targetPort properties of the edge.

const state = manager.getFoldingEdgeState(
  new FoldingEdgeStateId(
    masterEdge,
    masterSource,
    true,
    masterTarget,
    false,
  ),
)
const portState = state.sourcePort
portState.locationParameter = FreeNodePortLocationModel.RIGHT

See Also

Developer's Guide

API

sourcePort, targetPort, ports, getFoldingPortState

Members

Show:

Properties

labels

: IListEnumerable<FoldingLabelState>
readonly
Gets the FoldingLabelStates owned by this state.
readonly

Examples

const state = manager.getFolderNodeState(masterNode)
const labelState = state.labels.get(0)
labelState.text = 'New Label Text'
const state = manager.getFolderNodeState(masterNode)
const labelState = state.labels.get(0)
labelState.text = 'New Label Text'

locationParameter

: IPortLocationModelParameter
Gets or sets the IPortLocationModelParameter describing the position of this port.

style

: IPortStyle
Gets or sets the style of this port.

tag

: IPort['tag']
abstract
Gets or sets the tag of the port.

type

: FoldingPortType
readonlyabstract
Gets the type of port this state represents.

Methods

addLabel

(
text: string
layoutParameter?: ILabelModelParameter
style?: ILabelStyle
preferredSize?: Size
tag?: ILabel['tag']
): FoldingLabelState
abstract
Adds a FoldingLabelState to this state.
abstract

Parameters

text: string
The text of the new label.
layoutParameter?: ILabelModelParameter
The layout parameter of the new label.
style?: ILabelStyle
The style of the new label.
preferredSize?: Size
The preferred size of the label.
tag?: ILabel['tag']
The tag of the label.

Return Value

FoldingLabelState
The newly added FoldingLabelState.

Examples

const state = manager.getFolderNodeState(masterNode)
const style = new LabelStyle()
state.addLabel(
  'Folder Label',
  InteriorNodeLabelModel.TOP_RIGHT,
  style,
  new Size(20, 10),
)

asPort

(): IPort
abstract
Returns an IPort instance which represents this port state.
The returned port is not present in any graph but may be passed to getViewItem to get the port state's view port in the folding view graph.
abstract

Return Value

IPort
An IPort instance which represents this port state.

clearLabels

()
Removes all labels.

removeLabel

(label: FoldingLabelState)
abstract
Removes the label from its owning FoldingLabelOwnerState.
abstract

Parameters

label: FoldingLabelState
The label to remove.