jeb.api.ui

Class TextView

java.lang.Object

jeb.api.ui.View

jeb.api.ui.TextView

Direct Known Subclasses:

InteractiveTextView

public class TextView
extends View

This class represents a text view.

Since:

1.2.201305230

Nested Class Summary

Nested classes/interfaces inherited from class jeb.api.ui.View

View.Type

Method Summary

Modifier and Type	Method and Description
int	getCaretLine() Retrieve the caret current line index.
int	getCaretOffset() Retrieve the caret current position.
java.lang.String	getLine(int index) Retrieve a specific line of text in the view.
int	getLineCount() Get the number of lines of text displayed by the view.
int	getOffsetAtLine(int index) Get the offset of the first character of the given line.
java.lang.String	getText() Retrieve the entire text displayed by the view.
boolean	gotoLine(int index) Position the caret on a specific line
void	setCaretOffset(int offset) Position the caret at a specific location.
void	setCaretPosition(int lineindex, int lineoffset) Position the caret at a specific location.

Methods inherited from class jeb.api.ui.View

refresh

Methods inherited from class java.lang.Object

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

Method Detail

getText

public java.lang.String getText()

Retrieve the entire text displayed by the view.

Returns:

the text data displayed by the view

Since:

1.2.201305230

getLineCount

public int getLineCount()

Get the number of lines of text displayed by the view.

Returns:

the number of lines

Since:

1.2.201305230

getLine

public java.lang.String getLine(int index)

Retrieve a specific line of text in the view.

Parameters:

index - 0-based line index

Returns:

the line of text, or null on error

Since:

1.2.201305230

gotoLine

public boolean gotoLine(int index)

Position the caret on a specific line

Parameters:

index - 0-based line index

Returns:

boolean indicating success

Since:

1.2.201305230

getCaretOffset

public int getCaretOffset()

Retrieve the caret current position.

Returns:

the caret offset in the text view

Since:

1.2.201305230

setCaretOffset

public void setCaretOffset(int offset)

Position the caret at a specific location.

Parameters:

offset - the new caret position

Since:

1.2.201305230

setCaretPosition

public void setCaretPosition(int lineindex,
                             int lineoffset)

Position the caret at a specific location.

Note that this method does not scroll the window to make the caret visible. A method like gotoLine(int) can be used in combination with setCaretPosition to achieve the desired effect.

The getter method ("getCaretPosition") is redundant and not provided in the API. The desired effect can be achieved by using other public methods provided in this class.

Parameters:

lineindex - the 0-based line index (y coordinate)

lineoffset - the 0-based offset within the line (x coordinate)

Since:

1.5.201404100

getCaretLine

public int getCaretLine()

Retrieve the caret current line index.

Returns:

the line index in the text view, or -1 on error

Since:

1.2.201305230

getOffsetAtLine

public int getOffsetAtLine(int index)

Get the offset of the first character of the given line.

Parameters:

index - line index

Returns:

the offset of the first character of the given line

Since:

1.3.201307250