com.atlassian.confluence.content.render.xhtml
Interface LinkRenderer

All Known Implementing Classes:

DefaultLinkRenderer

public interface LinkRenderer

Allows links to content to be rendered without exposing our marshalling architecture.

Method Summary

java.lang.String	render(ContentEntityObject content, ConversionContext conversionContext) Renders link to specified content using the display name of the content as the link body.
java.lang.String	render(ContentEntityObject content, java.lang.String linkAlias, ConversionContext conversionContext) Renders link to specified content with specified alias.

Method Detail

render

java.lang.String render(ContentEntityObject content,
                        ConversionContext conversionContext)
                        throws XhtmlException

Renders link to specified content using the display name of the content as the link body.

Parameters:

content - the content

conversionContext - conversion context

Returns:

link to specified content in storage format.

Throws:

XhtmlException - if there is an error rendering the link

java.lang.IllegalArgumentException - if content is null or if the type of content is not a supported type. (see ContentTypeEnum

render

java.lang.String render(ContentEntityObject content,
                        java.lang.String linkAlias,
                        ConversionContext conversionContext)
                        throws XhtmlException

Renders link to specified content with specified alias.

Parameters:

content - the content

linkAlias - body or alias of resulting link. Note that this will be HTML encoded on output.

conversionContext - conversion context

Returns:

link to specified content in storage format.

Throws:

XhtmlException - if there is an error rendering the link

java.lang.IllegalArgumentException - if content is null or if the type of content is not a supported type. (see ContentTypeEnum