ro.sync.exml.workspace.api.editor.page.ditamap.keys
Class MetaContentProvider

java.lang.Object
  ro.sync.exml.workspace.api.editor.page.ditamap.keys.MetaContentProvider

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

According to the: http://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/processing_key_references.html and: http://dita.xml.org/resource/dita-tc-faq-about-keys#Q2 if a node of a certain type makes a keyref to a topic ref on which is defined, the content of the key will be extracted from that particular . This content will appear inline in the Author page for that particular keyref. It will also appear in the documentation window when the value for a keyref is computed. The API will get called by Oxygen either when the content completion shows the user descriptions for each key reference or when the content of a keyref is shown as static text in the editor.

Since:

14.1

*********************************
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.

Constructor Summary

MetaContentProvider()

Method Summary

abstract java.lang.String

getContent(java.lang.String nodeClass) Get as text the keyref content.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaContentProvider

public MetaContentProvider()

Method Detail

getContent

public abstract java.lang.String getContent(java.lang.String nodeClass)

Get as text the keyref content. For an XML like:
<keyword keyref="test"/>
the method gets called like: getKeyRefContent("- topic/keyword ")

Parameters:

nodeClass - The "@class" of the node which links.

Returns:

The content or null if it cannot be determined.