org.jledit

Interface Editor<C>

Type Parameters:

C -

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ConsoleEditor

All Known Implementing Classes:

AbstractConsoleEditor, SimpleConsoleEditor, StringEditor

public interface Editor<C>
extends 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 String	CARRIEGE_RETURN
static String	NEW_LINE

Method Summary

Methods

Modifier and Type	Method and Description
String	backspace() Deletes the previous character if exists.
String	delete() Deletes the current character, shifting remaining characters one position left.
void	end() Moves cursor to the end of the line.
void	findNext(String str) Finds the next appearance of the String.
void	findPrevious(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.
File	getFile() Returns the File being edited.
int	getLine() Returns the number of the current line.
void	home() Moves the cursors to the start of the line.
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	newLine() Adds a new line to the current position.
void	open(File source) Opens a file for editing.
void	put(String str) Puts the link to the current position.
void	save(File target) Saves the file.
void	setDirty(Boolean dirty) Marks that the editor has unsaved changes.

Methods inherited from interface java.io.Closeable

close

Field Detail

NEW_LINE

static final String NEW_LINE

See Also:

Constant Field Values

CARRIEGE_RETURN

static final String CARRIEGE_RETURN

See Also:

Constant Field Values

Method Detail

open

void open(File source)
          throws IOException

Opens a file for editing.

Parameters:

source -

Throws:

IOException

save

void save(File target)
          throws IOException

Saves the file.

Parameters:

target -

Throws:

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 -

home

void home()

Moves the cursors to the start of the line.

end

void end()

Moves cursor to the end of the line.

put

void put(String str)

Puts the link to the current position.

Parameters:

str -

delete

String delete()

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

backspace

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(String str)

Finds the next appearance of the String.

Parameters:

str -

lines

int lines()

Returns the number of lines.

Returns:

findPrevious

void findPrevious(String str)

Finds the next appearance of the String.

Parameters:

str -

setDirty

void setDirty(Boolean dirty)

Marks that the editor has unsaved changes.

Parameters:

dirty -

isDirty

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:

getFile

File getFile()

Returns the File being edited.

Returns: