com.grapecity.documents.excel.drawing

Interface IShapes

All Superinterfaces:

java.lang.Iterable<IShape>

public interface IShapes
extends java.lang.Iterable<IShape>

A collection of all the IShape objects on the specified sheet.

Method Summary

Modifier and Type	Method and Description
IShape	addCameraPicture(java.lang.String reference, double left, double top) Creates a picture from reference range.Returns the IShape object that represents the new picture.
IShape	addCameraPicture(java.lang.String reference, double left, double top, double width, double height) Creates a picture from reference range.Returns the IShape object that represents the new picture.
IShape	addCameraPicture(java.lang.String reference, java.lang.String name, double left, double top) Creates a picture from reference range.Returns the IShape object that represents the new picture.
IShape	addCameraPicture(java.lang.String reference, java.lang.String name, double left, double top, double width, double height) Creates a picture from reference range.Returns the IShape object that represents the new picture.
IShape	addChart(ChartType chartType, double left, double top, double width, double height) Creates a chart at the specified location on the active sheet.
IShape	addChart(java.lang.String name, ChartType chartType, double left, double top, double width, double height) Creates a chart at the specified location on the active sheet.
IShape	addChartInPixel(ChartType chartType, double left, double top, double width, double height) Creates a chart at the specified location on the active sheet.
IShape	addChartInPixel(java.lang.String name, ChartType chartType, double left, double top, double width, double height) Creates a chart at the specified location on the active sheet.
IShape	addConnector(ConnectorType type, double beginX, double beginY, double endX, double endY) Creates a connector.
IShape	addConnector(java.lang.String name, ConnectorType type, double beginX, double beginY, double endX, double endY) Creates a connector.
IShape	addConnectorInPixel(ConnectorType type, float beginX, float beginY, float endX, float endY) Creates a connector.
IShape	addConnectorInPixel(java.lang.String name, ConnectorType type, float beginX, float beginY, float endX, float endY) Creates a connector.
IShape	addPicture(java.io.InputStream stream, ImageType type, double left, double top, double width, double height) Creates a picture from an existing stream.
IShape	addPicture(java.lang.String filename, double left, double top, double width, double height) Creates a picture from an existing file.
IShape	addPicture(java.lang.String name, java.io.InputStream stream, ImageType type, double left, double top, double width, double height) Creates a picture from an existing stream.
IShape	addPicture(java.lang.String name, java.lang.String filename, double left, double top, double width, double height) Creates a picture from an existing file.
IShape	addPictureInPixel(java.io.InputStream stream, ImageType type, double left, double top, double width, double height) Creates a picture from an existing stream.
IShape	addPictureInPixel(java.lang.String filename, double left, double top, double width, double height) Creates a picture from an existing file.
IShape	addPictureInPixel(java.lang.String name, java.io.InputStream stream, ImageType type, double left, double top, double width, double height) Creates a picture from an existing stream.
IShape	addPictureInPixel(java.lang.String name, java.lang.String filename, double left, double top, double width, double height) Creates a picture from an existing file.
IShape	addShape(AutoShapeType type, double left, double top, double width, double height) Returns the IShape object that represents the new AutoShape in a worksheet.
IShape	addShape(java.lang.String name, AutoShapeType type, double left, double top, double width, double height) Returns the IShape object that represents the new AutoShape in a worksheet.
IShape	addShapeInPixel(AutoShapeType type, double left, double top, double width, double height) Returns the IShape object that represents the new AutoShape in a worksheet.
IShape	addShapeInPixel(java.lang.String name, AutoShapeType type, double left, double top, double width, double height) Returns the IShape object that represents the new AutoShape in a worksheet.
IShape	get(int index) Returns a single object from a collection.
IShape	get(java.lang.String name) Returns a single object from a collection.
int	getCount() Returns the number of objects in the collection.
IShapeRange	getRange(int[] index) Returns a ShapeRange object that represents a subset of the shapes in a Shapes collection.
IShapeRange	getRange(java.lang.String[] index) Returns a ShapeRange object that represents a subset of the shapes in a Shapes collection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getRange

