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

All Superinterfaces:

IRemoteShape

public interface IRemoteGroupShape
extends IRemoteShape

This class is the subclass of Shape class, and it represents a group shape.

Creation and access

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

Method Summary

int	countByType(int shapeType) This method returns the number of shapes by specified type.
int	getCount() This property returns the number of shapes in a group shape.
IRemoteShape	item(int index) This method returns a shape according to an index.
IRemoteShape	itemByType(int shapeType, int index) This method returns a shape according to the shape type and index.
void	unGroup() This method release the shapes from a group.

Methods inherited from interface com.mindoo.remote.api.symphony.presentation.IRemoteShape

copy, cut, exportToImage, getApplication, getAttributes, getContent, getFillFormat, getHeight, getLeft, getLineFormat, getMoveProtect, getName, getParagraphs, getRotateAngle, getShadowFormat, getShearAngle, getSizeProtect, getTop, getType, getWidth, getZOrder, isShadowEnable, remove, setHeight, setLeft, setMoveProtect, setName, setRotateAngle, setShadowEnable, setShearAngle, setSizeProtect, setTop, setWidth, setZOrder

Method Detail

unGroup

void unGroup()
             throws RemoteEclipseAPIException

This method release the shapes from a group.

Throws:

RemoteEclipseAPIException

itemByType

IRemoteShape itemByType(int shapeType,
                        int index)
                        throws RemoteEclipseAPIException

This method returns a shape according to the shape type and index.

Parameters:

shapeType - Specifies the type of the shape. The type is a constant and can be one of these values:

• Constant.SHAPE_TYPE_TEXTSHAPE specifies a text box.
• Constant.SHAPE_TYPE_TABLESHAPE specifies a table.
• Constant.SHAPE_TYPE_RECTANGLESHAPE specifies a rectangle shape.
• Constant.SHAPE_TYPE_ELLIPSESHAPE specifies an ellipse shape.
• Constant.SHAPE_TYPE_LINESHAPE specifies a line shape.
• Constant.SHAPE_TYPE_CONNECTORSHAPE specifies a connector shape.
• Constant.SHAPE_TYPE_GROUPSHAPE specifies a group shape.
• Constant.SHAPE_TYPE_GRAPHICSHAPE specifies a graphic shape.
• Constant.SHAPE_TYPE_MEASURESHAPE specifies a measure shape.

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

Returns:

A Shape object that represents a shape.

Throws:

RemoteEclipseAPIException

countByType

int countByType(int shapeType)
                throws RemoteEclipseAPIException

This method returns the number of shapes by specified type.

Parameters:

shapeType - Specifies the type of the shape. The type is a constant and can be one of these values:

• Constant.SHAPE_TYPE_TEXTSHAPE specifies a text box.
• Constant.SHAPE_TYPE_TABLESHAPE specifies a table.
• Constant.SHAPE_TYPE_RECTANGLESHAPE specifies a rectangle shape.
• Constant.SHAPE_TYPE_ELLIPSESHAPE specifies an ellipse shape.
• Constant.SHAPE_TYPE_LINESHAPE specifies a line shape.
• Constant.SHAPE_TYPE_CONNECTORSHAPE specifies a connector shape.
• Constant.SHAPE_TYPE_GROUPSHAPE specifies a group shape.
• Constant.SHAPE_TYPE_GRAPHICSHAPE specifies a graphic shape.
• Constant.SHAPE_TYPE_MEASURESHAPE specifies a measure shape.

Returns:

An integer value.

Throws:

RemoteEclipseAPIException

item

IRemoteShape item(int index)
                  throws RemoteEclipseAPIException

This method returns a shape according to an index.

Parameters:

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

Returns:

A Shape object that represents a shape.

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property returns the number of shapes in a group shape.

Returns:

count

Throws:

RemoteEclipseAPIException