com.alee.laf.rootpane.WebRootPaneUI Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
Show all versions of weblaf-ui Show documentation
WebLaf is a Java Swing Look and Feel and extended components library for cross-platform applications
/*
* 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 ()
{
@Override
public void run ( final IRootPanePainter newPainter )
{
WebRootPaneUI.this.painter = newPainter;
}
}, this.painter, painter, IRootPanePainter.class, AdaptiveRootPanePainter.class );
}
/**
* Returns whether or not this root pane uses custom decoration for its window.
*
* @return true if this root pane uses custom decoration for its window, false otherwise
*/
public boolean isDecorated ()
{
return painter != null && painter.isDecorated ();
}
/**
* Returns window title component.
*
* @return window title component
*/
public JComponent getTitleComponent ()
{
return titleComponent;
}
/**
* Sets window title component.
*
* @param title new window title component
*/
public void setTitleComponent ( final JComponent title )
{
this.titleComponent = title;
root.revalidate ();
}
/**
* Returns window buttons panel.
*
* @return window buttons panel
*/
public GroupPane getButtonsPanel ()
{
return buttonsPanel;
}
/**
* Returns whether or not window title component should be displayed.
*
* @return true if window title component should be displayed, false otherwise
*/
public boolean isDisplayTitleComponent ()
{
return displayTitleComponent;
}
/**
* Sets whether or not window title component should be displayed.
*
* @param display whether or not window title component should be displayed
*/
public void setDisplayTitleComponent ( final boolean display )
{
this.displayTitleComponent = display;
root.revalidate ();
}
/**
* Returns whether or not window buttons should be displayed.
*
* @return true if window buttons should be displayed, false otherwise
*/
public boolean isDisplayWindowButtons ()
{
return displayWindowButtons;
}
/**
* Sets whether or not window buttons should be displayed.
*
* @param display whether or not window buttons should be displayed
*/
public void setDisplayWindowButtons ( final boolean display )
{
this.displayWindowButtons = display;
root.revalidate ();
}
/**
* Returns whether or not window minimize button should be displayed.
*
* @return true if window minimize button should be displayed, false otherwise
*/
public boolean isDisplayMinimizeButton ()
{
return displayMinimizeButton;
}
/**
* Sets whether or not window minimize button should be displayed.
*
* @param display whether or not window minimize button should be displayed
*/
public void setDisplayMinimizeButton ( final boolean display )
{
this.displayMinimizeButton = display;
updateButtons ();
root.revalidate ();
}
/**
* Returns whether or not window maximize button should be displayed.
*
* @return true if window maximize button should be displayed, false otherwise
*/
public boolean isDisplayMaximizeButton ()
{
return displayMaximizeButton;
}
/**
* Sets whether or not window maximize button should be displayed.
*
* @param display whether or not window maximize button should be displayed
*/
public void setDisplayMaximizeButton ( final boolean display )
{
this.displayMaximizeButton = display;
updateButtons ();
root.revalidate ();
}
/**
* Returns whether or not window close button should be displayed.
*
* @return true if window close button should be displayed, false otherwise
*/
public boolean isDisplayCloseButton ()
{
return displayCloseButton;
}
/**
* Sets whether or not window close button should be displayed.
*
* @param display whether or not window close button should be displayed
*/
public void setDisplayCloseButton ( final boolean display )
{
this.displayCloseButton = display;
updateButtons ();
root.revalidate ();
}
/**
* Returns whether or not menu bar should be displayed.
*
* @return true if menu bar should be displayed, false otherwise
*/
public boolean isDisplayMenuBar ()
{
return displayMenuBar;
}
/**
* Sets whether or not menu bar should be displayed.
*
* @param display whether or not menu bar should be displayed
*/
public void setDisplayMenuBar ( final boolean display )
{
this.displayMenuBar = display;
root.revalidate ();
}
@Override
public void propertyChange ( final PropertyChangeEvent e )
{
super.propertyChange ( e );
// Retrieving changed property
final String propertyName = e.getPropertyName ();
if ( propertyName == null )
{
return;
}
// Reinstalling window decorations
if ( propertyName.equals ( WebLookAndFeel.WINDOW_DECORATION_STYLE_PROPERTY ) )
{
updateWindowDecorations ();
}
}
/**
* Updates window decorations.
*/
protected void updateWindowDecorations ()
{
if ( !root.isShowing () )
{
uninstallWindowDecorations ();
installWindowDecorations ();
}
else
{
throw new RuntimeException ( "Unable to modify window decoration while it is displayed" );
}
}
/**
* Installs window decorations.
*/
protected void installWindowDecorations ()
{
if ( root.getWindowDecorationStyle () != JRootPane.NONE && isDecorated () )
{
window = SwingUtils.getWindowAncestor ( root );
frame = window instanceof Frame ? ( Frame ) window : null;
dialog = window instanceof Dialog ? ( Dialog ) window : null;
installListeners ();
installOpacity ();
installLayout ();
installDecorationComponents ();
}
}
/**
* Uninstalls window decorations.
*/
protected void uninstallWindowDecorations ()
{
if ( window != null && isDecorated () )
{
uninstallDecorationComponents ();
uninstallLayout ();
uninstallOpacity ();
uninstallListeners ();
uninstallSettings ();
dialog = null;
frame = null;
window = null;
}
}
/**
* Uninstalls settings used in runtime.
*/
protected void uninstallSettings ()
{
if ( isFrame () )
{
// Maximum frame size
frame.setMaximizedBounds ( null );
}
}
/**
* Installs listeners.
*/
protected void installListeners ()
{
// Listen to window icon and title changes
titleChangeListener = new PropertyChangeListener ()
{
@Override
public void propertyChange ( final PropertyChangeEvent evt )
{
titleComponent.revalidate ();
titleComponent.repaint ();
}
};
window.addPropertyChangeListener ( WebLookAndFeel.WINDOW_ICON_PROPERTY, titleChangeListener );
window.addPropertyChangeListener ( WebLookAndFeel.WINDOW_TITLE_PROPERTY, titleChangeListener );
// Listen to window resizeability changes
resizableChangeListener = new PropertyChangeListener ()
{
@Override
public void propertyChange ( final PropertyChangeEvent evt )
{
updateButtons ();
}
};
window.addPropertyChangeListener ( WebLookAndFeel.WINDOW_RESIZABLE_PROPERTY, resizableChangeListener );
}
/**
* Uninstalls listeners.
*/
protected void uninstallListeners ()
{
window.removePropertyChangeListener ( WebLookAndFeel.WINDOW_ICON_PROPERTY, titleChangeListener );
window.removePropertyChangeListener ( WebLookAndFeel.WINDOW_TITLE_PROPERTY, titleChangeListener );
window.removePropertyChangeListener ( WebLookAndFeel.WINDOW_RESIZABLE_PROPERTY, resizableChangeListener );
}
/**
* Installs window opacity.
*/
protected void installOpacity ()
{
if ( ProprietaryUtils.isWindowTransparencyAllowed () )
{
root.setOpaque ( false );
ProprietaryUtils.setWindowOpaque ( window, false );
}
}
/**
* Uninstalls window opacity.
*/
protected void uninstallOpacity ()
{
if ( ProprietaryUtils.isWindowTransparencyAllowed () )
{
root.setOpaque ( true );
ProprietaryUtils.setWindowOpaque ( window, true );
}
}
/**
* Installs appropriate layout manager.
*/
protected void installLayout ()
{
if ( layoutManager == null )
{
layoutManager = new WebRootPaneLayout ();
}
previousLayoutManager = root.getLayout ();
root.setLayout ( layoutManager );
}
/**
* Uninstalls layout manager.
*/
protected void uninstallLayout ()
{
if ( previousLayoutManager != null )
{
root.setLayout ( previousLayoutManager );
previousLayoutManager = null;
}
}
/**
* Installs decoration components.
*/
protected void installDecorationComponents ()
{
// Title
titleComponent = createDefaultTitleComponent ();
root.add ( titleComponent );
// Buttons
updateButtons ();
}
/**
* Uninstalls decoration components.
*/
protected void uninstallDecorationComponents ()
{
// Title
if ( titleComponent != null )
{
root.remove ( titleComponent );
titleComponent = null;
}
// Buttons
if ( buttonsPanel != null )
{
root.remove ( buttonsPanel );
buttonsPanel = null;
minimizeButton = null;
maximizeButton = null;
closeButton = null;
}
}
/**
* Returns default window title component.
*
* @return default window title component
*/
protected JComponent createDefaultTitleComponent ()
{
final StyleId titlePanelId = StyleId.rootpaneTitlePanel.at ( root );
final WebPanel titlePanel = new WebPanel ( titlePanelId, new BorderLayout ( 5, 0 ) );
final WebLabel titleIcon = new WebLabel ( StyleId.rootpaneTitleIcon.at ( titlePanel ) )
{
@Override
public Icon getIcon ()
{
return getWindowIcon ();
}
};
titlePanel.add ( titleIcon, BorderLayout.LINE_START );
final TitleLabel titleLabel = new TitleLabel ( StyleId.rootpaneTitleLabel.at ( titlePanel ) );
titleLabel.setFont ( WebLookAndFeel.globalTitleFont );
titleLabel.setFontSize ( 13 );
titleLabel.setHorizontalAlignment ( CENTER );
titleLabel.addComponentListener ( new ComponentAdapter ()
{
@Override
public void componentResized ( final ComponentEvent e )
{
titleLabel.setHorizontalAlignment ( titleLabel.getRequiredSize ().width > titleLabel.getWidth () ? LEADING : CENTER );
}
} );
titlePanel.add ( titleLabel, BorderLayout.CENTER );
// Window move and max/restore listener
final ComponentMoveBehavior cma = new ComponentMoveBehavior ()
{
@Override
public void mouseClicked ( final MouseEvent e )
{
if ( isFrame () && isDisplayMaximizeButton () && SwingUtils.isLeftMouseButton ( e ) && e.getClickCount () == 2 )
{
if ( isMaximized () )
{
restore ();
}
else
{
maximize ();
}
}
}
@Override
public void mouseDragged ( final MouseEvent e )
{
if ( dragging && isMaximized () )
{
// todo provide shade width
//initialPoint = new Point ( initialPoint.x + shadeWidth, initialPoint.y + shadeWidth );
restore ();
}
super.mouseDragged ( e );
}
};
titlePanel.addMouseListener ( cma );
titlePanel.addMouseMotionListener ( cma );
return titlePanel;
}
/**
* Custom decoration title label.
*/
public class TitleLabel extends WebLabel
{
/**
* Constructs new title label.
*
* @param id style ID
*/
public TitleLabel ( final StyleId id )
{
super ( id );
}
/**
* Returns window title text.
* Single spacing workaround allows window dragging even when title is not set.
* That is required because otherwise title label would shrink to zero size due to missing content.
*
* @return window title text
*/
@Override
public String getText ()
{
final String title = getWindowTitle ();
final String t = !TextUtils.isEmpty ( title ) ? title : emptyTitleText != null ? LM.get ( emptyTitleText ) : null;
return !TextUtils.isEmpty ( t ) ? t : " ";
}
/**
* Returns actual preferred size of the title label.
*
* @return actual preferred size of the title label
*/
public Dimension getRequiredSize ()
{
return super.getPreferredSize ();
}
}
/**
* Updates displayed buttons
*/
protected void updateButtons ()
{
// Creating new buttons panel
if ( buttonsPanel == null )
{
buttonsPanel = new GroupPane ( StyleId.rootpaneButtonsPanel.at ( root ) );
buttonsPanel.setPaintSides ( false, true, true, true );
root.add ( buttonsPanel );
}
// Minimize button
if ( displayMinimizeButton && isFrame () )
{
if ( minimizeButton == null )
{
final StyleId minimizeId = StyleId.rootpaneMinimizeButton.at ( buttonsPanel );
minimizeButton = new WebButton ( minimizeId, minimizeIcon, minimizeActiveIcon );
minimizeButton.setName ( "minimize" );
minimizeButton.addActionListener ( new ActionListener ()
{
@Override
public void actionPerformed ( final ActionEvent e )
{
iconify ();
}
} );
}
buttonsPanel.add ( minimizeButton );
}
else
{
if ( minimizeButton != null )
{
buttonsPanel.remove ( minimizeButton );
}
}
// Maximize button
if ( displayMaximizeButton && isResizable () && isFrame () )
{
if ( maximizeButton == null )
{
final StyleId maximizeId = StyleId.rootpaneMaximizeButton.at ( buttonsPanel );
maximizeButton = new WebButton ( maximizeId, maximizeIcon, maximizeActiveIcon )
{
@Override
public Icon getIcon ()
{
return isMaximized () ? restoreIcon : maximizeIcon;
}
@Override
public Icon getRolloverIcon ()
{
return isMaximized () ? restoreActiveIcon : maximizeActiveIcon;
}
};
maximizeButton.setName ( "maximize" );
maximizeButton.addActionListener ( new ActionListener ()
{
@Override
public void actionPerformed ( final ActionEvent e )
{
if ( isFrame () )
{
if ( isMaximized () )
{
restore ();
}
else
{
maximize ();
}
}
}
} );
}
buttonsPanel.add ( maximizeButton );
}
else
{
if ( maximizeButton != null )
{
buttonsPanel.remove ( maximizeButton );
}
}
// Close button
if ( displayCloseButton )
{
if ( closeButton == null )
{
final StyleId closeId = StyleId.rootpaneCloseButton.at ( buttonsPanel );
closeButton = new WebButton ( closeId, closeIcon, closeActiveIcon );
closeButton.setName ( "close" );
closeButton.addActionListener ( new ActionListener ()
{
@Override
public void actionPerformed ( final ActionEvent e )
{
close ();
}
} );
}
buttonsPanel.add ( closeButton );
}
else
{
if ( closeButton != null )
{
buttonsPanel.remove ( closeButton );
}
}
}
/**
* Returns window title.
*
* @return window title
*/
protected String getWindowTitle ()
{
if ( isDialog () )
{
return dialog.getTitle ();
}
else if ( isFrame () )
{
return frame.getTitle ();
}
else
{
return null;
}
}
/**
* Returns window icon of suitable size.
*
* @return window icon of suitable size
*/
protected ImageIcon getWindowIcon ()
{
final List images = window != null ? window.getIconImages () : null;
if ( images != null && images.size () > 1 )
{
int bestIndex = 0;
int bestDiff = Math.abs ( images.get ( bestIndex ).getWidth ( null ) - iconSize );
for ( int i = 1; i < images.size (); i++ )
{
if ( bestDiff == 0 )
{
break;
}
final int diff = Math.abs ( images.get ( i ).getWidth ( null ) - iconSize );
if ( diff < bestDiff )
{
bestIndex = i;
bestDiff = diff;
}
}
return generateProperIcon ( images.get ( bestIndex ) );
}
else if ( images != null && images.size () == 1 )
{
return generateProperIcon ( images.get ( 0 ) );
}
else
{
return new ImageIcon ();
}
}
/**
* Returns generated window icon of suitable size.
*
* @param image image used to generate icon of suitable size
* @return generated window icon of suitable size
*/
protected ImageIcon generateProperIcon ( final Image image )
{
if ( image.getWidth ( null ) <= iconSize )
{
return new ImageIcon ( image );
}
else
{
return ImageUtils.createPreviewIcon ( image, iconSize );
}
}
/**
* Closes the Window.
*/
protected void close ()
{
if ( window != null )
{
window.dispatchEvent ( new WindowEvent ( window, WindowEvent.WINDOW_CLOSING ) );
}
}
/**
* Iconifies the Frame.
*/
protected void iconify ()
{
if ( frame != null )
{
frame.setExtendedState ( Frame.ICONIFIED );
}
}
/**
* Maximizes the Frame.
*/
protected void maximize ()
{
if ( frame != null )
{
// Retrieving screen device configuration
final GraphicsConfiguration gc = frame.getGraphicsConfiguration ().getDevice ().getDefaultConfiguration ();
// Updating maximized bounds for the frame
frame.setMaximizedBounds ( SystemUtils.getMaxWindowBounds ( gc, true ) );
// Forcing window to go into maximized state
frame.setExtendedState ( Frame.MAXIMIZED_BOTH );
}
}
/**
* Restores the Frame size.
*/
protected void restore ()
{
if ( frame != null )
{
frame.setExtendedState ( Frame.NORMAL );
}
}
/**
* Returns whether or not window is resizable.
*
* @return true if window is resizable, false otherwise
*/
protected boolean isResizable ()
{
return isDialog () ? dialog.isResizable () : isFrame () && frame.isResizable ();
}
/**
* Returns whether or not this root pane is attached to frame.
*
* @return true if this root pane is attached to frame, false otherwise
*/
public boolean isFrame ()
{
return frame != null;
}
/**
* Returns whether or not window this root pane is attached to is maximized.
*
* @return true if window this root pane is attached to is maximized, false otherwise
*/
public boolean isIconified ()
{
return isFrame () && ( frame.getExtendedState () & Frame.ICONIFIED ) == Frame.ICONIFIED;
}
/**
* Returns whether or not window this root pane is attached to is maximized.
*
* @return true if window this root pane is attached to is maximized, false otherwise
*/
public boolean isMaximized ()
{
return isFrame () && ( frame.getExtendedState () & Frame.MAXIMIZED_BOTH ) == Frame.MAXIMIZED_BOTH;
}
/**
* Returns whether or not this root pane is attached to dialog.
*
* @return true if this root pane is attached to dialog, false otherwise
*/
public boolean isDialog ()
{
return dialog != null;
}
@Override
public void paint ( final Graphics g, final JComponent c )
{
if ( painter != null )
{
painter.paint ( ( Graphics2D ) g, Bounds.component.of ( c ), c, this );
}
}
@Override
public Dimension getPreferredSize ( final JComponent c )
{
// return PainterSupport.getPreferredSize ( c, painter );
return null;
}
}