com.yworks.yfiles.graph

Class FoldingEdgeState

java.lang.Object

com.yworks.yfiles.graph.FoldingLabelOwnerState

com.yworks.yfiles.graph.FoldingEdgeState

public final class FoldingEdgeState
extends FoldingLabelOwnerState

A data container representing the state of an edge whose source and/or target node are collapsed.

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

See Also:

FoldingEdgeStateId, FoldingManager.getFoldingEdgeState(FoldingEdgeStateId)

Method Summary

Modifier and Type	Method and Description
FoldingBendState	addBend(PointD location) Adds a new FoldingBendState to this edge state at the given index and location.
FoldingBendState	addBend(PointD location, int index) Adds a new FoldingBendState to this edge state at the given index and location.
FoldingLabelState	addLabel(String text, ILabelModelParameter layoutParameter, ILabelStyle style, SizeD preferredSize, Object tag) Adds a FoldingLabelState to this state.
IEdge	asEdge() Returns an IEdge instance which represents this edge state.
void	clearBends() Removes all Bends.
FoldingEdgeState	clone()
IListEnumerable<FoldingBendState>	getBends() The FoldingBendStates of this state.
FoldingPortState	getSourcePort() The FoldingPortState which represents the source port of this edge state.
IEdgeStyle	getStyle() The style of this edge.
Object	getTag() The tag of the edge.
FoldingPortState	getTargetPort() The FoldingPortState which represents the target port of this edge state.
void	remove(FoldingBendState bend) Removes the bend from this edge state.
void	remove(FoldingLabelState label) Removes the label from its owning FoldingLabelOwnerState.
void	setStyle(IEdgeStyle value) The style of this edge.
void	setTag(Object value) The tag of the edge.

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

clearLabels, getLabels

Methods inherited from class java.lang.Object

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

Method Detail

addBend

public final FoldingBendState addBend(PointD location)

Adds a new FoldingBendState to this edge state at the given index and location.

Parameters:

location - The location of the new bend state.

Returns:

The newly added bend state.

addBend

public final FoldingBendState addBend(PointD location,
                                      int index)

Adds a new FoldingBendState to this edge state at the given index and location.

Parameters:

location - The location of the new bend state.

index - The index the bend state shall be inserted in the Bends; a negative value (which is the default) indicates that the bend should be appended to the end of the list of bends.

Returns:

The newly added bend state.

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.

asEdge

public final IEdge asEdge()

Returns an IEdge instance which represents this edge state.

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

Returns:

An IEdge instance which represents this edge state.

clearBends

public final void clearBends()

Removes all Bends.

clone

public final FoldingEdgeState clone()

Overrides:

clone in class Object

getBends

public final IListEnumerable<FoldingBendState> getBends()

The FoldingBendStates of this state.

Returns:

The Bends.

getSourcePort

public final FoldingPortState getSourcePort()

The FoldingPortState which represents the source port of this edge state.

Returns:

The SourcePort.

getStyle

public final IEdgeStyle getStyle()

The style of this edge.

Returns:

The Style.

See Also:

setStyle(IEdgeStyle)

getTag

public final Object getTag()

The tag of the edge.

Returns:

The Tag.

See Also:

setTag(Object)

getTargetPort

public final FoldingPortState getTargetPort()

The FoldingPortState which represents the target port of this edge state.

Returns:

The TargetPort.

remove

public final void remove(FoldingBendState bend)

Removes the bend from this edge state.

Throws:

IllegalArgumentException - Thrown if the bend doesn't belong to this edge state.

Parameters:

bend - The bend to remove.

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.

setStyle

public final void setStyle(IEdgeStyle value)

The style of this edge.

Parameters:

value - The Style to set.

See Also:

getStyle()

setTag

public final void setTag(Object value)

The tag of the edge.

Parameters:

value - The Tag to set.

See Also:

getTag()