|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.actions.BaseSelectionListenerAction
org.eclipse.ui.actions.SelectionListenerAction
org.eclipse.ui.actions.WorkspaceAction
org.eclipse.ui.actions.RefreshAction
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:
Field Summary | |
static String |
ID
The id of this action. |
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 | |
RefreshAction(IShellProvider provider)
Creates a new action. |
|
RefreshAction(Shell shell)
Deprecated. See RefreshAction(IShellProvider) |
Method Summary | |
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 |
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. |
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.AbstractAction |
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener |
Methods inherited from class org.eclipse.core.commands.common.EventManager |
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.action.IAction |
addPropertyChangeListener, removePropertyChangeListener |
Field Detail |
public static final String ID
Constructor Detail |
public RefreshAction(Shell shell)
RefreshAction(IShellProvider)
shell
- the shell for any dialogspublic RefreshAction(IShellProvider provider)
provider
- the IShellProvider for any dialogs.Method Detail |
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 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
public 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 monitor
CoreException
- 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
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.