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

Class HTMLTableCellInfoProvider

java.lang.Object

ro.sync.ecss.extensions.api.AuthorTableColumnWidthProviderBase

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

All Implemented Interfaces:

AuthorTableCellSpanProvider, AuthorTableColumnWidthProvider, Extension

Direct Known Subclasses:

HTMLTableCellSpanProvider

@API(type=INTERNAL,
     src=PUBLIC)
public class HTMLTableCellInfoProvider
extends AuthorTableColumnWidthProviderBase
implements AuthorTableCellSpanProvider

Provides information regarding HTML table cell span and column width. Updates the table width modification and the column widths in the document and in the layout model.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_NAME_SPAN	Span attribute name.

Fields inherited from class ro.sync.ecss.extensions.api.AuthorTableColumnWidthProviderBase

errorsListener

Constructor Summary

Constructors

Constructor	Description
HTMLTableCellInfoProvider()

Method Summary

Modifier and Type	Method	Description
void	commitColumnWidthModifications(AuthorDocumentController authorDocumentController, WidthRepresentation[] colWidths, java.lang.String tableCellsTagName)	Updates the column widths in the document and in the column layout model.
void	commitTableWidthModification(AuthorDocumentController authorDocumentController, int newTableWidth, java.lang.String tableCellsTagName)	Commit the table width modification.
java.util.List<WidthRepresentation>	getAllColspecWidthRepresentations()	Get all with representations defined in all colspecs.
java.util.List<WidthRepresentation>	getCellWidth(AuthorElement cellElement, int colNumberStart, int colSpan)	Get the width representation for the cell represented by the cellElement.
java.lang.Integer	getColSpan(AuthorElement cellElement)	Compute the number of columns the cell spans across by looking at the colspan attribute.
AuthorElement	getColSpec(int columnIndex)	Get the column specification for a certain column index.
java.lang.String	getDescription()
java.lang.Integer	getRowSpan(AuthorElement cellElement)	Compute the number of rows the cell spans across by looking at the rowspan attribute.
WidthRepresentation	getTableWidth(java.lang.String tableCellsTagName)	Returns a non null WidthRepresentation if the table width is currently known.
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.
boolean	isAcceptingFixedColumnWidths(java.lang.String tableCellsTagName)	Check if the table column widths can be represented as fixed values.
boolean	isAcceptingPercentageColumnWidths(java.lang.String tableCellsTagName)	Check if the table column widths can be represented as percentage values.
boolean	isAcceptingProportionalColumnWidths(java.lang.String tableCellsTagName)	Check if the table column widths can be represented as proportional values.
boolean	isHTMLTableCellTagName(java.lang.String tableCellsTagName)	Verify if a given table cell tag name is a HTML cell tag name.
boolean	isPreferPercentageColumnWidths(java.lang.String tableCellsTagName)	Check if percentage column widths are preferred.
boolean	isTableAcceptingWidth(java.lang.String tableCellsTagName)	Used to determine if the table accepts width specification.
boolean	isTableAndColumnsResizable(java.lang.String tableCellsTagName)	This method is used to check if the table and/or table columns can be resized.

Methods inherited from class ro.sync.ecss.extensions.api.AuthorTableColumnWidthProviderBase

getErrorsListener, setErrorsListener

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_SPAN

public static final java.lang.String ATTR_NAME_SPAN

Span attribute name. The value is span

See Also:

Constant Field Values

Constructor Detail

HTMLTableCellInfoProvider

public HTMLTableCellInfoProvider()

Method Detail

getColSpan

public java.lang.Integer getColSpan(AuthorElement cellElement)

Compute the number of columns the cell spans across by looking at the colspan 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 java.lang.Integer getRowSpan(AuthorElement cellElement)

Compute the number of rows the cell spans across by looking at the rowspan 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

Specified by:

init in interface AuthorTableColumnWidthProvider

Parameters:

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

See Also:

AuthorTableCellSpanProvider.init(AuthorElement)

getDescription

public java.lang.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)

getCellWidth

