bibliothek.gui.dock.common.SingleCDockable 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

DockingFrames is an open source Java Swing docking framework, licenced under LGPL 2.1. This is the same distribution as the original distribution (http://www.docking-frames.org/), only reinstalled in maven

There is a newer version: 1.1.2p20b.fix-1

Show 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;

import bibliothek.gui.dock.common.intern.CDockable;

/**
 * A SingleCDockable is a dockable which is added once to
 * the {@link CControl} and remains there until it is removed by the application.
 * A SingleCDockable is never removed automatically from the
 * {@link CControl}.

 * 
 * If a {@link SingleCDockable} is missing when the {@link CControl} loads a layout, then a new Dockable can be created using
 * a {@link SingleCDockableFactory}. If no such factory is present, no Dockable is shown
 * No two {@link SingleCDockable} can have the same id if they are added to the same {@link CControl}
 * When saving a layout, only the unique id of a {@link SingleCDockable} is written out. Everything else has
 * to be saved by the client itself.
 * 
 * @author Benjamin Sigg
 */
public interface SingleCDockable extends CDockable{
	
	/**
	 * Gets the id of this dockable. The id is unique if among all dockables
	 * which are added to the same {@link CControl}.
	 * @return the unique id
	 */
	public String getUniqueId();
}