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.style.border
Class BaseBorderAttribute

    java.lang.Object
      application.workbooks.workbook.style.border.BaseBorderAttribute

All Implemented Interfaces:
  BorderAndShadingConstants

Direct Known Subclasses:
  SsBorderAttribute, WpBaseBorderAttribute

public class BaseBorderAttribute
extends java.lang.Object
implements BorderAndShadingConstants

边框属性。

Field Summary

Fields inherited from interface application.constants.BorderAndShadingConstants
`ALL_BORDERS, APPLY_CELL, APPLY_PAGE, APPLY_PARAGRAPH, APPLY_SECTION, APPLY_TABLE, APPLY_TEXT, BORDERTYPE_ALL, BORDERTYPE_BOX, BORDERTYPE_CUSTOM, BORDERTYPE_GRID, BORDERTYPE_NONE, BORDERTYPE_SHADOW, BORDERTYPE_THREED, BOTTOM, BOTTOM_BORDER, BOTTOM_DOUBLE_BORDER, DEFAULT, DIAGONAL_BACKWARD, DIAGONAL_FORWARD, LEFT, LEFT_BORDER, LINESTYLE_DASHDOT, LINESTYLE_DASHDOTDOT, LINESTYLE_DASHLARGEGAP, LINESTYLE_DASHSMALLGAP, LINESTYLE_DOT, LINESTYLE_DOUBLE, LINESTYLE_SINGLE, LINESTYLE_THICKTHINLARGEGAP, LINESTYLE_THICKTHINMEDGAP, LINESTYLE_THICKTHINSMALLGAP, LINESTYLE_THINTHICKLARGEGAP, LINESTYLE_THINTHICKMEDGAP, LINESTYLE_THINTHICKSMALLGAP, LINESTYLE_THINTHICKTHINLARGEGAP, LINESTYLE_THINTHICKTHINMEDGAP, LINESTYLE_THINTHICKTHINSMALLGAP, LINESTYLE_TRIPLE, LINEWIDTH_025PT, LINEWIDTH_050PT, LINEWIDTH_075PT, LINEWIDTH_100PT, LINEWIDTH_150PT, LINEWIDTH_225PT, LINEWIDTH_300PT, LINEWIDTH_450PT, LINEWIDTH_600PT, MIDDLE_HORIZON, MIDDLE_VERTICAL, NO_BORDER, OUTSIDE_BORDERS, RIGHT, RIGHT_BORDER, TEXTURE_10PERCENT, TEXTURE_20PERCENT, TEXTURE_25PERCENT, TEXTURE_30PERCENT, TEXTURE_40PERCENT, TEXTURE_50PERCENT, TEXTURE_5PERCENT, TEXTURE_60PERCENT, TEXTURE_70PERCENT, TEXTURE_75PERCENT, TEXTURE_80PERCENT, TEXTURE_90PERCENT, TEXTURE_DARKDOWNWARDDIAGONAL, TEXTURE_DARKHORIZONTAL, TEXTURE_DARKUPWARDDIAGONAL, TEXTURE_DARKVERTICAL, TEXTURE_DASHEDDOWNWARDDIAGONAL, TEXTURE_DASHEDHORIZONTAL, TEXTURE_DASHEDUPWARDDIAGONAL, TEXTURE_DASHEDVERTICAL, TEXTURE_DIAGONALBRICK, TEXTURE_DIVOT, TEXTURE_DOTTEDDIAMOND, TEXTURE_DOTTEDGRID, TEXTURE_HORIZONTALBRICK, TEXTURE_LARGECHECKERBOARD, TEXTURE_LARGECONFETTI, TEXTURE_LARGEGRID, TEXTURE_LIGHTDOWNWARDDIAGONAL, TEXTURE_LIGHTHORIZONTAL, TEXTURE_LIGHTUPWARDDIAGONAL, TEXTURE_LIGHTVERTICAL, TEXTURE_NARROWHORIZONTAL, TEXTURE_NARROWVERTICAL, TEXTURE_OUTLINEDDIAMOND, TEXTURE_PLAID, TEXTURE_SHINGLE, TEXTURE_SMALLCHECKERBOARD, TEXTURE_SMALLCONFETTI, TEXTURE_SMALLGRID, TEXTURE_SOLIDDIAMOND, TEXTURE_SPHERE, TEXTURE_TRELLIS, TEXTURE_WAVE, TEXTURE_WEAVE, TEXTURE_WIDEDOWNWARDDIAGONAL, TEXTURE_WIDEUPWARDDIAGONAL, TEXTURE_ZIGZAG, THICK_BOTTOM_BORDER, THICK_BOX_BORDER, TOP, TOP_BOTTOM_BORDER, TOP_DOUBLE_BOTTOM_BORDER, TOP_THICK_BOTTOM_BORDER`

