@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSEditor extends WSEditorBase, ro.sync.exml.editor.EditorPageConstants
Modifier and Type | Method and Description |
---|---|
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.
|
boolean |
checkValid()
Check if the current editor is valid, performs manual validation and returns
true if the last validation was finished without errors or warnings. |
java.lang.Object |
getComponent()
Get the internal component (Swing or SWT based) which represents the editor (the editor in its turn has multiple pages, each with its subcomponent).
|
WSEditorPage |
getCurrentPage()
Get access to the current page.
|
java.lang.String |
getCurrentPageID()
Get the ID of the current page.
|
WSEditorListener[] |
getEditorListeners()
Get a list with all editor listeners, never
null . |
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.
|
close, createContentInputStream, createContentReader, getDocumentTypeInformation, getEditorLocation, isModified, isNewDocument, reloadContent, reloadContent, save, saveAs, setEditorTabText, setEditorTabTooltipText, setModified
runTransformationScenarios
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.WSEditorListener[] getEditorListeners()
null
.null
.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.boolean checkValid()
true
if the last validation was finished without errors or warnings.
For document types which do not support validation, this returns always true
.
If you want to see the problems reported by the validation process you can add a validation problems filter addValidationProblemsFilter(ValidationProblemsFilter)
.true
if right now no error is reported on the editor content.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.
java.lang.Object getComponent()
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.
© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.