Package ro.sync.ecss.extensions.api.component

Interface EditorComponentProvider

All Superinterfaces:
ComponentProvider
All Known Implementing Classes:
AbstractComponentProvider, AuthorComponentProvider, GenericEditorComponentProvider
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface EditorComponentProvider extends ComponentProvider
Provides access to a created editor + helper views and additional panels. The editor might have multiple editor pages.
Since:
14.2

  • Field Details

  • Method Details

    • showLocation

      void showLocation(URL url, Reader reader) throws AuthorComponentException
      Show the location referenced by a given URL in the editor.
      If the document pointed by this URL is different than the document currently loaded in the editor page, this URL will be used to set the content to edit, to solve relative references (eg: images) and to show the location pointed by the URL reference part.
      If the document pointed by this URL is currently loaded in the editor page, only the reference part of the given URL will be used to show the corresponding location in the editor.
      Parameters:
      url - The URL to show location for.
      reader - The reader over the URL, can be null.
      Throws:
      AuthorComponentException - When there was a load problem (eg: IOException).

    • addAuthorComponentListener

      void addAuthorComponentListener(AuthorComponentListener listener)
      Adds an author component listener.
      Parameters:
      listener - The listener.

    • removeAuthorComponentListener

      void removeAuthorComponentListener(AuthorComponentListener listener)
      Removes an author component listener.
      Parameters:
      listener - The listener.

    • getAdditionalEditHelper

      JComponent getAdditionalEditHelper(int helperID)
      Get an additional edit helper panel. It can be the outline, attributes, entities, elements or model helper component, depending on the ID.
      Parameters:
      helperID - One of:
      • ATTRIBUTES_PANEL_ID,
      • ELEMENTS_PANEL_ID,
      • ENTITIES_PANEL_ID,
      • MODEL_PANEL_ID,
      • OUTLINER_PANEL_ID constants.
      Returns:
      The additional component.