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

public interface IRemoteFields

Method Summary

IRemoteDateTimeField	addDateField(IRemoteTextRange position) This method adds a date field to the document.
IRemoteField	addField(IRemoteTextRange position, int type) This method adds a field to a document.
IRemoteHiddenTextField	addHiddenTextField(IRemoteTextRange position, java.lang.String content, java.lang.String condition) This method adds a hidden text field to a document.
IRemotePageNumberField	addPageNumberField(IRemoteTextRange position) This method adds a page number field to a document.
IRemoteSetVariableField	addSetVariableField(IRemoteTextRange position, java.lang.String variableName) This method adds a set variable field to a document.
IRemoteShowVariableField	addShowVariableField(IRemoteTextRange position, java.lang.String variableName) This method adds a show variable field to a document.
IRemoteDateTimeField	addTimeField(IRemoteTextRange position) This method adds a time field to a document.
IRemoteUserField	addUserField(IRemoteTextRange position, java.lang.String name) This method adds a user field to a document.
int	countByType(int type) This method returns the number of the fields according to the field type.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
IRemoteField	itemByType(int type, int index) This method gets a field according to the index and field type.
void	refresh() This method refreshes all the fields of a document.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

itemByType

IRemoteField itemByType(int type,
                        int index)
                        throws RemoteEclipseAPIException

This method gets a field according to the index and field type.

Parameters:

type - Specifies the type of the field. The type of this parameter is a constant and can be one of these values:

Constant	Value	Description
Constant.FIELD_TYPE_USER	0	specifies the user field.
Constant.FIELD_TYPE_PAGENUMBER	1	specifies the page number field.
Constant.FIELD_TYPE_DATETIME	2	specifies the show variable field.
Constant.FIELD_TYPE_HIDDENTEXT	3	specifies the set variable field.
Constant.FIELD_TYPE_SETVARIABLE	4	specifies the hidden text field.
Constant.FIELD_TYPE_SHOWVARIABLE	5	specifies the date time field.

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

Returns:

A Field object that represents a field.

Throws:

RemoteEclipseAPIException

countByType

int countByType(int type)
                throws RemoteEclipseAPIException

This method returns the number of the fields according to the field type.

Parameters:

type - Specifies the type of the field. The type of this parameter is a constant and can be one of these values:

Constant	Value	Description
Constant.FIELD_TYPE_USER	0	specifies the user field.
Constant.FIELD_TYPE_PAGENUMBER	1	specifies the page number field.
Constant.FIELD_TYPE_DATETIME	2	specifies the show variable field.
Constant.FIELD_TYPE_HIDDENTEXT	3	specifies the set variable field.
Constant.FIELD_TYPE_SETVARIABLE	4	specifies the hidden text field.
Constant.FIELD_TYPE_SHOWVARIABLE	5	specifies the date time field.

Returns:

A int value that represents the field number.

Throws:

RemoteEclipseAPIException

addField

IRemoteField addField(IRemoteTextRange position,
                      int type)
                      throws RemoteEclipseAPIException

This method adds a field to a document.

Parameters:

position - Specifies the position of the new field.

type - Specifies the type of the new field. The type of this parameter is a constant and can be one of these values:

Constant	Value	Description
Constant.FIELD_TYPE_USER	0	specifies the user field.
Constant.FIELD_TYPE_PAGENUMBER	1	specifies the page number field.
Constant.FIELD_TYPE_DATETIME	2	specifies the show variable field.
Constant.FIELD_TYPE_HIDDENTEXT	3	specifies the set variable field.
Constant.FIELD_TYPE_SETVARIABLE	4	specifies the hidden text field.
Constant.FIELD_TYPE_SHOWVARIABLE	5	specifies the date time field.

Returns:

Throws:

RemoteEclipseAPIException

addPageNumberField

IRemotePageNumberField addPageNumberField(IRemoteTextRange position)
                                          throws RemoteEclipseAPIException

This method adds a page number field to a document.

Parameters:

position - Specifies the position of the field.

Returns:

A PageNumberField object that represents a page number field.

Throws:

RemoteEclipseAPIException

addUserField

IRemoteUserField addUserField(IRemoteTextRange position,
                              java.lang.String name)
                              throws RemoteEclipseAPIException

This method adds a user field to a document.

Parameters:

position - Specifies the position of the new field.

name - Specifies the name of the user field, the name is restrict within [alphabet,number,_].

Returns:

A UserField object that represents a user field.

Throws:

RemoteEclipseAPIException

addHiddenTextField

IRemoteHiddenTextField addHiddenTextField(IRemoteTextRange position,
                                          java.lang.String content,
                                          java.lang.String condition)
                                          throws RemoteEclipseAPIException

This method adds a hidden text field to a document.

Parameters:

position - Specifies the position of the field.

content - Specifies the content of the hidden text field.

condition - Specifies a logical expression to control the display of the field. For more information, see Help > Help Contents > IBM Lotus Symphony >Documents: Reference > Defining Conditions.

Returns:

A HiddenTextField object that represents a hidden text field.

Throws:

RemoteEclipseAPIException

addShowVariableField

IRemoteShowVariableField addShowVariableField(IRemoteTextRange position,
                                              java.lang.String variableName)
                                              throws RemoteEclipseAPIException

This method adds a show variable field to a document.

Parameters:

position - Specifies the position of the field.

variableName - Specifies the name of the variable to show, the name is restrict within (_|[:alnum:]).

Returns:

A ShowVariableField object that represents a show variable field.

Throws:

RemoteEclipseAPIException

addSetVariableField

IRemoteSetVariableField addSetVariableField(IRemoteTextRange position,
                                            java.lang.String variableName)
                                            throws RemoteEclipseAPIException

This method adds a set variable field to a document.

Parameters:

position - Specifies the position of the field.

variableName - Specifies the variable name of the field, the name is restrict within (_|[:alnum:]).

Returns:

A SetVariableField object that represents a set variable field.

Throws:

RemoteEclipseAPIException

addDateField

IRemoteDateTimeField addDateField(IRemoteTextRange position)
                                  throws RemoteEclipseAPIException

This method adds a date field to the document.

Parameters:

position - Specifies the position of the new field.

Returns:

A DateTimeField object that represents a date or time field.

Throws:

RemoteEclipseAPIException

addTimeField

IRemoteDateTimeField addTimeField(IRemoteTextRange position)
                                  throws RemoteEclipseAPIException

This method adds a time field to a document.

Parameters:

position - Specifies the position of the new field.

Returns:

A DateTimeField object that represents a date time field.

Throws:

RemoteEclipseAPIException

refresh

void refresh()
             throws RemoteEclipseAPIException

This method refreshes all the fields of a document.

Throws:

RemoteEclipseAPIException