edu.neu.ccs.gui
Class MouseAction

java.lang.Object
  extended byjavax.swing.AbstractAction
      extended byedu.neu.ccs.gui.MouseAction
All Implemented Interfaces:
Action, ActionListener, Cloneable, EventListener, Serializable

public abstract class MouseAction
extends AbstractAction

Encapsulates an action that is performed as a result of a MouseEvent.

Since:
1.0.1
Version:
2.2
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.AbstractAction
 
Field Summary
 
Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled
 
Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON
 
Constructor Summary
MouseAction()
          Constructs a mouse action with no name or icon.
MouseAction(String name)
          Constructs a mouse action with the given name but no icon.
MouseAction(String name, Icon icon)
          Constructs a mouse action with the given name and icon.
 
Method Summary
 void actionPerformed(ActionEvent evt)
          Performs this action by calling the mouseActionPerformed method of this class intended to perform tasks requiring information contained in the MouseEvent triggering this action.
abstract  void mouseActionPerformed(MouseEvent mevt)
          Performs the tasks encapsulated by this action.
 
Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MouseAction

public MouseAction()
Constructs a mouse action with no name or icon.


MouseAction

public MouseAction(String name)
Constructs a mouse action with the given name but no icon.

Parameters:
name - the name for this action

MouseAction

public MouseAction(String name,
                   Icon icon)
Constructs a mouse action with the given name and icon.

Parameters:
name - the name for this action
icon - the icon for this action
Method Detail

actionPerformed

public final void actionPerformed(ActionEvent evt)
Performs this action by calling the mouseActionPerformed method of this class intended to perform tasks requiring information contained in the MouseEvent triggering this action. If the given event is not a MouseActionEvent, this action is not performed.

Parameters:
evt - an object encapsulating an event that triggered this action

mouseActionPerformed

public abstract void mouseActionPerformed(MouseEvent mevt)
Performs the tasks encapsulated by this action. Subclasses should override this method to provide tasks this action performs.

Parameters:
mevt - the mouse event that triggered this action