Package org.apache.poi.xslf.usermodel
Class XSLFTable
java.lang.Object
org.apache.poi.xslf.usermodel.XSLFShape
org.apache.poi.xslf.usermodel.XSLFGraphicFrame
org.apache.poi.xslf.usermodel.XSLFTable
- All Implemented Interfaces:
Iterable<XSLFTableRow>,GraphicalFrame<XSLFShape,,XSLFTextParagraph> PlaceableShape<XSLFShape,,XSLFTextParagraph> Shape<XSLFShape,,XSLFTextParagraph> TableShape<XSLFShape,XSLFTextParagraph>
public class XSLFTable
extends XSLFGraphicFrame
implements Iterable<XSLFTableRow>, TableShape<XSLFShape,XSLFTextParagraph>
Represents a table in a .pptx presentation
-
Method Summary
Modifier and TypeMethodDescriptionaddRow()getCell(int row, int col) Gets a celldoublegetColumnWidth(int idx) Gets the width (in points) of the n-th columnorg.openxmlformats.schemas.drawingml.x2006.main.CTTableintReturn the maximum number of columns.intReturn the number of rowsdoublegetRowHeight(int row) Gets the row heightgetRows()protected XSLFTableStyleGet assigned TableStyleiterator()voidmergeCells(int firstRow, int lastRow, int firstCol, int lastCol) Merge cells of a tablevoidsetColumnWidth(int idx, double width) Sets the width (in points) of the n-th columnvoidsetRowHeight(int row, double height) Sets the row height.Methods inherited from class org.apache.poi.xslf.usermodel.XSLFGraphicFrame
getAnchor, getFallbackPicture, getFlipHorizontal, getFlipVertical, getRotation, getShapeType, setAnchor, setFlipHorizontal, setFlipVertical, setRotationMethods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
draw, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getFillPaint, getGrpSpPr, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getShapeProperties, getSheet, getSpStyle, getXmlObject, isPlaceholder, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent, setPlaceholderMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotationMethods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getAnchor, getParent, getShapeId, getShapeName, getSheet
-
Method Details
-
getCell
Description copied from interface:TableShapeGets a cell- Specified by:
getCellin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Parameters:
row- the row index (0-based)col- the column index (0-based)- Returns:
- the cell or null if the cell doesn't exists, e.g. when accessing a merged cell or if the index is out of bounds
-
getCTTable
-
getNumberOfColumns
public int getNumberOfColumns()Description copied from interface:TableShapeReturn the maximum number of columns. If the table contains merged cells, the number of columns might be less than the maximum.- Specified by:
getNumberOfColumnsin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Returns:
- the maximum number of column
-
getNumberOfRows
public int getNumberOfRows()Description copied from interface:TableShapeReturn the number of rows- Specified by:
getNumberOfRowsin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Returns:
- the row count
-
getColumnWidth
public double getColumnWidth(int idx) Description copied from interface:TableShapeGets the width (in points) of the n-th column- Specified by:
getColumnWidthin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Parameters:
idx- the column index (0-based)- Returns:
- the width (in points)
-
setColumnWidth
public void setColumnWidth(int idx, double width) Description copied from interface:TableShapeSets the width (in points) of the n-th column- Specified by:
setColumnWidthin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Parameters:
idx- the column index (0-based)width- the width (in points)
-
getRowHeight
public double getRowHeight(int row) Description copied from interface:TableShapeGets the row height- Specified by:
getRowHeightin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Parameters:
row- the row index (0-based)- Returns:
- the height (in points)
-
setRowHeight
public void setRowHeight(int row, double height) Description copied from interface:TableShapeSets the row height.- Specified by:
setRowHeightin interfaceTableShape<XSLFShape,XSLFTextParagraph> - Parameters:
row- the row index (0-based)height- the height to set (in points)
-
iterator
- Specified by:
iteratorin interfaceIterable<XSLFTableRow>
-
getRows
-
addRow
-
mergeCells
public void mergeCells(int firstRow, int lastRow, int firstCol, int lastCol) Merge cells of a table -
getTableStyle
Get assigned TableStyle- Returns:
- the assigned TableStyle
- Since:
- POI 3.15-beta2
-