Spec-Zone.ru › OpenJavaFX 24

Класс Service<V>

java.lang.Object
javafx.concurrent.Service<V>
Параметры типа:
V — тип объекта, возвращаемого сервисом
Все реализованные интерфейсы:
Worker<V>, EventTarget
Непосредственные известные подклассы:
ScheduledService
public abstract class Service<V> extends Object implements Worker<V>, EventTarget

Сервис — это компонент, не связанный с визуальным представлением, который содержит информацию, необходимую для выполнения некоторой работы в одном или нескольких фоновых потоках. Как часть библиотеки пользовательского интерфейса JavaFX, сервис знает о потоке приложения JavaFX и предназначен для освобождения разработчика от необходимости управления многопоточным кодом, взаимодействующим с пользовательским интерфейсом. Таким образом, все методы и состояние сервиса предназначены для вызова только из потока приложения JavaFX. Единственное исключение из этого правила — это начальная настройка сервиса, которую можно безопасно выполнить из любого потока, и первоначальный запуск сервиса, который также можно безопасно выполнить из любого потока. Однако после инициализации и запуска сервиса он может использоваться только из потока FX.

Сервис создает и управляет задачей Task, которая выполняет работу в фоновом потоке. Сервис реализует интерфейс Worker. Таким образом, вы можете наблюдать состояние фоновой задачи и, при необходимости, отменить ее. Сервис является многократно используемой задачей, что означает, что ее можно сбросить и перезапустить. Благодаря этому, сервис можно создавать декларативно и перезапускать по требованию. После запуска сервиса он будет планировать свою работу Task и отслеживать изменения состояния задачи Task. Сервис не хранит ссылку на запустивший его объект, что означает, что запущенный сервис не помешает объекту, его запустившему, быть удаленным из памяти.

Если на сервисе указан Executor, то он будет использован для выполнения сервиса. В противном случае будет создан и запущен демон-поток. Если вы хотите создать не-демон-потоки, укажите пользовательский Executor (например, вы можете использовать ThreadPoolExecutor с пользовательской фабрикой потоков ThreadFactory).

Поскольку сервис предназначен для упрощения декларативных случаев использования, подклассы должны экспонировать в качестве свойств входные параметры выполняемой работы. Например, для создания сервиса, который считывает первую строку из любого URL и возвращает её как String, можно определить одно свойство, url, и реализовать его следующим образом:


     public static class FirstLineService extends Service<String> {
         private StringProperty url = new SimpleStringProperty(this, "url");
         public final void setUrl(String value) { url.set(value); }
         public final String getUrl() { return url.get(); }
         public final StringProperty urlProperty() { return url; }

         protected Task createTask() {
             final String _url = getUrl();
             return new Task<String>() {
                 protected String call() throws Exception {
                     URL u = new URL(_url);
                     BufferedReader in = new BufferedReader(
                             new InputStreamReader(u.openStream()));
                     String result = in.readLine();
                     in.close();
                     return result;
                 }
             };
         }
     }
     

Сервис по умолчанию использует пул потоков ThreadPoolExecutor с каким-то неопределённым значением по умолчанию или максимальным размером пула потоков. Это делается для того, чтобы код по умолчанию не перегружал систему, создавая тысячи потоков.

С момента:
JavaFX 2.0

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в интерфейсе javafx.concurrent.Worker

Worker.State

Краткое описание свойств

