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

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

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

Provides information about all key definitions which are a context for all opened topics. This is implemented on the API side.

Since:

14

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

KeyDefinitionManager()

Method Summary

abstract java.util.List<KeyDefinitionInfo>	getContextKeyDefinitions() Get the key definitions which will be used as a context for solving all conkeyref and keyref references in the opened DITA topics.
java.util.List<KeyDefinitionInfo>	getContextKeyDefinitions(java.net.URL originatorURL) Get the key definitions which will be used as a context for solving all conkeyref and keyref references in the opened DITA topics.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyDefinitionManager

public KeyDefinitionManager()

Method Detail

getContextKeyDefinitions

public abstract java.util.List<KeyDefinitionInfo> getContextKeyDefinitions()

Get the key definitions which will be used as a context for solving all conkeyref and keyref references in the opened DITA topics. This method might be asked quite often so it could be cached on the implementor's side.

Returns:

the key definitions which will be used as a context for solving all conkeyref and keyref references in the opened DITA topics.

getContextKeyDefinitions

public java.util.List<KeyDefinitionInfo> getContextKeyDefinitions(java.net.URL originatorURL)

Get the key definitions which will be used as a context for solving all conkeyref and keyref references in the opened DITA topics. This method might be asked quite often so it could be cached on the implementor's side.

Parameters:

originatorURL - The DITA topic or map for which the keys are requested to resolve something (either a clicked keyref or a conkeyref).

Returns:

the key definitions which will be used as a context for solving all conkeyref and keyref references in the opened DITA topics.

Since:

14.2

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