Oxygen XML Editor 16.1 Author API

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

All Superinterfaces:
WSAuthorEditorPageBase, WSEditorPage, WSTextBasedEditorPage
All Known Subinterfaces:
WSAuthorComponentEditorPage

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WSAuthorEditorPage
extends WSAuthorEditorPageBase

Author editor page.

Since:
11.2

Method Summary
 AuthorAccess getAuthorAccess()
          Access class to the author functions.
 AuthorChangeTrackingController getChangeTrackingController()
          Deprecated. Use getReviewController() instead.
 AuthorDocumentController getDocumentController()
          Returns the Author document controller.
 OptionsStorage getOptionsStorage()
          The object that manages the options stored for author extensions.
 AuthorOutlineAccess getOutlineAccess()
          Get the author Outline access providing Outline related information.
 AuthorReviewController getReviewController()
          Controller that can be used to toggle the change tracking state, modify the review highlight author name, the highlight painting or to obtain information about the properties used in the serialization and representation of the review highlight (author name, reviewer auto color or the current time stamp in a format identical to the one used by Oxygen for insert, delete and comment markers).
 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
addAuthorAttributesDisplayFilter, addAuthorCaretListener, addAuthorMouseListener, addPopUpMenuCustomizer, deleteSelection, editAttribute, getActionsProvider, getAuthorComponent, getAuthorSelectionModel, getBalancedSelection, getBalancedSelectionEnd, getBalancedSelectionStart, getDefaultAuthorSchemaAwareEditingHandler, getFullySelectedNode, getFullySelectedNode, getHighlighter, getPersistentHighlighter, getSelectedText, getSelectionEnd, getSelectionStart, getStyles, goToNextEditablePosition, hasSelection, isOffsetInInvisibleBounds, refresh, refresh, removeAuthorAttributesDisplayFilter, removeAuthorCaretListener, removeAuthorMouseListener, removePopUpMenuCustomizer, scrollToRectangle, select, setPopUpMenuCustomizer, viewToModel
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage
getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getStartEndOffsets, getWordAtCaret, isEditable, modelToViewRectangle, selectWord, setCaretPosition, setEditable, viewToModelOffset
 

Method Detail

getDocumentController

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

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

@Deprecated
AuthorChangeTrackingController getChangeTrackingController()
Deprecated. Use getReviewController() instead.

The change tracking controller used to toggle change tracking on and off and check its state.

Returns:
The change tracking controller. Cannot be null.

getReviewController

AuthorReviewController getReviewController()
Controller that can be used to toggle the change tracking state, modify the review highlight author name, the highlight painting or to obtain information about the properties used in the serialization and representation of the review highlight (author name, reviewer auto color or the current time stamp in a format identical to the one used by Oxygen for insert, delete and comment markers).

Returns:
The review controller. Cannot be null.
Since:
12

getOptionsStorage

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

AuthorOutlineAccess getOutlineAccess()
Get the author Outline access providing Outline related information.

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

getAuthorAccess

AuthorAccess getAuthorAccess()
Access class to the author functions. The WSAuthorEditorPage has most of the methods which can also be found in the AuthorAccess. This method is offered only as an useful way to have utility methods which take AuthorAccess as a parameter and to use them both from a plugin and from a framework. Provides access to specific components corresponding to editor, document, workspace, tables, change tracking and utility informations and actions.

Returns:
The author access.
Since:
14.1

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.