パッケージ jakarta.faces.component

クラス UINamingContainer

java.lang.ObjectSE
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UINamingContainer
実装されているすべてのインターフェース:
NamingContainer、PartialStateHolder、StateHolder、TransientStateHolder、UniqueIdVendor、ComponentSystemEventListener、FacesListener、SystemEventListenerHolder、EventListenerSE
public class UINamingContainer extends UIComponentBase implements NamingContainer, UniqueIdVendor, StateHolder

UINamingContainer は、NamingContainer 機能を実装するコンポーネントの便利な基本クラスです。

  • フィールドの詳細

    • COMPONENT_TYPE

      public static final StringSE COMPONENT_TYPE

      このコンポーネントの標準コンポーネント型。

      関連事項:

    • COMPONENT_FAMILY

      public static final StringSE COMPONENT_FAMILY

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

      関連事項:

    • SEPARATOR_CHAR_PARAM_NAME

      public static final StringSE SEPARATOR_CHAR_PARAM_NAME

      clientId 文字列の区切り文字を Web アプリケーションごとに設定できるようにするコンテキストパラメーター。

      導入:
      2.0
      関連事項:

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

    • UINamingContainer

      public UINamingContainer()

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

  • メソッドの詳細

    • getFamily

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

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

      次で指定:
      クラス UIComponent の getFamily 
      戻り値:
      コンポーネントファミリ（null 以外）。

    • getSeparatorChar

      public static char getSeparatorChar(FacesContext context)

      clientId のセグメントを区切るために使用される文字を返します。実装では、シンボリック定数 SEPARATOR_CHAR_PARAM_NAME の値によって指定された値を持つ <context-param> があるかどうかを判断する必要があります。このパラメーターに値がある場合は、値の最初の文字がこのメソッドから返される必要があります。それ以外の場合は、シンボリック定数 NamingContainer.SEPARATOR_CHAR の値を返す必要があります。

      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      セパレータ文字。
      導入:
      2.0

    • 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() を呼び出す必要があります。

      オーバーライド:
      クラス UIComponent の visitTree 
      パラメーター:
      context - この訪問の VisitContext 
      callback - 訪問したノードごとに visit メソッドが呼び出される VisitCallback インスタンス
      戻り値:
      ツリーにアクセスする必要がある場合は true、それ以外の場合は false。
      関連事項:

    • createUniqueId

      public StringSE createUniqueId(FacesContext context, StringSE seed)
      インターフェースからコピーされた説明: UniqueIdVendor

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

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