概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

## application.workbooks.workbook.style.phonetic
类 PhoneticAttribute

    java.lang.Object
      application.workbooks.workbook.style.phonetic.PhoneticAttribute

    public class PhoneticAttribute

extends java.lang.Object

拼音列表框内的属性设置。

构造函数摘要
`PhoneticAttribute()` 默认构建器

方法摘要
`int` | `getAlignment()` 取得拼音文字的对齐方式集
`java.lang.String[]` | `getBaseText()` 取得拼音列表框内的基准文字的集合。
`java.awt.Color` | `getFontColor()` 取得拼音文字颜色
`java.lang.String` | `getFontName()` 得到拼音字体名称
`int` | `getFontSize()` 得到拼音字体大小
`int` | `getOffset()` 取得拼音文字偏移量
`java.lang.String[]` | `getRubyText()` 取得拼音列表框内的拼音文字的集合。
`int[]` | `getToneText()` 取得拼音列表框内的拼音声调的集合。
`void` | `modifyRubyText(int baseTextIndex, java.lang.String rubyText, int tone)` 对拼音列表框中由baseTextIndex索引指定的拼音进行修改。
`void` | `removeAll()` 删除基准文字的所有拼音 例子: Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument(); Section section = doc.getSection(0); BaseText baseText = section.getBaseText(); PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3); phoneticAttr.removeAll(); baseText.setPhoneticAttribute(2,3,phoneticAttr);
`void` | `setAlignment(int type)` 设置拼音文字的对齐方式
`void` | `setFontColor(java.awt.Color color)` 设置拼音文字颜色
`void` | `setFontName(java.lang.String fontName)` 设置拼音字体名称
`void` | `setFontSize(int fontSize)` 设置拼音字体大小
`void` | `setOffset(int offset)` 设置拼音文字偏移量
`void` | `setRubyText(java.lang.String[] rubytext)` 设置拼音列表框内的拼音文字的集合。
`void` | `setToneText(int[] tonetext)` 设置拼音列表框内的拼音声调的集合。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

构造函数详细信息

### PhoneticAttribute

    public PhoneticAttribute()

  默认构建器

方法详细信息

### getAlignment

    public int getAlignment()

  取得拼音文字的对齐方式集

  返回：
    拼音文字的对齐方式集

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         System.out.println("当前拼音属性的对齐方式为："+phoneticAttr.getAlignment());

### getBaseText

    public java.lang.String[] getBaseText()

  取得拼音列表框内的基准文字的集合。注：拼音列表框中的拼音是由用户选择的一段文字而得到的。

  返回：
    返回拼音列表框内的基准文字的集合

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         String[] basetext = phoneticAttr.getBaseText();
         for (int i = 0; i < basetext.length; i++)
         {
             System.out.println("得到当前拼音属性列表框中第"+i+"个基准文字是："+basetext[i]);
         }

### getFontColor

    public java.awt.Color getFontColor()

  取得拼音文字颜色

  返回：
    拼音文字颜色

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         System.out.println("当前拼音属性的字体颜色为："+phoneticAttr.getFontColor());

### getFontName

    public java.lang.String getFontName()

  得到拼音字体名称

  返回：
    拼音字体名称

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         System.out.println("当前拼音属性的字体名为："+phoneticAttr.getFontName());

### getFontSize

    public int getFontSize()

  得到拼音字体大小

  返回：
    拼音字体大小

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         System.out.println("当前拼音属性的字体大小为："+phoneticAttr.getFontSize());

### getOffset

    public int getOffset()

  取得拼音文字偏移量

  返回：
    偏移量

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         System.out.println("当前拼音属性的偏移量为："+phoneticAttr.getOffset());

### getRubyText

    public java.lang.String[] getRubyText()

  取得拼音列表框内的拼音文字的集合。注：拼音列表框中的拼音是由用户选择的一段文字而得到的。

  返回：
    拼音列表框内的拼音文字的集合

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         String[] rubytext = phoneticAttr.getRubyText();
         for (int i = 0; i < rubytext.length; i++)
         {
             System.out.println("得到当前拼音属性列表框中第"+i+"个拼音文字是："+rubytext[i]);
         }

