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

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

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

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

    public class CaptionLabel

extends java.lang.Object

代表单个题注标签

构造函数摘要
`CaptionLabel(java.lang.String name)` 题注标签构造器

方法摘要
`void` | `delete()` 删除指定的标签对象 例子： CaptionLabels captionLabels=Application.getCaptionLabels(); CaptionLabel label=captionLabels.addCaptionLabel("dd"); CaptionLabel label2=CaptionLabels.addCaptionLabel("ss"); label2.delete();
`int` | `getChapterStyleLevel()` 当指定题注标签包含章节号时，返回用来标记新章节的标题样式
`java.lang.String` | `getName()` 返回名称
`int` | `getNumberStyle()` 返回编号样式
`int` | `getPosition()` 返回题注标签文本的位置
`boolean` | `isIncludeChapterNumber()` 返回是否包含章节号
`void` | `setChapterStyleLevel(int chapterStyleLevel)` 当指定题注标签包含章节号时，用来标记新章节的标题样式
`void` | `setIncludeChapterNumber(boolean includeChapterNumber)` 设置标识包含章节号
`void` | `setNumberStyle(int numberStyle)` 设置编号样式
`void` | `setPosition(int position)` 设置题注标签文本的位置

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

构造函数详细信息

### CaptionLabel

    public CaptionLabel(java.lang.String name)

  题注标签构造器

  参数：
    `name` - 名称

方法详细信息

### delete

    public void delete()

  删除指定的标签对象

  例子：

       CaptionLabels captionLabels=Application.getCaptionLabels();
       CaptionLabel label=captionLabels.addCaptionLabel("dd");
       CaptionLabel label2=CaptionLabels.addCaptionLabel("ss");
       label2.delete();

### getChapterStyleLevel

    public int getChapterStyleLevel()

  当指定题注标签包含章节号时，返回用来标记新章节的标题样式

  返回：
    章节的标题样式

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         System.out.println(label.getChapterStyleLevel());

### getName

    public java.lang.String getName()

  返回名称

  返回：
    名称

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.getName();

### getNumberStyle

    public int getNumberStyle()

  返回编号样式

  返回：
    编号样式

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.getNumberStyle();

### getPosition

    public int getPosition()

  返回题注标签文本的位置

  返回：
    题注标签文本的位置

                  为CAPTION_POSITION_ABOVE时，在项目的上方；
                  为CAPTION_POSITION_BELOW时，在项目的下方。

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.isPosition();

### isIncludeChapterNumber

    public boolean isIncludeChapterNumber()

  返回是否包含章节号

  返回：

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.isIncludeChapterNumber();

### setChapterStyleLevel

    public void setChapterStyleLevel(int chapterStyleLevel)

  当指定题注标签包含章节号时，用来标记新章节的标题样式

  参数：
    `chapterStyleLevel` - 章节的标题样式

                     CHAPTER1  标题1
                     CHAPTER2  标题2
                     CHAPTER3  标题3
                     .. ...
                     CHAPTER9  标题9

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.setIncludeChapterNumber(true);
         label.setChapterStyleLevel(CaptionConstants.CHAPTER1);
         System.out.println(label.getChapterStyleLevel());

  抛出：
    `MacroRunException` - 当参数小于0或者大于8时

### setIncludeChapterNumber

    public void setIncludeChapterNumber(boolean includeChapterNumber)

  设置标识包含章节号

  参数：
    `includeChapterNumber` -

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.setIncludeChapterNumber(true);

### setNumberStyle

    public void setNumberStyle(int numberStyle)

  设置编号样式

  参数：
    `numberStyle` - 编号样式

                    "1,2,3, …"
                    "a,b,c,…"
                    "A,B,C,…"
                    "i,ii,iii, …"
                    "I,II,III,…"
                    "一,二,三(简) …"
                    "壹,贰,叁 …"
                    "甲,乙,丙 …"
                    "子,丑,寅 …"

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.setNumberStyle(CaptionConstants.ARABIC_NUMBER);

### setPosition

    public void setPosition(int position)

  设置题注标签文本的位置

  参数：
    `position` - 为CAPTION_POSITION_ABOVE时，在项目的上方； 为CAPTION_POSITION_BELOW时，在项目的下方。

    例子：

         CaptionLabels captionLabels=Application.getCaptionLabels();
         CaptionLabel label=captionLabels.addCaptionLabel("dd");
         label.setPosition(CaptionConstants.CAPTION_POSITION_ABOVE);

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

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

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