|
Oxygen XML Editor 14.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.
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 |
---|
WSEditorPage getCurrentPage()
WSTextEditorPage
.
If the Text page is for an XML Editor, this return an implementation of WSXMLTextEditorPage
.
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.void removeEditorListener(WSEditorListener editorListener)
editorListener
- The editor listener.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
void addValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)
validationProblemsFilter
- a filter for problems encountered during validation of the current editor.void removeValidationProblemsFilter(ValidationProblemsFilter validationProblemsFilter)
validationProblemsFilter
- a filter for problems encountered during validation of the current editor.
|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |