com.almworks.jira.structure.api.export

Interface ExportRenderer<C extends ExportCell,M extends ExportColumn<C>>

Type Parameters:

C - The expected cell type.

M - The expected column type.

@PublicSpi
public interface ExportRenderer<C extends ExportCell,M extends ExportColumn<C>>

An ExportRenderer corresponds to a single column of the underlying table-like medium (e.g. an Excel sheet or an HTML table). The renderer is responsible for configuring the column and rendering its cells.

Single-format renderers can be parameterized with the expected ExportCell and ExportColumn subtypes. Generic or multiple-format renderers can use the basic cell and column types or implement the raw interface.

See Also:

ExportCell, ExportColumn

Method Summary

Modifier and Type	Method and Description
void	configureColumn(M column, ExportRenderContext context) Configure the column, i.e.
void	prepare(ExportRequestContext context) Allows the renderer to do one-time preparations before rendering a forest.
void	renderCell(C cell, ExportRow row, ExportRenderContext context) Render the cell, i.e.

Method Detail

prepare

void prepare(@NotNull
             ExportRequestContext context)

Allows the renderer to do one-time preparations before rendering a forest. The renderer should request attributes that it needs for rendering through ExportRequestContext.requireAttribute(com.almworks.jira.structure.api.attribute.AttributeSpec<?>).

Parameters:

context - rendering context

configureColumn

void configureColumn(@NotNull
                     M column,
                     @NotNull
                     ExportRenderContext context)

Configure the column, i.e. set the column name (through the header cell) and, probably, other column options, depending on the medium. This method is called once for export request.

Parameters:

column - The column instance to configure.

context - The current request context.

renderCell

void renderCell(@NotNull
                C cell,
                @NotNull
                ExportRow row,
                @NotNull
                ExportRenderContext context)

Render the cell, i.e. set its value and, probably, other cell options, depending on the medium. This method is called once for each issue in the exported structure (or part of a structure).

Parameters:

cell - The cell instance to render into.

row - The current row.

context - The current request context.