KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > myfaces > wap > def > Messages


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.myfaces.wap.def;
17
18 /**
19  * Render a single message for a specific component.
20  *
21  * Set-up for Rendering
22  * Obtain the "summary" and "detail" properties fromUIMessage component. If not present, keep the empty string as the value, respectively. Obtain the firstFacesMessage to render from the component, using the "for" property of the UIMessage. This will be the only message we render.
23  *
24  * Rendering
25  * For the message renderer, we only render one row, for the first message. For the messages renderer, we render as many rows as we have messages.
26  *
27  * @wapfaces.tag
28  * componentFamily="UIMessage"
29  * rendererType="MessagesRenderer"
30  * tagName="messages"
31  * tagBaseClass="org.apache.myfaces.wap.base.MessageTagBase"
32  * bodyContent="JSP"
33  *
34  * @author <a HREF="mailto:Jiri.Zaloudek@ivancice.cz">Jiri Zaloudek</a> (latest modification by $Author: matzew $)
35  * @version $Revision: 1.1 $ $Date: 2004/12/30 09:37:25 $
36  * $Log: Messages.java,v $
37  * Revision 1.1 2004/12/30 09:37:25 matzew
38  * added a new RenderKit for WML. Thanks to Jirí Žaloudek
39  *
40  */
41
42
43 public class Messages extends javax.faces.component.UIMessage {
44         
45     /**
46      * Flag indicating that only global messages (that is, messages not associated with any client identifier) are to be displayed.
47      * Default value is "false".
48      *
49      * @wapfaces.attribute
50      * valueBinding="true"
51      * initValue="false"
52      */
53     boolean globalOnly;
54
55     /**
56      * The type of layout markup to use when rendering error messages. Valid values are "table" (an WML table) and "list"
57      * (records disjoin with &lt;br/&gt; element). If not specified, the default value is "list".
58      *
59      * @wapfaces.attribute
60      * valueBinding="true"
61      */
62     java.lang.String JavaDoc layout;
63     
64     // ============= ABSTARACT ATTRIBUTES ======================================
65 /**
66      * The component identifier for the associated component.
67      *
68      * @wapfaces.attribute
69      * abstract="true"
70      * inherit="true"
71      */
72     java.lang.String JavaDoc id;
73     
74     /**
75      * Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
76      *
77      * @wapfaces.attribute
78      * abstract="true"
79      * inherit="true"
80      */
81     boolean rendered;
82         
83     /**
84      * The value binding expression linking this component to a property in a backing bean.
85      *
86      * @wapfaces.attribute
87      * abstract="true"
88      * inherit="true"
89      */
90     java.lang.String JavaDoc binding;
91     
92      /**
93      * Flag indicating whether the summary portion of displayed messages should be included. Default value is "true".
94      *
95      * @wapfaces.attribute
96      * initValue="true"
97      * abstract="true"
98      * inherit="true"
99      */
100     boolean showDetail;
101     
102      /**
103      * Flag indicating whether the summary portion of displayed messages should be included. Default value is "false".
104      *
105      * @wapfaces.attribute
106      * initValue="false"
107      * abstract="true"
108      * inherit="true"
109      */
110     boolean showSummary;
111     
112 }
113
Popular Tags