View Javadoc

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 javax.faces.component.html;
20  
21  import javax.faces.component.UIMessages;
22  
23  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
24  
25  /**
26   * Renders all or some FacesMessages depending on the "for" and
27   * "globalOnly" attributes.
28   *
29   * <ul>
30   * <li>If globalOnly = true, only global messages, that have no
31   * associated clientId, will be displayed.</li>
32   * <li>else if there is a "for" attribute, only messages that are
33   * assigned to the component referenced by the "for" attribute
34   * are displayed.</li>
35   * <li>else all messages are displayed.</li>
36   * </ul>
37   */
38  @JSFComponent
39  (name = "h:messages",
40  clazz = "javax.faces.component.html.HtmlMessages",template=true,
41  tagClass = "org.apache.myfaces.taglib.html.HtmlMessagesTag",
42  defaultRendererType = "javax.faces.Messages"
43  )
44  abstract class _HtmlMessages extends UIMessages implements _StyleProperties, 
45  _MessageProperties, _UniversalProperties
46  {
47  
48    static public final String COMPONENT_FAMILY =
49      "javax.faces.Messages";
50    static public final String COMPONENT_TYPE =
51      "javax.faces.HtmlMessages";
52  
53    /**
54     * The layout: "table" or "list". Default: list
55     * 
56     * @JSFProperty
57     *   defaultValue = "list"
58     */
59    public abstract String getLayout();
60    
61  }