public java.util.List<WidthRepresentation> getCellWidth(AuthorElement cellElement,
                                                        int colNumberStart,
                                                        int colSpan)

Description copied from interface: AuthorTableColumnWidthProvider

Get the width representation for the cell represented by the cellElement.
For example for a CALS table cell the list with the width representations is obtained by computing the column span and then determining the WidthRepresentation for each column the cell spans across.

Specified by:

getCellWidth in interface AuthorTableColumnWidthProvider

Parameters:

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

colNumberStart - The column number the cell starts at.

colSpan - The column span of the cell.

Returns:

The list with the WidthRepresentation of the specified cell element or null if the cell width cannot be computed. If the cell spans over multiple columns then the returned list will contain one WidthRepresentation for each column the cell spans over.

See Also:

AuthorTableColumnWidthProvider.getCellWidth(ro.sync.ecss.extensions.api.node.AuthorElement, int, int)

commitColumnWidthModifications

public void commitColumnWidthModifications(AuthorDocumentController authorDocumentController,
                                           WidthRepresentation[] colWidths,
                                           java.lang.String tableCellsTagName)
                                    throws AuthorOperationException

Description copied from interface: AuthorTableColumnWidthProvider

Updates the column widths in the document and in the column layout model.
For example, for the DocBook CALS tables the method updates the columns width specifications in the source document by setting the colwidth attribute value of the colspec elements. New colspec elements will be added if needed.

Specified by:

commitColumnWidthModifications in interface AuthorTableColumnWidthProvider

Parameters:

authorDocumentController - The AuthorDocumentController used to commit the table modifications in the document.

colWidths - The new column WidthRepresentation to set. The column widths must be ordered according to the corresponding column numbers.

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. 'entry' for CALS or 'td' for HTML).

Throws:

AuthorOperationException - If the operation fails.

See Also:

AuthorTableColumnWidthProvider.commitColumnWidthModifications(AuthorDocumentController, ro.sync.ecss.extensions.api.WidthRepresentation[], java.lang.String)

commitTableWidthModification

public void commitTableWidthModification(AuthorDocumentController authorDocumentController,
                                         int newTableWidth,
                                         java.lang.String tableCellsTagName)
                                  throws AuthorOperationException

Description copied from interface: AuthorTableColumnWidthProvider

Commit the table width modification.
For example in the case of DocBook HTML tables sets the width attribute value of the table element.

Specified by:

commitTableWidthModification in interface AuthorTableColumnWidthProvider

Parameters:

authorDocumentController - The AuthorDocumentController used to commit the table width modifications in the document.

newTableWidth - The new table WidthRepresentation to set. The value is given in pixels.

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. 'entry' for CALS or 'td' for HTML).

Throws:

AuthorOperationException - If the operation fails.

See Also:

AuthorTableColumnWidthProvider.commitTableWidthModification(AuthorDocumentController, int, java.lang.String)

getTableWidth

public WidthRepresentation getTableWidth(java.lang.String tableCellsTagName)

Description copied from interface: AuthorTableColumnWidthProvider

Returns a non null WidthRepresentation if the table width is currently known.
For the DocBook HTML tables it returns the WidthRepresentation obtained by analyzing the width attribute value of the table element.

Specified by:

getTableWidth in interface AuthorTableColumnWidthProvider

Parameters:

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. 'entry' for CALS or 'td' for HTML).

Returns:

A non null value if the table width is specified. Otherwise null.

See Also:

AuthorTableColumnWidthProvider.getTableWidth(java.lang.String)

isTableAcceptingWidth

public boolean isTableAcceptingWidth(java.lang.String tableCellsTagName)

Description copied from interface: AuthorTableColumnWidthProvider

Used to determine if the table accepts width specification.
For example, for the DocBook CALS tables which do not accept an width attribute the method will return false.

Specified by:

isTableAcceptingWidth in interface AuthorTableColumnWidthProvider

Parameters:

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. 'entry' for CALS or 'td' for HTML).

Returns:

true if the table type denoted by the tableCellsTagName accepts width specification of any kind.

See Also:

