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
ConstructorsModifierConstructorDescriptionprotectedXSSFGraphicFrame(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.CTGraphicalObjectFramelonggetId()Gets the frame id.getName()Returns the frame name.protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapePropertiesReturns xml bean with shape properties.protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTGraphicalObjectFrameInitialize default structure of a new graphic frameprotected voidsetAnchor(XSSFClientAnchor anchor) Attaches frame to an anchor.protected voidAssign a DrawingML chart to the graphic frame.protected voidsetId(long id) Sets the frame id.voidSets the frame macro.voidSets 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:XSSFShapeReturns xml bean with shape properties.- Specified by:
getShapePropertiesin classXSSFShape- Returns:
- xml bean with shape properties.
-
getShapeName
- Returns:
- the name of this shape
-