/* ====================================================================
* The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
*
* Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by Jcorporate Ltd.
* (http://www.jcorporate.com/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. "Jcorporate" and product names such as "Expresso" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written permission,
* please contact info@jcorporate.com.
*
* 5. Products derived from this software may not be called "Expresso",
* or other Jcorporate product names; nor may "Expresso" or other
* Jcorporate product names appear in their name, without prior
* written permission of Jcorporate Ltd.
*
* 6. No product derived from this software may compete in the same
* market space, i.e. framework, without prior written permission
* of Jcorporate Ltd. For written permission, please contact
* partners@jcorporate.com.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Jcorporate Ltd. Contributions back
* to the project(s) are encouraged when you make modifications.
* Please send them to support@jcorporate.com. For more information
* on Jcorporate Ltd. and its products, please see
* <http://www.jcorporate.com/>.
*
* Portions of this software are based upon other open source
* products and are subject to their respective licenses.
*/
package com.jcorporate.expresso.services.html;
/**
* Heading.java
*
* Copyright 1999, 2000, 2001 Jcorporate Ltd.
*/
import java.io.PrintWriter;
/**
* An HTML Heading item
*
* @author Michael Nash
* @version $Revision: 1.8 $ $Date: 2004/11/17 20:48:18 $
*/
public class Heading
extends Text {
private int level = 1;
private String alignment = ("center");
private String thisClass = (this.getClass().getName() + ".");
/**
* Constructor
*
* @throws HtmlException If the superclass constructor fails
*/
public Heading()
throws HtmlException {
super();
} /* Heading() */
/**
* Constructor
* Create the heading with the given name
*
* @param newString the value for the heading
*/
public Heading(String newString)
throws HtmlException {
super(newString);
} /* Heading(String) */
/**
* Constructor
* Create a heading with the given level and given string as contents
*
* @param newString String for the contents of the heading
* @param newLevel Level of the heading
* @throws HtmlException If the parameters are invalid
*/
public Heading(String newString, int newLevel)
throws HtmlException {
super(newString);
level = newLevel;
} /* Heading(String, int) */
/**
* Constructor
* Build a heading object with the given contents and the given style
*
* @param newString The string for the heading
* @param newStyle A style, such as "bold", or "italic"
* @throws HtmlException If the parameters are invalid
*/
public Heading(String newString, String newStyle)
throws HtmlException {
super(newString, newStyle);
} /* Heading(String, String) */
/**
* Constructor
* Create a heading specifying the contents, style and level
*
* @param newString String for the contents of the heading
* @param newStyle Style of the contents, e.g. "bold", "italic"
* @param newLevel Level of the heading
* @throws HtmlException If the parameters are invalid
*/
public Heading(String newString, String newStyle, int newLevel)
throws HtmlException {
super(newString, newStyle);
level = newLevel;
} /* Heading(String, String, int) */
/**
* Display the heading
*
* @param out PrintWriter to display
* @param depth the number of tabs to indent
* @throws HtmlException If the heading cannot be displayed
*/
protected void display(PrintWriter out, int depth)
throws HtmlException {
this.padWithTabs(out, depth);
out.print("<h" + level);
if (cSSClass != null) {
out.print(" class=\"" + cSSClass + "\"");
}
if (cSSID != null) {
out.print(" ID=\"" + cSSID + "\"");
}
out.print(" align=\"" + alignment + "\">");
super.display(out, depth + 1);
this.padWithTabs(out, depth);
out.println("</h" + level + ">");
setDisplayed();
} /* display(PrintWriter) */
/**
* Set the horizontal alignment of the contents of this heading
*
* @param newAlignment New alignment as a string. Must be "left", "right"
* or "center"
* @throws HtmlException If the parameter is invalid
*/
public synchronized void setAlignment(String newAlignment)
throws HtmlException {
String myName = (thisClass + "setAlignment(String)");
if (newAlignment.equalsIgnoreCase("left")) {
alignment = newAlignment;
} else if (newAlignment.equalsIgnoreCase("right")) {
alignment = newAlignment;
} else if (newAlignment.equalsIgnoreCase("center")) {
alignment = newAlignment;
} else {
throw new HtmlException(myName +
":Alignment must be left, right, or center for '" +
getName() + "'");
}
} /* setAlignment(String) */
} /* Heading */
/* Heading */
|