VisualGraph (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.graph.view
Interface VisualGraph

All Superinterfaces:: LayoutableGraph, VisualGraphObjectContainer

All Known Subinterfaces:: VisualGraphView

public interface VisualGraph
extends VisualGraphObjectContainer, LayoutableGraph

This interface defines a view of a Graph model to which instances must always be attached. A GraphView is associated n:1 with this model object.

Objects of type Graph, Node and Edge represent the model entities in the graph domain. These entities may be associated on a one-to-many basis with objects whose types are used for the visualization inside a view. Simply put, each model class has a visual counterpart whose instances may reference exactly one model object.

The following class diagram shows the visual component structure and dependencies in the Tensegrity Graph Framework.

Constructing a VisualGraph and other visual objects is done by means of a GraphViewFactory, which will hide the particular implementation classes from client code.

The VisualGraph distinguishes among three kinds of VisualGraphObject classes:

A VisualNode defines nodes in the VisualGraph and corresponds to the Node in the model scope.
A VisualEdge defines connected edges in the VisualGraph and corresponds to the Edge in the model scope.
An Isolated VisualEdge defines unconnected edges and does not correspond to an Edge in the model scope, since the model can only represent connected edges.

When you add a VisualGraphObject to a view, its identifier is automatically assigned. Before adding, it, however, this identifier should be set to -1. Upon removal, this identifier will be reset to -1.

Each VisualGraphObject may only be added to at most one VisualGraph or VisualSubgraph at a time. Attempting to add the same object to more than one VisualGraph or VisualSubgraph will cause an exception to be thrown.

Besides adding and removing VisualNode and VisualEdge instances to and from a VisualGraph, you should be aware of a few notable methods defined in the VisualGraph interface:

deepCopy(com.tensegrity.graph.model.Graph) can be invoked on a VisualGraph to create a deep, independent copy of it.
setRuleRegistry(RuleRegistry) allows you to apply a RuleRegistry to a VisualGraph, thereby constraining the way a user interacts with and programmatically invokes objects. This helps you to customize applications with certain requirements that determine how a VisualGraph can be manipulated at runtime.
portsReassignment(com.tensegrity.graph.view.VisualPortAssignmentPredicate) allows processing of all ports in the VisualGraph. All ports are visited with the supplied visitor method and can be readjusted.

A visual graph type is closely coupled with the following graph model types:

Model object	Associated view object
`Graph`	`VisualGraph`
`GraphObject`	`VisualGraphObject`
`Node`	`VisualNode`
`Subgraph`	`VisualSubgraph`
`Edge`	`VisualEdge`
`Port`	`VisualPort`
`PortDenotation`	`VisualPortDenotation`

Every time a view object is added to a VisualGraph, an associated model object must be already present in the Graph model. Every time a VisualGraph object is removed, a model object must also be present as well. These conditions can be summarized as follows:

First add model objects, then add the associated view objects.
First remove view objects, then remove the associated model objects.

VisualGraph objects can be nested inside another VisualGraph to any depth whatsoever. This is possible because the interface specification for VisualSubgraph derives from the interface VisualNode.

It is possible to traverse a hierarchy of VisualSubgraph objects by invoking the method VisualGraphObjectContainer.visitSubgraphs(VisualGraphVisitor) and providing a custom callback object that implements interface VisualGraphVisitor. VisualSubgraph objects can be nested inside each other recursively. The nesting hierarchy, however, may not contain cycles.

Several methods in this interface specification are inherited from the base interface VisualGraphObjectContainer, which specifies generic handling of VisualGraph and VisualSubgraph objects.

It is recommended that you configure and customize the behavior of a VisualGraph by using the rules facility only. The rules package offers the most flexible way of configuring VisualGraphs.
Therefore a VisualGraph supports the registration of a RuleRegistry.
In the context of VisualGraphs client code should register an instance of a RuleRegistry ONLY at the top-level VisualGraphView. This RuleRegistry will be subsequently registered to all the added VisualGraphObjects and nested VisualSubgraphs automatically by the GraphAPI. This means that there can be only one active RuleRegistry within the entire hierarchy of VisualGraphs.
For further information about the usage please see the documentation of RuleRegistry.
The methods a VisualGraph provides in order to support the RuleRegistry are listed below:

RuleRegistry getRuleRegistry()
void setRuleRegistry(RuleRegistry)
void setRuleRegistry(RuleRegistry, boolean)

Any number of event listener instances may be added to a VisualGraph. Two types of event listeners are available. Instances of class VisualGraphListener listen for events in a single VisualGraph while VisualGraphEventMediator instances listen for events in the entire hierarchy of VisualGraph and nested VisualSubgraph objects.

The classes VisualNode and VisualEdge are the types managed by a VisualGraph.

Version:: $Id: VisualGraph.java,v 1.111 2005/06/09 13:06:18 AndreasEbbert Exp $
Author:: Stepan Rutz
See Also:: VisualGraphObjectContainer, VisualGraphView, VisualSubgraph, VisualGraphObject, VisualNode, VisualEdge, VisualPort, VisualPortDenotation, GraphViewFactory, Graph, GraphObject, Subgraph, Node, Edge, VisualGraphListener, RuleRegistry, VisualPortAssignmentPredicate, VisualGraphVisitor

Field Summary
`static int`	`EVENTQUEUEREQUEST_MASK_EDGESPLIT` Enumeration for marking events to be queued for the different type of events.
`static int`	`EVENTQUEUEREQUEST_MASK_ISOLATED_VISUALEDGE_ADDED` Enumeration for marking events to be queued for the different type of events.
`static int`	`EVENTQUEUEREQUEST_MASK_ISOLATED_VISUALEDGE_REMOVED` Enumeration for marking events to be queued for the different type of events.
`static int`	`EVENTQUEUEREQUEST_MASK_VISUALEDGE_ADDED` Enumeration for marking events to be queued for the different type of events.
`static int`	`EVENTQUEUEREQUEST_MASK_VISUALEDGE_REMOVED` Enumeration for marking events to be queued for the different type of events.
`static int`	`EVENTQUEUEREQUEST_MASK_VISUALNODE_ADDED` Enumeration for marking events to be queued for the different type of events.
`static int`	`EVENTQUEUEREQUEST_MASK_VISUALNODE_REMOVED` Enumeration for marking events to be queued for the different type of events.

Fields inherited from interface com.tensegrity.graph.view.VisualGraphObjectContainer

EVENT_MASK_EDGESPLIT, EVENT_MASK_ISOLATED_VISUALEDGE_ADDED, EVENT_MASK_ISOLATED_VISUALEDGE_PRE_ADD, EVENT_MASK_ISOLATED_VISUALEDGE_PRE_REMOVE, EVENT_MASK_ISOLATED_VISUALEDGE_REMOVED, EVENT_MASK_LAYOUT, EVENT_MASK_VISUALEDGE_ADDED, EVENT_MASK_VISUALEDGE_PRE_ADD, EVENT_MASK_VISUALEDGE_PRE_REMOVE, EVENT_MASK_VISUALEDGE_REMOVED, EVENT_MASK_VISUALNODE_ADDED, EVENT_MASK_VISUALNODE_DELETE_CASCADE, EVENT_MASK_VISUALNODE_PRE_ADD, EVENT_MASK_VISUALNODE_PRE_REMOVE, EVENT_MASK_VISUALNODE_REMOVED

Method Summary
`void`	`addAttributableOnSetListener(AttributableOnSetListener attributableOnSetListener)` Adds an attributeableOnSetListener to track attribute changes in all the elements of this `VisualGraph`.
`void`	`addVetoableVisualEventMediatorListener(VetoableVisualGraphEventMediatorListener listener)` Adds the `VetoableVisualGraphEventMediatorListener` given by `listener` to the `VisualGraph`'s internal structure of listeners that are notified when an event occurs.
`void`	`addVetoableVisualGraphListener(VetoableVisualGraphListener listener)` Adds the `VetoableVisualGraphListener` given by `listener` to the `VisualGraph`'s internal structure of listeners that are notified when an event occurs.
`void`	`addVisualEventMediatorListener(VisualGraphEventMediatorListener listener)` Adds the `VisualGraphEventMediatorListener` given by `listener` to the `VisualGraph`'s internal structure of listeners that are notified when an event occurs.
`void`	`addVisualGraphListener(VisualGraphListener listener)` Adds the `VisualGraphListener` given by `listener` to the `VisualGraph`'s internal structure of listeners that are notified when an event occurs.
`VisualGraph`	`deepCopy(Graph graph)` Makes a deep copy of the `VisualGraph` and registers the copy with the given `Graph`.
`VisualGraph`	`deepCopyWithoutNodesAndEdges(Graph graph)` Makes a deep copy of the `VisualGraph` and registers the copy with the given `Graph`.
`void`	`disableEventQueueRequests(int eventmask)` Disables all of the events specified in the given event mask.
`void`	`enableEventQueueRequests(int eventmask)` Enables all of the events specified in the given event mask.
`void`	`flushQueuedEvents()` When events were marked as queued events, they are internally gathered by the `VisualGraph`.
`Graph`	`getGraph()` Returns the reference to the `Graph` this `VisualGraph` is associated with.
`RuleRegistry`	`getRuleRegistry()` Gets the `RuleRegistry` that is the currently active set of rules for this `VisualGraph`.
`boolean`	`internalAddVisualNodeWithInteractionExecution(InteractionInfo info, VisualNode visualnode, boolean doEvent, boolean doRules, boolean useCursorPosition, int x, int y)` Notice: For internal use only.
`boolean`	`isVisualGraphListener(VisualGraphListener listener)` Queries whether a given listener is currently registered.
`void`	`portsReassignment(VisualPortAssignmentPredicate predicate)` Reassigns all ports of all edges to the desired port.
`void`	`removeAttributableOnSetListener(AttributableOnSetListener attributableOnSetListener)` Removes an attributeableOnSetListener to track attribute changes in all the elements of this `VisualGraph`.
`void`	`removeVetoableVisualEventMediatorListener(VetoableVisualGraphEventMediatorListener listener)` Removes the `VetoableVisualGraphEventMediatorListener` given by `listener` from the `VisualGraph`'s internal structure of listener so that he is no longer be notified about the occurrence of events.
`void`	`removeVetoableVisualGraphListener(VetoableVisualGraphListener listener)` Removes the `VetoableVisualGraphListener` given by `listener` from the `VisualGraph`'s internal structure of listener so that he is no longer be notified about the occurrence of events.
`void`	`removeVisualEventMediatorListener(VisualGraphEventMediatorListener listener)` Removes the `VisualGraphEventMediatorListener` given by `listener` from the `VisualGraph`'s internal structure of listener so that he is no longer be notified about the occurrence of events.
`void`	`removeVisualGraphListener(VisualGraphListener listener)` Removes the `VisualGraphListener` given by `listener` from the `VisualGraph`'s internal structure of listener so that he is no longer be notified about the occurrence of events
`void`	`setRuleRegistry(RuleRegistry ruleregistry)` Sets a `RuleRegistry` as the currently active set of rules for this `VisualGraph`.
`void`	`setRuleRegistry(RuleRegistry ruleregistry, boolean preserveAssignedRules)` Sets a `RuleRegistry` as the currently active set of rules for this `VisualGraph`.
`void`	`updateEdges()` Updates all edges.

Methods inherited from interface com.tensegrity.graph.view.VisualGraphObjectContainer

addIsolatedVisualEdge, addVisualEdge, addVisualNode, disableVisualGraphEvents, enableVisualGraphEvents, getAllVisualEdges, getGraphObjectContainer, getIsolatedVisualEdgeByID, getIsolatedVisualEdgeCount, getIsolatedVisualEdges, getIsolatedVisualEdgesCollection, getParentContainer, getRootContainer, getVisualEdgeByID, getVisualEdgeCount, getVisualEdges, getVisualEdgesCollection, getVisualGraphEventmask, getVisualGraphObjects, getVisualNodeByID, getVisualNodeByName, getVisualNodeCount, getVisualNodes, getVisualNodesCollection, getVisualPortByID, removeIsolatedVisualEdge, removeVisualEdge, removeVisualNode, specificPortReassignmentVisualEdge, specificPortReassignmentVisualEdge, specificPortReassignmentVisualEdgeSource, specificPortReassignmentVisualEdgeTarget, startBulkModify, stopBulkModify, visitSubgraphs

Field Detail