Package ro.sync.ecss.extensions.dita.link

Class DitaLinkTextResolver

java.lang.Object

ro.sync.ecss.extensions.api.link.LinkTextResolver

ro.sync.ecss.extensions.dita.link.DitaLinkTextResolver

@API(type=EXTENDABLE,
     src=PUBLIC)
public class DitaLinkTextResolver
extends LinkTextResolver

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

Constructors

Constructor	Description
DitaLinkTextResolver()	Constructor.
DitaLinkTextResolver(ContextKeyManager keyManager)	Deprecated. use DitaLinkTextResolver(ContextKeyManagerProvider) instead.
DitaLinkTextResolver(ContextKeyManagerProvider keyManagerProvider)	Constructor

Method Summary

Modifier and Type	Method	Description
void	activated(AuthorAccess authorAccess)	Signals that this resolver has entered in use.
void	clearReferencesCache()	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	refreshNodeReferences(AuthorNode node)	Marks the references used by the given node as being invalid and requiring refreshing.
java.lang.String	resolveReference(AuthorNode node)	Get the text of the reference.
void	update(java.util.Set<java.lang.String> modifiedURLs)	Update the cache of references.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DitaLinkTextResolver

public DitaLinkTextResolver()

Constructor.

DitaLinkTextResolver

@Deprecated
public DitaLinkTextResolver(ContextKeyManager keyManager)

Deprecated.

use DitaLinkTextResolver(ContextKeyManagerProvider) instead.

Constructor.

Parameters:

keyManager - The context-aware key manager.

DitaLinkTextResolver

public DitaLinkTextResolver(ContextKeyManagerProvider keyManagerProvider)

Constructor

Parameters:

keyManagerProvider - The context-aware key manager provider.

Method Detail

resolveReference

public java.lang.String resolveReference(AuthorNode node)
                                  throws InvalidLinkException

Get the text of the reference.

Overrides:

resolveReference in class LinkTextResolver

Parameters:

node - Author node.

Returns:

The link text.

Throws:

InvalidLinkException - Various problems while resolving the reference.

update

public void update(java.util.Set<java.lang.String> modifiedURLs)

Update the cache of references.

Overrides:

update in class LinkTextResolver

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 class LinkTextResolver

See Also:

LinkTextResolver.refresh()

refreshNodeReferences

public void refreshNodeReferences(AuthorNode node)

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 using AuthorAccess.getEditorAccess() and call WSAuthorEditorPageBase.refresh(AuthorNode) so that the editing area updates.

Overrides:

refreshNodeReferences in class LinkTextResolver

Parameters:

node - The node to be refresh.

See Also:

LinkTextResolver.refreshNodeReferences(ro.sync.ecss.extensions.api.node.AuthorNode)

clearReferencesCache

public void clearReferencesCache()

Description copied from class: LinkTextResolver

Any cache should be cleared in order to prepare for future evaluations.

Overrides:

clearReferencesCache in class LinkTextResolver

See Also:

LinkTextResolver.clearReferencesCache()

activated

public void activated(AuthorAccess authorAccess)

Description copied from class: LinkTextResolver

Signals that this resolver has entered in use. All kinds of listeners can be added on this call (like AuthorMouseListener or AuthorListener).

Overrides:

activated in class LinkTextResolver

Parameters:

authorAccess - The AuthorAccess of the Author page where the listener was activated.

See Also:

AuthorExtensionStateListener.activated(ro.sync.ecss.extensions.api.AuthorAccess)

deactivated

public void deactivated(AuthorAccess authorAccess)

Description copied from class: LinkTextResolver

Signals that this resolver has exit from use. All listeners should be removed on this call.

Overrides:

deactivated in class LinkTextResolver

Parameters:

authorAccess - The AuthorAccess of the Author page where the listener was activated.

See Also:

AuthorExtensionStateListener.deactivated(ro.sync.ecss.extensions.api.AuthorAccess)