Package com.polarion.alm.shared.api.model.wi

Interface WorkItemRenderer

All Superinterfaces:

BasicRenderer, CollectionElementRenderer, Renderer<WorkItemRenderer>

public interface WorkItemRenderer
extends Renderer<WorkItemRenderer>, CollectionElementRenderer

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
WorkItemRenderer	openLinksInCollectionContext(BaselineCollectionReference reference)	Links rendered with Renderer.withLinks(boolean) set to 'true' will open in the Baseline Collection context, and the revision parameter will not be present in the link.
WorkItemRenderer	withDecoration()	Shortcut for calling withDecoration(boolean) with true.
WorkItemRenderer	withDecoration(boolean value)	Configures if the strike through indicating resolved item and text color indicating the severity should be used Default is true when this method is not used.
WorkItemRenderer	withLinksToDocument()	Shortcut for calling withLinksToDocument(boolean) with true.
WorkItemRenderer	withLinksToDocument(boolean value)	Configures if the Links to the Document containing the Work Item should be rendered.
WorkItemRenderer	withOutlineNumber()	Shortcut for calling withOutlineNumber(boolean) with true.
WorkItemRenderer	withOutlineNumber(boolean value)	Configures if the Outline Number is rendered instead of ID.
WorkItemRenderer	withRevisionIconInBaseline(boolean value)	If Renderer.withRevisionIconInBaseline(boolean) is called with true, Renderer.withRevisionIcon(boolean) is called with true and the rendered object has no requested revision, then the current baseline's revision (if any) is used as the tooltip on the revision icon.
WorkItemRenderer	withTitle()	Shortcut for calling withTitle(boolean) with true.
WorkItemRenderer	withTitle(boolean value)	Default is false when this method is not used.
WorkItemRenderer	withTruncatedTitle(int maxTitleLength)	Renders work item with truncated title. Maximum length of title is maxTitleLength symbols.
WorkItemRenderer	wrapTitle()	Shortcut for calling wrapTitle(boolean) with true.
WorkItemRenderer	wrapTitle(boolean value)	Defines if title will be wrapped.

Methods inherited from interface com.polarion.alm.shared.api.model.Renderer

htmlFor, htmlTo, openLinksInNewWindow, openLinksInNewWindow, withBaselineIcon, withBaselineIcon, withIcon, withIcon, withLinks, withLinks, withRevisionIcon, withRevisionIcon, withRevisionOrBaselineIcon, withText, withText

Method Details

withTitle

@NotNull
WorkItemRenderer withTitle(boolean value)

Default is false when this method is not used.

withTitle

@NotNull
WorkItemRenderer withTitle()

Shortcut for calling withTitle(boolean) with true.

wrapTitle

@NotNull
WorkItemRenderer wrapTitle(boolean value)

Defines if title will be wrapped. Default is true when this method is not used.

Since:

3.9.1

wrapTitle

@NotNull
WorkItemRenderer wrapTitle()

Shortcut for calling wrapTitle(boolean) with true.

Since:

3.9.1

withTruncatedTitle

@NotNull
WorkItemRenderer withTruncatedTitle(int maxTitleLength)

Renders work item with truncated title.
Maximum length of title is maxTitleLength symbols. Also three-dot symbol will be added.
If the argument is less than 1, original title will be rendered.

Parameters:

maxTitleLength - maximal length of the title

Since:

3.9.1

withDecoration

@NotNull
WorkItemRenderer withDecoration(boolean value)

Configures if the strike through indicating resolved item and text color indicating the severity should be used Default is true when this method is not used.

withDecoration

@NotNull
WorkItemRenderer withDecoration()

Shortcut for calling withDecoration(boolean) with true.

withOutlineNumber

@NotNull
WorkItemRenderer withOutlineNumber(boolean value)

Configures if the Outline Number is rendered instead of ID.

Since:

3.18.2

withOutlineNumber

@NotNull
WorkItemRenderer withOutlineNumber()

Shortcut for calling withOutlineNumber(boolean) with true.

Since:

3.18.2

withRevisionIconInBaseline

@NotNull
WorkItemRenderer withRevisionIconInBaseline(boolean value)

Description copied from interface: Renderer

If Renderer.withRevisionIconInBaseline(boolean) is called with true, Renderer.withRevisionIcon(boolean) is called with true and the rendered object has no requested revision, then the current baseline's revision (if any) is used as the tooltip on the revision icon.

Specified by:

withRevisionIconInBaseline in interface Renderer<WorkItemRenderer>

withLinksToDocument

@NotNull
WorkItemRenderer withLinksToDocument(boolean value)

Configures if the Links to the Document containing the Work Item should be rendered.

Since:

3.24.4

withLinksToDocument

@NotNull
WorkItemRenderer withLinksToDocument()

Shortcut for calling withLinksToDocument(boolean) with true.

Since:

3.24.4

openLinksInCollectionContext

@NotNull
WorkItemRenderer openLinksInCollectionContext(@Nullable
 BaselineCollectionReference reference)

Links rendered with Renderer.withLinks(boolean) set to 'true' will open in the Baseline Collection context, and the revision parameter will not be present in the link. (Because the revision is defined by the context.)

Specified by:

openLinksInCollectionContext in interface CollectionElementRenderer

Since:

3.25.6