diva.canvas.connector
Class ConnectorEvent

java.lang.Object
  java.util.EventObject
      diva.canvas.connector.ConnectorEvent

All Implemented Interfaces:

java.io.Serializable

public class ConnectorEvent
extends java.util.EventObject

A graph event that is emitted when anything interesting happens inside a graph by way of a GraphModel. Each graph event contains an ID, a source, and a previous value for all changes and deletions, the specifics of which are described on a case-by-case basis below.

Version:

$Id: ConnectorEvent.java 38798 2005-07-08 20:00:01Z cxh $

Author:

Michael Shilman, John Reekie, Contributor: Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red

Field Summary

private Connector	_connector The connector that is being operated on.
private int	_end The end this event concerns.
private int	_id The event ID.
private Figure	_target The target figure
static int	BOTH_ENDS This event is concerns both ends of the connector.
static int	CONNECTOR_DRAGGED Signifies that a connector is dragged some distance
static int	CONNECTOR_DROPPED Signifies that a connector end is dropped.
static int	CONNECTOR_SNAPPED Signifies that a connector end is snapped to a possible target.
static int	CONNECTOR_UNSNAPPED Signifies that a connector end is unsnapped from the original site that it was attached to, or from a possible target.
static int	HEAD_END This event concerns the head end of the connector.
static int	MIDPOINT This event is concerns the midpoint of the connector.
static int	TAIL_END This event concerns the tail end of the connector.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ConnectorEvent(int id, java.lang.Object source, Figure target, Connector connector, int end)
Construct a ConnectorEvent with the given source, target, connector, and "end" flag.

Method Summary

private java.lang.String	endToString() Return a string representation of the endpoint.
Connector	getConnector() Return the connector that this event concerns.
int	getEnd() Return the end of the connector that this event concerns.
int	getID() Return the type id for this event.
Figure	getTarget() Return the target that the connector is snapped to or unsnapped from.
private java.lang.String	idToString() Return a string representation of the ID.
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTOR_DRAGGED

public static final int CONNECTOR_DRAGGED

Signifies that a connector is dragged some distance

See Also:

Constant Field Values

CONNECTOR_DROPPED

public static final int CONNECTOR_DROPPED

Signifies that a connector end is dropped. If the connector is currently snapped to a target, the target can be obtained from the event as the source field.

See Also:

Constant Field Values

CONNECTOR_SNAPPED

public static final int CONNECTOR_SNAPPED

Signifies that a connector end is snapped to a possible target.

See Also:

Constant Field Values

CONNECTOR_UNSNAPPED

public static final int CONNECTOR_UNSNAPPED

Signifies that a connector end is unsnapped from the original site that it was attached to, or from a possible target.

See Also:

Constant Field Values

HEAD_END

public static final int HEAD_END

This event concerns the head end of the connector.

See Also:

getEnd(), Constant Field Values

TAIL_END

public static final int TAIL_END

This event concerns the tail end of the connector.

See Also:

getEnd(), Constant Field Values

BOTH_ENDS

public static final int BOTH_ENDS

This event is concerns both ends of the connector.

See Also:

getEnd(), Constant Field Values

MIDPOINT

public static final int MIDPOINT

This event is concerns the midpoint of the connector.

See Also:

getEnd(), Constant Field Values

_id

private int _id

The event ID.

See Also:

getID()

_end

private int _end

The end this event concerns.

See Also:

getEnd()

_target

private Figure _target

The target figure

See Also:

getTarget()

_connector

private Connector _connector

The connector that is being operated on.

See Also:

getConnector()

Constructor Detail

ConnectorEvent

public ConnectorEvent(int id,
                      java.lang.Object source,
                      Figure target,
                      Connector connector,
                      int end)

Construct a ConnectorEvent with the given source, target, connector, and "end" flag. The source is the layer in which the connector exists, while the target is the figure that the connector is snapped to or unsnapped from.

Method Detail

getConnector

public Connector getConnector()

Return the connector that this event concerns.

getEnd

public int getEnd()

Return the end of the connector that this event concerns.

getID

public int getID()

Return the type id for this event.

getTarget

public Figure getTarget()

Return the target that the connector is snapped to or unsnapped from.

idToString

private java.lang.String idToString()

Return a string representation of the ID.

endToString

private java.lang.String endToString()

Return a string representation of the endpoint.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject