com.aspose.words

Class Row

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.Row

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class Row
extends CompositeNode

Represents a table row.

Row can only be a child of a Table.

Row can contain one or more Cell nodes.

A minimal valid row needs to have at least one Cell.

Constructor Summary

Constructors

Constructor and Description
Row(DocumentBase doc) Initializes a new instance of the Row class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
void	clearRowAttrs()
void	ensureMinimum() If the Row has no cells, creates and appends one Cell.
java.lang.Object	fetchInheritedRowAttr(int key)
java.lang.Object	fetchRowAttr(int key)
CellCollection	getCells() Provides typed access to the Cell child nodes of the row.
java.lang.Object	getDirectRowAttr(int key)
Cell	getFirstCell() Returns the first Cell in the row.
Cell	getLastCell() Returns the last Cell in the row.
int	getNodeType() Returns NodeType.Row.
Table	getParentTable() Returns the immediate parent table of the row.
RowFormat	getRowFormat() Provides access to the formatting properties of the row.
java.lang.String	getText() Gets the text of all cells in this row including the end of row character.
boolean	isFirstRow() True if this is the first row in a table; false otherwise.
boolean	isLastRow() True if this is the last row in a table; false otherwise.
void	removeMoveRevisions()
void	resetToDefaultAttrs()
void	setRowAttr(int key, java.lang.Object value)

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Row

public Row(DocumentBase doc)

Initializes a new instance of the Row class.

When Row is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Row to the document use InsertAfter or InsertBefore on the table where you want the row inserted.

Parameters:

doc - The owner document.

Method Detail

getNodeType

public int getNodeType()

Returns NodeType.Row.

Specified by:

getNodeType in class Node

Returns:

NodeType.Row. The returned value is one of NodeType constants.

getParentTable

public Table getParentTable()

Returns the immediate parent table of the row. Equivalent to (Table)FirstNonMarkupParentNode.

Returns:

The immediate parent table of the row.

isFirstRow

public boolean isFirstRow()

True if this is the first row in a table; false otherwise.

Returns:

The corresponding boolean value.

isLastRow

public boolean isLastRow()

True if this is the last row in a table; false otherwise.

Returns:

The corresponding boolean value.

getFirstCell

public Cell getFirstCell()

Returns the first Cell in the row.

Returns:

The first Cell in the row.

getLastCell

public Cell getLastCell()

Returns the last Cell in the row.

Returns:

The last Cell in the row.

getCells

public CellCollection getCells()

Provides typed access to the Cell child nodes of the row.

Returns:

The corresponding CellCollection value.

getRowFormat

public RowFormat getRowFormat()

Provides access to the formatting properties of the row.

Returns:

The corresponding RowFormat value.

accept

public boolean accept(DocumentVisitor visitor)
               throws java.lang.Exception

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Throws:

java.lang.Exception

getText

public java.lang.String getText()

Gets the text of all cells in this row including the end of row character.

Returns concatenated text of all child nodes with the end of row character ControlChar.CELL appended at the end.

The returned string includes all control and special characters as described in ControlChar.

Overrides:

getText in class CompositeNode

ensureMinimum

public void ensureMinimum()

If the Row has no cells, creates and appends one Cell.

getDirectRowAttr

public java.lang.Object getDirectRowAttr(int key)

fetchRowAttr

public java.lang.Object fetchRowAttr(int key)

fetchInheritedRowAttr

public java.lang.Object fetchInheritedRowAttr(int key)

setRowAttr

public void setRowAttr(int key,
                       java.lang.Object value)

clearRowAttrs

public void clearRowAttrs()

resetToDefaultAttrs

public void resetToDefaultAttrs()
                         throws java.lang.Exception

Throws:

java.lang.Exception

removeMoveRevisions

public void removeMoveRevisions()