com.spire.presentation.collections
Class ShapeList

java.lang.Object
  com.spire.presentation.collections.ShapeList

Direct Known Subclasses:

ShapeCollection

public class ShapeList
extends java.lang.Object

Represents a collection of a shapes.

Constructor Summary

ShapeList()

Method Summary

void	addFromHtml(java.lang.String htmlText)
void	addShape(Shape shape) Add a shape to shape list.
IAudio	appendAudioMedia(java.io.InputStream stream, float X, float Y) Adds a new audio to list.
IAudio	appendAudioMedia(java.io.InputStream stream, java.awt.geom.Rectangle2D rectangle) Adds a new audio to list.
IAudio	appendAudioMedia(java.awt.geom.Rectangle2D rectangle) Adds an Audio from CD
IAudio	appendAudioMedia(java.lang.String filePath, float X, float Y) Adds a new audio to list.
IAudio	appendAudioMedia(java.lang.String filePath, float X, float Y, boolean isEmbed) Adds a new audio to list.
IAudio	appendAudioMedia(java.lang.String filePath, java.awt.geom.Rectangle2D rectangle) Adds a new audio to list.
IAudio	appendAudioMedia(java.lang.String filePath, java.awt.geom.Rectangle2D rectangle, boolean isEmbed) Adds a new audio to list.
IChart	appendChart(ChartType type, java.awt.geom.Rectangle2D rectangle) Adds a new chart.init chart use default data
IChart	appendChart(ChartType type, java.awt.geom.Rectangle2D rectangle, boolean init) Adds a new chart.
IEmbedImage	appendEmbedImage(ShapeType shapeType, IImageData embedImage, java.awt.geom.Rectangle2D rectangle) Add a new embed image to List.
IEmbedImage	appendEmbedImage(ShapeType shapeType, java.io.InputStream stream, java.awt.geom.Rectangle2D rectangle) Add a new embed image to List.
IEmbedImage	appendEmbedImage(ShapeType shapeType, java.lang.String fileName, java.awt.geom.Rectangle2D rectangle) Add a new embed image to List.
IOleObject	appendOleObject(java.lang.String objectName, byte[] objectData, java.awt.geom.Rectangle2D rectangle) Add a new OleObject to Collection
IOleObject	appendOleObject(java.lang.String objectName, byte[] objectData, com.spire.ms.System.Drawing.RectangleF rectangle)
IAutoShape	appendRoundRectangle(float x, float y, float width, float height, float radius) Adds a roundrectangle to list.
IAutoShape	appendShape(ShapeType shapeType, java.awt.geom.Rectangle2D rectangle) Adds a new shape to list.
IShape	appendShapeConnector(ShapeType shapeType, java.awt.geom.Rectangle2D rectangle) Add new shape connector to collection.
ISmartArt	appendSmartArt(float x, float y, float width, float height, SmartArtLayoutType layoutType) Add SmartArt object
ITable	appendTable(float x, float y, java.lang.Double[] widths, java.lang.Double[] heights) Add a new table to collection.
IVideo	appendVideoMedia(java.lang.String filePath, java.awt.geom.Rectangle2D rectangle) Add a new video to collection.
IVideo	appendVideoMedia(java.lang.String filePath, java.awt.geom.Rectangle2D rectangle, boolean isInnerLink) Add a new video to collection
IChart	createChart(IChart baseChart, java.awt.geom.Rectangle2D rectangle, int nIndex) clone basechart and insert into shapes
IShape	get(int index) Gets the element at the specified index.
int	getCount() Gets the number of elements actually contained in the collection.
java.lang.Object	getParent() Gets parent object for a Shapes collection.
int	indexOf(IShape shape) Gets the index of the first occurrence of a shape in the collectio
void	insertAudioMedia(int index, java.io.InputStream stream, java.awt.geom.Rectangle2D rectangle) Insert an audio to collection.
void	insertAudioMedia(int index, java.awt.geom.Rectangle2D rectangle) Insert an Audio From CD.
void	insertAudioMedia(int index, java.lang.String filePath, float X, float Y) Insert an audio to collection.
void	insertAudioMedia(int index, java.lang.String filePath, float X, float Y, boolean isEmbed) Insert an audio to collection.
void	insertAudioMedia(int index, java.lang.String filePath, java.awt.geom.Rectangle2D rectangle) Insert an audio to collection.
void	insertAudioMedia(int index, java.lang.String filePath, java.awt.geom.Rectangle2D rectangle, boolean isEmbed) Insert an audio to collection.
void	insertChart(int index, ChartType type, java.awt.geom.Rectangle2D rectangle, boolean init) Add a new chart to collection.
void	insertEmbedImage(int index, ShapeType shapeType, java.awt.geom.Rectangle2D rectangle, IImageData embedImage) Insert a embed image to collection.
void	insertOleObject(int index, java.lang.String objectName, byte[] objectData, java.awt.geom.Rectangle2D rectangle) Insert a object to collection.
void	insertOleObject(int index, java.lang.String objectName, byte[] objectData, com.spire.ms.System.Drawing.RectangleF rectangle)
void	insertRoundRectangle(int index, float x, float y, float width, float height, float radius) Insert a new shape to collection.
void	insertShape(int index, ShapeType shapeType, java.awt.geom.Rectangle2D rectangle) Insert a new shape to collection.
void	insertShapeConnector(int index, ShapeType shapeType, java.awt.geom.Rectangle2D rectangle) Insert a new shape connector to collection.
void	insertTable(int index, float x, float y, java.lang.Double[] columnWidths, java.lang.Double[] rowHeights) Adds a new Table to collection.
void	insertVideoMedia(int index, java.lang.String filePath, java.awt.geom.Rectangle2D rectangle) Adds a new video to collection.
void	remove(IShape shape) Removes the first occurrence of a specific shape from the collection.
void	removeAt(int index) Removes the element at the specified index of the collection.
void	saveAsEMF(int shapeIndex, java.lang.String filePath) Save shapes to EMF.
java.awt.image.BufferedImage	saveAsImage(int shapeIndex) Save shapes to Image.
IShape[]	toArray() Creates and returns an array with all shapse in it.
IShape[]	toArray(int startIndex, int count) Creates and returns an array with all shapes from the specified range in it.
void	zOrder(int index, IShape... shapes) Change shapes's zorder.
void	zOrder(int index, IShape shape) Change a shape's zorder.

