Spec-Zone.ru › OpenJavaFX 8
javafx.scene.control

Класс Dialog<R>

java.lang.Object
  • javafx.scene.control.Dialog<R>

Параметры типа:

R - Тип возвращаемого значения диалога через свойство result.

Все реализуемые интерфейсы:

EventTarget

Прямые известные подклассы:

Alert, ChoiceDialog, TextInputDialog



public class Dialog<R>
extends Object
implements EventTarget
Диалог в JavaFX оборачивает DialogPane и предоставляет необходимый API для его представления конечным пользователям. В JavaFX 8u40 это означает, что DialogPane отображается пользователям внутри Stage, но будущие версии могут предложить альтернативные варианты (такие как «лёгкие» или «внутренние» диалоги). Этот API преднамеренно не учитывает реализацию, стремясь представить общий API для всех возможных реализаций.

Класс Dialog имеет один параметризованный тип R, который используется для представления типа свойства result (и также для преобразования из ButtonType в R с помощью result converter Callback).

Важное примечание: Все разработчики, которые решат создавать собственные диалоги, расширяя класс Dialog, должны понимать важность свойства result converter. Конвертер результата должен всегда быть задан, когда тип R не равен Void или ButtonType. В противном случае разработчики столкнутся с ClassCastExceptions из-за несостоятельности преобразования из ButtonType через result converter.

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

После создания экземпляра Dialog следующим шагом является его конфигурация. Практически все свойства Dialog не связаны с содержимым диалога, исключениями являются contentTextProperty(), headerTextProperty() и graphicProperty(), которые просто передают API соответствующим свойствам DialogPane, хранящимся в свойстве dialog pane. Эти три свойства передаются от DialogPane для удобства разработчиков. Для настройки диалога разработчикам часто потребуется использовать код, аналогичный dialog.getDialogPane().setExpandableContent(node).

После настройки этих свойств остаётся только проверить, полностью ли настроены кнопки (созданные с помощью ButtonType и метода DialogPane.createButton(ButtonType)). Разработчики быстро обнаружат, что возможности настройки через класс ButtonType минимальны. Это намеренно, но не означает, что разработчики не могут изменить кнопки, созданные классом ButtonType, которые были заданы. Для этого разработчики просто вызывают метод DialogPane.lookupButton(ButtonType) с ButtonType (предполагая, что он уже установлен в списке DialogPane.getButtonTypes()). Возвращаемый узел обычно является типом Button, но это зависит от переопределения метода DialogPane.createButton(ButtonType). Типичный подход — следующий:

ButtonType loginButtonType = new ButtonType("Login", ButtonData.OK_DONE);
 Dialog<String> dialog = new Dialog<>();
 dialog.getDialogPane().getButtonTypes().add(loginButtonType);
 boolean disabled = false; // computed based on content of text fields, for example
 dialog.getDialogPane().lookupButton(loginButtonType).setDisable(disabled);

После создания и полной настройки Dialog следующим шагом является его отображение. Чаще всего диалоги отображаются в модальном и блокирующем режиме. «Модальный» означает, что диалог предотвращает взаимодействие пользователя с приложением-владельцем во время его отображения, а «блокирующий» означает, что выполнение кода останавливается в момент отображения диалога. Это позволяет отобразить диалог, дождаться ответа пользователя и продолжить выполнение кода, который следует за вызовом show, предоставляя разработчикам возможность немедленно обработать ввод пользователя из диалога (если это необходимо).

По умолчанию диалоги JavaFX являются модальными (это можно изменить с помощью API initModality(javafx.stage.Modality)). Для указания, хотите ли вы блокирующие или неблокирующие диалоги, разработчики просто вызывают showAndWait() или show() (соответственно). По умолчанию большинство разработчиков должны использовать showAndWait() из-за простоты кодирования в таких ситуациях. Ниже приведены три фрагмента кода, демонстрирующие три одинаково допустимых способа отображения диалога:

Вариант 1: «Традиционный» подход

Optional<ButtonType> result = dialog.showAndWait();
 if (result.isPresent() && result.get() == ButtonType.OK) {
     formatSystem();
 }

Вариант 2: Традиционный + необязательный подход

dialog.showAndWait().ifPresent(response -> {
     if (response == ButtonType.OK) {
         formatSystem();
     }
 });

Вариант 3: Полностью лямбда-подход

dialog.showAndWait()
      .filter(response -> response == ButtonType.OK)
      .ifPresent(response -> formatSystem());

Нет лучшего или худшего варианта из трёх перечисленных, поэтому разработчики могут выбирать подход, соответствующий их стилю. Цель демонстрации — познакомить разработчиков с API Optional, который является новым в Java 8 и может быть незнаком многим разработчикам.

