/*
* This file is part of WebLookAndFeel library.
*
* WebLookAndFeel library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WebLookAndFeel library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebLookAndFeel library. If not, see <http://www.gnu.org/licenses/>.
*/
package com.alee.managers.popup;
import com.alee.extended.painter.Painter;
import com.alee.utils.SwingUtils;
import javax.swing.*;
import java.awt.*;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.awt.event.WindowEvent;
import java.awt.event.WindowStateListener;
import java.util.HashMap;
import java.util.Map;
/**
* This manager allows you to add your own popups within the window/applet root pane bounds.
*
* @author Mikle Garin
* @see PopupLayer
* @see WebPopup
* @see WebButtonPopup
* @see com.alee.managers.notification.WebInnerNotification
*/
public class PopupManager
{
/**
* Shade layers cache.
*/
protected static final Map<JRootPane, ShadeLayer> shadeLayers = new HashMap<JRootPane, ShadeLayer> ();
/**
* Popup layers cache.
*/
protected static final Map<JRootPane, PopupLayer> popupLayers = new HashMap<JRootPane, PopupLayer> ();
/**
* Default style used for popups.
*/
protected static PopupStyle defaultPopupStyle = PopupStyle.bordered;
/**
* Hides all visible popups on all cached popup layers.
*/
public static void hideAllPopups ()
{
for ( final ShadeLayer layer : shadeLayers.values () )
{
layer.hideAllPopups ();
}
for ( final PopupLayer layer : popupLayers.values () )
{
layer.hideAllPopups ();
}
}
/**
* Hides all visible popups for the root pane under the specified component.
*
* @param component component to process
*/
public static void hideAllPopups ( final JComponent component )
{
hideAllPopups ( SwingUtils.getRootPane ( component ) );
}
/**
* Hides all visible popups for the specified root pane.
*
* @param rootPane root pane to process
*/
public static void hideAllPopups ( final JRootPane rootPane )
{
if ( shadeLayers.containsKey ( rootPane ) )
{
shadeLayers.get ( rootPane ).hideAllPopups ();
}
if ( popupLayers.containsKey ( rootPane ) )
{
popupLayers.get ( rootPane ).hideAllPopups ();
}
}
/**
* Returns default popup style.
*
* @return default popup style
*/
public static PopupStyle getDefaultPopupStyle ()
{
return defaultPopupStyle;
}
/**
* Sets default popup style.
*
* @param style default popup style
*/
public static void setDefaultPopupStyle ( final PopupStyle style )
{
PopupManager.defaultPopupStyle = style;
}
/**
* Returns default popup painter.
*
* @return default popup painter
*/
public static Painter getDefaultPopupPainter ()
{
return defaultPopupStyle.getPainter ();
}
/**
* Displays popup for the root pane containing specified component.
*
* @param component component used to determine root pane for which modal popup will be displayed
* @param popup popup to display
*/
public static void showPopup ( final Component component, final WebPopup popup )
{
showPopup ( component, popup, true );
}
/**
* Displays popup for the root pane containing specified component.
*
* @param component component used to determine root pane for which modal popup will be displayed
* @param popup popup to display
* @param transferFocus whether to transfer focus to content of the displayed popup or not
*/
public static void showPopup ( final Component component, final WebPopup popup, final boolean transferFocus )
{
final JRootPane rootPane = SwingUtils.getRootPane ( component );
if ( rootPane != null )
{
showPopup ( rootPane, popup, transferFocus );
}
}
/**
* Displays popup for the specified root pane.
*
* @param rootPane root pane used to display popup
* @param popup popup to display
* @param transferFocus whether to transfer focus to content of the displayed popup or not
*/
public static void showPopup ( final JRootPane rootPane, final WebPopup popup, final boolean transferFocus )
{
// Displaying new modal popup
getPopupLayer ( rootPane ).showPopup ( popup );
// Transfering focus to first focusable component in the popup
if ( transferFocus )
{
popup.transferFocus ();
}
}
/**
* Returns cached popup layer for root pane containing specified component.
*
* @param component component used to determine root pane for popup layer
* @return cached popup layer for root pane containing specified component
*/
public static PopupLayer getPopupLayer ( final Component component )
{
return getPopupLayer ( SwingUtils.getRootPane ( component ) );
}
/**
* Returns cached popup layer for the specified root pane.
*
* @param rootPane root pane for popup layer
* @return cached popup layer for the specified root pane
*/
public static PopupLayer getPopupLayer ( final JRootPane rootPane )
{
if ( rootPane == null )
{
throw new RuntimeException ( "JRootPane for PopupLayer cannot be found" );
}
if ( popupLayers.containsKey ( rootPane ) )
{
return popupLayers.get ( rootPane );
}
else
{
final JLayeredPane layeredPane = rootPane.getLayeredPane ();
if ( layeredPane == null )
{
throw new RuntimeException ( "Popup layer can be installed only into window or applet with JLayeredPane" );
}
final PopupLayer popupLayer = new PopupLayer ();
installPopupLayer ( popupLayer, rootPane, layeredPane );
popupLayers.put ( rootPane, popupLayer );
return popupLayer;
}
}
/**
* Displays popup as modal for the root pane containing specified component.
*
* @param component component used to determine root pane for which modal popup will be displayed
* @param popup popup to display
* @param hfill whether popup should fill the whole available width or not
* @param vfill whether popup should fill the whole available height or not
*/
public static void showModalPopup ( final Component component, final WebPopup popup, final boolean hfill, final boolean vfill )
{
showModalPopup ( component, popup, hfill, vfill, false );
}
/**
* Displays popup as modal for the root pane containing specified component.
*
* @param component component used to determine root pane for which modal popup will be displayed
* @param popup popup to display
* @param hfill whether popup should fill the whole available width or not
* @param vfill whether popup should fill the whole available height or not
*/
public static void showModalPopup ( final Component component, final WebPopup popup, final boolean hfill, final boolean vfill,
final boolean blockClose )
{
final JRootPane rootPane = SwingUtils.getRootPane ( component );
if ( rootPane != null )
{
showModalPopup ( rootPane, popup, hfill, vfill, blockClose );
}
}
/**
* Displays popup as modal for the specified root pane.
*
* @param rootPane root pane used to display modal popup
* @param popup popup to display
* @param hfill whether popup should fill the whole available width or not
* @param vfill whether popup should fill the whole available height or not
*/
public static void showModalPopup ( final JRootPane rootPane, final WebPopup popup, final boolean hfill, final boolean vfill )
{
showModalPopup ( rootPane, popup, hfill, vfill, false );
}
/**
* Displays popup as modal for the specified root pane.
*
* @param rootPane root pane used to display modal popup
* @param popup popup to display
* @param hfill whether popup should fill the whole available width or not
* @param vfill whether popup should fill the whole available height or not
*/
public static void showModalPopup ( final JRootPane rootPane, final WebPopup popup, final boolean hfill, final boolean vfill,
final boolean blockClose )
{
// Hiding all modal and simple popups inside root pane
hideAllPopups ( rootPane );
// Displaying new modal popup
final ShadeLayer shadeLayer = getShadeLayer ( rootPane );
shadeLayer.setBlockClose ( blockClose );
shadeLayer.showPopup ( popup, hfill, vfill );
// Transfering focus to first focusable component in the popup
popup.transferFocus ();
}
/**
* Returns cached shade layer for the specified root pane.
*
* @param rootPane root pane for the shade layer
* @return cached shade layer for the specified root pane
*/
public static ShadeLayer getShadeLayer ( final JRootPane rootPane )
{
if ( rootPane == null )
{
throw new RuntimeException ( "JRootPane for PopupLayer cannot be found" );
}
if ( shadeLayers.containsKey ( rootPane ) )
{
return shadeLayers.get ( rootPane );
}
else
{
final JLayeredPane layeredPane = rootPane.getLayeredPane ();
if ( layeredPane == null )
{
throw new RuntimeException ( "Popup layer can be installed only into window or applet with JLayeredPane" );
}
final ShadeLayer shadeLayer = new ShadeLayer ();
installPopupLayer ( shadeLayer, rootPane, layeredPane );
shadeLayers.put ( rootPane, shadeLayer );
return shadeLayer;
}
}
/**
* Installs popup layer for the specified root pane.
*
* @param popupLayer popup layer to install
* @param rootPane root pane for which popup layer should be installed
* @param layeredPane window's layered pane
*/
protected static void installPopupLayer ( final PopupLayer popupLayer, final JRootPane rootPane, final JLayeredPane layeredPane )
{
popupLayer.setBounds ( 0, 0, layeredPane.getWidth (), layeredPane.getHeight () );
popupLayer.setVisible ( true );
layeredPane.add ( popupLayer, JLayeredPane.PALETTE_LAYER );
layeredPane.revalidate ();
layeredPane.addComponentListener ( new ComponentAdapter ()
{
@Override
public void componentResized ( final ComponentEvent e )
{
popupLayer.setBounds ( 0, 0, layeredPane.getWidth (), layeredPane.getHeight () );
popupLayer.revalidate ();
}
} );
final Window window = SwingUtils.getWindowAncestor ( rootPane );
if ( window != null )
{
window.addWindowStateListener ( new WindowStateListener ()
{
@Override
public void windowStateChanged ( final WindowEvent e )
{
popupLayer.setBounds ( 0, 0, layeredPane.getWidth (), layeredPane.getHeight () );
popupLayer.revalidate ();
}
} );
}
}
}