Spec-Zone.ru › OpenJavaFX 21

Класс 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.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();
Image of the Dialog control

После создания и полной настройки 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(). Этот последний момент означает, что, если вы используете любой из вариантов 2 или 3 (как показано ранее в документации к этому классу), лямбда-выражение Optional.ifPresent(java.util.function.Consumer) никогда не будет вызвана, и выполнение кода продолжится так, как будто диалоговое окно не вернуло никакого значения.
Since:
JavaFX 8u40
See Also:
  • Alert
  • TextInputDialog
  • ChoiceDialog

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

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

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

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

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

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

contentText

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

headerText

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

graphic

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

result

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

resultConverter

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

showing

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

resizable

public final BooleanProperty resizableProperty
Указывает, можно ли изменять размер диалогового окна.
См. также:
  • isResizable()
  • setResizable(boolean)
  • resizableProperty()

width

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

height

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

title

public final StringProperty titleProperty
Возвращает свойство заголовка диалогового окна.
См. также:
  • getTitle()
  • setTitle(String)
  • titleProperty()

x

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

y

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

onShowing

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

onShown

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

onHiding

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

onHidden

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

onCloseRequest

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

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

Dialog

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

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

show

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

showAndWait

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

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

Возвращает:
Объект 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 содержит все визуальные элементы, отображаемые в диалоговом окне. Таким образом, можно полностью настроить отображение диалогового окна, изменив существующую область диалогового окна или создав новую.
Возвращает:
свойство dialogPane
См. также:
  • getDialogPane()
  • setDialogPane(DialogPane)

getDialogPane

public final DialogPane getDialogPane()
Возвращает значение свойства dialogPane.
Описание свойства:
Корневой узел диалогового окна, DialogPane содержит все визуальные элементы, отображаемые в диалоговом окне. Таким образом, можно полностью настроить отображение диалогового окна, изменив существующую область диалогового окна или создав новую.
Возвращает:
значение свойства dialogPane
См. также:
  • setDialogPane(DialogPane)
  • dialogPaneProperty()

setDialogPane

public final void setDialogPane(DialogPane value)
Устанавливает значение свойства dialogPane.
Описание свойства:
Корневой узел диалогового окна, DialogPane содержит все визуальные элементы, отображаемые в диалоговом окне. Таким образом, можно полностью настроить отображение диалогового окна, изменив существующую область диалогового окна или создав новую.
Параметры:
value - значение для свойства dialogPane
См. также:
  • getDialogPane()
  • dialogPaneProperty()

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.
Возвращает:
Объект ObjectProperty, содержащий текущую графику.
См. также:
  • getGraphic()
  • setGraphic(Node)

getGraphic

public final Node getGraphic()
Получает значение свойства graphic.
Описание свойства:
Графика диалогового окна, отображаемая в заголовке, если он отображается, или слева от content.
Возвращает:
значение свойства graphic
См. также:
  • setGraphic(Node)
  • graphicProperty()

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.
Возвращает:
значение свойства result
См. также:
  • setResult(R)
  • resultProperty()

setResult

public final void setResult(R value)
Устанавливает значение свойства result.
Описание свойства:
Свойство, представляющее возвращаемое значение из диалогового окна. Результат генерируется с помощью result converter, который предназначен для преобразования ButtonType, на который нажал пользователь, в значение типа R. Дополнительные сведения см. в документации к классу Dialog.
Параметры:
value - значение для свойства result
См. также:
  • getResult()
  • resultProperty()

resultConverterProperty

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

getResultConverter

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

setResultConverter

public final void setResultConverter(Callback<ButtonType,R> value)
Устанавливает значение свойства resultConverter.
Описание свойства:
API для преобразования ButtonType, на который нажал пользователь, в результат, который может быть возвращен через свойство result. Это необходимо, так как ButtonType представляет собой визуальную кнопку в диалоговом окне и не знает, как сопоставить себя с допустимым результатом - это требование реализации диалогового окна с использованием преобразователя результатов. В некоторых случаях тип результата подкласса Dialog — ButtonType (что означает, что преобразователь результатов может быть null), но в некоторых случаях (где тип результата, R, не ButtonType или Void), этот обратный вызов должен быть указан.
Параметры:
value - значение для свойства resultConverter
См. также:
  • getResultConverter()
  • resultConverterProperty()

