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

public interface IRemoteTextField

This class represents an user field in a document.

The value of an user field can be a string value or a double value. The property Content is used to set the string value for an user field. The property Value is used to set the double value for an user field. The value for the Content property and Value property can overwrite each other's value.

• When you set the value for the Content property, the value of the Value property is the numeric conversion value of the Content property's value.
• When you set the value for the Value property, the value of the Content property is the string conversion value of the Value property's value.

For example, if we set the Content property's value as Test, the Value property's value is 0; if we set the Value property's value as 26.7, the Content property's value is 26.7.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
java.lang.String	getContent() This property returns the content of an user or page number field, or sets the content of an user field.
java.lang.String	getName() This property returns only the name of an user field.
IRemoteTextRange	getRange() This property returns the position of the field.
java.lang.String	getType() This property returns the type of the field.
double	getValue() This property returns the value of an user or page number field, or sets the value of an user field.
boolean	isVisible() This property returns or sets whether the field is visible.
void	remove() This method deletes the current field from the document.
void	setContent(java.lang.String content) This property returns the content of an user or page number field, or sets the content of an user field.
void	setValue(double value) This property returns the value of an user or page number field, or sets the value of an user field.
void	setVisible(boolean visible) This property returns or sets whether the field is visible.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getContent

java.lang.String getContent()
                            throws RemoteEclipseAPIException

This property returns the content of an user or page number field, or sets the content of an user field. The content of a page number field can not be changed, when setting content for a page number field, this property throws an exception.

Returns:

content

Throws:

RemoteEclipseAPIException

setContent

void setContent(java.lang.String content)
                throws RemoteEclipseAPIException

This property returns the content of an user or page number field, or sets the content of an user field. The content of a page number field can not be changed, when setting content for a page number field, this property throws an exception.

Parameters:

content - content

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns only the name of an user field.

Returns:

name

Throws:

RemoteEclipseAPIException

getValue

double getValue()
                throws RemoteEclipseAPIException

This property returns the value of an user or page number field, or sets the value of an user field. The value of a page number field can not be changed, when setting value for a page number field, this property throws an exception.

Returns:

value

Throws:

RemoteEclipseAPIException

setValue

void setValue(double value)
              throws RemoteEclipseAPIException

This property returns the value of an user or page number field, or sets the value of an user field. The value of a page number field can not be changed, when setting value for a page number field, this property throws an exception.

Parameters:

value - value

Throws:

RemoteEclipseAPIException

isVisible

boolean isVisible()
                  throws RemoteEclipseAPIException

This property returns or sets whether the field is visible. It returns true when the field is visible, otherwise returns false. The visible property of a page number field can not be changed, when setting the visible property for a page number field, this property throws an exception.

Returns:

visible

Throws:

RemoteEclipseAPIException

setVisible

void setVisible(boolean visible)
                throws RemoteEclipseAPIException

This property returns or sets whether the field is visible. It returns true when the field is visible, otherwise returns false. The visible property of a page number field can not be changed, when setting the visible property for a page number field, this property throws an exception.

Parameters:

visible - visible

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method deletes the current field from the document.

Throws:

RemoteEclipseAPIException

getType

java.lang.String getType()
                         throws RemoteEclipseAPIException

This property returns the type of the field. This property can specify User, which means that it is an user field; or PageNumber, which means that it is a page number field.

Returns:

type

Throws:

RemoteEclipseAPIException

getRange

IRemoteTextRange getRange()
                          throws RemoteEclipseAPIException

This property returns the position of the field.

Returns:

range

Throws:

RemoteEclipseAPIException