001/* FontUIResource.java
002   Copyright (C) 2002, 2003 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.plaf;
040
041import java.awt.Font;
042
043
044/**
045 * A font that is marked as <code>UIResource</code>, which
046 * indicates that it has been installed by a pluggable
047 * LookAndFeel. Such dimensions are replaced when the LookAndFeel
048 * changes.
049 *
050 * @author Andrew Selkirk (aselkirk@sympatico.ca)
051 * @author Sascha Brawer (brawer@dandelis.ch)
052 */
053public class FontUIResource extends Font implements UIResource
054{
055  /**
056   * Constructs a new <code>FontUIResource</code> given
057   * the name, style and size of the font.
058   *
059   * @param name the name of the font. A number of
060   *        &#x201c;logical&#x201d; names are supported by any Java
061   *        implementation. These are
062   *        <code>&#x201c;Dialog&#x201d;</code>,
063   *        <code>&#x201c;DialogInput&#x201d;</code>,
064   *        <code>&#x201c;Monospaced&#x201d;</code>,
065   *        <code>&#x201c;Serif&#x201d;</code>, and
066   *        <code>&#x201c;SansSerif&#x201d;</code>.
067   *
068   * @param style the style of the font, for instance {@link
069   *        java.awt.Font#BOLD} or {@link java.awt.Font#PLAIN}.
070   *
071   * @param size the size of the font in typographic points, for
072   *        instance 10, 12 or 13. Designers of LookAndFeels should be
073   *        aware that some languages (like Japanese and Chinese) have
074   *        glyphs that are too complex to be legible at small point
075   *        sizes.
076   */
077  public FontUIResource(String name, int style, int size)
078  {
079    super(name, style, size);
080  }
081
082
083  /**
084   * Constructs a new <code>FontUIResource</code> given
085   * an existing font.
086   *
087   * @param f the font that serves as a template.
088   */
089  public FontUIResource(Font f)
090  {
091    /* This implementation will get rid of many font properties,
092     * such as skewing, values of multiple master design axes,
093     * etc.,  unless they get encoded into the name.  It probably
094     * is not a problem for LookAndFeels because user interfaces
095     * are usually not very advanced with respect to typography.
096     */
097    super(f.getName(), f.getStyle(), f.getSize());
098  }
099}