Class Popup
- java.lang.Object
-
- javax.swing.Popup
-
public class Popup extends Object
Popups are used to display aComponentto the user, typically on top of all the otherComponents in a particular containment hierarchy.Popups have a very small life cycle. Once you have obtained aPopup, and hidden it (invoked thehidemethod), you should no longer invoke any methods on it. This allows thePopupFactoryto cachePopups for later use.The general contract is that if you need to change the size of the
Component, or location of thePopup, you should obtain a newPopup.Popupdoes not descend fromComponent, rather implementations ofPopupare responsible for creating and maintaining their ownComponents to render the requestedComponentto the user.You typically do not explicitly create an instance of
Popup, instead obtain one from aPopupFactory.- Since:
- 1.4
- See Also:
-
PopupFactory
-
-
Constructor Summary
Constructors Modifier Constructor and Description protectedPopup()Creates aPopup.protectedPopup(Component owner, Component contents, int x, int y)Creates aPopupfor the Componentownercontaining the Componentcontents.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description voidhide()Hides and disposes of thePopup.voidshow()Makes thePopupvisible.
-
-
-
Constructor Detail
Popup
protected Popup(Component owner, Component contents, int x, int y)
Creates aPopupfor the Componentownercontaining the Componentcontents.owneris used to determine whichWindowthe newPopupwill parent theComponentthePopupcreates to. A nullownerimplies there is no valid parent.xandyspecify the preferred initial location to place thePopupat. Based on screen size, or other paramaters, thePopupmay not display atxandy.- Parameters:
-
owner- Component mouse coordinates are relative to, may be null -
contents- Contents of the Popup -
x- Initial x screen coordinate -
y- Initial y screen coordinate - Throws:
-
IllegalArgumentException- if contents is null
Popup
protected Popup()
Creates aPopup. This is provided for subclasses.
-
Method Detail
show
public void show()
Makes thePopupvisible. If thePopupis currently visible, this has no effect.
hide
public void hide()
Hides and disposes of thePopup. Once aPopuphas been disposed you should no longer invoke methods on it. AdisposedPopupmay be reclaimed and later used based on thePopupFactory. As such, if you invoke methods on adisposedPopup, indeterminate behavior will result.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