Constructor Summary
`BaseBorderAttribute()` 创建一个边框属性的实例。

Method Summary
`java.awt.Color` | `getBorderLineColor(int borderPosition)` 得到边框线颜色。
`int` | `getBorderLineType(int borderPosition)` 得到边框线类型。
`float` | `getBorderLineWidth(int borderPosition)` 得到边框线宽度。
`int` | `getBordersApplyType()` 得到边框应用范围。
`int` | `getBorderType()` 得到边框类型。
`boolean` | `isSideBorderValid(int borderPosition)` 判断边缘边框是否被应用。
`void` | `setBorderLineColor(int borderPosition, java.awt.Color color)` 设置边框线颜色。
`void` | `setBorderLineColor(int borderPosition, int r, int g, int b)` 设置边框线颜色。
`void` | `setBorderLineType(int borderPosition, int lineType)` 设置边框线条属性。
`void` | `setBorderLineWidth(int borderPosition, float width)` 设置边框线宽度。
`void` | `setBordersApplyType(int bordersApplyType)` 设置边框应用范围。
`void` | `setBorderType(int borderType)` 设置边框类型。
`void` | `setSideBorderValid(int borderPosition, boolean isValid)` 设置是否给选定内容应用边缘边框。

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

Constructor Detail

### BaseBorderAttribute

    public BaseBorderAttribute()

  创建一个边框属性的实例。

  例子:

       application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
       new application.workbooks.workbook.style.border.BaseBorderAttribute();

Method Detail

### getBorderLineColor

    public java.awt.Color getBorderLineColor(int borderPosition)

  得到边框线颜色。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
  Returns:
    边框线颜色

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineColor(2,10,9,8);
         System.out.println(BBA.getBorderLineColor());

  See Also:
    `setBorderLineColor(int borderPosition,int r,int g,int b)`, `getBorderLineColor(int borderPosition)`, `BorderAndShadingConstants`

### getBorderLineType

    public int getBorderLineType(int borderPosition)

  得到边框线类型。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
  Returns:
    边框线类型

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineType(2,3);
         System.out.println(BBA.getBorderLineType(2));

  See Also:
    `setBorderLineType(int borderPosition, int lineType)`, `BorderAndShadingConstants`

### getBorderLineWidth

    public float getBorderLineWidth(int borderPosition)

  得到边框线宽度。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
  Returns:
    边框线条宽度，为float型

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineWidth(2,(float)5) ;
         System.out.println(BBA.getBorderLineWidth(2));

  See Also:
    `setBorderLineWidth(int borderPosition, float width)`, `BorderAndShadingConstants`

### getBordersApplyType

    public int getBordersApplyType()

  得到边框应用范围。

  Returns:
    边框类型其常量和相应的值如下：

    APPLY_PARAGRAPH = 0（应用于段落）；

    APPLY_TXET = 1（应用于正文）；

    APPLY_TXET = 2（应用于章节）；

    APPLY_TXET = 2（应用于单元格）；

    APPLY_TXET = 3（应用于整个文档）；

    APPLY_TXET = 3（应用于表格）；

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBordersApplyType(2);
         System.out.println(BBA.getBordersApplyType());

  See Also:
    `setBordersApplyType(int bordersApplyType)`, `BorderAndShadingConstants`

### getBorderType

    public int getBorderType()

  得到边框类型。

  Returns:
    边框的类型，其常量和相应的值如下：

    BORDERTYPE_NONE = -1（表示无边框）；

    BORDERTYPE_BOX = 0（表示方框格式）；

    BORDERTYPE_SHADOW = 1（表示在所选内容四周加上边框，并应用预设的阴影格式）；

    BORDERTYPE_SHADOW = 1（当应用边框范围为单元格或表格时，表示在所选单元格加上边框，并应用预设的全部网格格式）；

    BORDERTYPE_THREED = 2（表示在所选内容四周加上边框，并应用预设的三维边框格式）；

    BORDERTYPE_SHADOW = 2（当应用边框范围为单元格或表格时，表示在所选单元格加上边框，并应用预设的网格格式）；

    BORDERTYPE_CUSTOM = 3（表示自定义格式）

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderType(1);
         System.out.println(BBA.getBordersType());

  See Also:
    `setBorderType(int borderType)`, `BorderAndShadingConstants`

### isSideBorderValid

    public boolean isSideBorderValid(int borderPosition)

  判断边缘边框是否被应用。

  Parameters:
    `borderPosition` - 边缘边框类型
  Returns:
    布尔型值，如果应用了指定的边缘边框，返回true；否则，返回false

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setSideBorderValid(1,true);
         System.out.println(BBA.isSideBorderValid(1));

  See Also:
    `setSideBorderValid(int borderPosition, boolean isValid)`, `BorderAndShadingConstants`

