JUNG (Java Universal Network/Graph Framework)

The AnnotatingGraphMousePlugin allows users to interactively add text and shape annotations to a graph visualization using mouse gestures. It integrates with a VisualizationViewer to handle rendering and input.

Interaction Patterns

• Text Annotations: Triggered by a popup event (e.g., right-click) which prompts the user for a string via a dialog.
• Shape Annotations: Created by clicking and dragging (using the primary selection modifier). The plugin draws a transient rectangle while dragging and converts it into a permanent Shape annotation upon release.
• Removing Annotations: Triggered by using the additionalModifiers (e.g., BUTTON1_MASK | SHIFT_MASK) while clicking on an existing annotation.

Configuration

• Annotation Color: Set via setAnnotationColor(Color).
• Layering: Annotations can be placed in different layers using setLayer(Annotation.Layer). Available layers are defined in Annotation.Layer (e.g., LOWER).
• Fill: Toggle whether shape annotations are filled using setFill(boolean).

// Example initialization with a RenderContext
AnnotatingGraphMousePlugin<N, E> plugin = new AnnotatingGraphMousePlugin<>(renderContext);

// Customize appearance
plugin.setAnnotationColor(Color.RED);
plugin.setFill(true);
plugin.setLayer(Annotation.Layer.LOWER);

// Add the plugin to your VisualizationViewer
viewer.addMouseListener(plugin);
viewer.addMouseMotionListener(plugin);

The GraphZoomScrollPane provides methods to access its internal UI components for further customization:

• getHorizontalScrollBar(): Returns the JScrollBar used for horizontal panning.
• getVerticalScrollBar(): Returns the JScrollBar used for vertical panning.
• getCorner(): Returns the JComponent located at the intersection of the horizontal and vertical scrollbars (the lower-right corner).
• setCorner(JComponent corner): Allows you to replace the default corner component with a custom one (e.g., a button or menu). The component's preferred size will be automatically set to match the scrollbar widths.

GraphZoomScrollPane scrollPane = new GraphZoomScrollPane(vv);

// Access scrollbars
JScrollBar hBar = scrollPane.getHorizontalScrollBar();
JScrollBar vBar = scrollPane.getVerticalScrollBar();

// Set a custom corner component
JButton customButton = new JButton("!");
scrollPane.setCorner(customButton);

When working with a MutableCTreeNetwork<N, E>, you can navigate and manipulate the tree hierarchy using the following methods:

Hierarchy Navigation

• root(): Returns an Optional<N> containing the root node of the tree.
• predecessor(N node): Returns an Optional<N> containing the parent of the specified node. Since it is a tree, a node has at most one predecessor.
• inEdge(N node): Returns an Optional<E> containing the edge connecting the node to its parent.
• depth(N node): Returns the integer depth of the node (distance from the root).
• height(): Returns an Optional<Integer> representing the maximum depth of the tree.

Structural Modification

• addNode(N node): Adds a node. If no root exists, the first node added becomes the root.
• addEdge(N nodeU, N nodeV, E edge): Adds a directed edge from nodeU to nodeV. nodeV must not already exist in the tree (unless it is the root being established).
• removeNode(N node): Removes the specified node and all its descendants (the entire subtree).
• removeEdge(E edge): Removes the specified edge and the entire subtree rooted at the edge's target node.

The PickingGraphMousePlugin is a control plugin for VisualizationViewer that enables users to select nodes and edges using mouse input.

Default Behavior:

• Single Selection: Clicking a node or edge with the primary mouse button (default BUTTON1_MASK) selects that element. If no element is clicked, it clears existing selections and prepares for a multi-selection rectangle.
• Additive Selection: Using the secondary modifier (default SHIFT_MASK + BUTTON1_MASK) adds elements to the current selection. If an already selected element is clicked, it is deselected.
• Multi-Selection: Dragging the mouse without clicking an element draws a selection rectangle (the "lens") to pick all nodes contained within that area.
• Repositioning: If a node is selected and dragged, the node will be repositioned in the layout to follow the mouse.

Customization:

• Modifiers: You can specify custom selectionModifiers and addToSelectionModifiers via the constructor.
• Lens Color: The color of the selection rectangle can be changed using setLensColor(Color).
• Locking: Use setLocked(boolean) to control whether nodes can be moved via dragging.

// Default constructor uses BUTTON1 for selection and SHIFT+BUTTON1 for additive selection
PickingGraphMousePlugin<N, E> plugin = new PickingGraphMousePlugin<>();

// Custom modifiers (e.g., using CTRL instead of SHIFT)
// selectionModifiers: primary selection
// addToSelectionModifiers: additive selection
PickingGraphMousePlugin<N, E> customPlugin = new PickingGraphMousePlugin(
    InputEvent.CTRL_DOWN_MASK, 
    InputEvent.CTRL_DOWN_MASK | InputEvent.SHIFT_DOWN_MASK
);

// Change the selection rectangle color
plugin.setLensColor(Color.RED);

// Prevent nodes from being moved by dragging
plugin.setLocked(true);