Package com.smartgwt.client.docs

Interface ExportBGColor

public interface ExportBGColor

Exports & Cell Background Color

Several APIs and settings influence the background color which will be used for spreadsheet cells when exporting to Excel/OpenOffice formats using ListGrid.exportData() or ListGrid.exportClientData(). The following APIs are called in the order shown, so hilite.backgroundColor takes precedence over exportDefaultBGColor, for example.

1. getExportBGColor(rowNum, colNum, record)
2. Hilite.backgroundColor
3. getExportRowBGColor(rowNum, record)
4. getExportColumnBGColor(colNum)
5. exportAlternateRowBGColor
6. exportDefaultBGColor

If overriding any of the above methods, return null to allow methods later in the precedence order to influence background color. For example, if you want certain rows to have a special background color but also want to show alternating colors per row, override getExportRowBGColor and return null for all rows that should just show normal alternating colors, and not a special color.