bibliothek.gui.dock.DockElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docking-frames-core Show documentation
${project.name} is base or core library
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;

import bibliothek.gui.DockController;
import bibliothek.gui.DockStation;
import bibliothek.gui.Dockable;


/**
 * An element in the hierarchy of dockables and stations. Classes implementing this interface
 * must either be a {@link Dockable}, a {@link DockStation} or both of them.
 * @author Benjamin Sigg
 */
public interface DockElement {
	/**
     * Returns this if this is an instance of 
     * {@link Dockable}. Otherwise null is returned.
     * @return this or null. Must not return null if {@link #asDockable()}
     * already returns null.
     */
    public Dockable asDockable();

    /**
     * Returns this if this is an instance of 
     * {@link DockStation}. Otherwise null is returned.
     * @return this or null. Must not return null if {@link #asDockable()}
     * already returns null
     */
    public DockStation asDockStation();
    
    /**
     * Gets the controller that currently is associated with this {@link DockElement}.
     * @return the controller or null
     */
    public DockController getController();
    
    /**
     * Gets the unique name of the {@link DockFactory} which can read
     * and write elements of this type.
     * @return the id of the factory
     */
    public String getFactoryID();
}