Класс PopupWindow

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

Все реализованные интерфейсы:: EventTarget

Непосредственные подклассы:: Popup, PopupControl

public abstract class PopupWindow
extends Window

PopupWindow — родительский класс для различных типов всплывающих окон, включая Popup и Tooltip и ContextMenu.

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

PopupWindow не может быть показан без владельца. Для отображения PopupWindows необходимо, чтобы существовало окно-владелец. Однако можно создать PopupWindow заранее и просто установить владельца (или изменить владельца) перед первым отображением. Попытка изменить владельца, пока PopupWindow отображается, приведет к исключению IllegalStateException.

PopupWindow encapsulates much of the behavior and functionality common to popups, such as the ability to close when the "esc" key is pressed, or the ability to hide all child popup windows whenever this window is hidden. These abilities can be enabled or disabled via properties.

Since:: JavaFX 2.0

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

Свойства
Тип	Свойство	Описание
`ObjectProperty<PopupWindow.AnchorLocation>`	`anchorLocation`	Определяет точку привязки всплывающего окна, используемую при позиционировании.
`ReadOnlyDoubleProperty`	`anchorX`	Определяет координату x точки привязки всплывающего окна на экране.
`ReadOnlyDoubleProperty`	`anchorY`	Определяет координату y точки привязки всплывающего окна на экране.
`BooleanProperty`	`autoFix`	Это переменная-удобство, указывающая, следует ли автоматически корректировать позицию всплывающего окна при отображении, чтобы оно не выходило за пределы экрана.
`BooleanProperty`	`autoHide`	Определяет, следует ли автоматически скрывать всплывающие окна.
`BooleanProperty`	`consumeAutoHidingEvents`	Указывает, следует ли потреблять событие, вызвавшее скрытие Popup.
`BooleanProperty`	`hideOnEscape`	Указывает, должно ли окно PopupWindow скрываться, если нажата необработанная клавиша Escape, пока всплывающее окно имеет фокус.
`ObjectProperty<EventHandler<Event>>`	`onAutoHide`	Вызывается после выполнения autoHide.
`ReadOnlyObjectProperty<Node>`	`ownerNode`	Узел, являющийся владельцем этого всплывающего окна.
`ReadOnlyObjectProperty<Window>`	`ownerWindow`	Окно, являющееся родителем этого всплывающего окна.

Свойства, объявленные в классе javafx.stage.Window

eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y

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

Вложенные классы
Модификатор и тип	Класс	Описание
`static class`	`PopupWindow.AnchorLocation`	Константы расположения точки привязки для выбора точки привязки всплывающего окна.

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

Конструкторы
Конструктор	Описание
`PopupWindow()`

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

