ro.sync.ecss.extensions.api.structure

Class AuthorOutlineCustomizer

java.lang.Object

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

All Implemented Interfaces:

AuthorNodeRendererCustomizer, AuthorPopupMenuCustomizer

@API(type=EXTENDABLE,
     src=PUBLIC)
public class AuthorOutlineCustomizer
extends java.lang.Object
implements AuthorNodeRendererCustomizer, AuthorPopupMenuCustomizer

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

Since:

11.2

Constructor Summary

Constructors

Constructor and Description
AuthorOutlineCustomizer()

Method Summary

Modifier and Type	Method and Description
void	customizePopUpMenu(java.lang.Object popUp, AuthorAccess authorAccess) Customize a pop-up menu in the Author page before showing it.
void	customizeRenderingInformation(RenderingInformation renderInfo) If you need to change the way the XML elements are displayed, you may consider using a configuration file.
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)

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

See Also:

AuthorNodeRendererCustomizer.customizeRenderingInformation(ro.sync.ecss.extensions.api.structure.RenderingInformation)

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)