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

Interface LinkedResourcePositionRenderer

All Superinterfaces:

BasicRenderer, Renderer<LinkedResourcePositionRenderer>

public interface LinkedResourcePositionRenderer
extends Renderer<LinkedResourcePositionRenderer>

The "position" varies depending on the source file being parsed and the selected parser creating the resource traceability link.
For example, for a custom parser of .ppt files, "position" could mean the slide number and would therefore require a different message to be rendered.
For the provided Java, C and XML parsers "position" refers to the line number in the source file.

Since:

3.17.0

Method Summary

Modifier and Type	Method	Description
LinkedResourcePositionRenderer	withMessage()	Will render the "position" value and a "message" that accompanies it.

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

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

Method Details

withMessage

@NotNull
LinkedResourcePositionRenderer withMessage()

Will render the "position" value and a "message" that accompanies it.
This message is added by RtParserDescriptor through an eclipse extension, together with RtParser.
More details on how to create a custom parser can be found in the Polarion SDK documentation.

Returns:

the renderer that provides the "position" and its "message" values. (E.g "65" and "Line" for line number.)