Implement Outline Panel and minor fixes

Implement Outline Panel. for Java, JS, and XML.

Fixes:
- Fix spurious 'file has changed' prompts, see https://forum.image.sc/t/shiny-new-script-editor/64160/33
- Disable AquaLaF hack on main split pane. No longer needed
- Revert GotoType shortcut as custom override was never successful
- Ensure editing shortcuts in Help> and contextual menus are consistent with menubar

Author: tferr

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

@@ -90,6 +90,13 @@ public EditorPaneActions(final EditorPane editorPane) {
 		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_I, defaultMod), epaIncreaseIndentAction);
 		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_I, defaultMod + shift), rstaDecreaseIndentAction);
 
+		// editing: override defaults for undo/redo/copy/cut/paste for consistency with menubar
+		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_C, defaultMod), copyAction);
+		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_V, defaultMod), pasteAction);
+		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_X, defaultMod), cutAction);
+		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_Z, defaultMod), rtaUndoAction);
+		map.put(KeyStroke.getKeyStroke(KeyEvent.VK_Y, defaultMod), rtaRedoAction); // this should be ctrl+shift+z!?
+
 		/*
 		 * see RSyntaxTextAreaDefaultInputMap and RTADefaultInputMap for other bindings.
 		 * Note that some of those bindings must be overridden in map.getParent()

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

@@ -0,0 +1,160 @@
+/*
+ * #%L
+ * Script Editor and Interpreter for SciJava script languages.
+ * %%
+ * Copyright (C) 2009 - 2022 SciJava developers.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.ui.swing.script;
+
+import java.awt.Color;
+import java.awt.Graphics2D;
+import java.awt.Insets;
+import java.awt.RenderingHints;
+import java.awt.font.FontRenderContext;
+import java.awt.font.LineBreakMeasurer;
+import java.awt.font.TextAttribute;
+import java.awt.font.TextLayout;
+import java.text.AttributedCharacterIterator;
+import java.text.AttributedString;
+
+import javax.swing.JMenuItem;
+import javax.swing.JPopupMenu;
+import javax.swing.JScrollPane;
+import javax.swing.JTree;
+import javax.swing.tree.TreeNode;
+
+import org.fife.rsta.ac.AbstractSourceTree;
+import org.fife.rsta.ac.java.tree.JavaOutlineTree;
+import org.fife.rsta.ac.js.tree.JavaScriptOutlineTree;
+import org.fife.rsta.ac.xml.tree.XmlOutlineTree;
+import org.scijava.script.ScriptLanguage;
+
+/**
+ * Convenience class for displaying a {@link AbstractSourceTree}
+ *
+ * @author Tiago Ferreira
+ */
+class OutlineTreePanel extends JScrollPane {
+
+	private static final long serialVersionUID = -710040159139542578L;
+	private AbstractSourceTree sourceTree;
+	private final Color placeholdColor;
+	private float fontSize;
+
+	OutlineTreePanel(final TextEditor editor) {
+		super();
+		fontSize = getFont().getSize();
+		setViewportView(new UnsupportedLangTree());
+		placeholdColor = TextEditor.getDisabledComponentColor();
+
+	}
+
+	protected void refreshSourceTree(final EditorPane pane) {
+		if (!isVisible())
+			return;
+		if (sourceTree != null) {
+			sourceTree.uninstall();
+		}
+		final ScriptLanguage sLanguage = pane.getCurrentLanguage();
+		final String language = (sLanguage == null) ? "" : sLanguage.getLanguageName();
+		switch (language) {
+		case "Java":
+			sourceTree = new JavaOutlineTree();
+			break;
+		case "JavaScript":
+			sourceTree = new JavaScriptOutlineTree();
+			break;
+		default:
+			if (EditorPane.SYNTAX_STYLE_XML.equals(pane.getSyntaxEditingStyle())) {
+				sourceTree = new XmlOutlineTree();
+			} else
+				sourceTree = null;
+			break;
+		}
+		fontSize = pane.getFontSize();
+		if (sourceTree == null) {
+			setViewportView(new UnsupportedLangTree(pane));
+		} else {
+			sourceTree.setFont(sourceTree.getFont().deriveFont(fontSize));
+			sourceTree.listenTo(pane);
+			setViewportView(sourceTree);
+			setPopupMenu(sourceTree, pane);
+		}
+		revalidate();
+	}
+
+	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));
+		popup.add(jmi);
+		setComponentPopupMenu(popup);
+	}
+
+	private class UnsupportedLangTree extends JTree {
+
+		private static final long serialVersionUID = 1L;
+		private static final String HOLDER = "Outline not available... "
+				+ "(Currently, only Java, JS, & XML are supported)";
+
+		public UnsupportedLangTree() {
+			super((TreeNode) null);
+		}
+
+		public UnsupportedLangTree(EditorPane pane) {
+			this();
+			setPopupMenu(this, pane);
+		}
+
+		@Override
+		protected void paintComponent(final java.awt.Graphics g) {
+			super.paintComponent(g);
+			final Graphics2D g2 = (Graphics2D) g.create();
+			g2.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
+			g2.setColor(placeholdColor);
+			final Insets i = getInsets();
+			float yTop = i.top;
+			final int w = getWidth() - i.left - i.right;
+			final int lastIndex = HOLDER.length();
+			final AttributedString ac = new AttributedString(HOLDER);
+			ac.addAttribute(TextAttribute.SIZE, fontSize, 0, lastIndex);
+			ac.addAttribute(TextAttribute.POSTURE, TextAttribute.POSTURE_OBLIQUE, 0, lastIndex);
+			final AttributedCharacterIterator aci = ac.getIterator();
+			final FontRenderContext frc = g2.getFontRenderContext();
+			final LineBreakMeasurer lbm = new LineBreakMeasurer(aci, frc);
+			while (lbm.getPosition() < aci.getEndIndex()) {
+				// see https://stackoverflow.com/a/41118280s
+				final TextLayout tl = lbm.nextLayout(w);
+				final float xPos = (float) (i.left + ((getWidth() - tl.getBounds().getWidth()) / 2));
+				final float yPos = (float) (yTop + ((getHeight() - tl.getBounds().getHeight()) / 2));
+				tl.draw(g2, xPos, yPos + tl.getAscent());
+				yTop += tl.getDescent() + tl.getLeading() + tl.getAscent();
+			}
+			g2.dispose();
+		}
+
+	}
+}

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

