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 Section

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

public class Section
extends java.lang.Object

此类封装了章节的属性，是一个容器，管理页眉页脚，脚注尾注，正文。

Method Summary
`BaseText` | `getBaseText()` 返回当前章节的正文部分。
`Column` | `getColumn()` 获得当前章节的分栏对象。
`EndNote` | `getEndNote(int index)` 返回当前章节的尾注部分。
`int` | `getEndNoteCount()` 获得当前章节的尾注个数。
`Footer` | `getFooter()` 返回当前章节的默认页脚（每一页的页脚都相同）。
`Footer` | `getFooter(int footerType)` 返回当前章节的指定页脚。
`FootNote` | `getFootNote(int index)` 返回当前章节的脚注部分。
`int` | `getFootNoteCount()` 获得当前章节的脚注个数。
`Header` | `getHeader()` 返回当前章节的默认页眉（每一页的页眉都相同）。
`Header` | `getHeader(int headerType)` 返回当前章节的指定页眉。
`WpPageSetup` | `getPageSetup()` 得到当前章节的页面设置属性集。
`void` | `insertPageBreak(long offset)` 在当前章节指定位置后插入页分隔符。
`void` | `insertPageBreak(long offset, FontAttribute fontAttribute)` 在当前章节指定位置后插入带有字体属性的页分隔符。
`void` | `insertPageNumbers(PageNumbersAttribute pageNumbersAttribute)` 插入带有页码属性的页码。
`void` | `setBorder(WpBaseBorderAttribute baseBorderAttribute)` 为整个章节设置一个边框。

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

Method Detail

### getBaseText

    public BaseText getBaseText()

  返回当前章节的正文部分。

  Returns:
    BaseText类，即当前章节的正文

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();

  See Also:
    `BaseText`

### getColumn

    public Column getColumn()

  获得当前章节的分栏对象。

  Returns:
    Column类，即本章节的分栏对象

    例子:

         //首先在正文输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnWidthAt(0, 100.0f);
         column.setColumnWidthAt(1, 200.0f);
         column.setColumnWidthAt(2, 100.0f);
         column.apply();

  See Also:
    `Column`

### getEndNote

    public EndNote getEndNote(int index)

  返回当前章节的尾注部分。

  Parameters:
    `index` - 得到的是第几个尾注 注：index的起始位置为0，如果没有尾注，就返回异常，如果index大于等于尾注的总数，也返回一个异常。 注： EIO刚启动时只有正文、页眉、页脚这三个部分，而脚注、尾注部分必须在以后由用户自己插入。
  Returns:
    EndNote类，即索引值指定的某一个尾注

    例子:

         //首先插入尾注并输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         EndNote endNote = section.getEndNote(0);

  See Also:
    `getFootNote(int)`, `EndNote`

### getEndNoteCount

    public int getEndNoteCount()

  获得当前章节的尾注个数。

  Returns:
    当前章节的尾注个数。

### getFooter

    public Footer getFooter()

  返回当前章节的默认页脚（每一页的页脚都相同）。

  Returns:
    Footer类，即当前章节的默认页脚

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Footer footer = section.getFooter();

  See Also:
    `getFooter(int)`, `getHeader()`, `getHeader(int)`, `Footer`

### getFooter

    public Footer getFooter(int footerType)

  返回当前章节的指定页脚。 注：页脚可分为首页不同，奇数页不同，偶数页不同三种不同的形式。

  Parameters:
    `footerType` - 指定当前章节的页脚属于哪一种形式

               HeaderFooterConstants.FIRST_PAGE        首页不同
               HeaderFooterConstants.ODD        奇数页不同
               HeaderFooterConstants.EVEN        偶数页不同

  Returns:
    Footer类，即当前章节的指定页脚

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Footer oddfooter = section.getFooter(HeaderFooterConstants.ODD);

  See Also:
    `getFooter()`, `getHeader()`, `getHeader(int)`, `Footer`

### getFootNote

    public FootNote getFootNote(int index)

  返回当前章节的脚注部分。

  Parameters:
    `index` - 得到的是第几个脚注 注：index的起始位置为0，如果没有脚注，就返回异常，如果index大于等于脚注的总数，也返回一个异常。 注： EIO刚启动时只有正文、页眉、页脚这三个部分，而脚注、尾注部分必须在以后由用户自己插入。
  Returns:
    FootNote类，即索引值指定的某一个脚注

    例子:

         //首先插入脚注并输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         FootNote footNote = section.getFootNote(0);

  See Also:
    `getEndNote(int)`, `FootNote`

