Eclipse JDT
Release 3.7

org.eclipse.jdt.ui.actions
Class OpenAction

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.OpenAction
All Implemented Interfaces:
IAction, ISelectionChangedListener

public class OpenAction
extends SelectionDispatchAction

This action opens a Java editor on a Java element or file.

The action is applicable to selections containing elements of type ICompilationUnit, IMember or IFile.

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
OpenAction(IWorkbenchSite site)
          Creates a new OpenAction.
OpenAction(org.eclipse.jdt.internal.ui.javaeditor.JavaEditor editor)
          Note: This constructor is for internal use only.
 
Method Summary
 Object getElementToOpen(Object object)
          Note: this method is for internal use only.
 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 run(Object[] elements)
          Note: this method is for internal use only.
 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

OpenAction

public OpenAction(IWorkbenchSite site)
Creates a new OpenAction. 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 context information for this action

OpenAction

public OpenAction(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(Object[] elements)
Note: this method is for internal use only. Clients should not call this method.

Parameters:
elements - the elements to process
Restriction:
This method is not intended to be referenced by clients.

getElementToOpen

public Object getElementToOpen(Object object)
                        throws JavaModelException
Note: this method is for internal use only. Clients should not call this method.

Parameters:
object - the element to open
Returns:
the real element to open
Throws:
JavaModelException - if an error occurs while accessing the Java model
Restriction:
This method is not intended to be referenced by clients.

Eclipse JDT
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) 2000, 2011 IBM Corporation and others. All rights reserved.