Class OpenResourceAction
- All Implemented Interfaces:
EventListener
,IResourceChangeListener
,IAction
,ISelectionChangedListener
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 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
Fields inherited from interface org.eclipse.core.resources.IResourceChangeListener
PROPERTY_EVENT_MASK
-
Constructor Summary
ConstructorDescriptionOpenResourceAction
(IShellProvider provider) Creates a new action.OpenResourceAction
(Shell shell) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionprotected String
Returns the string to display for this action's operation.protected String
Returns the string to display for this action's problems dialog.protected String
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
Handles a resource changed event by updating the enablement if one of the selected projects is opened or closed.void
run()
TheCoreWrapperAction
implementation of thisIAction
method uses aProgressMonitorDialog
to run the operation.protected boolean
Returns whether this action should attempt to optimize the resources being operated on.protected boolean
TheOpenResourceAction
implementation of thisSelectionListenerAction
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
-
Field Details
-
ID
The id of this action.- See Also:
-
-
Constructor Details
-
OpenResourceAction
Deprecated.Creates a new action.- Parameters:
shell
- the shell for any dialogs
-
OpenResourceAction
Creates a new action.- Parameters:
provider
- the shell for any dialogs- Since:
- 3.4
-
-
Method Details
-
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 classWorkspaceAction
- Returns:
- the message
-
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 classWorkspaceAction
- Returns:
- the problems message
-
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 classWorkspaceAction
- Returns:
- the problems dialog title
-
invokeOperation
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 classWorkspaceAction
- Parameters:
resource
- one of the selected resourcesmonitor
- a progress monitor- Throws:
CoreException
- if the operation fails
-
resourceChanged
Handles a resource changed event by updating the enablement if one of the selected projects is opened or closed.- Specified by:
resourceChanged
in interfaceIResourceChangeListener
- Parameters:
event
- the resource change event- See Also:
-
run
public void run()Description copied from class:WorkspaceAction
TheCoreWrapperAction
implementation of thisIAction
method uses aProgressMonitorDialog
to run the operation. The operation callsexecute
(which, in turn, callsinvokeOperation
). Afterwards, anyCoreException
s encountered while running the operation are reported to the user via a problems dialog.Subclasses may extend this method.
- Specified by:
run
in interfaceIAction
- Overrides:
run
in classWorkspaceAction
- See Also:
-
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 returnstrue
. Subclasses should reimplement to returnfalse
if pruning is not required.- Overrides:
shouldPerformResourcePruning
in classWorkspaceAction
- Returns:
true
if pruning should be performed, andfalse
if pruning is not desired
-
updateSelection
TheOpenResourceAction
implementation of thisSelectionListenerAction
method ensures that this action is enabled only if one of the selections is a closed project.- Overrides:
updateSelection
in classWorkspaceAction
- Parameters:
s
- the new selection- Returns:
true
if the action should be enabled for this selection, andfalse
otherwise
-
OpenResourceAction(IShellProvider)