org.xwiki.rendering.internal.renderer.xhtml.link
Interface XHTMLLinkTypeRenderer

All Superinterfaces:

LinkListener

All Known Implementing Classes:

AbstractXHTMLLinkTypeRenderer, AttachmentXHTMLLinkTypeRenderer, DefaultXHTMLLinkTypeRenderer, DocumentXHTMLLinkTypeRenderer, InterWikiXHTMLLinkTypeRenderer, MailtoXHTMLLinkTypeRenderer, UNCXHTMLLinkTypeRenderer

@ComponentRole
public interface XHTMLLinkTypeRenderer
extends LinkListener

Renders a type of link (mailto link, document link, URL, etc) in XHTML. Components implementing this interface implement the rendering logic only for a single link type and must have a role hint value equal to the ResourceType name (eg "doc" for document link, "attach" for attachment link, etc). Implementations must handle both cases when rendering a link:

• when inside a wiki (ie when an implementation of WikiModel is provided.
• when outside of a wiki. In this case links to attachmets or documents are ignored and rendered as is as direct HREF values. In other words only external links are meaningful.

Since:

2.5M2

Version:

$Id$

Method Summary

XHTMLWikiPrinter	getXHTMLWikiPrinter()
void	setHasLabel(boolean hasLabel)
void	setXHTMLWikiPrinter(XHTMLWikiPrinter printer)

Methods inherited from interface org.xwiki.rendering.listener.LinkListener

beginLink, endLink

Method Detail

setXHTMLWikiPrinter

void setXHTMLWikiPrinter(XHTMLWikiPrinter printer)

Parameters:

printer - the XHTML printer to use to output links as XHTML

getXHTMLWikiPrinter

XHTMLWikiPrinter getXHTMLWikiPrinter()

Returns:

the XHTML printer to use to output links as XHTML

setHasLabel

void setHasLabel(boolean hasLabel)

Parameters:

hasLabel - true if the link to be rendered has a label specified or false otherwise. If no label has been specified then it's up to the XHTML renderer implementation to generate a default label.