1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
/* * @(#)GraphicAttribute.java 1.22 06/02/14 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ /* * (C) Copyright Taligent, Inc. 1996 - 1997, All Rights Reserved * (C) Copyright IBM Corp. 1996 - 1998, All Rights Reserved * * The original version of this source code and documentation is * copyrighted and owned by Taligent, Inc., a wholly-owned subsidiary * of IBM. These materials are provided under terms of a License * Agreement between Taligent and Sun. This technology is protected * by multiple US and International patents. * * This notice and attribution to Taligent may not be removed. * Taligent is a registered trademark of Taligent, Inc. * */ package java.awt.font; import java.awt.Graphics2D; import java.awt.Font; import java.awt.Shape; import java.awt.geom.AffineTransform; import java.awt.geom.Rectangle2D; /** * This class is used with the CHAR_REPLACEMENT attribute. * <p> * The <code>GraphicAttribute</code> class represents a graphic embedded * in text. Clients subclass this class to implement their own char * replacement graphics. Clients wishing to embed shapes and images in * text need not subclass this class. Instead, clients can use the * {@link ShapeGraphicAttribute} and {@link ImageGraphicAttribute} * classes. * <p> * Subclasses must ensure that their objects are immutable once they * are constructed. Mutating a <code>GraphicAttribute</code> that * is used in a {@link TextLayout} results in undefined behavior from the * <code>TextLayout</code>. */ public abstract class GraphicAttribute { private int fAlignment; /** * Aligns top of graphic to top of line. */ public static final int TOP_ALIGNMENT = -1; /** * Aligns bottom of graphic to bottom of line. */ public static final int BOTTOM_ALIGNMENT = -2; /** * Aligns origin of graphic to roman baseline of line. */ public static final int ROMAN_BASELINE = Font.ROMAN_BASELINE; /** * Aligns origin of graphic to center baseline of line. */ public static final int CENTER_BASELINE = Font.CENTER_BASELINE; /** * Aligns origin of graphic to hanging baseline of line. */ public static final int HANGING_BASELINE = Font.HANGING_BASELINE; /** * Constructs a <code>GraphicAttribute</code>. * Subclasses use this to define the alignment of the graphic. * @param alignment an int representing one of the * <code>GraphicAttribute</code> alignment fields * @throws IllegalArgumentException if alignment is not one of the * five defined values. */ protected GraphicAttribute(int alignment) { if (alignment < BOTTOM_ALIGNMENT || alignment > HANGING_BASELINE) { throw new IllegalArgumentException("bad alignment"); } fAlignment = alignment; } /** * Returns the ascent of this <code>GraphicAttribute</code>. A * graphic can be rendered above its ascent. * @return the ascent of this <code>GraphicAttribute</code>. * @see #getBounds() */ public abstract float getAscent(); /** * Returns the descent of this <code>GraphicAttribute</code>. A * graphic can be rendered below its descent. * @return the descent of this <code>GraphicAttribute</code>. * @see #getBounds() */ public abstract float getDescent(); /** * Returns the advance of this <code>GraphicAttribute</code>. The * <code>GraphicAttribute</code> object's advance is the distance * from the point at which the graphic is rendered and the point where * the next character or graphic is rendered. A graphic can be * rendered beyond its advance * @return the advance of this <code>GraphicAttribute</code>. * @see #getBounds() */ public abstract float getAdvance(); /** * Returns a {@link Rectangle2D} that encloses all of the * bits drawn by this <code>GraphicAttribute</code> relative to the * rendering position. * A graphic may be rendered beyond its origin, ascent, descent, * or advance; but if it is, this method's implementation must * indicate where the graphic is rendered. * Default bounds is the rectangle (0, -ascent, advance, ascent+descent). * @return a <code>Rectangle2D</code> that encloses all of the bits * rendered by this <code>GraphicAttribute</code>. */ public Rectangle2D getBounds() { float ascent = getAscent(); return new Rectangle2D.Float(0, -ascent, getAdvance(), ascent+getDescent()); } /** * Return a {@link java.awt.Shape} that represents the region that * this <code>GraphicAttribute</code> renders. This is used when a * {@link TextLayout} is requested to return the outline of the text. * The (untransformed) shape must not extend outside the rectangular * bounds returned by <code>getBounds</code>. * The default implementation returns the rectangle returned by * {@link #getBounds}, transformed by the provided {@link AffineTransform} * if present. * @param tx an optional {@link AffineTransform} to apply to the * outline of this <code>GraphicAttribute</code>. This can be null. * @return a <code>Shape</code> representing this graphic attribute, * suitable for stroking or filling. * @since 1.6 */ public Shape getOutline(AffineTransform tx) { Shape b = getBounds(); if (tx != null) { b = tx.createTransformedShape(b); } return b; } /** * Renders this <code>GraphicAttribute</code> at the specified * location. * @param graphics the {@link Graphics2D} into which to render the * graphic * @param x the user-space X coordinate where the graphic is rendered * @param y the user-space Y coordinate where the graphic is rendered */ public abstract void draw(Graphics2D graphics, float x, float y); /** * Returns the alignment of this <code>GraphicAttribute</code>. * Alignment can be to a particular baseline, or to the absolute top * or bottom of a line. * @return the alignment of this <code>GraphicAttribute</code>. */ public final int getAlignment() { return fAlignment; } /** * Returns the justification information for this * <code>GraphicAttribute</code>. Subclasses * can override this method to provide different justification * information. * @return a {@link GlyphJustificationInfo} object that contains the * justification information for this <code>GraphicAttribute</code>. */ public GlyphJustificationInfo getJustificationInfo() { // should we cache this? float advance = getAdvance(); return new GlyphJustificationInfo( advance, // weight false, // growAbsorb 2, // growPriority advance/3, // growLeftLimit advance/3, // growRightLimit false, // shrinkAbsorb 1, // shrinkPriority 0, // shrinkLeftLimit 0); // shrinkRightLimit } }