DITAAccess (Oxygen XML API)

java.lang.Object
- ro.sync.ecss.dita.DITAAccess

@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public class DITAAccess
extends java.lang.Object

Utility methods for DITA interaction.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DITAAccess.InsertLinkReferenceShortcut` Short cut for the insert link operation.
`static class`	`DITAAccess.PasteInfo` Paste type of clipboard fragments.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONKEYREF_TYPE` Conkeyref
`static int`	`CONREF_TYPE` Conref
`static java.lang.String`	`DEFAULT_CONKEYREF_CONREFEND` Value for conrefend attribute value when a conkeyref is used.
`static java.lang.String`	`DITA_ROOT_MAP_URL_ATTRIBUTE` The attribute name for the dita root map url.
`static java.lang.String`	`ID_ANY` Identifier used in references path, representing that the topic id can be excluded from the reference.
`static int`	`INHERITANCE_GENERALIZATION` If the source is a generalization of the target
`static int`	`INHERITANCE_NONE` No match between the two classes..
`static int`	`INHERITANCE_SAME` If the source class is the same as the target class.
`static int`	`INHERITANCE_SPECIALIZATION` If the source is a specialization of the target
`static int`	`KEYREF_TYPE` Keyref
`static java.lang.String`	`LINK_TYPE_DITA_TOPIC` The 'href' attribute type DITA topic.
`static java.lang.String`	`LINK_TYPE_NON_DITA_RESOURCE` The 'href' attribute type non DITA resource.
`static java.lang.String`	`LINK_TYPE_WEB_PAGE` The 'href' attribute type web page.
`protected static ro.sync.exml.MessageBundle`	`messages` The messages resource bundle.
`static java.lang.String[]`	`REF_ATTRIBUTES` DITA reference attributes.

Constructor Summary

Constructors
Constructor and Description

DITAAccess()

