IMapInterfaceListener.java

/*******************************************************************************
 * Copyright (c) 2015
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *******************************************************************************/
package jsettlers.common.menu;

import jsettlers.common.menu.action.IAction;

/**
 * This is a map interface listener. <h2>Registering listeners</h2> At first you have to get the connector when adding the map va
 * {@link JOGLPanel#showHexMap(jsettlers.graphics.map.IHexMap)} Then you should add a listener to the connector with
 * {@link MapInterfaceConnector#addListener(MapInterfaceListener)}.
 * 
 * @author Michael Zangl
 */
public interface IMapInterfaceListener {
	/**
	 * This method gets called when the user performed an action.
	 * 
	 * @param action
	 *            The action the user performed.
	 */
	void action(IAction action);
}