|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.exml.workspace.api.editor.page.ditamap.keys.KeyDefinitionManager
@API(type=NOT_EXTENDABLE, src=PUBLIC) public abstract class KeyDefinitionManager
Provides information about all key definitions which are a context for all opened topics. This is implemented on the API side.
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 |
---|
public KeyDefinitionManager()
Method Detail |
---|
public abstract java.util.List<KeyDefinitionInfo> getContextKeyDefinitions()
public java.util.List<KeyDefinitionInfo> getContextKeyDefinitions(java.net.URL originatorURL)
originatorURL
- The DITA topic or map for which the keys are requested to resolve something (either a clicked keyref or a conkeyref).
public java.util.LinkedHashSet<EnumerationDefInfo> getEnumerationDefinitions(java.net.URL originatorURL)
null
.
This method might be asked quite often so it could be cached on the implementor's side.
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).
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.
public java.lang.String getDescription()
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.
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |