XSLFSheet (POI API Documentation)

java.lang.Object
- org.apache.poi.ooxml.POIXMLDocumentPart
- - org.apache.poi.xslf.usermodel.XSLFSheet

All Implemented Interfaces:

java.lang.Iterable<XSLFShape>, ShapeContainer<XSLFShape,XSLFTextParagraph>, Sheet<XSLFShape,XSLFTextParagraph>, XSLFShapeContainer

Direct Known Subclasses:

XSLFNotes, XSLFNotesMaster, XSLFSlide, XSLFSlideLayout, XSLFSlideMaster
```
@Beta
public abstract class XSLFSheet
extends POIXMLDocumentPart
implements XSLFShapeContainer, Sheet<XSLFShape,XSLFTextParagraph>
```

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
  POIXMLDocumentPart.RelationPart

Constructor Summary

Constructors
Modifier Constructor and Description

protected XSLFSheet()

protected XSLFSheet(PackagePart part)

Constructors
Modifier	Constructor and Description
`protected`	`XSLFSheet()`
`protected`	`XSLFSheet(PackagePart part)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChart(XSLFChart chart)` this method will add chart into slide with default height, width, x and y
`void`	`addChart(XSLFChart chart, java.awt.geom.Rectangle2D rect2D)` this method will add chart into slide with given height, width, x and y
`void`	`addShape(XSLFShape shape)`
`protected int`	`allocateShapeId()`
`XSLFSheet`	`appendContent(XSLFSheet src)` Append content to this sheet.
`protected static java.util.List<XSLFShape>`	`buildShapes(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape spTree, XSLFShapeContainer parent)`
`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
`XSLFObjectShape`	`createOleShape(PictureData pictureData)` Create a new OLE object shape with the given pictureData as preview image
`XSLFPictureShape`	`createPicture(PictureData pictureData)` create a picture belonging to this container
`XSLFTable`	`createTable()`
`XSLFTable`	`createTable(int numRows, int numCols)` Create a new Table of the given number of rows and columns
`XSLFTextBox`	`createTextBox()` create a text box
`protected void`	`deregisterShapeId(int shapeId)`
`void`	`draw(java.awt.Graphics2D graphics)` Render this sheet into the supplied graphics object
`XSLFBackground`	`getBackground()`
`boolean`	`getFollowMasterGraphics()`
`XSLFSimpleShape`	`getPlaceholder(org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder ph)`
`XSLFTextShape`	`getPlaceholder(int idx)`
`XSLFSimpleShape`	`getPlaceholder(Placeholder ph)`
`XSLFPlaceholderDetails`	`getPlaceholderDetails(Placeholder placeholder)` Get the placeholder details for the given placeholder type.
`XSLFTextShape[]`	`getPlaceholders()`
`protected abstract java.lang.String`	`getRootElementName()`
`java.util.List<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)`
`XSLFTheme`	`getTheme()`
`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
`protected java.lang.String`	`mapSchemeColor(org.openxmlformats.schemas.drawingml.x2006.main.CTColorMappingOverride cmapOver, java.lang.String schemeColor)`
`protected java.lang.String`	`mapSchemeColor(org.openxmlformats.schemas.drawingml.x2006.main.CTColorMapping cmap, java.lang.String schemeColor)`
`protected void`	`registerShapeId(int shapeId)`
`boolean`	`removeShape(XSLFShape xShape)` Removes the specified shape from this sheet, if it is present (optional operation).

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.sl.usermodel.Sheet
getMasterSheet

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - XSLFSheet
```
protected XSLFSheet()
```
  - XSLFSheet
```
protected XSLFSheet(PackagePart part)
```
    Since:
    
    POI 3.14-Beta1
- Method Detail
  - getSlideShow
```
public XMLSlideShow getSlideShow()
```
    Specified by:
    
    getSlideShow in interface Sheet<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    the XMLSlideShow this sheet belongs to
  - allocateShapeId
```
protected int allocateShapeId()
```
  - registerShapeId
```
protected void registerShapeId(int shapeId)
```
  - deregisterShapeId
```
protected void deregisterShapeId(int shapeId)
```
  - buildShapes
```
protected static java.util.List<XSLFShape> buildShapes(org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape spTree,
                                                       XSLFShapeContainer parent)
```
  - getXmlObject
