ro.sync.ecss.extensions.commons.table.properties

Interface TablePropertiesHelper

All Superinterfaces:

TableHelper, TableHelperConstants, TablePropertiesConstants

All Known Implementing Classes:

ChoiceTableHelper, DITACALSTableHelper, Docbook5CALSTableHelper, Docbook5HTMLTableHelper, DocbookCALSTableHelper, DocbookHTMLTableHelper, RelTablePropertiesHelper, SimpleTableHelper, TablePropertiesHelperBase

@API(type=INTERNAL,
     src=PUBLIC)
public interface TablePropertiesHelper
extends TableHelper, TablePropertiesConstants

Table helper for 'Table Properties' dialog.

Field Summary

Fields inherited from interface ro.sync.ecss.extensions.commons.table.properties.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, VALIGN

Fields inherited from interface ro.sync.ecss.extensions.commons.table.properties.TableHelperConstants

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

Method Summary

Modifier and Type	Method and Description
boolean	allowsFooter() true if the current table allows footer element.
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	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	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.

Methods inherited from interface ro.sync.ecss.extensions.commons.table.properties.TableHelper

isNodeOfType, isTable, isTableGroup

Method Detail

isTableBody

boolean isTableBody(AuthorElement node)

Checks if the given node represents a table body element.

Parameters:

node - The node to be checked.

Returns:

true if the given node is a table body element.

isTableHead

boolean isTableHead(AuthorElement node)

Checks if the given node represents a table head element.

Parameters:

node - The node to be checked.

Returns:

true if the given node is a table head element.

isTableFoot

boolean isTableFoot(AuthorElement node)

Checks if the given node represents a table foot element.

Parameters:

node - The node to be checked.

Returns:

true if the given node is a table foot element.

isTableRow

boolean isTableRow(AuthorElement node)

Checks if the given node represents a table row element.

Parameters:

node - The node to be checked.

Returns:

true if the given node is a table row element.

isTableCell

boolean isTableCell(AuthorElement node)

Checks if the given node represents a table cell element.

Parameters:

node - The node to be checked.

Returns:

true if the given node is a table cell element.

isTableColspec

boolean isTableColspec(AuthorElement node)

Checks if the given node represents a table colspec element.

Parameters:

node - The node to be checked.

Returns:

true if the given node is a table colspec element.

allowsFooter

boolean allowsFooter()

true if the current table allows footer element.

Returns:

true if the table allows footer.

getFirstChildOfTypeFromParentWithType

AuthorElement getFirstChildOfTypeFromParentWithType(AuthorElement currentRow,
                                                    int childType,
                                                    int parentType)

Obtain the first row child of the parent which has the given type. The type could be one of TYPE_HEADED, TYPE_BODY, TYPE_FOOTER.

Parameters:

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.

Returns:

The first row from the parent or null if a parent with the given type is not found or if it does not contain any rows.

getElementType

int getElementType(AuthorElement node)

Obtain the type of the given node. Type can be one of TableHelperConstants.TYPE_TABLE, TableHelperConstants.TYPE_GROUP, TableHelperConstants.TYPE_HEADER, TableHelperConstants.TYPE_BODY, TableHelperConstants.TYPE_FOOTER, TableHelperConstants.TYPE_ROW, TableHelperConstants.TYPE_CELL, TableHelperConstants.TYPE_COLSPEC.

Parameters:

node - The node to compute type for.

Returns:

The type of the given node or -1 if the node is not a table node.

getElementTag

java.lang.String getElementTag(int elementType)

Obtain the element name.

Parameters:

elementType - The type of the element.

Returns:

the element tag.

getElementName

java.lang.String getElementName(int elementType)

Parameters:

elementType - The element type.

Returns:

The element name.