|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.help.ui.browser.LaunchURL
Action that launches a URL in a browser.
Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
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 action element must 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.
Constructor Summary | |
LaunchURL()
|
Method Summary | |
void |
dispose()
Disposes this action delegate. |
void |
init(IWorkbenchWindow window)
Initializes this action delegate with the workbench window it will work in. |
void |
run(IAction action)
Performs this action. |
void |
selectionChanged(IAction action,
ISelection selection)
Notifies this action delegate that the selection in the workbench has changed. |
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 |
Constructor Detail |
public LaunchURL()
Method Detail |
public void dispose()
IWorkbenchWindowActionDelegate
dispose
in interface IWorkbenchWindowActionDelegate
IWorkbenchWindowActionDelegate.dispose()
public void init(IWorkbenchWindow window)
IWorkbenchWindowActionDelegate
init
in interface IWorkbenchWindowActionDelegate
window
- the window that provides the context for this delegateIWorkbenchWindowActionDelegate.init(IWorkbenchWindow)
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException
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
.
CoreException
- if error(s) detected during initialization processingIExecutableExtension.setInitializationData(IConfigurationElement, String, Object)
public void run(IAction action)
IActionDelegate
This method is called when the delegating action has been triggered. Implement this method to do the actual work.
run
in interface IActionDelegate
action
- the action proxy that handles the presentation portion of the
actionIActionDelegate.run(IAction)
public void selectionChanged(IAction action, ISelection selection)
IActionDelegate
Implementers can use this opportunity to change the availability of the action or to modify other presentation properties.
selectionChanged
in interface IActionDelegate
action
- the action proxy that handles presentation portion of
the actionselection
- the current selection, or null
if there
is no selection.IActionDelegate.selectionChanged(IAction, ISelection)
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |