KickJava   Java API By Example, From Geeks To Geeks.

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


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 an WML "a" anchor element. The value of the component is rendered as the value of the "href" attribute. Any child UIParameter components are appended to the String to be output as the value of the "href" attribute as query parameters before rendering. The entire "href" string must be passed through a call to the encodeResourceURL() method of theExternalContext. The name of the UIParameter goes on the left hand side, and the value of the UIParameter on the right hand side. The name and the value must be URLEncoded. Each UIParameter instance is separeted by an ampersand, as dictated in the URL spec. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute.
20  *
21  * @wapfaces.tag
22  * componentFamily="UIOutput"
23  * rendererType="OutputLinkRenderer"
24  * tagName="outputLink"
25  * tagBaseClass="org.apache.myfaces.wap.base.ValueHolderTagBase"
26  * bodyContent="JSP"
27  *
28  * @author <a HREF="mailto:Jiri.Zaloudek@ivancice.cz">Jiri Zaloudek</a> (latest modification by $Author: matzew $)
29  * @version $Revision: 1.1 $ $Date: 2004/12/30 09:37:25 $
30  * $Log: OutputLink.java,v $
31  * Revision 1.1 2004/12/30 09:37:25 matzew
32  * added a new RenderKit for WML. Thanks to Jirí Žaloudek
33  *
34  */
35
36
37 public class OutputLink extends javax.faces.component.UIOutput {
38
39     /**
40      * Defines a text identifying the link.
41      *
42      * @wapfaces.attribute
43      * valueBinding="true"
44      */
45     java.lang.String JavaDoc title;
46         
47     /**
48      * The xml:lang attribute specifies the natural or formal language of an element or its attributes.
49      *
50      * @wapfaces.attribute
51      * valueBinding="true"
52      */
53     java.lang.String JavaDoc xmllang;
54     
55     /**
56      * Space-separated list of style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
57      *
58      * @wapfaces.attribute
59      * valueBinding="true"
60      */
61     java.lang.String JavaDoc styleClass;
62     
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      * Converter instance registered with this component.
94      *
95      * @wapfaces.attribute
96      * abstract="true"
97      * inherit="true"
98      */
99     java.lang.String JavaDoc converter;
100
101     /**
102      * The current value of this component.
103      *
104      * @wapfaces.attribute
105      * inherit="true"
106      * abstract="true"
107      */
108     java.lang.Object JavaDoc value;
109 }
110
Popular Tags