Class SoSystemTimer

  • All Implemented Interfaces:
    Direct Known Subclasses:
    Timer, Timer

    public abstract class SoSystemTimer
    extends Inventor
    implements SafeDisposable
    Common interface to expose system dependent timers. The timer implementation usually depends on the window toolkit used (Qt, Awt, Swt...). The purpose of this class is to expose a common interface for system dependent timers. When the timer is triggered, it must call the run() method of its SoSystemTimerTask (given by the setTask method).


    • Method Detail

      • dispose

        public boolean dispose()
        Description copied from class: Inventor
        Explicitly call this method to force object to dispose its unmanaged resources. The object may not be reused in the application code after this call.
        Specified by:
        dispose in interface SafeDisposable
        dispose in class Inventor
        true if this object native resources were successfully disposed; false if it was already disposed or no native resources has been registered for this object.
      • stop

        public void stop()
        Stop the timer.
      • start

        public void start()
        Start the timer. If it is already started, stop it and restart
      • setRepeat

        public void setRepeat​(boolean flag)
        If set to true, the timer will be triggered periodically at the rate defined by setDelay.
      • setTask

        public void setTask​(SoSystemTimerTask task)
        Sets the task executed when the timer is triggered. When the timer is is triggered, it calls the run() method of task.
      • isPending

        public boolean isPending()
        Return true if the timer is running.
      • setDelay

        public void setDelay​(int time)
        Set the timer's timeout in milliseconds.