XWIKI-19383: Display a title on createlink

* Fixed types and names

TODO:
* Fix tests
* Check DocumentXHTMLLinkTypeRenderer.java L105

Author: Sereza7

xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/renderer/DefaultDocumentURITitleGenerator.java renamed to xwiki-rendering-api/src/main/java/org/xwiki/rendering/internal/renderer/DefaultWantedLinkTitleGenerator.java

@@ -23,29 +23,30 @@
 
 import org.xwiki.component.annotation.Component;
 import org.xwiki.rendering.listener.reference.ResourceReference;
-import org.xwiki.rendering.renderer.reference.link.URITitleGenerator;
+import org.xwiki.rendering.renderer.reference.link.WantedLinkTitleGenerator;
 
 /**
- * Generate link titles for DOC URIs.
- *
+ * Generates wanted link titles for resource references.
+ * Using this implementation should be avoided, another implementation should be used instead.
+ * E.g. XWikiDocumentURITitleGenerator in xwiki-platform which is used to provide proper translations.
+ * This implementation is a fallback and should only be used when xwiki-rendering is running by itself.
+ * This implementation uses the reference as the title.
  * @version $Id$
- * @since 15.2RC1
+ * @since 15.3RC1
  */
-@Component(hints = {"doc", "page"})
+@Component
 @Singleton