Тип Свойство Описание
final ReadOnlyObjectProperty<Throwable> exception
Получает ReadOnlyObjectProperty, представляющий любую произошедшую ошибку.
final ObjectProperty<Executor> executor
Исполнитель, который нужно использовать для запуска этого сервиса.
final ReadOnlyStringProperty message
Получает ReadOnlyStringProperty, представляющий сообщение.
final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelled
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onFailed
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onReady
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
final ObjectProperty<EventHandler<WorkerStateEvent>> onRunning
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduled
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceeded
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
final ReadOnlyDoubleProperty progress
Получает ReadOnlyDoubleProperty, представляющий прогресс.
final ReadOnlyBooleanProperty running
Получает ReadOnlyBooleanProperty, представляющий, запущен ли сервис.
final ReadOnlyObjectProperty<Worker.State> state
Получает ReadOnlyObjectProperty, представляющий текущее состояние.
final ReadOnlyStringProperty title
Получает ReadOnlyStringProperty, представляющий заголовок.
final ReadOnlyDoubleProperty totalWork
Получает ReadOnlyDoubleProperty, представляющий максимальное количество работы, которое нужно сделать.
final ReadOnlyObjectProperty<V> value
Получает ReadOnlyObjectProperty, представляющий значение.
final ReadOnlyDoubleProperty workDone
Получает ReadOnlyDoubleProperty, представляющий текущий прогресс.

Краткое описание конструкторов

Service()
Модификатор Конструктор Описание
protected
Создаёт новый сервис.

Краткое описание методов

