JavaTM 2 Platform
Std. Ed. v1.4.2

Class PopupFactory

  extended byjavax.swing.PopupFactory

public class PopupFactory
extends Object

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);;

See Also:

Constructor Summary
Method Summary
 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 AppContext specific PopupFactory.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public PopupFactory()
Method Detail


public static void setSharedInstance(PopupFactory factory)
Sets the AppContext specific PopupFactory. This will throw an IllegalArgumentException if factory is null.

factory - Shared PopupFactory
IllegalArgumentException - if factory is null


public static PopupFactory getSharedInstance()
Returns the shared PopupFactory which can be used to obtain Popups.

Shared PopupFactory


public Popup getPopup(Component owner,
                      Component contents,
                      int x,
                      int y)
               throws IllegalArgumentException
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.

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
Popup containing Contents
IllegalArgumentException - if contents is null

JavaTM 2 Platform
Std. Ed. v1.4.2

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2003, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.