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

All Known Subinterfaces:

IRemoteConnectorShape, IRemoteEllipseShape, IRemoteGraphicShape, IRemoteGroupShape, IRemoteLineShape, IRemoteMeasureShape, IRemoteRectangleShape, IRemoteTableShape, IRemoteTextShape, IRemoteUnKnownShape

public interface IRemoteShape

This class represents a shape on a page.

Creation and access

• To get a shape of a page, use the itemByType method in the Shapes class.
• To create a shape, use the addShape method in the Shapes class.

Method Summary

void	copy() This method copies the current shape to the clipboard
void	cut() This method cuts the current shape to the clipboard.
void	exportToImage(java.lang.String filename, int imageType, int quality) This method exports the specified shape to an image file.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
IRemoteUserDefinedAttributes	getAttributes() This property returns the user-defined attributes of a shape.
IRemoteTextRange	getContent() This property returns the text range of a shape.
IRemoteFillFormat	getFillFormat() This property returns the fill format of a shape.
int	getHeight() This property returns or sets the height of a shape in 1/100th mm.
int	getLeft() This property returns or sets the left position of the shape in 1/100th mm.
IRemoteLineFormat	getLineFormat() This property returns the line format of the shape.
boolean	getMoveProtect() This property returns or sets whether the shape can be moved.
java.lang.String	getName() This property returns or sets the name of the shape.
IRemoteTextParagraphs	getParagraphs() This property returns a TextParagraphs object that represents all the paragraphs of a shape.
int	getRotateAngle() This property returns or sets the rotate angle of a shape in 1/100th degree.
IRemoteShadowFormat	getShadowFormat() This property returns the shadow format of a shape and is used with the ShadowEnable property.
int	getShearAngle() This property returns or sets the shear angle of a shape in 1/100th degree.
boolean	getSizeProtect() This property returns or sets whether the size of the shape can be changed.
int	getTop() This property returns or sets the top position of a shape in 1/100th mm.
int	getType() This property returns the type of a shape.
int	getWidth() This property returns or sets the width of a shape in 1/100th mm.
int	getZOrder() This property returns the display order of a shape.
boolean	isShadowEnable() This property returns or sets whether the shadow format of a shape is enabled.
void	remove() This method removes the current shape from the page.
void	setHeight(int height) This property returns or sets the height of a shape in 1/100th mm.
void	setLeft(int left) This property returns or sets the left position of the shape in 1/100th mm.
void	setMoveProtect(boolean moveProtect) This property returns or sets whether the shape can be moved.
void	setName(java.lang.String name) This property returns or sets the name of the shape.
void	setRotateAngle(int angle) This property returns or sets the rotate angle of a shape in 1/100th degree.
void	setShadowEnable(boolean enable) This property returns or sets whether the shadow format of a shape is enabled.
void	setShearAngle(int angle) This property returns or sets the shear angle of a shape in 1/100th degree.
void	setSizeProtect(boolean sizeProtect) This property returns or sets whether the size of the shape can be changed.
void	setTop(int top) This property returns or sets the top position of a shape in 1/100th mm.
void	setWidth(int width) This property returns or sets the width of a shape in 1/100th mm.
void	setZOrder(int order) This property returns the display order of a shape.

Method Detail

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets the name of the shape.

Returns:

name

Throws:

RemoteEclipseAPIException

setName

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

This property returns or sets the name of the shape.

Parameters:

name -

Throws:

RemoteEclipseAPIException

cut

void cut()
         throws RemoteEclipseAPIException

This method cuts the current shape to the clipboard.

Throws:

RemoteEclipseAPIException

copy

void copy()
          throws RemoteEclipseAPIException

This method copies the current shape to the clipboard

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method removes the current shape from the page.

Throws:

RemoteEclipseAPIException

getHeight

int getHeight()
              throws RemoteEclipseAPIException

This property returns or sets the height of a shape in 1/100th mm. If the height is negative, this property throws an exception.

Returns:

height

Throws:

RemoteEclipseAPIException

getWidth

int getWidth()
             throws RemoteEclipseAPIException

This property returns or sets the width of a shape in 1/100th mm. If the width is negative, this property throws an exception.

Returns:

width

Throws:

RemoteEclipseAPIException

getTop

int getTop()
           throws RemoteEclipseAPIException

This property returns or sets the top position of a shape in 1/100th mm.

Returns:

top

Throws:

RemoteEclipseAPIException

getLeft

int getLeft()
            throws RemoteEclipseAPIException

This property returns or sets the left position of the shape in 1/100th mm.

Returns:

left

Throws:

RemoteEclipseAPIException

setZOrder

void setZOrder(int order)
               throws RemoteEclipseAPIException

This property returns the display order of a shape. The value is from 0 to the count of the shapes on the page minus 1. The higher the value, the higher the shape is in the Z-order. If the value is out of bounds, this method throws an exception.

Parameters:

order -

Throws:

RemoteEclipseAPIException

getZOrder

int getZOrder()
              throws RemoteEclipseAPIException

This property returns the display order of a shape. The value is from 0 to the count of the shapes on the page minus 1. The higher the value, the higher the shape is in the Z-order. If the value is out of bounds, this method throws an exception.

Returns:

order

Throws:

RemoteEclipseAPIException

getFillFormat

IRemoteFillFormat getFillFormat()
                                throws RemoteEclipseAPIException

This property returns the fill format of a shape.

The connector shape, graphic shape, group shape, line shape, measure shape, and shapes of unknown type do not support this property.

Returns:

format

Throws:

RemoteEclipseAPIException

getType

int getType()
            throws RemoteEclipseAPIException

This property returns the type of a shape.
Legal value:

Constant	Value	Description
Constant.SHAPE_TYPE_TEXTSHAPE	0	specifies a text box.
Constant.SHAPE_TYPE_TABLESHAPE	1	specifies a table.
Constant.SHAPE_TYPE_RECTANGLESHAPE	2	specifies a rectangle shape.
Constant.SHAPE_TYPE_ELLIPSESHAPE	3	specifies an ellipse shape.
Constant.SHAPE_TYPE_LINESHAPE	4	specifies a line shape.
Constant.SHAPE_TYPE_CONNECTORSHAPE	5	specifies a connector shape.
Constant.SHAPE_TYPE_GROUPSHAPE	6	specifies a group shape.
Constant.SHAPE_TYPE_MEASURESHAPE	7	specifies a measure shape.
Constant.SHAPE_TYPE_GRAPHICSHAPE	8	specifies a graphic shape.
Constant.SHAPE_TYPE_UNKNOWNSHAPE	1024	specifies a unknown shape.

Returns:

type

Throws:

RemoteEclipseAPIException

getMoveProtect

boolean getMoveProtect()
                       throws RemoteEclipseAPIException

This property returns or sets whether the shape can be moved.

Returns:

moveProtect

Throws:

RemoteEclipseAPIException

setMoveProtect

void setMoveProtect(boolean moveProtect)
                    throws RemoteEclipseAPIException

This property returns or sets whether the shape can be moved.

Parameters:

moveProtect -

Throws:

RemoteEclipseAPIException

getSizeProtect

boolean getSizeProtect()
                       throws RemoteEclipseAPIException

This property returns or sets whether the size of the shape can be changed.

Returns:

sizeProtect, true specifies the shape size cannot be changed.

Throws:

RemoteEclipseAPIException

setSizeProtect

void setSizeProtect(boolean sizeProtect)
                    throws RemoteEclipseAPIException

This property returns or sets whether the size of the shape can be changed.

Parameters:

sizeProtect, - true specifies the shape size cannot be changed.

Throws:

RemoteEclipseAPIException

isShadowEnable

boolean isShadowEnable()
                       throws RemoteEclipseAPIException

This property returns or sets whether the shadow format of a shape is enabled. When the value is true, the shadow format is enabled. When the value is false, then the shadow format is not enabled.

The group shape and unknown type shape do not support this property.

Returns:

enable

Throws:

RemoteEclipseAPIException

setShadowEnable

void setShadowEnable(boolean enable)
                     throws RemoteEclipseAPIException

This property returns or sets whether the shadow format of a shape is enabled. When the value is true, the shadow format is enabled. When the value is false, then the shadow format is not enabled.