Modifier and Type Method Description
final <T extends Event>
void
addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
Регистрирует фильтр событий для этого целевого объекта.
final <T extends Event>
void
addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
Регистрирует обработчик событий для этого целевого объекта.
EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
Создаёт цепочку обработки событий для этого целевого объекта.
boolean cancel()
Отменяет любой текущий запущенный Task, если таковой имеется.
protected void cancelled()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние Service переходит в состояние CANCELLED.
protected abstract Task<V> createTask()
Вызывается после запуска Service на потоке JavaFX Application.
final ReadOnlyObjectProperty<Throwable> exceptionProperty()
Получает ReadOnlyObjectProperty, представляющий любую произошедшую ошибку.
protected void executeTask(Task<V> task)
Использует executor, определённый для этого Service, для выполнения заданной задачи.
final ObjectProperty<Executor> executorProperty()
Исполнитель, используемый для выполнения этого Service.
protected void failed()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние Service переходит в состояние FAILED.
protected final void fireEvent(Event event)
Вызывает указанное событие.
final Throwable getException()
Получает значение свойства exception.
final Executor getExecutor()
Получает значение свойства executor.
final String getMessage()
Получает значение свойства message.
final EventHandler<WorkerStateEvent> getOnCancelled()
Обработчик события onCancelled вызывается всякий раз, когда состояние Task переходит в состояние CANCELLED.
final EventHandler<WorkerStateEvent> getOnFailed()
Обработчик события onFailed вызывается всякий раз, когда состояние Task переходит в состояние FAILED.
final EventHandler<WorkerStateEvent> getOnReady()
Обработчик события onReady вызывается всякий раз, когда состояние Task переходит в состояние READY.
final EventHandler<WorkerStateEvent> getOnRunning()
Обработчик события onRunning вызывается всякий раз, когда состояние Task переходит в состояние RUNNING.
final EventHandler<WorkerStateEvent> getOnScheduled()
Обработчик события onSchedule вызывается всякий раз, когда состояние Task переходит в состояние SCHEDULED.
final EventHandler<WorkerStateEvent> getOnSucceeded()
Обработчик события onSucceeded вызывается всякий раз, когда состояние Task переходит в состояние SUCCEEDED.
final double getProgress()
Получает значение свойства progress.
final Worker.State getState()
Получает значение свойства state.
final String getTitle()
Получает значение свойства title.
final double getTotalWork()
Получает значение свойства totalWork.
final V getValue()
Получает значение свойства value.
final double getWorkDone()
Получает значение свойства workDone.
final boolean isRunning()
Получает значение свойства running.
final ReadOnlyStringProperty messageProperty()
Получает ReadOnlyStringProperty, представляющий сообщение.
final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty()
Обработчик события onCancelled вызывается всякий раз, когда состояние Task переходит в состояние CANCELLED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty()
Обработчик события onFailed вызывается всякий раз, когда состояние Task переходит в состояние FAILED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty()
Обработчик события onReady вызывается всякий раз, когда состояние Task переходит в состояние READY.
final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty()
Обработчик события onRunning вызывается всякий раз, когда состояние Task переходит в состояние RUNNING.
final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty()
Обработчик события onSchedule вызывается всякий раз, когда состояние Task переходит в состояние SCHEDULED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty()
Обработчик события onSucceeded вызывается всякий раз, когда состояние Task переходит в состояние SUCCEEDED.
final ReadOnlyDoubleProperty progressProperty()
Получает ReadOnlyDoubleProperty, представляющий прогресс.
protected void ready()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние Service переходит в состояние READY.
final <T extends Event>
void
removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
Отменяет ранее зарегистрированный фильтр событий для этого целевого объекта.
final <T extends Event>
void
removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
Отменяет ранее зарегистрированный обработчик событий для этого целевого объекта.
void reset()
Сбрасывает Service.
void restart()
Отменяет любой текущий запущенный Task, если таковой имеется, и перезапускает этот Service.
protected void running()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние Service переходит в состояние RUNNING.
final ReadOnlyBooleanProperty runningProperty()
Получает ReadOnlyBooleanProperty, представляющий, запущен ли Worker.
protected void scheduled()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние Service переходит в состояние SCHEDULED.
protected final <T extends Event>
void
setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
Устанавливает обработчик для данного типа события.
final void setExecutor(Executor value)
Устанавливает значение свойства executor.
final void setOnCancelled(EventHandler<WorkerStateEvent> value)
Обработчик события onCancelled вызывается всякий раз, когда состояние Task переходит в состояние CANCELLED.
final void setOnFailed(EventHandler<WorkerStateEvent> value)
Обработчик события onFailed вызывается всякий раз, когда состояние Task переходит в состояние FAILED.
final void setOnReady(EventHandler<WorkerStateEvent> value)
Обработчик события onReady вызывается всякий раз, когда состояние Task переходит в состояние READY.
final void setOnRunning(EventHandler<WorkerStateEvent> value)
Обработчик события onRunning вызывается всякий раз, когда состояние Task переходит в состояние RUNNING.
final void setOnScheduled(EventHandler<WorkerStateEvent> value)
Обработчик события onSchedule вызывается всякий раз, когда состояние Task переходит в состояние SCHEDULED.
final void setOnSucceeded(EventHandler<WorkerStateEvent> value)
Обработчик события onSucceeded вызывается всякий раз, когда состояние Task переходит в состояние SUCCEEDED.
void start()
Запускает этот Service.
final ReadOnlyObjectProperty<Worker.State> stateProperty()
Получает ReadOnlyObjectProperty, представляющий текущее состояние.
protected void succeeded()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние Service переходит в состояние SUCCEEDED.
final ReadOnlyStringProperty titleProperty()
Получает ReadOnlyStringProperty, представляющий заголовок.
final ReadOnlyDoubleProperty totalWorkProperty()
Получает ReadOnlyDoubleProperty, представляющий максимальное количество работы, которое необходимо выполнить.
final ReadOnlyObjectProperty<V> valueProperty()
Получает ReadOnlyObjectProperty, представляющий значение.
final ReadOnlyDoubleProperty workDoneProperty()
Получает ReadOnlyDoubleProperty, представляющий текущий прогресс.

Методы, объявленные в классе java.lang.Object

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

Подробное описание свойств

state

public final ReadOnlyObjectProperty<Worker.State> stateProperty
Определено:
stateProperty в интерфейсе Worker<V>
Возвращает:
Свойство, представляющее состояние
См. также:
  • getState()
  • stateProperty()

value

public final ReadOnlyObjectProperty<V> valueProperty
Определено:
valueProperty в интерфейсе Worker<V>
Возвращает:
Свойство, представляющее текущее значение
См. также:
  • getValue()
  • valueProperty()

exception

