com.alee.laf.window.WebWindow Maven / Gradle / Ivy
/*
* 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 {@link WebWindow} type
* @author Mikle Garin
* @see JWindow
* @see WebRootPaneUI
* @see com.alee.laf.rootpane.RootPanePainter
*/
public class WebWindow> extends JWindow implements Styleable, Paintable, PaddingMethods, WindowEventMethods,
LanguageMethods, LanguageEventMethods, SettingsMethods, WindowMethods
{
/**
* Whether should close window on focus loss or not.
*/
protected boolean closeOnFocusLoss = false;
/**
* Window focus tracker.
*/
protected transient DefaultFocusTracker focusTracker;
/**
* Creates a window with no specified owner. This window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*/
public WebWindow ()
{
this ( StyleId.auto );
}
/**
* Creates a window with the specified {@code GraphicsConfiguration} of a screen device. This window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param gc the {@code GraphicsConfiguration} that is used to construct the new window with; if gc is {@code null},
* the system default {@code GraphicsConfiguration} is assumed
*/
public WebWindow ( final GraphicsConfiguration gc )
{
this ( StyleId.auto, gc );
}
/**
* Creates a window with the owner window from the specified component.
* This window will not be focusable unless its owner is showing on the screen.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param owner the componnt from which parent window this window is displayed
*/
public WebWindow ( final Component owner )
{
this ( StyleId.auto, owner );
}
/**
* Creates a window with the specified owner window. This window will not be focusable unless its owner is showing on the screen.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param owner the window from which the window is displayed
*/
public WebWindow ( final Window owner )
{
this ( StyleId.auto, owner );
}
/**
* Creates a window with the specified owner window and {@code GraphicsConfiguration} of a screen device.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param owner the window from which the window is displayed
* @param gc the {@code GraphicsConfiguration} that is used to construct the new window with; if gc is {@code null},
* the system default {@code GraphicsConfiguration} is assumed, unless {@code owner} is also null, in which
* case the {@code GraphicsConfiguration} from the shared owner frame will be used
*/
public WebWindow ( final Window owner, final GraphicsConfiguration gc )
{
this ( StyleId.auto, owner, gc );
}
/**
* Creates a window with the specified owner frame.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
* Also, this window will not be focusable unless its owner is showing on the screen.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param owner the frame from which the window is displayed
*/
public WebWindow ( final Frame owner )
{
this ( StyleId.auto, owner );
}
/**
* Creates a window with no specified owner. This window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param id style ID
*/
public WebWindow ( final StyleId id )
{
this ( id, ( Frame ) null );
}
/**
* Creates a window with the specified {@code GraphicsConfiguration} of a screen device. This window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param id style ID
* @param gc the {@code GraphicsConfiguration} that is used to construct the new window with; if gc is {@code null},
* the system default {@code GraphicsConfiguration} is assumed
*/
public WebWindow ( final StyleId id, final GraphicsConfiguration gc )
{
this ( id, null, gc );
}
/**
* Creates a window with the owner window from the specified component.
* This window will not be focusable unless its owner is showing on the screen.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param id style ID
* @param owner the componnt from which parent window this window is displayed
*/
public WebWindow ( final StyleId id, final Component owner )
{
this ( id, CoreSwingUtils.getWindowAncestor ( owner ) );
}
/**
* Creates a window with the specified owner window. This window will not be focusable unless its owner is showing on the screen.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param id style ID
* @param owner the window from which the window is displayed
*/
public WebWindow ( final StyleId id, final Window owner )
{
this ( id, owner, owner != null ? owner.getGraphicsConfiguration () : null );
}
/**
* Creates a window with the specified owner window and {@code GraphicsConfiguration} of a screen device.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param id style ID
* @param owner the window from which the window is displayed
* @param gc the {@code GraphicsConfiguration} that is used to construct the new window with; if gc is {@code null},
* the system default {@code GraphicsConfiguration} is assumed, unless {@code owner} is also null, in which
* case the {@code GraphicsConfiguration} from the shared owner frame will be used
*/
public WebWindow ( final StyleId id, final Window owner, final GraphicsConfiguration gc )
{
super ( owner, gc );
initialize ( id );
}
/**
* Creates a window with the specified owner frame.
* If {@code owner} is {@code null}, the shared owner will be used and this window will not be focusable.
* Also, this window will not be focusable unless its owner is showing on the screen.
*
* This constructor sets the component's locale property to the value returned by {@code JComponent.getDefaultLocale}.
*
* @param id style ID
* @param owner the frame from which the window is displayed
*/
public WebWindow ( final StyleId id, final Frame owner )
{
super ( owner );
initialize ( id );
}
@Override
protected void windowInit ()
{
// Disabling default initialization to optimize startup performance
}
/**
* Additional initializtion of WebWindow settings.
*
* @param id initial style ID
*/
protected void initialize ( final StyleId id )
{
// Default window initialization
setLocale ( JComponent.getDefaultLocale () );
setRootPane ( createRootPane () );
setRootPaneCheckingEnabled ( true );
ProprietaryUtils.checkAndSetPolicy ( this );
// Updating base settings
setFocusable ( true );
setFocusableWindowState ( true );
SwingUtils.setOrientation ( this );
// Installing root pane style
setStyleId ( id );
// Adding focus tracker for this window
// It is stored into a separate field to avoid its disposal from memory
focusTracker = new DefaultFocusTracker ( getRootPane (), true )
{
@Override
public boolean isEnabled ()
{
return closeOnFocusLoss && super.isEnabled ();
}
@Override
public void focusChanged ( final boolean focused )
{
if ( isEnabled () && !focused )
{
// Simply disposing window
dispose ();
}
}
};
FocusManager.addFocusTracker ( getRootPane (), focusTracker );
}
@Override
protected JRootPane createRootPane ()
{
return new WebWindowRootPane ();
}
/**
* Returns whether should close window on focus loss or not.
*
* @return true if should close window on focus loss, false otherwise
*/
public boolean isCloseOnFocusLoss ()
{
return closeOnFocusLoss;
}
/**
* Sets whether should close window on focus loss or not.
*
* @param closeOnFocusLoss whether should close window on focus loss or not
*/
public void setCloseOnFocusLoss ( final boolean closeOnFocusLoss )
{
this.closeOnFocusLoss = closeOnFocusLoss;
}
/**
* Returns focusable children that don't force window to close even if it set to close on focus loss.
*
* @return focusable children that don't force window to close even if it set to close on focus loss
*/
public List getFocusableChildren ()
{
return focusTracker.getFocusableChildren ();
}
/**
* Adds focusable child that won't force window to close even if it set to close on focus loss.
*
* @param child focusable child that won't force window to close even if it set to close on focus loss
*/
public void addFocusableChild ( final Component child )
{
focusTracker.addFocusableChild ( child );
}
/**
* Removes focusable child that doesn't force window to close even if it set to close on focus loss.
*
* @param child focusable child that doesn't force window to close even if it set to close on focus loss
*/
public void removeFocusableChild ( final Component child )
{
focusTracker.removeFocusableChild ( child );
}
@Override
public StyleId getDefaultStyleId ()
{
return StyleId.window;
}
@Override
public StyleId getStyleId ()
{
return StyleManager.getStyleId ( getRootPane () );
}
@Override
public StyleId setStyleId ( final StyleId id )
{
return StyleManager.setStyleId ( getRootPane (), id );
}
@Override
public StyleId resetStyleId ()
{
return StyleManager.resetStyleId ( getRootPane () );
}
@Override
public Skin getSkin ()
{
return StyleManager.getSkin ( getRootPane () );
}
@Override
public Skin setSkin ( final Skin skin )
{
return StyleManager.setSkin ( getRootPane (), skin );
}
@Override
public Skin setSkin ( final Skin skin, final boolean recursively )
{
return StyleManager.setSkin ( getRootPane (), skin, recursively );
}
@Override
public Skin resetSkin ()
{
return StyleManager.resetSkin ( getRootPane () );
}
@Override
public void addStyleListener ( final StyleListener listener )
{
StyleManager.addStyleListener ( getRootPane (), listener );
}
@Override
public void removeStyleListener ( final StyleListener listener )
{
StyleManager.removeStyleListener ( getRootPane (), listener );
}
@Override
public Painter getCustomPainter ()
{
return StyleManager.getCustomPainter ( getRootPane () );
}
@Override
public Painter setCustomPainter ( final Painter painter )
{
return StyleManager.setCustomPainter ( getRootPane (), painter );
}
@Override
public boolean resetCustomPainter ()
{
return StyleManager.resetCustomPainter ( getRootPane () );
}
@Override
public Insets getPadding ()
{
return PaddingMethodsImpl.getPadding ( getRootPane () );
}
@Override
public void setPadding ( final int padding )
{
PaddingMethodsImpl.setPadding ( getRootPane (), padding );
}
@Override
public void setPadding ( final int top, final int left, final int bottom, final int right )
{
PaddingMethodsImpl.setPadding ( getRootPane (), top, left, bottom, right );
}
@Override
public void setPadding ( final Insets padding )
{
PaddingMethodsImpl.setPadding ( getRootPane (), padding );
}
/**
* Returns the look and feel (LaF) object that renders this component.
*
* @return the {@link com.alee.laf.rootpane.WRootPaneUI} object that renders this component
*/
public WRootPaneUI getUI ()
{
return ( WRootPaneUI ) getRootPane ().getUI ();
}
/**
* Sets the LaF object that renders this component.
*
* @param ui {@link WRootPaneUI}
*/
public void setUI ( final WRootPaneUI ui )
{
getRootPane ().setUI ( ui );
}
@Override
public WindowAdapter onClosing ( final WindowEventRunnable runnable )
{
return WindowEventMethodsImpl.onClosing ( this, runnable );
}
@Override
public WindowCloseAdapter onClose ( final ComponentEventRunnable runnable )
{
return WindowEventMethodsImpl.onClose ( this, runnable );
}
@Override
public String getLanguage ()
{
return UILanguageManager.getComponentKey ( getRootPane () );
}
@Override
public void setLanguage ( final String key, final Object... data )
{
UILanguageManager.registerComponent ( getRootPane (), key, data );
}
@Override
public void updateLanguage ( final Object... data )
{
UILanguageManager.updateComponent ( getRootPane (), data );
}
@Override
public void updateLanguage ( final String key, final Object... data )
{
UILanguageManager.updateComponent ( getRootPane (), key, data );
}
@Override
public void removeLanguage ()
{
UILanguageManager.unregisterComponent ( getRootPane () );
}
@Override
public boolean isLanguageSet ()
{
return UILanguageManager.isRegisteredComponent ( getRootPane () );
}
@Override
public void setLanguageUpdater ( final LanguageUpdater updater )
{
UILanguageManager.registerLanguageUpdater ( getRootPane (), updater );
}
@Override
public void removeLanguageUpdater ()
{
UILanguageManager.unregisterLanguageUpdater ( getRootPane () );
}
@Override
public void addLanguageListener ( final LanguageListener listener )
{
UILanguageManager.addLanguageListener ( getRootPane (), listener );
}
@Override
public void removeLanguageListener ( final LanguageListener listener )
{
UILanguageManager.removeLanguageListener ( getRootPane (), listener );
}
@Override
public void removeLanguageListeners ()
{
UILanguageManager.removeLanguageListeners ( getRootPane () );
}
@Override
public void addDictionaryListener ( final DictionaryListener listener )
{
UILanguageManager.addDictionaryListener ( getRootPane (), listener );
}
@Override
public void removeDictionaryListener ( final DictionaryListener listener )
{
UILanguageManager.removeDictionaryListener ( getRootPane (), listener );
}
@Override
public void removeDictionaryListeners ()
{
UILanguageManager.removeDictionaryListeners ( getRootPane () );
}
@Override
public void registerSettings ( final Configuration configuration )
{
UISettingsManager.registerComponent ( getRootPane (), configuration );
}
@Override
public void registerSettings ( final SettingsProcessor processor )
{
UISettingsManager.registerComponent ( getRootPane (), processor );
}
@Override
public void unregisterSettings ()
{
UISettingsManager.unregisterComponent ( getRootPane () );
}
@Override
public void loadSettings ()
{
UISettingsManager.loadSettings ( getRootPane () );
}
@Override
public void saveSettings ()
{
UISettingsManager.saveSettings ( getRootPane () );
}
@Override
public boolean isWindowOpaque ()
{
return WindowMethodsImpl.isWindowOpaque ( this );
}
@Override
public T setWindowOpaque ( final boolean opaque )
{
return WindowMethodsImpl.setWindowOpaque ( this, opaque );
}
@Override
public float getWindowOpacity ()
{
return WindowMethodsImpl.getWindowOpacity ( this );
}
@Override
public T setWindowOpacity ( final float opacity )
{
return WindowMethodsImpl.setWindowOpacity ( this, opacity );
}
@Override
public T center ()
{
return WindowMethodsImpl.center ( this );
}
@Override
public T center ( final Component relativeTo )
{
return WindowMethodsImpl.center ( this, relativeTo );
}
@Override
public T center ( final int width, final int height )
{
return WindowMethodsImpl.center ( this, width, height );
}
@Override
public T center ( final Component relativeTo, final int width, final int height )
{
return WindowMethodsImpl.center ( this, relativeTo, width, height );
}
@Override
public T packToWidth ( final int width )
{
return WindowMethodsImpl.packToWidth ( this, width );
}
@Override
public T packToHeight ( final int height )
{
return WindowMethodsImpl.packToHeight ( this, height );
}
/**
* Custom root pane for this {@link WebWindow}.
* It is required to provide undecorated root pane style ID to avoid issues with further style updates.
* It also provides default window style ID instead of default root pane style ID.
*/
public class WebWindowRootPane extends WebRootPane
{
/**
* Constructs new root pane for this {@link WebWindow}.
* Providing default {@link StyleId} here is very important to avoid calling any updates.
*/
public WebWindowRootPane ()
{
super ( StyleManager.getDescriptor ( JRootPane.class ).getDefaultStyleId () );
}
@Override
public StyleId getDefaultStyleId ()
{
return WebWindow.this.getDefaultStyleId ();
}
}
}