com.mindoo.remote.api.symphony.document
Interface IRemoteTextFields

public interface IRemoteTextFields

This class represents a collection of all the fields in a document.

TextFields only provides access to user fields and page number fields, and it provides a method to add user and page number fields.

Method Summary

IRemoteTextField	add(IRemoteTextRange position, java.lang.String type, java.lang.String name) This method adds a field for the document.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property represents the number of fields in the collection.
IRemoteTextField	item(int index) This method gets a field according to an index.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of fields in the collection.

Returns:

count

Throws:

RemoteEclipseAPIException

item

IRemoteTextField item(int index)
                      throws RemoteEclipseAPIException

This method gets a field according to an index.

Parameters:

index - Specifies the index of the field to get, starting at 1.

Returns:

A TextField object that represents a user field.

Throws:

RemoteEclipseAPIException

add

IRemoteTextField add(IRemoteTextRange position,
                     java.lang.String type,
                     java.lang.String name)
                     throws RemoteEclipseAPIException

This method adds a field for the document.

Parameters:

position - Specifies the position of the new field.

type - Specifies the type of the new field. The value of this parameter can only be "User" or "PageNumber", which means it is an user field or a page number field. If other filed types is used, this method throws an exception.

name - Specifies the name of the user field. This parameter is only available when add an user field. If an user field with the same name already exist, it inserts the existing user field into the specified position.

Returns:

A TextField object that represents a field.

Throws:

RemoteEclipseAPIException