add withProperties methods

Author: siordache

dist/xbin/Cuboid.properties

@@ -2,32 +2,31 @@
 
 textio.user.interrupt.key = ctrl Q
 
-textio.custom.default.color = white
-textio.custom.default.bgcolor = black
+textio.custom.neutral.prompt.color = white
+textio.custom.neutral.prompt.bgcolor = black
+textio.custom.neutral.input.color = white
+textio.custom.neutral.input.bgcolor = black
 
-textio.custom.title.color = black
-textio.custom.title.bgcolor = green
-textio.custom.title.bold = true
-web.custom.title.style = fancy-border
+textio.custom.title.prompt.color = black
+textio.custom.title.prompt.bgcolor = green
+textio.custom.title.prompt.bold = true
+textio.custom.title.prompt.style.class = fancy-border
 
 textio.custom.length.prompt.color = cyan
 textio.custom.length.prompt.bgcolor = black
 textio.custom.length.prompt.italic = true
 textio.custom.length.input.color = blue
 textio.custom.length.input.bold = true
-web.custom.length.style =
 
 textio.custom.width.prompt.color = green
 textio.custom.width.prompt.bgcolor = black
-textio.custom.width.underline = true
+textio.custom.width.prompt.underline = true
 textio.custom.width.input.color = yellow
 textio.custom.width.input.italic = true
-web.custom.width.style =
 
 textio.custom.height.prompt.color = magenta
 textio.custom.height.prompt.bgcolor = black
 textio.custom.height.input.color = red
 textio.custom.height.input.italic = true
 textio.custom.height.input.underline = true
-web.custom.height.style =
 

doc/user_guide.adoc

@@ -329,13 +329,56 @@ link:{blob-root}/text-io-demo/src/main/java/org/beryx/textio/demo[source code]
 and the link:{blob-root}/dist/xbin[configuration files]
 of the https://github.com/beryx/text-io/releases/download/v{project-version}/textio-demo-{project-version}.zip[demo application].
 
+[[terminal_temporary_props]]
+=== TextTerminal temporary properties
+
+Sometimes you want to temporarily change some TextTerminal properties and revert them to their previous values after a couple of operations.
+You can achieve this by passing the sequence of operations to be executed with modified properties as argument to the
+link:javadoc/org/beryx/textio/TextTerminal.html#executeWithPropertiesConfigurator-java.util.function.Consumer-java.util.function.Consumer-[executeWithPropertiesConfigurator()]
+method, as shown in the example below.
+[source,java]
+----
+textTerminal.getProperties().setPromptColor("cyan");
+textTerminal.println("1. Choose the desired hard drive.");
+textTerminal.executeWithPropertiesConfigurator(
+        props -> props.setPromptColor("red"),
+        t -> t.println("2. Backup all your data."));
+textTerminal.println("3. Start the formatting process.");
+----
+The second message will appear in red, while the other two will be printed in cyan.
+
+The code above uses hard-coded property values.
+A more elegant solution is to specify these values in the `textio.properties` file.
+TextTerminal offers the
+link:javadoc/org/beryx/textio/TextTerminal.html#executeWithPropertiesPrefix-java.util.function.Consumer-java.util.function.Consumer-[executeWithPropertiesConfigurator()]
+convenience method to help you accomplish this task.
+
+Consider the code below:
+[source,java]
+----
+textTerminal.println("1. Choose the desired hard drive.");
+textTerminal.executeWithPropertiesPrefix("warn",
+        t -> t.println("2. Backup all your data."));
+textTerminal.println("3. Start the formatting process.");
+----
+and let's assume that your `textio.properties` contains:
+[source]
+----
+textio.prompt.color = cyan
+textio.warn.prompt.color = red
+----
+Then, the second message will appear in red, while the other two will be printed in cyan.
+
+TIP: Look at the source code of
+link:{blob-root}/text-io-demo/src/main/java/org/beryx/textio/demo/app/Cuboid.java[Cuboid.java]
+for an example of using temporary TextTerminal properties.
+
 [[input_reader_props]]
 === InputReader-specific properties
 
