public class

PopupFactory

extends Object
java.lang.Object
   ↳ javax.swing.PopupFactory

Class Overview

PopupFactory, as the name implies, is used to obtain instances of Popups. Popups are used to display a Component above all other Components in a particular containment hierarchy. The general contract is that once you have obtained a Popup from a PopupFactory, you must invoke hide on the Popup. The typical usage is: 

   PopupFactory factory = PopupFactory.getSharedInstance();
   Popup popup = factory.getPopup(owner, contents, x, y);
   popup.show();
   ...
   popup.hide();

See Also

Summary

Public Constructors
PopupFactory()
Public Methods
Popup getPopup(Component owner, Component contents, int x, int y)
Creates a Popup for the Component owner containing the Component contents.
static PopupFactory getSharedInstance()
Returns the shared PopupFactory which can be used to obtain Popups.
static void setSharedInstance(PopupFactory factory)
Sets the PopupFactory that will be used to obtain Popups.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PopupFactory ()

Public Methods

public Popup getPopup (Component owner, Component contents, int x, int y)

Creates a Popup for the Component owner containing the Component contents. owner is used to determine which Window the new Popup will parent the Component the Popup creates to. A null owner implies there is no valid parent. x and y specify the preferred initial location to place the Popup at. Based on screen size, or other paramaters, the Popup may not display at x and y.

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

public static PopupFactory getSharedInstance ()

Returns the shared PopupFactory which can be used to obtain Popups.

Returns
  • Shared PopupFactory

public static void setSharedInstance (PopupFactory factory)

Sets the PopupFactory that will be used to obtain Popups. This will throw an IllegalArgumentException if factory is null.

Parameters
factory Shared PopupFactory
Throws
IllegalArgumentException if factory is null
See Also