org.primefaces.component.export

Class Exporter

java.lang.Object

org.primefaces.component.export.Exporter

Direct Known Subclasses:

CSVExporter, ExcelExporter, PDFExporter, XMLExporter

public abstract class Exporter
extends Object

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Exporter()

Method Summary

Modifier and Type	Method and Description
abstract void	export(javax.faces.context.FacesContext facesContext, DataTable table, String outputFileName, boolean pageOnly, boolean selectionOnly, String encodingType, javax.el.MethodExpression preProcessor, javax.el.MethodExpression postProcessor, ExporterOptions options)
abstract void	export(javax.faces.context.FacesContext facesContext, List<String> clientIds, String outputFileName, boolean pageOnly, boolean selectionOnly, String encodingType, javax.el.MethodExpression preProcessor, javax.el.MethodExpression postProcessor, ExporterOptions options)
abstract void	export(javax.faces.context.FacesContext facesContext, String outputFileName, List<DataTable> tables, boolean pageOnly, boolean selectionOnly, String encodingType, javax.el.MethodExpression preProcessor, javax.el.MethodExpression postProcessor, ExporterOptions options)
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)
protected String	exportValue(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
protected List<javax.faces.component.UIColumn>	getColumnsToExport(javax.faces.component.UIData table)
String	getSheetName(javax.faces.context.FacesContext context, DataTable table)
protected boolean	hasColumnFooter(List<javax.faces.component.UIColumn> columns)
protected void	postRowExport(DataTable table, Object document)
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

Exporter

public Exporter()

Method Detail

export

public abstract void export(javax.faces.context.FacesContext facesContext,
                            DataTable table,
                            String outputFileName,
                            boolean pageOnly,
                            boolean selectionOnly,
                            String encodingType,
                            javax.el.MethodExpression preProcessor,
                            javax.el.MethodExpression postProcessor,
                            ExporterOptions options)
                     throws IOException

Throws:

IOException

export

public abstract void export(javax.faces.context.FacesContext facesContext,
                            List<String> clientIds,
                            String outputFileName,
                            boolean pageOnly,
                            boolean selectionOnly,
                            String encodingType,
                            javax.el.MethodExpression preProcessor,
                            javax.el.MethodExpression postProcessor,
                            ExporterOptions options)
                     throws IOException

Throws:

IOException

export

public abstract void export(javax.faces.context.FacesContext facesContext,
                            String outputFileName,
                            List<DataTable> tables,
                            boolean pageOnly,
                            boolean selectionOnly,
                            String encodingType,
                            javax.el.MethodExpression preProcessor,
                            javax.el.MethodExpression postProcessor,
                            ExporterOptions options)
                     throws IOException

Throws:

IOException

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

protected 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)

getSheetName

public String getSheetName(javax.faces.context.FacesContext context,
                           DataTable table)

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)