public final ReadOnlyObjectProperty<Throwable> exceptionProperty
Определено:
exceptionProperty в интерфейсе Worker<V>
Возвращает:
свойство, представляющее исключение
См. также:
  • getException()
  • exceptionProperty()

workDone

public final ReadOnlyDoubleProperty workDoneProperty
Определено:
workDoneProperty в интерфейсе Worker<V>
Возвращает:
Свойство, представляющее объем проделанной работы
См. также:
  • getWorkDone()
  • workDoneProperty()

totalWork

public final ReadOnlyDoubleProperty totalWorkProperty
Определено:
totalWorkProperty в интерфейсе Worker<V>
Возвращает:
свойство, представляющее общий объем работы
См. также:
  • getTotalWork()
  • totalWorkProperty()

progress

public final ReadOnlyDoubleProperty progressProperty
Определено:
progressProperty в интерфейсе Worker<V>
Возвращает:
свойство, представляющее прогресс
См. также:
  • getProgress()
  • progressProperty()

running

public final ReadOnlyBooleanProperty runningProperty
Определено:
runningProperty в интерфейсе Worker<V>
Возвращает:
свойство, представляющее, запущена ли задача
См. также:
  • isRunning()
  • runningProperty()

message

public final ReadOnlyStringProperty messageProperty
Определено:
messageProperty в интерфейсе Worker<V>
Возвращает:
свойство, представляющее текущее сообщение
См. также:
  • getMessage()
  • messageProperty()

title

public final ReadOnlyStringProperty titleProperty
Определено:
titleProperty в интерфейсе Worker<V>
Возвращает:
свойство, представляющее текущий заголовок
См. также:
  • getTitle()
  • titleProperty()

executor

public final ObjectProperty<Executor> executorProperty
Используемый для запуска этой службы исполняющий механизм. Если исполняющий механизм не указан, то для запуска службы будет создан и использован новый демонический поток, использующий некоторый стандартный исполняющий механизм.
См. также:
  • getExecutor()
  • setExecutor(Executor)
  • executorProperty()

onReady

public final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
С:
JavaFX 2.1
См. также:
  • getOnReady()
  • setOnReady(EventHandler)
  • onReadyProperty()

onScheduled

public final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
С:
JavaFX 2.1
См. также:
  • getOnScheduled()
  • setOnScheduled(EventHandler)
  • onScheduledProperty()

onRunning

public final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
С:
JavaFX 2.1
См. также:
  • getOnRunning()
  • setOnRunning(EventHandler)
  • onRunningProperty()

onSucceeded

public final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
С:
JavaFX 2.1
См. также:
  • getOnSucceeded()
  • setOnSucceeded(EventHandler)
  • onSucceededProperty()

onCancelled

public final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
С:
JavaFX 2.1
См. также:
  • getOnCancelled()
  • setOnCancelled(EventHandler)
  • onCancelledProperty()

onFailed

public final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
С:
JavaFX 2.1
См. также:
  • getOnFailed()
  • setOnFailed(EventHandler)
  • onFailedProperty()

Подробное описание конструкторов

Service

protected Service()
Создать новую службу.

Подробное описание методов

getState

public final Worker.State getState()
Получает значение свойства state.
Определено:
getState в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства state
См. также:
  • stateProperty()

stateProperty

public final ReadOnlyObjectProperty<Worker.State> stateProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyObjectProperty, представляющее текущее состояние.
Определено:
stateProperty в интерфейсе Worker<V>
Возвращает:
свойство state
См. также:
  • getState()

getValue

public final V getValue()
Получает значение свойства value.
Определено:
getValue в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства value
См. также:
  • valueProperty()
END_OF_DOCUMENT_MARKER

Свойство value

public final ReadOnlyObjectProperty<V> valueProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyObjectProperty, представляющий значение.
Определено в:
valueProperty в интерфейсе Worker<V>
Возвращает:
свойство value
См. также:
  • getValue()

getException

public final Throwable getException()
Получает значение свойства exception.
Определено в:
getException в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства exception
См. также:
  • exceptionProperty()