showingProperty

public final ReadOnlyBooleanProperty showingProperty()
Представляет, отображается ли диалоговое окно в данный момент.
Возвращает:
свойство, представляющее, отображается ли диалоговое окно в данный момент
См. также:
  • isShowing()

isShowing

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

resizableProperty

public final BooleanProperty resizableProperty()
Представляет, может ли быть изменен размер диалогового окна.
Возвращает:
свойство, представляющее, может ли быть изменен размер диалогового окна
См. также:
  • isResizable()
  • setResizable(boolean)

isResizable

public final boolean isResizable()
Возвращает значение true, если размер диалогового окна можно изменять.
Возвращает:
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()
Возвращает свойство titleProperty диалогового окна.
Возвращает:
свойство 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 по горизонтали.
Возвращает:
значение свойства x
См. также:
  • setX(double)
  • xProperty()

setX

public final void setX(double x)
Устанавливает значение свойства x.
Описание свойства:
Горизонтальное положение этого Dialog. Изменение этого атрибута переместит Dialog по горизонтали.
Параметры:
x - значение для свойства x
См. также:
  • getX()
  • xProperty()

xProperty

public final ReadOnlyDoubleProperty xProperty()
Горизонтальное положение этого Dialog. Изменение этого атрибута переместит Dialog по горизонтали.
Возвращает:
горизонтальное положение этого Dialog
См. также:
  • getX()
  • setX(double)

getY

public final double getY()
Возвращает значение свойства y.
Описание свойства:
Вертикальное положение этого Dialog. Изменение этого атрибута переместит Dialog по вертикали.
Возвращает:
значение свойства y
См. также:
  • setY(double)
  • yProperty()

setY

public final void setY(double y)
Устанавливает значение свойства y.
Описание свойства:
Вертикальное положение этого Dialog. Изменение этого атрибута переместит Dialog по вертикали.
Параметры:
y - значение для свойства y
См. также:
  • getY()
  • yProperty()

yProperty

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

buildEventDispatchChain

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

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

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

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

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

addEventHandler

public final <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)
Описание скопировано из интерфейса: EventTarget
Регистрирует обработчик событий для этой мишени.

Обработчик вызывается, когда мишень получает Event указанного типа во время фазы всплытия доставки события.

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

removeEventHandler

public final <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)
Описание скопировано из интерфейса: EventTarget
Отменяет регистрацию ранее зарегистрированного обработчика событий от этой мишени.

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

Определено в:
removeEventHandler в интерфейсе EventTarget
Параметры типа:
E - класс события для обработчика
Параметры:
eventType - тип события, от которого нужно отменить регистрацию
eventHandler - обработчик событий

addEventFilter

public final <E extends Event> void addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)
Описание скопировано из интерфейса: EventTarget
Регистрирует фильтр событий для этой мишени.

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

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

removeEventFilter

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

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

Определено в:
removeEventFilter в интерфейсе EventTarget
Параметры типа:
E - класс события для фильтра
Параметры:
eventType - тип события, от которого нужно отменить регистрацию
eventFilter - фильтр событий

setOnShowing

public final void setOnShowing(EventHandler<DialogEvent> value)
Устанавливает значение свойства onShowing.
Описание свойства:
Вызывается непосредственно перед отображением диалогового окна.
Параметры:
value - значение для свойства onShowing
См. также:
  • getOnShowing()
  • onShowingProperty()

getOnShowing

public final EventHandler<DialogEvent> getOnShowing()
Возвращает значение свойства onShowing.
Описание свойства:
Вызывается непосредственно перед отображением диалогового окна.
Возвращает:
значение свойства onShowing
См. также:
  • setOnShowing(EventHandler)
  • onShowingProperty()

onShowingProperty

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

setOnShown

