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

Interface RichPageWidgetRenderer

public interface RichPageWidgetRenderer

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
RichPageWidgetRenderer	columnWidth(int width)
RichPageWidgetRenderer	displayedReference(ModelObjectReference displayedReference)	Default is a current object reference, if current view supports it.
boolean	isInlineBlockStyle()
RichPageWidgetRenderer	object(ModelObject object)	Generalized replacement for page(RichPage) method.
RichPageWidgetRenderer	page(RichPage page)	Should be called before the scope(Scope) is called, because this method also sets the scope to the scope of the page if it is not null
RichPageWidgetRenderer	pageContext(Map<Object,Object> pageContext)
RichPageWidgetRenderer	pageParameters(ReadOnlyStrictMap<String,RichPageParameter> pageParameters)
RichPageWidgetRenderer	parameters(ReadOnlyStrictMap<String,RichPageParameter> parameters)
String	renderHtml()
RichPageWidgetRenderer	scope(Scope scope)	Should be called after the page(RichPage) or object(ModelObject) is called, because it overrides the scope
RichPageWidgetRenderer	selectedWorkItems(StrictCollection<WorkItemReference> selectedWorkItems)	Default is a selection of Work Item references, if current view supports it.
RichPageWidgetRenderer	target(RichTextRenderTarget target)	The default is RichTextRenderTarget.PREVIEW when this method is not used.
RichPageWidgetRenderer	urlParameters(ReadOnlyStrictMap<String,String> urlParameters)

Method Details

target

@NotNull
RichPageWidgetRenderer target(@NotNull
 RichTextRenderTarget target)

The default is RichTextRenderTarget.PREVIEW when this method is not used.

Returns:

this to allow method chaining;

See Also:

• RichPageRenderingContext.target()

page

@NotNull
RichPageWidgetRenderer page(@Nullable
 RichPage page)

Should be called before the scope(Scope) is called, because this method also sets the scope to the scope of the page if it is not null

Returns:

this to allow method chaining;

See Also:

• RichPageRenderingContext.page()

object

@NotNull
RichPageWidgetRenderer object(@Nullable
 ModelObject object)

Generalized replacement for page(RichPage) method. Should be called before the scope(Scope) is called, because this method also sets the scope to the scope of the page if it is not null

Returns:

this to allow method chaining;

Since:

3.9.1

See Also:

• RichPageRenderingContext.object()

scope

@NotNull
RichPageWidgetRenderer scope(@Nullable
 Scope scope)

Should be called after the page(RichPage) or object(ModelObject) is called, because it overrides the scope

Parameters:

scope - - null means global scope

Returns:

this to allow method chaining;

displayedReference

@NotNull
RichPageWidgetRenderer displayedReference(@Nullable
 ModelObjectReference displayedReference)

Default is a current object reference, if current view supports it.

Returns:

this to allow method chaining;

Since:

3.23.4

selectedWorkItems

@NotNull
RichPageWidgetRenderer selectedWorkItems(@NotNull
 StrictCollection<WorkItemReference> selectedWorkItems)

Default is a selection of Work Item references, if current view supports it.

Returns:

this to allow method chaining;

Since:

3.23.4

columnWidth

@NotNull
RichPageWidgetRenderer columnWidth(int width)

Returns:

this to allow method chaining;

See Also:

• RichPageWidgetCommonContext.columnWidth()

parameters

@NotNull
RichPageWidgetRenderer parameters(@NotNull
 ReadOnlyStrictMap<String,RichPageParameter> parameters)

Returns:

this to allow method chaining;

See Also:

• RichPageWidgetCommonContext.parameter(String)

pageParameters

@NotNull
RichPageWidgetRenderer pageParameters(@NotNull
 ReadOnlyStrictMap<String,RichPageParameter> pageParameters)

urlParameters

@NotNull
RichPageWidgetRenderer urlParameters(@NotNull
 ReadOnlyStrictMap<String,String> urlParameters)

pageContext

@NotNull
RichPageWidgetRenderer pageContext(@NotNull
 Map<Object,Object> pageContext)

Since:

3.9.1

renderHtml

@NotNull
String renderHtml()

isInlineBlockStyle

boolean isInlineBlockStyle()

Returns:

if the widget called the RichPageWidgetRenderingContext.setInlineBlockStyle()