Eclipse Plug-in Developer Guide (Galileo) - OpenResourceAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.actions
Class OpenResourceAction


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

org.eclipse.jface.action.Action
              

org.eclipse.ui.actions.BaseSelectionListenerAction
                  

org.eclipse.ui.actions.SelectionListenerAction
                      

org.eclipse.ui.actions.WorkspaceAction
                          
org.eclipse.ui.actions.OpenResourceAction

All Implemented Interfaces:: EventListener, IResourceChangeListener, IAction, ISelectionChangedListener

public class OpenResourceAction
extends WorkspaceAction
implements IResourceChangeListener
extends WorkspaceAction
implements IResourceChangeListener

Standard action for opening the currently selected project(s).

Note that there is a different action for opening an editor on file resources: OpenFileAction.

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

Restriction:: This class is not intended to be subclassed by clients.

Field Summary

static String ID
          The id of this action.

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

OpenResourceAction ( IShellProvider provider)
          Creates a new action.

OpenResourceAction ( Shell shell)
          Deprecated. OpenResourceAction(IShellProvider)

Method Summary

protected String getOperationMessage ()
          Returns the string to display for this action's operation.

protected String getProblemsMessage ()
          Returns the string to display for this action's problems dialog.

protected String getProblemsTitle ()
          Returns the title for this action's problems dialog.

protected void invokeOperation ( IResource resource, IProgressMonitor monitor)
          Performs this action's operation on each of the selected resources, reporting progress to, and fielding cancel requests from, the given progress monitor.

void resourceChanged ( IResourceChangeEvent event)
          Handles a resource changed event by updating the enablement if one of the selected projects is opened or closed.

void run ()
          The CoreWrapperAction implementation of this IAction method uses a ProgressMonitorDialog to run the operation.

protected boolean shouldPerformResourcePruning ()
          Returns whether this action should attempt to optimize the resources being operated on.

protected boolean updateSelection ( IStructuredSelection s)
          The OpenResourceAction implementation of this SelectionListenerAction method ensures that this action is enabled only if one of the selections is a closed project.

Methods inherited from class org.eclipse.ui.actions. WorkspaceAction

createOperation, getActionResources, runInBackground, runInBackground, runInBackground

Methods inherited from class org.eclipse.ui.actions. SelectionListenerAction

clearCache, getSelectedNonResources, getSelectedResources, resourceIsType, selectionIsOfType

Methods inherited from class org.eclipse.ui.actions. BaseSelectionListenerAction

getStructuredSelection, runWithEvent, selectionChanged, selectionChanged

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, 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

Field Detail

ID

public static final 
String ID

The id of this action.

See Also:: Constant Field Values

Constructor Detail

OpenResourceAction

public OpenResourceAction(
Shell shell)

Deprecated. OpenResourceAction(IShellProvider)

Creates a new action.

Parameters:: shell - the shell for any dialogs

OpenResourceAction

public OpenResourceAction(
IShellProvider provider)

Creates a new action.

Parameters:: provider - the shell for any dialogs
Since:: 3.4

Method Detail

getOperationMessage

protected 
String getOperationMessage()

Description copied from class: WorkspaceAction

Returns the string to display for this action's operation.

Note that this hook method is invoked in a non-UI thread.

Subclasses must implement this method.

Specified by:: getOperationMessage in class WorkspaceAction

Returns:: the message

getProblemsMessage

protected 
String getProblemsMessage()

Description copied from class: WorkspaceAction

Returns the string to display for this action's problems dialog.

The WorkspaceAction implementation of this method returns a vague message (localized counterpart of something like "The following problems occurred."). Subclasses may reimplement to provide something more suited to the particular action.

Overrides:: getProblemsMessage in class WorkspaceAction

Returns:: the problems message

getProblemsTitle

protected 
String getProblemsTitle()

Description copied from class: WorkspaceAction

Returns the title for this action's problems dialog.

The WorkspaceAction implementation of this method returns a generic title (localized counterpart of "Problems"). Subclasses may reimplement to provide something more suited to the particular action.

Overrides:: getProblemsTitle in class WorkspaceAction

Returns:: the problems dialog title

invokeOperation

protected void invokeOperation(
IResource resource,
                               
IProgressMonitor monitor)
                        throws 
CoreException

Description copied from class: WorkspaceAction

Performs this action's operation on each of the selected resources, reporting progress to, and fielding cancel requests from, the given progress monitor.

Note that this method is invoked in a non-UI thread.

Subclasses must implement this method.

Overrides:: invokeOperation in class WorkspaceAction

Parameters:: resource - one of the selected resources; monitor - a progress monitor
Throws:: CoreException - if the operation fails

resourceChanged

public void resourceChanged(
IResourceChangeEvent event)

Handles a resource changed event by updating the enablement if one of the selected projects is opened or closed.

Specified by:: resourceChanged in interface IResourceChangeListener

Parameters:: event - the resource change event
See Also:: IResourceDelta

run

public void run()

Description copied from class: WorkspaceAction

The CoreWrapperAction implementation of this IAction method uses a ProgressMonitorDialog to run the operation. The operation calls execute (which, in turn, calls invokeOperation). Afterwards, any CoreExceptions encountered while running the operation are reported to the user via a problems dialog.

Subclasses may extend this method.

Specified by:: run in interface IAction
Overrides:: run in class WorkspaceAction

shouldPerformResourcePruning

protected boolean shouldPerformResourcePruning()

Description copied from class: WorkspaceAction

Returns whether this action should attempt to optimize the resources being operated on. This kind of pruning makes sense when the operation has depth infinity semantics (when the operation is applied explicitly to a resource then it is also applied implicitly to all the resource's descendents).

The WorkspaceAction implementation of this method returns true. Subclasses should reimplement to return false if pruning is not required.

Overrides:: shouldPerformResourcePruning in class WorkspaceAction

Returns:: true if pruning should be performed, and false if pruning is not desired

updateSelection

protected boolean updateSelection(
IStructuredSelection s)

The OpenResourceAction implementation of this SelectionListenerAction method ensures that this action is enabled only if one of the selections is a closed project.