com.aspose.diagram
Class ShapeCollection

java.lang.Object
  extended by Collection
      extended by com.aspose.diagram.ShapeCollection
All Implemented Interfaces:
java.lang.Iterable

public class ShapeCollection 
extends Collection

Collection of Shapes.


Property Getters/Setters Summary
intgetCount()→ inherited from Collection
           Gets the number of elements actually contained in the collection.
Shapeget(int)
           Gets the element at the specified index.
 
Method Summary
intadd(Shape item)
           Add the shape in the collection.
voidclear()→ inherited from Collection
           Removes all elements from collection.
ShapegetShape(java.lang.String name)
           Gets the element at the specified name.
ShapegetShape(long ID)
           Gets the element at the specified ID.
ShapegetShapeIncludingChild(int id)
           Gets the element including it's child shape at the specified id.
ShapegetShapeIncludingChild(java.lang.String name)
           Gets the element including it's child shape at the specified name.
Shapegroup(com.aspose.diagram.Shape[] groupItems)
           Group the shapes.
booleanisExist(int index)→ inherited from Collection
           Is exist item in the collection.
java.util.Iteratoriterator()→ inherited from Collection
           Supports a simple iteration over a nongeneric collection.
voidremove(Shape item)
           Remove the shape from the collection.
voidremoveDependsOn(Shape item)
           Remove the shapes including DEPENDSON shapes from the collection.
voidunGroup(Shape groupShape)
           UnGroup the shape.
 

Property Getters/Setters Detail

getCount

→ inherited from Collection
public int getCount()
Gets the number of elements actually contained in the collection.

get

public Shape get(int index)
Gets the element at the specified index.
Parameters:
index -
Returns:

Method Detail

add

public int add(Shape item)
Add the shape in the collection.
Parameters:
item -
Returns:
ID

remove

public void remove(Shape item)
Remove the shape from the collection.
Parameters:
item - Shape

removeDependsOn

public void removeDependsOn(Shape item)
                    throws java.lang.Exception
Remove the shapes including DEPENDSON shapes from the collection.
Parameters:
item - Shape

unGroup

public void unGroup(Shape groupShape)
            throws java.lang.Exception
UnGroup the shape.
Parameters:
groupShape - the group shape.

group

public Shape group(com.aspose.diagram.Shape[] groupItems)
           throws java.lang.Exception
Group the shapes. The shape in the groupItems should not be grouped. The shape must be in this Shapes collection.
Parameters:
groupItems - the group items.
Returns:
Return the group shape.

getShape

public Shape getShape(java.lang.String name)
Gets the element at the specified name.
Parameters:
name -
Returns:

getShapeIncludingChild

public Shape getShapeIncludingChild(java.lang.String name)
Gets the element including it's child shape at the specified name.
Parameters:
name -
Returns:

getShapeIncludingChild

public Shape getShapeIncludingChild(int id)
Gets the element including it's child shape at the specified id.
Parameters:
name -
Returns:

getShape

public Shape getShape(long ID)
Gets the element at the specified ID.
Parameters:
ID -
Returns:

iterator

→ inherited from Collection
public java.util.Iterator iterator()
Supports a simple iteration over a nongeneric collection.
Returns:

isExist

→ inherited from Collection
public boolean isExist(int index)
Is exist item in the collection.
Parameters:
index - index of element.
Returns:

clear

→ inherited from Collection
public void clear()
Removes all elements from collection.

See Also:
          Aspose.Diagram Documentation - the home page for the Aspose.Diagram Product Documentation.
          Aspose.Diagram Support Forum - our preferred method of support.