bibliothek.gui.dock.station.screen.window

Class InternalScreenDockWindowFactory

java.lang.Object

bibliothek.gui.dock.station.screen.window.InternalScreenDockWindowFactory

All Implemented Interfaces:

ScreenDockWindowFactory

public class InternalScreenDockWindowFactory
extends Object
implements ScreenDockWindowFactory

A simple factory creating new instances of InternalDockDialog.

Author:

Benjamin Sigg

See Also:

InternalBoundaryRestriction

Constructor Summary

Constructors

Constructor and Description
InternalScreenDockWindowFactory(JDesktopPane desktop) Creates the factory.

Method Summary

Modifier and Type	Method and Description
ScreenDockWindow	createWindow(ScreenDockStation station, WindowConfiguration configuration) Creates a new window which will be used by station.
int	getScreenDockWindowLayer() Gets the layer in which new InternalDockDialogs will appear.
void	setScreenDockWindowLayer(int screenDockWindowLayer) Sets the layer in which new InternalDockDialogs will appear.
ScreenDockWindow	updateWindow(ScreenDockWindow window, WindowConfiguration configuration, ScreenDockStation station) This method is called if the result of ScreenDockStation.getOwner() changed, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalScreenDockWindowFactory

public InternalScreenDockWindowFactory(JDesktopPane desktop)

Creates the factory. All windows will have desktop as parent.

Parameters:

desktop - the parent for new windows

Method Detail

setScreenDockWindowLayer

public void setScreenDockWindowLayer(int screenDockWindowLayer)

Sets the layer in which new InternalDockDialogs will appear. The default value for this property is JLayeredPane.MODAL_LAYER. Please have a look at JLayeredPane.setLayer(java.awt.Component, int) to learn more about the meaning of this integer.

Parameters:

screenDockWindowLayer - the layer, a constant like JLayeredPane.MODAL_LAYER

getScreenDockWindowLayer

public int getScreenDockWindowLayer()

Gets the layer in which new InternalDockDialogs will appear.

Returns:

the layer

See Also:

setScreenDockWindowLayer(int)

updateWindow

public ScreenDockWindow updateWindow(ScreenDockWindow window,
                                     WindowConfiguration configuration,
                                     ScreenDockStation station)

Description copied from interface: ScreenDockWindowFactory

This method is called if the result of ScreenDockStation.getOwner() changed, i.e. if the ScreenDockStation has a new owner. This method may replace the existing window with a new window if necessary.

Specified by:

updateWindow in interface ScreenDockWindowFactory

Parameters:

window - the currently shown window

configuration - the configuration that was used to create window

station - the owner of the window

Returns:

the replacement, a value of null or window means that nothing happens

createWindow

public ScreenDockWindow createWindow(ScreenDockStation station,
                                     WindowConfiguration configuration)

Description copied from interface: ScreenDockWindowFactory

Creates a new window which will be used by station.

Specified by:

createWindow in interface ScreenDockWindowFactory

Parameters:

station - the owner of the window

configuration - information about how the window has to look depending on its future Dockable and on the current ScreenDockWindowConfiguration.

Returns:

the new window