Class/Object

scalafx.concurrent

ScheduledService

Related Docs: object ScheduledService | package concurrent

Permalink

abstract class ScheduledService[T] extends Service[T] with SFXDelegate[javafx.concurrent.ScheduledService[T]]

Wrapper class for ScheduledService Class.

Source
ScheduledService.scala
Linear Supertypes
Service[T], EventHandlerDelegate, EventTarget, Worker[T], SFXDelegate[javafx.concurrent.ScheduledService[T]], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScheduledService
  2. Service
  3. EventHandlerDelegate
  4. EventTarget
  5. Worker
  6. SFXDelegate
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScheduledService(delegate: javafx.concurrent.ScheduledService[T])

    Permalink

Type Members

  1. type EventHandled = AnyRef { ... /* 5 definitions in type refinement */ }

    Permalink

    Definition Classes
    EventHandlerDelegate
  2. sealed trait FilterMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Permalink

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate
  3. sealed trait HandlerMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Permalink

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object FilterMagnet

    Permalink

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate
  5. object HandlerMagnet

    Permalink

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate
  6. def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    Registers an event filter to this task.

    Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

    E

    Event class

    eventType

    the type of the events to receive by the filter

    eventHandler

    the filter to register that will filter event

    Definition Classes
    EventHandlerDelegate
  7. def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    Registers an event handler to this task.

    Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

    E

    Event class

    eventType

    the type of the events to receive by the handler

    eventHandler

    the handler to register that will manipulate event

    Definition Classes
    EventHandlerDelegate
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def backoffStrategy: ObjectProperty[Callback[javafx.concurrent.ScheduledService[_], Duration]]

    Permalink

    Computes the amount of time to add to the period on each failure.

  10. def backoffStrategy_=(v: Callback[javafx.concurrent.ScheduledService[_], Duration]): Unit

    Permalink
  11. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Permalink

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate
  12. def cancel: Boolean

    Permalink

    Terminates execution of this Worker.

    Terminates execution of this Worker.

    Definition Classes
    Worker
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def cumulativePeriod: ReadOnlyObjectProperty[Duration]

    Permalink

    The current cumulative period in use between iterations.

  15. def currentFailureCount: ReadOnlyIntegerProperty

    Permalink

    The current number of times the ScheduledService has failed.

  16. def delay: ObjectProperty[Duration]

    Permalink

    The initial delay between when the ScheduledService is first started, and when it will begin operation.

  17. def delay_=(v: Duration): Unit

    Permalink
  18. val delegate: javafx.concurrent.ScheduledService[T]

    Permalink

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    ScheduledServiceServiceSFXDelegate
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(ref: Any): Boolean

    Permalink

    Verifies if a object is equals to this delegate.

    Verifies if a object is equals to this delegate.

    ref

    Object to be compared.

    returns

    if the other object is equals to this delegate or not.

    Definition Classes
    SFXDelegate → AnyRef → Any
  21. def eventHandlerDelegate: EventHandled

    Permalink

    Returns a object that implements scalafx.event.EventHandlerDelegate.EventHandled.

    Returns a object that implements scalafx.event.EventHandlerDelegate.EventHandled.

    Definition Classes
    ServiceEventHandlerDelegate
  22. def exception: ReadOnlyObjectProperty[Throwable]

    Permalink

    Gets the ReadOnlyObjectProperty representing any exception which occurred.

    Gets the ReadOnlyObjectProperty representing any exception which occurred.

    Definition Classes
    Worker
  23. def executor: ObjectProperty[Executor]

    Permalink

    The executor to use for running this Service.

    The executor to use for running this Service.

    Definition Classes
    Service
  24. def executor_=(v: Executor): Unit

    Permalink
    Definition Classes
    Service
  25. def filterEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

    Permalink

    Registers an event filter.

    Registers an event filter. Registered event filters get an event before any associated event handlers.

    Example of filtering mouse events

    pane.filterEvent(MouseEvent.Any) {
      me: MouseEvent => {
        me.eventType match {
          case MouseEvent.MousePressed => {
            ...
          }
          case MouseEvent.MouseDragged => {
            ...
          }
          case _ => {
            ...
          }
        }
      }
    }

    or

    pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    filter

    code handling the event, see examples above.

    Definition Classes
    EventHandlerDelegate
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def handleEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

    Permalink

    Registers an event handler.

    Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.

    Example of handling mouse events

    pane.handleEvent(MouseEvent.Any) {
      me: MouseEvent => {
        me.eventType match {
          case MouseEvent.MousePressed => ...
          case MouseEvent.MouseDragged => ...
          case _                       => {}
        }
      }
    }

    or

    pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    handler

    code handling the event, see examples above.

    returns

    Returns a subscription that can be used to cancel/remove this event handler

    Definition Classes
    EventHandlerDelegate
  29. def hashCode(): Int

    Permalink

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. def lastValue: ReadOnlyObjectProperty[T]

    Permalink

    The last successfully computed value.

  32. def maximumCumulativePeriod: ObjectProperty[Duration]

    Permalink

    The maximum allowed value for the cumulativePeriod.

  33. def maximumCumulativePeriod_=(v: Duration): Unit

    Permalink
  34. def maximumFailureCount: IntegerProperty

    Permalink

    The maximum number of times the ScheduledService can fail before it simply ends in the FAILED state.

  35. def maximumFailureCount_=(v: Int): Unit

    Permalink
  36. def message: ReadOnlyStringProperty

    Permalink

    Gets the ReadOnlyStringProperty representing the message.

    Gets the ReadOnlyStringProperty representing the message.

    Definition Classes
    Worker
  37. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. def onCancelled: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    Permalink

    The onCancelled event handler is called whenever the Task state transitions to the CANCELLED state.

    The onCancelled event handler is called whenever the Task state transitions to the CANCELLED state.

    Definition Classes
    Service
  41. def onCancelled_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit

    Permalink
    Definition Classes
    Service
  42. def onFailed: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    Permalink

    The onFailed event handler is called whenever the Task state transitions to the FAILED state.

    The onFailed event handler is called whenever the Task state transitions to the FAILED state.

    Definition Classes
    Service
  43. def onFailed_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit

    Permalink
    Definition Classes
    Service
  44. def onReady: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    Permalink

    The onReady event handler is called whenever the Task state transitions to the READY state.

    The onReady event handler is called whenever the Task state transitions to the READY state.

    Definition Classes
    Service
  45. def onReady_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit

    Permalink
    Definition Classes
    Service
  46. def onRunning: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    Permalink

    The onRunning event handler is called whenever the Task state transitions to the RUNNING state.

    The onRunning event handler is called whenever the Task state transitions to the RUNNING state.

    Definition Classes
    Service
  47. def onRunning_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit

    Permalink
    Definition Classes
    Service
  48. def onScheduled: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    Permalink

    The onSchedule event handler is called whenever the Task state transitions to the SCHEDULED state.

    The onSchedule event handler is called whenever the Task state transitions to the SCHEDULED state.

    Definition Classes
    Service
  49. def onScheduled_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit

    Permalink
    Definition Classes
    Service
  50. def onSucceeded: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    Permalink

    The onSucceeded event handler is called whenever the Task state transitions to the SUCCEEDED state.

    The onSucceeded event handler is called whenever the Task state transitions to the SUCCEEDED state.

    Definition Classes
    Service
  51. def onSucceeded_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit

    Permalink
    Definition Classes
    Service
  52. def period: ObjectProperty[Duration]

    Permalink

    The minimum amount of time to allow between the start of the last run and the start of the next run.

  53. def period_=(v: Duration): Unit

    Permalink
  54. def progress: ReadOnlyDoubleProperty

    Permalink

    Gets the ReadOnlyDoubleProperty representing the progress.

    Gets the ReadOnlyDoubleProperty representing the progress.

    Definition Classes
    Worker
  55. def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    Unregisters a previously registered event filter from this task.

    Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the filter to unregister

    Definition Classes
    EventHandlerDelegate
  56. def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Permalink

    Unregisters a previously registered event handler from this task.

    Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the handler to unregister

    Definition Classes
    EventHandlerDelegate
  57. def reset(): Unit

    Permalink

    Resets the Service.

    Resets the Service.

    Definition Classes
    Service
  58. def restart(): Unit

    Permalink

    Cancels any currently running Task, if any, and restarts this Service.

    Cancels any currently running Task, if any, and restarts this Service.

    Definition Classes
    Service
  59. def restartOnFailure: BooleanProperty

    Permalink

    Indicates whether the ScheduledService should automatically restart in the case of a failure in the Task.

  60. def restartOnFailure_=(v: Boolean): Unit

    Permalink
  61. def running: ReadOnlyBooleanProperty

    Permalink

    Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

    Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

    Definition Classes
    Worker
  62. def start(): Unit

    Permalink

    Starts this Service.

    Starts this Service.

    Definition Classes
    Service
  63. def state: ReadOnlyObjectProperty[State]

    Permalink

    Gets the ReadOnlyObjectProperty representing the current state.

    Gets the ReadOnlyObjectProperty representing the current state.

    Definition Classes
    Worker
  64. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  65. def title: ReadOnlyStringProperty

    Permalink

    Gets the ReadOnlyStringProperty representing the title.

    Gets the ReadOnlyStringProperty representing the title.

    Definition Classes
    Worker
  66. def toString(): String

    Permalink

    returns

    Returns the original delegate's toString() adding a [SFX] prefix.

    Definition Classes
    SFXDelegate → AnyRef → Any
  67. def totalWork: ReadOnlyDoubleProperty

    Permalink

    Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done.

    Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done.

    Definition Classes
    Worker
  68. def value: ReadOnlyObjectProperty[T]

    Permalink

    Gets the ReadOnlyObjectProperty representing the value.

    Gets the ReadOnlyObjectProperty representing the value.

    Definition Classes
    Worker
  69. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. def workDone: ReadOnlyDoubleProperty

    Permalink

    Gets the ReadOnlyDoubleProperty representing the current progress.

    Gets the ReadOnlyDoubleProperty representing the current progress.

    Definition Classes
    Worker

Inherited from Service[T]

Inherited from EventHandlerDelegate

Inherited from EventTarget

Inherited from Worker[T]

Inherited from SFXDelegate[javafx.concurrent.ScheduledService[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped