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

public interface IRemotePage

This class represents a page.

Creation and access

• To get a page of a presentation, use the item method in the Pages class.
• To create a page, use the addTo method in the Pages class.

Method Summary

void	activate() This method makes the specified page into the active page.
IRemotePage	duplicate() This method duplicates the specified page.
void	exportToImage(java.lang.String fileName, int imagetype, int quality) This method exports the specified page to an image file.
IRemoteUserDefinedAttributes	getAttributes() This property returns the user-defined attributes of the page.
int	getHeight() This property returns the height of the page within 0.01 mm.
int	getIndex() This property returns the index of the current page, starting from 1.
IRemotePage	getMasterPage() This property returns or sets the master page of the page.
java.lang.String	getName() This property returns or sets a string value representing the name of the page.
IRemoteShapes	getShapes() This property returns all the shapes on the page.
int	getWidth() This property returns the width of this page within 0.01 mm.
void	paste() This method pastes the shape that is copied in the clipboard into the specified page, it is not supported in invisible mode.
void	remove() This method removes the specified page.
void	setHeight(int height) This property returns the height of the page within 0.01 mm.
void	setMasterPage(IRemotePage page) This property returns or sets the master page of the page.
void	setName(java.lang.String name) This property returns or sets a string value representing the name of the page.
void	setWidth(int width) This property returns the width of this page within 0.01 mm.

Method Detail

activate

void activate()
              throws RemoteEclipseAPIException

This method makes the specified page into the active page.

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets a string value representing the name of the page.

Returns:

name

Throws:

RemoteEclipseAPIException

setName

void setName(java.lang.String name)
             throws RemoteEclipseAPIException

This property returns or sets a string value representing the name of the page.

Parameters:

name -

Throws:

RemoteEclipseAPIException

getIndex

int getIndex()
             throws RemoteEclipseAPIException

This property returns the index of the current page, starting from 1.

Returns:

index

Throws:

RemoteEclipseAPIException

getShapes

IRemoteShapes getShapes()
                        throws RemoteEclipseAPIException

This property returns all the shapes on the page.

Returns:

shapes

Throws:

RemoteEclipseAPIException

paste

void paste()
           throws RemoteEclipseAPIException

This method pastes the shape that is copied in the clipboard into the specified page, it is not supported in invisible mode.

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method removes the specified page.

Throws:

RemoteEclipseAPIException

duplicate

IRemotePage duplicate()
                      throws RemoteEclipseAPIException

This method duplicates the specified page.

Returns:

page

Throws:

RemoteEclipseAPIException

setMasterPage

void setMasterPage(IRemotePage page)
                   throws RemoteEclipseAPIException

This property returns or sets the master page of the page.

Parameters:

page - master

Throws:

RemoteEclipseAPIException

getMasterPage

IRemotePage getMasterPage()
                          throws RemoteEclipseAPIException

This property returns or sets the master page of the page.

Returns:

master

Throws:

RemoteEclipseAPIException

getHeight

int getHeight()
              throws RemoteEclipseAPIException

This property returns the height of the page within 0.01 mm.

Returns:

height

Throws:

RemoteEclipseAPIException

getWidth

int getWidth()
             throws RemoteEclipseAPIException

This property returns the width of this page within 0.01 mm.

Returns:

width

Throws:

RemoteEclipseAPIException

setHeight

void setHeight(int height)
               throws RemoteEclipseAPIException

This property returns the height of the page within 0.01 mm.

Parameters:

height -

Throws:

RemoteEclipseAPIException

setWidth

void setWidth(int width)
              throws RemoteEclipseAPIException

This property returns the width of this page within 0.01 mm.

Parameters:

width -

Throws:

RemoteEclipseAPIException

exportToImage

void exportToImage(java.lang.String fileName,
                   int imagetype,
                   int quality)
                   throws RemoteEclipseAPIException

This method exports the specified page to an image file.

Parameters:

fileName - Specifies the file to export.

imagetype - Specifies the type of the image to export. The value is a constant and can be one of these types:

Constant	Value	Description
Constant.IMAGE_TYPE_JPEG	1	specifies the JPEG image type.
Constant.IMAGE_TYPE_PNG	2	specifies the PNG image type.
Constant.IMAGE_TYPE_GIF	3	specifies the GIF image type.

quality - Specifies the quality of the image. Values range from 0 which is the lowest quality to 100 which is the highest quality.

Throws:

RemoteEclipseAPIException

getAttributes

IRemoteUserDefinedAttributes getAttributes()
                                           throws RemoteEclipseAPIException

This property returns the user-defined attributes of the page.

Returns:

attributes

Throws:

RemoteEclipseAPIException