フィールドの詳細

• FACELETS_VIEW_DECLARATION_LANGUAGE_ID

  public static final StringSE FACELETS_VIEW_DECLARATION_LANGUAGE_ID

  Facelets ビュー宣言言語の識別子。

  導入:

  2.1

  関連事項:

  定数フィールド値

コンストラクターの詳細

• ViewDeclarationLanguage

  public ViewDeclarationLanguage()

メソッドの詳細

• restoreView

  public abstract UIViewRoot restoreView​(FacesContext context,
                                         StringSE viewId)

  以前に作成したビューから UIViewRoot を復元します。デフォルト実装の仕様については、Jakarta Faces Specification Document のセクション 7.7.2「デフォルト ViewDeclarationLanguage 実装」を参照してください。

  パラメーター:

  context - このリクエストの FacesContext 

  viewId - 以前にレンダリングされたビューの識別子。

  戻り値:

  復元されたビュー

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合

• getViewMetadata

  public abstract ViewMetadata getViewMetadata​(FacesContext context,
                                               StringSE viewId)

  引数 viewId で表されるビューのビューメタデータへの参照を返すか、メタデータが見つからない場合は null を返します。デフォルト実装の仕様については、Jakarta Faces Specification Document のセクション 7.7.2「デフォルト ViewDeclarationLanguage 実装」を参照してください。Facelets の実装は非 null を返す必要があります。

  パラメーター:

  context - このリクエストの FacesContext。

  viewId - メタデータを抽出するビュー ID

  戻り値:

  ビューのメタデータ

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合。

  FacesException - メタデータの取得にエラーがある場合

  導入:

  2.0

• createView

  public abstract UIViewRoot createView​(FacesContext context,
                                        StringSE viewId)

  引数 viewId によって参照されるアーティファクトに含まれる VDL から UIViewRoot を作成します。デフォルト実装の仕様については、Jakarta Faces Specification Document のセクション 7.7.2「デフォルト ViewDeclarationLanguage 実装」を参照してください。

  パラメーター:

  context - このリクエストの FacesContext 

  viewId - このビューを説明する VDL 構文を含むアーティファクトの識別子。

  戻り値:

  新しく作成されたビュールート

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合

  導入:

  2.0

• buildView

  public abstract void buildView​(FacesContext context,
                                 UIViewRoot root)
                          throws IOExceptionSE

  子供たちと一緒に移入する、createView(jakarta.faces.context.FacesContext, java.lang.String) への呼び出しを介して作成されている必要があり、引数 UIViewRoot を引き起こすために、この VDL 実装に任意のアクションを特定してください。

  Facelets の実装では、ビューを構成するマークアップを実行する必要があります。ビュー内の UIComponent インスタンスは、UIComponent で定義された他のライフサイクルメソッドと同じ深さ優先で検出され、その間にビューに追加されます（ただしレンダリングされません）。トラバーサル。ランタイムは、次のいずれかが発生する前に、ビューが完全に入力されている必要があることを保証する必要があります。

  • アプリケーションに接続されている PhaseListener の PhaseListener.afterPhase(jakarta.faces.event.PhaseEvent) メソッドが呼び出されます

  • UIViewRoot.setAfterPhaseListener(jakarta.el.MethodExpression) または UIViewRoot.addPhaseListener(jakarta.faces.event.PhaseListener) を介してインストールされた UIViewRoot フェーズリスナーが呼び出されます。

  root にすでに子が設定されている場合でも、ビューを再構築する必要がありますが、既存のコンポーネントが VDL ページの対応する VDL と正しくペアリングされるように注意する必要があります。また、ビューからのコンポーネントの追加または削除中に通常生成されるシステムイベントは、ビューの作成中に一時的に無効にし、ビューの作成時に再度有効にする必要があります。

  パラメーター:

  context - このリクエストの FacesContext 

  root - この VDL 実装に固有の手法を使用して、子を実装する UIViewRoot。

  例外:

  IOExceptionSE - 何らかの理由でビューを構築できない場合

• renderView

  public abstract void renderView​(FacesContext context,
                                  UIViewRoot view)
                           throws IOExceptionSE

  引数 view をルートとするビューをレンダリングします。デフォルト実装の仕様については、Jakarta Faces Specification Document のセクション 7.7.2「デフォルト ViewDeclarationLanguage 実装」を参照してください。

  パラメーター:

  context - このリクエストの FacesContext 

  view - createView(jakarta.faces.context.FacesContext, java.lang.String) または restoreView(jakarta.faces.context.FacesContext, java.lang.String) への早期呼び出しからの UIViewRoot。

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合

  IOExceptionSE - 何らかの理由でビューをレンダリングできない場合

• getComponentMetadata

  public abstract BeanInfoSE getComponentMetadata​(FacesContext context,
                                                Resource componentResource)

  引数 componentResource で表される複合コンポーネントのコンポーネントメタデータへの参照を返すか、メタデータが見つからない場合は null を返します。デフォルト実装の仕様については、Jakarta Faces Specification Document のセクション 7.7.2「デフォルト ViewDeclarationLanguage 実装」を参照してください。Jakarta Server Pages 実装は UnsupportedOperationException をスローする必要があります。

  パラメーター:

  context - このリクエストの FacesContext。

  componentResource - コンポーネントを表す Resource。

  戻り値:

  コンポーネントのメタデータ

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合。

  FacesException - メタデータの取得にエラーがある場合

  UnsupportedOperationExceptionSE - これが Jakarta Server Pages VDL 実装の場合。

  導入:

  2.0