Constructor Detail

ShapeList

public ShapeList()

Method Detail

getCount

public int getCount()

Gets the number of elements actually contained in the collection. Read-only .

Returns:

get

public IShape get(int index)

Gets the element at the specified index. Read-only .

Parameters:

index -

Returns:

saveAsImage

public java.awt.image.BufferedImage saveAsImage(int shapeIndex)

Save shapes to Image.

Parameters:

shapeIndex -

Returns:

Throws:

java.lang.Exception

saveAsEMF

public void saveAsEMF(int shapeIndex,
                      java.lang.String filePath)

Save shapes to EMF.

Parameters:

shapeIndex - Represents the shape index in the indicated slide's shapes collection

filePath - Represents the save path

Throws:

java.lang.Exception

createChart

public IChart createChart(IChart baseChart,
                          java.awt.geom.Rectangle2D rectangle,
                          int nIndex)

clone basechart and insert into shapes

Parameters:

baseChart - source chart<

rectangle - Rectangle should be inserted

nIndex - index should be inserted.-1 mean append at the last.

Returns:

Throws:

java.lang.Exception

appendChart

public IChart appendChart(ChartType type,
                          java.awt.geom.Rectangle2D rectangle,
                          boolean init)

Adds a new chart.

Parameters:

type -

rectangle -

init -

Returns:

Throws:

java.lang.Exception

appendChart

public IChart appendChart(ChartType type,
                          java.awt.geom.Rectangle2D rectangle)

Adds a new chart.init chart use default data

Parameters:

type - Chart type

rectangle - rectangle should be inserted.

Returns:

Throws:

java.lang.Exception

appendSmartArt

public ISmartArt appendSmartArt(float x,
                                float y,
                                float width,
                                float height,
                                SmartArtLayoutType layoutType)

Add SmartArt object

Parameters:

x -

y -

width -

height -

layoutType -

Returns:

Throws:

java.lang.Exception

insertChart

public void insertChart(int index,
                        ChartType type,
                        java.awt.geom.Rectangle2D rectangle,
                        boolean init)

Add a new chart to collection.

Parameters:

index - Index should be inserted.

type - Chart type

rectangle - Rectangle should inserted.

init -

Throws:

java.lang.Exception

appendOleObject

public IOleObject appendOleObject(java.lang.String objectName,
                                  byte[] objectData,
                                  java.awt.geom.Rectangle2D rectangle)

Add a new OleObject to Collection

Parameters:

objectName -

objectData -

rectangle -

Returns:

Throws:

java.lang.Exception

appendOleObject

public IOleObject appendOleObject(java.lang.String objectName,
                                  byte[] objectData,
                                  com.spire.ms.System.Drawing.RectangleF rectangle)

insertOleObject

public void insertOleObject(int index,
                            java.lang.String objectName,
                            byte[] objectData,
                            java.awt.geom.Rectangle2D rectangle)

Insert a object to collection.

Parameters:

index -

objectName -

objectData -

rectangle -

Throws:

java.lang.Exception

insertOleObject

public void insertOleObject(int index,
                            java.lang.String objectName,
                            byte[] objectData,
                            com.spire.ms.System.Drawing.RectangleF rectangle)