-Sometimes you want to change some TextTerminal properties for the next read operation, but want to revert to the previous property values at the end of this read operation.
-You can achieve this by configuring InputReader-specific properties via the
-link:javadoc/org/beryx/textio/InputReader.html#withPropertiesConfigurator-java.util.function.Consumer-withPropertiesConfigurator[withPropertiesConfigurator()]
-method, as shown in the example below.
+If you want to apply some temporary TextTerminal properties only during the next read operation, you can call the
+link:javadoc/org/beryx/textio/InputReader.html#withPropertiesConfigurator-java.util.function.Consumer-[withPropertiesConfigurator()]
+method of your InputReader, as shown in the example below.
 [source,java]
 ----
 textIO.getTextTerminal().getProperties().setPromptColor("cyan");
@@ -347,6 +390,36 @@ String directory = textIO.newStringInputReader().read("Home directory");
 ----
 The question _"Erase all data?"_ will appear in red, while _"User name"_ and _"Home directory"_ will be printed in cyan.
 
+The code above uses hard-coded property values.
+A more elegant solution is to specify these values in the `textio.properties` file.
+InputReader offers the
+link:javadoc/org/beryx/textio/InputReader.html#withPropertiesPrefix-java.lang.String-[withPropertiesPrefix()]
+convenience method to help you accomplish this task.
+
+Consider the code below:
+[source,java]
+----
+String user = textIO.newStringInputReader().read("User name");
+textIO.newBooleanInputReader()
+   .withPropertiesPrefix("warn")
+   .read("Erase all data?");
+String directory = textIO.newStringInputReader().read("Home directory");
+----
+and let's assume that your `textio.properties` contains:
+[source]
+----
+textio.prompt.color = green
+textio.input.color = yellow
+textio.warn.prompt.color = red
+textio.warn.input.color = orange
+----
+Then, the question _"Erase all data?"_ will appear in red and its corresponding user input in orange.
+For the other two read operations the questions will be displayed in green and the user input in yellow.
+
+TIP: Look at the source code of
+link:{blob-root}/text-io-demo/src/main/java/org/beryx/textio/demo/app/Cuboid.java[Cuboid.java]
+for an example of using InputReader-specific properties.
+
 
 [[web_text_term]]
 == Using the WebTextTerminal

text-io-demo/src/main/java/org/beryx/textio/demo/app/Cuboid.java

@@ -29,94 +29,39 @@ public static void main(String[] args) {
         new Cuboid().accept(textIO, null);
     }
 
-    private static class TextProps {
-        private final String prefix;
-        private final TerminalProperties<?> props;
-
-        public final String color;
-        public final String bgcolor;
-        public final boolean bold;
-        public final boolean italic;
-        public final boolean underline;
-        public final String style;
-
-        public TextProps(TerminalProperties<?> props, String prefix) {
-            this.props = props;
-            this.prefix = prefix;
-            color = props.getString(propName("color"));
-            bgcolor = props.getString(propName("bgcolor"));
-            bold = props.getBoolean(propName("bold"), false);
-            italic = props.getBoolean(propName("italic"), false);
-            underline = props.getBoolean(propName("underline"), false);
-            style = props.getString(propName("style"));
-        }
-
-        private String propName(String name) {
-            return "custom." + prefix + "." + name;
-        }
-
-        public void configurePrompt() {
-            if(color != null) {
-                props.setPromptColor(color);
-            }
-            if(bgcolor != null) {
-                props.setPromptBackgroundColor(bgcolor);
-            }
-            props.setPromptBold(bold);
-            props.setPromptItalic(italic);
-            props.setPromptUnderline(underline);
-            props.put(PropertiesConstants.PROP_PROMPT_STYLE_CLASS, style);
-        }
-
-        public void configureInput() {
-            if(color != null) {
-                props.setInputColor(color);
-            }
-            if(bgcolor != null) {
-                props.setInputBackgroundColor(bgcolor);
-            }
-            props.setInputBold(bold);
-            props.setInputItalic(italic);
-            props.setInputUnderline(underline);
-            props.put(PropertiesConstants.PROP_INPUT_STYLE_CLASS, style);
-        }
-    }
-
     @Override
     public void accept(TextIO textIO, RunnerData runnerData) {
         TextTerminal<?> terminal = textIO.getTextTerminal();
         String initData = (runnerData == null) ? null : runnerData.getInitData();
         AppUtil.printGsonMessage(terminal, initData);
 
-        TerminalProperties<?> props = terminal.getProperties();
-
-        new TextProps(props, "title").configurePrompt();
-        terminal.println("Cuboid dimensions");
+        terminal.executeWithPropertiesPrefix("custom.title", t -> t.print("Cuboid dimensions: "));
+        terminal.println();
 
-        new TextProps(props, "length.prompt").configurePrompt();
-        new TextProps(props, "length.input").configureInput();
         double length = textIO.newDoubleInputReader()
                 .withMinVal(0.0)
+                .withPropertiesPrefix("custom.length")
                 .read("Length");
 
-        new TextProps(props, "width.prompt").configurePrompt();
-        new TextProps(props, "width.input").configureInput();
         double width = textIO.newDoubleInputReader()
                 .withMinVal(0.0)
+                .withPropertiesPrefix("custom.width")
                 .read("Width");
 
-        new TextProps(props, "height.prompt").configurePrompt();
-        new TextProps(props, "height.input").configureInput();
         double height = textIO.newDoubleInputReader()
                 .withMinVal(0.0)
+                .withPropertiesPrefix("custom.height")
                 .read("Height");
 
 
-        new TextProps(props, "title").configurePrompt();
-        terminal.println("The volume of your cuboid is: " + length * width * height);
+        terminal.executeWithPropertiesPrefix("custom.title",
+                t -> t.print("The volume of your cuboid is: " + length * width * height));
+        terminal.println();
 
-        new TextProps(props, "default").configurePrompt();
-        textIO.newStringInputReader().withMinLength(0).read("\nPress enter to terminate...");
+        textIO.newStringInputReader()
+                .withMinLength(0)
+                .withPropertiesPrefix("custom.neutral")
+                .read("\nPress enter to terminate...");
         textIO.dispose();
     }
 

