クラス UIMessage
- java.lang.ObjectSE
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIMessage
- 実装されたすべてのインターフェース:
PartialStateHolder
、StateHolder
、TransientStateHolder
、ComponentSystemEventListener
、FacesListener
、SystemEventListenerHolder
、EventListenerSE
- 既知の直属サブクラス
HtmlMessage
public class UIMessage extends UIComponentBase
このコンポーネントは、
clientId
または最も近い祖先NamingContainer
に関連するコンポーネント ID によって識別される特定のUIComponent
のメッセージを表示するロールを果たします。コンポーネントはFacesContext
からメッセージを取得します。デフォルトでは、
rendererType
プロパティを "jakarta.faces.Message
" に設定する必要があります。この値は、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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 StringSE
getFamily()
このコンポーネントが属するコンポーネントファミリの識別子を返します。StringSE
getFor()
エラーメッセージを表示するコンポーネントの識別子を返します。boolean
isRedisplay()
boolean
isShowDetail()
関連するメッセージのdetail
プロパティを表示するかどうかを示すフラグを返します。boolean
isShowSummary()
関連するメッセージのsummary
プロパティを表示するかどうかを示すフラグを返します。void
setFor(StringSE newFor)
このコンポーネントが関連するメッセージを表すコンポーネントの識別子を設定します(存在する場合)。void
setRedisplay(boolean redisplay)
関連するメッセージのdetail
プロパティを表示するかどうかを示すフラグを設定します。void
setShowDetail(boolean showDetail)
関連するメッセージのdetail
プロパティを表示するかどうかを示すフラグを設定します。void
setShowSummary(boolean showSummary)
関連するメッセージのsummary
プロパティを表示するかどうかを示すフラグを設定します。クラス 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, visitTree
コンストラクターの詳細
UIMessage
public UIMessage()
デフォルトのプロパティ値で新しい
UIMessage
インスタンスを作成します。
メソッドの詳細
getFamily
public StringSE getFamily()
クラスからコピーされた説明:UIComponent
このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、
rendererType
プロパティの値と組み合わせて、このコンポーネントインスタンスに適切なRenderer
を選択するために使用できます。このメソッドはnull
を返すべきではないことに注意してください- 次で指定:
- クラス
UIComponent
のgetFamily
- 戻り値:
- コンポーネントファミリ(null 以外)。
getFor
public StringSE getFor()
エラーメッセージを表示するコンポーネントの識別子を返します。このコンポーネントがターゲットコンポーネントと同じ NamingContainer 内にある場合、これはコンポーネント識別子である必要があります。それ以外の場合は、絶対コンポーネント識別子( ":" で始まる)である必要があります。詳細については、
UIComponent.findComponent(java.lang.String)
を参照してください。- 戻り値:
- for クライアント識別子。
setFor
public void setFor(StringSE newFor)
このコンポーネントが関連するメッセージを表すコンポーネントの識別子を設定します(存在する場合)。このプロパティは、メッセージを表示する前に設定する必要があります。
- パラメーター:
newFor
- 新しいクライアント ID
isShowDetail
public boolean isShowDetail()
関連するメッセージの
detail
プロパティを表示するかどうかを示すフラグを返します。デフォルトはtrue
です。- 戻り値:
- 詳細を表示する場合は
true
、それ以外の場合はfalse
。
setShowDetail
public void setShowDetail(boolean showDetail)
関連するメッセージの
detail
プロパティを表示するかどうかを示すフラグを設定します。- パラメーター:
showDetail
- 新しい旗
isShowSummary
public boolean isShowSummary()
関連するメッセージの
summary
プロパティを表示するかどうかを示すフラグを返します。デフォルトはfalse
です。- 戻り値:
- 要約を表示する場合は
true
、それ以外の場合はfalse
。
setShowSummary
public void setShowSummary(boolean showSummary)
関連するメッセージの
summary
プロパティを表示するかどうかを示すフラグを設定します。- パラメーター:
showSummary
- 新しいフラグ値
isRedisplay
public boolean isRedisplay()
- 戻り値:
- この
UIMessage
インスタンスがすでに処理されたFacesMessage
を再表示する必要がある場合は、true
。それ以外の場合は、false
を返します。デフォルトでは、setRedisplay(boolean)
が呼び出されていない場合、このメソッドは常にtrue
を返します。 - 導入:
- 2.0
setRedisplay
public void setRedisplay(boolean redisplay)
関連するメッセージの
detail
プロパティを表示するかどうかを示すフラグを設定します。- パラメーター:
redisplay
- 以前に処理されたメッセージが再表示されるかどうかを示すフラグ- 導入:
- 2.0