org.trianacode.gui.components.hidden

Class HiddenComponentModel

java.lang.Object

org.trianacode.gui.components.hidden.HiddenComponentModel

All Implemented Interfaces:

ToolComponentModel

public class HiddenComponentModel
extends java.lang.Object
implements ToolComponentModel

A tool model that renders a tool invisible on the gui.

Field Summary

Fields inherited from interface org.trianacode.gui.hci.tools.ToolComponentModel

DISPLAY_ICON, HIDE_ICON, UNKNOWN_ACTION

Constructor Summary

Constructors

Constructor and Description
HiddenComponentModel()

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) Return whether the icon is shown for the specified update action (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

HiddenComponentModel

public HiddenComponentModel()

Method Detail

getTreeIcon

public javax.swing.Icon getTreeIcon(Tool tool)

Specified by:

getTreeIcon in interface ToolComponentModel

Returns:

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

getTreeToolTip

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

Specified by:

getTreeToolTip in interface ToolComponentModel

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

public javax.swing.JPopupMenu getTreePopup(Tool tool)

Specified by:

getTreePopup in interface ToolComponentModel

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

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

Specified by:

getWorkspaceToolTip in interface ToolComponentModel

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

public javax.swing.JPopupMenu getWorkspacePopup(Task task)

Specified by:

getWorkspacePopup in interface ToolComponentModel

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)

getTaskComponent

public TaskComponent getTaskComponent(Task task)

Specified by:

getTaskComponent in interface ToolComponentModel

Returns:

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

getTaskAction

public javax.swing.Action getTaskAction(Task task)

Specified by:

getTaskAction in interface ToolComponentModel

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.

isUpdateIcon

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

Return whether the icon is shown for the specified update action (e.g. INCREASE_INPUT_NODES_ACTION as defined in UpdateActionConstants)

Specified by:

isUpdateIcon in interface ToolComponentModel

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

Returns:

either DISPLAY_ICON, HIDE_ICON or UNKNOWN_ACTION

getUpdateAction

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

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

Specified by:

getUpdateAction in interface ToolComponentModel

Parameters:

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

Returns:

either the action or null if unknown.