RichPageWidgetCommonContext

All Superinterfaces:: RichPageContext, RichPageParametersContext, RichPageRenderingContext, RichPageWidgetContext

All Known Subinterfaces:: RichPageWidgetActionContext, RichPageWidgetRenderingContext

public interface RichPageWidgetCommonContext extends RichPageWidgetContext, RichPageRenderingContext

Common super interface for contexts used in methods RichPageWidget.renderHtml(RichPageWidgetRenderingContext) and RichPageWidget.executeAction(RichPageWidgetActionContext)

Since:: 3.9.2

Method Summary

Modifier and Type

Method

Description

int

columnWidth()

<T extends RichPageParameter> T

parameter(String id)

Returns widget parameter with requested id.

PropertiesSidebarConfiguration

propertiesSidebarConfiguration()

Configuration that will bind the widget section to Polarion's Java script for opening and handling the Properties Sidebar Currently, the sidebar is only available for Work Items.

Methods inherited from interface com.polarion.alm.shared.api.model.rp.widget.RichPageContext
getDisplayedReference, getDisplayedScope, getSelectedWorkItems, localization, sharedContext, transaction

Methods inherited from interface com.polarion.alm.shared.api.model.rp.widget.RichPageParametersContext
pageParameters, urlParameters

Methods inherited from interface com.polarion.alm.shared.api.model.rp.widget.RichPageRenderingContext
createChartBuilder, createCustomHighchartBuilder, createHighchartBuilder, createHtmlFragmentBuilder, createJsActionsBuilder, generateUniqueElementId, object, page, plan, renderError, renderInfo, renderWarning, target, testRun

Methods inherited from interface com.polarion.alm.shared.api.model.rp.widget.RichPageWidgetContext
resourceUrl

Method Details
- parameter
  
  @NotNull <T extends RichPageParameter> T parameter(@NotNull String id)
  
  Returns widget parameter with requested id.
  
  Throws:
  
  IllegalArgumentException - when the parameter with the given id is not defined for this widget by RichPageWidget.getParametersDefinition(ParameterFactory)
- columnWidth
  
  int columnWidth()
- propertiesSidebarConfiguration
  
  @NotNull PropertiesSidebarConfiguration propertiesSidebarConfiguration()
  
  Configuration that will bind the widget section to Polarion's Java script for opening and handling the Properties Sidebar Currently, the sidebar is only available for Work Items.
  
  Since:
  
  3.17.3