com.alee.managers.popup

Class PopupManager

java.lang.Object

com.alee.managers.popup.PopupManager

public class PopupManager
extends java.lang.Object

This manager allows you to add your own popups within the window/applet root pane bounds.

See Also:

PopupLayer, WebInnerPopup, WebButtonPopup, WebInnerNotification

Field Summary

Fields

Modifier and Type	Field and Description
protected static StyleId	defaultPopupStyleId Default style used for popups.
protected static java.util.Map<javax.swing.JRootPane,PopupLayer>	popupLayers Popup layers cache.
protected static java.util.Map<javax.swing.JRootPane,ShadeLayer>	shadeLayers Shade layers cache.

Constructor Summary

Constructors

Constructor and Description
PopupManager()

Method Summary

Modifier and Type	Method and Description
static StyleId	getDefaultPopupStyleId() Returns default popup style.
static PopupLayer	getPopupLayer(java.awt.Component component) Returns cached popup layer for root pane containing specified component.
static PopupLayer	getPopupLayer(javax.swing.JRootPane rootPane) Returns cached popup layer for the specified root pane.
static ShadeLayer	getShadeLayer(javax.swing.JRootPane rootPane) Returns cached shade layer for the specified root pane.
static void	hideAllPopups() Hides all visible popups on all cached popup layers.
static void	hideAllPopups(javax.swing.JComponent component) Hides all visible popups for the root pane under the specified component.
static void	hideAllPopups(javax.swing.JRootPane rootPane) Hides all visible popups for the specified root pane.
protected static void	installPopupLayer(PopupLayer popupLayer, javax.swing.JRootPane rootPane, javax.swing.JLayeredPane layeredPane) Installs popup layer for the specified root pane.
static void	setDefaultPopupStyleId(StyleId id) Sets default popup style.
static void	showModalPopup(java.awt.Component component, WebInnerPopup popup, boolean hfill, boolean vfill) Displays popup as modal for the root pane containing specified component.
static void	showModalPopup(java.awt.Component component, WebInnerPopup popup, boolean hfill, boolean vfill, boolean blockClose) Displays popup as modal for the root pane containing specified component.
static void	showModalPopup(javax.swing.JRootPane rootPane, WebInnerPopup popup, boolean hfill, boolean vfill) Displays popup as modal for the specified root pane.
static void	showModalPopup(javax.swing.JRootPane rootPane, WebInnerPopup popup, boolean hfill, boolean vfill, boolean blockClose) Displays popup as modal for the specified root pane.
static void	showPopup(java.awt.Component component, WebInnerPopup popup) Displays popup for the root pane containing specified component.
static void	showPopup(java.awt.Component component, WebInnerPopup popup, boolean transferFocus) Displays popup for the root pane containing specified component.
static void	showPopup(javax.swing.JRootPane rootPane, WebInnerPopup popup, boolean transferFocus) Displays popup for the specified root pane.

Methods inherited from class java.lang.Object

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

Field Detail

shadeLayers

protected static final java.util.Map<javax.swing.JRootPane,ShadeLayer> shadeLayers

Shade layers cache.

popupLayers

protected static final java.util.Map<javax.swing.JRootPane,PopupLayer> popupLayers

Popup layers cache.

defaultPopupStyleId

protected static StyleId defaultPopupStyleId

Default style used for popups.

Constructor Detail

PopupManager

public PopupManager()

Method Detail

hideAllPopups

public static void hideAllPopups()

Hides all visible popups on all cached popup layers.

hideAllPopups

public static void hideAllPopups(javax.swing.JComponent component)

Hides all visible popups for the root pane under the specified component.

Parameters:

component - component to process

hideAllPopups

public static void hideAllPopups(javax.swing.JRootPane rootPane)

Hides all visible popups for the specified root pane.

Parameters:

rootPane - root pane to process

getDefaultPopupStyleId

public static StyleId getDefaultPopupStyleId()

