Oxygen XML Author plugin 13.2.0

Author Developer Guide | 209// Other custom initializations...}The authorAccess parameter received by the activated method can be used to gain access to Author specific actionsand informations related to components like the editor, document, workspace, tables, or the change tracking manager.If options specific to the custom developed Author extension need to be stored or retrieved, a reference to thero.sync.ecss.extensions.api.OptionsStorage can be obtained by calling the getOptionsStoragemethod from the author access. The same object can be used to registerro.sync.ecss.extensions.api.OptionListener listeners. An option listener is registered in relation withan option key and will be notified about the value changes of that option.An AuthorListener can be used if events related to the Author document modifications are of interest. The listenercan be added to the ro.sync.ecss.extensions.api.AuthorDocumentController. A reference to thedocument controller is returned by the getDocumentController method from the author access. The documentcontroller can also be used to perform operations involving document modifications.To provide access to Author editor component related functionality and information, the author access has a referenceto the ro.sync.ecss.extensions.api.access.AuthorEditorAccess that can be obtained when callingthe getEditorAccess method. At this level AuthorMouseListener and AuthorCaretListener can beadded which will be notified about mouse and caret events occurring in the Author editor mode.The deactivation event is received when another framework is activated for the same document, the user switches toanother editor mode or the editor is closed. The deactivate method is typically used to unregister the listenerspreviously added on the activate method and to perform other actions. For example, options related to the deactivatedauthor extension can be saved at this point.public void deactivated(AuthorAccess authorAccess) {// Store the option.authorAccess.getOptionsStorage().setOption("sdf.custom.option.key", optionValue);// Remove the option listener.authorAccess.getOptionsStorage().removeOptionListener(sdfOptionListener);// Remove document listeners.authorAccess.getDocumentController().removeAuthorListener(sdfAuthorDocumentListener);// Remove mouse listener.authorAccess.getEditorAccess().removeAuthorMouseListener(sdfMouseListener);// Remove caret listener.authorAccess.getEditorAccess().removeAuthorCaretListener(sdfCaretListener);}// Other actions...Implementing an Author Schema Aware Editing HandlerYou can implement your own handler for actions like typing, delete or paste by providing an implementation ofro.sync.ecss.extensions.api.AuthorSchemaAwareEditingHandler. The Schema Aware Editingmust be On or Custom in order for this handler to be called. The handler can either resolve a specific case, let the defaultimplementation take place or reject the edit entirely by throwing an InvalidEditException.