Oxygen XML Editor 11.2 Author API

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

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

public class AuthorOutlineCustomizer
extends Object
implements AuthorNodeRendererCustomizer, AuthorPopupMenuCustomizer

Author Outline customizer used for custom filtering and nodes rendering in the Outline.

*********************************
EXPERIMENTAL - Subject to change
*********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Since:
11.2

Constructor Summary
AuthorOutlineCustomizer()
           
 
Method Summary
 void customizePopUpMenu(Object popUp, AuthorAccess authorAccess)
          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.
 boolean ignoreNode(AuthorNode node)
          If true this node and all its descendants are not shown in the Outline.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthorOutlineCustomizer

public AuthorOutlineCustomizer()
Method Detail

ignoreNode

public boolean ignoreNode(AuthorNode node)
If true this node and all its descendants are not shown in the Outline.

Parameters:
node - The node to check for ignore.
Returns:
True if the given node and its descendants will not be presented in the Outline.

customizeRenderingInformation

public void customizeRenderingInformation(RenderingInformation renderInfo)
Description copied from interface: AuthorNodeRendererCustomizer
Customize the tooltip, text and additional info to be presented in the Outline and Breadcrumb for the given 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
See Also:
AuthorNodeRendererCustomizer.customizeRenderingInformation(ro.sync.ecss.extensions.api.structure.RenderingInformation)

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

Oxygen XML Editor 11.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.