Class OpenResourceAction
-
- All Implemented Interfaces:
EventListener,IResourceChangeListener,IAction,ISelectionChangedListener
public class OpenResourceAction 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
Fields Modifier and Type Field Description static StringIDThe 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
Constructors Constructor Description OpenResourceAction(IShellProvider provider)Creates a new action.OpenResourceAction(Shell shell)Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringgetOperationMessage()Returns the string to display for this action's operation.protected StringgetProblemsMessage()Returns the string to display for this action's problems dialog.protected StringgetProblemsTitle()Returns the title for this action's problems dialog.protected voidinvokeOperation(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.voidresourceChanged(IResourceChangeEvent event)Handles a resource changed event by updating the enablement if one of the selected projects is opened or closed.voidrun()TheCoreWrapperActionimplementation of thisIActionmethod uses aProgressMonitorDialogto run the operation.protected booleanshouldPerformResourcePruning()Returns whether this action should attempt to optimize the resources being operated on.protected booleanupdateSelection(IStructuredSelection s)TheOpenResourceActionimplementation of thisSelectionListenerActionmethod 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
-
-
-
-
Field Detail
-
ID
public static final String ID
The id of this action.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
OpenResourceAction
@Deprecated public OpenResourceAction(Shell shell)
Deprecated.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:WorkspaceActionReturns 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:
getOperationMessagein classWorkspaceAction- Returns:
- the message
-
getProblemsMessage
protected String getProblemsMessage()
Description copied from class:WorkspaceActionReturns the string to display for this action's problems dialog.The
WorkspaceActionimplementation 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:
getProblemsMessagein classWorkspaceAction- Returns:
- the problems message
-
getProblemsTitle
protected String getProblemsTitle()
Description copied from class:WorkspaceActionReturns the title for this action's problems dialog.The
WorkspaceActionimplementation of this method returns a generic title (localized counterpart of "Problems"). Subclasses may reimplement to provide something more suited to the particular action.- Overrides:
getProblemsTitlein classWorkspaceAction- Returns:
- the problems dialog title
-
invokeOperation
protected void invokeOperation(IResource resource, IProgressMonitor monitor) throws CoreException
Description copied from class:WorkspaceActionPerforms 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:
invokeOperationin classWorkspaceAction- Parameters:
resource- one of the selected resourcesmonitor- 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:
resourceChangedin interfaceIResourceChangeListener- Parameters:
event- the resource change event- See Also:
IResourceDelta
-
run
public void run()
Description copied from class:WorkspaceActionTheCoreWrapperActionimplementation of thisIActionmethod uses aProgressMonitorDialogto run the operation. The operation callsexecute(which, in turn, callsinvokeOperation). Afterwards, anyCoreExceptions encountered while running the operation are reported to the user via a problems dialog.Subclasses may extend this method.
- Specified by:
runin interfaceIAction- Overrides:
runin classWorkspaceAction- See Also:
How radio buttons are handled,How check boxes are handled
-
shouldPerformResourcePruning
protected boolean shouldPerformResourcePruning()
Description copied from class:WorkspaceActionReturns 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
WorkspaceActionimplementation of this method returnstrue. Subclasses should reimplement to returnfalseif pruning is not required.- Overrides:
shouldPerformResourcePruningin classWorkspaceAction- Returns:
trueif pruning should be performed, andfalseif pruning is not desired
-
updateSelection
protected boolean updateSelection(IStructuredSelection s)
TheOpenResourceActionimplementation of thisSelectionListenerActionmethod ensures that this action is enabled only if one of the selections is a closed project.- Overrides:
updateSelectionin classWorkspaceAction- Parameters:
s- the new selection- Returns:
trueif the action should be enabled for this selection, andfalseotherwise
-
-