Класс Dialog<R>

java.lang.Object

fx.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 не связаны с содержанием 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.setTitle("Login Dialog");
 dialog.setContentText("Would you like to log in?");
 dialog.getDialogPane().getButtonTypes().add(loginButtonType);
 boolean disabled = false; // computed based on content of text fields, for example
 dialog.getDialogPane().lookupButton(loginButtonType).setDisable(disabled);
 dialog.showAndWait();

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

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

С:: 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`	Возвращает titleProperty диалога.
`ReadOnlyDoubleProperty`	`width`	Свойство, представляющее ширину диалога.
`ReadOnlyDoubleProperty`	`x`	Горизонтальное положение этого `Dialog`.
`ReadOnlyDoubleProperty`	`y`	Вертикальное положение этого `Dialog`.

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

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

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

Модификатор и тип	Метод	Описание

`void`	`close()`	Закрывает этот `Dialog`.
`StringProperty`	`contentTextProperty()`	Свойство, представляющее текст содержимого диалогового окна.
`ObjectProperty<DialogPane>`	`dialogPaneProperty()`	Корневой узел диалогового окна, `DialogPane` содержит все визуальные элементы, отображаемые в диалоговом окне.
`String`	`getContentText()`	Возвращает текущий текст содержимого этого DialogPane.
`DialogPane`	`getDialogPane()`	Возвращает значение свойства dialogPane.
`Node`	`getGraphic()`	Возвращает значение свойства graphic.
`String`	`getHeaderText()`	Возвращает текущий текст заголовка этого DialogPane.
`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)`	Устанавливает окно-владелец для этого диалогового окна, или 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

Методы, объявленные в интерфейсе javafx.event.EventTarget

buildEventDispatchChain

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

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

Исключения:: IllegalStateException - если этот метод вызывается в потоке, отличном от потока JavaFX Application.

showAndWait

public final Optional<R> showAndWait()

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

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

Возвращает:: Объект Optional, содержащий result. Дополнительные сведения см. в документации класса Dialog.
Исключения:: IllegalStateException - если этот метод вызывается в потоке, отличном от потока JavaFX Application.; 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)

Устанавливает окно-владелец для этого диалогового окна или null для верхнего уровня, не связанного с окном диалогового окна. Это необходимо сделать до отображения диалогового окна.

Значение по умолчанию:: null
Параметры:: 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. Дополнительные сведения см. в документации к классу Dialog.

См. также:: getResult(), setResult(R)

getResult

public final R getResult()

Получает значение свойства result.

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

setResult

public final void setResult(R value)

Устанавливает значение свойства result.

Описание свойства:: Свойство, представляющее возвращаемое значение из диалогового окна. Результат генерируется через result converter, который предназначен для преобразования выбранной пользователем ButtonType в значение типа R. Дополнительные сведения см. в документации к классу 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)

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

См. также:: 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.