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

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

## application
类 CommandBars

    java.lang.Object
      application.CommandBars

    public final class CommandBars

extends java.lang.Object

该类为菜单和工具条的管理类

方法摘要
`CommandBar` | `addMenu(int index, char acceleratKey, java.lang.String name)` 新建菜单。
`CommandBar` | `addToolBar(java.lang.String name)` 新建工具条。
`void` | `delete(CommandBar bar)` 删除自定义工具条。
`void` | `delete(java.lang.String name)` 根据指定的名称删除自定义工具条。
`void` | `deleteByID(int ID)` 根据已知工具条ID删除自定义工具条。
`CommandBar` | `getCommandBar(java.lang.String name)` 根据指定的名称查找相应的CommandBar对象。
`CommandBar` | `getCommandBarForMenu(int id)` 根据菜单ID获得CommandBar对象。
`CommandBar` | `getCommandBarForToolBar(int id)` 根据工具栏ID获得CommandBar对象。
`int[]` | `getCustomBarIDs()` 获得所有自定义工具条的ID数组。
`CommandBar` | `getCustomCommandBar(int type, java.lang.String name)` 根据自定义工具条的类型和名称获得工具条对象。
`CommandBar` | `getPopMenuBarID(int ID)` 根据ID得到相应的右键菜单
`boolean` | `isLocked()` 返回主程序的工具条管理器的锁定状态。
`void` | `setLocked(boolean locked)` 设置主程序的工具条管理器的锁定状态。

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

方法详细信息

### addMenu

    public CommandBar addMenu(int index,
                              char acceleratKey,
                              java.lang.String name)

  新建菜单。

  参数：
    `index` - 新建菜单在菜单条上的位置
    `acceleratKey` - 新建菜单的助记符
    `caption` - 新建菜单的名称和显示文字。
  返回：
    新建的菜单

    例子:

         CommandBars bars = Application.getCommandBars();
         bars.addMenu(2, 'C', "Customized Menu");

### addToolBar

    public CommandBar addToolBar(java.lang.String name)

  新建工具条。

  参数：
    `name` - 新建工具条的名称
  返回：
    新建的工具条

    例子:

         CommandBars bars = Application.getCommandBars();
         bars.addToolBar("Customized ToolBar");

### delete

    public void delete(CommandBar bar)

  删除自定义工具条。

  参数：
    `bar` - CommandBar对象

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addToolBar("Customized ToolBar");
         bars.delete(bar);

### delete

    public void delete(java.lang.String name)

  根据指定的名称删除自定义工具条。

  参数：
    `name` - 名称

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addToolBar("Customized ToolBar");
         bars.delete("Customized ToolBar");

### deleteByID

    public void deleteByID(int ID)

  根据已知工具条ID删除自定义工具条。

  参数：
    `ID` - 工具条或菜单的ID

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addToolBar("Customized ToolBar");
         bars.deleteByID(bar.getID());

