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.documents.document
Class Index

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

public class Index
extends java.lang.Object

该类定义了设置索引和目录的方法。

Method Summary
`void` | `addEntry(java.lang.String mainEntry)` 添加主索引项。
`void` | `addEntry(java.lang.String mainEntry, java.lang.String subEntry)` 添加索引项。
`void` | `apply()` 执行索引操作,只有调用这个apply()方法,才能真正的插入索引。
`void` | `clearEntrys()` 全部删除索引项。
`java.lang.Object[]` | `getEnteryArry()` 返回索引的字段数组(如果主索引为main，次索引为sub ，那么返回 main:sub ,其中主次索引用':'隔开)。
`int` | `getFormat()` 获取索引的风格。
`int` | `getTabLeader()` 获取制表位的前导符。
`int` | `getType()` 获取索引的类型 (缩进式、接近式)。
`boolean` | `isRight()` 判断页码是否右对齐。
`void` | `setFormat(int format)` 设置索引的风格。
`void` | `setRight(boolean right)` 设置页码是否右对齐。
`void` | `setTabLeader(int type)` 设置制表位的前导符。
`void` | `setType(int type)` 设置索引的类型 (缩进式、接近式)。

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

Method Detail

### addEntry

    public void addEntry(java.lang.String mainEntry)

  添加主索引项。

  Parameters:
    `mainEntry` - 主索引项

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();

  See Also:
    `addEntry(String,String)`

### addEntry

    public void addEntry(java.lang.String mainEntry,
                         java.lang.String subEntry)

  添加索引项。

  Parameters:
    `mainEntry` - 主索引项
    `subEntry` - 次索引项

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();

  See Also:
    `addEntry(String)`

### apply

    public void apply()

  执行索引操作,只有调用这个apply()方法,才能真正的插入索引。

  例子：

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       Index index = baseText.getIndex(0);
       index.addEntry("eio","");
       index.setFormat(IndexAndTableConstants.FANCY);
       index.setRight(true);
       index.setTabLeader(IndexAndTableConstants.DOTS);
       index.setType(IndexAndTableConstants.INDENTED);
       index.apply();

### clearEntrys

    public void clearEntrys()

  全部删除索引项。

  例子：

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       Index index = baseText.getIndex(0);
       index.addEntry("eio");
       index.clearEntry();

### getEnteryArry

    public java.lang.Object[] getEnteryArry()

  返回索引的字段数组(如果主索引为main，次索引为sub ，那么返回 main:sub ,其中主次索引用':'隔开)。

  Returns:
    Object[]，即索引的字段数组

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();
         System.out.println((String)index.getEnteryArry()[0]);

### getFormat

    public int getFormat()

  获取索引的风格。

  Returns:
    索引的风格索引号

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();
         System.out.println(index.getFormat());

  See Also:
    `setFormat(int)`

### getTabLeader

    public int getTabLeader()

  获取制表位的前导符。

  Returns:
    制表位的前导符的类型

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();
         System.out.println(index.getTabLeader());

### getType

    public int getType()

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

  Returns:
    索引的类型。0表示缩进式，1表示接近式

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();
         System.out.println(index.getType());

  See Also:
    `setType(int)`

### isRight

    public boolean isRight()

  判断页码是否右对齐。

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

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();
         System.out.println(index.isRight(true));

### setFormat

    public void setFormat(int format)

  设置索引的风格。

  Parameters:
    `format` - 索引的风格索引号

         IndexAndTableConstants.TEMPLATE      索引的风格   来自模板
         IndexAndTableConstants.CLASSIC       索引的风格   古典
         IndexAndTableConstants.DISTINCTIVE   索引的风格   独特
         IndexAndTableConstants.FANCY         索引的风格   流行
         IndexAndTableConstants.MORDERN       索引的风格   现代
         IndexAndTableConstants.FORMAL        索引的风格   正式
         IndexAndTableConstants.SIMPLE        索引的风格   简单

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();

  See Also:
    `getFormat()`, `IndexAndTableConstants`

### setRight

    public void setRight(boolean right)

  设置页码是否右对齐。

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

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();

### setTabLeader

    public void setTabLeader(int type)

  设置制表位的前导符。

  Parameters:
    `type` - 制表位的前导符的类型

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

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();

  See Also:
    `IndexAndTableConstants`

### setType

    public void setType(int type)

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

  Parameters:
    `type` - 显示类型

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

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         Index index = baseText.getIndex(0);
         index.addEntry("eio","");
         index.setFormat(IndexAndTableConstants.FANCY);
         index.setRight(true);
         index.setTabLeader(IndexAndTableConstants.DOTS);
         index.setType(IndexAndTableConstants.INDENTED);
         index.apply();

  See Also:
    `getType()`, `IndexAndTableConstants`

Overview | Package | Class | Tree | Index | Help

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

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