Service

abstract class Service[T](val delegate: Service[T]) extends Worker[T] with EventTarget with EventHandlerDelegate2 with SFXDelegate[Service[T]]

Wrapper trait for Service Class.

Wrapper trait for Service Class.

Companion
object
trait EventTarget
trait Worker[T]
trait SFXDelegate[Service[T]]
class Object
trait Matchable
class Any

Type members

Inherited classlikes

Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate2.EventHandled Type:

Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate2.EventHandled Type:

def addEventHandler   [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def removeEventHandler[E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def addEventFilter    [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def removeEventFilter [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def buildEventDispatchChain(chain: jfxe.EventDispatchChain): jfxe.EventDispatchChain
Inherited from
EventHandlerDelegate2
object FilterMagnet

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"

Inherited from
EventHandlerDelegate2
sealed trait FilterMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Inherited from
EventHandlerDelegate2
sealed trait HandlerMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Inherited from
EventHandlerDelegate2

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"

Inherited from
EventHandlerDelegate2

Value members

Concrete methods

def executor: ObjectProperty[Executor]

The executor to use for running this Service.

The executor to use for running this Service.

def executor_=(v: Executor): Unit
def onCancelled: ObjectProperty[EventHandler[WorkerStateEvent]]

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.

def onCancelled_=(v: EventHandler[WorkerStateEvent]): Unit
def onFailed: ObjectProperty[EventHandler[WorkerStateEvent]]

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.

def onFailed_=(v: EventHandler[WorkerStateEvent]): Unit
def onReady: ObjectProperty[EventHandler[WorkerStateEvent]]

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.

def onReady_=(v: EventHandler[WorkerStateEvent]): Unit
def onRunning: ObjectProperty[EventHandler[WorkerStateEvent]]

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.

def onRunning_=(v: EventHandler[WorkerStateEvent]): Unit
def onScheduled: ObjectProperty[EventHandler[WorkerStateEvent]]

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.

def onScheduled_=(v: EventHandler[WorkerStateEvent]): Unit
def onSucceeded: ObjectProperty[EventHandler[WorkerStateEvent]]

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.

def onSucceeded_=(v: EventHandler[WorkerStateEvent]): Unit
def reset(): Unit

Resets the Service.

Resets the Service.

def restart(): Unit

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

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

def start(): Unit

Starts this Service.

Starts this Service.

Inherited methods

def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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

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

Type Params
E

Event class

Value Params
eventHandler

the filter to register that will filter event

eventType

the type of the events to receive by the filter

Inherited from
EventHandlerDelegate2
def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to register that will manipulate event

eventType

the type of the events to receive by the handler

Inherited from
EventHandlerDelegate2
def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target.

Construct an event dispatch chain for this target.

Inherited from
EventHandlerDelegate2
def cancel: Boolean

Terminates execution of this Worker.

Terminates execution of this Worker.

Inherited from
Worker
override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value Params
ref

Object to be compared.

Returns

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

Definition Classes
Inherited from
SFXDelegate

Gets the ReadOnlyObjectProperty representing any exception which occurred.

Gets the ReadOnlyObjectProperty representing any exception which occurred.

Inherited from
Worker
def filterEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

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

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Inherited from
EventHandlerDelegate2
def handleEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

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.

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
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

Inherited from
EventHandlerDelegate2
override def hashCode: Int
Returns

The delegate hashcode

Definition Classes
Inherited from
SFXDelegate

Gets the ReadOnlyStringProperty representing the message.

Gets the ReadOnlyStringProperty representing the message.

Inherited from
Worker

Gets the ReadOnlyDoubleProperty representing the progress.

Gets the ReadOnlyDoubleProperty representing the progress.

Inherited from
Worker
def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the filter to unregister

eventType

the event type from which to unregister

Inherited from
EventHandlerDelegate2
def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to unregister

eventType

the event type from which to unregister

Inherited from
EventHandlerDelegate2

Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

Inherited from
Worker

Gets the ReadOnlyObjectProperty representing the current state.

Gets the ReadOnlyObjectProperty representing the current state.

Inherited from
Worker

Gets the ReadOnlyStringProperty representing the title.

Gets the ReadOnlyStringProperty representing the title.

Inherited from
Worker
override def toString: String
Returns

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

Definition Classes
Inherited from
SFXDelegate

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.

Inherited from
Worker

Gets the ReadOnlyObjectProperty representing the value.

Gets the ReadOnlyObjectProperty representing the value.

Inherited from
Worker

Gets the ReadOnlyDoubleProperty representing the current progress.

Gets the ReadOnlyDoubleProperty representing the current progress.

Inherited from
Worker

Concrete fields

override val delegate: Service[T]