The group shape and unknown type shape do not support this property.

Parameters:

enable -

Throws:

RemoteEclipseAPIException

getShadowFormat

IRemoteShadowFormat getShadowFormat()
                                    throws RemoteEclipseAPIException

This property returns the shadow format of a shape and is used with the ShadowEnable property.

The group shape and unknown type shape do not support this property.

Before getting the shadow format of a shape, you must set the ShadowEnable property to true. When the ShadowEnable property is false, this property throws an exception.

Returns:

format

Throws:

RemoteEclipseAPIException

getContent

IRemoteTextRange getContent()
                            throws RemoteEclipseAPIException

This property returns the text range of a shape.
The shapes of unknown type do not support this property.

Returns:

content

Throws:

RemoteEclipseAPIException

getParagraphs

IRemoteTextParagraphs getParagraphs()
                                    throws RemoteEclipseAPIException

This property returns a TextParagraphs object that represents all the paragraphs of a shape.

Returns:

paragraphs

Throws:

RemoteEclipseAPIException

getAttributes

IRemoteUserDefinedAttributes getAttributes()
                                           throws RemoteEclipseAPIException

This property returns the user-defined attributes of a shape.
The shapes of unknown type do not support this property.

Returns:

attributes

Throws:

RemoteEclipseAPIException

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

setHeight

void setHeight(int height)
               throws RemoteEclipseAPIException

This property returns or sets the height of a shape in 1/100th mm. If the height is negative, this property throws an exception.

Parameters:

height -

Throws:

RemoteEclipseAPIException

setWidth

void setWidth(int width)
              throws RemoteEclipseAPIException

This property returns or sets the width of a shape in 1/100th mm. If the width is negative, this property throws an exception.

Parameters:

width -

Throws:

RemoteEclipseAPIException

setTop

void setTop(int top)
            throws RemoteEclipseAPIException

This property returns or sets the top position of a shape in 1/100th mm.

Parameters:

top -

Throws:

RemoteEclipseAPIException

setLeft

void setLeft(int left)
             throws RemoteEclipseAPIException

This property returns or sets the left position of the shape in 1/100th mm.

Parameters:

left -

Throws:

RemoteEclipseAPIException

getLineFormat

IRemoteLineFormat getLineFormat()
                                throws RemoteEclipseAPIException

This property returns the line format of the shape.

The graphic shape, group shape, and shapes of unknown type do not support this property.

Returns:

format

Throws:

RemoteEclipseAPIException

setRotateAngle

void setRotateAngle(int angle)
                    throws RemoteEclipseAPIException

This property returns or sets the rotate angle of a shape in 1/100th degree. Valid values are from 0 to 36000. If the value is out of bounds, this property throws an exception.

Parameters:

angle - angle

Throws:

RemoteEclipseAPIException

setShearAngle

void setShearAngle(int angle)
                   throws RemoteEclipseAPIException

This property returns or sets the shear angle of a shape in 1/100th degree. Valid values are from 0 to 36000. If the value is out of bounds, this property throws an exception.

The textshape,tableshape,connectorshape,graphicshape ,groupshape and unknown type shape do not support this property.

Parameters:

angle -

Throws:

RemoteEclipseAPIException

getRotateAngle

int getRotateAngle()
                   throws RemoteEclipseAPIException

This property returns or sets the rotate angle of a shape in 1/100th degree. Valid values are from 0 to 36000. If the value is out of bounds, this property throws an exception.

Returns:

angle

Throws:

RemoteEclipseAPIException

getShearAngle

int getShearAngle()
                  throws RemoteEclipseAPIException

This property returns or sets the shear angle of a shape in 1/100th degree. Valid values are from 0 to 36000. If the value is out of bounds, this property throws an exception.

The textshape,tableshape,connectorshape,graphicshape ,groupshape and unknown type shape do not support this property.

Returns:

angle

Throws:

RemoteEclipseAPIException

exportToImage

void exportToImage(java.lang.String filename,
                   int imageType,
                   int quality)
                   throws RemoteEclipseAPIException

This method exports the specified shape 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