@@ -246,7 +246,7 @@ public class TextEditor extends JFrame implements ActionListener,
 	private FindAndReplaceDialog findDialog;
 	private JCheckBoxMenuItem autoSave, wrapLines, tabsEmulated, autoImport,
 			autocompletion, fallbackAutocompletion, keylessAutocompletion,
-			markOccurences, paintTabs, whiteSpace, marginLine;
+			markOccurences, paintTabs, whiteSpace, marginLine, lockPane;
 	private ButtonGroup themeRadioGroup;
 	private JTextArea errorScreen = new JTextArea();
 
@@ -299,11 +299,13 @@ public class TextEditor extends JFrame implements ActionListener,
 	private boolean incremental = false;
 	private DragSource dragSource;
 	private boolean layoutLoading = true;
+	private OutlineTreePanel sourceTreePanel;
 
 	public static final ArrayList<TextEditor> instances = new ArrayList<>();
 	public static final ArrayList<Context> contexts = new ArrayList<>();
 
 	public TextEditor(final Context context) {
+
 		super("Script Editor");
 		instances.add(this);
 		contexts.add(context);
@@ -313,15 +315,10 @@ public TextEditor(final Context context) {
 		// NB: All panes must be initialized before menus are assembled!
 		tabbed = new JTabbedPane();
 		tree = new FileSystemTree(log);
-		body = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, new FileSystemTreePanel(tree, context), tabbed);
-		try {// on Aqua L&F, 'one touch arrows' collide with borderless options button, which in turn are
-			// needed for proper resize of the search panel. Grrrrr....
-			if ("com.apple.laf.AquaLookAndFeel".equals(UIManager.getLookAndFeel().getClass().getName())) {
-				body.setOneTouchExpandable(false);
-			}
-		} catch (final Exception ignored) {
-			// do nothing
-		}
+		final JTabbedPane sideTabs = new JTabbedPane();
+		sideTabs.addTab("File Explorer", new FileSystemTreePanel(tree, context));
+		sideTabs.addTab("Outline", sourceTreePanel = new OutlineTreePanel(this));
+		body = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, sideTabs, tabbed);
 
 		// These items are dynamic and need to be initialized before EditorPane creation
 		initializeDynamicMenuComponents();
