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

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

## 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()` 返回页面视图。
`ReadingView` | `getReadingView()` 返回阅读视图。
`Reviewers` | `getReviewers()` 返回一个 Reviewers 对象，该对象代表所有的审阅者。
`int` | `getRevisionsViewType()` 返回文档的修订状态。
`int` | `getViewType()` 得到视图的类型。
`void` | `hideRulers()` 设置隐藏垂直标尺和水平标尺。
`boolean` | `isCustomPopupMenuEnable()` 返回是否需要显示用户的自定义右键菜单
`void` | `setAllReviewersVisible(boolean visible)` 设置是否显示文档中所有审阅者所添加的批注或修订。
`void` | `setCommentsVisible(boolean visible)` 设置是否显示文档中的批注。
`void` | `setCustomPopupMenu(javax.swing.JPopupMenu customPopupMenu)` 设置用户的自定义右键菜单，注意：如isCustomPopupMenuEnable()方法返回false， 自定义菜单不能弹出，必须先调用setCustomPopupMenuEnable(true)方能弹出。
`void` | `setCustomPopupMenuEnable(boolean enabled)` 设置是否需要显示用户的自定义右键菜单
`void` | `setFormattingChangesVisible(boolean visible)` 在启用"修订"功能后，设置是否显示文档中正在格式化的内容。
`void` | `setHandAnnotationsVisible(boolean visible)` 设置是否显示文档中的手写批注。
`void` | `setInsertionsAndDeletionsVisible(boolean visible)` 在启用"修订"功能后，设置是否显示文档中插入和删除的内容。
`void` | `setRevisionsViewType(int type)` 设置文档的修订状态。
`void` | `setZoom(int zoom)` 设置文档显示的缩放比例。
`void` | `showRulers()` 设置显示垂直标尺和水平标尺 例子: //请输入一些文字。
`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());

### getReadingView

    public ReadingView getReadingView()

  返回阅读视图。调用此方法时视图将切换至阅读视图。

  返回：
    阅读视图对象

    例子:

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

### getReviewers

    public Reviewers getReviewers()

  返回一个 Reviewers 对象，该对象代表所有的审阅者。

  返回：
    Reviewers 对象

    例子:

         //请输入一些文字。
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.getReviewers();

### getRevisionsViewType

    public int getRevisionsViewType()

  返回文档的修订状态。

  返回：
    文档的修订状态，取值如下：

              RevisionsConstants.FINAL_SHOWING_MARKUP           显示标记的最终状态
              RevisionsConstants.FINAL                          最终状态
              RevisionsConstants.ORIGINAL_SHOWING_MARKUP        显示标记的原始状态
              RevisionsConstants.ORIGINAL                       原始状态

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!");
         Revisions revisions = doc.getRevisions();
         revisions.setViewType(RevisionsConstants.ORIGINAL);
         doc.beginTrackRevision();
         baseText.insertText(0,"new");
         doc.stopTrackRevision();
         System.out.println("viewType=" + revisions.getViewType());

### getViewType

    public int getViewType()

  得到视图的类型。

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

               ViewConstants.NORMAL_VIEW  (普通视图）
               ViewConstants.PAGE_VIEW    (页面视图）
               ViewConstants.OUTLINE_VIEW （大纲视图）
               ViewConstants.READING_VIEW (阅读视图)

    例子:

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

  另请参见：
    `switchView(int)`

### hideRulers

    public void hideRulers()

  设置隐藏垂直标尺和水平标尺。

  例子:

       //请输入一些文字。
       Document doc = Application.getWorkbooks().getActiveDocument();
       DocumentView docview = doc.getDocumentView();
       docview.hideRulers();

  另请参见：
    `showRulers()`

### isCustomPopupMenuEnable

    public boolean isCustomPopupMenuEnable()

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

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

    例子:

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

### setAllReviewersVisible

    public void setAllReviewersVisible(boolean visible)

  设置是否显示文档中所有审阅者所添加的批注或修订。

  参数：
    `visible` - 是否显示文档中所有审阅者所添加的批注或修订

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setAllReviewersVisible(false);

### setCommentsVisible

    public void setCommentsVisible(boolean visible)

  设置是否显示文档中的批注。

  参数：
    `visible` - 是否显示文档中的批注

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setCommentsVisible(false);

### 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);

### setFormattingChangesVisible

    public void setFormattingChangesVisible(boolean visible)

  在启用"修订"功能后，设置是否显示文档中正在格式化的内容。

  参数：
    `visible` - 是否显示文档中正在格式化的内容

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setFormattingVisible(false);

### setHandAnnotationsVisible

    public void setHandAnnotationsVisible(boolean visible)

  设置是否显示文档中的手写批注。

  参数：
    `visible` - 是否显示文档中的手写批注

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setHandAnnotationsVisible(false);

### setInsertionsAndDeletionsVisible

    public void setInsertionsAndDeletionsVisible(boolean visible)

  在启用"修订"功能后，设置是否显示文档中插入和删除的内容。

  参数：
    `visible` - 是否显示文档中插入和删除的内容

    例子:

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setInsertionsAndDeletionsVisible(false);

### setRevisionsViewType

    public void setRevisionsViewType(int type)

  设置文档的修订状态。

  参数：
    `type` - 文档的修订状态，取值如下：

         RevisionsConstants.FINAL_SHOWING_MARKUP           显示标记的最终状态
         RevisionsConstants.FINAL                          最终状态
         RevisionsConstants.ORIGINAL_SHOWING_MARKUP        显示标记的原始状态
         RevisionsConstants.ORIGINAL                       原始状态

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         doc.beginTrackRevision();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!");
         doc.getDocumentView().setViewType(RevisionsConstants.ORIGINAL);

  抛出：
    `MacroRunException` - 当指定的常量不存在或不适用

### setZoom

    public void setZoom(int zoom)

  设置文档显示的缩放比例。

  参数：
    `zoom` - 缩放比例，为int型,100为100％,缩放比例在10％ ～ 500％之间

    例子:

         //请输入一些文字。
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         DocumentView docView = doc.getDocumentView();
         docView.setZoom(50);

### showRulers

    public void showRulers()

  设置显示垂直标尺和水平标尺

  例子:

       //请输入一些文字。
       Document doc = Application.getWorkbooks().getActiveDocument();
       DocumentView docview = doc.getDocumentView();
       docview.showRulers();

  另请参见：
    `hideRulers()`

### switchView

    public void switchView(int type)

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

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

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

    例子:

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

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

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

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

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