WebEngine.LoadWorker (JavaFX 2.2)

java.lang.Object
- javafx.scene.web.WebEngine.LoadWorker

All Implemented Interfaces:: Worker<java.lang.Void>

Enclosing class:: WebEngine

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

Property Summary

Properties
Type	Property and Description
`ReadOnlyObjectProperty<java.lang.Throwable>`	`exception` Gets the ReadOnlyObjectProperty representing any exception which occurred.
`ReadOnlyStringProperty`	`message` Gets the ReadOnlyStringProperty representing the message.
`ReadOnlyDoubleProperty`	`progress` Gets the ReadOnlyDoubleProperty representing the progress.
`ReadOnlyBooleanProperty`	`running` Gets the ReadOnlyBooleanProperty representing whether the Worker is running.
`ReadOnlyObjectProperty<Worker.State>`	`state` Gets the ReadOnlyObjectProperty representing the current state.
`ReadOnlyStringProperty`	`title` Gets the ReadOnlyStringProperty representing the title.
`ReadOnlyDoubleProperty`	`totalWork` Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done.
`ReadOnlyObjectProperty<java.lang.Void>`	`value` Gets the ReadOnlyObjectProperty representing the value.
`ReadOnlyDoubleProperty`	`workDone` Gets the ReadOnlyDoubleProperty representing the current progress.

Nested Class Summary
- Nested classes/interfaces inherited from interface javafx.concurrent.Worker
  Worker.State

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`cancel()` Cancels the loading of the page.
`ReadOnlyObjectProperty<java.lang.Throwable>`	`exceptionProperty()` Gets the ReadOnlyObjectProperty representing any exception which occurred.
`java.lang.Throwable`	`getException()` Gets the value of the property exception.
`java.lang.String`	`getMessage()` Gets the value of the property message.
`double`	`getProgress()` Gets the value of the property progress.
`Worker.State`	`getState()` Gets the value of the property state.
`java.lang.String`	`getTitle()` Gets the value of the property title.
`double`	`getTotalWork()` Gets the value of the property totalWork.
`java.lang.Void`	`getValue()` Gets the value of the property value.
`double`	`getWorkDone()` Gets the value of the property workDone.
`boolean`	`isRunning()` Gets the value of the property 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.
`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

- Property Detail
  - state
```
public final ReadOnlyObjectProperty<Worker.State> stateProperty
```
    Specified by:
    
    stateProperty in interface Worker<java.lang.Void>
    
    Returns:
    The property representing the state
    See Also:
    getState()
  - value
```
public final ReadOnlyObjectProperty<java.lang.Void> valueProperty
```
    Specified by:
    
    valueProperty in interface Worker<java.lang.Void>
    
    Returns:
    The property representing the current value
    See Also:
    getValue()
  - exception
```
public final ReadOnlyObjectProperty<java.lang.Throwable> exceptionProperty
```
    Specified by:
    
    exceptionProperty in interface Worker<java.lang.Void>
    
    Returns:
    the property representing the exception
    See Also:
    getException()
  - workDone
```
public final ReadOnlyDoubleProperty workDoneProperty
```
    Specified by:
    
    workDoneProperty in interface Worker<java.lang.Void>
    
    Returns:
    The property representing the amount of work done
    See Also:
    getWorkDone()
  - totalWork
```
public final ReadOnlyDoubleProperty totalWorkProperty
```
    Specified by:
    
    totalWorkProperty in interface Worker<java.lang.Void>
    
    Returns:
    the property representing the total work to be done
    See Also:
    getTotalWork()
  - progress
```
public final ReadOnlyDoubleProperty progressProperty
```
    Specified by:
    
    progressProperty in interface Worker<java.lang.Void>
    
    Returns:
    the property representing the progress
    See Also:
    getProgress()
  - running
```
public final ReadOnlyBooleanProperty runningProperty
```
    Specified by:
    
    runningProperty in interface Worker<java.lang.Void>
    
    Returns:
    the property representing whether the worker is running
    See Also:
    isRunning()
  - message
```
public final ReadOnlyStringProperty messageProperty
```
    Specified by:
    
    messageProperty in interface Worker<java.lang.Void>
    
    Returns:
    a property representing the current message
    See Also:
    getMessage()
  - title
```
public final ReadOnlyStringProperty titleProperty
```
    Specified by:
    
    titleProperty in interface Worker<java.lang.Void>
    
    Returns:
    the property representing the current title
    See Also:
    getTitle()
- Method Detail
  - getState
```
public final Worker.State getState()
```
    Gets the value of the property state.
    
    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
    See Also:
    getState()
  - getValue
```
public final java.lang.Void getValue()
```
    Gets the value of the property value.
    
    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
    See Also:
    getValue()
  - getException
```
public final java.lang.Throwable getException()
```
    Gets the value of the property exception.
    
    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
    See Also:
    getException()
  - getWorkDone
```
public final double getWorkDone()
```
    Gets the value of the property workDone.
    
    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
    See Also:
    getWorkDone()
  - getTotalWork
```
public final double getTotalWork()
```
    Gets the value of the property totalWork.
    
    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
    See Also:
    getTotalWork()
  - getProgress
```
public final double getProgress()
```
    Gets the value of the property progress.
    
    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
    See Also:
    getProgress()
  - isRunning
```
public final boolean isRunning()
```
    Gets the value of the property running.
    
    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
    See Also:
    isRunning()
  - getMessage
```
public final java.lang.String getMessage()
```
    Gets the value of the property message.
    
    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
    See Also:
    getMessage()
  - getTitle
```
public final java.lang.String getTitle()
```
    Gets the value of the property title.
    
    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
    See Also:
    getTitle()
  - 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

Class WebEngine.LoadWorker

Property Summary

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Property Detail

state

value

exception

workDone

totalWork

progress

running

message

title

Method Detail

getState

stateProperty

getValue

valueProperty

getException

exceptionProperty

getWorkDone

workDoneProperty

getTotalWork

totalWorkProperty

getProgress

progressProperty

isRunning

runningProperty

getMessage

messageProperty

getTitle

titleProperty

cancel