@Beta public abstract class XSLFSheet extends POIXMLDocumentPart implements XSLFShapeContainer
DEFAULT_XML_OPTIONS| Constructor and Description |
|---|
XSLFSheet() |
XSLFSheet(PackagePart part,
PackageRelationship rel) |
| Modifier and Type | Method and Description |
|---|---|
XSLFSheet |
appendContent(XSLFSheet src)
Append content to this sheet.
|
protected java.util.List<XSLFShape> |
buildShapes(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape spTree) |
protected boolean |
canDraw(XSLFShape shape)
Checks if this
sheet displays the specified shape. |
void |
clear()
Removes all of the elements from this container (optional operation).
|
protected void |
commit()
Save the content in the underlying package part.
|
XSLFAutoShape |
createAutoShape()
create a new shape with a predefined geometry and add it to this shape container
|
XSLFConnectorShape |
createConnector()
create a connector
|
XSLFFreeformShape |
createFreeform()
create a new shape with a custom geometry
|
XSLFGroupShape |
createGroup()
create a group of shapes belonging to this container
|
XSLFPictureShape |
createPicture(int pictureIndex)
create a picture belonging to this container
|
XSLFTable |
createTable() |
XSLFTextBox |
createTextBox()
create a text box
|
void |
draw(java.awt.Graphics2D graphics)
Render this sheet into the supplied graphics object
|
XSLFBackground |
getBackground() |
XSLFCommonSlideData |
getCommonSlideData() |
boolean |
getFollowMasterGraphics() |
abstract XSLFSheet |
getMasterSheet() |
XSLFTextShape |
getPlaceholder(int idx) |
XSLFTextShape[] |
getPlaceholders() |
protected abstract java.lang.String |
getRootElementName() |
XSLFShape[] |
getShapes()
Returns an array containing all of the shapes in this sheet
|
XMLSlideShow |
getSlideShow() |
protected org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape |
getSpTree() |
protected XSLFTextShape |
getTextShapeByType(Placeholder type) |
abstract org.apache.xmlbeans.XmlObject |
getXmlObject() |
XSLFSheet |
importContent(XSLFSheet src)
Set the contents of this sheet to be a copy of the source sheet.
|
java.util.Iterator<XSLFShape> |
iterator()
Returns an iterator over the shapes in this sheet
|
boolean |
removeShape(XSLFShape xShape)
Removes the specified shape from this sheet, if it is present
(optional operation).
|
protected void |
setCommonSlideData(org.openxmlformats.schemas.presentationml.x2006.main.CTCommonSlideData data) |
addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toStringpublic XSLFSheet()
public XSLFSheet(PackagePart part, PackageRelationship rel)
public XMLSlideShow getSlideShow()
protected java.util.List<XSLFShape> buildShapes(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape spTree)
public abstract org.apache.xmlbeans.XmlObject getXmlObject()
@Internal public XSLFCommonSlideData getCommonSlideData()
protected void setCommonSlideData(org.openxmlformats.schemas.presentationml.x2006.main.CTCommonSlideData data)
public XSLFAutoShape createAutoShape()
XSLFShapeContainercreateAutoShape in interface XSLFShapeContainerpublic XSLFFreeformShape createFreeform()
XSLFShapeContainercreateFreeform in interface XSLFShapeContainerpublic XSLFTextBox createTextBox()
XSLFShapeContainercreateTextBox in interface XSLFShapeContainerpublic XSLFConnectorShape createConnector()
XSLFShapeContainercreateConnector in interface XSLFShapeContainerpublic XSLFGroupShape createGroup()
XSLFShapeContainercreateGroup in interface XSLFShapeContainerpublic XSLFPictureShape createPicture(int pictureIndex)
XSLFShapeContainercreatePicture in interface XSLFShapeContainerpublic XSLFTable createTable()
public XSLFShape[] getShapes()
getShapes in interface XSLFShapeContainerpublic java.util.Iterator<XSLFShape> iterator()
iterator in interface java.lang.Iterable<XSLFShape>public boolean removeShape(XSLFShape xShape)
removeShape in interface XSLFShapeContainerxShape - shape to be removed from this sheet, if presentjava.lang.IllegalArgumentException - if the type of the specified shape
is incompatible with this sheet (optional)public void clear()
clear in interface XSLFShapeContainerprotected abstract java.lang.String getRootElementName()
protected org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape getSpTree()
protected final void commit()
throws java.io.IOException
POIXMLDocumentPart
protected void commit() throws IOException {
PackagePart part = getPackagePart();
OutputStream out = part.getOutputStream();
XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
bean.save(out, DEFAULT_XML_OPTIONS);
out.close();
}
commit in class POIXMLDocumentPartjava.io.IOExceptionpublic XSLFSheet importContent(XSLFSheet src)
src - the source sheet to copy data frompublic XSLFSheet appendContent(XSLFSheet src)
src - the source sheetthis.public abstract XSLFSheet getMasterSheet()
protected XSLFTextShape getTextShapeByType(Placeholder type)
public XSLFTextShape getPlaceholder(int idx)
idx - 0-based index of a placeholder in the sheetpublic XSLFTextShape[] getPlaceholders()
protected boolean canDraw(XSLFShape shape)
sheet displays the specified shape.
Subclasses can override it and skip certain shapes from drawings,
for instance, slide masters and layouts don't display placeholderspublic boolean getFollowMasterGraphics()
public XSLFBackground getBackground()
public void draw(java.awt.Graphics2D graphics)
graphics - Copyright 2014 The Apache Software Foundation or its licensors, as applicable.