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

All Superinterfaces:

IRemoteField

public interface IRemoteSetVariableField
extends IRemoteField

This class is a subclass of the Field class and represents a set variable field in a document.

Creation and access

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

Method Summary

double	getValue() This property returns or sets the value of a field.
java.lang.String	getVariableName() This property returns the variable name of a field.
boolean	isVisible() This property returns or sets whether the field is visible.
void	setContent(java.lang.String content) This property returns or sets the content of a field.
void	setValue(double value) This property returns or sets the value of a field.
void	setVisible(boolean visible) This property returns or sets whether the field is visible.

Methods inherited from interface com.mindoo.remote.api.symphony.document.IRemoteField

getContent, getRange, getType, remove

Method Detail

getVariableName

java.lang.String getVariableName()
                                 throws RemoteEclipseAPIException

This property returns the variable name of a field.

Returns:

name

Throws:

RemoteEclipseAPIException

setContent

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

This property returns or sets the content of a field.

Parameters:

content - content

Throws:

RemoteEclipseAPIException

setValue

void setValue(double value)
              throws RemoteEclipseAPIException

This property returns or sets the value of a field.

Parameters:

value - value

Throws:

RemoteEclipseAPIException

getValue

double getValue()
                throws RemoteEclipseAPIException

This property returns or sets the value of a field.

Returns:

value

Throws:

RemoteEclipseAPIException

setVisible

void setVisible(boolean visible)
                throws RemoteEclipseAPIException

This property returns or sets whether the field is visible.

Parameters:

visible - new state

Throws:

RemoteEclipseAPIException

isVisible

boolean isVisible()
                  throws RemoteEclipseAPIException

This property returns or sets whether the field is visible.

Returns:

visible

Throws:

RemoteEclipseAPIException