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

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

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

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

    public class TableOfContent

extends java.lang.Object

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

构造函数摘要
`TableOfContent()` 默认构建器

方法摘要
`int` | `getShowLevel()` 获取显示于目录中的标题级别数。
`java.util.HashMap` | `getStylesAndLevel()` 得到所有有效样式以及其各自对应的目录级别
`int` | `getTabLeader()` 获取制表位的前导符。
`boolean` | `isBuildFromOutlineLevel()` 判断目录是否建自大纲级别
`boolean` | `isBuildFromStyles()` 判断目录是否建自样式
`boolean` | `isPageVisible()` 判断是否显示各目录项的页码。
`boolean` | `isRight()` 判断页码是否右对齐。
`void` | `setBuildFromOutlineLevel(boolean flag)` 设置目录是否建自大纲级别
`void` | `setBuildFromStyles(boolean flag)` 设置目录是否建自样式
`void` | `setFormat(int format)` 设置目录或索引的格式。
`void` | `setOutlineLevelVisible(int level)` 设置需显示于目录中的标题级别数。
`void` | `setPageVisible(boolean visible)` 设置是否显示各目录项的页码。
`void` | `setRight(boolean right)` 设置页码右对齐（即页码与右边距对齐）。
`void` | `setStylesAndLevel(java.util.HashMap styles)` 设置所有有效样式以及其各自对应的目录级别
`void` | `setTabLeader(int type)` 设置制表位的前导符。

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

构造函数详细信息

### TableOfContent

    public TableOfContent()

  默认构建器

方法详细信息

### getShowLevel

    public int getShowLevel()

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

  返回：
    标题级别数

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         System.out.println("当前目录中的标题级别数为："+toc.getShowLevel());

### getStylesAndLevel

    public java.util.HashMap getStylesAndLevel()

  得到所有有效样式以及其各自对应的目录级别

  返回：
    是一个容器，存放样式以及对应的级别，注：存放的都是字符串，按以下方式存放{有效样式名称,目录级别,有效样式名称,目录级别,有效样式名称,目录级别……｝

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         java.util.HashMap hash = toc.getStylesAndLevel();
         java.util.Set keys = hash.keySet();
         Iterator keyIterators = keys.iterator();
         int i = 0;
         while (keyIterators.hasNext())
         {
             String key = (String)keyIterators.next();
             System.out.println("当前目录的有效样式 "+i+"为："+key +"对应的目录级别为："+hash.get(key));
         }

### getTabLeader

    public int getTabLeader()

  获取制表位的前导符。

  返回：
    制表位的前导符的类型，为整型数值

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         System.out.println("当前目录的制表位的前导符为："+toc.getTabLeader());

### isBuildFromOutlineLevel

    public boolean isBuildFromOutlineLevel()

  判断目录是否建自大纲级别

  返回：
    布尔型值，如果目录建自大纲级别，返回true；否则，返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         System.out.println("当前目录是否建自大纲级别："+toc.isBuildFromOutlineLevel());

### isBuildFromStyles

    public boolean isBuildFromStyles()

  判断目录是否建自样式

  返回：
    布尔型值，如果目录建自样式，返回true；否则，返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         System.out.println("当前目录是否建自样式："+toc.isBuildFromStyles());

### isPageVisible

    public boolean isPageVisible()

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

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

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         System.out.println("当前目录是否显示各目录项的页码："+toc.isPageVisible());

### isRight

    public boolean isRight()

  判断页码是否右对齐。

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

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         baseText.insertTableOfContent(0,toc);
         toc = baseText.getTableOfContent(0,4);
         System.out.println("当前目录是否页码右对齐："+toc.isRight());

### setBuildFromOutlineLevel

    public void setBuildFromOutlineLevel(boolean flag)

  设置目录是否建自大纲级别

  参数：
    `flag` - 布尔型值，如为true，目录建自大纲级别；否则目录不建自大纲级别

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setBuildFromOutlineLevel(true);
         baseText.insertTableOfContent(0,toc);

### setBuildFromStyles

    public void setBuildFromStyles(boolean flag)

  设置目录是否建自样式

  参数：
    `flag` - 布尔型值，如为true，目录建自样式；否则目录不建自样式

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setBuildFromStyles(true);
         baseText.insertTableOfContent(0,toc);

### setFormat

    public void setFormat(int format)

  设置目录或索引的格式。

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

         IndexAndTableConstants.FORMAT_TEMPLATE = 0（来自模板）；
         IndexAndTableConstants.FORMAT_CLASSIC = 1（古典）；
         IndexAndTableConstants.FORMAT_DISTINCTIVE = 2（独特）；
         IndexAndTableConstants.FORMAT_FANCY  = 3（流行）；
         IndexAndTableConstants.FORMAT_MORDERN = 4（现代）；
         IndexAndTableConstants.FORMAT_FORMAL = 5（正式）；
         IndexAndTableConstants.FORMAT_SIMPLE = 6（简单）

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setFormat(IndexAndTableConstants.FORMAT_FANCY);
         baseText.insertTableOfContent(0,toc);

  抛出：
    `MacroRunException` - 当参数小于0或者大于6时
  另请参见：
    `IndexAndTableConstants`

### setOutlineLevelVisible

    public void setOutlineLevelVisible(int level)

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

  参数：
    `level` - 标题级别数(1:标题1,2:标题2,3:标题3,...)

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setOutlineLevelVisible(3);
         baseText.insertTableOfContent(0,toc);

  抛出：
    `MacroRunException` - 当参数小于1或者大于9时

### setPageVisible

    public void setPageVisible(boolean visible)

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

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

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setPageVisible(true);
         baseText.insertTableOfContent(0,toc);

### setRight

    public void setRight(boolean right)

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

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

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setPageVisible(true);
         toc.setRight(true);
         baseText.insertTableOfContent(0,toc);

### setStylesAndLevel

    public void setStylesAndLevel(java.util.HashMap styles)

  设置所有有效样式以及其各自对应的目录级别

  参数：
    `styles` - 是一个容器，存放样式以及对应的级别，注：存放的都是字符串，按以下方式存放{有效样式名称,目录级别,有效样式名称,目录级别,有效样式名称,目录级别……｝

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setBuildFromStyles(true);
         java.util.HashMap hash = new java.util.HashMap();
         hash.put("标题　1","1");
         hash.put("标题　2","2");
         hash.put("标题　3","3");
         hash.put("标题　3","4");
         toc.setStylesAndLevel(hash);
         baseText.insertTableOfContent(0,toc);

  抛出：
    `MacroRunException` - 当参数为空时

### setTabLeader

    public void setTabLeader(int type)

  设置制表位的前导符。

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

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

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TableOfContent toc = baseText.getTableOfContent(2,4);
         toc.setTabLeader(IndexAndTableConstants.DOTS);
         baseText.insertTableOfContent(0,toc);

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

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

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

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