org.kohsuke.ajaxterm

Class Terminal

java.lang.Object

org.kohsuke.ajaxterm.Terminal

public class Terminal
extends Object

Screen buffer.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
int	height Screen width and height.
char[]	scr This is typed as 'char' but it's not character that's stored.
boolean	showCursor True if the cursor should be displayed.
int	width Screen width and height.

Constructor Summary

Constructors

Constructor and Description
Terminal(int width, int height)

Method Summary

Methods

Modifier and Type	Method and Description
void	csi_a(int[] args)
void	csi_A(int[] i)
void	csi_B(int[] i)
void	csi_c(int[] args)
void	csi_C(int[] i)
void	csi_d(int[] args)
void	csi_D(int[] i)
void	csi_e(int[] args)
void	csi_E(int[] i)
void	csi_f(int[] args)
void	csi_F(int[] i)
void	csi_G(int[] i)
void	csi_h(int[] args)
void	csi_H(int[] i)
void	csi_J(int[] i)
void	csi_K(int... i)
void	csi_l(int[] args)
void	csi_L(int[] args) Insert lines.
void	csi_m(int[] args)
void	csi_M(int[] args) Delete lines.
void	csi_P(int[] args) Delete n chars
void	csi_r(int[] args)
void	csi_s(int[] args)
void	csi_u(int[] args)
void	csi_X(int[] args)
void	cursorDown()
void	cursorRight()
String	dump()
ScreenImage	dumpHtml(boolean color, int clientTimestamp)
String	dumpLatin1()
void	echo(char c)
void	esc_0x08() Backspace.
void	esc_0x09() Tab.
void	esc_0x0d() Carriage return
void	esc_da()
void	escape()
void	escRi()
int	getCx()
int	getCy()
void	noOp()
String	peek(int y1, int y2)
String	peek(int y1, int x1, int y2, int x2)
void	poke(int y, int x, String s)
void	poke(int y, String s)
String	read()
void	reset()
void	restoreCursor()
void	saveCursor()
void	scrollDown(int y1, int y2)
void	scrollRight(int y, int x)
void	scrollUp(int y1, int y2) Scroll the (y1+1,y2) region up one line to (y1,y2-1)
void	setCssClass(String cssClass) Sets additional CSS classes for the terminal element.
void	write(String s) Receives the output from the forked process into the terminal.
void	zero(int y1, int y2)
void	zero(int y1, int x1, int y2, int x2)

Methods inherited from class java.lang.Object

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

Field Detail

scr

public char[] scr

This is typed as 'char' but it's not character that's stored. The lower 8 bit is the character code, and upper 8 bit are back/fore color. 0xFBCC ^^~~ <- ASCII char code || |+-- background color code (0:black, 1:blue, 2:red, 4:green, ....) | +--- foreground color code

width

public final int width

Screen width and height.

height

public final int height

Screen width and height.

showCursor

public boolean showCursor

True if the cursor should be displayed.

Constructor Detail

Terminal

public Terminal(int width,
        int height)

Method Detail

setCssClass

public void setCssClass(String cssClass)

Sets additional CSS classes for the terminal element.

getCx

public int getCx()

getCy

public int getCy()

reset

public void reset()

peek

public String peek(int y1,
          int y2)

peek

public String peek(int y1,
          int x1,
          int y2,
          int x2)

poke

public void poke(int y,
        int x,
        String s)

poke

public void poke(int y,
        String s)

zero

public void zero(int y1,
        int x1,
        int y2,
        int x2)

zero

public void zero(int y1,
        int y2)

scrollUp

public void scrollUp(int y1,
            int y2)

Scroll the (y1+1,y2) region up one line to (y1,y2-1)

scrollDown

public void scrollDown(int y1,
              int y2)

scrollRight

public void scrollRight(int y,
               int x)

cursorDown

public void cursorDown()

cursorRight

public void cursorRight()

echo

public void echo(char c)

escape

public void escape()

write

public void write(String s)

Receives the output from the forked process into the terminal.

read

public String read()

dump

public String dump()

dumpLatin1

public String dumpLatin1()

dumpHtml

public ScreenImage dumpHtml(boolean color,
                   int clientTimestamp)

Parameters:

color - If we want the color coded output. It'll make the response bit bigger.

clientTimestamp - The value of ScreenImage.timestamp that the client currently has. This information is used to avoid unnecessary screen refresh.

esc_da

public void esc_da()

esc_0x08

public void esc_0x08()

Backspace.

esc_0x09

public void esc_0x09()

Tab.

esc_0x0d

public void esc_0x0d()

Carriage return

noOp

public void noOp()

saveCursor

public void saveCursor()

restoreCursor

public void restoreCursor()

escRi

public void escRi()

csi_A

public void csi_A(int[] i)

csi_B

public void csi_B(int[] i)

csi_C

public void csi_C(int[] i)

csi_D

public void csi_D(int[] i)

csi_E

public void csi_E(int[] i)

csi_F

public void csi_F(int[] i)

csi_G

public void csi_G(int[] i)

csi_H

public void csi_H(int[] i)

csi_J

public void csi_J(int[] i)

csi_K

public void csi_K(int... i)

csi_L

public void csi_L(int[] args)

Insert lines.

csi_M

public void csi_M(int[] args)

Delete lines.

csi_P

public void csi_P(int[] args)

Delete n chars

csi_X

public void csi_X(int[] args)

csi_a

public void csi_a(int[] args)

csi_c

public void csi_c(int[] args)

csi_d

public void csi_d(int[] args)

csi_e

public void csi_e(int[] args)

csi_f

public void csi_f(int[] args)

csi_h

public void csi_h(int[] args)

csi_l

public void csi_l(int[] args)

csi_m

public void csi_m(int[] args)

csi_r

public void csi_r(int[] args)

csi_s

public void csi_s(int[] args)

csi_u

public void csi_u(int[] args)