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

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

## application.commandbars
类 CommandBarControl

    java.lang.Object
      application.commandbars.CommandBarControl

    public class CommandBarControl

extends java.lang.Object

代表一个命令栏控件。CommandBarControl 对象是 CommandBarControls 集合中的成员。

方法摘要
`void` | `delete()` 删除当前的控件。
`int` | `getID()` 返回控件的id。
`java.lang.String` | `getText()` 返回指定命令栏控件的题注文字。
`boolean` | `isEnabled()` 返回控件是否可以使用。
`boolean` | `isVisible()` 返回控件是否可见。
`void` | `setAction(int actionID)` 设置菜单项或工具栏项的动作类型。
`void` | `setAction(java.lang.String className)` 设置菜单项或工具栏项的动作类型，此动作类型为用户自己编写，必须是javax.swing.Action的实现类， 也可以直接继承application.commandbars包中的EIOAction类。
`void` | `setEnabled(boolean enable)` 设置控件是否可以使用。
`void` | `setIcon(int iconID)` 为控件设置office系统中已有的图标。
`void` | `setIcon(java.lang.String path)` 根据用户指定的图标路径设置图标。
`void` | `setText(java.lang.String text)` 设置指定命令栏控件的题注文字。
`void` | `setVisible(boolean visible)` 设置控件是否可见。

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

方法详细信息

### delete

    public void delete()

  删除当前的控件。

  例子:

       Application.getApplicationInstance();
       CommandBars bars = Application.getCommandBars();
       //删除"格式化"工具栏中最后一个可见控件
       CommandBarControls controls = bars.getCommandBar("formatting").getControls();
       controls.getControl(controls.getCount() -1).delete();

### getID

    public int getID()

  返回控件的id。

  返回：
    控件的id

    例子:

         //输出标准工具栏中所有控件的id
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("standard");
         CommandBarControl[] controls = bar.getControls().getAllControls();
         for (int i = 0; i < controls.length;i++)
         {
             System.out.println(controls[i].getID());
         }

### getText

    public java.lang.String getText()

  返回指定命令栏控件的题注文字。

  返回：
    控件的题注文字

    例子:

         //返回格式化工具栏中所有控件的文字。
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("formatting");
         System.out.println(bar.getControls().getCount());
         CommandBarControl[] controls = bar.getControls().getAllControls();
         System.out.println("aaa "+ controls.length);
         for (int i = 0; i < controls.length;i++)
         {
             System.out.println(controls[i].getText());
         }

### isEnabled

    public boolean isEnabled()

  返回控件是否可以使用。

  返回：
    控件能否使用

    例子:

         //判断标准工具栏中的控件能否使用
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("formatting");
         CommandBarControl[] controls = bar.getControls().getAllControls();
         for (int i = 0; i < controls.length;i++)
         {
             System.out.println(controls[i].isEnabled());
         }

### isVisible

    public boolean isVisible()

  返回控件是否可见。

  返回：
    控件是否可见

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBar("formatting");
         CommandBarControl control = bar.getControls().getControl(0);
         System.out.println(control.isVisible());

### setAction

    public void setAction(int actionID)

  设置菜单项或工具栏项的动作类型。

  参数：
    `actionID` - 动作类型ID

    例子:

         Application.getApplicationInstance();
         CommandBars bars = Application.getCommandBars();
         //设置"文件"菜单中"保存"菜单项的action为"打开"
         CommandBarControls controls = bars.getCommandBar("file").getControls();
         controls.getControl(5).setAction(ActionNameConstants.FILE_OPEN);
         //设置标准工具栏中第三个控件的action为"打开"
         CommandBarControls controls2 = bars.getCommandBar("标准").getControls();
         controls2.getControl(2).setAction(ActionNameConstants.FILE_OPEN);

### setAction

    public void setAction(java.lang.String className)
                   throws java.lang.ClassNotFoundException

  设置菜单项或工具栏项的动作类型，此动作类型为用户自己编写，必须是javax.swing.Action的实现类， 也可以直接继承application.commandbars包中的EIOAction类。

  参数：
    `className` - 用户指定的动作类名，必须包含包名
  抛出：
    `java.lang.ClassNotFoundException` - 如果无法找到对应的类。

    例子:

         CommandBarControls controls = bars.getCommandBar("file").getControls();
         try
         {
             controls.getControl(5).setAction("testaction.TestAction");
         }
         catch(ClassNotFoundException e)
         {
             e.printStackTrace();
         }

### setEnabled

    public void setEnabled(boolean enable)

  设置控件是否可以使用。控件必须在当前状态下可以使用，对于当前状态下无法使用的控件，设置此属性为true时，控件仍然无法使用。

  参数：
    `enable` - 控件能否使用

    例子:

         //设置标准工具栏中所有的控件无法使用
         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("formatting");
         CommandBarControl[] controls = bar.getControls().getAllControls();
         for (int i = 0; i < controls.length;i++)
         {
             controls[i].setEnabled(false);
         }

### setIcon

    public void setIcon(int iconID)

  为控件设置office系统中已有的图标。

  参数：
    `iconID` - 图标id,可以参考ImageIconConstants常量类。

    例子:

         Application.getApplicationInstance();
         CommandBars bars = Application.getCommandBars();
         //设置"文件"菜单中"保存"子菜单的action为"打开"
         CommandBarControls controls = bars.getCommandBar("file").getControls();
         controls.getControl(5).setIcon(ImageIconConstants.FORMATTING_BOLD);

  另请参见：
    `ImageIconConstants`

### setIcon

    public void setIcon(java.lang.String path)

  根据用户指定的图标路径设置图标。当前只支持"jpg"、"gif"、"png"三种类型的图标，如果设置其它类型图片作为图标，则无效果。

  参数：
    `path` - 图标路径

    例子:

         Application.getApplicationInstance();
         CommandBars bars = Application.getCommandBars();
         //修改"文件"菜单中"保存"菜单项的图标
         CommandBarControls controls = bars.getCommandBar("file").getControls();
         controls.getControl(5)..setIcon("C:\\WINDOWS\\Blue Lace 16.bmp")

  另请参见：
    `ImageIconConstants`

### setText

    public void setText(java.lang.String text)

  设置指定命令栏控件的题注文字。

  参数：
    `text` - 控件文本

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBar("formatting");
         CommandBarControl control = bar.getControls().getControl(0);
         control.setText("aaa");

### setVisible

    public void setVisible(boolean visible)

  设置控件是否可见。

  参数：
    `visible` - 控件是否可见

    例子:

         CommandBar bar = Application.getCommandBars().getCommandBar("formatting");
         CommandBarControl control = bar.getControls().getControl(0);
         control.setVisible(false);

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

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

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