|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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 descendents.
This class may be instantiated; it is not intended to be subclassed.
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(Shell shell)
Creates a new action. |
Method Summary | |
---|---|
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. |
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 |
refreshAll()
Refreshes the entire workspace. |
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, 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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String ID
Constructor Detail |
public RefreshAction(Shell shell)
shell
- the shell for any dialogsMethod 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 void invokeOperation(IResource resource, IProgressMonitor monitor) throws CoreException
WorkspaceAction
Note that this method is invoked in a non-UI thread.
Subclasses must implement this method.
invokeOperation
in class WorkspaceAction
resource
- one of the selected resourcesmonitor
- a progress monitor
CoreException
- if the operation failsprotected 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 void refreshAll()
public 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.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.