Package com.polarion.alm.shared.api.model.rp.widget

Interface PropertiesSidebarConfiguredContainer

public interface PropertiesSidebarConfiguredContainer

The container that the Properties Sidebar is available inside of.

Since:

3.17.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PropertiesSidebarConfiguredContainer.Attributes
static interface	PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration	Configuration for enabling the sidebar on a tag representing the rendered object.

Method Summary

Modifier and Type	Method	Description
PropertiesSidebarConfiguredContainer.Attributes	attributes()	The attribute names used in PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration.
HtmlTagBuilder	htmlTagBuilder()
PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration	openSidebarOnClick(HtmlTagBuilder referenceTagBuilder)	Configuration for opening the sidebar on click on the html tag containing the rendered object.

Method Details

htmlTagBuilder

@NotNull
HtmlTagBuilder htmlTagBuilder()

Returns:

HtmlTagBuilder prepared with the Java script configuration for the sidebar. Use it for adding all or part of the widget's content.

openSidebarOnClick

@NotNull
PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration openSidebarOnClick(@NotNull
 HtmlTagBuilder referenceTagBuilder)

Configuration for opening the sidebar on click on the html tag containing the rendered object.

Parameters:

referenceTagBuilder - representing the tag, for which the sidebar will open on click.

attributes

@NotNull
PropertiesSidebarConfiguredContainer.Attributes attributes()

The attribute names used in PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration.
No need to use this, when openSidebarOnClick(HtmlTagBuilder) and PropertiesSidebarConfiguredContainer.ReferenceTagConfiguration} are used.