パッケージ jakarta.faces.view

クラス ViewMetadata


  • public abstract class ViewMetadata
    extends ObjectSE

    ViewMetadata は、VDL ビューからビューパラメーターメタデータを抽出して提供する責任があります。ViewDeclarationLanguage.getViewMetadata(jakarta.faces.context.FacesContext, java.lang.String) は、Jakarta Server Pages ビューの場合は null を返し、Jakarta Faces 2 のフェイスレットで作成されたビューの場合は非 null を返す必要があるため、この仕様は Jakarta Faces 2 のフェイスレットにのみ適用されます。

    導入:
    2.0
    • コンストラクターの詳細

      • ViewMetadata

        public ViewMetadata()
    • メソッドの詳細

      • getViewId

        public abstract StringSE getViewId()

        ビュー ID を取得する

        戻り値:
        この ViewMetadata インスタンスが作成されたビュー ID
      • createMetadataView

        public abstract UIViewRoot createMetadataView​(FacesContext context)

        ビューパラメーターメタデータのみを含む新しい UIViewRoot を作成します。メタデータを使用してこの UIViewRoot を構築する処理によって、イベントがアプリケーションに公開されることはありません。実装では、メソッドの最初に false を引数として渡して FacesContext.setProcessingEvents(boolean) を呼び出し、最後に同じメソッドに true を渡す必要があります。実装では、スローされる可能性のある ant 例外に関係なく、これが発生することを確認する必要があります。

        準拠した実装では、次のことを確認する必要があることに注意してください。

        • タグハンドラーを適用する前に、新しい UIViewRoot を FacesContext の viewRoot として設定し、finally ブロックで古い FacesContext を復元する必要があります。
        • タグハンドラーを適用する前に、現在の UIViewRoot の ViewMap の内容を新しい UIViewRoot の ViewMap にコピーする必要があります。
        • UIImportConstants は、タグハンドラーを適用した後に処理する必要があります。
        パラメーター:
        context - 現在のリクエストの FacesContext
        戻り値:
        ビューパラメーターメタデータのみを含む UIViewRoot (もしあれば)
      • getViewParameters

        public static CollectionSE<UIViewParameter> getViewParameters​(UIViewRoot root)

        提供された UIViewRoot からビューメタデータを抽出するユーティリティメソッド。

        パラメーター:
        root - メタデータが抽出される UIViewRoot
        戻り値:
        UIViewParameter インスタンスの Collection。ビューにメタデータがない場合、コレクションは空になります。
      • getViewActions

        public static CollectionSE<UIViewAction> getViewActions​(UIViewRoot root)

        提供された UIViewRoot からビューメタデータを抽出するユーティリティメソッド。

        パラメーター:
        root - メタデータが抽出される UIViewRoot
        戻り値:
        UIViewAction インスタンスの Collection。ビューにメタデータがない場合、コレクションは空になります。
      • getImportConstants

        public static CollectionSE<UIImportConstants> getImportConstants​(UIViewRoot root)

        提供された UIViewRoot からビューメタデータを抽出するユーティリティメソッド。

        パラメーター:
        root - メタデータが抽出される UIViewRoot
        戻り値:
        UIImportConstants インスタンスの Collection。ビューにメタデータがない場合、コレクションは空になります。
      • hasMetadata

        public static boolean hasMetadata​(UIViewRoot root)

        提供された UIViewRoot にメタデータがあるかどうかを判別するためのユーティリティメソッド。提供された UIViewRoot に UIViewRoot.METADATA_FACET_NAME という名前のファセットがあり、そのファセットに子がある場合、デフォルトの実装は true を返します。それ以外の場合は false を返します。

        パラメーター:
        root - メタデータの抽出元となる UIViewRoot
        戻り値:
        ビューにメタデータがある場合は true、それ以外の場合は false。