Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.ui.actions
Class OpenExternalJavadocAction

java.lang.Object
  extended by 

org.eclipse.core.commands.common.EventManager
      extended by 

org.eclipse.jface.action.AbstractAction
          extended by 

org.eclipse.jface.action.Action
              extended by 

org.eclipse.jdt.ui.actions.SelectionDispatchAction
                  extended by 
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
Restriction:
This class is not intended to be subclassed by clients.

Field Summary
 
Fields inherited from interface org.eclipse.jface.action. IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
OpenExternalJavadocAction ( IWorkbenchSite site)
          Creates a new OpenExternalJavadocAction.
OpenExternalJavadocAction ( IWorkbenchSite site, ISelectionProvider provider)
          Deprecated. Use SelectionDispatchAction.setSpecialSelectionProvider(ISelectionProvider) instead. This API will be removed after 3.2 M5.
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.
 void run ( IJavaElement element)
           
 void run ( IStructuredSelection selection)
          Executes this actions with the given structured selection.
 void run ( ITextSelection selection)
          Executes this actions with the given text selection.
 void selectionChanged ( IStructuredSelection selection)
          Notifies this action that the given structured selection has changed.
 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, run, selectionChanged, selectionChanged, selectionChanged, setSpecialSelectionProvider, update
 
Methods inherited from class org.eclipse.jface.action. Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class org.eclipse.jface.action. AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
 
Methods inherited from class org.eclipse.core.commands.common. EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.action. IAction
addPropertyChangeListener, removePropertyChangeListener
 

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(
IWorkbenchSite site,
                                 
ISelectionProvider provider)
Deprecated. Use SelectionDispatchAction.setSpecialSelectionProvider(ISelectionProvider) instead. This API will be removed after 3.2 M5.

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

Parameters:
site - the site providing additional context information for this action
provider - a special selection provider which is used instead of the site's selection provider or null to use the site's selection provider
Since:
3.2

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.

Parameters:
editor - the Java editor
Restriction:
This constructor is not intended to be referenced by clients.
Method Detail

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

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

public void run(
IJavaElement element)

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.

Eclipse JDT
Release 3.5

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

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire