GUI: minor improvements

- Option to sort outline
- Option to restrict outline to 'major' elements
- Option to browse selected folder in terminal
- Extend tab customizations to all tabbed panes
- Ensure 'non-executable-syntax' choice reflects active pane
- Ensure menu bar separators are displayed on MacOS
- Ensure EditorPane has focus when calling one of its actions
- Fix contextual menu not being displayed on Outline panel
- Fix bookmarks prompt being displayed twice
- Fix vertical alignment of search field
- Fix inconsistencies with scaled fold icons
- Code cleanup: Aggregate GUI-related code in common class

Author: tferr

src/main/java/org/scijava/ui/swing/script/EditorPane.java

@@ -61,6 +61,7 @@
 import javax.swing.JRadioButtonMenuItem;
 import javax.swing.JScrollPane;
 import javax.swing.JViewport;
+import javax.swing.MenuElement;
 import javax.swing.ToolTipManager;
 import javax.swing.UIManager;
 import javax.swing.event.DocumentEvent;
@@ -184,7 +185,7 @@ public void hyperlinkUpdate(final HyperlinkEvent hle) {
 				wordMovement("Prev-Word-Select-Action", -1, true));
 
 		noneLangSyntaxMenu = geSyntaxForNoneLang();
-		installCostumPopupMenu();
+		installCustomPopupMenu();
 
 		ToolTipManager.sharedInstance().registerComponent(this);
 		addMouseListener(new MouseAdapter() {
@@ -236,30 +237,30 @@ public void addNotify() {
 		if (isVisible()) super.addNotify();
 	}
 
-	private void installCostumPopupMenu() {
+	private void installCustomPopupMenu() {
 		// We are overriding the entire menu so that we can include our shortcuts
 		// in the menu items. These commands are not listed on the menubar, so
 		// this is the only access point in the GUI for these
 		// see #createPopupMenu(); #appendFoldingMenu();
 		final JPopupMenu popup = new JPopupMenu();
-		TextEditor.addPopupMenuSeparator(popup, "Code Editing:");
+		TextEditor.GuiUtils.addPopupMenuSeparator(popup, "Code Editing:");
 		popup.add(getMenuItem("Copy", EditorPaneActions.copyAction, false));
 		popup.add(getMenuItem("Cut", EditorPaneActions.cutAction, true));
 		popup.add(getMenuItem("Paste", EditorPaneActions.pasteAction, true));
 		popup.add(getMenuItem("Delete Line", EditorPaneActions.rtaDeleteLineAction, true));
 		popup.add(getMenuItem("Delete Rest of Line", EditorPaneActions.rtaDeleteRestOfLineAction, true));
-		TextEditor.addPopupMenuSeparator(popup, "Code Selection:");
+		TextEditor.GuiUtils.addPopupMenuSeparator(popup, "Code Selection:");
 		popup.add(getMenuItem("Select All", EditorPaneActions.selectAllAction, false));
 		popup.add(getMenuItem("Select Line", EditorPaneActions.selectLineAction, false));
 		popup.add(getMenuItem("Select Paragraph", EditorPaneActions.selectParagraphAction, false));
-		TextEditor.addPopupMenuSeparator(popup, "Code Folding:");
+		TextEditor.GuiUtils.addPopupMenuSeparator(popup, "Code Folding:");
 		popup.add(getMenuItem("Collapse Fold", EditorPaneActions.rstaCollapseFoldAction, false));
 		popup.add(getMenuItem("Expand Fold", EditorPaneActions.rstaExpandFoldAction, false));
 		popup.add(getMenuItem("Toggle Current Fold", EditorPaneActions.rstaToggleCurrentFoldAction, false));
 		popup.add(getMenuItem("Collapse All Folds", EditorPaneActions.rstaCollapseAllFoldsAction, false));
 		popup.add(getMenuItem("Expand All Folds", EditorPaneActions.rstaExpandAllFoldsAction, false));
 		popup.add(getMenuItem("Collapse All Comments", EditorPaneActions.rstaCollapseAllCommentFoldsAction, false));
-		TextEditor.addPopupMenuSeparator(popup, "Code Formatting:");
+		TextEditor.GuiUtils.addPopupMenuSeparator(popup, "Code Formatting:");
 		popup.add(getMenuItem("Indent Right", EditorPaneActions.epaIncreaseIndentAction, true));
 		popup.add(getMenuItem("Indent Left", EditorPaneActions.rstaDecreaseIndentAction, true));
 		popup.add(getMenuItem("Move Up", EditorPaneActions.rtaLineUpAction, true));
@@ -274,10 +275,10 @@ private void installCostumPopupMenu() {
 		menu.add(getMenuItem("Lower Case ('_' Sep.)", EditorPaneActions.epaLowerCaseUndAction, true));
 		menu.add(getMenuItem("Title Case", EditorPaneActions.epaTitleCaseAction, true));
 		menu.add(getMenuItem("Upper Case", EditorPaneActions.rtaUpperSelectionCaseAction, true));
-		TextEditor.addPopupMenuSeparator(popup, "Ocurrences:");
+		TextEditor.GuiUtils.addPopupMenuSeparator(popup, "Ocurrences:");
 		popup.add(getMenuItem("Next Occurrence", EditorPaneActions.rtaNextOccurrenceAction, false));
 		popup.add(getMenuItem("Previous Occurrence", EditorPaneActions.rtaPrevOccurrenceAction, false));
-		TextEditor.addPopupMenuSeparator(popup, "Utilities:");
+		TextEditor.GuiUtils.addPopupMenuSeparator(popup, "Utilities:");
 		popup.add(new OpenLinkUnderCursor().getMenuItem());
 		popup.add(new SearchWebOnSelectedText().getMenuItem());
 		popup.add(noneLangSyntaxMenu);
@@ -323,6 +324,7 @@ private JMenu geSyntaxForNoneLang() {
 	private JMenuItem getSyntaxItem(final ButtonGroup bg, final String label, final String syntaxId) {
 		final JRadioButtonMenuItem item = new JRadioButtonMenuItem(label);
 		bg.add(item);
+		item.setActionCommand(syntaxId);
 		item.addActionListener(e -> {
 			if (getCurrentLanguage() == null) {
 				setSyntaxEditingStyle(syntaxId);
@@ -335,6 +337,30 @@ private JMenuItem getSyntaxItem(final ButtonGroup bg, final String label, final
 		return item;
 	}
 
+	private void updateNoneLangSyntaxMenu(final ScriptLanguage language) {
+		noneLangSyntaxMenu.setEnabled(language == null);
+		if (language == null) {
+			JRadioButtonMenuItem defaultChoice = null;
+			try {
+				for (final MenuElement me : noneLangSyntaxMenu.getSubElements()) {
+					if (me instanceof JRadioButtonMenuItem) {
+						final JRadioButtonMenuItem rb = ((JRadioButtonMenuItem) me);
+						final String choice = rb.getActionCommand();
+						if (getSyntaxEditingStyle().equals(choice)) {
+							rb.setSelected(true);
+							return;
+						}
+						if (SYNTAX_STYLE_NONE.equals(choice))
+							defaultChoice = rb;
+					}
+				}
+				defaultChoice.setSelected(true);
+			} catch (final Exception ignored) {
+				// do nothing
+			}
+		}
+	}
+
 	@Override
 	public void setTabSize(final int width) {
 		if (getTabSize() != width) super.setTabSize(width);
@@ -740,7 +766,7 @@ protected void setLanguage(final ScriptLanguage language,
 			setText(header += getText());
 		}
 
-		noneLangSyntaxMenu.setEnabled(language == null);
+		updateNoneLangSyntaxMenu(language);
 		if ("None".equals(languageName) ) {
 			supportStatus = "Active language: None";
 			return; // no need to update console any further

src/main/java/org/scijava/ui/swing/script/FileSystemTreePanel.java

@@ -99,8 +99,8 @@ class FileSystemTreePanel extends JPanel {
 		bc.gridy = 0;
 		bc.weightx = 0;
 		bc.weighty = 0;
-		bc.anchor = GridBagConstraints.NORTHWEST;
-		bc.fill = GridBagConstraints.NONE;
+		bc.anchor = GridBagConstraints.CENTER;
+		bc.fill = GridBagConstraints.HORIZONTAL;
 		add(addDirectoryButton(), bc);
 		bc.gridx = 1;
 		add(removeDirectoryButton(), bc);
@@ -322,13 +322,13 @@ private boolean allTreeNodesCollapsed() {
 	private void addContextualMenuToTree() {
 		final JPopupMenu popup = new JPopupMenu();
 		JMenuItem jmi = new JMenuItem("Collapse All");
-		jmi.addActionListener(e -> collapseAllNodes());
+		jmi.addActionListener(e -> TextEditor.GuiUtils.collapseAllTreeNodes(tree));
 		popup.add(jmi);
 		jmi = new JMenuItem("Expand Folders");
 		jmi.addActionListener(e -> expandImmediateNodes());
 		popup.add(jmi);
 		popup.addSeparator();
-		jmi = new JMenuItem("Show in System Explorer");
+		jmi = new JMenuItem("Open in System Explorer");
 		jmi.addActionListener(e -> {
 			final TreePath path = tree.getSelectionPath();
 			if (path == null) {
@@ -346,6 +346,24 @@ private void addContextualMenuToTree() {
 			}
 		});
 		popup.add(jmi);
+		jmi = new JMenuItem("Open in Terminal");
+		jmi.addActionListener(e -> {
+			final TreePath path = tree.getSelectionPath();
+			if (path == null) {
+				JOptionPane.showMessageDialog(this, "No items are currently selected.", "Invalid Selection",
+						JOptionPane.INFORMATION_MESSAGE);
+				return;
+			}
+			try {
+				final String filepath = (String) ((FileSystemTree.Node) path.getLastPathComponent()).getUserObject();
+				TextEditor.GuiUtils.openTerminal(new File(filepath));
+			} catch (final Exception ignored) {
+				JOptionPane.showMessageDialog(this, "Could not open path in Terminal.", "Error",
+						JOptionPane.ERROR_MESSAGE);
+			}
+		});
+		popup.add(jmi);
+		
 		popup.addSeparator();
 		jmi = new JMenuItem("Reset to Home Folder");
 		jmi.addActionListener(e -> changeRootPath(System.getProperty("user.home")));
@@ -363,11 +381,6 @@ void changeRootPath(final String path) {
 		expandImmediateNodes();
 	}
 
-	private void collapseAllNodes() {
-		for (int i = tree.getRowCount() - 1; i >= 0; i--)
-			tree.collapseRow(i);
-	}
-
 	private void expandImmediateNodes() {
 		for (int i = tree.getRowCount() - 1; i >= 0; i--)
 			tree.expandRow(i);
@@ -387,8 +400,8 @@ private void showHelpMsg() {
 				+ "to paste their paths into the active script.</p>" //
 				+ "<br><p><b>Filtering Files</b></p>" //
 				+ "<p>Filters affect filenames (not folders) and are applied by typing a filtering "//
-				+ "string + [Enter]. Filters act only on files being listed, and ignore collapsed " //
-				+ "folders. Examples of regex usage:</p>" //
+				+ "string + [Enter]. Filters act only on files being listed in expanded directories, " //
+				+ "and ignore the content of collapsed folders. Examples of regex usage:</p>" //
 				+ "<br><table align='center'>" //
 				+ "  <tr>" //
 				+ "   <th>Pattern</th>" //

src/main/java/org/scijava/ui/swing/script/GutterUtils.java

@@ -124,13 +124,18 @@ public int getIconWidth() {
 
 		@Override
 		public void paintIcon(final Component c, final Graphics g, final int x, final int y) {
-			g.setColor(background);
-			g.fillRect(x, y, size, size);
-			g.setColor(foreground);
-			g.drawRect(x, y, size, size);
-			g.drawLine(x + 2, y + size / 2, x + 2 + size / 2, y + size / 2);
+			// the default '+'/'-' symbols are to small with scaled fonts, and we don't
+			// have an easy way to resize the space allocated for the icon in the gutter
 			if (collapsed) {
-				g.drawLine(x + size / 2, y + 2, x + size / 2, y + size / 2 + 2);
+				g.setColor(foreground);
+				g.fillRect(x, y, size, size);
+				g.setColor(background);
+				g.drawRect(x, y, size-2, size-1); // no idea why the extra pixel is needed
+			} else {
+				g.setColor(background);
+				g.fillRect(x, y, size, size);
+				g.setColor(foreground);
+				g.drawRect(x, y, size-2, size-1);
 			}
 		}
 	}

src/main/java/org/scijava/ui/swing/script/OutlineTreePanel.java

@@ -40,6 +40,7 @@
 import java.text.AttributedCharacterIterator;
 import java.text.AttributedString;
 
+import javax.swing.JCheckBoxMenuItem;
 import javax.swing.JMenuItem;
 import javax.swing.JPopupMenu;
 import javax.swing.JScrollPane;
@@ -63,16 +64,17 @@ class OutlineTreePanel extends JScrollPane {
 	private AbstractSourceTree sourceTree;
 	private final Color placeholdColor;
 	private float fontSize;
+	private boolean sorted;
+	private boolean major;
 
 	OutlineTreePanel(final TextEditor editor) {
 		super();
 		fontSize = getFont().getSize();
 		setViewportView(new UnsupportedLangTree());
-		placeholdColor = TextEditor.getDisabledComponentColor();
-
+		placeholdColor = TextEditor.GuiUtils.getDisabledComponentColor();
 	}
 
-	protected void refreshSourceTree(final EditorPane pane) {
+	protected void rebuildSourceTree(final EditorPane pane) {
 		if (!isVisible())
 			return;
 		if (sourceTree != null) {
@@ -82,14 +84,15 @@ protected void refreshSourceTree(final EditorPane pane) {
 		final String language = (sLanguage == null) ? "" : sLanguage.getLanguageName();
 		switch (language) {
 		case "Java":
-			sourceTree = new JavaOutlineTree();
+		//case "BeanShell":
+			sourceTree = new JavaOutlineTree(sorted);
 			break;
 		case "JavaScript":
-			sourceTree = new JavaScriptOutlineTree();
+			sourceTree = new JavaScriptOutlineTree(sorted);
 			break;
 		default:
 			if (EditorPane.SYNTAX_STYLE_XML.equals(pane.getSyntaxEditingStyle())) {
-				sourceTree = new XmlOutlineTree();
+				sourceTree = new XmlOutlineTree(sorted);
 			} else
 				sourceTree = null;
 			break;
@@ -98,6 +101,7 @@ protected void refreshSourceTree(final EditorPane pane) {
 		if (sourceTree == null) {
 			setViewportView(new UnsupportedLangTree(pane));
 		} else {
+			sourceTree.setShowMajorElementsOnly(major);
 			sourceTree.setFont(sourceTree.getFont().deriveFont(fontSize));
 			sourceTree.listenTo(pane);
 			setViewportView(sourceTree);
@@ -108,10 +112,35 @@ protected void refreshSourceTree(final EditorPane pane) {
 
 	private void setPopupMenu(final JTree tree, final EditorPane pane) {
 		final JPopupMenu popup = new JPopupMenu();
-		final JMenuItem jmi = new JMenuItem("Refresh");
-		jmi.addActionListener(e -> refreshSourceTree(pane));
+		JMenuItem jmi;
+		if (tree instanceof AbstractSourceTree) {
+			jmi = new JMenuItem("Collapse All");
+			jmi.addActionListener(e -> TextEditor.GuiUtils.collapseAllTreeNodes(tree));
+			popup.add(jmi);
+			jmi = new JMenuItem("Expand All");
+			jmi.addActionListener(e -> TextEditor.GuiUtils.expandAllTreeNodes(tree));
+			popup.add(jmi);
+			popup.addSeparator();
+			final JCheckBoxMenuItem jcmi1 = new JCheckBoxMenuItem("Hide 'Minor' Elements", major);
+			jcmi1.setToolTipText("Whether non-proeminent elements (e.g., local variables) should be displayed");
+			jcmi1.addItemListener(e -> {
+				major = jcmi1.isSelected();
+				((AbstractSourceTree) tree).setShowMajorElementsOnly(major);
+				((AbstractSourceTree) tree).refresh();
+			});
+			popup.add(jcmi1);
+			final JCheckBoxMenuItem jcmi2 = new JCheckBoxMenuItem("Sort Elements", sorted);
+			jcmi2.addItemListener(e -> {
+				sorted = jcmi2.isSelected();
+				((AbstractSourceTree) tree).setSorted(sorted); // will refresh
+			});
+			popup.add(jcmi2);
+			popup.addSeparator();
+		}
+		jmi = new JMenuItem("Rebuild");
+		jmi.addActionListener(e -> rebuildSourceTree(pane));
 		popup.add(jmi);
-		setComponentPopupMenu(popup);
+		tree.setComponentPopupMenu(popup);
 	}
 
 	private class UnsupportedLangTree extends JTree {
@@ -124,7 +153,7 @@ public UnsupportedLangTree() {
 			super((TreeNode) null);
 		}
 
-		public UnsupportedLangTree(EditorPane pane) {
+		public UnsupportedLangTree(final EditorPane pane) {
 			this();
 			setPopupMenu(this, pane);
 		}