AbstractGraphMousePlugin

java.lang.Object
- edu.uci.ics.jung.visualization.control.AbstractGraphMousePlugin

All Implemented Interfaces:

GraphMousePlugin

Direct Known Subclasses:

AbstractPopupGraphMousePlugin, AnimatedPickingGraphMousePlugin, AnnotatingGraphMousePlugin, EditingGraphMousePlugin, LabelEditingGraphMousePlugin, LensMagnificationGraphMousePlugin, PickingGraphMousePlugin, RotatingGraphMousePlugin, ScalingGraphMousePlugin, ShearingGraphMousePlugin, TranslatingGraphMousePlugin, ViewTranslatingGraphMousePlugin
```
public abstract class AbstractGraphMousePlugin
extends java.lang.Object
implements GraphMousePlugin
```
a base class for GraphMousePlugin instances. Holds some members common to all GraphMousePlugins

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.awt.Cursor`	`cursor` the special cursor that plugins may display
`protected java.awt.Point`	`down` the location in the View where the mouse was pressed
`protected int`	`modifiers` modifiers to compare against mouse event modifiers

Constructor Summary

Constructors
Constructor and Description

AbstractGraphMousePlugin(int modifiers)
create an instance with passed values

Constructors
Constructor and Description
`AbstractGraphMousePlugin(int modifiers)` create an instance with passed values

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`checkModifiers(java.awt.event.MouseEvent e)` check the mouse event modifiers against the instance member modifiers.
`java.awt.Cursor`	`getCursor()`
`int`	`getModifiers()` getter for mouse modifiers
`void`	`setCursor(java.awt.Cursor cursor)`
`void`	`setModifiers(int modifiers)` setter for mouse modifiers

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

- Field Detail
  - modifiers
```
protected int modifiers
```
    modifiers to compare against mouse event modifiers
  - down
```
protected java.awt.Point down
```
    the location in the View where the mouse was pressed
  - cursor
```
protected java.awt.Cursor cursor
```
    the special cursor that plugins may display
- Constructor Detail
  - AbstractGraphMousePlugin
```
public AbstractGraphMousePlugin(int modifiers)
```
    create an instance with passed values
    
    Parameters:
    modifiers -
- Method Detail
  - getModifiers
```
public int getModifiers()
```
    getter for mouse modifiers
    
    Specified by:
    
    getModifiers in interface GraphMousePlugin
    
    Returns:
    modifiers
  - setModifiers
```
public void setModifiers(int modifiers)
```
    setter for mouse modifiers
    
    Specified by:
    
    setModifiers in interface GraphMousePlugin
  - checkModifiers
```
public boolean checkModifiers(java.awt.event.MouseEvent e)
```
    check the mouse event modifiers against the instance member modifiers. Default implementation checks equality. Can be overridden to test with a mask
    
    Specified by:
    
    checkModifiers in interface GraphMousePlugin
    
    Parameters:
    e - an event to compare to
    
    Returns:
    whether the member modifers match the event modifiers
  - getCursor
```
public java.awt.Cursor getCursor()
```
    Returns:
    Returns the cursor.
  - setCursor
```
public void setCursor(java.awt.Cursor cursor)
```
    Parameters:
    cursor - The cursor to set.

Class AbstractGraphMousePlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

modifiers

down

cursor

Constructor Detail

AbstractGraphMousePlugin

Method Detail

getModifiers

setModifiers

checkModifiers

getCursor

setCursor