org.trianacode.gui.hci.tools

Interface ToolComponentModel

All Known Subinterfaces:

RegisterableToolComponentModel

All Known Implementing Classes:

DaxFileComponentModel, DaxJobComponentModel, HiddenComponentModel, IWIRControlComponentModel, MapLocationComponentModel, ScriptComponentModel, ShiwaConfigComponentModel, TextToolComponentModel, TrianaComponentModel

public interface ToolComponentModel

The model for a tool in the tool tree and on the workspace

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISPLAY_ICON
static int	HIDE_ICON
static int	UNKNOWN_ACTION

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.Action	getTaskAction(Task task)
TaskComponent	getTaskComponent(Task task)
javax.swing.Icon	getTreeIcon(Tool tool)
javax.swing.JPopupMenu	getTreePopup(Tool tool)
java.lang.String	getTreeToolTip(Tool tool, boolean extended)
javax.swing.Action	getUpdateAction(Task task, java.lang.String action) Called to determine the action that is invoked when an update action is choosen.
javax.swing.JPopupMenu	getWorkspacePopup(Task task)
java.lang.String	getWorkspaceToolTip(Task task, boolean extended)
int	isUpdateIcon(Task task, java.lang.String action) Called to determine if an icon for the specified action should be displayed, e.g.

Field Detail

UNKNOWN_ACTION

static final int UNKNOWN_ACTION

See Also:

Constant Field Values

DISPLAY_ICON

static final int DISPLAY_ICON

See Also:

Constant Field Values

HIDE_ICON

static final int HIDE_ICON

See Also:

Constant Field Values

Method Detail

getTreeIcon

javax.swing.Icon getTreeIcon(Tool tool)

Returns:

the icon for the specified tool (if null is returned then the default leaf icon is used)

getTreeToolTip

java.lang.String getTreeToolTip(Tool tool,
                              boolean extended)

Returns:

the tool tip for the tool when in the tree (if null is returned then the default tool tip is used, return a empty string for no tip)

getTreePopup

javax.swing.JPopupMenu getTreePopup(Tool tool)

Returns:

the popup menu the tool when in the tree (if null is returned then the default popup menu is used, return a empty popup menu for no popup)

getWorkspaceToolTip

java.lang.String getWorkspaceToolTip(Task task,
                                   boolean extended)

Returns:

the tool tip for the tool when on the workspace (if null is returned then the default tool tip is used, return a empty string for no tip)

getWorkspacePopup

javax.swing.JPopupMenu getWorkspacePopup(Task task)

Returns:

the popup menu the tool when in the workspace (if null is returned then the default popup menu is used, return a empty popup menu for no popup)

getTaskAction

javax.swing.Action getTaskAction(Task task)

Returns:

the action that is invoked when the task is activated (e.g. double-clicked). If null is returned the default tool action is used.

getTaskComponent

TaskComponent getTaskComponent(Task task)

Returns:

the task component used to represent the specified task (if null is returned then the default component is used)

isUpdateIcon

int isUpdateIcon(Task task,
               java.lang.String action)

Called to determine if an icon for the specified action should be displayed, e.g. ADD_INPUT_NODE_ACTION. Returns whether the icon should be displayed (DISPLAY_ICON), should not be displayed (HIDE_ICON) or the action is unknown and should be deffered to the default handler (UNKNOWN_ACTION). If the default handler does not know the action then the icon is not displayed.

Parameters:

action - the update action (e.g. ADD_INPUT_NODE_ACTION as defined in UpdateActionConstants)

Returns:

either DISPLAY_ICON, HIDE_ICON or UNKNOWN_ACTION

getUpdateAction

javax.swing.Action getUpdateAction(Task task,
                                 java.lang.String action)

Called to determine the action that is invoked when an update action is choosen.

Parameters:

action - the update action (e.g. ADD_INPUT_NODE_ACTION)

Returns:

either the action or null if unknown.