text-io-demo/src/main/resources/public-html/web-demo.css

@@ -1,4 +1,6 @@
 .fancy-border {
     border-style: dashed;
     border-color: orange;
+    line-height: 2.0;
+    font-size: 18px;
 }

text-io/src/main/java/org/beryx/textio/InputReader.java

@@ -267,6 +267,36 @@ public B withPropertiesConfigurator(Consumer<TerminalProperties<?>> propertiesCo
         return (B)this;
     }
 
+    /** Convenience method that calls {@link #withPropertiesConfigurator(Consumer)}
+     * with a configurator that takes all terminal properties with the given prefix
+     * and applies them after stripping the prefix from their keys.
+     * <br>For example, if {@code textio.properties} contains:
+     * <pre>
+     *   textio.prompt.color = green
+     *   textio.input.color = yellow
+     *   textio.warn.prompt.color = red
+     *   textio.warn.input.color = orange
+     * </pre>
+     * then the following statement:
+     * <pre>
+     *   textIO.newBooleanInputReader()
+     *      .withPropertiesPrefix("warn")
+     *      .read("Erase all data?");
+     * </pre>
+     * will display the question in red and the user input in orange.
+     **/
+    @SuppressWarnings("unchecked")
+    public B withPropertiesPrefix(String prefix) {
+        return withPropertiesConfigurator(t -> {
+            Set<String> keys = t.getMatchingKeys(key -> key.startsWith(prefix + "."));
+            int len = prefix.length() + 1;
+            keys.forEach(key -> {
+                String baseKey = key.substring(len);
+                t.put(baseKey, t.getString(key));
+            });
+        });
+    }
+
     /**
      * @return true, if currently reading a list of values via {@link #readList(List)}
      */

text-io/src/main/java/org/beryx/textio/TerminalProperties.java

@@ -19,11 +19,10 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.function.Function;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
 
 import static org.beryx.textio.PropertiesConstants.*;
 
@@ -161,6 +160,18 @@ public void putAll(Map<String, ? extends Object> map) {
         map.entrySet().forEach(entry -> put(entry.getKey(), entry.getValue()));
     }
 
+    public Set<String> getAllKeys() {
+        return props.keySet();
+    }
+
+    public Set<String> getMatchingKeys(String regex) {
+        return getMatchingKeys(key -> key.matches(regex));
+    }
+
+    public Set<String> getMatchingKeys(Predicate<String> keyFilter) {
+        return props.keySet().stream().filter(keyFilter).collect(Collectors.toSet());
+    }
+
     /**
      * @return the value associated with the specified key.
      */