com.yworks.yfiles.graph

Class EdgeEventArgs

java.lang.Object

com.yworks.yfiles.utils.ItemEventArgs<IEdge>

com.yworks.yfiles.graph.EdgeEventArgs

All Implemented Interfaces:

IEventArgs

public final class EdgeEventArgs
extends ItemEventArgs<IEdge>

A specialized subclass of the ItemEventArgs class that is bound to the IEdge type and carries additional source and target port information.

Since for some events (EdgePortsChanged and EdgeRemoved) it is unclear what SourcePort and TargetPort the edge had been connected to before the event, this event can be used to carry exactly that information.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
EdgeEventArgs(IEdge edge) Initializes a new instance of the EdgeEventArgs class.
EdgeEventArgs(IEdge edge, IPort source, IPort target) Initializes a new instance of the EdgeEventArgs class.
EdgeEventArgs(IEdge edge, IPort source, IPort target, IPortOwner sourceOwner, IPortOwner targetOwner) Initializes a new instance of the EdgeEventArgs class.

Method Summary

Modifier and Type	Method and Description
IPort	getSourcePort() Gets the source port the edge was connected to before the event happened.
IPortOwner	getSourcePortOwner() Gets the owner of the source port the edge was connected to before the event happened.
IPort	getTargetPort() Gets the target port the edge was connected to before the event happened.
IPortOwner	getTargetPortOwner() Gets the owner of the target port the edge was connected to before the event happened.

Methods inherited from class com.yworks.yfiles.utils.ItemEventArgs

getItem

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeEventArgs

public EdgeEventArgs(IEdge edge)

Initializes a new instance of the EdgeEventArgs class.

Parameters:

edge - The edge to assign to the Item property.

EdgeEventArgs

public EdgeEventArgs(IEdge edge,
                     IPort source,
                     IPort target)

Initializes a new instance of the EdgeEventArgs class.

Parameters:

edge - The edge to assign to the Item property.

source - The source port the edge was connected to before the event happened.

target - The target port the edge was connected to before the event happened.

EdgeEventArgs

public EdgeEventArgs(IEdge edge,
                     IPort source,
                     IPort target,
                     IPortOwner sourceOwner,
                     IPortOwner targetOwner)

Initializes a new instance of the EdgeEventArgs class.

Parameters:

edge - The edge to assign to the Item property.

source - The source port the edge was connected to before the event happened.

target - The target port the edge was connected to before the event happened.

sourceOwner - The owner of the source port the edge was connected to before the event happened.

targetOwner - The owner of the target port the edge was connected to before the event happened.

Method Detail

getSourcePort

public final IPort getSourcePort()

Gets the source port the edge was connected to before the event happened.

Returns:

The old source port.

getSourcePortOwner

public final IPortOwner getSourcePortOwner()

Gets the owner of the source port the edge was connected to before the event happened.

Returns:

The owner of the old source port.

getTargetPort

public final IPort getTargetPort()

Gets the target port the edge was connected to before the event happened.

Returns:

The old target port.

getTargetPortOwner

public final IPortOwner getTargetPortOwner()

Gets the owner of the target port the edge was connected to before the event happened.

Returns:

The owner of the old target port.