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

${project.name} is a user-level framework

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) 2010 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.perspective;


/**
 * Represents a dockable or a station in a {@link CPerspective}.
 * @author Benjamin Sigg
 */
public interface CElementPerspective {
	/**
	 * Gets the internal representation for this element.
 
	 * If {@link #asDockable()} returns a non-null value, then intern().asDockable() must not
	 * return null either.

	 * If {@link #asStation()} returns a non-null value, then intern().asStation() must not
	 * return null either.

	 * @return the internal representation
	 */
	public CommonElementPerspective intern();
	
	/**
	 * Gets this as dockable, if this is a dockable.
	 * @return this or null
	 */
	public CDockablePerspective asDockable();
	
	/**
	 * Gets this as station, if this is a station.
	 * @return this or null
	 */
	public CStationPerspective asStation();
}