Oxygen XML Editor 11.2 Author API

ro.sync.ecss.extensions.commons.table.operations.xhtml
Class XHTMLDocumentTypeHelper

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.AbstractDocumentTypeHelper
      extended by ro.sync.ecss.extensions.commons.table.operations.xhtml.XHTMLDocumentTypeHelper
All Implemented Interfaces:
AuthorTableHelper, XHTMLConstants

public class XHTMLDocumentTypeHelper
extends AbstractDocumentTypeHelper
implements XHTMLConstants

Implementation of the document type helper for XHTML.


Field Summary
 
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.xhtml.XHTMLConstants
ATTRIBUTE_NAME_COLSPAN, ATTRIBUTE_NAME_ID, ATTRIBUTE_NAME_ROWSPAN, ELEMENT_NAME_INFORMALTABLE, ELEMENT_NAME_TABLE, ELEMENT_NAME_TD, ELEMENT_NAME_TH, ELEMENT_NAME_THEAD, ELEMENT_NAME_TR
 
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.AuthorTableHelper
TYPE_CELL, TYPE_ROW, TYPE_TABLE
 
Constructor Summary
XHTMLDocumentTypeHelper()
           
 
Method Summary
 void checkTableColSpanIsDefined(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSpanSupport, AuthorElement cellElement)
          For XHTML, the column span is always defined.
 String[] getTableCellElementNames()
          Returns the possible local names of the elements that represents a table cell.
 AuthorTableCellSpanProvider getTableCellSpanProvider(AuthorElement tableElement)
          Create the table cell span provider for a specific table element.
 String[] getTableElementLocalName()
          Returns the possible local names of the elements that represents a table.
 String[] getTableRowElementNames()
          Return the possible local names of the elements that represent a table row.
 void updateTableColSpan(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSupport, AuthorElement cellElement, int startCol, int endCol)
          Update the 'colspan' attribute.
 void updateTableColumnNumber(AuthorAccess authorAccess, AuthorElement tableElement, int colNum)
          Update the table columns number.
 void updateTableRowNumber(AuthorAccess authorAccess, AuthorElement tableElement, int rowsNumber)
          Update the table rows number.
 void updateTableRowSpan(AuthorAccess authorAccess, AuthorElement cellElement, int rowSpan)
          Updates the cell row span to a specified value.
 
Methods inherited from class ro.sync.ecss.extensions.commons.AbstractDocumentTypeHelper
isElement, isTable, isTableCell, isTableRow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XHTMLDocumentTypeHelper

public XHTMLDocumentTypeHelper()
Method Detail

checkTableColSpanIsDefined

public void checkTableColSpanIsDefined(AuthorAccess authorAccess,
                                       AuthorTableCellSpanProvider tableSpanSupport,
                                       AuthorElement cellElement)
                                throws AuthorOperationException
For XHTML, the column span is always defined.

Specified by:
checkTableColSpanIsDefined in interface AuthorTableHelper
Parameters:
authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.
tableSpanSupport - The table cell span provider.
cellElement - The cell element to be tested.
Throws:
AuthorOperationException - When the column span is not defined for the table cell.
See Also:
AuthorTableHelper.checkTableColSpanIsDefined(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.AuthorTableCellSpanProvider, ro.sync.ecss.extensions.api.node.AuthorElement)

getTableCellElementNames

public String[] getTableCellElementNames()
Description copied from class: AbstractDocumentTypeHelper
Returns the possible local names of the elements that represents a table cell.

Specified by:
getTableCellElementNames in class AbstractDocumentTypeHelper
Returns:
The local names of the elements that represents a table cell. Not null.
See Also:
AbstractDocumentTypeHelper.getTableCellElementNames()

getTableElementLocalName

public String[] getTableElementLocalName()
Description copied from class: AbstractDocumentTypeHelper
Returns the possible local names of the elements that represents a table.

Specified by:
getTableElementLocalName in class AbstractDocumentTypeHelper
Returns:
The local names of the elements that represents a table.
See Also:
AbstractDocumentTypeHelper.getTableElementLocalName()

getTableRowElementNames

public String[] getTableRowElementNames()
Description copied from class: AbstractDocumentTypeHelper
Return the possible local names of the elements that represent a table row.

Specified by:
getTableRowElementNames in class AbstractDocumentTypeHelper
Returns:
The local names of the elements that represent a table row.
See Also:
AbstractDocumentTypeHelper.getTableRowElementNames()

getTableCellSpanProvider

public AuthorTableCellSpanProvider getTableCellSpanProvider(AuthorElement tableElement)
Description copied from interface: AuthorTableHelper
Create the table cell span provider for a specific table element.

Specified by:
getTableCellSpanProvider in interface AuthorTableHelper
Parameters:
tableElement - The element rendered as a table. Its 'display' CSS property is set to 'table'.
Returns:
The table cell span provider. Must not be null.
See Also:
AuthorTableHelper.getTableCellSpanProvider(ro.sync.ecss.extensions.api.node.AuthorElement)

updateTableColSpan

public void updateTableColSpan(AuthorAccess authorAccess,
                               AuthorTableCellSpanProvider tableSupport,
                               AuthorElement cellElement,
                               int startCol,
                               int endCol)
Update the 'colspan' attribute.

Specified by:
updateTableColSpan in interface AuthorTableHelper
Parameters:
authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.
tableSupport - The object responsible for providing information about the cell spanning.
cellElement - The cell element whose column span will be updated.
startCol - The new index of start column. It is 1 based and inclusive.
endCol - The new index of end column. It is 1 based and inclusive.
See Also:
AuthorTableHelper.updateTableColSpan(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.AuthorTableCellSpanProvider, ro.sync.ecss.extensions.api.node.AuthorElement, int, int)

updateTableRowSpan

public void updateTableRowSpan(AuthorAccess authorAccess,
                               AuthorElement cellElement,
                               int rowSpan)
Description copied from interface: AuthorTableHelper
Updates the cell row span to a specified value. For example, for the DocBook CALS tables the morerows attribute value will be updated.

Specified by:
updateTableRowSpan in interface AuthorTableHelper
Parameters:
authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.
cellElement - The cell element whose row span will be updated.
rowSpan - The new row span value. It is 1 based.
See Also:
AuthorTableHelper.updateTableRowSpan(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int)

updateTableColumnNumber

public void updateTableColumnNumber(AuthorAccess authorAccess,
                                    AuthorElement tableElement,
                                    int colNum)
Description copied from interface: AuthorTableHelper
Update the table columns number. For example, for the DocBook CALS tables the cols attribute value will be updated.

Specified by:
updateTableColumnNumber in interface AuthorTableHelper
Parameters:
authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.
tableElement - The element rendered as a table. Its 'display' CSS property is set to 'table'.
colNum - The updated number of columns.
See Also:
AuthorTableHelper.updateTableColumnNumber(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int)

updateTableRowNumber

public void updateTableRowNumber(AuthorAccess authorAccess,
                                 AuthorElement tableElement,
                                 int rowsNumber)
Description copied from interface: AuthorTableHelper
Update the table rows number.

Specified by:
updateTableRowNumber in interface AuthorTableHelper
Parameters:
authorAccess - The author access. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility a.s.o.
tableElement - The element rendered as a table. Its 'display' CSS property is set to 'table'.
rowsNumber - The number of rows to increase or decrease the current number of table rows. If the number of rows must be decreased then the argument must be negative.
See Also:
AuthorTableHelper.updateTableRowNumber(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int)

Oxygen XML Editor 11.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.