IShapeRange getRange(java.lang.String[] index)

Returns a ShapeRange object that represents a subset of the shapes in a Shapes collection.

getRange

IShapeRange getRange(int[] index)

Returns a ShapeRange object that represents a subset of the shapes in a Shapes collection.

get

IShape get(int index)

Returns a single object from a collection.

Parameters:

index - Required int. The index number for the object.

get

IShape get(java.lang.String name)

Returns a single object from a collection.

Parameters:

name - Required string. The name for the object.

getCount

int getCount()

Returns the number of objects in the collection.

addChart

IShape addChart(ChartType chartType,
                double left,
                double top,
                double width,
                double height)

Creates a chart at the specified location on the active sheet.

Parameters:

chartType - The chart type

left - The distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

top - The distance, in points, from the top edge of the top most shape in the shape range to the top edge of the worksheet.

width - The width, in points, of the object

height - The height, in points, of the object

Returns:

The IShapeThe object.

addChart

IShape addChart(java.lang.String name,
                ChartType chartType,
                double left,
                double top,
                double width,
                double height)

Creates a chart at the specified location on the active sheet.

Parameters:

name - * The chart name

chartType - The chart type

left - The distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

top - The distance, in points, from the top edge of the top most shape in the shape range to the top edge of the worksheet.

width - The width, in points, of the object

height - The height, in points, of the object

Returns:

The IShapeThe object.

addPicture

IShape addPicture(java.lang.String filename,
                  double left,
                  double top,
                  double width,
                  double height)
           throws java.io.IOException

Creates a picture from an existing file. Returns the IShape object that represents the new picture.

Parameters:

filename - The file from which the object is to be created

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in points.

height - The height of the picture, in points.

Returns:

The IShapeThe object.

Throws:

java.io.IOException

addPicture

IShape addPicture(java.lang.String name,
                  java.lang.String filename,
                  double left,
                  double top,
                  double width,
                  double height)
           throws java.io.IOException

Creates a picture from an existing file. Returns the IShape object that represents the new picture.

Parameters:

name - The picture name

filename - The file from which the object is to be created

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in points.

height - The height of the picture, in points.

Returns:

The IShapeThe object.

Throws:

java.io.IOException

addPicture

IShape addPicture(java.io.InputStream stream,
                  ImageType type,
                  double left,
                  double top,
                  double width,
                  double height)
           throws java.io.IOException

Creates a picture from an existing stream. Returns the IShape object that represents the new picture.

Parameters:

stream - The stream from which the object is to be created.

type - Specifies the type of picture to create.

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in points.

height - The height of the picture, in points.

Returns:

The IShapeThe object.

Throws:

java.io.IOException

addPicture

IShape addPicture(java.lang.String name,
                  java.io.InputStream stream,
                  ImageType type,
                  double left,
                  double top,
                  double width,
                  double height)
           throws java.io.IOException

Creates a picture from an existing stream. Returns the IShape object that represents the new picture.

Parameters:

name - The picture name

stream - The stream from which the object is to be created.

type - Specifies the type of picture to create.

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in points.

height - The height of the picture, in points.

Returns:

The IShapeThe object.

Throws:

java.io.IOException

addShape

IShape addShape(AutoShapeType type,
                double left,
                double top,
                double width,
                double height)

Returns the IShape object that represents the new AutoShape in a worksheet.

Parameters:

type - Specifies the type of AutoShape to create.

left - The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

width - The width and height of the AutoShape's boundary box, in points.

height - The width and height of the AutoShape's boundary box, in points.

Returns:

The IShapeThe object.

addShape

IShape addShape(java.lang.String name,
                AutoShapeType type,
                double left,
                double top,
                double width,
                double height)

Returns the IShape object that represents the new AutoShape in a worksheet.

Parameters:

name - The shape name

type - Specifies the type of AutoShape to create.

left - The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

width - The width and height of the AutoShape's boundary box, in points.

height - The width and height of the AutoShape's boundary box, in points.

Returns:

The IShapeThe object.

