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

Interface DocumentRenderer

All Superinterfaces:

BasicRenderer, Renderer<DocumentRenderer>

public interface DocumentRenderer
extends Renderer<DocumentRenderer>

Since:

3.9.0

Author:

Jakub Stroleny, Polarion Software

Method Summary

Modifier and Type	Method	Description
DocumentRenderer	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.
DocumentRenderer	withDefaultIcon()	Shortcut for calling withDefaultIcon(boolean) with true
DocumentRenderer	withDefaultIcon(boolean value)	When true, it renders the Document icon as the default Document icon; otherwise, it renders the icon as an enum type.
DocumentRenderer	withRevisionIconInBaseline(boolean withRevisionIconInBaseline)	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.
DocumentRenderer	withSpace()	Shortcut for calling withSpace(boolean) with true
DocumentRenderer	withSpace(boolean value)	When true renders document name together with space name otherwise only document name is rendered.

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

withSpace

@NotNull
DocumentRenderer withSpace(boolean value)

When true renders document name together with space name otherwise only document name is rendered.

withSpace

@NotNull
DocumentRenderer withSpace()

Shortcut for calling withSpace(boolean) with true

withDefaultIcon

@NotNull
DocumentRenderer withDefaultIcon(boolean value)

When true, it renders the Document icon as the default Document icon; otherwise, it renders the icon as an enum type.

Since:

3.23.10

withDefaultIcon

@NotNull
DocumentRenderer withDefaultIcon()

Shortcut for calling withDefaultIcon(boolean) with true

Since:

3.23.10

openLinksInCollectionContext

@NotNull
DocumentRenderer openLinksInCollectionContext(@NotNull
 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.)

Since:

3.20.1

withRevisionIconInBaseline

@NotNull
DocumentRenderer withRevisionIconInBaseline(boolean withRevisionIconInBaseline)

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<DocumentRenderer>