Interface WSAuthorEditorPage
-
- All Superinterfaces:
AuthorTooltipCustomizerProvider
,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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addQuickAssistProcessor(SimpleQuickAssistProcessor processor)
Register a quick assist processor.AuthorAccess
getAuthorAccess()
Access class to the author functions.AuthorChangeTrackingController
getChangeTrackingController()
Deprecated.Use
instead.getReviewController()
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.void
removeQuickAssistProcessor(SimpleQuickAssistProcessor processor)
The processor to be unregistered.-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.tooltip.AuthorTooltipCustomizerProvider
addTooltipCustomizer, removeTooltipCustomizer
-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.WSAuthorEditorPageBase
addAuthorAttributesDisplayFilter, addAuthorCaretListener, addAuthorMouseListener, addDNDListener, addPopUpMenuCustomizer, buildURLForReferencedContent, deleteSelection, editAttribute, getActionsProvider, getAuthorComponent, getAuthorFoldManager, getAuthorSelectionModel, getBalancedSelection, getBalancedSelectionEnd, getBalancedSelectionStart, getDefaultAuthorSchemaAwareEditingHandler, getFullySelectedNode, getFullySelectedNode, getHighlighter, getPersistentHighlighter, getPseudoElementStyles, getSelectedText, getSelectionEnd, getSelectionStart, getStyles, getTagsDisplayMode, goToNextEditablePosition, hasSelection, isOffsetInInvisibleBounds, moveOutOfInvisibleBounds, refresh, refresh, removeAuthorAttributesDisplayFilter, removeAuthorCaretListener, removeAuthorMouseListener, removeDNDListener, removePopUpMenuCustomizer, scrollToRectangle, select, setPopUpMenuCustomizer, setTagsDisplayMode, viewToModel
-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSEditorPage
getParentEditor, hasFocus, isEditable, requestFocus, setEditable, setReadOnly, setReadOnly
-
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.WSTextBasedEditorPage
createAnchor, getCaretOffset, getLocationOnScreenAsPoint, getLocationRelativeToEditorFromScreen, getOffsetForAnchor, getStartEndOffsets, getWordAtCaret, modelToViewRectangle, scrollCaretToVisible, selectWord, setCaretPosition, 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
instead.getReviewController()
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
-
addQuickAssistProcessor
void addQuickAssistProcessor(SimpleQuickAssistProcessor processor)
Register a quick assist processor. This allow you to provide quick custom quick assist proposals in the current editor page quick assist menu. The quick assist processor cannot be registered for WebAuthor application.- Parameters:
processor
- The processor to be registered.- Since:
- 26.1
*********************************
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.
-
removeQuickAssistProcessor
void removeQuickAssistProcessor(SimpleQuickAssistProcessor processor)
The processor to be unregistered.- Parameters:
processor
- The processor to be unregistered.- Since:
- 26.1
*********************************
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.
-
-