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

Interface RichPageContext

All Known Subinterfaces:

RichPageParametersContext, RichPageRenderingContext, RichPageWidgetActionContext, RichPageWidgetCommonContext, RichPageWidgetContext, RichPageWidgetDependenciesContext, RichPageWidgetRenderingContext

public interface RichPageContext

Since:

3.9.1

Method Summary

Modifier and Type	Method	Description
ModelObjectReference	getDisplayedReference()	Returns the reference in which the page is displayed.
Scope	getDisplayedScope()	Returns the scope in which the page is displayed.
StrictCollection<WorkItemReference>	getSelectedWorkItems()	Returns a set of selected Work Item references, if you are on a view that supports it.
SharedLocalization	localization()	Shortcut for sharedContext().SharedContext.localization()
SharedContext	sharedContext()	Shortcut for transaction().ReadOnlyTransaction.context()
ReadOnlyTransaction	transaction()

Method Details

transaction

@NotNull
ReadOnlyTransaction transaction()

sharedContext

@NotNull
SharedContext sharedContext()

Shortcut for transaction().ReadOnlyTransaction.context()

localization

@NotNull
SharedLocalization localization()

Shortcut for sharedContext().SharedContext.localization()

getDisplayedScope

@NotNull
Scope getDisplayedScope()

Returns the scope in which the page is displayed.

Since:

3.10.1

getDisplayedReference

@Nullable
ModelObjectReference getDisplayedReference()

Returns the reference in which the page is displayed.

Or a one that is set by RichPageWidgetRenderer.displayedReference(ModelObjectReference)

It is null if unknown.

Since:

3.23.4

getSelectedWorkItems

@NotNull
StrictCollection<WorkItemReference> getSelectedWorkItems()

Returns a set of selected Work Item references, if you are on a view that supports it. e.g. tracker table/tree (more items) and document (1 item selection only).

Or a one that is set by RichPageWidgetRenderer.selectedWorkItems(StrictCollection).

It is an empty collection if unknown.

Since:

3.23.4