ro.sync.ecss.extensions.docbook.link
Class DocbookLinkTextResolver

java.lang.Object
  ro.sync.ecss.extensions.api.link.LinkTextResolver
      ro.sync.ecss.extensions.docbook.link.DocbookLinkTextResolver

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class DocbookLinkTextResolver
extends LinkTextResolver

Resolves local docbook xrefs. The content of the link is given by either the xreflabel attribute or a title(info/title) child of the targeted element.

Since:

14.2

*********************************
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.

Constructor Summary

DocbookLinkTextResolver()

Method Summary

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.
static java.lang.String	getTitleValue(AuthorElement elem) Checks if the element has a TITLE child or an INFO/TITLE child and returns it's value.
void	refresh() Signals a major refresh.
java.lang.String	resolveReference(AuthorNode node) Gets a text representation for the reference.

Methods inherited from class ro.sync.ecss.extensions.api.link.LinkTextResolver

update

Methods inherited from class java.lang.Object

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

Constructor Detail

DocbookLinkTextResolver

public DocbookLinkTextResolver()

Method Detail

resolveReference

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

Description copied from class: LinkTextResolver

Gets a text representation for the reference. This text will be used inside author page next to the the link element.

Overrides:

resolveReference in class LinkTextResolver

Parameters:

node - Author node.

Returns:

The link text.

Throws:

InvalidLinkException - When it is not possible to resolve the link.

See Also:

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

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()

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()

getTitleValue

public static java.lang.String getTitleValue(AuthorElement elem)

Checks if the element has a TITLE child or an INFO/TITLE child and returns it's value.

Parameters:

elem - The current element.

Returns:

The title value.

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)