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 TableOfContents

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

public class TableOfContents
extends java.lang.Object

该类定义了设置目录的一些方法。

Method Summary
`void` | `apply()` 执行目录操作,只有调用这个apply()方法,才能真正的插入目录。
`boolean` | `getAppendsSelected()` 判断目录是否建自附录。
`int` | `getFormats()` 获取目录或索引的格式索引。
`boolean` | `getIndexSelected()` 判断目录是否建自索引。
`java.util.Vector` | `getNotShowData()` 获取不需要显示的级别的一个向量。
`int` | `getShowLevel()` 获取显示于目录中的标题级别数。
`int` | `getTabLeader()` 获取制表位的前导符。
`boolean` | `isRight()` 判断页码是否右对齐。
`boolean` | `isShowPage()` 判断是否显示各目录项的页码。
`void` | `setAppendsSelected(boolean isAppends)` 设置目录是否建自附录。
`void` | `setFormats(int format)` 设置目录或索引的格式。
`void` | `setIndexSelected(boolean isIndex)` 设置目录是否建自索引。
`void` | `setNotShowData(java.util.Vector vector)` 设置不需要显示的级别。
`void` | `setRight(boolean right)` 设置页码右对齐（即页码与右边距对齐）。
`void` | `setShowLevel(int level)` 设置需显示于目录中的标题级别数。
`void` | `setShowPage(boolean show)` 设置是否显示各目录项的页码。
`void` | `setTabLeader(int type)` 设置制表位的前导符。

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

Method Detail

### apply

    public void apply()

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

  例子：

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       TableOfContents dir = baseText.getTableOfContents(0);
       dir.setAppendsSelected(false);
       dir.setFormats(IndexAndTableConstants.FANCY);
       dir.setIndexSelected(false);
       dir.setRight(false);
       dir.setShowLevel(6);
       dir.setShowPage(true);
       dir.setTabLeader(IndexAndTableConstants.DOTS);
       dir.apply();

### getAppendsSelected

    public boolean getAppendsSelected()

  判断目录是否建自附录。

  Returns:
    布尔型值，如果目录建自附录，返回true；否则，返回false

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.getAppendsSelected());

### getFormats

    public int getFormats()

  获取目录或索引的格式索引。

  Returns:
    目录的格式索引号，为整型数值，其常量和相应的值如下：

         IndexAndTableConstants.TEMPLATE = 0（来自模板）；
         IndexAndTableConstants.CLASSIC = 1（古典）；
         IndexAndTableConstants.DISTINCTIVE = 2（独特）；
         IndexAndTableConstants.FANCY  = 3（流行）；
         IndexAndTableConstants.MORDERN = 4（现代）；
         IndexAndTableConstants.FORMAL = 5（正式）；
         IndexAndTableConstants.SIMPLE = 6（简单）

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.getFormats());

  See Also:
    `setFormats(int)`

### getIndexSelected

    public boolean getIndexSelected()

  判断目录是否建自索引。

  Returns:
    布尔型值，如果目录建自索引，返回true；否则，返回false

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.getIndexSelected());

### getNotShowData

    public java.util.Vector getNotShowData()

  获取不需要显示的级别的一个向量。

  Returns:
    java.util.Vector，不需要显示的级别的一个向量

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         Vector vector = new Vector();
         vector.addElement(new Integer(3));
         vector.addElement(new Integer(4));
         dir.setNotShowData(vector);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(((Integer)dir.getNotShowData()[0]).intValue());

  See Also:
    `setNotShowData(java.util.Vector)`

### getShowLevel

    public int getShowLevel()

  获取显示于目录中的标题级别数。

  Returns:
    标题级别数

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.getShowLevel());

### getTabLeader

    public int getTabLeader()

  获取制表位的前导符。

  Returns:
    制表位的前导符的类型，为整型数值

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.getTabLeader());

### isRight

    public boolean isRight()

  判断页码是否右对齐。

  Returns:
    布尔型值，如果页码设置了右对齐，返回true；否则，返回false

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.isRight(true));

### isShowPage

    public boolean isShowPage()

  判断是否显示各目录项的页码。

  Returns:
    布尔型值，如为true，显示各目录项的页码；否则，不显示各目录项的页码

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();
         System.out.println(dir.isShowPage(true));

### setAppendsSelected

    public void setAppendsSelected(boolean isAppends)

  设置目录是否建自附录。

### setFormats

    public void setFormats(int format)

  设置目录或索引的格式。

  Parameters:
    `format` - 目录的格式索引号，其常量和相应的值如下：

         IndexAndTableConstants.TEMPLATE = 0（来自模板）；
         IndexAndTableConstants.CLASSIC = 1（古典）；
         IndexAndTableConstants.DISTINCTIVE = 2（独特）；
         IndexAndTableConstants.FANCY  = 3（流行）；
         IndexAndTableConstants.MORDERN = 4（现代）；
         IndexAndTableConstants.FORMAL = 5（正式）；
         IndexAndTableConstants.SIMPLE = 6（简单）

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

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

### setIndexSelected

    public void setIndexSelected(boolean isIndex)

  设置目录是否建自索引。

  Parameters:
    `isIndex` - 布尔型值，如为true，设置目录建自索引；否则，目录不建自索引

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

### setNotShowData

    public void setNotShowData(java.util.Vector vector)

  设置不需要显示的级别。

  Parameters:
    `vector` - 不需要显示的级别

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         Vector vector = new Vector();
         vector.addElement(new Integer(3));
         vector.addElement(new Integer(4));
         dir.setNotShowData(vector);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

### setRight

    public void setRight(boolean right)

  设置页码右对齐（即页码与右边距对齐）。

  Parameters:
    `right` - 布尔型值，如为true，设置页码右对齐；否则不设置页码右对齐

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

### setShowLevel

    public void setShowLevel(int level)

  设置需显示于目录中的标题级别数。

  Parameters:
    `level` - 标题级别数

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

### setShowPage

    public void setShowPage(boolean show)

  设置是否显示各目录项的页码。

  Parameters:
    `show` - 布尔型值，如为true，显示各目录项的页码；否则，不显示各目录项的页码

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

### setTabLeader

    public void setTabLeader(int type)

  设置制表位的前导符。

  Parameters:
    `type` - 制表位的前导符的类型，其常量和相应的值如下：

         IndexAndTableConstants.SPACES = 0 （无前导符）；
         IndexAndTableConstants.DOTS = 1（前导符为点划线）；
         IndexAndTableConstants.DASHES = 2（前导符为虚线）；
         IndexAndTableConstants.LINES = 3（前导符为实线）；
         IndexAndTableConstants.MIDDLEDOTS = 4（前导符为项目符号（点居中））

    例子：

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContents dir = baseText.getTableOfContents(0);
         dir.setAppendsSelected(false);
         dir.setFormats(IndexAndTableConstants.FANCY);
         dir.setIndexSelected(false);
         dir.setRight(false);
         dir.setShowLevel(6);
         dir.setShowPage(true);
         dir.setTabLeader(IndexAndTableConstants.DOTS);
         dir.apply();

  See Also:
    `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 无锡永中科技有限公司