home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1996 May / PCW596.iso / wtest / clico / sunsoft / java / solaris.lzh / SOLARIS.TAZ / SOLARIS / hotjava / classsrc / awt / FontMetrics.java < prev    next >
Encoding:
Java Source  |  1995-05-15  |  4.1 KB  |  113 lines
  1. /*
  2.  * @(#)FontMetrics.java    1.2 95/04/10 Jim Graham
  3.  *
  4.  * Copyright (c) 1994 Sun Microsystems, Inc. All Rights Reserved.
  5.  *
  6.  * Permission to use, copy, modify, and distribute this software
  7.  * and its documentation for NON-COMMERCIAL purposes and without
  8.  * fee is hereby granted provided that this copyright notice
  9.  * appears in all copies. Please refer to the file "copyright.html"
  10.  * for further important copyright and licensing information.
  11.  *
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
  13.  * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
  14.  * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  15.  * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR
  16.  * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
  17.  * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
  18.  */
  19. package awt;
  20.  
  21. import java.lang.*;
  22. import awt.*;
  23.  
  24. /** A font metrics object.
  25.  * @version 1.2 10 Apr 1995
  26.  * @author Jim Graham
  27.  */
  28. public class FontMetrics {
  29.     public int widths[];
  30.  
  31.     /** The font for which these metrics are valid. */
  32.     Font        font;
  33.  
  34.     /** The standard ascent of the font.  This is the logical height
  35.      * above the baseline for the Alphanumeric characters and should
  36.      * be used for determining line spacing.  Note, however, that some
  37.      * characters in the font may extend above this height.
  38.      */
  39.     public int        ascent;
  40.  
  41.     /** The standard descent of the font.  This is the logical height
  42.      * below the baseline for the Alphanumeric characters and should
  43.      * be used for determining line spacing.  Note, however, that some
  44.      * characters in the font may extend below this height.
  45.      */
  46.     public int        descent;
  47.  
  48.     /** The standard leading for the font.  This is the logical amount
  49.      * of space to be reserved between the descent of one line of text
  50.      * and the ascent of the next line.  The height metric is calculated
  51.      * to include this extra space.
  52.      */
  53.     public int        leading;
  54.  
  55.     /** The standard height of a line of text in this font.  This is
  56.      * the distance between the baseline of adjacent lines of text.
  57.      * It is the sum of the ascent+descent+leading.  There is no
  58.      * guarantee that lines of text spaced at this distance will be
  59.      * disjoint; such lines may overlap if some characters overshoot
  60.      * the standard ascent and descent metrics.
  61.      */
  62.     public int        height;
  63.  
  64.     /** The maximum ascent for all characters in this font.  No character
  65.      * will extend further above the baseline than this metric.
  66.      */
  67.     public int        maxAscent;
  68.  
  69.     /** The maximum descent for all characters in this font.  No character
  70.      * will descend further below the baseline than this metric.
  71.      */
  72.     public int        maxDescent;
  73.  
  74.     /** The maximum possible height of a line of text in this font.
  75.      * Adjacent lines of text spaced this distance apart will be
  76.      * guaranteed not to overlap.  Note, however, that many paragraphs
  77.      * that contain ordinary alphanumeric text may look too widely
  78.      * spaced if this metric is used to determine line spacing.  The
  79.      * height field should be preferred unless the text in a given
  80.      * line contains particularly tall characters.
  81.      */
  82.     public int        maxHeight;
  83.  
  84.     /** The maximum advance width of any character in this font. */
  85.     public int        maxAdvance;
  86.  
  87.     /**
  88.      * Store the Font object and rely on the subclass constructors to
  89.      * calculate the metrics.
  90.      */
  91.     FontMetrics(Font f) {
  92.     font = f;
  93.     }
  94.  
  95.     /** Convert this object to a string representation. */
  96.     public String toString() {
  97.     return getClass().getName() + "[font=" + font + ", ascent=" +
  98.         ascent + ", descent=" + descent + ", height=" + height + "]";
  99.     }
  100.  
  101.     /** Return the width of the specified character in this Font. */
  102.     public abstract int charWidth(int ch);
  103.  
  104.     /** Return the width of the specified string in this Font. */
  105.     public abstract int stringWidth(String s);
  106.  
  107.     /** Return the width of the specified char[] in this Font. */
  108.     public abstract int charsWidth(char data[], int off, int len);
  109.  
  110.     /** Return the width of the specified byte[] in this Font. */
  111.     public abstract int bytesWidth(byte data[], int off, int len);
  112. }
  113.