configure the title bar of a Swing text terminal

beryx · Jun 3, 2017 · 5b564ae · 5b564ae
1 parent 0b285e7
commit 5b564ae
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 0 deletions.
diff --git a/dist/xbin/UserDataCollector.properties b/dist/xbin/UserDataCollector.properties
@@ -25,5 +25,9 @@ textio.input.color = yellow
 
 # swing.prompt.color = #22ff88
 textio.pane.bgcolor = #002f00
+textio.pane.title = User Data Collector
+textio.pane.icon.file = data.png
+# textio.pane.icon.resource = /your/resource/path/data.png
+# textio.pane.icon.url = https://upload.wikimedia.org/wikipedia/commons/4/42/Favicon%28PNG%29.PNG
 
 # jline.ansi.color.mode = indexed
diff --git a/dist/xbin/data.png b/dist/xbin/data.png
diff --git a/doc/user_guide.adoc b/doc/user_guide.adoc
@@ -205,7 +205,11 @@ Default value: `false`.
 |input.underline | &#x2713; | &#x2713; | &#x2713; | `true`, if the input text should be underlined. +
 Default value: `false`.
 |pane.bgcolor | - | &#x2713; | &#x2713; | The background color of the terminal pane.
+|pane.icon.file | - | &#x2713; | - | The path to the file containing the icon to be used in the title bar of the terminal pane.
+|pane.icon.resource | - | &#x2713; | - | The name of the resource containing the icon to be used in the title bar of the terminal pane.
+|pane.icon.url | - | &#x2713; | - | The URL of the icon to be used in the title bar of the terminal pane.
 |pane.style.class | - | - | &#x2713; | The CSS style class of the terminal pane.
+|pane.title | - | &#x2713; | - | The text to appear in the title bar of the terminal pane.
 |prompt.bgcolor | &#x2713; | &#x2713; | &#x2713; | The background color of the prompt text.
 |prompt.bold | &#x2713; | &#x2713; | &#x2713; | `true`, if the prompt text should be bold. +
 Default value: `false`.

diff --git a/text-io/src/main/java/org/beryx/textio/PropertiesConstants.java b/text-io/src/main/java/org/beryx/textio/PropertiesConstants.java
@@ -26,6 +26,11 @@ public class PropertiesConstants {
     public static final String PROP_PANE_BGCOLOR = "pane.bgcolor";
     public static final String PROP_PANE_STYLE_CLASS = "pane.style.class";
 
+    public static final String PROP_PANE_TITLE = "pane.title";
+    public static final String PROP_PANE_ICON_URL = "pane.icon.url";
+    public static final String PROP_PANE_ICON_FILE = "pane.icon.file";
+    public static final String PROP_PANE_ICON_RESOURCE = "pane.icon.resource";
+
     public static final String PROP_ANSI_COLOR_MODE = "ansi.color.mode";
 
     public static final String PROP_USER_INTERRUPT_KEY = "user.interrupt.key";

diff --git a/text-io/src/main/java/org/beryx/textio/swing/SwingTextTerminal.java b/text-io/src/main/java/org/beryx/textio/swing/SwingTextTerminal.java
@@ -22,6 +22,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.imageio.ImageIO;
 import javax.swing.*;
 import javax.swing.text.*;
 import java.awt.*;
@@ -30,6 +31,10 @@
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
 import java.util.Optional;
 import java.util.function.Consumer;
 
@@ -168,6 +173,10 @@ public SwingTextTerminal() {
         props.addStringListener(PROP_USER_INTERRUPT_KEY, null, (term, newVal) -> setUserInterruptKey(newVal));
 
         props.addStringListener(PROP_PANE_BGCOLOR, null, (term, newVal) -> setPaneBackgroundColor(newVal));
+        props.addStringListener(PROP_PANE_TITLE, null, (term, newVal) -> setPaneTitle(newVal));
+        props.addStringListener(PROP_PANE_ICON_URL, null, (term, newVal) -> setPaneIconUrl(newVal));
+        props.addStringListener(PROP_PANE_ICON_FILE, null, (term, newVal) -> setPaneIconFile(newVal));
+        props.addStringListener(PROP_PANE_ICON_RESOURCE, null, (term, newVal) -> setPaneIconResource(newVal));
 
         props.addStringListener(PROP_PROMPT_COLOR, null, (term, newVal) -> setPromptColor(newVal));
         props.addStringListener(PROP_PROMPT_BGCOLOR, null, (term, newVal) -> setPromptBackgroundColor(newVal));
@@ -422,6 +431,39 @@ public void setPaneBackgroundColor(String colorName) {
         getColor(colorName).ifPresent(col -> textPane.setBackground(col));
     }
 
+    public void setPaneTitle(String newTitle) {
+        frame.setTitle(newTitle);
+    }
+
+    public void setPaneIconUrl(String url) {
+        try {
+            frame.setIconImage(ImageIO.read(new URL(url)));
+        } catch (IOException e) {
+            logger.warn("Cannot set icon from URL " + url, e);
+        }
+    }
+
+    public void setPaneIconFile(String filePath) {
+        try {
+            frame.setIconImage(ImageIO.read(new File(filePath)));
+        } catch (IOException e) {
+            logger.warn("Cannot set icon from file " + filePath, e);
+        }
+    }
+
+    public void setPaneIconResource(String res) {
+        InputStream istream = getClass().getResourceAsStream(res);
+        if(istream == null) {
+            logger.warn("Cannot find icon resource " + res);
+        } else {
+            try {
+                frame.setIconImage(ImageIO.read(istream));
+            } catch (IOException e) {
+                logger.warn("Cannot set icon from resource " + res, e);
+            }
+        }
+    }
+
 
     public static Optional<Color> getColor(String colorName) {
         try {