类 AbstractExcelView
- java.lang.Object
- org.springframework.context.support.ApplicationObjectSupport
- org.springframework.web.context.support.WebApplicationObjectSupport
- org.springframework.web.servlet.view.AbstractView
- org.springframework.web.servlet.view.document.AbstractExcelView
- 所有已实现的接口:
Aware
,BeanNameAware
,ApplicationContextAware
,ServletContextAware
,View
@Deprecated public abstract class AbstractExcelView extends AbstractView
已过时。as of Spring 4.2, in favor ofAbstractXlsView
and itsAbstractXlsxView
andAbstractXlsxStreamingView
variantsConvenient superclass for Excel document views. Compatible with Apache POI 3.5 and higher, as of Spring 4.0.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 Apache'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.- 作者:
- Jean-Pierre Pawlak, Juergen Hoeller
- 另请参阅:
AbstractPdfView
字段概要
从类继承的字段 org.springframework.web.servlet.view.AbstractView
DEFAULT_CONTENT_TYPE
从类继承的字段 org.springframework.context.support.ApplicationObjectSupport
logger
从接口继承的字段 org.springframework.web.servlet.View
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
构造器概要
构造器 构造器 说明 AbstractExcelView()
已过时。Default Constructor.
方法概要
所有方法 实例方法 抽象方法 具体方法 已过时的方法 修饰符和类型 方法 说明 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.从类继承的方法 org.springframework.web.servlet.view.AbstractView
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse
从类继承的方法 org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
从类继承的方法 org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
构造器详细资料
AbstractExcelView
public AbstractExcelView()
已过时。Default Constructor. Sets the content type of the view to "application/vnd.ms-excel".
方法详细资料
setUrl
public void setUrl(String url)
已过时。Set the URL of the Excel workbook source, without localization part nor extension.
generatesDownloadContent
protected boolean generatesDownloadContent()
已过时。从类复制的说明:AbstractView
Return whether this view generates download content (typically binary content like PDF or Excel files).The default implementation returns
false
. Subclasses are encouraged to returntrue
here if they know that they are generating download content that requires temporary caching on the client side, typically via the response OutputStream.
renderMergedOutputModel
protected final void renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception
已过时。Renders the Excel view, given the specified model.- 指定者:
renderMergedOutputModel
在类中AbstractView
- 参数:
model
- combined output Map (nevernull
), with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP response- 抛出:
Exception
- if rendering failed
getTemplateSource
protected org.apache.poi.hssf.usermodel.HSSFWorkbook getTemplateSource(String url, HttpServletRequest request) throws Exception
已过时。Creates the workbook from an existing XLS document.- 参数:
url
- the URL of the Excel template without localization part nor extensionrequest
- current HTTP request- 返回:
- the HSSFWorkbook
- 抛出:
Exception
- in case of failure
buildExcelDocument
protected abstract void buildExcelDocument(Map<String,Object> model, org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception
已过时。Subclasses must implement this method to create an Excel HSSFWorkbook document, given the model.- 参数:
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.- 抛出:
Exception
getCell
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.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
- the row numbercol
- the column number- 返回:
- the HSSFCell