com.mindoo.remote.api.com.ibm.notes.java.ui.documents
Interface IRemoteNotesUIField

public interface IRemoteNotesUIField

Remote API Wrapper for the com.ibm.notes.java.ui.documents.NotesUIField (Online documentation)

Original documentation:
A single field within a NotesUIDocument.

Method Summary

void	appendText(java.lang.String text) Append the given text at the end of the field.
void	clear() Clear the field of all contents.
boolean	contains(java.lang.String text) Returns whether or not the field has the given text.
java.lang.String	getName() Returns the name of the field.
java.lang.String	getText() Retrieve the current text of the field.
IRemoteNotesUIDocument	getUIDocument() Get the document that contains this field.
void	setText(java.lang.String text) Sets the text of the field.

Method Detail

appendText

void appendText(java.lang.String text)
                throws RemoteEclipseAPIException

Append the given text at the end of the field.

If the length of the text passed into this method exceeds 30,000 characters, you may see unexpected results.

Parameters:

text - text to append

Throws:

RemoteEclipseAPIException

clear

void clear()
           throws RemoteEclipseAPIException

Clear the field of all contents.

Throws:

RemoteEclipseAPIException

contains

boolean contains(java.lang.String text)
                 throws RemoteEclipseAPIException

Returns whether or not the field has the given text. The comparison to field text will not be case sensitive.

If the length of the text passed into this method exceeds 30,000 characters, you may see unexpected results.

Parameters:

text - text to look for

Returns:

true if the text is in the field, false if it is not

Throws:

RemoteEclipseAPIException

getText

java.lang.String getText()
                         throws RemoteEclipseAPIException

Retrieve the current text of the field.

Returns:

the text of the field

Throws:

RemoteEclipseAPIException

setText

void setText(java.lang.String text)
             throws RemoteEclipseAPIException

Sets the text of the field.

If the length of the text passed into this method exceeds 30,000 characters, you may see unexpected results.

Parameters:

text - text to place in the field

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

Returns the name of the field.

Returns:

name of the field

Throws:

RemoteEclipseAPIException

getUIDocument

IRemoteNotesUIDocument getUIDocument()
                                     throws RemoteEclipseAPIException

Get the document that contains this field.

Returns:

the document that contains the field

Throws:

RemoteEclipseAPIException