com.atlassian.renderer

Interface RendererConfiguration

public interface RendererConfiguration

Interface that provides the renderer with configuration information about its current environment.

Method Summary

Modifier and Type	Method and Description
String	getCharacterEncoding() Will return the character encoding for the current application.
String	getWebAppContextPath() Returns the context path of the running web application.
boolean	isAllowCamelCase() If this method returns true then camelCase links will be allowed and generated.
boolean	isNofollowExternalLinks() If this method returns true then external links will be generated with the rel=nofollow attribute.
default boolean	isOpenExternalLinksInNewWindow() If this method returns "true", there will be target="_blank" attribute added to each external link, thus forcing the browser to open it in a separate tab.

Method Detail

getWebAppContextPath

String getWebAppContextPath()

Returns the context path of the running web application.

Returns:

the current context path.

isNofollowExternalLinks

boolean isNofollowExternalLinks()

If this method returns true then external links will be generated with the rel=nofollow attribute.

Returns:

true to include the nofollow attribute, false to not include it.

isAllowCamelCase

boolean isAllowCamelCase()

If this method returns true then camelCase links will be allowed and generated.

Returns:

true to allow camel case links, false otherwise.

getCharacterEncoding

String getCharacterEncoding()

Will return the character encoding for the current application.

Returns:

a string representation of the current applications character encoding.

isOpenExternalLinksInNewWindow

default boolean isOpenExternalLinksInNewWindow()

If this method returns "true", there will be target="_blank" attribute added to each external link, thus forcing the browser to open it in a separate tab. Links to internal pages are ignored. A link is understood as internal when its URL is relative to site's base URL provided by RenderContext.getBaseUrl().

Returns:

true to add target="_blank" attribute to external links