Oxygen XML Web Author

Namespace: api

sync. api

Classes

ActionsManager
ActionsManagerCore
AuthorEditingSupport
AuthorWidgetsFactory
ChangeTrackingManager
ConcurrentEditingManager
CreateDocumentAction
Dialog
EditImageMapAction
EditingContextManager
EditingSupport
EditingSupportManager
Editor
FileBrowsingDialog
FileServersManager
HighlightUpdateEvent
NotificationsManager
PersistentHighlightsManager
PersistentHighlightUpdateEvent
PositionInformation
Selection
SelectionCore
SelectionManager
SelectionManagerCore
SpellChecker
UrlChooser
WebappMessage
Workspace
WorkspaceActionsManager
WrapperAuthorEditingSupport
WrapperEditingSupport

Namespaces

change_tracking
dom
math
Translation

Members

<static> SelectionModel

Deprecated:

<static> SelectionModel

Deprecated:

Methods

<static> EditingSupportProvider()

Provides the possibility to impose a specific sync.api.EditingSupport to be used instead of the built-in one to render the content of the current editor, to set the actions, toolbars and views associated with it.

Type Definitions

ElementNameEnhancer(elementName, elementAttrs)

A function callback used to enhance the name of elements, as shown in the UI (breadcrumbs and tags), depending on their attributes.
Parameters:
Name Type Description
elementName string The name of the XML element.
elementAttrs Object The attributes stored in an object with the attribute names as keys and with a descriptor object as value. The descriptor contains:
  • the value of the object (attributeValue).
  • whether it's value comes from DTD or not (isDefaultValue).
  • whether the attribute is hidden (isHidden).
    		•
    Returns:
    A new name for the given XML element.
    Type
    string

    FileServerDescriptor

    File server descriptor that provides rendering information and browsing functionality for a specific file server.
    Type:
    • Object
    Properties:
    Name Type Description
    id string The id of the server. It will be used as a namespace to save the following server-specific information in the local storage:
    • server_id.latestRootUrl - The latest root URL used in the file servers Dashboard tab
    • server_id.latestUrl - The latest URL for which the content files are listed in the file servers Dashboard tab
    name string The name of the file server (it will be displayed in the Dashboard, on the file server tab).
    icon string The URL of the file server icon (it will be displayed in the Dashboard, on the file server tab).
    matches function Returns true if the URL given as parameter points to a file or folder from this file server.
    fileServer sync.api.FileServer It provides login, logout and file browsing functionality for a specific server.

    ReadOnlyState

    The descriptor for the read-only or editable state of the editor.
    Type:
    • Object
    Properties:
    Name Type Description
    readOnly boolean A flag that indicated whether the document is read-only.
    message string The message to display to the user if the editor is read-only.
    code string A code for the reason which will be the same across UI languages.