/* |
|
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. |
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
* |
|
* This code is free software; you can redistribute it and/or modify it |
|
* under the terms of the GNU General Public License version 2 only, as |
|
* published by the Free Software Foundation. Oracle designates this |
|
* particular file as subject to the "Classpath" exception as provided |
|
* by Oracle in the LICENSE file that accompanied this code. |
|
* |
|
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
* version 2 for more details (a copy is included in the LICENSE file that |
|
* accompanied this code). |
|
* |
|
* You should have received a copy of the GNU General Public License version |
|
* 2 along with this work; if not, write to the Free Software Foundation, |
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
* |
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
* or visit www.oracle.com if you need additional information or have any |
|
* questions. |
|
*/ |
|
/* |
|
* @author Charlton Innovations, Inc. |
|
*/ |
|
package java.awt.font; |
|
import java.awt.Graphics2D; |
|
import java.awt.Font; |
|
import java.awt.Polygon; // remind - need a floating point version |
|
import java.awt.Rectangle; |
|
import java.awt.geom.Point2D; |
|
import java.awt.geom.Rectangle2D; |
|
import java.awt.geom.AffineTransform; |
|
import java.awt.Shape; |
|
import java.awt.font.GlyphMetrics; |
|
import java.awt.font.GlyphJustificationInfo; |
|
/** |
|
* A <code>GlyphVector</code> object is a collection of glyphs |
|
* containing geometric information for the placement of each glyph |
|
* in a transformed coordinate space which corresponds to the |
|
* device on which the <code>GlyphVector</code> is ultimately |
|
* displayed. |
|
* <p> |
|
* The <code>GlyphVector</code> does not attempt any interpretation of |
|
* the sequence of glyphs it contains. Relationships between adjacent |
|
* glyphs in sequence are solely used to determine the placement of |
|
* the glyphs in the visual coordinate space. |
|
* <p> |
|
* Instances of <code>GlyphVector</code> are created by a {@link Font}. |
|
* <p> |
|
* In a text processing application that can cache intermediate |
|
* representations of text, creation and subsequent caching of a |
|
* <code>GlyphVector</code> for use during rendering is the fastest |
|
* method to present the visual representation of characters to a user. |
|
* <p> |
|
* A <code>GlyphVector</code> is associated with exactly one |
|
* <code>Font</code>, and can provide data useful only in relation to |
|
* this <code>Font</code>. In addition, metrics obtained from a |
|
* <code>GlyphVector</code> are not generally geometrically scaleable |
|
* since the pixelization and spacing are dependent on grid-fitting |
|
* algorithms within a <code>Font</code>. To facilitate accurate |
|
* measurement of a <code>GlyphVector</code> and its component |
|
* glyphs, you must specify a scaling transform, anti-alias mode, and |
|
* fractional metrics mode when creating the <code>GlyphVector</code>. |
|
* These characteristics can be derived from the destination device. |
|
* <p> |
|
* For each glyph in the <code>GlyphVector</code>, you can obtain: |
|
* <ul> |
|
* <li>the position of the glyph |
|
* <li>the transform associated with the glyph |
|
* <li>the metrics of the glyph in the context of the |
|
* <code>GlyphVector</code>. The metrics of the glyph may be |
|
* different under different transforms, application specified |
|
* rendering hints, and the specific instance of the glyph within |
|
* the <code>GlyphVector</code>. |
|
* </ul> |
|
* <p> |
|
* Altering the data used to create the <code>GlyphVector</code> does not |
|
* alter the state of the <code>GlyphVector</code>. |
|
* <p> |
|
* Methods are provided to adjust the positions of the glyphs |
|
* within the <code>GlyphVector</code>. These methods are most |
|
* appropriate for applications that are performing justification |
|
* operations for the presentation of the glyphs. |
|
* <p> |
|
* Methods are provided to transform individual glyphs within the |
|
* <code>GlyphVector</code>. These methods are primarily useful for |
|
* special effects. |
|
* <p> |
|
* Methods are provided to return both the visual, logical, and pixel bounds |
|
* of the entire <code>GlyphVector</code> or of individual glyphs within |
|
* the <code>GlyphVector</code>. |
|
* <p> |
|
* Methods are provided to return a {@link Shape} for the |
|
* <code>GlyphVector</code>, and for individual glyphs within the |
|
* <code>GlyphVector</code>. |
|
* @see Font |
|
* @see GlyphMetrics |
|
* @see TextLayout |
|
* @author Charlton Innovations, Inc. |
|
*/ |
|
public abstract class GlyphVector implements Cloneable { |
|
// |
|
// methods associated with creation-time state |
|
// |
|
/** |
|
* Returns the <code>Font</code> associated with this |
|
* <code>GlyphVector</code>. |
|
* @return <code>Font</code> used to create this |
|
* <code>GlyphVector</code>. |
|
* @see Font |
|
*/ |
|
public abstract Font getFont(); |
|
/** |
|
* Returns the {@link FontRenderContext} associated with this |
|
* <code>GlyphVector</code>. |
|
* @return <code>FontRenderContext</code> used to create this |
|
* <code>GlyphVector</code>. |
|
* @see FontRenderContext |
|
* @see Font |
|
*/ |
|
public abstract FontRenderContext getFontRenderContext(); |
|
// |
|
// methods associated with the GlyphVector as a whole |
|
// |
|
/** |
|
* Assigns default positions to each glyph in this |
|
* <code>GlyphVector</code>. This can destroy information |
|
* generated during initial layout of this <code>GlyphVector</code>. |
|
*/ |
|
public abstract void performDefaultLayout(); |
|
/** |
|
* Returns the number of glyphs in this <code>GlyphVector</code>. |
|
* @return number of glyphs in this <code>GlyphVector</code>. |
|
*/ |
|
public abstract int getNumGlyphs(); |
|
/** |
|
* Returns the glyphcode of the specified glyph. |
|
* This return value is meaningless to anything other |
|
* than the <code>Font</code> object that created this |
|
* <code>GlyphVector</code>. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* that corresponds to the glyph from which to retrieve the |
|
* glyphcode. |
|
* @return the glyphcode of the glyph at the specified |
|
* <code>glyphIndex</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the |
|
* number of glyphs in this <code>GlyphVector</code> |
|
*/ |
|
public abstract int getGlyphCode(int glyphIndex); |
|
/** |
|
* Returns an array of glyphcodes for the specified glyphs. |
|
* The contents of this return value are meaningless to anything other |
|
* than the <code>Font</code> used to create this |
|
* <code>GlyphVector</code>. This method is used |
|
* for convenience and performance when processing glyphcodes. |
|
* If no array is passed in, a new array is created. |
|
* @param beginGlyphIndex the index into this |
|
* <code>GlyphVector</code> at which to start retrieving glyphcodes |
|
* @param numEntries the number of glyphcodes to retrieve |
|
* @param codeReturn the array that receives the glyphcodes and is |
|
* then returned |
|
* @return an array of glyphcodes for the specified glyphs. |
|
* @throws IllegalArgumentException if <code>numEntries</code> is |
|
* less than 0 |
|
* @throws IndexOutOfBoundsException if <code>beginGlyphIndex</code> |
|
* is less than 0 |
|
* @throws IndexOutOfBoundsException if the sum of |
|
* <code>beginGlyphIndex</code> and <code>numEntries</code> is |
|
* greater than the number of glyphs in this |
|
* <code>GlyphVector</code> |
|
*/ |
|
public abstract int[] getGlyphCodes(int beginGlyphIndex, int numEntries, |
|
int[] codeReturn); |
|
/** |
|
* Returns the character index of the specified glyph. |
|
* The character index is the index of the first logical |
|
* character represented by the glyph. The default |
|
* implementation assumes a one-to-one, left-to-right mapping |
|
* of glyphs to characters. |
|
* @param glyphIndex the index of the glyph |
|
* @return the index of the first character represented by the glyph |
|
* @since 1.4 |
|
*/ |
|
public int getGlyphCharIndex(int glyphIndex) { |
|
return glyphIndex; |
|
} |
|
/** |
|
* Returns the character indices of the specified glyphs. |
|
* The character index is the index of the first logical |
|
* character represented by the glyph. Indices are returned |
|
* in glyph order. The default implementation invokes |
|
* getGlyphCharIndex for each glyph, and subclassers will probably |
|
* want to override this implementation for performance reasons. |
|
* Use this method for convenience and performance |
|
* in processing of glyphcodes. If no array is passed in, |
|
* a new array is created. |
|
* @param beginGlyphIndex the index of the first glyph |
|
* @param numEntries the number of glyph indices |
|
* @param codeReturn the array into which to return the character indices |
|
* @return an array of character indices, one per glyph. |
|
* @since 1.4 |
|
*/ |
|
public int[] getGlyphCharIndices(int beginGlyphIndex, int numEntries, |
|
int[] codeReturn) { |
|
if (codeReturn == null) { |
|
codeReturn = new int[numEntries]; |
|
} |
|
for (int i = 0, j = beginGlyphIndex; i < numEntries; ++i, ++j) { |
|
codeReturn[i] = getGlyphCharIndex(j); |
|
} |
|
return codeReturn; |
|
} |
|
/** |
|
* Returns the logical bounds of this <code>GlyphVector</code>. |
|
* This method is used when positioning this <code>GlyphVector</code> |
|
* in relation to visually adjacent <code>GlyphVector</code> objects. |
|
* @return a {@link Rectangle2D} that is the logical bounds of this |
|
* <code>GlyphVector</code>. |
|
*/ |
|
public abstract Rectangle2D getLogicalBounds(); |
|
/** |
|
* Returns the visual bounds of this <code>GlyphVector</code> |
|
* The visual bounds is the bounding box of the outline of this |
|
* <code>GlyphVector</code>. Because of rasterization and |
|
* alignment of pixels, it is possible that this box does not |
|
* enclose all pixels affected by rendering this <code>GlyphVector</code>. |
|
* @return a <code>Rectangle2D</code> that is the bounding box |
|
* of this <code>GlyphVector</code>. |
|
*/ |
|
public abstract Rectangle2D getVisualBounds(); |
|
/** |
|
* Returns the pixel bounds of this <code>GlyphVector</code> when |
|
* rendered in a graphics with the given |
|
* <code>FontRenderContext</code> at the given location. The |
|
* renderFRC need not be the same as the |
|
* <code>FontRenderContext</code> of this |
|
* <code>GlyphVector</code>, and can be null. If it is null, the |
|
* <code>FontRenderContext</code> of this <code>GlyphVector</code> |
|
* is used. The default implementation returns the visual bounds, |
|
* offset to x, y and rounded out to the next integer value (i.e. returns an |
|
* integer rectangle which encloses the visual bounds) and |
|
* ignores the FRC. Subclassers should override this method. |
|
* @param renderFRC the <code>FontRenderContext</code> of the <code>Graphics</code>. |
|
* @param x the x-coordinate at which to render this <code>GlyphVector</code>. |
|
* @param y the y-coordinate at which to render this <code>GlyphVector</code>. |
|
* @return a <code>Rectangle</code> bounding the pixels that would be affected. |
|
* @since 1.4 |
|
*/ |
|
public Rectangle getPixelBounds(FontRenderContext renderFRC, float x, float y) { |
|
Rectangle2D rect = getVisualBounds(); |
|
int l = (int)Math.floor(rect.getX() + x); |
|
int t = (int)Math.floor(rect.getY() + y); |
|
int r = (int)Math.ceil(rect.getMaxX() + x); |
|
int b = (int)Math.ceil(rect.getMaxY() + y); |
|
return new Rectangle(l, t, r - l, b - t); |
|
} |
|
/** |
|
* Returns a <code>Shape</code> whose interior corresponds to the |
|
* visual representation of this <code>GlyphVector</code>. |
|
* @return a <code>Shape</code> that is the outline of this |
|
* <code>GlyphVector</code>. |
|
*/ |
|
public abstract Shape getOutline(); |
|
/** |
|
* Returns a <code>Shape</code> whose interior corresponds to the |
|
* visual representation of this <code>GlyphVector</code> when |
|
* rendered at x, y. |
|
* @param x the X coordinate of this <code>GlyphVector</code>. |
|
* @param y the Y coordinate of this <code>GlyphVector</code>. |
|
* @return a <code>Shape</code> that is the outline of this |
|
* <code>GlyphVector</code> when rendered at the specified |
|
* coordinates. |
|
*/ |
|
public abstract Shape getOutline(float x, float y); |
|
/** |
|
* Returns a <code>Shape</code> whose interior corresponds to the |
|
* visual representation of the specified glyph |
|
* within this <code>GlyphVector</code>. |
|
* The outline returned by this method is positioned around the |
|
* origin of each individual glyph. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* @return a <code>Shape</code> that is the outline of the glyph |
|
* at the specified <code>glyphIndex</code> of this |
|
* <code>GlyphVector</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
*/ |
|
public abstract Shape getGlyphOutline(int glyphIndex); |
|
/** |
|
* Returns a <code>Shape</code> whose interior corresponds to the |
|
* visual representation of the specified glyph |
|
* within this <code>GlyphVector</code>, offset to x, y. |
|
* The outline returned by this method is positioned around the |
|
* origin of each individual glyph. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* @param x the X coordinate of the location of this {@code GlyphVector} |
|
* @param y the Y coordinate of the location of this {@code GlyphVector} |
|
* @return a <code>Shape</code> that is the outline of the glyph |
|
* at the specified <code>glyphIndex</code> of this |
|
* <code>GlyphVector</code> when rendered at the specified |
|
* coordinates. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
* @since 1.4 |
|
*/ |
|
public Shape getGlyphOutline(int glyphIndex, float x, float y) { |
|
Shape s = getGlyphOutline(glyphIndex); |
|
AffineTransform at = AffineTransform.getTranslateInstance(x,y); |
|
return at.createTransformedShape(s); |
|
} |
|
/** |
|
* Returns the position of the specified glyph relative to the |
|
* origin of this <code>GlyphVector</code>. |
|
* If <code>glyphIndex</code> equals the number of of glyphs in |
|
* this <code>GlyphVector</code>, this method returns the position after |
|
* the last glyph. This position is used to define the advance of |
|
* the entire <code>GlyphVector</code>. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* @return a {@link Point2D} object that is the position of the glyph |
|
* at the specified <code>glyphIndex</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than the number of glyphs |
|
* in this <code>GlyphVector</code> |
|
* @see #setGlyphPosition |
|
*/ |
|
public abstract Point2D getGlyphPosition(int glyphIndex); |
|
/** |
|
* Sets the position of the specified glyph within this |
|
* <code>GlyphVector</code>. |
|
* If <code>glyphIndex</code> equals the number of of glyphs in |
|
* this <code>GlyphVector</code>, this method sets the position after |
|
* the last glyph. This position is used to define the advance of |
|
* the entire <code>GlyphVector</code>. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* @param newPos the <code>Point2D</code> at which to position the |
|
* glyph at the specified <code>glyphIndex</code> |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than the number of glyphs |
|
* in this <code>GlyphVector</code> |
|
* @see #getGlyphPosition |
|
*/ |
|
public abstract void setGlyphPosition(int glyphIndex, Point2D newPos); |
|
/** |
|
* Returns the transform of the specified glyph within this |
|
* <code>GlyphVector</code>. The transform is relative to the |
|
* glyph position. If no special transform has been applied, |
|
* <code>null</code> can be returned. A null return indicates |
|
* an identity transform. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* @return an {@link AffineTransform} that is the transform of |
|
* the glyph at the specified <code>glyphIndex</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
* @see #setGlyphTransform |
|
*/ |
|
public abstract AffineTransform getGlyphTransform(int glyphIndex); |
|
/** |
|
* Sets the transform of the specified glyph within this |
|
* <code>GlyphVector</code>. The transform is relative to the glyph |
|
* position. A <code>null</code> argument for <code>newTX</code> |
|
* indicates that no special transform is applied for the specified |
|
* glyph. |
|
* This method can be used to rotate, mirror, translate and scale the |
|
* glyph. Adding a transform can result in significant performance changes. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* @param newTX the new transform of the glyph at <code>glyphIndex</code> |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
* @see #getGlyphTransform |
|
*/ |
|
public abstract void setGlyphTransform(int glyphIndex, AffineTransform newTX); |
|
/** |
|
* Returns flags describing the global state of the GlyphVector. |
|
* Flags not described below are reserved. The default |
|
* implementation returns 0 (meaning false) for the position adjustments, |
|
* transforms, rtl, and complex flags. |
|
* Subclassers should override this method, and make sure |
|
* it correctly describes the GlyphVector and corresponds |
|
* to the results of related calls. |
|
* @return an int containing the flags describing the state |
|
* @see #FLAG_HAS_POSITION_ADJUSTMENTS |
|
* @see #FLAG_HAS_TRANSFORMS |
|
* @see #FLAG_RUN_RTL |
|
* @see #FLAG_COMPLEX_GLYPHS |
|
* @see #FLAG_MASK |
|
* @since 1.4 |
|
*/ |
|
public int getLayoutFlags() { |
|
return 0; |
|
} |
|
/** |
|
* A flag used with getLayoutFlags that indicates that this <code>GlyphVector</code> has |
|
* per-glyph transforms. |
|
* @since 1.4 |
|
*/ |
|
public static final int FLAG_HAS_TRANSFORMS = 1; |
|
/** |
|
* A flag used with getLayoutFlags that indicates that this <code>GlyphVector</code> has |
|
* position adjustments. When this is true, the glyph positions don't match the |
|
* accumulated default advances of the glyphs (for example, if kerning has been done). |
|
* @since 1.4 |
|
*/ |
|
public static final int FLAG_HAS_POSITION_ADJUSTMENTS = 2; |
|
/** |
|
* A flag used with getLayoutFlags that indicates that this <code>GlyphVector</code> has |
|
* a right-to-left run direction. This refers to the glyph-to-char mapping and does |
|
* not imply that the visual locations of the glyphs are necessarily in this order, |
|
* although generally they will be. |
|
* @since 1.4 |
|
*/ |
|
public static final int FLAG_RUN_RTL = 4; |
|
/** |
|
* A flag used with getLayoutFlags that indicates that this <code>GlyphVector</code> has |
|
* a complex glyph-to-char mapping (one that does not map glyphs to chars one-to-one in |
|
* strictly ascending or descending order matching the run direction). |
|
* @since 1.4 |
|
*/ |
|
public static final int FLAG_COMPLEX_GLYPHS = 8; |
|
/** |
|
* A mask for supported flags from getLayoutFlags. Only bits covered by the mask |
|
* should be tested. |
|
* @since 1.4 |
|
*/ |
|
public static final int FLAG_MASK = |
|
FLAG_HAS_TRANSFORMS | |
|
FLAG_HAS_POSITION_ADJUSTMENTS | |
|
FLAG_RUN_RTL | |
|
FLAG_COMPLEX_GLYPHS; |
|
/** |
|
* Returns an array of glyph positions for the specified glyphs. |
|
* This method is used for convenience and performance when |
|
* processing glyph positions. |
|
* If no array is passed in, a new array is created. |
|
* Even numbered array entries beginning with position zero are the X |
|
* coordinates of the glyph numbered <code>beginGlyphIndex + position/2</code>. |
|
* Odd numbered array entries beginning with position one are the Y |
|
* coordinates of the glyph numbered <code>beginGlyphIndex + (position-1)/2</code>. |
|
* If <code>beginGlyphIndex</code> equals the number of of glyphs in |
|
* this <code>GlyphVector</code>, this method gets the position after |
|
* the last glyph and this position is used to define the advance of |
|
* the entire <code>GlyphVector</code>. |
|
* @param beginGlyphIndex the index at which to begin retrieving |
|
* glyph positions |
|
* @param numEntries the number of glyphs to retrieve |
|
* @param positionReturn the array that receives the glyph positions |
|
* and is then returned. |
|
* @return an array of glyph positions specified by |
|
* <code>beginGlyphIndex</code> and <code>numEntries</code>. |
|
* @throws IllegalArgumentException if <code>numEntries</code> is |
|
* less than 0 |
|
* @throws IndexOutOfBoundsException if <code>beginGlyphIndex</code> |
|
* is less than 0 |
|
* @throws IndexOutOfBoundsException if the sum of |
|
* <code>beginGlyphIndex</code> and <code>numEntries</code> |
|
* is greater than the number of glyphs in this |
|
* <code>GlyphVector</code> plus one |
|
*/ |
|
public abstract float[] getGlyphPositions(int beginGlyphIndex, int numEntries, |
|
float[] positionReturn); |
|
/** |
|
* Returns the logical bounds of the specified glyph within this |
|
* <code>GlyphVector</code>. |
|
* These logical bounds have a total of four edges, with two edges |
|
* parallel to the baseline under the glyph's transform and the other two |
|
* edges are shared with adjacent glyphs if they are present. This |
|
* method is useful for hit-testing of the specified glyph, |
|
* positioning of a caret at the leading or trailing edge of a glyph, |
|
* and for drawing a highlight region around the specified glyph. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* that corresponds to the glyph from which to retrieve its logical |
|
* bounds |
|
* @return a <code>Shape</code> that is the logical bounds of the |
|
* glyph at the specified <code>glyphIndex</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
* @see #getGlyphVisualBounds |
|
*/ |
|
public abstract Shape getGlyphLogicalBounds(int glyphIndex); |
|
/** |
|
* Returns the visual bounds of the specified glyph within the |
|
* <code>GlyphVector</code>. |
|
* The bounds returned by this method is positioned around the |
|
* origin of each individual glyph. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* that corresponds to the glyph from which to retrieve its visual |
|
* bounds |
|
* @return a <code>Shape</code> that is the visual bounds of the |
|
* glyph at the specified <code>glyphIndex</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
* @see #getGlyphLogicalBounds |
|
*/ |
|
public abstract Shape getGlyphVisualBounds(int glyphIndex); |
|
/** |
|
* Returns the pixel bounds of the glyph at index when this |
|
* <code>GlyphVector</code> is rendered in a <code>Graphics</code> with the |
|
* given <code>FontRenderContext</code> at the given location. The |
|
* renderFRC need not be the same as the |
|
* <code>FontRenderContext</code> of this |
|
* <code>GlyphVector</code>, and can be null. If it is null, the |
|
* <code>FontRenderContext</code> of this <code>GlyphVector</code> |
|
* is used. The default implementation returns the visual bounds of the glyph, |
|
* offset to x, y and rounded out to the next integer value, and |
|
* ignores the FRC. Subclassers should override this method. |
|
* @param index the index of the glyph. |
|
* @param renderFRC the <code>FontRenderContext</code> of the <code>Graphics</code>. |
|
* @param x the X position at which to render this <code>GlyphVector</code>. |
|
* @param y the Y position at which to render this <code>GlyphVector</code>. |
|
* @return a <code>Rectangle</code> bounding the pixels that would be affected. |
|
* @since 1.4 |
|
*/ |
|
public Rectangle getGlyphPixelBounds(int index, FontRenderContext renderFRC, float x, float y) { |
|
Rectangle2D rect = getGlyphVisualBounds(index).getBounds2D(); |
|
int l = (int)Math.floor(rect.getX() + x); |
|
int t = (int)Math.floor(rect.getY() + y); |
|
int r = (int)Math.ceil(rect.getMaxX() + x); |
|
int b = (int)Math.ceil(rect.getMaxY() + y); |
|
return new Rectangle(l, t, r - l, b - t); |
|
} |
|
/** |
|
* Returns the metrics of the glyph at the specified index into |
|
* this <code>GlyphVector</code>. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* that corresponds to the glyph from which to retrieve its metrics |
|
* @return a {@link GlyphMetrics} object that represents the |
|
* metrics of the glyph at the specified <code>glyphIndex</code> |
|
* into this <code>GlyphVector</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
*/ |
|
public abstract GlyphMetrics getGlyphMetrics(int glyphIndex); |
|
/** |
|
* Returns the justification information for the glyph at |
|
* the specified index into this <code>GlyphVector</code>. |
|
* @param glyphIndex the index into this <code>GlyphVector</code> |
|
* that corresponds to the glyph from which to retrieve its |
|
* justification properties |
|
* @return a {@link GlyphJustificationInfo} object that |
|
* represents the justification properties of the glyph at the |
|
* specified <code>glyphIndex</code> into this |
|
* <code>GlyphVector</code>. |
|
* @throws IndexOutOfBoundsException if <code>glyphIndex</code> |
|
* is less than 0 or greater than or equal to the number |
|
* of glyphs in this <code>GlyphVector</code> |
|
*/ |
|
public abstract GlyphJustificationInfo getGlyphJustificationInfo(int glyphIndex); |
|
// |
|
// general utility methods |
|
// |
|
/** |
|
* Tests if the specified <code>GlyphVector</code> exactly |
|
* equals this <code>GlyphVector</code>. |
|
* @param set the specified <code>GlyphVector</code> to test |
|
* @return <code>true</code> if the specified |
|
* <code>GlyphVector</code> equals this <code>GlyphVector</code>; |
|
* <code>false</code> otherwise. |
|
*/ |
|
public abstract boolean equals(GlyphVector set); |
|
} |