public class UIMessages extends UIComponentBase
このコンポーネントのレンダラーは、FacesContext
からメッセージを取得してユーザーに表示する責任があります。
このコンポーネントは、Messages
レンダラー型をサポートします。
デフォルトでは、rendererType
プロパティを "jakarta.faces.Messages
" に設定する必要があります。この値は、setRendererType()
メソッドを呼び出すことで変更できます。
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | COMPONENT_FAMILY このコンポーネントの標準コンポーネントファミリ。 |
static StringSE | COMPONENT_TYPE このコンポーネントの標準コンポーネント型。 |
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
コンストラクターと説明 |
---|
UIMessages() デフォルトのプロパティ値で新しい UIMessages インスタンスを作成します。 |
修飾子と型 | メソッドと説明 |
---|---|
StringSE | getFamily() このコンポーネントが属するコンポーネントファミリの識別子を返します。 |
StringSE | getFor() このコンポーネントが関連するメッセージを表すコンポーネントのクライアント識別子を返します(存在する場合)。 |
boolean | isGlobalOnly() グローバルメッセージ(つまり、クライアント識別子が関連付けられていないメッセージ)のみをレンダリングするかどうかを示すフラグを返します。 |
boolean | isRedisplay() |
boolean | isShowDetail() 関連するメッセージの detail プロパティを表示するかどうかを示すフラグを返します。 |
boolean | isShowSummary() 関連するメッセージの summary プロパティを表示するかどうかを示すフラグを返します。 |
void | setFor(StringSE newFor) このコンポーネントが関連するメッセージを表すコンポーネントのクライアント識別子を設定します(存在する場合)。 |
void | setGlobalOnly(boolean globalOnly) グローバルメッセージ(つまり、クライアント識別子が関連付けられていないメッセージ)のみをレンダリングするかどうかを示すフラグを設定します。 |
void | setRedisplay(boolean redisplay) 関連するメッセージの detail プロパティを表示するかどうかを示すフラグを設定します。 |
void | setShowDetail(boolean showDetail) 関連するメッセージの detail プロパティを表示するかどうかを示すフラグを設定します。 |
void | setShowSummary(boolean showSummary) 関連するメッセージの summary プロパティを表示するかどうかを示すフラグを設定します。 |
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, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
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
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public UIMessages()
デフォルトのプロパティ値で新しい UIMessages
インスタンスを作成します。
public StringSE getFamily()
UIComponent
このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、rendererType
プロパティの値と組み合わせて、このコンポーネントインスタンスに適切な Renderer
を選択するために使用できます。このメソッドは null
を返すべきではないことに注意してください
UIComponent
の getFamily
public StringSE getFor()
このコンポーネントが関連するメッセージを表すコンポーネントのクライアント識別子を返します(存在する場合)。
public void setFor(StringSE newFor)
このコンポーネントが関連するメッセージを表すコンポーネントのクライアント識別子を設定します(存在する場合)。このプロパティは、メッセージを表示する前に設定する必要があります。
newFor
- 新しいクライアント IDpublic boolean isGlobalOnly()
グローバルメッセージ(つまり、クライアント識別子が関連付けられていないメッセージ)のみをレンダリングするかどうかを示すフラグを返します。優先される "for" プロパティと相互に排他的です。デフォルトは false です。
true
、それ以外の場合は false
。public void setGlobalOnly(boolean globalOnly)
グローバルメッセージ(つまり、クライアント識別子が関連付けられていないメッセージ)のみをレンダリングするかどうかを示すフラグを設定します。
globalOnly
- 新しいフラグ値 public boolean isShowDetail()
関連するメッセージの detail
プロパティを表示するかどうかを示すフラグを返します。デフォルトは false です。
true
、それ以外の場合は false
。public void setShowDetail(boolean showDetail)
関連するメッセージの detail
プロパティを表示するかどうかを示すフラグを設定します。
showDetail
- 新しい旗 public boolean isShowSummary()
関連するメッセージの summary
プロパティを表示するかどうかを示すフラグを返します。デフォルトは true です。
true
、それ以外の場合は false
。public void setShowSummary(boolean showSummary)
関連するメッセージの summary
プロパティを表示するかどうかを示すフラグを設定します。
showSummary
- 新しいフラグ値 public boolean isRedisplay()
UIMessage
インスタンスがすでに処理された FacesMessage
を再表示する必要がある場合は、true
。それ以外の場合は、false
を返します。デフォルトでは、setRedisplay(boolean)
が呼び出されていない場合、このメソッドは常に true
を返します。public void setRedisplay(boolean redisplay)
関連するメッセージの detail
プロパティを表示するかどうかを示すフラグを設定します。
redisplay
- 以前に処理されたメッセージが再表示されるかどうかを示すフラグ Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.