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.

  • Field Details

    • enabled

      private boolean enabled

    • cmdDescs

      private final TailTipWidgets.CommandDescriptions cmdDescs

    • tipType

      private TailTipWidgets.TipType tipType

    • descriptionSize

      private int descriptionSize

    • descriptionEnabled

      private boolean descriptionEnabled

    • descriptionCache

      private boolean descriptionCache

    • readerErrors

      private Object readerErrors

  • 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.

    • TailTipWidgets

      private TailTipWidgets(LineReader reader, Map<String,CmdDesc> tailTips, int descriptionSize, TailTipWidgets.TipType tipType, Function<CmdLine,CmdDesc> descFun)

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

    • clearTailTip

      private boolean clearTailTip(String widget)

    • tailtipDelete

      public boolean tailtipDelete()

    • tailtipKillLine

      public boolean tailtipKillLine()

    • tailtipKillWholeLine

      public boolean tailtipKillWholeLine()

    • tailtipInsert

      public boolean tailtipInsert()

    • tailtipUpdateStatus

      public boolean tailtipUpdateStatus()

    • doTailTip

      private boolean doTailTip(String widget)

    • doCommandTailTip

      private void doCommandTailTip(String widget, CmdDesc cmdDesc, List<String> args)

    • resetTailTip

      private void resetTailTip()

    • doDescription

      private void doDescription(List<AttributedString> desc)

    • autopairEnabled

      private boolean autopairEnabled()

    • toggleWindow

      public boolean toggleWindow()

    • toggleKeyBindings

      public boolean toggleKeyBindings()

    • defaultBindings

      private boolean defaultBindings()

    • customBindings

      private void customBindings()

    • compileMainDescription

      private List<AttributedString> compileMainDescription(CmdDesc cmdDesc, int descriptionSize)

    • compileMainDescription

      private List<AttributedString> compileMainDescription(CmdDesc cmdDesc, int descriptionSize, String lastArg)

    • compileOptionDescription

      private List<AttributedString> compileOptionDescription(CmdDesc cmdDesc, String opt, int descriptionSize)