org.apache.myfaces.component.html.ext
Interface MessageProperties

All Known Implementing Classes:

AbstractHtmlMessage, AbstractHtmlMessages

public interface MessageProperties

Since:

1.1.7

Version:

$Revision: 704778 $ $Date: 2008-10-14 23:27:46 -0500 (Tue, 14 Oct 2008) $

Author:

Leonardo Uribe (latest modification by $Author: lu4242 $)

Method Summary

String	getDetailFormat() If present, instead of rendering the message detail, a MessageFormat with this attribute as pattern is created.
String	getSummaryFormat() If present, instead of rendering the message summary, a MessageFormat with this attribute as pattern is created.
boolean	isForceSpan() If set to true, an empty span element is rendered.
boolean	isReplaceIdWithLabel() If present, all occurrences of the id of the component for which the message is rendered will be replaced by the label.
void	setDetailFormat(String detailFormat)
void	setForceSpan(boolean forceSpan)
void	setReplaceIdWithLabel(boolean replaceIdWithLabel)
void	setSummaryFormat(String summaryFormat)

Method Detail

getSummaryFormat

String getSummaryFormat()

If present, instead of rendering the message summary, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message summary as the first argument and the label of the associated component (if any) as the second argument. Example: "{0}:"

setSummaryFormat

void setSummaryFormat(String summaryFormat)

getDetailFormat

String getDetailFormat()

If present, instead of rendering the message detail, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message detail as the first argument and the label of the associated component (if any) as the second argument. Example: "The input in field {1} is wrong: {0}"

setDetailFormat

void setDetailFormat(String detailFormat)

isReplaceIdWithLabel

boolean isReplaceIdWithLabel()

If present, all occurrences of the id of the component for which the message is rendered will be replaced by the label. Default: true.

setReplaceIdWithLabel

void setReplaceIdWithLabel(boolean replaceIdWithLabel)

isForceSpan

boolean isForceSpan()

If set to true, an empty span element is rendered. Useful if there is an inputAjax field and the corresponding error message is displayed there.

setForceSpan

void setForceSpan(boolean forceSpan)