/**
* 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.generic;
import es.eucm.ead.editor.control.CommandManager;
import es.eucm.ead.editor.model.EditorModel;
import javax.swing.JComponent;
/**
* An option in the user interface.
* <p>
* Exposes a control that can display and/or modify a piece of the underlying
* model. Titles are intended as always-visible labels. Tooltips are only
* displayed on-demand.
*
* @param <S>
*/
public interface Option<S> extends EditorModel.ModelListener {
/**
* @return the title to be used in the interface (can be null)
*/
String getTitle();
/**
* @return a component for this element
*/
JComponent getComponent(CommandManager manager);
/**
* @return the tooltiptext for the interface, to help users (should not be
* left null)
*/
String getToolTipText();
}