• getScriptComponentResource

  public abstract Resource getScriptComponentResource​(FacesContext context,
                                                      Resource componentResource)

  引数 componentResource を指定して、実装固有のアクションを実行して Resource を検出します。デフォルト実装の仕様については、Jakarta Faces Specification Document のセクション 7.7.2「デフォルト ViewDeclarationLanguage 実装」を参照してください。Jakarta Server Pages 実装は UnsupportedOperationException をスローする必要があります。

  パラメーター:

  context - このリクエストの FacesContext。

  componentResource - コンポーネントを表す Resource。

  戻り値:

  引数  componentResource に対応する Resource

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合。

  FacesException - スクリプトコンポーネントリソースの取得でエラーが発生した場合

  UnsupportedOperationExceptionSE - これが Jakarta Server Pages VDL 実装の場合。

  導入:

  2.0

• createComponent

  public UIComponent createComponent​(FacesContext context,
                                     StringSE taglibURI,
                                     StringSE tagName,
                                     MapSE<StringSE,​ObjectSE> attributes)

  ViewDeclarationLanguage 固有のタグライブラリ URI とタグ名を指定してコンポーネントを作成します。ランタイムは、FaceletsVDL で動作するこのメソッドをサポートする必要があります。他の種類の ViewDeclarationLanguage がサポートされている場合がありますが、サポートする必要はありません。このメソッドをオーバーライドしない装飾された ViewDeclrationLanguage 実装との下位互換性のために、null を返すデフォルトの実装が提供されています。ただし、このメソッドが導入された仕様のバージョンに準拠する実装では、このメソッドを実装する必要があります。

  パラメーター:

  context - このリクエストの FacesContext

  taglibURI - コンポーネントを含む完全修飾タグライブラリ URI

  tagName - コンポーネントを公開するライブラリ内のタグの名前

  attributes - 属性を指定する必要がない場合、このコンポーネントまたは null の作成を引き起こすマークアップで指定されたであろう名前 = 値のペア。

  戻り値:

  新しく作成されたコンポーネント

  例外:

  NullPointerExceptionSE - context、taglibURI、tagName が null の場合

  導入:

  2.2

• retargetAttachedObjects

  public void retargetAttachedObjects​(FacesContext context,
                                      UIComponent topLevelComponent,
                                      ListSE<AttachedObjectHandler> handlers)

  引数 topLevelComponent のコンポーネントメタデータが getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource) の以前の呼び出しによって使用可能になっていると仮定すると、コンポーネントメタデータを活用して、アタッチされたオブジェクトを最上位の複合コンポーネントから複合コンポーネント内の個々の AttachedObjectTarget インスタンスに再ターゲットします。このメソッドは、複合コンポーネントの使用が検出されたときに UIComponent ツリーを作成するときに、ViewDeclarationLanguage 実装によって呼び出される必要があります。

  以下と意味的に同等のアルゴリズムを実装する必要があります。

  • 複合コンポーネントのメタデータを取得します。現在、これには、BeanInfo のインスタンスとなる UIComponent.BEANINFO_KEY コンポーネント属性の値を取得する必要があります。メタデータが見つからない場合は、エラーメッセージをログに記録して戻ります。

  • BeanInfo から BeanDescriptor を取得します。

  • BeanDescriptor の getValue() メソッドから AttachedObjectTarget.ATTACHED_OBJECT_TARGETS_KEY の値を取得します。これは List<AttachedObjectTarget> になります。これを targetList とします。

  • 引数 handlers の各 curHandler エントリについて

    • forAttributeValue を AttachedObjectHandler.getFor() からの戻り値とします。

    • targetList 内の各 curTarget エントリに対して、一致する最初の次の項目がこのアクションを実行します。

      curTarget.getTargets() から返されたリスト内の各 UIComponent に対して、FacesContext と UIComponent を渡して curHandler.applyAttachedObject() を呼び出します。

      そして、この内部ループを終了させます。

      • curHandler が ActionSource2AttachedObjectHandler のインスタンスであり、curTarget が ActionSource2AttachedObjectTarget のインスタンスであり、curTarget.getName() が curTargetName と等しい場合は、一致しているとみなします。

      • curHandler が EditableValueHolderAttachedObjectHandler のインスタンスであり、curTarget が EditableValueHolderAttachedObjectTarget のインスタンスであり、curTarget.getName() が curTargetName と等しい場合は、一致と見なします。

      • curHandler が ValueHolderAttachedObjectHandler のインスタンスであり、curTarget が ValueHolderAttachedObjectTarget のインスタンスであり、curTarget.getName() が curTargetName と等しい場合は、一致しているとみなします。

      • curHandler が BehaviorHolderAttachedObjectHandler のインスタンスであり、curTarget が BehaviorHolderAttachedObjectTarget のインスタンスであり、以下の条件のいずれかが真である場合

        • curHandler.getEventName() は null ではなく、curTargetName と等しくなります。
        • curHandler.getEventName() は null であり、curTarget.isDefaultEvent() は true です。

        それを一致と見なします。

  実装は、アタッチされたオブジェクトをトップレベルのコンプサイトコンポーネントからコンポジットおよび非コンポジットコンポーネントであるターゲットに再ターゲットすることをサポートする必要があります。

  UnsupportedOperationException をスローする実装が提供されます。バージョン 2.0 に準拠し、仕様を超える Faces 実装は、このメソッドをオーバーライドする必要があります。

  パラメーター:

  context - このリクエストの FacesContext。

  topLevelComponent - アタッチされたオブジェクトをアタッチする必要があるビューの UIComponent。この UIComponent には、そのコンポーネントメタデータがすでに関連付けられており、JavaBeans API を介して利用できる必要があります。

  handlers - アタッチされたオブジェクトのタグハンドラー

  例外:

  NullPointerExceptionSE - 引数のいずれかが null の場合。

  導入:

  2.0