パッケージ jakarta.faces.context
クラス PartialResponseWriter
- java.lang.ObjectSE
-
- java.io.WriterSE
-
- jakarta.faces.context.ResponseWriter
-
- jakarta.faces.context.ResponseWriterWrapper
-
- jakarta.faces.context.PartialResponseWriter
- 実装されたすべてのインターフェース:
FacesWrapper<ResponseWriter>
、CloseableSE
、FlushableSE
、AppendableSE
、AutoCloseableSE
public class PartialResponseWriter extends ResponseWriterWrapper
PartialResponseWriter は、既存の
ResponseWriter
を装飾して、Ajax 操作に適した部分レスポンスの生成をサポートします。このクラスは、jakarta.faces.context.ResponseWriter
から継承されたマークアップ生成メソッドに加えて、標準の部分レスポンス要素を構築するためのメソッドを提供します。- 導入:
- 2.0
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static StringSE
RENDER_ALL_MARKER
ViewRoot 全体を示す予約済み ID 値。static StringSE
VIEW_STATE_MARKER
直列化された ViewState を示す予約済み ID 値。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 PartialResponseWriter(ResponseWriter writer)
PartialResponseWriter
を作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 void
delete(StringSE targetId)
削除操作を記述します。void
endDocument()
部分的なレスポンスの終わりを書きます。void
endError()
エラーの終わりを書きます。void
endEval()
eval 操作の終わりを記述します。void
endExtension()
拡張操作の終わりを書き込みます。void
endInsert()
挿入操作の終わりを書き込みます。void
endUpdate()
更新操作の終わりを書き込みます。void
redirect(StringSE url)
リダイレクト操作を記述します。void
startDocument()
部分レスポンスの開始を書き込みます。void
startError(StringSE errorName)
エラーの始まりを書きます。void
startEval()
eval 操作の開始を書き込みます。void
startExtension(MapSE<StringSE,StringSE> attributes)
拡張操作の開始を書き込みます。void
startInsertAfter(StringSE targetId)
指定されたターゲットノードの後にコンテンツが挿入される挿入操作の開始を書き込みます。void
startInsertBefore(StringSE targetId)
指定されたターゲットノードの前にコンテンツが挿入される挿入操作の開始を書き込みます。void
startUpdate(StringSE targetId)
更新操作の開始を書き込みます。void
updateAttributes(StringSE targetId, MapSE<StringSE,StringSE> attributes)
属性更新操作を記述します。クラス jakarta.faces.context.ResponseWriterWrapper から継承されたメソッド
cloneWithWriter, close, endCDATA, endElement, flush, getCharacterEncoding, getContentType, getWrapped, startCDATA, startElement, write, writeAttribute, writeComment, writeDoctype, writePreamble, writeText, writeText, writeText, writeURIAttribute
コンストラクターの詳細
PartialResponseWriter
public PartialResponseWriter(ResponseWriter writer)
PartialResponseWriter
を作成します。- パラメーター:
writer
- 包むライター。- 導入:
- 2.0
メソッドの詳細
startDocument
public void startDocument() throws IOExceptionSE
部分レスポンスの開始を書き込みます。
UIViewRoot
がNamingContainer
のインスタンスである場合は、ルート要素のid
属性の値としてUIComponent.getContainerClientId(FacesContext)
を書き込みます。- オーバーライド:
- クラス
ResponseWriterWrapper
のstartDocument
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
- 関連事項:
ResponseWriter.startDocument()
endDocument
public void endDocument() throws IOExceptionSE
部分的なレスポンスの終わりを書きます。
- オーバーライド:
- クラス
ResponseWriterWrapper
のendDocument
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
- 関連事項:
ResponseWriter.endDocument()
startInsertBefore
public void startInsertBefore(StringSE targetId) throws IOExceptionSE
指定されたターゲットノードの前にコンテンツが挿入される挿入操作の開始を書き込みます。
- パラメーター:
targetId
- ノード挿入の ID は前に発生する必要があります- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
startInsertAfter
public void startInsertAfter(StringSE targetId) throws IOExceptionSE
指定されたターゲットノードの後にコンテンツが挿入される挿入操作の開始を書き込みます。
- パラメーター:
targetId
- ノード挿入の ID は、後に発生する必要があります- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
endInsert
public void endInsert() throws IOExceptionSE
挿入操作の終わりを書き込みます。
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
startUpdate
public void startUpdate(StringSE targetId) throws IOExceptionSE
更新操作の開始を書き込みます。
- パラメーター:
targetId
- 更新するノードの ID- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
endUpdate
public void endUpdate() throws IOExceptionSE
更新操作の終わりを書き込みます。
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
updateAttributes
public void updateAttributes(StringSE targetId, MapSE<StringSE,StringSE> attributes) throws IOExceptionSE
属性更新操作を記述します。
- パラメーター:
targetId
- 更新するノードの IDattributes
- 更新される属性名 / 値のペアのマップ- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
delete
public void delete(StringSE targetId) throws IOExceptionSE
削除操作を記述します。
- パラメーター:
targetId
- 削除するノードの ID- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
redirect
public void redirect(StringSE url) throws IOExceptionSE
リダイレクト操作を記述します。
- パラメーター:
url
- リダイレクト先の URL- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
startEval
public void startEval() throws IOExceptionSE
eval 操作の開始を書き込みます。
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
endEval
public void endEval() throws IOExceptionSE
eval 操作の終わりを記述します。
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
startExtension
public void startExtension(MapSE<StringSE,StringSE> attributes) throws IOExceptionSE
拡張操作の開始を書き込みます。
- パラメーター:
attributes
- 拡張要素属性の文字列名 / 値のペア- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
endExtension
public void endExtension() throws IOExceptionSE
拡張操作の終わりを書き込みます。
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
startError
public void startError(StringSE errorName) throws IOExceptionSE
エラーの始まりを書きます。
- パラメーター:
errorName
- エラーの説明文字列- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0
endError
public void endError() throws IOExceptionSE
エラーの終わりを書きます。
- 例外:
IOExceptionSE
- 入出力エラーが発生した場合- 導入:
- 2.0