Class XSSFGraphicFrame

java.lang.Object
org.apache.poi.xssf.usermodel.XSSFShape
org.apache.poi.xssf.usermodel.XSSFGraphicFrame
All Implemented Interfaces:
Shape

public final class XSSFGraphicFrame extends XSSFShape
Represents DrawingML GraphicalObjectFrame.
Author:
Roman Kashitsyn
  • Constructor Details

    • XSSFGraphicFrame

      protected XSSFGraphicFrame(XSSFDrawing drawing, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrame ctGraphicFrame)
      Construct a new XSSFGraphicFrame object.
      Parameters:
      drawing - the XSSFDrawing that owns this frame
      ctGraphicFrame - the XML bean that stores this frame content
  • Method Details

    • getCTGraphicalObjectFrame

      @Internal public org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrame getCTGraphicalObjectFrame()
    • prototype

      protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrame prototype()
      Initialize default structure of a new graphic frame
    • setMacro

      public void setMacro(String macro)
      Sets the frame macro.
    • setName

      public void setName(String name)
      Sets the frame name.
    • getName

      public String getName()
      Returns the frame name.
      Returns:
      name of the frame
    • setAnchor

      protected void setAnchor(XSSFClientAnchor anchor)
      Attaches frame to an anchor.
    • getAnchor

      public XSSFClientAnchor getAnchor()
      Returns the frame anchor.
      Specified by:
      getAnchor in interface Shape
      Overrides:
      getAnchor in class XSSFShape
      Returns:
      the XSSFClientAnchor anchor this frame is attached to
    • setChart

      protected void setChart(XSSFChart chart, String relId)
      Assign a DrawingML chart to the graphic frame.
    • getId

      public long getId()
      Gets the frame id.
    • setId

      protected void setId(long id)
      Sets the frame id.
    • getShapeProperties

      protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getShapeProperties()
      Description copied from class: XSSFShape
      Returns xml bean with shape properties.
      Specified by:
      getShapeProperties in class XSSFShape
      Returns:
      xml bean with shape properties.
    • getShapeName

      public String getShapeName()
      Returns:
      the name of this shape