Spring Framework 6.1.4 · org.springframework.web.servlet.view.document.AbstractXlsView

Access	Constructor and Description
public	AbstractXlsView() Default Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	buildExcelDocument(Map<String, Object> the model Map model, Workbook the Excel workbook to populate workbook, HttpServletRequest in case we need locale etc. Shouldn't look at attributes. request, HttpServletResponse in case we need to set cookies. Shouldn't write to it. response) Application-provided subclasses must implement this method to populate the Excel workbook document, given the model.
protected Workbook	Returns: the new `Workbook` instance createWorkbook(Map<String, Object> the model Map model, HttpServletRequest current HTTP request (for taking the URL or headers into account) request) Template method for creating the POI `Workbook` instance.
protected boolean	generatesDownloadContent() Overrides org.springframework.web.servlet.view.AbstractView.generatesDownloadContent. Return whether this view generates download content (typically binary content like PDF or Excel files).
protected final void	renderMergedOutputModel(Map<String, Object> combined output Map (never `null`), with dynamic values taking precedence over static attributes model, HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response) Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. Renders the Excel view, given the specified model.
protected void	renderWorkbook(Workbook the POI Workbook to render workbook, HttpServletResponse current HTTP response response) The actual render step: taking the POI `Workbook` and rendering it to the given response.

AbstractXlsView	back to summary
public AbstractXlsView() Default Constructor. Sets the content type of the view to "application/vnd.ms-excel".

Method Detail

buildExcelDocument	back to summary
protected abstract void buildExcelDocument(Map<String, Object> model, Workbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception Application-provided subclasses must implement this method to populate the Excel workbook document, given the model. Parameters model:Map<String, Object> the model Map workbook:Workbook the Excel workbook to populate request:HttpServletRequest in case we need locale etc. Shouldn't look at attributes. response:HttpServletResponse in case we need to set cookies. Shouldn't write to it.

buildExcelDocument

back to summary

protected abstract void buildExcelDocument(Map<String, Object> model, Workbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception

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

Parameters

model:Map<String, Object>: the model Map
workbook:Workbook: the Excel workbook to populate
request:HttpServletRequest: in case we need locale etc. Shouldn't look at attributes.
response:HttpServletResponse: in case we need to set cookies. Shouldn't write to it.

createWorkbook back to summary

createWorkbook	back to summary
protected Workbook createWorkbook(Map<String, Object> model, HttpServletRequest request) Template method for creating the POI `Workbook` instance. The default implementation creates a traditional `HSSFWorkbook`. Spring-provided subclasses are overriding this for the OOXML-based variants; custom subclasses may override this for reading a workbook from a file. Parameters model:Map<String, Object> the model Map request:HttpServletRequest current HTTP request (for taking the URL or headers into account) Returns:Workbook the new `Workbook` instance

protected Workbook createWorkbook(Map<String, Object> model, HttpServletRequest request)

Template method for creating the POI Workbook instance.

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

Parameters

model:Map<String, Object>: the model Map
request:HttpServletRequest: current HTTP request (for taking the URL or headers into account)

Returns:Workbook

the new Workbook instance

generatesDownloadContent back to summary

generatesDownloadContent	back to summary
protected boolean generatesDownloadContent() Overrides org.springframework.web.servlet.view.AbstractView.generatesDownloadContent. Doc from org.springframework.web.servlet.view.AbstractView.generatesDownloadContent. 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. Annotations @Override

protected boolean generatesDownloadContent()

Overrides org.springframework.web.servlet.view.AbstractView.generatesDownloadContent.

Doc from org.springframework.web.servlet.view.AbstractView.generatesDownloadContent.

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.

Annotations

@Override

renderMergedOutputModel back to summary

renderMergedOutputModel	back to summary
protected final void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. Renders the Excel view, given the specified model. Parameters model:Map<String, Object> Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. combined output Map (never `null`), with dynamic values taking precedence over static attributes request:HttpServletRequest Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. current HTTP request response:HttpServletResponse Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. current HTTP response Annotations @Override Exceptions Exception: Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel. if rendering failed

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

Implements abstract org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

Renders the Excel view, given the specified model.

Parameters

model:Map<String, Object>

Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

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

request:HttpServletRequest

Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

current HTTP request

response:HttpServletResponse

Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

current HTTP response

Annotations

@Override

Exceptions

Exception:

Doc from org.springframework.web.servlet.view.AbstractView.renderMergedOutputModel.

if rendering failed

renderWorkbook back to summary

renderWorkbook	back to summary
protected void renderWorkbook(Workbook workbook, HttpServletResponse response) throws IOException The actual render step: taking the POI `Workbook` and rendering it to the given response. Parameters workbook:Workbook the POI Workbook to render response:HttpServletResponse current HTTP response Exceptions IOException: when thrown by I/O methods that we're delegating to

protected void renderWorkbook(Workbook workbook, HttpServletResponse response) throws IOException

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

Parameters

workbook:Workbook: the POI Workbook to render
response:HttpServletResponse: current HTTP response

Exceptions

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

public abstract Class AbstractXlsView

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail