se.biltmore.tools.fileeditor

Interface TextBuffer

All Known Implementing Classes:

TextFileBuffer

public interface TextBuffer

Method Summary

Methods

Modifier and Type	Method and Description
void	addLine(java.lang.String text) Adds a line of text to the end of the buffer.
void	clear() Clears the buffer.
java.lang.String	getLine(int line) Gets a specific line from the buffer.
int	getSize() Returns the number of lines in the buffer.
void	insertLine(int line, java.lang.String text) Inserts a new line at the specified position.
void	load(java.lang.String path) Loads a text file into the buffer.
TextBuffer	newInstance() Returns a new instance of the buffer.
void	removeLine(int line) Removes the specified line.
void	save() Saves the buffer back to disk again.
void	saveAs(java.lang.String path) Saves the buffer to another file.
void	setLine(int line, java.lang.String text) Replaces a specific line in the buffer.
void	setReadOnly(boolean readOnly) If true makes the buffer read only.

Method Detail

load

void load(java.lang.String path)
          throws java.io.IOException

Loads a text file into the buffer.

Parameters:

path - The path to the file to load.

Throws:

java.io.IOException

save

void save()
          throws java.io.IOException

Saves the buffer back to disk again.

Throws:

java.io.IOException

saveAs

void saveAs(java.lang.String path)
            throws java.io.IOException

Saves the buffer to another file.

Parameters:

path - The path to the file to save to.

Throws:

java.io.IOException

clear

void clear()

Clears the buffer.

getSize

int getSize()

Returns the number of lines in the buffer.

getLine

java.lang.String getLine(int line)

Gets a specific line from the buffer.

Parameters:

line - The line to get.

setLine

void setLine(int line,
           java.lang.String text)

Replaces a specific line in the buffer.

Parameters:

line - The line to replace.

text - The new text for the line.

removeLine

void removeLine(int line)

Removes the specified line.

Parameters:

line - The line to remove.

insertLine

void insertLine(int line,
              java.lang.String text)

Inserts a new line at the specified position.

Parameters:

line - the poistion to insert at.

text - The text to insert.

addLine

void addLine(java.lang.String text)

Adds a line of text to the end of the buffer.

Parameters:

text - The text to add.

newInstance

TextBuffer newInstance()

Returns a new instance of the buffer.

Some editor operations work by creating a new buffer. This method allows those operations to create a buffer of the same type.

Please note however that any saved reference to the loaded file must be copied to the new instance before it is returned.

setReadOnly

void setReadOnly(boolean readOnly)

If true makes the buffer read only.

Parameters:

readOnly - Set to true to make buffer read only. Defaults to false.