io.datafx.core.concurrent

Class TaskState

java.lang.Object

io.datafx.core.concurrent.TaskState

public class TaskState
extends java.lang.Object

This class wraps the complete state of a task

Constructor Summary

Constructors

Constructor and Description
TaskState()

Method Summary

Modifier and Type	Method and Description
double	getMaxProgress() Returns the max progress value.
double	getProgress() Returns the current progress of the task.
javafx.beans.property.DoubleProperty	maxProgress() Returns a property that defines the maximum value that the progress value can reach
javafx.beans.property.DoubleProperty	progress() Returns a property that defines the current progress of the task.
void	setMaxProgress(double maxProgress) Sets the max progress value.
void	setProgress(double progress) Sets the current progress of the task.
javafx.beans.value.ObservableStringValue	title() Returns a property that defines the title of the task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskState

public TaskState()

Method Detail

maxProgress

public javafx.beans.property.DoubleProperty maxProgress()

Returns a property that defines the maximum value that the progress value can reach

Returns:

property that defines the maximum value that the progress value can reach

setMaxProgress

public void setMaxProgress(double maxProgress)

Sets the max progress value. The value defines the maximum value that the progress value can reach

Parameters:

maxProgress - the max progress value

getMaxProgress

public double getMaxProgress()

Returns the max progress value. The value defines the maximum value that the progress value can reach

Returns:

the max progress value

progress

public javafx.beans.property.DoubleProperty progress()

Returns a property that defines the current progress of the task. The internal value will be between 0 and maxProgress

Returns:

a property that defines the current progress

getProgress

public double getProgress()

Returns the current progress of the task. This will be between 0 and maxProgress

Returns:

the current progress

setProgress

public void setProgress(double progress)

Sets the current progress of the task.

Parameters:

progress - the current progress

title

public javafx.beans.value.ObservableStringValue title()

Returns a property that defines the title of the task.

Returns:

a property that defines the title