类 AbstractJasperReportsSingleFormatView
- 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.AbstractUrlBasedView
- org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView
- org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsSingleFormatView
- 直接已知子类:
ConfigurableJasperReportsView
,JasperReportsCsvView
,JasperReportsHtmlView
,JasperReportsPdfView
,JasperReportsXlsView
,JasperReportsXlsxView
public abstract class AbstractJasperReportsSingleFormatView extends AbstractJasperReportsView
ExtendsAbstractJasperReportsView
to provide basic rendering logic for views that use a fixed format, e.g. always PDF or always HTML.Subclasses need to implement two template methods:
createExporter
to create a JasperReports exporter for a specific output format, anduseWriter
to determine whether to write text or binary content.This class is compatible with classic JasperReports releases back until 2.x. As a consequence, it keeps using the
JRExporter
API which got deprecated as of JasperReports 5.5.2 (early 2014).- 从以下版本开始:
- 1.1.5
- 作者:
- Rob Harrop, Juergen Hoeller
- 另请参阅:
createExporter()
,useWriter()
字段概要
从类继承的字段 org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView
CONTENT_DISPOSITION_INLINE, HEADER_CONTENT_DISPOSITION
从类继承的字段 org.springframework.web.servlet.view.AbstractView
DEFAULT_CONTENT_TYPE
从类继承的字段 org.springframework.context.support.ApplicationObjectSupport
logger
从接口继承的字段 org.springframework.web.servlet.View
PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE
构造器概要
构造器 构造器 说明 AbstractJasperReportsSingleFormatView()
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 protected abstract net.sf.jasperreports.engine.JRExporter
createExporter()
Create a JasperReports exporter for a specific output format, which will be used to render the report to the HTTP response.protected boolean
generatesDownloadContent()
Return whether this view generates download content (typically binary content like PDF or Excel files).protected void
renderReport(net.sf.jasperreports.engine.JasperPrint populatedReport, Map<String,Object> model, HttpServletResponse response)
Perform rendering for a single Jasper Reports exporter, that is, for a pre-defined output format.protected void
renderReportUsingOutputStream(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint populatedReport, HttpServletResponse response)
We need to write binary output to the response OutputStream.protected void
renderReportUsingWriter(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint populatedReport, HttpServletResponse response)
We need to write text to the response Writer.protected abstract boolean
useWriter()
Return whether to use ajava.io.Writer
to write text content to the HTTP response.从类继承的方法 org.springframework.web.servlet.view.jasperreports.AbstractJasperReportsView
convertExporterParameters, convertParameterValue, convertReportData, convertToExporterParameter, createReport, exposeLocalizationContext, fillReport, getConvertedExporterParameters, getExporterParameter, getExporterParameters, getJdbcDataSource, getReport, getReportData, getReportDataTypes, initApplicationContext, isUrlRequired, loadReport, loadReport, onInit, postProcessReport, renderMergedOutputModel, setConvertedExporterParameters, setExporterParameters, setHeaders, setJdbcDataSource, setReportDataKey, setSubReportDataKeys, setSubReportUrls
从类继承的方法 org.springframework.web.servlet.view.AbstractUrlBasedView
afterPropertiesSet, checkResource, getUrl, setUrl, toString
从类继承的方法 org.springframework.web.servlet.view.AbstractView
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse
从类继承的方法 org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
从类继承的方法 org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext
构造器详细资料
AbstractJasperReportsSingleFormatView
public AbstractJasperReportsSingleFormatView()
方法详细资料
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 returntrue
here if they know that they are generating download content that requires temporary caching on the client side, typically via the response OutputStream.
renderReport
protected void renderReport(net.sf.jasperreports.engine.JasperPrint populatedReport, Map<String,Object> model, HttpServletResponse response) throws Exception
Perform rendering for a single Jasper Reports exporter, that is, for a pre-defined output format.- 指定者:
renderReport
在类中AbstractJasperReportsView
- 参数:
populatedReport
- the populatedJasperPrint
to rendermodel
- the map containing report parametersresponse
- the HTTP response the report should be rendered to- 抛出:
Exception
- if rendering failed- 另请参阅:
AbstractView.getContentType()
,ServletResponse.setContentType(java.lang.String)
,ServletResponse.setCharacterEncoding(java.lang.String)
renderReportUsingWriter
protected void renderReportUsingWriter(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint populatedReport, HttpServletResponse response) throws Exception
We need to write text to the response Writer.- 参数:
exporter
- the JasperReports exporter to usepopulatedReport
- the populatedJasperPrint
to renderresponse
- the HTTP response the report should be rendered to- 抛出:
Exception
- if rendering failed
renderReportUsingOutputStream
protected void renderReportUsingOutputStream(net.sf.jasperreports.engine.JRExporter exporter, net.sf.jasperreports.engine.JasperPrint populatedReport, HttpServletResponse response) throws Exception
We need to write binary output to the response OutputStream.- 参数:
exporter
- the JasperReports exporter to usepopulatedReport
- the populatedJasperPrint
to renderresponse
- the HTTP response the report should be rendered to- 抛出:
Exception
- if rendering failed
createExporter
protected abstract net.sf.jasperreports.engine.JRExporter createExporter()
Create a JasperReports exporter for a specific output format, which will be used to render the report to the HTTP response.The
useWriter
method determines whether the output will be written as text or as binary content.- 另请参阅:
useWriter()
useWriter
protected abstract boolean useWriter()
Return whether to use ajava.io.Writer
to write text content to the HTTP response. Else, ajava.io.OutputStream
will be used, to write binary content to the response.