程序包 cn.taketoday.web.view.document

类 AbstractXlsView

java.lang.Object

cn.taketoday.context.support.ApplicationObjectSupport

cn.taketoday.web.view.AbstractView

cn.taketoday.web.view.document.AbstractXlsView

所有已实现的接口:

cn.taketoday.beans.factory.Aware, cn.taketoday.beans.factory.BeanNameAware, cn.taketoday.context.ApplicationContextAware, View

直接已知子类:

AbstractXlsxView

public abstract class AbstractXlsView
extends AbstractView

Convenient superclass for Excel document views in traditional XLS format. Compatible with Apache POI 3.5 and higher.

For working with the workbook in the subclass, see Apache's POI site

从以下版本开始:

4.0

作者:

Juergen Hoeller

字段概要

从类继承的字段 cn.taketoday.web.view.AbstractView

DEFAULT_CONTENT_TYPE

从类继承的字段 cn.taketoday.context.support.ApplicationObjectSupport

applicationContext, log, messageSourceAccessor

从接口继承的字段 cn.taketoday.web.view.View

RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

构造器概要

构造器

构造器	说明
AbstractXlsView()	Default Constructor.

方法概要

修饰符和类型	方法	说明
protected abstract void	buildExcelDocument(Map<String,Object> model, org.apache.poi.ss.usermodel.Workbook workbook, RequestContext context)	Application-provided subclasses must implement this method to populate the Excel workbook document, given the model.
protected org.apache.poi.ss.usermodel.Workbook	createWorkbook(Map<String,Object> model, RequestContext request)	Template method for creating the POI Workbook instance.
protected boolean	generatesDownloadContent()	Return whether this view generates download content (typically binary content like PDF or Excel files).
protected final void	renderMergedOutputModel(Map<String,Object> model, RequestContext request)	Renders the Excel view, given the specified model.
protected void	renderWorkbook(org.apache.poi.ss.usermodel.Workbook workbook, RequestContext response)	The actual render step: taking the POI Workbook and rendering it to the given response.

从类继承的方法 cn.taketoday.web.view.AbstractView

addStaticAttribute, createMergedOutputModel, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestContextToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposeOutputRedirectModel, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse

从类继承的方法 cn.taketoday.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, isContextRequired, obtainApplicationContext, requiredContextClass, setApplicationContext, unwrapContext, unwrapFactory

从类继承的方法 java.lang.Object

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

构造器详细资料

AbstractXlsView

public AbstractXlsView()

Default Constructor. Sets the content type of the view to "application/vnd.ms-excel".

方法详细资料

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 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.

覆盖:

generatesDownloadContent 在类中 AbstractView

另请参阅:

• AbstractView.prepareResponse(cn.taketoday.web.RequestContext)
• RequestContext.getOutputStream()

renderMergedOutputModel

protected final void renderMergedOutputModel(Map<String,Object> model,
 RequestContext request)
                                      throws Exception

Renders the Excel view, given the specified model.

指定者:

renderMergedOutputModel 在类中 AbstractView

参数:

model - combined output Map (never null), with dynamic values taking precedence over static attributes

request - current HTTP request context

抛出:

Exception - if rendering failed

createWorkbook

protected org.apache.poi.ss.usermodel.Workbook createWorkbook(Map<String,Object> model,
 RequestContext request)

Template method for creating the POI Workbook instance.

The default implementation creates a traditional HSSFWorkbook. Framework-provided subclasses are overriding this for the OOXML-based variants; custom subclasses may override this for reading a workbook from a file.

参数:

model - the model Map

request - current HTTP request (for taking the URL or headers into account)

返回:

the new Workbook instance

renderWorkbook

protected void renderWorkbook(org.apache.poi.ss.usermodel.Workbook workbook,
 RequestContext response)
                       throws IOException

The actual render step: taking the POI Workbook and rendering it to the given response.

参数:

workbook - the POI Workbook to render

response - current HTTP response

抛出:

IOException - when thrown by I/O methods that we're delegating to

buildExcelDocument

protected abstract void buildExcelDocument(Map<String,Object> model,
 org.apache.poi.ss.usermodel.Workbook workbook,
 RequestContext context)
                                    throws Exception

Application-provided subclasses must implement this method to populate the Excel workbook document, given the model.

参数:

model - the model Map

workbook - the Excel workbook to populate

context - in case we need locale etc. Shouldn't look at attributes.

抛出:

Exception