Interface AuthorEditorAccess

All Superinterfaces:
AuthorTooltipCustomizerProvider, ModifiedStatusProvider, ScenarioInvoker, TransformationScenarioInvoker, ValidationScenarioInvoker, WSAuthorEditorPageBase, WSEditorBase, WSEditorPage, WSTextBasedEditorPage
All Known Subinterfaces:
IWebappAuthorEditorAccess

@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface AuthorEditorAccess extends WSAuthorEditorPageBase, WSEditorBase
Provides access to methods related to the Author editor actions and information. It also provides methods to save the file, close, etc.
  • Method Details

    • getLocationOnScreen

      @Deprecated int[] getLocationOnScreen(int x, int y)
      Deprecated.
      Use the getLocationOnScreenAsPoint(int x, int y) method instead.
      Take relative mouse coordinates and translate then to absolute on-screen coordinates.
      Parameters:
      x - The "x" coordinate relative to the viewport origin.
      y - The "y" coordinate relative to the viewport origin.
      Returns:
      An array with the "x" and "y" coordinates relative to the screen.
    • modelToView

      @Deprecated int[] modelToView(int offset)
      Deprecated.
      use modelToViewRectangle(int offset) instead
      Returns a representation of the caret shape for the specified document offset.
      Parameters:
      offset - The document offset to get the corresponding caret shape for.
      Returns:
      An array of int values corresponding to the caret shape: the caret "x" coordinate relative to the viewport origin, the caret "y" coordinate relative to the viewport origin, the caret rectangle width and the caret rectangle height.
    • getEditingContext

      EditingSessionContext getEditingContext()
      The editing session context. An editing session corresponds to an editor instance, contains custom attributes that can be set from the API.
      Returns:
      The editing session context.
      Since:
      15.2
    • getExtensionsBundle

      ExtensionsBundle getExtensionsBundle()
      Get the extensions bundle Java extension associated to this XML document's document type.
      Returns:
      the extensions bundle Java extension associated to this XML document's document type, may be null.
      Since:
      20.1
    • getUnsavedContentReferenceManager

      UnsavedContentReferenceManager getUnsavedContentReferenceManager()
      Get the manager that can be used to find (and save) the resources whose content has been modified in-place, by editing the expanded references.
      Returns:
      The unsaved reference manager. Can be null, if the references cannot be edited in place in this editor.
      Since:
      23