### getFootNoteCount

    public int getFootNoteCount()

  获得当前章节的脚注个数。

  Returns:
    当前章节的脚注个数。

### getHeader

    public Header getHeader()

  返回当前章节的默认页眉（每一页的页眉都相同）。

  Returns:
    Header类，即当前章节的默认页眉

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Header header = section.getHeader();

  See Also:
    `getHeader(int)`, `getFooter()`, `getFooter(int)`, `Header`

### getHeader

    public Header getHeader(int headerType)

  返回当前章节的指定页眉。 注：页眉可分为首页不同，奇数页不同，偶数页不同三种不同的形式。

  Parameters:
    `headerType` - 指定当前章节的页眉属于哪一种形式

               HeaderFooterConstants.FIRST_PAGE        首页不同
               HeaderFooterConstants.ODD        奇数页不同
               HeaderFooterConstants.EVEN        偶数页不同

  Returns:
    Header类，即当前章节的指定页眉

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Header oddheader = section.getHeader(HeaderFooterConstants.ODD);

  See Also:
    `getHeader()`, `getFooter()`, `getFooter(int)`, `Header`

### getPageSetup

    public WpPageSetup getPageSetup()

  得到当前章节的页面设置属性集。

  Returns:
    WpPageSetup类，即前章节的页面设置属性集

    例子:

         //首先在正文输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageHeight(500.0f);
         pageSetup.setPageWidth(500.0f);
         pageSetup.apply();

  See Also:
    `WpPageSetup`

### insertPageBreak

    public void insertPageBreak(long offset)

  在当前章节指定位置后插入页分隔符。 注：插入分隔符后，当前页后增加了新的一页，分隔符后的文本移到新页上。

  Parameters:
    `offset` - 需要插入页分隔符的位置（起始位置为0）

    例子:

         //首先在正文输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         section.insertPageBreak(5)

  See Also:
    `insertPageBreak(long,FontAttribute)`, `FontAttribute`

### insertPageBreak

    public void insertPageBreak(long offset,
                                FontAttribute fontAttribute)

  在当前章节指定位置后插入带有字体属性的页分隔符。 注：插入分隔符后，当前页后增加了新的一页，分隔符后的文本移到新页上。

  Parameters:
    `offset` - 需要插入页分隔符的位置（起始位置为0）
    `fontAttribute` - 页分隔符的字体属性

    例子:

         //首先在正文输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         FontAttribute font = new FontAttribute();
         font.setBold(true);
         font.setFontSize(14);
         section.insertPageBreak(5,font)

  See Also:
    `insertPageBreak(long)`, `FontAttribute`

### insertPageNumbers

    public void insertPageNumbers(PageNumbersAttribute pageNumbersAttribute)

  插入带有页码属性的页码。

  Parameters:
    `pageNumbersAttribute` - 插入页码的页码属性（如：页码的位置，页码对齐方式，设置是否首页显示页号等）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         PageNumbersAttribute pageNumbersAttribute = new PageNumbersAttribute();
         pageNumbersAttribute.setPosition(1);
        	pageNumbersAttribute.setAlignment(2);
        	pageNumbersAttribute.setShowFirstPageNumber(true);
          pageNumbersAttribute.setIncludeChapterNumber(false);
          pageNumbersAttribute.setHeadingLeverForCharpter(0);
          pageNumbersAttribute.setChapterPageSeparator(0);
          pageNumbersAttribute.setContinuePreviousSection(true);
          pageNumbersAttribute.setStartingNumber(1);
          pageNumbersAttribute.setPageNumberFormat(0);
          section.insertPageNumbers(pageNumbersAttribute);

  See Also:
    `PageNumbersAttribute`

### setBorder

    public void setBorder(WpBaseBorderAttribute baseBorderAttribute)

  为整个章节设置一个边框。

  Parameters:
    `baseBorderAttribute` - 所设置的边框属性

    例子:

         //首先在正文输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpBaseBorderAttribute wpBaseBorder = new WpBaseBorderAttribute();
         wpBaseBorder.setBordersApplyType(BorderAndShadingConstants.APPLY_SECTION);
         wpBaseBorder.setSideBorderValid(BorderAndShadingConstants.TOP,true);
         wpBaseBorder.setOptionTop(2);
         wpBaseBorder.setBorderType(BorderAndShadingConstants.BORDERTYPE_THREED);
         section.setBorder(wpBaseBorder);

  See Also:
    `AbstractText`, `Document`, `WpBaseBorderAttribute`

Overview | Package | Class | Tree | Index | Help

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

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