com.almworks.jira.structure.api.export.excel

Interface ExcelCell

All Superinterfaces:

ExportCell

@PublicApi
public interface ExcelCell
extends ExportCell

ExcelCell is a specialization of ExportCell for exporting to the Microsoft Excel format, offering limited support for Excel-specific styling.

Excel export is backed by Apache POI. For advanced formatting you can call the underlying POI objects directly, obtaining them from the column context.

See Also:

ExcelColumn, AttributeContext.getObject(Object), ExportContextKeys.Excel

Method Summary

Modifier and Type	Method and Description
void	setIndention(int indention) Set the indentation level for the cell.
void	setRichTextFromHtml(String html) Attempts to convert an HTML fragment into a rich text string and set that as the cell value.
void	setStyle(ExcelStyle style) Set the cell style.

Methods inherited from interface com.almworks.jira.structure.api.export.ExportCell

setDate, setDatetime, setDuration, setHyperlink, setNumber, setPercentage, setText

Method Detail

setRichTextFromHtml

void setRichTextFromHtml(@Nullable
                         String html)

Attempts to convert an HTML fragment into a rich text string and set that as the cell value. The conversion used is very primitive, at present it only supports <b>, <i>, <em>, and <strong> HTML tags. If the passed HTML fragment is invalid, it may be treated as a literal string.

Parameters:

html - The HTML fragment.

setStyle

void setStyle(@Nullable
              ExcelStyle style)

Set the cell style. The style is very important for the correct display of your values, as it determines the cell's value format, alignment, font, and color. For most value types it is expected that you set the data cell style accordingly. We recommend you to use ExcelColumn.setDefaultStyle(ExcelStyle) once instead of setting the same style to each data cell. It is OK to use setStyle() for column header cells.

Parameters:

style - The style.

setIndention

void setIndention(int indention)

Set the indentation level for the cell. This is used by Structure's Summary column to show an issue's depth within the structure. Indentation levels over 15 cannot be represented due to Excel format limitations.

Parameters:

indention - The indentation level, clamped to be between 0 and 15, inclusive.