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 TabStops

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

public class TabStops
extends java.lang.Object

该类定义了添加制表位，获取制表位和删除制表位的方法。

Method Summary
`void` | `addTabStop(int paragraphStartIndex, int paragraphEndIndex, TabStop tabStop)` 在指定多段落之间添加制表位。
`void` | `addTabStop(int paragraph, TabStop tabStop)` 在指定段落添加制表位。
`void` | `clearAllTabStops(int paragraph)` 删除指定段落的所有制表位。
`void` | `clearAllTabStops(int paragraphStartIndex, int paragraphEndIndex)` 删除指定段落之间的所有制表位。
`TabStop[]` | `getTabStop(int paragraph)` 在指定段落得到制表位数组。
`TabStop` | `getTabStop(int paragraph, int tabStopIndex)` 在指定段落得到指定的制表位。
`void` | `setDefaultTabStop(float value)` 设置默认制表位位置大小(默认单位是磅)。
`void` | `setDefaultTabStop(float value, int unit)` 设置默认制表位位置大小。

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

Method Detail

### addTabStop

    public void addTabStop(int paragraphStartIndex,
                           int paragraphEndIndex,
                           TabStop tabStop)

  在指定多段落之间添加制表位。

  Parameters:
    `paragraphStartIndex` - 段落的起始索引号
    `paragraphEndIndex` - 段落的结束索引号
    `tabStop` - 插入的制表位

    例子:

         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,1,tabStop);

  See Also:
    `addTabStop(int,TabStop)`, `TabStop`

### addTabStop

    public void addTabStop(int paragraph,
                           TabStop tabStop)

  在指定段落添加制表位。

  Parameters:
    `paragraph` - 段落的索引号，表明在哪个段落添加制表位
    `tabStop` - 插入的制表位

    例子:

         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:
    `addTabStop(int,int,TabStop)`, `TabStop`

### clearAllTabStops

    public void clearAllTabStops(int paragraph)

  删除指定段落的所有制表位。

  Parameters:
    `paragraph` - 段落索引号

    例子:

         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);
         tabStops.clearAllTabStops(0);

  See Also:
    `clearAllTabStops(int,int)`

### clearAllTabStops

    public void clearAllTabStops(int paragraphStartIndex,
                                 int paragraphEndIndex)

  删除指定段落之间的所有制表位。

  Parameters:
    `paragraphStartIndex` - 段落起始索引号
    `paragraphEndIndex` - 段落结束索引号

    例子:

         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,1,tabStop);
         tabStops.clearAllTabStops(0,1);

  See Also:
    `clearAllTabStops(int)`

### getTabStop

    public TabStop[] getTabStop(int paragraph)

  在指定段落得到制表位数组。

  Parameters:
    `paragraph` - 段落的索引号，在指定的段落的制表位数组
  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);
         System.out.println(tabStops.getTabStop(0)[0]);

  See Also:
    `TabStop`

### getTabStop

    public TabStop getTabStop(int paragraph,
                              int tabStopIndex)

  在指定段落得到指定的制表位。

  Parameters:
    `paragraph` - 段落的索引号，在指定的段落的制表位
    `tabStopIndex` - 在指定段落中的制表位索引号
  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);
         System.out.println(tabStops.getTabStop(0,0));

  See Also:
    `TabStop`

### setDefaultTabStop

    public void setDefaultTabStop(float value)

  设置默认制表位位置大小(默认单位是磅)。

  Parameters:
    `value` - 需要设置默认制表位的大小

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         tabStops.setDefaultTabStop(3.0f);

  See Also:
    `setDefaultTabStop(float,int)`

### setDefaultTabStop

    public void setDefaultTabStop(float value,
                                  int unit)

  设置默认制表位位置大小。

  Parameters:
    `value` - 需要设置默认制表位的大小，为float型
    `unit` - 度量单位，其常量和相应的值如下：

         UnitConstants.INCH = 0（英寸）；
         UnitConstants.CENTIMETER = 1（厘米）；
         UnitConstants.MILLIMETER = 2（毫米）；
         UnitConstants.POINT = 3（磅）；
         UnitConstants.PICA = 4（十二点活字）

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         TabStops tabStops = baseText.getTabStops();
         tabStops.setDefaultTabStop(3.0f,UnitConstants.CENTIMETER);

  See Also:
    `setDefaultTabStop(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 无锡永中科技有限公司