Oxygen XML Editor 11.2 Author API

ro.sync.ecss.extensions.commons.table.operations.cals
Class CALSDocumentTypeHelper

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.AbstractDocumentTypeHelper
      extended by ro.sync.ecss.extensions.commons.table.operations.cals.CALSDocumentTypeHelper
All Implemented Interfaces:
AuthorTableHelper, CALSConstants

public class CALSDocumentTypeHelper
extends AbstractDocumentTypeHelper
implements CALSConstants

Implementation of the document type helper for CALS table model(DocBook and DITA).


Field Summary
 
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.cals.CALSConstants
ATTRIBUTE_NAME_COLNAME, ATTRIBUTE_NAME_COLNUM, ATTRIBUTE_NAME_COLS, ATTRIBUTE_NAME_COLWIDTH, ATTRIBUTE_NAME_ID, ATTRIBUTE_NAME_MOREROWS, ATTRIBUTE_NAME_NAMEEND, ATTRIBUTE_NAME_NAMEST, ATTRIBUTE_NAME_SPANNAME, ATTRIBUTE_NAME_TABLE_WIDTH, ELEMENT_NAME_COLSPEC, ELEMENT_NAME_ENTRY, ELEMENT_NAME_INFORMALTABLE, ELEMENT_NAME_ROW, ELEMENT_NAME_SPANSPEC, ELEMENT_NAME_TABLE, ELEMENT_NAME_TGROUP
 
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.AuthorTableHelper
TYPE_CELL, TYPE_ROW, TYPE_TABLE
 
Constructor Summary
CALSDocumentTypeHelper()
           
 
Method Summary
 void checkTableColSpanIsDefined(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSpanSupport, AuthorElement cellElement)
          Check if the column span is defined for a table cell.
 String[] getTableCellElementNames()
          Returns the possible local names of the elements that represents a table cell.
 AuthorTableCellSpanProvider getTableCellSpanProvider(AuthorElement tgroupElement)
          Creates an AuthorTableCellSpanProvider corresponding to the 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 cellElem, int startCol, int endCol)
          Update the span information of the specified cell element.
 void updateTableColumnNumber(AuthorAccess authorAccess, AuthorElement tableElement, int colsNumber)
          Update the cols attribute value of the table tgroup element.
 void updateTableRowNumber(AuthorAccess authorAccess, AuthorElement tableElement, int rowsNumber)
          Not needed for CALS Tables.
 void updateTableRowSpan(AuthorAccess authorAccess, AuthorElement cellElem, int rowSpan)
          Update the morerows attribute value for the given cell element.
 
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

CALSDocumentTypeHelper

public CALSDocumentTypeHelper()
Method Detail

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()

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()

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()

checkTableColSpanIsDefined

public void checkTableColSpanIsDefined(AuthorAccess authorAccess,
                                       AuthorTableCellSpanProvider tableSpanSupport,
                                       AuthorElement cellElement)
                                throws AuthorOperationException
Description copied from interface: AuthorTableHelper
Check if the column span is defined for a table cell.

I.E. for DocBook the column span is defined by the 'colspec' element. If it is missing then the column span is not 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)

updateTableColSpan

public void updateTableColSpan(AuthorAccess authorAccess,
                               AuthorTableCellSpanProvider tableSupport,
                               AuthorElement cellElem,
                               int startCol,
                               int endCol)
                        throws AuthorOperationException
Update the span information of the specified cell element. The namest and nameend attributes will be set according to the startCol and endCol supplied values. If the spanname attribute is set, then it will be removed.

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.
cellElem - 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.
Throws:
AuthorOperationException - If the supplied values for start span column and end span column do not correspond to existing columns specifications.
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)

getTableCellSpanProvider

public AuthorTableCellSpanProvider getTableCellSpanProvider(AuthorElement tgroupElement)
Creates an AuthorTableCellSpanProvider corresponding to the table element.

Specified by:
getTableCellSpanProvider in interface AuthorTableHelper
Parameters:
tgroupElement - 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)

updateTableRowSpan

public void updateTableRowSpan(AuthorAccess authorAccess,
                               AuthorElement cellElem,
                               int rowSpan)
Update the morerows attribute value for the given cell element. If the supplied value for the row span is less than or equal to 1 then the attribute will be removed.

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.
cellElem - 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 colsNumber)
Update the cols attribute value of the table tgroup element.

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'.
colsNumber - 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)
Not needed for CALS Tables.

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.