### getToneText

    public int[] getToneText()

  取得拼音列表框内的拼音声调的集合。注：拼音列表框中的拼音是由用户选择的一段文字而得到的。

  返回：
    返回拼音列表框内的拼音声调的集合

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         int[] tonetext = phoneticAttr.getToneText();
         for (int i = 0; i < tonetext.length; i++)
         {
             System.out.println("当前拼音属性第"+i+"个拼音文字的声调是："+tonetext[i]);
         }

### modifyRubyText

    public void modifyRubyText(int baseTextIndex,
                               java.lang.String rubyText,
                               int tone)

  对拼音列表框中由baseTextIndex索引指定的拼音进行修改。 注：拼音列表框中的拼音是由用户选择的一段文字而得到的。

  参数：
    `baseTextIndex` - 需要修改的拼音在选取的拼音属性中的位置（以0为初始位置）
    `rubyText` - 修改成的新的拼音
    `tone` - 需修改成的新的拼音的声调，只能取以下整型值之一：

         PhoneticConstants.LIGHT_TUNE = 0;    表示声调为轻声
         PhoneticConstants.FIRST_TUNE = 1;    表示声调为阴平
         PhoneticConstants.SECOND_TUNE = 2;   表示声调为阳平
         PhoneticConstants.THIRD_TUNE = 3;    表示声调为上声
         PhoneticConstants.FOURTH_TUNE = 4;   表示声调为去声

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         phoneticAttr.modifyRubyText(0,"bao",PhoneticConstants.FOURTH_TUNE);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

### removeAll

    public void removeAll()

  删除基准文字的所有拼音

  例子:

       Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
       phoneticAttr.removeAll();
       baseText.setPhoneticAttribute(2,3,phoneticAttr);

### setAlignment

    public void setAlignment(int type)

  设置拼音文字的对齐方式

  参数：
    `type` - 对齐方式

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         phoneticAttr.setAlignment(PhoneticConstants.ALIGNMENT_RIGHT);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

### setFontColor

    public void setFontColor(java.awt.Color color)

  设置拼音文字颜色

  参数：
    `color` - 拼音文字颜色

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         phoneticAttr.setFontColor(java.awt.Color.red);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

### setFontName

    public void setFontName(java.lang.String fontName)

  设置拼音字体名称

  参数：
    `fontName` - 拼音字体名称

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         phoneticAttr.setFontName("永中楷体");
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

### setFontSize

    public void setFontSize(int fontSize)

  设置拼音字体大小

  参数：
    `fontSize` - 拼音字体大小

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         phoneticAttr.setFontSize(16);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

### setOffset

    public void setOffset(int offset)

  设置拼音文字偏移量

  参数：
    `offset` - 偏移量

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         phoneticAttr.setOffset(10);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

  抛出：
    `MacroRunException` - 当指定偏移量超出[0, 100]的范围

### setRubyText

    public void setRubyText(java.lang.String[] rubytext)

  设置拼音列表框内的拼音文字的集合。注：拼音列表框中的拼音是由用户选择的一段文字而得到的。

  参数：
    `rubyText` - 拼音列表框内的拼音文字的集合

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         String[] rubytext = new String[]{"yong","gan","zhe"};
         phoneticAttr.setRubyText(rubytext);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

### setToneText

    public void setToneText(int[] tonetext)

  设置拼音列表框内的拼音声调的集合。注：拼音列表框中的拼音是由用户选择的一段文字而得到的。

  参数：
    `toneText` - 拼音列表框内的拼音声调的集合

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PhoneticAttribute phoneticAttr = baseText.getPhoneticAttribute(2,3);
         int[] tonetext = new int[]{PhoneticConstants.FIRST_TUNE,PhoneticConstants.FOURTH_TUNE,PhoneticConstants.LIGHT_TUNE};
         phoneticAttr.setToneText(tonetext);
         baseText.setPhoneticAttribute(2,3,phoneticAttr);

概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

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