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

public interface IRemoteTextTableCell

This class represents a cell of a table.

Access

To get a cell of a table, use:

• The cell method in the TextTable class.
• The item method in the TextTableCells class.

Usage

TextTableCell provides access to the range, text, and value of a cell.

To automatically calculate the value for a cell, use the Formula property.

To protect the cell from being modified by users, use the Protected property.
The value of a cell can be a string value or a double value. The property Text is used to set the string value for a cell. The property Value is used to set the double value for a cell. The value for the Text property and Value property can overwrite each other's value.

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

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

Method Summary

IRemoteBorder	borders(int position) This method returns a Border object, which represents a border around the cell.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getBackColor() This property returns or sets the background color of a cell.
java.lang.String	getFormula() This property returns or sets a formula for the cell.
java.lang.String	getName() This property returns the name of the cell.
IRemoteTextParagraphs	getParagraphs() This property returns a TextParagraphs object that represents all the paragraphs of a cell.
IRemoteTextRange	getRange() This property returns a TextRange object, which represents the text range in the cell.
java.lang.String	getText() This property returns or sets the text in the cell.
double	getValue() This property returns or sets the value of the cell.
boolean	isBackTransparent() This property returns or sets whether the background of a cell is transparent.
boolean	isProtected() This property returns or sets whether the cell can be modified from the user interface.
void	setBackColor(int color) This property returns or sets the background color of a cell.
void	setBackTransparent(boolean transparent) This property returns or sets whether the background of a cell is transparent.
void	setFormula(java.lang.String formula) This property returns or sets a formula for the cell.
void	setProtected(boolean protect) This property returns or sets whether the cell can be modified from the user interface.
void	setText(java.lang.String text) This property returns or sets the text in the cell.
void	setValue(double value) This property returns or sets the value of the cell.
void	split(int rows, int columns) This method split the cell.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property returns or sets the background color of a cell.

Defined in

The value of this property is the decimal value of a color which you can using the RGB method in the Application class.

Returns:

color

Throws:

RemoteEclipseAPIException

setBackColor

void setBackColor(int color)
                  throws RemoteEclipseAPIException

This property returns or sets the background color of a cell.

Defined in

The value of this property is the decimal value of a color which you can using the RGB method in the Application class.

Parameters:

color -

Throws:

RemoteEclipseAPIException

isBackTransparent

boolean isBackTransparent()
                          throws RemoteEclipseAPIException

This property returns or sets whether the background of a cell is transparent. Specifying true means that no background color is used in this cell. Specifying false uses the background color specified by the BackColor property.

Returns:

transparent

Throws:

RemoteEclipseAPIException

setBackTransparent

void setBackTransparent(boolean transparent)
                        throws RemoteEclipseAPIException

This property returns or sets whether the background of a cell is transparent. Specifying true means that no background color is used in this cell. Specifying false uses the background color specified by the BackColor property.

Parameters:

transparent -

Throws:

RemoteEclipseAPIException

getFormula

java.lang.String getFormula()
                            throws RemoteEclipseAPIException

This property returns or sets a formula for the cell.

Formula property is used to calculate automatically the cell's value. For example, =Sum sums the values of cells on row 2 from column C to column E, or for example, =* multiplies the value of cell C2 by E2.

Returns:

formula

Throws:

RemoteEclipseAPIException

setFormula

void setFormula(java.lang.String formula)
                throws RemoteEclipseAPIException

This property returns or sets a formula for the cell.

Formula property is used to calculate automatically the cell's value. For example, =Sum sums the values of cells on row 2 from column C to column E, or for example, =* multiplies the value of cell C2 by E2.

Parameters:

formula -

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns the name of the cell.

Returns:

name

Throws:

RemoteEclipseAPIException

isProtected

boolean isProtected()
                    throws RemoteEclipseAPIException

This property returns or sets whether the cell can be modified from the user interface. Specifying true means that the cell is read-only from the user interface. Specifying false means that the cell is read-write from the user interface.
If the Protected property is set to true, the cell can not be modified from the user interface, but can be modified by the API.

Returns:

protect

Throws:

RemoteEclipseAPIException

setProtected

void setProtected(boolean protect)
                  throws RemoteEclipseAPIException

This property returns or sets whether the cell can be modified from the user interface. Specifying true means that the cell is read-only from the user interface. Specifying false means that the cell is read-write from the user interface.
If the Protected property is set to true, the cell can not be modified from the user interface, but can be modified by the API.

Parameters:

protect -

Throws:

RemoteEclipseAPIException

getRange

IRemoteTextRange getRange()
                          throws RemoteEclipseAPIException

This property returns a TextRange object, which represents the text range in the cell.

Returns:

range

Throws:

RemoteEclipseAPIException

getText

java.lang.String getText()
                         throws RemoteEclipseAPIException

This property returns or sets the text in the cell.

Returns:

text

Throws:

RemoteEclipseAPIException

setText

void setText(java.lang.String text)
             throws RemoteEclipseAPIException

This property returns or sets the text in the cell.

Parameters:

text - text

Throws:

RemoteEclipseAPIException

getValue

double getValue()
                throws RemoteEclipseAPIException

This property returns or sets the value of the cell. Use this property to calculate the formula in a cell.

Returns:

value

Throws:

RemoteEclipseAPIException

setValue

void setValue(double value)
              throws RemoteEclipseAPIException

This property returns or sets the value of the cell. Use this property to calculate the formula in a cell.

Parameters:

value - value

Throws:

RemoteEclipseAPIException

borders

IRemoteBorder borders(int position)
                      throws RemoteEclipseAPIException

This method returns a Border object, which represents a border around the cell.

If the border type is invalid, this method throws an exception.

Parameters:

position - Specifies the position of the border, and the type of this property can be a border type constant.

Returns:

A Border object that represents a border.

Throws:

RemoteEclipseAPIException

See Also:

IRemoteConstant

getParagraphs

IRemoteTextParagraphs getParagraphs()
                                    throws RemoteEclipseAPIException

This property returns a TextParagraphs object that represents all the paragraphs of a cell.

Returns:

paragraphs

Throws:

RemoteEclipseAPIException

split

void split(int rows,
           int columns)
           throws RemoteEclipseAPIException

This method split the cell.

Parameters:

rows - Specifies the row count to split.

columns - Specifies the column count to split.

Throws:

RemoteEclipseAPIException