Merge pull request #91 from ProgrammingLife3/fix/bettercontrolmenu

Fix/bettercontrolmenu

Author: kwendel

src/main/java/tudelft/ti2806/pl3/Constants.java

@@ -1,6 +1,7 @@
 package tudelft.ti2806.pl3;
 
 /**
+ * Constants contains every string used in the GUI.
  * Created by Mathieu Post on 17-6-15.
  */
 public class Constants {
@@ -10,6 +11,7 @@ public class Constants {
 	public static final char MINUS = '-';
 	public static final char ARROW_RIGHT = '\u2192';
 	public static final char ARROW_LEFT = '\u2190';
+	public static final String SPACE = "Space";
 
 	// Name of the application.
 	public static final String APP_NAME = "Helix" + POWER;
@@ -28,7 +30,11 @@ public class Constants {
 			+ "- Kasper Wendel\n"
 			+ "\n"
 			+ "The code of this application is open source and can be found on GitHub: \n";
-	public static final String INFO_CONTROLS = APP_NAME + " uses key shortcuts to make life easier. "
+	public static final String INFO_CONTROLS = "To achieve semantic zooming " + APP_NAME
+			+ " combines nodes to new nodes, we call it wrapping."
+			+ "When a node has a square icon it means that it can unwrap to more nodes. "
+			+ "If it has a circle icon it's fully unwrapped.\n"
+			+ APP_NAME + " uses key shortcuts to make life easier. "
 			+ "All the controls that can be used are listed below. \n"
 			+ "\n"
 			+ "Zooming in     \t " + PLUS + " \n"
@@ -37,10 +43,11 @@ public class Constants {
 			+ "Move the view to the left \t " + ARROW_LEFT + " \n"
 			+ "Move the view to the right \t " + ARROW_RIGHT + " \n"
 			+ "Gene navigation window \t G \n"
-			+ "Hide/show phylogenetic tree window \t spacebar \n"
+			+ "Hide/show phylogenetic tree window \t " + SPACE + " \n"
 			+ "\n"
 			+ "All of the menus can be controlled with the underlined letter, "
 			+ "hold the ALT key to activate this.";
+
 	public static final String INFO_GITHUB_URL = "https://github.com/ProgrammingLife3/ProgrammingLife3";
 
 	// Menu constants.
@@ -60,6 +67,7 @@ public class Constants {
 	public static final String MENU_VIEW_RESET = "Reset view";
 	public static final String MENU_VIEW_NAVIGATE_TO_GENE = "Navigate to gene";
 	public static final String MENU_VIEW_METADATA = "Filter on metadata";
+	public static final String MENU_VIEW_PYLO = "Phylogenetic view";
 
 	public static final String MENU_HELP = "Help";
 	public static final String MENU_HELP_CONTROLS = "Controls";
@@ -68,4 +76,10 @@ public class Constants {
 	public static final String DIALOG_ERROR = "Error!";
 	public static final String DETAILVIEW_GENOMES = "Genomes:";
 	public static final String DETAILVIEW_LABELS = "Labels:";
+
+	// Phylogenetic view constants.
+	public static final String PHYLO_WINDOW_TITLE = "Select Genomes";
+	public static final String PHYLO_BUTTON_LABEL_UPDATE = "Update";
+	public static final String PHYLO_LABEL_PHYLOGENETIC_TREE = "Phylogenetic tree";
+	public static final String PHYLO_LABEL_COMMON_ANCESTOR = "Common ancestor";
 }

src/main/java/tudelft/ti2806/pl3/controls/KeyController.java

@@ -15,7 +15,7 @@ public class KeyController implements KeyListener {
 
 	/**
 	 * Constructor removes the old keylisteners and makes our own.
-	 * 
+	 *
 	 * @param app
 	 *            that is controlled
 	 */
@@ -32,23 +32,23 @@ public KeyController(Application app) {
 	public void release() {
 		app.removeKeyListener(this);
 	}
-	
+
 	/**
 	 * KeyTyped is triggered when the unicode character represented by this key
 	 * is sent by the keyboard to system input.
-	 * 
+	 *
 	 * @param event
 	 *            key that is typed
 	 */
-	
+
 	@Override
 	public void keyTyped(KeyEvent event) {
-		
+
 	}
-	
+
 	/**
 	 * KeyPressed is triggered when the key goes down.
-	 * 
+	 *
 	 * @param event
 	 *            key that is pressed
 	 */
@@ -58,10 +58,6 @@ public void keyPressed(KeyEvent event) {
 			app.stop();
 		}
 
-		if (event.getKeyCode() == KeyEvent.VK_SPACE) {
-			app.getSideBarController().toggleSideBar();
-		}
-
 		if (event.getKeyCode() == KeyEvent.VK_EQUALS) {
 			app.getGraphController().zoomLevelUp();
 		}
@@ -77,15 +73,15 @@ public void keyPressed(KeyEvent event) {
 		app.getGraphController().removeDetailView();
 	}
 
-	
+
 	/**
 	 * KeyReleased is triggered when the key comes up.
-	 * 
+	 *
 	 * @param event
 	 *            key that is releases
 	 */
 	@Override
 	public void keyReleased(KeyEvent event) {
-		
+
 	}
 }

src/main/java/tudelft/ti2806/pl3/menubar/MenuBarController.java

@@ -39,7 +39,6 @@
 public class MenuBarController implements ActionListener, Controller {
 
 	private final MenuBarView menuBarView;
-
 	private final Application application;
 
 	/**
@@ -102,6 +101,10 @@ private void showFindGenes() {
 		application.getFindGenesController().openDialog();
 	}
 
+	private void toggleSideBar() {
+		application.getSideBarController().toggleSideBar();
+	}
+
 	private void filterMetadata() {
 		application.getMetaFilterController().openDialog();
 	}
@@ -119,6 +122,7 @@ private void displayControls() {
 
 	/**
 	 * Make a {@link JTextPane} with controls text.
+	 *
 	 * @return JTextpane with control text.
 	 */
 	public JTextPane makeControls() {
@@ -148,6 +152,7 @@ private void displayAbout() {
 
 	/**
 	 * Make a {@link JTextPane} with about me text.
+	 *
 	 * @return JTextpane with about me text.
 	 */
 	public JTextPane makeAbout() {
@@ -250,6 +255,9 @@ public void actionPerformed(ActionEvent e) {
 			case Constants.MENU_HELP_ABOUT:
 				displayAbout();
 				break;
+			case Constants.MENU_VIEW_PYLO:
+				toggleSideBar();
+				break;
 			default:
 				break;
 		}

src/main/java/tudelft/ti2806/pl3/menubar/MenuBarView.java

@@ -92,7 +92,10 @@ private JMenu setUpView() {
 		JMenuItem findGenes = new JMenuItem(Constants.MENU_VIEW_NAVIGATE_TO_GENE);
 		findGenes.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_G,0));
 		findGenes.setMnemonic(KeyEvent.VK_G);
-		JMenuItem filterMetadata = new JMenuItem("Filter on metadata");
+		JMenuItem phylo = new JMenuItem(Constants.MENU_VIEW_PYLO);
+		phylo.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE, 0));
+		phylo.setMnemonic(KeyEvent.VK_P);
+		JMenuItem filterMetadata = new JMenuItem(Constants.MENU_VIEW_METADATA);
 		filterMetadata.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F,0));
 		filterMetadata.setMnemonic(KeyEvent.VK_F);
 
@@ -103,6 +106,7 @@ private JMenu setUpView() {
 		viewMenu.add(reset);
 		viewMenu.add(findGenes);
 		viewMenu.add(filterMetadata);
+		viewMenu.add(phylo);
 
 		return viewMenu;
 	}

src/main/java/tudelft/ti2806/pl3/sidebar/phylotree/PhyloView.java

@@ -1,6 +1,7 @@
 package tudelft.ti2806.pl3.sidebar.phylotree;
 
 import newick.NewickParser;
+import tudelft.ti2806.pl3.Constants;
 import tudelft.ti2806.pl3.ScreenSize;
 import tudelft.ti2806.pl3.View;
 import tudelft.ti2806.pl3.util.Resources;
@@ -36,12 +37,8 @@
  * Created by Kasper on 20-5-2015.
  */
 public class PhyloView extends JPanel implements View, Observer {
-	private static final String WINDOW_TITLE = "Select Genomes";
-	private static final String BUTTON_LABEL_UPDATE = "Update";
-	private static final String ICON_BACTERIA = "pictures/bacteria_small.jpg";
 
-	public static final String LABEL_PHYLOGENETIC_TREE = "Phylogenetic tree";
-	public static final String LABEL_COMMON_ANCESTOR = "Common ancestor";
+	private static final String ICON_BACTERIA = "pictures/bacteria_small.jpg";
 
 	private JTree jTree;
 	private List<String> selected = new ArrayList<>();
@@ -72,7 +69,7 @@ private void setUpUserInterface() {
 		final int width = ScreenSize.getInstance().getSideBarWidth() - 10;
 		final int height = ScreenSize.getInstance().getHeight() - 100;
 
-		header = new JLabel(WINDOW_TITLE);
+		header = new JLabel(Constants.PHYLO_WINDOW_TITLE);
 		header.setPreferredSize(new Dimension(width, 50));
 
 		scroller = new JScrollPane(jTree,
@@ -89,7 +86,7 @@ private void setUpUserInterface() {
 		this.add(emptyLabel);
 		add(Box.createVerticalGlue());
 
-		button = new JButton(BUTTON_LABEL_UPDATE);
+		button = new JButton(Constants.PHYLO_BUTTON_LABEL_UPDATE);
 		button.setVisible(false);
 		this.add(button);
 		button.setPreferredSize(new Dimension(200, 50));
@@ -112,7 +109,7 @@ private void setUpLook() {
 	 * @return Root node.
 	 */
 	private DefaultMutableTreeNode convertTree(NewickParser.TreeNode tree) {
-		DefaultMutableTreeNode root = new DefaultMutableTreeNode(LABEL_PHYLOGENETIC_TREE);
+		DefaultMutableTreeNode root = new DefaultMutableTreeNode(Constants.PHYLO_LABEL_PHYLOGENETIC_TREE);
 		convertChildren(tree, root);
 
 		return root;
@@ -131,7 +128,7 @@ private void convertChildren(NewickParser.TreeNode tree, DefaultMutableTreeNode
 		for (NewickParser.TreeNode child : tree.getChildren()) {
 			DefaultMutableTreeNode childNode;
 			if (child.getName() == null) {
-				childNode = new DefaultMutableTreeNode(LABEL_COMMON_ANCESTOR);
+				childNode = new DefaultMutableTreeNode(Constants.PHYLO_LABEL_COMMON_ANCESTOR);
 			} else {
 				childNode = new DefaultMutableTreeNode(child.getName());
 			}
@@ -197,8 +194,8 @@ public void valueChanged(TreeSelectionEvent treeSelectionEvent) {
 					DefaultMutableTreeNode select = (DefaultMutableTreeNode) path
 							.getLastPathComponent();
 					String selectName = select.toString();
-					if (selectName.equals(LABEL_COMMON_ANCESTOR)
-							|| selectName.equals(LABEL_PHYLOGENETIC_TREE)) {
+					if (selectName.equals(Constants.PHYLO_LABEL_COMMON_ANCESTOR)
+							|| selectName.equals(Constants.PHYLO_LABEL_PHYLOGENETIC_TREE)) {
 						selected.addAll(getChildsOfAncestor(select));
 					} else {
 						selected.add(select.toString());
@@ -237,7 +234,7 @@ private List<String> getChildsOfAncestor(DefaultMutableTreeNode name) {
 		while (children.hasMoreElements()) {
 			DefaultMutableTreeNode next = (DefaultMutableTreeNode) children
 					.nextElement();
-			if (next.toString().equals(LABEL_COMMON_ANCESTOR)) {
+			if (next.toString().equals(Constants.PHYLO_LABEL_COMMON_ANCESTOR)) {
 				selected.addAll(getChildsOfAncestor(next));
 			} else {
 				selected.add(next.toString());

src/test/java/tudelft/ti2806/pl3/controls/KeyControllerTest.java

@@ -5,7 +5,6 @@
 import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
 import tudelft.ti2806.pl3.Application;
-import tudelft.ti2806.pl3.sidebar.SideBarController;
 import tudelft.ti2806.pl3.visualization.GraphController;
 
 import java.awt.event.KeyEvent;
@@ -40,19 +39,6 @@ public void testEscape() {
 		verify(application, times(1)).stop();
 	}
 
-	@Test
-	public void testSpace() {
-		KeyController keyController = new KeyController(application);
-		when(keyEvent.getKeyCode()).thenReturn(KeyEvent.VK_SPACE);
-		SideBarController sideBarController = mock(SideBarController.class);
-		when(application.getSideBarController()).thenReturn(sideBarController);
-		when(application.getGraphController()).thenReturn(mock(GraphController.class));
-
-		keyController.keyPressed(keyEvent);
-		verify(application, times(1)).getSideBarController();
-		verify(sideBarController, times(1)).toggleSideBar();
-	}
-
 	@Test
 	public void testPlus() {
 		KeyController keyController = new KeyController(application);

src/test/java/tudelft/ti2806/pl3/menubar/MenuBarControllerTest.java

@@ -15,6 +15,7 @@
 import tudelft.ti2806.pl3.Application;
 import tudelft.ti2806.pl3.Constants;
 import tudelft.ti2806.pl3.findgenes.FindGenesController;
+import tudelft.ti2806.pl3.sidebar.SideBarController;
 import tudelft.ti2806.pl3.visualization.GraphController;
 
 import java.awt.event.ActionEvent;
@@ -149,6 +150,17 @@ public void testActionShowFindGenes() {
 		verify(findgenesController, times(1)).openDialog();
 	}
 
+	@Test
+	public void testActionSideBar() {
+		SideBarController sideBarController = mock(SideBarController.class);
+		when(actionEvent.getActionCommand()).thenReturn(Constants.MENU_VIEW_PYLO);
+		when(application.getSideBarController()).thenReturn(sideBarController);
+		menuBarController.actionPerformed(actionEvent);
+
+		verify(application, times(1)).getSideBarController();
+		verify(sideBarController, times(1)).toggleSideBar();
+	}
+
 	@Test
 	public void testMakeControls() {
 		String expected = Constants.INFO_CONTROLS;
@@ -160,8 +172,9 @@ public void testMakeControls() {
 	public void testMakeAbout() {
 		String expected = Constants.INFO_ABOUT + "githublink";
 		String result = menuBarController.makeAbout().getText();
-//		assertEquals(expected, result);
-//		assertEquals(result.contains(expected), expected.contains(result));
+		// this test is not working
+		//assertEquals(expected, result);
+		//assertEquals(result.contains(expected), expected.contains(result));
 	}
 
 }