LoggingPanel: add "Settings" to LoggingPanel's popup menu

Now LoggingPanel can be used to record and show the calling class
of the log messages.

Author: maarzt

src/main/java/org/scijava/ui/swing/console/LogFormatter.java

@@ -33,6 +33,7 @@
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.util.EnumSet;
 
 import org.scijava.log.LogLevel;
 import org.scijava.log.LogMessage;
@@ -44,25 +45,56 @@
  */
 public class LogFormatter {
 
+	public enum Field {
+		TIME, LEVEL, SOURCE, MESSAGE, THROWABLE, ATTACHMENT
+	}
+
+	private EnumSet<Field> visibleFields = EnumSet.of(Field.TIME,
+		Field.LEVEL, Field.SOURCE, Field.MESSAGE, Field.THROWABLE);
+
+	public boolean isVisible(Field field) {
+		return visibleFields.contains(field);
+	}
+
+	public void setVisible(Field field, boolean visible) {
+		// copy on write to enable isVisible to be used concurrently
+		EnumSet<Field> copy = EnumSet.copyOf(visibleFields);
+		if (visible) copy.add(field);
+		else copy.remove(field);
+		visibleFields = copy;
+	}
+
 	public String format(LogMessage message) {
+		try {
+			final StringWriter sw = new StringWriter();
+			final PrintWriter printer = new PrintWriter(sw);
+
+			if (isVisible(Field.TIME))
+				printWithBrackets(printer, message.time().toString());
+
+			if (isVisible(Field.LEVEL))
+				printWithBrackets(printer, LogLevel.prefix(message.level()));
 
-		final StringWriter sw = new StringWriter();
-		final PrintWriter printer = new PrintWriter(sw);
+			if (isVisible(Field.SOURCE))
+				printWithBrackets(printer, message.source().toString());
 
-		printWithBrackets(printer, message.time().toString());
-		printWithBrackets(printer, LogLevel.prefix(message.level()));
-		printWithBrackets(printer, message.source().toString());
-		printer.println(message.text());
-		if (message.throwable() != null)
-			message.throwable().printStackTrace(printer);
+			if (isVisible(Field.ATTACHMENT)) {
+				printer.print(message.attachments());
+				printer.print(" ");
+			}
 
-		return sw.toString();
+			if (isVisible(Field.MESSAGE)) printer.println(message.text());
+
+			if (isVisible(Field.THROWABLE) && message.throwable() != null)
+				message.throwable().printStackTrace(printer);
+			return sw.toString();
+		}
+		catch (Exception e) {
+			return "[Exception while formatting log message: " + e + "]\n";
+		}
 	}
 
 	private void printWithBrackets(PrintWriter printer, String prefix) {
-		printer.print('[');
-		printer.print(prefix);
-		printer.print("] ");
+		printer.append('[').append(prefix).append("] ");
 	}
-
 }

src/main/java/org/scijava/ui/swing/console/LoggingPanel.java

@@ -207,7 +207,6 @@ private void registerKeyStroke(String keyStroke, String id, final Runnable actio
 		getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(KeyStroke
 			.getKeyStroke(keyStroke), id);
 		getActionMap().put(id, new AbstractAction() {
-
 			@Override
 			public void actionPerformed(ActionEvent actionEvent) {
 				action.run();
@@ -227,9 +226,47 @@ private JPopupMenu initMenu() {
 			this::clear);
 		menu.add(newMenuItem("Log Sources",
 			this::toggleSourcesPanel));
+		menu.add(initSettingsMenu());
+		return menu;
+	}
+
+	private JMenu initSettingsMenu() {
+		JMenu menu = new JMenu("Settings");
+		menu.add(checkboxItem(LogFormatter.Field.TIME, "show time stamp"));
+		menu.add(checkboxItem(LogFormatter.Field.SOURCE, "show log source"));
+		menu.add(checkboxItem(LogFormatter.Field.LEVEL, "show log level"));
+		menu.add(checkboxItem(LogFormatter.Field.THROWABLE, "show exception"));
+		menu.add(checkboxItem(LogFormatter.Field.ATTACHMENT, "show attached data"));
+		menu.add(new JSeparator());
+		menu.add(recordCallingClassMenuItem());
 		return menu;
 	}
 
+	private JCheckBoxMenuItem recordCallingClassMenuItem() {
+		JCheckBoxMenuItem menuItem = new JCheckBoxMenuItem();
+		menuItem.setState(false);
+		menuItem.setAction(new AbstractAction("record calling class") {
+			@Override
+			public void actionPerformed(ActionEvent e) {
+				recorder.setRecordCallingClass(menuItem.getState());
+				updateFilter();
+			}
+		});
+		return menuItem;
+	}
+
+	private JMenuItem checkboxItem(LogFormatter.Field field, String text) {
+		JCheckBoxMenuItem menuItem = new JCheckBoxMenuItem(text, logFormatter.isVisible(field));
+		menuItem.setAction(new AbstractAction(text) {
+			@Override
+			public void actionPerformed(ActionEvent e) {
+				logFormatter.setVisible(field, menuItem.getState());
+				updateFilter();
+			}
+		});
+		return menuItem;
+	}
+
 	static private JMenuItem newMenuItem(String text, String keyStroke,
 		Runnable runnable)
 	{