Oxygen XML Editor 11.2 Author API

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

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.table.operations.TableInfo

public class TableInfo
extends Object

Contains information about the table element (number of rows, columns, table title).


Field Summary
static int TABLE_MODEL_CALS
          Constant for CALS table model.
static int TABLE_MODEL_CUSTOM
          Constant for custom table model specific for a document type (proprietary table model).
static int TABLE_MODEL_DITA_SIMPLE
          The simple table model for DITA.
static int TABLE_MODEL_HTML
          Constant for HTML table model.
 
Constructor Summary
TableInfo(String title, int rowsNumber, int columnsNumber, boolean generateHeader, boolean generateFooter, String frame, int tableModel)
          Constructor.
TableInfo(String title, int rowsNumber, int columnsNumber, boolean generateHeader, boolean generateFooter, String frame, int tableModel, TableCustomizerConstants.ColumnWidthsType columnsWidthsType)
          Constructor.
 
Method Summary
 int getColumnsNumber()
          Return the number of columns.
 TableCustomizerConstants.ColumnWidthsType getColumnsWidthsType()
           
 String getFrame()
           
 int getRowsNumber()
          Return the number of rows.
 int getTableModel()
           
 String getTitle()
          Returns the title of the table.
 boolean isGenerateFooter()
           
 boolean isGenerateHeader()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TABLE_MODEL_HTML

public static final int TABLE_MODEL_HTML
Constant for HTML table model.

See Also:
Constant Field Values

TABLE_MODEL_CALS

public static final int TABLE_MODEL_CALS
Constant for CALS table model.

See Also:
Constant Field Values

TABLE_MODEL_CUSTOM

public static final int TABLE_MODEL_CUSTOM
Constant for custom table model specific for a document type (proprietary table model).

See Also:
Constant Field Values

TABLE_MODEL_DITA_SIMPLE

public static final int TABLE_MODEL_DITA_SIMPLE
The simple table model for DITA.

See Also:
Constant Field Values
Constructor Detail

TableInfo

public TableInfo(String title,
                 int rowsNumber,
                 int columnsNumber,
                 boolean generateHeader,
                 boolean generateFooter,
                 String frame,
                 int tableModel)
Constructor.

Parameters:
title - The table title.
rowsNumber - The number of rows.
columnsNumber - The number of columns.
generateHeader - If true generate table header.
generateFooter - If true generate table footer.
frame - Specifies how the table is to be framed.
tableModel - The table model type. One of the constants: TABLE_MODEL_CALS, TABLE_MODEL_CUSTOM, TABLE_MODEL_DITA_SIMPLE, TABLE_MODEL_HTML.

TableInfo

public TableInfo(String title,
                 int rowsNumber,
                 int columnsNumber,
                 boolean generateHeader,
                 boolean generateFooter,
                 String frame,
                 int tableModel,
                 TableCustomizerConstants.ColumnWidthsType columnsWidthsType)
Constructor.

Parameters:
title - The table title.
rowsNumber - The number of rows.
columnsNumber - The number of columns.
generateHeader - If true generate table header.
generateFooter - If true generate table footer.
frame - Specifies how the table is to be framed.
tableModel - The table model type. One of the constants: TABLE_MODEL_CALS, TABLE_MODEL_CUSTOM, TABLE_MODEL_DITA_SIMPLE, TABLE_MODEL_HTML.
columnsWidthsType - The columns widths type.
Method Detail

getTitle

public String getTitle()
Returns the title of the table.

Returns:
The title of the table.

getRowsNumber

public int getRowsNumber()
Return the number of rows.

Returns:
The number of rows.

getColumnsNumber

public int getColumnsNumber()
Return the number of columns.

Returns:
The number of columns.

isGenerateHeader

public boolean isGenerateHeader()
Returns:
If true then table header will be generated.

isGenerateFooter

public boolean isGenerateFooter()
Returns:
If true then table footer will be generated.

getFrame

public String getFrame()
Returns:
Specifies the table frame.

getTableModel

public int getTableModel()
Returns:
Returns the table model. One of the constants: TABLE_MODEL_CALS, TABLE_MODEL_CUSTOM, TABLE_MODEL_DITA_SIMPLE, TABLE_MODEL_HTML.

getColumnsWidthsType

public TableCustomizerConstants.ColumnWidthsType getColumnsWidthsType()
Returns:
Returns the columns widths type(proportional, fixed, dynamic).

Oxygen XML Editor 11.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.