Class WorkspaceAction
- All Implemented Interfaces:
IAction
,ISelectionChangedListener
- Direct Known Subclasses:
BuildAction
,CloseResourceAction
,OpenResourceAction
,RefreshAction
,RenameResourceAction
,ScrubLocalAction
Subclasses must implement the following methods:
invokeOperation
- to perform the operation on one of the selected resourcesgetOperationMessage
- to furnish a title for the progress dialog
Subclasses may override the following methods:
shouldPerformResourcePruning
- reimplement to turn offupdateSelection
- extend to refine enablement criteriagetProblemsTitle
- reimplement to furnish a title for the problems dialoggetProblemsMessage
- reimplement to furnish a message for the problems dialogrun
- extend to
-
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
ModifierConstructorDescriptionprotected
WorkspaceAction
(IShellProvider provider, String text) Creates a new action with the given text.protected
WorkspaceAction
(Shell shell, String text) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionprotected IRunnableWithProgress
createOperation
(IStatus[] errorStatus) Returns the operation to perform when this action runs.Returns the elements that the action is to be performed on.protected abstract 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) Deprecated.Since 3.3, subclasses should instead implement the methodcreateOperation(IStatus[])
and provide an empty implementation for this method.void
run()
TheCoreWrapperAction
implementation of thisIAction
method uses aProgressMonitorDialog
to run the operation.void
Run the action in the background rather than with the progress dialog.void
runInBackground
(ISchedulingRule rule, Object jobFamily) Run the action in the background rather than with the progress dialog.void
runInBackground
(ISchedulingRule rule, Object[] jobFamilies) Run the action in the background rather than with the progress dialog.protected boolean
Returns whether this action should attempt to optimize the resources being operated on.protected boolean
updateSelection
(IStructuredSelection selection) TheWorkspaceAction
implementation of thisSelectionListenerAction
method ensures that this action is disabled if any of the selected resources are inaccessible.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
-
Constructor Details
-
WorkspaceAction
Deprecated.Creates a new action with the given text.- Parameters:
shell
- the shell (for the modal progress dialog and error messages)text
- the string used as the text for the action, ornull
if there is no text
-
WorkspaceAction
Creates a new action with the given text.- Parameters:
provider
- the shell provider (for the modal progress dialog and error messages)text
- the string used as the text for the action, ornull
if there is no text- Since:
- 3.4
-
-
Method Details
-
getOperationMessage
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.
- Returns:
- the message
- Since:
- 3.1
-
getProblemsMessage
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.- Returns:
- the problems message
- Since:
- 3.1
-
getProblemsTitle
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.- Returns:
- the problems dialog title
- Since:
- 3.1
-
invokeOperation
@Deprecated protected void invokeOperation(IResource resource, IProgressMonitor monitor) throws CoreException Deprecated.Since 3.3, subclasses should instead implement the methodcreateOperation(IStatus[])
and provide an empty implementation for this method.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.
- Parameters:
resource
- one of the selected resourcesmonitor
- a progress monitor- Throws:
CoreException
- if the operation fails- Since:
- 3.1
-
run
public void run()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.
-
shouldPerformResourcePruning
protected boolean shouldPerformResourcePruning()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.- Returns:
true
if pruning should be performed, andfalse
if pruning is not desired- Since:
- 3.1
-
updateSelection
TheWorkspaceAction
implementation of thisSelectionListenerAction
method ensures that this action is disabled if any of the selected resources are inaccessible. Subclasses may extend to react to selection changes; however, if the super method returnsfalse
, the overriding method should also returnfalse
.- Overrides:
updateSelection
in classBaseSelectionListenerAction
- Parameters:
selection
- the new selection- Returns:
true
if the action should be enabled for this selection, andfalse
otherwise
-
getActionResources
Returns the elements that the action is to be performed on. By default return the selected resources.Subclasses may override this method.
- Returns:
- list of resource elements (element type:
IResource
)
-
runInBackground
Run the action in the background rather than with the progress dialog.- Parameters:
rule
- The rule to apply to the background job ornull
if there isn't one.
-
runInBackground
Run the action in the background rather than with the progress dialog.- Parameters:
rule
- The rule to apply to the background job ornull
if there isn't one.jobFamily
- a single family that the job should belong to ornull
if none.- Since:
- 3.1
-
runInBackground
Run the action in the background rather than with the progress dialog.- Parameters:
rule
- The rule to apply to the background job ornull
if there isn't one.jobFamilies
- the families the job should belong to ornull
if none.- Since:
- 3.1
-
createOperation
Returns the operation to perform when this action runs. The returned operation must be anIRunnableWithProgress
that will perform the action's work. The default implementation returns an operation that will iterate over the selected resources and callinvokeOperation(IResource, IProgressMonitor)
for each resource. Subclasses must either implementinvokeOperation(IResource, IProgressMonitor)
or override this method to provide a different operation. Subclasses typically override this method when an undoable operation is to be provided.- Parameters:
errorStatus
- an array of error status objects to which the result of running the operation should be added.- Returns:
- the operation to perform when this action runs.
- Since:
- 3.3
-
WorkspaceAction(IShellProvider, String)