Class 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 descendants.

    This class may be instantiated; it may also subclass to extend:

    • getSelectedResources - A list containing 0 or more resources to be refreshed
    • updateSelection - controls when this action is enabled
    • refreshResource - can be extended to refresh model objects related to the resource
    • Constructor Detail

      • RefreshAction

        public RefreshAction​(IShellProvider provider)
        Creates a new action.
        Parameters:
        provider - the IShellProvider for any dialogs.
        Since:
        3.4
    • 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<? extends IResource> 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.
        Parameters:
        event - the event
      • refreshAll

        public final void refreshAll()
        Refreshes the entire workspace.
      • refreshResource

        protected void refreshResource​(IResource resource,
                                       IProgressMonitor monitor)
                                throws CoreException
        Refresh the resource (with a check for deleted projects).

        This method may be extended to refresh model objects related to the resource.

        Parameters:
        resource - the resource to refresh. Must not be null.
        monitor - progress monitor
        Throws:
        CoreException - if things go wrong
        Since:
        3.4
      • 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
        See Also:
        How radio buttons are handled, How check boxes are handled