GlyphVector JDK 1.6)

publicabstract boolean equals (GlyphVector set)

Tests if the specified GlyphVector exactly equals this GlyphVector.

Tests if the specified GlyphVector exactly
equals this GlyphVector.
Returns: true if the specified GlyphVector equals this GlyphVector; false otherwise.
Parameters:
- set - the specified GlyphVector to test

publicabstract Font getFont ()

Returns the Font associated with this GlyphVector.

Returns the Font associated with this
GlyphVector.
Returns: Font used to create this GlyphVector.
See Also: Font,

publicabstract FontRenderContext getFontRenderContext ()

Returns the FontRenderContext associated with this GlyphVector.

Returns the FontRenderContext associated with this
GlyphVector.
Returns: FontRenderContext used to create this GlyphVector.
See Also: FontRenderContext, Font,

public int getGlyphCharIndex (int glyphIndex)

Returns the character index of the specified glyph.

public int getGlyphCharIndices (int beginGlyphIndex, int numEntries, int[] codeReturn)

Returns the character indices of the specified glyphs.

publicabstract int getGlyphCode (int glyphIndex)

Returns the glyphcode of the specified glyph.

Returns the glyphcode of the specified glyph.
This return value is meaningless to anything other
than the Font object that created this
GlyphVector.
Returns: the glyphcode of the glyph at the specified glyphIndex.
Parameters:
- glyphIndex - the index into this GlyphVector that corresponds to the glyph from which to retrieve the glyphcode.
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector

publicabstract int getGlyphCodes (int beginGlyphIndex, int numEntries, int[] codeReturn)

Returns an array of glyphcodes for the specified glyphs.

Returns an array of glyphcodes for the specified glyphs.
The contents of this return value are meaningless to anything other
than the Font used to create this
GlyphVector. This method is used
for convenience and performance when processing glyphcodes.
If no array is passed in, a new array is created.
Returns: an array of glyphcodes for the specified glyphs.
Parameters:
- beginGlyphIndex - the index into this GlyphVector at which to start retrieving glyphcodes
- numEntries - the number of glyphcodes to retrieve
- codeReturn - the array that receives the glyphcodes and is then returned
Throws:
- IllegalArgumentException - if numEntries is less than 0
- IndexOutOfBoundsException - if beginGlyphIndex is less than 0
- IndexOutOfBoundsException - if the sum of beginGlyphIndex and numEntries is greater than the number of glyphs in this GlyphVector

publicabstract GlyphJustificationInfo getGlyphJustificationInfo (int glyphIndex)

Returns the justification information for the glyph at the specified index into this GlyphVector.

Returns the justification information for the glyph at
the specified index into this GlyphVector.
Returns: a {@link GlyphJustificationInfo} object that represents the justification properties of the glyph at the specified glyphIndex into this GlyphVector.
Parameters:
- glyphIndex - the index into this GlyphVector that corresponds to the glyph from which to retrieve its justification properties
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector

publicabstract Shape getGlyphLogicalBounds (int glyphIndex)

Returns the logical bounds of the specified glyph within this GlyphVector.

Returns the logical bounds of the specified glyph within this
GlyphVector.
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.
Returns: a Shape that is the logical bounds of the glyph at the specified glyphIndex.
Parameters:
- glyphIndex - the index into this GlyphVector that corresponds to the glyph from which to retrieve its logical bounds
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
See Also: GlyphVector.getGlyphVisualBounds(int),

publicabstract GlyphMetrics getGlyphMetrics (int glyphIndex)

Returns the metrics of the glyph at the specified index into this GlyphVector.

Returns the metrics of the glyph at the specified index into
this GlyphVector.
Returns: a {@link GlyphMetrics} object that represents the metrics of the glyph at the specified glyphIndex into this GlyphVector.
Parameters:
- glyphIndex - the index into this GlyphVector that corresponds to the glyph from which to retrieve its metrics
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector

publicabstract Shape getGlyphOutline (int glyphIndex)

Returns a Shape whose interior corresponds to the visual representation of the specified glyph within this GlyphVector.

