KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > icesoft > tutorial > CheckedTimeZone


1 /*
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * "The contents of this file are subject to the Mozilla Public License
5  * Version 1.1 (the "License"); you may not use this file except in
6  * compliance with the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
11  * License for the specific language governing rights and limitations under
12  * the License.
13  *
14  * The Original Code is ICEfaces 1.5 open source software code, released
15  * November 5, 2006. The Initial Developer of the Original Code is ICEsoft
16  * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C)
17  * 2004-2006 ICEsoft Technologies Canada, Corp. All Rights Reserved.
18  *
19  * Contributor(s): _____________________.
20  *
21  * Alternatively, the contents of this file may be used under the terms of
22  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"
23  * License), in which case the provisions of the LGPL License are
24  * applicable instead of those above. If you wish to allow use of your
25  * version of this file only under the terms of the LGPL License and not to
26  * allow others to use your version of this file under the MPL, indicate
27  * your decision by deleting the provisions above and replace them with
28  * the notice and other provisions required by the LGPL License. If you do
29  * not delete the provisions above, a recipient may use your version of
30  * this file under either the MPL or the LGPL License."
31  *
32  */
33
34 package com.icesoft.tutorial;
35
36 import java.util.TimeZone JavaDoc;
37
38 /**
39  * Bean holding time zone specific information. Checking a selectBooleanCheckbox
40  * in the UI will cause instances of this class to populate the ArrayList in
41  * <code>TimeZoneBean</code>. That ArrayList is used to create a DataTable of
42  * checked time zones in the UI.
43  */
44 public class CheckedTimeZone {
45
46     /**
47      * Time zone name displayed in the UI. DisplayName is associated with the id
48      * for this CheckedTimeZone.
49      */
50     private String JavaDoc dislayName;
51     /**
52      * {@link TimeZone} id used to identify the time zone. This is the id
53      * returned from <code>interpretId</code> in TimeZoneBean.
54      * <code>interpretId</code> returns a specific location in a timezone so
55      * that daylight time properties can be accessed.
56      */
57     private String JavaDoc id;
58     /**
59      * TimeZoneBean used to access dynamic time.
60      */
61     private TimeZoneBean parent;
62     /**
63      * Time zone uses daylight savings time.
64      */
65     private boolean useDaylightTime;
66     /**
67      * Time zone in daylight savings time.
68      */
69     private boolean inDaylightTime;
70
71     /**
72      * Constructor
73      *
74      * @param displayName Time zone name that is displayed in the UI.
75      * @param id {@link TimeZone} id used to identify the time
76      * zone.
77      * @param useDaylightTime Does time zone use daylight time.
78      * @param inDaylightTime Is time zone currently in daylight time.
79      * @param parent TimeZoneBean instance to access dynamic time in
80      * time zone.
81      */
82     public CheckedTimeZone(String JavaDoc displayName, String JavaDoc id,
83                            boolean useDaylightTime, boolean inDaylightTime,
84                            TimeZoneBean parent) {
85         this.dislayName = displayName;
86         this.id = id;
87         this.useDaylightTime = useDaylightTime;
88         this.inDaylightTime = inDaylightTime;
89         this.parent = parent;
90     }
91
92     /**
93      * Gets the name of this time zone to be displayed in the UI.
94      *
95      * @return String
96      */
97     public String JavaDoc getDisplayName() {
98         return dislayName;
99     }
100
101     /**
102      * Gets the {@link TimeZone} id used to identify this time zone.
103      *
104      * @return String
105      */
106     public String JavaDoc getId() {
107         return id;
108     }
109
110     /**
111      * Gets the dynamic time through the <code>getComputedTime</code> method in
112      * the <code>TimeZoneBean</code>.
113      *
114      * @return String
115      */
116     public String JavaDoc getTime() {
117         TimeZone JavaDoc thisTimeZone = TimeZone.getTimeZone(id);
118         return parent.getComputedTime(thisTimeZone);
119
120     }
121
122     /**
123      * Gets whether or not this time zone uses DayLight time.
124      *
125      * @return Returns the useDaylightTime.
126      */
127     public String JavaDoc getUseDaylightTime() {
128         if (useDaylightTime) {
129             return "Yes";
130         } else {
131             return "No";
132         }
133     }
134
135     /**
136      * Gets the state of DayLight Time in this time zone.
137      *
138      * @return Returns the inDaylightTime.
139      */
140     public String JavaDoc getInDaylightTime() {
141         if (inDaylightTime) {
142             return "Yes";
143         } else {
144             return "No";
145         }
146     }
147 }
148
Popular Tags