Constructors
Constructor and Description
`DITAAccess()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addEditReference(AuthorAccess authorAccess)` Add a new conref to the current element or edit the existing one.
`static java.util.List<CIAttribute>`	`annotateAttributes(java.util.List<CIAttribute> attributes)` Annotate a list of attributes.
`protected static int`	`checkConsecutiveInsertionWarning(int previousOperationOffset, int selectionStart, int selectionEnd, ro.sync.ecss.dita.reference.ReferenceInfo previousReferenceInfo, ro.sync.ecss.dita.reference.ReferenceInfo currentReferenceInfo)` Show a warning message when consecutive insertion of the same references are performed.
`static java.lang.String`	`checkValidKeyName(java.lang.String keyName)` Check if a keyref has a valid key name.
`static java.lang.String`	`checkValidKeyRef(java.lang.String keyref)` Check if a keyref has a valid key name.
`static ro.sync.ecss.dita.ImageInfo`	`chooseImageReference(AuthorAccess authorAccess)` Allows the user to choose an image reference, which will be inserted inside the document.
`static ro.sync.ecss.dita.MediaInfo`	`chooseMediaReference(AuthorAccess authorAccess)` Allows the user to choose an media file reference, which will be inserted inside the document.
`static java.lang.String`	`computeElementClazz(WhatPossibleValuesHasAttributeContext context)` Compute the element's clazz
`static java.lang.String`	`computeImageReferenceXMLToInsert(AuthorAccess authorAccess, java.lang.String refAttrName, java.lang.String refValue)` Compute the image reference XML fragment to insert.
`static java.lang.String`	`computeLinkText(AuthorNode contextNode, java.lang.String hrefValue, java.lang.String baseSystemID)` Obtains information about the referred target.
`static java.lang.String`	`computeLinkText(java.lang.String hrefValue, java.lang.String baseSystemID)` Obtains information about the referred target.
`static void`	`createNewTopicReference(AuthorAccess authorAccess)` Create a new DITA topic and link to it as a reference.
`static void`	`createReusableComponent(AuthorAccess authorAccess, ro.sync.ecss.extensions.api.DITAUniqueIDAssigner idsAssigner)` Reuse the selected content.
`static void`	`editProperties(AuthorAccess authorAccess)` Edit properties for the given reference elements.
`static void`	`editProperties(java.net.URL location, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, AuthorElement[] elementsToEdit, ro.sync.ecss.dita.topic.ref.TopicRefInserter topicRefInserter, java.lang.Object parentFrame, boolean displayReferenceUrl)` Edit properties for the given reference elements.
`static void`	`editTopicref(AuthorElement[] topicrefNodes, AuthorAccess authorAccess)` Edits one or more topicref elements inside a specialized dialog.
`static void`	`exportDITAMap(java.net.URL ditamapURL, java.io.File exportDirectory, boolean exportAsZip, java.lang.String zipFileName, ExportProgressUpdater progressUpdater)` Export DITA Map as zip.
`static java.util.List<CIValue>`	`filterAttributeValues(java.util.List<CIValue> attributeValues, WhatPossibleValuesHasAttributeContext context, ContextKeyManager keyManager, java.lang.String documentTypeName, AuthorAccess authorAccess)` Propose additional attribute values.
`static java.util.List<CIValue>`	`filterAttributeValues(java.util.List<CIValue> attributeValues, WhatPossibleValuesHasAttributeContext context, java.lang.String documentTypeName)` Deprecated. Please use the equivalent method which also receives the URL of the requestor.
`static java.util.List<CIValue>`	`filterAttributeValues(java.util.List<CIValue> attributeValues, WhatPossibleValuesHasAttributeContext context, java.lang.String documentTypeName, AuthorAccess authorAccess)` Propose additional attribute values.
`static java.util.List<CIValue>`	`filterDITAVALAttributeValues(java.util.List<CIValue> attributeValues, WhatPossibleValuesHasAttributeContext context)` Filter DITAVAL Attribute values.
`static java.util.List<CIElement>`	`filterElements(java.util.List<CIElement> elements, WhatElementsCanGoHereContext context)` Filter the given elements according to the given context.
`static java.lang.String`	`getAPIKeysManagerDescription()`
`static java.lang.String`	`getAutoInsertImageRefElementName(AuthorAccess authorAccess, int caretPosition)` Get the name of the image element to insert.
`static java.lang.String`	`getAutoInsertRefElementName(AuthorAccess authorAccess, int caretPosition)` Get the name of the topic ref element to insert
`static java.lang.String`	`getAutoInsertTopicRefElementName(AuthorAccess authorAccess, int caretPosition)` Get the name of the topic ref element to insert
`static java.util.List<DitaReferenceTargetDescriptor>`	`getDitaReferenceTargets(AuthorAccess authorAccess, java.net.URL targetURL)` Returns the DITA reference targets in the given topic.
`static CIElement`	`getEquivalentChildCIElement(AuthorAccess authorAccess, int caretOffset, java.lang.String tagName)` Get the equivalent child CIElement
`static java.lang.String`	`getFormat(java.lang.String hrefValue, java.lang.String formatValue, boolean fillFormatAttr)` Get the format for the specified resource.
`static HrefInfo`	`getHrefInformation(AuthorNode node)` Get the reference information (by analizing attributes like keyref, href, mapref, ...) of a node.
`static int`	`getInheritanceType(java.lang.String sourceClass, java.lang.String targetClass)` Check what inheritance is between the two classes.
`static ro.sync.ecss.dita.topic.group.TopicgroupInfo`	`getInsertTopicgroup(java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, int caretOffset)` Deprecated. This method is not used anymore from oXygen to insert topic group elements and it will be removed in a future release. All topic reference elements are inserted using the same method: `#insertTopicReference(URL, Object, AuthorCCManager, AuthorDocumentController, int, String, TopicRefInserter, String, boolean)`
`static ro.sync.ecss.dita.topic.TopicInfo`	`getInsertTopichead(java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, int caretOffset)` Deprecated. This method is not used anymore from oXygen to insert topichead elements and it will be removed in a future release. All topic reference elements are inserted using the same method: `#insertTopicReference(URL, Object, AuthorCCManager, AuthorDocumentController, int, String, TopicRefInserter, String, boolean)`
`static void`	`getInsertTopicref(java.net.URL editorLocation, java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, AuthorDocumentController ctrl, int caretOffset, java.lang.String initialTopicRefLocation, ro.sync.ecss.dita.topic.ref.TopicRefInserter inserter, java.lang.String preferredElementName, boolean displayReferenceUrl)` Insert a topic reference.
`static java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo>`	`getKeys()` Deprecated. Please use the equivalent method which also receives the URL of the requestor.
`static java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo>`	`getKeys(java.net.URL originatorURL)`
`static java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo>`	`getKeys(java.net.URL originatorURL, ContextKeyManager keysManager)` Returns the mapped DITA 1.2 keys
`static java.util.List<ro.sync.ecss.dita.reference.keyref.KeyInfo>`	`getKeysForInsertion(java.net.URL originatorURL)`
`static ro.sync.ecss.dita.map.TitleInfo`	`getNewMapTitle(java.lang.Object parentFrame, java.lang.String oldTitle, boolean preferTitleAttribute)` Deprecated. This method is not used anymore from oXygen to edit map titles and it will be removed in a future release. The map root is now edited using the following method: `editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)`
`static java.lang.String`	`getPossibleElementQName(AuthorDocumentController ctrl, java.lang.String clazzFrag, java.lang.String mostUsed)` Obtain the qualified name of the element with the given class, which will be inserted in the document.
`static CIElement[]`	`getPossibleElements(ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, ro.sync.ecss.contentcompletion.AuthorCCManager ccManager, int offset, java.lang.String reqAttr, java.lang.String... classFrag)` Get the possible elements that can be inserted at a given offset and have the class 'classFrag' and a 'reqAttr' attribute.
`static java.net.URL`	`getRootMapURL()` Get DITA root map URL.
`static ro.sync.ecss.dita.topic.group.TopicgroupInfo`	`getTopicGroupInfo(java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, int caretOffset, ro.sync.ecss.dita.topic.group.TopicgroupInfo initialTopicrefInfo)` Deprecated. This method is not used anymore from oXygen to edit topic group elements and it will be removed in a future release. All topic reference elements are edited using the same method: `editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)`
`static ro.sync.ecss.dita.topic.head.TopicheadInfo`	`getTopicHeadInfo(java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, int caretOffset, ro.sync.ecss.dita.topic.head.TopicheadInfo initialHeadInfo)` Deprecated. This method is not used anymore from oXygen to edit topichead elements and it will be removed in a future release. All topic reference elements are edited using the same method: `editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)`
`static void`	`getTopicRefInfo(java.net.URL location, java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl, int caretOffset, ro.sync.ecss.dita.topic.ref.TopicrefInfo initialTopicrefInfo, ro.sync.ecss.dita.topic.ref.TopicRefInserter inserter)` Deprecated. This method is not used anymore from oXygen to insert topic reference elements and it will be removed in a future release. All topic reference elements are inserted using the same method: `editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)`
`static java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>>`	`getURLKeyScopeContexts(java.net.URL originatorURL)` Get the URL to key scopes context for the default keys manager.
`static java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>>`	`getURLKeyScopeContexts(java.net.URL originatorURL, ContextKeyManager keysManager)` Returns a mapping between topic URLs and DITA 1.3 key scopes where the URLs are referenced.
`static void`	`handleTopicRefInsertUrl(AuthorAccess authorAccess, java.net.URL topicUrl)` Insert a topic ref with the given URL.
`static boolean`	`hasAPIKeysManager()`
`static void`	`insertContentReference(AuthorAccess authorAccess, java.net.URL initialReferenceURL, boolean displayReferenceUrl)` Shows a dialog that allows inserting a content reference (conref).
`static void`	`insertHref(AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, boolean isHrefTypeDitaTopic)` Insert a Xref.
`static void`	`insertHref(AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, boolean isHrefTypeDitaTopic, java.net.URL initialReferenceURL, boolean displayReferenceUrl)` Insert a Xref or link element.
`static void`	`insertImage(AuthorAccess authorAccess, ro.sync.ecss.dita.ImageInfo ref)` Insert a DITA Image.
`static void`	`insertImage(AuthorAccess authorAccess, java.lang.String ref)` Insert a DITA Image
`static SchemaAwareHandlerResult`	`insertImageSchemaAware(AuthorAccess authorAccess, ro.sync.ecss.dita.ImageInfo reference)` Insert a DITA image.
`static SchemaAwareHandlerResult`	`insertImageSchemaAware(AuthorAccess authorAccess, java.lang.String ref)` Insert a DITA Image
`static SchemaAwareHandlerResult`	`insertImageSchemaAware(AuthorAccess authorAccess, java.lang.String refAttrName, java.lang.String refValue)` Insert a DITA Image
`static void`	`insertKeydefWithKeyword(java.lang.Object parentFrame, ro.sync.ecss.contentcompletion.AuthorCCManager ccM, AuthorDocumentController ctrl, int caretOffset, ro.sync.ecss.dita.topic.ref.TopicRefInserter inserter, boolean append)` Insert a key definition with keyword.
`static void`	`insertLinkReference(AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, java.lang.String preferredElName, java.lang.String hrefType, java.net.URL initialReferenceURL, boolean displayReferenceUrl)` Insert a Xref or link element.
`static void`	`insertLinkReference(AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, java.lang.String preferredElName, java.lang.String hrefType, java.net.URL initialReferenceURL, boolean displayReferenceUrl, DITAAccess.InsertLinkReferenceShortcut insertLinkReferenceShortcut)` Insert a Xref or link element.
`static void`	`insertLinkReference(AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, java.lang.String hrefType, java.net.URL initialReferenceURL, boolean displayReferenceUrl)` Insert a Xref or link element.
`static void`	`insertLinkReference(AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, java.lang.String hrefType, java.net.URL initialReferenceURL, boolean displayReferenceUrl, DITAAccess.InsertLinkReferenceShortcut insertLinkReferenceShortcut)` Insert a Xref or link element.
`static void`	`insertLinkReference(java.lang.String referenceValue, java.lang.String targetElementClass, java.lang.String targetElementQName, AuthorAccess authorAccess, java.lang.String typeValue, java.lang.String formatValue, java.lang.String scopeValue, boolean isXref, java.lang.String hrefType)` Insert a Xref or link element.
`static void`	`insertMedia(AuthorAccess authorAccess, ro.sync.ecss.dita.MediaInfo ref)` Insert a media object.
`static SchemaAwareHandlerResult`	`insertMediaSchemaAware(AuthorAccess authorAccess, ro.sync.ecss.dita.MediaInfo reference)` Insert a DITA media object.
`static void`	`insertReference(AuthorAccess authorAccess, int refType)` Insert a keyref or a conkeyref.
`static void`	`insertReference(AuthorAccess authorAccess, java.lang.String referenceValue, java.lang.String targetElementQName, java.lang.String elementClass)` Inserts a reference from the information passed in the ArgumentsMap.
`static void`	`insertReusableComponent(AuthorAccess authorAccess)` Insert a reusable component
`static void`	`insertTopicgroup(AuthorAccess authorAccess)` Insert a topic group.
`static void`	`insertTopichead(AuthorAccess authorAccess)` Insert a topic head.
`static void`	`insertTopicref(AuthorAccess authorAccess)` Insert a topic ref.
`static void`	`insertTopicref(AuthorAccess authorAccess, java.net.URL initialReferenceURL, boolean displayReferenceUrl)` Insert a topic reference.
`static void`	`insertTopicref(WSDITAMapEditorPage ditaPageAccess, java.net.URL initialReferenceURL, java.lang.String preferredElementName, boolean asChild, boolean displayReferenceUrl)` Insert a topic reference in the DITA Map tree.
`static boolean`	`isDITA1_3OrNewer(java.lang.String archVersion)` Check if the topic or map with a certain architecture version is DITA 1.3 or newer,
`static boolean`	`isGeneralizationOf(java.lang.String sourceClass, java.lang.String targetClass)` True if the first class value is a generalization or the same as the second class value.
`static Reference`	`parseDITAHref(java.lang.String baseUrl, java.lang.String hrefValue)` Parse the `href` attribute and returns the absolute URL and the id.
`static Reference`	`parseDITAKeyRef(java.lang.String keyref)` Deprecated. Please use the equivalent method which also receives the URL of the requestor.
`static Reference`	`parseDITAKeyRef(java.lang.String keyref, ro.sync.ecss.dita.reference.keyref.KeyResolver kr)` Parse the DITA conkeyref value
`static Reference`	`parseDITAKeyRef(java.net.URL originatorURL, ContextKeyManager keyManager, java.lang.String keyref)` Parse the DITA conkeyref value
`static Reference`	`parseDITAKeyRef(java.net.URL originatorURL, java.lang.String keyref)` Parse the DITA conkeyref value
`static java.lang.String`	`pasteAsReference(AuthorAccess authorAccess, boolean asConref)` Paste as reference
`static java.lang.String`	`pasteAsReference(AuthorAccess authorAccess, DITAAccess.PasteInfo pasteInfo)` Paste as reference
`static boolean`	`pasteClipboardFragmentsAsReference(AuthorAccess authorAccess, DITAAccess.PasteInfo pasteInfo, ro.sync.ecss.component.AuthorDocumentFragmentClipboardObject[] fragments)` Paste the fragments from clipboard as reference.
`static void`	`pushElement(AuthorAccess authorAccess)` Shows a dialog that allows the user to push an element.
`static void`	`removeReference(AuthorAccess authorAccess)` Remove a content reference from a DITA document.
`static void`	`replaceConref(AuthorAccess authorAccess)` Replace the conref at caret position
`static void`	`resolveKeyNotFoundError(AuthorAccess authorAccess, java.lang.String keyref)` The give key was not found.
`static java.net.URL`	`resolveKeyRef(java.lang.String keyRef)` Deprecated. Please use the equivalent method which also receives the URL of the requestor.
`static java.net.URL`	`resolveKeyRef(java.lang.String keyRef, boolean addANYIdentifierForKeys)` Deprecated. Please use the equivalent method which also receives the URL of the requestor.
`static java.net.URL`	`resolveKeyRef(java.lang.String keyRef, ro.sync.ecss.dita.reference.keyref.KeyResolver kr)` Resolve a keyref.
`static java.net.URL`	`resolveKeyRef(java.net.URL originatorURL, java.lang.String keyRef, boolean addANYIdentifierForKeys)` Resolve a keyref.
`static java.net.URL`	`resolveKeyRef(java.net.URL originatorURL, java.lang.String keyRef, ContextKeyManager keysManager, boolean addANYIdentifierForKeys)` Resolve a keyref.
`static java.lang.String`	`rewriteKeyref(java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>> urlKeyScopesMapping, java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo> keys, AuthorNode contextNode, java.lang.String keyref)` Rewrite a keyref looking also at key scopes..
`static void`	`searchReferences(AuthorAccess authorAccess)` Search references to a certain element at the caret position.
`static void`	`setDitaAccessCustomizer(ro.sync.ecss.dita.DITAAccessCustomizer ditaAccessCustomizer)` Set the DITA access customizer from SA or EC.
`static void`	`showInsertReferenceDialog(ro.sync.ecss.contentcompletion.AuthorCCManager ccManager, ro.sync.ecss.ue.AuthorDocumentControllerImpl controller, int caretOffset, java.lang.Object parentFrame, int refType, boolean showOnlyKeysList, ro.sync.ecss.dita.topic.ref.ReferenceInserter referenceInserter)` Shows the keyref/conkeyref insert dialog and returns the chosen reference information.
`static void`	`showInsertReferenceDialog(ro.sync.ecss.contentcompletion.AuthorCCManager ccManager, ro.sync.ecss.ue.AuthorDocumentControllerImpl controller, int caretOffset, java.lang.Object parentFrame, int refType, boolean showOnlyKeysList, ro.sync.ecss.dita.topic.ref.ReferenceInserter referenceInserter, ro.sync.ecss.dita.IKeyInfoFilter keysFilter, boolean useModalDialog)` Shows the keyref/conkeyref insert dialog and returns the chosen reference information.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - messages
```
protected static final ro.sync.exml.MessageBundle messages
```
    The messages resource bundle.
  - LINK_TYPE_WEB_PAGE
