001/* GraphicAttribute.java 002 Copyright (C) 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 java.awt.font; 040 041import java.awt.Graphics2D; 042import java.awt.geom.Rectangle2D; 043 044/** 045 * This class represents a graphic embedded in text. 046 * 047 * @author Michael Koch 048 * @author Lillian Angel (langel at redhat dot com) 049 */ 050public abstract class GraphicAttribute 051{ 052 public static final int BOTTOM_ALIGNMENT = - 2; 053 public static final int CENTER_BASELINE = 1; 054 public static final int HANGING_BASELINE = 2; 055 public static final int ROMAN_BASELINE = 0; 056 public static final int TOP_ALIGNMENT = - 1; 057 058 private int alignment; 059 060 /** 061 * Constructor. 062 * 063 * @param alignment - the alignment to use for the graphic 064 */ 065 protected GraphicAttribute(int alignment) 066 { 067 if (alignment < BOTTOM_ALIGNMENT || alignment > HANGING_BASELINE) 068 throw new IllegalArgumentException("Invalid alignment"); 069 this.alignment = alignment; 070 } 071 072 /** 073 * Draws the graphic. 074 * 075 * @param graphics - the graphics configuration to use 076 * @param x - the x location 077 * @param y - the y location 078 */ 079 public abstract void draw(Graphics2D graphics, float x, float y); 080 081 /** 082 * Gets the distance from the origin of its graphic to the right side of the 083 * bounds of its graphic. 084 * 085 * @return the advance 086 */ 087 public abstract float getAdvance(); 088 089 /** 090 * Gets the positive distance from the origin of its graphic to the top of 091 * bounds. 092 * 093 * @return the ascent 094 */ 095 public abstract float getAscent(); 096 097 /** 098 * Gets the distance from the origin of its graphic to the bottom of the bounds. 099 * 100 * @return the descent 101 */ 102 public abstract float getDescent(); 103 104 /** 105 * Gets the alignment. 106 * 107 * @return the alignment 108 */ 109 public final int getAlignment() 110 { 111 return alignment; 112 } 113 114 /** 115 * Returns a Rectangle2D that encloses the rendered area. 116 * Default bounds is the rectangle (0, -ascent, advance, ascent+descent). 117 * 118 * @return the bounds of the rendered area 119 */ 120 public Rectangle2D getBounds() 121 { 122 float asc = getAscent(); 123 return new Rectangle2D.Float(0, - asc, getAdvance(), asc + getDescent()); 124 } 125 126 /** 127 * Returns the justification information for this object. 128 * 129 * @return the justification information 130 */ 131 public GlyphJustificationInfo getJustificationInfo() 132 { 133 float adv = getAdvance(); 134 return new GlyphJustificationInfo(adv, false, 2, adv / 3, adv / 3, false, 135 1, 0, 0); 136 } 137}