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

All Known Subinterfaces:

IRemoteDateTimeField, IRemoteHiddenTextField, IRemotePageNumberField, IRemoteSetVariableField, IRemoteShowVariableField, IRemoteUserField

public interface IRemoteField

This class represents a user field in a document.

Creation and access

• To get a field in a document, use the itemByType method in the Fields class.
• To create a field, use the addField method in the Fields class.

Method Summary

java.lang.String	getContent() This property returns the content of a field.
IRemoteTextRange	getRange() This property returns the position of a field.
int	getType() This property returns the type of a field.
void	remove() This method deletes a field from a document.

Method Detail

getContent

java.lang.String getContent()
                            throws RemoteEclipseAPIException

This property returns the content of a field.

Returns:

content

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method deletes a field from a document.

Throws:

RemoteEclipseAPIException

getType

int getType()
            throws RemoteEclipseAPIException

This property returns the type of a field.

Legal 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

getRange

IRemoteTextRange getRange()
                          throws RemoteEclipseAPIException

This property returns the position of a field.

Returns:

range

Throws:

RemoteEclipseAPIException