public class RefreshAction extends WorkspaceAction
This class may be instantiated; it may also subclass to extend:
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 |
---|
RefreshAction(IShellProvider provider)
Creates a new action.
|
RefreshAction(Shell shell)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected IRunnableWithProgress |
createOperation(IStatus[] errorStatus)
Returns the operation to perform when this action runs.
|
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 List<? extends IResource> |
getSelectedResources()
Returns a list containing the workspace root if the selection would
otherwise be empty.
|
void |
handleKeyReleased(KeyEvent event)
Handle the key release.
|
void |
refreshAll()
Refreshes the entire workspace.
|
protected void |
refreshResource(IResource resource,
IProgressMonitor monitor)
Refresh the resource (with a check for deleted projects).
|
void |
run()
The
CoreWrapperAction implementation of this
IAction method uses a ProgressMonitorDialog
to run the operation. |
protected boolean |
updateSelection(IStructuredSelection s)
The
RefreshAction implementation of this
SelectionListenerAction method ensures that this action is
enabled if the selection is empty, but is disabled if any of the selected
elements are not resources. |
getActionResources, invokeOperation, runInBackground, runInBackground, runInBackground, shouldPerformResourcePruning
clearCache, getSelectedNonResources, 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 RefreshAction(Shell shell)
RefreshAction(IShellProvider)
shell
- the shell for any dialogspublic RefreshAction(IShellProvider provider)
provider
- the IShellProvider for any dialogs.protected 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 List<? extends IResource> getSelectedResources()
getSelectedResources
in class SelectionListenerAction
IResource
)protected boolean updateSelection(IStructuredSelection s)
RefreshAction
implementation of this
SelectionListenerAction
method ensures that this action is
enabled if the selection is empty, but is disabled if any of the selected
elements are not resources.updateSelection
in class WorkspaceAction
s
- the new selectiontrue
if the action should be enabled for this selection,
and false
otherwisepublic void handleKeyReleased(KeyEvent event)
event
- the eventpublic final void refreshAll()
protected final IRunnableWithProgress createOperation(IStatus[] errorStatus)
WorkspaceAction
IRunnableWithProgress
that will perform the
action's work. The default implementation returns an operation that will
iterate over the selected resources and call
WorkspaceAction.invokeOperation(IResource, IProgressMonitor)
for each resource.
Subclasses must either implement
WorkspaceAction.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.createOperation
in class WorkspaceAction
errorStatus
- an array of error status objects to which the result of
running the operation should be added.protected void refreshResource(IResource resource, IProgressMonitor monitor) throws CoreException
This method may be extended to refresh model objects related to the resource.
resource
- the resource to refresh. Must not be null
.monitor
- progress monitorCoreException
- if things go wrongpublic 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
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.