```
public static final java.lang.String LINK_TYPE_WEB_PAGE
```
    The 'href' attribute type web page.
    
    See Also:
    
    Constant Field Values
  - LINK_TYPE_NON_DITA_RESOURCE
```
public static final java.lang.String LINK_TYPE_NON_DITA_RESOURCE
```
    The 'href' attribute type non DITA resource.
    
    See Also:
    
    Constant Field Values
  - LINK_TYPE_DITA_TOPIC
```
public static final java.lang.String LINK_TYPE_DITA_TOPIC
```
    The 'href' attribute type DITA topic.
    
    See Also:
    
    Constant Field Values
  - DITA_ROOT_MAP_URL_ATTRIBUTE
```
public static final java.lang.String DITA_ROOT_MAP_URL_ATTRIBUTE
```
    The attribute name for the dita root map url. The attribute is given as string.
    
    See Also:
    
    Constant Field Values
  - REF_ATTRIBUTES
```
public static final java.lang.String[] REF_ATTRIBUTES
```
    DITA reference attributes.
  - DEFAULT_CONKEYREF_CONREFEND
```
public static final java.lang.String DEFAULT_CONKEYREF_CONREFEND
```
    Value for conrefend attribute value when a conkeyref is used.
    
    See Also:
    
    Constant Field Values
  - KEYREF_TYPE
```
public static final int KEYREF_TYPE
```
    Keyref
    
    See Also:
    
    Constant Field Values
  - CONREF_TYPE
```
public static final int CONREF_TYPE
```
    Conref
    
    See Also:
    
    Constant Field Values
  - CONKEYREF_TYPE
```
public static final int CONKEYREF_TYPE
```
    Conkeyref
    
    See Also:
    
    Constant Field Values
  - ID_ANY
```
public static final java.lang.String ID_ANY
```
    Identifier used in references path, representing that the topic id can be excluded from the reference.
    
    See Also:
    
    Constant Field Values
  - INHERITANCE_GENERALIZATION
```
public static final int INHERITANCE_GENERALIZATION
```
    If the source is a generalization of the target
    
    See Also:
    
    Constant Field Values
  - INHERITANCE_SPECIALIZATION
```
public static final int INHERITANCE_SPECIALIZATION
```
    If the source is a specialization of the target
    
    See Also:
    
    Constant Field Values
  - INHERITANCE_SAME
```
public static final int INHERITANCE_SAME
```
    If the source class is the same as the target class.
    
    See Also:
    
    Constant Field Values
  - INHERITANCE_NONE
```
public static final int INHERITANCE_NONE
```
    No match between the two classes..
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DITAAccess
```
public DITAAccess()
```
- Method Detail
  - insertTopicref
```
public static void insertTopicref(AuthorAccess authorAccess)
                           throws AuthorOperationException
```
    Insert a topic ref.
    
    Parameters:
    
    authorAccess - The author access.
    
    Throws:
    
    AuthorOperationException
  - handleTopicRefInsertUrl
```
public static void handleTopicRefInsertUrl(AuthorAccess authorAccess,
                                           java.net.URL topicUrl)
                                    throws AuthorOperationException
```
    Insert a topic ref with the given URL. No dialog is displayed.
    
    Parameters:
    
    authorAccess - The author access.
    
    topicUrl - The URL of the topic to be inserted.
    
    Throws:
    
    AuthorOperationException
  - insertTopicgroup
```
public static void insertTopicgroup(AuthorAccess authorAccess)
                             throws AuthorOperationException
```
    Insert a topic group.
    
    Parameters:
    
    authorAccess - The author access.
    
    Throws:
    
    AuthorOperationException
  - getTopicHeadInfo
```
@Deprecated
public static ro.sync.ecss.dita.topic.head.TopicheadInfo getTopicHeadInfo(java.lang.Object parentFrame,
                                                                                       ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                                                                       ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                                                                       int caretOffset,
                                                                                       ro.sync.ecss.dita.topic.head.TopicheadInfo initialHeadInfo)
```
    Deprecated. This method is not used anymore from oXygen to edit topichead elements and it will be removed in a future release. All topic reference elements are edited using the same method: editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
    
    Show the topic head info dialog with some initial content
    
    Parameters:
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    initialHeadInfo - Initial topic head info.
    
    Returns:
    
    The new modified content.
  - getInsertTopichead
```
@Deprecated
public static ro.sync.ecss.dita.topic.TopicInfo getInsertTopichead(java.lang.Object parentFrame,
                                                                                ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                                                                ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                                                                int caretOffset)
```
    Deprecated. This method is not used anymore from oXygen to insert topichead elements and it will be removed in a future release. All topic reference elements are inserted using the same method: #insertTopicReference(URL, Object, AuthorCCManager, AuthorDocumentController, int, String, TopicRefInserter, String, boolean)
    
    Insert a topic head.
    
    Parameters:
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    Returns:
    
    The XML fragment to insert or null if operation canceled.
  - getTopicGroupInfo
```
@Deprecated
public static ro.sync.ecss.dita.topic.group.TopicgroupInfo getTopicGroupInfo(java.lang.Object parentFrame,
                                                                                          ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                                                                          ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                                                                          int caretOffset,
                                                                                          ro.sync.ecss.dita.topic.group.TopicgroupInfo initialTopicrefInfo)
```
    Deprecated. This method is not used anymore from oXygen to edit topic group elements and it will be removed in a future release. All topic reference elements are edited using the same method: editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
    
    Show the topic group info dialog with some initial content
    
    Parameters:
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    initialTopicrefInfo - Initial topic group info.
    
    Returns:
    
    The new modified content.
  - getInsertTopicgroup
```
@Deprecated
public static ro.sync.ecss.dita.topic.group.TopicgroupInfo getInsertTopicgroup(java.lang.Object parentFrame,
                                                                                            ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                                                                            ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                                                                            int caretOffset)
```
    Deprecated. This method is not used anymore from oXygen to insert topic group elements and it will be removed in a future release. All topic reference elements are inserted using the same method: #insertTopicReference(URL, Object, AuthorCCManager, AuthorDocumentController, int, String, TopicRefInserter, String, boolean)
    
    Insert a topic group.
    
    Parameters:
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    Returns:
    
    The XML fragment to insert or null if operation canceled.
  - getTopicRefInfo
```
@Deprecated
public static void getTopicRefInfo(java.net.URL location,
                                                java.lang.Object parentFrame,
                                                ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                                ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                                int caretOffset,
                                                ro.sync.ecss.dita.topic.ref.TopicrefInfo initialTopicrefInfo,
                                                ro.sync.ecss.dita.topic.ref.TopicRefInserter inserter)
```
    Deprecated. This method is not used anymore from oXygen to insert topic reference elements and it will be removed in a future release. All topic reference elements are inserted using the same method: editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
    
    Show the topic reference info dialog with some initial content
    
    Parameters:
    
    location - The DITA map location
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    initialTopicrefInfo - Initial topic ref info.
    
    inserter - Callback when the dialog is used.
  - getInsertTopicref
```
public static void getInsertTopicref(java.net.URL editorLocation,
                                     java.lang.Object parentFrame,
                                     ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                     AuthorDocumentController ctrl,
                                     int caretOffset,
                                     java.lang.String initialTopicRefLocation,
                                     ro.sync.ecss.dita.topic.ref.TopicRefInserter inserter,
                                     java.lang.String preferredElementName,
                                     boolean displayReferenceUrl)
```
    Insert a topic reference.
    
    Parameters:
    
    editorLocation - The editor location.
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    initialTopicRefLocation - The initial location (relative or absolute) to set to the topic ref insert dialog.
    
    inserter - Topic ref inserter
    
    preferredElementName - Preferred name or class of the element to insert
    
    displayReferenceUrl - If true the URL input will be displayed in the insert topic reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
  - insertKeydefWithKeyword
