javax.swing
Class PopupFactory
- java.lang.Object
-
- javax.swing.PopupFactory
-
public class PopupFactory extends Object
PopupFactory, as the name implies, is used to obtain instances ofPopups.Popups are used to display aComponentabove all otherComponents in a particular containment hierarchy. The general contract is that once you have obtained aPopupfrom aPopupFactory, you must invokehideon 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description PopupgetPopup(Component owner, Component contents, int x, int y)Creates aPopupfor the Componentownercontaining the Componentcontents.static PopupFactorygetSharedInstance()Returns the sharedPopupFactorywhich can be used to obtainPopups.static voidsetSharedInstance(PopupFactory factory)Sets thePopupFactorythat will be used to obtainPopups.
-
-
-
Method Detail
setSharedInstance
public static void setSharedInstance(PopupFactory factory)
Sets thePopupFactorythat will be used to obtainPopups. This will throw anIllegalArgumentExceptioniffactoryis null.- Parameters:
-
factory- Shared PopupFactory - Throws:
-
IllegalArgumentException- iffactoryis null - See Also:
-
getPopup(java.awt.Component, java.awt.Component, int, int)
getSharedInstance
public static PopupFactory getSharedInstance()
Returns the sharedPopupFactorywhich can be used to obtainPopups.- Returns:
- Shared PopupFactory
getPopup
public Popup getPopup(Component owner, Component contents, int x, int y) throws IllegalArgumentException
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 - Returns:
- Popup containing Contents
- Throws:
-
IllegalArgumentException- if contents is null
-
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.
