f@0: /*  
f@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0:   
f@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0: 
f@0:  This program is free software: you can redistribute it and/or modify
f@0:  it under the terms of the GNU General Public License as published by
f@0:  the Free Software Foundation, either version 3 of the License, or
f@0:  (at your option) any later version.
f@0: 
f@0:  This program is distributed in the hope that it will be useful,
f@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f@0:  GNU General Public License for more details.
f@0: 
f@0:  You should have received a copy of the GNU General Public License
f@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
f@0: */  
f@0: package uk.ac.qmul.eecs.ccmi.gui;
f@0: 
f@0: import java.text.MessageFormat;
f@0: import java.util.ResourceBundle;
f@0: 
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.CollectionEvent;
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.CollectionListener;
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramElement;
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramTreeNodeListener;
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.DiagramTreeNodeEvent;
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.ElementChangedEvent;
f@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.ElementChangedEvent.PropertyChangeArgs;
f@0: import uk.ac.qmul.eecs.ccmi.sound.PlayerListener;
f@0: import uk.ac.qmul.eecs.ccmi.sound.SoundEvent;
f@0: import uk.ac.qmul.eecs.ccmi.sound.SoundFactory;
f@0: import uk.ac.qmul.eecs.ccmi.speech.NarratorFactory;
f@0: 
f@0: /**
f@0:  * This class is a listener providing audio (speech + sound) feedback to changes on the 
f@0:  * model (e.g. node added, node removed, node name changed etc.) operated only on the local (so not from 
f@0:  * a tree of another user sharing the same diagram)  
f@0:  * tree it is linked to. If the source of the events is different from the local tree , then no action 
f@0:  * is performed. 
f@0:  */
f@0: public class AudioFeedback implements CollectionListener, DiagramTreeNodeListener  {
f@0: 
f@0: 	/**
f@0: 	 * Construct an {@code AudioFeedback} object linked to a {@code DiagramTree}.
f@0: 	 * 
f@0: 	 * @param tree the tree this instance is going to be linked to
f@0: 	 */
f@0: 	AudioFeedback(DiagramTree tree){
f@0: 		resources = ResourceBundle.getBundle(EditorFrame.class.getName());
f@0: 		this.tree = tree;
f@0: 	}
f@0: 	
f@0: 	@Override
f@0: 	public void elementInserted(CollectionEvent e) {
f@0: 		DiagramEventSource source = (DiagramEventSource)e.getSource();
f@0: 		if(source.isLocal() && source.type == DiagramEventSource.Type.TREE){
f@0: 			final DiagramElement diagramElement = e.getDiagramElement();
f@0: 			boolean isNode = diagramElement instanceof Node;
f@0: 			if(isNode){
f@0: 				SoundFactory.getInstance().play( SoundEvent.OK ,new PlayerListener(){
f@0: 					@Override
f@0: 					public void playEnded() {
f@0: 						NarratorFactory.getInstance().speak(MessageFormat.format(resources.getString("speech.input.node.ack"),diagramElement.spokenText()));
f@0: 					}
f@0: 				});
f@0: 			}else{
f@0: 				Edge edge = (Edge)diagramElement;
f@0: 				final StringBuilder builder = new StringBuilder();
f@0: 				for(int i=0; i<edge.getNodesNum();i++){
f@0: 					if(i == edge.getNodesNum()-1)
f@0: 						builder.append(edge.getNodeAt(i)+resources.getString("speech.input.edge.ack"));
f@0: 					else
f@0: 						builder.append(edge.getNodeAt(i)+ resources.getString("speech.input.edge.ack2"));
f@0: 				   	}
f@0: 				   	SoundFactory.getInstance().play( SoundEvent.OK, new PlayerListener(){
f@0: 				   		@Override
f@0: 				   		public void playEnded() {
f@0: 				   			NarratorFactory.getInstance().speak(builder.toString());
f@0: 				   		}
f@0: 				   });
f@0: 			}
f@0: 		}
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public void elementTakenOut(CollectionEvent e) {
f@0: 		DiagramEventSource source = (DiagramEventSource)e.getSource();
f@0: 		if(source.isLocal() && source.type == DiagramEventSource.Type.TREE){
f@0: 			final DiagramElement element = e.getDiagramElement();
f@0: 			SoundFactory.getInstance().play(SoundEvent.OK, new PlayerListener(){
f@0: 				@Override
f@0: 				public void playEnded() {
f@0: 					NarratorFactory.getInstance().speak(MessageFormat.format(resources.getString("speech.delete.element.ack"),element.spokenText(),tree.currentPathSpeech()));
f@0: 				}
f@0: 			});
f@0: 		}
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public void elementChanged(ElementChangedEvent e) {
f@0: 		DiagramEventSource source = (DiagramEventSource)e.getSource();
f@0: 		if(!source.isLocal() || source.type != DiagramEventSource.Type.TREE)
f@0: 			return;
f@0: 		String change = e.getChangeType();
f@0: 		if("name".equals(change)){
f@0: 			playOK(tree.currentPathSpeech());
f@0: 		}else if ("property.add".equals(change)){
f@0: 			PropertyChangeArgs args = (PropertyChangeArgs)e.getArguments();
f@0: 			String propertyValue = ((Node)e.getDiagramElement()).getProperties().getValues(args.getPropertyType()).get(args.getPropertyIndex());
f@0: 			playOK(MessageFormat.format(resources.getString("speech.input.property.ack"),propertyValue));
f@0: 		}else if("property.set".equals(change)){
f@0: 			playOK(tree.currentPathSpeech());
f@0: 		}else if("property.remove".equals(change)){
f@0: 			PropertyChangeArgs args = (PropertyChangeArgs)e.getArguments();
f@0: 			playOK(MessageFormat.format(resources.getString("speech.deleted.property.ack"),args.getOldValue(),tree.currentPathSpeech()));
f@0: 		}else if("property.modifiers".equals(change)){
f@0: 			playOK(tree.currentPathSpeech());
f@0: 		}else if("arrowHead".equals(change)||"endLabel".equals(change)){
f@0: 			playOK(tree.currentPathSpeech());
f@0: 		}
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public void bookmarkAdded(DiagramTreeNodeEvent evt) {
f@0: 		DiagramEventSource source = (DiagramEventSource)evt.getSource();
f@0: 		if(source.isLocal() && source.type == DiagramEventSource.Type.TREE){
f@0: 			playOK(tree.currentPathSpeech());
f@0: 		}
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public void bookmarkRemoved(DiagramTreeNodeEvent evt) {
f@0: 		DiagramEventSource source = (DiagramEventSource)evt.getSource();
f@0: 		if(source.isLocal() && source.type == DiagramEventSource.Type.TREE){
f@0: 			playOK(MessageFormat.format(
f@0: 					resources.getString("speech.delete.bookmark.ack"), 
f@0: 					evt.getValue(),
f@0: 					tree.currentPathSpeech()));
f@0: 		}
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public void notesChanged(DiagramTreeNodeEvent evt) {
f@0: 		DiagramEventSource source = (DiagramEventSource)evt.getSource();
f@0: 		if(source.isLocal() && source.type == DiagramEventSource.Type.TREE){
f@0: 			playOK(tree.currentPathSpeech());
f@0: 		}
f@0: 	}
f@0: 	
f@0: 	private void playOK(final String speech){
f@0: 		SoundFactory.getInstance().play(SoundEvent.OK, new PlayerListener(){
f@0: 			   @Override
f@0: 			   public void playEnded() {
f@0: 				   NarratorFactory.getInstance().speak(speech);
f@0: 			   }
f@0: 		   });
f@0: 	}
f@0: 
f@0: 	private ResourceBundle resources;
f@0: 	private DiagramTree tree;
f@0: }