org.xwiki.rendering.internal.renderer.xhtml.link
Class DocumentXHTMLLinkTypeRenderer

java.lang.Object
  org.xwiki.rendering.internal.renderer.xhtml.link.AbstractXHTMLLinkTypeRenderer
      org.xwiki.rendering.internal.renderer.xhtml.link.DocumentXHTMLLinkTypeRenderer

All Implemented Interfaces:

org.xwiki.component.phase.Initializable, XHTMLLinkTypeRenderer, LinkListener

@Component
@Named(value="doc")
@InstantiationStrategy(value=PER_LOOKUP)
public class DocumentXHTMLLinkTypeRenderer
extends AbstractXHTMLLinkTypeRenderer
implements org.xwiki.component.phase.Initializable

Handle XHTML rendering for links to documents.

Since:

2.5M2

Version:

$Id$

Field Summary

Fields inherited from class org.xwiki.rendering.internal.renderer.xhtml.link.AbstractXHTMLLinkTypeRenderer

CLASS, componentManager, SPAN

Constructor Summary

DocumentXHTMLLinkTypeRenderer()

Method Summary

void	beginLink(ResourceReference reference, boolean isFreeStandingURI, java.util.Map<java.lang.String,java.lang.String> parameters)
protected void	beginLinkExtraAttributes(ResourceReference reference, java.util.Map<java.lang.String,java.lang.String> spanAttributes, java.util.Map<java.lang.String,java.lang.String> anchorAttributes) Hook called when rendering the beginning of a link to allow implementation classes to augment the passed span and anchor attributes as they see fit.
protected java.lang.String	computeLabel(ResourceReference reference) Default implementation for computing a link label when no label has been specified.
void	initialize()

Methods inherited from class org.xwiki.rendering.internal.renderer.xhtml.link.AbstractXHTMLLinkTypeRenderer

endLink, getXHTMLWikiPrinter, hasLabel, setHasLabel, setXHTMLWikiPrinter

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentXHTMLLinkTypeRenderer

public DocumentXHTMLLinkTypeRenderer()

Method Detail

initialize

public void initialize()
                throws org.xwiki.component.phase.InitializationException

Specified by:

initialize in interface org.xwiki.component.phase.Initializable

Throws:

org.xwiki.component.phase.InitializationException

See Also:

Initializable.initialize()

beginLink

public void beginLink(ResourceReference reference,
                      boolean isFreeStandingURI,
                      java.util.Map<java.lang.String,java.lang.String> parameters)

Specified by:

beginLink in interface LinkListener

Overrides:

beginLink in class AbstractXHTMLLinkTypeRenderer

See Also:

LinkListener.beginLink(org.xwiki.rendering.listener.reference.ResourceReference , boolean, Map)

computeLabel

protected java.lang.String computeLabel(ResourceReference reference)

Default implementation for computing a link label when no label has been specified. Can be overwritten by implementations to provide a different algorithm.

Overrides:

computeLabel in class AbstractXHTMLLinkTypeRenderer

Parameters:

reference - the reference of the link for which to compute the label

Returns:

the computed label

See Also:

AbstractXHTMLLinkTypeRenderer.computeLabel(org.xwiki.rendering.listener.reference.ResourceReference)

beginLinkExtraAttributes

protected void beginLinkExtraAttributes(ResourceReference reference,
                                        java.util.Map<java.lang.String,java.lang.String> spanAttributes,
                                        java.util.Map<java.lang.String,java.lang.String> anchorAttributes)

Hook called when rendering the beginning of a link to allow implementation classes to augment the passed span and anchor attributes as they see fit.

Specified by:

beginLinkExtraAttributes in class AbstractXHTMLLinkTypeRenderer

Parameters:

reference - the reference of the link being rendered

spanAttributes - the HTML attributes for the SPAN HTML element added around the ANCHOR HTML element

anchorAttributes - the HTML attributes for the ANCHOR element

See Also:

AbstractXHTMLLinkTypeRenderer.beginLinkExtraAttributes(org.xwiki.rendering.listener.reference.ResourceReference , java.util.Map, java.util.Map)