Package org.beryx.textio.jline

Class JLineTextTerminal

    • Constructor Detail

      • JLineTextTerminal

        public JLineTextTerminal()

      • JLineTextTerminal

        public JLineTextTerminal​(jline.console.ConsoleReader reader)

    • Method Detail

      • getStandardColorCode

        public static int getStandardColorCode​(java.lang.String colorName)

      • getColorCode

        public java.util.Optional<java.lang.String> getColorCode​(java.lang.String colorName)

      • getAnsiColor

        public java.lang.String getAnsiColor​(java.lang.String colorName)

      • getAnsiBackgroundColor

        public java.lang.String getAnsiBackgroundColor​(java.lang.String colorName)

      • createReader

        public static jline.console.ConsoleReader createReader()

      • read

        public java.lang.String read​(boolean masking)
        Description copied from interface: TextTerminal
        Reads a line of text
        Parameters:
        masking - true, if the input should be masked (for example to enter a password)
        Returns:
        the entered text

      • rawPrint

        public void rawPrint​(java.lang.String message)
        Description copied from interface: TextTerminal
        Prints the message in its raw form. This method expects a single line of text. The behavior is undefined if the string contains line separators.

      • printAnsi

        public void printAnsi​(java.lang.String message)

      • getAnsiPrefix

        public java.lang.String getAnsiPrefix​(org.beryx.textio.jline.JLineTextTerminal.StyleData styleData)

      • println

        public void println()
        Description copied from interface: TextTerminal
        Terminates the current line by writing the line separator string.

      • resetLine

        public boolean resetLine()
        Description copied from interface: TextTerminal
        Clears the current line of text. Since not all terminals support this feature, the default implementation calls TextTerminal.println() and returns false.
        Returns:
        true, if the terminal supports this feature and the current line has been successfully cleared.

      • moveToLineStart

        public boolean moveToLineStart()
        Description copied from interface: TextTerminal
        Moves the cursor to the start of the current line of text in order to allow overwriting the current line. Since not all terminals support this feature, the default implementation calls TextTerminal.println() and returns false.
        Returns:
        true, if the terminal supports this feature and the cursor has been moved to the start of the current line.

      • registerUserInterruptHandler

        public boolean registerUserInterruptHandler​(java.util.function.Consumer<JLineTextTerminal> handler,
                                            boolean abortRead)
        Description copied from interface: TextTerminal
        Registers a handler that will be called in response to a user interrupt. The event that triggers a user interrupt is usually Ctrl+C, but in general it is terminal specific. For example, a Swing based terminal may send a user interrupt when the X close button of its window is hit. Since not all terminals support this feature, the default implementation just returns false.
        Parameters:
        handler - the action to be performed in response to a user interrupt.
        abortRead - true, if the current read operation should be aborted on user interrupt.
        Returns:
        true, if the terminal supports this feature and the handler has been registered; false, otherwise.

      • registerHandler

        public boolean registerHandler​(java.lang.String keyStroke,
                               java.util.function.Function<JLineTextTerminal,​ReadHandlerData> handler)
        Description copied from interface: TextTerminal
        Associates a key combination to a handler. Since not all terminals support this feature, the default implementation just returns false.
        Parameters:
        keyStroke - the key combination associated with the handler. It should have the same format as the argument of KeyStroke.getKeyStroke(String).
        handler - the action to be performed when the keyStroke is detected during a read operation.
        Returns:
        true, if the terminal supports this feature and the handler has been associated with the given key combination; false, otherwise.

      • dispose

        public void dispose​(java.lang.String resultData)
        Description copied from interface: TextTerminal
        This method is typically called at the end of a text-based input/output session in order to allow the terminal to release its screen resources. The terminal should be able to rebuild the released resources when a print or read method is subsequently called. The default implementation does nothing.
        Parameters:
        resultData - stringified information about the outcome of the input/output session; may be null,

      • abort

        public void abort()
        Description copied from interface: TextTerminal
        This method is typically called when a text-based input/output session has been aborted by the user or when a severe error occurred. The default implementation does nothing.

      • getReader

        public jline.console.ConsoleReader getReader()

      • setPromptColor

        public void setPromptColor​(java.lang.String colorName)

      • setPromptBackgroundColor

        public void setPromptBackgroundColor​(java.lang.String colorName)

      • setPromptBold

        public void setPromptBold​(boolean bold)

      • setPromptItalic

        public void setPromptItalic​(boolean italic)

      • setPromptUnderline

        public void setPromptUnderline​(boolean underline)

      • setInputColor

        public void setInputColor​(java.lang.String colorName)

      • setInputBackgroundColor

        public void setInputBackgroundColor​(java.lang.String colorName)

      • setInputBold

        public void setInputBold​(boolean bold)

      • setInputItalic

        public void setInputItalic​(boolean italic)

      • setInputUnderline

        public void setInputUnderline​(boolean underline)

      • setAnsiColorMode

        public void setAnsiColorMode​(java.lang.String mode)

      • getKeySequence

        public static java.lang.String getKeySequence​(java.lang.String keyStroke)