AuthorDocumentModel (Oxygen XML API)

All Superinterfaces:

java.io.Serializable
```
@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorDocumentModel
extends java.io.Serializable
```
The model of an XML document to be edited. It has the following components:
1. some associated CSS files
2. a schema used to validate the document and to propose elements to be inserted in a specific context.
3. a set of markers added by reviewers
4. a selection model
5. an undo manager that supports undoable edits
This class is a facade over all these components.
Since:

15.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AuthorHTMLRenderer`	`createHTMLRenderer(java.io.Writer out)` Returns a renderer of the document to the specified writer.
`AuthorHTMLRenderer`	`createHTMLRenderer(java.io.Writer out, AuthorHighlighter highlighter)` Returns a renderer of the document to the specified writer.
`java.io.Reader`	`createReader()` Returns a reader over the document.
`void`	`dispose()` Dispose the current document.
`WebappActionsManager`	`getActionsManager()`
`WebappAuthorSchemaAwareActionsHandler`	`getActionsSupport()` Returns the schema aware actions handler.
`AttributesManager`	`getAttributesManager()` Returns the attribute manager offering attributes support.
`AuthorAccess`	`getAuthorAccess()` Returns the Autor access object.
`AuthorDocumentController`	`getAuthorDocumentController()` Getter for the document controller.
`ContentCompletionManager`	`getContentCompletionManager()` Returns the content completion manager that can be used to insert XML tags in the document such that the document remains valid according to its schema.
`java.lang.String`	`getCssContent()` TODO (EXM-27739): split it into document-specific and doctype specific CSS in order to allow separate caching.
`ro.sync.exml.editor.xmleditor.DocumentTypeProvider`	`getDocTypeProvider()` Get document type provider.
`java.lang.String`	`getDocumentTypeId()` Returns the id of the document type of the document.
`DPILocation`	`getDPILocation(DocumentPositionedInfo dpInfo)` Compute for the given document position info the content offsets.
`FormControlEditingHelper`	`getEditingHelper()` Returns the form control editing helper.
`java.lang.String`	`getEncoding()`
`FindReplaceSupport`	`getFindReplaceSupport()` The support object for find and replace actions.
`java.lang.String`	`getLicenseeId()`
`WebappLockManager`	`getLockManager()`
`AuthorIdIndex<AuthorPersistentHighlight>`	`getMarkersIndexer()` Return an indexer that assigned IDs to all markers in the document.
`WebappMessagesProvider`	`getMessageProvider()` Returns the message reporter.
`AuthorIdIndex<AuthorNode>`	`getNodeIndexer()` Returns an indexer that assigned IDs to the nodes in the document.
`ReviewController`	`getReviewController()` Returns a review controller that can be used to perform actions on the markers present in the document.
`AuthorSelectionAndCaretModel`	`getSelectionModel()` Returns the selection model of the document.
`WebappSpellchecker`	`getSpellchecker()`
`java.lang.String`	`getUserId()` The ID that uniquely identifies the user that opened the document.
`java.util.List<ro.sync.exml.editor.scenario.BaseScenario>`	`getValidationScenarios()` Get validation scenarios associated with the document.
`java.util.concurrent.Callable<java.util.List<DocumentPositionedInfo>>`	`getValidationTask()` A task that tries to validate the document according to its schema and returns the list of found errors.
`WSEditor`	`getWSEditor()` Exposes some of the WSEditor functionality for the current document.
`void`	`setUserId(java.lang.String userId)` Sets the user id.

- Method Detail
  - getAuthorDocumentController
```
AuthorDocumentController getAuthorDocumentController()
```
    Getter for the document controller. The controller is used to perform undoable edits on the document content.
    
    Returns:
    
    the document controller.
  - createHTMLRenderer
```
AuthorHTMLRenderer createHTMLRenderer(java.io.Writer out)
```
    Returns a renderer of the document to the specified writer.
    
    Parameters:
    
    out - The writer.
    
    Returns:
    
    The HTML renderer.
  - createHTMLRenderer
```
AuthorHTMLRenderer createHTMLRenderer(java.io.Writer out,
                                      AuthorHighlighter highlighter)