AuthorTableColumnWidthProvider.isTableAcceptingWidth(java.lang.String)

isTableAndColumnsResizable

public boolean isTableAndColumnsResizable(java.lang.String tableCellsTagName)

Description copied from interface: AuthorTableColumnWidthProvider

This method is used to check if the table and/or table columns can be resized.
For example in the case of the DocBook CALS tables will return true only if the given table cells tag name is equal to 'entry'.

Specified by:

isTableAndColumnsResizable in interface AuthorTableColumnWidthProvider

Parameters:

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. CALS or HTML).

Returns:

true if the size of the table or the table cells can be adjusted.

See Also:

AuthorTableColumnWidthProvider.isTableAndColumnsResizable(java.lang.String)

isAcceptingFixedColumnWidths

public boolean isAcceptingFixedColumnWidths(java.lang.String tableCellsTagName)

Description copied from interface: AuthorTableColumnWidthProvider

Check if the table column widths can be represented as fixed values.

Specified by:

isAcceptingFixedColumnWidths in interface AuthorTableColumnWidthProvider

Parameters:

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. CALS or HTML).

Returns:

true if the table column widths can be represented in fixed values.

See Also:

AuthorTableColumnWidthProvider.isAcceptingFixedColumnWidths(java.lang.String)

isAcceptingPercentageColumnWidths

public boolean isAcceptingPercentageColumnWidths(java.lang.String tableCellsTagName)

Description copied from interface: AuthorTableColumnWidthProvider

Check if the table column widths can be represented as percentage values.

Specified by:

isAcceptingPercentageColumnWidths in interface AuthorTableColumnWidthProvider

Parameters:

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. CALS or HTML).

Returns:

true if the table column widths can be represented in percentage values.

See Also:

AuthorTableColumnWidthProvider.isAcceptingPercentageColumnWidths(java.lang.String)

isAcceptingProportionalColumnWidths

public boolean isAcceptingProportionalColumnWidths(java.lang.String tableCellsTagName)

Description copied from interface: AuthorTableColumnWidthProvider

Check if the table column widths can be represented as proportional values.

Specified by:

isAcceptingProportionalColumnWidths in interface AuthorTableColumnWidthProvider

Parameters:

tableCellsTagName - The cells tag name. Used to identify the table type (e.g. CALS or HTML).

Returns:

true if the table column widths can be represented in proportional values.

See Also:

AuthorTableColumnWidthProvider.isAcceptingProportionalColumnWidths(java.lang.String)

isHTMLTableCellTagName

public boolean isHTMLTableCellTagName(java.lang.String tableCellsTagName)

Verify if a given table cell tag name is a HTML cell tag name.

Parameters:

tableCellsTagName - The table cell tag name to check.

Returns:

True if the provided table cell tag name is a HTML cell name or a HTML header cell name.

getAllColspecWidthRepresentations

public java.util.List<WidthRepresentation> getAllColspecWidthRepresentations()

Description copied from class: AuthorTableColumnWidthProviderBase

Get all with representations defined in all colspecs. If a colspec does not specify a width, it is supposed to be 1*. If the table group specifies more columns than colspecs, those widths are supposed to be 1*.

Specified by:

getAllColspecWidthRepresentations in class AuthorTableColumnWidthProviderBase

Returns:

All width representations from the defined colspecs.

See Also:

AuthorTableColumnWidthProviderBase.getAllColspecWidthRepresentations()

getColSpec

public AuthorElement getColSpec(int columnIndex)

Get the column specification for a certain column index.

Parameters:

columnIndex - The column index

Returns:

the colspec element or null

isPreferPercentageColumnWidths

public boolean isPreferPercentageColumnWidths(java.lang.String tableCellsTagName)

Description copied from class: AuthorTableColumnWidthProviderBase

Check if percentage column widths are preferred.

Overrides:

isPreferPercentageColumnWidths in class AuthorTableColumnWidthProviderBase

Parameters:

tableCellsTagName - The cell tag name

Returns:

false by default.

See Also:

AuthorTableColumnWidthProviderBase.isPreferPercentageColumnWidths(java.lang.String)