# Print output for @column tags ?>
public
final
class
PositionedGlyphs
extends Object
java.lang.Object | |
↳ | android.graphics.text.PositionedGlyphs |
Text shaping result object for single style text.
You can get text shaping result by
TextRunShaper#shapeTextRun(char[], int, int, int, int, float, float, boolean, Paint)
and
TextRunShaper#shapeTextRun(CharSequence, int, int, int, int, float, float, boolean,
Paint)
.
See also:
Public methods | |
---|---|
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
float
|
getAdvance()
Returns the total amount of advance consumed by this positioned glyphs. |
float
|
getAscent()
Effective ascent value of this positioned glyphs. |
float
|
getDescent()
Effective descent value of this positioned glyphs. |
Font
|
getFont(int index)
Returns the font object used for drawing the glyph at the given index. |
int
|
getGlyphId(int index)
Returns the glyph ID used for drawing the glyph at the given index. |
float
|
getGlyphX(int index)
Returns the x coordinate of the glyph position at the given index. |
float
|
getGlyphY(int index)
Returns the y coordinate of the glyph position at the given index. |
float
|
getOffsetX()
Returns the amount of X offset added to glyph position. |
float
|
getOffsetY()
Returns the amount of Y offset added to glyph position. |
int
|
glyphCount()
Returns the number of glyphs stored. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
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 | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public float getAdvance ()
Returns the total amount of advance consumed by this positioned glyphs. The advance is an amount of width consumed by the glyph. The total amount of advance is a total amount of advance consumed by this series of glyphs. In other words, if another glyph is placed next to this series of glyphs, it's X offset should be shifted this amount of width.
Returns | |
---|---|
float |
total amount of advance |
public float getAscent ()
Effective ascent value of this positioned glyphs. If two or more font files are used in this series of glyphs, the effective ascent will be the minimum ascent value across the all font files.
Returns | |
---|---|
float |
effective ascent value |
public float getDescent ()
Effective descent value of this positioned glyphs. If two or more font files are used in this series of glyphs, the effective descent will be the maximum descent value across the all font files.
Returns | |
---|---|
float |
effective descent value |
public Font getFont (int index)
Returns the font object used for drawing the glyph at the given index.
Parameters | |
---|---|
index |
int : the glyph index
Value is 0 or greater |
Returns | |
---|---|
Font |
the font object used for drawing the glyph at the given index
This value cannot be null . |
public int getGlyphId (int index)
Returns the glyph ID used for drawing the glyph at the given index.
Parameters | |
---|---|
index |
int : the glyph index
Value is 0 or greater |
Returns | |
---|---|
int |
An glyph ID of the font. Value is 0 or greater |
public float getGlyphX (int index)
Returns the x coordinate of the glyph position at the given index.
Parameters | |
---|---|
index |
int : the glyph index
Value is 0 or greater |
Returns | |
---|---|
float |
A X offset in pixels |
public float getGlyphY (int index)
Returns the y coordinate of the glyph position at the given index.
Parameters | |
---|---|
index |
int : the glyph index
Value is 0 or greater |
Returns | |
---|---|
float |
A Y offset in pixels. |
public float getOffsetX ()
Returns the amount of X offset added to glyph position.
Returns | |
---|---|
float |
The X offset added to glyph position. |
public float getOffsetY ()
Returns the amount of Y offset added to glyph position.
Returns | |
---|---|
float |
The Y offset added to glyph position. |
public int glyphCount ()
Returns the number of glyphs stored.
Returns | |
---|---|
int |
the number of glyphs Value is 0 or greater |
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
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 hash tables.
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
Java™ programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
public String toString ()
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())
Returns | |
---|---|
String |
a string representation of the object. |