Модификатор и тип	Метод	Описание
`ObjectProperty<PopupWindow.AnchorLocation>`	`anchorLocationProperty()`	Указывает точку привязки всплывающего окна, которая используется для позиционирования всплывающего окна.
`ReadOnlyDoubleProperty`	`anchorXProperty()`	Указывает координату x точки привязки всплывающего окна на экране.
`ReadOnlyDoubleProperty`	`anchorYProperty()`	Указывает координату y точки привязки всплывающего окна на экране.
`BooleanProperty`	`autoFixProperty()`	Эта удобная переменная указывает, следует ли автоматически корректировать положение всплывающего окна при его отображении, чтобы оно не выходило за пределы экрана.
`BooleanProperty`	`autoHideProperty()`	Указывает, должны ли всплывающие окна автоматически скрываться.
`BooleanProperty`	`consumeAutoHidingEventsProperty()`	Указывает, следует ли обрабатывать событие, которое привело к скрытию всплывающего окна.
`PopupWindow.AnchorLocation`	`getAnchorLocation()`	Получает значение свойства anchorLocation.
`double`	`getAnchorX()`	Получает значение свойства anchorX.
`double`	`getAnchorY()`	Получает значение свойства anchorY.
`boolean`	`getConsumeAutoHidingEvents()`	Получает значение свойства consumeAutoHidingEvents.
`EventHandler<Event>`	`getOnAutoHide()`	Получает значение свойства onAutoHide.
`Node`	`getOwnerNode()`	Получает значение свойства ownerNode.
`Window`	`getOwnerWindow()`	Получает значение свойства ownerWindow.
`void`	`hide()`	Скрывает это всплывающее окно и все его дочерние элементы
`BooleanProperty`	`hideOnEscapeProperty()`	Указывает, должно ли всплывающее окно скрываться при нажатии необработанной клавиши Escape, когда у всплывающего окна есть фокус.
`boolean`	`isAutoFix()`	Получает значение свойства autoFix.
`boolean`	`isAutoHide()`	Получает значение свойства autoHide.
`boolean`	`isHideOnEscape()`	Получает значение свойства hideOnEscape.
`ObjectProperty<EventHandler<Event>>`	`onAutoHideProperty()`	Вызывается после выполнения autoHide.
`ReadOnlyObjectProperty<Node>`	`ownerNodeProperty()`	Узел, являющийся владельцем этого всплывающего окна.
`ReadOnlyObjectProperty<Window>`	`ownerWindowProperty()`	Окно, являющееся родительским для этого всплывающего окна.
`void`	`setAnchorLocation(PopupWindow.AnchorLocation value)`	Устанавливает значение свойства anchorLocation.
`void`	`setAnchorX(double value)`	Устанавливает значение свойства anchorX.
`void`	`setAnchorY(double value)`	Устанавливает значение свойства anchorY.
`void`	`setAutoFix(boolean value)`	Устанавливает значение свойства autoFix.
`void`	`setAutoHide(boolean value)`	Устанавливает значение свойства autoHide.
`void`	`setConsumeAutoHidingEvents(boolean value)`	Устанавливает значение свойства consumeAutoHidingEvents.
`void`	`setHideOnEscape(boolean value)`	Устанавливает значение свойства hideOnEscape.
`void`	`setOnAutoHide(EventHandler<Event> value)`	Устанавливает значение свойства onAutoHide.
`protected void`	`setScene(Scene scene)`	Примечание для подклассов: сцена, используемая PopupWindow, очень специфически управляется PopupWindow.
`void`	`show(Node ownerNode, double anchorX, double anchorY)`	Отображает всплывающее окно в указанном месте на экране.
`void`	`show(Window owner)`	Отображает всплывающее окно.
`void`	`show(Window ownerWindow, double anchorX, double anchorY)`	Отображает всплывающее окно в указанном месте на экране.

Методы, объявленные в классе javafx.stage.Window

addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, forceIntegerRenderScaleProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getOutputScaleX, getOutputScaleY, getProperties, getRenderScaleX, getRenderScaleY, getScene, getUserData, getWidth, getWindows, getX, getY, hasProperties, heightProperty, isFocused, isForceIntegerRenderScale, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, outputScaleXProperty, outputScaleYProperty, removeEventFilter, removeEventHandler, renderScaleXProperty, renderScaleYProperty, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setForceIntegerRenderScale, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setRenderScaleX, setRenderScaleY, setUserData, setWidth, setX, setY, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

ownerWindow

public final ReadOnlyObjectProperty<Window> ownerWindowProperty

Окно, являющееся родителем этого всплывающего окна. Все всплывающие окна должны иметь окно-владелец.

См. также:: getOwnerWindow()

ownerNode

public final ReadOnlyObjectProperty<Node> ownerNodeProperty

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

См. также:: getOwnerNode()

autoFix

public final BooleanProperty autoFixProperty

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

Значение по умолчанию:: true
См. также:: isAutoFix(), setAutoFix(boolean)

autoHide

public final BooleanProperty autoHideProperty

Указывает, должны ли всплывающие окна автоматически скрываться. Если всплывающее окно теряет фокус, а autoHide — true, то всплывающее окно будет автоматически скрыто.

Исключением является случай, когда узел-владелец указан с помощью show(javafx.scene.Node, double, double). При получении фокуса узлом-владельцем PopupWindow не будет скрыт.

Значение по умолчанию:: false
См. также:: isAutoHide(), setAutoHide(boolean)

