- java.lang.Object
-
- javax.swing.PopupFactory
-
public class PopupFactory extends Object
PopupFactory
, as the name implies, is used to obtain instances ofPopup
s.Popup
s are used to display aComponent
above all otherComponent
s in a particular containment hierarchy. The general contract is that once you have obtained aPopup
from aPopupFactory
, you must invokehide
on thePopup
. The typical usage is:PopupFactory factory = PopupFactory.getSharedInstance(); Popup popup = factory.getPopup(owner, contents, x, y); popup.show(); ... popup.hide();
- Since:
- 1.4
- See Also:
Popup
-
-
Constructor Summary
Constructors Constructor and Description PopupFactory()
-
Method Summary
Methods Modifier and Type Method and Description Popup
getPopup(Component owner, Component contents, int x, int y)
Creates aPopup
for the Componentowner
containing the Componentcontents
.static PopupFactory
getSharedInstance()
Returns the sharedPopupFactory
which can be used to obtainPopup
s.static void
setSharedInstance(PopupFactory factory)
Sets thePopupFactory
that will be used to obtainPopup
s.
-
-
-
Method Detail
-
setSharedInstance
public static void setSharedInstance(PopupFactory factory)
Sets thePopupFactory
that will be used to obtainPopup
s. This will throw anIllegalArgumentException
iffactory
is null.- Parameters:
factory
- Shared PopupFactory- Throws:
IllegalArgumentException
- iffactory
is null- See Also:
getPopup(java.awt.Component, java.awt.Component, int, int)
-
getSharedInstance
public static PopupFactory getSharedInstance()
Returns the sharedPopupFactory
which can be used to obtainPopup
s.- Returns:
- Shared PopupFactory
-
getPopup
public Popup getPopup(Component owner, Component contents, int x, int y) throws IllegalArgumentException
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- Returns:
- Popup containing Contents
- Throws:
IllegalArgumentException
- if contents is null
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/popupfactory.html/.html/
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.