Package org.jline.widget

Class TailTipWidgets

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 enum	TailTipWidgets.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

Modifier and Type	Method	Description
void	disable()
void	enable()
int	getDescriptionSize()
TailTipWidgets.TipType	getTipType()
boolean	isEnabled()
void	setDescriptionCache(boolean cache)
void	setDescriptionSize(int descriptionSize)
void	setTailTips(Map<String,CmdDesc> tailTips)
void	setTipType(TailTipWidgets.TipType type)
boolean	tailtipAcceptLine()
boolean	tailtipBackwardDelete()
boolean	tailtipComplete()
boolean	tailtipDelete()
boolean	tailtipInsert()
boolean	tailtipKillLine()
boolean	tailtipKillWholeLine()
boolean	tailtipUpdateStatus()
boolean	toggleKeyBindings()
boolean	toggleWindow()

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

setTailTips

public void setTailTips(Map<String,CmdDesc> tailTips)

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()