A GlyphVector 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 GlyphVector is ultimately displayed.

The GlyphVector 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.

Instances of GlyphVector are created by a Font .

In a text processing application that can cache intermediate representations of text, creation and subsequent caching of a GlyphVector for use during rendering is the fastest method to present the visual representation of characters to a user.

A GlyphVector is associated with exactly one Font, and can provide data useful only in relation to this Font. In addition, metrics obtained from a GlyphVector are not generally geometrically scaleable since the pixelization and spacing are dependent on grid-fitting algorithms within a Font. To facilitate accurate measurement of a GlyphVector and its component glyphs, you must specify a scaling transform, anti-alias mode, and fractional metrics mode when creating the GlyphVector. These characteristics can be derived from the destination device.

For each glyph in the GlyphVector, you can obtain:

Altering the data used to create the GlyphVector does not alter the state of the GlyphVector.

Methods are provided to adjust the positions of the glyphs within the GlyphVector. These methods are most appropriate for applications that are performing justification operations for the presentation of the glyphs.

Methods are provided to transform individual glyphs within the GlyphVector. These methods are primarily useful for special effects.

Methods are provided to return both the visual, logical, and pixel bounds of the entire GlyphVector or of individual glyphs within the GlyphVector.

Methods are provided to return a Shape for the GlyphVector, and for individual glyphs within the GlyphVector.

@version
19 Mar 1998
@author
Charlton Innovations, Inc.
A flag used with getLayoutFlags that indicates that this GlyphVector 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
A flag used with getLayoutFlags that indicates that this GlyphVector 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
A flag used with getLayoutFlags that indicates that this GlyphVector has per-glyph transforms.
@since
1.4
A mask for supported flags from getLayoutFlags. Only bits covered by the mask should be tested.
@since
1.4
A flag used with getLayoutFlags that indicates that this GlyphVector 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
Tests if the specified GlyphVector exactly equals this GlyphVector.
Parameters
setthe specified GlyphVector to test
Return
true if the specified GlyphVector equals this GlyphVector; false otherwise.
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
objthe reference object with which to compare.
Return
true if this object is the same as the obj argument; false otherwise.
Returns the runtime class of an object. That Class object is the object that is locked by static synchronized methods of the represented class.
Return
The java.lang.Class object that represents the runtime class of the object. The result is of type {@code Class} where X is the erasure of the static type of the expression on which getClass is called.
Returns the Font associated with this GlyphVector.
Return
Font used to create this GlyphVector.
See Also
Returns the FontRenderContext associated with this GlyphVector.
Return
FontRenderContext used to create this GlyphVector.
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.
Parameters
glyphIndexthe index of the glyph
Return
the index of the first character represented by the glyph
@since
1.4
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.
Parameters
beginGlyphIndexthe index of the first glyph
numEntriesthe number of glyph indices
codeReturnthe array into which to return the character indices
Return
an array of character indices, one per glyph.
@since
1.4
Returns the glyphcode of the specified glyph. This return value is meaningless to anything other than the Font object that created this GlyphVector.
Parameters
glyphIndexthe index into this GlyphVector that corresponds to the glyph from which to retrieve the glyphcode.
Return
the glyphcode of the glyph at the specified glyphIndex.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
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.
Parameters
beginGlyphIndexthe index into this GlyphVector at which to start retrieving glyphcodes
numEntriesthe number of glyphcodes to retrieve
codeReturnthe array that receives the glyphcodes and is then returned
Return
an array of glyphcodes for the specified glyphs.
Throws
IllegalArgumentExceptionif numEntries is less than 0
IndexOutOfBoundsExceptionif beginGlyphIndex is less than 0
IndexOutOfBoundsExceptionif the sum of beginGlyphIndex and numEntries is greater than the number of glyphs in this GlyphVector
Returns the justification information for the glyph at the specified index into this GlyphVector.
Parameters
glyphIndexthe index into this GlyphVector 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 glyphIndex into this GlyphVector.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in 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.
Parameters
glyphIndexthe index into this GlyphVector that corresponds to the glyph from which to retrieve its logical bounds
Return
a Shape that is the logical bounds of the glyph at the specified glyphIndex.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
Returns the metrics of the glyph at the specified index into this GlyphVector.
Parameters
glyphIndexthe index into this GlyphVector 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 glyphIndex into this GlyphVector.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in 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.
Parameters
glyphIndexthe index into this GlyphVector
Return
a Shape that is the outline of the glyph at the specified glyphIndex of this GlyphVector.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
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.
Parameters
glyphIndexthe index into this GlyphVector
x, ythe coordinates of the location of this GlyphVector.
Return
a Shape that is the outline of the glyph at the specified glyphIndex of this GlyphVector when rendered at the specified coordinates.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
@since
1.4
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.
Parameters
indexthe index of the glyph.
renderFRCthe FontRenderContext of the Graphics.
x, ythe position at which to render this GlyphVector.
Return
a Rectangle bounding the pixels that would be affected.
@since
1.4
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.
Parameters
glyphIndexthe index into this GlyphVector
Return
a {@link Point2D} object that is the position of the glyph at the specified glyphIndex.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than the number of glyphs in this GlyphVector
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.
Parameters
beginGlyphIndexthe index at which to begin retrieving glyph positions
numEntriesthe number of glyphs to retrieve
positionReturnthe array that receives the glyph positions and is then returned.
Return
an array of glyph positions specified by beginGlyphIndex and numEntries.
Throws
IllegalArgumentExceptionif numEntries is less than 0
IndexOutOfBoundsExceptionif beginGlyphIndex is less than 0
IndexOutOfBoundsExceptionif the sum of beginGlyphIndex and numEntries is greater than the number of glyphs in this GlyphVector plus one
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.
Parameters
glyphIndexthe index into this GlyphVector
Return
an {@link AffineTransform} that is the transform of the glyph at the specified glyphIndex.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this 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.
Parameters
glyphIndexthe index into this GlyphVector that corresponds to the glyph from which to retrieve its visual bounds
Return
a Shape that is the visual bounds of the glyph at the specified glyphIndex.
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
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
@since
1.4
Returns the logical bounds of this GlyphVector. This method is used when positioning this GlyphVector in relation to visually adjacent GlyphVector objects.
Return
a {@link Rectangle2D} that is the logical bounds of this GlyphVector.
Returns the number of glyphs in this GlyphVector.
Return
number of glyphs in this GlyphVector.
Returns a Shape whose interior corresponds to the visual representation of this GlyphVector.
Return
a Shape that is the outline of this GlyphVector.
Returns a Shape whose interior corresponds to the visual representation of this GlyphVector when rendered at x, y.
Parameters
x, ythe coordinates of this GlyphVector.
Return
a Shape that is the outline of this GlyphVector when rendered at the specified coordinates.
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.
Parameters
renderFRCthe FontRenderContext of the Graphics.
xthe x-coordinate at which to render this GlyphVector.
ythe y-coordinate at which to render this GlyphVector.
Return
a Rectangle bounding the pixels that would be affected.
@since
1.4
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.
Return
a Rectangle2D that is the bounding box of this GlyphVector.
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Return
a hash code value for this object.
Wakes up a single thread that is waiting on this object's monitor. If any threads are waiting on this object, one of them is chosen to be awakened. The choice is arbitrary and occurs at the discretion of the implementation. A thread waits on an object's monitor by calling one of the wait methods.

