bibliothek.gui.dock.common.perspective.CDockablePerspective 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) 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;

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

/**
 * Represents a {@link CDockable} in a {@link CPerspective}.
 * @author Benjamin Sigg
 */
public interface CDockablePerspective extends CElementPerspective{
	/**
	 * Gets the next parent of this perspective that represents a {@link CStation}. This method
	 * may jump over some parents to get to the next station.
	 * @return the next station, may be null
	 */
	public CStationPerspective getParent();
	
	/**
	 * Sets the working-area of this element. This user will not be able drag
	 * this element away from that working-area.
	 * @param workingArea the working-area, can be null
	 */
	public void setWorkingArea( CStationPerspective workingArea );
	
	/**
	 * Gets the working-area of this element
	 * @return the area, can be null
	 * @see #setWorkingArea(CStationPerspective)
	 */
	public CStationPerspective getWorkingArea();
	
	/**
	 * Gets information about the locations this dockable had in the past.
	 * @return the locations, not null
	 */
	public LocationHistory getLocationHistory();
}