Overview
Task provides a way of starting, stopping and tracking code that does not run on the JavaFX event dispatch thread.
Task does not define how to specifiy the code to run but only provides callback function, state variable and progress variable definitions and behavior.
Tasks are expected to be executed one time (one call to start() per instance of a Task).
Profile: common
Variable Summary
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public-read protected | causeOfFailure | Object | subclass | subclass | null |
Indicates the cause of failure of this task. Indicates the cause of failure of this task. If this variable's value
is
See Also:
Profile: common |
|
public-read protected | done | Boolean | subclass | subclass | false |
Indicates if this task has completed. Indicates if this task has completed. This is the last of the
variables started, stopped, failed,
succeeded and causeOfFailure to be modified.
This variable is to be set to Profile: common |
|
public-read protected | failed | Boolean | subclass | subclass | false |
Indicates if this task has failed. Indicates if this task has failed.
This variable is set to
See Also:
Profile: common |
|
public-read protected | maxProgress | Long | subclass | subclass | -1 |
Indicates a maximum value for the progress variable. Indicates a maximum value for the progress variable. If set to zero or a negative value, there is no known maximum and the percentDone variable will not change during the course of execution of this task. -1
See Also:
Profile: common |
|
public | onDone | function():Void | null |
Callback that is invoked once to indicate that the task execution has completed (successfully, or unsuccessfully). Callback that is invoked once to indicate that the task execution has completed (successfully, or unsuccessfully). This task's implemenation will not modify this task's variables during or after a call to this function. Once the start() function has been called, this function will eventually be called, if it is non-null. null
See Also:
Profile: common |
|||
public | onStart | function():Void | null |
Callback that is invoked once to indicate that the task is about to start execution. |
|||
public-read | percentDone | Number | -1 |
Indicates the current progress of this task in terms of percent complete. Indicates the current progress of this task in terms of percent complete. Zero or a positive value indicate progress toward completion. This variable's value may or may not change from its default value depending on the specific Task implementation. -1
See Also:
Profile: common |
|||
public-read protected | progress | Long | subclass | subclass | -1 |
Indicates the current progress toward completion of this task. Indicates the current progress toward completion of this task. Zero or a positive value indicate progress toward completion. This variable's value may or may not change from its default value depending on the specific Task implementation. -1
See Also:
Profile: common |
|
public-read protected | started | Boolean | subclass | subclass | false |
Indicates if this task has started. |
|
public-read protected | stopped | Boolean | subclass | subclass | false |
Indicates if this task has been stopped. Indicates if this task has been stopped.
This variable is set to
See Also:
Profile: common |
|
public-read protected | succeeded | Boolean | subclass | subclass | false |
Indicates if this task has successfully completed. |
Inherited Variables
Function Summary
- public impl_setCauseOfFailure(cause: java.lang.Throwable) : Void
- public impl_setDone() : Void
- public impl_setStarted() : Void
- public impl_setStopped() : Void
- public abstract start() : Void
-
Initiates execution of this task.
Initiates execution of this task. Calling this function will either queue this task for future execution or start execution. The execution of the task happens on a thread other than the JavaFX event dispatch thread. The onStart function may not be called before this function returns. This function is expected to be called a maximum of once per instance of Task.
See Also:
onStartProfile: common
- public abstract stop() : Void
-
Terminates execution of this task.
Terminates execution of this task. Calling this function will either remove this task from the execution queue or stop execution. Subsequent calls to this function have no effect. The onDone function will be called as a result of calling this function, if it is non-null. The onDone function may not be called before this function returns. This function is expected to be called a maximum of once per instance of Task.
Profile: common