```
public static void insertKeydefWithKeyword(java.lang.Object parentFrame,
                                           ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                           AuthorDocumentController ctrl,
                                           int caretOffset,
                                           ro.sync.ecss.dita.topic.ref.TopicRefInserter inserter,
                                           boolean append)
```
    Insert a key definition with keyword.
    
    Parameters:
    
    parentFrame - The parent frame.
    
    ccM - The CC Manager.
    
    ctrl - The document controller.
    
    caretOffset - The caret offset.
    
    inserter - Topic reference inserter
    Note: the preferredElementName parameter is not used on Eclipse plugin implementation.
    
    append - true to append child, false to insert after.
  - insertTopichead
```
public static void insertTopichead(AuthorAccess authorAccess)
                            throws AuthorOperationException
```
    Insert a topic head.
    
    Parameters:
    
    authorAccess - The author access.
    
    Throws:
    
    AuthorOperationException
  - setDitaAccessCustomizer
```
public static void setDitaAccessCustomizer(ro.sync.ecss.dita.DITAAccessCustomizer ditaAccessCustomizer)
```
    Set the DITA access customizer from SA or EC.
    
    Parameters:
    
    ditaAccessCustomizer - The DITA access customizer.
  - hasAPIKeysManager
```
public static boolean hasAPIKeysManager()
```
    Returns:
    
    true if we have a keys manager provided through the API.
  - getAPIKeysManagerDescription
```
public static java.lang.String getAPIKeysManagerDescription()
```
    Returns:
    
    A description for the API Keys manager.
  - getNewMapTitle
```
@Deprecated
public static ro.sync.ecss.dita.map.TitleInfo getNewMapTitle(java.lang.Object parentFrame,
                                                                          java.lang.String oldTitle,
                                                                          boolean preferTitleAttribute)
```
    Deprecated. This method is not used anymore from oXygen to edit map titles and it will be removed in a future release. The map root is now edited using the following method: editProperties(URL, AuthorCCManager, AuthorDocumentControllerImpl, AuthorElement[], TopicRefInserter, Object, boolean)
    
    Edit the map title
    
    Parameters:
    
    parentFrame - The parent frame
    
    oldTitle - The old title
    
    preferTitleAttribute -
    
    Returns:
    
    The new title proposed by the user
  - editProperties
```
public static void editProperties(java.net.URL location,
                                  ro.sync.ecss.contentcompletion.AuthorCCManager ccM,
                                  ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                  AuthorElement[] elementsToEdit,
                                  ro.sync.ecss.dita.topic.ref.TopicRefInserter topicRefInserter,
                                  java.lang.Object parentFrame,
                                  boolean displayReferenceUrl)
```
    Edit properties for the given reference elements.
    
    Parameters:
    
    location - DITA Map editor location.
    
    ccM - The CC Manager
    
    ctrl - The Author document controller.
    
    elementsToEdit - The elements that must be edited.
    
    topicRefInserter - Callback to insert/edit a topic ref
    
    parentFrame - Parent frame.
    
    displayReferenceUrl - If true the URL input will be displayed in the edit reference dialog (the user will have the possibility to change the reference URL).
    
    Since:
    
    17.1
  - editProperties
```
public static void editProperties(AuthorAccess authorAccess)
                           throws AuthorOperationException
```
    Edit properties for the given reference elements.
    
    Parameters:
    
    authorAccess - the author access.
    
    Throws:
    
    AuthorOperationException
  - insertHref
```
public static void insertHref(AuthorAccess authorAccess,
                              java.lang.String typeValue,
                              java.lang.String formatValue,
                              java.lang.String scopeValue,
                              boolean isXref,
                              boolean isHrefTypeDitaTopic,
                              java.net.URL initialReferenceURL,
                              boolean displayReferenceUrl)
                       throws AuthorOperationException
```
    Insert a Xref or link element.
    
    Parameters:
    
    authorAccess - The author access.
    
    typeValue - The type attribute value. If not null, the generated reference will have the 'type="typeValue"' attribute set to it.
    
    formatValue - The format attribute value. If not null and the reference points to a non-DITA resource, the generated reference will have the 'format="formatValue"' attribute set to it.
    
    scopeValue - The scope attribute value. If not null, the generated reference will have the 'scope="scopeValue"' attribute set to it.
    
    isXref - true if we need to insert an <xref> element, false for the <link> element.
    
    isHrefTypeDitaTopic - If true the user wants to insert a reference to a DITA resource (Insert Cross Reference action) If false the user wants to a reference to an external non-dita resource (Web Link action or File Reference action).
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    14.2
  - insertHref
```
public static void insertHref(AuthorAccess authorAccess,
                              java.lang.String typeValue,
                              java.lang.String formatValue,
                              java.lang.String scopeValue,
                              boolean isXref,
                              boolean isHrefTypeDitaTopic)
                       throws AuthorOperationException
```
    Insert a Xref.
    
    Parameters:
    
    authorAccess - The author access.
    
    typeValue - The the attribute value.
    
    formatValue - The format attribute value.
    
    scopeValue - The scope attribute value.
    
    isXref - true if we need to insert a xref element, false for link element.
    
    isHrefTypeDitaTopic - if true a dita topic chooser will be shown otherwise a input url dialog will be show for the href attribute value.
    
    Throws:
    
    AuthorOperationException
  - insertContentReference
```
public static void insertContentReference(AuthorAccess authorAccess,
                                          java.net.URL initialReferenceURL,
                                          boolean displayReferenceUrl)
                                   throws AuthorOperationException
```
    Shows a dialog that allows inserting a content reference (conref).
    
    Parameters:
    
    authorAccess - The Author access.
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    14.2
  - insertTopicref
```
public static void insertTopicref(AuthorAccess authorAccess,
                                  java.net.URL initialReferenceURL,
                                  boolean displayReferenceUrl)
                           throws AuthorOperationException
```
    Insert a topic reference.
    
    Parameters:
    
    authorAccess - The Author access.
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    14.2
  - insertTopicref
```
public static void insertTopicref(WSDITAMapEditorPage ditaPageAccess,
                                  java.net.URL initialReferenceURL,
                                  java.lang.String preferredElementName,
                                  boolean asChild,
                                  boolean displayReferenceUrl)
                           throws AuthorOperationException
```
    Insert a topic reference in the DITA Map tree.
    
    Parameters:
    
    ditaPageAccess - The DITA Page access.
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    preferredElementName - The preferred name of the element to insert.
    
    asChild - true to insert as a child of the selected item, false to insert as a next sibling.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    15
  - insertReference
```
public static void insertReference(AuthorAccess authorAccess,
                                   int refType)
                            throws AuthorOperationException
```
    Insert a keyref or a conkeyref.
    Parameters:
    
    authorAccess - The author access.
    refType - Reference type. Can be one of the following constants:
    
    CONKEYREF_TYPE,
    
    CONREF_TYPE,
    
    KEYREF_TYPE,
    Throws:
    
    AuthorOperationException
  - showInsertReferenceDialog
```
public static void showInsertReferenceDialog(ro.sync.ecss.contentcompletion.AuthorCCManager ccManager,
                                             ro.sync.ecss.ue.AuthorDocumentControllerImpl controller,
                                             int caretOffset,
                                             java.lang.Object parentFrame,
                                             int refType,
                                             boolean showOnlyKeysList,
                                             ro.sync.ecss.dita.topic.ref.ReferenceInserter referenceInserter)
                                      throws AuthorOperationException
```
    Shows the keyref/conkeyref insert dialog and returns the chosen reference information.
    
    Parameters:
    
    ccManager - CC manager.
    
    controller - Author document controller.
    
    caretOffset - Caret offset.
    
    parentFrame - Parent frame.
    
    refType - One of: KEYREF_TYPE, CONREF_TYPE, CONKEYREF_TYPE
    
    showOnlyKeysList - true to show only keys list in the insert reference dialog.
    
    referenceInserter - The reference inserter.
    
    Throws:
    
    AuthorOperationException - When the insertion fails.
  - showInsertReferenceDialog
```
public static void showInsertReferenceDialog(ro.sync.ecss.contentcompletion.AuthorCCManager ccManager,
                                             ro.sync.ecss.ue.AuthorDocumentControllerImpl controller,
                                             int caretOffset,
                                             java.lang.Object parentFrame,
                                             int refType,
                                             boolean showOnlyKeysList,
                                             ro.sync.ecss.dita.topic.ref.ReferenceInserter referenceInserter,
                                             ro.sync.ecss.dita.IKeyInfoFilter keysFilter,
                                             boolean useModalDialog)
                                      throws AuthorOperationException
```
    Shows the keyref/conkeyref insert dialog and returns the chosen reference information.
    
    Parameters:
    
    ccManager - CC manager.
    
    controller - Author document controller.
    
    caretOffset - Caret offset.
    
    parentFrame - Parent frame.
    
    refType - One of: KEYREF_TYPE, CONREF_TYPE, CONKEYREF_TYPE
    
    showOnlyKeysList - true to show only keys list in the insert reference dialog.
    
    referenceInserter - The reference inserter.
    
    keysFilter - Filters the keys.
    
    useModalDialog - true if the dialog should be modal.
    
    Throws:
    
    AuthorOperationException - When the insertion fails.
  - insertReference
```
public static void insertReference(AuthorAccess authorAccess,
                                   java.lang.String referenceValue,
                                   java.lang.String targetElementQName,
                                   java.lang.String elementClass)
                            throws AuthorOperationException
```
    Inserts a reference from the information passed in the ArgumentsMap.
    
    Parameters:
    
    authorAccess - the AuthorAccess
    
    referenceValue - the reference value.
    
    targetElementQName - the target element qualified name.
    
    elementClass - the element class.
    
    Throws:
    
    AuthorOperationException - if the operation fails.
  - getRootMapURL
