Package ro.sync.ecss.extensions.api

Interface AuthorTableCellSepProvider

All Superinterfaces:

Extension

All Known Implementing Classes:

CALSTableCellInfoProvider, CALSTableCellSpanProvider, DITACALSTableCellInfoProvider, DITATableCellSepInfoProvider, DocbookTableCellSepInfoProvider

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface AuthorTableCellSepProvider
extends Extension

This is an interface for classes which are responsible for providing information about the cell separators: "rowsep" and "colsep". It should be implemented when the author extension being developed offers support for editing data in tabular form.

See Also:

• "http://www.docbook.org/tdg5/en/html/cals.table.html"
• "http://docs.oasis-open.org/dita/v1.0/langspec/table.html"
• "https://www.oasis-open.org/specs/tm9901.html"

Method Summary

Modifier and Type	Method	Description
boolean	getColSep(AuthorElement cellElement, int columnIndex)	Checks if a separator should be placed at the cell right.
boolean	getRowSep(AuthorElement cellElement, int columnIndex)	Checks if a separator should be placed at the cell bottom.
void	init(AuthorElement tableElement)	This method is called when starting to compute the layout for a table.

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Method Details

getColSep

boolean getColSep(AuthorElement cellElement,
 int columnIndex)

Checks if a separator should be placed at the cell right. Note that if the cell is the last from its row, the separator is not painted even if this method returns true.

Parameters:

cellElement - The node that represents a table cell in CSS.

columnIndex - The index of the column, used to identify the colspec associated to the cell. The colspec can give information about the colsep. 1 based.

Returns:

true if a separator should be placed at its right, false otherwise.

getRowSep

boolean getRowSep(AuthorElement cellElement,
 int columnIndex)

Checks if a separator should be placed at the cell bottom. Note that if the cell is on the last row, the separator is not painted even if this method returns true.

Parameters:

cellElement - The node that represents a table cell in CSS.

columnIndex - The index of the column, used to identify the rowspec associated to the cell. The rowspec can give information about the colsep. 1 based.

Returns:

true if a separator should be placed at its right, false otherwise.

init

void init(AuthorElement tableElement)

This method is called when starting to compute the layout for a table. Its intended to extract information from the element representing the table only once, not on every getColSep() or getRowSep() call. Example: for a CALS table we identify and cache the colsep and rowsep elements from that table. A new instance of the table cell span provider is used for every table in a document so cached data cannot be used between different tables..

Parameters:

tableElement - The AuthorElement representing a table (it has the CSS display property set on 'table').