onAutoHide

public final ObjectProperty<EventHandler<Event>> onAutoHideProperty

Вызывается после выполнения autoHide.

См. также:: getOnAutoHide(), setOnAutoHide(EventHandler)

hideOnEscape

public final BooleanProperty hideOnEscapeProperty

Указывает, должно ли всплывающее окно скрываться при нажатии необработанной клавиши Escape, когда у всплывающего окна фокус.

Значение по умолчанию:: true
См. также:: isHideOnEscape(), setHideOnEscape(boolean)

consumeAutoHidingEvents

public final BooleanProperty consumeAutoHidingEventsProperty

Указывает, должна ли быть обработана событие, вызвавшее скрытие всплывающего окна. Обработка события предотвращает его срабатывание для дополнительных UI-реакций в окне-владельце всплывающего окна.

Значение по умолчанию:: true
С:: JavaFX 2.2
См. также:: getConsumeAutoHidingEvents(), setConsumeAutoHidingEvents(boolean)

anchorX

public final ReadOnlyDoubleProperty anchorXProperty

Указывает координату x точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_BOTTOM_LEFT, значения x и anchorX будут идентичны.

С:: JavaFX 8.0
См. также:: getAnchorX(), setAnchorX(double)

anchorY

public final ReadOnlyDoubleProperty anchorYProperty

Указывает координату y точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_TOP_RIGHT, значения y и anchorY будут идентичны.

С:: JavaFX 8.0
См. также:: getAnchorY(), setAnchorY(double)

anchorLocation

public final ObjectProperty<PopupWindow.AnchorLocation> anchorLocationProperty

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

В общем случае изменение точки привязки не изменит текущую позицию окна. Вместо этого значения anchorX и anchorY пересчитываются для соответствия новой точке привязки.

С:: JavaFX 8.0
См. также:: getAnchorLocation(), setAnchorLocation(PopupWindow.AnchorLocation)

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

PopupWindow

public PopupWindow()

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

getOwnerWindow

public final Window getOwnerWindow()

Возвращает значение свойства ownerWindow.

Описание свойства:: Окно, являющееся родителем этого всплывающего окна. Все всплывающие окна должны иметь окно-владелец.

ownerWindowProperty

public final ReadOnlyObjectProperty<Window> ownerWindowProperty()

Окно, являющееся родителем этого всплывающего окна. Все всплывающие окна должны иметь окно-владелец.

См. также:: getOwnerWindow()

getOwnerNode

public final Node getOwnerNode()

Возвращает значение свойства ownerNode.

Описание свойства:: Узел, являющийся владельцем этого всплывающего окна. Все всплывающие окна должны иметь окно-владелец, но не обязаны быть связаны с узлом-владельцем. Если у автоскрывающегося всплывающего окна есть узел-владелец, нажатие мыши внутри узла-владельца не приводит к скрытию всплывающего окна.

ownerNodeProperty

public final ReadOnlyObjectProperty<Node> ownerNodeProperty()

См. также:: getOwnerNode()

setScene

protected final void setScene(Scene scene)

Примечание для подклассов: сцена, используемая PopupWindow, очень специфически управляется PopupWindow. Этот метод переопределяется, чтобы выбросить UnsupportedOperationException. Вы не можете указать собственную сцену.

Переопределяет:: setScene в классе Window
Параметры:: scene - сцена, которая должна быть отображена в этом окне

setAutoFix

public final void setAutoFix(boolean value)

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

Описание свойства:: Эта переменная-удобство указывает, должно ли всплывающее окно автоматически корректировать свою позицию при отображении, чтобы оно не оказалось за пределами экрана.
Значение по умолчанию:: true

isAutoFix

public final boolean isAutoFix()

Возвращает значение свойства autoFix.

Описание свойства:: Эта переменная-удобство указывает, должно ли всплывающее окно автоматически корректировать свою позицию при отображении, чтобы оно не оказалось за пределами экрана.
Значение по умолчанию:: true

autoFixProperty

public final BooleanProperty autoFixProperty()