public final void setOnShown(EventHandler<DialogEvent> value)
Устанавливает значение свойства onShown.
Описание свойства:
Вызывается сразу после отображения диалогового окна.
Параметры:
value - значение для свойства onShown
См. также:
  • getOnShown()
  • onShownProperty()

getOnShown

public final EventHandler<DialogEvent> getOnShown()
Получает значение свойства onShown.
Описание свойства:
Вызывается сразу после отображения диалогового окна.
Возвращает:
значение свойства onShown
См. также:
  • setOnShown(EventHandler)
  • onShownProperty()

onShownProperty

public final ObjectProperty<EventHandler<DialogEvent>> onShownProperty()
Вызывается сразу после отображения диалогового окна.
Возвращает:
свойство onShown
См. также:
  • getOnShown()
  • setOnShown(EventHandler)

setOnHiding

public final void setOnHiding(EventHandler<DialogEvent> value)
Устанавливает значение свойства onHiding.
Описание свойства:
Вызывается непосредственно перед скрытием диалогового окна.
Параметры:
value - значение для свойства onHiding
См. также:
  • getOnHiding()
  • onHidingProperty()

getOnHiding

public final EventHandler<DialogEvent> getOnHiding()
Получает значение свойства onHiding.
Описание свойства:
Вызывается непосредственно перед скрытием диалогового окна.
Возвращает:
значение свойства onHiding
См. также:
  • setOnHiding(EventHandler)
  • onHidingProperty()

onHidingProperty

public final ObjectProperty<EventHandler<DialogEvent>> onHidingProperty()
Вызывается непосредственно перед скрытием диалогового окна.
Возвращает:
свойство onHiding
См. также:
  • getOnHiding()
  • setOnHiding(EventHandler)

setOnHidden

public final void setOnHidden(EventHandler<DialogEvent> value)
Устанавливает значение свойства onHidden.
Описание свойства:
Вызывается сразу после скрытия диалогового окна. При скрытии диалогового окна этот обработчик событий вызывается, позволяя разработчику очищать ресурсы или выполнять другие задачи при закрытии Alert.
Параметры:
value - значение для свойства onHidden
См. также:
  • getOnHidden()
  • onHiddenProperty()

getOnHidden

public final EventHandler<DialogEvent> getOnHidden()
Получает значение свойства onHidden.
Описание свойства:
Вызывается сразу после скрытия диалогового окна. При скрытии диалогового окна этот обработчик событий вызывается, позволяя разработчику очищать ресурсы или выполнять другие задачи при закрытии Alert.
Возвращает:
значение свойства onHidden
См. также:
  • setOnHidden(EventHandler)
  • onHiddenProperty()

onHiddenProperty

public final ObjectProperty<EventHandler<DialogEvent>> onHiddenProperty()
Вызывается сразу после скрытия диалогового окна. При скрытии диалогового окна этот обработчик событий вызывается, позволяя разработчику очищать ресурсы или выполнять другие задачи при закрытии Alert.
Возвращает:
свойство onHidden
См. также:
  • getOnHidden()
  • setOnHidden(EventHandler)

setOnCloseRequest

public final void setOnCloseRequest(EventHandler<DialogEvent> value)
Устанавливает значение свойства onCloseRequest.
Описание свойства:
Вызывается при внешнем запросе на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалогового окна, обработав полученное событие.
Параметры:
value - значение для свойства onCloseRequest
См. также:
  • getOnCloseRequest()
  • onCloseRequestProperty()

getOnCloseRequest

public final EventHandler<DialogEvent> getOnCloseRequest()
Получает значение свойства onCloseRequest.
Описание свойства:
Вызывается при внешнем запросе на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалогового окна, обработав полученное событие.
Возвращает:
значение свойства onCloseRequest
См. также:
  • setOnCloseRequest(EventHandler)
  • onCloseRequestProperty()

onCloseRequestProperty

public final ObjectProperty<EventHandler<DialogEvent>> onCloseRequestProperty()
Вызывается при внешнем запросе на закрытие этого Dialog. Установленный обработчик событий может предотвратить закрытие диалогового окна, обработав полученное событие.
Возвращает:
свойство onCloseRequest
См. также:
  • 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