Проверка диалога/перехват действий кнопок

В некоторых случаях желательно предотвратить закрытие диалога до тех пор, пока какой-либо аспект диалога не станет внутренне согласованным (например, у формы внутри диалога все поля находятся в корректном состоянии). Для этого пользователи API диалогов должны ознакомиться с методом DialogPane.lookupButton(ButtonType). Передав ButtonType (который уже был установлен в списке button types), пользователи получат узел, который обычно является типом Button (но это зависит от переопределения метода DialogPane.createButton(ButtonType)). С помощью этой кнопки пользователи могут добавить фильтр событий, который вызывается перед обычной обработкой событий кнопки, и, таким образом, могут предотвратить обработку события, consuming событие. Вот упрощённый пример:

final Button btOk = (Button) dlg.getDialogPane().lookupButton(ButtonType.OK);
 btOk.addEventFilter(ActionEvent.ACTION, event -> {
     if (!validateAndStore()) {
         event.consume();
     }
 });

Правила закрытия диалога

Важно понимать, что происходит при закрытии диалога, а также как диалог может быть закрыт, особенно в нестандартных ситуациях закрытия (например, при нажатии кнопки «X» в строке заголовка диалога или при выполнении операционных системных комбинаций клавиш (например, Alt-F4 в Windows)). К счастью, результат в этих ситуациях определён, и его можно кратко резюмировать в следующих пунктах:

  • Диалоги JavaFX могут быть закрыты «нестандартно» (как определено выше) в двух ситуациях:
    1. Когда у диалога одна кнопка, или
    2. Когда у диалога несколько кнопок, при условии, что одна из них соответствует одному из следующих требований:
      1. Кнопка имеет ButtonType, у которого ButtonBar.ButtonData имеет тип ButtonBar.ButtonData.CANCEL_CLOSE.
      2. Кнопка имеет ButtonType, у которого ButtonBar.ButtonData возвращает true при вызове ButtonBar.ButtonData.isCancelButton().
  • Во всех остальных ситуациях диалог откажется реагировать на все запросы закрытия, оставаясь открытым до тех пор, пока пользователь не нажмёт одну из доступных кнопок в области DialogPane диалога.
  • Если диалог закрывается нестандартно и содержит кнопку, соответствующую одному из двух вышеуказанных критериев, диалог попытается установить свойство result в значение, возвращённое при вызове result converter с первой соответствующей ButtonType.
  • Если по какой-либо причине конвертер результата возвращает null или диалог закрывается, когда присутствует только одна кнопка, не являющаяся кнопкой отмены, свойство result будет null, а метод showAndWait() вернёт Optional.empty(). Последний пункт означает, что если вы используете второй или третий варианты (как показано ранее в этом документе), лямбда-выражение Optional.ifPresent(java.util.function.Consumer) никогда не будет вызвана, и код продолжит выполнение так, как если бы диалог не вернул никакого значения.

С:

JavaFX 8u40

См. также:

