public class OpenResourceAction extends WorkspaceAction implements IResourceChangeListener
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.
Modifier and Type | Field and Description |
---|---|
static String |
ID
The id of this action.
|
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 and Description |
---|
OpenResourceAction(IShellProvider provider)
Creates a new action.
|
OpenResourceAction(Shell shell)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
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. |
createOperation, getActionResources, runInBackground, runInBackground, runInBackground
clearCache, getSelectedNonResources, getSelectedResources, resourceIsType, selectionIsOfType
getStructuredSelection, runWithEvent, selectionChanged, selectionChanged
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
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
public static final String ID
@Deprecated public OpenResourceAction(Shell shell)
OpenResourceAction(IShellProvider)
shell
- the shell for any dialogspublic OpenResourceAction(IShellProvider provider)
provider
- the shell for any dialogsprotected String getOperationMessage()
WorkspaceAction
Note that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
getOperationMessage
in class WorkspaceAction
protected String getProblemsMessage()
WorkspaceAction
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.
getProblemsMessage
in class WorkspaceAction
protected String getProblemsTitle()
WorkspaceAction
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.
getProblemsTitle
in class WorkspaceAction
protected void invokeOperation(IResource resource, IProgressMonitor monitor) throws CoreException
WorkspaceAction
Note that this method is invoked in a non-UI thread.
Subclasses must implement this method.
invokeOperation
in class WorkspaceAction
resource
- one of the selected resourcesmonitor
- a progress monitorCoreException
- if the operation failspublic void resourceChanged(IResourceChangeEvent event)
resourceChanged
in interface IResourceChangeListener
event
- the resource change eventIResourceDelta
public void run()
WorkspaceAction
CoreWrapperAction
implementation of this
IAction
method uses a ProgressMonitorDialog
to run the operation. The operation calls execute
(which,
in turn, calls invokeOperation
). Afterwards, any
CoreException
s encountered while running the operation
are reported to the user via a problems dialog.
Subclasses may extend this method.
run
in interface IAction
run
in class WorkspaceAction
How radio buttons are handled
,
How check boxes are handled
protected boolean shouldPerformResourcePruning()
WorkspaceAction
The WorkspaceAction
implementation of this method returns
true
. Subclasses should reimplement to return
false
if pruning is not required.
shouldPerformResourcePruning
in class WorkspaceAction
true
if pruning should be performed, and
false
if pruning is not desiredprotected boolean updateSelection(IStructuredSelection s)
OpenResourceAction
implementation of this
SelectionListenerAction
method ensures that this action is
enabled only if one of the selections is a closed project.updateSelection
in class WorkspaceAction
s
- the new selectiontrue
if the action should be enabled for this selection,
and false
otherwise
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.