Package org.apache.poi.xssf.usermodel
Class XSSFGraphicFrame
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFShape
org.apache.poi.xssf.usermodel.XSSFGraphicFrame
- All Implemented Interfaces:
Shape
Represents DrawingML GraphicalObjectFrame.
- Author:
- Roman Kashitsyn
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
XSSFGraphicFrame
(XSSFDrawing drawing, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrame ctGraphicFrame) Construct a new XSSFGraphicFrame object. -
Method Summary
Modifier and TypeMethodDescriptionReturns the frame anchor.org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrame
long
getId()
Gets the frame id.getName()
Returns the frame name.protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties
Returns xml bean with shape properties.protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrame
Initialize default structure of a new graphic frameprotected void
setAnchor
(XSSFClientAnchor anchor) Attaches frame to an anchor.protected void
Assign a DrawingML chart to the graphic frame.protected void
setId
(long id) Sets the frame id.void
Sets the frame macro.void
Sets the frame name.Methods inherited from class org.apache.poi.xssf.usermodel.XSSFShape
getDrawing, getParent, isNoFill, setFillColor, setLineStyle, setLineStyleColor, setLineWidth, setNoFill
-
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 framectGraphicFrame
- 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
Sets the frame macro. -
setName
Sets the frame name. -
getName
Returns the frame name.- Returns:
- name of the frame
-
setAnchor
Attaches frame to an anchor. -
getAnchor
Returns the frame anchor. -
setChart
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 classXSSFShape
- Returns:
- xml bean with shape properties.
-
getShapeName
- Returns:
- the name of this shape
-