TabularExporter

SPI to provide file export to table views.

API

TabularExporter.java

interface TabularExporter {
  void export(TabularModel.TabularSheet tabularSheet, File exportFile)     (1)
  CommonMimeType getMimeType()
  String getTitleLabel()     (2)
  String getCssClass()     (3)
  int orderOfAppearanceInUiDropdown()     (4)
  boolean appliesTo(Class<?> elementType)     (5)
  Blob exportToBlob(TabularModel.TabularSheet tabularSheet)     (6)
}

1	export(TabularModel_TabularSheet, File) Implementing exporters need to write given tabular data from org.apache.causeway.commons.tabular.TabularModel.TabularSheet into the File exportFile , which is provided by the framework for the duration of a single request cycle.
2	getTitleLabel()
3	getCssClass()
4	orderOfAppearanceInUiDropdown() An ordinal, that governs the order of appearance in the UI dropdown.
5	appliesTo(Class) Whether this exporter applies to given elementType . If `false` , this exporter is not provided to end users.
6	exportToBlob(TabularModel_TabularSheet) Writes given tabular data to a Blob , using given sheet’s name as blob name.

Members

export(TabularModel_TabularSheet, File)

Implementing exporters need to write given tabular data from org.apache.causeway.commons.tabular.TabularModel.TabularSheet into the File exportFile , which is provided by the framework for the duration of a single request cycle.

getTitleLabel()

getCssClass()

orderOfAppearanceInUiDropdown()

An ordinal, that governs the order of appearance in the UI dropdown.

1000..1999 reserved for different table presentations
2000..2999 reserved for different table exports

Lowest comes first.

appliesTo(Class)

Whether this exporter applies to given elementType . If false , this exporter is not provided to end users.

exportToBlob(TabularModel_TabularSheet)

Writes given tabular data to a Blob , using given sheet’s name as blob name.