com.atlassian.bitbucket.markup

Class RenderContext

java.lang.Object

com.atlassian.bitbucket.markup.RenderContext

public class RenderContext
extends Object

Context-specific data for rendering markup.

This information will be used by rendering components to determine context-specific information, such as whether URLs are absolute or relative.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderContext.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getData()
Boolean	getHardwrap()
Boolean	getHtmlEscaped()
Boolean	getIncludeHeadingId()
UrlMode	getUrlMode()

Methods inherited from class java.lang.Object

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

Method Detail

getData

@Nonnull
public Map<String,Object> getData()

Returns:

additional data to make available when rendering, which may be empty but never null

getHardwrap

@Nullable
public Boolean getHardwrap()

Returns:

TRUE to render newlines as breaks; FALSE to retain newlines unchanged; or null to use the system-configured default (currently true)

getHtmlEscaped

@Nullable
public Boolean getHtmlEscaped()

Returns:

TRUE to escape HTML in the content when rendering; FALSE to retain HTML unchanged; or null to use the system-configured default (currently true)

getIncludeHeadingId

@Nullable
public Boolean getIncludeHeadingId()

Returns:

TRUE to include an ID on each rendered heading; FALSE to omit them; or null to use the system-configured default (currently false)

Since:

5.11

getUrlMode

@Nonnull
public UrlMode getUrlMode()

Returns:

the mode to use when rendering URLs (RELATIVE by default)