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.tabstops
Class TabStop

    java.lang.Object
      application.workbooks.workbook.documents.document.tabstops.TabStop

public class TabStop
extends java.lang.Object

该类定义了制表位的属性。

Constructor Summary
`TabStop()` 创建一个制表位。
`TabStop(float position, int alignment, int leader)` 设置制表位。
`TabStop(float position, int unit, int alignment, int leader)` 设置制表位。

Method Summary
`void` | `clearTabStop()` 删除制表位。
`int` | `getAlignment()` 获得对齐方式。
`int` | `getLeader()` 返回前导符索引。
`float` | `getPosition()` 返回制表位的位置大小（默认以P磅为单位)。
`float` | `getPosition(int unit)` 返回制表位的在相应单位下的位置大小。
`int` | `getUnit()` 获取度量单位。
`void` | `setAlignment(int alignment)` 设置制表位的对齐方式。
`void` | `setLeader(int leader)` 设置制表位的前导符索引。
`void` | `setPosition(float position)` 设置制表位的位置,默认以磅为单位。
`void` | `setPosition(float position, int unit)` 设置制表位的位置。

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

Constructor Detail

### TabStop

    public TabStop()

  创建一个制表位。

### TabStop

    public TabStop(float position,
                   int alignment,
                   int leader)

  设置制表位。

Parameters:
  `position` - 需要设置制表位的位置大小（默认以磅为单位）
  `alignment` - 需要设置制表位的对齐方式
  `leader` - 设置制表位的前导符索引

### TabStop

    public TabStop(float position,
                   int unit,
                   int alignment,
                   int leader)

  设置制表位。

Parameters:
  `position` - 需要设置制表位的位置大小（默认以磅为单位）
  `unit` - 度量单位

       UnitConstants.INCH            英寸
       UnitConstants.CENTIMETER      厘米
       UnitConstants.MILLIMETER      毫米
       UnitConstants.POINT           磅
       UnitConstants.PICA            十二点活字

  `alignment` - 需要设置制表位的对齐方式
  `leader` - 设置制表位的前导符索引

Method Detail

### clearTabStop

    public void clearTabStop()

  删除制表位。

  例子:

       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       TabStops tabStops = baseText.getTabStops();
       TabStop tabStop  = new TabStop();
       tabStop.setAlignment(TabStopConstants.RIGHT);
       tabStop.setLeader(TabStopConstants.DASHES);
       tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
       tabStops.addTabStop(0,tabStop);
       TabStop tabStop2 = tabStops.getTabStop(0,0);
       tabStop2.clearTabStop();

### getAlignment

    public int getAlignment()

  获得对齐方式。

  Returns:
    对齐方式

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);
         TabStop tabStop2 = tabStops.getTabStop(0,0);
         System.out.println(tabStop2.getAlignment());

### getLeader

    public int getLeader()

  返回前导符索引。

  Returns:
    前导符索引

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);
         TabStop tabStop2 = tabStops.getTabStop(0,0);
         System.out.println(tabStop2.getLeader());

### getPosition

    public float getPosition()

  返回制表位的位置大小（默认以P磅为单位)。

  Returns:
    制表位的位置大小

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);
         TabStop tabStop2 = tabStops.getTabStop(0,0);
         System.out.println(tabStop2.getPosition());

### getPosition

    public float getPosition(int unit)

  返回制表位的在相应单位下的位置大小。

  Parameters:
    `unit` - 度量单位

         UnitConstants.INCH            英寸
         UnitConstants.CENTIMETER      厘米
         UnitConstants.MILLIMETER      毫米
         UnitConstants.POINT           磅
         UnitConstants.PICA            十二点活字

  Returns:
    制表位的位置大小

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);
         TabStop tabStop2 = tabStops.getTabStop(0,0);
         System.out.println(tabStop2.getPosition(UnitConstants.CENTIMETER));

### getUnit

    public int getUnit()

  获取度量单位。

  Returns:
    度量单位

            0     表示英寸
            1     表示厘米
            2     表示毫米
            3     表示磅
            4     表示十二点活字

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);
         TabStop tabStop2 = tabStops.getTabStop(0,0);
         System.out.println(tabStop2.getUnit());

### setAlignment

    public void setAlignment(int alignment)

  设置制表位的对齐方式。

  Parameters:
    `alignment` - 对齐方式的类型

         TabStopConstants.LEFT       居左
         TabStopConstants.RIGHT      居右
         TabStopConstants.CENTER     居中

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);

  See Also:
    `TabStopConstants`

### setLeader

    public void setLeader(int leader)

  设置制表位的前导符索引。

  Parameters:
    `leader` - 前导符索引

         TabStopConstants.SPACES      导符  无
         TabStopConstants.DOTS        导符  ...
         TabStopConstants.DASHES      导符  ---
         TabStopConstants.LINES       导符  ___
         TabStopConstants.MIDDLEDOTS  导符  ...(点居中）

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);

  See Also:
    `TabStopConstants`

### setPosition

    public void setPosition(float position)

  设置制表位的位置,默认以磅为单位。

  Parameters:
    `position` - 需要设置制表位的位置大小

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(30.0f);
         tabStops.addTabStop(0,tabStop);

  See Also:
    `setPosition(float,int)`, `UnitConstants`

### setPosition

    public void setPosition(float position,
                            int unit)

  设置制表位的位置。

  Parameters:
    `position` - 需要设置制表位的位置大小
    `unit` - 度量单位

         UnitConstants.INCH            英寸
         UnitConstants.CENTIMETER      厘米
         UnitConstants.MILLIMETER      毫米
         UnitConstants.POINT           磅
         UnitConstants.PICA            十二点活字

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         TabStop tabStop  = new TabStop();
         tabStop.setAlignment(TabStopConstants.RIGHT);
         tabStop.setLeader(TabStopConstants.DASHES);
         tabStop.setPosition(3.0f,UnitConstants.CENTIMETER);
         tabStops.addTabStop(0,tabStop);

  See Also:
    `setPosition(float)`, `UnitConstants`

Overview | Package | Class | Tree | Index | Help

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

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