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

Interface RichPageRenderingContext

All Superinterfaces:
RichPageContext, RichPageParametersContext
All Known Subinterfaces:
RichPageWidgetActionContext, RichPageWidgetCommonContext, RichPageWidgetRenderingContext
public interface RichPageRenderingContext extends RichPageParametersContext
Since:
3.9.1

  • Method Details

    • target

      @NotNull RichTextRenderTarget target()

    • createHtmlFragmentBuilder

      @NotNull HtmlFragmentBuilder createHtmlFragmentBuilder()
      Creates builder for given target - target()

    • page

      @Nullable RichPage page()
      Can be null when the widget is used somewhere else than in RichPage

    • plan

      @Nullable Plan plan()
      Can be null when the widget is used somewhere else than in Plan Page
      Since:
      3.10.0

    • testRun

      @Nullable TestRun testRun()
      Can be null when the widget is used somewhere else than in TestRun Page
      Since:
      3.10.0

    • object

      @Nullable ModelObject object()
      Generalized replacement for page(), plan() and testRun() methods.
      Specified by:
      object in interface RichPageParametersContext
      Since:
      3.9.1

    • generateUniqueElementId

      @NotNull String generateUniqueElementId()
      Generates unique id which can be used to identify elements on the client side for the client side javascript code. The returned id contains only characters which do not need any escaping.

    • renderInfo

      @NotNull String renderInfo(@NotNull String message)
      Render message in info box.

    • renderWarning

      @NotNull String renderWarning(@NotNull String message)
      Render message in warning box. Clients can call it in case if not all of required widget's parameters are defined.

    • renderError

      @NotNull String renderError(@NotNull String message)
      Render message in error box.

    • createChartBuilder

      @NotNull PolarionChartBuilder createChartBuilder()

    • createHighchartBuilder

      @NotNull HighchartBuilder createHighchartBuilder()

    • createCustomHighchartBuilder

      @NotNull CustomHighchartBuilder createCustomHighchartBuilder()
      Since:
      3.10.2

    • createJsActionsBuilder

      @NotNull JsActionsBuilder createJsActionsBuilder()
      Creates JS actions builder
      Since:
      3.10.2