org.jledit

Class AbstractConsoleEditor

java.lang.Object

org.jledit.AbstractConsoleEditor

All Implemented Interfaces:

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

Direct Known Subclasses:

SimpleConsoleEditor

public abstract class AbstractConsoleEditor
extends Object
implements ConsoleEditor, CommandFactory

An Editor which delegates to an other Editor implementation and displays the outcome to the console.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ESCAPE_TIMEOUT
static String	DIRTY_SIGN
static String	EDITOR_NAME
static int	ESCAPE
static int	READ_EXPIRED

Fields inherited from interface org.jledit.Editor

CARRIEGE_RETURN, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
AbstractConsoleEditor(jline.Terminal term)

Method Summary

Methods

Modifier and Type	Method and Description
String	backspace() Deletes the previous character if exists.
protected void	clearLine() Clears the current line.
void	close()
String	delete() Deletes the current character, shifting remaining characters one position left.
protected void	displayText(String text) Displays Text highlighting the text that was marked as highlighted.
void	end() Moves cursor to the end of the current line.
void	findNext(String str) Finds the next appearance of the String.
void	findPrevious(String str) Finds the next appearance of the String.
void	flush()
int	getColumn() Returns the current column.
String	getContent() Returns the content of the file.
String	getContent(int line) Returns the content of the file.
Editor<String>	getDelegate()
String	getDisplayAs()
File	getFile() Returns the File being edited.
int	getFooterSize() Returns the size in lines of the footer.
int	getHeaderSize() Returns the size in lines of the header.
jline.console.KeyMap	getKeys()
int	getLine() Returns the number of the current line.
jline.Terminal	getTerminal() Returns the Terminal used by the ConsoleEditor.
Theme	getTheme() Returns the Theme.
String	getTitle() Returns the ConsoleEditor title.
UndoContext	getUndoContext()
void	hide() Hides the editor screen and restore the Terminal.
protected void	highLight(String text)
void	home() Moves cursor to the end of the current line.
void	init()
Boolean	isDirty() Returns if editor contains 'dirty' data.
boolean	isOpenEnabled() Checks if the ConsoleEditor can open new file.
boolean	isReadOnly() Checks if the ConsoleEditor is set to be read only.
int	lines() Returns the number of lines.
void	mergeLine() Removes the new line character at the end of the line.
void	move(int line, int column) Moves the cursor to the specified line and column.
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	newLine() Adds a new line to the current position.
void	onCommand(Command command)
void	open(File source) Opens a file for editing.
void	open(File source, String displayAs) Opens a file for editing.
void	put(String str) Puts the link to the current position.
int	read() Reads a character from the user input.
boolean	readBoolean() Reads a boolean from the user input.
boolean	readBoolean(String message, Boolean defaultValue) Displays a message and reads a boolean from the user input.
String	readLine() Reads a line from the user input.
String	readLine(String message) Displays a message and prompts the user for input.
void	redrawText() Redraws the text that fits inside the current frame.
void	restoreCursorPosition() Moves the cursor to the last saved position.
void	save(File target) Saves the file.
void	saveCursorPosition() Saves the cursor position.
protected void	scrollDown(int rows)
protected void	scrollUp(int rows)
void	setDirty(Boolean dirty) Marks that the editor has unsaved changes.
void	setDisplayAs(String displayAs)
void	setFooterSize(int footerSize)
void	setHeaderSize(int headerSize)
void	setKeys(jline.console.KeyMap keys)
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 screen.
void	start() Starts the editor.
void	stop() Stops the editor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jledit.ConsoleEditor

redrawCoords, redrawFooter, redrawHeader

Methods inherited from interface org.jledit.command.CommandFactory

create

Field Detail

EDITOR_NAME

public static final String EDITOR_NAME

See Also:

Constant Field Values

DIRTY_SIGN

public static final String DIRTY_SIGN

See Also:

Constant Field Values

ESCAPE

public static final int ESCAPE

See Also:

Constant Field Values

DEFAULT_ESCAPE_TIMEOUT

public static final int DEFAULT_ESCAPE_TIMEOUT

See Also:

Constant Field Values

READ_EXPIRED

public static final int READ_EXPIRED

See Also:

Constant Field Values

Constructor Detail

AbstractConsoleEditor

public AbstractConsoleEditor(jline.Terminal term)
                      throws Exception

Throws:

Exception

Method Detail

init

public final void init()
                throws Exception

Throws:

Exception

start

public void start()

Starts the editor. This methods actually creates the Reader.

