Package 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 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 <topicmeta> is defined, the content of the key will be extracted from that particular <topicmeta>. 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

  • Constructor Details

    • MetaContentProvider

      public MetaContentProvider()

  • Method Details

    • getContent

      public abstract String getContent(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.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      See Also:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      See Also: