Oxygen XML Editor 16.1 Author API

ro.sync.ecss.extensions.api.structure
Class AuthorBreadCrumbCustomizer

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

@API(type=EXTENDABLE,
     src=PUBLIC)
public class AuthorBreadCrumbCustomizer
extends java.lang.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 Summary
AuthorBreadCrumbCustomizer()
           
 
Method Summary
 void customizePopUpMenu(java.lang.Object popUp, AuthorAccess authorAccess)
          Customize a pop-up menu in the Author page before showing it.
 void customizePopUpMenu(java.lang.Object popUp, AuthorAccess authorAccess, AuthorNode clickedNode)
          Customize a pop-up menu in the Author page before showing it.
 void customizeRenderingInformation(RenderingInformation renderInfo)
          Customize the tooltip, text and additional info to be presented in the Outline and Breadcrumb for the given node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthorBreadCrumbCustomizer

public AuthorBreadCrumbCustomizer()
Method Detail

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.

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(java.lang.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:
AuthorPopupMenuCustomizer.customizePopUpMenu(java.lang.Object, ro.sync.ecss.extensions.api.AuthorAccess)

customizePopUpMenu

public void customizePopUpMenu(java.lang.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

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.