Returns default popup style.

Returns:

default popup style

setDefaultPopupStyleId

public static void setDefaultPopupStyleId(StyleId id)

Sets default popup style.

Parameters:

id - default popup style

showPopup

public static void showPopup(java.awt.Component component,
                             WebInnerPopup popup)

Displays popup for the root pane containing specified component.

Parameters:

component - component used to determine root pane for which modal popup will be displayed

popup - popup to display

showPopup

public static void showPopup(java.awt.Component component,
                             WebInnerPopup popup,
                             boolean transferFocus)

Displays popup for the root pane containing specified component.

Parameters:

component - component used to determine root pane for which modal popup will be displayed

popup - popup to display

transferFocus - whether to transfer focus to content of the displayed popup or not

showPopup

public static void showPopup(javax.swing.JRootPane rootPane,
                             WebInnerPopup popup,
                             boolean transferFocus)

Displays popup for the specified root pane.

Parameters:

rootPane - root pane used to display popup

popup - popup to display

transferFocus - whether to transfer focus to content of the displayed popup or not

showModalPopup

public static void showModalPopup(java.awt.Component component,
                                  WebInnerPopup popup,
                                  boolean hfill,
                                  boolean vfill)

Displays popup as modal for the root pane containing specified component.

Parameters:

component - component used to determine root pane for which modal popup will be displayed

popup - popup to display

hfill - whether popup should fill the whole available width or not

vfill - whether popup should fill the whole available height or not

showModalPopup

public static void showModalPopup(java.awt.Component component,
                                  WebInnerPopup popup,
                                  boolean hfill,
                                  boolean vfill,
                                  boolean blockClose)

Displays popup as modal for the root pane containing specified component.

Parameters:

component - component used to determine root pane for which modal popup will be displayed

popup - popup to display

hfill - whether popup should fill the whole available width or not

vfill - whether popup should fill the whole available height or not

blockClose - whether or not popup close attemps should be blocked or not

showModalPopup

public static void showModalPopup(javax.swing.JRootPane rootPane,
                                  WebInnerPopup popup,
                                  boolean hfill,
                                  boolean vfill)

Displays popup as modal for the specified root pane.

Parameters:

rootPane - root pane used to display modal popup

popup - popup to display

hfill - whether popup should fill the whole available width or not

vfill - whether popup should fill the whole available height or not

showModalPopup

public static void showModalPopup(javax.swing.JRootPane rootPane,
                                  WebInnerPopup popup,
                                  boolean hfill,
                                  boolean vfill,
                                  boolean blockClose)

Displays popup as modal for the specified root pane.

Parameters:

rootPane - root pane used to display modal popup

popup - popup to display

hfill - whether popup should fill the whole available width or not

vfill - whether popup should fill the whole available height or not

blockClose - whether or not popup close attemps should be blocked or not

getPopupLayer

public static PopupLayer getPopupLayer(java.awt.Component component)

Returns cached popup layer for root pane containing specified component.

Parameters:

component - component used to determine root pane for popup layer

Returns:

cached popup layer for root pane containing specified component

getPopupLayer

public static PopupLayer getPopupLayer(javax.swing.JRootPane rootPane)

Returns cached popup layer for the specified root pane.

Parameters:

rootPane - root pane for popup layer

Returns:

cached popup layer for the specified root pane

getShadeLayer

public static ShadeLayer getShadeLayer(javax.swing.JRootPane rootPane)

Returns cached shade layer for the specified root pane.

Parameters:

rootPane - root pane for the shade layer

Returns:

cached shade layer for the specified root pane

installPopupLayer

protected static void installPopupLayer(PopupLayer popupLayer,
                                        javax.swing.JRootPane rootPane,
                                        javax.swing.JLayeredPane layeredPane)

Installs popup layer for the specified root pane.

Parameters:

popupLayer - popup layer to install

rootPane - root pane for which popup layer should be installed

layeredPane - window's layered pane