クラス AbstractXlsView
java.lang.ObjectSE
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.context.support.WebApplicationObjectSupport
org.springframework.web.servlet.view.AbstractView
org.springframework.web.servlet.view.document.AbstractXlsView
- 実装されたすべてのインターフェース:
Aware
、BeanNameAware
、ApplicationContextAware
、ServletContextAware
、View
- 既知の直属サブクラス
AbstractXlsxView
従来の XLS 形式の Excel ドキュメントビュー用の便利なスーパークラス。Apache POI 3.5 以降と互換性があります。
サブクラスでワークブックを操作するには、Apache の POI サイトを参照してください
- 導入:
- 4.2
- 作成者:
- Juergen Hoeller
フィールドのサマリー
クラス 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
コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明protected abstract void
buildExcelDocument
(MapSE<StringSE, ObjectSE> model, org.apache.poi.ss.usermodel.Workbook workbook, HttpServletRequestEE request, HttpServletResponseEE response) アプリケーションが提供するサブクラスは、このメソッドを実装して、モデルに基づいて Excel ブックドキュメントにデータを入力する必要があります。protected org.apache.poi.ss.usermodel.Workbook
createWorkbook
(MapSE<StringSE, ObjectSE> model, HttpServletRequestEE request) POIWorkbook
インスタンスを作成するためのテンプレートメソッド。protected boolean
このビューがダウンロードコンテンツ(通常は PDF ファイルや Excel ファイルなどのバイナリコンテンツ)を生成するかどうかを返します。protected final void
renderMergedOutputModel
(MapSE<StringSE, ObjectSE> model, HttpServletRequestEE request, HttpServletResponseEE response) 指定されたモデルを指定して、Excel ビューをレンダリングします。protected void
renderWorkbook
(org.apache.poi.ss.usermodel.Workbook workbook, HttpServletResponseEE response) 実際のレンダリングステップ: POIWorkbook
を取得して、指定されたレスポンスにレンダリングします。クラス org.springframework.web.servlet.view.AbstractView から継承されたメソッド
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestToExpose, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setRequestContextAttribute, setResponseContentType, toString, writeToResponse
クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
コンストラクターの詳細
AbstractXlsView
public AbstractXlsView()デフォルトのコンストラクター。ビューのコンテンツ型を "application/vnd.ms-excel" に設定します。
メソッドの詳細
generatesDownloadContent
protected boolean generatesDownloadContent()クラスからコピーされた説明:AbstractView
このビューがダウンロードコンテンツ(通常は PDF ファイルや Excel ファイルなどのバイナリコンテンツ)を生成するかどうかを返します。デフォルトの実装は
false
を返します。通常、レスポンス OutputStream を介して、クライアント側で一時キャッシュを必要とするダウンロードコンテンツを生成していることがわかっている場合、サブクラスはここでtrue
を返すことが推奨されます。renderMergedOutputModel
protected final void renderMergedOutputModel(MapSE<StringSE, ObjectSE> model, HttpServletRequestEE request, HttpServletResponseEE response) throws ExceptionSE指定されたモデルを指定して、Excel ビューをレンダリングします。- 次で指定:
- クラス
AbstractView
のrenderMergedOutputModel
- パラメーター:
model
- 静的な属性よりも動的な値が優先される、結合された出力マップ(非null
)request
- 現在の HTTP リクエストresponse
- 現在の HTTP レスポンス- 例外:
ExceptionSE
- レンダリングに失敗した場合
createWorkbook
protected org.apache.poi.ss.usermodel.Workbook createWorkbook(MapSE<StringSE, ObjectSE> model, HttpServletRequestEE request) POIWorkbook
インスタンスを作成するためのテンプレートメソッド。デフォルトの実装では、従来の
HSSFWorkbook
が作成されます。Spring が提供するサブクラスは、OOXML ベースのバリアントに対してこれをオーバーライドしています。カスタムサブクラスは、ファイルからワークブックを読み取るためにこれをオーバーライドできます。- パラメーター:
model
- モデルマップrequest
- 現在の HTTP リクエスト (URL またはヘッダーを考慮するため)- 戻り値:
- 新しい
Workbook
インスタンス
renderWorkbook
protected void renderWorkbook(org.apache.poi.ss.usermodel.Workbook workbook, HttpServletResponseEE response) throws IOExceptionSE 実際のレンダリングステップ: POIWorkbook
を取得して、指定されたレスポンスにレンダリングします。- パラメーター:
workbook
- レンダリングする POI ワークブックresponse
- 現在の HTTP レスポンス- 例外:
IOExceptionSE
- 委譲している I/O メソッドによってスローされたとき
buildExcelDocument
protected abstract void buildExcelDocument(MapSE<StringSE, ObjectSE> model, org.apache.poi.ss.usermodel.Workbook workbook, HttpServletRequestEE request, HttpServletResponseEE response) throws ExceptionSEアプリケーションが提供するサブクラスは、このメソッドを実装して、モデルに基づいて Excel ブックドキュメントにデータを入力する必要があります。- パラメーター:
model
- モデルマップworkbook
- 移入する Excel ワークブックrequest
- ロケールなどが必要な場合に備えて。属性を見てはいけません。response
- クッキーを設定する必要がある場合に備えて。書いてはいけません。- 例外:
ExceptionSE