/* 
 * This file is part of the Echo Point Project.  This project is a collection
 * of Components that have extended the Echo Web Application Framework.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */
package echopointng.able;

import echopointng.model.ExpansionGroup;
import echopointng.model.ExpansionModel;

/** 
 * An <code>Expandable</code> can be expanded/contracted and tracks this
 * change with an <code>ExpansionModel</code>. 
 */

public interface Expandable {
	/** can be fired when the expnasion model changes */
	public final static String EXPANDED_CHANGED_PROPERTY = "expanded";

	public final static String PROPERTY_EXPANSION_MODEL = "expansionModel";
	public final static String PROPERTY_EXPANSION_GROUP = "expansionGroup";

	/** 
	 * @return the <code>ExpansionModel</code> model of the <code>Expandable</code>.
	 */
	public abstract ExpansionModel getExpansionModel();

	/** 
	 * @return the <code>ExpansionGroup</code> of the <code>Expandable</code>.
	 */
	public abstract ExpansionGroup getExpansionGroup();

	/** 
	 * @return whether <code>Expandable</code> is expanded or not
	 */
	public abstract boolean isExpanded();

	/**
	 * Sets whether the <code>Expandable</code> is expanded or not 
	 */
	public abstract void setExpanded(boolean isExpanded);

	/**
	 * Sets the <code>ExpansionModel</code> model used by the <code>Expandable</code>.
	 */
	public abstract void setExpansionModel(ExpansionModel newExpansionModel);

	/**
	 * Sets the <code>ExpansionGroup</code> used by the <code>Expandable</code>.
	 */
	public abstract void setExpansionGroup(ExpansionGroup newExpansionGroup);

}