ncsa.j3d.ui.tools
Interface ToolInterface

All Known Implementing Classes:

Tool, PickTool, AdjustmentTool, MouseTool, SensorViewTool, SensorRecordTool, ViewTool

public interface ToolInterface

extends PortfolioEventReceiver

This interface defines how the ToolManager interacts with the tools.

Method Summary

java.lang.String	describe() A function that allows the tool to report its name.
java.lang.String	describeFunctionality() Allows a tool to indicate any special functionality.
void	setToolManager(ToolManagerInterface manager) This function allows specifying the tool manager that this tool is owned by.

Methods inherited from interface ncsa.j3d.ui.events.PortfolioEventReceiver

notify

Method Detail

setToolManager

public void setToolManager(ToolManagerInterface manager)

This function allows specifying the tool manager that this tool is owned by. Typically there is only 1 toolmanager.

Parameters:

ToolManagerInterface - the interface to talk to

describe

public java.lang.String describe()

A function that allows the tool to report its name. useful to fill menus of tools, etc..

Parameters:

none -

describeFunctionality

public java.lang.String describeFunctionality()

Allows a tool to indicate any special functionality. For instance the 'H' might do something special

Parameters:

none -