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 and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	Popup.DefaultFrame Used if no valid Window ancestor of the supplied owner is found.
pack-priv static class	Popup.HeavyWeightWindow Component used to house window.

Field Summary

Modifier and Type	Field and Description
private Component	component The Component representing the Popup.

Constructor Summary

Access	Constructor and Description
protected	Popup(Component Component mouse coordinates are relative to, may be null owner, Component Contents of the Popup contents, int Initial x screen coordinate x, int Initial y screen coordinate y) Creates a `Popup` for the Component `owner` containing the Component `contents`.
protected	Popup() Creates a `Popup`.

Method Summary

Modifier and Type	Method and Description
pack-priv Component	createComponent(Component owner) Creates the Component to use as the parent of the `Popup`.
pack-priv void	dispose() Frees any resources the `Popup` may be holding onto.
pack-priv Component	getComponent() Returns the `Component` returned from `createComponent` that will hold the `Popup`.
private Window	getParentWindow(Component owner) Returns the `Window` to use as the parent of the `Window` created for the `Popup`.
public void	hide() Hides and disposes of the `Popup`.
pack-priv void	pack() Causes the `Popup` to be sized to fit the preferred size of the `Component` it contains.
pack-priv void	reset(Component owner, Component contents, int ownerX, int ownerY) Resets the `Popup` to an initial state.
public void	show() Makes the `Popup` visible.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

component	back to summary
private Component component The Component representing the Popup.

Constructor Detail

Popup back to summary

Popup	back to summary
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 parameters, the `Popup` may not display at `x` and `y`. Parameters owner:Component Component mouse coordinates are relative to, may be null contents:Component Contents of the Popup x:int Initial x screen coordinate y:int Initial y screen coordinate Exceptions IllegalArgumentException: if contents is null

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 parameters, the Popup may not display at x and y.

Parameters

owner:Component: Component mouse coordinates are relative to, may be null
contents:Component: Contents of the Popup
x:int: Initial x screen coordinate
y:int: Initial y screen coordinate

Exceptions

IllegalArgumentException:: if contents is null

Popup	back to summary
protected Popup() Creates a `Popup`. This is provided for subclasses.

Method Detail

createComponent	back to summary
pack-priv Component createComponent(Component owner) Creates the Component to use as the parent of the `Popup`. The default implementation creates a `Window`, subclasses should override.

dispose	back to summary
pack-priv void dispose() Frees any resources the `Popup` may be holding onto.

getComponent	back to summary
pack-priv Component getComponent() Returns the `Component` returned from `createComponent` that will hold the `Popup`.

getParentWindow	back to summary
private Window getParentWindow(Component owner) Returns the `Window` to use as the parent of the `Window` created for the `Popup`. This creates a new `DefaultFrame`, if necessary.

hide back to summary

hide	back to summary
public void hide() Hides and disposes of the `Popup`. Once a `Popup` has been disposed you should no longer invoke methods on it. A `dispose`d `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. Annotations @SuppressWarnings:deprecation

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.

Annotations

@SuppressWarnings:deprecation

pack	back to summary
pack-priv void pack() Causes the `Popup` to be sized to fit the preferred size of the `Component` it contains.

reset	back to summary
pack-priv void reset(Component owner, Component contents, int ownerX, int ownerY) Resets the `Popup` to an initial state.

show back to summary

show	back to summary
public void show() Makes the `Popup` visible. If the `Popup` is currently visible, this has no effect. Annotations @SuppressWarnings:deprecation

public void show()

Makes the Popup visible. If the Popup is currently visible, this has no effect.

Annotations

@SuppressWarnings:deprecation

javax.swing back to summary

pack-priv Class Popup.DefaultFrame

Class Inheritance

extends Frame

Annotations

@SuppressWarnings:serial

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.

Access	Constructor and Description
pack-priv	DefaultFrame()

DefaultFrame	back to summary
pack-priv DefaultFrame()

javax.swing back to summary

pack-priv Class Popup.HeavyWeightWindow

Class Inheritance

extends JWindow
implements ModalExclude

All Implemented Interfaces

sun.awt.ModalExclude

Annotations

@SuppressWarnings:serial

Component used to house window.

Access	Constructor and Description
pack-priv	HeavyWeightWindow(Window parent)

Method Summary

Modifier and Type	Method and Description
public void	show() Overrides java.awt.Window.show. Makes the Window visible.
public void	update(Graphics the `Graphics` context in which to paint g) Overrides javax.swing.JWindow.update. Calls `paint(g)`.

HeavyWeightWindow	back to summary
pack-priv HeavyWeightWindow(Window parent)

Method Detail

show	back to summary
public void show() Overrides java.awt.Window.show. Doc from java.awt.Window.show. Makes the Window visible. If the Window and/or its owner are not yet displayable, both are made displayable. The Window will be validated prior to being made visible. If the Window is already visible, this will bring the Window to the front. Annotations @SuppressWarnings:deprecation

show

back to summary

public void show()

Overrides java.awt.Window.show.

Doc from java.awt.Window.show.

Makes the Window visible. If the Window and/or its owner are not yet displayable, both are made displayable. The Window will be validated prior to being made visible. If the Window is already visible, this will bring the Window to the front.

Annotations

@SuppressWarnings:deprecation

update back to summary

update	back to summary
public void update(Graphics g) Overrides javax.swing.JWindow.update. Doc from javax.swing.JWindow.update. Calls `paint(g)`. This method was overridden to prevent an unnecessary call to clear the background. Parameters g:Graphics the `Graphics` context in which to paint

public void update(Graphics g)

Overrides javax.swing.JWindow.update.

Doc from javax.swing.JWindow.update.

Calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.

Parameters

g:Graphics: the Graphics context in which to paint

public Class Popup

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Popup.DefaultFrame

Field Summary

Constructor Summary

Method Summary

Constructor Detail

pack-priv Class Popup.HeavyWeightWindow

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail