Class HSSFShapeGroup

java.lang.Object
loci.poi.hssf.usermodel.HSSFShape
loci.poi.hssf.usermodel.HSSFShapeGroup
All Implemented Interfaces:
HSSFShapeContainer

public class HSSFShapeGroup extends HSSFShape implements HSSFShapeContainer
A shape group may contain other shapes. It was no actual form on the sheet.
Author:
Glen Stampoultzis (glens at apache.org)
  • Constructor Details

  • Method Details

    • createGroup

      public HSSFShapeGroup createGroup(HSSFChildAnchor anchor)
      Create another group under this group.
      Parameters:
      anchor - the position of the new group.
      Returns:
      the group
    • createShape

      public HSSFSimpleShape createShape(HSSFChildAnchor anchor)
      Create a new simple shape under this group.
      Parameters:
      anchor - the position of the shape.
      Returns:
      the shape
    • createTextbox

      public HSSFTextbox createTextbox(HSSFChildAnchor anchor)
      Create a new textbox under this group.
      Parameters:
      anchor - the position of the shape.
      Returns:
      the textbox
    • createPolygon

      public HSSFPolygon createPolygon(HSSFChildAnchor anchor)
      Creates a polygon
      Parameters:
      anchor - the client anchor describes how this group is attached to the sheet.
      Returns:
      the newly created shape.
    • createPicture

      public HSSFPicture createPicture(HSSFChildAnchor anchor, int pictureIndex)
      Creates a picture.
      Parameters:
      anchor - the client anchor describes how this group is attached to the sheet.
      Returns:
      the newly created shape.
    • getChildren

      public List getChildren()
      Return all children contained by this shape.
      Specified by:
      getChildren in interface HSSFShapeContainer
      Returns:
      Any children contained by this shape.
    • setCoordinates

      public void setCoordinates(int x1, int y1, int x2, int y2)
      Sets the coordinate space of this group. All children are contrained to these coordinates.
    • getX1

      public int getX1()
      The top left x coordinate of this group.
    • getY1

      public int getY1()
      The top left y coordinate of this group.
    • getX2

      public int getX2()
      The bottom right x coordinate of this group.
    • getY2

      public int getY2()
      The bottom right y coordinate of this group.
    • countOfAllChildren

      public int countOfAllChildren()
      Count of all children and their childrens children.
      Overrides:
      countOfAllChildren in class HSSFShape