Package org.jline.consoleui.prompt

Class AbstractPrompt<T extends ConsoleUIItemIF>

java.lang.Object

org.jline.consoleui.prompt.AbstractPrompt<T>

Direct Known Subclasses:

AbstractPrompt.CheckboxPrompt, AbstractPrompt.ConfirmPrompt, AbstractPrompt.ExpandableChoicePrompt, AbstractPrompt.InputValuePrompt, AbstractPrompt.ListChoicePrompt

public abstract class AbstractPrompt<T extends ConsoleUIItemIF>
extends Object

Classes for all prompt implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractPrompt.CheckboxPrompt
private static class	AbstractPrompt.CompletingWord
protected static class	AbstractPrompt.ConfirmPrompt
protected static class	AbstractPrompt.ExpandableChoiceException
protected static class	AbstractPrompt.ExpandableChoicePrompt
protected static class	AbstractPrompt.InputValuePrompt
protected static class	AbstractPrompt.ListChoicePrompt<T extends ListItemIF>
private static class	AbstractPrompt.ListRange

Field Summary

Fields

Modifier and Type	Field	Description
protected final BindingReader	bindingReader
protected final ConsolePrompt.UiConfig	config
static final long	DEFAULT_TIMEOUT_WITH_ESC
private Display	display
protected int	firstItemRow
private final List<AttributedString>	header
protected final List<T>	items
private final AttributedString	message
private AbstractPrompt.ListRange	range
private final Size	size
protected final Terminal	terminal

Constructor Summary

Constructors

Constructor	Description
AbstractPrompt(Terminal terminal, List<AttributedString> header, AttributedString message, List<T> items, int pageSize, ConsolePrompt.UiConfig cfg)
AbstractPrompt(Terminal terminal, List<AttributedString> header, AttributedString message, ConsolePrompt.UiConfig cfg)

Method Summary

Modifier and Type	Method	Description
private int	candidateStartPosition(int candidatesColumn, String buffer, List<Candidate> cands)
private void	computeListRange(int cursorRow, int itemsSize)
private List<AttributedString>	displayLines(int cursorRow, int candidatesColumn, AttributedString buffer, List<Candidate> candidates)
private List<AttributedString>	displayLines(int cursorRow, Set<String> selected)
private List<AttributedString>	displayLines(int cursorRow, AttributedString buffer, boolean newline)
private void	fillCheckboxSpace(AttributedStringBuilder asb)
private AttributedStringBuilder	fillIndicatorSpace(AttributedStringBuilder asb)
private static <T extends ConsoleUIItemIF> int	nextRow(int row, int firstItemRow, List<T> items)
private static <T extends ConsoleUIItemIF> int	prevRow(int row, int firstItemRow, List<T> items)
protected void	refreshDisplay(int row)
protected void	refreshDisplay(int row, int column, String buffer, boolean newline)
protected void	refreshDisplay(int buffRow, int buffCol, String buffer, int candRow, int candCol, List<Candidate> candidates)
protected void	refreshDisplay(int row, Set<String> selected)
protected void	resetDisplay()
protected void	resetHeader()

Methods inherited from class java.lang.Object

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

Field Details

terminal

protected final Terminal terminal

bindingReader

protected final BindingReader bindingReader

header

private final List<AttributedString> header

message

private final AttributedString message

items

protected final List<T extends ConsoleUIItemIF> items

firstItemRow

protected int firstItemRow

size

private final Size size

config

protected final ConsolePrompt.UiConfig config

display

private Display display

range

private AbstractPrompt.ListRange range

DEFAULT_TIMEOUT_WITH_ESC

public static final long DEFAULT_TIMEOUT_WITH_ESC

See Also:

• Constant Field Values

Constructor Details

AbstractPrompt

public AbstractPrompt(Terminal terminal,
 List<AttributedString> header,
 AttributedString message,
 ConsolePrompt.UiConfig cfg)

AbstractPrompt

public AbstractPrompt(Terminal terminal,
 List<AttributedString> header,
 AttributedString message,
 List<T> items,
 int pageSize,
 ConsolePrompt.UiConfig cfg)

Method Details

resetHeader

protected void resetHeader()

resetDisplay

protected void resetDisplay()

refreshDisplay

protected void refreshDisplay(int row)

refreshDisplay

protected void refreshDisplay(int row,
 Set<String> selected)

refreshDisplay

protected void refreshDisplay(int row,
 int column,
 String buffer,
 boolean newline)

refreshDisplay

protected void refreshDisplay(int buffRow,
 int buffCol,
 String buffer,
 int candRow,
 int candCol,
 List<Candidate> candidates)

candidateStartPosition

private int candidateStartPosition(int candidatesColumn,
 String buffer,
 List<Candidate> cands)

displayLines

private List<AttributedString> displayLines(int cursorRow,
 int candidatesColumn,
 AttributedString buffer,
 List<Candidate> candidates)

displayLines

private List<AttributedString> displayLines(int cursorRow,
 Set<String> selected)

fillIndicatorSpace

private AttributedStringBuilder fillIndicatorSpace(AttributedStringBuilder asb)

fillCheckboxSpace

private void fillCheckboxSpace(AttributedStringBuilder asb)

computeListRange

private void computeListRange(int cursorRow,
 int itemsSize)

displayLines

private List<AttributedString> displayLines(int cursorRow,
 AttributedString buffer,
 boolean newline)

nextRow

private static <T extends ConsoleUIItemIF> int nextRow(int row,
 int firstItemRow,
 List<T> items)

prevRow

private static <T extends ConsoleUIItemIF> int prevRow(int row,
 int firstItemRow,
 List<T> items)