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

public interface IRemoteTextTableRow

This class represents a row in a table.

Creation and access

• To create a new row, use the add method in the TextTableRows class.
• To get a row of a table, use the item method in the TextTableRows class.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getBackColor() This property returns or sets the background color in a row.
int	getHeight() This property returns or sets the height of the row in 1/100th mm.
boolean	isAutoHeight() This property returns or sets whether the height of the row is changed according to the content in the table.
boolean	isBackTransparent() This property returns or sets whether the background of a row is transparent.
void	setAutoHeight(boolean autoHeight) This property returns or sets whether the height of the row is changed according to the content in the table.
void	setBackColor(int color) This property returns or sets the background color in a row.
void	setBackTransparent(boolean transparent) This property returns or sets whether the background of a row is transparent.
void	setHeight(int height) This property returns or sets the height of the row in 1/100th mm.

Method Detail

isAutoHeight

boolean isAutoHeight()
                     throws RemoteEclipseAPIException

This property returns or sets whether the height of the row is changed according to the content in the table.

Returns:

auto height

Throws:

RemoteEclipseAPIException

setAutoHeight

void setAutoHeight(boolean autoHeight)
                   throws RemoteEclipseAPIException

This property returns or sets whether the height of the row is changed according to the content in the table.

Parameters:

autoHeight - auto height

Throws:

RemoteEclipseAPIException

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property returns or sets the background color in a row.

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 in a row.

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 - color

Throws:

RemoteEclipseAPIException

isBackTransparent

boolean isBackTransparent()
                          throws RemoteEclipseAPIException

This property returns or sets whether the background of a row is transparent. Specifying true means that no background color is used in this row. 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 row is transparent. Specifying true means that no background color is used in this row. Specifying false uses the background color specified by the BackColor property.

Parameters:

transparent -

Throws:

RemoteEclipseAPIException

getHeight

int getHeight()
              throws RemoteEclipseAPIException

This property returns or sets the height of the row in 1/100th mm. To set the height of the row, set the AutoHeight property to false.

Usage

When setting height for a table row in 1/100th mm, the value of the height is converted to a internal value in twip(1 inch = 1440 twips) which is the internal unit for this property in Lotus Symphony. When getting the height of a table row, the internal value in twip is converted to a value in 1/100th mm and the value in 1/100th mm is returned to the user. So the value you get from the height maybe different (a little larger or smaller) from the value you set to the height. The following is the macro of converting a value in twip to 1/100th mm:

((TWIP) >= 0 ? (((TWIP)*127L+36L)/72L) : (((TWIP)*127L-36L)/72L))

The following is the macro of converting a value in 1/100th mm to twip :

((MM100) >= 0 ? (((MM100)*72L+63L)/127L) : (((MM100)*72L-63L)/127L))

Returns:

height

Throws:

RemoteEclipseAPIException

setHeight

void setHeight(int height)
               throws RemoteEclipseAPIException

This property returns or sets the height of the row in 1/100th mm. To set the height of the row, set the AutoHeight property to false.

Usage

When setting height for a table row in 1/100th mm, the value of the height is converted to a internal value in twip(1 inch = 1440 twips) which is the internal unit for this property in Lotus Symphony. When getting the height of a table row, the internal value in twip is converted to a value in 1/100th mm and the value in 1/100th mm is returned to the user. So the value you get from the height maybe different (a little larger or smaller) from the value you set to the height. The following is the macro of converting a value in twip to 1/100th mm:

((TWIP) >= 0 ? (((TWIP)*127L+36L)/72L) : (((TWIP)*127L-36L)/72L))

The following is the macro of converting a value in 1/100th mm to twip :

((MM100) >= 0 ? (((MM100)*72L+63L)/127L) : (((MM100)*72L-63L)/127L))

Parameters:

height -

Throws:

RemoteEclipseAPIException

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException