com.ibm.notes.java.ui.documents
Interface NotesUIField

public interface NotesUIField

A single field within a NotesUIDocument.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

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

Method Detail

appendText

void appendText(String text)

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

Since:

8.5.1

clear

void clear()

Clear the field of all contents.

Since:

8.5.1

contains

boolean contains(String text)

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

Since:

8.5.1

getText

String getText()

Retrieve the current text of the field.

Returns:

the text of the field

Since:

8.5.1

setText

void setText(String text)

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

Since:

8.5.1

getName

String getName()

Returns the name of the field.

Returns:

name of the field

Since:

8.5.1

getUIDocument

NotesUIDocument getUIDocument()

Get the document that contains this field.

Returns:

the document that contains the field

Since:

8.5.1