KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tigris > scarab > util > OptionModel


1 package org.tigris.scarab.util;
2
3 /* ================================================================
4  * Copyright (c) 2000-2002 CollabNet. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowlegement: "This product includes
19  * software developed by Collab.Net <http://www.Collab.Net/>."
20  * Alternately, this acknowlegement may appear in the software itself, if
21  * and wherever such third-party acknowlegements normally appear.
22  *
23  * 4. The hosted project names must not be used to endorse or promote
24  * products derived from this software without prior written
25  * permission. For written permission, please contact info@collab.net.
26  *
27  * 5. Products derived from this software may not use the "Tigris" or
28  * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
29  * prior written permission of Collab.Net.
30  *
31  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
32  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
34  * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
37  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
39  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  * ====================================================================
44  *
45  * This software consists of voluntary contributions made by many
46  * individuals on behalf of Collab.Net.
47  */

48
49 /**
50  * A model that provides for an application to present a list of possible
51  * options. Can be used along with a velocity macro to create option tags.
52  *
53  * #macro (option $optionModel)
54  * <option #selected($optionModel.isSelected())
55  * value="$optionModel.Value">$optionModel.Name</option>
56  * #end
57  *
58  * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally</a>
59  * @version $Id: OptionModel.java 7502 2003-03-28 00:02:24Z jon $
60  */

61 public class OptionModel
62 {
63     private String JavaDoc name;
64     private String JavaDoc value;
65     private boolean selected;
66     
67     public OptionModel()
68     {
69     }
70
71     public OptionModel(String JavaDoc value, String JavaDoc name)
72     {
73         this(value, name, false);
74     }
75     
76     public OptionModel(int value, String JavaDoc name)
77     {
78         this(String.valueOf(value), name);
79     }
80
81     public OptionModel(int value, String JavaDoc name, boolean selected)
82     {
83         this(String.valueOf(value), name, selected);
84     }
85
86     public OptionModel(String JavaDoc value, String JavaDoc name, boolean selected)
87     {
88         this.name = name;
89         this.value = value;
90         this.selected = selected;
91     }
92     
93     /**
94      * Get the name which is useful for ui.
95      * @return value of name.
96      */

97     public String JavaDoc getName()
98     {
99         return name;
100     }
101     
102     /**
103      * Set the name which is useful for ui.
104      * @param v Value to assign to name.
105      */

106     public void setName(String JavaDoc v)
107     {
108         this.name = v;
109     }
110     
111     /**
112      * Get the value used by the application.
113      * @return value of value.
114      */

115     public String JavaDoc getValue()
116     {
117         return value;
118     }
119     
120     /**
121      * Set the value used by the application.
122      * @param v Value to assign to value.
123      */

124     public void setValue(String JavaDoc v)
125     {
126         this.value = v;
127     }
128     
129     /**
130      * Get the value of selected.
131      * @return value of selected.
132      */

133     public boolean isSelected()
134     {
135         return selected;
136     }
137     
138     /**
139      * Set the value of selected.
140      * @param v Value to assign to selected.
141      */

142     public void setSelected(boolean v)
143     {
144         this.selected = v;
145     }
146 }
147
Popular Tags