```
public static java.net.URL getRootMapURL()
```
    Get DITA root map URL.
    
    Returns:
    
    DITA root map URL.
  - resolveKeyRef
```
@Deprecated
public static java.net.URL resolveKeyRef(java.lang.String keyRef)
```
    Deprecated. Please use the equivalent method which also receives the URL of the requestor.
    
    Deprecated method for resolving a keyref. Preserved for backward compatibility.
    
    Parameters:
    
    keyRef - The keyref value
    
    Returns:
    
    The absolute value of the key ref target.
  - resolveKeyRef
```
@Deprecated
public static java.net.URL resolveKeyRef(java.lang.String keyRef,
                                                      boolean addANYIdentifierForKeys)
```
    Deprecated. Please use the equivalent method which also receives the URL of the requestor.
    
    Resolve a keyref.
    
    Parameters:
    
    keyRef - The keyref value
    
    addANYIdentifierForKeys - If true then reference keys will be prefixed by 'ANY/'. in a element_keyref function.
    
    Returns:
    
    The absolute value of the key ref target.
  - resolveKeyRef
```
public static java.net.URL resolveKeyRef(java.net.URL originatorURL,
                                         java.lang.String keyRef,
                                         boolean addANYIdentifierForKeys)
```
    Resolve a keyref.
    
    Parameters:
    
    originatorURL - The originator URL.
    
    keyRef - The keyref value
    
    addANYIdentifierForKeys - If true then reference keys will be prefixed by 'ANY/'. in a element_keyref function.
    
    Returns:
    
    The absolute value of the key ref target.
  - checkValidKeyRef
```
public static java.lang.String checkValidKeyRef(java.lang.String keyref)
```
    Check if a keyref has a valid key name.
    
    Parameters:
    
    keyref - The keyref (may also contain the "/").
    
    Returns:
    
    an error message if the key name is not valid or null if the key name is valid.
  - resolveKeyRef
```
public static java.net.URL resolveKeyRef(java.net.URL originatorURL,
                                         java.lang.String keyRef,
                                         ContextKeyManager keysManager,
                                         boolean addANYIdentifierForKeys)
```
    Resolve a keyref.
    
    Parameters:
    
    originatorURL - The url that contains the key.
    
    keyRef - The keyref value
    
    keysManager - The key manager.
    
    addANYIdentifierForKeys - If true then reference keys will be prefixed by 'ANY/'. in a element_keyref function.
    
    Returns:
    
    The absolute value of the key ref target.
  - resolveKeyRef
```
public static java.net.URL resolveKeyRef(java.lang.String keyRef,
                                         ro.sync.ecss.dita.reference.keyref.KeyResolver kr)
```
    Resolve a keyref.
    
    Parameters:
    
    keyRef - The keyref value
    
    kr - The key resolver.
    
    Returns:
    
    The absolute value of the key ref target.
  - createReusableComponent
```
public static void createReusableComponent(AuthorAccess authorAccess,
                                           ro.sync.ecss.extensions.api.DITAUniqueIDAssigner idsAssigner)
                                    throws AuthorOperationException
```
    Reuse the selected content.
    
    Parameters:
    
    authorAccess - The author access
    
    idsAssigner - The IDs assigner
    
    Throws:
    
    AuthorOperationException - If fails
  - insertReusableComponent
```
public static void insertReusableComponent(AuthorAccess authorAccess)
                                    throws AuthorOperationException
```
    Insert a reusable component
    
    Parameters:
    
    authorAccess - The author access
    
    Throws:
    
    AuthorOperationException
  - replaceConref
```
public static void replaceConref(AuthorAccess authorAccess)
                          throws AuthorOperationException
```
    Replace the conref at caret position
    
    Parameters:
    
    authorAccess -
    
    Throws:
    
    AuthorOperationException
  - removeReference
```
public static void removeReference(AuthorAccess authorAccess)
                            throws AuthorOperationException
```
    Remove a content reference from a DITA document.
    
    Parameters:
    
    authorAccess - The author access.
    
    Throws:
    
    AuthorOperationException
  - addEditReference
```
public static void addEditReference(AuthorAccess authorAccess)
                             throws AuthorOperationException
```
    Add a new conref to the current element or edit the existing one.
    
    Parameters:
    
    authorAccess - The author access
    
    Throws:
    
    AuthorOperationException
  - isGeneralizationOf
```
public static boolean isGeneralizationOf(java.lang.String sourceClass,
                                         java.lang.String targetClass)
```
    True if the first class value is a generalization or the same as the second class value.
    
    Parameters:
    
    sourceClass - The source class value
    
    targetClass - The target class value
    
    Returns:
    
    True if the first class value is a generalization of the second
  - getInheritanceType
```
public static int getInheritanceType(java.lang.String sourceClass,
                                     java.lang.String targetClass)
```
    Check what inheritance is between the two classes.
    
    Parameters:
    
    sourceClass - The source class value
    
    targetClass - The target class value
    
    Returns:
    
    the inheritanche type between the source and target class
  - parseDITAHref
```
public static final Reference parseDITAHref(java.lang.String baseUrl,
                                            java.lang.String hrefValue)
                                     throws java.net.MalformedURLException
```
    Parse the href attribute and returns the absolute URL and the id.
    
    Parameters:
    
    baseUrl - The base document URL.
    
    hrefValue - The href attribute value. Provides access to specific informations and actions for editor, document, workspace, tables, change tracking, utility
    
    Returns:
    
    A container object with the content reference URI and topicID or null.
    
    Throws:
    
    java.net.MalformedURLException - Can't create the URL.
  - parseDITAKeyRef
```
@Deprecated
public static Reference parseDITAKeyRef(java.lang.String keyref)
                                              throws java.net.MalformedURLException
```
    Deprecated. Please use the equivalent method which also receives the URL of the requestor.
    
    Parse the DITA conkeyref value
    
    Parameters:
    
    keyref - The attribute 'conkeyref' value
    
    Returns:
    
    The DITA Conref object
    
    Throws:
    
    java.net.MalformedURLException
  - parseDITAKeyRef
```
public static Reference parseDITAKeyRef(java.net.URL originatorURL,
                                        java.lang.String keyref)
                                 throws java.net.MalformedURLException
```
    Parse the DITA conkeyref value
    
    Parameters:
    
    originatorURL - The originator URL.
    
    keyref - The attribute 'conkeyref' value
    
    Returns:
    
    The DITA Conref object
    
    Throws:
    
    java.net.MalformedURLException
  - parseDITAKeyRef
```
public static Reference parseDITAKeyRef(java.net.URL originatorURL,
                                        ContextKeyManager keyManager,
                                        java.lang.String keyref)
                                 throws java.net.MalformedURLException
```
    Parse the DITA conkeyref value
    
    Parameters:
    
    originatorURL - The originator URL.
    
    keyManager - The key manager used to resolve the keyref.
    
    keyref - The attribute 'conkeyref' value
    
    Returns:
    
    The DITA Conref object
    
    Throws:
    
    java.net.MalformedURLException
  - parseDITAKeyRef
```
public static Reference parseDITAKeyRef(java.lang.String keyref,
                                        ro.sync.ecss.dita.reference.keyref.KeyResolver kr)
                                 throws java.net.MalformedURLException
```
    Parse the DITA conkeyref value
    
    Parameters:
    
    keyref - The attribute 'conkeyref' value
    
    kr - The keys resolver
    
    Returns:
    
    The DITA Conref object
    
    Throws:
    
    java.net.MalformedURLException
  - getAutoInsertTopicRefElementName
```
public static java.lang.String getAutoInsertTopicRefElementName(AuthorAccess authorAccess,
                                                                int caretPosition)
```
    Get the name of the topic ref element to insert
    
    Parameters:
    
    authorAccess - The author access
    
    caretPosition - Caret position
    
    Returns:
    
    A name for the topic ref to insert
  - getAutoInsertRefElementName
```
public static java.lang.String getAutoInsertRefElementName(AuthorAccess authorAccess,
                                                           int caretPosition)
```
    Get the name of the topic ref element to insert
    
    Parameters:
    
    authorAccess - The author access
    
    caretPosition - Caret position
    
    Returns:
    
    A name for the topic ref to insert
  - getAutoInsertImageRefElementName
```
public static java.lang.String getAutoInsertImageRefElementName(AuthorAccess authorAccess,
                                                                int caretPosition)
```
    Get the name of the image element to insert.
    
    Parameters:
    
    authorAccess - The author access
    
    caretPosition - Caret position
    
    Returns:
    
    A name for the topic ref to insert
  - getPossibleElements
```
public static CIElement[] getPossibleElements(ro.sync.ecss.ue.AuthorDocumentControllerImpl ctrl,
                                              ro.sync.ecss.contentcompletion.AuthorCCManager ccManager,
                                              int offset,
                                              java.lang.String reqAttr,
                                              java.lang.String... classFrag)
```
    Get the possible elements that can be inserted at a given offset and have the class 'classFrag' and a 'reqAttr' attribute.
    
    Parameters:
    
    ctrl - the author document controller.
    
    ccManager - the content completion manager.
    
    offset - the offset.
    
    reqAttr - the required attribute that needs to be on the element.
    
    classFrag - the class fragments to search for in the element.
    
    Returns:
    
    the possible elements that can be inserted at a given offset and have the class 'classFrag' and a 'reqAttr' attribute.
  - getEquivalentChildCIElement
