- java.lang.Object
-
- org.jline.widget.Widgets
-
- org.jline.widget.TailTipWidgets
-
public class TailTipWidgets extends Widgets
Creates and manages widgets for as you type command line suggestions. Suggestions are created using a command completer data and/or positional argument descriptions.- Author:
- Matti Rinta-Nikkola
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTailTipWidgets.TipType
-
Field Summary
-
Fields inherited from class org.jline.widget.Widgets
AP_BACKWARD_DELETE_CHAR, AP_INSERT, AUTOPAIR_TOGGLE, AUTOSUGGEST_TOGGLE, reader, TAILTIP_PANE, TAILTIP_TOGGLE, TT_ACCEPT_LINE
-
-
Constructor Summary
Constructors Constructor Description TailTipWidgets(LineReader reader, Function<CmdLine,CmdDesc> descFun, int descriptionSize, TailTipWidgets.TipType tipType)Creates tailtip widgets used in command line suggestions.TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips)Creates tailtip widgets used in command line suggestions.TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, int descriptionSize)Creates tailtip widgets used in command line suggestions.TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, int descriptionSize, TailTipWidgets.TipType tipType)Creates tailtip widgets used in command line suggestions.TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, TailTipWidgets.TipType tipType)Creates tailtip widgets used in command line suggestions.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddisable()voidenable()intgetDescriptionSize()TailTipWidgets.TipTypegetTipType()booleanisEnabled()voidsetDescriptionCache(boolean cache)voidsetDescriptionSize(int descriptionSize)voidsetTailTips(Map<String,CmdDesc> tailTips)voidsetTipType(TailTipWidgets.TipType type)booleantailtipAcceptLine()booleantailtipBackwardDelete()booleantailtipComplete()booleantailtipDelete()booleantailtipInsert()booleantailtipKillLine()booleantailtipKillWholeLine()booleantailtipUpdateStatus()booleantoggleKeyBindings()booleantoggleWindow()-
Methods inherited from class org.jline.widget.Widgets
addDescription, addWidget, aliasWidget, args, buffer, callWidget, clearDescription, clearTailTip, currChar, destroyDescription, executeWidget, existsWidget, getKeyMap, getWidget, initDescription, lastBinding, parser, prevChar, putString, replaceBuffer, setErrorIndex, setErrorPattern, setSuggestionType, setTailTip, tailTip
-
-
-
-
Constructor Detail
-
TailTipWidgets
public TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips)
Creates tailtip widgets used in command line suggestions. Suggestions are created using a command positional argument names. If argument descriptions do not exists command completer data will be used. Status bar for argument descriptions will not be created.- Parameters:
reader- LineReader.tailTips- Commands options and positional argument descriptions.- Throws:
IllegalStateException- If widgets are already created.
-
TailTipWidgets
public TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, TailTipWidgets.TipType tipType)
Creates tailtip widgets used in command line suggestions. Status bar for argument descriptions will not be created.- Parameters:
reader- LineReader.tailTips- Commands options and positional argument descriptions.tipType- Defines which data will be used for suggestions.- Throws:
IllegalStateException- If widgets are already created.
-
TailTipWidgets
public TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, int descriptionSize)
Creates tailtip widgets used in command line suggestions. Suggestions are created using a command positional argument names. If argument descriptions do not exists command completer data will be used.- Parameters:
reader- LineReader.tailTips- Commands options and positional argument descriptions.descriptionSize- Size of the status bar.- Throws:
IllegalStateException- If widgets are already created.
-
TailTipWidgets
public TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, int descriptionSize, TailTipWidgets.TipType tipType)
Creates tailtip widgets used in command line suggestions.- Parameters:
reader- LineReader.tailTips- Commands options and positional argument descriptions.descriptionSize- Size of the status bar.tipType- Defines which data will be used for suggestions.- Throws:
IllegalStateException- If widgets are already created.
-
TailTipWidgets
public TailTipWidgets(LineReader reader, Function<CmdLine,CmdDesc> descFun, int descriptionSize, TailTipWidgets.TipType tipType)
Creates tailtip widgets used in command line suggestions.- Parameters:
reader- LineReader.descFun- Function that returns command description.descriptionSize- Size of the status bar.tipType- Defines which data will be used for suggestions.- Throws:
IllegalStateException- If widgets are already created.
-
-
Method Detail
-
setDescriptionSize
public void setDescriptionSize(int descriptionSize)
-
getDescriptionSize
public int getDescriptionSize()
-
setTipType
public void setTipType(TailTipWidgets.TipType type)
-
getTipType
public TailTipWidgets.TipType getTipType()
-
isEnabled
public boolean isEnabled()
-
disable
public void disable()
-
enable
public void enable()
-
setDescriptionCache
public void setDescriptionCache(boolean cache)
-
tailtipComplete
public boolean tailtipComplete()
-
tailtipAcceptLine
public boolean tailtipAcceptLine()
-
tailtipBackwardDelete
public boolean tailtipBackwardDelete()
-
tailtipDelete
public boolean tailtipDelete()
-
tailtipKillLine
public boolean tailtipKillLine()
-
tailtipKillWholeLine
public boolean tailtipKillWholeLine()
-
tailtipInsert
public boolean tailtipInsert()
-
tailtipUpdateStatus
public boolean tailtipUpdateStatus()
-
toggleWindow
public boolean toggleWindow()
-
toggleKeyBindings
public boolean toggleKeyBindings()
-
-