torero.gui
Class FunctionTool

java.lang.Object
  |
  +--torero.gui.FunctionTool

All Implemented Interfaces:

ToreroTool

public class FunctionTool

extends Object

implements ToreroTool

The function tool class is used to set the function description of an (existing) attribute assignment, wich defines the exaxt mathematical function in target (ox, c) syntax. The visual component is included in the class. The tool also modifies the cursor on activation. On an appropriate call to the processUI() method it opens the tool's window. All public accessable functionality is contained in the processUI method.

See Also:

AttributeAssingnment, GrammarNode

Constructor Summary

FunctionTool()

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. one 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionTool

public FunctionTool()

Method Detail

processUI

public void processUI(GrammarNode gn,
                      MouseEvent me,
                      Attribute att)

Process the mouseevent me at node gn at attribute att. Shows the visual component, and allows the definition of the functiontext for the given destination attribute.

Specified by:

processUI in interface ToreroTool

Parameters:

gn - affected grammarnode.

me - the mouseevent that occured.

att - the affected (destination)attribute.

activate

public void activate()

Activates (resets) this tool. Sets the function tool's cursor.

Specified by:

activate in interface ToreroTool

deactivate

public void deactivate()

Deactivates (resets) this tool. Resets the cursor.

Specified by:

deactivate in interface ToreroTool

pluggedIn

public void pluggedIn(ToreroToolBox ttb)

Called when the tool is plugged into the ToreroToolBox. Creates the visual component, set it's sze but its is still hidden.

Specified by:

pluggedIn in interface ToreroTool

pluggedOut

public void pluggedOut()

Called when the tool is removed from the ToreroToolBox.

Specified by:

pluggedOut in interface ToreroTool

getToolIcon

public Icon getToolIcon()

Get the icon for this tool.

Specified by:

getToolIcon in interface ToreroTool

Returns:

the Icon for this tool.

getShortDescription

public String getShortDescription()

Get a short textual description of the tool (a few words).

Specified by:

getShortDescription in interface ToreroTool

Returns:

a short textual description.

getDescription

public String getDescription()

Get a textual description of the tool (e.g. one sentence).

Specified by:

getDescription in interface ToreroTool

Returns:

a textual description.