Eclipse Platform
Release 3.1

org.eclipse.ui.activities
Class WorkbenchTriggerPointAdvisor

java.lang.Object
  extended byorg.eclipse.ui.activities.WorkbenchTriggerPointAdvisor
All Implemented Interfaces:
IExecutableExtension, ITriggerPointAdvisor

public class WorkbenchTriggerPointAdvisor
extends Object
implements ITriggerPointAdvisor, IExecutableExtension

Workbench implementation prompts the user with a dialog unless they've said that they don't want to be prompted. You may provide the certain strings to this class via method #2 of IExecutableExtension. This is provided as API so that non-SDK Eclipse applications can reuse and augment the default SDK trigger point behaviour.

Since:
3.1
See Also:
PROCEED_MULTI, PROCEED_SINGLE, DONT_ASK, NO_DETAILS

Field Summary
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 Summary
WorkbenchTriggerPointAdvisor()
          Create a new instance of this advisor.
 
Method Summary
 Set allow(ITriggerPoint triggerPoint, IIdentifier identifier)
          Answer whether the activities bound to the identifier should be enabled when triggered by the provided trigger point.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROCEED_MULTI

public static String PROCEED_MULTI
The string to be used when prompting to proceed with multiple activities. Ie: "Enable the selected activities?"


PROCEED_SINGLE

public static String PROCEED_SINGLE
The string to be used when prompting to proceed with a single activity. Ie: "Enable the required activity?"


DONT_ASK

public static String DONT_ASK
The string to be used to label the "don't ask" button. Ie: "&Always enable activities and don't ask me again"


NO_DETAILS

public static String NO_DETAILS
The string to be used when no activities are selected and Details are shown. Ie: "Select an activity to view its description."

Constructor Detail

WorkbenchTriggerPointAdvisor

public WorkbenchTriggerPointAdvisor()
Create a new instance of this advisor.

Method Detail

allow

public Set allow(ITriggerPoint triggerPoint,
                 IIdentifier identifier)
Description copied from interface: ITriggerPointAdvisor
Answer whether the activities bound to the identifier should be enabled when triggered by the provided trigger point.

Specified by:
allow in interface ITriggerPointAdvisor
Parameters:
triggerPoint - the trigger point to test
identifier - the identifier to test against the trigger point
Returns:
the set of activities to enable. If the set is not null the caller may proceed with their usage of the object represented by the identifier. If null the caller should abort the action.

setInitializationData

public void setInitializationData(IConfigurationElement config,
                                  String propertyName,
                                  Object data)
Description copied from interface: IExecutableExtension
This method is called by the implementation of the method 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:

Specified by:
setInitializationData in interface IExecutableExtension
Parameters:
config - the configuration element used to trigger this execution. It can be queried by the executable extension for specific configuration properties
propertyName - 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.
See Also:
IConfigurationElement.createExecutableExtension(String)

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.