Class AuthorBreadCrumbCustomizer

java.lang.Object
ro.sync.ecss.extensions.api.structure.AuthorBreadCrumbCustomizer
All Implemented Interfaces:
AuthorNodeRendererCustomizer, AuthorPopupMenuCustomizer

@API(type=EXTENDABLE, src=PUBLIC) public class AuthorBreadCrumbCustomizer extends Object implements AuthorNodeRendererCustomizer, AuthorPopupMenuCustomizer
Author Bread Crumb (components path which appears in the top of the Author editor) customizer used for nodes rendering and pop-up customization.
Since:
11.2
  • Constructor Details

    • AuthorBreadCrumbCustomizer

      public AuthorBreadCrumbCustomizer()
  • Method Details

    • customizeRenderingInformation

      public void customizeRenderingInformation(RenderingInformation renderInfo)
      Customize the tooltip, text and additional info to be presented in the Outline and Breadcrumb for the given node. The breadcrumb cannot assign a certain icon for a rendered node. By default a node is represented in the Outline by its tag name and a additional information obtained from a specific attribute or text. You can set custom values for each rendered field. If you need to change the way the XML elements are displayed, you may consider using a configuration file. For more information, search the oXygen documentation for "cc_config.xml" configuration file. For DITA, this file is in "frameworks/dita/resources/cc_config.xml".
      Specified by:
      customizeRenderingInformation in interface AuthorNodeRendererCustomizer
      Parameters:
      renderInfo - The default information which will get displayed. You can set custom values for each field
    • customizePopUpMenu

      public void customizePopUpMenu(Object popUp, AuthorAccess authorAccess)
      Description copied from interface: AuthorPopupMenuCustomizer
      Customize a pop-up menu in the Author page before showing it. If everything is removed then the menu will not be shown.
      For the standalone implementation the object is a JPopupMenu.
      For the eclipse implementation the object is a IMenuManager.
      Specified by:
      customizePopUpMenu in interface AuthorPopupMenuCustomizer
      Parameters:
      popUp - The pop-up Menu.
      authorAccess - Access class to the author functions.
      See Also:
    • customizePopUpMenu

      public void customizePopUpMenu(Object popUp, AuthorAccess authorAccess, AuthorNode clickedNode)
      Customize a pop-up menu in the Author page before showing it. If everything is removed then the menu will not be shown.
      For the standalone implementation the object is a JPopupMenu.
      For the eclipse implementation the object is a IMenuManager.
      Parameters:
      popUp - The pop-up Menu.
      authorAccess - Access class to the author functions.
      clickedNode - The current clicked node in the Author page.
      Since:
      14.2