scalafx
API
Generated with
scalafx/scalafx/scalafx.concurrent/Task

Task

scalafx.concurrent.Task
See theTask companion object
abstract class Task[T](val delegate: Task[T]) extends EventTarget, Worker[T], SFXDelegate[Task[T]]

Wrapper trait for Task Class.

Attributes

Companion
object
Graph
Supertypes
trait Worker[T]
class EventTarget
trait SFXDelegate[Task[T]]
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
object HandlerMagnet

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

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.

Attributes

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.

Attributes

def onFailed_=(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.

Attributes

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.

Attributes

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.

Attributes

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

Inherited methods

def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Value parameters

tail

the initial chain to build from

Attributes

Returns

the resulting event dispatch chain for this target

See also
Inherited from:
EventTarget
def cancel: Boolean

Terminates execution of this Worker.

Terminates execution of this Worker.

Attributes

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 parameters

ref

Object to be compared.

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def exception: ReadOnlyObjectProperty[Throwable]

Gets the ReadOnlyObjectProperty representing any exception which occurred.

Gets the ReadOnlyObjectProperty representing any exception which occurred.

Attributes

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Attributes

Inherited from:
EventTarget
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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

handler

code handling the event, see examples above.

Attributes

Returns

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

Inherited from:
EventTarget
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def message: ReadOnlyStringProperty

Gets the ReadOnlyStringProperty representing the message.

Gets the ReadOnlyStringProperty representing the message.

Attributes

Inherited from:
Worker
def progress: ReadOnlyDoubleProperty

Gets the ReadOnlyDoubleProperty representing the progress.

Gets the ReadOnlyDoubleProperty representing the progress.

Attributes

Inherited from:
Worker
def running: ReadOnlyBooleanProperty

Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

Attributes

Inherited from:
Worker
def state: ReadOnlyObjectProperty[State]

Gets the ReadOnlyObjectProperty representing the current state.

Gets the ReadOnlyObjectProperty representing the current state.

Attributes

Inherited from:
Worker
def title: ReadOnlyStringProperty

Gets the ReadOnlyStringProperty representing the title.

Gets the ReadOnlyStringProperty representing the title.

Attributes

Inherited from:
Worker
override def toString: String

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def totalWork: ReadOnlyDoubleProperty

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.

Attributes

Inherited from:
Worker
def value: ReadOnlyObjectProperty[T]

Gets the ReadOnlyObjectProperty representing the value.

Gets the ReadOnlyObjectProperty representing the value.

Attributes

Inherited from:
Worker
def workDone: ReadOnlyDoubleProperty

Gets the ReadOnlyDoubleProperty representing the current progress.

Gets the ReadOnlyDoubleProperty representing the current progress.

Attributes

Inherited from:
Worker

Concrete fields

override val delegate: Task[T]

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with