```
public abstract org.apache.xmlbeans.XmlObject getXmlObject()
```
    Returns:
    
    top-level Xml bean representing this sheet
  - getShapes
```
public java.util.List<XSLFShape> getShapes()
```
    Returns an array containing all of the shapes in this sheet
    
    Specified by:
    
    getShapes in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    an array of all shapes in this sheet
  - createAutoShape
```
public XSLFAutoShape createAutoShape()
```
    Description copied from interface: ShapeContainer
    
    create a new shape with a predefined geometry and add it to this shape container
    
    Specified by:
    
    createAutoShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Specified by:
    
    createAutoShape in interface XSLFShapeContainer
  - createFreeform
```
public XSLFFreeformShape createFreeform()
```
    Description copied from interface: ShapeContainer
    
    create a new shape with a custom geometry
    
    Specified by:
    
    createFreeform in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Specified by:
    
    createFreeform in interface XSLFShapeContainer
  - createTextBox
```
public XSLFTextBox createTextBox()
```
    Description copied from interface: ShapeContainer
    
    create a text box
    
    Specified by:
    
    createTextBox in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Specified by:
    
    createTextBox in interface XSLFShapeContainer
  - createConnector
```
public XSLFConnectorShape createConnector()
```
    Description copied from interface: ShapeContainer
    
    create a connector
    
    Specified by:
    
    createConnector in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Specified by:
    
    createConnector in interface XSLFShapeContainer
  - createGroup
```
public XSLFGroupShape createGroup()
```
    Description copied from interface: ShapeContainer
    
    create a group of shapes belonging to this container
    
    Specified by:
    
    createGroup in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Specified by:
    
    createGroup in interface XSLFShapeContainer
  - createPicture
```
public XSLFPictureShape createPicture(PictureData pictureData)
```
    Description copied from interface: ShapeContainer
    
    create a picture belonging to this container
    
    Specified by:
    
    createPicture in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Specified by:
    
    createPicture in interface XSLFShapeContainer
  - createTable
```
public XSLFTable createTable()
```
  - createTable
```
public XSLFTable createTable(int numRows,
                             int numCols)
```
    Description copied from interface: ShapeContainer
    
    Create a new Table of the given number of rows and columns
    
    Specified by:
    
    createTable in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    numRows - the number of rows
    
    numCols - the number of columns
  - createOleShape
```
public XSLFObjectShape createOleShape(PictureData pictureData)
```
    Description copied from interface: ShapeContainer
    
    Create a new OLE object shape with the given pictureData as preview image
    
    Specified by:
    
    createOleShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    pictureData - the preview image
  - iterator
```
public java.util.Iterator<XSLFShape> iterator()
```
    Returns an iterator over the shapes in this sheet
    
    Specified by:
    
    iterator in interface java.lang.Iterable<XSLFShape>
    
    Returns:
    
    an iterator over the shapes in this sheet
  - addShape
```
public void addShape(XSLFShape shape)
```
    Specified by:
    
    addShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
  - removeShape
```
public boolean removeShape(XSLFShape xShape)
```
    Removes the specified shape from this sheet, if it is present (optional operation). If this sheet does not contain the element, it is unchanged.
    
    Specified by:
    
    removeShape in interface ShapeContainer<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    xShape - shape to be removed from this sheet, if present
    
    Returns:
    
    true if this sheet contained the specified element
    
    Throws:
    
    java.lang.IllegalArgumentException - if the type of the specified shape is incompatible with this sheet (optional)
  - clear
```
public void clear()
```
    Removes all of the elements from this container (optional operation). The container will be empty after this call returns.
    
    Specified by:
    
    clear in interface XSLFShapeContainer
  - getRootElementName
```
protected abstract java.lang.String getRootElementName()
```
  - getSpTree
```
protected org.openxmlformats.schemas.presentationml.x2006.main.CTGroupShape getSpTree()
```
  - commit
```
protected final void commit()
                     throws java.io.IOException
```
    Description copied from class: POIXMLDocumentPart
    Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified.
    Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
    For example, the code saving a generic XML entry may look as follows:
```
 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();
 }
 
```
    Overrides:
    
    commit in class POIXMLDocumentPart
    
    Throws:
    
    java.io.IOException - a subclass may throw an IOException if the changes can't be committed
  - importContent
