org.apache.click.examples.control.exporter

Class ExportTable

java.lang.Object

org.apache.click.control.AbstractControl

org.apache.click.control.Table

org.apache.click.examples.control.exporter.ExportTable

All Implemented Interfaces:

Serializable, Control, Stateful

public class ExportTable
extends Table

This example provides a table that can be exported to an Excel spreadsheet.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	excludedColumns
protected List<String>	excludedExportColumns
protected int	exportAttachment
protected int	exportBannerPosition
protected TableExportContainer	exportContainer
static int	EXPORTER_ATTACHED
static int	EXPORTER_DETACHED
static int	EXPORTER_INLINE
protected boolean	exportTableHeaders
protected int	firstExportRow
protected int	lastExportRow

Fields inherited from class org.apache.click.control.Table

ASCENDING, bannerPosition, caption, CLASS_BLUE1, CLASS_BLUE2, CLASS_COMPLEX, CLASS_ISI, CLASS_ITS, CLASS_MARS, CLASS_NOCOL, CLASS_ORANGE1, CLASS_ORANGE2, CLASS_REPORT, CLASS_SIMPLE, CLASS_STYLES, COLUMN, columnList, columns, controlLink, controlList, dataProvider, height, hoverRows, nullifyRowListOnDestroy, PAGE, pageNumber, pageSize, paginator, PAGINATOR_ATTACHED, PAGINATOR_DETACHED, PAGINATOR_INLINE, paginatorAttachment, POSITION_BOTH, POSITION_BOTTOM, POSITION_TOP, renderId, rowCount, rowList, showBanner, SORT, sortable, sorted, sortedAscending, sortedColumn, width

Fields inherited from class org.apache.click.control.AbstractControl

actionListener, attributes, behaviors, headElements, listener, listenerMethod, messages, name, parent, styles

Fields inherited from interface org.apache.click.Control

CONTROL_MESSAGES

Constructor Summary

Constructors

Constructor and Description
ExportTable()
ExportTable(String name)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getExcludedColumns()
List<String>	getExcludedExportColumns()
int	getExportAttachment()
int	getExportBannerPosition()
List	getExportColumnList()
TableExportContainer	getExportContainer()
int	getFirstExportRow()
int	getLastExportRow()
boolean	isExportTableHeaders()
void	onInit()
boolean	onProcess()
void	onRender()
void	render(HtmlStringBuffer buffer)
protected void	renderBodyNoRows(HtmlStringBuffer buffer)
protected void	renderBodyRowColumns(HtmlStringBuffer buffer, int rowIndex)
protected void	renderBodyRows(HtmlStringBuffer buffer)
protected void	renderHeaderRow(HtmlStringBuffer buffer)
void	setExcludedColumns(List<String> excludedColumns)
void	setExcludedExportColumns(List<String> excludedExportColumns)
void	setExportAttachment(int exportAttachment)
void	setExportBannerPosition(int exportBannerPosition)
void	setExportContainer(TableExportContainer exportContainer)
void	setExportTableHeaders(boolean exportTableHeaders)
void	setFirstExportRow(int firstExportRow)
void	setLastExportRow(int lastExportRow)

Methods inherited from class org.apache.click.control.Table

add, addColumn, addControl, addRowAttributes, createRowList, getBannerPosition, getCaption, getColumn, getColumnList, getColumns, getControlLink, getControls, getControlSizeEst, getDataProvider, getFirstRow, getHeadElements, getHeight, getHoverRows, getLastRow, getNullifyRowListOnDestroy, getNumberPages, getPageNumber, getPageSize, getPaginator, getPaginatorAttachment, getRenderId, getRowCount, getRowList, getShowBanner, getSortable, getSortedColumn, getState, getTag, getWidth, hasControls, isSorted, isSortedAscending, onDestroy, removeColumn, removeColumn, removeColumns, removeState, renderFooterRow, renderPaginator, renderPagingControls, renderTableBanner, restoreState, saveState, setBannerPosition, setCaption, setClass, setDataProvider, setHeight, setHoverRows, setName, setNullifyRowListOnDestroy, setPageNumber, setPageSize, setPaginator, setPaginatorAttachment, setParent, setRenderId, setRowList, setShowBanner, setSortable, setSorted, setSortedAscending, setSortedColumn, setState, setWidth, sortRowList

