org.jledit

Class StringEditor

java.lang.Object

org.jledit.StringEditor

All Implemented Interfaces:

Closeable, AutoCloseable, Editor<String>

public class StringEditor
extends Object
implements Editor<String>

An Editor implementation for String objects.

Field Summary

Fields inherited from interface org.jledit.Editor

CARRIEGE_RETURN, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
StringEditor()
StringEditor(String content)

Method Summary

Methods

Modifier and Type	Method and Description
String	backspace() Deletes the previous character if exists.
void	close()
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.
String	getContent() Returns the content of the file.
String	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 index 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 class java.lang.Object

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

Constructor Detail

StringEditor

public StringEditor()

StringEditor

public StringEditor(String content)

Method Detail

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)

Moves the index to the specified line and column. If the requested line is greater that the actual lines number and exception is thrown. If the requested column is greater than the line width, the index is moved to the end of the line.

Specified by:

move in interface Editor<String>

Parameters:

line -

column -

Throws:

IndexOutOfBoundsException - When the requested line exceeds the number of lines in the content.

home

public void home()

Moves the cursors to the start of the line.

Specified by:

home in interface Editor<String>

end

public void end()

Moves cursor to the end of the line.

Specified by:

end 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 -

lines

public int lines()

Returns the number of lines.

Specified by:

lines in interface Editor<String>

Returns:

findPrevious

public void findPrevious(String str)

Finds the next appearance of the String.

Specified by:

findPrevious in interface Editor<String>

Parameters:

str -

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

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

Returns the File being edited.

Specified by:

getFile in interface Editor<String>

Returns:

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>