Oxygen XML Editor 12.2 Author API

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

All Superinterfaces:
WSEditorBase

public interface WSEditor
extends WSEditorBase

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

Since:
11.2

Method Summary
 void addPageChangedListener(WSEditorPageChangedListener pageChangedListener)
          Add a listener for page changed events.
 WSEditorPage getCurrentPage()
          Get access to the current page.
 java.lang.String getCurrentPageID()
          Get the ID of the current page.
 void removePageChangedListener(WSEditorPageChangedListener pageChangedListener)
          Remove the listener for page changed events.
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.WSEditorBase
close, createContentReader, getEditorLocation, isModified, isNewDocument, reloadContent, save, setEditorTabText, setEditorTabTooltipText, 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

java.lang.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

addPageChangedListener

void addPageChangedListener(WSEditorPageChangedListener pageChangedListener)
Add a listener for page changed events.

Parameters:
pageChangedListener - The page changed listener.
Since:
12

removePageChangedListener

void removePageChangedListener(WSEditorPageChangedListener pageChangedListener)
Remove the listener for page changed events.

Parameters:
pageChangedListener - The page changed listener.
Since:
12

Oxygen XML Editor 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.