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: 
f@0: package uk.ac.qmul.eecs.ccmi.gui.filechooser;
f@0: 
f@0: import java.awt.Component;
f@0: import java.awt.event.ActionEvent;
f@0: import java.awt.event.InputEvent;
f@0: import java.awt.event.KeyEvent;
f@0: import java.awt.event.MouseEvent;
f@0: import java.io.File;
f@0: import java.io.IOException;
f@0: import java.util.LinkedList;
f@0: import java.util.ResourceBundle;
f@0: 
f@0: import javax.swing.AbstractAction;
f@0: import javax.swing.JTree;
f@0: import javax.swing.KeyStroke;
f@0: import javax.swing.event.TreeSelectionEvent;
f@0: import javax.swing.event.TreeSelectionListener;
f@0: import javax.swing.filechooser.FileFilter;
f@0: import javax.swing.tree.DefaultTreeModel;
f@0: import javax.swing.tree.TreeCellRenderer;
f@0: import javax.swing.tree.TreeNode;
f@0: import javax.swing.tree.TreePath;
f@0: import javax.swing.tree.TreeSelectionModel;
f@0: 
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:  *
f@0:  * A JTree displaying the content for the local file system.
f@0:  * 
f@0:  *
f@0:  */
f@0: @SuppressWarnings("serial")
f@0: class FileSystemTree extends JTree {
f@0: 	FileSystemTree(FileFilter filter){
f@0: 		super(new DefaultTreeModel(FileSystemTreeNode.getRootNode(filter)));
f@0: 		getAccessibleContext().setAccessibleName(ResourceBundle.getBundle(SpeechFileChooser.class.getName()).getString("tree.accessible_name"));
f@0: 		getSelectionModel().setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
f@0: 		setCellRenderer(new FileSystemTreeCellRendered(getCellRenderer()));
f@0: 
f@0: 		setSelectionPath(new TreePath(getModel().getRoot()));
f@0: 		overwriteTreeKeystrokes();
f@0: 		this.addTreeSelectionListener(new TreeSelectionListener(){
f@0: 			@Override
f@0: 			public void valueChanged(TreeSelectionEvent evt) {
f@0: 				if(treeSelectionListenerGateOpen){
f@0: 					FileSystemTreeNode treeNode = (FileSystemTreeNode)evt.getPath().getLastPathComponent();
f@0: 					NarratorFactory.getInstance().speak(treeNode.spokenText());
f@0: 				}
f@0: 			}
f@0: 		});
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public void setSelectionPath(TreePath path){
f@0: 		super.setSelectionPath(path);
f@0: 		scrollPathToVisible(path);
f@0: 		getSelectionPath();
f@0: 	}
f@0: 	
f@0: 	public void setSelectionPath(File file){
f@0: 		if(file == null)
f@0: 			return;
f@0: 		
f@0: 		try {
f@0: 			file = file.getCanonicalFile();
f@0: 		} catch (IOException e) {
f@0: 			setSelectionPath(new TreePath(getModel().getRoot()));
f@0: 			return;
f@0: 		}
f@0: 		/* make a file path: a list of file's each one representing a directory of file's path */
f@0: 		LinkedList<File> filePath = new LinkedList<File>();
f@0: 		filePath.add(file);
f@0: 		File parent = file.getParentFile();
f@0: 		while(parent != null){
f@0: 			filePath.add(0, parent);
f@0: 			parent = parent.getParentFile();
f@0: 		}
f@0: 		/* make a TreePath out of the file path */
f@0: 		FileSystemTreeNode currentNode = (FileSystemTreeNode)getModel().getRoot();
f@0: 		TreePath treePath = new TreePath(currentNode);
f@0: 		for(File f : filePath){
f@0: 			boolean found = false;
f@0: 			for(int i=0;i<currentNode.getChildCount();i++){
f@0: 				if(currentNode.getChildAt(i).getFile().equals(f)){
f@0: 					currentNode = currentNode.getChildAt(i);
f@0: 					treePath = treePath.pathByAddingChild(currentNode);
f@0: 					found = true;
f@0: 					break;
f@0: 				}
f@0: 			}
f@0: 			if(!found)
f@0: 				break;
f@0: 		}
f@0: 		treeSelectionListenerGateOpen = false;
f@0: 		setSelectionPath(treePath);
f@0: 		treeSelectionListenerGateOpen = true;
f@0: 	}
f@0: 
f@0: 	public void applyFilter(FileFilter filter){
f@0: 		FileSystemTreeNode selectedNode = (FileSystemTreeNode)getSelectionPath().getLastPathComponent();
f@0: 		File file = selectedNode.getFile();
f@0: 		treeSelectionListenerGateOpen = false;
f@0: 		((DefaultTreeModel)getModel()).setRoot(FileSystemTreeNode.getRootNode(filter));
f@0: 		treeSelectionListenerGateOpen = true;
f@0: 		if(file == null)
f@0: 			setSelectionPath(new TreePath(getModel().getRoot()));
f@0: 		else
f@0: 			setSelectionPath(file);
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	protected  void	processMouseEvent(MouseEvent e){
f@0: 		//do nothing as the tree does not have to be editable with mouse
f@0: 	}
f@0: 
f@0: 	private void overwriteTreeKeystrokes() {
f@0: 		/* overwrite the keys. up and down arrow are overwritten so that it loops when the top and the  */
f@0: 		/* bottom are reached rather than getting stuck                                                 */ 
f@0: 
f@0: 		/* Overwrite keystrokes up,down,left,right arrows and space, shift, ctrl */
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_DOWN,0),"down");
f@0: 		getActionMap().put("down", new AbstractAction(){
f@0: 			@Override
f@0: 			public void actionPerformed(ActionEvent evt) {
f@0: 				FileSystemTreeNode treeNode = (FileSystemTreeNode)getLastSelectedPathComponent();
f@0: 				/* look if we've got a sibling node after (we are not at the bottom) */
f@0: 				FileSystemTreeNode nextTreeNode = treeNode.getNextSibling(); 
f@0: 				SoundEvent loop = null;
f@0: 				if(nextTreeNode == null){
f@0: 					TreeNode parent = treeNode.getParent();
f@0: 					if(parent == null) /* root node, just stay there */
f@0: 						nextTreeNode = treeNode;
f@0: 					else /* loop = go to first child of own parent */
f@0: 						nextTreeNode = (FileSystemTreeNode)parent.getChildAt(0);
f@0: 					loop = SoundEvent.LIST_BOTTOM_REACHED;
f@0: 				}
f@0: 
f@0: 				final String speech = nextTreeNode.spokenText(); 
f@0: 				treeSelectionListenerGateOpen = false;
f@0: 				setSelectionPath(new TreePath(nextTreeNode.getPath()));
f@0: 				treeSelectionListenerGateOpen = true;
f@0: 				SoundFactory.getInstance().play(loop, new PlayerListener(){
f@0: 					public void playEnded() {
f@0: 						NarratorFactory.getInstance().speak(speech);
f@0: 					}
f@0: 				});
f@0: 			}});
f@0: 
f@0: 		/* Overwrite keystrokes up,down,left,right arrows and space, shift, ctrl */
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_UP,0),"up");
f@0: 		getActionMap().put("up", new AbstractAction(){
f@0: 			@Override
f@0: 			public void actionPerformed(ActionEvent evt) {
f@0: 				FileSystemTreeNode treeNode = (FileSystemTreeNode)getLastSelectedPathComponent();
f@0: 				/* look if we've got a sibling node after (we are not at the bottom) */
f@0: 				FileSystemTreeNode peviousTreeNode = treeNode.getPreviousSibling(); 
f@0: 				SoundEvent loop = null;
f@0: 				if(peviousTreeNode == null){
f@0: 					TreeNode parent = treeNode.getParent();
f@0: 					if(parent == null) /* root node, just stay there */
f@0: 						peviousTreeNode = treeNode;
f@0: 					else /* loop = go to first child of own parent */
f@0: 						peviousTreeNode = (FileSystemTreeNode)parent.getChildAt(parent.getChildCount()-1);
f@0: 					loop = SoundEvent.LIST_TOP_REACHED;
f@0: 				}
f@0: 
f@0: 				final String speech = peviousTreeNode.spokenText();
f@0: 				treeSelectionListenerGateOpen = false;
f@0: 				setSelectionPath(new TreePath(peviousTreeNode.getPath()));
f@0: 				treeSelectionListenerGateOpen = true;
f@0: 				SoundFactory.getInstance().play(loop, new PlayerListener(){
f@0: 					public void playEnded() {
f@0: 						NarratorFactory.getInstance().speak(speech);
f@0: 					}
f@0: 				});
f@0: 			}});
f@0: 
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_LEFT,0),"left");
f@0: 		getActionMap().put("left", new AbstractAction(){
f@0: 			@Override
f@0: 			public void actionPerformed(ActionEvent evt) {
f@0: 				TreePath path = getSelectionPath();
f@0: 				TreeNode treeNode = (TreeNode)path.getLastPathComponent();
f@0: 				final FileSystemTreeNode parent = (FileSystemTreeNode)treeNode.getParent();
f@0: 				if(parent == null){/* root node */
f@0: 					SoundFactory.getInstance().play(SoundEvent.ERROR);
f@0: 				}
f@0: 				else{
f@0: 					TreePath newPath = new TreePath(parent.getPath());
f@0: 					treeSelectionListenerGateOpen = false;
f@0: 					setSelectionPath(newPath);
f@0: 					collapsePath(newPath);
f@0: 					treeSelectionListenerGateOpen = true;
f@0: 					SoundFactory.getInstance().play(SoundEvent.TREE_NODE_COLLAPSE,new PlayerListener(){
f@0: 						@Override
f@0: 						public void playEnded() {
f@0: 							NarratorFactory.getInstance().speak(parent.spokenText());
f@0: 						}
f@0: 					});
f@0: 				}
f@0: 			}
f@0: 		});
f@0: 
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_RIGHT,0),"right");
f@0: 		getActionMap().put("right", new AbstractAction(){
f@0: 			@Override
f@0: 			public void actionPerformed(ActionEvent evt) {
f@0: 				TreePath path = getSelectionPath();
f@0: 				TreeNode treeNode = (TreeNode)path.getLastPathComponent();
f@0: 				if(treeNode.isLeaf()){/* leaf node */
f@0: 					SoundFactory.getInstance().play(SoundEvent.ERROR);
f@0: 				}
f@0: 				else{
f@0: 					expandPath(path);
f@0: 					final FileSystemTreeNode firstChild = (FileSystemTreeNode)treeNode.getChildAt(0); 
f@0: 					treeSelectionListenerGateOpen = false;
f@0: 					setSelectionPath(new TreePath(firstChild.getPath()));
f@0: 					treeSelectionListenerGateOpen = true;
f@0: 					SoundFactory.getInstance().play(SoundEvent.TREE_NODE_EXPAND,new PlayerListener(){
f@0: 						@Override
f@0: 						public void playEnded() {
f@0: 							NarratorFactory.getInstance().speak(firstChild.spokenText());
f@0: 						}
f@0: 					});
f@0: 				}
f@0: 			}
f@0: 		});
f@0: 
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE,0),"space");
f@0: 		getActionMap().put("space",new AbstractAction(){
f@0: 			@Override
f@0: 			public void actionPerformed(ActionEvent evt) {
f@0: 				TreePath path = getSelectionPath();
f@0: 				FileSystemTreeNode treeNode = (FileSystemTreeNode)path.getLastPathComponent();
f@0: 				NarratorFactory.getInstance().speak(treeNode.toString());
f@0: 			}
f@0: 		});
f@0: 		
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE,InputEvent.CTRL_DOWN_MASK), "ctrl_space");
f@0: 		getActionMap().put("ctrl_space", new AbstractAction(){
f@0: 			@Override
f@0: 			public void actionPerformed(ActionEvent evt) {
f@0: 				TreePath path = getSelectionPath();
f@0: 				FileSystemTreeNode treeNode = (FileSystemTreeNode)path.getLastPathComponent();
f@0: 				NarratorFactory.getInstance().speak(treeNode.getFile().getPath());
f@0: 			}
f@0: 		});
f@0: 		/* make the tree ignore the page up and page down keys */
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_PAGE_UP,0),"none");
f@0: 		getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_PAGE_DOWN,0),"none");
f@0: 	}
f@0: 	private boolean treeSelectionListenerGateOpen;
f@0: }
f@0: 
f@0: /**
f@0:  * This class  overwrites the default cell renderer in order to always render directories with a  
f@0:  * directory-icon regardless whether they are a leaf node or not. 
f@0:  *
f@0:  */
f@0: class FileSystemTreeCellRendered implements TreeCellRenderer {
f@0: 	FileSystemTreeCellRendered(TreeCellRenderer delegate){
f@0: 		this.delegate = delegate;
f@0: 	}
f@0: 
f@0: 	@Override
f@0: 	public Component getTreeCellRendererComponent(JTree tree, Object value, boolean selected, 
f@0: 			boolean expanded, boolean leaf, int row, boolean hasFocus)  {
f@0: 		if(leaf && ((FileSystemTreeNode)value).getFile().isDirectory() )
f@0: 			return delegate.getTreeCellRendererComponent(tree, value, selected, expanded, false, row, hasFocus);
f@0: 		return delegate.getTreeCellRendererComponent(tree, value, selected, expanded, leaf, row, hasFocus);
f@0: 	}
f@0: 
f@0: 	TreeCellRenderer delegate;
f@0: }