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

public interface IRemoteTextHeaderFooter

This class represents the header or footer of a document.

To get the header of the document, use the Header property in the PageStyle class.
To get the footer of the document, use the Footer property in the PageStyle class.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getBackColor() This property returns or sets the background color of the header or footer.
int	getHeight() This property returns or sets the height of the header or footer in 1/100th mm.
IRemoteTextRange	getRange() This property returns a range contained within this header or footer.
boolean	isAutoHeight() This property returns or sets whether the height is adjusted by the content automatically.
boolean	isBackTransparent() This property sets or gets whether the background is transparent.
void	setAutoHeight(boolean autoHeight) This property returns or sets whether the height is adjusted by the content automatically.
void	setBackColor(int color) This property returns or sets the background color of the header or footer.
void	setBackTransparent(boolean transparent) This property sets or gets whether the background is transparent.
void	setHeight(int height) This property returns or sets the height of the header or footer in 1/100th mm.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

isAutoHeight

boolean isAutoHeight()
                     throws RemoteEclipseAPIException

This property returns or sets whether the height is adjusted by the content automatically.

Returns:

autoHeight

Throws:

RemoteEclipseAPIException

setAutoHeight

void setAutoHeight(boolean autoHeight)
                   throws RemoteEclipseAPIException

This property returns or sets whether the height is adjusted by the content automatically.

Parameters:

autoHeight - isAutoHeight

Throws:

RemoteEclipseAPIException

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property returns or sets the background color of the header or footer.

Returns:

color

Throws:

RemoteEclipseAPIException

setBackColor

void setBackColor(int color)
                  throws RemoteEclipseAPIException

This property returns or sets the background color of the header or footer.

Parameters:

color - color

Throws:

RemoteEclipseAPIException

isBackTransparent

boolean isBackTransparent()
                          throws RemoteEclipseAPIException

This property sets or gets whether the background is transparent. Specifying true means that no background color is used in this header or footer. Specifying false means to use the background color specified by the BackColor property.

Returns:

transparent

Throws:

RemoteEclipseAPIException

setBackTransparent

void setBackTransparent(boolean transparent)
                        throws RemoteEclipseAPIException

This property sets or gets whether the background is transparent. Specifying true means that no background color is used in this header or footer. Specifying false means to use the background color specified by the BackColor property.

Parameters:

transparent - transparent

Throws:

RemoteEclipseAPIException

getHeight

int getHeight()
              throws RemoteEclipseAPIException

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

When setting height for a header or footer 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 header or footer, 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 header or footer in 1/100th mm. To set the height of the header or footer, set the AutoHeight property to false.

When setting height for a header or footer 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 header or footer, 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 - height

Throws:

RemoteEclipseAPIException

getRange

IRemoteTextRange getRange()
                          throws RemoteEclipseAPIException

This property returns a range contained within this header or footer.

Returns:

range

Throws:

RemoteEclipseAPIException