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

public interface IRemotePageStyle

This class represents a page style of a document.

Access

To get the default page style of a document, use the Standard property in the PageStyles class.

Usage

PageStyle provides access to the header and footer of a document.

Method Summary

IRemoteTextHeaderFooter	getFooter() This property returns a TextHeaderFooter object which represents the footer of a document.
IRemoteTextHeaderFooter	getHeader() This property returns a TextHeaderFooter object which represents the header of a document.
boolean	isFooterEnable() This property enables or disables the document footer.
boolean	isHeaderEnable() This property enables or disables the document header.
void	setFooterEnable(boolean enabled) This property enables or disables the document footer.
void	setHeaderEnable(boolean enabled) This property enables or disables the document header.

Method Detail

getHeader

IRemoteTextHeaderFooter getHeader()
                                  throws RemoteEclipseAPIException

This property returns a TextHeaderFooter object which represents the header of a document.

To get the header of a document, you must set the HeaderEnable property in the class PageStyle to true first, otherwise an exception is thrown.

Returns:

header

Throws:

RemoteEclipseAPIException

getFooter

IRemoteTextHeaderFooter getFooter()
                                  throws RemoteEclipseAPIException

This property returns a TextHeaderFooter object which represents the footer of a document.

To get the footer of a document, you must set the FooterEnable property in the class PageStyle to true first, otherwise an exception is thrown.

Returns:

footer

Throws:

RemoteEclipseAPIException

isHeaderEnable

boolean isHeaderEnable()
                       throws RemoteEclipseAPIException

This property enables or disables the document header. Specifies true to enable the header. Specifies false to disable the header.

Returns:

enabled state

Throws:

RemoteEclipseAPIException

setHeaderEnable

void setHeaderEnable(boolean enabled)
                     throws RemoteEclipseAPIException

This property enables or disables the document header. Specifies true to enable the header. Specifies false to disable the header.

Parameters:

enabled - new state

Throws:

RemoteEclipseAPIException

isFooterEnable

boolean isFooterEnable()
                       throws RemoteEclipseAPIException

This property enables or disables the document footer. Specifies true to enable the footer. Specifies false to disable the footer.

Returns:

enabled state

Throws:

RemoteEclipseAPIException

setFooterEnable

void setFooterEnable(boolean enabled)
                     throws RemoteEclipseAPIException

This property enables or disables the document footer. Specifies true to enable the footer. Specifies false to disable the footer.

Parameters:

enabled - new state

Throws:

RemoteEclipseAPIException