public abstract class AbstractJExcelView extends AbstractView
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.
AbstractExcelView
,
AbstractPdfView
Modifier and Type | Field and Description |
---|---|
private static java.lang.String |
CONTENT_TYPE
The content type for an Excel response
|
private static java.lang.String |
EXTENSION
The extension to look for existing templates
|
private java.lang.String |
url
The url at which the template to use is located
|
DEFAULT_CONTENT_TYPE
logger
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
Constructor and Description |
---|
AbstractJExcelView()
Default Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected abstract void |
buildExcelDocument(java.util.Map<java.lang.String,java.lang.Object> model,
WritableWorkbook workbook,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to create an Excel Workbook
document, given the model.
|
protected boolean |
generatesDownloadContent()
Return whether this view generates download content
(typically binary content like PDF or Excel files).
|
protected Workbook |
getTemplateSource(java.lang.String url,
HttpServletRequest request)
Create the workbook from an existing XLS document.
|
protected void |
renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model,
HttpServletRequest request,
HttpServletResponse response)
Renders the Excel view, given the specified model.
|
void |
setUrl(java.lang.String url)
Set the URL of the Excel workbook source, without localization part nor extension.
|
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
private static final java.lang.String CONTENT_TYPE
private static final java.lang.String EXTENSION
private java.lang.String url
public AbstractJExcelView()
public void setUrl(java.lang.String url)
protected boolean generatesDownloadContent()
AbstractView
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
in class AbstractView
AbstractView.prepareResponse(HttpServletRequest, HttpServletResponse)
,
javax.servlet.http.HttpServletResponse#getOutputStream()
protected final void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, HttpServletRequest request, HttpServletResponse response) throws java.lang.Exception
renderMergedOutputModel
in class AbstractView
model
- combined output Map (never null
),
with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP responsejava.lang.Exception
- if rendering failedprotected Workbook getTemplateSource(java.lang.String url, HttpServletRequest request) throws java.lang.Exception
url
- the URL of the Excel template without localization part nor extensionrequest
- current HTTP requestjava.lang.Exception
- in case of failureprotected abstract void buildExcelDocument(java.util.Map<java.lang.String,java.lang.Object> model, WritableWorkbook workbook, HttpServletRequest request, HttpServletResponse response) throws java.lang.Exception
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.java.lang.Exception
- in case of failure