Package org.eclnt.jsfserver.elements.impl

Class FIXGRIDBinding.Exporter

java.lang.Object
org.eclnt.jsfserver.elements.impl.FIXGRIDBinding.Exporter
All Implemented Interfaces:
Serializable
Enclosing class:
FIXGRIDBinding<itemClass extends FIXGRIDItem>
public class FIXGRIDBinding.Exporter extends Object implements Serializable
Central class providing all the export functions of the grid. You can override by extending your class from this class, and by overriding the FIXGRIDBinding.createExporter() method.

This class provides a couple of URLs that can be passed to e.g. DOWNLOAD components. Pleayse pay attention: these URLs change with every roundtrip! Background: the corresponding BufferedContent provider (see IBufferedContent are created within each request on server side, and are removed after the render phase, in order to not build up static references within the grid management.
See Also:

  • Constructor Details

    • Exporter

      public Exporter()

  • Method Details

    • getExportFilePrefix

      public String getExportFilePrefix()

    • setExportFilePrefix

      public void setExportFilePrefix(String exportFilePrefix)
      Filename prefix that are proposed when downloading documents. The prefix is appended with the corresponding file extension (e.g. ".pdf" for PDF)

    • getAdditionalExportColumnsLeft

      public List<org.eclnt.jsfserver.elements.impl.FIXGRIDComponent.ColumnInfo> getAdditionalExportColumnsLeft()

    • getAdditionalExportColumnsRight

      public List<org.eclnt.jsfserver.elements.impl.FIXGRIDComponent.ColumnInfo> getAdditionalExportColumnsRight()

    • getExportURLCsvWholeGrid

      public String getExportURLCsvWholeGrid()

    • getExportURLCsvSelectedRows

      public String getExportURLCsvSelectedRows()

    • getExportURLCsvRange

      public String getExportURLCsvRange()

    • getExportURLXMLWholeGrid

      public String getExportURLXMLWholeGrid()

    • getExportURLXMLSelectedRows

      public String getExportURLXMLSelectedRows()

    • getExportURLXMLRange

      public String getExportURLXMLRange()

    • getExportURLPDFWholeGrid

      public String getExportURLPDFWholeGrid()

    • getExportURLPDFSelectedRows

      public String getExportURLPDFSelectedRows()

    • getExportURLHTMLWholeGrid

      public String getExportURLHTMLWholeGrid()

    • getExportURLHTMLSelectedRows

      public String getExportURLHTMLSelectedRows()

    • getExportURLXLSXWholeGrid

      public String getExportURLXLSXWholeGrid()

    • getExportURLXLSXSelectedRows

      public String getExportURLXLSXSelectedRows()

    • exportToObjectListWholeGrid

      public List<List> exportToObjectListWholeGrid(boolean selectedRowsOnly)
      Exports the currently visible grid data into a simple list. Each grid item is exported into a list of objects itself. - The data is in sync with the user's current column selection and column sequence.

    • exportToFormattedValueList

      public List<List<FIXGRIDBinding.FormattedValue>> exportToFormattedValueList(boolean selectedRowsOnly)

    • exportToStringListHeader

      public List<List<String>> exportToStringListHeader()
      Exports the values of the current header rows.

    • exportToValueListHeader

      public List<List<FIXGRIDBinding.FormattedValue>> exportToValueListHeader()

    • exportToStringListFooter

      public List<List<String>> exportToStringListFooter()
      Exports the values of the current footer rows.

    • exportToValueListFooter

      public List<List<FIXGRIDBinding.FormattedValue>> exportToValueListFooter()

    • exportToStringListWholeGrid

      public List<List<String>> exportToStringListWholeGrid(boolean selectedRowsOnly)
      Exports the currently visible grid data into a simple list. Each grid item is exported into a list of strings itself. - The data is in sync with the user's current column selection and column sequence.

    • exportToStringListRange

      public List<List<String>> exportToStringListRange()

    • exportToObjectListRange

      public List<List<Object>> exportToObjectListRange()

    • exportToTabSeparatedStringRange

      public String exportToTabSeparatedStringRange()

    • exportToTabSeparatedStringWholeGrid

      public String exportToTabSeparatedStringWholeGrid(boolean selectedRowsOnly)

    • exportToCSVStringRange

      public String exportToCSVStringRange()

    • exportToCSVStringWholeGrid

      public String exportToCSVStringWholeGrid(boolean selectedRowsOnly)

    • exportToXMLWholeGrid

      public byte[] exportToXMLWholeGrid(boolean selectedRowsOnly)

    • exportToXMLRange

      public byte[] exportToXMLRange()

    • setHtmlExporter

      public void setHtmlExporter(IFIXGRIDHtmlExporter htmlExporter)
      The class that is used for creating instances of IFIXGRIDHtmlExporter is defined in system.xml. If no own class is defined then the default class FIXGRIDHtmlExporter is used.
      You can also assign an own implementation of IFIXGRIDHtmlExporter - if not set by you then an instance of FIXGRIDHtmlExporter is created automatically.

    • getHtmlExporter

      public IFIXGRIDHtmlExporter getHtmlExporter()

    • setPDFExporter

      public void setPDFExporter(IFIXGRIDPdfExporter pdfExporter)
      The class that is used for creating instances of IFIXGRIDPdfExporter is defined in system.xml. If no own class is defined then the default class FIXGRIDPDFExporter is used.
      You can also assign an own implementation of IFIXGRIDPDFExporter - if not set by you then an instance of FIXGRIDPDFExporter is created automatically.

    • getPDFExporter

      public IFIXGRIDPdfExporter getPDFExporter()

    • setExcelExporter

      public void setExcelExporter(IFIXGRIDExcelExporter excelExporter)
      The class that is used for creating instances of IFIXGRIDExcelExporter is defined in system.xml. If no own class is defined then the default class FIXGRIDExcelExporter is used.
      You can also assign an own implementation of IFIXGRIDExcelExporter - if not set by you then an instance of FIXGRIDXMLSpreadSheetExporter is created automatically.

    • getCsvExporter

      public IFIXGRIDCsvExporter getCsvExporter()

    • getExcelExporter

      public IFIXGRIDExcelExporter getExcelExporter()

    • exportToPDFWholeGrid

      public byte[] exportToPDFWholeGrid(boolean selectedRowsOnly)
      Export of grid information into PDF file that is returned as byte array.

    • exportToHTMLWholeGrid

      public byte[] exportToHTMLWholeGrid(boolean selectedRowsOnly)
      Export of grid information into HTML file that is returned as byte array.

    • exportToXLSXWholeGrid

      public byte[] exportToXLSXWholeGrid(boolean selectedRowsOnly)
      Export of grid information into XLSX file that is returned as byte array.