org.primefaces.component.datatable.export

Class DataTableExporter

java.lang.Object

org.primefaces.component.datatable.export.DataTableExporter

All Implemented Interfaces:

Exporter<DataTable>

Direct Known Subclasses:

DataTableCSVExporter, DataTableExcelExporter, DataTablePDFExporter, DataTableXMLExporter

public abstract class DataTableExporter
extends Object
implements Exporter<DataTable>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataTableExporter.ColumnType

Constructor Summary

Constructors

Constructor and Description
DataTableExporter()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doExport(javax.faces.context.FacesContext facesContext, DataTable table, ExportConfiguration config, int index) Export datatable
void	export(javax.faces.context.FacesContext context, List<DataTable> tables, ExportConfiguration config)
protected void	exportAll(javax.faces.context.FacesContext context, DataTable table, Object document)
protected abstract void	exportCells(DataTable table, Object document)
protected String	exportColumnByFunction(javax.faces.context.FacesContext context, UIColumn column)
protected void	exportPageOnly(javax.faces.context.FacesContext context, DataTable table, Object document)
protected void	exportRow(DataTable table, Object document)
protected void	exportRow(DataTable table, Object document, int rowIndex)
protected void	exportSelectionOnly(javax.faces.context.FacesContext context, DataTable table, Object document)
String	exportValue(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
protected List<javax.faces.component.UIColumn>	getColumnsToExport(javax.faces.component.UIData table)
protected boolean	hasColumnFooter(List<javax.faces.component.UIColumn> columns)
protected void	postExport(javax.faces.context.FacesContext context, ExportConfiguration config)
protected void	postRowExport(DataTable table, Object document)
protected void	preExport(javax.faces.context.FacesContext context, ExportConfiguration config)
protected void	preRowExport(DataTable table, Object document)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataTableExporter

public DataTableExporter()

Method Detail

getColumnsToExport

protected List<javax.faces.component.UIColumn> getColumnsToExport(javax.faces.component.UIData table)

hasColumnFooter

protected boolean hasColumnFooter(List<javax.faces.component.UIColumn> columns)

exportColumnByFunction

protected String exportColumnByFunction(javax.faces.context.FacesContext context,
                                        UIColumn column)

exportValue

public String exportValue(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component)

exportPageOnly

protected void exportPageOnly(javax.faces.context.FacesContext context,
                              DataTable table,
                              Object document)

exportAll

protected void exportAll(javax.faces.context.FacesContext context,
                         DataTable table,
                         Object document)

exportRow

protected void exportRow(DataTable table,
                         Object document,
                         int rowIndex)

exportRow

protected void exportRow(DataTable table,
                         Object document)

exportSelectionOnly

protected void exportSelectionOnly(javax.faces.context.FacesContext context,
                                   DataTable table,
                                   Object document)

preExport

protected void preExport(javax.faces.context.FacesContext context,
                         ExportConfiguration config)
                  throws IOException

Throws:

IOException

postExport

protected void postExport(javax.faces.context.FacesContext context,
                          ExportConfiguration config)
                   throws IOException

Throws:

IOException

preRowExport

protected void preRowExport(DataTable table,
                            Object document)

postRowExport

protected void postRowExport(DataTable table,
                             Object document)

exportCells

protected abstract void exportCells(DataTable table,
                                    Object document)

export

public void export(javax.faces.context.FacesContext context,
                   List<DataTable> tables,
                   ExportConfiguration config)
            throws IOException

Specified by:

export in interface Exporter<DataTable>

Throws:

IOException

doExport

protected abstract void doExport(javax.faces.context.FacesContext facesContext,
                                 DataTable table,
                                 ExportConfiguration config,
                                 int index)
                          throws IOException

Export datatable

Parameters:

facesContext - faces context

table - datatable to export

config - export configuration

index - datatable current index during export process

Throws:

IOException