Class DITAMapNodeRendererCustomizer
- java.lang.Object
-
- ro.sync.exml.workspace.api.node.customizer.XMLNodeRendererCustomizer
-
- ro.sync.exml.workspace.api.editor.page.ditamap.DITAMapNodeRendererCustomizer
-
- All Implemented Interfaces:
Extension
@API(type=EXTENDABLE, src=PUBLIC) public abstract class DITAMapNodeRendererCustomizer extends XMLNodeRendererCustomizer
Node renderer customizer specific for the DITA Maps Manager.- Since:
- 18.1
-
-
Constructor Summary
Constructors Constructor Description DITAMapNodeRendererCustomizer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
customizeComputedTopicrefTitle(AuthorNode topicref, AuthorNode targetTopicOrMap, java.lang.String defaultComputedTitle)
Customize the default computed topicref title.java.lang.String
customizeRenderedTopicrefTitle(AuthorNode topicref, java.lang.String defaultRenderedTitle)
Customize the default rendered topicref title.java.lang.String
getDescription()
BasicRenderingInformation
getRenderingInformation(NodeRendererCustomizerContext context)
Override this to provide extra rendering information.
-
-
-
Method Detail
-
customizeComputedTopicrefTitle
public java.lang.String customizeComputedTopicrefTitle(AuthorNode topicref, AuthorNode targetTopicOrMap, java.lang.String defaultComputedTitle)
Customize the default computed topicref title. After the API returns the modified title, the title will be cached for the current referenced topic. So this method is called usually once for every individual referenced topic. This kind of method is useful for example if you want to get some significant attributes (maybe profiling attributes) from the topic's root element and display them in the title.- Parameters:
topicref
- The topicref node present in the DITA Maps ManagertargetTopicOrMap
- Oxygen already parsed the document referenced via topicref, computed a title and this parameter gives you access to the root element of the parsed topic.defaultComputedTitle
- The default title computed by Oxygen- Returns:
- The customized topic title.
-
customizeRenderedTopicrefTitle
public java.lang.String customizeRenderedTopicrefTitle(AuthorNode topicref, java.lang.String defaultRenderedTitle)
Customize the default rendered topicref title. This method is called very often, each time the tree or part of the tree is rendered. It is also called separately if there are multiple topicrefs pointing to the same topic. This kind of method is useful for example if you want to number topicrefs displayed in the DITA Maps Manager view based on depth.- Parameters:
topicref
- The topicref node present in the DITA Maps ManagerdefaultRenderedTitle
- The default title which will be rendered by Oxygen- Returns:
- The customized topic title.
- Since:
- 21
-
getRenderingInformation
public BasicRenderingInformation getRenderingInformation(NodeRendererCustomizerContext context)
Override this to provide extra rendering information. The context is an instance ofDITAMapNodeRendererCustomizerContext
which has more information about topicrefs.- Specified by:
getRenderingInformation
in classXMLNodeRendererCustomizer
- Parameters:
context
- The node context(contains information like node name, namespace and attributes).- Returns:
- The rendering information.
If the returned value is
null
then the default node rendering will be used. - See Also:
XMLNodeRendererCustomizer.getRenderingInformation(ro.sync.exml.workspace.api.node.customizer.NodeRendererCustomizerContext)
-
getDescription
public java.lang.String getDescription()
- Returns:
- The description of the extension.
- See Also:
Extension.getDescription()
-
-