```
public XSLFSheet importContent(XSLFSheet src)
```
    Set the contents of this sheet to be a copy of the source sheet. This method erases any existing shapes and replaces them with object from the source sheet.
    
    Parameters:
    
    src - the source sheet to copy data from
    
    Returns:
    
    modified 'this'
  - appendContent
```
public XSLFSheet appendContent(XSLFSheet src)
```
    Append content to this sheet.
    
    Parameters:
    
    src - the source sheet
    
    Returns:
    
    modified this.
  - getTheme
```
public XSLFTheme getTheme()
```
    Returns:
    
    theme (shared styles) associated with this theme. By default returns null which means that this sheet is theme-less. Sheets that support the notion of themes (slides, masters, layouts, etc.) should override this method and return the corresponding package part.
  - getTextShapeByType
```
protected XSLFTextShape getTextShapeByType(Placeholder type)
```
  - getPlaceholder
```
public XSLFSimpleShape getPlaceholder(Placeholder ph)
```
  - getPlaceholder
```
@Internal
public XSLFSimpleShape getPlaceholder(org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder ph)
```
  - getPlaceholder
```
public XSLFTextShape getPlaceholder(int idx)
```
    Parameters:
    
    idx - 0-based index of a placeholder in the sheet
    
    Returns:
    
    placeholder
  - getPlaceholders
```
public XSLFTextShape[] getPlaceholders()
```
    Returns:
    
    all placeholder shapes in this sheet
  - getFollowMasterGraphics
```
public boolean getFollowMasterGraphics()
```
    Specified by:
    
    getFollowMasterGraphics in interface Sheet<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    whether shapes on the master sheet should be shown. By default master graphics is turned off. Sheets that support the notion of master (slide, slideLayout) should override it and check this setting in the sheet XML
  - getBackground
```
public XSLFBackground getBackground()
```
    Specified by:
    
    getBackground in interface Sheet<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    background for this sheet
  - draw
```
public void draw(java.awt.Graphics2D graphics)
```
    Render this sheet into the supplied graphics object
    
    Specified by:
    
    draw in interface Sheet<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    graphics - the graphics context to draw to
  - getPlaceholderDetails
```
public XSLFPlaceholderDetails getPlaceholderDetails(Placeholder placeholder)
```
    Description copied from interface: Sheet
    
    Get the placeholder details for the given placeholder type. Not all placeholders are also shapes - this is especially true for old HSLF slideshows, which notes have header/footers elements which aren't shapes.
    
    Specified by:
    
    getPlaceholderDetails in interface Sheet<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    placeholder - the placeholder type
    
    Returns:
    
    the placeholder details or null, if the placeholder isn't contained in the sheet
  - addChart
```
public void addChart(XSLFChart chart)
```
    this method will add chart into slide with default height, width, x and y
    
    Parameters:
    
    chart - xslf chart object
    
    Since:
    
    POI 4.1.0
  - addChart
```
public void addChart(XSLFChart chart,
                     java.awt.geom.Rectangle2D rect2D)
```
    this method will add chart into slide with given height, width, x and y
    
    Parameters:
    
    chart - xslf chart object
    
    Since:
    
    POI 4.1.0
  - mapSchemeColor
```
protected java.lang.String mapSchemeColor(org.openxmlformats.schemas.drawingml.x2006.main.CTColorMappingOverride cmapOver,
                                          java.lang.String schemeColor)
```
  - mapSchemeColor
```
protected java.lang.String mapSchemeColor(org.openxmlformats.schemas.drawingml.x2006.main.CTColorMapping cmap,
                                          java.lang.String schemeColor)
```

Class XSLFSheet

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.poi.sl.usermodel.Sheet

Methods inherited from interface java.lang.Iterable

Constructor Detail

XSLFSheet

XSLFSheet

Method Detail

getSlideShow

allocateShapeId

registerShapeId

deregisterShapeId

buildShapes

getXmlObject

getShapes

createAutoShape

createFreeform

createTextBox

createConnector

createGroup

createPicture

createTable

createTable

createOleShape

iterator

addShape

removeShape

clear

getRootElementName

getSpTree

commit

importContent

appendContent

getTheme

getTextShapeByType

getPlaceholder

getPlaceholder

getPlaceholder

getPlaceholders

getFollowMasterGraphics

getBackground

draw

getPlaceholderDetails

addChart

addChart

mapSchemeColor

mapSchemeColor