Returns a Shape whose interior corresponds to the
visual representation of the specified glyph
within this GlyphVector.
The outline returned by this method is positioned around the
origin of each individual glyph.
Returns: a Shape that is the outline of the glyph at the specified glyphIndex of this GlyphVector.
Parameters:
- glyphIndex - the index into this GlyphVector
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector

public Shape getGlyphOutline (int glyphIndex, float x, float y)

Returns a Shape whose interior corresponds to the visual representation of the specified glyph within this GlyphVector, offset to x, y.

Returns a Shape whose interior corresponds to the
visual representation of the specified glyph
within this GlyphVector, offset to x, y.
The outline returned by this method is positioned around the
origin of each individual glyph.
Returns: a Shape that is the outline of the glyph at the specified glyphIndex of this GlyphVector when rendered at the specified coordinates.
Parameters:
- glyphIndex - the index into this GlyphVector
- x - the X coordinate of the location of this {@code GlyphVector}
- y - the Y coordinate of the location of this {@code GlyphVector}
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
Since: 1.4

public Rectangle getGlyphPixelBounds (int index, FontRenderContext renderFRC, float x, float y)

Returns the pixel bounds of the glyph at index when this GlyphVector is rendered in a Graphics with the given FontRenderContext at the given location.

Returns the pixel bounds of the glyph at index when this
GlyphVector is rendered in a Graphics with the
given FontRenderContext at the given location. The
renderFRC need not be the same as the
FontRenderContext of this
GlyphVector, and can be null. If it is null, the
FontRenderContext of this GlyphVector
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.
Returns: a Rectangle bounding the pixels that would be affected.
Parameters:
- index - the index of the glyph.
- renderFRC - the FontRenderContext of the Graphics.
- x - the X position at which to render this GlyphVector.
- y - the Y position at which to render this GlyphVector.
Since: 1.4

publicabstract Point2D getGlyphPosition (int glyphIndex)

Returns the position of the specified glyph relative to the origin of this GlyphVector.

Returns the position of the specified glyph relative to the
origin of this GlyphVector.
If glyphIndex equals the number of of glyphs in
this GlyphVector, this method returns the position after
the last glyph. This position is used to define the advance of
the entire GlyphVector.
Returns: a {@link Point2D} object that is the position of the glyph at the specified glyphIndex.
Parameters:
- glyphIndex - the index into this GlyphVector
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than the number of glyphs in this GlyphVector
See Also: GlyphVector.setGlyphPosition(int, java.awt.geom.Point2D),

publicabstract float getGlyphPositions (int beginGlyphIndex, int numEntries, float[] positionReturn)

Returns an array of glyph positions for the specified 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 beginGlyphIndex + position/2.
Odd numbered array entries beginning with position one are the Y
coordinates of the glyph numbered beginGlyphIndex + (position-1)/2.
If beginGlyphIndex equals the number of of glyphs in
this GlyphVector, this method gets the position after
the last glyph and this position is used to define the advance of
the entire GlyphVector.
Returns: an array of glyph positions specified by beginGlyphIndex and numEntries.
Parameters:
- beginGlyphIndex - the index at which to begin retrieving glyph positions
- numEntries - the number of glyphs to retrieve
- positionReturn - the array that receives the glyph positions and is then returned.
Throws:
- IllegalArgumentException - if numEntries is less than 0
- IndexOutOfBoundsException - if beginGlyphIndex is less than 0
- IndexOutOfBoundsException - if the sum of beginGlyphIndex and numEntries is greater than the number of glyphs in this GlyphVector plus one

publicabstract AffineTransform getGlyphTransform (int glyphIndex)

Returns the transform of the specified glyph within this GlyphVector.

Returns the transform of the specified glyph within this
GlyphVector. The transform is relative to the
glyph position. If no special transform has been applied,
null can be returned. A null return indicates
an identity transform.
Returns: an {@link AffineTransform} that is the transform of the glyph at the specified glyphIndex.
Parameters:
- glyphIndex - the index into this GlyphVector
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
See Also: GlyphVector.setGlyphTransform(int, java.awt.geom.AffineTransform),

publicabstract Shape getGlyphVisualBounds (int glyphIndex)

Returns the visual bounds of the specified glyph within the GlyphVector.

