ComponentInputProcessorSupport.java

/***********************************************************************
 * mt4j Copyright (c) 2008 - 2009 Christopher Ruff, Fraunhofer-Gesellschaft All rights reserved.
 *  
 *   This program 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.
 *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ***********************************************************************/
package org.mt4j.input;

import java.util.ArrayList;
import java.util.Collections;

import org.mt4j.components.MTComponent;
import org.mt4j.input.inputData.MTInputEvent;
import org.mt4j.input.inputProcessors.componentProcessors.AbstractComponentProcessor;

import processing.core.PApplet;

/**
 * The Class ComponentInputProcessorSupport. Keeps the list of registered component input processors for
 * one component and sorts them by locking priority.
 * 
 * @author Christopher Ruff
 */
public class ComponentInputProcessorSupport implements IMTInputEventListener /*, IGestureEventListener*/ {
	
	/** The registered processors. */
	private ArrayList<AbstractComponentProcessor> registeredProcessors;
	
	/** The associated component. */
	private MTComponent associatedComponent;
	
	/**
	 * Instantiates a new component input processor support.
	 *
	 * @param graphicsContext the graphics context
	 * @param associatedComponent the associated component
	 */
	public ComponentInputProcessorSupport(PApplet graphicsContext, MTComponent associatedComponent) {
		this.associatedComponent = associatedComponent;
		this.registeredProcessors = new ArrayList<AbstractComponentProcessor>(5);
	}


	/* (non-Javadoc)
	 * @see org.mt4j.input.IMTInputEventListener#processInputEvent(org.mt4j.input.inputData.MTInputEvent)
	 */
	public boolean processInputEvent(MTInputEvent inEvt){
		boolean handled = false;
		int pCount = registeredProcessors.size();
		int i = 0;
		
		//Call preProcess() on _all_ processors before calling processInputEvent on each of them
		//to allow each processor to take part in the locking mechanism before anyone actually locks something
		for (i = 0; i < pCount; i++) {
			AbstractComponentProcessor inputProcessor = registeredProcessors.get(i);
			if (inputProcessor.isInterestedIn(inEvt) && this.associatedComponent.isGestureAllowed(inputProcessor.getClass())){
				inputProcessor.preProcess(inEvt);
			}
		}
		
		for (i = 0; i < pCount; i++) {
			AbstractComponentProcessor inputProcessor = registeredProcessors.get(i);
			if (inputProcessor.isInterestedIn(inEvt) && this.associatedComponent.isGestureAllowed(inputProcessor.getClass())){
				handled = true;
				inputProcessor.processInputEvent(inEvt); //process events
			}
		}
		return handled;
	}
	
	
	/**
	 * Register input processor.
	 *
	 * @param inputProcessor the input processor
	 */
	public synchronized void registerInputProcessor(AbstractComponentProcessor inputProcessor){
		if (!this.registeredProcessors.contains(inputProcessor)){
			this.registeredProcessors.add(inputProcessor);
			
			//Sort the list so that the cursor processors
			//with the highest locking priority get served first
			Collections.sort(registeredProcessors,  Collections.reverseOrder());
			
			//-maybe put all this back to mtcomp?
			inputProcessor.addGestureListener(associatedComponent);
		}
	}
	
	/**
	 * Unregister input processor.
	 *
	 * @param inputProcessor the input processor
	 */
	public synchronized void unregisterInputProcessor(AbstractComponentProcessor inputProcessor){
		if (this.registeredProcessors.contains(inputProcessor)){
			this.registeredProcessors.remove(inputProcessor);
		}
	}
	
	/**
	 * Gets the input processors.
	 *
	 * @return the input processors
	 */
	public AbstractComponentProcessor[] getInputProcessors(){
		return this.registeredProcessors.toArray(new AbstractComponentProcessor[this.registeredProcessors.size()]);
	}
	
	

}