Alert, TextInputDialog, ChoiceDialog

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

    Все методыМетоды экземпляраКонкретные методы
    Тип Свойство и описание
    StringProperty contentText
    Свойство, представляющее текстовое содержимое области диалога.
    ObjectProperty<DialogPane> dialogPane
    Корневой узел диалога, DialogPane содержит все визуальные элементы, отображаемые в диалоге.
    ObjectProperty<Node> graphic
    Графика диалога, представленная либо в заголовке, если он отображается, либо слева от content.
    StringProperty headerText
    Свойство, представляющее заголовок области диалога.
    ReadOnlyDoubleProperty height
    Свойство, представляющее высоту диалога.
    ObjectProperty<EventHandler<DialogEvent>> onCloseRequest
    Вызывается при внешнем запросе на закрытие этого Dialog.
    ObjectProperty<EventHandler<DialogEvent>> onHidden
    Вызывается сразу после того, как диалог был скрыт.
    ObjectProperty<EventHandler<DialogEvent>> onHiding
    Вызывается непосредственно перед скрытием диалога.
    ObjectProperty<EventHandler<DialogEvent>> onShowing
    Вызывается непосредственно перед отображением диалога.
    ObjectProperty<EventHandler<DialogEvent>> onShown
    Вызывается сразу после отображения диалога.
    BooleanProperty resizable
    Определяет, можно ли изменять размер диалога.
    ObjectProperty<Callback<ButtonType,R>> resultConverter
    API для преобразования ButtonType, на который нажал пользователь, в результат, который можно вернуть через свойство result.
    ObjectProperty<R> result
    Свойство, представляющее то, что было возвращено из диалога.
    ReadOnlyBooleanProperty showing
    Определяет, отображается ли в данный момент диалог.
    StringProperty title
    Возвращает свойство title диалога.
    ReadOnlyDoubleProperty width
    Свойство, представляющее ширину диалога.
    ReadOnlyDoubleProperty x
    Горизонтальное расположение этого Dialog.
    ReadOnlyDoubleProperty y
    Вертикальное расположение этого Dialog.
  • Краткое описание конструкторов

    Конструкторы
    Конструктор и описание
    Dialog()
    Создаёт диалог без указанного владельца.
  • Краткое описание методов

    Все методыМетоды экземпляраКонкретные методы
    Модификатор и тип Метод и описание
    EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
    Создаёт цепочку обработки событий для этого целевого объекта.
    void close()
    Скрывает диалоговое окно.
    StringProperty contentTextProperty()
    Свойство, представляющее текстовое содержимое панели диалогового окна.
    ObjectProperty<DialogPane> dialogPaneProperty()
    Корневой узел диалогового окна, DialogPane содержит все визуальные элементы, отображаемые в диалоговом окне.
    String getContentText()
    Возвращает текущий заданный текст содержимого для этой панели диалогового окна.
    DialogPane getDialogPane()
    Получает значение свойства dialogPane.
    Node getGraphic()
    Получает значение свойства graphic.
    String getHeaderText()
    Возвращает текущий заданный текст заголовка для этой панели диалогового окна.
    double getHeight()
    Возвращает высоту диалогового окна.
    Modality getModality()
    Извлекает атрибут модальности для этого диалогового окна.
    EventHandler<DialogEvent> getOnCloseRequest()
    Получает значение свойства onCloseRequest.
    EventHandler<DialogEvent> getOnHidden()
    Получает значение свойства onHidden.
    EventHandler<DialogEvent> getOnHiding()
    Получает значение свойства onHiding.
    EventHandler<DialogEvent> getOnShowing()
    Получает значение свойства onShowing.
    EventHandler<DialogEvent> getOnShown()
    Получает значение свойства onShown.
    Window getOwner()
    Извлекает окно-владелец для этого диалогового окна или null для диалогового окна без владельца.
    R getResult()
    Получает значение свойства result.
    Callback<ButtonType,R> getResultConverter()
    Получает значение свойства resultConverter.
    String getTitle()
    Возвращает заголовок диалогового окна.
    double getWidth()
    Возвращает ширину диалогового окна.
    double getX()
    Получает значение свойства x.
    double getY()
    Получает значение свойства y.
    ObjectProperty<Node> graphicProperty()
    Графика диалогового окна, представленная в заголовке, если он отображается, или слева от content.
    StringProperty headerTextProperty()
    Свойство, представляющее текст заголовка для панели диалогового окна.
    ReadOnlyDoubleProperty heightProperty()
    Свойство, представляющее высоту диалогового окна.
    void hide()
    Закрывает диалоговое окно.
    void initModality(Modality modality)
    Устанавливает модальность для этого диалогового окна.
    void initOwner(Window window)
    Устанавливает окно-владелец Window для этого диалогового окна или null для диалогового окна верхнего уровня без владельца.
    void initStyle(StageStyle style)
    Устанавливает стиль для этого диалогового окна.
    boolean isResizable()
    Возвращает, может ли диалоговое окно изменяться размером.
    boolean isShowing()
    Возвращает, отображается ли диалоговое окно.
    ObjectProperty<EventHandler<DialogEvent>> onCloseRequestProperty()
    Вызывается при внешнем запросе на закрытие этого Dialog.
    ObjectProperty<EventHandler<DialogEvent>> onHiddenProperty()
    Вызывается сразу после того, как диалоговое окно было скрыто.
    ObjectProperty<EventHandler<DialogEvent>> onHidingProperty()
    Вызывается непосредственно перед скрытием диалогового окна.
    ObjectProperty<EventHandler<DialogEvent>> onShowingProperty()
    Вызывается непосредственно перед отображением диалогового окна.
    ObjectProperty<EventHandler<DialogEvent>> onShownProperty()
    Вызывается сразу после отображения диалогового окна.
    BooleanProperty resizableProperty()
    Представляет, может ли пользователь изменять размер диалогового окна.
    ObjectProperty<Callback<ButtonType,R>> resultConverterProperty()
    API для преобразования ButtonType, на который нажал пользователь, в результат, который может быть возвращён через свойство result.
    ObjectProperty<R> resultProperty()
    Свойство, представляющее то, что было возвращено из диалогового окна.
    void setContentText(String contentText)
    Устанавливает строку для отображения в области содержимого диалогового окна.
    void setDialogPane(DialogPane value)
    Устанавливает значение свойства dialogPane.
    void setGraphic(Node graphic)
    Устанавливает графику диалогового окна, которая будет отображаться либо в заголовке, если он отображается, либо слева от content.
    void setHeaderText(String headerText)
    Устанавливает строку для отображения в области заголовка диалогового окна.
    void setHeight(double height)
    Устанавливает высоту диалогового окна.
    void setOnCloseRequest(EventHandler<DialogEvent> value)
    Устанавливает значение свойства onCloseRequest.
    void setOnHidden(EventHandler<DialogEvent> value)
    Устанавливает значение свойства onHidden.
    void setOnHiding(EventHandler<DialogEvent> value)
    Устанавливает значение свойства onHiding.
    void setOnShowing(EventHandler<DialogEvent> value)
    Устанавливает значение свойства onShowing.
    void setOnShown(EventHandler<DialogEvent> value)
    Устанавливает значение свойства onShown.
    void setResizable(boolean resizable)
    Устанавливает, можно ли пользователю изменять размер диалогового окна.
    void setResult(R value)
    Устанавливает значение свойства result.
    void setResultConverter(Callback<ButtonType,R> value)
    Устанавливает значение свойства resultConverter.
    void setTitle(String title)
    Изменяет заголовок диалогового окна.
    void setWidth(double width)
    Устанавливает ширину диалогового окна.
    void setX(double x)
    Устанавливает значение свойства x.
    void setY(double y)
    Устанавливает значение свойства y.
    void show()
    Отображает диалоговое окно, но не ждёт ответа пользователя (другими словами, это диалоговое окно без блокировки).
    Optional<R> showAndWait()
    Отображает диалоговое окно и ждёт ответа пользователя (другими словами, это блокирующее диалоговое окно, с возвращаемым значением - вводом пользователя).
    ReadOnlyBooleanProperty showingProperty()
    Представляет, отображается ли диалоговое окно в настоящее время.
    StringProperty titleProperty()
    Возвращает titleProperty диалогового окна.
    ReadOnlyDoubleProperty widthProperty()
    Свойство, представляющее ширину диалогового окна.
    ReadOnlyDoubleProperty xProperty()
    Горизонтальное положение этого Dialog.
    ReadOnlyDoubleProperty yProperty()
    Вертикальное положение этого Dialog.
    • Наследованные методы от класса java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Подробное описание свойств

    • dialogPane

      public final ObjectProperty<DialogPane> dialogPaneProperty
      Главный узел диалога, DialogPane содержит все визуальные элементы, отображаемые в диалоге. Таким образом, можно полностью настроить отображение диалога, изменив существующий диалоговый фрагмент или создав новый.

      См. также:

      getDialogPane(), setDialogPane(DialogPane)

    • contentText

      public final StringProperty contentTextProperty
      Свойство, представляющее текстовое содержимое диалогового фрагмента. Текст содержимого имеет более низкий приоритет, чем content node, что означает, что если установлены оба свойства узла содержимого и contentText, текст содержимого не будет отображаться в стандартном экземпляре DialogPane.

      См. также:

      getContentText(), setContentText(String)

    • headerText

      public final StringProperty headerTextProperty
      Свойство, представляющее заголовок диалогового фрагмента. Текст заголовка имеет более низкий приоритет, чем header node, что означает, что если установлены оба свойства узла заголовка и headerText, текст заголовка не будет отображаться в стандартном экземпляре DialogPane.

      См. также:

      getHeaderText(), setHeaderText(String)

    • graphic

      public final ObjectProperty<Node> graphicProperty
      Графика диалога, отображаемая либо в заголовке, если он отображается, либо слева от content.

      См. также:

      getGraphic(), setGraphic(Node)

    • result

      public final ObjectProperty<R> resultProperty
      Свойство, представляющее возвращаемое значение диалога. Результат генерируется с помощью result converter, который предназначен для преобразования нажатой пользователем ButtonType в значение типа R. Для получения дополнительных сведений см. JavaDoc класса Dialog.

      См. также:

      getResult(), setResult(R)

    • resultConverter

      public final ObjectProperty<Callback<ButtonType,R>> resultConverterProperty
      API для преобразования нажатой пользователем ButtonType в результат, который можно вернуть через свойство result. Это необходимо, так как ButtonType представляет собой визуальную кнопку в диалоге и не знает, как сопоставить себя с допустимым результатом — это требование реализации диалога, использующей преобразователь результатов. В некоторых случаях тип результата подкласса Dialog — ButtonType (что означает, что преобразователь результата может быть null), но в некоторых случаях (где тип результата R не ButtonType или Void) этот обратный вызов должен быть указан.

      См. также:

      getResultConverter(), setResultConverter(Callback)

    • showing

      public final ReadOnlyBooleanProperty showingProperty
      Указывает, отображается ли диалог в данный момент.

      См. также:

      isShowing()

    • resizable

      public final BooleanProperty resizableProperty
      Указывает, можно ли изменять размер диалога.

      См. также:

      isResizable(), setResizable(boolean)

    • width

      public final ReadOnlyDoubleProperty widthProperty
      Свойство, представляющее ширину диалога.

      См. также:

      getWidth(), setWidth(double)

    • height

      public final ReadOnlyDoubleProperty heightProperty
      Свойство, представляющее высоту диалога.

      См. также:

      getHeight(), setHeight(double)

    • title

      public final StringProperty titleProperty
      Возвращает свойство заголовка диалога.

      См. также:

      getTitle(), setTitle(String)

    • x

      public final ReadOnlyDoubleProperty xProperty
      Горизонтальное положение этого Dialog. Изменение этого атрибута переместит Dialog по горизонтали.

      См. также:

      getX(), setX(double)

    • y

      public final ReadOnlyDoubleProperty yProperty
      Вертикальное положение этого Dialog. Изменение этого атрибута переместит Dialog по вертикали.

      См. также:

      getY(), setY(double)

    • onShowing

      public final ObjectProperty<EventHandler<DialogEvent>> onShowingProperty
      Вызывается непосредственно перед отображением диалога.

      См. также:

      getOnShowing(), setOnShowing(EventHandler)

    • onShown

      public final ObjectProperty<EventHandler<DialogEvent>> onShownProperty
      Вызывается сразу после отображения диалога.

      См. также:

      getOnShown(), setOnShown(EventHandler)

    • onHiding

      public final ObjectProperty<EventHandler<DialogEvent>> onHidingProperty
      Вызывается непосредственно перед скрытием диалога.

      См. также:

      getOnHiding(), setOnHiding(EventHandler)

    • onHidden

      public final ObjectProperty<EventHandler<DialogEvent>> onHiddenProperty
      Вызывается сразу после скрытия диалога. При скрытии Dialog этот обработчик событий вызывается, позволяя разработчику очистить ресурсы или выполнить другие задачи при закрытии Alert.

      См. также:

      getOnHidden(), setOnHidden(EventHandler)

    • onCloseRequest

      public final ObjectProperty<EventHandler<DialogEvent>> onCloseRequestProperty
      Вызывается при внешнем запросе на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалога, обработв полученное событие.

      См. также:

      getOnCloseRequest(), setOnCloseRequest(EventHandler)

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

    • Dialog

      public Dialog()
      Создаёт диалог без указанного владельца.
  • Метод детали

    • show

      public final void show()
      Отображает диалог, но не ожидает ответа пользователя (другими словами, это отображает диалог без блокировки). Пользователи этого API должны либо проверять свойство result property, либо добавить слушатель к свойству результата, чтобы быть уведомленными, когда оно будет установлено.
    • showAndWait

      public final Optional<R> showAndWait()
      Отображает диалог и ожидает ответа пользователя (другими словами, отображает блокирующий диалог, а возвращаемое значение - ввод пользователя).

      Возвращает:

      An Optional содержащий result. Подробности см. в документации класса Dialog.

    • close

      public final void close()
      Скрывает диалог.
    • hide

      public final void hide()
      Закрывает диалог.
    • initModality

      public final void initModality(Modality modality)
      Устанавливает модальность для этого диалога. Это должно быть сделано до того, как диалог станет видимым. Модальность может быть: Modality.NONE, Modality.WINDOW_MODAL или Modality.APPLICATION_MODAL.

      Значение по умолчанию:

      Modality.APPLICATION_MODAL

      Параметры:

      modality - модальность для этого диалога.

      Исключения:

      IllegalStateException - если это свойство установлено после того, как диалог был виден.

    • getModality

      public final Modality getModality()
      Возвращает атрибут модальности для этого диалога.

      Возвращает:

      модальность.

    • initStyle

      public final void initStyle(StageStyle style)
      Устанавливает стиль для этого диалога. Это должно быть сделано до того, как диалог станет видимым. Стиль может быть: StageStyle.DECORATED, StageStyle.UNDECORATED, StageStyle.TRANSPARENT, StageStyle.UTILITY или StageStyle.UNIFIED.

      Значение по умолчанию:

      StageStyle.DECORATED

      Параметры:

      style - стиль для этого диалога.

      Исключения:

      IllegalStateException - если это свойство установлено после того, как диалог был виден.

    • initOwner

      public final void initOwner(Window window)
      Устанавливает владельца Window для этого диалога или null для диалога верхнего уровня без владельца. Это должно быть сделано до того, как диалог станет видимым.

      Значение по умолчанию:

      null

      Параметры:

      window - владелец Window для этого диалога.

      Исключения:

      IllegalStateException - если это свойство установлено после того, как диалог был виден.

    • getOwner

      public final Window getOwner()
      Возвращает окно-владелец для этого диалога или null для диалога без владельца.

      Возвращает:

      окно-владелец.

    • dialogPaneProperty

      public final ObjectProperty<DialogPane> dialogPaneProperty()
      Корневой узел диалога, DialogPane содержит все визуальные элементы, отображаемые в диалоге. Таким образом, можно полностью настроить отображение диалога, изменив существующую область диалога или создав новую.

      См. также:

      getDialogPane(), setDialogPane(DialogPane)

    • getDialogPane

      public final DialogPane getDialogPane()
      Возвращает значение свойства dialogPane.

      Описание свойства:

      Корневой узел диалога, DialogPane содержит все визуальные элементы, отображаемые в диалоге. Таким образом, можно полностью настроить отображение диалога, изменив существующую область диалога или создав новую.

    • setDialogPane

      public final void setDialogPane(DialogPane value)
      Устанавливает значение свойства dialogPane.

      Описание свойства:

      Корневой узел диалога, DialogPane содержит все визуальные элементы, отображаемые в диалоге. Таким образом, можно полностью настроить отображение диалога, изменив существующую область диалога или создав новую.

    • contentTextProperty

      public final StringProperty contentTextProperty()
      Свойство, представляющее текст содержимого для области диалога. Текст содержимого имеет меньший приоритет, чем content node, что означает, что если установлены и узел содержимого, и свойства contentText, текст содержимого не будет отображаться в экземпляре DialogPane по умолчанию.

      См. также:

      getContentText(), setContentText(String)

    • getContentText

      public final String getContentText()
      Возвращает текущий текст содержимого для этой области диалога.
    • setContentText

      public final void setContentText(String contentText)
      Устанавливает строку для отображения в области содержимого диалога. Обратите внимание, что текст содержимого имеет меньший приоритет, чем content node, что означает, что если установлены и узел содержимого, и свойства contentText, текст содержимого не будет отображаться в экземпляре DialogPane по умолчанию.
    • headerTextProperty

      public final StringProperty headerTextProperty()
      Свойство, представляющее текст заголовка для области диалога. Текст заголовка имеет меньший приоритет, чем header node, что означает, что если установлены и узел заголовка, и свойства headerText, текст заголовка не будет отображаться в экземпляре DialogPane по умолчанию.

      См. также:

      getHeaderText(), setHeaderText(String)

    • getHeaderText

      public final String getHeaderText()
      Возвращает текущий текст заголовка для этой области диалога.
    • setHeaderText

      public final void setHeaderText(String headerText)
      Устанавливает строку для отображения в области заголовка диалога. Обратите внимание, что текст заголовка имеет меньший приоритет, чем header node, что означает, что если установлены и узел заголовка, и свойства headerText, текст заголовка не будет отображаться в экземпляре DialogPane по умолчанию.
    • graphicProperty

      public final ObjectProperty<Node> graphicProperty()
      Графика диалога, отображаемая либо в заголовке, если он отображается, либо слева от content.

      См. также:

      getGraphic(), setGraphic(Node)

    • getGraphic

      public final Node getGraphic()
      Возвращает значение свойства graphic.

      Описание свойства:

      Графика диалога, отображаемая либо в заголовке, если он отображается, либо слева от content.

    • setGraphic

      public final void setGraphic(Node graphic)
      Устанавливает графику диалога, которая будет отображаться либо в заголовке, если он отображается, либо слева от content.

      Параметры:

      graphic - новая графика диалога или null, если графика не должна отображаться.

    • resultProperty

      public final ObjectProperty<R> resultProperty()
      Свойство, представляющее возвращённое значение диалога. Результат генерируется с помощью result converter, который предназначен для преобразования нажатой пользователем ButtonType в значение типа R. Дополнительные сведения см. в JavaDoc класса Dialog.

      См. также:

      getResult(), setResult(R)

    • getResult

      public final R getResult()
      Возвращает значение свойства result.

      Описание свойства:

      Свойство, представляющее возвращённое значение диалога. Результат генерируется с помощью result converter, который предназначен для преобразования нажатой пользователем ButtonType в значение типа R. Дополнительные сведения см. в JavaDoc класса Dialog.

    • setResult

      public final void setResult(R value)
      Устанавливает значение свойства result.

      Описание свойства:

      Свойство, представляющее возвращённое значение диалога. Результат генерируется с помощью result converter, который предназначен для преобразования нажатой пользователем ButtonType в значение типа R. Дополнительные сведения см. в JavaDoc класса Dialog.

    • resultConverterProperty

      public final ObjectProperty<Callback<ButtonType,R>> resultConverterProperty()
      API для преобразования нажатой пользователем ButtonType в результат, который может быть возвращён через свойство result. Это необходимо, так как ButtonType представляет собой визуальную кнопку в диалоговом окне и не знает, как сопоставить себя с допустимым результатом — это требование реализации диалога с использованием преобразователя результата. В некоторых случаях тип результата подкласса Dialog — ButtonType (что означает, что преобразователь результата может быть null), но в некоторых случаях (где тип результата, R, не ButtonType или Void) этот вызов должен быть указан.

      См. также:

      getResultConverter(), setResultConverter(Callback)

    • getResultConverter

      public final Callback<ButtonType,R> getResultConverter()
      Получает значение свойства resultConverter.

      Описание свойства:

      API для преобразования ButtonType, на который нажал пользователь, в результат, который может быть возвращён через свойство result. Это необходимо, так как ButtonType представляет собой визуальную кнопку в диалоговом окне и не знает, как сопоставить себя с допустимым результатом — это требование реализации диалогового окна с использованием преобразователя результатов. В некоторых случаях тип результата подкласса Dialog — ButtonType (что означает, что преобразователь результатов может быть null), но в некоторых случаях (где тип результата, R, не ButtonType или Void), этот обратный вызов должен быть указан.

    • setResultConverter

      public final void setResultConverter(Callback<ButtonType,R> value)
      Устанавливает значение свойства resultConverter.

      Описание свойства:

      API для преобразования ButtonType, на который нажал пользователь, в результат, который может быть возвращён через свойство result. Это необходимо, так как ButtonType представляет собой визуальную кнопку в диалоговом окне и не знает, как сопоставить себя с допустимым результатом — это требование реализации диалогового окна с использованием преобразователя результатов. В некоторых случаях тип результата подкласса Dialog — ButtonType (что означает, что преобразователь результатов может быть null), но в некоторых случаях (где тип результата, R, не ButtonType или Void), этот обратный вызов должен быть указан.

    • showingProperty

      public final ReadOnlyBooleanProperty showingProperty()
      Представляет собой отображение диалогового окна.

      См. также:

      isShowing()

    • isShowing

      public final boolean isShowing()
      Возвращает значение, показывается ли диалоговое окно.

      Возвращает:

      true, если диалоговое окно отображается.

    • resizableProperty

      public final BooleanProperty resizableProperty()
      Представляет собой возможность изменения размера диалогового окна.

      См. также:

      isResizable(), setResizable(boolean)

    • isResizable

      public final boolean isResizable()
      Возвращает значение, является ли диалоговое окно изменяемым по размеру.

      Возвращает:

      true, если диалоговое окно изменяемо по размеру.

    • setResizable

      public final void setResizable(boolean resizable)
      Устанавливает, можно ли пользователю изменять размер диалогового окна. Изменяемые по размеру диалоговые окна также могут быть максимизированы (кнопка максимизации становится видимой).

      Параметры:

      resizable - true, если диалоговое окно должно быть изменяемым по размеру.

    • widthProperty

      public final ReadOnlyDoubleProperty widthProperty()
      Свойство, представляющее ширину диалогового окна.

      См. также:

      getWidth(), setWidth(double)

    • getWidth

      public final double getWidth()
      Возвращает ширину диалогового окна.
    • setWidth

      public final void setWidth(double width)
      Устанавливает ширину диалогового окна.
    • heightProperty

      public final ReadOnlyDoubleProperty heightProperty()
      Свойство, представляющее высоту диалогового окна.

      См. также:

      getHeight(), setHeight(double)

    • getHeight

      public final double getHeight()
      Возвращает высоту диалогового окна.
    • setHeight

      public final void setHeight(double height)
      Устанавливает высоту диалогового окна.
    • titleProperty

      public final StringProperty titleProperty()
      Возвращает свойство заголовка диалогового окна.

      См. также:

      getTitle(), setTitle(String)

    • getTitle

      public final String getTitle()
      Возвращает заголовок диалогового окна.
    • setTitle

      public final void setTitle(String title)
      Изменить заголовок диалогового окна.

      Параметры:

      title -

    • getX

      public final double getX()
      Получает значение свойства x.

      Описание свойства:

      Горизонтальное положение этого Dialog. Изменение этого атрибута переместит Dialog по горизонтали.

    • setX

      public final void setX(double x)
      Устанавливает значение свойства x.

      Описание свойства:

      Горизонтальное положение этого Dialog. Изменение этого атрибута переместит Dialog по горизонтали.

    • xProperty

      public final ReadOnlyDoubleProperty xProperty()
      Горизонтальное положение этого Dialog. Изменение этого атрибута переместит Dialog по горизонтали.

      См. также:

      getX(), setX(double)

    • getY

      public final double getY()
      Получает значение свойства y.

      Описание свойства:

      Вертикальное положение этого Dialog. Изменение этого атрибута переместит Dialog по вертикали.

    • setY

      public final void setY(double y)
      Устанавливает значение свойства y.

      Описание свойства:

      Вертикальное положение этого Dialog. Изменение этого атрибута переместит Dialog по вертикали.

    • yProperty

      public final ReadOnlyDoubleProperty yProperty()
      Вертикальное положение этого Dialog. Изменение этого атрибута переместит Dialog по вертикали.

      См. также:

      getY(), setY(double)

    • buildEventDispatchChain

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

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

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

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

      Определено в:

      buildEventDispatchChain в интерфейсе EventTarget

      Параметры:

      tail - начальная цепочка для построения

      Возвращает:

      результирующая цепочка обработки событий для этой цели

    • setOnShowing

      public final void setOnShowing(EventHandler<DialogEvent> value)
      Устанавливает значение свойства onShowing.

      Описание свойства:

      Вызывается непосредственно перед отображением диалогового окна.

    • getOnShowing

      public final EventHandler<DialogEvent> getOnShowing()
      Получает значение свойства onShowing.

      Описание свойства:

      Вызывается непосредственно перед отображением диалогового окна.

    • onShowingProperty

      public final ObjectProperty<EventHandler<DialogEvent>> onShowingProperty()
      Вызывается непосредственно перед отображением диалогового окна.

      См. также:

      getOnShowing(), setOnShowing(EventHandler)

    • setOnShown

      public final void setOnShown(EventHandler<DialogEvent> value)
      Устанавливает значение свойства onShown.

      Описание свойства:

      Вызывается сразу после отображения диалогового окна.

    • getOnShown

      public final EventHandler<DialogEvent> getOnShown()
      Получает значение свойства onShown.

      Описание свойства:

      Вызывается сразу после отображения диалогового окна.

    • onShownProperty

      public final ObjectProperty<EventHandler<DialogEvent>> onShownProperty()
      Вызывается сразу после отображения диалогового окна.

      См. также:

      getOnShown(), setOnShown(EventHandler)

    • setOnHiding

      public final void setOnHiding(EventHandler<DialogEvent> value)
      Устанавливает значение свойства onHiding.

      Описание свойства:

      Вызывается непосредственно перед скрытием диалогового окна.

    • getOnHiding

      public final EventHandler<DialogEvent> getOnHiding()
      Получает значение свойства onHiding.

      Описание свойства:

      Вызывается непосредственно перед скрытием диалогового окна.

    • onHidingProperty

      public final ObjectProperty<EventHandler<DialogEvent>> onHidingProperty()
      Вызывается непосредственно перед скрытием диалогового окна.

      См. также:

      getOnHiding(), setOnHiding(EventHandler)

    • setOnHidden

      public final void setOnHidden(EventHandler<DialogEvent> value)
      Устанавливает значение свойства onHidden.

      Описание свойства:

      Вызывается сразу после скрытия диалогового окна. Когда Dialog скрыт, этот обработчик событий вызывается, позволяя разработчику очистить ресурсы или выполнить другие задачи при закрытии Alert.

    • getOnHidden

      public final EventHandler<DialogEvent> getOnHidden()
      Получает значение свойства onHidden.

      Описание свойства:

      Вызывается сразу после скрытия диалогового окна. Когда Dialog скрыт, этот обработчик событий вызывается, позволяя разработчику очистить ресурсы или выполнить другие задачи при закрытии Alert.

    • onHiddenProperty

      public final ObjectProperty<EventHandler<DialogEvent>> onHiddenProperty()
      Вызывается сразу после того, как диалоговое окно было скрыто. Когда Dialog скрыт, этот обработчик событий вызывается, позволяя разработчику очистить ресурсы или выполнить другие задачи при закрытии Alert.

      См. также:

      getOnHidden(), setOnHidden(EventHandler)

    • setOnCloseRequest

      public final void setOnCloseRequest(EventHandler<DialogEvent> value)
      Устанавливает значение свойства onCloseRequest.

      Описание свойства:

      Вызывается, когда происходит внешний запрос на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалогового окна, обработав полученное событие.

    • getOnCloseRequest

      public final EventHandler<DialogEvent> getOnCloseRequest()
      Получает значение свойства onCloseRequest.

      Описание свойства:

      Вызывается, когда происходит внешний запрос на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалогового окна, обработав полученное событие.

    • onCloseRequestProperty

      public final ObjectProperty<EventHandler<DialogEvent>> onCloseRequestProperty()
      Вызывается, когда происходит внешний запрос на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалогового окна, обработав полученное событие.

      См. также:

      getOnCloseRequest(), setOnCloseRequest(EventHandler)

© 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