Package org.jline.widget
Class Widgets
- java.lang.Object
-
- org.jline.widget.Widgets
-
- Direct Known Subclasses:
AutopairWidgets
,AutosuggestionWidgets
,TailTipWidgets
public abstract class Widgets extends java.lang.Object
Create custom widgets by extending Widgets class- Author:
- Matti Rinta-Nikkola
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
AP_BACKWARD_DELETE_CHAR
protected static java.lang.String
AP_INSERT
static java.lang.String
AUTOPAIR_TOGGLE
static java.lang.String
AUTOSUGGEST_TOGGLE
protected LineReader
reader
static java.lang.String
TAILTIP_PANE
static java.lang.String
TAILTIP_TOGGLE
protected static java.lang.String
TT_ACCEPT_LINE
-
Constructor Summary
Constructors Constructor Description Widgets(LineReader reader)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addWidget(java.lang.String name, Widget widget)
Add widget to the LineReadervoid
aliasWidget(java.lang.String orig, java.lang.String alias)
Create alias to widgetjava.util.List<java.lang.String>
args()
Parse lineReader buffer and returns its argumentsBuffer
buffer()
Get lineReader's buffervoid
callWidget(java.lang.String name)
Call widget.void
clearDescription()
Clears terminal status barvoid
clearTailTip()
Clears command line command hintjava.lang.String
currChar()
Access lineReader's buffer and return its current charactervoid
destroyDescription()
Remove terminal status barvoid
executeWidget(java.lang.String name)
Bind widget to ctrl-alt-x and execute itboolean
existsWidget(java.lang.String name)
Test if widget existsKeyMap<Binding>
getKeyMap()
Get lineReader's Main KeyMapjava.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 bindingParser
parser()
Get lineReader's parserjava.lang.String
prevChar()
Access lineReader buffer and return its previous charactervoid
putString(java.lang.String string)
Write the string parameter to the lineReader's buffervoid
replaceBuffer(Buffer buffer)
Replace lineReader buffervoid
setDescription(java.util.List<AttributedString> desc)
Set description text to the terminal status barvoid
setErrorIndex(int errorIndex)
Set errorIndex to the lineReader's highlightervoid
setErrorPattern(java.util.regex.Pattern errorPattern)
Set errorPattern to the lineReader's highlightervoid
setSuggestionType(LineReader.SuggestionType type)
Set lineReader's autosuggestion typevoid
setTailTip(java.lang.String tailTip)
Set lineReader's command hint to be added in the command linejava.lang.String
tailTip()
Get lineReader's command hint
-
-
-
Field Detail
-
TAILTIP_TOGGLE
public static final java.lang.String TAILTIP_TOGGLE
- See Also:
- Constant Field Values
-
TAILTIP_PANE
public static final java.lang.String TAILTIP_PANE
- See Also:
- Constant Field Values
-
AUTOPAIR_TOGGLE
public static final java.lang.String AUTOPAIR_TOGGLE
- See Also:
- Constant Field Values
-
AUTOSUGGEST_TOGGLE
public static final java.lang.String AUTOSUGGEST_TOGGLE
- See Also:
- Constant Field Values
-
AP_INSERT
protected static final java.lang.String AP_INSERT
- See Also:
- Constant Field Values
-
AP_BACKWARD_DELETE_CHAR
protected static final java.lang.String AP_BACKWARD_DELETE_CHAR
- See Also:
- Constant Field Values
-
TT_ACCEPT_LINE
protected static final java.lang.String TT_ACCEPT_LINE
- See Also:
- Constant Field Values
-
reader
protected final LineReader reader
-
-
Constructor Detail
-
Widgets
public Widgets(LineReader reader)
-
-
Method Detail
-
addWidget
public void addWidget(java.lang.String name, Widget widget)
Add widget to the LineReader- Parameters:
name
- the name of widgetwidget
- 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 namealias
- 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 Parser parser()
Get lineReader's parser- Returns:
- The parser
-
buffer
public Buffer buffer()
Get lineReader's buffer- Returns:
- The buffer
-
replaceBuffer
public void replaceBuffer(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(LineReader.SuggestionType type)
Set lineReader's autosuggestion type- Parameters:
type
- autosuggestion type
-
setDescription
public void setDescription(java.util.List<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
-
-