### getCommandBar

    public CommandBar getCommandBar(java.lang.String name)

  根据指定的名称查找相应的CommandBar对象。如果存在多个相同名称的commandbar对象，则返回最先查找到的。 对于菜单，如"file"、"edit"等，所获取的CommandBar是对应与当前应用，调用相关方法时，只作用于当前应用的菜单。

  参数：
    `name` - CommandBar名称

         //office菜单名称映射
             菜单ID                     英文名称     中文名称
         MenuIDConstants.FILE          "file"      "文件"
         MenuIDConstants.EDIT          "edit"      "编辑"
         MenuIDConstants.VIEW          "view"      "视图"
         MenuIDConstants.INSERT        "insert"    "插入"
         MenuIDConstants.FORMAT        "format"    "格式"
         MenuIDConstants.TOOL          "tool"      "工具"
         MenuIDConstants.SLIDE         "slide"     "幻灯片"
         MenuIDConstants.TABLE         "table"     "表格"
         MenuIDConstants.DATA          "data"      "数据"
         MenuIDConstants.WINDOW        "window"    "窗体"
         MenuIDConstants.HELP          "help"      "帮助"

         //office已有工具栏名称映射
             工具栏ID                            英文名称          中文名称
         BarConstants.MENU_BAR               "menu bar"          "菜单"
         BarConstants.STANDARD               "standard"          "标准"
         BarConstants.FORMATTING             "formatting"        "格式"
         BarConstants.CHART                  "chart"             "图表"
         BarConstants.WINDOW_LIST            "window list"       "窗口列表"
         BarConstants.OUTLINING              "outlining"         "大纲"
         BarConstants.SYMBOL                 "Symbol"            "符号"
         BarConstants.LIST                   "list"              "列表"
         BarConstants.FULL_SCREEN            "full screen"       "全屏"
         BarConstants.THREE_D_SETTINGS       "3d settings"       "三维设置"
         BarConstants.REVIEWING              "reviewing"         "审阅"
         BarConstants.PENMARK                "penmark"           "手写批注"
         BarConstants.PICTURE                "picture"           "图片"
         BarConstants.TEXT_BOX               "text box"          "文本框"
         BarConstants.FONT_EFFECT            "font effect"       "文字效果"
         BarConstants.WORDART                "wordart"           "艺术字"
         BarConstants.MAIL_MERGE             "mail merge"        "邮件合并"
         BarConstants.AUTOTEXT               "autotext"          "自动文集"
         BarConstants.AUTOSHAPE              "autoshape"         "自选图形"
         BarConstants.MACRO_EDITOR           "macro editor"      "宏编辑器"
         BarConstants.DRAWING                "drawing"           "绘图"
         BarConstants.SHADOW_SETTINGS        "shadow settings"   "阴影设置"
         BarConstants.DRAWING_CANVAS         "drawing canvas"    "绘图画布"
         BarConstants.SCIENTIST_EDIT         "scientist edit"    "科教编辑"
         BarConstants.CONTROL_TOOLBOX        "control toolbox"   "控件工具箱"
         BarConstants.ONLINEMEETING          "onlinemeeting"     "联机协作"
         BarConstants.STOP_RECORDING         "stop recording"    "停止宏录制"
         BarConstants.FUNCTION_PICTURE       "function picture"     "函数图像"
         BarConstants.TABLES_AND_BORDERS     "Tables and Borders"   "表格和边框"
         BarConstants.EXTENDED_FORMATTING    "extended formatting"  "扩展格式"

  返回：
    commandbar对象

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBar("file");
         System.out.println(bar.getName());

### getCommandBarForMenu

    public CommandBar getCommandBarForMenu(int id)

  根据菜单ID获得CommandBar对象。

  参数：
    `ID` - CommandBar对象的ID
  返回：
    CommandBar对象

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBarForMenu(MenuIDConstants.FILE);

### getCommandBarForToolBar

    public CommandBar getCommandBarForToolBar(int id)

  根据工具栏ID获得CommandBar对象。

  参数：
    `ID` - CommandBar对象的ID
  返回：
    CommandBar对象

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.getCommandBarForToolBar(BarConstants.STANDARD_INDEX);

### getCustomBarIDs

    public int[] getCustomBarIDs()

  获得所有自定义工具条的ID数组。

  返回：
    所有自定义工具条的ID数组

         CommandBars bars = Application.getCommandBars();
         CommandBar bar = bars.addToolBar("Customized ToolBar");
         int[] IDs = bars.getCustomBarIDs();

### getCustomCommandBar

    public CommandBar getCustomCommandBar(int type,
                                          java.lang.String name)

  根据自定义工具条的类型和名称获得工具条对象。

  参数：
    `type` - 工具条的类型，取值如下： 工具条： CommandBar.TOOLBAR
    `name` - 工具条的名称
  返回：
    符合条件的工具条对象

    例子:

         CommandBars bars = Application.getCommandBars();
         CommandBar bar1 = bars.addToolBar("Customized ToolBar");
         CommandBar cbs = bars.getCustomCommandBar(CommandBar.TOOLBAR, "Customized ToolBar");
         System.out.println(cbs.getName());

### getPopMenuBarID

    public CommandBar getPopMenuBarID(int ID)

  根据ID得到相应的右键菜单

  参数：
    `ID` - 右健菜单相应ID
  返回：
    右键菜单

    例子：

         CommandBar bar = Application.getCommandBars().getPopMenuBarID(PopupMenuBarIDConstants.POPPICTURE);

### isLocked

    public boolean isLocked()

  返回主程序的工具条管理器的锁定状态。

  返回：
    返回boolean　若为true　主程序的工具条管理器为锁定状态，否则没有锁定

    例子:

         CommandBars bars = Application.getCommandBars();
         bars.setLocked(false);
         System.out.print("主程序的工具条管理器的锁定状态为"+bars.isLocked());

### setLocked

    public void setLocked(boolean locked)

  设置主程序的工具条管理器的锁定状态。

  参数：
    `locked` - 锁定状态，true表示锁定。

    例子:

         CommandBars bars = Application.getCommandBars();
         bars.setLocked(true);

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

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

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