```
    Returns a renderer of the document to the specified writer.
    
    Parameters:
    
    out - The writer.
    
    highlighter - Highlighter for non-persistent highlights.
    
    Returns:
    
    The HTML renderer.
  - createReader
```
java.io.Reader createReader()
```
    Returns a reader over the document. The reader serializes the current content of the document trying to match the indentation and line-width that were used in the document before the editing started.
    
    Returns:
    
    a reader over the document.
  - getNodeIndexer
```
AuthorIdIndex<AuthorNode> getNodeIndexer()
```
    Returns an indexer that assigned IDs to the nodes in the document. Note that only the rendered node have an ID assigned.
    
    Returns:
    
    The node indexer.
  - getMarkersIndexer
```
AuthorIdIndex<AuthorPersistentHighlight> getMarkersIndexer()
```
    Return an indexer that assigned IDs to all markers in the document.
    
    Returns:
    
    The marker indexer.
  - getCssContent
```
java.lang.String getCssContent()
```
    TODO (EXM-27739): split it into document-specific and doctype specific CSS in order to allow separate caching. Returns the CSS to be applied to the HTML document.
    
    Returns:
    
    The CSS to be applied to the HTML document.
  - getReviewController
```
ReviewController getReviewController()
```
    Returns a review controller that can be used to perform actions on the markers present in the document.
    
    Returns:
    
    The review controller.
  - getAttributesManager
```
AttributesManager getAttributesManager()
```
    Returns the attribute manager offering attributes support.
    
    Returns:
    
    The attribute manager.
  - getContentCompletionManager
```
ContentCompletionManager getContentCompletionManager()
```
    Returns the content completion manager that can be used to insert XML tags in the document such that the document remains valid according to its schema.
    
    Returns:
    
    The content completion manager.
  - getSelectionModel
```
AuthorSelectionAndCaretModel getSelectionModel()
```
    Returns the selection model of the document.
    
    Returns:
    
    The selection model.
  - getValidationTask
```
java.util.concurrent.Callable<java.util.List<DocumentPositionedInfo>> getValidationTask()
```
    A task that tries to validate the document according to its schema and returns the list of found errors.
    
    Returns:
    
    The validation task for the current document.
  - getEncoding
```
java.lang.String getEncoding()
```
    Returns:
    
    The encoding of the document in Java format.
  - getActionsManager
```
WebappActionsManager getActionsManager()
```
    Returns:
    
    Actions support.
  - getEditingHelper
```
FormControlEditingHelper getEditingHelper()
```
    Returns the form control editing helper.
    
    Returns:
    
    the form control editing helper.
  - getActionsSupport
```
WebappAuthorSchemaAwareActionsHandler getActionsSupport()
```
    Returns the schema aware actions handler.
    
    Returns:
    
    The schema aware actions handler.
  - getAuthorAccess
```
AuthorAccess getAuthorAccess()
```
    Returns the Autor access object.
    
    Returns:
    
    Returns the author access object.
  - getMessageProvider
```
WebappMessagesProvider getMessageProvider()
```
    Returns the message reporter. It collects error/warning/info messages.
    
    Returns:
    
    The message reporter.
  - getDocumentTypeId
```
java.lang.String getDocumentTypeId()
```
    Returns the id of the document type of the document.
    
    Returns:
    
    The id of the document type of the document.
  - getValidationScenarios
```
java.util.List<ro.sync.exml.editor.scenario.BaseScenario> getValidationScenarios()
```
    Get validation scenarios associated with the document.
    
    Returns:
    
    Validation scenarios associated with the document.
  - getDocTypeProvider
```
ro.sync.exml.editor.xmleditor.DocumentTypeProvider getDocTypeProvider()
```
    Get document type provider.
    
    Returns:
    
    The document type provider.
  - getDPILocation
```
DPILocation getDPILocation(DocumentPositionedInfo dpInfo)
```
    Compute for the given document position info the content offsets.
    
    Parameters:
    
    dpInfo - The document position info.
    
    Returns:
    
    The DPI location info.
  - dispose
```
void dispose()
```
    Dispose the current document. Its use after disposal produce undefined behavior.
  - getFindReplaceSupport
```
FindReplaceSupport getFindReplaceSupport()
```
    The support object for find and replace actions.
    
    Returns:
    
    The support object for find and replace actions.
  - getWSEditor
```
WSEditor getWSEditor()
```
    Exposes some of the WSEditor functionality for the current document.
    
    Returns:
    
    An WSEditor adapter.
  - getUserId
```
java.lang.String getUserId()
```
    The ID that uniquely identifies the user that opened the document.
    
    Returns:
    
    The ID of the user. By default we use the license ID.
  - setUserId
```
void setUserId(java.lang.String userId)
```
    Sets the user id.
    
    Parameters:
    
    userId - Sets the unique ID of the user that opened the document.
  - getLicenseeId
```
java.lang.String getLicenseeId()
```
    Returns:
    
    The licensee ID which is unique for each browser connected to the webapp, even if the same person uses multiple browsers.
  - getLockManager
```
WebappLockManager getLockManager()
```
    Returns:
    
    The lock manager for this document.
  - getSpellchecker
```
WebappSpellchecker getSpellchecker()
```
    Returns:
    
    The spellchecker for this document.

Interface AuthorDocumentModel

Method Summary

Method Detail

getAuthorDocumentController

createHTMLRenderer

createHTMLRenderer

createReader

getNodeIndexer

getMarkersIndexer

getCssContent

getReviewController

getAttributesManager

getContentCompletionManager

getSelectionModel

getValidationTask

getEncoding

getActionsManager

getEditingHelper

getActionsSupport

getAuthorAccess

getMessageProvider

getDocumentTypeId

getValidationScenarios

getDocTypeProvider

getDPILocation

dispose

getFindReplaceSupport

getWSEditor

getUserId

setUserId

getLicenseeId

getLockManager

getSpellchecker