-public class DefaultDocumentURITitleGenerator implements URITitleGenerator
+public class DefaultWantedLinkTitleGenerator implements WantedLinkTitleGenerator
 {
-    private static final String DEFAULT_TITLE = "Create page: %s";
+    private static final String DEFAULT_TITLE = "Create resource: %s";
 
     /**
-     * Generate the title of a Document URI. Using this implementation should be avoided, another implementation should
-     * be used instead, e.g. XWikiDocumentURITitleGenerator in xwiki-platform which is used to provide proper
-     * translations. This implementation should only be used when xwiki-rendering is running by itself.
-     * @param reference the reference pointing to a document URI for which we want to generate a create link title
-     * @return the URI title to display when rendering a document reference.
+     * Generates wanted link titles for resource references.
+     * @param reference the reference for which we want to generate a wanted link title
+     * @return the wanted link title used when rendering a resource reference.
      */
     @Override
-    public String generateCreateTitle(ResourceReference reference)
+    public String generateWantedLinkTitle(ResourceReference reference)
     {
         return String.format(DEFAULT_TITLE, reference.getReference());
     }

xwiki-rendering-api/src/main/java/org/xwiki/rendering/renderer/reference/link/URITitleGenerator.java renamed to xwiki-rendering-api/src/main/java/org/xwiki/rendering/renderer/reference/link/WantedLinkTitleGenerator.java

@@ -24,19 +24,19 @@
 import org.xwiki.stability.Unstable;
 
 /**
- * Generate Resource Reference titles for URIs.
+ * Generate Resource Reference titles for wanted links.
  * The implementations should be named according to the kind of reference they process.
  *
  * @version $Id$
- * @since 15.2RC1
+ * @since 15.3RC1
  */
 @Role
 @Unstable
-public interface URITitleGenerator
+public interface WantedLinkTitleGenerator
 {
     /**
-     * @param reference the reference pointing to a URI for which we want to generate a create link title
-     * @return the URI title to display when rendering resource references
+     * @param reference the reference for which we want to generate a wanted link title
+     * @return the title to display when rendering the resource reference wanted link
      */
-    String generateCreateTitle(ResourceReference reference);
+    String generateWantedLinkTitle(ResourceReference reference);
 }

xwiki-rendering-api/src/main/resources/META-INF/components.txt

@@ -29,7 +29,7 @@ org.xwiki.rendering.internal.renderer.DefaultAttachmentURILabelGenerator
 org.xwiki.rendering.internal.renderer.MailtoURILabelGenerator
 org.xwiki.rendering.internal.renderer.DataURILabelGenerator
 org.xwiki.rendering.internal.renderer.DefaultPageAttachmentURILabelGenerator
-org.xwiki.rendering.internal.renderer.DefaultDocumentURITitleGenerator
+org.xwiki.rendering.internal.renderer.DefaultWantedLinkTitleGenerator
 org.xwiki.rendering.internal.renderer.reference.DefaultResourceReferenceTypeSerializer
 org.xwiki.rendering.internal.syntax.SyntaxConverter
 org.xwiki.rendering.internal.syntax.DefaultSyntaxRegistry

xwiki-rendering-syntaxes/xwiki-rendering-syntax-xhtml/src/main/java/org/xwiki/rendering/internal/renderer/xhtml/link/AbstractXHTMLLinkTypeRenderer.java

@@ -49,7 +49,7 @@ public abstract class AbstractXHTMLLinkTypeRenderer implements XHTMLLinkTypeRend
 
     /**
      * The XHTML element {@code title} parameter.
-     * @since 15.2RC1
+     * @since 15.3RC1
      */
     protected static final String TITLE = "title";
 
@@ -227,10 +227,7 @@ public void endLink(ResourceReference reference, boolean freestanding, Map<Strin
     {
         // If there was no link content then generate it based on the passed reference
         if (!hasLabel()) {
-            getXHTMLWikiPrinter().printXMLStartElement(SPAN, new String[][]
-            {
-                { CLASS, "wikigeneratedlinkcontent" }
-            });
+            getXHTMLWikiPrinter().printXMLStartElement(SPAN, new String[][] { { CLASS, "wikigeneratedlinkcontent" } });
             getXHTMLWikiPrinter().printXML(computeLabel(reference));
             getXHTMLWikiPrinter().printXMLEndElement(SPAN);
         }

xwiki-rendering-syntaxes/xwiki-rendering-syntax-xhtml/src/main/java/org/xwiki/rendering/internal/renderer/xhtml/link/DocumentXHTMLLinkTypeRenderer.java

@@ -36,7 +36,7 @@
 import org.xwiki.rendering.listener.reference.DocumentResourceReference;
 import org.xwiki.rendering.listener.reference.ResourceReference;
 import org.xwiki.rendering.renderer.reference.link.LinkLabelGenerator;
-import org.xwiki.rendering.renderer.reference.link.URITitleGenerator;
+import org.xwiki.rendering.renderer.reference.link.WantedLinkTitleGenerator;
 import org.xwiki.rendering.wiki.WikiModel;
 
 /**
@@ -72,7 +72,7 @@ public class DocumentXHTMLLinkTypeRenderer extends AbstractXHTMLLinkTypeRenderer
      * Used to generate a link title.
      */
     @Inject
-    private URITitleGenerator defaultTitleGenerator;
+    private WantedLinkTitleGenerator defaultTitleGenerator;
 
     @Override
     public void initialize() throws InitializationException
@@ -102,33 +102,35 @@ protected String computeLabel(ResourceReference reference)
         return this.linkLabelGenerator.generate(reference);
     }
 
-    private URITitleGenerator getTitleGenerator(ResourceReference reference)
+    private WantedLinkTitleGenerator getTitleGenerator(ResourceReference reference)
     {
-        URITitleGenerator titleGenerator = this.defaultTitleGenerator;
-        if (this.componentManager.hasComponent(URITitleGenerator.class, reference.getType().getScheme())) {
-            try {
-                titleGenerator = this.componentManager.getInstance(URITitleGenerator.class,
-                    reference.getType().getScheme());
-            } catch (Exception e) {
-                logger.warn("Error while loading component for generating URI title: [{}]",
-                    ExceptionUtils.getRootCauseMessage(e));
-                logger.debug("Full stack trace: ", e);
+        WantedLinkTitleGenerator titleGenerator = this.defaultTitleGenerator;
+        try {
+            titleGenerator = this.componentManager.getInstance(WantedLinkTitleGenerator.class,
+                reference.getType().getScheme());
+        } catch (Exception e) {
+            String message = "Could not find a [WantedLinkTitleGenerator] component to generate the wanted "
+                + "link title for [{}].";
+            if (logger.isDebugEnabled()) {
+                logger.debug(message, reference, e);
+            } else {
+                logger.warn(String.format("%s: [{}]", message), reference, ExceptionUtils.getRootCauseMessage(e));
             }
         }
         return titleGenerator;
     }
 
     /**
-     * Implementation for computing a document link title when no title has been specified.
-     * Looks for a component implementing URITitleGenerator with a role hint matching the reference scheme.
-     * @param reference the reference of the link for which to compute the label
-     * @return the computed title
-     * @since 15.2RC1
+     * Implementation for computing a wanted link title.
+     * Looks for a component implementing WantedLinkTitleGenerator with a role hint matching the reference scheme.
+     * @param reference the reference for which to compute the title
+     * @return the wanted link title
+     * @since 15.3RC1
      */
-    private String computeCreateTitle(ResourceReference reference)
+    private String computeWantedLinkTitle(ResourceReference reference)
     {
-        URITitleGenerator titleGenerator = getTitleGenerator(reference);
-        return titleGenerator.generateCreateTitle(reference);
+        WantedLinkTitleGenerator titleGenerator = getTitleGenerator(reference);
+        return titleGenerator.generateWantedLinkTitle(reference);
     }
 
     @Override
@@ -167,7 +169,7 @@ private void beginInternalLink(ResourceReference reference, boolean freestanding
         } else {
             // The wiki document doesn't exist
             spanAttributes.put(CLASS, "wikicreatelink");
-            spanAttributes.put(TITLE, computeCreateTitle(reference));
+            spanAttributes.put(TITLE, computeWantedLinkTitle(reference));
             anchorAttributes.put(XHTMLLinkRenderer.HREF, this.wikiModel.getDocumentEditURL(reference));
         }