Specified by:

start in interface LifeCycle

stop

public void stop()

Stops the editor. The methods clears the editor screen and also closes in/out and Reader.

Specified by:

stop in interface LifeCycle

show

public void show()

Shows the editor screen.

Specified by:

show in interface ConsoleEditor

hide

public void hide()

Hides the editor screen and restore the Terminal.

Specified by:

hide in interface ConsoleEditor

read

public int read()
         throws IOException

Reads a character from the user input.

Specified by:

read in interface InputReader

Returns:

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Reads a boolean from the user input. The mapping of the user input to a boolean value is specified by the implementation.

Specified by:

readBoolean in interface InputReader

Returns:

Throws:

IOException

readBoolean

public boolean readBoolean(String message,
                  Boolean defaultValue)
                    throws IOException

Displays a message and reads a boolean from the user input. The mapping of the user input to a boolean value is specified by the implementation.

Specified by:

readBoolean in interface InputReader

Parameters:

message -

defaultValue -

Returns:

Throws:

IOException

readLine

public String readLine()
                throws IOException

Reads a line from the user input.

Specified by:

readLine in interface InputReader

Returns:

Throws:

IOException

readLine

public String readLine(String message)
                throws IOException

Description copied from interface: InputReader

Displays a message and prompts the user for input. Returns a single line.

Specified by:

readLine in interface InputReader

Returns:

Throws:

IOException

onCommand

public void onCommand(Command command)

redrawText

public void redrawText()

Description copied from interface: ConsoleEditor

Redraws the text that fits inside the current frame.

Specified by:

redrawText in interface ConsoleEditor

getLine

public int getLine()

Description copied from interface: Editor

Returns the number of the current line. This method refers to the actual line in the file. Line numbering starts with 1.

Specified by:

getLine in interface Editor<String>

Returns:

getColumn

public int getColumn()

Description copied from interface: Editor

Returns the current column. This method refers to the actual line in the file. Column numbering starts with 1.

Specified by:

getColumn in interface Editor<String>

Returns:

move

public void move(int line,
        int column)

Description copied from interface: Editor

Moves the cursor to the specified line and column.

Specified by:

move in interface Editor<String>

moveUp

public void moveUp(int offset)

Description copied from interface: ConsoleEditor

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

Specified by:

moveUp in interface ConsoleEditor

Parameters:

offset - The number of lines to move upwards.

moveDown

public void moveDown(int offset)

Description copied from interface: ConsoleEditor

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

Specified by:

moveDown in interface ConsoleEditor

Parameters:

offset - The number of lines to move downwards.

moveLeft

public void moveLeft(int offset)

Description copied from interface: ConsoleEditor

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

Specified by:

moveLeft in interface ConsoleEditor

Parameters:

offset - The number of lines to move.

moveRight

public void moveRight(int offset)

Description copied from interface: ConsoleEditor

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

Specified by:

moveRight in interface ConsoleEditor

Parameters:

offset - The number of lines to move.

end

public void end()

Moves cursor to the end of the current line.

Specified by:

end in interface Editor<String>

home

public void home()

Moves cursor to the end of the current line.

Specified by:

home in interface Editor<String>

put

public void put(String str)

Description copied from interface: Editor

Puts the link to the current position.

Specified by:

put in interface Editor<String>

delete

public String delete()

Description copied from interface: Editor

Deletes the current character, shifting remaining characters one position left.

Specified by:

delete in interface Editor<String>

backspace

public String backspace()

Description copied from interface: Editor

Deletes the previous character if exists.

Specified by:

backspace in interface Editor<String>

newLine

public void newLine()

Description copied from interface: Editor

Adds a new line to the current position.

Specified by:

newLine in interface Editor<String>

mergeLine

public void mergeLine()

Description copied from interface: Editor

Removes the new line character at the end of the line.

Specified by:

mergeLine in interface Editor<String>

findNext

public void findNext(String str)

Finds the next appearance of the String.

Specified by:

findNext in interface Editor<String>

Parameters:

str -

findPrevious

public void findPrevious(String str)

Finds the next appearance of the String.

Specified by:

findPrevious in interface Editor<String>

Parameters:

str -

scrollUp

protected void scrollUp(int rows)

scrollDown

protected void scrollDown(int rows)

displayText

protected void displayText(String text)

Displays Text highlighting the text that was marked as highlighted.

Parameters:

text -

clearLine

protected void clearLine()

Clears the current line. The purpose of this method is to cover cases where erase line doesn't respect background color (e.g some Windows).

