Package com.atlassian.jira.projects.api.sidebar

Interface SidebarRenderer

All Known Implementing Classes:

SidebarRendererImpl

public interface SidebarRenderer

Renders sidebar HTML.

Method Summary

Modifier and Type	Method	Description
String	render(String content, String headerContent, io.atlassian.fugue.Option<SettingsButton> settingsButton)	Deprecated. since 4.0.29.
String	render(Supplier<String> content, Supplier<String> headerContent, io.atlassian.fugue.Option<SettingsButton> settingsButton)	Render a sidebar.
String	renderHidden()	Render a sidebar as hidden.

Method Details

render

String render(Supplier<String> content,
 Supplier<String> headerContent,
 io.atlassian.fugue.Option<SettingsButton> settingsButton)

Render a sidebar.

Parameters:

content - The content of the sidebar's body.

headerContent - The content of the sidebar's header.

settingsButton - Optional text and href of a 'settings button' to show in the sidebar footer

Returns:

Sidebar HTML.

renderHidden

String renderHidden()

Render a sidebar as hidden.

Returns:

Sidebar HTML in hidden state.

render

@Deprecated
String render(String content,
 String headerContent,
 io.atlassian.fugue.Option<SettingsButton> settingsButton)

Deprecated.

since 4.0.29. Use render(Supplier, Supplier, Option) to lazily supply the contents needed.

Render a sidebar.

Parameters:

content - The content of the sidebar's body.

headerContent - The content of the sidebar's header.

settingsButton - Optional text and href of a 'settings button' to show in the sidebar footer

Returns:

Sidebar HTML.