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

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

## application.workbooks.workbook.documents.document
类 DocumentView

    java.lang.Object
      application.workbooks.workbook.documents.document.DocumentView

    public class DocumentView

extends java.lang.Object

该类定义了对文档视图进行操作的一些方法。

方法摘要
`javax.swing.JComponent` | `getComponent()` 返回WP组件
`javax.swing.JPopupMenu` | `getCustomPopupMenu()` 返回用户的自定义右键菜单
`NormalView` | `getNormalView()` 返回普通视图。
`OutlineView` | `getOutlineView()` 返回大纲视图。
`PageView` | `getPageView()` 返回页面视图。
`int` | `getViewType()` 得到视图的类型。
`boolean` | `isCustomPopupMenuEnable()` 返回是否需要显示用户的自定义右键菜单
`void` | `setCustomPopupMenu(javax.swing.JPopupMenu customPopupMenu)` 设置用户的自定义右键菜单，注意：如isCustomPopupMenuEnable()方法返回false， 自定义菜单不能弹出，必须先调用setCustomPopupMenuEnable(true)方能弹出。
`void` | `setCustomPopupMenuEnable(boolean enabled)` 设置是否需要显示用户的自定义右键菜单
`void` | `switchView(int type)` 设置当前文档的视图类型。

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

方法详细信息

### getComponent

    public javax.swing.JComponent getComponent()

  返回WP组件

  返回：
    返回WP组件

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         System.out.println(docView.getComponent());

### getCustomPopupMenu

    public javax.swing.JPopupMenu getCustomPopupMenu()

  返回用户的自定义右键菜单

  返回：
    返回用户自定义右键菜单，如果无，返回null

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         JPopupMenu menu = docView.getCustomPopupMenu();
         System.out.println(menu);

### getNormalView

    public NormalView getNormalView()

  返回普通视图。调用此方法时视图将切换至普通视图。

  返回：
    普通视图

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         NormalView normalView = docView.getNormalView();
         System.out.println("得到当前文档视图的类型是："+normalView.getViewType());

### getOutlineView

    public OutlineView getOutlineView()

  返回大纲视图。调用此方法时视图将切换至大纲视图。

  返回：
    大纲视图

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         OutlineView outlineView = docView.getOutlineView();
         System.out.println("得到当前文档视图的类型是："+outlineView.getViewType());

### getPageView

    public PageView getPageView()

  返回页面视图。调用此方法时视图将切换至页面视图。

  返回：
    页面视图

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         PageView pageView = docView.getPageView();
         System.out.println("得到当前文档视图的类型是："+pageView.getViewType());

### getViewType

    public int getViewType()

  得到视图的类型。

  返回：
    视图类型，其常量和相应的值如下：

               ViewConstants.NORMAL_VIEW  (普通视图）；
               ViewConstants.PAGE_VIEW    (页面视图）；
               ViewConstants.OUTLINE_VIEW （大纲视图）

    例子:

         //请输入一些文字。
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         System.out.println("得到当前文档视图的类型是："+docView.getViewType());

  另请参见：
    `switchView(int)`

### isCustomPopupMenuEnable

    public boolean isCustomPopupMenuEnable()

  返回是否需要显示用户的自定义右键菜单

  返回：
    false表示显示WP的右键菜单，true表示显示自定义右键菜单

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         System.out.println(docView.isCustomPopupMenuEnable());

### setCustomPopupMenu

    public void setCustomPopupMenu(javax.swing.JPopupMenu customPopupMenu)

  设置用户的自定义右键菜单，注意：如isCustomPopupMenuEnable()方法返回false， 自定义菜单不能弹出，必须先调用setCustomPopupMenuEnable(true)方能弹出。

  参数：
    `customPopupMenu` - 标准Swing弹出菜单

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         JPopupMenu menu = new JPopupMenu();
         menu.add("First");
         menu.add("Second");
         menu.addSeparator();
         menu.add("One");
         menu.add("Two");
         docView.setCustomPopupMenuEnable(true);
         docView.setCustomPopupMenu(menu);

### setCustomPopupMenuEnable

    public void setCustomPopupMenuEnable(boolean enabled)

  设置是否需要显示用户的自定义右键菜单

  参数：
    `enabled` - false表示显示WP的右键菜单，true表示显示自定义右键菜单

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setCustomPopupMenuEnable(true);

### switchView

    public void switchView(int type)

  设置当前文档的视图类型。

  参数：
    `type` - 文档的视图类型。可分为普通视图，页面视图，大纲视图。 其常量如下：

         ViewConstants.NORMAL_VIEW      (普通视图)
         ViewConstants.OUTLINE_VIEW     (大纲视图)
         ViewConstants.PAGE_VIEW        (页面视图)

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.switchView(ViewConstants.OUTLINE_VIEW);

  抛出：
    `application.exceptions.MacroRunException` - 当文档视图类型的常量不存在
  另请参见：
    `ViewConstants`

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

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