torero.gui
Interface ToreroTool

All Known Implementing Classes:
ConnectTool, TraversalTool, SwapTool, AttributeTool, FunctionTool

public interface ToreroTool

Interface describing all tools used in Torero. They are used together with the ToreroToolBox.

See Also:
ToreroToolBox

Method Summary
 void activate()
          Activates (resets) this tool.
 void deactivate()
          Deactivates (resets) this tool.
 String getDescription()
          Get a textual description of the tool (e.g. ine sentence).
 String getShortDescription()
          Get a short textual description of the tool (a few words).
 Icon getToolIcon()
          Get the icon for this tool.
 void pluggedIn(ToreroToolBox ttb)
          Called when the tool is plugged into the ToreroToolBox.
 void pluggedOut()
          Called when the tool is removed from the ToreroToolBox.
 void processUI(GrammarNode gn, MouseEvent me, Attribute att)
          Process the mouseevent me at node gn at attribute att.
 

Method Detail

processUI

public void processUI(GrammarNode gn,
                      MouseEvent me,
                      Attribute att)
Process the mouseevent me at node gn at attribute att.
Parameters:
gn - affected grammarnode.
me - the mouseevent that occured.
att - the affected attribute.

getToolIcon

public Icon getToolIcon()
Get the icon for this tool.
Returns:
the Icon for this tool.

getShortDescription

public String getShortDescription()
Get a short textual description of the tool (a few words).
Returns:
a short textual description.

getDescription

public String getDescription()
Get a textual description of the tool (e.g. ine sentence).
Returns:
a textual description.

activate

public void activate()
Activates (resets) this tool.

deactivate

public void deactivate()
Deactivates (resets) this tool.

pluggedIn

public void pluggedIn(ToreroToolBox ttb)
Called when the tool is plugged into the ToreroToolBox.

pluggedOut

public void pluggedOut()
Called when the tool is removed from the ToreroToolBox.