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

Class DITAMapTreeComponentProvider

java.lang.Object
ro.sync.ecss.extensions.api.component.InternalComponentProvider
ro.sync.ecss.extensions.api.component.ditamap.DITAMapTreeComponentProvider
All Implemented Interfaces:
ComponentProvider
@API(type=NOT_EXTENDABLE, src=PRIVATE) public class DITAMapTreeComponentProvider extends ro.sync.ecss.extensions.api.component.InternalComponentProvider implements ComponentProvider
A component encapsulating editing a DITA Map in a DITA Maps Manager tree-like structure.
Since:
14

  • Field Details

    • messages

      protected static final ro.sync.i18n.MessageBundle messages
      The messages resource bundle.

    • detectionFinished

      protected boolean detectionFinished
      True if the detection finished

  • Constructor Details

    • DITAMapTreeComponentProvider

      public DITAMapTreeComponentProvider(ro.sync.exml.workspace.impl.component.DITAMapComponentEditorManager parentEditorManager, ro.sync.exml.editor.EditorManager mainFileOpener, Frame parentFrame) throws AuthorComponentException
      Constructor.
      Parameters:
      parentEditorManager - The parent editor manager
      mainFileOpener - The main file opener
      parentFrame - The parent frame.
      Throws:
      AuthorComponentException

  • Method Details

    • save

      public void save()
      Save the content back to the original URL from where it was loaded using the internal support. Useful only when you provide an initial URL from which the component is loaded.

    • load

      public 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.

      Specified by:
      load in interface ComponentProvider
      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).

    • createReader

      public Reader createReader()
      Create a reader over the editor's current page content
      Returns:
      The reader over the current page's content

    • addDITAMapTreeComponentListener

      public void addDITAMapTreeComponentListener(DITAMapTreeComponentListener listener)
      Adds a component listener.
      Parameters:
      listener - The listener.

    • removeAuthorComponentListener

      public void removeAuthorComponentListener(DITAMapTreeComponentListener listener)
      Removes a component listener.
      Parameters:
      listener - The listener.

    • getEditorComponent

      public Component getEditorComponent()
      Description copied from interface: ComponentProvider
      Get the main editor panel.
      Specified by:
      getEditorComponent in interface ComponentProvider
      Returns:
      The editor panel.

    • getStatusComponent

      public Component getStatusComponent()
      Description copied from interface: ComponentProvider
      Get the status panel which shows the status of the edited document.
      Specified by:
      getStatusComponent in interface ComponentProvider
      Returns:
      The status panel.

    • getDITACommonActions

      @Deprecated public Map<String,AbstractAction> getDITACommonActions()
      Deprecated.
      Please use instead the method getDITAAccess().getActionsProvider().getActions().
      Get the map of DITA Map common actions (undo, redo, cut, copy, paste, etc).
      Returns:
      The map with (action id, AbstractAction) pairs with the actions defined for working in the DITA Map.

    • isModified

      public boolean isModified()
      Returns:
      true if the component is modified.

    • setModified

      public void setModified(boolean modified)
      Sets the modified status.
      Parameters:
      modified - true to flag as modified.

    • getWSEditorAccess

      public WSEditor getWSEditorAccess()
      Get the access to the WS Editor.
      Specified by:
      getWSEditorAccess in interface ComponentProvider
      Returns:
      The editor access.

    • getEditorKey

      public ro.sync.exml.editor.AbstractEditor getEditorKey()
      Specified by:
      getEditorKey in class ro.sync.ecss.extensions.api.component.InternalComponentProvider
      Returns:
      The editor.

    • getDITAAccess

      public WSDITAMapEditorPage getDITAAccess()
      Get the page access used to perform various operations on the DITA Map tree.
      Returns:
      The page access.

    • setEditorPopUpCustomizer

      public void setEditorPopUpCustomizer(DITAMapPopupMenuCustomizer popUpCustomizer)
      The Pop-up customizer can be used to add/remove actions from the pop-up menu in the DITA Map tree editor before showing it. If everything is removed then the menu will not be shown.
      Parameters:
      popUpCustomizer - The pop Up Customizer.

    • print

      public void print(boolean preview)
      Print the DITA Map component content. Shows the Print dialog.
      Specified by:
      print in interface ComponentProvider
      Parameters:
      preview - true to show the Print Preview dialog, false to show the Print dialog.