| org.springframework.web.servlet.view.AbstractView
 org.springframework.web.servlet.view.document.AbstractExcelView
| AbstractExcelView | | abstract public class AbstractExcelView extends AbstractView (Code) | | Convenient superclass for Excel document views.
Properties:
- url (optional): The url of an existing Excel document to pick as a starting point.
It is done without localization part nor the ".xls" extension.
The file will be searched with locations in the following order:
- [url]_[language]_[country].xls
- [url]_[language].xls
- [url].xls
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 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.
author:
Jean-Pierre Pawlak
author:
Juergen Hoeller
See Also: AbstractPdfView |
| Method Summary | |
| abstract protected void | buildExcelDocument(Map model, HSSFWorkbook workbook, HttpServletRequest request, HttpServletResponse response)
Subclasses must implement this method to create an Excel HSSFWorkbook document,
given the model.
Parameters:
model - the model Map
Parameters:
workbook - the Excel workbook to complete
Parameters:
request - in case we need locale etc. | | protected HSSFCell | getCell(HSSFSheet sheet, int row, int col)
Convenient method to obtain the cell in the given sheet, row and column.
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.
Parameters:
sheet - a sheet object. | | protected HSSFWorkbook | getTemplateSource(String url, HttpServletRequest request)
Creates the workbook from an existing XLS document. | | final protected void | renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response)
Renders the Excel view, given the specified model. | | protected void | setText(HSSFCell cell, String text)
Convenient method to set a String as text content in a cell. | | public void | setUrl(String url)
Set the URL of the Excel workbook source, without localization part nor extension. |
| AbstractExcelView | | public AbstractExcelView()(Code) | | Default Constructor.
Sets the content type of the view to "application/vnd.ms-excel".
|
| buildExcelDocument | | abstract protected void buildExcelDocument(Map model, HSSFWorkbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception(Code) | | Subclasses must implement this method to create an Excel HSSFWorkbook document,
given the model.
Parameters:
model - the model Map
Parameters:
workbook - the Excel workbook to complete
Parameters:
request - in case we need locale etc. Shouldn't look at attributes.
Parameters:
response - in case we need to set cookies. Shouldn't write to it. |
| getCell | | protected HSSFCell getCell(HSSFSheet sheet, int row, int col)(Code) | | Convenient method to obtain the cell in the given sheet, row and column.
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.
Parameters:
sheet - a sheet object. The first sheet is usually obtained by workbook.getSheetAt(0)
Parameters:
row - thr row number
Parameters:
col - the column number the HSSFCell |
| getTemplateSource | | protected HSSFWorkbook getTemplateSource(String url, HttpServletRequest request) throws Exception(Code) | | Creates the workbook from an existing XLS document.
Parameters:
url - the URL of the Excel template without localization part nor extension
Parameters:
request - current HTTP request the HSSFWorkbook
throws:
Exception - in case of failure |
| setText | | protected void setText(HSSFCell cell, String text)(Code) | | Convenient method to set a String as text content in a cell.
Parameters:
cell - the cell in which the text must be put
Parameters:
text - the text to put in the cell |
| setUrl | | public void setUrl(String url)(Code) | | Set the URL of the Excel workbook source, without localization part nor extension.
|
| Fields inherited from org.springframework.web.servlet.view.AbstractView | final public static String DEFAULT_CONTENT_TYPE(Code)(Java Doc)
|
|
|