クラス 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
機能を実装するコンポーネントの便利な基本クラスです。
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static StringSE
COMPONENT_FAMILY
このコンポーネントの標準コンポーネントファミリ。static StringSE
COMPONENT_TYPE
このコンポーネントの標準コンポーネント型。static StringSE
SEPARATOR_CHAR_PARAM_NAME
clientId 文字列の区切り文字を Web アプリケーションごとに設定できるようにするコンテキストパラメーター。クラス jakarta.faces.component.UIComponent から継承されたフィールド
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
インターフェース jakarta.faces.component.NamingContainer から継承されたフィールド
SEPARATOR_CHAR
コンストラクターのサマリー
コンストラクター コンストラクター 説明 UINamingContainer()
デフォルトのプロパティ値で新しいUINamingContainer
インスタンスを作成します。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 StringSE
createUniqueId(FacesContext context, StringSE seed)
コンポーネントの識別子を生成します。StringSE
getFamily()
このコンポーネントが属するコンポーネントファミリの識別子を返します。static char
getSeparatorChar(FacesContext context)
clientId のセグメントを区切るために使用される文字を返します。boolean
visitTree(VisitContext context, VisitCallback callback)
ツリー内のこのノードからツリー訪問を実行します。クラス jakarta.faces.component.UIComponentBase から継承されたメソッド
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
クラス jakarta.faces.component.UIComponent から継承されたメソッド
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース jakarta.faces.component.StateHolder から継承されたメソッド
isTransient, restoreState, saveState, setTransient
コンストラクターの詳細
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
。 - 関連事項:
UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)
createUniqueId
public StringSE createUniqueId(FacesContext context, StringSE seed)
インターフェースからコピーされた説明:UniqueIdVendor
コンポーネントの識別子を生成します。識別子の前には UNIQUE_ID_PREFIX が付けられ、このコンポーネントコンテナー内で一意になります。オプションで、生成された一意の ID に含める必要のある一意のシード値をコンポーネントの作成者が提供できます。
- 次で指定:
- インターフェース
UniqueIdVendor
のcreateUniqueId
- パラメーター:
context
- FacesContextseed
- オプションのシード値 - 例 VDL テンプレート内のコンポーネントの位置に基づく- 戻り値:
- このコンポーネントコンテナーの一意の ID