saveCursorPosition

public void saveCursorPosition()

Description copied from interface: ConsoleEditor

Saves the cursor position.

Specified by:

saveCursorPosition in interface ConsoleEditor

restoreCursorPosition

public void restoreCursorPosition()

Description copied from interface: ConsoleEditor

Moves the cursor to the last saved position.

Specified by:

restoreCursorPosition in interface ConsoleEditor

flush

public void flush()

highLight

protected void highLight(String text)

open

public void open(File source,
        String displayAs)
          throws IOException

Description copied from interface: ConsoleEditor

Opens a file for editing.

Specified by:

open in interface ConsoleEditor

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

Throws:

IOException

open

public void open(File source)
          throws IOException

Description copied from interface: Editor

Opens a file for editing.

Specified by:

open in interface Editor<String>

Throws:

IOException

save

public void save(File target)
          throws IOException

Description copied from interface: Editor

Saves the file.

Specified by:

save in interface Editor<String>

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

lines

public int lines()

Returns the number of lines.

Specified by:

lines in interface Editor<String>

Returns:

getContent

public String getContent()

Description copied from interface: Editor

Returns the content of the file.

Specified by:

getContent in interface Editor<String>

Returns:

getContent

public String getContent(int line)

Description copied from interface: Editor

Returns the content of the file.

Specified by:

getContent in interface Editor<String>

Returns:

getFile

public File getFile()

Description copied from interface: Editor

Returns the File being edited.

Specified by:

getFile in interface Editor<String>

Returns:

getTerminal

public jline.Terminal getTerminal()

Description copied from interface: ConsoleEditor

Returns the Terminal used by the ConsoleEditor.

Specified by:

getTerminal in interface ConsoleEditor

Returns:

getDelegate

public Editor<String> getDelegate()

isDirty

public Boolean isDirty()

Description copied from interface: Editor

Returns if editor contains 'dirty' data.

Specified by:

isDirty in interface Editor<String>

Returns:

setDirty

public void setDirty(Boolean dirty)

Description copied from interface: Editor

Marks that the editor has unsaved changes.

Specified by:

setDirty in interface Editor<String>

getHeaderSize

public int getHeaderSize()

Description copied from interface: ConsoleEditor

Returns the size in lines of the header.

Specified by:

getHeaderSize in interface ConsoleEditor

Returns:

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

setHeaderSize

public void setHeaderSize(int headerSize)

getFooterSize

public int getFooterSize()

Description copied from interface: ConsoleEditor

Returns the size in lines of the footer.

Specified by:

getFooterSize in interface ConsoleEditor

Returns:

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

setFooterSize

public void setFooterSize(int footerSize)

getKeys

public jline.console.KeyMap getKeys()

setKeys

public void setKeys(jline.console.KeyMap keys)

getTheme

public Theme getTheme()

Description copied from interface: ConsoleEditor

Returns the Theme.

Specified by:

getTheme in interface ConsoleEditor

Returns:

setTheme

public void setTheme(Theme theme)

Description copied from interface: ConsoleEditor

Sets the Theme of the editor.

Specified by:

setTheme in interface ConsoleEditor

getUndoContext

public UndoContext getUndoContext()

getTitle

public String getTitle()

Description copied from interface: ConsoleEditor

Returns the ConsoleEditor title.

Specified by:

getTitle in interface ConsoleEditor

Returns:

setTitle

public void setTitle(String title)

Description copied from interface: ConsoleEditor

Sets the ConsoleEditor title.

Specified by:

setTitle in interface ConsoleEditor

isReadOnly

public boolean isReadOnly()

Description copied from interface: ConsoleEditor

Checks if the ConsoleEditor is set to be read only.

Specified by:

isReadOnly in interface ConsoleEditor

Returns:

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: ConsoleEditor

Sets/Unsets the ConsoleEditor to read only mode.

Specified by:

setReadOnly in interface ConsoleEditor

isOpenEnabled

public boolean isOpenEnabled()

Description copied from interface: ConsoleEditor

Checks if the ConsoleEditor can open new file.

Specified by:

isOpenEnabled in interface ConsoleEditor

Returns:

setOpenEnabled

public void setOpenEnabled(boolean openEnabled)

Description copied from interface: ConsoleEditor

Allows/disallows the ConsoleEditor to open files.

Specified by:

setOpenEnabled in interface ConsoleEditor

getDisplayAs

public String getDisplayAs()

setDisplayAs

public void setDisplayAs(String displayAs)