SwingConsolePane: Store settings for log formatting in PrefService

Author: maarzt

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

@@ -34,9 +34,11 @@
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.util.EnumSet;
+import java.util.Map;
 
 import org.scijava.log.LogLevel;
 import org.scijava.log.LogMessage;
+import org.scijava.prefs.PrefService;
 
 /**
  * Used by {@link LoggingPanel} to simplify formatting log messages.
@@ -45,6 +47,16 @@
  */
 public class LogFormatter {
 
+	private String prefKey = null;
+
+	private PrefService prefService = null;
+
+	public void setPrefService(PrefService prefService, String prefKey) {
+		this.prefService = (prefKey != null && !prefKey.isEmpty()) ? prefService : null;
+		this.prefKey = prefKey;
+		applySettings();
+	}
+
 	public enum Field {
 		TIME, LEVEL, SOURCE, MESSAGE, THROWABLE, ATTACHMENT
 	}
@@ -62,6 +74,7 @@ public void setVisible(Field field, boolean visible) {
 		if (visible) copy.add(field);
 		else copy.remove(field);
 		visibleFields = copy;
+		changeSetting(field, visible);
 	}
 
 	public String format(LogMessage message) {
@@ -97,4 +110,24 @@ public String format(LogMessage message) {
 	private void printWithBrackets(PrintWriter printer, String prefix) {
 		printer.append('[').append(prefix).append("] ");
 	}
+
+	// -- Helper methods --
+
+	public void applySettings() {
+		if(prefService == null) return;
+		Map<String, String> settings = prefService.getMap(prefKey);
+		for(Field field : Field.values()) {
+			String defaultValue = Boolean.toString(isVisible(field));
+			String value = settings.getOrDefault(field.toString(), defaultValue);
+			setVisible(field, Boolean.valueOf(value));
+		}
+		visibleFields.toString();
+	}
+
+	public void changeSetting(Field field, boolean visible) {
+		if(prefService == null) return;
+		Map<String, String> settings = prefService.getMap(prefKey);
+		settings.put(field.toString(), Boolean.toString(visible));
+		prefService.putMap(prefKey, settings);
+	}
 }

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

@@ -57,6 +57,7 @@
 import org.scijava.log.LogService;
 import org.scijava.log.LogSource;
 import org.scijava.log.Logger;
+import org.scijava.prefs.PrefService;
 import org.scijava.thread.ThreadService;
 
 /**
@@ -99,11 +100,12 @@ public class LoggingPanel extends JPanel implements LogListener
 	// -- constructor --
 
 	public LoggingPanel(Context context) {
-		this(context.getService(ThreadService.class));
+		this(context.getService(ThreadService.class), null, null);
 	}
 
-	public LoggingPanel(ThreadService threadService) {
+	public LoggingPanel(ThreadService threadService, PrefService prefService, String prefKey) {
 		textArea = new ItemTextPane(threadService);
+		logFormatter.setPrefService(prefService, prefKey);
 		initGui();
 		setRecorder(new LogRecorder());
 	}

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

@@ -40,6 +40,7 @@
 import org.scijava.console.OutputEvent;
 import org.scijava.log.LogService;
 import org.scijava.plugin.Parameter;
+import org.scijava.prefs.PrefService;
 import org.scijava.thread.ThreadService;
 import org.scijava.ui.console.AbstractConsolePane;
 import org.scijava.ui.console.ConsolePane;
@@ -56,12 +57,17 @@
  */
 public class SwingConsolePane extends AbstractConsolePane<JPanel> {
 
+	public static final String LOG_FORMATTING_SETTINGS_KEY = "/log-formatting";
+
 	@Parameter
 	private ThreadService threadService;
 
 	@Parameter
 	private LogService logService;
 
+	@Parameter
+	private PrefService prefService;
+
 	private ConsolePanel consolePanel;
 
 	private LoggingPanel loggingPanel;
@@ -131,7 +137,7 @@ private ConsolePanel consolePanel() {
 	private synchronized void initLoggingPanel() {
 		if (consolePanel != null) return;
 		consolePanel = new ConsolePanel(threadService);
-		loggingPanel = new LoggingPanel(threadService);
+		loggingPanel = new LoggingPanel(threadService, prefService, LOG_FORMATTING_SETTINGS_KEY);
 		logService.addLogListener(loggingPanel);
 		component = new JPanel(new MigLayout("", "[grow]", "[grow]"));
 		JTabbedPane tabs = new JTabbedPane();

src/test/java/org/scijava/ui/swing/console/LogFormatterTest.java

@@ -0,0 +1,51 @@
+package org.scijava.ui.swing.console;
+
+import org.junit.Test;
+import org.scijava.Context;
+import org.scijava.prefs.PrefService;
+
+import java.util.Collections;
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Tests {@link LogFormatter}.
+ *
+ * @author Matthias Arzt
+ */
+public class LogFormatterTest {
+
+	@Test
+	public void testPrefService() {
+		PrefService prefService = new Context(PrefService.class).service(PrefService.class);
+		String expected = "Hello World";
+		prefService.put("foo", expected);
+		String actual = prefService.get("foo");
+		assertEquals(expected, actual);
+	}
+
+	@Test
+	public void testPrefServiceMap() {
+		PrefService prefService = new Context(PrefService.class).service(PrefService.class);
+		Map<String, String> expected = Collections.singletonMap("Hello", "World");
+		prefService.putMap("/foo", expected);
+		Map<String, String> actual = prefService.getMap("/foo");
+		assertEquals(expected, actual);
+	}
+
+	@Test
+	public void testSettings() {
+		PrefService prefService = new Context(PrefService.class).service(PrefService.class);
+		LogFormatter formatter1 = new LogFormatter();
+		formatter1.setPrefService(prefService, "/abc");
+		formatter1.setVisible(LogFormatter.Field.ATTACHMENT, true);
+		formatter1.setVisible(LogFormatter.Field.LEVEL, false);
+		LogFormatter formatter2 = new LogFormatter();
+		formatter2.setPrefService(prefService, "/abc");
+		assertTrue(formatter2.isVisible(LogFormatter.Field.ATTACHMENT));
+		assertFalse(formatter2.isVisible(LogFormatter.Field.LEVEL));
+	}
+}