Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook
Class Tables

    java.lang.Object
      application.workbooks.workbook.Tables

public class Tables
extends java.lang.Object

封装了某个区域所有表格的一个集合，是一个表格管理器，提供了插入，删除表格，得到表格等功能。

Method Summary
`java.lang.String[]` | `getNames()` 返回当前区域有名字表格的名字集合。
`Table` | `getTable(long offset)` 得到当前区域内offset指定的表格。
`Table` | `getTable(java.lang.String tableName)` 得到当前区域内指定名字的表格。
`int` | `getTablesCount()` 得到当前区域内表格的总数。
`void` | `insertTable(long offset, int row, int column, int autoFit, float cellWidth)` 在当前区域指定位置插入一张指定行列的自由表格。
`boolean` | `insertTable(long offset, int row, int column, int autoFit, float cellWidth, java.lang.String tableName)` 在当前区域指定位置插入一张指定行列、并且带有名子字的自由表格。
`void` | `removeAllTables()` 在当前区域内删除所有表格。
`void` | `removeTable(long startOffset, long endOffset)` 在当前区域内删除startOffset和endOffset指定范围内的所有表格。
`void` | `removeTable(java.lang.String tableName)` 在当前区域内删除指定名字的表格。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getNames

    public java.lang.String[] getNames()

  返回当前区域有名字表格的名字集合。

  Returns:
    Srting[] 如果没有有名字的表格，就返回null

### getTable

    public Table getTable(long offset)

  得到当前区域内offset指定的表格。

  Parameters:
    `offset` - 此位置值指定要得到的表格
  Returns:
    Table 所得到的指定表格

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(0,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f);
         Table table = tables.getTable(0);
         table.selectCell(0,0,2,2);

  See Also:
    `insertTable(long,int,int,int,float)`, `getTable(String)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### getTable

    public Table getTable(java.lang.String tableName)

  得到当前区域内指定名字的表格。

  Parameters:
    `tableName` - 表格名字
  Returns:
    Table 所得到的指定表格，如果没有就返回null

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(0,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f,"Test");
         Table table = tables.getTable("Test");
         table.selectCell(0,0,2,2);

  See Also:
    `insertTable(long,int,int,int,float)`, `insertTable(long,int,int,int,float,String)`, `getTable(long)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### getTablesCount

    public int getTablesCount()

  得到当前区域内表格的总数。

  Returns:
    int 当前区域内表格的总数

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(0,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f);
         tables.insertTable(100,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f);
         System.out.println("当前区域内表格的总数为："+tables.getTablesCount());

  See Also:
    `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### insertTable

    public void insertTable(long offset,
                            int row,
                            int column,
                            int autoFit,
                            float cellWidth)

  在当前区域指定位置插入一张指定行列的自由表格。

  Parameters:
    `offset` - 插入表格的指定位置
    `row` - 插入表格的行数
    `column` - 插入表格的列数
    `autoFit` - 插入表格时列宽是否要自适应文本内容，只能取以下整形值之一：

                TableConstants.FIXED_COLUMN_WIDTH  固定列宽
                TableConstants.AUTOFIT_CONTENT     列宽自适应文本内容

    `cellWidth` - 当固定列宽时，表格列宽值，以磅为单位 注： cellWidth < 0 时，其值为页面大小与表格列数之比 cellWidth的最大值为1584磅

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(0,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f);

  See Also:
    `(long,int,int,int,float,String)`, `removeTable(long,long)`, `removeAllTables()`, `(long)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### insertTable

    public boolean insertTable(long offset,
                               int row,
                               int column,
                               int autoFit,
                               float cellWidth,
                               java.lang.String tableName)

  在当前区域指定位置插入一张指定行列、并且带有名子字的自由表格。 （该表格是用户在选择整张表格时，是无法删除的，只有通过API才能删除。）

  Parameters:
    `offset` - 插入表格的指定位置
    `row` - 插入表格的行数
    `column` - 插入表格的列数
    `autoFit` - 插入表格时列宽是否要自适应文本内容，只能取以下整形值之一：

                TableConstants.FIXED_COLUMN_WIDTH  固定列宽
                TableConstants.AUTOFIT_CONTENT     列宽自适应文本内容

    `cellWidth` - 当固定列宽时，表格列宽值，以磅为单位 注： cellWidth < 0 时，其值为页面大小与表格列数之比 cellWidth的最大值为1584磅
    `tableName` - 插入表格的名字（在相同区域内表格名字不能重复）
  Returns:
    boolean 当插入表格同名时，返回false，表明插入表格失败，其余情况下 只要没有真正插入表格均返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(0,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f,"特殊表格");

  See Also:
    `(long,int,int,int,float)`, `removeTable(long,long)`, `removeAllTables()`, `(long)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### removeAllTables

    public void removeAllTables()

  在当前区域内删除所有表格。

  例子:

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       Tables tables = baseText.getTables();
       tables.insertTable(0,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f);
       tables.removeAllTables();

  See Also:
    `insertTable(long,int,int,int,float)`, `removeTable(long,long)`, `(long)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### removeTable

    public void removeTable(long startOffset,
                            long endOffset)

  在当前区域内删除startOffset和endOffset指定范围内的所有表格。

  Parameters:
    `startOffset` - 要删除表格范围的起始位置
    `endOffset` - 要删除表格范围的结束位置

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(10,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f);
         tables.removeTable(0,100);

  See Also:
    `insertTable(long,int,int,int,float)`, `removeAllTables()`, `(long)`, `removeTable(String)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

### removeTable

    public void removeTable(java.lang.String tableName)

  在当前区域内删除指定名字的表格。

  Parameters:
    `tableName` - 要删除表格的名字

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Tables tables = baseText.getTables();
         tables.insertTable(10,5,5,TableConstants.FIXED_COLUMN_WIDTH,-30.0f,"Remove Table");
         tables.removeTable("Remove Table");

  See Also:
    `insertTable(long,int,int,int,float)`, `removeAllTables()`, `(long)`, `Table`, `application.workbooks.workbook.documents.document.section.AbstractText.getTables()`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

版权所有 2001-2004 无锡永中科技有限公司