Package ro.sync.exml.workspace.api.editor.page

Interface WSEditorPage

All Known Subinterfaces:
AuthorEditorAccess, IWebappAuthorEditorAccess, WSAuthorComponentEditorPage, WSAuthorEditorPage, WSAuthorEditorPageBase, WSDesignEditorPage, WSDITAMapEditorPage, WSGridEditorPage, WSTextBasedEditorPage, WSTextEditorPage, WSXMLTextEditorPage
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WSEditorPage
Access to an editor's page.
Since:
11.2

  • Method Summary

    Modifier and Type
    Method
    Description
    WSEditor
    getParentEditor()
    Get the parent editor access.
    boolean
    hasFocus()
    Check if the page has focus
    boolean
    isEditable()
    Check if the document can be edited.
    void
    requestFocus()
    Request focus in the current page.
    void
    setEditable(boolean editable)
    Sets the specified flag to indicate whether or not this page should be editable.
    void
    setReadOnly(String reason)
    Sets the document as read-only.
    void
    setReadOnly(ReadOnlyReason reason)
    Sets the document as read-only.

  • Method Details

    • setReadOnly

      void setReadOnly(ReadOnlyReason reason)
      Sets the document as read-only.
      Parameters:
      reason - The reason for making the document read-only. If null is passed, a default message will be displayed.
      Since:
      19.1

    • setReadOnly

      void setReadOnly(String reason)
      Sets the document as read-only.
      Parameters:
      reason - The reason for making the document read-only. It will be displayed to the user. If null is passed, a default message will be displayed.
      Since:
      18.0

    • setEditable

      void setEditable(boolean editable)
      Sets the specified flag to indicate whether or not this page should be editable. It is recommended to use setReadOnly(String) if you plan to make the page read-only.
      Parameters:
      editable - true if the page should be editable.
      Since:
      12.2

    • isEditable

      boolean isEditable()
      Check if the document can be edited. A document can be set as read-only from API, by using the setEditable(boolean) method.
      Returns:
      true if the document is editable.
      Since:
      14.1

    • getParentEditor

      WSEditor getParentEditor()
      Get the parent editor access.
      Returns:
      The parent editor access.
      Since:
      18

    • requestFocus

      void requestFocus()
      Request focus in the current page. Works for all editing modes (Text/Grid/Author) in the standalone and Eclipse-based Oxygen and Author Component distributions. Does not do anything in the WebAuthor online editor.
      Since:
      21

    • hasFocus

      boolean hasFocus()
      Check if the page has focus
      Returns:
      true if focus is inside the page's main editing component.
      Since:
      23