```
public static CIElement getEquivalentChildCIElement(AuthorAccess authorAccess,
                                                    int caretOffset,
                                                    java.lang.String tagName)
```
    Get the equivalent child CIElement
    
    Parameters:
    
    authorAccess - Author access
    
    caretOffset - The caret offset
    
    tagName - The tag name
    
    Returns:
    
    the equivalent child CIElement
  - getKeys
```
@Deprecated
public static java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo> getKeys()
```
    Deprecated. Please use the equivalent method which also receives the URL of the requestor.
    
    Returns:
    
    The mapped DITA 1.2 keys
  - getKeys
```
public static java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo> getKeys(java.net.URL originatorURL)
```
    Parameters:
    
    originatorURL - The URL for which the keys are requested
    
    Returns:
    
    The mapped DITA 1.2 keys
  - getKeysForInsertion
```
public static java.util.List<ro.sync.ecss.dita.reference.keyref.KeyInfo> getKeysForInsertion(java.net.URL originatorURL)
```
    Parameters:
    
    originatorURL - The URL for which the keys are requested
    
    Returns:
    
    The mapped DITA 1.2 keys. The returned list of keys depends on the current editing context.
  - getKeys
```
public static java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo> getKeys(java.net.URL originatorURL,
                                                                                                           ContextKeyManager keysManager)
```
    Returns the mapped DITA 1.2 keys
    
    Parameters:
    
    originatorURL - The URL of the document which contains the keys.
    
    keysManager - The key manager that is aware of the context of the document.
    
    Returns:
    
    The mapped DITA 1.2 keys
  - getURLKeyScopeContexts
```
public static java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>> getURLKeyScopeContexts(java.net.URL originatorURL,
                                                                                                                                            ContextKeyManager keysManager)
```
    Returns a mapping between topic URLs and DITA 1.3 key scopes where the URLs are referenced.
    
    Parameters:
    
    originatorURL - The URL of the document which contains the keys.
    
    keysManager - The key manager that is aware of the context of the document.
    
    Returns:
    
    The mapped DITA 1.2 keys
  - pasteAsReference
```
public static java.lang.String pasteAsReference(AuthorAccess authorAccess,
                                                boolean asConref)
                                         throws AuthorOperationException
```
    Paste as reference
    
    Parameters:
    
    authorAccess - The author access.
    
    asConref - True if paste as conref, false as link
    
    Returns:
    
    information about how this action should be used.
    
    Throws:
    
    AuthorOperationException
  - pasteAsReference
```
public static java.lang.String pasteAsReference(AuthorAccess authorAccess,
                                                DITAAccess.PasteInfo pasteInfo)
                                         throws AuthorOperationException
```
    Paste as reference
    
    Parameters:
    
    authorAccess - The author access.
    
    pasteInfo - Paste type of clipboard fragments.
    
    Returns:
    
    information about how this action should be used.
    
    Throws:
    
    AuthorOperationException
  - pasteClipboardFragmentsAsReference
```
public static boolean pasteClipboardFragmentsAsReference(AuthorAccess authorAccess,
                                                         DITAAccess.PasteInfo pasteInfo,
                                                         ro.sync.ecss.component.AuthorDocumentFragmentClipboardObject[] fragments)
                                                  throws AuthorOperationException
```
    Paste the fragments from clipboard as reference.
    
    Parameters:
    
    authorAccess - The author access.
    
    pasteInfo - Paste type of clipboard fragments.
    
    fragments - The fragments to paste with.
    
    Returns:
    
    true if the paste was valid.
    
    Throws:
    
    AuthorOperationException
  - filterAttributeValues
```
@Deprecated
public static java.util.List<CIValue> filterAttributeValues(java.util.List<CIValue> attributeValues,
                                                                         WhatPossibleValuesHasAttributeContext context,
                                                                         java.lang.String documentTypeName)
```
    Deprecated. Please use the equivalent method which also receives the URL of the requestor.
    
    Propose additional attribute values.
    
    Parameters:
    
    attributeValues - The attribute values.
    
    context - The context.
    
    documentTypeName - The document type name.
    
    Returns:
    
    The enriched list.
  - filterAttributeValues
```
public static java.util.List<CIValue> filterAttributeValues(java.util.List<CIValue> attributeValues,
                                                            WhatPossibleValuesHasAttributeContext context,
                                                            java.lang.String documentTypeName,
                                                            AuthorAccess authorAccess)
```
    Propose additional attribute values.
    
    Parameters:
    
    attributeValues - The attribute values.
    
    context - The context.
    
    documentTypeName - The document type name.
    
    authorAccess - The Author Access.
    
    Returns:
    
    The enriched list.
  - filterAttributeValues
```
public static java.util.List<CIValue> filterAttributeValues(java.util.List<CIValue> attributeValues,
                                                            WhatPossibleValuesHasAttributeContext context,
                                                            ContextKeyManager keyManager,
                                                            java.lang.String documentTypeName,
                                                            AuthorAccess authorAccess)
```
    Propose additional attribute values.
    
    Parameters:
    
    attributeValues - The attribute values.
    
    context - The context.
    
    keyManager - The key manager to use to propose values for attributes like keyref.
    
    documentTypeName - The document type name.
    
    authorAccess - The Author Access.
    
    Returns:
    
    The enriched list.
  - computeElementClazz
```
public static java.lang.String computeElementClazz(WhatPossibleValuesHasAttributeContext context)
```
    Compute the element's clazz
    
    Parameters:
    
    context - The attributes editing context.
    
    Returns:
    
    The element clazz or null.
  - annotateAttributes
```
public static java.util.List<CIAttribute> annotateAttributes(java.util.List<CIAttribute> attributes)
```
    Annotate a list of attributes.
    
    Parameters:
    
    attributes - The attributes list.
    
    Returns:
    
    The list of attributes with annotations.
  - insertImage
```
public static void insertImage(AuthorAccess authorAccess,
                               java.lang.String ref)
                        throws AuthorOperationException
```
    Insert a DITA Image
    
    Parameters:
    
    authorAccess - The author access
    
    ref - The reference.
    
    Throws:
    
    AuthorOperationException
  - insertMedia
```
public static void insertMedia(AuthorAccess authorAccess,
                               ro.sync.ecss.dita.MediaInfo ref)
                        throws AuthorOperationException
```
    Insert a media object.
    
    Parameters:
    
    authorAccess - The author access.
    
    ref - Media reference.
    
    Throws:
    
    AuthorOperationException - When fail.
  - chooseMediaReference
```
public static ro.sync.ecss.dita.MediaInfo chooseMediaReference(AuthorAccess authorAccess)
                                                        throws AuthorOperationException
```
    Allows the user to choose an media file reference, which will be inserted inside the document.
    
    Parameters:
    
    authorAccess - The author access.
    
    Returns:
    
    A MediaInfo object containing all the properties for the file which will be inserted.
    
    Throws:
    
    AuthorOperationException - On fail.
  - insertMediaSchemaAware
```
public static SchemaAwareHandlerResult insertMediaSchemaAware(AuthorAccess authorAccess,
                                                              ro.sync.ecss.dita.MediaInfo reference)
                                                       throws AuthorOperationException
```
    Insert a DITA media object.
    
    Parameters:
    
    authorAccess - The author access
    
    reference - The reference value.
    
    Returns:
    
    The insertion result
    
    Throws:
    
    AuthorOperationException - On fail.
  - insertImage
```
public static void insertImage(AuthorAccess authorAccess,
                               ro.sync.ecss.dita.ImageInfo ref)
                        throws AuthorOperationException
```
    Insert a DITA Image.
    
    Parameters:
    
    authorAccess - The author access
    
    ref - The information reference.
    
    Throws:
    
    AuthorOperationException - If the image could not be inserted.
  - chooseImageReference
```
public static ro.sync.ecss.dita.ImageInfo chooseImageReference(AuthorAccess authorAccess)
                                                        throws AuthorOperationException
```
    Allows the user to choose an image reference, which will be inserted inside the document.
    
    Parameters:
    
    authorAccess - The author access.
    
    Returns:
    
    A ImageInfo object containing all the properties for the image, which will be inserted.
    
    Throws:
    
    AuthorOperationException
  - insertImageSchemaAware
```
public static SchemaAwareHandlerResult insertImageSchemaAware(AuthorAccess authorAccess,
                                                              java.lang.String ref)
                                                       throws AuthorOperationException
```
    Insert a DITA Image
    
    Parameters:
    
    authorAccess - The author access
    
    ref - The reference.
    
    Returns:
    
    The insertion result
    
    Throws:
    
    AuthorOperationException
  - insertImageSchemaAware
```
public static SchemaAwareHandlerResult insertImageSchemaAware(AuthorAccess authorAccess,
                                                              java.lang.String refAttrName,
                                                              java.lang.String refValue)
                                                       throws AuthorOperationException
```
    Insert a DITA Image
    
    Parameters:
    
    authorAccess - The author access
    
    refAttrName - The reference attribute name.
    
    refValue - The reference value.
    
    Returns:
    
    The insertion result
    
    Throws:
    
    AuthorOperationException
  - insertImageSchemaAware
```
public static SchemaAwareHandlerResult insertImageSchemaAware(AuthorAccess authorAccess,
                                                              ro.sync.ecss.dita.ImageInfo reference)
                                                       throws AuthorOperationException
```
    Insert a DITA image.
    
    Parameters:
    
    authorAccess - The author access
    
    reference - The reference value.
    
    Returns:
    
    The insertion result
    
    Throws:
    
    AuthorOperationException
  - computeImageReferenceXMLToInsert
```
public static java.lang.String computeImageReferenceXMLToInsert(AuthorAccess authorAccess,
                                                                java.lang.String refAttrName,
                                                                java.lang.String refValue)
```
    Compute the image reference XML fragment to insert.
    
    Parameters:
    
    authorAccess - The author access.
    
    refAttrName - The reference attribute name
    
    refValue - The reference value name
    
    Returns:
    
    the image reference XML fragment to insert.
  - getPossibleElementQName
```
public static java.lang.String getPossibleElementQName(AuthorDocumentController ctrl,
                                                       java.lang.String clazzFrag,
                                                       java.lang.String mostUsed)
```
    Obtain the qualified name of the element with the given class, which will be inserted in the document.
    
    Parameters:
    
    ctrl - The author document controller.
    
    clazzFrag - The class of the element, whose name is searched.
    
    mostUsed - The most used name of the element with the given class.
    
    Returns:
    
    The qualified name of the element with the given class.
  - searchReferences
```
public static void searchReferences(AuthorAccess authorAccess)
```
    Search references to a certain element at the caret position.
    
    Parameters:
    
    authorAccess - The author access.
  - computeLinkText
```
public static java.lang.String computeLinkText(java.lang.String hrefValue,
                                               java.lang.String baseSystemID)
                                        throws java.net.MalformedURLException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException,
                                               org.xml.sax.SAXException,
                                               java.lang.Exception
```
    Obtains information about the referred target.
    
    Parameters:
    
    hrefValue - The relative location of the target.
    
    baseSystemID - base system ID.
    
    Returns:
    
    The computed title information.
    
    Throws:
    
    java.net.MalformedURLException
    
    java.io.IOException
    
    javax.xml.parsers.ParserConfigurationException
    
    org.xml.sax.SAXException
    
    java.lang.Exception
  - computeLinkText
```
public static java.lang.String computeLinkText(AuthorNode contextNode,
                                               java.lang.String hrefValue,
                                               java.lang.String baseSystemID)
                                        throws java.net.MalformedURLException,
                                               java.io.IOException,
                                               javax.xml.parsers.ParserConfigurationException,
                                               org.xml.sax.SAXException,
                                               java.lang.Exception
```
    Obtains information about the referred target.
    
    Parameters:
    
    contextNode - The context node.
    
    hrefValue - The relative location of the target.
    
    baseSystemID - base system ID.
    
    Returns:
    
    The computed title information.
    
    Throws:
    
    java.net.MalformedURLException
    
    java.io.IOException
    
    javax.xml.parsers.ParserConfigurationException
    
    org.xml.sax.SAXException
    
    java.lang.Exception
  - filterElements
```
public static java.util.List<CIElement> filterElements(java.util.List<CIElement> elements,
                                                       WhatElementsCanGoHereContext context)
```
    Filter the given elements according to the given context.
    
    Parameters:
    
    elements - The list of CIElement elements.
    
    context - The context.
    
    Returns:
    
    The filtered CIElements.
  - resolveKeyNotFoundError
```
public static void resolveKeyNotFoundError(AuthorAccess authorAccess,
                                           java.lang.String keyref)
```
    The give key was not found. We will present a warning dialog to the user and we will offer the user as a possible solution to change the root map.
    
    Parameters:
    
    authorAccess - Interface to the author context.
    
    keyref - The key that wasn't found in the current root map context.
  - checkConsecutiveInsertionWarning
```
protected static int checkConsecutiveInsertionWarning(int previousOperationOffset,
                                                      int selectionStart,
                                                      int selectionEnd,
                                                      ro.sync.ecss.dita.reference.ReferenceInfo previousReferenceInfo,
                                                      ro.sync.ecss.dita.reference.ReferenceInfo currentReferenceInfo)
```
    Show a warning message when consecutive insertion of the same references are performed.
    
    Parameters:
    
    previousOperationOffset - The previous operation offset, usually where the caret is positioned.
    
    selectionStart - The current selection start.
    
    selectionEnd - The current selection end.
    
    previousReferenceInfo - The previous inserted reference.
    
    currentReferenceInfo - The current inserted reference.
  - filterDITAVALAttributeValues
```
public static java.util.List<CIValue> filterDITAVALAttributeValues(java.util.List<CIValue> attributeValues,
                                                                   WhatPossibleValuesHasAttributeContext context)
```
    Filter DITAVAL Attribute values.
    
    Parameters:
    
    attributeValues - The current list of attribute values.
    
    context - The what attribute values context.
    
    Returns:
    
    The modified list of values.
  - createNewTopicReference
```
public static void createNewTopicReference(AuthorAccess authorAccess)
                                    throws java.lang.Exception
```
    Create a new DITA topic and link to it as a reference.
    
    Parameters:
    
    authorAccess - The Author Access
    
    Throws:
    
    java.lang.Exception - if it fails.
  - pushElement
```
public static void pushElement(AuthorAccess authorAccess)
                        throws AuthorOperationException
```
    Shows a dialog that allows the user to push an element.
    
    Parameters:
    
    authorAccess - The Author access.
    
    Throws:
    
    AuthorOperationException - When the operation could not be completed.
    
    Since:
    
    17.1
  - isDITA1_3OrNewer
```
public static boolean isDITA1_3OrNewer(java.lang.String archVersion)
```
    Check if the topic or map with a certain architecture version is DITA 1.3 or newer,
    
    Parameters:
    
    archVersion - The architecture version.
    
    Returns:
    
    true if the topic or map with a certain architecture version is DITA 1.3 or newer,
  - insertLinkReference
```
public static void insertLinkReference(AuthorAccess authorAccess,
                                       java.lang.String typeValue,
                                       java.lang.String formatValue,
                                       java.lang.String scopeValue,
                                       boolean isXref,
                                       java.lang.String hrefType,
                                       java.net.URL initialReferenceURL,
                                       boolean displayReferenceUrl)
                                throws AuthorOperationException
```
    Insert a Xref or link element.
    
    Parameters:
    
    authorAccess - The author access.
    
    typeValue - The type attribute value. If not null, the generated reference will have the 'type="typeValue"' attribute set to it.
    
    formatValue - The format attribute value. If not null and the reference points to a non-DITA resource, the generated reference will have the 'format="formatValue"' attribute set to it.
    
    scopeValue - The scope attribute value. If not null, the generated reference will have the 'scope="scopeValue"' attribute set to it.
    
    isXref - true if we need to insert an <xref> element, false for the <link> element.
    
    hrefType - The type of the link. If LINK_TYPE_DITA_TOPIC, the user wants to insert a reference to a DITA resource (Insert Cross Reference action). If LINK_TYPE_NON_DITA_RESOURCE, wants to a reference to an external non-dita resource (Web Link action or File Reference action).
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    Throws:
    
    AuthorOperationException
  - insertLinkReference
```
public static void insertLinkReference(AuthorAccess authorAccess,
                                       java.lang.String typeValue,
                                       java.lang.String formatValue,
                                       java.lang.String scopeValue,
                                       boolean isXref,
                                       java.lang.String preferredElName,
                                       java.lang.String hrefType,
                                       java.net.URL initialReferenceURL,
                                       boolean displayReferenceUrl)
                                throws AuthorOperationException
```
    Insert a Xref or link element.
    
    Parameters:
    
    authorAccess - The author access.
    
    typeValue - The type attribute value. If not null, the generated reference will have the 'type="typeValue"' attribute set to it.
    
    formatValue - The format attribute value. If not null and the reference points to a non-DITA resource, the generated reference will have the 'format="formatValue"' attribute set to it.
    
    scopeValue - The scope attribute value. If not null, the generated reference will have the 'scope="scopeValue"' attribute set to it.
    
    isXref - true if we need to insert an <xref> element, false for the <link> element.
    
    preferredElName - The preferred name of the reference element.
    
    hrefType - The type of the link. If LINK_TYPE_DITA_TOPIC, the user wants to insert a reference to a DITA resource (Insert Cross Reference action). If LINK_TYPE_NON_DITA_RESOURCE, wants to a reference to an external non-dita resource (Web Link action or File Reference action).
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    Throws:
    
    AuthorOperationException
  - insertLinkReference
```
public static void insertLinkReference(AuthorAccess authorAccess,
                                       java.lang.String typeValue,
                                       java.lang.String formatValue,
                                       java.lang.String scopeValue,
                                       boolean isXref,
                                       java.lang.String hrefType,
                                       java.net.URL initialReferenceURL,
                                       boolean displayReferenceUrl,
                                       DITAAccess.InsertLinkReferenceShortcut insertLinkReferenceShortcut)
                                throws AuthorOperationException
```
    Insert a Xref or link element.
    
    Parameters:
    
    authorAccess - The author access.
    
    typeValue - The type attribute value. If not null, the generated reference will have the 'type="typeValue"' attribute set to it.
    
    formatValue - The format attribute value. If not null and the reference points to a non-DITA resource, the generated reference will have the 'format="formatValue"' attribute set to it.
    
    scopeValue - The scope attribute value. If not null, the generated reference will have the 'scope="scopeValue"' attribute set to it.
    
    isXref - true if we need to insert an <xref> element, false for the <link> element.
    
    hrefType - The type of the link. If LINK_TYPE_DITA_TOPIC, the user wants to insert a reference to a DITA resource (Insert Cross Reference action). If LINK_TYPE_NON_DITA_RESOURCE, wants to a reference to an external non-dita resource (Web Link action or File Reference action).
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    insertLinkReferenceShortcut - A shortcut class that allows us to collectthe references before inserting them into document.
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    18
    
    *********************************
    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.
  - insertLinkReference
