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

All Superinterfaces:
IRemoteField

public interface IRemoteShowVariableField
extends IRemoteField

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

Creation and access


Field Summary
static int DISPLAY_NUMBER_MODE
          displays the numeral.
static int DISPLAY_STRING_MODE
          displays the string.
 
Method Summary
 int getDisplayMode()
          This property returns the display mode of a variable field.
 double getValue()
          This property returns the value of a variable field.
 java.lang.String getVariableName()
          This property returns variable name of a show variable field.
 void setVariable(java.lang.String variableName)
          This method sets the variable for the field.
 void setVariable(java.lang.String variableName, int displayMode)
          This method sets the variable for the field.
 
Methods inherited from interface com.mindoo.remote.api.symphony.document.IRemoteField
getContent, getRange, getType, remove
 

Field Detail

DISPLAY_NUMBER_MODE

static final int DISPLAY_NUMBER_MODE
displays the numeral.

See Also:
Constant Field Values

DISPLAY_STRING_MODE

static final int DISPLAY_STRING_MODE
displays the string.

See Also:
Constant Field Values
Method Detail

setVariable

void setVariable(java.lang.String variableName)
                 throws RemoteEclipseAPIException
This method sets the variable for the field.

Parameters:
variableName - Specifies the variable name of the field. The variable name is the name of an existing set variable field.
Throws:
RemoteEclipseAPIException

setVariable

void setVariable(java.lang.String variableName,
                 int displayMode)
                 throws RemoteEclipseAPIException
This method sets the variable for the field.

Parameters:
variableName - Specifies the variable name of the field. The variable name is the name of an existing set variable field.
displayMode - Specifies the display mode of the field. The mode is a constant and can be one of these values:
  • ShowVariableField.DISPLAY_NUMBER_MODE, displays the numeral.
  • ShowVariableField.DISPLAY_STRING_MODE, displays the string.
Throws:
RemoteEclipseAPIException

getDisplayMode

int getDisplayMode()
                   throws RemoteEclipseAPIException
This property returns the display mode of a variable field.

Legal values:

ConstantValueDescription
ShowVariableField.DISPLAY_NUMBER_MODE0displays the numeral.
ShowVariableField.DISPLAY_STRING_MODE1displays the string.

Returns:
mode
Throws:
RemoteEclipseAPIException

getVariableName

java.lang.String getVariableName()
                                 throws RemoteEclipseAPIException
This property returns variable name of a show variable field.

Returns:
name
Throws:
RemoteEclipseAPIException

getValue

double getValue()
                throws RemoteEclipseAPIException
This property returns the value of a variable field.

Returns:
value
Throws:
RemoteEclipseAPIException