Top Description Methods
org.apache.poi.hssf.usermodel

public Interface HSSFShapeContainer

extends ShapeContainer<HSSFShape>
Known Direct Implementers
org.apache.poi.hssf.usermodel.HSSFShapeGroup, org.apache.poi.hssf.usermodel.HSSFPatriarch
Imports
java.util.List, org.apache.poi.ss.usermodel.ShapeContainer
An interface that indicates whether a class can contain children.

Method Summary

Modifier and TypeMethod and Description
public void
addShape(HSSFShape shape)

add shape to the list of child records

public void
clear()

public List<HSSFShape>

Returns:

Any children contained by this shape.
getChildren()

public int

Returns:

The top left x coordinate of this group.
getX1()

public int

Returns:

The bottom right x coordinate of this group.
getX2()

public int

Returns:

The top left y coordinate of this group.
getY1()

public int

Returns:

The bottom right y coordinate of this group.
getY2()

public boolean

Returns:

true if shape is removed else return false
removeShape(HSSFShape
to be removed
shape)

remove first level shapes

public void
setCoordinates(int x1, int y1, int x2, int y2)

set coordinates of this group relative to the parent

Method Detail

addShapeback to summary
public void addShape(HSSFShape shape)

add shape to the list of child records

clearback to summary
public void clear()
getChildrenback to summary
public List<HSSFShape> getChildren()
Returns:List<HSSFShape>

Any children contained by this shape.

getX1back to summary
public int getX1()
Returns:int

The top left x coordinate of this group.

getX2back to summary
public int getX2()
Returns:int

The bottom right x coordinate of this group.

getY1back to summary
public int getY1()
Returns:int

The top left y coordinate of this group.

getY2back to summary
public int getY2()
Returns:int

The bottom right y coordinate of this group.

removeShapeback to summary
public boolean removeShape(HSSFShape shape)

remove first level shapes

Parameters
shape:HSSFShape

to be removed

Returns:boolean

true if shape is removed else return false

setCoordinatesback to summary
public void setCoordinates(int x1, int y1, int x2, int y2)

set coordinates of this group relative to the parent