```
public static void insertLinkReference(AuthorAccess authorAccess,
                                       java.lang.String typeValue,
                                       java.lang.String formatValue,
                                       java.lang.String scopeValue,
                                       boolean isXref,
                                       java.lang.String preferredElName,
                                       java.lang.String hrefType,
                                       java.net.URL initialReferenceURL,
                                       boolean displayReferenceUrl,
                                       DITAAccess.InsertLinkReferenceShortcut insertLinkReferenceShortcut)
                                throws AuthorOperationException
```
    Insert a Xref or link element.
    
    Parameters:
    
    authorAccess - The author access.
    
    typeValue - The type attribute value. If not null, the generated reference will have the type="typeValue" attribute set to it.
    
    formatValue - The format attribute value. If not null and the reference points to a non-DITA resource, the generated reference will have the format="formatValue" attribute set to it.
    
    scopeValue - The scope attribute value. If not null, the generated reference will have the scope="scopeValue" attribute set to it.
    
    isXref - true if we need to insert an <xref> element, false for the <link> element.
    
    preferredElName - The preferred name of the reference element.
    
    hrefType - The type of the link. If LINK_TYPE_DITA_TOPIC, the user wants to insert a reference to a DITA resource (Insert Cross Reference action). If LINK_TYPE_NON_DITA_RESOURCE, wants to a reference to an external non-dita resource (Web Link action or File Reference action).
    
    initialReferenceURL - The default URL that will be displayed in the URL field of the insert reference dialog.
    Note: this parameter is not used on Eclipse plugin implementation.
    
    displayReferenceUrl - If true the URL input will be displayed in the insert reference dialog (the user will have the possibility to change the reference URL). This parameter can be set to false when an initialReferenceURL is provided, and the user must not have the possibility to change it (the reference URL must be fixed).
    Note: this parameter is not used on Eclipse plugin implementation.
    
    insertLinkReferenceShortcut - A shortcut class that allows us to collectthe references before inserting them into document.
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    18
    
    *********************************
    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.
  - insertLinkReference
```
public static void insertLinkReference(java.lang.String referenceValue,
                                       java.lang.String targetElementClass,
                                       java.lang.String targetElementQName,
                                       AuthorAccess authorAccess,
                                       java.lang.String typeValue,
                                       java.lang.String formatValue,
                                       java.lang.String scopeValue,
                                       boolean isXref,
                                       java.lang.String hrefType)
                                throws AuthorOperationException
```
    Insert a Xref or link element.
    
    Parameters:
    
    referenceValue - The class of the target element.
    
    targetElementClass - The class of the target element.
    
    targetElementQName - The qualified name of the target element.
    
    authorAccess - The author access.
    
    typeValue - The type attribute value. If not null, the generated reference will have the 'type="typeValue"' attribute set to it.
    
    formatValue - The format attribute value. If not null and the reference points to a non-DITA resource, the generated reference will have the 'format="formatValue"' attribute set to it.
    
    scopeValue - The scope attribute value. If not null, the generated reference will have the 'scope="scopeValue"' attribute set to it.
    
    isXref - true if we need to insert an <xref> element, false for the <link> element.
    
    hrefType - The type of the link. If LINK_TYPE_DITA_TOPIC, the user wants to insert a reference to a DITA resource (Insert Cross Reference action). If LINK_TYPE_NON_DITA_RESOURCE, wants to a reference to an external non-dita resource (Web Link action or File Reference action).
    
    Throws:
    
    AuthorOperationException
    
    Since:
    
    18
    
    *********************************
    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.
  - rewriteKeyref
```
public static java.lang.String rewriteKeyref(java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>> urlKeyScopesMapping,
                                             java.util.LinkedHashMap<java.lang.String,ro.sync.ecss.dita.reference.keyref.KeyInfo> keys,
                                             AuthorNode contextNode,
                                             java.lang.String keyref)
```
    Rewrite a keyref looking also at key scopes..
    
    Parameters:
    
    urlKeyScopesMapping - Global URL to key scopes mapping.
    
    keys - Map of keys.
    
    contextNode - The context node.
    
    keyref - The original keyref.
    
    Returns:
    
    The rewritten reference.
  - getURLKeyScopeContexts
```
public static java.util.LinkedHashMap<java.net.URL,java.util.List<java.util.Stack<java.util.Set<java.lang.String>>>> getURLKeyScopeContexts(java.net.URL originatorURL)
```
    Get the URL to key scopes context for the default keys manager.
    
    Parameters:
    
    originatorURL - The originator URL.
    
    Returns:
    
    the URL to key scopes context mapping for the default keys manager.
  - editTopicref
```
public static void editTopicref(AuthorElement[] topicrefNodes,
                                AuthorAccess authorAccess)
```
    Edits one or more topicref elements inside a specialized dialog.
    
    Parameters:
    
    topicrefNodes - The topicref elements.
    
    authorAccess - Author access.
  - getDitaReferenceTargets
```
public static java.util.List<DitaReferenceTargetDescriptor> getDitaReferenceTargets(AuthorAccess authorAccess,
                                                                                    java.net.URL targetURL)
                                                                             throws java.io.IOException
```
    Returns the DITA reference targets in the given topic.
    
    Parameters:
    
    authorAccess - The author access of the currently opened document.
    
    targetURL - The URL of the topic.
    
    Returns:
    
    the DITA reference targets in the given topic.
    
    Throws:
    
    java.io.IOException - If an error occured while reading the URL.
    
    Since:
    
    18.0
  - getFormat
```
public static java.lang.String getFormat(java.lang.String hrefValue,
                                         java.lang.String formatValue,
                                         boolean fillFormatAttr)
```
    Get the format for the specified resource.
    
    Parameters:
    
    hrefValue - The HREF of the resource.
    
    formatValue - The default format value.
    
    fillFormatAttr - true if the attribute should be filled when serializing.
    
    Returns:
    
    The format for the resource.
  - checkValidKeyName
```
public static java.lang.String checkValidKeyName(java.lang.String keyName)
```
    Check if a keyref has a valid key name.
    
    Parameters:
    
    keyName - The key name.
    
    Returns:
    
    an error message if the key name is not valid or null if the key name is valid.
  - getHrefInformation
```
public static HrefInfo getHrefInformation(AuthorNode node)
```
    Get the reference information (by analizing attributes like keyref, href, mapref, ...) of a node.
    
    Parameters:
    
    node - The author node to get the reference information for.
    
    Returns:
    
    The information about what the given node references.
    
    Since:
    
    18.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.
  - exportDITAMap
```
public static void exportDITAMap(java.net.URL ditamapURL,
                                 java.io.File exportDirectory,
                                 boolean exportAsZip,
                                 java.lang.String zipFileName,
                                 ExportProgressUpdater progressUpdater)
```
    Export DITA Map as zip.
    
    Parameters:
    
    ditamapURL - The DITA Map URL.
    
    exportDirectory - The export directory.
    
    exportAsZip - true to export as ZIP
    
    zipFileName - Zip file name.
    
    progressUpdater - The progress updater.
    
    Since:
    
    18.1

Class DITAAccess

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

messages

LINK_TYPE_WEB_PAGE

LINK_TYPE_NON_DITA_RESOURCE

LINK_TYPE_DITA_TOPIC

DITA_ROOT_MAP_URL_ATTRIBUTE

REF_ATTRIBUTES

DEFAULT_CONKEYREF_CONREFEND

KEYREF_TYPE

CONREF_TYPE

CONKEYREF_TYPE

ID_ANY

INHERITANCE_GENERALIZATION

INHERITANCE_SPECIALIZATION

INHERITANCE_SAME

INHERITANCE_NONE

Constructor Detail

DITAAccess

Method Detail

insertTopicref

handleTopicRefInsertUrl

insertTopicgroup

getTopicHeadInfo

getInsertTopichead

getTopicGroupInfo

getInsertTopicgroup

getTopicRefInfo

getInsertTopicref

insertKeydefWithKeyword

insertTopichead

setDitaAccessCustomizer

hasAPIKeysManager

getAPIKeysManagerDescription

getNewMapTitle

editProperties

editProperties

insertHref

insertHref

insertContentReference

insertTopicref

insertTopicref

insertReference

showInsertReferenceDialog

showInsertReferenceDialog

insertReference

getRootMapURL

resolveKeyRef

resolveKeyRef

resolveKeyRef

checkValidKeyRef

resolveKeyRef

resolveKeyRef

createReusableComponent

insertReusableComponent

replaceConref

removeReference

addEditReference

isGeneralizationOf

getInheritanceType

parseDITAHref

parseDITAKeyRef

parseDITAKeyRef

parseDITAKeyRef

parseDITAKeyRef

getAutoInsertTopicRefElementName

getAutoInsertRefElementName

getAutoInsertImageRefElementName

getPossibleElements

getEquivalentChildCIElement

getKeys

getKeys

getKeysForInsertion

getKeys

getURLKeyScopeContexts