Package org.eclipse.ui.actions
Class RefreshAction
- All Implemented Interfaces:
IAction
,ISelectionChangedListener
Standard action for refreshing the workspace from the local file system for
the selected resources and all of their descendants.
This class may be instantiated; it may also subclass to extend:
- getSelectedResources - A list containing 0 or more resources to be refreshed
- updateSelection - controls when this action is enabled
- refreshResource - can be extended to refresh model objects related to the resource
-
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
ConstructorDescriptionRefreshAction
(IShellProvider provider) Creates a new action.RefreshAction
(Shell shell) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionprotected final IRunnableWithProgress
createOperation
(IStatus[] errorStatus) Returns the operation to perform when this action runs.protected 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.Returns a list containing the workspace root if the selection would otherwise be empty.void
handleKeyReleased
(KeyEvent event) Handle the key release.final void
Refreshes the entire workspace.protected void
refreshResource
(IResource resource, IProgressMonitor monitor) Refresh the resource (with a check for deleted projects).void
run()
TheCoreWrapperAction
implementation of thisIAction
method uses aProgressMonitorDialog
to run the operation.protected boolean
TheRefreshAction
implementation of thisSelectionListenerAction
method ensures that this action is enabled if the selection is empty, but is disabled if any of the selected elements are not resources.Methods inherited from class org.eclipse.ui.actions.WorkspaceAction
getActionResources, invokeOperation, runInBackground, runInBackground, runInBackground, shouldPerformResourcePruning
Methods inherited from class org.eclipse.ui.actions.SelectionListenerAction
clearCache, getSelectedNonResources, 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
-
RefreshAction
Deprecated.Creates a new action.- Parameters:
shell
- the shell for any dialogs
-
RefreshAction
Creates a new action.- Parameters:
provider
- the IShellProvider 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
-
getSelectedResources
Returns a list containing the workspace root if the selection would otherwise be empty.- Overrides:
getSelectedResources
in classSelectionListenerAction
- Returns:
- list of resource elements (element type:
IResource
)
-
updateSelection
TheRefreshAction
implementation of thisSelectionListenerAction
method ensures that this action is enabled if the selection is empty, but is disabled if any of the selected elements are not resources.- Overrides:
updateSelection
in classWorkspaceAction
- Parameters:
s
- the new selection- Returns:
true
if the action should be enabled for this selection, andfalse
otherwise
-
handleKeyReleased
Handle the key release.- Parameters:
event
- the event
-
refreshAll
public final void refreshAll()Refreshes the entire workspace. -
createOperation
Description copied from class:WorkspaceAction
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 callWorkspaceAction.invokeOperation(IResource, IProgressMonitor)
for each resource. Subclasses must either implementWorkspaceAction.invokeOperation(IResource, IProgressMonitor)
or override this method to provide a different operation. Subclasses typically override this method when an undoable operation is to be provided.- Overrides:
createOperation
in classWorkspaceAction
- 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.
-
refreshResource
Refresh the resource (with a check for deleted projects).This method may be extended to refresh model objects related to the resource.
- Parameters:
resource
- the resource to refresh. Must not benull
.monitor
- progress monitor- Throws:
CoreException
- if things go wrong- Since:
- 3.4
-
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:
-
RefreshAction(IShellProvider)