Back to index

moin  1.9.0~rc2
Public Member Functions | Protected Attributes | Package Attributes
CH.ifa.draw.standard.ActionTool Class Reference

A tool that performs an action when it is active and the mouse is clicked. More...

Inheritance diagram for CH.ifa.draw.standard.ActionTool:
Inheritance graph
[legend]
Collaboration diagram for CH.ifa.draw.standard.ActionTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ActionTool (DrawingView itsView)
void mouseDown (MouseEvent e, int x, int y)
 Add the touched figure to the selection an invoke action.
void mouseUp (MouseEvent e, int x, int y)
 Handles mouse up in the drawing view.
abstract void action (Figure figure)
 Performs an action with the touched figure.
void activate ()
 Activates the tool for the given view.
void deactivate ()
 Deactivates the tool.
void mouseDrag (MouseEvent e, int x, int y)
 Handles mouse drag events in the drawing view.
void mouseMove (MouseEvent evt, int x, int y)
 Handles mouse moves (if the mouse button is up).
void keyDown (KeyEvent evt, int key)
 Handles key down events in the drawing view.
Drawing drawing ()
 Gets the tool's drawing.
DrawingEditor editor ()
 Gets the tool's editor.
DrawingView view ()
 Gets the tool's view.

Protected Attributes

DrawingView fView
int fAnchorX
 The position of the initial mouse down.

Package Attributes

int fAnchorY

Detailed Description

A tool that performs an action when it is active and the mouse is clicked.

Definition at line 17 of file ActionTool.java.


Constructor & Destructor Documentation

CH.ifa.draw.standard.ActionTool.ActionTool ( DrawingView  itsView) [inline]

Definition at line 19 of file ActionTool.java.

                                           {
        super(itsView);
    }

Member Function Documentation

abstract void CH.ifa.draw.standard.ActionTool.action ( Figure  figure) [pure virtual]

Performs an action with the touched figure.

Here is the caller graph for this function:

void CH.ifa.draw.standard.AbstractTool.activate ( ) [inline, inherited]

Activates the tool for the given view.

This method is called whenever the user switches to this tool. Use this method to reinitialize a tool.

Reimplemented in CH.ifa.draw.standard.CreationTool, and CH.ifa.draw.figures.ScribbleTool.

Definition at line 41 of file AbstractTool.java.

                           {
        fView.clearSelection();
    }
void CH.ifa.draw.standard.AbstractTool.deactivate ( ) [inline, inherited]

Deactivates the tool.

This method is called whenever the user switches to another tool. Use this method to do some clean-up when the tool is switched. Subclassers should always call super.deactivate.

Reimplemented in CH.ifa.draw.standard.ConnectionTool, and CH.ifa.draw.figures.ScribbleTool.

Definition at line 51 of file AbstractTool.java.

                             {
        fView.setCursor(Cursor.getDefaultCursor());
    }
Drawing CH.ifa.draw.standard.AbstractTool.drawing ( ) [inline, inherited]

Gets the tool's drawing.

Definition at line 90 of file AbstractTool.java.

                             {
        return fView.drawing();
    }

Here is the caller graph for this function:

DrawingEditor CH.ifa.draw.standard.AbstractTool.editor ( ) [inline, inherited]

Gets the tool's editor.

Definition at line 97 of file AbstractTool.java.

                                  {
        return fView.editor();
    }

Here is the caller graph for this function:

void CH.ifa.draw.standard.AbstractTool.keyDown ( KeyEvent  evt,
int  key 
) [inline, inherited]

Handles key down events in the drawing view.

Definition at line 84 of file AbstractTool.java.

                                               {
    }
void CH.ifa.draw.standard.ActionTool.mouseDown ( MouseEvent  e,
int  x,
int  y 
) [inline]

Add the touched figure to the selection an invoke action.

See also:
action()

Reimplemented from CH.ifa.draw.standard.AbstractTool.

Definition at line 27 of file ActionTool.java.

                                                      {
        Figure target = drawing().findFigure(x, y);
        if (target != null) {
            view().addToSelection(target);
            action(target);
        }
    }

Here is the call graph for this function:

void CH.ifa.draw.standard.AbstractTool.mouseDrag ( MouseEvent  e,
int  x,
int  y 
) [inline, inherited]
void CH.ifa.draw.standard.AbstractTool.mouseMove ( MouseEvent  evt,
int  x,
int  y 
) [inline, inherited]

Handles mouse moves (if the mouse button is up).

Reimplemented in CH.ifa.draw.standard.ConnectionTool.

Definition at line 78 of file AbstractTool.java.

                                                        {
    }
void CH.ifa.draw.standard.ActionTool.mouseUp ( MouseEvent  e,
int  x,
int  y 
) [inline]

Handles mouse up in the drawing view.

Reimplemented from CH.ifa.draw.standard.AbstractTool.

Definition at line 35 of file ActionTool.java.

                                                    {
        editor().toolDone();
    }

Here is the call graph for this function:

DrawingView CH.ifa.draw.standard.AbstractTool.view ( ) [inline, inherited]

Gets the tool's view.

Definition at line 104 of file AbstractTool.java.

                              {
        return fView;
    }

Here is the caller graph for this function:


Member Data Documentation

int CH.ifa.draw.standard.AbstractTool.fAnchorX [protected, inherited]

The position of the initial mouse down.

Definition at line 27 of file AbstractTool.java.

Definition at line 27 of file AbstractTool.java.

DrawingView CH.ifa.draw.standard.AbstractTool.fView [protected, inherited]

Definition at line 22 of file AbstractTool.java.


The documentation for this class was generated from the following file: