パッケージ jakarta.faces.component

クラス UIViewParameter

  • 実装済みのインターフェース一覧:
    EditableValueHolder、PartialStateHolder、StateHolder、TransientStateHolder、ValueHolder、ComponentSystemEventListener、FacesListener、SystemEventListenerHolder、EventListenerSE
    public class UIViewParameter
extends UIInput

    UIViewParameter は、リクエストパラメーターとモデルプロパティまたは UIViewRoot プロパティ間のバインディングを表します。これは双方向バインディングです。

    ViewDeclarationLanguage 実装では、<f:metadata /> 要素内に配置された <f:viewParam /> 要素が出現するたびに、このコンポーネントのインスタンスをビューに表示する必要があります。ユーザーはこのファセットを UIViewRoot 内に配置する必要があります。

    このクラスは UIInput を継承するため、通常 UIInput インスタンスで実行されるすべてのアクションは、このクラスのインスタンスに対して有効です。このクラスのインスタンスは、Ajax リクエストを含む通常の Jakarta Server Faces ライフサイクルに参加します。

    導入:
    2.0

    • フィールドの詳細

      • COMPONENT_FAMILY

        public static final StringSE COMPONENT_FAMILY

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

        関連事項:
        定数フィールド値

    • コンストラクターの詳細

      • UIViewParameter

        public UIViewParameter()

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

    • メソッドの詳細

      • getFamily

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

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

        オーバーライド:
        クラス UIInput の getFamily 
        戻り値:
        コンポーネントファミリ（null 以外）。

      • getName

        public StringSE getName()

        値を取得するリクエストパラメーター名を返します。

        戻り値:
        名前。
        導入:
        2.0

      • setName

        public void setName​(StringSE name)

        値を取得するリクエストパラメーター名を設定します。

        パラメーター:
        name - 新しいリクエストパラメーター名。
        導入:
        2.0

      • isImmediate

        public boolean isImmediate()

        false を返します。即時設定はビューパラメーターには関係がないため、false であると想定する必要があります。

        次で指定:
        インターフェース EditableValueHolder 内の isImmediate 
        オーバーライド:
        クラス UIInput の isImmediate 
        戻り値:
        即時の場合は true、それ以外の場合は false。
        導入:
        2.0

      • getSubmittedValue

        public ObjectSE getSubmittedValue()

        送信された値は常に文字列であると想定しますが、このメソッドからの戻り値の型は Object です。

        次で指定:
        インターフェース EditableValueHolder 内の getSubmittedValue 
        オーバーライド:
        クラス UIInput の getSubmittedValue 
        戻り値:
        送信された値。
        導入:
        2.0

      • setSubmittedValue

        public void setSubmittedValue​(ObjectSE submittedValue)
        PENDING（ドキュメント）送信された値が親によって保存されないことに興味がある
        次で指定:
        インターフェース EditableValueHolder 内の setSubmittedValue 
        オーバーライド:
        クラス UIInput の setSubmittedValue 
        パラメーター:
        submittedValue - 新しく送信された値

      • decode

        public void decode​(FacesContext context)

        スーパークラスの動作をオーバーライドして、getName() によって指定された名前で受信リクエストパラメーターマップから値をプルし、UIInput.setSubmittedValue(java.lang.Object) への呼び出しで値を格納します。

        オーバーライド:
        クラス UIInput の decode 
        パラメーター:
        context - FacesContext（処理中のリクエスト）
        導入:
        2.0

      • processValidators

        public void processValidators​(FacesContext context)

        スーパークラスの動作を特殊化して、 null を別の方法で扱います。このクラスでは、null 値と「必須」フラグが true に設定されていると、検証エラーが発生します。それ以外の場合、UIInput.EMPTY_STRING_AS_NULL_PARAM_NAME コンテキストパラメーターが true で値が null の場合、空の文字列を引数として渡して UIInput.setSubmittedValue(java.lang.Object) を呼び出します。これにより、Bean 検証を含む通常の検証処理が行われます。

        オーバーライド:
        クラス UIInput の processValidators 
        パラメーター:
        context - Faces コンテキスト。
        導入:
        2.0
        関連事項:
        PreValidateEvent, PostValidateEvent

      • updateModel

        public void updateModel​(FacesContext context)

        スーパークラス UIInput.updateModel(jakarta.faces.context.FacesContext) を呼び出し、値が値式ではなく、有効であり、このライフサイクルの実行でローカル値が設定されている場合にのみ、値をリクエストスコープにプッシュする追加のアクションを実行します。

        オーバーライド:
        クラス UIInput の updateModel 
        パラメーター:
        context - FacesContext（処理中のリクエスト）
        導入:
        2.0

      • getStringValue

        public StringSE getStringValue​(FacesContext context)

        このパラメーターの値が ValueExpression からのものである場合は式の値を返し、それ以外の場合はローカル値を返します。

        パラメーター:
        context - Faces コンテキスト。
        戻り値:
        文字列値。
        導入:
        2.0

      • getStringValueFromModel

        public StringSE getStringValueFromModel​(FacesContext context)
                               throws ConverterException

        標準の変換手順を手動で実行して、値式から文字列値を取得します。

        パラメーター:
        context - Faces コンテキスト。
        戻り値:
        モデルからの文字列値。
        例外:
        ConverterException
        導入:
        2.0