appendVideoMedia

public IVideo appendVideoMedia(java.lang.String filePath,
                               java.awt.geom.Rectangle2D rectangle)

Add a new video to collection. innerLink mode

Parameters:

filePath -

rectangle -

Returns:

Throws:

java.lang.Exception

appendVideoMedia

public IVideo appendVideoMedia(java.lang.String filePath,
                               java.awt.geom.Rectangle2D rectangle,
                               boolean isInnerLink)

Add a new video to collection

Parameters:

filePath -

rectangle -

isInnerLink -

Returns:

Throws:

java.lang.Exception

insertVideoMedia

public void insertVideoMedia(int index,
                             java.lang.String filePath,
                             java.awt.geom.Rectangle2D rectangle)

Adds a new video to collection.

Parameters:

index - Index should be inserted.

filePath - Video file path.

rectangle - Rectangle should be inserted.

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.awt.geom.Rectangle2D rectangle)

Adds an Audio from CD

Parameters:

rectangle -

Returns:

Throws:

java.lang.Exception

insertAudioMedia

public void insertAudioMedia(int index,
                             java.awt.geom.Rectangle2D rectangle)

Insert an Audio From CD.

Parameters:

index -

rectangle -

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.lang.String filePath,
                               float X,
                               float Y,
                               boolean isEmbed)

Adds a new audio to list.

Parameters:

filePath - Audio file name

X - X Position

Y - Y Position<

isEmbed - Whether embed or not

Returns:

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.lang.String filePath,
                               float X,
                               float Y)

Adds a new audio to list.

Parameters:

filePath - Audio file name

X - X Position

Y - Y Position

Returns:

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.lang.String filePath,
                               java.awt.geom.Rectangle2D rectangle,
                               boolean isEmbed)

Adds a new audio to list.

Parameters:

filePath - Audio file name

rectangle - Rectangle should be inserted

isEmbed - Whether embed or not,default not

Returns:

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.lang.String filePath,
                               java.awt.geom.Rectangle2D rectangle)

Adds a new audio to list.

Parameters:

filePath - Audio file name

rectangle - Rectangle should be inserted

Returns:

Throws:

java.lang.Exception

insertAudioMedia

public void insertAudioMedia(int index,
                             java.lang.String filePath,
                             java.awt.geom.Rectangle2D rectangle,
                             boolean isEmbed)

Insert an audio to collection.

Parameters:

index -

filePath - Audio file path

rectangle - Rectangle should be inserted.

isEmbed - Whether embed or not,default not

Throws:

java.lang.Exception

insertAudioMedia

public void insertAudioMedia(int index,
                             java.lang.String filePath,
                             java.awt.geom.Rectangle2D rectangle)

Insert an audio to collection.

Parameters:

index -

filePath - Audio file path

rectangle - Rectangle should be inserted.

Throws:

java.lang.Exception

insertAudioMedia

public void insertAudioMedia(int index,
                             java.lang.String filePath,
                             float X,
                             float Y,
                             boolean isEmbed)

Insert an audio to collection.

Parameters:

index -

filePath - Audio file path<

X -

Y -

isEmbed - Whether embed or not,default not

Throws:

java.lang.Exception

insertAudioMedia

public void insertAudioMedia(int index,
                             java.lang.String filePath,
                             float X,
                             float Y)

Insert an audio to collection.

Parameters:

index -

filePath - Audio file path

X -

Y -

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.io.InputStream stream,
                               java.awt.geom.Rectangle2D rectangle)

Adds a new audio to list.

Parameters:

stream - Audio InputStream

rectangle - Rectangle should be inserted

Returns:

Throws:

java.lang.Exception

appendAudioMedia

public IAudio appendAudioMedia(java.io.InputStream stream,
                               float X,
                               float Y)

Adds a new audio to list.

Parameters:

stream - Audio stream

X -

Y -

Returns:

Throws:

java.lang.Exception

insertAudioMedia

public void insertAudioMedia(int index,
                             java.io.InputStream stream,
                             java.awt.geom.Rectangle2D rectangle)

Insert an audio to collection.

Parameters:

index - Index to inserted.

stream - Audio stream

rectangle - Rectangle should be inserted

Throws:

java.lang.Exception

indexOf

public int indexOf(IShape shape)

Gets the index of the first occurrence of a shape in the collectio

Parameters:

shape -

Returns:

Index of the first occurrence of shape

toArray

public IShape[] toArray()

Creates and returns an array with all shapse in it.

Returns:

Array of

toArray

public IShape[] toArray(int startIndex,
                        int count)

Creates and returns an array with all shapes from the specified range in it.

Parameters:

startIndex - An index of a first shape to return.

count - A number of shapes to return

Returns:

Array of

zOrder

public void zOrder(int index,
                   IShape shape)
            throws DocumentEditException

