comparison java/src/uk/ac/qmul/eecs/ccmi/gui/DiagramTree.java @ 2:4b2f975e35fa

Minor Bug fixes

 import javax.swing.JOptionPane;
 import javax.swing.JTree;
 import javax.swing.KeyStroke;
 import javax.swing.event.TreeModelEvent;
 import javax.swing.event.TreeModelListener;
-import javax.swing.event.TreeSelectionEvent;
-import javax.swing.event.TreeSelectionListener;
 import javax.swing.tree.DefaultMutableTreeNode;
 import javax.swing.tree.TreeNode;
 import javax.swing.tree.TreePath;
 import javax.swing.tree.TreeSelectionModel;
 

 		collapsePath(rootPath);
 		selectedNodes = new ArrayList<Node>();
 		setEditable(false);
 	    getSelectionModel().setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
 	    overwriteTreeKeystrokes();
-	    this.addTreeSelectionListener(new TreeSelectionListener(){
-	    	@Override
-	    	public void valueChanged(TreeSelectionEvent evt) {
-	    		if(treeSelectionListenerGateOpen){
-	    			final DiagramModelTreeNode treeNode = (DiagramModelTreeNode)evt.getPath().getLastPathComponent();
-	    			if(treeNode instanceof DiagramElement){
-	    				SoundFactory.getInstance().play(((DiagramElement)treeNode).getSound(), new PlayerListener(){
-	    					@Override
-	    					public void playEnded() {
-	    						NarratorFactory.getInstance().speak(treeNode.spokenText());
-	    					}
-	    				});
-	    			}else{
-	    				NarratorFactory.getInstance().speak(treeNode.spokenText());
-	    			}
-	    		}
-	    	}
-		});
 	    /* don't use the swing focus system as we provide one on our own */
 	    setFocusTraversalKeysEnabled(false);
 	    getAccessibleContext().setAccessibleName("");
 	}
 	

 	 * to the related edge/node itself
 	 */
 	public void jump(JumpTo jumpTo){
 		final Narrator narrator = NarratorFactory.getInstance();
 		TreePath oldPath;
-		treeSelectionListenerGateOpen = false;
 		switch(jumpTo){
 		case REFERENCE :
 			oldPath = getSelectionPath();
 			DiagramModelTreeNode selectedTreeNode = (DiagramModelTreeNode)oldPath.getLastPathComponent();
 			if(selectedTreeNode instanceof NodeReferenceMutableTreeNode){

 					initialValue);
 			if(selectedValue == null){
 				/* it speaks anyway as we set up the playerListener in the EditorFrame class. No need to use narrator then */
 				SoundFactory.getInstance().play(SoundEvent.CANCEL);
 				InteractionLog.log(INTERACTIONLOG_SOURCE,"cancel select type to jump dialog","");
-				treeSelectionListenerGateOpen = true;
 				return;
 			}
 			/* we search in the root which type tree node has getName() equal to the selected one */
 			TypeMutableTreeNode typeNode = null;
 			for(int i = 0; i< root.getChildCount(); i++){

 			
 			if(treeModel.getBookmarks().size() == 0){
 				SoundFactory.getInstance().play(SoundEvent.ERROR ,new PlayerListener(){
 					   @Override
 					   public void playEnded() {
-						   narrator.speak("speech.no_bookmarks");
+						   narrator.speak(resources.getString("speech.no_bookmarks"));
 					   }
 				   });
 				InteractionLog.log(INTERACTIONLOG_SOURCE,"no bookmarks available","");
-				treeSelectionListenerGateOpen = true;
 				return;
 			}
 
 			String[] bookmarkArray = new String[treeModel.getBookmarks().size()];
 			bookmarkArray = treeModel.getBookmarks().toArray(bookmarkArray);

 				InteractionLog.log(INTERACTIONLOG_SOURCE,"bookmark selected",bookmark);
 			}else{
 				/* it speaks anyway, as we set up the speech in the EditorFrame class. no need to use the narrator then */
 				SoundFactory.getInstance().play(SoundEvent.CANCEL);
 				InteractionLog.log(INTERACTIONLOG_SOURCE,"cancel select bookmark dialog","");
-				treeSelectionListenerGateOpen = true;
 				return;
 			}
 			break;
 			
 		}
 		InteractionLog.log(INTERACTIONLOG_SOURCE,"jumped to "+jumpTo.toString(),((DiagramModelTreeNode)getSelectionPath().getLastPathComponent()).getName());
 		SoundFactory.getInstance().play(SoundEvent.JUMP);
-		treeSelectionListenerGateOpen = true;
 	}
 	
 	public void jumpTo(final DiagramElement de){
 		TreePath oldPath = getSelectionPath();
 		collapseAll((DiagramModelTreeNode)oldPath.getLastPathComponent(),de);
 		setSelectionPath(new TreePath(de.getPath()));
-		treeSelectionListenerGateOpen = false;
 		SoundFactory.getInstance().play( SoundEvent.JUMP, new PlayerListener(){
 			@Override
 			public void playEnded() {
 				NarratorFactory.getInstance().speak(MessageFormat.format(resources.getString("speech.jump"),de.spokenText()));
 			}
 		});
-		treeSelectionListenerGateOpen = true;
 	}
 	
 	/* collapse all the nodes in the path from "from" to "to" upwards(with the same direction as going from a leaf to the root)*/
 	private void collapseAll(DiagramModelTreeNode from, DiagramModelTreeNode to){
 		DiagramModelTreeNode currentNode = from;

 	}
 	
 	@Override
 	protected  void	processMouseEvent(MouseEvent e){
 		//do nothing as the tree does not have to be editable with mouse
+	}
+	
+	@Override
+	protected void processKeyEvent(KeyEvent e){
+		/* allow only cursor keys, tab key, delete, and actions (CTRL+something) */
+		if(e.getKeyChar() == KeyEvent.CHAR_UNDEFINED 
+				|| e.getKeyCode() == KeyEvent.VK_TAB
+					|| e.getKeyCode() == KeyEvent.VK_SPACE
+						|| e.getKeyCode() == KeyEvent.VK_DELETE
+				 			|| e.isControlDown()
+				 				|| e.isAltDown())
+			super.processKeyEvent(e);
 	}
 	
 	private void overwriteTreeKeystrokes() {
 		   /* overwrite the keys. up and down arrow are overwritten so that it loops when the top and the  */
 		   /* bottom are reached rather than getting stuck                               */ 

 							nextTreeNode = treeNode;
 						else /* loop = go to first child of own parent */
 							nextTreeNode = (DiagramModelTreeNode)parent.getFirstChild();
 						loop = SoundEvent.LIST_BOTTOM_REACHED;
 					}
