1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.component.html.ext;
20
21 import javax.faces.context.FacesContext;
22
23 import org.apache.myfaces.component.EventAware;
24 import org.apache.myfaces.component.ForceIdAware;
25 import org.apache.myfaces.component.UniversalProperties;
26 import org.apache.myfaces.component.UserRoleAware;
27 import org.apache.myfaces.component.UserRoleUtils;
28 import org.apache.myfaces.component.html.util.HtmlComponentUtils;
29
30 /**
31 * MyFaces extension to the standard messages tag: see showInputLabel attribute.
32 *
33 * Unless otherwise specified, all attributes accept static values or EL expressions.
34 *
35 * @JSFComponent
36 * name = "t:messages"
37 * class = "org.apache.myfaces.component.html.ext.HtmlMessages"
38 * tagClass = "org.apache.myfaces.generated.taglib.html.ext.HtmlMessagesTag"
39 * @since 1.1.7
40 * @author Thomas Spiegl (latest modification by $Author: lu4242 $)
41 * @author Manfred Geiler
42 * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $
43 */
44 public abstract class AbstractHtmlMessages
45 extends javax.faces.component.html.HtmlMessages
46 implements UserRoleAware, MessageProperties, ForceIdAware,
47 EventAware, UniversalProperties
48 {
49 public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlMessages";
50 public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.Messages";
51
52 public String getClientId(FacesContext context)
53 {
54 String clientId = HtmlComponentUtils.getClientId(this, getRenderer(context), context);
55 if (clientId == null)
56 {
57 clientId = super.getClientId(context);
58 }
59
60 return clientId;
61 }
62
63 public boolean isRendered()
64 {
65 if (!UserRoleUtils.isVisibleOnUserRole(this)) return false;
66 return super.isRendered();
67 }
68
69 public boolean getForceSpan(){
70 return isForceSpan();
71 }
72
73 /**
74 * Like summaryFormat, but applies to global messages
75 * (i.e. messages not associated with a component). If no
76 * globalSummaryFormat is given, the summaryFormat is used
77 * for global messages. Example: "{0}:"
78 *
79 * @JSFProperty
80 */
81 public abstract String getGlobalSummaryFormat();
82
83 }