Oxygen XML Editor, Version ${standalone-version-number}

ro.sync.exml.workspace.api.editor
Interface WSEditor

All Superinterfaces:
ro.sync.exml.editor.EditorPageConstants, WSEditorBase

public interface WSEditor
extends WSEditorBase, ro.sync.exml.editor.EditorPageConstants

Provides access to methods related to the editor actions and information.

*********************************
EXPERIMENTAL - Subject to change
*********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Since:
11.2

Field Summary
 
Fields inherited from interface ro.sync.exml.editor.EditorPageConstants
PAGE_AUTHOR, PAGE_DESIGN, PAGE_DITA_MAP, PAGE_GRID, PAGE_TEXT, PAGE_UNKNOWN
 
Method Summary
 WSEditorPage getCurrentPage()
          Get access to the current page.
 String getCurrentPageID()
          Get the ID of the current page.
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.WSEditorBase
close, createContentReader, getEditorLocation, isModified, isNewDocument, reloadContent, save, setModified
 

Method Detail

getCurrentPage

WSEditorPage getCurrentPage()
Get access to the current page.

Returns:
the current page access. Can be null for pages which do not have special access methods (for example Grid or Design).
For the Text page this return an implementation of WSTextEditorPage.
For the Author page this return an implementation of WSAuthorEditorPage.

getCurrentPageID

String getCurrentPageID()
Get the ID of the current page.

Returns:
The ID of the page, one of the constant fields: EditorPageConstants.PAGE_TEXT, EditorPageConstants.PAGE_AUTHOR, EditorPageConstants.PAGE_GRID, EditorPageConstants.PAGE_DESIGN, EditorPageConstants.PAGE_DITA_MAP

Oxygen XML Editor, Version ${standalone-version-number}

© Copyright Syncro Soft SRL 2002 - 2010.