The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object. The awakened thread will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. A thread becomes the owner of the object's monitor in one of three ways:

  • By executing a synchronized instance method of that object.
  • By executing the body of a synchronized statement that synchronizes on the object.
  • For objects of type Class, by executing a synchronized static method of that class.

Only one thread at a time can own an object's monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
Wakes up all threads that are waiting on this object's monitor. A thread waits on an object's monitor by calling one of the wait methods.

The awakened threads will not be able to proceed until the current thread relinquishes the lock on this object. The awakened threads will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened threads enjoy no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
Assigns default positions to each glyph in this GlyphVector. This can destroy information generated during initial layout of 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
glyphIndexthe index into this GlyphVector
newPosthe Point2D at which to position the glyph at the specified glyphIndex
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than the number of glyphs in 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
glyphIndexthe index into this GlyphVector
newTXthe new transform of the glyph at glyphIndex
Throws
IndexOutOfBoundsExceptionif glyphIndex is less than 0 or greater than or equal to the number of glyphs in this GlyphVector
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
Return
a string representation of the object.
Causes current thread to wait until another thread invokes the method or the method for this object. In other words, this method behaves exactly as if it simply performs the call wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method. The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait();
         ... // Perform action appropriate to condition
     }
 
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Throws
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.

The current thread must own this object's monitor.

This method causes the current thread (call it T) to place itself in the wait set for this object and then to relinquish any and all synchronization claims on this object. Thread T becomes disabled for thread scheduling purposes and lies dormant until one of four things happens:

  • Some other thread invokes the notify method for this object and thread T happens to be arbitrarily chosen as the thread to be awakened.
  • Some other thread invokes the notifyAll method for this object.
  • Some other thread interrupts thread T.
  • The specified amount of real time has elapsed, more or less. If timeout is zero, however, then real time is not taken into consideration and the thread simply waits until notified.
The thread T is then removed from the wait set for this object and re-enabled for thread scheduling. It then competes in the usual manner with other threads for the right to synchronize on the object; once it has gained control of the object, all its synchronization claims on the object are restored to the status quo ante - that is, to the situation as of the time that the wait method was invoked. Thread T then returns from the invocation of the wait method. Thus, on return from the wait method, the synchronization state of the object and of thread T is exactly as it was when the wait method was invoked.

A thread can also wake up without being notified, interrupted, or timing out, a so-called spurious wakeup. While this will rarely occur in practice, applications must guard against it by testing for the condition that should have caused the thread to be awakened, and continuing to wait if the condition is not satisfied. In other words, waits should always occur in loops, like this one:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout);
         ... // Perform action appropriate to condition
     }
 
(For more information on this topic, see Section 3.2.3 in Doug Lea's "Concurrent Programming in Java (Second Edition)" (Addison-Wesley, 2000), or Item 50 in Joshua Bloch's "Effective Java Programming Language Guide" (Addison-Wesley, 2001).

If the current thread is interrupted by another thread while it is waiting, then an InterruptedException is thrown. This exception is not thrown until the lock status of this object has been restored as described above.

Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Parameters
timeoutthe maximum time to wait in milliseconds.
Throws
IllegalArgumentExceptionif the value of timeout is negative.
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

This method is similar to the wait method of one argument, but it allows finer control over the amount of time to wait for a notification before giving up. The amount of real time, measured in nanoseconds, is given by:

 1000000*timeout+nanos

In all other respects, this method does the same thing as the method of one argument. In particular, wait(0, 0) means the same thing as wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until either of the following two conditions has occurred:

  • Another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method.
  • The timeout period, specified by timeout milliseconds plus nanos nanoseconds arguments, has elapsed.

The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout, nanos);
         ... // Perform action appropriate to condition
     }
 
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Parameters
timeoutthe maximum time to wait in milliseconds.
nanosadditional time, in nanoseconds range 0-999999.
Throws
IllegalArgumentExceptionif the value of timeout is negative or the value of nanos is not in the range 0-999999.
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.