public interface IPluginActionInfo extends IPluginInfo
Modifier and Type | Field and Description |
---|---|
static IPluginActionInfo[] |
EMPTY_ARRAY |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActionText(java.util.Locale locale,
org.pfsw.odem.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(org.pfsw.odem.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(org.pfsw.odem.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,
org.pfsw.odem.IExplorationModelObject object)
Returns the text that should be shown as tooltip for this action.
|
getPluginId, getPluginProvider, getPluginVersion
static final IPluginActionInfo[] EMPTY_ARRAY
java.lang.String getActionText(java.util.Locale locale, org.pfsw.odem.IExplorationModelObject object)
locale
- Defines the language the text is required forobject
- An object this plug-in acts on (may be null)java.lang.String getToolTipText(java.util.Locale locale, org.pfsw.odem.IExplorationModelObject object)
locale
- Represents the language the text is required forobject
- An object this plug-in acts on (may be null)java.lang.String getEnabledIconFilename(org.pfsw.odem.IExplorationModelObject object)
object
- An object this plug-in acts on (may be null)java.lang.String getDisabledIconFilename(org.pfsw.odem.IExplorationModelObject object)
object
- An object this plug-in acts on (may be null)PluginConfiguration getConfiguration(java.awt.Frame parentFrame)
parentFrame
- The frame from which this method gets called.