javafx.scene.web

Class WebEngine.LoadWorker

java.lang.Object

javafx.scene.web.WebEngine.LoadWorker

All Implemented Interfaces:

Worker<java.lang.Void>

Enclosing class:

WebEngine

private final class WebEngine.LoadWorker
extends java.lang.Object
implements Worker<java.lang.Void>

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.concurrent.Worker

Worker.State

Field Summary

Fields

Modifier and Type	Field and Description
private ReadOnlyObjectWrapper<java.lang.Throwable>	exception
private ReadOnlyStringWrapper	message
private ReadOnlyDoubleWrapper	progress
private ReadOnlyBooleanWrapper	running
private ReadOnlyObjectWrapper<Worker.State>	state
private ReadOnlyStringWrapper	title
private ReadOnlyDoubleWrapper	totalWorkToBeDone
private ReadOnlyObjectWrapper<java.lang.Void>	value
private ReadOnlyDoubleWrapper	workDone

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LoadWorker()

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancels the loading of the page.
private void	cancelAndReset()
private java.lang.Throwable	describeError(int errorCode)
private void	dispatchLoadEvent(long frame, int state, java.lang.String url, java.lang.String contentType, double workDone, int errorCode)
ReadOnlyObjectProperty<java.lang.Throwable>	exceptionProperty() Gets the ReadOnlyObjectProperty representing any exception which occurred.
java.lang.Throwable	getException() Indicates the exception which occurred while the Worker was running, if any.
java.lang.String	getMessage() Gets a message associated with the current state of this Worker.
double	getProgress() Indicates the current progress of this Worker in terms of percent complete.
Worker.State	getState() Specifies the current state of this Worker.
java.lang.String	getTitle() An optional title that should be associated with this Worker.
double	getTotalWork() Indicates a maximum value for the Worker.workDoneProperty() property.
java.lang.Void	getValue() Specifies the value, or result, of this Worker.
double	getWorkDone() Indicates the current amount of work that has been completed.
boolean	isRunning() True if the state is either SCHEDULED or RUNNING.
ReadOnlyStringProperty	messageProperty() Gets the ReadOnlyStringProperty representing the message.
ReadOnlyDoubleProperty	progressProperty() Gets the ReadOnlyDoubleProperty representing the progress.
ReadOnlyBooleanProperty	runningProperty() Gets the ReadOnlyBooleanProperty representing whether the Worker is running.
ReadOnlyObjectProperty<Worker.State>	stateProperty() Gets the ReadOnlyObjectProperty representing the current state.
ReadOnlyStringProperty	titleProperty() Gets the ReadOnlyStringProperty representing the title.
ReadOnlyDoubleProperty	totalWorkProperty() Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done.
private void	updateProgress(double p)
private void	updateState(Worker.State value)
ReadOnlyObjectProperty<java.lang.Void>	valueProperty() Gets the ReadOnlyObjectProperty representing the value.
ReadOnlyDoubleProperty	workDoneProperty() Gets the ReadOnlyDoubleProperty representing the current progress.

Methods inherited from class java.lang.Object

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

Field Detail

state

private final ReadOnlyObjectWrapper<Worker.State> state

value

private final ReadOnlyObjectWrapper<java.lang.Void> value

exception

private final ReadOnlyObjectWrapper<java.lang.Throwable> exception

workDone

private final ReadOnlyDoubleWrapper workDone

totalWorkToBeDone

private final ReadOnlyDoubleWrapper totalWorkToBeDone

progress

private final ReadOnlyDoubleWrapper progress

running

private final ReadOnlyBooleanWrapper running

message

private final ReadOnlyStringWrapper message

title

private final ReadOnlyStringWrapper title

Constructor Detail

LoadWorker

private LoadWorker()

Method Detail

getState

public final Worker.State getState()

Description copied from interface: Worker

Specifies the current state of this Worker. The initial value is State.READY. A Task may be restarted, in which case it will progress from one of these end states (SUCCEEDED, CANCELLED, or FAILED) back to READY and then immediately to SCHEDULED and RUNNING. These state transitions may occur immediately one after the other, but will always occur in the prescribed order.

Specified by:

getState in interface Worker<java.lang.Void>

Returns:

The current state of this Worker

stateProperty

public final ReadOnlyObjectProperty<Worker.State> stateProperty()

Description copied from interface: Worker

Gets the ReadOnlyObjectProperty representing the current state.

Specified by:

stateProperty in interface Worker<java.lang.Void>

Returns:

The property representing the state

updateState

private void updateState(Worker.State value)

getValue

public final java.lang.Void getValue()

Description copied from interface: Worker

Specifies the value, or result, of this Worker. This is set upon entering the SUCCEEDED state, and cleared (set to null) if the Worker is reinitialized (that is, if the Worker is a reusable Worker and is reset or restarted).

Specified by:

getValue in interface Worker<java.lang.Void>

Returns:

the current value of this Worker

valueProperty

public final ReadOnlyObjectProperty<java.lang.Void> valueProperty()

Description copied from interface: Worker

Gets the ReadOnlyObjectProperty representing the value.

Specified by:

valueProperty in interface Worker<java.lang.Void>

Returns:

The property representing the current value

getException

public final java.lang.Throwable getException()

