org.jline.utils

Class Display

java.lang.Object

org.jline.utils.Display

public class Display
extends Object

Handle display and visual cursor.

Author:

Guillaume Nodet

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canScroll
protected Map<InfoCmp.Capability,Integer>	cost
protected boolean	cursorDownIsNewLine
protected int	cursorPos
protected boolean	delayedWrapAtEol
protected boolean	delayLineWrap
protected boolean	fullScreen
protected List<AttributedString>	oldLines
protected boolean	reset
protected int	rows
protected Terminal	terminal
protected boolean	wrapAtEol

Constructor Summary

Constructors

Constructor and Description
Display(Terminal terminal, boolean fullscreen)

Method Summary

Modifier and Type	Method and Description
protected boolean	can(InfoCmp.Capability single, InfoCmp.Capability multi)
void	clear() Clears the whole screen.
boolean	delayLineWrap() If cursor is at right margin, don't wrap immediately.
protected boolean	deleteChars(int nb)
protected boolean	deleteLines(int nb)
protected boolean	insertChars(int nb)
protected boolean	insertLines(int nb)
protected int	moveVisualCursorTo(int i1) Move cursor from cursorPos to argument, updating cursorPos We're at the right margin if (cursorPos % columns1) == columns.
protected void	moveVisualCursorTo(int targetPos, List<AttributedString> newLines) Move cursor from cursorPos to argument, updating cursorPos We're at the right margin if (cursorPos % columns1) == columns.
protected boolean	perform(InfoCmp.Capability single, InfoCmp.Capability multi, int nb)
void	reset()
void	resize(int rows, int columns)
void	setDelayLineWrap(boolean v)
void	update(List<AttributedString> newLines, int targetCursorPos) Update the display according to the new lines
void	updateAnsi(List<String> newLines, int targetCursorPos)
int	wcwidth(String str)

Methods inherited from class java.lang.Object

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

Field Detail

terminal

protected final Terminal terminal

fullScreen

protected final boolean fullScreen

oldLines

protected List<AttributedString> oldLines

cursorPos

protected int cursorPos

rows

protected int rows

reset

protected boolean reset

delayLineWrap

protected boolean delayLineWrap

cost

protected final Map<InfoCmp.Capability,Integer> cost

canScroll

protected final boolean canScroll

wrapAtEol

protected final boolean wrapAtEol

delayedWrapAtEol

protected final boolean delayedWrapAtEol

cursorDownIsNewLine

protected final boolean cursorDownIsNewLine

Constructor Detail

Display

public Display(Terminal terminal,
               boolean fullscreen)

Method Detail

delayLineWrap

public boolean delayLineWrap()

If cursor is at right margin, don't wrap immediately. See LineReader.Option#DELAY_LINE_WRAP.

setDelayLineWrap

public void setDelayLineWrap(boolean v)

resize

public void resize(int rows,
                   int columns)

reset

public void reset()

clear

public void clear()

Clears the whole screen. Use this method only when using full-screen / application mode.

updateAnsi

public void updateAnsi(List<String> newLines,
                       int targetCursorPos)

update

public void update(List<AttributedString> newLines,
                   int targetCursorPos)

Update the display according to the new lines

Parameters:

targetCursorPos - desired cursor position - see Size.cursorPos.

deleteLines

protected boolean deleteLines(int nb)

insertLines

protected boolean insertLines(int nb)

insertChars

protected boolean insertChars(int nb)

deleteChars

protected boolean deleteChars(int nb)

can

protected boolean can(InfoCmp.Capability single,
                      InfoCmp.Capability multi)

perform

protected boolean perform(InfoCmp.Capability single,
                          InfoCmp.Capability multi,
                          int nb)

moveVisualCursorTo

protected void moveVisualCursorTo(int targetPos,
                                  List<AttributedString> newLines)

Move cursor from cursorPos to argument, updating cursorPos We're at the right margin if (cursorPos % columns1) == columns. This method knows how to move both *from* and *to* the right margin.

moveVisualCursorTo

protected int moveVisualCursorTo(int i1)

Move cursor from cursorPos to argument, updating cursorPos We're at the right margin if (cursorPos % columns1) == columns. This method knows how to move *from* the right margin, but does not know how to move *to* the right margin. I.e. (i1 % columns1) == column is not allowed.

wcwidth

public int wcwidth(String str)