Package org.apache.myfaces.renderkit.html.base

Class HtmlMessageRendererBase

java.lang.Object

jakarta.faces.render.Renderer

org.apache.myfaces.renderkit.html.base.HtmlRenderer

org.apache.myfaces.renderkit.html.base.HtmlMessageRendererBase

Direct Known Subclasses:

HtmlMessageRenderer, HtmlMessagesRendererBase

public abstract class HtmlMessageRendererBase
extends HtmlRenderer

Field Summary

Fields inherited from class jakarta.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor	Description
HtmlMessageRendererBase()

Method Summary

Modifier and Type	Method	Description
protected abstract String	getDetail(FacesContext facesContext, UIComponent message, FacesMessage facesMessage, String msgClientId)
protected String	getFor(UIComponent component)
static String[]	getStyleAndStyleClass(UIComponent message, FacesMessage.Severity severity)
protected abstract String	getSummary(FacesContext facesContext, UIComponent message, FacesMessage facesMessage, String msgClientId)
protected String	getTitle(UIComponent component)
protected boolean	isRedisplay(UIComponent component)
protected boolean	isShowDetail(UIComponent component)
protected boolean	isShowSummary(UIComponent component)
protected boolean	isTooltip(UIComponent component)
protected void	renderMessage(FacesContext facesContext, UIComponent message)
protected void	renderMessage(FacesContext facesContext, UIComponent message, boolean alwaysRenderSpan)
protected void	renderMessage(FacesContext facesContext, UIComponent message, boolean alwaysRenderSpan, boolean renderDivWhenNoMessagesAndIdSet)
protected void	renderSingleFacesMessage(FacesContext facesContext, UIComponent message, FacesMessage facesMessage, String messageClientId)
protected void	renderSingleFacesMessage(FacesContext facesContext, UIComponent message, FacesMessage facesMessage, String messageClientId, boolean renderId)
protected void	renderSingleFacesMessage(FacesContext facesContext, UIComponent message, FacesMessage facesMessage, String messageClientId, boolean renderId, boolean renderStyleAndStyleClass)
protected void	renderSingleFacesMessage(FacesContext facesContext, UIComponent message, FacesMessage facesMessage, String messageClientId, boolean renderId, boolean renderStyleAndStyleClass, boolean wrapSpan)

Methods inherited from class org.apache.myfaces.renderkit.html.base.HtmlRenderer

getActionUrl, getChildCount, getChildren, getClientId, isCommonEventsOptimizationEnabled, isCommonPropertiesOptimizationEnabled, renderId, shouldRenderId

Methods inherited from class jakarta.faces.render.Renderer

convertClientId, decode, encodeBegin, encodeChildren, encodeEnd, getConvertedValue, getRendersChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlMessageRendererBase

public HtmlMessageRendererBase()

Method Detail

getSummary

protected abstract String getSummary(FacesContext facesContext,
                                     UIComponent message,
                                     FacesMessage facesMessage,
                                     String msgClientId)

getDetail

protected abstract String getDetail(FacesContext facesContext,
                                    UIComponent message,
                                    FacesMessage facesMessage,
                                    String msgClientId)

renderMessage

protected void renderMessage(FacesContext facesContext,
                             UIComponent message)
                      throws IOException

Throws:

IOException

renderMessage

protected void renderMessage(FacesContext facesContext,
                             UIComponent message,
                             boolean alwaysRenderSpan)
                      throws IOException

Throws:

IOException

renderMessage

protected void renderMessage(FacesContext facesContext,
                             UIComponent message,
                             boolean alwaysRenderSpan,
                             boolean renderDivWhenNoMessagesAndIdSet)
                      throws IOException

Parameters:

facesContext -

message -

alwaysRenderSpan - if true will render a span even if there is no message

Throws:

IOException

renderSingleFacesMessage

protected void renderSingleFacesMessage(FacesContext facesContext,
                                        UIComponent message,
                                        FacesMessage facesMessage,
                                        String messageClientId)
                                 throws IOException

Throws:

IOException

renderSingleFacesMessage

protected void renderSingleFacesMessage(FacesContext facesContext,
                                        UIComponent message,
                                        FacesMessage facesMessage,
                                        String messageClientId,
                                        boolean renderId)
                                 throws IOException

Throws:

IOException

renderSingleFacesMessage

protected void renderSingleFacesMessage(FacesContext facesContext,
                                        UIComponent message,
                                        FacesMessage facesMessage,
                                        String messageClientId,
                                        boolean renderId,
                                        boolean renderStyleAndStyleClass)
                                 throws IOException

Throws:

IOException

renderSingleFacesMessage

protected void renderSingleFacesMessage(FacesContext facesContext,
                                        UIComponent message,
                                        FacesMessage facesMessage,
                                        String messageClientId,
                                        boolean renderId,
                                        boolean renderStyleAndStyleClass,
                                        boolean wrapSpan)
                                 throws IOException

Throws:

IOException

getStyleAndStyleClass

public static String[] getStyleAndStyleClass(UIComponent message,
                                             FacesMessage.Severity severity)

getFor

protected String getFor(UIComponent component)

getTitle

protected String getTitle(UIComponent component)

isTooltip

protected boolean isTooltip(UIComponent component)

isShowSummary

protected boolean isShowSummary(UIComponent component)

isShowDetail

protected boolean isShowDetail(UIComponent component)

isRedisplay

protected boolean isRedisplay(UIComponent component)