Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.io.action
Interface ActionUI

All Superinterfaces:
Comparable<de.cs3d.util.eclipse.extension.ExtensionObjectDefinition>, de.cs3d.util.eclipse.extension.ExtensionObjectDefinition, de.cs3d.util.eclipse.extension.ExtensionObjectFactory<IOWizard<?>>

public interface ActionUI
extends de.cs3d.util.eclipse.extension.ExtensionObjectFactory<IOWizard<?>>

Interface for IOWizard factories provided by the ActionUIExtension.

Author:
Simon Templer

Method Summary
 String getActionID()
          Get the identifier of the associated action
 String getCustomTitle()
          Get the custom wizard title.
 String getDisabledReason()
          Get the reason why the action is disabled in a human understandable way.
 org.eclipse.core.expressions.Expression getEnabledWhen()
          Get the expression that specifies whether the command to show the I/O wizard for the advisor should be enabled.
 boolean isProjectResource()
          States if I/O operations based on this advisor represent project resources and thus shall be remembered, i.e.
 
Methods inherited from interface de.cs3d.util.eclipse.extension.ExtensionObjectFactory
allowConfigure, configure, createExtensionObject, dispose
 
Methods inherited from interface de.cs3d.util.eclipse.extension.ExtensionObjectDefinition
getDisplayName, getIconURL, getIdentifier, getTypeName
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getActionID

String getActionID()
Get the identifier of the associated action

Returns:
the associated action ID

isProjectResource

boolean isProjectResource()
States if I/O operations based on this advisor represent project resources and thus shall be remembered, i.e. the configuration stored in the project. If stored in a project the resource will be loaded again when the project is loaded.

Returns:
if operations based on this advisor shall be remembered

getEnabledWhen

org.eclipse.core.expressions.Expression getEnabledWhen()
Get the expression that specifies whether the command to show the I/O wizard for the advisor should be enabled.

Returns:
the expression or null if the command should always be enabled
See Also:
IEvaluationService

getDisabledReason

String getDisabledReason()
Get the reason why the action is disabled in a human understandable way. May for instance state what the user must do to enable the action.

Returns:
the reason message

getCustomTitle

String getCustomTitle()
Get the custom wizard title.

Returns:
the wizard title, may be null

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d