Class UIMessages
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIMessages
-
- org.apache.myfaces.tobago.internal.component.AbstractUIMessages
-
- org.apache.myfaces.tobago.component.UIMessages
-
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.component.TransientStateHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,Visual
@Generated("component.stg") public class UIMessages extends AbstractUIMessages implements javax.faces.component.behavior.ClientBehaviorHolder
Renders error/validation messages. UIComponent class, generated from templatecomponent.stgwith classMessagesTagDeclaration.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIMessages
AbstractUIMessages.Item
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIMessages()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()MarkupgetMarkup()IntegergetMaxNumber()Sets the maximum number of messages to show.javax.faces.application.FacesMessage.SeveritygetMaxSeverity()Sets the maximum severity to be shown.javax.faces.application.FacesMessage.SeveritygetMinSeverity()Sets the mininum severity to be shown.OrderBygetOrderBy()Sets the order of the messages.booleanisConfirmation()Has the user to confirm this message?voidrestoreState(javax.faces.context.FacesContext context, Object state)voidsetConfirmation(boolean confirmation)voidsetCustomClass(CustomClass customClass)voidsetMarkup(Markup markup)voidsetMaxNumber(Integer maxNumber)voidsetMaxSeverity(javax.faces.application.FacesMessage.Severity maxSeverity)voidsetMinSeverity(javax.faces.application.FacesMessage.Severity minSeverity)voidsetOrderBy(OrderBy orderBy)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIMessages
createMessageList
-
Methods inherited from class javax.faces.component.UIMessages
getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummary
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjavax.faces.component.UIMessages
-
getMinSeverity
public javax.faces.application.FacesMessage.Severity getMinSeverity()
Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".
Default:info- Specified by:
getMinSeverityin classAbstractUIMessages
-
setMinSeverity
public void setMinSeverity(javax.faces.application.FacesMessage.Severity minSeverity)
-
getMaxNumber
public Integer getMaxNumber()
Sets the maximum number of messages to show.
Default:2147483647- Specified by:
getMaxNumberin classAbstractUIMessages
-
setMaxNumber
public void setMaxNumber(Integer maxNumber)
-
getCustomClass
public CustomClass getCustomClass()
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.- Specified by:
getCustomClassin interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClassin interfaceVisual
-
getOrderBy
public OrderBy getOrderBy()
Sets the order of the messages.
Default:occurrence
Allowed Values:occurrence,severity- Specified by:
getOrderByin classAbstractUIMessages
-
setOrderBy
public void setOrderBy(OrderBy orderBy)
-
isConfirmation
public boolean isConfirmation()
Has the user to confirm this message? This attributes handles the case, if the application wants to warn the user about a problem, and the user has to confirm the message before he/she can continue.
Default:false- Specified by:
isConfirmationin classAbstractUIMessages
-
setConfirmation
public void setConfirmation(boolean confirmation)
-
getMaxSeverity
public javax.faces.application.FacesMessage.Severity getMaxSeverity()
Sets the maximum severity to be shown. E. g. "warn" shows only "warn" and "info". When setting this attribute you usually shoud take care, that you have a second message tag to show the higher severity levels.
Default:fatal- Specified by:
getMaxSeverityin classAbstractUIMessages
-
setMaxSeverity
public void setMaxSeverity(javax.faces.application.FacesMessage.Severity maxSeverity)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIComponentBase
-
-