com.mindoo.remote.api.symphony.presentation
Interface IRemotePages

public interface IRemotePages

This class represents a collection of pages in a presentation.

Access

• To get all the pages of a presentation, use the Pages property in the Presentation class.
• To get all the master pages of a presentation, use the MasterPages property in the Presentation class.

Usage

Pages provides access to pages and methods to insert new pages and access pages.

Method Summary

void	addTo(IRemotePage page) This method creates a page.
void	addTo(IRemotePage page, int count) This method creates a page.
void	addTo(IRemotePage page, int count, boolean beforeOrAfter) This method creates a page.
int	getCount() This property represents the number of pages in a presentation.
IRemotePage	item(int index) This method returns a page according to the index.

Method Detail

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of pages in a presentation.

Returns:

count

Throws:

RemoteEclipseAPIException

item

IRemotePage item(int index)
                 throws RemoteEclipseAPIException

This method returns a page according to the index.

Parameters:

index - Specifies the index of the page, starting at 1.

Returns:

A Page object that represents a page.

Throws:

RemoteEclipseAPIException

addTo

void addTo(IRemotePage page)
           throws RemoteEclipseAPIException

This method creates a page.

Usage

This method throws an exception if:

• The target page is in another presentation.
• The target page is null.

Parameters:

page - Specifies the target page before or after which the new page is added.

Throws:

RemoteEclipseAPIException

addTo

void addTo(IRemotePage page,
           int count)
           throws RemoteEclipseAPIException

This method creates a page.

Usage

This method throws an exception if:

• The target page is in another presentation.
• The target page is null.

Parameters:

page - Specifies the target page before or after which the new page is added.

count - Specifies the number of pages to be added. The default value is 1.

Throws:

RemoteEclipseAPIException

addTo

void addTo(IRemotePage page,
           int count,
           boolean beforeOrAfter)
           throws RemoteEclipseAPIException

This method creates a page.

Usage

This method throws an exception if:

• The target page is in another presentation.
• The target page is null.

Parameters:

page - Specifies the target page before or after which the new page is added.

count - Specifies the number of pages to be added. The default value is 1.

beforeOrAfter - Specifies true to add the new page before the parameter page, or false to add the new page after the parameter page. The default value is false.

Throws:

RemoteEclipseAPIException