Свойство exception

public final ReadOnlyObjectProperty<Throwable> exceptionProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyObjectProperty, представляющий любой произошедший исключение.
Определено в:
exceptionProperty в интерфейсе Worker<V>
Возвращает:
свойство exception
См. также:
  • getException()

getWorkDone

public final double getWorkDone()
Получает значение свойства workDone.
Определено в:
getWorkDone в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства workDone
См. также:
  • workDoneProperty()

Свойство workDone

public final ReadOnlyDoubleProperty workDoneProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyDoubleProperty, представляющий текущий прогресс.
Определено в:
workDoneProperty в интерфейсе Worker<V>
Возвращает:
свойство workDone
См. также:
  • getWorkDone()

getTotalWork

public final double getTotalWork()
Получает значение свойства totalWork.
Определено в:
getTotalWork в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства totalWork
См. также:
  • totalWorkProperty()

Свойство totalWork

public final ReadOnlyDoubleProperty totalWorkProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyDoubleProperty, представляющий максимальное количество работы, которое необходимо выполнить. Эти "единицы работы" имеют значение для реализации Worker, например, количество байтов, которые нужно загрузить, количество изображений для обработки или какой-либо другой метрики.
Определено в:
totalWorkProperty в интерфейсе Worker<V>
Возвращает:
свойство totalWork
См. также:
  • getTotalWork()

getProgress

public final double getProgress()
Получает значение свойства progress.
Определено в:
getProgress в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства progress
См. также:
  • progressProperty()

Свойство progress

public final ReadOnlyDoubleProperty progressProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyDoubleProperty, представляющий прогресс.
Определено в:
progressProperty в интерфейсе Worker<V>
Возвращает:
свойство progress
См. также:
  • getProgress()

isRunning

public final boolean isRunning()
Получает значение свойства running.
Определено в:
isRunning в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства running
См. также:
  • runningProperty()

Свойство running

public final ReadOnlyBooleanProperty runningProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyBooleanProperty, представляющий, запущен ли Worker.
Определено в:
runningProperty в интерфейсе Worker<V>
Возвращает:
свойство running
См. также:
  • isRunning()

getMessage

public final String getMessage()
Получает значение свойства message.
Определено в:
getMessage в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства message
См. также:
  • messageProperty()

Свойство message

public final ReadOnlyStringProperty messageProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyStringProperty, представляющий сообщение.
Определено в:
messageProperty в интерфейсе Worker<V>
Возвращает:
свойство message
См. также:
  • getMessage()

getTitle

public final String getTitle()
Получает значение свойства title.
Определено в:
getTitle в интерфейсе Worker<V>
Описание свойства:
Возвращает:
значение свойства title
См. также:
  • titleProperty()

Свойство title

public final ReadOnlyStringProperty titleProperty()
Описание скопировано из интерфейса: Worker
Получает ReadOnlyStringProperty, представляющий заголовок.
Определено в:
titleProperty в интерфейсе Worker<V>
Возвращает:
свойство title
См. также:
  • getTitle()

setExecutor

public final void setExecutor(Executor value)
Устанавливает значение свойства executor.
Описание свойства:
Исполнитель, используемый для запуска данного Service. Если исполнитель не указан, то будет создан и использован новый демон-поток для запуска Service с помощью некоторого стандартного исполнителя.
Параметры:
value - значение для свойства executor
См. также:
  • getExecutor()
  • executorProperty()

getExecutor

public final Executor getExecutor()
Получает значение свойства executor.
Описание свойства:
Исполнитель, используемый для запуска данного Service. Если исполнитель не указан, то будет создан и использован новый демон-поток для запуска Service с помощью некоторого стандартного исполнителя.
Возвращает:
значение свойства executor
См. также:
  • setExecutor(Executor)
  • executorProperty()
END_OF_DOCUMENT_MARKER

executorProperty

