Package org.eclipse.nebula.widgets.xviewer.util.internal

Class XViewerWorkbenchJob

java.lang.Object
org.eclipse.core.runtime.PlatformObject
org.eclipse.core.internal.jobs.InternalJob
org.eclipse.core.runtime.jobs.Job
org.eclipse.nebula.widgets.xviewer.util.internal.XViewerUIJob
org.eclipse.nebula.widgets.xviewer.util.internal.XViewerWorkbenchJob
All Implemented Interfaces:
java.lang.Comparable, org.eclipse.core.runtime.IAdaptable
public abstract class XViewerWorkbenchJob
extends XViewerUIJob
WorkbenchJob is a type of job that implements a done listener and does the shutdown checks before scheduling. This is used if a job is not meant to run when the Workbench is shutdown.
Since:
3.0

  • Field Summary

    Fields inherited from class org.eclipse.core.runtime.jobs.Job

    ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING

    Fields inherited from class org.eclipse.core.internal.jobs.InternalJob

    manager

  • Constructor Summary

    Constructors 
    Constructor Description
    XViewerWorkbenchJob​(java.lang.String name)
    Add a new instance of the reciever with the supplied name.
    XViewerWorkbenchJob​(org.eclipse.swt.widgets.Display jobDisplay, java.lang.String name)
    Create a new instance of the receiver with the supplied display and name.

  • Method Summary

    Modifier and Type Method Description
    void performDone​(org.eclipse.core.runtime.jobs.IJobChangeEvent event)
    Perform done with the supplied event.
    boolean shouldRun()
    (non-Javadoc)
    boolean shouldSchedule()  

    Methods inherited from class org.eclipse.nebula.widgets.xviewer.util.internal.XViewerUIJob

    errorStatus, getDisplay, run, runInUIThread, setDisplay

    Methods inherited from class org.eclipse.core.runtime.jobs.Job

    addJobChangeListener, belongsTo, cancel, canceling, create, create, createSystem, createSystem, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, sleep, toString, wakeUp, wakeUp, yieldRule

    Methods inherited from class org.eclipse.core.internal.jobs.InternalJob

    compareTo

    Methods inherited from class org.eclipse.core.runtime.PlatformObject

    getAdapter

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • XViewerWorkbenchJob

      public XViewerWorkbenchJob​(org.eclipse.swt.widgets.Display jobDisplay, java.lang.String name)
      Create a new instance of the receiver with the supplied display and name. Normally this constructor would not be used as it is best to let the job find the display from the workbench
      Parameters:
      jobDisplay - Display. The display to run the job with.
      name - String

    • XViewerWorkbenchJob

      public XViewerWorkbenchJob​(java.lang.String name)
      Add a new instance of the reciever with the supplied name.
      Parameters:
      name - String

  • Method Details

    • performDone

      public void performDone​(org.eclipse.core.runtime.jobs.IJobChangeEvent event)
      Perform done with the supplied event. This will only occur if the returned status was OK. This is called only if the job is finished with an IStatus.OK result and the workbench is still running.
      Parameters:
      event - IJobChangeEvent

    • shouldSchedule

      public boolean shouldSchedule()
      Overrides:
      shouldSchedule in class org.eclipse.core.runtime.jobs.Job
      See Also:
      Job.shouldSchedule()

    • shouldRun

      public boolean shouldRun()
      (non-Javadoc)
      Overrides:
      shouldRun in class org.eclipse.core.runtime.jobs.Job
      See Also:
      Job.shouldRun()