APIdia Launch Partner
Top Description Fields Constructors Methods
sun.font

public final Class FontLineMetrics

extends LineMetrics
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Imports
java.awt.font.FontRenderContext, .LineMetrics

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

Field Summary

Modifier and TypeField and Description
public final CoreMetrics
public final FontRenderContext
public int

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.

public boolean
equals(Object rhs)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public float
getAscent()

Implements abstract java.awt.font.LineMetrics.getAscent.

Returns the ascent of the text.

public int
getBaselineIndex()

Implements abstract java.awt.font.LineMetrics.getBaselineIndex.

Returns the baseline index of the text.

public float[]
getBaselineOffsets()

Implements abstract java.awt.font.LineMetrics.getBaselineOffsets.

Returns the baseline offsets of the text, relative to the baseline of the text.

public float
getDescent()

Implements abstract java.awt.font.LineMetrics.getDescent.

Returns the descent of the text.

public float
getHeight()

Implements abstract java.awt.font.LineMetrics.getHeight.

Returns the height of the text.

public float
getLeading()

Implements abstract java.awt.font.LineMetrics.getLeading.

Returns the leading of the text.

public int
getNumChars()

Implements abstract java.awt.font.LineMetrics.getNumChars.

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

public float
getStrikethroughOffset()

Implements abstract java.awt.font.LineMetrics.getStrikethroughOffset.

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

public float
getStrikethroughThickness()

Implements abstract java.awt.font.LineMetrics.getStrikethroughThickness.

Returns the thickness of the strike-through line.

public float
getUnderlineOffset()

Implements abstract java.awt.font.LineMetrics.getUnderlineOffset.

Returns the position of the underline relative to the baseline.

public float
getUnderlineThickness()

Implements abstract java.awt.font.LineMetrics.getUnderlineThickness.

Returns the thickness of the underline.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Field Detail

cmback to summary
public final CoreMetrics cm
frcback to summary
public final FontRenderContext frc
numcharsback to summary
public int numchars

Constructor Detail

FontLineMetricsback to summary
public FontLineMetrics(int numchars, CoreMetrics cm, FontRenderContext frc)

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.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.

equalsback to summary
public boolean equals(Object rhs)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getAscentback to summary
public float getAscent()

Implements abstract java.awt.font.LineMetrics.getAscent.

Doc from java.awt.font.LineMetrics.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.

getBaselineIndexback to summary
public int getBaselineIndex()

Implements abstract java.awt.font.LineMetrics.getBaselineIndex.

Doc from java.awt.font.LineMetrics.getBaselineIndex.

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

getBaselineOffsetsback to summary
public float[] getBaselineOffsets()

Implements abstract java.awt.font.LineMetrics.getBaselineOffsets.

Doc from java.awt.font.LineMetrics.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.

getDescentback to summary
public float getDescent()

Implements abstract java.awt.font.LineMetrics.getDescent.

Doc from java.awt.font.LineMetrics.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.

getHeightback to summary
public float getHeight()

Implements abstract java.awt.font.LineMetrics.getHeight.

Doc from java.awt.font.LineMetrics.getHeight.

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

getLeadingback to summary
public float getLeading()

Implements abstract java.awt.font.LineMetrics.getLeading.

Doc from java.awt.font.LineMetrics.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.

getNumCharsback to summary
public int getNumChars()

Implements abstract java.awt.font.LineMetrics.getNumChars.

Doc from java.awt.font.LineMetrics.getNumChars.

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

getStrikethroughOffsetback to summary
public float getStrikethroughOffset()

Implements abstract java.awt.font.LineMetrics.getStrikethroughOffset.

Doc from java.awt.font.LineMetrics.getStrikethroughOffset.

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

getStrikethroughThicknessback to summary
public float getStrikethroughThickness()

Implements abstract java.awt.font.LineMetrics.getStrikethroughThickness.

Doc from java.awt.font.LineMetrics.getStrikethroughThickness.

Returns the thickness of the strike-through line.

getUnderlineOffsetback to summary
public float getUnderlineOffset()

Implements abstract java.awt.font.LineMetrics.getUnderlineOffset.

Doc from java.awt.font.LineMetrics.getUnderlineOffset.

Returns the position of the underline relative to the baseline.

getUnderlineThicknessback to summary
public float getUnderlineThickness()

Implements abstract java.awt.font.LineMetrics.getUnderlineThickness.

Doc from java.awt.font.LineMetrics.getUnderlineThickness.

Returns the thickness of the underline.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

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 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 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 hash tables.