public class UIMessage extends UIComponentBase
このコンポーネントは、clientId
または最も近い祖先 NamingContainer
に関連するコンポーネント ID によって識別される特定の UIComponent
のメッセージを表示するロールを果たします。コンポーネントは FacesContext
からメッセージを取得します。
デフォルトでは、rendererType
プロパティを "jakarta.faces.Message
" に設定する必要があります。この値は、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
修飾子と型 | メソッドと説明 |
---|---|
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 プロパティを表示するかどうかを示すフラグを設定します。 |
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 UIMessage()
デフォルトのプロパティ値で新しい UIMessage
インスタンスを作成します。
public StringSE getFamily()
UIComponent
このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、rendererType
プロパティの値と組み合わせて、このコンポーネントインスタンスに適切な Renderer
を選択するために使用できます。このメソッドは null
を返すべきではないことに注意してください
UIComponent
の getFamily
public StringSE getFor()
エラーメッセージを表示するコンポーネントの識別子を返します。このコンポーネントがターゲットコンポーネントと同じ NamingContainer 内にある場合、これはコンポーネント識別子である必要があります。それ以外の場合は、絶対コンポーネント識別子( ":" で始まる)である必要があります。詳細については、UIComponent.findComponent(java.lang.String)
を参照してください。
public void setFor(StringSE newFor)
このコンポーネントが関連するメッセージを表すコンポーネントの識別子を設定します(存在する場合)。このプロパティは、メッセージを表示する前に設定する必要があります。
newFor
- 新しいクライアント IDpublic boolean isShowDetail()
関連するメッセージの detail
プロパティを表示するかどうかを示すフラグを返します。デフォルトは true
です。
true
、それ以外の場合は false
。public void setShowDetail(boolean showDetail)
関連するメッセージの detail
プロパティを表示するかどうかを示すフラグを設定します。
showDetail
- 新しい旗 public boolean isShowSummary()
関連するメッセージの summary
プロパティを表示するかどうかを示すフラグを返します。デフォルトは false
です。
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.