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 Column

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

public class Column
extends java.lang.Object

该类定义了管理分栏的方法，包括设置分栏列数，栏宽，栏间距及获取栏宽等方法。

Method Summary
`void` | `apply()` 应用分栏（使当前分栏的设置有效）。
`int` | `getColumnCount()` 获取当前章节的分栏的列数。
`float` | `getColumnSpacing(int index)` 获取当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。
`float` | `getColumnWidth(int index)` 获取当前章节分栏的指定索引号的栏的宽度（以磅为单位）。
`boolean` | `isEqualsWidth()` 判断当前章节分栏的栏宽是否都相等。
`boolean` | `isLineBetween()` 判断当前章节分栏的栏间是否有分隔线。
`void` | `setColumnCount(int count)` 设置当前章节的分栏的列数。
`void` | `setColumnSpacingAt(int index, float spacing)` 设置当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。
`void` | `setColumnSpacingAt(int index, float spacing, int unit)` 设置当前章节分栏的指定索引号的栏与相邻右栏的的栏间距离（默认以磅为单位，也可以以其他度量为单位）。
`void` | `setColumnWidthAt(int index, float width)` 设置当前章节分栏的指定索引号的栏的宽度（以磅为单位）。
`void` | `setColumnWidthAt(int index, float width, int unit)` 设置当前章节分栏的指定索引号的分栏的宽度（默认磅以为单位，也可以以其他度量为单位）。
`void` | `setEqualsWidth(boolean equal)` 设置当前章节分栏的栏位宽度是否相等。
`void` | `setLineBetween(boolean line)` 设置当前章节分栏的栏间是否有分隔线。

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

Method Detail

### apply

    public void apply()

  应用分栏（使当前分栏的设置有效）。

  例子:

       //请输入一些文字
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       Column column = section.getColumn();
       column.setColumnCount(3);
       column.setColumnWidthAt(1,20.0f);
       column.apply();

### getColumnCount

    public int getColumnCount()

  获取当前章节的分栏的列数。（注：只有调用了apply()方法后，setColumnCount(int)才起作用。）

  Returns:
    当前章节的分栏的列数

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.apply();
         int count = column.getColumnCount();
         System.out.println("当前章节分栏的列数为：" + count);

  See Also:
    `setColumnCount(int)`, `apply()`

### getColumnSpacing

    public float getColumnSpacing(int index)

  获取当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。（注：只有调用了apply()方法后，setColumnSpacingAt(int,float)才起作用。）

  Parameters:
    `index` - 分栏索引号，表示第几栏
  Returns:
    当前分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnSpacingAt(2,20.0f);
         column.apply();
         float spacing = column.getColumnSpacing(2);
         System.out.println("当前章节分栏的第二栏的间距为：" + spacing);

  See Also:
    `setColumnSpacingAt(int,float)`, `setColumnSpacingAt(int,float,int)`, `apply()`

### getColumnWidth

    public float getColumnWidth(int index)

  获取当前章节分栏的指定索引号的栏的宽度（以磅为单位）。（注：只有调用了apply()方法后，setColumnWidthAt(int,float)才起作用。）

  Parameters:
    `index` - 分栏索引号，表示第几栏
  Returns:
    当前分栏的指定索引号分栏的宽度（以磅为单位）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnWidthAt(2,50.0f);
         column.apply();
         float width = column.getColumnWidth(2);
         System.out.println("当前章节分栏的第二栏的宽度为：" + width);

  See Also:
    `setColumnWidthAt(int,float)`, `setColumnWidthAt(int,float,int)`, `apply()`

### isEqualsWidth

    public boolean isEqualsWidth()

  判断当前章节分栏的栏宽是否都相等。

  Returns:
    布尔型值，如果当前章节分栏的栏宽都相等，返回true；否则，返回false

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setEqualsWidth(true);
         column.apply();
         boolean isEqualsWidth = column.isEqualsWidth();
         System.out.println("当前章节分栏的栏宽是否都相等：" + isEqualsWidth);

  See Also:
    `setEqualsWidth(boolean)`

### isLineBetween

    public boolean isLineBetween()

  判断当前章节分栏的栏间是否有分隔线。

  Returns:
    布尔型值，如果当前章节分栏各栏之间有分隔线，返回true；否则，返回false

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setLineBetween(true);
         column.apply();
         boolean isLineBetween = column.isLineBetween();
         System.out.println("当前章节分栏的栏间是否有分隔线：" + isLineBetween);

  See Also:
    `setLineBetween(boolean)`

