Package ro.sync.ecss.extensions.api.link

Class LinkTextResolver

  • Direct Known Subclasses:
    DitaLinkTextResolver, DocbookLinkTextResolver
    @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class LinkTextResolver
extends java.lang.Object
    Resolves a link and obtains a text representation. This interface is used when CSS function oxy_link-text() is encountered in the CSS on 'content' properties.
    Since:
    14.2

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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)
      Gets a text representation for the reference.
      void update​(java.util.Set<java.lang.String> modifiedURLs)
      The given URLs have changed.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LinkTextResolver

        public LinkTextResolver()

    • Method Detail

      • resolveReference

        public java.lang.String resolveReference​(AuthorNode node)
                                  throws InvalidLinkException
        Gets a text representation for the reference. This text will be used inside author page next to the the link element.
        Parameters:
        node - Author node.
        Returns:
        The link text.
        Throws:
        InvalidLinkException - When it is not possible to resolve the link.

      • update

        public void update​(java.util.Set<java.lang.String> modifiedURLs)
        The given URLs have changed. Update the cache of references if any of the resolved links were loaded from one of these URL.
        Parameters:
        modifiedURLs - The URLs that are modified.

      • refresh

        public void refresh()
        Signals a major refresh. Any cache should be cleared in order to prepare for future evaluations.

      • clearReferencesCache

        public void clearReferencesCache()
        Any cache should be cleared in order to prepare for future evaluations.

      • activated

        public void activated​(AuthorAccess authorAccess)
        Signals that this resolver has entered in use. All kinds of listeners can be added on this call (like AuthorMouseListener or AuthorListener).
        Parameters:
        authorAccess - The AuthorAccess of the Author page where the listener was activated.

      • deactivated

        public void deactivated​(AuthorAccess authorAccess)
        Signals that this resolver has exit from use. All listeners should be removed on this call.
        Parameters:
        authorAccess - The AuthorAccess of the Author page where the listener was activated.