Значение по умолчанию:: true
См. также:: isAutoFix(), setAutoFix(boolean)

setAutoHide

public final void setAutoHide(boolean value)

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

Описание свойства:: Указывает, должны ли всплывающие окна автоматически скрываться. Если всплывающее окно теряет фокус, а autoHide — true, то всплывающее окно будет автоматически скрыто.
Исключением является случай, когда узел-владелец указан с помощью show(javafx.scene.Node, double, double). При получении фокуса узлом-владельцем PopupWindow не будет скрыт.
Значение по умолчанию:: false

isAutoHide

public final boolean isAutoHide()

Возвращает значение свойства autoHide.

Описание свойства:: Указывает, должны ли всплывающие окна автоматически скрываться. Если всплывающее окно теряет фокус, а autoHide — true, то всплывающее окно будет автоматически скрыто.
Исключением является случай, когда узел-владелец указан с помощью show(javafx.scene.Node, double, double). При получении фокуса узлом-владельцем PopupWindow не будет скрыт.
Значение по умолчанию:: false

autoHideProperty

public final BooleanProperty autoHideProperty()

Значение по умолчанию:: false
См. также:: isAutoHide(), setAutoHide(boolean)

setOnAutoHide

public final void setOnAutoHide(EventHandler<Event> value)

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

Описание свойства:: Вызывается после выполнения autoHide.

getOnAutoHide

public final EventHandler<Event> getOnAutoHide()

Возвращает значение свойства onAutoHide.

Описание свойства:: Вызывается после выполнения autoHide.

onAutoHideProperty

public final ObjectProperty<EventHandler<Event>> onAutoHideProperty()

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

См. также:: getOnAutoHide(), setOnAutoHide(EventHandler)

setHideOnEscape

public final void setHideOnEscape(boolean value)

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

Описание свойства:: Указывает, должен ли PopupWindow скрываться при нажатии клавиши Escape, если на ней нет обработчика.
Значение по умолчанию:: true

isHideOnEscape

public final boolean isHideOnEscape()

Возвращает значение свойства hideOnEscape.

Описание свойства:: Указывает, должен ли PopupWindow скрываться при нажатии клавиши Escape, если на ней нет обработчика.
Значение по умолчанию:: true

hideOnEscapeProperty

public final BooleanProperty hideOnEscapeProperty()

Указывает, должен ли PopupWindow скрываться при нажатии клавиши Escape, если на ней нет обработчика.

Значение по умолчанию:: true
См. также:: isHideOnEscape(), setHideOnEscape(boolean)

setConsumeAutoHidingEvents

public final void setConsumeAutoHidingEvents(boolean value)

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

Описание свойства:: Указывает, нужно ли потреблять событие, которое привело к скрытию всплывающего окна. Если событие потребляется, это предотвращает срабатывание дополнительных ответов пользовательского интерфейса в окне-владельце всплывающего окна.
Значение по умолчанию:: true
С:: JavaFX 2.2

getConsumeAutoHidingEvents

public final boolean getConsumeAutoHidingEvents()

Возвращает значение свойства consumeAutoHidingEvents.

Описание свойства:: Указывает, нужно ли потреблять событие, которое привело к скрытию всплывающего окна. Если событие потребляется, это предотвращает срабатывание дополнительных ответов пользовательского интерфейса в окне-владельце всплывающего окна.
Значение по умолчанию:: true
С:: JavaFX 2.2

consumeAutoHidingEventsProperty

public final BooleanProperty consumeAutoHidingEventsProperty()

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

Значение по умолчанию:: true
С:: JavaFX 2.2
См. также:: getConsumeAutoHidingEvents(), setConsumeAutoHidingEvents(boolean)

show

public void show(Window owner)

Отображает всплывающее окно.

Параметры:: owner - Владелец всплывающего окна. Не должно быть null.
Исключения:: NullPointerException - если owner равен null; IllegalArgumentException - если указанное окно-владелец создаст цикл в иерархии окон

show

public void show(Node ownerNode, double anchorX, double anchorY)

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

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

