jexer

Class TEditorWidget

java.lang.Object

jexer.TWidget

jexer.TEditorWidget

All Implemented Interfaces:

java.lang.Comparable<TWidget>

public class TEditorWidget
extends TWidget

TEditorWidget displays an editable text document. It is unaware of scrolling behavior, but can respond to mouse and keyboard events.

Constructor Summary

Constructors

Constructor and Description
TEditorWidget(TWidget parent, java.lang.String text, int x, int y, int width, int height) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	draw() Draw the text box.
int	getEditingColumnNumber() Get the current editing column number.
int	getEditingRowNumber() Get the current editing row number.
int	getLineCount() Get the number of lines in the underlying Document.
int	getMaximumColumnNumber() Get the maximum possible column number.
int	getMaximumRowNumber() Get the maximum possible row number.
int	getVisibleColumnNumber() Set the current visible column number.
int	getVisibleRowNumber() Get the current visible top row number.
boolean	isDirty() Get the dirty value.
void	onKeypress(TKeypressEvent keypress) Handle keystrokes.
void	onMouseDown(TMouseEvent mouse) Handle mouse press events.
void	onResize(TResizeEvent resize) Method that subclasses can override to handle window/screen resize events.
void	saveToFilename(java.lang.String filename) Save contents to file.
void	setEditingColumnNumber(int column) Set the current editing column number.
void	setEditingRowNumber(int row) Set the current editing row number.
void	setVisibleColumnNumber(int column) Set the current visible column number.
void	setVisibleRowNumber(int row) Set the current visible row number.

Methods inherited from class jexer.TWidget

activate, activate, activate, activateAll, addButton, addCalendar, addCheckBox, addComboBox, addDirectoryList, addDirectoryList, addDirectoryList, addDirectoryList, addEditor, addField, addField, addField, addImage, addImage, addLabel, addLabel, addLabel, addLabel, addLabel, addLabel, addList, addList, addList, addList, addPanel, addPasswordField, addPasswordField, addPasswordField, addProgressBar, addRadioGroup, addSpinner, addSplitPane, addTable, addTable, addText, addText, addTreeViewWidget, addTreeViewWidget, close, compareTo, doRepaint, drawBox, drawBox, drawBoxShadow, fileOpenBox, fileOpenBox, fileOpenBox, fileOpenBox, fileSaveBox, getAbsoluteX, getAbsoluteY, getActiveChild, getApplication, getAttrXY, getChildren, getCursorAbsoluteX, getCursorAbsoluteY, getCursorX, getCursorY, getHeight, getLayoutManager, getParent, getScreen, getTheme, getWidth, getWindow, getX, getY, handleEvent, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEnabled, isVisible, messageBox, messageBox, mouseWouldHit, onCommand, onIdle, onMenu, onMouseDoubleClick, onMouseMotion, onMouseUp, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setDimensions, setEnabled, setHeight, setLayoutManager, setParent, setupForTWindow, setVisible, setWidth, setWindow, setX, setY, splitHorizontal, splitVertical, switchWidget, toPrettyString, toPrettyString, toString, vLineXY

Methods inherited from class java.lang.Object

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

Constructor Detail

TEditorWidget

public TEditorWidget(TWidget parent,
                     java.lang.String text,
                     int x,
                     int y,
                     int width,
                     int height)

Public constructor.

Parameters:

parent - parent widget

text - text on the screen

x - column relative to parent

y - row relative to parent

width - width of text area

height - height of text area

Method Detail

draw

public void draw()

Draw the text box.

Overrides:

draw in class TWidget

onMouseDown

public void onMouseDown(TMouseEvent mouse)

Handle mouse press events.

Overrides:

onMouseDown in class TWidget

Parameters:

mouse - mouse button press event

onKeypress

public void onKeypress(TKeypressEvent keypress)

Handle keystrokes.

Overrides:

onKeypress in class TWidget

Parameters:

keypress - keystroke event

onResize

public void onResize(TResizeEvent resize)

Method that subclasses can override to handle window/screen resize events.

Overrides:

onResize in class TWidget

Parameters:

resize - resize event

getLineCount

public int getLineCount()

Get the number of lines in the underlying Document.

Returns:

the number of lines

getVisibleRowNumber

public int getVisibleRowNumber()

Get the current visible top row number. 1-based.

Returns:

the visible top row number. Row 1 is the first row.

setVisibleRowNumber

public void setVisibleRowNumber(int row)

Set the current visible row number. 1-based.

Parameters:

row - the new visible row number. Row 1 is the first row.

getEditingRowNumber

public int getEditingRowNumber()

Get the current editing row number. 1-based.

Returns:

the editing row number. Row 1 is the first row.

setEditingRowNumber

public void setEditingRowNumber(int row)

Set the current editing row number. 1-based.

Parameters:

row - the new editing row number. Row 1 is the first row.

getVisibleColumnNumber

public int getVisibleColumnNumber()

Set the current visible column number. 1-based.

Returns:

the visible column number. Column 1 is the first column.

setVisibleColumnNumber

public void setVisibleColumnNumber(int column)

Set the current visible column number. 1-based.

Parameters:

column - the new visible column number. Column 1 is the first column.

getEditingColumnNumber

public int getEditingColumnNumber()

Get the current editing column number. 1-based.

Returns:

the editing column number. Column 1 is the first column.

setEditingColumnNumber

public void setEditingColumnNumber(int column)

Set the current editing column number. 1-based.

Parameters:

column - the new editing column number. Column 1 is the first column.

getMaximumRowNumber

public int getMaximumRowNumber()

Get the maximum possible row number. 1-based.

Returns:

the maximum row number. Row 1 is the first row.

getMaximumColumnNumber

public int getMaximumColumnNumber()

Get the maximum possible column number. 1-based.

Returns:

the maximum column number. Column 1 is the first column.

isDirty

public boolean isDirty()

Get the dirty value.

Returns:

true if the buffer is dirty

saveToFilename

public void saveToFilename(java.lang.String filename)
                    throws java.io.IOException

Save contents to file.

Parameters:

filename - file to save to

Throws:

java.io.IOException - if a java.io operation throws