/*
 * Bibliothek - DockingFrames
 * Library built on Java/Swing, allows the user to "drag and drop"
 * panels containing any Swing-Component the developer likes to add.
 * 
 * Copyright (C) 2008 Benjamin Sigg
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Benjamin Sigg
 * benjamin_sigg@gmx.ch
 * CH - Switzerland
 */
package bibliothek.gui.dock.station.screen;

import bibliothek.gui.Dockable;
import bibliothek.gui.dock.ScreenDockStation;
import bibliothek.gui.dock.station.screen.window.WindowConfiguration;

/**
 * A {@link ScreenDockWindowFactory} can create new {@link ScreenDockWindow}s.
 * This factory is used by the {@link ScreenDockStation} and set through
 * {@link ScreenDockStation#WINDOW_FACTORY}.
 * @author Benjamin Sigg
 */
public interface ScreenDockWindowFactory {
    /**
     * Creates a new window which will be used by <code>station</code>. 
     * @param station the owner of the window
     * @param configuration information about how the window has to look depending on its future 
     * {@link Dockable} and on the current {@link ScreenDockWindowConfiguration}.
     * @return the new window
     */
    public ScreenDockWindow createWindow( ScreenDockStation station, WindowConfiguration configuration );
    
    /**
     * This method is called if the result of {@link ScreenDockStation#getOwner()} changed, i.e. if
     * the {@link ScreenDockStation} has a new owner. This method may replace the existing <code>window</code>
     * with a new window if necessary.
     * @param window the currently shown window
     * @param configuration the configuration that was used to create <code>window</code>
     * @param station the owner of the window
     * @return the replacement, a value of <code>null</code> or <code>window</code> means that nothing happens
     */
    public ScreenDockWindow updateWindow( ScreenDockWindow window, WindowConfiguration configuration, ScreenDockStation station );
}