Widgets (JLine Console 3.23.0 API)

java.lang.Object
- org.jline.widget.Widgets

Direct Known Subclasses:

AutopairWidgets, AutosuggestionWidgets, TailTipWidgets
```
public abstract class Widgets
extends Object
```
Create custom widgets by extending Widgets class

Author:

Matti Rinta-Nikkola

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`AP_BACKWARD_DELETE_CHAR`
`protected static String`	`AP_INSERT`
`static String`	`AUTOPAIR_TOGGLE`
`static String`	`AUTOSUGGEST_TOGGLE`
`protected org.jline.reader.LineReader`	`reader`
`static String`	`TAILTIP_PANE`
`static String`	`TAILTIP_TOGGLE`
`protected static String`	`TT_ACCEPT_LINE`

Constructor Summary

Constructors
Constructor and Description

Widgets(org.jline.reader.LineReader reader)

Constructors
Constructor and Description
`Widgets(org.jline.reader.LineReader reader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDescription(List<org.jline.utils.AttributedString> desc)` Add description text to the terminal status bar
`void`	`addWidget(String name, org.jline.reader.Widget widget)` Add widget to the LineReader
`void`	`aliasWidget(String orig, String alias)` Create alias to widget
`List<String>`	`args()` Parse lineReader buffer and returns its arguments
`org.jline.reader.Buffer`	`buffer()` Get lineReader's buffer
`void`	`callWidget(String name)` Call widget.
`void`	`clearDescription()` Clears terminal status bar
`void`	`clearTailTip()` Clears command line command hint
`String`	`currChar()` Access lineReader's buffer and return its current character
`void`	`destroyDescription()` Remove terminal status bar
`void`	`executeWidget(String name)` Bind widget to ctrl-alt-x and execute it
`boolean`	`existsWidget(String name)` Test if widget exists
`org.jline.keymap.KeyMap<org.jline.reader.Binding>`	`getKeyMap()` Get lineReader's Main KeyMap
`String`	`getWidget(String name)` Resolve widget name if its alias is given as method parameter.
`void`	`initDescription(int size)` Initialize terminal status bar
`String`	`lastBinding()` Get lineReader's last binding
`org.jline.reader.Parser`	`parser()` Get lineReader's parser
`String`	`prevChar()` Access lineReader buffer and return its previous character
`void`	`putString(String string)` Write the string parameter to the lineReader's buffer
`void`	`replaceBuffer(org.jline.reader.Buffer buffer)` Replace lineReader buffer
`void`	`setErrorIndex(int errorIndex)` Set errorIndex to the lineReader's highlighter
`void`	`setErrorPattern(Pattern errorPattern)` Set errorPattern to the lineReader's highlighter
`void`	`setSuggestionType(org.jline.reader.LineReader.SuggestionType type)` Set lineReader's autosuggestion type
`void`	`setTailTip(String tailTip)` Set lineReader's command hint to be added in the command line
`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
  - TAILTIP_TOGGLE
```
public static final String TAILTIP_TOGGLE
```
    See Also:
    
    Constant Field Values
  - TAILTIP_PANE
```
public static final String TAILTIP_PANE
```
    See Also:
    
    Constant Field Values
  - AUTOPAIR_TOGGLE
```
public static final String AUTOPAIR_TOGGLE
```
    See Also:
    
    Constant Field Values
  - AUTOSUGGEST_TOGGLE
```
public static final String AUTOSUGGEST_TOGGLE
```
    See Also:
    
    Constant Field Values
  - AP_INSERT
```
protected static final String AP_INSERT
```
    See Also:
    
    Constant Field Values
  - AP_BACKWARD_DELETE_CHAR
```
protected static final String AP_BACKWARD_DELETE_CHAR
```
    See Also:
    
    Constant Field Values
  - TT_ACCEPT_LINE
```
protected static final String TT_ACCEPT_LINE
```
    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(String name,
                      org.jline.reader.Widget widget)
```
    Add widget to the LineReader
    
    Parameters:
    
    name - the name of widget
    
    widget - widget
  - callWidget
```
public void callWidget(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(String name)
```
    Bind widget to ctrl-alt-x and execute it
    
    Parameters:
    
    name - widget name
  - aliasWidget
```
public void aliasWidget(String orig,
                        String alias)
```
    Create alias to widget
    
    Parameters:
    
    orig - widget original name
    
    alias - alias name
  - getWidget
```
public String getWidget(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(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 List<String> args()
```
    Parse lineReader buffer and returns its arguments
    
    Returns:
    
    command line arguments
  - prevChar
```
public String prevChar()
```
    Access lineReader buffer and return its previous character
    
    Returns:
    
    previous character
  - currChar
```
public String currChar()
```
    Access lineReader's buffer and return its current character
    
    Returns:
    
    current character
  - lastBinding
```
public String lastBinding()
```
    Get lineReader's last binding
    
    Returns:
    
    last binding
  - putString
```
public void putString(String string)
```
    Write the string parameter to the lineReader's buffer
    
    Parameters:
    
    string - string to be written
  - tailTip
```
public String tailTip()
```
    Get lineReader's command hint
    
    Returns:
    
    Command hint.
  - setTailTip
```
public void setTailTip(String tailTip)
```
    Set lineReader's command hint to be added in the command line
    
    Parameters:
    
    tailTip - command hint
  - setErrorPattern
```
public void setErrorPattern(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
  - addDescription
```
public void addDescription(List<org.jline.utils.AttributedString> desc)
```
    Add description text to the terminal status bar
    
    Parameters:
    
    desc - description text
  - clearDescription
```
public void clearDescription()
```
    Clears terminal status bar
  - initDescription
```
public void initDescription(int size)
```
    Initialize terminal status bar
    
    Parameters:
    
    size - Terminal status bar size in rows
  - destroyDescription
```
public void destroyDescription()
```
    Remove terminal status bar

Class Widgets

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAILTIP_TOGGLE

TAILTIP_PANE

AUTOPAIR_TOGGLE

AUTOSUGGEST_TOGGLE

AP_INSERT

AP_BACKWARD_DELETE_CHAR

TT_ACCEPT_LINE

reader

Constructor Detail

Widgets

Method Detail

addWidget

callWidget

executeWidget

aliasWidget

getWidget

existsWidget

parser

getKeyMap

buffer

replaceBuffer

args

prevChar

currChar

lastBinding

putString

tailTip

setTailTip

setErrorPattern

setErrorIndex

clearTailTip

setSuggestionType

addDescription

clearDescription

initDescription

destroyDescription