org.jledit

Interface Editor<C>

Type Parameters:

C -

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

ConsoleEditor

All Known Implementing Classes:

AbstractConsoleEditor, SimpleConsoleEditor, StringEditor

public interface Editor<C>
extends java.io.Closeable

The Editor interface describes all the text manipulation methods. It includes methods for File manipulation, navigation and text modification.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CARRIEGE_RETURN
static java.lang.String	NEW_LINE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	backspace() Deletes the previous character if exists.
java.lang.String	delete() Deletes the current character, shifting remaining characters one position left.
void	findNext(java.lang.String str) Finds the next appearance of the String.
void	findPrevious(java.lang.String str) Finds the next appearance of the String.
int	getColumn() Returns the current column.
C	getContent() Returns the content of the file.
C	getContent(int line) Returns the content of the file.
ContentManager	getContentManager() Sets the ContentManager.
int	getLine() Returns the number of the current line.
java.lang.String	getSource() Returns the File being edited.
java.lang.Boolean	isDirty() Returns if editor contains 'dirty' data.
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	moveToEndOfFile() Moves cursor to the end of the line.
void	moveToEndOfLine() Moves cursor to the end of the line.
void	moveToStartOfFile() Moves the cursors to the start of the line.
void	moveToStartOfLine() Moves the cursors to the start of the line.
void	newLine() Adds a new line to the current position.
void	open(java.lang.String source) Opens a file for editing.
void	put(java.lang.String str) Puts the link to the current position.
void	save(java.lang.String target) Saves the file.
void	setContentManager(ContentManager contentManager) Returns the ContentManager.
void	setDirty(java.lang.Boolean dirty) Marks that the editor has unsaved changes.

Methods inherited from interface java.io.Closeable

close

Field Detail

NEW_LINE

static final java.lang.String NEW_LINE

See Also:

Constant Field Values

CARRIEGE_RETURN

static final java.lang.String CARRIEGE_RETURN

See Also:

Constant Field Values

Method Detail

open

void open(java.lang.String source)
          throws java.io.IOException

Opens a file for editing.

Parameters:

source -

Throws:

java.io.IOException

save

void save(java.lang.String target)
          throws java.io.IOException

Saves the file.

Parameters:

target -

Throws:

java.io.IOException

getLine

int getLine()

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

Returns:

getColumn

int getColumn()

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

Returns:

move

void move(int line,
        int column)

Moves the cursor to the specified line and column.

Parameters:

line -

column -

moveToStartOfLine

void moveToStartOfLine()

Moves the cursors to the start of the line.

moveToEndOfLine

void moveToEndOfLine()

Moves cursor to the end of the line.

moveToStartOfFile

void moveToStartOfFile()

Moves the cursors to the start of the line.

moveToEndOfFile

void moveToEndOfFile()

Moves cursor to the end of the line.

put

void put(java.lang.String str)

Puts the link to the current position.

Parameters:

str -

delete

java.lang.String delete()

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

backspace

java.lang.String backspace()

Deletes the previous character if exists.

newLine

void newLine()

Adds a new line to the current position.

mergeLine

void mergeLine()

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

findNext

void findNext(java.lang.String str)

Finds the next appearance of the String.

Parameters:

str -

lines

int lines()

Returns the number of lines.

Returns:

findPrevious

void findPrevious(java.lang.String str)

Finds the next appearance of the String.

Parameters:

str -

setDirty

void setDirty(java.lang.Boolean dirty)

Marks that the editor has unsaved changes.

Parameters:

dirty -

isDirty

java.lang.Boolean isDirty()

Returns if editor contains 'dirty' data.

Returns:

getContent

C getContent()

Returns the content of the file.

Returns:

getContent

C getContent(int line)

Returns the content of the file.

Returns:

getSource

java.lang.String getSource()

Returns the File being edited.

Returns:

getContentManager

ContentManager getContentManager()

Sets the ContentManager.

Returns:

setContentManager

void setContentManager(ContentManager contentManager)

Returns the ContentManager.

Parameters:

contentManager -