KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > html > List


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. 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
8  * are 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
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */

64
65 package com.jcorporate.expresso.services.html;
66
67 /**
68  * List.java
69  *
70  * Copyright 1999, 2000, 2001 Jcorporate Ltd.
71  */

72
73 import java.io.PrintWriter JavaDoc;
74 import java.util.Enumeration JavaDoc;
75
76
77 /**
78  * A list (ordered or unordered)
79  *
80  * @author Michael Nash
81  * @version $Revision: 1.8 $ $Date: 2004/11/17 20:48:18 $
82  */

83 public class List
84         extends HtmlElement {
85     private String JavaDoc thisClass = (this.getClass().getName() + ".");
86     private boolean ordered = false;
87     private String JavaDoc listType = ("");
88
89     /**
90      * Constructor
91      */

92     public List()
93             throws HtmlException {
94         super();
95     } /* List() */
96
97     /**
98      * Constructor
99      *
100      * @param newName the name of the list
101      */

102     public List(String JavaDoc newName)
103             throws HtmlException {
104         super(newName);
105     } /* List(String) */
106
107     /**
108      * Display the list
109      *
110      * @param depth the number of tabs to indent
111      * @param out the output stream
112      */

113     protected synchronized void display(PrintWriter JavaDoc out, int depth)
114             throws HtmlException {
115         String JavaDoc myName = (thisClass + "display(PrintWriter)");
116
117         if (contents.size() == 0) {
118             throw new HtmlException(myName + ":List " + getName() +
119                     " has no contents");
120         }
121         if (ordered) {
122             this.padWithTabs(out, depth);
123             out.print("<ol");
124         } else {
125             this.padWithTabs(out, depth);
126             out.print("<ul");
127         }
128         if (cSSClass != null) {
129             out.print(" class=\"" + cSSClass + "\"");
130         }
131         if (cSSID != null) {
132             out.print(" id=\"" + cSSID + "\"");
133         }
134         if (!listType.equals("")) {
135             out.print(" type=\"" + listType + "\">");
136         } else {
137             out.print(">");
138         }
139
140         HtmlElement oneElement = null;
141
142         for (Enumeration JavaDoc e = contents.elements(); e.hasMoreElements();) {
143             oneElement = (HtmlElement) e.nextElement();
144             oneElement.display(out, depth + 1);
145         }
146         if (ordered) {
147             this.padWithTabs(out, depth);
148             out.print("</ol>");
149         } else {
150             this.padWithTabs(out, depth);
151             out.print("</ul>");
152         }
153
154         setDisplayed();
155     } /* display(PrintWriter) */
156
157
158     /**
159      * Specify if this list is ordered (OL) or unordered (UL)
160      *
161      * @param newOrdered true if OL
162      */

163     public void setOrdered(boolean newOrdered)
164             throws HtmlException {
165         ordered = newOrdered;
166     } /* setOrdered(boolean) */
167
168
169     /**
170      * Set the type argument for the list
171      *
172      * @param newType java.lang.String
173      */

174     public synchronized void setType(String JavaDoc newType)
175             throws HtmlException {
176         listType = newType;
177     } /* setType(String) */
178
179
180 }
181
182 /* List */
Popular Tags