|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ro.sync.ecss.extensions.commons.AbstractDocumentTypeHelper ro.sync.ecss.extensions.commons.table.operations.cals.CALSDocumentTypeHelper
@API(type=INTERNAL, src=PUBLIC) public class CALSDocumentTypeHelper
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, ATTRIBUTE_NAME_XML_ID, 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. |
java.lang.String[] |
getIgnoredColumnAttributes()
Gets the attributes which should be skipped when inserting a new column and the attributes from source cell fragments must be copied. |
java.lang.String[] |
getIgnoredRowAttributes()
Gets the attributes which should be skipped when using the current row as template for insert operation. |
java.lang.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. |
java.lang.String[] |
getTableElementLocalName()
Returns the possible local names of the elements that represents a table. |
java.lang.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 |
---|
public CALSDocumentTypeHelper()
Method Detail |
---|
public java.lang.String[] getTableCellElementNames()
AbstractDocumentTypeHelper
getTableCellElementNames
in class AbstractDocumentTypeHelper
null
.AbstractDocumentTypeHelper.getTableCellElementNames()
public java.lang.String[] getTableRowElementNames()
AbstractDocumentTypeHelper
getTableRowElementNames
in class AbstractDocumentTypeHelper
AbstractDocumentTypeHelper.getTableRowElementNames()
public java.lang.String[] getTableElementLocalName()
AbstractDocumentTypeHelper
getTableElementLocalName
in class AbstractDocumentTypeHelper
AbstractDocumentTypeHelper.getTableElementLocalName()
public void checkTableColSpanIsDefined(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSpanSupport, AuthorElement cellElement) throws AuthorOperationException
AuthorTableHelper
I.E. for DocBook the column span is defined by the 'colspec' element. If it is missing then the column span is not defined.
checkTableColSpanIsDefined
in interface AuthorTableHelper
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.
AuthorOperationException
- When the column span is not defined for the table cell.AuthorTableHelper.checkTableColSpanIsDefined(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.AuthorTableCellSpanProvider, ro.sync.ecss.extensions.api.node.AuthorElement)
public void updateTableColSpan(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableSupport, AuthorElement cellElem, int startCol, int endCol) throws AuthorOperationException
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.
updateTableColSpan
in interface AuthorTableHelper
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.
AuthorOperationException
- If the supplied values for start span column
and end span column do not correspond to existing columns specifications.AuthorTableHelper.updateTableColSpan(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.AuthorTableCellSpanProvider, ro.sync.ecss.extensions.api.node.AuthorElement, int, int)
public AuthorTableCellSpanProvider getTableCellSpanProvider(AuthorElement tgroupElement)
AuthorTableCellSpanProvider
corresponding to the table element.
getTableCellSpanProvider
in interface AuthorTableHelper
tgroupElement
- The element rendered as a table. Its 'display' CSS property
is set to 'table'.
null
.AuthorTableHelper.getTableCellSpanProvider(ro.sync.ecss.extensions.api.node.AuthorElement)
public void updateTableRowSpan(AuthorAccess authorAccess, AuthorElement cellElem, int rowSpan)
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.
updateTableRowSpan
in interface AuthorTableHelper
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.AuthorTableHelper.updateTableRowSpan(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int)
public void updateTableColumnNumber(AuthorAccess authorAccess, AuthorElement tableElement, int colsNumber)
cols
attribute value of the table tgroup
element.
updateTableColumnNumber
in interface AuthorTableHelper
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.AuthorTableHelper.updateTableColumnNumber(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int)
public void updateTableRowNumber(AuthorAccess authorAccess, AuthorElement tableElement, int rowsNumber)
updateTableRowNumber
in interface AuthorTableHelper
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.AuthorTableHelper.updateTableRowNumber(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.node.AuthorElement, int)
public java.lang.String[] getIgnoredRowAttributes()
AuthorTableHelper
getIgnoredRowAttributes
in interface AuthorTableHelper
AuthorTableHelper.getIgnoredRowAttributes()
public java.lang.String[] getIgnoredColumnAttributes()
AuthorTableHelper
getIgnoredColumnAttributes
in interface AuthorTableHelper
AuthorTableHelper.getIgnoredColumnAttributes()
|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |