java.lang.Object
javax.swing.Popup
public class Popup extends Object
Popups are used to display a
Component
to the user, typically
on top of all the other Component
s in a particular containment
hierarchy. Popup
s have a very small life cycle. Once you
have obtained a Popup
, and hidden it (invoked the
hide
method), you should no longer
invoke any methods on it. This allows the PopupFactory
to cache
Popup
s for later use.
The general contract is that if you need to change the size of the
Component
, or location of the Popup
, you should
obtain a new Popup
.
Popup
does not descend from Component
, rather
implementations of Popup
are responsible for creating
and maintaining their own Component
s to render the
requested Component
to the user.
You typically do not explicitly create an instance of Popup
,
instead obtain one from a PopupFactory
.
- Since:
- 1.4
- See Also:
PopupFactory
-
Constructor Summary
-
Method Summary
-
Constructor Details
-
Popup
Creates aPopup
for the Componentowner
containing the Componentcontents
.owner
is used to determine whichWindow
the newPopup
will parent theComponent
thePopup
creates to. A nullowner
implies there is no valid parent.x
andy
specify the preferred initial location to place thePopup
at. Based on screen size, or other paramaters, thePopup
may not display atx
andy
.- Parameters:
owner
- Component mouse coordinates are relative to, may be nullcontents
- Contents of the Popupx
- Initial x screen coordinatey
- Initial y screen coordinate- Throws:
IllegalArgumentException
- if contents is null
-
Popup
protected Popup()Creates aPopup
. This is provided for subclasses.
-
-
Method Details
-
show
public void show()Makes thePopup
visible. If thePopup
is currently visible, this has no effect. -
hide
public void hide()Hides and disposes of thePopup
. Once aPopup
has been disposed you should no longer invoke methods on it. Adispose
dPopup
may be reclaimed and later used based on thePopupFactory
. As such, if you invoke methods on adisposed
Popup
, indeterminate behavior will result.
-