View Javadoc
1   /*
2    * Copyright (c) 2011-2024 PrimeFaces Extensions
3    *
4    *  Permission is hereby granted, free of charge, to any person obtaining a copy
5    *  of this software and associated documentation files (the "Software"), to deal
6    *  in the Software without restriction, including without limitation the rights
7    *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    *  copies of the Software, and to permit persons to whom the Software is
9    *  furnished to do so, subject to the following conditions:
10   *
11   *  The above copyright notice and this permission notice shall be included in
12   *  all copies or substantial portions of the Software.
13   *
14   *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20   *  THE SOFTWARE.
21   */
22  package org.primefaces.extensions.util;
23  
24  import static org.primefaces.util.MessageFactory.getFormattedText;
25  
26  import java.util.Locale;
27  import java.util.MissingResourceException;
28  import java.util.ResourceBundle;
29  
30  import javax.faces.application.FacesMessage;
31  import javax.faces.component.UIComponent;
32  import javax.faces.context.FacesContext;
33  
34  import org.primefaces.util.LocaleUtils;
35  
36  /**
37   * PrimeFaces Extensions message factory. Delegates as much as possible to {@link org.primefaces.util.MessageFactory}.
38   *
39   * @author Jasper de Vries <jepsar@gmail.com>
40   * @since 7.0
41   */
42  public class MessageFactory {
43  
44      private static final String PF_EXTENSIONS_BUNDLE_BASENAME = "org.primefaces.extensions.Messages";
45      private static final String DEFAULT_DETAIL_SUFFIX = "_detail";
46  
47      private MessageFactory() {
48      }
49  
50      public static FacesMessage getMessage(final String messageId,
51                  final FacesMessage.Severity severity,
52                  final Object... params) {
53          final FacesMessage message = getMessage(LocaleUtils.getCurrentLocale(), messageId, params);
54          message.setSeverity(severity);
55          return message;
56      }
57  
58      public static FacesMessage getMessage(final Locale locale,
59                  final String messageId,
60                  final Object... params) {
61          final FacesMessage message = org.primefaces.util.MessageFactory.getFacesMessage(locale, messageId, params);
62          if (message.getSummary() == null) {
63              populateMessageFromExtensions(message, locale, messageId, params);
64          }
65          return message;
66      }
67  
68      public static Object getLabel(FacesContext facesContext, UIComponent component) {
69          String label = (String) component.getAttributes().get("label");
70  
71          if (label == null) {
72              label = component.getClientId(facesContext);
73          }
74  
75          return label;
76      }
77  
78      private static void populateMessageFromExtensions(final FacesMessage message,
79                  final Locale locale,
80                  final String messageId,
81                  final Object[] params) {
82          final ResourceBundle extensionsBundle = getExtensionsBundle(locale);
83          message.setSummary(getFormattedText(locale, extensionsBundle.getString(messageId), params));
84          try {
85              message.setDetail(getFormattedText(locale, extensionsBundle.getString(messageId + DEFAULT_DETAIL_SUFFIX), params));
86          }
87          catch (final MissingResourceException e) {
88              // NoOp
89          }
90      }
91  
92      private static ResourceBundle getExtensionsBundle(final Locale locale) {
93          return ResourceBundle.getBundle(PF_EXTENSIONS_BUNDLE_BASENAME,
94                      locale,
95                      Thread.currentThread().getContextClassLoader());
96  
97      }
98  
99  }