Spec-Zone.ru › OpenJavaFX 11
Модуль javafx.controls
Пакет javafx.scene.control

Класс Dialog<R>

  • java.lang.Object
    • javafx.scene.control.Dialog<R>
  • Type Parameters:
    R — тип возвращаемого значения диалога через свойство result.
    All Implemented Interfaces:
    EventTarget
    Direct Known Subclasses:
    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);

    После создания и полной настройки диалога следующим шагом является его отображение. В большинстве случаев диалоги отображаются модально и блокирующим образом. «Модальный» означает, что диалог блокирует взаимодействие пользователя с приложением во время его отображения, а «блокирующий» означает остановку выполнения кода в момент отображения диалога. Это позволяет отобразить диалог, дождаться ответа пользователя и продолжить выполнение кода, который следует сразу после вызова 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(). Последний пункт означает, что если вы используете любой из вариантов 2 или 3 (как показано ранее в документации к этому классу), лямбда-выражение Optional.ifPresent(java.util.function.Consumer) никогда не будет выполнено, и выполнение кода продолжится так, как если бы диалог не возвратил никакого значения вообще.
  • Since:
    JavaFX 8u40
    See Also:
    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
    Возвращает titleProperty диалогового окна.
    ReadOnlyDoubleProperty width
    Свойство, представляющее ширину диалогового окна.
    ReadOnlyDoubleProperty x
    Горизонтальное расположение этого Dialog.
    ReadOnlyDoubleProperty y
    Вертикальное расположение этого Dialog.
  • Краткое описание конструкторов

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

    Все методыМетоды экземпляраКонкретные методы
    Модификатор и тип Метод Описание
    EventDispatchChain buildEventDispatchChain​(EventDispatchChain tail)
    Создаёт цепочку обработки событий для данного целевого объекта.
    void close()
    Закрывает этот Dialog.
    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()
    Скрывает этот Dialog.
    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
      Возвращает свойство title диалога.
      См. также:
      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, либо добавить слушателя к свойству результата, чтобы получать информацию о том, когда оно установлено.
      Исключения:
      IllegalStateException - если этот метод вызывается в потоке, отличном от потока приложения JavaFX.
    • showAndWait

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

      Этот метод должен вызываться в потоке приложения JavaFX. Кроме того, он должен вызываться либо из обработчика событий ввода, либо из метода run Runnable, переданного в Platform.runLater. Его нельзя вызывать во время обработки анимации или компоновки.

      Возвращает:
      A Optional, который содержит result. См. документацию по классу Dialog для получения более подробной информации.
      Исключения:
      IllegalStateException - если этот метод вызывается в потоке, отличном от потока приложения JavaFX.
      IllegalStateException - если этот метод вызывается во время обработки анимации или компоновки.
    • close

      public final void close()
      Закрывает это Dialog. Этот вызов эквивалентен hide().
    • hide

      public final void hide()
      Скрывает это Dialog.
    • 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()
      Возвращает текущий заданный текст содержимого для этого DialogPane.
      Возвращает:
      текущий заданный текст содержимого для этого DialogPane
    • setContentText

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

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

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

      public final void setHeaderText​(String headerText)
      Задает строку для отображения в области заголовка диалогового окна. Обратите внимание, что текст заголовка имеет более низкий приоритет, чем header node, что означает, что если установлены как узел заголовка, так и свойства headerText, текст заголовка не будет отображаться в экземпляре DialogPane по умолчанию.
      Параметры:
      headerText - строка для отображения в области заголовка диалогового окна
    • 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)
      Устанавливает ширину диалогового окна.
      Параметры:
      width - ширина диалогового окна
    • heightProperty

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

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

      public final void setHeight​(double height)
      Устанавливает высоту диалогового окна.
      Параметры:
      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