KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
37  * Bean holding time zone specific information.
38  * Checking a selectBooleanCheckbox in the UI will cause instances of this class
39  * to populate the checkedTimeZoneList ArrayList in <code>TimeZoneBean</code>.
40  * That ArrayList is used to create a DataTable of checked time zones in the UI.
41  */
42
43 import java.awt.*;
44 import java.util.TimeZone JavaDoc;
45
46 public class TimeZoneWrapper {
47
48     /**
49      * {@link TimeZone} id used to identify the time zone. This id can be passed
50      * to <code>TimeZone.getTimeZone(String)</code>, to get the appropriate
51      * {@link TimeZone} object.
52      */
53     private String JavaDoc id;
54
55     /**
56      * The component id of the commandButton, in the map UI, corresponding to
57      * this time zone.
58      */
59     private String JavaDoc mapCommandButtonId;
60
61     /**
62      * The Polygon object of each Time Zone on the Image map
63      */
64     private Polygon mapPolygon;
65
66     /**
67      * @param id id used to identify the time zone.
68      * @param mapId map button component id in web page.
69      * @param xCoords array of X-coordinates for the image map object.
70      * @param yCoords array of Y-coordinates for the image map object.
71      * @param coords number of corrdinates in the imagem map object.
72      */
73     public TimeZoneWrapper(String JavaDoc id, String JavaDoc mapId, int[] xCoords,
74                            int[] yCoords, int coords) {
75         this.id = id;
76         this.mapCommandButtonId = mapId;
77         mapPolygon = new Polygon(xCoords, yCoords, coords);
78     }
79
80     /**
81      * Gets the {@link TimeZone} id used to identify this time zone in the Java
82      * code.
83      *
84      * @return String
85      */
86     public String JavaDoc getId() {
87         return id;
88     }
89
90     /**
91      * Ascertains whether mapCommandButtonId is a part of componentId.
92      * componentId might be a fully qualified id, with a prefix corresponding to
93      * container component(s).
94      *
95      * @param componentId Id of some component that may be related to this time
96      * zone
97      * @return true if mapCommandButtonId is a part of componentId, false
98      * otherwise.
99      */
100     public boolean isRelevantComponentId(String JavaDoc componentId) {
101         return componentId.endsWith(mapCommandButtonId);
102     }
103
104     /**
105      * Gets the component id of the commandButton, in the map UI, corresponding
106      * to this time zone.
107      *
108      * @return componentId of command button.
109      */
110     public String JavaDoc getMapCommandButtonId() {
111         return mapCommandButtonId;
112     }
113
114     /**
115      * Gets the Polygon object that represents the Time Zone on the image map.
116      *
117      * @return polygon object representing the image map for this timezone.
118      */
119     public Polygon getMapPolygon() {
120         return mapPolygon;
121     }
122 }
123
Popular Tags