Spec-Zone.ru › OpenJavaFX 21

Класс Service

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

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

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

Если на сервисе указан 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

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

Тип Свойство Описание
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, представляющий текущий прогресс.

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

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

Worker.State

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

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()
Отменяет выполнение текущей задачи, если она запущена.
protected void cancelled()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние CANCELLED.
protected abstract Task<V> createTask()
Вызывается после запуска службы в потоке JavaFX Application.
final ReadOnlyObjectProperty<Throwable> exceptionProperty()
Возвращает ReadOnlyObjectProperty, представляющий любую произошедшую ошибку.
protected void executeTask(Task<V> task)
Использует executor, определённый для данной службы, для выполнения заданной задачи.
final ObjectProperty<Executor> executorProperty()
Исполнитель, используемый для запуска данной службы.
protected void failed()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние FAILED.
protected final void fireEvent(Event event)
Срабатывает указанное событие.
final Throwable getException()
Возвращает значение свойства exception.
final Executor getExecutor()
Возвращает значение свойства executor.
final String getMessage()
Возвращает значение свойства message.
final EventHandler<WorkerStateEvent> getOnCancelled()
Обработчик события onCancelled вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
final EventHandler<WorkerStateEvent> getOnFailed()
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
final EventHandler<WorkerStateEvent> getOnReady()
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
final EventHandler<WorkerStateEvent> getOnRunning()
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
final EventHandler<WorkerStateEvent> getOnScheduled()
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
final EventHandler<WorkerStateEvent> getOnSucceeded()
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние 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 вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty()
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty()
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty()
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty()
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty()
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
final ReadOnlyDoubleProperty progressProperty()
Возвращает ReadOnlyDoubleProperty, представляющий прогресс.
protected void ready()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние 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()
Сбрасывает состояние службы.
void restart()
Отменяет выполнение текущей задачи, если она запущена, и перезапускает данную службу.
protected void running()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние RUNNING.
final ReadOnlyBooleanProperty runningProperty()
Возвращает ReadOnlyBooleanProperty, представляющее, запущена ли рабочая задача.
protected void scheduled()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние 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 вызывается всякий раз, когда состояние задачи переходит в состояние CANCELLED.
final void setOnFailed(EventHandler<WorkerStateEvent> value)
Обработчик события onFailed вызывается всякий раз, когда состояние задачи переходит в состояние FAILED.
final void setOnReady(EventHandler<WorkerStateEvent> value)
Обработчик события onReady вызывается всякий раз, когда состояние задачи переходит в состояние READY.
final void setOnRunning(EventHandler<WorkerStateEvent> value)
Обработчик события onRunning вызывается всякий раз, когда состояние задачи переходит в состояние RUNNING.
final void setOnScheduled(EventHandler<WorkerStateEvent> value)
Обработчик события onSchedule вызывается всякий раз, когда состояние задачи переходит в состояние SCHEDULED.
final void setOnSucceeded(EventHandler<WorkerStateEvent> value)
Обработчик события onSucceeded вызывается всякий раз, когда состояние задачи переходит в состояние SUCCEEDED.
void start()
Запускает данную службу.
final ReadOnlyObjectProperty<Worker.State> stateProperty()
Возвращает ReadOnlyObjectProperty, представляющий текущее состояние.
protected void succeeded()
Защищённый вспомогательный метод для подклассов, вызываемый всякий раз, когда состояние службы переходит в состояние 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

Подробности свойств

состояние

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

значение

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

исключение

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

выполненная работа

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

общая работа

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

прогресс

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

запущен

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

сообщение

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

заголовок

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

исполнитель

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()

valueProperty

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

getException

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

exceptionProperty

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

getWorkDone

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

workDoneProperty

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

getTotalWork

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

totalWorkProperty

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

getProgress

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

progressProperty

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

isRunning

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

runningProperty

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

getMessage

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

messageProperty

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

getTitle

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

titleProperty

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()

executorProperty

public final ObjectProperty<Executor> executorProperty()
Исполнитель для запуска данного Service. Если исполнитель не указан, тогда будет создан новый демон-поток и использован для запуска Service с помощью некоторого исполнителя по умолчанию.
Возвращает:
свойство 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
END_OF_DOCUMENT_MARKER

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

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 для различных типов событий, вызывающему объекту необходимо указать тип события, из которого должен быть снят обработчик.

Specified by:
removeEventHandler в интерфейсе EventTarget
Type Parameters:
T - класс события обработчика
Parameters:
eventType - тип события, из которого нужно снять обработку
eventHandler - обработчик событий
Since:
JavaFX 2.1

addEventFilter

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

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

Specified by:
addEventFilter в интерфейсе EventTarget
Type Parameters:
T - класс события фильтра
Parameters:
eventType - тип событий, получаемых фильтром
eventFilter - фильтр событий
Since:
JavaFX 2.1

removeEventFilter

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

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

Specified by:
removeEventFilter в интерфейсе EventTarget
Type Parameters:
T - класс события фильтра
Parameters:
eventType - тип события, из которого нужно снять обработку
eventFilter - фильтр событий
Since:
JavaFX 2.1

setEventHandler

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

fireEvent

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

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

Parameters:
event - событие для вызова
Since:
JavaFX 2.1

buildEventDispatchChain

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

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

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

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

Specified by:
buildEventDispatchChain в интерфейсе EventTarget
Parameters:
tail - начальная цепочка для построения
Returns:
результирующая цепочка обработки событий для этого целевого объекта

createTask

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

     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());
     }
Returns:
задача для выполнения

© 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