com.oxygenxml.editor.editors.dita

Class LinkTextResolverCustomizer

java.lang.Object

com.oxygenxml.editor.editors.dita.LinkTextResolverCustomizer

@API(type=EXTENDABLE,
     src=PUBLIC)
public class LinkTextResolverCustomizer
extends java.lang.Object

Abstract class allowed as an extension point to customize the resolution of the text which appears on DITA xrefs. In your plugin in the plugin.xml you should reference it like:

 
  <extension point="oxygen.plugin.id.ditaLinkTextResolverCustomizer">
     <implementation class="my.package.CustomLinkTextResolverCustomizer"/>;
    </extension>

Since:

17

Constructor Summary

Constructors

Constructor and Description
LinkTextResolverCustomizer()

Method Summary

Modifier and Type	Method and Description
java.lang.String	computeLinkText(java.lang.String hrefValue, java.lang.String baseSystemID) Compute the link text to appear on a certain DITA xref or link based on the href and base system ID values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkTextResolverCustomizer

public LinkTextResolverCustomizer()

Method Detail

computeLinkText

public java.lang.String computeLinkText(java.lang.String hrefValue,
                                        java.lang.String baseSystemID)
                                 throws java.lang.Exception

Compute the link text to appear on a certain DITA xref or link based on the href and base system ID values.

Parameters:

hrefValue - The value of the reference.

baseSystemID - The base system ID

Returns:

The computed link text or null to continue the default processing.

Throws:

java.lang.Exception