Обратите внимание, что когда autoHide установлено в true, щелчок мыши по узлу-владельцу не будет скрывать PopupWindow.

Параметры:: ownerNode - Узел-владелец всплывающего окна. Не должен быть null и должен быть связан с окном.; anchorX - Позиция x точки привязки всплывающего окна в координатах экрана; anchorY - Позиция y точки привязки всплывающего окна в координатах экрана
Исключения:: NullPointerException - если ownerNode равен null; IllegalArgumentException - если указанный узел-владелец не связан с окном или когда окно создаст цикл в иерархии окон

show

public void show(Window ownerWindow, double anchorX, double anchorY)

Параметры:: ownerWindow - Владелец всплывающего окна. Не должен быть null.; anchorX - Позиция x точки привязки всплывающего окна в координатах экрана; anchorY - Позиция y точки привязки всплывающего окна в координатах экрана
Исключения:: NullPointerException - если ownerWindow равен null; IllegalArgumentException - если указанное окно-владелец создаст цикл в иерархии окон

hide

public void hide()

Скрыть это всплывающее окно и все его дочерние элементы

Переопределяет:: hide в классе Window

setAnchorX

public final void setAnchorX(double value)

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

Описание свойства:: Указывает координату x точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_BOTTOM_LEFT значения x и anchorX будут идентичны.
С:: JavaFX 8.0

getAnchorX

public final double getAnchorX()

Возвращает значение свойства anchorX.

Описание свойства:: Указывает координату x точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_BOTTOM_LEFT значения x и anchorX будут идентичны.
С:: JavaFX 8.0

anchorXProperty

public final ReadOnlyDoubleProperty anchorXProperty()

Указывает координату x точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_BOTTOM_LEFT значения x и anchorX будут идентичны.

С:: JavaFX 8.0
См. также:: getAnchorX(), setAnchorX(double)

setAnchorY

public final void setAnchorY(double value)

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

Описание свойства:: Указывает координату y точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_TOP_RIGHT значения y и anchorY будут идентичны.
С:: JavaFX 8.0

getAnchorY

public final double getAnchorY()

Возвращает значение свойства anchorY.

Описание свойства:: Указывает координату y точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_TOP_RIGHT значения y и anchorY будут идентичны.
С:: JavaFX 8.0

anchorYProperty

public final ReadOnlyDoubleProperty anchorYProperty()

Указывает координату y точки привязки всплывающего окна на экране. Если anchorLocation установлено в WINDOW_TOP_LEFT или WINDOW_TOP_RIGHT значения y и anchorY будут идентичны.

С:: JavaFX 8.0
См. также:: getAnchorY(), setAnchorY(double)

setAnchorLocation

public final void setAnchorLocation(PopupWindow.AnchorLocation value)

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

Описание свойства:: Указывает точку привязки всплывающего окна, используемую при позиционировании всплывающего окна. Точка может быть установлена в угол окна всплывающего окна или в угол его содержимого. В данном контексте углы содержимого выводятся из границ макета узла-корня всплывающего окна.
В общем случае изменение точки привязки не изменит текущую позицию окна. Вместо этого значения anchorX и anchorY пересчитываются, чтобы соответствовать новой точке привязки.
С:: JavaFX 8.0

getAnchorLocation

public final PopupWindow.AnchorLocation getAnchorLocation()

Возвращает значение свойства anchorLocation.

Описание свойства:: Указывает точку привязки всплывающего окна, используемую при позиционировании всплывающего окна. Точка может быть установлена в угол окна всплывающего окна или в угол его содержимого. В данном контексте углы содержимого выводятся из границ макета узла-корня всплывающего окна.
В общем случае изменение точки привязки не изменит текущую позицию окна. Вместо этого значения anchorX и anchorY пересчитываются, чтобы соответствовать новой точке привязки.
С:: JavaFX 8.0

anchorLocationProperty

public final ObjectProperty<PopupWindow.AnchorLocation> anchorLocationProperty()

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

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

Since:: JavaFX 8.0
См. также:: getAnchorLocation(), setAnchorLocation(PopupWindow.AnchorLocation)

© 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.