com.yworks.yfiles.server.graphml.folding
Class EdgeViewState

java.lang.Object
  com.yworks.yfiles.server.graphml.folding.EdgeViewState

All Implemented Interfaces:

IMarkupExtensionFactory

public class EdgeViewState

extends java.lang.Object

implements IMarkupExtensionFactory

Data object that describes the visual appearance of a dummy edge in a folded graph.

The style, labels, bends and ports of a dummy edge may differ from the visual appearance of the master edge.

See Also:

DummyEdgeId, FoldingSupport.getEdgeViewState(y.base.Graph, DummyEdgeId), FoldedLayoutGraph.getEdgeViewState(DummyEdgeId)

Constructor Summary

EdgeViewState()
Creates a new instance for a dummy edge that isn't connected to any dummy edge ports, yet.

EdgeViewState(Port sourcePort, Port targetPort, IEdgeStyle style)
Creates a new instance for a dummy edge connected to the passed source and target ports that has the passed edge style.

Method Summary

MarkupExtension	createMarkupExtension(Lookup lookup) Creates a markup extension that can be used instead of the original class.
YList	getBends() A list of Bend instances that define the geometric shape of the dummy edge.
YList	getLabels() A list of Label instances that define the labels associated with the dummy edge.
Port	getSourcePort() A Port instance that defines the source port location of the dummy edge.
IEdgeStyle	getStyle() The style that defines the visual appearance of the dummy edge.
java.lang.Object	getTag() The user tag assigned to this edge view state.
Port	getTargetPort() A Port instance that defines the target port location of the dummy edge.
void	setSourcePort(Port sourcePort) A Port instance that defines the source port location of the dummy edge.
void	setStyle(IEdgeStyle style) The style that defines the visual appearance of the dummy edge.
void	setTag(java.lang.Object tag) The user tag assigned to this edge view state.
void	setTargetPort(Port targetPort) A Port instance that defines the target port location of the dummy edge.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeViewState

public EdgeViewState()

Creates a new instance for a dummy edge that isn't connected to any dummy edge ports, yet.

EdgeViewState

public EdgeViewState(Port sourcePort,
                     Port targetPort,
                     IEdgeStyle style)

Creates a new instance for a dummy edge connected to the passed source and target ports that has the passed edge style.

Parameters:

sourcePort - The source port of the dummy edge.

targetPort - The target port of the dummy edge.

style - The edge style of the dummy edge.

Method Detail

getLabels

public YList getLabels()

A list of Label instances that define the labels associated with the dummy edge.

See Also:

Label

getStyle

public IEdgeStyle getStyle()

The style that defines the visual appearance of the dummy edge.

setStyle

public void setStyle(IEdgeStyle style)

The style that defines the visual appearance of the dummy edge.

getBends

public YList getBends()

A list of Bend instances that define the geometric shape of the dummy edge.

See Also:

Bend

getSourcePort

public Port getSourcePort()

A Port instance that defines the source port location of the dummy edge.

setSourcePort

public void setSourcePort(Port sourcePort)

A Port instance that defines the source port location of the dummy edge.

getTargetPort

public Port getTargetPort()

A Port instance that defines the target port location of the dummy edge.

setTargetPort

public void setTargetPort(Port targetPort)

A Port instance that defines the target port location of the dummy edge.

createMarkupExtension

public MarkupExtension createMarkupExtension(Lookup lookup)

Description copied from interface: IMarkupExtensionFactory

Creates a markup extension that can be used instead of the original class.

Specified by:

createMarkupExtension in interface IMarkupExtensionFactory

Parameters:

lookup - The lookup that shall be considered when creating the markup extension.

getTag

public java.lang.Object getTag()

The user tag assigned to this edge view state.

setTag

public void setTag(java.lang.Object tag)

The user tag assigned to this edge view state.