PopupFactory (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class PopupFactory

java.lang.Object
  javax.swing.PopupFactory

Most common way to construct:

PopupFactory factory = PopupFactory.getSharedInstance();

Based on 84 examples

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);
   popup.show();
   ...
   popup.hide();

Constructor Summary
`PopupFactory()`

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 `Popup`s.
`static void`	`setSharedInstance(PopupFactory factory)` Sets the `PopupFactory` that will be used to obtain `Popup`s.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

PopupFactory

public PopupFactory()

Method Detail

getPopup

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.

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

getSharedInstance

public static PopupFactory getSharedInstance()

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

Returns:: Shared PopupFactory

setSharedInstance

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