org.eclipse.wst.jsdt.ui.actions
Class OpenExternalJavadocAction

java.lang.Object
  Action
      org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction
          org.eclipse.wst.jsdt.ui.actions.OpenExternalJavadocAction

public class OpenExternalJavadocAction
extends SelectionDispatchAction

This action opens the selected element's Javadoc in an external browser.

The action is applicable to selections containing elements of type IJavaScriptElement.

This class may be instantiated; it is not intended to be subclassed.

Provisional API: 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.

Constructor Summary

OpenExternalJavadocAction(IWorkbenchSite site)
Creates a new OpenExternalJavadocAction.

Method Summary

protected String	getDialogTitle() Note: this method is for internal use only.
void	run(IStructuredSelection selection) Executes this actions with the given selection.
void	run(ITextSelection selection) Executes this actions with the given selection.
void	selectionChanged(IStructuredSelection selection)
void	selectionChanged(ITextSelection selection)

Methods inherited from class org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction

getSelection, getSelectionProvider, getShell, getSite, run, setSpecialSelectionProvider, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenExternalJavadocAction

public OpenExternalJavadocAction(IWorkbenchSite site)

Creates a new OpenExternalJavadocAction. The action requires that the selection provided by the site's selection provider is of type org.eclipse.jface.viewers.IStructuredSelection.

Parameters:

site - the site providing additional context information for this action

Method Detail

selectionChanged

public void selectionChanged(ITextSelection selection)

Overrides:

selectionChanged in class SelectionDispatchAction

selectionChanged

public void selectionChanged(IStructuredSelection selection)

Overrides:

selectionChanged in class SelectionDispatchAction

run

public void run(ITextSelection selection)

Description copied from class: SelectionDispatchAction

Executes this actions with the given selection. This default implementation does nothing.

Overrides:

run in class SelectionDispatchAction

Parameters:

selection - the selection

run

public void run(IStructuredSelection selection)

Description copied from class: SelectionDispatchAction

Executes this actions with the given selection. This default implementation does nothing.

Overrides:

run in class SelectionDispatchAction

Parameters:

selection - the selection

getDialogTitle

protected String getDialogTitle()

Note: this method is for internal use only. Clients should not call this method.

Returns:

the dialog default title