Returns the visual bounds of the specified glyph within the
GlyphVector.
The bounds returned by this method is positioned around the
origin of each individual glyph.
Returns: a Shape that is the visual bounds of the glyph at the specified glyphIndex.
Parameters:
- glyphIndex - the index into this GlyphVector that corresponds to the glyph from which to retrieve its visual bounds
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
See Also: GlyphVector.getGlyphLogicalBounds(int),

public int getLayoutFlags ()

Returns flags describing the global state of the GlyphVector.

publicabstract Rectangle2D getLogicalBounds ()

Returns the logical bounds of this GlyphVector.

Returns the logical bounds of this GlyphVector.
This method is used when positioning this GlyphVector
in relation to visually adjacent GlyphVector objects.
Returns: a {@link Rectangle2D} that is the logical bounds of this GlyphVector.

publicabstract int getNumGlyphs ()

Returns the number of glyphs in this GlyphVector.

Returns the number of glyphs in this GlyphVector.
Returns: number of glyphs in this GlyphVector.

publicabstract Shape getOutline ()

Returns a Shape whose interior corresponds to the visual representation of this GlyphVector.

Returns a Shape whose interior corresponds to the
visual representation of this GlyphVector.
Returns: a Shape that is the outline of this GlyphVector.

publicabstract Shape getOutline (float x, float y)

Returns a Shape whose interior corresponds to the visual representation of this GlyphVector when rendered at x, y.

Returns a Shape whose interior corresponds to the
visual representation of this GlyphVector when
rendered at x, y.
Returns: a Shape that is the outline of this GlyphVector when rendered at the specified coordinates.
Parameters:
- x - the X coordinate of this GlyphVector.
- y - the Y coordinate of this GlyphVector.

public Rectangle getPixelBounds (FontRenderContext renderFRC, float x, float y)

Returns the pixel bounds of this GlyphVector when rendered in a graphics with the given FontRenderContext at the given location.

Returns the pixel bounds of this GlyphVector when
rendered in a graphics with the given
FontRenderContext at the given location. The
renderFRC need not be the same as the
FontRenderContext of this
GlyphVector, and can be null. If it is null, the
FontRenderContext of this GlyphVector
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.
Returns: a Rectangle bounding the pixels that would be affected.
Parameters:
- renderFRC - the FontRenderContext of the Graphics.
- x - the x-coordinate at which to render this GlyphVector.
- y - the y-coordinate at which to render this GlyphVector.
Since: 1.4

publicabstract Rectangle2D getVisualBounds ()

Returns the visual bounds of this GlyphVector The visual bounds is the bounding box of the outline of this GlyphVector.

Returns the visual bounds of this GlyphVector
The visual bounds is the bounding box of the outline of this
GlyphVector. Because of rasterization and
alignment of pixels, it is possible that this box does not
enclose all pixels affected by rendering this GlyphVector.
Returns: a Rectangle2D that is the bounding box of this GlyphVector.

publicabstract void performDefaultLayout ()

Assigns default positions to each glyph in this GlyphVector.

Assigns default positions to each glyph in this
GlyphVector. This can destroy information
generated during initial layout of this GlyphVector.

publicabstract void setGlyphPosition (int glyphIndex, Point2D newPos)

Sets the position of the specified glyph within this GlyphVector.

Sets the position of the specified glyph within this
GlyphVector.
If glyphIndex equals the number of of glyphs in
this GlyphVector, this method sets the position after
the last glyph. This position is used to define the advance of
the entire GlyphVector.
Parameters:
- glyphIndex - the index into this GlyphVector
- newPos - the Point2D at which to position the glyph at the specified glyphIndex
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than the number of glyphs in this GlyphVector
See Also: GlyphVector.getGlyphPosition(int),

publicabstract void setGlyphTransform (int glyphIndex, AffineTransform newTX)

Sets the transform of the specified glyph within this GlyphVector.

Sets the transform of the specified glyph within this
GlyphVector. The transform is relative to the glyph
position. A null argument for newTX
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 signifant performance changes.
Parameters:
- glyphIndex - the index into this GlyphVector
- newTX - the new transform of the glyph at glyphIndex
Throws:
- IndexOutOfBoundsException - if glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
See Also: GlyphVector.getGlyphTransform(int),