|
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.tei.TEIDocumentTypeHelper
@API(type=INTERNAL, src=PUBLIC) public class TEIDocumentTypeHelper
Implementation of the document type helper for TEI.
Field Summary |
---|
Fields inherited from interface ro.sync.ecss.extensions.tei.table.TEIConstants |
---|
ATTRIBUTE_NAME_COLS, ATTRIBUTE_NAME_ID, ATTRIBUTE_NAME_ROWS, ATTRIBUTE_NAME_XML_ID, ELEMENT_NAME_CELL, ELEMENT_NAME_ROW, ELEMENT_NAME_TABLE |
Fields inherited from interface ro.sync.ecss.extensions.commons.table.operations.AuthorTableHelper |
---|
TYPE_CELL, TYPE_ROW, TYPE_TABLE |
Constructor Summary | |
---|---|
TEIDocumentTypeHelper()
|
Method Summary | |
---|---|
void |
checkTableColSpanIsDefined(AuthorAccess authorAccess,
AuthorTableCellSpanProvider tableCellSpanProvider,
AuthorElement cellElement)
For TEI the column span is always defined. |
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 tableElement)
Create the table cell span provider for a specific 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 tableCellSpanProvider,
AuthorElement cellElement,
int startCol,
int endCol)
Update the 'cols' attribute. |
void |
updateTableColumnNumber(AuthorAccess authorAccess,
AuthorElement tableElement,
int colNumber)
Updates the 'cols' attribute. |
void |
updateTableRowNumber(AuthorAccess authorAccess,
AuthorElement tableElement,
int relativeValue)
Updates the 'rows' attribute. |
void |
updateTableRowSpan(AuthorAccess authorAccess,
AuthorElement cellElement,
int rowSpan)
Update the 'rows' attribute. |
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 TEIDocumentTypeHelper()
Method Detail |
---|
public void checkTableColSpanIsDefined(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableCellSpanProvider, AuthorElement cellElement) throws AuthorOperationException
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.tableCellSpanProvider
- 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 java.lang.String[] getTableCellElementNames()
AbstractDocumentTypeHelper
getTableCellElementNames
in class AbstractDocumentTypeHelper
null
.AbstractDocumentTypeHelper.getTableCellElementNames()
public java.lang.String[] getTableElementLocalName()
AbstractDocumentTypeHelper
getTableElementLocalName
in class AbstractDocumentTypeHelper
AbstractDocumentTypeHelper.getTableElementLocalName()
public java.lang.String[] getTableRowElementNames()
AbstractDocumentTypeHelper
getTableRowElementNames
in class AbstractDocumentTypeHelper
AbstractDocumentTypeHelper.getTableRowElementNames()
public AuthorTableCellSpanProvider getTableCellSpanProvider(AuthorElement tableElement)
AuthorTableHelper
getTableCellSpanProvider
in interface AuthorTableHelper
tableElement
- 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 updateTableColSpan(AuthorAccess authorAccess, AuthorTableCellSpanProvider tableCellSpanProvider, AuthorElement cellElement, int startCol, int endCol)
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.tableCellSpanProvider
- 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.AuthorTableHelper.updateTableColSpan(ro.sync.ecss.extensions.api.AuthorAccess, ro.sync.ecss.extensions.api.AuthorTableCellSpanProvider, ro.sync.ecss.extensions.api.node.AuthorElement, int, int)
public void updateTableRowSpan(AuthorAccess authorAccess, AuthorElement cellElement, int rowSpan)
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.cellElement
- 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 colNumber)
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'.colNumber
- 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 relativeValue)
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'.relativeValue
- 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 |