Eclipse JDT
2.0

org.eclipse.jdt.ui.actions
Class OpenExternalJavadocAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.jdt.ui.actions.SelectionDispatchAction
              |
              +--org.eclipse.jdt.ui.actions.OpenExternalJavadocAction
All Implemented Interfaces:
IAction, ISelectionChangedListener

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 IJavaElement.

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

Since:
2.0

Field Summary
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
OpenExternalJavadocAction(IWorkbenchSite site)
          Creates a new OpenExternalJavadocAction.
OpenExternalJavadocAction(org.eclipse.jdt.internal.ui.javaeditor.JavaEditor editor)
          Note: This constructor is for internal use only.
 
Method Summary
protected  String getDialogTitle()
          Note: this method is for internal use only.
protected  void run(IStructuredSelection selection)
          Executes this actions with the given structured selection.
protected  void run(ITextSelection selection)
          Executes this actions with the given text selection.
protected  void selectionChanged(IStructuredSelection selection)
          Notifies this action that the given structured selection has changed.
protected  void selectionChanged(ITextSelection selection)
          Notifies this action that the given text selection has changed.
 
Methods inherited from class org.eclipse.jdt.ui.actions.SelectionDispatchAction
getSelection, getSelectionProvider, getShell, getSite, run, run, selectionChanged, selectionChanged, update
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removeAcceleratorText, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
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

OpenExternalJavadocAction

public OpenExternalJavadocAction(org.eclipse.jdt.internal.ui.javaeditor.JavaEditor editor)
Note: This constructor is for internal use only. Clients should not call this constructor.

Method Detail

selectionChanged

protected 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

protected 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

run

protected 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

run

protected 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

getDialogTitle

protected String getDialogTitle()
Note: this method is for internal use only. Clients should not call this method.


Eclipse JDT
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.