public final ObjectProperty<Executor> executorProperty()
Исполнитель, используемый для запуска этого сервиса. Если исполнитель не указан, тогда будет создан и использован новый демонический поток для запуска сервиса с использованием некоторого стандартного исполнителя.
Возвращает:
свойство executor
См. также:
  • getExecutor()
  • setExecutor(Executor)

onReadyProperty

public final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty()
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
Возвращает:
свойство обработчика события onReady
С:
JavaFX 2.1
См. также:
  • getOnReady()
  • setOnReady(EventHandler)

getOnReady

public final EventHandler<WorkerStateEvent> getOnReady()
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
Возвращает:
обработчик события onReady, если есть
С:
JavaFX 2.1

setOnReady

public final void setOnReady(EventHandler<WorkerStateEvent> value)
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
Параметры:
value - обработчик события, может быть null для очистки
С:
JavaFX 2.1

ready

protected void ready()
Защищенный вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние сервиса переходит в состояние READY. Этот метод вызывается после того, как сервис полностью перешел в новое состояние.
С:
JavaFX 2.1

onScheduledProperty

public final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty()
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
Возвращает:
свойство обработчика события onScheduled
С:
JavaFX 2.1
См. также:
  • getOnScheduled()
  • setOnScheduled(EventHandler)

getOnScheduled

public final EventHandler<WorkerStateEvent> getOnScheduled()
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
Возвращает:
обработчик события onScheduled, если есть
С:
JavaFX 2.1

setOnScheduled

public final void setOnScheduled(EventHandler<WorkerStateEvent> value)
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
Параметры:
value - обработчик события, может быть null для очистки
С:
JavaFX 2.1

scheduled

protected void scheduled()
Защищенный вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние сервиса переходит в состояние SCHEDULED. Этот метод вызывается после того, как сервис полностью перешел в новое состояние.
С:
JavaFX 2.1

onRunningProperty

public final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty()
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
Возвращает:
свойство обработчика события onRunning
С:
JavaFX 2.1
См. также:
  • getOnRunning()
  • setOnRunning(EventHandler)

getOnRunning

public final EventHandler<WorkerStateEvent> getOnRunning()
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
Возвращает:
обработчик события onRunning, если есть
С:
JavaFX 2.1

setOnRunning

public final void setOnRunning(EventHandler<WorkerStateEvent> value)
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
Параметры:
value - обработчик события, может быть null для очистки
С:
JavaFX 2.1

running

protected void running()
Защищенный вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние сервиса переходит в состояние RUNNING. Этот метод вызывается после того, как сервис полностью перешел в новое состояние.
С:
JavaFX 2.1

onSucceededProperty

public final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty()
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
Возвращает:
свойство обработчика события onSucceeded
С:
JavaFX 2.1
См. также:
  • getOnSucceeded()
  • setOnSucceeded(EventHandler)

getOnSucceeded

public final EventHandler<WorkerStateEvent> getOnSucceeded()
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
Возвращает:
обработчик события onSucceeded, если есть
С:
JavaFX 2.1

setOnSucceeded

public final void setOnSucceeded(EventHandler<WorkerStateEvent> value)
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
Параметры:
value - обработчик события, может быть null для очистки
С:
JavaFX 2.1

succeeded

protected void succeeded()
Защищенный вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние сервиса переходит в состояние SUCCEEDED. Этот метод вызывается после того, как сервис полностью перешел в новое состояние.
С:
JavaFX 2.1

onCancelledProperty

public final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty()
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
Возвращает:
свойство обработчика события onCancelled
С:
JavaFX 2.1
См. также:
  • getOnCancelled()
  • setOnCancelled(EventHandler)

getOnCancelled

public final EventHandler<WorkerStateEvent> getOnCancelled()
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
Возвращает:
обработчик события onCancelled, если есть
С:
JavaFX 2.1

setOnCancelled

public final void setOnCancelled(EventHandler<WorkerStateEvent> value)
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
Параметры:
value - обработчик события, может быть null для очистки
С:
JavaFX 2.1

