public abstract class AbstractExcelView extends AbstractView
Properties:
The file will be searched with locations in the following order:
For working with the workbook in the subclass, see Jakarta's POI site
As an example, you can try this snippet:
protected void buildExcelDocument(
Map<String, Object> model, HSSFWorkbook workbook,
HttpServletRequest request, HttpServletResponse response) {
// Go to the first sheet.
// getSheetAt: only if workbook is created from an existing document
// HSSFSheet sheet = workbook.getSheetAt(0);
HSSFSheet sheet = workbook.createSheet("Spring");
sheet.setDefaultColumnWidth(12);
// Write a text at A1.
HSSFCell cell = getCell(sheet, 0, 0);
setText(cell, "Spring POI test");
// Write the current date at A2.
HSSFCellStyle dateStyle = workbook.createCellStyle();
dateStyle.setDataFormat(HSSFDataFormat.getBuiltinFormat("m/d/yy"));
cell = getCell(sheet, 1, 0);
cell.setCellValue(new Date());
cell.setCellStyle(dateStyle);
// Write a number at A3
getCell(sheet, 2, 0).setCellValue(458);
// Write a range of numbers.
HSSFRow sheetRow = sheet.createRow(3);
for (short i = 0; i < 10; i++) {
sheetRow.createCell(i).setCellValue(i * 10);
}
}
This class is similar to the AbstractPdfView class in usage style.AbstractPdfViewDEFAULT_CONTENT_TYPEloggerPATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE| Constructor and Description |
|---|
AbstractExcelView()
Default Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract void |
buildExcelDocument(Map<String,Object> model,
org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to create an Excel HSSFWorkbook document,
given the model.
|
protected boolean |
generatesDownloadContent()
Return whether this view generates download content
(typically binary content like PDF or Excel files).
|
protected org.apache.poi.hssf.usermodel.HSSFCell |
getCell(org.apache.poi.hssf.usermodel.HSSFSheet sheet,
int row,
int col)
Convenient method to obtain the cell in the given sheet, row and column.
|
protected org.apache.poi.hssf.usermodel.HSSFWorkbook |
getTemplateSource(String url,
HttpServletRequest request)
Creates the workbook from an existing XLS document.
|
protected void |
renderMergedOutputModel(Map<String,Object> model,
HttpServletRequest request,
HttpServletResponse response)
Renders the Excel view, given the specified model.
|
protected void |
setText(org.apache.poi.hssf.usermodel.HSSFCell cell,
String text)
Convenient method to set a String as text content in a cell.
|
void |
setUrl(String url)
Set the URL of the Excel workbook source, without localization part nor extension.
|
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponsegetServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContextgetApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContextpublic AbstractExcelView()
public void setUrl(String url)
protected boolean generatesDownloadContent()
AbstractViewThe default implementation returns false. Subclasses are
encouraged to return true here if they know that they are
generating download content that requires temporary caching on the
client side, typically via the response OutputStream.
protected final void renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception
renderMergedOutputModel in class AbstractViewmodel - combined output Map (never null),
with dynamic values taking precedence over static attributesrequest - current HTTP requestresponse - current HTTP responseException - if rendering failedprotected org.apache.poi.hssf.usermodel.HSSFWorkbook getTemplateSource(String url, HttpServletRequest request) throws Exception
url - the URL of the Excel template without localization part nor extensionrequest - current HTTP requestException - in case of failureprotected abstract void buildExcelDocument(Map<String,Object> model, org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception
model - the model Mapworkbook - the Excel workbook to completerequest - in case we need locale etc. Shouldn't look at attributes.response - in case we need to set cookies. Shouldn't write to it.Exceptionprotected org.apache.poi.hssf.usermodel.HSSFCell getCell(org.apache.poi.hssf.usermodel.HSSFSheet sheet,
int row,
int col)
Creates the row and the cell if they still doesn't already exist. Thus, the column can be passed as an int, the method making the needed downcasts.
sheet - a sheet object. The first sheet is usually obtained by workbook.getSheetAt(0)row - thr row numbercol - the column numberprotected void setText(org.apache.poi.hssf.usermodel.HSSFCell cell,
String text)
cell - the cell in which the text must be puttext - the text to put in the cell