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.shapes
Class TextEffectFormat

    java.lang.Object
      application.workbooks.workbook.shapes.TextEffectFormat

public class TextEffectFormat
extends java.lang.Object

该类定义了对艺术字对象进行操作的一些方法，如设置艺术字的类型，对齐方式，艺术字形状和艺术字模式等。

Method Summary
`int` | `getAlignType()` 获取艺术字的对齐方式。
`int` | `getMode()` 获取当前艺术字的形状。
`double` | `getPitch()` 获取艺术字的字间距。
`java.lang.String` | `getText()` 获取艺术字文本。
`int` | `getType()` 得到当前艺术字的类型。
`boolean` | `isEqualHeight()` 判断艺术字是否相同高度。
`boolean` | `isErect()` 判断艺术字是否为垂直竖排。
`void` | `setAlignType(int alignType)` 设置艺术字的对齐方式。
`void` | `setEqualHeight(boolean equal)` 设置艺术字为相同高度。
`void` | `setErect(boolean isErect)` 设置艺术字是否垂直竖排。
`void` | `setMode(int mode)` 设置当前艺术字的形状。
`void` | `setPitch(int type, double pitch)` 设置艺术字的字间距。
`void` | `setText(java.lang.String text)` 设置艺术字文本。
`void` | `setText(java.lang.String text, java.lang.String fontName, int fontStyle, int fontSize)` 设置艺术字文本。
`void` | `setType(int type)` 设置当前艺术字的类型。

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

Method Detail

### getAlignType

    public int getAlignType()

  获取艺术字的对齐方式。

  Returns:
    艺术字的对齐方式，为整型数值，如果艺术字的文本对齐方式为“左对齐”，返回1；如果艺术字的文本对齐方式为“居中对齐”，返回2；如果艺术字的文本对齐方式为“右对齐”，返回3；如果艺术字的文本对齐方式为“伸展对齐”，返回4

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字是第"+txteffect.getAlignType()+"种对齐方式") ;

### getMode

    public int getMode()

  获取当前艺术字的形状。

  Returns:
    艺术字的形状，为整型数值

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的模式是"+txteffect.getMode()+"种")  ;

### getPitch

    public double getPitch()

  获取艺术字的字间距。

  Returns:
    艺术字的字间距，为double型

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的间距是"+txteffect.getPitch()) ;

### getText

    public java.lang.String getText()

  获取艺术字文本。

  Returns:
    艺术字文本

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的文本内容是"+txteffect.getText()) ;

### getType

    public int getType()

  得到当前艺术字的类型。

  Returns:
    艺术字的类型

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字的类型是"+txteffect.getType()+"种") ;

### isEqualHeight

    public boolean isEqualHeight()

  判断艺术字是否相同高度。

  Returns:
    布尔型值，如果艺术字为相同高度，返回true；否则，返回false

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字字母高度是否等高"+txteffect.isEqualHeight()) ;

### isErect

    public boolean isErect()

  判断艺术字是否为垂直竖排。

  Returns:
    布尔型值，如果艺术字垂直竖排，返回true；否则，返回false

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         javax.swing.JOptionPane.showMessageDialog(null,"当前艺术字是否坚排"+txteffect.isErect()) ;

### setAlignType

    public void setAlignType(int alignType)

  设置艺术字的对齐方式。

  Parameters:
    `alignType` - 对齐类型索引值，如为1，表示左对齐；如为2，表示居中对齐；如为3，表示右对齐；如为4，表示伸展对齐

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setAlignType(1) ;

### setEqualHeight

    public void setEqualHeight(boolean equal)

  设置艺术字为相同高度。

  Parameters:
    `equal` - 布尔型值，如为true，设置艺术字为相同高度；否则，不设置相同高度

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setEqualHeight(true) ;

### setErect

    public void setErect(boolean isErect)

  设置艺术字是否垂直竖排。

  Parameters:
    `isErect` - 布尔型值，如为true，设置艺术字垂直竖排；否则，水平方向排列

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setErect(true) ;

### setMode

    public void setMode(int mode)

  设置当前艺术字的形状。

  Parameters:
    `mode` - 艺术字的形状

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setMode(2) ;

### setPitch

    public void setPitch(int type,
                         double pitch)

  设置艺术字的字间距。

  Parameters:
    `type` - 艺术字的类型，为整型数值
    `pitch` - 艺术字的间距，为double型

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setPitch(1,2.0) ;

### setText

    public void setText(java.lang.String text)

  设置艺术字文本。

  Parameters:
    `text` - 艺术字的文本

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setText("春夏秋冬") ;

### setText

    public void setText(java.lang.String text,
                        java.lang.String fontName,
                        int fontStyle,
                        int fontSize)

  设置艺术字文本。

  Parameters:
    `text` - 艺术字的文本
    `fontName` - 字体的名称
    `fontStyle` - 字型，为整型数值，1表示黑体，2表示斜体
    `fontSize` - 字体的大小

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setText("中华人民共和国","宋体",2,72) ;

### setType

    public void setType(int type)

  设置当前艺术字的类型。

  Parameters:
    `type` - 艺术字的类型，为整型数值

    例子:

         Shapes shapes = Application.getWorkbooks().getActiveWorkbook().getActiveShapes() ;
         Shape shape = shapes.getShape("艺术字 1") ;
         TextEffectFormat txteffect = shape.getTextEffectFormat() ;
         txteffect.setType(10) ;

Overview | Package | Class | Tree | Index | Help

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

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