パッケージ jakarta.faces.model

クラス SelectItem

java.lang.ObjectSE
jakarta.faces.model.SelectItem
実装されているすべてのインターフェース:
SerializableSE
既知の直属サブクラス
SelectItemGroup

public class SelectItem extends ObjectSE implements SerializableSE

SelectItem は、UISelectMany または UISelectOne コンポーネントに関連付けられたサポートされるアイテムのリスト内の単一のアイテムを表します。

関連事項:
  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    初期化されたプロパティ値を持たない SelectItem を構築します。
    指定された値で SelectItem を構築します。
    指定された値とラベルで SelectItem を構築します。
    SelectItem(ObjectSE value, StringSE label, StringSE description)
    指定された値、ラベル、説明を使用して SelectItem インスタンスを構築します。
    SelectItem(ObjectSE value, StringSE label, StringSE description, boolean disabled)
    指定されたプロパティ値で SelectItem インスタンスを構築します。
    SelectItem(ObjectSE value, StringSE label, StringSE description, boolean disabled, boolean escape)
    指定されたプロパティ値で SelectItem インスタンスを構築します。
    SelectItem(ObjectSE value, StringSE label, StringSE description, boolean disabled, boolean escape, boolean noSelectionOption)
    指定されたプロパティ値で SelectItem インスタンスを構築します。
  • 方法の概要

    修飾子と型
    メソッド
    説明
    開発ツールで使用するために、このアイテムの説明を返します。
    このアイテムのラベルを返し、ユーザーに表示されます。
    このアイテムがユーザーによって選択された場合にモデルに配信されるように、このアイテムの値を返します。
    boolean
    このアイテムの無効化フラグを返します。true に設定されている場合、レンダリングされた出力を変更して、ユーザーがこのアイテムを選択できないようにする必要があります。
    boolean
    これが true を返す場合に限り、この選択項目をレンダリングするコードは、レンダリングされるコンテンツ型に適切なエスケープ構文を使用してラベルをエスケープする必要があります。
    boolean
    noSelectionOption プロパティの値を返します。
    void
    開発ツールで使用するために、このアイテムの説明を設定します。
    void
    setDisabled(boolean disabled)
    このアイテムの無効化フラグを設定します。これにより、レンダリングされた出力が変更され、true に設定されている場合、ユーザーがこのアイテムを選択できなくなります。
    void
    setEscape(boolean escape)
    エスケーププロパティの値を設定します。
    void
    このアイテムのラベルを設定して、ユーザーに表示されるようにします。
    void
    setNoSelectionOption(boolean noSelectionOption)
    noSelectionOption プロパティの値を設定します。
    void
    このユーザーがこのアイテムを選択した場合にモデルに配信されるように、このアイテムの値を設定します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
  • コンストラクターの詳細

    • SelectItem

      public SelectItem()

      初期化されたプロパティ値を持たない SelectItem を構築します。

    • SelectItem

      public SelectItem(ObjectSE value)

      指定された値で SelectItem を構築します。label プロパティは値に設定され(必要に応じて文字列に変換されます)、description プロパティは null に設定され、disabled プロパティは false に設定され、escape プロパティは(true に設定されます。

      パラメーター:
      value - このアイテムがユーザーによって選択された場合にモデルに配信される値
    • SelectItem

      public SelectItem(ObjectSE value, StringSE label)

      指定された値とラベルで SelectItem を構築します。description プロパティは null に設定され、disabled プロパティは false に設定され、escape プロパティは true に設定されます。

      パラメーター:
      value - このアイテムがユーザーによって選択された場合にモデルに配信される値
      label - レスポンスでこのアイテムに対してレンダリングされるラベル
    • SelectItem

      public SelectItem(ObjectSE value, StringSE label, StringSE description)

      指定された値、ラベル、説明を使用して SelectItem インスタンスを構築します。この disabled プロパティは false に設定され、escape プロパティは true に設定されます。

      パラメーター:
      value - このアイテムがユーザーによって選択された場合にモデルに配信される値
      label - レスポンスでこのアイテムに対してレンダリングされるラベル
      description - このアイテムの説明、ツールで使用
    • SelectItem

      public SelectItem(ObjectSE value, StringSE label, StringSE description, boolean disabled)

      指定されたプロパティ値で SelectItem インスタンスを構築します。escape プロパティは true に設定されます。

      パラメーター:
      value - このアイテムがユーザーによって選択された場合にモデルに配信される値
      label - レスポンスでこのアイテムに対してレンダリングされるラベル
      description - このアイテムの説明、ツールで使用
      disabled - このオプションが無効であることを示すフラグ
    • SelectItem

      public SelectItem(ObjectSE value, StringSE label, StringSE description, boolean disabled, boolean escape)

      指定されたプロパティ値で SelectItem インスタンスを構築します。

      パラメーター:
      value - このアイテムがユーザーによって選択された場合にモデルに配信される値
      label - レスポンスでこのアイテムに対してレンダリングされるラベル
      description - このアイテムの説明、ツールで使用
      disabled - このオプションが無効であることを示すフラグ
      escape - このオプションのテキストをレンダリングするときにエスケープする必要があることを示すフラグ。
      導入:
      1.2
    • SelectItem

      public SelectItem(ObjectSE value, StringSE label, StringSE description, boolean disabled, boolean escape, boolean noSelectionOption)

      指定されたプロパティ値で SelectItem インスタンスを構築します。

      パラメーター:
      value - このアイテムがユーザーによって選択された場合にモデルに配信される値
      label - レスポンスでこのアイテムに対してレンダリングされるラベル
      description - このアイテムの説明、ツールで使用
      disabled - このオプションが無効であることを示すフラグ
      escape - このオプションのテキストをレンダリングするときにエスケープする必要があることを示すフラグ。
      noSelectionOption - 現在のオプションが「選択なし」オプションであることを示すフラグ
      導入:
      1.2
  • メソッドの詳細

    • getDescription

      public StringSE getDescription()

      開発ツールで使用するために、このアイテムの説明を返します。

      戻り値:
      このアイテムの説明、開発ツールで使用
    • setDescription

      public void setDescription(StringSE description)

      開発ツールで使用するために、このアイテムの説明を設定します。

      パラメーター:
      description - 新しい説明
    • isDisabled

      public boolean isDisabled()

      このアイテムの無効化フラグを返します。true に設定されている場合、レンダリングされた出力を変更して、ユーザーがこのアイテムを選択できないようにする必要があります。

      戻り値:
      このアイテムの無効フラグ
    • setDisabled

      public void setDisabled(boolean disabled)

      このアイテムの無効化フラグを設定します。これにより、レンダリングされた出力が変更され、true に設定されている場合、ユーザーがこのアイテムを選択できなくなります。

      パラメーター:
      disabled - 新しい無効化フラグ
    • getLabel

      public StringSE getLabel()

      このアイテムのラベルを返し、ユーザーに表示されます。

      戻り値:
      このアイテムのラベル
    • setLabel

      public void setLabel(StringSE label)

      このアイテムのラベルを設定して、ユーザーに表示されるようにします。

      パラメーター:
      label - 新しいラベル
    • getValue

      public ObjectSE getValue()

      このアイテムがユーザーによって選択された場合にモデルに配信されるように、このアイテムの値を返します。

      戻り値:
      このアイテムの値
    • setValue

      public void setValue(ObjectSE value)

      このユーザーがこのアイテムを選択した場合にモデルに配信されるように、このアイテムの値を設定します。

      パラメーター:
      value - 新しい価値
    • isEscape

      public boolean isEscape()

      これが true を返す場合に限り、この選択項目をレンダリングするコードは、レンダリングされるコンテンツ型に適切なエスケープ構文を使用してラベルをエスケープする必要があります。

      戻り値:
      エスケープ値。
      導入:
      2.0
    • setEscape

      public void setEscape(boolean escape)

      エスケーププロパティの値を設定します。isEscape() を参照してください。

      パラメーター:
      escape - エスケーププロパティの新しい値
      導入:
      2.0
    • isNoSelectionOption

      public boolean isNoSelectionOption()

      noSelectionOption プロパティの値を返します。このプロパティの値が true の場合、システムはこの SelectItem インスタンスによって表されるオプションを「選択なし」オプションを表すものとして解釈します。使用方法については、UISelectOne.validateValue(jakarta.faces.context.FacesContext, java.lang.Object) および UISelectMany.validateValue(jakarta.faces.context.FacesContext, java.lang.Object) を参照してください。

      戻り値:
      noSelectionOption プロパティの値
      導入:
      2.0
    • setNoSelectionOption

      public void setNoSelectionOption(boolean noSelectionOption)

      noSelectionOption プロパティの値を設定します。

      パラメーター:
      noSelectionOption - noSelectionOption プロパティの新しい値
      導入:
      2.0