Methods inherited from class org.apache.click.control.AbstractControl

addBehavior, addStyleClass, appendAttributes, dispatchActionEvent, getActionListener, getAttribute, getAttributes, getBehaviors, getContext, getHtmlImports, getId, getMessage, getMessage, getMessages, getName, getPage, getParent, getStyle, getStyles, hasAttribute, hasAttributes, hasBehaviors, hasStyles, isAjaxTarget, onDeploy, removeBehavior, removeStyleClass, renderTagBegin, renderTagEnd, setActionListener, setAttribute, setId, setListener, setStyle, toString

Methods inherited from class java.lang.Object

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

Field Detail

EXPORTER_ATTACHED

public static final int EXPORTER_ATTACHED

See Also:

Constant Field Values

EXPORTER_DETACHED

public static final int EXPORTER_DETACHED

See Also:

Constant Field Values

EXPORTER_INLINE

public static final int EXPORTER_INLINE

See Also:

Constant Field Values

exportTableHeaders

protected boolean exportTableHeaders

firstExportRow

protected int firstExportRow

lastExportRow

protected int lastExportRow

exportBannerPosition

protected int exportBannerPosition

exportAttachment

protected int exportAttachment

excludedColumns

protected List<String> excludedColumns

excludedExportColumns

protected List<String> excludedExportColumns

exportContainer

protected TableExportContainer exportContainer

Constructor Detail

ExportTable

public ExportTable()

ExportTable

public ExportTable(String name)

Method Detail

getExportContainer

public TableExportContainer getExportContainer()

setExportContainer

public void setExportContainer(TableExportContainer exportContainer)

isExportTableHeaders

public boolean isExportTableHeaders()

Returns:

the exportTableHeaders

getFirstExportRow

public int getFirstExportRow()

Returns:

the firstExportRow

setFirstExportRow

public void setFirstExportRow(int firstExportRow)

Parameters:

firstExportRow - the firstExportRow to set

getLastExportRow

public int getLastExportRow()

Returns:

the lastExportRow

setLastExportRow

public void setLastExportRow(int lastExportRow)

Parameters:

lastExportRow - the lastExportRow to set

setExportTableHeaders

public void setExportTableHeaders(boolean exportTableHeaders)

Parameters:

exportTableHeaders - the exportTableHeaders to set

getExportBannerPosition

public int getExportBannerPosition()

Returns:

the exportBannerPosition

setExportBannerPosition

public void setExportBannerPosition(int exportBannerPosition)

Parameters:

exportBannerPosition - the exportBannerPosition to set

getExcludedColumns

public List<String> getExcludedColumns()

setExcludedColumns

public void setExcludedColumns(List<String> excludedColumns)

getExcludedExportColumns

public List<String> getExcludedExportColumns()

setExcludedExportColumns

public void setExcludedExportColumns(List<String> excludedExportColumns)

getExportColumnList

public List getExportColumnList()

getExportAttachment

public int getExportAttachment()

setExportAttachment

public void setExportAttachment(int exportAttachment)

onInit

public void onInit()

Specified by:

onInit in interface Control

Overrides:

onInit in class Table

onRender

public void onRender()

Specified by:

onRender in interface Control

Overrides:

onRender in class Table

onProcess

public boolean onProcess()

Specified by:

onProcess in interface Control

Overrides:

onProcess in class Table

render

public void render(HtmlStringBuffer buffer)

Specified by:

render in interface Control

Overrides:

render in class Table

renderBodyRows

protected void renderBodyRows(HtmlStringBuffer buffer)

Overrides:

renderBodyRows in class Table

renderHeaderRow

protected void renderHeaderRow(HtmlStringBuffer buffer)

Overrides:

renderHeaderRow in class Table

renderBodyRowColumns

protected void renderBodyRowColumns(HtmlStringBuffer buffer,
                        int rowIndex)

Overrides:

renderBodyRowColumns in class Table

renderBodyNoRows

protected void renderBodyNoRows(HtmlStringBuffer buffer)

Overrides:

renderBodyNoRows in class Table