Class HSSFShapeGroup

java.lang.Object
org.apache.poi.hssf.usermodel.HSSFShape
org.apache.poi.hssf.usermodel.HSSFShapeGroup
All Implemented Interfaces:
Iterable<HSSFShape>, HSSFShapeContainer, Shape, ShapeContainer<HSSFShape>

public class HSSFShapeGroup extends HSSFShape implements HSSFShapeContainer
A shape group may contain other shapes. It was no actual form on the sheet.
  • Constructor Details

  • Method Details

    • createSpContainer

      protected EscherContainerRecord createSpContainer()
      Specified by:
      createSpContainer in class HSSFShape
    • createObjRecord

      protected ObjRecord createObjRecord()
      Specified by:
      createObjRecord in class HSSFShape
    • afterRemove

      protected void afterRemove(HSSFPatriarch patriarch)
      Description copied from class: HSSFShape
      remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes
      Specified by:
      afterRemove in class HSSFShape
    • createGroup

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

      public void addShape(HSSFShape shape)
      Description copied from interface: HSSFShapeContainer
      add shape to the list of child records
      Specified by:
      addShape in interface HSSFShapeContainer
    • 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<HSSFShape> 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 constrained to these coordinates.
      Specified by:
      setCoordinates in interface HSSFShapeContainer
    • clear

      public void clear()
      Specified by:
      clear in interface HSSFShapeContainer
    • getX1

      public int getX1()
      The top left x coordinate of this group.
      Specified by:
      getX1 in interface HSSFShapeContainer
      Returns:
      The top left x coordinate of this group.
    • getY1

      public int getY1()
      The top left y coordinate of this group.
      Specified by:
      getY1 in interface HSSFShapeContainer
      Returns:
      The top left y coordinate of this group.
    • getX2

      public int getX2()
      The bottom right x coordinate of this group.
      Specified by:
      getX2 in interface HSSFShapeContainer
      Returns:
      The bottom right x coordinate of this group.
    • getY2

      public int getY2()
      The bottom right y coordinate of this group.
      Specified by:
      getY2 in interface HSSFShapeContainer
      Returns:
      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
    • cloneShape

      protected HSSFShape cloneShape()
      Specified by:
      cloneShape in class HSSFShape
    • cloneShape

      protected HSSFShape cloneShape(HSSFPatriarch patriarch)
    • removeShape

      public boolean removeShape(HSSFShape shape)
      Description copied from interface: HSSFShapeContainer
      remove first level shapes
      Specified by:
      removeShape in interface HSSFShapeContainer
      Parameters:
      shape - to be removed
      Returns:
      true if shape is removed else return false
    • iterator

      public Iterator<HSSFShape> iterator()
      Specified by:
      iterator in interface Iterable<HSSFShape>