|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteShowVariableField
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 |
---|
static final int DISPLAY_NUMBER_MODE
static final int DISPLAY_STRING_MODE
Method Detail |
---|
void setVariable(java.lang.String variableName) throws RemoteEclipseAPIException
variableName
- Specifies the variable name of the field. The variable name is the name of an existing set variable field.
RemoteEclipseAPIException
void setVariable(java.lang.String variableName, int displayMode) throws RemoteEclipseAPIException
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:RemoteEclipseAPIException
int getDisplayMode() throws RemoteEclipseAPIException
Constant | Value | Description |
---|---|---|
ShowVariableField.DISPLAY_NUMBER_MODE | 0 | displays the numeral. |
ShowVariableField.DISPLAY_STRING_MODE | 1 | displays the string. |
RemoteEclipseAPIException
java.lang.String getVariableName() throws RemoteEclipseAPIException
RemoteEclipseAPIException
double getValue() throws RemoteEclipseAPIException
RemoteEclipseAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |