Package ro.sync.ecss.extensions.api

Interface DITAMapReferencesResolver

All Superinterfaces:

AuthorReferenceResolver, Extension, ValidatingAuthorReferenceResolver

All Known Implementing Classes:

DITAMapRefResolver

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface DITAMapReferencesResolver
extends ValidatingAuthorReferenceResolver

Resolve references when showing a DITA Map in the editor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPAND_PSEUDO_CLASS	Reference elements (like topicref, mapref, etc) will be expanded if: have this pseudo class this pseudo class is set on root See also setResolveAllTopicReferences(boolean).

Method Summary

Modifier and Type	Method	Description
default Object	getGrammarCache()	Get the grammar cache to be reused in another references resolver.
default void	setExpandMapReferences(boolean isExpandMapRefs)	Decide whether to expand or not the references of DITA maps.
default void	setGrammarCache(Object grammarCache)	Set the grammar cache to be reused in another references resolver.
void	setResolveAllTopicReferences(boolean resolveAllTopicRefs)	Try to resolve all topic references

Methods inherited from interface ro.sync.ecss.extensions.api.AuthorReferenceResolver

allowsValidatationForEditableReference, getDisplayName, getReferenceSystemID, getReferenceUniqueID, hasEditableReference, hasReferences, isReferenceChanged, replaceReference, resolveReference

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Methods inherited from interface ro.sync.ecss.extensions.api.ValidatingAuthorReferenceResolver

checkTarget

Field Details

EXPAND_PSEUDO_CLASS

static final String EXPAND_PSEUDO_CLASS

Reference elements (like topicref, mapref, etc) will be expanded if:

• have this pseudo class
• this pseudo class is set on root

See also setResolveAllTopicReferences(boolean).

See Also:

• Constant Field Values

Method Details

setResolveAllTopicReferences

void setResolveAllTopicReferences(boolean resolveAllTopicRefs)

Try to resolve all topic references

Parameters:

resolveAllTopicRefs - If true, will resolve both map references and topic references. If false, will resolve only map references, defaults to false

setExpandMapReferences

default void setExpandMapReferences(boolean isExpandMapRefs)

Decide whether to expand or not the references of DITA maps.

Parameters:

isExpandMapRefs - true to expand the references.

getGrammarCache

default Object getGrammarCache()

Get the grammar cache to be reused in another references resolver.

Returns:

the grammar cache to be reused in another references resolver.

Since:

23

setGrammarCache

default void setGrammarCache(Object grammarCache)

Set the grammar cache to be reused in another references resolver.

Parameters:

grammarCache - The grammar cache to be used.

Since:

23