ElementPanel.java

/**
 * eAdventure (formerly <e-Adventure> and <e-Game>) is a research project of the
 *    <e-UCM> research group.
 *
 *    Copyright 2005-2010 <e-UCM> research group.
 *
 *    You can access a list of all the contributors to eAdventure at:
 *          http://e-adventure.e-ucm.es/contributors
 *
 *    <e-UCM> is a research group of the Department of Software Engineering
 *          and Artificial Intelligence at the Complutense University of Madrid
 *          (School of Computer Science).
 *
 *          C Profesor Jose Garcia Santesmases sn,
 *          28040 Madrid (Madrid), Spain.
 *
 *          For more info please visit:  <http://e-adventure.e-ucm.es> or
 *          <http://www.e-ucm.es>
 *
 * ****************************************************************************
 *
 *  This file is part of eAdventure, version 2.0
 *
 *      eAdventure 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 3 of the License, or
 *      (at your option) any later version.
 *
 *      eAdventure 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 eAdventure.  If not, see <http://www.gnu.org/licenses/>.
 */

package es.eucm.ead.editor.view.dock;

import es.eucm.ead.editor.control.Controller;
import es.eucm.ead.editor.model.nodes.DependencyNode;

/**
 * Minimal interface for a panel that displays DependencyNodes.
 * @author mfreire
 */
public interface ElementPanel<E extends DependencyNode> {

	/**
	 * Called before setTarget to establish the controller that manages this
	 * elementPanel.
	 */
	void setController(Controller controller);

	/**
	 * Sets the target of this ElementPanel.
	 * @param target to set. After setTarget, the interface should be
	 * rebuilt from scratch. Any model listeners should be registered here.
	 */
	void setTarget(E target);

	/**
	 * @return the backing target of this ElementPanel.
	 */
	E getTarget();

	/**
	 * Called to release resources on target change or closing up.
	 * This is specially important to prevent "listener pollution".
	 */
	void cleanup();
}