Package ro.sync.ecss.extensions.commons.table.support

Class DITASimpleTableCellSpanProvider

java.lang.Object

ro.sync.ecss.extensions.commons.table.support.DITASimpleTableCellSpanProvider

All Implemented Interfaces:

AuthorTableCellSpanProvider, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class DITASimpleTableCellSpanProvider
extends Object
implements AuthorTableCellSpanProvider

This class is responsible for providing information about the DITA simple table cell spanning.

Constructor Summary

Constructors

Constructor	Description
DITASimpleTableCellSpanProvider()

Method Summary

Modifier and Type	Method	Description
Integer	getColSpan(AuthorElement cellElement)	Get the number of columns the given cell spans across.
String	getDescription()
Integer	getRowSpan(AuthorElement cellElement)	Get the number of rows that the given cell spans across.
boolean	hasColumnSpecifications(AuthorElement tableElement)	This method tells if the table contains column specifications.
void	init(AuthorElement tableElement)	This method is called when starting to compute the layout for a table.

Methods inherited from class java.lang.Object

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

Constructor Details

DITASimpleTableCellSpanProvider

public DITASimpleTableCellSpanProvider()

Method Details

getColSpan

public Integer getColSpan(AuthorElement cellElement)

Description copied from interface: AuthorTableCellSpanProvider

Get the number of columns the given cell spans across. For example, for the DocBook CALS tables the number of columns the cell spans across is computed by looking at the spanspec attribute. In case the spanspec attribute is missing then the column span is defined by the namest and nameend attribute.

Specified by:

getColSpan in interface AuthorTableCellSpanProvider

Parameters:

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

Returns:

The number of columns this cell spans across (the minimum returned value must be 1) or null if not specified.

See Also:

• AuthorTableCellSpanProvider.getColSpan(AuthorElement)

getRowSpan

public Integer getRowSpan(AuthorElement cellElement)

Description copied from interface: AuthorTableCellSpanProvider

Get the number of rows that the given cell spans across. For example, for the DocBook CALS tables this value is computed by looking at the morerows attribute.

Specified by:

getRowSpan in interface AuthorTableCellSpanProvider

Parameters:

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

Returns:

The number of rows this cell spans across (the minimum returned value must be 1) or null if not specified.

See Also:

• AuthorTableCellSpanProvider.getRowSpan(AuthorElement)

init

public void init(AuthorElement tableElement)

Description copied from interface: AuthorTableCellSpanProvider

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 getColSpan() or getRowSpan() call. Example: for a DocBook table we identify and cache the colspec and spanspec 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..

Specified by:

init in interface AuthorTableCellSpanProvider

Parameters:

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

See Also:

• AuthorTableCellSpanProvider.init(AuthorElement)

getDescription

public String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

• Extension.getDescription()

hasColumnSpecifications

public boolean hasColumnSpecifications(AuthorElement tableElement)

Description copied from interface: AuthorTableCellSpanProvider

This method tells if the table contains column specifications. For example the CALS table model requires colspec elements to be present.

Specified by:

hasColumnSpecifications in interface AuthorTableCellSpanProvider

Parameters:

tableElement - The AuthorElement that is rendered as a table.

Returns:

true if some column specification info is present or if the table doesn't require any column specification info.

See Also:

• AuthorTableCellSpanProvider.hasColumnSpecifications(ro.sync.ecss.extensions.api.node.AuthorElement)