Description copied from interface: Worker

Indicates the exception which occurred while the Worker was running, if any. If this property value is null, there is no known exception, even if the status is FAILED. If this property is not null, it will most likely contain an exception that describes the cause of failure.

Specified by:

getException in interface Worker<java.lang.Void>

Returns:

the exception, if one occurred

exceptionProperty

public final ReadOnlyObjectProperty<java.lang.Throwable> exceptionProperty()

Description copied from interface: Worker

Gets the ReadOnlyObjectProperty representing any exception which occurred.

Specified by:

exceptionProperty in interface Worker<java.lang.Void>

Returns:

the property representing the exception

getWorkDone

public final double getWorkDone()

Description copied from interface: Worker

Indicates the current amount of work that has been completed. Zero or a positive value indicate progress toward completion. This variables value may or may not change from its default value depending on the specific Worker implementation. A value of -1 means that the current amount of work done cannot be determined (ie: it is indeterminate). The value of this property is always less than or equal to totalWork.

Specified by:

getWorkDone in interface Worker<java.lang.Void>

Returns:

the amount of work done

See Also:

Worker.totalWorkProperty(), Worker.progressProperty()

workDoneProperty

public final ReadOnlyDoubleProperty workDoneProperty()

Description copied from interface: Worker

Gets the ReadOnlyDoubleProperty representing the current progress.

Specified by:

workDoneProperty in interface Worker<java.lang.Void>

Returns:

The property representing the amount of work done

getTotalWork

public final double getTotalWork()

Description copied from interface: Worker

Indicates a maximum value for the Worker.workDoneProperty() property. The totalWork will either be -1 (indicating that the amount of work to do is indeterminate), or it will be a non-zero value less than or equal to Double.MAX_VALUE.

Specified by:

getTotalWork in interface Worker<java.lang.Void>

Returns:

the total work to be done

See Also:

Worker.workDoneProperty(), Worker.progressProperty()

totalWorkProperty

public final ReadOnlyDoubleProperty totalWorkProperty()

Description copied from interface: Worker

Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done. These "work units" have meaning to the Worker implementation, such as the number of bytes that need to be downloaded or the number of images to process or some other such metric.

Specified by:

totalWorkProperty in interface Worker<java.lang.Void>

Returns:

the property representing the total work to be done

getProgress

public final double getProgress()

Description copied from interface: Worker

Indicates the current progress of this Worker in terms of percent complete. A value between zero and one indicates progress toward completion. A value of -1 means that the current progress cannot be determined (that is, it is indeterminate). This property may or may not change from its default value of -1 depending on the specific Worker implementation.

Specified by:

getProgress in interface Worker<java.lang.Void>

Returns:

the current progress

See Also:

Worker.workDoneProperty(), Worker.totalWorkProperty()

progressProperty

public final ReadOnlyDoubleProperty progressProperty()

Description copied from interface: Worker

Gets the ReadOnlyDoubleProperty representing the progress.

Specified by:

progressProperty in interface Worker<java.lang.Void>

Returns:

the property representing the progress

updateProgress

private void updateProgress(double p)

isRunning

public final boolean isRunning()

Description copied from interface: Worker

True if the state is either SCHEDULED or RUNNING. When binding a Worker to a ProgressIndicator, you will typically bind the visibility of the ProgressIndicator to the Worker's running property, and the progress of the ProgressIndicator to the Worker's progress property.

Specified by:

isRunning in interface Worker<java.lang.Void>

Returns:

true if this Worker is running

runningProperty

public final ReadOnlyBooleanProperty runningProperty()

Description copied from interface: Worker

Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

Specified by:

runningProperty in interface Worker<java.lang.Void>

Returns:

the property representing whether the worker is running

getMessage

public final java.lang.String getMessage()

Description copied from interface: Worker

Gets a message associated with the current state of this Worker. This may be something such as "Processing image 1 of 3", for example.

Specified by:

getMessage in interface Worker<java.lang.Void>

Returns:

the current message

messageProperty

public final ReadOnlyStringProperty messageProperty()

Description copied from interface: Worker

Gets the ReadOnlyStringProperty representing the message.

Specified by:

messageProperty in interface Worker<java.lang.Void>

Returns:

a property representing the current message

getTitle

public final java.lang.String getTitle()

Description copied from interface: Worker

An optional title that should be associated with this Worker. This may be something such as "Modifying Images".

Specified by:

getTitle in interface Worker<java.lang.Void>

Returns:

the current title

titleProperty

public final ReadOnlyStringProperty titleProperty()

Description copied from interface: Worker

Gets the ReadOnlyStringProperty representing the title.

Specified by:

titleProperty in interface Worker<java.lang.Void>

Returns:

the property representing the current title

cancel

public boolean cancel()

Cancels the loading of the page. If called after the page has already been loaded, then this call takes no effect.

Specified by:

cancel in interface Worker<java.lang.Void>

Returns:

returns true if the cancel was successful

cancelAndReset

private void cancelAndReset()

dispatchLoadEvent

private void dispatchLoadEvent(long frame,
                               int state,
                               java.lang.String url,
                               java.lang.String contentType,
                               double workDone,
                               int errorCode)

describeError

private java.lang.Throwable describeError(int errorCode)