パッケージ jakarta.faces.component

クラス UIForm

    • フィールドの詳細

      • COMPONENT_FAMILY

        public static final StringSE COMPONENT_FAMILY

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

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

      • UIForm

        public UIForm()

        デフォルトのプロパティ値で新しい UIForm インスタンスを作成します。

    • メソッドの詳細

      • getFamily

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

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

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

        public boolean isSubmitted()

        submitted プロパティの現在の値を返します。デフォルト値は false です。詳細については、setSubmitted(boolean) を参照してください。

        このプロパティは、UIComponent.getTransientStateHelper() を使用して一時的なプロパティとして保持する必要があります。

        戻り値:
        フォームが送信された場合は true、それ以外の場合は false
      • setSubmitted

        public void setSubmitted​(boolean submitted)

        (ページ内の他の形ではなく) この UIForm インスタンスがこのリクエスト処理ライフサイクル中に提出発生している場合、このメソッドは、この UIForm インスタンスの UIComponent.decode(jakarta.faces.context.FacesContext) 時に、引数として true で、呼び出されなければなりません。この UIForm インスタンスで送信が発生していない場合は、この UIForm インスタンスの UIComponent.decode(jakarta.faces.context.FacesContext) 中に、false を引数としてこのメソッドを呼び出す必要があります。

        UIForm の送信されたプロパティの値は、その状態の一部として保存してはなりません。

        このプロパティは、UIComponent.getTransientStateHelper() を使用して一時的なプロパティとして保持する必要があります。

        パラメーター:
        submitted - 送信されたフラグの新しい値。
      • isPrependId

        public boolean isPrependId()
        先頭に ID が付いています。
        戻り値:
        ある場合は true、それ以外の場合は false
      • setPrependId

        public void setPrependId​(boolean prependId)
        ID を先頭に追加するかどうかを設定します。
        パラメーター:
        prependId - ある場合は true、そうでない場合は false
      • createUniqueId

        public StringSE createUniqueId​(FacesContext context,
                                     StringSE seed)

        コンポーネントの識別子を生成します。識別子の前には UNIQUE_ID_PREFIX が付けられ、このコンポーネントコンテナー内で一意になります。オプションで、生成された一意の ID に含める必要のある一意のシード値をコンポーネントの作成者が提供できます。

        prependId プロパティの値が false の場合、このメソッドは次の祖先 UniqueIdVendor で createUniqueId を呼び出す必要があります。

        次で指定:
        インターフェース UniqueIdVendorcreateUniqueId 
        パラメーター:
        context - FacesContext
        seed - オプションのシード値 - 例 VDL テンプレート内のコンポーネントの位置に基づく
        戻り値:
        このコンポーネントコンテナーの一意の ID
      • visitTree

        public boolean visitTree​(VisitContext context,
                                 VisitCallback callback)
        クラスからコピーされた説明: UIComponent

        ツリー内のこのノードからツリー訪問を実行します。

        UIComponent.visitTree() の実装は VisitCallback を直接呼び出さず、代わりに VisitContext.invokeVisitCallback(jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitCallback) を呼び出してコールバックを呼び出します。これにより、VisitContext 実装は、たとえばコンポーネントのサブセットに対して  VisitCallback を呼び出すだけで、最適化されたツリートラバーサルを提供できます。

        UIComponent.visitTree() 実装は、訪問を実行する前に UIComponent.pushComponentToEL() を呼び出し、訪問後に UIComponent.popComponentFromEL() を呼び出す必要があります。

        オーバーライド:
        クラス UIComponentvisitTree 
        パラメーター:
        context - この訪問の VisitContext 
        callback - 訪問したノードごとに visit メソッドが呼び出される VisitCallback インスタンス
        戻り値:
        コンポーネントの実装は、true を返し、ツリーの訪問が完了したことを示す場合があります(訪問する必要のあるすべてのコンポーネントが訪問されたなど)。これにより、ツリーへのアクセスが短絡され、アクセスされるコンポーネントがなくなります。
        関連事項:
        UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)