public final class

FontLineMetrics

extends LineMetrics
implements Cloneable
java.lang.Object
   ↳ java.awt.font.LineMetrics
     ↳ sun.font.FontLineMetrics

Class Overview

Metrics from a font for layout of characters along a line and layout of set of lines. This and CoreMetrics replace what was previously a private internal class of Font

Summary

Fields
public final CoreMetrics cm
public final FontRenderContext frc
public int numchars
Public Constructors
FontLineMetrics(int numchars, CoreMetrics cm, FontRenderContext frc)
Public Methods
final Object clone()
Creates and returns a copy of this object.
final boolean equals(Object rhs)
Indicates whether some other object is "equal to" this one.
final float getAscent()
Returns the ascent of the text.
final int getBaselineIndex()
Returns the baseline index of the text.
final float[] getBaselineOffsets()
Returns the baseline offsets of the text, relative to the baseline of the text.
final float getDescent()
Returns the descent of the text.
final float getHeight()
Returns the height of the text.
final float getLeading()
Returns the leading of the text.
final int getNumChars()
Returns the number of characters (char values) in the text whose metrics are encapsulated by this LineMetrics object.
final float getStrikethroughOffset()
Returns the position of the strike-through line relative to the baseline.
final float getStrikethroughThickness()
Returns the thickness of the strike-through line.
final float getUnderlineOffset()
Returns the position of the underline relative to the baseline.
final float getUnderlineThickness()
Returns the thickness of the underline.
final int hashCode()
Returns a hash code value for the object.
[Expand]
Inherited Methods
From class java.awt.font.LineMetrics
From class java.lang.Object

Fields

public final CoreMetrics cm

public final FontRenderContext frc

public int numchars

Public Constructors

public FontLineMetrics (int numchars, CoreMetrics cm, FontRenderContext frc)

Public Methods

public final Object clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x
will be true, and that the expression:
 x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
 x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Returns
  • a clone of this instance.

public final boolean equals (Object rhs)

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
rhs the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public final float getAscent ()

Returns the ascent of the text. The ascent is the distance from the baseline to the ascender line. The ascent usually represents the the height of the capital letters of the text. Some characters can extend above the ascender line.

Returns
  • the ascent of the text.

public final int getBaselineIndex ()

Returns the baseline index of the text. The index is one of ROMAN_BASELINE, CENTER_BASELINE, HANGING_BASELINE.

Returns
  • the baseline of the text.

public final float[] getBaselineOffsets ()

Returns the baseline offsets of the text, relative to the baseline of the text. The offsets are indexed by baseline index. For example, if the baseline index is CENTER_BASELINE then offsets[HANGING_BASELINE] is usually negative, offsets[CENTER_BASELINE] is zero, and offsets[ROMAN_BASELINE] is usually positive.

Returns
  • the baseline offsets of the text.

public final float getDescent ()

Returns the descent of the text. The descent is the distance from the baseline to the descender line. The descent usually represents the distance to the bottom of lower case letters like 'p'. Some characters can extend below the descender line.

Returns
  • the descent of the text.

public final float getHeight ()

Returns the height of the text. The height is equal to the sum of the ascent, the descent and the leading.

Returns
  • the height of the text.

public final float getLeading ()

Returns the leading of the text. The leading is the recommended distance from the bottom of the descender line to the top of the next line.

Returns
  • the leading of the text.

public final int getNumChars ()

Returns the number of characters (char values) in the text whose metrics are encapsulated by this LineMetrics object.

Returns
  • the number of characters (char values) in the text with which this LineMetrics was created.

public final float getStrikethroughOffset ()

Returns the position of the strike-through line relative to the baseline.

Returns
  • the position of the strike-through line.

public final float getStrikethroughThickness ()

Returns the thickness of the strike-through line.

Returns
  • the thickness of the strike-through line.

public final float getUnderlineOffset ()

Returns the position of the underline relative to the baseline.

Returns
  • the position of the underline.

public final float getUnderlineThickness ()

Returns the thickness of the underline.

Returns
  • the thickness of the underline.

public final int hashCode ()

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 equals(java.lang.Object) 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.)

Returns
  • a hash code value for this object.