### setColumnCount

    public void setColumnCount(int count)

  设置当前章节的分栏的列数。（注：只有调用了apply()方法后，setColumnCount(int)方法才起作用。）

  Parameters:
    `count` - 要设置的分栏列数

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.apply();

  See Also:
    `getColumnCount()`, `apply()`

### setColumnSpacingAt

    public void setColumnSpacingAt(int index,
                                   float spacing)

  设置当前章节分栏的指定索引号的栏与相邻右栏的栏间距离（以磅为单位）。（注：只有调用了apply()方法后，setColumnSpacingAt(int,float)方法才起作用。）

  Parameters:
    `index` - 分栏索引号，表示第几栏
    `spacing` - 当前分栏的指定索引号分栏的间距（以磅为单位）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnSpacingAt(2,20.0f);
         column.apply();

  See Also:
    `getColumnSpacing(int)`, `setColumnSpacingAt(int,float,int)`, `apply()`

### setColumnSpacingAt

    public void setColumnSpacingAt(int index,
                                   float spacing,
                                   int unit)

  设置当前章节分栏的指定索引号的栏与相邻右栏的的栏间距离（默认以磅为单位，也可以以其他度量为单位）。（注：只有调用了apply()方法后，setColumnSpacingAt(int,float,int)方法才起作用。）

  Parameters:
    `index` - 分栏索引号，表示第几栏
    `spacing` - 当前分栏的指定索引号分栏的间距
    `unit` - 度量单位，其决定了分栏间距大小的真正值

              UnitConstants.INCH - 度量单位为英寸；
              UnitConstants.CENTIMETER - 度量单位为厘米；
              UnitConstants.MILLIMETER - 度量单位为毫米；
              UnitConstants.POINT - 度量单位为磅；
              UnitConstants.PICA - 度量单位为十二点活字

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnSpacingAt(2,2.0f,UnitConstants.MILLIMETER);
         column.apply();

  See Also:
    `getColumnSpacing(int)`, `setColumnSpacingAt(int,float)`, `apply()`, `UnitConstants`

### setColumnWidthAt

    public void setColumnWidthAt(int index,
                                 float width)

  设置当前章节分栏的指定索引号的栏的宽度（以磅为单位）。（注：只有调用了apply()方法后，setColumnWidthAt(int,float)方法才起作用。）

  Parameters:
    `index` - 分栏索引号，表示第几栏
    `width` - 当前分栏的指定索引号分栏的宽度（以磅为单位）

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnWidthAt(2,50.0f);
         column.apply();

  See Also:
    `getColumnWidth(int)`, `setColumnWidthAt(int,float,int)`, `apply()`

### setColumnWidthAt

    public void setColumnWidthAt(int index,
                                 float width,
                                 int unit)

  设置当前章节分栏的指定索引号的分栏的宽度（默认磅以为单位，也可以以其他度量为单位）。（注：只有调用了apply()方法后，setColumnWidthAt(int,float,int)方法才起作用。)

  Parameters:
    `index` - 分栏索引号，表示第几栏
    `width` - 当前分栏的指定索引号栏的宽度
    `unit` - 度量单位，其决定了分栏宽度大小的真正值

              UnitConstants.INCH - 度量单位为英寸；
              UnitConstants.CENTIMETER - 度量单位为厘米；
              UnitConstants.MILLIMETER - 度量单位为毫米；
              UnitConstants.POINT - 度量单位为磅；
              UnitConstants.PICA - 表示度量单位为十二点活字

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setColumnWidthAt(2,5.0f,UnitConstants.CENTIMETER);
         column.apply();

  See Also:
    `setColumnWidthAt(int,float)`, `getColumnWidth(int)`, `Utilities`, `UnitConstants`

### setEqualsWidth

    public void setEqualsWidth(boolean equal)

  设置当前章节分栏的栏位宽度是否相等。

  Parameters:
    `equal` - 布尔型值，如为true，设置当前章节分栏的栏位宽度相等；否则，设置当前章节分栏的栏位宽度不相等

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setEqualsWidth(true);
         column.apply();

  See Also:
    `isEqualsWidth()`, `setLineBetween(boolean)`

### setLineBetween

    public void setLineBetween(boolean line)

  设置当前章节分栏的栏间是否有分隔线。

  Parameters:
    `line` - 布尔型值，如为true，设置当前章节分栏各栏之间有分隔线；否则，当前章节分栏各栏之间无分隔线

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         Column column = section.getColumn();
         column.setColumnCount(3);
         column.setLineBetween(true);
         column.apply();

  See Also:
    `isLineBetween()`, `setEqualsWidth(boolean)`

Overview | Package | Class | Tree | Index | Help

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

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