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.AbstractJExcelView |
Convenient superclass for Excel document views.
This class uses the JExcelAPI instead of POI. More information on JExcelAPI can be found on their website.
Properties:
The file will be searched with locations in the following order:
For working with the workbook in the subclass, see Java Excel API site
As an example, you can try this snippet:
protected void buildExcelDocument( Map<String, Object> model, WritableWorkbook workbook, HttpServletRequest request, HttpServletResponse response) { if (workbook.getNumberOfSheets() == 0) { workbook.createSheet("Spring", 0); } WritableSheet sheet = workbook.getSheet("Spring"); Label label = new Label(0, 0, "This is a nice label"); sheet.addCell(label); }The use of this view is close to the AbstractExcelView class, just using the JExcel API instead of the Apache POI API.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.web.servlet.view.AbstractView
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.context.support.ApplicationObjectSupport
| |||||||||||
From interface
org.springframework.web.servlet.View
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Default Constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Set the URL of the Excel workbook source, without localization part nor extension.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Subclasses must implement this method to create an Excel Workbook
document, given the model.
| |||||||||||
Return whether this view generates download content
(typically binary content like PDF or Excel files).
| |||||||||||
Create the workbook from an existing XLS document.
| |||||||||||
Renders the Excel view, given the specified model.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.springframework.web.servlet.view.AbstractView
| |||||||||||
From class
org.springframework.web.context.support.WebApplicationObjectSupport
| |||||||||||
From class
org.springframework.context.support.ApplicationObjectSupport
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.beans.factory.BeanNameAware
| |||||||||||
From interface
org.springframework.context.ApplicationContextAware
| |||||||||||
From interface
org.springframework.web.context.ServletContextAware
| |||||||||||
From interface
org.springframework.web.servlet.View
|
Default Constructor. Sets the content type of the view to "application/vnd.ms-excel".
Set the URL of the Excel workbook source, without localization part nor extension.
Subclasses must implement this method to create an Excel Workbook document, given the model.
model | the model Map |
---|---|
workbook | the Excel workbook to complete |
request | 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 | in case of failure |
---|
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.
Create the workbook from an existing XLS document.
url | the URL of the Excel template without localization part nor extension |
---|---|
request | current HTTP request |
Exception | in case of failure |
---|
Renders the Excel view, given the specified model.
model | combined output Map (never null ),
with dynamic values taking precedence over static attributes |
---|---|
request | current HTTP request |
response | current HTTP response |
Exception |
---|