KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > swixml > converters > FontConverter


1 /*--
2  $Id: FontConverter.java,v 1.1 2004/03/01 07:55:59 wolfpaulus Exp $
3
4  Copyright (C) 2003-2004 Wolf Paulus.
5  All rights reserved.
6
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions
9  are met:
10
11  1. Redistributions of source code must retain the above copyright
12  notice, this list of conditions, and the following disclaimer.
13
14  2. Redistributions in binary form must reproduce the above copyright
15  notice, this list of conditions, and the disclaimer that follows
16  these conditions in the documentation and/or other materials provided
17  with the distribution.
18
19  3. The end-user documentation included with the redistribution,
20  if any, must include the following acknowledgment:
21         "This product includes software developed by the
22          SWIXML Project (http://www.swixml.org/)."
23  Alternately, this acknowledgment may appear in the software itself,
24  if and wherever such third-party acknowledgments normally appear.
25
26  4. The name "Swixml" must not be used to endorse or promote products
27  derived from this software without prior written permission. For
28  written permission, please contact <info_AT_swixml_DOT_org>
29
30  5. Products derived from this software may not be called "Swixml",
31  nor may "Swixml" appear in their name, without prior written
32  permission from the Swixml Project Management.
33
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  DISCLAIMED. IN NO EVENT SHALL THE SWIXML PROJECT OR ITS
38  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
41  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
42  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
44  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
45  SUCH DAMAGE.
46  ====================================================================
47
48  This software consists of voluntary contributions made by many
49  individuals on behalf of the Swixml Project and was originally
50  created by Wolf Paulus <wolf_AT_swixml_DOT_org>. For more information
51  on the Swixml Project, please see <http://www.swixml.org/>.
52 */
53 package org.swixml.converters;
54
55 import org.jdom.Attribute;
56 import org.swixml.Converter;
57 import org.swixml.Localizer;
58
59 import java.awt.*;
60
61 /**********************************************************************
62  * This file contains proprietary information of Cardiff Software, Inc.
63  * Copying or reproduction without prior written approval is prohibited.
64  * Copyright (c) 2000-2003
65  * User: wpaulus
66  * Date: Jan 31, 2003
67  * Time: 4:31:08 PM
68  **********************************************************************/
69
70 /**
71  * The FontConverter class defines / describes
72  *
73  *
74  *
75  * @author <a HREF="mailto:wolf@paulus.com">Wolf Paulus</a>
76  * @version $Revision: 1.1 $
77  *
78  * @since LiquidOffice 3.0
79  */
80 public class FontConverter implements Converter {
81   /** converter's return type */
82   public static final Class JavaDoc TEMPLATE = Color.class;
83
84
85   /**
86    * Convert the value of the given <code>Attribute</code> object into an output object of the
87    * specified type.
88    * Returns the <code>Font</code> that the <code>str</code>
89    * argument describes.
90    * To ensure that this method returns the desired Font,
91    * format the <code>str</code> parameter in
92    * one of two ways:
93    * <p>
94    * "fontfamilyname-style-pointsize" or <br>
95    * "fontfamilyname style pointsize"<p>
96    * in which <i>style</i> is one of the three
97    * case-insensitive strings:
98    * <code>"BOLD"</code>, <code>"BOLDITALIC"</code>, or
99    * <code>"ITALIC"</code>, and pointsize is a decimal
100    * representation of the point size.
101    * For example, if you want a font that is Arial, bold, and
102    * a point size of 18, you would call this method with:
103    * "Arial-BOLD-18".
104    * <p>
105    * The default size is 12 and the default style is PLAIN.
106    * If you don't specify a valid size, the returned
107    * <code>Font</code> has a size of 12. If you don't specify
108    * a valid style, the returned Font has a style of PLAIN.
109    * If you do not provide a valid font family name in
110    * the <code>str</code> argument, this method still returns
111    * a valid font with a family name of "dialog".
112    * To determine what font family names are available on
113    * your system, use the
114    * {@link GraphicsEnvironment#getAvailableFontFamilyNames()} method.
115    * If <code>str</code> is <code>null</code>, a new <code>Font</code>
116    * is returned with the family name "dialog", a size of 12 and a
117    * PLAIN style.
118    If <code>str</code> is <code>null</code>,
119    * a new <code>Font</code> is returned with the name "dialog", a
120    * size of 12 and a PLAIN style.
121    *
122    * @param type <code>Class</code> Data type to which the Attribute's value should be converted
123    * @param attr <code>Attribute</code> the attribute, providing the value to be converted.
124    * @return the <code>Font</code> object that <code>str</code>
125    * describes, or a new default <code>Font</code> if
126    * <code>str</code> is <code>null</code>.
127    */
128   public Object JavaDoc convert( Class JavaDoc type, Attribute attr, Localizer localizer ) throws Exception JavaDoc {
129     Font font = null;
130     if (attr != null) {
131       font = Font.decode( attr.getValue() );
132     }
133     return font;
134
135   }
136
137   /**
138    * A <code>Converters</code> conversTo method informs about the Class type the converter
139    * is returning when its <code>convert</code> method is called
140    * @return <code>Class</code> - the Class the converter is returning when its convert method is called
141    */
142   public Class JavaDoc convertsTo() {
143     return TEMPLATE;
144   }
145 }
146
Popular Tags