-					treeSelectionListenerGateOpen = false;
 					setSelectionPath(new TreePath(nextTreeNode.getPath()));
 					final InputStream finalSound  = getTreeNodeSound(nextTreeNode);
 					final String currentPathSpeech = currentPathSpeech();
 					SoundFactory.getInstance().play(loop, new PlayerListener(){
 						public void playEnded() {
 							SoundFactory.getInstance().play(finalSound);
 							NarratorFactory.getInstance().speak(currentPathSpeech);
 						}
 					});
-					treeSelectionListenerGateOpen = true;
 					InteractionLog.log(INTERACTIONLOG_SOURCE,"move down",nextTreeNode.toString());
 				}});
 		   
 		   getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_UP,0),"up");
 		   getActionMap().put("up", new AbstractAction(){

 							previousTreeNode = treeNode;
 						else 
 							previousTreeNode = (DiagramModelTreeNode)parent.getLastChild();
 						loop = SoundEvent.LIST_TOP_REACHED;
 					}
-					treeSelectionListenerGateOpen = false;
 					setSelectionPath(new TreePath(previousTreeNode.getPath()));
 					final InputStream finalSound  = getTreeNodeSound(previousTreeNode);
 					final String currentPathSpeech = currentPathSpeech();
 					SoundFactory.getInstance().play(loop, new PlayerListener(){
 						public void playEnded() {
 							SoundFactory.getInstance().play(finalSound);
 							NarratorFactory.getInstance().speak(currentPathSpeech);
 						}
 					});
-					treeSelectionListenerGateOpen = true;
 					InteractionLog.log(INTERACTIONLOG_SOURCE,"move up",previousTreeNode.toString());
 				}});
 		   
 		   getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_RIGHT,0),"right");
 		   getActionMap().put("right", new AbstractAction(){

 				   if(treeNode.isLeaf()){
 					   notifyBorderReached(treeNode);
 					   InteractionLog.log(INTERACTIONLOG_SOURCE,"move right","border reached");
 				   }
 				   else{
-					   treeSelectionListenerGateOpen = false;
 					   expandPath(path);
 					   setSelectionPath(new TreePath(((DiagramModelTreeNode)treeNode.getFirstChild()).getPath()));
 					   final String currentPathSpeech = currentPathSpeech();
 					   SoundFactory.getInstance().play(SoundEvent.TREE_NODE_EXPAND,new PlayerListener(){
 						@Override
 						public void playEnded() {
 							NarratorFactory.getInstance().speak(currentPathSpeech);
 						}
 					   });
-					   treeSelectionListenerGateOpen = true;
 					   InteractionLog.log(INTERACTIONLOG_SOURCE,"move right",((DiagramModelTreeNode)treeNode.getFirstChild()).toString());
 				   }
 			   }
 		   });
 		   

 				   if(parent == null){/* root node */
 					   notifyBorderReached(treeNode);
 					   InteractionLog.log(INTERACTIONLOG_SOURCE,"move left","border reached");
 				   }
 				   else{
-					   treeSelectionListenerGateOpen = false;
 					   TreePath newPath = new TreePath(((DiagramModelTreeNode)parent).getPath());
 					   setSelectionPath(newPath);
 					   collapsePath(newPath);
 					   final String currentPathSpeech = currentPathSpeech(); 
 					   SoundFactory.getInstance().play(SoundEvent.TREE_NODE_COLLAPSE,new PlayerListener(){

 							public void playEnded() {
 								NarratorFactory.getInstance().speak(currentPathSpeech);
 							}
 					   });
 					   InteractionLog.log(INTERACTIONLOG_SOURCE,"move left",((DiagramModelTreeNode)parent).toString());
-					   treeSelectionListenerGateOpen = true;
 				   }
 			   }
 		   });
 		   
 		   getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE,0),"space");

 	
 
 	private List<Node> selectedNodes;
 	private Diagram diagram;
 	private ResourceBundle resources;
-	private boolean treeSelectionListenerGateOpen;
 	private static final char SELECTED_NODE_MARK_BEGIN = '<';
 	private static final char SELECTED_NODE_MARK_END = '>';
 	private static final String INTERACTIONLOG_SOURCE = "TREE";
 	static enum JumpTo {REFERENCE, ROOT, TYPE, SELECTED_TYPE, BOOKMARK}