Oxygen XML Editor, Version ${standalone-version-number}

ro.sync.exml.workspace.api.editor.page.author
Interface WSAuthorEditorPage

All Superinterfaces:
WSAuthorEditorPageBase, WSEditorPage, WSTextBasedEditorPage

public interface WSAuthorEditorPage
extends WSAuthorEditorPageBase

Author editor page.

*********************************
EXPERIMENTAL - Subject to change
*********************************

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.

Since:
11.2

Method Summary
 ro.sync.ecss.extensions.api.AuthorChangeTrackingController getChangeTrackingController()
          The change tracking controller used to toggle change tracking on and off and check its state.
 ro.sync.ecss.extensions.api.AuthorDocumentController getDocumentController()
          Returns the Author document controller.
 ro.sync.ecss.extensions.api.OptionsStorage getOptionsStorage()
          The object that manages the options stored for author extensions.
 ro.sync.ecss.extensions.api.access.AuthorOutlineAccess getOutlineAccess()
          Get the author Outline access providing Outline related information.
 ro.sync.ecss.extensions.api.access.AuthorTableAccess getTableAccess()
          Returns the author table access provider responsible for obtaining table related information and executing table actions.
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.WSAuthorEditorPageBase
addAuthorCaretListener, addAuthorMouseListener, getHighlighter, refresh, refresh, removeAuthorCaretListener, removeAuthorMouseListener, viewToModel
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage
deleteSelection, getCaretOffset, getLocationOnScreenAsPoint, getSelectedText, getSelectionEnd, getSelectionStart, getWordAtCaret, hasSelection, modelToViewRectangle, select, selectWord, setCaretPosition, viewToModelOffset
 

Method Detail

getDocumentController

ro.sync.ecss.extensions.api.AuthorDocumentController getDocumentController()
Returns the Author document controller. It has methods for changing the document model.

Returns:
The controller for Author document. Cannot be null.

getTableAccess

ro.sync.ecss.extensions.api.access.AuthorTableAccess getTableAccess()
Returns the author table access provider responsible for obtaining table related information and executing table actions.

Returns:
The table related information and actions provider. Cannot be null.

getChangeTrackingController

ro.sync.ecss.extensions.api.AuthorChangeTrackingController getChangeTrackingController()
The change tracking controller used to toggle change tracking on and off and check its state.

Returns:
The change tracking controller. Cannot be null.

getOptionsStorage

ro.sync.ecss.extensions.api.OptionsStorage getOptionsStorage()
The object that manages the options stored for author extensions. This is also responsible for adding and removing listeners that are notified about the option changes.

Returns:
The object that manages the options stored for author extensions.

getOutlineAccess

ro.sync.ecss.extensions.api.access.AuthorOutlineAccess getOutlineAccess()
Get the author Outline access providing Outline related information.

Returns:
The Outline related informations and actions provider. Cannot be null.

Oxygen XML Editor, Version ${standalone-version-number}

© Copyright Syncro Soft SRL 2002 - 2010.