Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
public class: Popup [javadoc | source]
java.lang.Object
   javax.swing.Popup

Direct Known Subclasses:
    HeadlessPopup, MediumWeightPopup, HeavyWeightPopup, ContainerPopup, LightWeightPopup

Popups are used to display a Component to the user, typically on top of all the other Components in a particular containment hierarchy. Popups have a very small life cycle. Once you have obtained a Popup, and hidden it (invoked the hide method), you should no longer invoke any methods on it. This allows the PopupFactory to cache Popups for later use.

The general contract is that if you need to change the size of the Component, or location of the Popup, you should obtain a new Popup.

Popup does not descend from Component, rather implementations of Popup are responsible for creating and maintaining their own Components to render the requested Component to the user.

You typically do not explicitly create an instance of Popup, instead obtain one from a PopupFactory.

Nested Class Summary:
static class  Popup.HeavyWeightWindow  Component used to house window. 
static class  Popup.DefaultFrame  Used if no valid Window ancestor of the supplied owner is found.

PopupFactory uses this as a way to know when the Popup shouldn't be cached based on the Window. 

Constructor:
 protected Popup() 
 protected Popup(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
    Throws:
    IllegalArgumentException - if contents is null
    exception: IllegalArgumentException - if contents is null
Method from javax.swing.Popup Summary:
createComponent,   dispose,   getComponent,   hide,   pack,   reset,   show
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.Popup Detail:
 Component createComponent(Component owner) 
    Creates the Component to use as the parent of the Popup. The default implementation creates a Window, subclasses should override.
  void dispose() 
    Frees any resources the Popup may be holding onto.
 Component getComponent() 
    Returns the Component returned from createComponent that will hold the Popup.
 public  void hide() 
    Hides and disposes of the Popup. Once a Popup has been disposed you should no longer invoke methods on it. A disposed Popup may be reclaimed and later used based on the PopupFactory. As such, if you invoke methods on a disposed Popup, indeterminate behavior will result.
  void pack() 
    Causes the Popup to be sized to fit the preferred size of the Component it contains.
  void reset(Component owner,
    Component contents,
    int ownerX,
    int ownerY) 
    Resets the Popup to an initial state.
 public  void show() 
    Makes the Popup visible. If the Popup is currently visible, this has no effect.