类 AbstractPdfView

构造器详细资料

• AbstractPdfView

  public AbstractPdfView()

  This constructor sets the appropriate content type "application/pdf". Note that IE won't take much notice of this, but there's not a lot we can do about this. Generated documents should have a ".pdf" extension.

方法详细资料

• 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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), ServletResponse.getOutputStream()

• renderMergedOutputModel

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

  从类复制的说明: AbstractView
  Subclasses must implement this method to actually render the view.

  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 在类中 AbstractView

  参数:

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

  request - current HTTP request

  response - current HTTP response

  抛出:

  Exception - if rendering failed

• newDocument

  protected com.lowagie.text.Document newDocument()

  Create a new document to hold the PDF contents.

  By default returns an A4 document, but the subclass can specify any Document, possibly parameterized via bean properties defined on the View.

  返回:

  the newly created iText Document instance

  另请参阅:

  Document(com.lowagie.text.Rectangle)

• newWriter

  protected com.lowagie.text.pdf.PdfWriter newWriter​(com.lowagie.text.Document document,
                                                     OutputStream os)
                                              throws com.lowagie.text.DocumentException

  Create a new PdfWriter for the given iText Document.

  参数:

  document - the iText Document to create a writer for

  os - the OutputStream to write to

  返回:

  the PdfWriter instance to use

  抛出:

  com.lowagie.text.DocumentException - if thrown during writer creation

• prepareWriter

  protected void prepareWriter​(Map<String,​Object> model,
                               com.lowagie.text.pdf.PdfWriter writer,
                               HttpServletRequest request)
                        throws com.lowagie.text.DocumentException

  Prepare the given PdfWriter. Called before building the PDF document, that is, before the call to 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 it

  writer - the PdfWriter to prepare

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

  抛出:

  com.lowagie.text.DocumentException - if thrown during writer preparation

  另请参阅:

  Document.open(), PdfWriter.setPageEvent(com.lowagie.text.pdf.PdfPageEvent), PdfWriter.setViewerPreferences(int), getViewerPreferences()

• getViewerPreferences

  protected int getViewerPreferences()

  Return the viewer preferences for the PDF file.

  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.

  返回:

  an int containing the bits information against PdfWriter definitions

  另请参阅:

  PdfWriter.AllowPrinting, PdfWriter.PageLayoutSinglePage

• buildPdfMetadata

  protected void buildPdfMetadata​(Map<String,​Object> model,
                                  com.lowagie.text.Document document,
                                  HttpServletRequest request)

  Populate the iText Document's meta fields (author, title, etc.).
  Default is an empty implementation. Subclasses may override this method to add meta fields such as title, subject, author, creator, keywords, etc. This method is called after assigning a PdfWriter to the Document and before calling document.open().

  参数:

  model - the model, in case meta information must be populated from it

  document - the iText document being populated

  request - 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)

• buildPdfDocument

  protected abstract void buildPdfDocument​(Map<String,​Object> model,
                                           com.lowagie.text.Document document,
                                           com.lowagie.text.pdf.PdfWriter writer,
                                           HttpServletRequest request,
                                           HttpServletResponse response)
                                    throws Exception

  Subclasses must implement this method to build an iText PDF document, given the model. Called between 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 Map

  document - the iText Document to add elements to

  writer - the PdfWriter to use

  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 - any exception that occurred during document building

  另请参阅:

  Document.open(), Document.close()