AnnotatingGraphMousePlugin

java.lang.Object
- edu.uci.ics.jung.visualization.control.AbstractGraphMousePlugin
- - edu.uci.ics.jung.visualization.annotations.AnnotatingGraphMousePlugin<V,E>

All Implemented Interfaces:

GraphMousePlugin, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.util.EventListener
```
public class AnnotatingGraphMousePlugin<V,E>
extends AbstractGraphMousePlugin
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener
```
AnnotatingGraphMousePlugin can create Shape and Text annotations in a layer of the graph visualization.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`added` set to true when the AnnotationPaintable has been added to the view component
`protected int`	`additionalModifiers` additional modifiers for the action of adding to an existing selection
`protected java.awt.Color`	`annotationColor` color for annotations
`protected AnnotationManager`	`annotationManager` a Paintable to store all Annotations
`protected MultiLayerTransformer`	`basicTransformer` holds rendering transforms
`protected boolean`	`fill`
`protected Annotation.Layer`	`layer` layer for annotations
`protected VisualizationServer.Paintable`	`lensPaintable` the Paintable for the Shape annotation
`protected RenderContext<V,E>`	`rc` holds rendering settings
`protected java.awt.geom.RectangularShape`	`rectangularShape` used to draw a Shape annotation

Fields inherited from class edu.uci.ics.jung.visualization.control.AbstractGraphMousePlugin
cursor, down, modifiers

Constructor Summary

Constructors
Constructor and Description
`AnnotatingGraphMousePlugin(RenderContext<V,E> rc)` create an instance with default settings
`AnnotatingGraphMousePlugin(RenderContext<V,E> rc, int selectionModifiers, int additionalModifiers)` create an instance with overides

Method Summary

Methods
Modifier and Type	Method and Description
`java.awt.Color`	`getAnnotationColor()`
`Annotation.Layer`	`getLayer()`
`java.awt.geom.RectangularShape`	`getRectangularShape()`
`boolean`	`isFill()`
`void`	`mouseClicked(java.awt.event.MouseEvent e)`
`void`	`mouseDragged(java.awt.event.MouseEvent e)` Draws the transient Paintable that will become a Shape annotation when the mouse button is released
`void`	`mouseEntered(java.awt.event.MouseEvent e)`
`void`	`mouseExited(java.awt.event.MouseEvent e)`
`void`	`mouseMoved(java.awt.event.MouseEvent e)`
`void`	`mousePressed(java.awt.event.MouseEvent e)` Sets the location for an Annotation.
`void`	`mouseReleased(java.awt.event.MouseEvent e)` Completes the process of adding a Shape annotation and removed the transient paintable
`void`	`setAnnotationColor(java.awt.Color lensColor)`
`void`	`setFill(boolean fill)`
`void`	`setLayer(Annotation.Layer layer)`
`void`	`setRectangularShape(java.awt.geom.RectangularShape rect)`

Methods inherited from class edu.uci.ics.jung.visualization.control.AbstractGraphMousePlugin
checkModifiers, getCursor, getModifiers, setCursor, setModifiers

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - additionalModifiers
```
protected int additionalModifiers
```
    additional modifiers for the action of adding to an existing selection
  - rectangularShape
```
protected java.awt.geom.RectangularShape rectangularShape
```
    used to draw a Shape annotation
  - lensPaintable
```
protected VisualizationServer.Paintable lensPaintable
```
    the Paintable for the Shape annotation
  - annotationManager
```
protected AnnotationManager annotationManager
```
    a Paintable to store all Annotations
  - annotationColor
```
protected java.awt.Color annotationColor
```
    color for annotations
  - layer
```
protected Annotation.Layer layer
```
    layer for annotations
  - fill
```
protected boolean fill
```
  - basicTransformer
```
protected MultiLayerTransformer basicTransformer
```
    holds rendering transforms
  - rc
```
protected RenderContext<V,E> rc
```
    holds rendering settings
  - added
```
protected boolean added
```
    set to true when the AnnotationPaintable has been added to the view component
- Constructor Detail
  - AnnotatingGraphMousePlugin
```
public AnnotatingGraphMousePlugin(RenderContext<V,E> rc)
```
    create an instance with default settings
  - AnnotatingGraphMousePlugin
```
public AnnotatingGraphMousePlugin(RenderContext<V,E> rc,
                          int selectionModifiers,
                          int additionalModifiers)
```
    create an instance with overides
    
    Parameters:
    selectionModifiers - for primary selection
    additionalModifiers - for additional selection
- Method Detail
  - getAnnotationColor
```
public java.awt.Color getAnnotationColor()
```
    Returns:
    Returns the lensColor.
  - setAnnotationColor
```
public void setAnnotationColor(java.awt.Color lensColor)
```
    Parameters:
    lensColor - The lensColor to set.
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Sets the location for an Annotation. Will either pop up a dialog to prompt for text input for a text annotation, or begin the process of drawing a Shape annotation
    
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
    
    Parameters:
    e - the event
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Completes the process of adding a Shape annotation and removed the transient paintable
    
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Draws the transient Paintable that will become a Shape annotation when the mouse button is released
    
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
  - getRectangularShape
```
public java.awt.geom.RectangularShape getRectangularShape()
```
    Returns:
    the rect
  - setRectangularShape
```
public void setRectangularShape(java.awt.geom.RectangularShape rect)
```
    Parameters:
    rect - the rect to set
  - getLayer
```
public Annotation.Layer getLayer()
```
    Returns:
    the layer
  - setLayer
```
public void setLayer(Annotation.Layer layer)
```
    Parameters:
    layer - the layer to set
  - isFill
```
public boolean isFill()
```
    Returns:
    the fill
  - setFill
```
public void setFill(boolean fill)
```
    Parameters:
    fill - the fill to set

Class AnnotatingGraphMousePlugin<V,E>

Field Summary

Fields inherited from class edu.uci.ics.jung.visualization.control.AbstractGraphMousePlugin

Constructor Summary

Method Summary

Methods inherited from class edu.uci.ics.jung.visualization.control.AbstractGraphMousePlugin

Methods inherited from class java.lang.Object

Field Detail

additionalModifiers

rectangularShape

lensPaintable

annotationManager

annotationColor

layer

fill

basicTransformer

rc

added

Constructor Detail

AnnotatingGraphMousePlugin

AnnotatingGraphMousePlugin

Method Detail

getAnnotationColor

setAnnotationColor

mousePressed

mouseReleased

mouseDragged

mouseClicked

mouseEntered

mouseExited

mouseMoved

getRectangularShape

setRectangularShape

getLayer

setLayer

isFill

setFill