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

All Superinterfaces:

ro.sync.exml.editor.EditorPageConstants, WSEditorBase

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WSEditor
extends WSEditorBase, ro.sync.exml.editor.EditorPageConstants

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

Since:

11.2

Field Summary

Fields inherited from interface ro.sync.exml.editor.EditorPageConstants

HIGHLIGHT_CLASS_DEBUGGER_CONTEXT, PAGE_AUTHOR, PAGE_DESIGN, PAGE_DITA_MAP, PAGE_GRID, PAGE_TEXT, PAGE_UNKNOWN

Method Summary

void	addEditorListener(WSEditorListener editorListener) Add a listener for editor related events.
void	addPageChangedListener(WSEditorPageChangedListener pageChangedListener) Add a listener for page changed events.
void	addValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter) Add a filter for problems encountered during validation of the current editor.
void	changePage(java.lang.String pageID) Change the current selected page in the editor.
WSEditorPage	getCurrentPage() Get access to the current page.
java.lang.String	getCurrentPageID() Get the ID of the current page.
void	removeEditorListener(WSEditorListener editorListener) Remove the listener for editor events.
void	removePageChangedListener(WSEditorPageChangedListener pageChangedListener) Remove the listener for page changed events.
void	removeValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter) Remove a filter for problems encountered during validation of the current editor.

Methods inherited from interface ro.sync.exml.workspace.api.editor.WSEditorBase

close, createContentReader, getEditorLocation, isModified, isNewDocument, reloadContent, reloadContent, save, saveAs, 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. If the Text page is for an XML Editor, this return an implementation of WSXMLTextEditorPage.
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

addEditorListener

void addEditorListener(WSEditorListener editorListener)

Add a listener for editor related events.

Parameters:

editorListener - The editor listener.

Since:

13

removeEditorListener

void removeEditorListener(WSEditorListener editorListener)

Remove the listener for editor events.

Parameters:

editorListener - The editor listener.

Since:

13

changePage

void changePage(java.lang.String pageID)

Change the current selected page in the editor. This does not affect editors opened in the DITA Maps Manager. If problems occur during the page switch or the page ID is not recognized the page will be switched to Text and the operation is aborted.

Parameters:

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

Since:

13

addValidationProblemsFilter

void addValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)

Add a filter for problems encountered during validation of the current editor. Validation can be manual or automatic. Automatic validation is done when modifications occur in the XML file.

Parameters:

validationProblemsFilter - a filter for problems encountered during validation of the current editor.

Since:

13

removeValidationProblemsFilter

void removeValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)

Remove a filter for problems encountered during validation of the current editor. Validation can be manual or automatic. Automatic validation is done when modifications occur in the XML file.

Parameters:

validationProblemsFilter - a filter for problems encountered during validation of the current editor.

Since:

13