|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.AbstractPdfView
public abstract class AbstractPdfView
Abstract superclass for PDF views, using Bruno Lowagie's iText package. Application-specific view classes will extend this class. The view will be held in the subclass itself, not in a template.
Note: Internet Explorer requires a ".pdf" extension, as it doesn't always respect the declared content type.
Field Summary |
---|
Fields inherited from class org.springframework.web.servlet.view.AbstractView |
---|
DEFAULT_CONTENT_TYPE |
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Constructor Summary | |
---|---|
AbstractPdfView()
This constructor sets the appropriate content type "application/pdf". |
Method Summary | |
---|---|
protected abstract void |
buildPdfDocument(Map model,
com.lowagie.text.Document document,
com.lowagie.text.pdf.PdfWriter writer,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to build an iText PDF document, given the model. |
protected void |
buildPdfMetadata(Map model,
com.lowagie.text.Document document,
HttpServletRequest request)
Populate the iText Document's meta fields (author, title, etc.). |
protected int |
getViewerPreferences()
Return the viewer preferences for the PDF file. |
protected com.lowagie.text.Document |
newDocument()
Create a new document to hold the PDF contents. |
protected com.lowagie.text.pdf.PdfWriter |
newWriter(com.lowagie.text.Document document,
OutputStream os)
Create a new PdfWriter for the given iText Document. |
protected void |
prepareWriter(Map model,
com.lowagie.text.pdf.PdfWriter writer,
HttpServletRequest request)
Prepare the given PdfWriter. |
protected void |
renderMergedOutputModel(Map model,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to actually render the view. |
Methods inherited from class org.springframework.web.servlet.view.AbstractView |
---|
addStaticAttribute, createRequestContext, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setRequestContextAttribute, toString |
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport |
---|
getServletContext, getTempDir, getWebApplicationContext, isContextRequired, setServletContext |
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractPdfView()
Method Detail |
---|
protected final void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception
AbstractView
The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.
renderMergedOutputModel
in class AbstractView
model
- combined output Map (never null
),
with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP response
Exception
- if rendering failedprotected com.lowagie.text.Document newDocument()
By default returns an A4 document, but the subclass can specify any Document, possibly parameterized via bean properties defined on the View.
Document.Document(com.lowagie.text.Rectangle)
protected com.lowagie.text.pdf.PdfWriter newWriter(com.lowagie.text.Document document, OutputStream os) throws com.lowagie.text.DocumentException
document
- the iText Document to create a writer foros
- the OutputStream to write to
com.lowagie.text.DocumentException
- if thrown during writer creationprotected void prepareWriter(Map model, com.lowagie.text.pdf.PdfWriter writer, HttpServletRequest request) throws com.lowagie.text.DocumentException
Document.open()
.
Useful for registering a page event listener, for example.
The default implementation sets the viewer preferences as returned
by this class's getViewerPreferences()
method.
model
- the model, in case meta information must be populated from itwriter
- the PdfWriter to preparerequest
- in case we need locale etc. Shouldn't look at attributes.
com.lowagie.text.DocumentException
- if thrown during writer preparationDocument.open()
,
PdfWriter.setPageEvent(com.lowagie.text.pdf.PdfPageEvent)
,
PdfWriter.setViewerPreferences(int)
,
getViewerPreferences()
protected int getViewerPreferences()
By default returns AllowPrinting
and
PageLayoutSinglePage
, but can be subclassed.
The subclass can either have fixed preferences or retrieve
them from bean properties defined on the View.
PdfWriter.AllowPrinting
,
PdfWriter.PageLayoutSinglePage
protected void buildPdfMetadata(Map model, com.lowagie.text.Document document, HttpServletRequest request)
document.open()
.
model
- the model, in case meta information must be populated from itdocument
- the iText document being populatedrequest
- in case we need locale etc. Shouldn't look at attributes.Document.addTitle(java.lang.String)
,
Document.addSubject(java.lang.String)
,
Document.addKeywords(java.lang.String)
,
Document.addAuthor(java.lang.String)
,
Document.addCreator(java.lang.String)
,
Document.addProducer()
,
Document.addCreationDate()
,
Document.addHeader(java.lang.String, java.lang.String)
protected abstract void buildPdfDocument(Map model, com.lowagie.text.Document document, com.lowagie.text.pdf.PdfWriter writer, HttpServletRequest request, HttpServletResponse response) throws Exception
Document.open()
and
Document.close()
calls.
Note that the passed-in HTTP response is just supposed to be used for setting cookies or other HTTP headers. The built PDF document itself will automatically get written to the response after this method returns.
model
- the model Mapdocument
- the iText Document to add elements towriter
- the PdfWriter to userequest
- 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
- any exception that occured during document buildingDocument.open()
,
Document.close()
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |