org.apache.poi.hslf.usermodel

Class HSLFTable

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFShape

org.apache.poi.hslf.usermodel.HSLFGroupShape

org.apache.poi.hslf.usermodel.HSLFTable

All Implemented Interfaces:

java.lang.Iterable<HSLFShape>, HSLFShapeContainer, GroupShape<HSLFShape,HSLFTextParagraph>, PlaceableShape<HSLFShape,HSLFTextParagraph>, Shape<HSLFShape,HSLFTextParagraph>, ShapeContainer<HSLFShape,HSLFTextParagraph>, TableShape<HSLFShape,HSLFTextParagraph>

public final class HSLFTable
extends HSLFGroupShape
implements HSLFShapeContainer, TableShape<HSLFShape,HSLFTextParagraph>

Represents a table in a PowerPoint presentation

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BORDER_BOTTOM
protected static int	BORDER_LEFT
protected static int	BORDER_RIGHT
protected static int	BORDER_TOP
protected static int	BORDERS_ALL
protected static int	BORDERS_INSIDE
protected static int	BORDERS_NONE
protected static int	BORDERS_OUTSIDE
protected HSLFTableCell[][]	cells

Fields inherited from class org.apache.poi.hslf.usermodel.HSLFShape

_escherContainer, _fill, _parent, _sheet, logger

Constructor Summary

Constructors

Constructor and Description
HSLFTable(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent) Create a Table object and initilize it from the supplied Record container.
HSLFTable(int numRows, int numCols) Create a new Table of the given number of rows and columns
HSLFTable(int numRows, int numCols, ShapeContainer<HSLFShape,HSLFTextParagraph> parent) Create a new Table of the given number of rows and columns

Method Summary

Modifier and Type	Method and Description
protected void	afterInsert(HSLFSheet sh) Event which fires when a shape is inserted in the sheet.
HSLFLine	createBorder() Create a border to format this table
HSLFTableCell	getCell(int row, int col) Gets a cell
int	getNumberOfColumns()
int	getNumberOfRows()
protected void	initTable()
void	setAllBorders(HSLFLine line) Format the table and apply the specified Line to all cell boundaries, both outside and inside
void	setColumnWidth(int col, int width) Sets the column width.
void	setInsideBorders(HSLFLine line) Format the inside border using the specified Line object
void	setOutsideBorders(HSLFLine line) Format the outside border using the specified Line object
void	setRowHeight(int row, int height) Sets the row height.
void	setSheet(HSLFSheet sheet) Assign the SlideShow this shape belongs to

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFGroupShape

addShape, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createSpContainer, createTable, createTextBox, getAnchor, getEscherChild, getHyperlink, getInteriorAnchor, getShapes, getShapeType, iterator, moveTo, removeShape, setAnchor, setInteriorAnchor

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFShape

draw, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFillStyle, getFlipHorizontal, getFlipVertical, getParent, getRotation, getShapeId, getShapeName, getSheet, getSpContainer, isPlaceholder, moveTo, setEscherProperty, setEscherProperty, setFlipHorizontal, setFlipVertical, setRotation, setShapeId, setShapeType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.hslf.usermodel.HSLFShapeContainer

createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTextBox

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

addShape, createTable, getShapes, removeShape

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

getAnchor, getParent, getSheet

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

getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

Field Detail

BORDER_TOP

protected static final int BORDER_TOP

See Also:

Constant Field Values

BORDER_RIGHT

protected static final int BORDER_RIGHT

See Also:

Constant Field Values

BORDER_BOTTOM

protected static final int BORDER_BOTTOM

See Also:

Constant Field Values

BORDER_LEFT

protected static final int BORDER_LEFT

See Also:

Constant Field Values

BORDERS_ALL

protected static final int BORDERS_ALL

See Also:

Constant Field Values

BORDERS_OUTSIDE

protected static final int BORDERS_OUTSIDE

See Also:

Constant Field Values

BORDERS_INSIDE

protected static final int BORDERS_INSIDE

See Also:

Constant Field Values

BORDERS_NONE

protected static final int BORDERS_NONE

See Also:

Constant Field Values

cells

protected HSLFTableCell[][] cells

Constructor Detail

HSLFTable

public HSLFTable(int numRows,
                 int numCols)

Create a new Table of the given number of rows and columns

Parameters:

numRows - the number of rows

numCols - the number of columns

HSLFTable

public HSLFTable(int numRows,
                 int numCols,
                 ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a new Table of the given number of rows and columns

Parameters:

numRows - the number of rows

numCols - the number of columns

parent - the parent shape, or null if table is added to sheet

HSLFTable

public HSLFTable(EscherContainerRecord escherRecord,
                 ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a Table object and initilize it from the supplied Record container.

Parameters:

escherRecord - EscherSpContainer container which holds information about this shape

parent - the parent of the shape

Method Detail

getCell

public HSLFTableCell getCell(int row,
                             int col)

Gets a cell

Parameters:

row - the row index (0-based)

col - the column index (0-based)

Returns:

the cell

getNumberOfColumns

public int getNumberOfColumns()

getNumberOfRows

public int getNumberOfRows()

afterInsert

protected void afterInsert(HSLFSheet sh)

Description copied from class: HSLFShape

Event which fires when a shape is inserted in the sheet. In some cases we need to propagate changes to upper level containers.
Default implementation does nothing.

Overrides:

afterInsert in class HSLFShape

Parameters:

sh - - owning shape

initTable

protected void initTable()

setSheet

public void setSheet(HSLFSheet sheet)

Assign the SlideShow this shape belongs to

Overrides:

setSheet in class HSLFShape

Parameters:

sheet - owner of this shape

setRowHeight

public void setRowHeight(int row,
                         int height)

Sets the row height.

Parameters:

row - the row index (0-based)

height - the height to set (in pixels)

setColumnWidth

public void setColumnWidth(int col,
                           int width)

Sets the column width.

Parameters:

col - the column index (0-based)

width - the width to set (in pixels)

setAllBorders

public void setAllBorders(HSLFLine line)

Format the table and apply the specified Line to all cell boundaries, both outside and inside

Parameters:

line - the border line

setOutsideBorders

public void setOutsideBorders(HSLFLine line)

Format the outside border using the specified Line object

Parameters:

line - the border line

setInsideBorders

public void setInsideBorders(HSLFLine line)

Format the inside border using the specified Line object

Parameters:

line - the border line

createBorder

public HSLFLine createBorder()

Create a border to format this table

Returns:

the created border