001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.services.html;
066:
067: import com.jcorporate.expresso.core.misc.StringUtil;
068:
069: import java.io.PrintWriter;
070: import java.util.Enumeration;
071:
072: /**
073: * Cell - The Cell of an HTML table
074: *
075: * @author Michael P. Nash
076: * @version $Revision: 1.8 $ $Date: 2004/11/17 20:48:18 $
077: */
078: public class Cell extends HtmlElement {
079: private String this Class = (this .getClass().getName() + ".");
080: private String alignment = null;
081: private int cellspacing = 0;
082: private int border = 0;
083: private String verticalAlignment = null;
084: private boolean noWrap = true;
085: private int colSpan = 0;
086: private int rowSpan = 0;
087: private String width = null;
088: private boolean isHeaderCell = false;
089: private String bgColor = null;
090: private String fgColor = null;
091:
092: /**
093: * Constructor
094: *
095: * @throws HtmlException If the super constructor fails
096: */
097: public Cell() throws HtmlException {
098: super ();
099: } /* Cell() */
100:
101: /**
102: * Constructor
103: * Create a cell with the given element as it's contents
104: *
105: * @param newElement Another HTML element to appear in the cell
106: * @throws HtmlException If the parameter is invalid
107: */
108: public Cell(HtmlElement newElement) throws HtmlException {
109: super (newElement);
110: } /* Cell(HtmlElement) */
111:
112: /**
113: * Constructor with text contents for the new cell
114: * Create a new cell with the given text as its contents
115: *
116: * @param contentText The text string which becomes the contents
117: * of this new cell
118: * @throws HtmlException If the parameter is invalid
119: */
120: public Cell(String contentText) throws HtmlException {
121: super (contentText);
122: } /* Cell(String) */
123:
124: /**
125: * Display the Cell
126: *
127: * @param out PrintWriter to the client
128: * @param depth the number of tabs to indent
129: * @throws HtmlException If an error occurs displaying the cell or it's
130: * contents
131: */
132: protected synchronized void display(PrintWriter out, int depth)
133: throws HtmlException {
134: String myName = (this Class + "display(PrintWriter)");
135:
136: if (contents.size() == 0) {
137: throw new HtmlException(myName + ":Cell '" + getName()
138: + "' has no contents");
139: }
140:
141: this .padWithTabs(out, depth);
142:
143: if (isHeaderCell) {
144: out.print("<th");
145: } else {
146: out.print("<td");
147: }
148: if (cSSClass != null) {
149: out.print(" class=\"" + cSSClass + "\"");
150: }
151: if (cSSID != null) {
152: out.print(" ID=\"" + cSSID + "\"");
153: }
154: if (!StringUtil.notNull(fgColor).equals("")) {
155: out.print(" color=\"" + fgColor + "\"");
156: }
157: if (!StringUtil.notNull(bgColor).equals("")) {
158: out.print(" bgcolor=\"" + bgColor + "\"");
159: }
160: if (alignment != null) {
161: out.print(" align=\"" + alignment + "\"");
162: }
163: if (verticalAlignment != null) {
164: out.print(" valign=\"" + verticalAlignment + "\"");
165: }
166: if (colSpan > 0) {
167: out.print(" colspan=\"" + colSpan + "\"");
168: }
169: if (rowSpan > 0) {
170: out.print(" rowspan=\"" + rowSpan + "\"");
171: }
172: if (width != null) {
173: out.print(" width=\"" + width + "\"");
174: }
175: if (noWrap) {
176: out.print(" nowrap");
177: }
178:
179: out.println(">");
180:
181: HtmlElement oneElement = null;
182:
183: for (Enumeration e = contents.elements(); e.hasMoreElements();) {
184: oneElement = (HtmlElement) e.nextElement();
185: oneElement.display(out, depth + 1);
186: }
187: if (isHeaderCell) {
188: out.println();
189: this .padWithTabs(out, depth);
190: out.println("</th>");
191: } else {
192: out.println();
193: this .padWithTabs(out, depth);
194: out.println("</td>");
195: }
196:
197: setDisplayed();
198: } /* display(PrintWriter) */
199:
200: /**
201: * Set the horizontal alignment of the contents of this cell
202: *
203: * @param newAlignment New alignment as a string. Must be "left",
204: * "right" or "center"
205: * @throws HtmlException If the parameter is invalid
206: */
207: public synchronized void setAlignment(String newAlignment)
208: throws HtmlException {
209: String myName = (this Class + "setAlignment(String)");
210:
211: if (newAlignment.equalsIgnoreCase("left")) {
212: alignment = newAlignment;
213: } else if (newAlignment.equalsIgnoreCase("right")) {
214: alignment = newAlignment;
215: } else if (newAlignment.equalsIgnoreCase("center")) {
216: alignment = newAlignment;
217: } else {
218: throw new HtmlException(myName
219: + ":Alignment must be left, right, "
220: + "or center for '" + getName() + "'");
221: }
222: } /* setAlignment(String) */
223:
224: /**
225: * Set the background color of the cell
226: *
227: * @param newColor Color to set the background of this cell
228: * @throws HtmlException If the parameter is invalid
229: */
230: public void setBGColor(String newColor) throws HtmlException {
231: bgColor = newColor;
232: } /* setBGColor(String) */
233:
234: /**
235: * Set the border for this cell
236: *
237: * @param newBorder New Border value for this Cell
238: * @throws HtmlException If the parameter is invalid
239: */
240: public synchronized void setBorder(int newBorder)
241: throws HtmlException {
242: border = newBorder;
243: } /* setBorder(int) */
244:
245: /**
246: * Set the cell spacing of this individual cell
247: *
248: * @param newSpacing The new spacing for this cell
249: * @throws HtmlException If the parameter is invalid
250: */
251: public synchronized void setCellSpacing(int newSpacing)
252: throws HtmlException {
253: cellspacing = newSpacing;
254: } /* setCellSpacing(int) */
255:
256: /**
257: * Set how many columns in the table this cell spans. Default is 0
258: *
259: * @param newSpan Number of columns to span
260: * @throws HtmlException If the parameter is invalid
261: */
262: public void setColSpan(int newSpan) throws HtmlException {
263: colSpan = newSpan;
264: } /* setColSpan(int) */
265:
266: /**
267: * Set the foreground color of the cell
268: *
269: * @param newColor Color to set the foreground of this cell
270: * @throws HtmlException If the parameter is invalid
271: */
272: public void setFGColor(String newColor) throws HtmlException {
273: fgColor = newColor;
274: } /* setFGColor(String) */
275:
276: /**
277: * Set the cell to be a header cell
278: *
279: * @param state set to true if header
280: */
281: public void setHeaderCell(boolean state) {
282: isHeaderCell = state;
283: } /* setHeaderCell(boolean) */
284:
285: /**
286: * Tell this cell whether or not to wrap it's contents
287: *
288: * @param newWrap True to wrap contents, else false
289: * @throws HtmlException If the parameter is invalid
290: */
291: public void setNoWrap(boolean newWrap) throws HtmlException {
292: noWrap = newWrap;
293: } /* setNoWrap(boolean) */
294:
295: /**
296: * Set how many rows this Cell spans. Default 0
297: *
298: * @param newSpan Number of rows to span
299: * @throws HtmlException If the parameter is invalid
300: */
301: public void setRowSpan(int newSpan) throws HtmlException {
302: rowSpan = newSpan;
303: } /* setRowSpan(int) */
304:
305: /**
306: * Set the vertical alignment of the contents of the cell
307: *
308: * @param newAlignment Vertical alignment value
309: * @throws HtmlException If the parameter is invalid
310: */
311: public synchronized void setVerticalAlignment(String newAlignment)
312: throws HtmlException {
313: String myName = (this Class + "setVerticalAlignment(String)");
314:
315: if (newAlignment.equalsIgnoreCase("top")) {
316: verticalAlignment = newAlignment;
317: } else if (newAlignment.equalsIgnoreCase("bottom")) {
318: verticalAlignment = newAlignment;
319: } else if (newAlignment.equalsIgnoreCase("center")) {
320: verticalAlignment = newAlignment;
321: } else {
322: throw new HtmlException(myName
323: + ":Verical alignment must be top, "
324: + "bottom, or center for " + getName());
325: }
326: } /* setVerticalAlignment(String) */
327:
328: /**
329: * @param newWidth The width of the cell
330: */
331: public void setWidth(String newWidth) throws HtmlException {
332: width = newWidth;
333: } /* setWidth(String) */
334:
335: } /* Cell */
336:
337: /* Cell */
|