bibliothek.gui.dock.common.intern.CControlFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docking-frames-common Show documentation
Docking Frames Common legacy version used in openTCS
The newest version!
/*
 * 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) 2007 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
 * [email protected]
 * CH - Switzerland
 */
package bibliothek.gui.dock.common.intern;

import java.awt.Component;

import bibliothek.gui.DockController;
import bibliothek.gui.DockFrontend;
import bibliothek.gui.dock.FlapDockStation;
import bibliothek.gui.dock.ScreenDockStation;
import bibliothek.gui.dock.SplitDockStation;
import bibliothek.gui.dock.common.CControl;
import bibliothek.gui.dock.common.intern.station.CFlapDockStation;
import bibliothek.gui.dock.common.intern.station.CScreenDockStation;
import bibliothek.gui.dock.common.intern.station.CSplitDockStation;
import bibliothek.gui.dock.common.intern.station.CommonDockStation;
import bibliothek.gui.dock.common.intern.station.CommonStationDelegate;
import bibliothek.gui.dock.util.WindowProvider;

/**
 * A factory creating various elements that are needed in a {@link CControl}
 * and its associated components.
 * @author Benjamin Sigg
 */
public interface CControlFactory {
    /**
     * Creates or gets the {@link DockController}.
     * @param owner the control for which the result of this method will be used
     * @return the new controller
     */
    public DockController createController( CControl owner );
    
    /**
     * Creates a new {@link DockFrontend} that will be used by owner. 
     * @param owner the owner
     * @param controller the controller to be used by the new frontend
     * @return the new frontend
     */
    public CDockFrontend createFrontend( CControlAccess owner, DockController controller );
    
    /**
     * Creates a new register that keeps track of all the elements shown and
     * used by owner.
     * @param owner the owner of the register
     * @return the new register
     */
    public MutableCControlRegister createRegister( CControl owner );
    
    /**
     * Creates a new {@link FlapDockStation}.
     * @param expansion a {@link Component} which will be some parent of
     * the result, the {@link FlapDockStation#getExpansionBounds()} should 
     * act as if expansion were the whole station
     * @param delegate some methods that can be used by the created station
     * @return the new station
     */
    public CommonDockStation createFlapDockStation( Component expansion, CommonStationDelegate delegate );
    
    /**
     * Creates a new {@link ScreenDockStation}.
     * @param owner the owner of the dialogs of the station
     * @param delegate some methods that can be used by the created station
     * @return the new station
     */
    public CommonDockStation createScreenDockStation( WindowProvider owner, CommonStationDelegate delegate );
    
    /**
     * Creates a new {@link SplitDockStation} that implements {@link CommonDockable}
     * as well.
     * @param delegate some methods that can be used by the created station
     * @return the new station
     */
    public CommonDockStation createSplitDockStation( CommonStationDelegate delegate );
}