edu.ksu.cis.bandera.tool
Interface ToolIconView


public interface ToolIconView

The ToolIconView provides description of the Tool that can be used in a interface with the user. One such use is in the Session Editor within Bandera where the icons and text will be used in a graphical display of the tools that are available.

Version:
$Revision: 1.2 $ - $Date: 2003/08/06 15:30:47 $
Author:
Todd Wallentine tcw AT cis ksu edu

Method Summary
 java.lang.Object getActiveIcon()
          Get the icon that can be used when the Tool is running (or active).
 java.lang.Object getDisabledIcon()
          Get the icon that can be used when the Tool is disabled.
 java.lang.Object getIcon()
          Get the icon that can be used for this Tool.
 java.lang.String getText()
          Get the text that describes this tool.
 java.lang.String getToolTipText()
          Get the tool-tip text that can be used when a user hovers over the Tool icon.
 

Method Detail

getText

public java.lang.String getText()
Get the text that describes this tool. This should be a short name that can be displayed beneath the icon.

Returns:
A short name for the associated Tool.

getIcon

public java.lang.Object getIcon()
Get the icon that can be used for this Tool.

Returns:
An Object that can be used to create an icon (or image).

getToolTipText

public java.lang.String getToolTipText()
Get the tool-tip text that can be used when a user hovers over the Tool icon.

Returns:
A short description of the Tool that can be used as tool-tip text.

getActiveIcon

public java.lang.Object getActiveIcon()
Get the icon that can be used when the Tool is running (or active). This might be an animated icon or simply something that denotes activity.

Returns:
An Object that can be used to create an icon (or image).

getDisabledIcon

public java.lang.Object getDisabledIcon()
Get the icon that can be used when the Tool is disabled. This might be a greyed-out version of the default icon.

Returns:
An Object that can be used to create an icon (or image).