|
Oxygen XML Editor 11.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.dita.topic.table.simpletable.DITASimpleTableDocumentTypeHelper
public class DITASimpleTableDocumentTypeHelper
Implementation of the document type helper for DITA simple table model
Field Summary |
---|
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.AuthorTableHelper |
---|
TYPE_CELL, TYPE_ROW, TYPE_TABLE |
Constructor Summary | |
---|---|
DITASimpleTableDocumentTypeHelper()
|
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 a SimpleTableCellSpanProvider over 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 column span of the cell by modifying the indices of start and end column. |
void |
updateTableColumnNumber(AuthorAccess authorAccess,
AuthorElement tableElement,
int colsNumber)
Update the table columns number. |
void |
updateTableRowNumber(AuthorAccess authorAccess,
AuthorElement tableElement,
int rowsNumber)
Update the table rows number. |
void |
updateTableRowSpan(AuthorAccess authorAccess,
AuthorElement cellElem,
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 |
---|
public DITASimpleTableDocumentTypeHelper()
Method Detail |
---|
public String[] getTableCellElementNames()
AbstractDocumentTypeHelper
getTableCellElementNames
in class AbstractDocumentTypeHelper
null
.AbstractDocumentTypeHelper.getTableCellElementNames()
public String[] getTableRowElementNames()
AbstractDocumentTypeHelper
getTableRowElementNames
in class AbstractDocumentTypeHelper
AbstractDocumentTypeHelper.getTableRowElementNames()
public 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
AuthorTableHelper
namest
and nameend
attributes will be set according to the startCol
and endCol
supplied values.
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
- When the column specifications
for start or end columns are missing.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)
SimpleTableCellSpanProvider
over 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)
AuthorTableHelper
morerows
attribute
value will be updated.
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)
AuthorTableHelper
cols
attribute
value will be updated.
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)
AuthorTableHelper
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)
|
Oxygen XML Editor 11.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |