1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
package org.apache.myfaces.shared_impl.renderkit.html; |
20 | |
|
21 | |
import java.io.IOException; |
22 | |
import java.util.Iterator; |
23 | |
import java.util.Map; |
24 | |
|
25 | |
import javax.faces.application.FacesMessage; |
26 | |
import javax.faces.component.UIComponent; |
27 | |
import javax.faces.component.UIMessage; |
28 | |
import javax.faces.component.UIViewRoot; |
29 | |
import javax.faces.component.html.HtmlMessage; |
30 | |
import javax.faces.context.FacesContext; |
31 | |
import javax.faces.context.ResponseWriter; |
32 | |
|
33 | |
import org.apache.commons.logging.Log; |
34 | |
import org.apache.commons.logging.LogFactory; |
35 | |
import org.apache.myfaces.shared_impl.renderkit.JSFAttr; |
36 | |
import org.apache.myfaces.shared_impl.renderkit.RendererUtils; |
37 | |
import org.apache.myfaces.shared_impl.renderkit.html.HTML; |
38 | |
|
39 | |
|
40 | |
|
41 | |
|
42 | |
|
43 | 0 | public abstract class HtmlMessageRendererBase |
44 | |
extends HtmlRenderer |
45 | |
{ |
46 | 0 | private static final Log log = LogFactory.getLog(HtmlMessageRendererBase.class); |
47 | |
|
48 | |
protected abstract String getSummary(FacesContext facesContext, |
49 | |
UIComponent message, |
50 | |
FacesMessage facesMessage, |
51 | |
String msgClientId); |
52 | |
|
53 | |
protected abstract String getDetail(FacesContext facesContext, |
54 | |
UIComponent message, |
55 | |
FacesMessage facesMessage, |
56 | |
String msgClientId); |
57 | |
|
58 | |
|
59 | |
protected void renderMessage(FacesContext facesContext, |
60 | |
UIComponent message) |
61 | |
throws IOException |
62 | |
{ |
63 | 0 | renderMessage(facesContext, message, false); |
64 | 0 | } |
65 | |
|
66 | |
|
67 | |
|
68 | |
|
69 | |
|
70 | |
|
71 | |
protected void renderMessage(FacesContext facesContext, UIComponent message, boolean alwaysRenderSpan) throws IOException |
72 | |
{ |
73 | 0 | String forAttr = getFor(message); |
74 | 0 | if (forAttr == null) |
75 | |
{ |
76 | 0 | log.error("Attribute 'for' of UIMessage must not be null"); |
77 | 0 | return; |
78 | |
} |
79 | |
|
80 | 0 | UIComponent forComponent = message.findComponent(forAttr); |
81 | 0 | if (forComponent == null) |
82 | |
{ |
83 | 0 | log.error("Could not render Message. Unable to find component '" + forAttr + "' (calling findComponent on component '" + message.getClientId(facesContext) + "'). If the provided id was correct, wrap the message and its component into an h:panelGroup or h:panelGrid."); |
84 | 0 | return; |
85 | |
} |
86 | |
|
87 | 0 | String clientId = forComponent.getClientId(facesContext); |
88 | |
|
89 | 0 | Iterator messageIterator = facesContext.getMessages(clientId); |
90 | 0 | if (!messageIterator.hasNext()) |
91 | |
{ |
92 | |
|
93 | 0 | if (alwaysRenderSpan) |
94 | |
{ |
95 | |
|
96 | 0 | ResponseWriter writer = facesContext.getResponseWriter(); |
97 | 0 | writer.startElement(HTML.SPAN_ELEM, message); |
98 | 0 | writer.writeAttribute(HTML.ID_ATTR, message.getId(), null); |
99 | 0 | writer.endElement(HTML.SPAN_ELEM); |
100 | |
} |
101 | 0 | return; |
102 | |
} |
103 | |
|
104 | |
|
105 | 0 | FacesMessage facesMessage = (FacesMessage) messageIterator.next(); |
106 | |
|
107 | |
|
108 | 0 | renderSingleFacesMessage(facesContext, message, facesMessage, clientId); |
109 | 0 | } |
110 | |
|
111 | |
|
112 | |
protected void renderSingleFacesMessage(FacesContext facesContext, |
113 | |
UIComponent message, |
114 | |
FacesMessage facesMessage, |
115 | |
String messageClientId) |
116 | |
throws IOException |
117 | |
{ |
118 | 0 | renderSingleFacesMessage(facesContext, message, facesMessage, messageClientId,true); |
119 | 0 | } |
120 | |
|
121 | |
protected void renderSingleFacesMessage(FacesContext facesContext, |
122 | |
UIComponent message, |
123 | |
FacesMessage facesMessage, |
124 | |
String messageClientId, |
125 | |
boolean renderId) |
126 | |
throws IOException |
127 | |
{ |
128 | 0 | renderSingleFacesMessage(facesContext, message, facesMessage, messageClientId, renderId, true); |
129 | 0 | } |
130 | |
|
131 | |
protected void renderSingleFacesMessage(FacesContext facesContext, |
132 | |
UIComponent message, |
133 | |
FacesMessage facesMessage, |
134 | |
String messageClientId, |
135 | |
boolean renderId, |
136 | |
boolean renderStyleAndStyleClass) |
137 | |
throws IOException |
138 | |
{ |
139 | |
|
140 | 0 | String[] styleAndClass = HtmlMessageRendererBase.getStyleAndStyleClass(message, facesMessage.getSeverity()); |
141 | 0 | String style = styleAndClass[0]; |
142 | 0 | String styleClass = styleAndClass[1]; |
143 | |
|
144 | 0 | String summary = getSummary(facesContext, message, facesMessage, messageClientId); |
145 | 0 | String detail = getDetail(facesContext, message, facesMessage, messageClientId); |
146 | |
|
147 | 0 | String title = getTitle(message); |
148 | 0 | boolean tooltip = isTooltip(message); |
149 | |
|
150 | 0 | if (title == null && tooltip) |
151 | |
{ |
152 | 0 | title = summary; |
153 | |
} |
154 | |
|
155 | 0 | ResponseWriter writer = facesContext.getResponseWriter(); |
156 | |
|
157 | 0 | boolean span = false; |
158 | |
|
159 | |
|
160 | 0 | if (message.getId() != null && !message.getId().startsWith(UIViewRoot.UNIQUE_ID_PREFIX)) |
161 | |
{ |
162 | 0 | span = true; |
163 | |
|
164 | 0 | writer.startElement(HTML.SPAN_ELEM, message); |
165 | |
|
166 | 0 | if (renderId) |
167 | |
{ |
168 | 0 | HtmlRendererUtils.writeIdIfNecessary(writer, message, facesContext); |
169 | |
} |
170 | |
|
171 | 0 | HtmlRendererUtils.renderHTMLAttributes(writer, message, HTML.MESSAGE_PASSTHROUGH_ATTRIBUTES_WITHOUT_TITLE_STYLE_AND_STYLE_CLASS); |
172 | |
} |
173 | |
else |
174 | |
{ |
175 | 0 | span = HtmlRendererUtils.renderHTMLAttributesWithOptionalStartElement( |
176 | |
writer, message, HTML.SPAN_ELEM, HTML.MESSAGE_PASSTHROUGH_ATTRIBUTES_WITHOUT_TITLE_STYLE_AND_STYLE_CLASS); |
177 | |
} |
178 | |
|
179 | 0 | span |= HtmlRendererUtils.renderHTMLAttributeWithOptionalStartElement(writer, message, HTML.SPAN_ELEM, HTML.TITLE_ATTR, title, span); |
180 | 0 | if (renderStyleAndStyleClass) |
181 | |
{ |
182 | 0 | span |= HtmlRendererUtils.renderHTMLAttributeWithOptionalStartElement(writer, message, HTML.SPAN_ELEM, HTML.STYLE_ATTR, style, span); |
183 | 0 | span |= HtmlRendererUtils.renderHTMLAttributeWithOptionalStartElement(writer, message, HTML.SPAN_ELEM, HTML.STYLE_CLASS_ATTR, styleClass, span); |
184 | |
} |
185 | |
|
186 | |
|
187 | 0 | boolean showSummary = isShowSummary(message) && (summary != null); |
188 | 0 | boolean showDetail = isShowDetail(message) && (detail != null); |
189 | |
|
190 | 0 | if (showSummary && !(title == null && tooltip)) |
191 | |
{ |
192 | 0 | writer.writeText(summary, null); |
193 | 0 | if (showDetail) |
194 | |
{ |
195 | 0 | writer.writeText(" ", null); |
196 | |
} |
197 | |
} |
198 | |
|
199 | 0 | if (showDetail) |
200 | |
{ |
201 | 0 | writer.writeText(detail, null); |
202 | |
} |
203 | |
|
204 | 0 | if (span) |
205 | |
{ |
206 | 0 | writer.endElement(org.apache.myfaces.shared_impl.renderkit.html.HTML.SPAN_ELEM); |
207 | |
} |
208 | 0 | } |
209 | |
|
210 | |
|
211 | |
public static String[] getStyleAndStyleClass(UIComponent message, |
212 | |
FacesMessage.Severity severity) |
213 | |
{ |
214 | 0 | String style = null; |
215 | 0 | String styleClass = null; |
216 | 0 | if (message instanceof HtmlMessage) |
217 | |
{ |
218 | 0 | if (severity == FacesMessage.SEVERITY_INFO) |
219 | |
{ |
220 | 0 | style = ((HtmlMessage) message).getInfoStyle(); |
221 | 0 | styleClass = ((HtmlMessage) message).getInfoClass(); |
222 | |
} |
223 | 0 | else if (severity == FacesMessage.SEVERITY_WARN) |
224 | |
{ |
225 | 0 | style = ((HtmlMessage) message).getWarnStyle(); |
226 | 0 | styleClass = ((HtmlMessage) message).getWarnClass(); |
227 | |
} |
228 | 0 | else if (severity == FacesMessage.SEVERITY_ERROR) |
229 | |
{ |
230 | 0 | style = ((HtmlMessage) message).getErrorStyle(); |
231 | 0 | styleClass = ((HtmlMessage) message).getErrorClass(); |
232 | |
} |
233 | 0 | else if (severity == FacesMessage.SEVERITY_FATAL) |
234 | |
{ |
235 | 0 | style = ((HtmlMessage) message).getFatalStyle(); |
236 | 0 | styleClass = ((HtmlMessage) message).getFatalClass(); |
237 | |
} |
238 | |
|
239 | 0 | if (style == null) |
240 | |
{ |
241 | 0 | style = ((HtmlMessage) message).getStyle(); |
242 | |
} |
243 | |
|
244 | 0 | if (styleClass == null) |
245 | |
{ |
246 | 0 | styleClass = ((HtmlMessage) message).getStyleClass(); |
247 | |
} |
248 | |
} |
249 | |
else |
250 | |
{ |
251 | 0 | Map attr = message.getAttributes(); |
252 | 0 | if (severity == FacesMessage.SEVERITY_INFO) |
253 | |
{ |
254 | 0 | style = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.INFO_STYLE_ATTR); |
255 | 0 | styleClass = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.INFO_CLASS_ATTR); |
256 | |
} |
257 | 0 | else if (severity == FacesMessage.SEVERITY_WARN) |
258 | |
{ |
259 | 0 | style = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.WARN_STYLE_ATTR); |
260 | 0 | styleClass = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.WARN_CLASS_ATTR); |
261 | |
} |
262 | 0 | else if (severity == FacesMessage.SEVERITY_ERROR) |
263 | |
{ |
264 | 0 | style = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.ERROR_STYLE_ATTR); |
265 | 0 | styleClass = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.ERROR_CLASS_ATTR); |
266 | |
} |
267 | 0 | else if (severity == FacesMessage.SEVERITY_FATAL) |
268 | |
{ |
269 | 0 | style = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.FATAL_STYLE_ATTR); |
270 | 0 | styleClass = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.FATAL_CLASS_ATTR); |
271 | |
} |
272 | |
|
273 | 0 | if (style == null) |
274 | |
{ |
275 | 0 | style = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.STYLE_ATTR); |
276 | |
} |
277 | |
|
278 | 0 | if (styleClass == null) |
279 | |
{ |
280 | 0 | styleClass = (String) attr.get(org.apache.myfaces.shared_impl.renderkit.JSFAttr.STYLE_CLASS_ATTR); |
281 | |
} |
282 | |
} |
283 | |
|
284 | 0 | return new String[]{style, styleClass}; |
285 | |
} |
286 | |
|
287 | |
protected String getFor(UIComponent component) |
288 | |
{ |
289 | 0 | if (component instanceof UIMessage) |
290 | |
{ |
291 | 0 | return ((UIMessage) component).getFor(); |
292 | |
} |
293 | |
|
294 | 0 | return (String) component.getAttributes().get(JSFAttr.FOR_ATTR); |
295 | |
|
296 | |
} |
297 | |
|
298 | |
protected String getTitle(UIComponent component) |
299 | |
{ |
300 | 0 | if (component instanceof HtmlMessage) |
301 | |
{ |
302 | 0 | return ((HtmlMessage) component).getTitle(); |
303 | |
} |
304 | |
|
305 | 0 | return (String) component.getAttributes().get(JSFAttr.TITLE_ATTR); |
306 | |
|
307 | |
} |
308 | |
|
309 | |
protected boolean isTooltip(UIComponent component) |
310 | |
{ |
311 | 0 | if (component instanceof HtmlMessage) |
312 | |
{ |
313 | 0 | return ((HtmlMessage) component).isTooltip(); |
314 | |
} |
315 | |
|
316 | 0 | return org.apache.myfaces.shared_impl.renderkit.RendererUtils.getBooleanAttribute(component, org.apache.myfaces.shared_impl.renderkit.JSFAttr.TOOLTIP_ATTR, false); |
317 | |
|
318 | |
} |
319 | |
|
320 | |
protected boolean isShowSummary(UIComponent component) |
321 | |
{ |
322 | 0 | if (component instanceof UIMessage) |
323 | |
{ |
324 | 0 | return ((UIMessage) component).isShowSummary(); |
325 | |
} |
326 | |
|
327 | 0 | return org.apache.myfaces.shared_impl.renderkit.RendererUtils.getBooleanAttribute(component, org.apache.myfaces.shared_impl.renderkit.JSFAttr.SHOW_SUMMARY_ATTR, false); |
328 | |
|
329 | |
} |
330 | |
|
331 | |
protected boolean isShowDetail(UIComponent component) |
332 | |
{ |
333 | 0 | if (component instanceof UIMessage) |
334 | |
{ |
335 | 0 | return ((UIMessage) component).isShowDetail(); |
336 | |
} |
337 | |
|
338 | 0 | return RendererUtils.getBooleanAttribute(component, org.apache.myfaces.shared_impl.renderkit.JSFAttr.SHOW_DETAIL_ATTR, false); |
339 | |
|
340 | |
} |
341 | |
|
342 | |
} |