addConnector

IShape addConnector(ConnectorType type,
                    double beginX,
                    double beginY,
                    double endX,
                    double endY)

Creates a connector. Returns the IShape object that represents the new connector.

Parameters:

type - The connector type to add.

beginX - The horizontal position (in points) of the connector's starting point relative to the upper-left corner of the document.

beginY - The vertical position (in points) of the connector's starting point relative to the upper-left corner of the document.

endX - The horizontal position (in points) of the connector's end point relative to the upper-left corner of the document.

endY - The veritcal position (in points) of the connector's end point relative to the upper-left corner of the document.

Returns:

The IShape object.

addConnector

IShape addConnector(java.lang.String name,
                    ConnectorType type,
                    double beginX,
                    double beginY,
                    double endX,
                    double endY)

Creates a connector. Returns the IShape object that represents the new connector.

Parameters:

name - The connector name

type - The connector type to add.

beginX - The horizontal position (in points) of the connector's starting point relative to the upper-left corner of the document.

beginY - The vertical position (in points) of the connector's starting point relative to the upper-left corner of the document.

endX - The horizontal position (in points) of the connector's end point relative to the upper-left corner of the document.

endY - The veritcal position (in points) of the connector's end point relative to the upper-left corner of the document.

Returns:

The IShape object.

addChartInPixel

IShape addChartInPixel(ChartType chartType,
                       double left,
                       double top,
                       double width,
                       double height)

Creates a chart at the specified location on the active sheet.

Parameters:

chartType - The chart type

left - The distance, in pixels, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

top - The distance, in pixels, from the top edge of the top most shape in the shape range to the top edge of the worksheet.

width - The width, in pixels, of the object

height - The height, in pixels, of the object

Returns:

The IShape object.

addChartInPixel

IShape addChartInPixel(java.lang.String name,
                       ChartType chartType,
                       double left,
                       double top,
                       double width,
                       double height)

Creates a chart at the specified location on the active sheet.

Parameters:

name - The chart name

chartType - The chart type

left - The distance, in pixels, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

top - The distance, in pixels, from the top edge of the top most shape in the shape range to the top edge of the worksheet.

width - The width, in pixels, of the object

height - The height, in pixels, of the object

Returns:

The IShape object.

addPictureInPixel

IShape addPictureInPixel(java.lang.String filename,
                         double left,
                         double top,
                         double width,
                         double height)
                  throws java.io.IOException

Creates a picture from an existing file. Returns the IShape object that represents the new picture.

Parameters:

filename - The file from which the object is to be created

left - The position (in pixels) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in pixels.

height - The height of the picture, in pixels.

Returns:

The IShape object.

Throws:

java.io.IOException

addPictureInPixel

IShape addPictureInPixel(java.lang.String name,
                         java.lang.String filename,
                         double left,
                         double top,
                         double width,
                         double height)
                  throws java.io.IOException

Creates a picture from an existing file. Returns the IShape object that represents the new picture.

Parameters:

name - The picture name

filename - The file from which the object is to be created

left - The position (in pixels) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in pixels.

height - The height of the picture, in pixels.

Returns:

The IShape object.

Throws:

java.io.IOException

addPictureInPixel

IShape addPictureInPixel(java.io.InputStream stream,
                         ImageType type,
                         double left,
                         double top,
                         double width,
                         double height)
                  throws java.io.IOException

Creates a picture from an existing stream. Returns the IShape object that represents the new picture.

Parameters:

stream - The stream from which the object is to be created.

type - Specifies the type of picture to create.

left - The position (in pixels) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in pixels.

height - The height of the picture, in pixels.

Returns:

The IShape object.

Throws:

java.io.IOException

addPictureInPixel

IShape addPictureInPixel(java.lang.String name,
                         java.io.InputStream stream,
                         ImageType type,
                         double left,
                         double top,
                         double width,
                         double height)
                  throws java.io.IOException

Creates a picture from an existing stream. Returns the IShape object that represents the new picture.

Parameters:

name - The picture name

stream - The stream from which the object is to be created.

