public class LaunchURL extends Object implements IWorkbenchWindowActionDelegate, IExecutableExtensionAction that launches a URL in a browser.
This class is intended to be specified as a value of a class attribute of an action element in plugin.xml for extensions of org.eclipse.ui.actionSets extension point. The URL to launch must be specified in the markup in one of two ways.
The action element can have an attribute named url, in addition to markup required by org.eclipse.ui.actionSets extension point specification. The value of the url attribute should specify a URL to be opened in a browser.
Alternatively, since 3.1, instead of a class attribute on the action element, the extension can specify a nested class element with a class attribute and URL specified in a parameter sub-element. For example:
<class class="org.eclipse.help.ui.browser.LaunchURL"> <parameter name="url" value="http://eclipse.org/" /> </class>
Constructors Constructor Description
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
dispose()Disposes this action delegate.
init(IWorkbenchWindow window)Initializes this action delegate with the workbench window it will work in.
run(IAction action)Performs this action.
selectionChanged(IAction action, ISelection selection)Notifies this action delegate that the selection in the workbench has changed.
setInitializationData(IConfigurationElement config, String propertyName, Object data)This method is called by the implementation of the method
IConfigurationElement.createExecutableExtensionon a newly constructed extension, passing it its relevant configuration information.
public void dispose()Description copied from interface:
IWorkbenchWindowActionDelegateDisposes this action delegate. The implementor should unhook any references to itself so that garbage collection can occur.
public void init(IWorkbenchWindow window)Description copied from interface:
IWorkbenchWindowActionDelegateInitializes this action delegate with the workbench window it will work in.
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreExceptionDescription copied from interface:
IExecutableExtensionThis method is called by the implementation of the method
IConfigurationElement.createExecutableExtensionon 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
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 supplied
- in case (1), the initialization data
string is passed as a
- in case (2), the initialization data is passed
Hashtablecontaining the actual parameter names and values (both
- Specified by:
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
CoreException- if error(s) detected during initialization processing
- See Also:
public void run(IAction action)Description copied from interface:
IActionDelegatePerforms this action.
This method is called by the proxy action when the action has been triggered. Implement this method to do the actual work.
Note: If the action delegate also implements
IActionDelegate2, then this method is not invoked but instead the
runWithEvent(IAction, Event)method is called.
public void selectionChanged(IAction action, ISelection selection)Description copied from interface:
IActionDelegateNotifies this action delegate that the selection in the workbench has changed.
Implementers can use this opportunity to change the availability of the action or to modify other presentation properties.
When the selection changes, the action enablement state is updated based on the criteria specified in the plugin.xml file. Then the delegate is notified of the selection change regardless of whether the enablement criteria in the plugin.xml file is met.