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 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| RenderContext.Builder | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[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
TRUEto render newlines as breaks;FALSEto retain newlines unchanged; ornullto use the system-configured default (currentlytrue)
@Nullable public Boolean getHtmlEscaped ()
Returns
TRUEto escape HTML in the content when rendering;FALSEto retain HTML unchanged; ornullto use the system-configured default (currentlytrue)
@Nullable public Boolean getIncludeHeadingId ()
Returns
TRUEto include an ID on each rendered heading;FALSEto omit them; ornullto use the system-configured default (currentlyfalse)
@Nonnull public UrlMode getUrlMode ()
Returns
- the mode to use when rendering URLs (
RELATIVEby default)