Oxygen XML Editor 16.1 Author API

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

java.lang.Object
  extended by 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

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.
 java.lang.String getDescription()
          Gets a short description used to explain this resolving to the user.
 java.util.LinkedHashSet<EnumerationDefInfo> getEnumerationDefinitions(java.net.URL originatorURL)
          Get the list of enumeration defs (detected in a subject scheme referenced in the context DITA Map).
 
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

getEnumerationDefinitions

public java.util.LinkedHashSet<EnumerationDefInfo> getEnumerationDefinitions(java.net.URL originatorURL)
Get the list of enumeration defs (detected in a subject scheme referenced in the context DITA Map). These are used to control the values allowed for certain attributes. The set can be null. 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 (when editing a keyref attribute or using the "Edit Profiling Attributes" dialog).
Returns:
the set of enumeration defs (detected in a subject scheme referenced in the context DITA Map).
Since:
15

getDescription

public java.lang.String getDescription()
Gets a short description used to explain this resolving to the user.

Returns:
A description used to explain this resolving to the user.
Since:
15

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.