Change a shape's zorder.

Parameters:

index - Target index.

shape - Shape to move.

Throws:

DocumentEditException

zOrder

public void zOrder(int index,
                   IShape... shapes)
            throws DocumentEditException

Change shapes's zorder.

Parameters:

index - target index

shapes - shapes to move.

Throws:

DocumentEditException

appendShape

public IAutoShape appendShape(ShapeType shapeType,
                              java.awt.geom.Rectangle2D rectangle)

Adds a new shape to list.

Parameters:

shapeType -

rectangle -

Returns:

Throws:

java.lang.Exception

appendRoundRectangle

public IAutoShape appendRoundRectangle(float x,
                                       float y,
                                       float width,
                                       float height,
                                       float radius)

Adds a roundrectangle to list.

Parameters:

x - X-coordinates of rectangle.

y - Y-coordinates of rectangle.

width - Width of rectangle.

height - Height of rectangle.

radius - Radius of rectangle.

Returns:

IAutoShape

Throws:

java.lang.Exception

insertRoundRectangle

public void insertRoundRectangle(int index,
                                 float x,
                                 float y,
                                 float width,
                                 float height,
                                 float radius)

Insert a new shape to collection.

Parameters:

index - Index should be inserted.

x - X-coordinates of rectangle.

y - Y-coordinates of rectangle.

width - Width of rectangle.

height - Height of rectangle.

radius - Radius of rectangle.

Throws:

java.lang.Exception

insertShape

public void insertShape(int index,
                        ShapeType shapeType,
                        java.awt.geom.Rectangle2D rectangle)

Insert a new shape to collection.

Parameters:

index -

shapeType -

rectangle -

Throws:

java.lang.Exception

appendShapeConnector

public IShape appendShapeConnector(ShapeType shapeType,
                                   java.awt.geom.Rectangle2D rectangle)

Add new shape connector to collection.

Parameters:

shapeType -

rectangle -

Returns:

Throws:

java.lang.Exception

insertShapeConnector

public void insertShapeConnector(int index,
                                 ShapeType shapeType,
                                 java.awt.geom.Rectangle2D rectangle)

Insert a new shape connector to collection.

Parameters:

index -

shapeType -

rectangle -

Throws:

java.lang.Exception

appendEmbedImage

public IEmbedImage appendEmbedImage(ShapeType shapeType,
                                    IImageData embedImage,
                                    java.awt.geom.Rectangle2D rectangle)

Add a new embed image to List.

Parameters:

shapeType -

embedImage -

rectangle -

Returns:

Throws:

java.lang.Exception

appendEmbedImage

public IEmbedImage appendEmbedImage(ShapeType shapeType,
                                    java.io.InputStream stream,
                                    java.awt.geom.Rectangle2D rectangle)

Add a new embed image to List.

Parameters:

shapeType -

stream -

rectangle -

Returns:

Throws:

java.lang.Exception

appendEmbedImage

public IEmbedImage appendEmbedImage(ShapeType shapeType,
                                    java.lang.String fileName,
                                    java.awt.geom.Rectangle2D rectangle)

Add a new embed image to List.

Parameters:

shapeType -

fileName -

rectangle -

Returns:

Throws:

java.lang.Exception

insertEmbedImage

public void insertEmbedImage(int index,
                             ShapeType shapeType,
                             java.awt.geom.Rectangle2D rectangle,
                             IImageData embedImage)

Insert a embed image to collection.

Parameters:

index - Index should be inserted.

shapeType - Shape type.

rectangle - Rectangle should be inserted.

embedImage - Embed image object.

Throws:

java.lang.Exception

addShape

public void addShape(Shape shape)

Add a shape to shape list.

Parameters:

shape - Add a shape to shape list.

appendTable

public ITable appendTable(float x,
                          float y,
                          java.lang.Double[] widths,
                          java.lang.Double[] heights)

Add a new table to collection.

Parameters:

x -

y -

widths -

heights -

Returns:

Throws:

java.lang.Exception

insertTable

public void insertTable(int index,
                        float x,
                        float y,
                        java.lang.Double[] columnWidths,
                        java.lang.Double[] rowHeights)

Adds a new Table to collection.

Parameters:

index - Index should be inserted

x - Left side of shape.

y - Top side of shape.

columnWidths - Widths of columns in the table.

rowHeights - Heights of rows in the table.

Throws:

java.lang.Exception

removeAt

public void removeAt(int index)

Removes the element at the specified index of the collection.

Parameters:

index -

remove

public void remove(IShape shape)

Removes the first occurrence of a specific shape from the collection.

Parameters:

shape - The shape to remove from the collection

getParent

public java.lang.Object getParent()

Gets parent object for a Shapes collection. Read-only . See also .

Returns:

addFromHtml

public void addFromHtml(java.lang.String htmlText)