org.jledit

Interface ConsoleEditor

All Superinterfaces:

AutoCloseable, Closeable, Editor<String>, InputReader, LifeCycle

All Known Implementing Classes:

AbstractConsoleEditor, SimpleConsoleEditor

public interface ConsoleEditor
extends Editor<String>, InputReader, LifeCycle

Field Summary

Fields inherited from interface org.jledit.Editor

CARRIEGE_RETURN, NEW_LINE

Method Summary

Methods

Modifier and Type	Method and Description
int	getFooterSize() Returns the size in lines of the footer.
int	getHeaderSize() Returns the size in lines of the header.
jline.Terminal	getTerminal() Returns the Terminal used by the ConsoleEditor.
Theme	getTheme() Returns the Theme.
String	getTitle() Returns the ConsoleEditor title.
void	hide() Hides the editor.
boolean	isOpenEnabled() Checks if the ConsoleEditor can open new file.
boolean	isReadOnly() Checks if the ConsoleEditor is set to be read only.
void	moveDown(int offset) Moves cursor down.
void	moveLeft(int offset) Moves cursor left.
void	moveRight(int offset) Moves cursor left.
void	moveUp(int offset) Moves cursors up.
void	open(File source, String displayAs) Opens a file for editing.
void	redrawCoords() Redraws the cursor coordinates if the flavor supports that.
void	redrawFooter() Redraws the footer of the editor (if exists).
void	redrawHeader() Redraws the header of the editor (if exists).
void	redrawText() Redraws the text that fits inside the current frame.
void	restoreCursorPosition() Moves the cursor to the last saved position.
void	saveCursorPosition() Saves the cursor position.
void	setOpenEnabled(boolean openEnabled) Allows/disallows the ConsoleEditor to open files.
void	setReadOnly(boolean readOnly) Sets/Unsets the ConsoleEditor to read only mode.
void	setTheme(Theme theme) Sets the Theme of the editor.
void	setTitle(String title) Sets the ConsoleEditor title.
void	show() Shows the editor.

Methods inherited from interface org.jledit.Editor

backspace, delete, end, findNext, findPrevious, getColumn, getContent, getContent, getFile, getLine, home, isDirty, lines, mergeLine, move, newLine, open, put, save, setDirty

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.jledit.InputReader

read, readBoolean, readBoolean, readLine, readLine

Methods inherited from interface org.jledit.LifeCycle

start, stop

Method Detail

open

void open(File source,
        String displayAs)
          throws IOException

Opens a file for editing.

Parameters:

source -

displayAs - The display String (if flavor supports it).

Throws:

IOException

show

void show()

Shows the editor.

hide

void hide()

Hides the editor.

moveUp

void moveUp(int offset)

Moves cursors up. If the beggining of the files is reached it does nothing.

Parameters:

offset - The number of lines to move upwards.

moveDown

void moveDown(int offset)

Moves cursor down. If the end of file is reached it does nothing.

Parameters:

offset - The number of lines to move downwards.

moveLeft

void moveLeft(int offset)

Moves cursor left. If the beggining of the line is reached. It move the cursor to the end of the previous line.

Parameters:

offset - The number of lines to move.

moveRight

void moveRight(int offset)

Moves cursor left. If the end of line is reached it moves the cursor to the beggining of the next line.

Parameters:

offset - The number of lines to move.

redrawText

void redrawText()

Redraws the text that fits inside the current frame.

redrawHeader

void redrawHeader()

Redraws the header of the editor (if exists).

redrawFooter

void redrawFooter()

Redraws the footer of the editor (if exists).

redrawCoords

void redrawCoords()

Redraws the cursor coordinates if the flavor supports that.

saveCursorPosition

void saveCursorPosition()

Saves the cursor position.

restoreCursorPosition

void restoreCursorPosition()

Moves the cursor to the last saved position.

getHeaderSize

int getHeaderSize()

Returns the size in lines of the header.

Returns:

The size of the header or 0 if the flavor doesn't use a header.

getFooterSize

int getFooterSize()

Returns the size in lines of the footer.

Returns:

The size of the footer or 0 if the flavor doesn't use a footer.

getTerminal

jline.Terminal getTerminal()

Returns the Terminal used by the ConsoleEditor.

Returns:

setTheme

void setTheme(Theme theme)

Sets the Theme of the editor.

Parameters:

theme -

getTheme

Theme getTheme()

Returns the Theme.

Returns:

getTitle

String getTitle()

Returns the ConsoleEditor title.

Returns:

setTitle

void setTitle(String title)

Sets the ConsoleEditor title.

Parameters:

title -

isReadOnly

boolean isReadOnly()

Checks if the ConsoleEditor is set to be read only.

Returns:

setReadOnly

void setReadOnly(boolean readOnly)

Sets/Unsets the ConsoleEditor to read only mode.

Parameters:

readOnly -

isOpenEnabled

boolean isOpenEnabled()

Checks if the ConsoleEditor can open new file.

Returns:

setOpenEnabled

void setOpenEnabled(boolean openEnabled)

Allows/disallows the ConsoleEditor to open files.

Parameters:

openEnabled -