概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

## application.workbooks.workbook.documents.document
类 Index

    java.lang.Object
      application.workbooks.workbook.documents.document.Index

    public class Index

extends java.lang.Object

该类定义了设置索引的方法

方法摘要
`int` | `getColumns()` 获取索引中每页的栏数。
`int` | `getFormat()` 获取索引的风格。
`int` | `getTabLeader()` 获取制表位的前导符。
`int` | `getType()` 获取索引的类型 (缩进式、接排式)。
`boolean` | `isRight()` 判断页码是否右对齐。
`void` | `setColumns(int columns)` 设置索引中每页的栏数。
`void` | `setFormat(int format)` 设置索引的风格。
`void` | `setRight(boolean right)` 设置页码是否右对齐。
`void` | `setTabLeader(int type)` 设置制表位的前导符。
`void` | `setType(int type)` 设置索引的类型 (缩进式、接排式)。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

方法详细信息

### getColumns

    public int getColumns()

  获取索引中每页的栏数。

  返回：
    索引中每页的栏数

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引中每页的列数为："+index.getColumns());

  另请参见：
    `setType(int)`

### getFormat

    public int getFormat()

  获取索引的风格。

  返回：
    索引的风格索引号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的风格为："+index.getFormat());

  另请参见：
    `setFormat(int)`

### getTabLeader

    public int getTabLeader()

  获取制表位的前导符。

  返回：
    制表位的前导符的类型

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的制表位的前导符为："+index.getTabLeader());

### getType

    public int getType()

  获取索引的类型 (缩进式、接排式)。

  返回：
    索引的类型。0表示缩进式，1表示接排式

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的类型为："+index.getType());

  另请参见：
    `setType(int)`

### isRight

    public boolean isRight()

  判断页码是否右对齐。

  返回：
    布尔型值，是否右对齐。如果右对齐，则返回true；否则，返回false

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引是否设置页码右对齐："+index.isRight());

### setColumns

    public void setColumns(int columns)

  设置索引中每页的栏数。

  参数：
    `columns` - 索引中每页的栏数。取值范围为：0 ～ 4。

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setColumns(2);
         baseText.insertIndex(0,index);

  抛出：
    `MacroRunException` - 参数越界
  另请参见：
    `setType(int)`

### setFormat

    public void setFormat(int format)

  设置索引的风格。

  参数：
    `format` - 索引的风格索引号

         IndexAndTableConstants.FORMAT_TEMPLATE      索引的风格   来自模板
         IndexAndTableConstants.FORMAT_CLASSIC       索引的风格   古典
         IndexAndTableConstants.FORMAT_DISTINCTIVE   索引的风格   项目符号
         IndexAndTableConstants.FORMAT_FANCY         索引的风格   流行
         IndexAndTableConstants.FORMAT_MORDERN       索引的风格   现代
         IndexAndTableConstants.FORMAT_FORMAL        索引的风格   正式
         IndexAndTableConstants.FORMAT_SIMPLE        索引的风格   简单

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setFormat(IndexAndTableConstants.FORMAT_CLASSIC);
         baseText.insertIndex(0,index);

  抛出：
    `MacroRunException` - 当常量不存在
  另请参见：
    `getFormat()`, `IndexAndTableConstants`

### setRight

    public void setRight(boolean right)

  设置页码是否右对齐。

  参数：
    `right` - 布尔型值，是否右对齐。如果为true，表示右对齐；如果为false，表示不是右对齐

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

### setTabLeader

    public void setTabLeader(int type)

  设置制表位的前导符。

  参数：
    `type` - 制表位的前导符的类型

         IndexAndTableConstants.SPACES     制表位前导符  无
         IndexAndTableConstants.DOTS       制表位前导符  ...
         IndexAndTableConstants.DASHES     制表位前导符  ----
         IndexAndTableConstants.LINES      制表位前导符  ___
         IndexAndTableConstants.MIDDLEDOTS 制表位前导符  ...(点居中）

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.MIDDLEDOTS);
         baseText.insertIndex(0,index);

  抛出：
    `MacroRunException` - 当常量不存在
  另请参见：
    `IndexAndTableConstants`

### setType

    public void setType(int type)

  设置索引的类型 (缩进式、接排式)。

  参数：
    `type` - 显示类型

         IndexAndTableConstants.INDENTED   索引的类型  缩进式
         IndexAndTableConstants.RUNIN      索引的类型  接排式

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\nthis is a test!");
         IndexEntry entry= baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setType(IndexAndTableConstants.INDENTED);
         baseText.insertIndex(0,index);

  抛出：
    `MacroRunException` - 当常量不存在
  另请参见：
    `getType()`, `IndexAndTableConstants`

概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

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