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.component.behavior.ClientBehaviorHolder;
22 import javax.faces.context.FacesContext;
23
24 import org.apache.myfaces.component.EventAware;
25 import org.apache.myfaces.component.ForceIdAware;
26 import org.apache.myfaces.component.UniversalProperties;
27 import org.apache.myfaces.component.UserRoleAware;
28 import org.apache.myfaces.component.UserRoleUtils;
29 import org.apache.myfaces.component.html.util.HtmlComponentUtils;
30
31 /**
32 * MyFaces extension to the standard messages tag: see showInputLabel attribute.
33 *
34 * Unless otherwise specified, all attributes accept static values or EL expressions.
35 *
36 * @JSFComponent
37 * name = "t:messages"
38 * class = "org.apache.myfaces.component.html.ext.HtmlMessages"
39 * tagClass = "org.apache.myfaces.generated.taglib.html.ext.HtmlMessagesTag"
40 * @since 1.1.7
41 * @author Thomas Spiegl (latest modification by $Author: lu4242 $)
42 * @author Manfred Geiler
43 * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (mié, 03 sep 2008) $
44 */
45 public abstract class AbstractHtmlMessages
46 extends javax.faces.component.html.HtmlMessages
47 implements UserRoleAware, MessageProperties, ForceIdAware,
48 EventAware, UniversalProperties,
49 ClientBehaviorHolder
50 {
51 public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlMessages";
52 public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.Messages";
53
54 public String getClientId(FacesContext context)
55 {
56 String clientId = HtmlComponentUtils.getClientId(this, getRenderer(context), context);
57 if (clientId == null)
58 {
59 clientId = super.getClientId(context);
60 }
61
62 return clientId;
63 }
64
65 public boolean isRendered()
66 {
67 if (!UserRoleUtils.isVisibleOnUserRole(this)) return false;
68 return super.isRendered();
69 }
70
71 public boolean getForceSpan(){
72 return isForceSpan();
73 }
74
75 /**
76 * Like summaryFormat, but applies to global messages
77 * (i.e. messages not associated with a component). If no
78 * globalSummaryFormat is given, the summaryFormat is used
79 * for global messages. Example: "{0}:"
80 *
81 * @JSFProperty
82 */
83 public abstract String getGlobalSummaryFormat();
84
85 }