|
Oxygen XML Editor 13.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSEditor
Provides access to methods related to the editor actions and information.
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 |
---|
WSEditorPage getCurrentPage()
WSTextEditorPage
.
WSAuthorEditorPage
.java.lang.String getCurrentPageID()
EditorPageConstants#PAGE_TEXT
, EditorPageConstants#PAGE_AUTHOR
, EditorPageConstants#PAGE_GRID
,
EditorPageConstants#PAGE_DESIGN
, EditorPageConstants#PAGE_DITA_MAP
void addPageChangedListener(WSEditorPageChangedListener pageChangedListener)
pageChangedListener
- The page changed listener.void removePageChangedListener(WSEditorPageChangedListener pageChangedListener)
pageChangedListener
- The page changed listener.void addEditorListener(WSEditorListener editorListener)
editorListener
- The editor listener.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.
void removeEditorListener(WSEditorListener editorListener)
editorListener
- The editor listener.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.
void changePage(java.lang.String pageID)
pageID
- The ID of the page, one of the constant fields:
EditorPageConstants#PAGE_TEXT
, EditorPageConstants#PAGE_AUTHOR
, EditorPageConstants#PAGE_GRID
,
EditorPageConstants#PAGE_DESIGN
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.
void addValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)
validationProblemsFilter
- a filter for problems encountered during validation of the current editor.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.
void removeValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)
validationProblemsFilter
- a filter for problems encountered during validation of the current editor.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.
|
Oxygen XML Editor 13.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |