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 ShadingAttribute

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

public class ShadingAttribute
extends java.lang.Object

背景属性。

Constructor Summary
`ShadingAttribute()` 创建一个底纹属性实例。

Method Summary
`java.awt.Color` | `getBackground()` 获取底纹图案的的背景色。
`java.awt.Color` | `getForeground()` 获取底纹的前景色。
`int` | `getShadingApplyTo()` 得到底纹应用的类型。
`java.awt.Paint` | `getTexture()` 获取底纹的纹理。
`int` | `getTextureIndex()` 获取底纹图案索引。
`void` | `setBackground(java.awt.Color color)` 设置底纹图案的背景色，必须设置底纹图案和应用文本或段落才能有效。
`void` | `setBackground(int r, int g, int b)` 设置底纹图案的背景色，必须设置底纹图案和应用文本或段落才能有效。
`void` | `setForeground(java.awt.Color color)` 设置底纹的前景色，必须设置底纹图案和应用文本或段落才能有效。
`void` | `setForeground(int r, int g, int b)` 设置底纹图案的前景色，必须设置底纹图案和应用文本或段落才能有效。
`void` | `setShadingApplyTo(int shading)` 为文本或段落设置底纹效果，必须设置底文图文才能有效。
`void` | `setTexture(java.awt.Paint texture)` 设置底纹的纹理，必须设置底纹图案和应用文本或段落才能有效。
`void` | `setTextureIndex(int textureIndex)` 设置底纹图案，必须设置应用文本或段落才能有效。

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

Constructor Detail

### ShadingAttribute

    public ShadingAttribute()

  创建一个底纹属性实例。

  例子:

        application.workbooks.workbook.style.border.ShadingAttribute sa =
        new application.workbooks.workbook.style.border.ShadingAttribute();

Method Detail

### getBackground

    public java.awt.Color getBackground()

  获取底纹图案的的背景色。

  Returns:
    底纹图案的的背景色

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         sa.setBackground(Color.black);
         System.out.println(sa.getBackground());

  See Also:
    `setBackground(int, int, int)`, `setBackground(java.awt.Color)`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### getForeground

    public java.awt.Color getForeground()

  获取底纹的前景色。

  Returns:
    底纹的前景色

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setForeground(Color.black);
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         System.out.println(sa.getForeground());

  See Also:
    `setForeground(int, int, int)`, `setForeground(java.awt.Color)`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### getShadingApplyTo

    public int getShadingApplyTo()

  得到底纹应用的类型。

  Returns:
    底纹应用的类型，其常量和相应的值如下：
    APPLY_PARAGRAPH = 0（应用到段落）；
    APPLY_TEXT = 1（应用到正文）

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa=
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         System.out.println(sa.getShadingApplyTo());

  See Also:
    `setShadingApplyTo(int)`, `#setTextureIndex(int);`

### getTexture

    public java.awt.Paint getTexture()

  获取底纹的纹理。

  Returns:
    纹理对象

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         sa.setTexture((Paint)(Color.blue));
         System.out.println(sa.getTexture());

  See Also:
    `setTexture(java.awt.Paint)`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### getTextureIndex

    public int getTextureIndex()

  获取底纹图案索引。

  Returns:
    底纹图案索引，为整型数值

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa=
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         System.out.println(sa.getTextureIndex());

  See Also:
    `setTextureIndex(int)`, `setShadingApplyTo(int)`, `BorderAndShadingConstants`

### setBackground

    public void setBackground(java.awt.Color color)

  设置底纹图案的背景色，必须设置底纹图案和应用文本或段落才能有效。

  Parameters:
    `color` - 底纹图案的背景色

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         sa.setBackground(Color.black);
         System.out.println(sa.getBackground());

  See Also:
    `setBackground(int, int, int)`, `getBackground()`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### setBackground

    public void setBackground(int r,
                              int g,
                              int b)

  设置底纹图案的背景色，必须设置底纹图案和应用文本或段落才能有效。

  Parameters:
    `r` - 颜色中的红色数量
    `g` - 颜色中的绿色数量
    `b` - 颜色中的蓝色数量

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa=
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         sa.setBackground(10,9,8);
         System.out.println(sa.getBackground());

  See Also:
    `setBackground(java.awt.Color)`, `getBackground()`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### setForeground

    public void setForeground(java.awt.Color color)

  设置底纹的前景色，必须设置底纹图案和应用文本或段落才能有效。

  Parameters:
    `color` - 底纹的前景色，如Color.red

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         sa.setForeground(Color.black);
         System.out.println(sa.getForeground());

  See Also:
    `setForeground(int, int, int)`, `getForeground()`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### setForeground

    public void setForeground(int r,
                              int g,
                              int b)

  设置底纹图案的前景色，必须设置底纹图案和应用文本或段落才能有效。

  Parameters:
    `r` - 颜色中的红色数量
    `g` - 颜色中的绿色数量
    `b` - 颜色中的蓝色数量

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         sa.setForeground(10,9,8);
         System.out.println(sa.getForeground());

  See Also:
    `setForeground(java.awt.Color)`, `getForeground()`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### setShadingApplyTo

    public void setShadingApplyTo(int shading)

  为文本或段落设置底纹效果，必须设置底文图文才能有效。

  Parameters:
    `shading` - 底纹应用范围，其常量和相应的值如下：
    APPLY_PARAGRAPH = 0（应用到段落）；
    APPLY_TEXT = 1（应用到正文）

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa=
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);

  See Also:
    `getShadingApplyTo()`, `#setTextureIndex(int);`, `BorderAndShadingConstants`

### setTexture

    public void setTexture(java.awt.Paint texture)

  设置底纹的纹理，必须设置底纹图案和应用文本或段落才能有效。

  Parameters:
    `texture` - 纹理对象

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa =
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setTexture((Paint)(Color.blue));
         sa.setShadingApplyTo(1);
         sa.setTextureIndex(2);
         System.out.println(sa.getTexture());

  See Also:
    `getTexture()`, `setTextureIndex(int)`, `setShadingApplyTo(int)`

### setTextureIndex

    public void setTextureIndex(int textureIndex)

  设置底纹图案，必须设置应用文本或段落才能有效。

  Parameters:
    `textureIndex` - 底纹图案索引

    例子:

         application.workbooks.workbook.style.border.ShadingAttribute sa=
         new application.workbooks.workbook.style.border.ShadingAttribute();
         sa.setTextureIndex(23);
         sa.setShadingApplyTo(1);
         System.out.println(sa.getTextureIndex());

  See Also:
    `getTextureIndex()`, `setShadingApplyTo(int)`, `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 无锡永中科技有限公司