@API(type=INTERNAL, src=PUBLIC) public interface TablePropertiesHelper extends TablePropertiesConstants
ALIGN, ATTR_NOT_SET, BOTTOM, CENTER, CHAR, COLSEP, EMPTY_ICON, FRAME, ICON_ALIGN_CENTER, ICON_ALIGN_JUSTIFY, ICON_ALIGN_LEFT, ICON_ALIGN_RIGHT, ICON_COL_ROW_SEP, ICON_COLSEP, ICON_FRAME_ALL, ICON_FRAME_BOTTOM, ICON_FRAME_LHS, ICON_FRAME_RHS, ICON_FRAME_SIDES, ICON_FRAME_TOP, ICON_FRAME_TOPBOT, ICON_ROW_TYPE_BODY, ICON_ROW_TYPE_FOOTER, ICON_ROW_TYPE_HEADER, ICON_ROWSEP, ICON_VALIGN_BOTTOM, ICON_VALIGN_MIDDLE, ICON_VALIGN_TOP, JUSTIFY, LEFT, MIDDLE, NOT_COMPUTED, PRESERVE, RIGHT, ROW_TYPE, ROW_TYPE_BODY, ROW_TYPE_FOOTER, ROW_TYPE_HEADER, ROW_TYPE_PROPERTY, ROWSEP, TOP, TYPE_BODY, TYPE_BODY_DESC_CELL, TYPE_CELL, TYPE_COLSPEC, TYPE_FOOTER, TYPE_GROUP, TYPE_HEADER, TYPE_HEADER_CELL, TYPE_HEADER_DESC_CELL, TYPE_ROW, TYPE_TABLE, VALIGN
Modifier and Type | Method and Description |
---|---|
boolean |
allowsFooter()
true if the current table allows footer element. |
void |
getChildElements(AuthorElement node,
int type,
java.util.List<AuthorElement> children)
Obtain a list of children with the given type.
|
AuthorElement |
getElementAncestor(AuthorNode node,
int type)
Search for an ancestor
AuthorNode with the specified type. |
java.lang.String |
getElementName(int elementType) |
java.lang.String |
getElementTag(int elementType)
Obtain the element name.
|
int |
getElementType(AuthorElement node)
Obtain the type of the given node.
|
AuthorElement |
getFirstChildOfTypeFromParentWithType(AuthorElement currentRow,
int childType,
int parentType)
Obtain the first row child of the parent which has the given type.
|
boolean |
isNodeOfType(AuthorElement node,
int type)
Test if an
AuthorNode is an element and it has one of the following types:
AuthorTableHelper.TYPE_CELL , AuthorTableHelper.TYPE_ROW or
AuthorTableHelper.TYPE_TABLE . |
boolean |
isTable(AuthorElement node)
Checks if the given node represents the table element.
|
boolean |
isTableBody(AuthorElement node)
Checks if the given node represents a table body element.
|
boolean |
isTableCell(AuthorElement node)
Checks if the given node represents a table cell element.
|
boolean |
isTableColspec(AuthorElement node)
Checks if the given node represents a table colspec element.
|
boolean |
isTableFoot(AuthorElement node)
Checks if the given node represents a table foot element.
|
boolean |
isTableGroup(AuthorElement node)
Checks if the given node represents a table group element.
|
boolean |
isTableHead(AuthorElement node)
Checks if the given node represents a table head element.
|
boolean |
isTableRow(AuthorElement node)
Checks if the given node represents a table row element.
|
boolean isTable(AuthorElement node)
node
- The node to be checked.true
if the given node is the table element.boolean isTableGroup(AuthorElement node)
node
- The node to be checked.true
if the given node is the table group element.boolean isTableBody(AuthorElement node)
node
- The node to be checked.true
if the given node is a table body element.boolean isTableHead(AuthorElement node)
node
- The node to be checked.true
if the given node is a table head element.boolean isTableFoot(AuthorElement node)
node
- The node to be checked.true
if the given node is a table foot element.boolean isTableRow(AuthorElement node)
node
- The node to be checked.true
if the given node is a table row element.boolean isTableCell(AuthorElement node)
node
- The node to be checked.true
if the given node is a table cell element.boolean isTableColspec(AuthorElement node)
node
- The node to be checked.true
if the given node is a table colspec element.AuthorElement getElementAncestor(AuthorNode node, int type)
AuthorNode
with the specified type.node
- The starting node.type
- The type of the ancestor.node
or the node
itself if the type matches.boolean isNodeOfType(AuthorElement node, int type)
AuthorNode
is an element and it has one of the following types:
AuthorTableHelper.TYPE_CELL
, AuthorTableHelper.TYPE_ROW
or
AuthorTableHelper.TYPE_TABLE
.node
- The node to be checked.type
- The type to search for.true
if the node
is an element with the specified type.boolean allowsFooter()
true
if the current table allows footer element.true
if the table allows footer.void getChildElements(AuthorElement node, int type, java.util.List<AuthorElement> children)
node
- The parent node.type
- The type of the children.children
- The list with collected children. Empty when the function is called.AuthorElement getFirstChildOfTypeFromParentWithType(AuthorElement currentRow, int childType, int parentType)
currentRow
- The current row element.childType
- The type of the child that is needed.parentType
- The type for the parent which will contain the returned row element.int getElementType(AuthorElement node)
TablePropertiesConstants.TYPE_TABLE
,
TablePropertiesConstants.TYPE_GROUP
, TablePropertiesConstants.TYPE_HEADER
,
TablePropertiesConstants.TYPE_BODY
, TablePropertiesConstants.TYPE_FOOTER
,
TablePropertiesConstants.TYPE_ROW
, TablePropertiesConstants.TYPE_CELL
,
TablePropertiesConstants.TYPE_COLSPEC
.node
- The node to compute type for.java.lang.String getElementTag(int elementType)
elementType
- The type of the element.java.lang.String getElementName(int elementType)
elementType
- The element type.© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.