|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.POIXMLDocumentPart org.apache.poi.xslf.usermodel.XSLFSheet
@Beta public abstract class XSLFSheet
Field Summary |
---|
Fields inherited from class org.apache.poi.POIXMLDocumentPart |
---|
DEFAULT_XML_OPTIONS |
Constructor Summary | |
---|---|
XSLFSheet()
|
|
XSLFSheet(PackagePart part,
PackageRelationship rel)
|
Method Summary | |
---|---|
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)
|
Methods inherited from class org.apache.poi.POIXMLDocumentPart |
---|
addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XSLFSheet()
public XSLFSheet(PackagePart part, PackageRelationship rel)
Method Detail |
---|
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()
XSLFShapeContainer
createAutoShape
in interface XSLFShapeContainer
public XSLFFreeformShape createFreeform()
XSLFShapeContainer
createFreeform
in interface XSLFShapeContainer
public XSLFTextBox createTextBox()
XSLFShapeContainer
createTextBox
in interface XSLFShapeContainer
public XSLFConnectorShape createConnector()
XSLFShapeContainer
createConnector
in interface XSLFShapeContainer
public XSLFGroupShape createGroup()
XSLFShapeContainer
createGroup
in interface XSLFShapeContainer
public XSLFPictureShape createPicture(int pictureIndex)
XSLFShapeContainer
createPicture
in interface XSLFShapeContainer
public XSLFTable createTable()
public XSLFShape[] getShapes()
getShapes
in interface XSLFShapeContainer
public java.util.Iterator<XSLFShape> iterator()
iterator
in interface java.lang.Iterable<XSLFShape>
public boolean removeShape(XSLFShape xShape)
removeShape
in interface XSLFShapeContainer
xShape
- shape to be removed from this sheet, if present
java.lang.IllegalArgumentException
- if the type of the specified shape
is incompatible with this sheet (optional)public void clear()
clear
in interface XSLFShapeContainer
protected 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 POIXMLDocumentPart
java.io.IOException
public XSLFSheet importContent(XSLFSheet src)
src
- the source sheet to copy data from
public XSLFSheet appendContent(XSLFSheet src)
src
- the source sheet
this
.public abstract XSLFSheet getMasterSheet()
protected XSLFTextShape getTextShapeByType(Placeholder type)
public XSLFTextShape getPlaceholder(int idx)
idx
- 0-based index of a placeholder in the sheet
public 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 placeholders
public boolean getFollowMasterGraphics()
public XSLFBackground getBackground()
public void draw(java.awt.Graphics2D graphics)
graphics
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |