Class Widgets

    • Constructor Summary

      Constructors 
      Constructor Description
      Widgets​(org.jline.reader.LineReader reader)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addWidget​(java.lang.String name, org.jline.reader.Widget widget)
      Add widget to the LineReader
      void aliasWidget​(java.lang.String orig, java.lang.String alias)
      Create alias to widget
      java.util.List<java.lang.String> args()
      Parse lineReader buffer and returns its arguments
      org.jline.reader.Buffer buffer()
      Get lineReader's buffer
      void callWidget​(java.lang.String name)
      Call widget.
      void clearDescription()
      Clears terminal status bar
      void clearTailTip()
      Clears command line command hint
      java.lang.String currChar()
      Access lineReader's buffer and return its current character
      void destroyDescription()
      Remove terminal status bar
      void executeWidget​(java.lang.String name)
      Bind widget to ctrl-alt-x and execute it
      boolean existsWidget​(java.lang.String name)
      Test if widget exists
      org.jline.keymap.KeyMap<org.jline.reader.Binding> getKeyMap()
      Get lineReader's Main KeyMap
      java.lang.String getWidget​(java.lang.String name)
      Resolve widget name if its alias is given as method parameter.
      java.lang.String lastBinding()
      Get lineReader's last binding
      org.jline.reader.Parser parser()
      Get lineReader's parser
      java.lang.String prevChar()
      Access lineReader buffer and return its previous character
      void putString​(java.lang.String string)
      Write the string parameter to the lineReader's buffer
      void replaceBuffer​(org.jline.reader.Buffer buffer)
      Replace lineReader buffer
      void setDescription​(java.util.List<org.jline.utils.AttributedString> desc)
      Set description text to the terminal status bar
      void setErrorIndex​(int errorIndex)
      Set errorIndex to the lineReader's highlighter
      void setErrorPattern​(java.util.regex.Pattern errorPattern)
      Set errorPattern to the lineReader's highlighter
      void setSuggestionType​(org.jline.reader.LineReader.SuggestionType type)
      Set lineReader's autosuggestion type
      void setTailTip​(java.lang.String tailTip)
      Set lineReader's command hint to be added in the command line
      java.lang.String tailTip()
      Get lineReader's command hint
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • AUTOSUGGEST_TOGGLE

        public static final java.lang.String AUTOSUGGEST_TOGGLE
        See Also:
        Constant Field Values
      • AP_BACKWARD_DELETE_CHAR

        protected static final java.lang.String AP_BACKWARD_DELETE_CHAR
        See Also:
        Constant Field Values
      • reader

        protected final org.jline.reader.LineReader reader
    • Constructor Detail

      • Widgets

        public Widgets​(org.jline.reader.LineReader reader)
    • Method Detail

      • addWidget

        public void addWidget​(java.lang.String name,
                              org.jline.reader.Widget widget)
        Add widget to the LineReader
        Parameters:
        name - the name of widget
        widget - widget
      • callWidget

        public void callWidget​(java.lang.String name)
        Call widget. System widget will be call if the name does not start with '_' or ends with '-toggle' i.e. '.' will be added at the beginning of the name.
        Parameters:
        name - widget name
      • executeWidget

        public void executeWidget​(java.lang.String name)
        Bind widget to ctrl-alt-x and execute it
        Parameters:
        name - widget name
      • aliasWidget

        public void aliasWidget​(java.lang.String orig,
                                java.lang.String alias)
        Create alias to widget
        Parameters:
        orig - widget original name
        alias - alias name
      • getWidget

        public java.lang.String getWidget​(java.lang.String name)
        Resolve widget name if its alias is given as method parameter. i.e. both method calls getWidget("yank") and getWidget(".yank") will return string ".yank"
        Parameters:
        name - widget name or alias
        Returns:
        widget name
      • existsWidget

        public boolean existsWidget​(java.lang.String name)
        Test if widget exists
        Parameters:
        name - widget name or its alias
        Returns:
        true if widget exists
      • parser

        public org.jline.reader.Parser parser()
        Get lineReader's parser
        Returns:
        The parser
      • getKeyMap

        public org.jline.keymap.KeyMap<org.jline.reader.Binding> getKeyMap()
        Get lineReader's Main KeyMap
        Returns:
        The KeyMap
      • buffer

        public org.jline.reader.Buffer buffer()
        Get lineReader's buffer
        Returns:
        The buffer
      • replaceBuffer

        public void replaceBuffer​(org.jline.reader.Buffer buffer)
        Replace lineReader buffer
        Parameters:
        buffer - buffer that will be copied to the LineReader Buffer
      • args

        public java.util.List<java.lang.String> args()
        Parse lineReader buffer and returns its arguments
        Returns:
        command line arguments
      • prevChar

        public java.lang.String prevChar()
        Access lineReader buffer and return its previous character
        Returns:
        previous character
      • currChar

        public java.lang.String currChar()
        Access lineReader's buffer and return its current character
        Returns:
        current character
      • lastBinding

        public java.lang.String lastBinding()
        Get lineReader's last binding
        Returns:
        last binding
      • putString

        public void putString​(java.lang.String string)
        Write the string parameter to the lineReader's buffer
        Parameters:
        string - string to be written
      • tailTip

        public java.lang.String tailTip()
        Get lineReader's command hint
        Returns:
        Command hint.
      • setTailTip

        public void setTailTip​(java.lang.String tailTip)
        Set lineReader's command hint to be added in the command line
        Parameters:
        tailTip - command hint
      • setErrorPattern

        public void setErrorPattern​(java.util.regex.Pattern errorPattern)
        Set errorPattern to the lineReader's highlighter
        Parameters:
        errorPattern - error pattern
      • setErrorIndex

        public void setErrorIndex​(int errorIndex)
        Set errorIndex to the lineReader's highlighter
        Parameters:
        errorIndex - error index
      • clearTailTip

        public void clearTailTip()
        Clears command line command hint
      • setSuggestionType

        public void setSuggestionType​(org.jline.reader.LineReader.SuggestionType type)
        Set lineReader's autosuggestion type
        Parameters:
        type - autosuggestion type
      • setDescription

        public void setDescription​(java.util.List<org.jline.utils.AttributedString> desc)
        Set description text to the terminal status bar
        Parameters:
        desc - description text
      • clearDescription

        public void clearDescription()
        Clears terminal status bar
      • destroyDescription

        public void destroyDescription()
        Remove terminal status bar