type - Specifies the type of picture to create.

left - The position (in pixels) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the picture relative to the top of the document.

width - The width of the picture, in pixels.

height - The height of the picture, in pixels.

Returns:

The IShape object.

Throws:

java.io.IOException

addShapeInPixel

IShape addShapeInPixel(AutoShapeType type,
                       double left,
                       double top,
                       double width,
                       double height)

Returns the IShape object that represents the new AutoShape in a worksheet.

Parameters:

type - Specifies the type of AutoShape to create.

left - The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

width - The width and height of the AutoShape's boundary box, in pixels.

height - The width and height of the AutoShape's boundary box, in pixels.

Returns:

The IShape object.

addShapeInPixel

IShape addShapeInPixel(java.lang.String name,
                       AutoShapeType type,
                       double left,
                       double top,
                       double width,
                       double height)

Returns the IShape object that represents the new AutoShape in a worksheet.

Parameters:

name - The shape name

type - Specifies the type of AutoShape to create.

left - The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

top - The position (in pixels) of the upper-left corner of the AutoShape's boundary box relative to the upper-left corner of the document.

width - The width and height of the AutoShape's boundary box, in pixels.

height - The width and height of the AutoShape's boundary box, in pixels.

Returns:

The IShape object.

addConnectorInPixel

IShape addConnectorInPixel(ConnectorType type,
                           float beginX,
                           float beginY,
                           float endX,
                           float endY)

Creates a connector. Returns the IShape object that represents the new connector.

Parameters:

type - The connector type to add.

beginX - The horizontal position (in pixels) of the connector's starting point relative to the upper-left corner of the document.

beginY - The vertical position (in pixels) of the connector's starting point relative to the upper-left corner of the document.

endX - The horizontal position (in pixels) of the connector's end point relative to the upper-left corner of the document.

endY - The veritcal position (in pixels) of the connector's end point relative to the upper-left corner of the document.

Returns:

The IShape object.

addConnectorInPixel

IShape addConnectorInPixel(java.lang.String name,
                           ConnectorType type,
                           float beginX,
                           float beginY,
                           float endX,
                           float endY)

Creates a connector. Returns the IShape object that represents the new connector.

Parameters:

name - The connector name

type - The connector type to add.

beginX - The horizontal position (in pixels) of the connector's starting point relative to the upper-left corner of the document.

beginY - The vertical position (in pixels) of the connector's starting point relative to the upper-left corner of the document.

endX - The horizontal position (in pixels) of the connector's end point relative to the upper-left corner of the document.

endY - The veritcal position (in pixels) of the connector's end point relative to the upper-left corner of the document.

Returns:

The IShape object.

addCameraPicture

IShape addCameraPicture(java.lang.String reference,
                        double left,
                        double top)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

Parameters:

reference - The range of the picture generated from

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

Returns:

The IShapeThe object.

addCameraPicture

IShape addCameraPicture(java.lang.String reference,
                        double left,
                        double top,
                        double width,
                        double height)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

Parameters:

reference - The range of the picture generated from

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

width - The width and height of the AutoShape's boundary box, in points.

height - The width and height of the AutoShape's boundary box, in points.

Returns:

The IShapeThe object.

addCameraPicture

IShape addCameraPicture(java.lang.String reference,
                        java.lang.String name,
                        double left,
                        double top)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

Parameters:

reference - The range of the picture generated from

name - The picture name

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

Returns:

The IShapeThe object.

addCameraPicture

IShape addCameraPicture(java.lang.String reference,
                        java.lang.String name,
                        double left,
                        double top,
                        double width,
                        double height)

Creates a picture from reference range.Returns the IShape object that represents the new picture.

Parameters:

reference - The range of the picture generated from

name - The picture name

left - The position (in points) of the upper-left corner of the picture relative to the upper-left corner of the document.

top - The position (in points) of the upper-left corner of the picture relative to the top of the document.

width - The width and height of the AutoShape's boundary box, in points.

height - The width and height of the AutoShape's boundary box, in points.

Returns:

The IShapeThe object.