Widgets (JLine Builtins 3.15.0 API)

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

Direct Known Subclasses:

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

Author:

Matti Rinta-Nikkola

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Widgets.AutopairWidgets`	Creates and manages widgets that auto-closes, deletes and skips over matching delimiters intelligently.
`static class`	`Widgets.AutosuggestionWidgets`	Creates and manages widgets for as you type command line suggestions.
`static class`	`Widgets.CmdLine`
`static class`	`Widgets.TailTipWidgets`	Creates and manages widgets for as you type command line suggestions.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static String`	`AP_BACKWARD_DELETE_CHAR`
`protected static String`	`AP_INSERT`
`protected static String`	`AP_TOGGLE`
`protected static String`	`TT_ACCEPT_LINE`
`protected static String`	`TT_TOGGLE`

Constructor Summary

Constructors
Constructor Description

Widgets(LineReader reader)

Constructors
Constructor	Description
`Widgets(LineReader reader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDescription(List<org.jline.utils.AttributedString> desc)`
`void`	`addWidget(String name, Widget widget)`	Add widget to the LineReader
`void`	`aliasWidget(String orig, String alias)`	Create alias to widget
`List<String>`	`args()`
`Buffer`	`buffer()`
`void`	`callWidget(String name)`	Call widget.
`void`	`clearDescription()`	Clears terminal status bar
`void`	`clearTailTip()`	Clears command line tail tip
`String`	`currChar()`
`void`	`destroyDescription()`	Remove terminal status bar
`void`	`executeWidget(String name)`	Bind widget to ctrl-alt-x and execute it
`boolean`	`existsWidget(String name)`
`KeyMap<Binding>`	`getKeyMap()`
`String`	`getWidget(String name)`
`void`	`initDescription(int size)`	Initialize terminal status bar
`String`	`lastBinding()`
`Parser`	`parser()`
`String`	`prevChar()`
`void`	`putString(String string)`
`void`	`replaceBuffer(Buffer buffer)`
`void`	`setErrorIndex(int errorIndex)`
`void`	`setErrorPattern(Pattern errorPattern)`
`void`	`setSuggestionType(LineReader.SuggestionType type)`
`void`	`setTailTip(String tailTip)`
`String`	`tailTip()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AP_TOGGLE
```
protected static final String AP_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_TOGGLE
```
protected static final String TT_TOGGLE
```
    See Also:
    
    Constant Field Values
  - TT_ACCEPT_LINE
```
protected static final String TT_ACCEPT_LINE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Widgets
```
public Widgets(LineReader reader)
```
- Method Detail
  - addWidget
```
public void addWidget(String name,
                      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 orginal name
    
    alias - alias name
  - getWidget
```
public String getWidget(String name)
```
    Parameters:
    
    name - widget name or alias
    
    Returns:
    
    widget name
  - existsWidget
```
public boolean existsWidget(String name)
```
    Parameters:
    
    name - widget name or alias
    
    Returns:
    
    true if widget exists
  - parser
```
public Parser parser()
```
    Returns:
    
    The LineRearer Parser
  - getKeyMap
```
public KeyMap<Binding> getKeyMap()
```
    Returns:
    
    The LineReader Main KeyMap
  - buffer
```
public Buffer buffer()
```
    Returns:
    
    The LineReader Buffer
  - replaceBuffer
```
public void replaceBuffer(Buffer buffer)
```
    Parameters:
    
    buffer - buffer that will be copied to the LineReader Buffer
  - args
```
public List<String> args()
```
    Returns:
    
    command line arguments
  - prevChar
```
public String prevChar()
```
    Returns:
    
    Buffer's previous character
  - currChar
```
public String currChar()
```
    Returns:
    
    Buffer's current character
  - lastBinding
```
public String lastBinding()
```
    Returns:
    
    LineReader's last binding
  - putString
```
public void putString(String string)
```
    Parameters:
    
    string - string to be written into LineReader Buffer
  - tailTip
```
public String tailTip()
```
    Returns:
    
    Command line tail tip.
  - setTailTip
```
public void setTailTip(String tailTip)
```
    Parameters:
    
    tailTip - tail tip to be added to the command line
  - setErrorPattern
```
public void setErrorPattern(Pattern errorPattern)
```
    Parameters:
    
    errorPattern - error pattern to be set LineReader Highlighter
  - setErrorIndex
```
public void setErrorIndex(int errorIndex)
```
    Parameters:
    
    errorIndex - error index to be set LineReader Highlighter
  - clearTailTip
```
public void clearTailTip()
```
    Clears command line tail tip
  - setSuggestionType
```
public void setSuggestionType(LineReader.SuggestionType type)
```
    Parameters:
    
    type - type to be set to the LineReader autosuggestion
  - addDescription
```
public void addDescription(List<org.jline.utils.AttributedString> desc)
```
    Parameters:
    
    desc - Text to be dispalyed on terminal status bar
  - 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

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AP_TOGGLE

AP_INSERT

AP_BACKWARD_DELETE_CHAR

TT_TOGGLE

TT_ACCEPT_LINE

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