cancelled

protected void cancelled()
Защищенный вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние сервиса переходит в состояние CANCELLED. Этот метод вызывается после того, как сервис полностью перешел в новое состояние.
С:
JavaFX 2.1

onFailedProperty

public final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty()
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
Возвращает:
свойство обработчика события onFailed
С:
JavaFX 2.1
См. также:
  • getOnFailed()
  • setOnFailed(EventHandler)

getOnFailed

public final EventHandler<WorkerStateEvent> getOnFailed()
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
Возвращает:
обработчик события onFailed, если есть
С:
JavaFX 2.1

setOnFailed

public final void setOnFailed(EventHandler<WorkerStateEvent> value)
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
Параметры:
value - обработчик события, может быть null для очистки
С:
JavaFX 2.1
END_OF_DOCUMENT_MARKER

failed

protected void failed()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние FAILED. Этот метод вызывается после того, как служба полностью перешла в новое состояние.
С тех пор:
JavaFX 2.1

cancel

public boolean cancel()
Отменяет любые текущие выполняемые задачи, если таковые имеются. Состояние будет установлено в CANCELLED.
Определено в:
cancel в интерфейсе Worker<V>
Возвращает:
возвращает true, если отмена прошла успешно

restart

public void restart()
Отменяет любые текущие выполняемые задачи, если таковые имеются, и перезапускает эту службу. Состояние будет сброшено на READY перед выполнением. Этот метод следует вызывать только в потоке приложения FX.

reset

public void reset()
Сбрасывает службу. Может вызываться только при нахождении в одном из состояний завершения, то есть SUCCEEDED, FAILED или CANCELLED, или когда READY. Этот метод следует вызывать только в потоке приложения FX.

start

public void start()
Запускает эту службу. Служба должна быть в состоянии READY, чтобы это вызов был успешным. Этот метод следует вызывать только в потоке приложения FX.

executeTask

protected void executeTask(Task<V> task)

Использует executor, определённый в этой службе, для выполнения заданной задачи. Если executor равно null, используется выполнение по умолчанию, которое создаст новый демонический поток для выполнения этой задачи.

Этот метод предназначен только для вызова реализацией службы.

Параметры:
task - непустая задача для выполнения
С тех пор:
JavaFX 2.1

addEventHandler

public final <T extends Event> void addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
Регистрирует обработчик событий для этого целевого объекта.

Обработчик вызывается, когда целевой объект получает Event указанного типа во время фазы «подъёма» доставки событий.

Определено в:
addEventHandler в интерфейсе EventTarget
Параметры типа:
T - класс события обработчика
Параметры:
eventType - тип событий, получаемых обработчиком
eventHandler - обработчик событий
С тех пор:
JavaFX 2.1

removeEventHandler

public final <T extends Event> void removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
Удаляет ранее зарегистрированный обработчик событий из этого целевого объекта.

Поскольку возможно зарегистрировать один экземпляр EventHandler для разных типов событий, вызывающий код должен указать тип события, из которого должен быть удалён обработчик.

Определено в:
removeEventHandler в интерфейсе EventTarget
Параметры типа:
T - класс события обработчика
Параметры:
eventType - тип события, из которого нужно удалить
eventHandler - обработчик событий
С тех пор:
JavaFX 2.1

addEventFilter

public final <T extends Event> void addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
Регистрирует фильтр событий для этого целевого объекта.

Фильтр вызывается, когда целевой объект получает Event указанного типа во время фазы захвата доставки событий.

Определено в:
addEventFilter в интерфейсе EventTarget
Параметры типа:
T - класс события фильтра
Параметры:
eventType - тип событий, получаемых фильтром
eventFilter - фильтр событий
С тех пор:
JavaFX 2.1

removeEventFilter

public final <T extends Event> void removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)
Удаляет ранее зарегистрированный фильтр событий из этого целевого объекта.

