public class WorkbenchTriggerPointAdvisor extends Object implements ITriggerPointAdvisor, IExecutableExtension
IExecutableExtension
. This is provided as
API so that non-SDK Eclipse applications can reuse and augment the default
SDK trigger point behaviour.PROCEED_MULTI
,
PROCEED_SINGLE
,
DONT_ASK
,
NO_DETAILS
Modifier and Type | Field and Description |
---|---|
static String |
DONT_ASK
The string to be used to label the "don't ask" button.
|
static String |
NO_DETAILS
The string to be used when no activities are selected and Details are shown.
|
static String |
PROCEED_MULTI
The string to be used when prompting to proceed with multiple activities.
|
static String |
PROCEED_SINGLE
The string to be used when prompting to proceed with a single activity.
|
Constructor and Description |
---|
WorkbenchTriggerPointAdvisor()
Create a new instance of this advisor.
|
Modifier and Type | Method and Description |
---|---|
Set |
allow(ITriggerPoint triggerPoint,
IIdentifier identifier)
Answer whether the activities bound to the identifier should be enabled
when triggered by the provided trigger point.
|
boolean |
computeEnablement(IActivityManager activityManager,
IIdentifier identifier)
This implementation of
ITriggerPointAdvisor.computeEnablement(IActivityManager, IIdentifier)
calls
doComputeEnablement(IActivityManager, IIdentifier, boolean) with
a boolean argument of false . |
protected boolean |
doComputeEnablement(IActivityManager activityManager,
IIdentifier identifier,
boolean disabledExpressionActivitiesTakePrecedence)
Helper method for determining whether an identifier should be enabled.
|
void |
setInitializationData(IConfigurationElement config,
String propertyName,
Object data)
This method is called by the implementation of the method
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. |
public static String PROCEED_MULTI
public static String PROCEED_SINGLE
public static String DONT_ASK
public static String NO_DETAILS
public WorkbenchTriggerPointAdvisor()
public Set allow(ITriggerPoint triggerPoint, IIdentifier identifier)
ITriggerPointAdvisor
allow
in interface ITriggerPointAdvisor
triggerPoint
- the trigger point to testidentifier
- the identifier to test against the trigger pointnull
, the caller can proceed with
usage of the contribution provided that the collection of
activities is enabled. If this is null
, the
caller should assume that the operation involving the
contribution should be aborted. If this method returns the empty
set then the operation can proceed without any changes to
activity enablement state. Please note that it is the callers
responsibility to ensure that the Set returned by this method is
actually enabled - after setting the enabled state of the
required activities the change should be verified by consulting
IActivityManager.getEnabledActivityIds()
.public void setInitializationData(IConfigurationElement config, String propertyName, Object data)
IExecutableExtension
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. Most executable extensions only make use of the first
two call arguments.
Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example
<action run="com.example.BaseAction"/>In the above example, this method would be called with a reference to the
<action>
element (first argument), and
"run"
as the name of the attribute that defined
this executable extension (second argument).
The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.
There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:
(1) by specifying adapter data as part of the implementation
class attribute value. The Java class name can be followed
by a ":" separator, followed by any adapter data in string
form. For example, if the extension point specifies an attribute
"run"
to contain the name of the extension implementation,
an adapter can be configured as
<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become
<action> <run class="com.xyz.ExternalAdapter"> <parameter name="exec" value="./cmds/util.exe"/> <parameter name="opt" value="3"/> </run > </action>
Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.
In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:
null
, if no adapter data was suppliedString
Hashtable
containing the actual
parameter names and values (both String
s)setInitializationData
in interface IExecutableExtension
config
- the configuration element used to trigger this execution.
It can be queried by the executable extension for specific
configuration propertiespropertyName
- the name of an attribute of the configuration element
used on the createExecutableExtension(String)
call. This
argument can be used in the cases where a single configuration element
is used to define multiple executable extensions.data
- adapter data in the form of a String
,
a Hashtable
, or null
.IConfigurationElement.createExecutableExtension(String)
public boolean computeEnablement(IActivityManager activityManager, IIdentifier identifier)
ITriggerPointAdvisor.computeEnablement(IActivityManager, IIdentifier)
calls
doComputeEnablement(IActivityManager, IIdentifier, boolean)
with
a boolean argument of false
. Subclasses that wish to
disable identifiers if there is at least one disabled expression-based
activity should override this method and call
doComputeEnablement(IActivityManager, IIdentifier, boolean)
with
a boolean argument of true
.
Subclasses may override.computeEnablement
in interface ITriggerPointAdvisor
activityManager
- the activity manageridentifier
- the identifier to updatetrue
if this identifier should be enabled,
false
otherwisedoComputeEnablement(IActivityManager,
IIdentifier, boolean)
protected boolean doComputeEnablement(IActivityManager activityManager, IIdentifier identifier, boolean disabledExpressionActivitiesTakePrecedence)
true
if there is no applicable activity for the
given identifier. Otherwise, if the boolean argument
disabledExpressionActivitiesTakePrecedence
is
false
, returns true if any of the applicable activities
is enabled. If the boolean argument is true
, this method
returns false
if there is at least one disabled
expression-based activity; and it returns true
if there
are no disabled expression-based activities and there is at least one
applicable activity that is enabled.activityManager
- the activity manageridentifier
- the identifier to updatedisabledExpressionActivitiesTakePrecedence
- true
if this identifier should be enabled,
false
otherwise
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.