パッケージ jakarta.faces.component

クラス UIImportConstants

  • 実装されたすべてのインターフェース:
    PartialStateHolderStateHolderTransientStateHolderComponentSystemEventListenerFacesListenerSystemEventListenerHolderEventListenerSE

    public class UIImportConstants
    extends UIComponentBase

    UIImportConstants は、現在のビューで指定された型のすべての定数フィールド値のマッピングをインポートします。

    ViewDeclarationLanguage 実装では、<f:metadata /> 要素内に配置された <f:importConstants /> 要素が出現するたびに、このコンポーネントのインスタンスをビューに配置する必要があります。ユーザーは、<f:metadata /> を UIViewRoot の直接の子として配置する必要があります。ViewMetadata.createMetadataView(jakarta.faces.context.FacesContext) は、定数をインポートする実際のタスクを処理する必要があります。

    このクラスのインスタンスは、Ajax リクエストを含め、通常の Jakarta Faces ライフサイクルに参加します。

    このコンポーネントの目的は、現在のビューで指定された型のすべての定数フィールド値のマッピングを提供することです。定数フィールド値は、指定された型のすべての public static final フィールドです。マップキーは、定数フィールド名を String として表します。マップ値は、実際の定数フィールド値を表します。これは、クラス、インターフェース、列挙型で機能します。

    使用方法

    以下の定数フィールド:

     package com.example;
    
     public class Foo {
         public static final String FOO1 = "foo1";
         public static final String FOO2 = "foo2";
     }
     
     package com.example;
    
     public interface Bar {
         public static final String BAR1 = "bar1";
         public static final String BAR2 = "bar2";
     }
     
     package com.example;
    
     public enum Baz {
         BAZ1, BAZ2;
     }
     

    以下のようにインポートできます。

     <f:metadata>
         <f:importConstants type="com.example.Foo" />
         <f:importConstants type="com.example.Bar" var="Barrr" />
         <f:importConstants type="com.example.Baz" />
     </f:metadata>
     

    そして、以下のように参照することができます:

     #{Foo.FOO1}, #{Foo.FOO2}, #{Barrr.BAR1}, #{Barrr.BAR2}, #{Baz.BAZ1}, #{Baz.BAZ2}
     
     <h:selectOneMenu value="#{bean.baz}" >
         <f:selectItems value="#{Baz}" />
     </h:selectOneMenu>
     
    導入:
    2.3
    • フィールドの詳細

      • COMPONENT_FAMILY

        public static final StringSE COMPONENT_FAMILY

        このコンポーネントの標準コンポーネントファミリ。

        関連事項:
        定数フィールド値
    • コンストラクターの詳細

      • UIImportConstants

        public UIImportConstants()

        レンダラー型を null に設定して新しい UIImportConstants インスタンスを作成します。

    • メソッドの詳細

      • getFamily

        public StringSE getFamily()
        クラスからコピーされた説明: UIComponent

        このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、rendererType プロパティの値と組み合わせて、このコンポーネントインスタンスに適切な Renderer を選択するために使用できます。このメソッドは null を返すべきではないことに注意してください

        次で指定:
        クラス UIComponentgetFamily 
        戻り値:
        コンポーネントファミリ(null 以外)。
      • getType

        public StringSE getType()

        定数フィールド値をインポートする型の完全修飾名を返します。

        戻り値:
        定数フィールド値をインポートする型の完全修飾名。
      • setType

        public void setType​(StringSE type)

        定数フィールド値をインポートする型の完全修飾名を設定します。

        パラメーター:
        type - 定数フィールド値をインポートする型の完全修飾名。
      • getVar

        public StringSE getVar()

        定数がマップとして公開されるリクエストスコープ属性の名前を返します。

        戻り値:
        定数がマップとして公開されるリクエストスコープ属性の名前。
      • setVar

        public void setVar​(StringSE var)

        定数がマップとして公開されるリクエストスコープ属性の名前を設定します。

        パラメーター:
        var - 定数がマップとして公開されるリクエストスコープ属性の名前。