LoggingPanel: add gui for text filtering

Author: maarzt

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

@@ -31,6 +31,7 @@
 package org.scijava.ui.swing.console;
 
 import java.awt.*;
+import java.util.function.Predicate;
 
 import javax.swing.*;
 import javax.swing.text.AttributeSet;
@@ -42,26 +43,22 @@
 
 import net.miginfocom.swing.MigLayout;
 
-import org.scijava.console.OutputListener;
 import org.scijava.log.IgnoreAsCallingClass;
+import org.scijava.log.LogLevel;
 import org.scijava.log.LogListener;
 import org.scijava.log.LogMessage;
 import org.scijava.log.LogService;
 import org.scijava.log.Logger;
-import org.scijava.log.LogLevel;
 import org.scijava.thread.ThreadService;
 import org.scijava.ui.swing.StaticSwingUtils;
 
 /**
- * LoggingPanel can display log message and console output as a list, and
- * provides convenient ways for the user to filter this list.
- * LoggingPanel implements {@link LogListener} and {@link OutputListener}, that
- * way it can receive log message and console output from {@link LogService},
- * {@link Logger} and {@link org.scijava.console.ConsoleService}
+ * {@link LoggingPanel} can displays log messages, and provides convenient ways
+ * for the user to filter this list. LoggingPanel can receive log messages from
+ * {@link LogService} and {@link Logger}.
  *
  * @see LogService
  * @see Logger
- * @see org.scijava.console.ConsoleService
  * @author Matthias Arzt
  */
 @IgnoreAsCallingClass
@@ -75,12 +72,14 @@ public class LoggingPanel extends JPanel implements LogListener
 	private static final AttributeSet STYLE_TRACE = normal(Color.GRAY);
 	private static final AttributeSet STYLE_OTHERS = normal(Color.GRAY);
 
+	private final TextFilterField textFilter = new TextFilterField(" Text Search (Alt-F)");
 	private JTextPane textPane;
 	private JScrollPane scrollPane;
 
 	private StyledDocument doc;
 
 	private final LogFormatter formatter = new LogFormatter();
+	private Predicate<String> filter = text -> true;
 
 	private final ThreadService threadService;
 
@@ -103,6 +102,8 @@ public void messageLogged(LogMessage message) {
 	// -- Helper methods --
 
 	private void appendText(final String text, final AttributeSet style) {
+		if(!filter.test(text)) return;
+
 		threadService.queue(new Runnable() {
 
 			@Override
@@ -120,8 +121,14 @@ public void run() {
 		});
 	}
 
-	private synchronized void initGui() {
-		setLayout(new MigLayout("inset 0", "[grow,fill]", "[grow,fill,align top]"));
+	// -- Helper methods --
+
+	private void initGui() {
+
+		setLayout(new MigLayout("insets 0", "[grow]", "[][grow]"));
+
+		textFilter.setChangeListener(this::updateFilter);
+		add(textFilter.getComponent(), "grow, wrap");
 
 		textPane = new JTextPane();
 		textPane.setFont(new Font(Font.MONOSPACED, Font.PLAIN, 12));
@@ -148,7 +155,11 @@ private synchronized void initGui() {
 		scrollPane.getHorizontalScrollBar().setUnitIncrement(charWidth);
 		scrollPane.getVerticalScrollBar().setUnitIncrement(2 * lineHeight);
 
-		add(scrollPane);
+		add(scrollPane, "grow");
+	}
+
+	private void updateFilter() {
+		filter = textFilter.getFilter();
 	}
 
 	private static AttributeSet getLevelStyle(int i) {

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

@@ -0,0 +1,135 @@
+/*
+ * #%L
+ * SciJava UI components for Java Swing.
+ * %%
+ * Copyright (C) 2010 - 2017 Board of Regents of the University of
+ * Wisconsin-Madison.
+ * %%
+ * 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.console;
+
+import java.awt.*;
+import java.util.function.Predicate;
+
+import javax.swing.*;
+import javax.swing.border.EmptyBorder;
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
+
+/**
+ * {@link TextFilterField} provides a {@link JTextField} and derives text filter
+ * from the content.
+ *
+ * @author Matthias Arzt
+ */
+class TextFilterField {
+
+	private final JTextField textField = new JTextField();
+
+	private JLabel prompt = new JLabel();
+
+	private Predicate<String> filter = null;
+
+	private Runnable changeListener = null;
+
+	// -- constructor --
+
+	TextFilterField(String textForPrompt) {
+		initPrompt(textForPrompt);
+		textField.getDocument().addDocumentListener(new DocumentListener() {
+
+			@Override
+			public void insertUpdate(DocumentEvent documentEvent) {
+				onUserInputChanged();
+			}
+
+			@Override
+			public void removeUpdate(DocumentEvent documentEvent) {
+				onUserInputChanged();
+			}
+
+			@Override
+			public void changedUpdate(DocumentEvent documentEvent) {
+				onUserInputChanged();
+			}
+		});
+	}
+
+	// -- TextFilterField methods --
+
+	public JTextField getComponent() {
+		return textField;
+	}
+
+	public void setChangeListener(Runnable changeListener) {
+		this.changeListener = changeListener;
+	}
+
+	public Predicate<String> getFilter() {
+		if (filter == null) filter = calculateFilter();
+		return filter;
+	}
+
+	// -- Helper methods --
+
+	private Predicate<String> calculateFilter() {
+		String text = textField.getText();
+		final String[] words = text.split(" ");
+		return s -> {
+			for (String word : words)
+				if (!s.contains(word)) return false;
+			return true;
+		};
+	}
+
+	private void onUserInputChanged() {
+		filter = null;
+		updatePromptVisibility();
+		notifyChangeListener();
+	}
+
+	private void notifyChangeListener() {
+		if (changeListener != null) changeListener.run();
+	}
+
+	private void initPrompt(String text) {
+		prompt.setText(text);
+		prompt.setFont(textField.getFont().deriveFont(Font.ITALIC));
+		prompt.setForeground(changeAlpha(textField.getForeground(), 128));
+		prompt.setBorder(new EmptyBorder(textField.getInsets()));
+		prompt.setHorizontalAlignment(JLabel.LEADING);
+		textField.setLayout(new BorderLayout());
+		textField.add(prompt);
+		updatePromptVisibility();
+	}
+
+	private static Color changeAlpha(Color color, int alpha) {
+		return new Color(color.getRed(), color.getGreen(), color.getBlue(), alpha);
+	}
+
+	private void updatePromptVisibility() {
+		prompt.setVisible(textField.getDocument().getLength() == 0);
+	}
+}