ICEfaces ACE Components 3.3.0
Java API Documentation

org.icefaces.ace.component.dataexporter
Class Exporter

java.lang.Object
  extended by org.icefaces.ace.component.dataexporter.Exporter
Direct Known Subclasses:
CSVExporter, ExcelExporter, PDFExporter, XMLExporter

public abstract class Exporter
extends java.lang.Object


Nested Class Summary
protected static class Exporter.ColumnType
           
protected static class Exporter.SpanningColumn
           
protected static class Exporter.SpanningRow
           
protected  class Exporter.SpanningRows
           
 
Field Summary
protected  java.lang.String encodingType
           
protected  int[] excludeColumns
           
protected  boolean expandedOnly
           
protected  java.lang.String filename
           
protected static java.util.regex.Pattern HTML_TAG_PATTERN
           
protected  boolean includeFooters
           
protected  boolean includeHeaders
           
protected  boolean pageOnly
           
protected  javax.el.MethodExpression postProcessor
           
protected  javax.el.MethodExpression preProcessor
           
protected  boolean selectedRowsOnly
           
protected  Exporter.SpanningRows spanningRows
           
protected  boolean userColumnOrder
           
 
Constructor Summary
Exporter()
           
 
Method Summary
abstract  java.lang.String export(javax.faces.context.FacesContext facesContext, DataExporter component, DataTable table)
           
protected  java.lang.String exportValue(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
           
protected  ColumnGroup getColumnGroupHeader(javax.faces.component.UIData table)
           
protected  java.util.List<javax.faces.component.UIColumn> getColumnsToExport(javax.faces.component.UIData table, int[] excludedColumns)
           
protected  java.util.List<javax.faces.component.UIColumn> getRowColumnsToExport(Row row, javax.faces.component.UIData table, int[] excludedColumns)
           
protected  java.util.List<Row> getRows(ColumnGroup columnGroup)
           
protected  boolean hasColumnFooter(java.util.List<javax.faces.component.UIColumn> columns)
           
protected  java.lang.String registerResource(byte[] bytes, java.lang.String filename, java.lang.String contentType)
           
protected  int[] resolveExcludedColumnIndexes(java.lang.String columnsToExclude)
           
 void setUp(DataExporter component, DataTable table)
           
protected  boolean shouldExcludeFromExport(javax.faces.component.UIComponent component)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTML_TAG_PATTERN

protected static final java.util.regex.Pattern HTML_TAG_PATTERN

spanningRows

protected Exporter.SpanningRows spanningRows

filename

protected java.lang.String filename

pageOnly

protected boolean pageOnly

excludeColumns

protected int[] excludeColumns

encodingType

protected java.lang.String encodingType

preProcessor

protected javax.el.MethodExpression preProcessor

postProcessor

protected javax.el.MethodExpression postProcessor

includeHeaders

protected boolean includeHeaders

includeFooters

protected boolean includeFooters

selectedRowsOnly

protected boolean selectedRowsOnly

userColumnOrder

protected boolean userColumnOrder

expandedOnly

protected boolean expandedOnly
Constructor Detail

Exporter

public Exporter()
Method Detail

setUp

public void setUp(DataExporter component,
                  DataTable table)

export

public abstract java.lang.String export(javax.faces.context.FacesContext facesContext,
                                        DataExporter component,
                                        DataTable table)
                                 throws java.io.IOException
Throws:
java.io.IOException

getColumnsToExport

protected java.util.List<javax.faces.component.UIColumn> getColumnsToExport(javax.faces.component.UIData table,
                                                                            int[] excludedColumns)

getColumnGroupHeader

protected ColumnGroup getColumnGroupHeader(javax.faces.component.UIData table)

getRows

protected java.util.List<Row> getRows(ColumnGroup columnGroup)

getRowColumnsToExport

protected java.util.List<javax.faces.component.UIColumn> getRowColumnsToExport(Row row,
                                                                               javax.faces.component.UIData table,
                                                                               int[] excludedColumns)

hasColumnFooter

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

shouldExcludeFromExport

protected boolean shouldExcludeFromExport(javax.faces.component.UIComponent component)

resolveExcludedColumnIndexes

protected int[] resolveExcludedColumnIndexes(java.lang.String columnsToExclude)

exportValue

protected java.lang.String exportValue(javax.faces.context.FacesContext context,
                                       javax.faces.component.UIComponent component)

registerResource

protected java.lang.String registerResource(byte[] bytes,
                                            java.lang.String filename,
                                            java.lang.String contentType)

ICEfaces ACE Components 3.3.0
Java API Documentation

Copyright 2013 ICEsoft Technologies Canada Corp., All Rights Reserved.