Oxygen XML Editor 14.2 Author API

ro.sync.ecss.extensions.commons.table.operations
Class TableCustomizer

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.table.operations.TableCustomizer
Direct Known Subclasses:
ECDITARelTableCustomizer, ECDITATableCustomizer, ECDocbookInnerTableCustomizer, ECDocbookTableCustomizer, ECTEITableCustomizer, ECXHTMLTableCustomizerInvoker, SADITARelTableCustomizer, SADITATableCustomizer, SADocbookInnerTableCustomizer, SADocbookTableCustomizer, SATEITableCustomizer, SAXHTMLTableCustomizerInvoker

@API(type=INTERNAL,
     src=PUBLIC)
public abstract class TableCustomizer
extends java.lang.Object

Base for frameworks table customizers. It is used on standalone implementation.


Field Summary
protected  TableInfo tableInfo
          The last table info specified by the user.
 
Constructor Summary
TableCustomizer()
           
 
Method Summary
 TableInfo customizeTable(AuthorAccess authorAccess)
          Customize a table.
 TableInfo customizeTable(AuthorAccess authorAccess, int predefinedRowsCount, int predefinedColumnsCount)
          Customize a table.
protected abstract  TableInfo showCustomizeTableDialog(AuthorAccess authorAccess, int predefinedRowsCount, int predefinedColumnsCount)
          Show table customizer dialog and return new table information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tableInfo

protected TableInfo tableInfo
The last table info specified by the user. Session level persistence.

Constructor Detail

TableCustomizer

public TableCustomizer()
Method Detail

customizeTable

public TableInfo customizeTable(AuthorAccess authorAccess)
Customize a table.
A table customizer dialog is shown, giving the possibility to choose the properties of a new table to be inserted in the document. An object containing the new table information is returned.

Parameters:
authorAccess - Access to Author operations.
Returns:
The table information provided by the user or null if customization operation is canceled.

customizeTable

public TableInfo customizeTable(AuthorAccess authorAccess,
                                int predefinedRowsCount,
                                int predefinedColumnsCount)
Customize a table.
A table customizer dialog is shown, giving the possibility to choose the properties of a new table to be inserted in the document. An object containing the new table information is returned.

Parameters:
authorAccess - Access to Author operations.
predefinedRowsCount - The predefined number of rows, -1 if the user can control the number of inserted column.
predefinedColumnsCount - The predefined number of columns, -1 if the user can control the number of inserted column. If predefined columns count and predefined rows count values are positive then the dialog will not contain any field for defining the table columns and rows count and the inserted table will use the predefined values.
Returns:
The table information provided by the user or null if customization operation is canceled.

showCustomizeTableDialog

protected abstract TableInfo showCustomizeTableDialog(AuthorAccess authorAccess,
                                                      int predefinedRowsCount,
                                                      int predefinedColumnsCount)
Show table customizer dialog and return new table information.

Parameters:
authorAccess - The Author access.
predefinedRowsCount - Predefined number of rows.
predefinedColumnsCount - Predefined number of columns.
Returns:
The table information provided by the user or null if customization operation is canceled.

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.