Class OpenAttachedJavadocAction

All Implemented Interfaces:
IAction, ISelectionChangedListener
Direct Known Subclasses:
OpenExternalJavadocAction

public class OpenAttachedJavadocAction extends SelectionDispatchAction
This action opens the selected element's Javadoc in a browser as defined by the preferences.

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

Since:
3.6
Restriction:
This class is not intended to be subclassed by clients.
  • Constructor Details

    • OpenAttachedJavadocAction

      public OpenAttachedJavadocAction(IWorkbenchSite site)
      Creates a new OpenAttachedJavadocAction. 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
    • OpenAttachedJavadocAction

      public OpenAttachedJavadocAction(org.eclipse.jdt.internal.ui.javaeditor.JavaEditor editor)
      Note: This constructor is for internal use only. Clients should not call this constructor.
      Parameters:
      editor - the Java editor
      Restriction:
      This constructor is not intended to be referenced by clients.
  • Method Details

    • selectionChanged

      public void selectionChanged(ITextSelection selection)
      Description copied from class: SelectionDispatchAction
      Notifies this action that the given text selection has changed. This default implementation calls selectionChanged(ISelection selection).
      Overrides:
      selectionChanged in class SelectionDispatchAction
      Parameters:
      selection - the new selection
    • selectionChanged

      public void selectionChanged(IStructuredSelection selection)
      Description copied from class: SelectionDispatchAction
      Notifies this action that the given structured selection has changed. This default implementation calls selectionChanged(ISelection selection).
      Overrides:
      selectionChanged in class SelectionDispatchAction
      Parameters:
      selection - the new selection
    • canEnableFor

      protected boolean canEnableFor(IStructuredSelection selection)
      Tells whether this action can be enabled for the given selection.
      Parameters:
      selection - the structured selection.
      Returns:
      true if the action can be enabled, false otherwise
    • run

      public void run(ITextSelection selection)
      Description copied from class: SelectionDispatchAction
      Executes this actions with the given text selection. This default implementation calls run(ISelection selection).
      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 structured selection. This default implementation calls run(ISelection selection).
      Overrides:
      run in class SelectionDispatchAction
      Parameters:
      selection - the selection
    • run

      protected void run(IJavaElement element)
      Executes this actions with the given Java element.
      Parameters:
      element - the Java element
    • open

      protected void open(URL url)
      Opens the given URL in the browser.
      Parameters:
      url - the URL
    • getDialogTitle

      protected String getDialogTitle()
      Note: this method is for internal use only. Clients should not call this method.
      Returns:
      the dialog default title
      Restriction:
      This method is not intended to be referenced by clients.
    • getShell

      public Shell getShell()
      Returns the shell provided by the site owning this action.
      Overrides:
      getShell in class SelectionDispatchAction
      Returns:
      the site's shell