### setBorderLineColor

    public void setBorderLineColor(int borderPosition,
                                   java.awt.Color color)

  设置边框线颜色。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
    `color` - 边框线颜色，如Color.red

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineColor(2,Color.blue);
         System.out.println(BBA.getBorderLineColor(2));

  See Also:
    `setBorderLineColor(int borderPosition,int r,int g,int b)`, `getBorderLineColor(int borderPosition)`, `BorderAndShadingConstants`

### setBorderLineColor

    public void setBorderLineColor(int borderPosition,
                                   int r,
                                   int g,
                                   int b)

  设置边框线颜色。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
    `r` - 颜色中的红色数量
    `g` - 颜色中的绿色数量
    `b` - 颜色中的蓝色数量

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineColor(2,10,9,8);

  See Also:
    `setBorderLineColor(int borderPosition, Color color)`, `getBorderLineColor(int borderPosition)`

### setBorderLineType

    public void setBorderLineType(int borderPosition,
                                  int lineType)

  设置边框线条属性。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
    `lineType` - 线条类型

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineType(2,3);
         System.out.println(BBA.getBorderLineType(2));

  See Also:
    `getBorderLineType(int borderPosition)`, `BorderAndShadingConstants`

### setBorderLineWidth

    public void setBorderLineWidth(int borderPosition,
                                   float width)

  设置边框线宽度。

  Parameters:
    `borderPosition` - 边缘边框类型，其常量和相应的值如下：
    TOP = 0（上边缘边框）；
    LEFT = 1（左边缘边框）；
    RIGHT = 2（右边缘边框）；
    BOTTOM = 3（下边缘边框）；
    TOP = 4（中间水平线边框）；
    LEFT = 5（中间垂直线边框）；
    RIGHT = 6（左上对角线边框）；
    BOTTOM = 7（右上对角线边框）
    `width` - 边框线条的宽度，为float型

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderLineWidth(2,(float)5) ;
         System.out.println(BBA.getBorderLineWidth(2));

  See Also:
    `getBorderLineWidth(int borderPosition)`

### setBordersApplyType

    public void setBordersApplyType(int bordersApplyType)

  设置边框应用范围。

  Parameters:
    `bordersApplyType` - 边框类型(缺省是应用于段落)，其常量和相应的值如下：

    APPLY_PARAGRAPH = 0（应用于段落）；

    APPLY_TXET = 1（应用于正文）；

    APPLY_TXET = 2（应用于章节）；

    APPLY_TXET = 2（应用于单元格）；

    APPLY_TXET = 3（应用于整个文档）；

    APPLY_TXET = 3（应用于表格）；

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBordersApplyType(2);

  See Also:
    `getBordersApplyType()`, `BorderAndShadingConstants`

### setBorderType

    public void setBorderType(int borderType)

  设置边框类型。

  Parameters:
    `borderType` - 边框的类型，其常量和相应的值如下：

    BORDERTYPE_NONE = -1（表示无边框）；

    BORDERTYPE_BOX = 0（表示方框格式）；

    BORDERTYPE_SHADOW = 1（表示在所选内容四周加上边框，并应用预设的阴影格式）；

    BORDERTYPE_SHADOW = 1（当应用边框范围为单元格或表格时，表示在所选单元格加上边框，并应用预设的全部网格格式）；

    BORDERTYPE_THREED = 2（表示在所选内容四周加上边框，并应用预设的三维边框格式）；

    BORDERTYPE_SHADOW = 2（当应用边框范围为单元格或表格时，表示在所选单元格加上边框，并应用预设的网格格式）；

    BORDERTYPE_CUSTOM = 3（表示自定义格式）

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setBorderType(2);
         BBA.setSideBorderValid(BorderAndShadingConstants.TOP,true);
         PSelection().getShapeText().setBorderFormat(0,4,BBA);

  See Also:
    `getBorderType()`, `BorderAndShadingConstants`

### setSideBorderValid

    public void setSideBorderValid(int borderPosition,
                                   boolean isValid)

  设置是否给选定内容应用边缘边框。

  Parameters:
    `borderPosition` - 边缘边框类型
    `isValid` - 布尔型，如为true，应用指定的边缘边框；否则，不应用边缘边框

    例子:

         application.workbooks.workbook.style.border.BaseBorderAttribute   BBA=
         new application.workbooks.workbook.style.border.BaseBorderAttribute();
         BBA.setSideBorderValid(1,true);
         System.out.println(BBA.isSideBorderValid(1));

  See Also:
    `isSideBorderValid(int borderPosition)`, `BorderAndShadingConstants`

Overview | Package | Class | Tree | Index | Help

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

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