/*--
 $Id: FontConverter.java,v 1.1 2004/03/01 07:55:59 wolfpaulus Exp $

 Copyright (C) 2003-2007 Wolf Paulus.
 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 disclaimer that follows
 these conditions 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 the
         SWIXML Project (http://www.swixml.org/)."
 Alternately, this acknowledgment may appear in the software itself,
 if and wherever such third-party acknowledgments normally appear.

 4. The name "Swixml" must not be used to endorse or promote products
 derived from this software without prior written permission. For
 written permission, please contact <info_AT_swixml_DOT_org>

 5. Products derived from this software may not be called "Swixml",
 nor may "Swixml" appear in their name, without prior written
 permission from the Swixml Project Management.

 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 THE SWIXML PROJECT 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 Swixml Project and was originally
 created by Wolf Paulus <wolf_AT_swixml_DOT_org>. For more information
 on the Swixml Project, please see <http://www.swixml.org/>.
*/
package org.swixml.converters;

import org.swixml.Attribute;
import org.swixml.Converter;
import org.swixml.Localizer;

import java.awt.*;

/**
 * The FontConverter class defines / describes
 *
 * @author <a href="mailto:wolf@wolfpaulus.com">Wolf Paulus</a>
 * @version $Revision: 1.1 $
 * @since swixml 1.0
 */
public class FontConverter implements Converter {
  /**
   * converter's return type
   */
  public static final Class TEMPLATE = Font.class;

  /**
   * Convert the value of the given <code>Attribute</code> object into an output object of the
   * specified type.
   * Returns the <code>Font</code> that the <code>str</code>
   * argument describes.
   * To ensure that this method returns the desired Font,
   * format the <code>str</code> parameter in
   * one of two ways:
   * <p/>
   * "fontfamilyname-style-pointsize" or <br>
   * "fontfamilyname style pointsize"<p>
   * in which <i>style</i> is one of the three
   * case-insensitive strings:
   * <code>"BOLD"</code>, <code>"BOLDITALIC"</code>, or
   * <code>"ITALIC"</code>, and pointsize is a decimal
   * representation of the point size.
   * For example, if you want a font that is Arial, bold, and
   * a point size of 18, you would call this method with:
   * "Arial-BOLD-18".
   * <p/>
   * The default size is 12 and the default style is PLAIN.
   * If you don't specify a valid size, the returned
   * <code>Font</code> has a size of 12.  If you don't specify
   * a valid style, the returned Font has a style of PLAIN.
   * If you do not provide a valid font family name in
   * the <code>str</code> argument, this method still returns
   * a valid font with a family name of "dialog".
   * To determine what font family names are available on
   * your system, use the
   * {@link GraphicsEnvironment#getAvailableFontFamilyNames()} method.
   * If <code>str</code> is <code>null</code>, a new <code>Font</code>
   * is returned with the family name "dialog", a size of 12 and a
   * PLAIN style.
   * If <code>str</code> is <code>null</code>,
   * a new <code>Font</code> is returned with the name "dialog", a
   * size of 12 and a PLAIN style.
   *
   * @param type <code>Class</code> Data type to which the Attribute's value should be converted
   * @param attr <code>Attribute</code> the attribute, providing the value to be converted.
   * @return the <code>Font</code> object that <code>str</code>
   *         describes, or a new default <code>Font</code> if
   *         <code>str</code> is <code>null</code>.
   */
  public Object convert(Class type, Attribute attr, Localizer localizer) throws Exception {
    return attr != null ? Font.decode(attr.getValue()) : null;
  }

  /**
   * A <code>Converters</code> conversTo method informs about the Class type the converter
   * is returning when its <code>convert</code> method is called
   *
   * @return <code>Class</code> - the Class the converter is returning when its convert method is called
   */
  public Class convertsTo() {
    return TEMPLATE;
  }
}
