javax.swing
Class PopupFactory

java.lang.Object
  extended by javax.swing.PopupFactory

public class PopupFactory
extends Object

A factory for Popup objects. These are used to managed little windows that float over everything else, typically containing a popup menu.

Since:
1.4

Constructor Summary
PopupFactory()
          Constructs a new PopupFactory.
 
Method Summary
 Popup getPopup(Component owner, Component contents, int x, int y)
          Creates a new Popup given its owner, contents and the screen position where the popup will appear.
static PopupFactory getSharedInstance()
          Retrieves the shared factory, creating a new factory if necessary.
static void setSharedInstance(PopupFactory factory)
          Sets the shared factory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PopupFactory

public PopupFactory()
Constructs a new PopupFactory. Usually, a single PopupFactory is shared among multiple consumers of Popup. Use getSharedInstance() to retrieve the current factory.

Method Detail

setSharedInstance

public static void setSharedInstance(PopupFactory factory)
Sets the shared factory.

Parameters:
factory - the PopupFactory that future invocations of getSharedInstance() will return.
Throws:
IllegalArgumentException - if factory is null.

getSharedInstance

public static PopupFactory getSharedInstance()
Retrieves the shared factory, creating a new factory if necessary.

Returns:
a PopupFactory that can be used to create Popup objects.

getPopup

public Popup getPopup(Component owner,
                      Component contents,
                      int x,
                      int y)
Creates a new Popup given its owner, contents and the screen position where the popup will appear.

Parameters:
owner - the Component to which x and y are relative, or null for placing the popup relative to the origin of the screen.
contents - the contents that will be displayed inside the Popup.
x - the horizontal position where the Popup will appear.
y - the vertical position where the Popup will appear.
Throws:
IllegalArgumentException - if contents is null.