Class HSSFShape

java.lang.Object
loci.poi.hssf.usermodel.HSSFShape
Direct Known Subclasses:
HSSFPolygon, HSSFShapeGroup, HSSFSimpleShape

public abstract class HSSFShape extends Object
An abstract shape.
Author:
Glen Stampoultzis (glens at apache.org)
  • Field Details

  • Method Details

    • getParent

      public HSSFShape getParent()
      Gets the parent shape.
    • getAnchor

      public HSSFAnchor getAnchor()
      Returns:
      the anchor that is used by this shape.
    • setAnchor

      public void setAnchor(HSSFAnchor anchor)
      Sets a particular anchor. A top-level shape must have an anchor of HSSFClientAnchor. A child anchor must have an anchor of HSSFChildAnchor
      Parameters:
      anchor - the anchor to use.
      Throws:
      IllegalArgumentException - when the wrong anchor is used for this particular shape.
      See Also:
    • getLineStyleColor

      public int getLineStyleColor()
      The color applied to the lines of this shape.
    • setLineStyleColor

      public void setLineStyleColor(int lineStyleColor)
      The color applied to the lines of this shape.
    • setLineStyleColor

      public void setLineStyleColor(int red, int green, int blue)
      The color applied to the lines of this shape.
    • getFillColor

      public int getFillColor()
      The color used to fill this shape.
    • setFillColor

      public void setFillColor(int fillColor)
      The color used to fill this shape.
    • setFillColor

      public void setFillColor(int red, int green, int blue)
      The color used to fill this shape.
    • getLineWidth

      public int getLineWidth()
      Returns:
      returns with width of the line in EMUs. 12700 = 1 pt.
    • setLineWidth

      public void setLineWidth(int lineWidth)
      Sets the width of the line. 12700 = 1 pt.
      Parameters:
      lineWidth - width in EMU's. 12700EMU's = 1 pt
      See Also:
    • getLineStyle

      public int getLineStyle()
      Returns:
      One of the constants in LINESTYLE_*
    • setLineStyle

      public void setLineStyle(int lineStyle)
      Sets the line style.
      Parameters:
      lineStyle - One of the constants in LINESTYLE_*
    • isNoFill

      public boolean isNoFill()
      Returns:
      true if this shape is not filled with a color.
    • setNoFill

      public void setNoFill(boolean noFill)
      Sets whether this shape is filled or transparent.
    • countOfAllChildren

      public int countOfAllChildren()
      Count of all children and their childrens children.