org.apache.poi.xwpf.usermodel

Class XWPFTableRow

java.lang.Object

org.apache.poi.xwpf.usermodel.XWPFTableRow

public class XWPFTableRow
extends Object

A row within an XWPFTable. Rows mostly just have sizings and stylings, the interesting content lives inside the child XWPFTableCells

Constructor Summary

Constructors

Constructor and Description
XWPFTableRow(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow row, XWPFTable table)

Method Summary

Modifier and Type	Method and Description
XWPFTableCell	addNewTableCell() adds a new TableCell at the end of this tableRow
XWPFTableCell	createCell() create a new XWPFTableCell and add it to the tableCell-list of this tableRow
XWPFTableCell	getCell(int pos)
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow	getCtRow()
int	getHeight() This element specifies the height of the current table row within the current table.
TableRowHeightRule	getHeightRule() Returns the meaning of the height specified for this table row.
XWPFTable	getTable()
XWPFTableCell	getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell) returns the XWPFTableCell which belongs to the CTTC cell if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned
List<XWPFTableCell>	getTableCells() create and return a list of all XWPFTableCell who belongs to this row
List<ICell>	getTableICells() create and return a list of all XWPFTableCell who belongs to this row
boolean	isCantSplitRow() Return true if the "can't split row" value is true.
boolean	isRepeatHeader() Return true if a table's header row should be repeated at the top of a table split across pages.
void	removeCell(int pos)
void	setCantSplitRow(boolean split) Controls whether to allow this table row to split across pages.
void	setHeight(int height) This element specifies the height of the current table row within the current table.
void	setHeightRule(TableRowHeightRule heightRule) Specifies the height rule for this table row.
void	setRepeatHeader(boolean repeat) This attribute controls whether to repeat a table's header row at the top of a table split across pages.

Methods inherited from class java.lang.Object

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

Constructor Detail

XWPFTableRow

public XWPFTableRow(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow row,
                    XWPFTable table)

Method Detail

getCtRow

@Internal
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRow getCtRow()

createCell

public XWPFTableCell createCell()

create a new XWPFTableCell and add it to the tableCell-list of this tableRow

Returns:

the newly created XWPFTableCell

getCell

public XWPFTableCell getCell(int pos)

removeCell

public void removeCell(int pos)

addNewTableCell

public XWPFTableCell addNewTableCell()

adds a new TableCell at the end of this tableRow

getHeight

public int getHeight()

This element specifies the height of the current table row within the current table. This height shall be used to determine the resulting height of the table row, which may be absolute or relative (depending on its attribute values). If omitted, then the table row shall automatically resize its height to the height required by its contents (the equivalent of an hRule value of auto).

Returns:

height

setHeight

public void setHeight(int height)

This element specifies the height of the current table row within the current table. This height shall be used to determine the resulting height of the table row, which may be absolute or relative (depending on its attribute values). If omitted, then the table row shall automatically resize its height to the height required by its contents (the equivalent of an hRule value of auto).

getHeightRule

public TableRowHeightRule getHeightRule()

Returns the meaning of the height specified for this table row.

If hRule is omitted, then its value shall be assumed to be auto.

Returns:

the height rule of this row.

setHeightRule

public void setHeightRule(TableRowHeightRule heightRule)

Specifies the height rule for this table row.

If the value of hRule is auto, then the table row's height should be automatically determined based on the height of its contents. The h value is ignored. If the value of hRule is atLeast, then the table row's height should be at least the value the h attribute. If the value of hRule is exact, then the table row's height should be exactly the value of the h attribute.

Parameters:

heightRule - the height rule to apply to this row.

getTable

public XWPFTable getTable()

getTableICells

public List<ICell> getTableICells()

create and return a list of all XWPFTableCell who belongs to this row

Returns:

a list of XWPFTableCell

getTableCells

public List<XWPFTableCell> getTableCells()

create and return a list of all XWPFTableCell who belongs to this row

Returns:

a list of XWPFTableCell

getTableCell

public XWPFTableCell getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell)

returns the XWPFTableCell which belongs to the CTTC cell if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned

isCantSplitRow

public boolean isCantSplitRow()

Return true if the "can't split row" value is true. The logic for this attribute is a little unusual: a TRUE value means DON'T allow rows to split, FALSE means allow rows to split.

Returns:

true if rows can't be split, false otherwise.

setCantSplitRow

public void setCantSplitRow(boolean split)

Controls whether to allow this table row to split across pages. The logic for this attribute is a little unusual: a true value means DON'T allow rows to split, false means allow rows to split.

Parameters:

split - - if true, don't allow row to be split. If false, allow row to be split.

isRepeatHeader

public boolean isRepeatHeader()

Return true if a table's header row should be repeated at the top of a table split across pages. NOTE - Word will not repeat a table row unless all preceding rows of the table are also repeated. This function returns false if the row will not be repeated even if the repeat tag is present for this row.

Returns:

true if table's header row should be repeated at the top of each page of table, false otherwise.

setRepeatHeader

public void setRepeatHeader(boolean repeat)

This attribute controls whether to repeat a table's header row at the top of a table split across pages. NOTE - for a row to be repeated, all preceding rows in the table must also be repeated.

Parameters:

repeat - - if TRUE, repeat header row at the top of each page of table; if FALSE, don't repeat header row.