@@ -356,7 +353,7 @@ public TextEditor(final Context context) {
 		makeJarWithSource = addToMenu(file, "Export as JAR (With Source)...", 0, 0);
 		makeJarWithSource.setMnemonic(KeyEvent.VK_X);
 		file.addSeparator();
-		final JCheckBoxMenuItem lockPane = new JCheckBoxMenuItem("Lock (Make Read Only)");
+		lockPane  = new JCheckBoxMenuItem("Lock (Make Read Only)");
 		lockPane.setToolTipText("Protects file from accidental editing");
 		file.add(lockPane);
 		lockPane.addActionListener(e -> {
@@ -366,7 +363,6 @@ public TextEditor(final Context context) {
 				new SetWritableAction().actionPerformedImpl(e, getEditorPane());
 			}
 		});
-		tabbed.addChangeListener(e -> lockPane.setSelected(getTab(tabbed.getSelectedIndex()).editorPane.isLocked()));
 		JMenuItem jmi = new JMenuItem("Revert...");
 		jmi.addActionListener(e -> {
 			if (getEditorPane().isLocked()) {
@@ -552,7 +548,7 @@ public TextEditor(final Context context) {
 		tabsMenu.setMnemonic(KeyEvent.VK_W);
 		addMenubarSeparator(tabsMenu, "Panes:");
 		// Assume initial status from prefs or panel visibility
-		final JCheckBoxMenuItem jcmi1 = new JCheckBoxMenuItem("File Explorer",
+		final JCheckBoxMenuItem jcmi1 = new JCheckBoxMenuItem("Side Pane",
 				prefService.getInt(getClass(), MAIN_DIV_LOCATION, body.getDividerLocation()) > 0
 						|| isLeftPaneExpanded(body));
 		jcmi1.addItemListener(e -> collapseSplitPane(0, !jcmi1.isSelected()));
@@ -677,8 +673,14 @@ public TextEditor(final Context context) {
 
 		// -- END MENUS --
 
-		// Add the editor and output area
+		// add tab-related listeners
 		tabbed.addChangeListener(this);
+		sideTabs.addChangeListener(e -> {
+			if (sideTabs.getSelectedIndex() == 1)
+				sourceTreePanel.refreshSourceTree(getTab(tabbed.getSelectedIndex()).editorPane);
+		});
+
+		// Add the editor and output area
 		new FileDrop(tabbed, files -> {
 			final ArrayList<File> filteredFiles = new ArrayList<>();
 			assembleFlatFileCollection(filteredFiles, files);
@@ -895,9 +897,7 @@ private void assembleEditMenu() {
 		addMappedActionToMenu(editMenu, "Goto Matching Bracket", EditorPaneActions.rstaGoToMatchingBracketAction, false);
 
 		final JMenuItem gotoType = new JMenuItem("Goto Type...");
-		gotoType.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_G, ctrl + shift)); // default is Ctrl+Shift+O
-		gotoType.setToolTipText(
-				"Alternative shortcut: " + getEditorPane().getPaneActions().getAcceleratorLabel("GoToType"));
+		gotoType.setAccelerator(getEditorPane().getPaneActions().getAccelerator("GoToType"));
 		gotoType.addActionListener(e -> {
 			try {
 				getTextArea().getActionMap().get("GoToType").actionPerformed(e);
@@ -1976,6 +1976,7 @@ public void stateChanged(final ChangeEvent e) {
 			return;
 		}
 		final EditorPane editorPane = getEditorPane(index);
+		lockPane.setSelected(editorPane.isLocked());
 		editorPane.requestFocus();
 		checkForOutsideChanges();
 
@@ -2209,6 +2210,7 @@ public TextEditorTab open(final File file) {
 
 			updateLanguageMenu(tab.editorPane.getCurrentLanguage());
 			tab.editorPane.getDocument().addDocumentListener(this);
+			tab.editorPane.requestFocusInWindow();
 			return tab;
 		}
 		catch (final FileNotFoundException e) {
@@ -2460,9 +2462,9 @@ public void updateTabAndFontSize(final boolean setByLanguage) {
 
 	public void updateUI(final boolean setByLanguage) {
 		final EditorPane pane = getEditorPane();
-		if (pane.getCurrentLanguage() == null) return;
+		//if (pane.getCurrentLanguage() == null) return;
 
-		if (setByLanguage) {
+		if (setByLanguage && pane.getCurrentLanguage() != null) {
 			if (pane.getCurrentLanguage().getLanguageName().equals("Python")) {
 				pane.setTabSize(4);
 			}
@@ -2513,6 +2515,7 @@ else if (tabSize == Integer.parseInt(item.getText())) {
 		autocompletion.setState(pane.isAutoCompletionEnabled());
 		fallbackAutocompletion.setState(pane.isAutoCompletionFallbackEnabled());
 		keylessAutocompletion.setState(pane.isAutoCompletionKeyless());
+		sourceTreePanel.refreshSourceTree(pane);
 	}
 
 	public void setEditorPaneFileName(final String baseName) {
@@ -3928,7 +3931,7 @@ else if (file.isDirectory())
 		return collection;
 	}
 
-	private static Color getDisabledComponentColor() {
+	protected static Color getDisabledComponentColor() {
 		try {
 			return UIManager.getColor("MenuItem.disabledForeground");
 		} catch (final Exception ignored) {