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

Interface ComponentProvider

All Known Subinterfaces:
EditorComponentProvider
All Known Implementing Classes:
AbstractComponentProvider, AuthorComponentProvider, DITAMapTreeComponentProvider, GenericEditorComponentProvider
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface ComponentProvider
Base interface for Editor and for DITA Map component providers with common methods.
Since:
15

  • Method Details

    • load

      void load(URL url, Reader reader) throws AuthorComponentException
      Sets the content to edit.

      This does not guarantee that the set content has been interpreted, you should set an AuthorComponentListener and listen for documentTypeChanged() before using the author extension actions.

      Parameters:
      url - URL to load, can be null if the reader is specified If no XML content reader is given, the URL will be used both to obtain the content and to solve relative references (eg: images). If the XML content reader is also given, the URL will only be used to solve relative references from the file.
      reader - The reader.
      Throws:
      AuthorComponentException - When there was a load problem (eg: IOException).

    • getEditorComponent

      Component getEditorComponent()
      Get the main editor panel.
      Returns:
      The editor panel.

    • getStatusComponent

      Component getStatusComponent()
      Get the status panel which shows the status of the edited document.
      Returns:
      The status panel.

    • print

      void print(boolean preview)
      Print the component content. Shows the Print dialog.
      Parameters:
      preview - true to show the Print Preview dialog, false to show the Print dialog.

    • getWSEditorAccess

      WSEditor getWSEditorAccess()
      Get the access to the WS Editor.
      Returns:
      The author access.