クラス UIImportConstants
- java.lang.ObjectSE
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIImportConstants
- 実装されたすべてのインターフェース:
PartialStateHolder
、StateHolder
、TransientStateHolder
、ComponentSystemEventListener
、FacesListener
、SystemEventListenerHolder
、EventListenerSE
public class UIImportConstants extends UIComponentBase
UIImportConstants は、現在のビューで指定された型のすべての定数フィールド値のマッピングをインポートします。
ViewDeclarationLanguage
実装では、<f:metadata />
要素内に配置された<f:importConstants />
要素が出現するたびに、このコンポーネントのインスタンスをビューに配置する必要があります。ユーザーは、<f:metadata />
をUIViewRoot
の直接の子として配置する必要があります。ViewMetadata.createMetadataView(jakarta.faces.context.FacesContext)
は、定数をインポートする実際のタスクを処理する必要があります。このクラスのインスタンスは、Ajax リクエストを含め、通常の Jakarta Faces ライフサイクルに参加します。
このコンポーネントの目的は、現在のビューで指定された型のすべての定数フィールド値のマッピングを提供することです。定数フィールド値は、指定された型のすべての
public static final
フィールドです。マップキーは、定数フィールド名をString
として表します。マップ値は、実際の定数フィールド値を表します。これは、クラス、インターフェース、列挙型で機能します。使用方法
以下の定数フィールド:
package com.example; public class Foo { public static final String FOO1 = "foo1"; public static final String FOO2 = "foo2"; }
package com.example; public interface Bar { public static final String BAR1 = "bar1"; public static final String BAR2 = "bar2"; }
package com.example; public enum Baz { BAZ1, BAZ2; }
以下のようにインポートできます。
<f:metadata> <f:importConstants type="com.example.Foo" /> <f:importConstants type="com.example.Bar" var="Barrr" /> <f:importConstants type="com.example.Baz" /> </f:metadata>
そして、以下のように参照することができます:
#{Foo.FOO1}, #{Foo.FOO2}, #{Barrr.BAR1}, #{Barrr.BAR2}, #{Baz.BAZ1}, #{Baz.BAZ2}
<h:selectOneMenu value="#{bean.baz}" > <f:selectItems value="#{Baz}" /> </h:selectOneMenu>
- 導入:
- 2.3
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static StringSE
COMPONENT_FAMILY
このコンポーネントの標準コンポーネントファミリ。static StringSE
COMPONENT_TYPE
このコンポーネントの標準コンポーネント型。クラス jakarta.faces.component.UIComponent から継承されたフィールド
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
コンストラクターのサマリー
コンストラクター コンストラクター 説明 UIImportConstants()
レンダラー型をnull
に設定して新しいUIImportConstants
インスタンスを作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 StringSE
getFamily()
このコンポーネントが属するコンポーネントファミリの識別子を返します。StringSE
getType()
定数フィールド値をインポートする型の完全修飾名を返します。StringSE
getVar()
定数がマップとして公開されるリクエストスコープ属性の名前を返します。void
setType(StringSE type)
定数フィールド値をインポートする型の完全修飾名を設定します。void
setValueExpression(StringSE name, ValueExpression binding)
指定された属性またはプロパティ名がある場合は、その値の計算に使用されるValueExpression
を設定します。void
setVar(StringSE var)
定数がマップとして公開されるリクエストスコープ属性の名前を設定します。クラス 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, visitTree
コンストラクターの詳細
UIImportConstants
public UIImportConstants()
レンダラー型を
null
に設定して新しいUIImportConstants
インスタンスを作成します。
メソッドの詳細
getFamily
public StringSE getFamily()
クラスからコピーされた説明:UIComponent
このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、
rendererType
プロパティの値と組み合わせて、このコンポーネントインスタンスに適切なRenderer
を選択するために使用できます。このメソッドはnull
を返すべきではないことに注意してください- 次で指定:
- クラス
UIComponent
のgetFamily
- 戻り値:
- コンポーネントファミリ(null 以外)。
getType
public StringSE getType()
定数フィールド値をインポートする型の完全修飾名を返します。
- 戻り値:
- 定数フィールド値をインポートする型の完全修飾名。
setType
public void setType(StringSE type)
定数フィールド値をインポートする型の完全修飾名を設定します。
- パラメーター:
type
- 定数フィールド値をインポートする型の完全修飾名。
getVar
public StringSE getVar()
定数がマップとして公開されるリクエストスコープ属性の名前を返します。
- 戻り値:
- 定数がマップとして公開されるリクエストスコープ属性の名前。
setVar
public void setVar(StringSE var)
定数がマップとして公開されるリクエストスコープ属性の名前を設定します。
- パラメーター:
var
- 定数がマップとして公開されるリクエストスコープ属性の名前。
setValueExpression
public void setValueExpression(StringSE name, ValueExpression binding)
指定された属性またはプロパティ名(存在する場合)の値を計算するために使用される
ValueExpression
を設定します。var
プロパティにValueExpression
が設定されている場合は、不正な引数の例外をスローします。- オーバーライド:
- クラス
UIComponent
のsetValueExpression
- パラメーター:
name
-ValueExpression
を設定する属性またはプロパティの名前binding
- 設定するValueExpression
、または現在設定されているValueExpression
を削除するnull
- 例外:
IllegalArgumentExceptionSE
-name
がid
、parent
、var
のいずれかである場合。NullPointerExceptionSE
-name
がnull
の場合。