/*
 * (c) Copyright 2010-2011 AgileBirds
 *
 * This file is part of OpenFlexo.
 *
 * OpenFlexo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OpenFlexo 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenFlexo. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package org.openflexo.fge.controller;

import java.awt.event.MouseEvent;
import java.util.logging.Logger;

import org.openflexo.fge.GraphicalRepresentation;

public abstract class MouseClickControlAction extends MouseControlAction {

	static final Logger logger = Logger.getLogger(MouseClickControlAction.class.getPackage().getName());

	public static enum MouseClickControlActionType {
		NONE, SELECTION, MULTIPLE_SELECTION, CONTINUOUS_SELECTION, CUSTOM;

		protected MouseClickControlAction makeAction() {
			if (this == NONE) {
				return new None();
			} else if (this == SELECTION) {
				return new SelectionAction();
			} else if (this == MULTIPLE_SELECTION) {
				return new MultipleSelectionAction();
			} else if (this == CONTINUOUS_SELECTION) {
				return new ContinuousSelectionAction();
			} else if (this == CUSTOM) {
				return new CustomClickControlAction() {
					@Override
					public boolean handleClick(GraphicalRepresentation<?> graphicalRepresentation, DrawingController<?> controller,
							MouseEvent event) {
						logger.info("Perform undefined CUSTOM MouseClickControlAction");
						return true;
					}
				};
			}
			return null;
		}
	}

	public abstract MouseClickControlActionType getActionType();

	/**
	 * Handle click event, by performing what is required here Return flag indicating if event has been correctely handled and thus, should
	 * be consumed.
	 * 
	 * @param graphicalRepresentation
	 * @param controller
	 *            TODO
	 * @param event
	 *            TODO
	 * @return
	 */
	public abstract boolean handleClick(GraphicalRepresentation<?> graphicalRepresentation, DrawingController<?> controller,
			MouseEvent event);

	public static class None extends MouseClickControlAction {
		@Override
		public MouseClickControlActionType getActionType() {
			return MouseClickControlActionType.NONE;
		}

		@Override
		public boolean handleClick(GraphicalRepresentation<?> graphicalRepresentation, DrawingController<?> controller, MouseEvent event) {
			// No action
			return true;
		}
	}

}