public class

RenderContext

extends Object
java.lang.Object
   ↳ com.atlassian.bitbucket.markup.RenderContext

Class Overview

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.

Summary

Nested Classes
class RenderContext.Builder  
Public Methods
@Nonnull Map<String, Object> getData()
@Nullable Boolean getHardwrap()
@Nullable Boolean getHtmlEscaped()
@Nullable Boolean getIncludeHeadingId()
@Nonnull UrlMode getUrlMode()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

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

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

@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)

@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)

@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)

@Nonnull public UrlMode getUrlMode ()

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