クラス UIOutput
- java.lang.ObjectSE
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIOutput
- 実装されたすべてのインターフェース:
PartialStateHolder
、StateHolder
、TransientStateHolder
、ValueHolder
、ComponentSystemEventListener
、FacesListener
、SystemEventListenerHolder
、EventListenerSE
- 既知の直属サブクラス
HtmlBody
、HtmlDoctype
、HtmlHead
、HtmlOutputFormat
、HtmlOutputLabel
、HtmlOutputLink
、HtmlOutputText
、UIInput
、UIOutcomeTarget
public class UIOutput extends UIComponentBase implements ValueHolder
UIOutput は
UIComponent
であり、オプションで値式を介してモデル層 Bean から取得され、ユーザーに表示されます。ユーザーはレンダリングされた値を直接変更できません。表示のみを目的としています。リクエスト処理ライフサイクルのレスポンスのレンダリングフェーズでは、次の規則に従って、このコンポーネントの現在の値を文字列に変換する必要があります(まだない場合)。
- 現在の値が
null
ではなく、まだString
でない場合、次のように、変換に使用するConverter
(ある場合)を見つけます。 - 現在の値が
null
ではなく、Converter
が見つかった場合、そのgetAsString()
メソッドを呼び出して変換を実行します。 - 現在の値が
null
ではなく、Converter
が見つからなかった場合、現在の値でtoString()
を呼び出して変換を実行します。
デフォルトでは、
rendererType
プロパティを "jakarta.faces.Text
" に設定する必要があります。この値は、setRendererType()
メソッドを呼び出すことで変更できます。
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 void
clearInitialState()
PartialStateHolder
を実装するこのインスタンス上の添付オブジェクトごとに、添付オブジェクトでPartialStateHolder.clearInitialState()
を呼び出します。Converter
getConverter()
このUIComponent
に登録されているConverter
(ある場合)を返します。StringSE
getFamily()
このコンポーネントが属するコンポーネントファミリの識別子を返します。ObjectSE
getLocalValue()
関連するValueExpression
を評価せずに、このUIComponent
のローカル値(存在する場合)を返します。ObjectSE
getValue()
value プロパティを返します。void
markInitialState()
PartialStateHolder.markInitialState()
が呼び出されたときにUIComponentBase
で実行されたアクションに加えて、インストールされたConverter
が PartialStateHolder であるかどうかを確認し、そうであればPartialStateHolder.markInitialState()
を呼び出します。void
resetValue()
このコンポーネントの値を初期化されていない状態にリセットする簡易メソッド。void
restoreState(FacesContext context, ObjectSE state)
state オブジェクトのエントリから状態を復元するために必要な処理を実行します。ObjectSE
saveState(FacesContext context)
インスタンスの状態をSerializable
オブジェクトとして取得します。void
setConverter(Converter converter)
このUIComponent
に登録されているConverter
(ある場合)を設定します。void
setValue(ObjectSE value)
このUIComponent
の値を設定します(ある場合)。クラス jakarta.faces.component.UIComponentBase から継承されたメソッド
addClientBehavior, addFacesListener, broadcast, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, 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, visitTree
コンストラクターの詳細
UIOutput
public UIOutput()
デフォルトのプロパティ値で新しい
UIOutput
インスタンスを作成します。
メソッドの詳細
getFamily
public StringSE getFamily()
クラスからコピーされた説明:UIComponent
このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、
rendererType
プロパティの値と組み合わせて、このコンポーネントインスタンスに適切なRenderer
を選択するために使用できます。このメソッドはnull
を返すべきではないことに注意してください- 次で指定:
- クラス
UIComponent
のgetFamily
- 戻り値:
- コンポーネントファミリ(null 以外)。
getConverter
public Converter getConverter()
インターフェースからコピーされた説明:ValueHolder
この
UIComponent
に登録されているConverter
(ある場合)を返します。- 次で指定:
- インターフェース
ValueHolder
のgetConverter
- 戻り値:
- コンバーター。
setConverter
public void setConverter(Converter converter)
インターフェースからコピーされた説明:ValueHolder
この
UIComponent
に登録されているConverter
(ある場合)を設定します。- 次で指定:
- インターフェース
ValueHolder
のsetConverter
- パラメーター:
converter
- 新しいConverter
(またはnull
)
getLocalValue
public ObjectSE getLocalValue()
インターフェースからコピーされた説明:ValueHolder
関連する
ValueExpression
を評価せずに、このUIComponent
のローカル値(存在する場合)を返します。- 次で指定:
- インターフェース
ValueHolder
のgetLocalValue
- 戻り値:
- ローカル値。
getValue
public ObjectSE getValue()
value プロパティを返します。
- 次で指定:
- インターフェース
ValueHolder
のgetValue
- 戻り値:
- 値。
- 導入:
- 2.2
setValue
public void setValue(ObjectSE value)
インターフェースからコピーされた説明:ValueHolder
この
UIComponent
の値を設定します(ある場合)。- 次で指定:
- インターフェース
ValueHolder
のsetValue
- パラメーター:
value
- 新しいローカル値
resetValue
public void resetValue()
このコンポーネントの値を初期化されていない状態にリセットする簡易メソッド。
- 導入:
- 2.2
markInitialState
public void markInitialState()
PartialStateHolder.markInitialState()
が呼び出されたときにUIComponentBase
で実行されたアクションに加えて、インストールされたConverter
が PartialStateHolder であるかどうかを確認し、そうであればPartialStateHolder.markInitialState()
を呼び出します。- 次で指定:
- インターフェース
PartialStateHolder
のmarkInitialState
- オーバーライド:
- クラス
UIComponentBase
のmarkInitialState
clearInitialState
public void clearInitialState()
クラスからコピーされた説明:UIComponentBase
PartialStateHolder
を実装するこのインスタンス上の添付オブジェクトごとに、添付オブジェクトでPartialStateHolder.clearInitialState()
を呼び出します。- 次で指定:
- インターフェース
PartialStateHolder
のclearInitialState
- オーバーライド:
- クラス
UIComponentBase
のclearInitialState
saveState
public ObjectSE saveState(FacesContext context)
インターフェースからコピーされた説明:StateHolder
インスタンスの状態を
Serializable
オブジェクトとして取得します。このインターフェースを実装するクラスが、StateHolder を実装するインスタンス(イベントハンドラー、バリデーターなどを含む
UIComponent
など)への参照を持っている場合、このメソッドはそれらすべてのインスタンスでStateHolder.saveState(jakarta.faces.context.FacesContext)
メソッドも呼び出す必要があります。このメソッドは、子とファセットの状態を保存してはなりませんそれはStateManager
を介して行われますこのメソッドは、実装オブジェクトの状態を変更してはなりません。つまり、このコードを実行した後:
Object state = component.saveState(facesContext);
component
は、実行前と同じでなければなりません。このメソッドからの戻り値は
Serializable
でなければなりません- 次で指定:
- インターフェース
StateHolder
のsaveState
- オーバーライド:
- クラス
UIComponentBase
のsaveState
- パラメーター:
context
- Faces コンテキスト。- 戻り値:
- 保存された状態。
restoreState
public void restoreState(FacesContext context, ObjectSE state)
インターフェースからコピーされた説明:StateHolder
state オブジェクトのエントリから状態を復元するために必要な処理を実行します。
このインターフェースを実装するクラスが、StateHolder も実装するインスタンスへの参照を持っている場合(イベントハンドラー、バリデーターなどを備えた
UIComponent
など)、このメソッドはそれらすべてのインスタンスでStateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object)
メソッドも呼び出す必要があります。state
引数がnull
の場合、アクションを実行せずに戻ります。- 次で指定:
- インターフェース
StateHolder
のrestoreState
- オーバーライド:
- クラス
UIComponentBase
のrestoreState
- パラメーター:
context
- Faces コンテキスト。state
- 状態。