KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Heading.java
69  *
70  * Copyright 1999, 2000, 2001 Jcorporate Ltd.
71  */
72
73 import java.io.PrintWriter JavaDoc;
74
75
76 /**
77  * An HTML Heading item
78  *
79  * @author Michael Nash
80  * @version $Revision: 1.8 $ $Date: 2004/11/17 20:48:18 $
81  */
82 public class Heading
83         extends Text {
84     private int level = 1;
85     private String JavaDoc alignment = ("center");
86     private String JavaDoc thisClass = (this.getClass().getName() + ".");
87
88     /**
89      * Constructor
90      *
91      * @throws HtmlException If the superclass constructor fails
92      */
93     public Heading()
94             throws HtmlException {
95         super();
96     } /* Heading() */
97
98     /**
99      * Constructor
100      * Create the heading with the given name
101      *
102      * @param newString the value for the heading
103      */
104     public Heading(String JavaDoc newString)
105             throws HtmlException {
106         super(newString);
107     } /* Heading(String) */
108
109     /**
110      * Constructor
111      * Create a heading with the given level and given string as contents
112      *
113      * @param newString String for the contents of the heading
114      * @param newLevel Level of the heading
115      * @throws HtmlException If the parameters are invalid
116      */
117     public Heading(String JavaDoc newString, int newLevel)
118             throws HtmlException {
119         super(newString);
120         level = newLevel;
121     } /* Heading(String, int) */
122
123     /**
124      * Constructor
125      * Build a heading object with the given contents and the given style
126      *
127      * @param newString The string for the heading
128      * @param newStyle A style, such as "bold", or "italic"
129      * @throws HtmlException If the parameters are invalid
130      */
131     public Heading(String JavaDoc newString, String JavaDoc newStyle)
132             throws HtmlException {
133         super(newString, newStyle);
134     } /* Heading(String, String) */
135
136     /**
137      * Constructor
138      * Create a heading specifying the contents, style and level
139      *
140      * @param newString String for the contents of the heading
141      * @param newStyle Style of the contents, e.g. "bold", "italic"
142      * @param newLevel Level of the heading
143      * @throws HtmlException If the parameters are invalid
144      */
145     public Heading(String JavaDoc newString, String JavaDoc newStyle, int newLevel)
146             throws HtmlException {
147         super(newString, newStyle);
148         level = newLevel;
149     } /* Heading(String, String, int) */
150
151     /**
152      * Display the heading
153      *
154      * @param out PrintWriter to display
155      * @param depth the number of tabs to indent
156      * @throws HtmlException If the heading cannot be displayed
157      */
158     protected void display(PrintWriter JavaDoc out, int depth)
159             throws HtmlException {
160         this.padWithTabs(out, depth);
161         out.print("<h" + level);
162
163         if (cSSClass != null) {
164             out.print(" class=\"" + cSSClass + "\"");
165         }
166         if (cSSID != null) {
167             out.print(" ID=\"" + cSSID + "\"");
168         }
169
170         out.print(" align=\"" + alignment + "\">");
171         super.display(out, depth + 1);
172         this.padWithTabs(out, depth);
173         out.println("</h" + level + ">");
174         setDisplayed();
175     } /* display(PrintWriter) */
176
177
178     /**
179      * Set the horizontal alignment of the contents of this heading
180      *
181      * @param newAlignment New alignment as a string. Must be "left", "right"
182      * or "center"
183      * @throws HtmlException If the parameter is invalid
184      */
185     public synchronized void setAlignment(String JavaDoc newAlignment)
186             throws HtmlException {
187         String JavaDoc myName = (thisClass + "setAlignment(String)");
188
189         if (newAlignment.equalsIgnoreCase("left")) {
190             alignment = newAlignment;
191         } else if (newAlignment.equalsIgnoreCase("right")) {
192             alignment = newAlignment;
193         } else if (newAlignment.equalsIgnoreCase("center")) {
194             alignment = newAlignment;
195         } else {
196             throw new HtmlException(myName +
197                     ":Alignment must be left, right, or center for '" +
198                     getName() + "'");
199         }
200     } /* setAlignment(String) */
201
202
203 } /* Heading */
204
205 /* Heading */
Popular Tags