org.eclipse.ui.actions
Class RefreshAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.actions.SelectionListenerAction
              |
              +--org.eclipse.ui.actions.WorkspaceAction
                    |
                    +--org.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, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT

Constructor Summary

RefreshAction(Shell shell)
Creates a new action.

Method Summary

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 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, run

Methods inherited from class org.eclipse.ui.actions.SelectionListenerAction

getSelectedNonResources, getStructuredSelection, resourceIsType, selectionChanged, selectionChanged, selectionIsOfType

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, removeAcceleratorText, removePropertyChangeListener, runWithEvent, 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

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)

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

Parameters:

s - the new selection

Returns:

true if the action should be enabled for this selection, and false otherwise

handleKeyReleased

public void handleKeyReleased(KeyEvent event)

Handle the key release.

refreshAll

public void refreshAll()

Refreshes the entire workspace.