palmed.edit
Interface ITextBox

All Superinterfaces:

ISerializable

All Known Implementing Classes:

TextBox

public interface ITextBox
extends ISerializable

This interface defines a text box.

Version:

$Revision: 381 $ $Date: 2005-12-30 16:44:33 +0900 (ven., 30 déc. 2005) $

Author:

Mathieu Champlon

Method Summary

void	clear() Clear the text box.
void	copy(java.io.OutputStream stream) Copy the current selected text.
void	cut(java.io.OutputStream stream) Cut the current selected text.
void	delete() Delete any resource associated to the current content.
boolean	hasBeenModified() Test the modification flag.
void	paste(java.io.InputStream stream) Paste the given text.
void	read(java.io.InputStream stream) Reset the text box and read text from a stream.
void	redo() Redo the last undo.
void	setFont(java.lang.String name) Change the font.
void	setLineSeparator(java.lang.String separator) Change the line separator.
void	undo() Undo the last action.
void	write(java.io.OutputStream stream) Write text to a stream.

Methods inherited from interface palmed.io.ISerializable

marshall, unmarshall

Method Detail

read

void read(java.io.InputStream stream)
          throws java.io.IOException

Reset the text box and read text from a stream.

Parameters:

stream - the stream to read from

Throws:

java.io.IOException - an io exception occurs

write

void write(java.io.OutputStream stream)
           throws java.io.IOException

Write text to a stream.

Parameters:

stream - the stream to write to

Throws:

java.io.IOException - an io exception occurs

hasBeenModified

boolean hasBeenModified()

Test the modification flag.

Returns:

whether the text has been modified since it has been read or written

clear

void clear()

Clear the text box.

copy

void copy(java.io.OutputStream stream)
          throws java.io.IOException

Copy the current selected text.

Parameters:

stream - the stream to write to

Throws:

java.io.IOException - an io exception occurs

cut

void cut(java.io.OutputStream stream)
         throws java.io.IOException

Cut the current selected text.

Parameters:

stream - the stream to write to

Throws:

java.io.IOException - an io exception occurs

paste

void paste(java.io.InputStream stream)
           throws java.io.IOException

Paste the given text.

Parameters:

stream - the stream to read from

Throws:

java.io.IOException - an io exception occurs

delete

void delete()

Delete any resource associated to the current content.

undo

void undo()

Undo the last action.

redo

void redo()

Redo the last undo.

setLineSeparator

void setLineSeparator(java.lang.String separator)

Change the line separator.

To reset to the default mode preserving file format use null.

Parameters:

separator - a string value or null to reset

setFont

void setFont(java.lang.String name)

Change the font.

Parameters:

name - the font resource name