org.pf.tools.cda.ui.xpi
Interface IPluginActionInfo

All Superinterfaces:
IPluginInfo
All Known Implementing Classes:
AActionPlugin, AModelExporterUIPlugin, ASubWindowPlugin

public interface IPluginActionInfo
extends IPluginInfo

Defines the methods that provide meta data about a plug-in action.

Version:
1.0
Author:
M.Duchrow

Field Summary
static IPluginActionInfo[] EMPTY_ARRAY
           
 
Method Summary
 java.lang.String getActionText(java.util.Locale locale, IExplorationModelObject object)
          This method must return the text to display in UI elements (e.g menu item, button) on the given object.
 PluginConfiguration getConfiguration(java.awt.Frame parentFrame)
          The method gets called to allow the plug-in collecting configuration parameters if necessary for execution.
 java.lang.String getDisabledIconFilename(IExplorationModelObject object)
          Returns the name of an icon file that should be shown in the UI when the plug-in cannot be used.
 java.lang.String getEnabledIconFilename(IExplorationModelObject object)
          Returns the filename of an icon image to that should be shown if the plug-in can be used.
 java.lang.String getToolTipText(java.util.Locale locale, IExplorationModelObject object)
          Returns the text that should be shown as tooltip for this action.
 
Methods inherited from interface org.pf.tools.cda.xpi.IPluginInfo
getPluginId, getPluginProvider, getPluginVersion
 

Field Detail

EMPTY_ARRAY

static final IPluginActionInfo[] EMPTY_ARRAY
Method Detail

getActionText

java.lang.String getActionText(java.util.Locale locale,
                               IExplorationModelObject object)
This method must return the text to display in UI elements (e.g menu item, button) on the given object. If it returns null, no action widget will be added to the UI. So this can also be used to control for what kind of objects the plugin is available.

Parameters:
locale - Defines the language the text is required for
object - An object this plug-in acts on (may be null)
Returns:
The action's text or null if the given object is not supported

getToolTipText

java.lang.String getToolTipText(java.util.Locale locale,
                                IExplorationModelObject object)
Returns the text that should be shown as tooltip for this action.

Parameters:
locale - Represents the language the text is required for
object - An object this plug-in acts on (may be null)
Returns:
A text or null to indicate that there is no tooltip text

getEnabledIconFilename

java.lang.String getEnabledIconFilename(IExplorationModelObject object)
Returns the filename of an icon image to that should be shown if the plug-in can be used.

Parameters:
object - An object this plug-in acts on (may be null)
Returns:
An filename of a graphics file or null

getDisabledIconFilename

java.lang.String getDisabledIconFilename(IExplorationModelObject object)
Returns the name of an icon file that should be shown in the UI when the plug-in cannot be used.

Parameters:
object - An object this plug-in acts on (may be null)
Returns:
An filename of a graphics file or null

getConfiguration

PluginConfiguration getConfiguration(java.awt.Frame parentFrame)
The method gets called to allow the plug-in collecting configuration parameters if necessary for execution. Returning null means, execution of the plug-in has been cancelled. If a configuration object is returned execution can be started.

Parameters:
parentFrame - The frame from which this method gets called.
Returns:
A configuration or null