| BlueSpray - Help © SchoonerTurtles, Inc. 2012-2015
Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About
| # Class STTool
Returns | Default | Function | Throws
--- | --- | --- | ---
boolean | false | MouseDragged(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) | Exception
boolean | false | MouseMoved(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) | Exception
boolean | false | MousePressed(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) | Exception
boolean | false | MouseReleased(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) | Exception
|  | Paint(STItem ItemClickedIn,STView TheView) | Exception
## Object Functions

### boolean MouseDragged(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) Exception

Response to the mouse being dragged while it is being held down.

Parameters:
ItemClickedIn - The item clicked on with the tool
ToolIndex - Index to the selected tool in this object.
TheView - The view containing the tool
TheEvent - The event that trigged this call.
Returns: - true if the event was used by the tool, false otherwise.
Throws: Exception

### boolean MouseMoved(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) Exception

### boolean MousePressed(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) Exception

Override to handle the tool being pressed down (with the mouse)in an
item container. The tool should take action needed such as selecting
items being clicked on and repainting the ProjectTree appropriately.
The tool will do any painting until the next call to Paint().

Parameters:
ItemClickedIn - The item clicked on with the tool
ToolIndex - Index to the selected tool in this object.
TheView - The view containing the tool
TheEvent - The event that trigged this call.
Returns: - true if the event was used by the tool, false otherwise.
Throws: Exception

### boolean MouseReleased(STItem ItemClickedIn,STView TheView,MouseEvent TheEvent) Exception

Respond to the mouse being released while the tool was selected.

Parameters:
ItemClickedIn - The item clicked on with the tool
ToolIndex - Index to the selected tool in this object.
TheView - The view containing the tool
TheEvent - The event that trigged this call.
Returns: - true if the event was used by the tool, false otherwise.
Throws: Exception

### Paint(STItem ItemClickedIn,STView TheView) Exception

Allows the tool to paint into the container it is being used in. This cGetSupportedan be
used to draw lines for distances being measured or boxes for selections.

Parameters:
ItemClickedIn - The item clicked on with the tool
ToolIndex - Index to the selected tool in this object.
TheView - The view containing the tool
TheEvent - The event that trigged this call.
Returns: - true if the event was used by the tool, false otherwise.
Throws: Exception