Interface IProgressService

    • Method Detail

      • getLongOperationTime

        int getLongOperationTime()
        The time at which an operation becomes considered a long operation. Used to determine when the busy cursor will be replaced with a progress monitor.
        Returns:
        int
        See Also:
        busyCursorWhile(IRunnableWithProgress)
      • registerIconForFamily

        void registerIconForFamily​(ImageDescriptor icon,
                                   Object family)
        Register the ImageDescriptor to be the icon used for all jobs that belong to family within the workbench.
        Parameters:
        icon - ImageDescriptor that will be used when the job is being displayed
        family - The family to associate with
        See Also:
        Job.belongsTo(Object)
      • runInUI

        void runInUI​(IRunnableContext context,
                     IRunnableWithProgress runnable,
                     ISchedulingRule rule)
              throws InvocationTargetException,
                     InterruptedException
        Runs the given operation in the UI thread using the given runnable context. The given scheduling rule, if any, will be acquired for the duration of the operation. If the rule is not available when this method is called, a progress dialog will be displayed that gives users control over the background processes that may be blocking the runnable from proceeding.

        This method can act as a wrapper for uses of IRunnableContext where the fork parameter was false.

        Note: Running long operations in the UI thread is generally not recommended. This can result in the UI becoming unresponsive for the duration of the operation. Where possible, busyCursorWhile should be used instead.

        Modal dialogs should also be avoided in the runnable as there will already be a modal progress dialog open when this operation runs.

        Parameters:
        context - The runnable context to run the operation in
        runnable - The operation to run
        rule - A scheduling rule, or null
        Throws:
        InvocationTargetException - wraps any exception or error which occurs while running the runnable
        InterruptedException - propagated by the context if the runnable acknowledges cancelation by throwing this exception.
        See Also:
        Dialog, SWT.APPLICATION_MODAL
      • getIconFor

        Image getIconFor​(Job job)
        Get the icon that has been registered for a Job by checking if the job belongs to any of the registered families.
        Parameters:
        job -
        Returns:
        Icon or null if there isn't one.
        See Also:
        registerIconForFamily(ImageDescriptor,Object)
      • run

        void run​(boolean fork,
                 boolean cancelable,
                 IRunnableWithProgress runnable)
          throws InvocationTargetException,
                 InterruptedException
        This specialization of IRunnableContext#run(boolean, boolean, IRunnableWithProgress) might run the runnable asynchronously if fork is true.
        Specified by:
        run in interface IRunnableContext
        Parameters:
        fork - true if the runnable should be run in a separate thread, and false to run in the same thread
        cancelable - true to enable the cancelation, and false to make the operation uncancellable
        runnable - the runnable to run
        Throws:
        InvocationTargetException - wraps any exception or error which occurs while running the runnable
        InterruptedException - propagated by the context if the runnable acknowledges cancelation by throwing this exception. This should not be thrown if cancelable is false.
        Since:
        3.2
      • showInDialog

        void showInDialog​(Shell shell,
                          Job job)
        Open a dialog on job when it starts to run and close it when the job is finished. Wait for ProgressManagerUtil#SHORT_OPERATION_TIME before opening the dialog. Do not open if it is already done or if the user has set a preference to always run in the background. Parent the dialog from the shell.
        Parameters:
        shell - The Shell to parent the dialog from or null if the active shell is to be used.
        job - The Job that will be reported in the dialog. job must not be null.