oracle.javatools.ui.popup

Class PopupWindowManager

java.lang.Object

oracle.javatools.ui.popup.PopupWindowManager

public class PopupWindowManager
extends java.lang.Object

The PopupWindowManager helps to manage popup windows for a given component. Specifically, it helps to position popups so that they are completely visible without obscuring other popups if possible.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EAST The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).
static int	NORTH The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).
static int	SOUTH The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).
static int	WEST The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).

Method Summary

Methods

Modifier and Type	Method and Description
static void	dismissPopup(PopupWindow popup) Dismisses the popup window and any associated resources.
static java.util.List<PopupWindow>	getPopupWindows(javax.swing.JComponent parent) Utility routine to fetch the current list of popup windows for a parent.
void	propertyChange(java.beans.PropertyChangeEvent event) This method gets called when a bound property is changed.
static PopupWindow	showPopup(javax.swing.JComponent parentComponent, javax.swing.JComponent content, boolean focusable, java.awt.Rectangle relativeToLocation, int[] preferredLocations, boolean center) Create and show a new PopupWindow with the given content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEST

public static final int WEST

The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).

See Also:

Constant Field Values

EAST

public static final int EAST

The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).

See Also:

Constant Field Values

NORTH

public static final int NORTH

The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

The constant indicating the west of a given rectangle location (when positining relative to location) or popup window (when positioning relative to popup).

See Also:

Constant Field Values

Method Detail

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

This method gets called when a bound property is changed.

Parameters:

event - the property change event

showPopup

public static PopupWindow showPopup(javax.swing.JComponent parentComponent,
                    javax.swing.JComponent content,
                    boolean focusable,
                    java.awt.Rectangle relativeToLocation,
                    int[] preferredLocations,
                    boolean center)

Create and show a new PopupWindow with the given content. The focusable parameter indicates whether the popup should be allowed to have focus at any time. If not, then if the popup window is brought to the front (i.e., user clicked on it), focus will be automatically moved back to the associated parent component. The size of the popup window is automatically based on the size of the content provided.

Parameters:

parentComponent - the parent component that the popup floats in front of.

content - the content to display in the popup

focusable - whether the content is allowed to have focus or not

Returns:

the newly created, visible, popup window Show the PopupWindow. The listener provided will be notified if the popup is closed, or if focus was lost.

dismissPopup

public static void dismissPopup(PopupWindow popup)

Dismisses the popup window and any associated resources.

Parameters:

popup - the popup window

getPopupWindows

public static java.util.List<PopupWindow> getPopupWindows(javax.swing.JComponent parent)

Utility routine to fetch the current list of popup windows for a parent.

Returns:

the visible popup windows