Class DitaLinkTextResolver
java.lang.Object
ro.sync.ecss.extensions.api.link.LinkTextResolver
ro.sync.ecss.extensions.dita.link.DitaLinkTextResolver
Can resolve DITA references to another topic made through the href attribute on elements of classes:
map/topicref , topic/xref and topic/link .
It also resolves key references provided that the ditamap is opened in DITA Map Manager."
- Since:
- 14.2
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor.DitaLinkTextResolver
(ContextKeyManager keyManager) Deprecated.DitaLinkTextResolver
(ContextKeyManagerProvider keyManagerProvider) Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
activated
(AuthorAccess authorAccess) Signals that this resolver has entered in use.void
Any cache should be cleared in order to prepare for future evaluations.void
deactivated
(AuthorAccess authorAccess) Signals that this resolver has exit from use.void
refresh()
Signals a major refresh.void
Marks the references used by the given node as being invalid and requiring refreshing.resolveReference
(AuthorNode node) Get the text of the reference.void
Update the cache of references.
-
Constructor Details
-
DitaLinkTextResolver
public DitaLinkTextResolver()Constructor. -
DitaLinkTextResolver
Deprecated.useDitaLinkTextResolver(ContextKeyManagerProvider)
instead.Constructor.- Parameters:
keyManager
- The context-aware key manager.
-
DitaLinkTextResolver
Constructor- Parameters:
keyManagerProvider
- The context-aware key manager provider.
-
-
Method Details
-
resolveReference
Get the text of the reference.- Overrides:
resolveReference
in classLinkTextResolver
- Parameters:
node
- Author node.- Returns:
- The link text.
- Throws:
InvalidLinkException
- Various problems while resolving the reference.
-
update
Update the cache of references.- Overrides:
update
in classLinkTextResolver
- Parameters:
modifiedURLs
- The URLs that are modified.
-
refresh
public void refresh()Description copied from class:LinkTextResolver
Signals a major refresh. Any cache should be cleared in order to prepare for future evaluations.- Overrides:
refresh
in classLinkTextResolver
- See Also:
-
refreshNodeReferences
Description copied from class:LinkTextResolver
Marks the references used by the given node as being invalid and requiring refreshing. After performing an internal refresh the resolver must get an editor access usingAuthorAccess.getEditorAccess()
and callWSAuthorEditorPageBase.refresh(AuthorNode)
so that the editing area updates.- Overrides:
refreshNodeReferences
in classLinkTextResolver
- Parameters:
node
- The node to be refresh.- See Also:
-
clearReferencesCache
public void clearReferencesCache()Description copied from class:LinkTextResolver
Any cache should be cleared in order to prepare for future evaluations.- Overrides:
clearReferencesCache
in classLinkTextResolver
- See Also:
-
activated
Description copied from class:LinkTextResolver
Signals that this resolver has entered in use. All kinds of listeners can be added on this call (likeAuthorMouseListener
orAuthorListener
).- Overrides:
activated
in classLinkTextResolver
- Parameters:
authorAccess
- TheAuthorAccess
of the Author page where the listener was activated.- See Also:
-
deactivated
Description copied from class:LinkTextResolver
Signals that this resolver has exit from use. All listeners should be removed on this call.- Overrides:
deactivated
in classLinkTextResolver
- Parameters:
authorAccess
- TheAuthorAccess
of the Author page where the listener was activated.- See Also:
-
DitaLinkTextResolver(ContextKeyManagerProvider)
instead.