Eclipse Platform
Release 3.1

org.eclipse.ui.actions
Class RefreshAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended byorg.eclipse.ui.actions.BaseSelectionListenerAction
          extended byorg.eclipse.ui.actions.SelectionListenerAction
              extended byorg.eclipse.ui.actions.WorkspaceAction
                  extended byorg.eclipse.ui.actions.RefreshAction
All Implemented Interfaces:
IAction, ISelectionChangedListener

public class RefreshAction
extends WorkspaceAction

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 org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
The id of this action.

See Also:
Constant Field Values
Constructor Detail

RefreshAction

public RefreshAction(Shell shell)
Creates a new action.

Parameters:
shell - the shell for any dialogs
Method Detail

getOperationMessage

protected String 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 class WorkspaceAction
Returns:
the message

getProblemsMessage

protected String 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 class WorkspaceAction
Returns:
the problems message

getProblemsTitle

protected String 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 class WorkspaceAction
Returns:
the problems dialog title

getSelectedResources

protected List getSelectedResources()
Returns a list containing the workspace root if the selection would otherwise be empty.

Overrides:
getSelectedResources in class SelectionListenerAction
Returns:
list of resource elements (element type: IResource)

invokeOperation

protected void invokeOperation(IResource resource,
                               IProgressMonitor monitor)
                        throws CoreException
Description copied from class: WorkspaceAction
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.

Specified by:
invokeOperation in class WorkspaceAction
Parameters:
resource - one of the selected resources
monitor - a progress monitor
Throws:
CoreException - if the operation fails

updateSelection

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.

Overrides:
updateSelection in class WorkspaceAction

handleKeyReleased

public void handleKeyReleased(KeyEvent event)
Handle the key release.

Parameters:
event - the event

refreshAll

public void refreshAll()
Refreshes the entire workspace.


run

public void run()
Description copied from class: WorkspaceAction
The CoreWrapperAction implementation of this IAction method uses a ProgressMonitorDialog to run the operation. The operation calls execute (which, in turn, calls invokeOperation). Afterwards, any CoreExceptions encountered while running the operation are reported to the user via a problems dialog.

Subclasses may extend this method.

Specified by:
run in interface IAction
Overrides:
run in class WorkspaceAction

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.