Поскольку возможно зарегистрировать один экземпляр EventHandler для разных типов событий, вызывающий код должен указать тип события, из которого должен быть удалён фильтр.

Определено в:
removeEventFilter в интерфейсе EventTarget
Параметры типа:
T - класс события фильтра
Параметры:
eventType - тип события, из которого нужно удалить
eventFilter - фильтр событий
С тех пор:
JavaFX 2.1

setEventHandler

protected final <T extends Event> void setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
Устанавливает обработчик для этого типа события. Одновременно может быть указан только один такой обработчик. Этот обработчик гарантированно вызывается первым. Используется для регистрации пользовательских обработчиков событий onFoo.
Параметры типа:
T - конкретный класс события обработчика
Параметры:
eventType - тип события, который нужно связать с данным eventHandler
eventHandler - обработчик для регистрации, или null для отмены регистрации
Исключения:
NullPointerException - если тип события равен null
С тех пор:
JavaFX 2.1

fireEvent

protected final void fireEvent(Event event)
Вызывает указанное событие. Любой встреченный фильтр событий будет уведомлен и может потреблять событие. Если событие не потребляется фильтрами, уведомляются обработчики событий в этой задаче. Если эти обработчики также не потребляют событие, вызываются все обработчики событий и могут потреблять событие.

Этот метод должен вызываться в потоке FX пользователя.

Параметры:
event - событие для вызова
С тех пор:
JavaFX 2.1

buildEventDispatchChain

public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
Описание скопировано из интерфейса: EventTarget
Строит цепочку маршрутизации событий для этого целевого объекта. Цепочка маршрутизации событий содержит диспетчеры событий, которые могут быть заинтересованы в обработке событий, направленных на этот EventTarget. Этот целевой объект не добавляется в цепочку автоматически, поэтому, если он хочет обрабатывать события, ему нужно добавить EventDispatcher для себя в цепочку.

В случае, если целевой объект является частью иерархии, цепочка для него обычно строится из диспетчеров событий, собранных от корня иерархии до целевого объекта.

Цепочка маршрутизации событий строится путём модификаций предоставленной начальной цепочки маршрутизации событий. Возвращаемая цепочка должна иметь начальную цепочку в конце, поэтому диспетчеры должны быть добавлены в начало начальной цепочки.

Вызывающий код не должен предполагать, что начальная цепочка останется неизменной, ни то, что возвращаемое значение будет ссылаться на другую цепочку.

Определено в:
buildEventDispatchChain в интерфейсе EventTarget
Параметры:
tail - начальная цепочка для построения
Возвращает:
результирующая цепочка маршрутизации событий для этого целевого объекта

createTask

protected abstract Task<V> createTask()
Вызывается после запуска службы в потоке приложения JavaFX. Реализации должны сохранить любые состояния в переменных `final` перед созданием задачи, так как доступ к свойствам, определённым в службе, внутри кода задачи в фоновом потоке, приведёт к исключениям. Например:

     protected Task createTask() {
         final String url = myService.getUrl();
         return new Task<String>() {
             protected String call() {
                 URL u = new URL("http://www.oracle.com");
                 BufferedReader in = new BufferedReader(
                         new InputStreamReader(u.openStream()));
                 String result = in.readLine();
                 in.close();
                 return result;
             }
         }
     }
 

Если задача является предопределённым классом (а не анонимным), и если она следует рекомендуемой лучшей практике, то нет необходимости сохранять состояние перед созданием задачи, так как её состояние полностью предоставляется в её конструкторе.


     protected Task createTask() {
         // This is safe because getUrl is called on the FX Application
         // Thread and the FirstLineReaderTasks stores it as an
         // immutable property
         return new FirstLineReaderTask(myService.getUrl());
     }
 
Возвращает:
задачу для выполнения

Отправить сообщение об ошибке или предложить улучшение
Авторское право © 2008, 2025, Oracle и/или его дочерние компании. Все права защищены.

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API