Added in API level 29

LineBreaker.Result


public static class LineBreaker.Result
extends Object

java.lang.Object
   ↳ android.graphics.text.LineBreaker.Result


Holds the result of the line breaking algorithm.

Summary

Public methods

int getEndLineHyphenEdit(int lineIndex)

Returns an end hyphen edit for the line.

float getLineAscent(int lineIndex)

Returns font ascent of the line in pixels.

int getLineBreakOffset(int lineIndex)

Returns character offset of the break for a given line.

int getLineCount()

Returns the number of lines in the paragraph.

float getLineDescent(int lineIndex)

Returns font descent of the line in pixels.

float getLineWidth(int lineIndex)

Returns width of a given line in pixels.

int getStartLineHyphenEdit(int lineIndex)

Returns a start hyphen edit for the line.

boolean hasLineTab(int lineIndex)

Returns true if the line has a TAB character.

Inherited methods

Public methods

getEndLineHyphenEdit

Added in API level 29
public int getEndLineHyphenEdit (int lineIndex)

Returns an end hyphen edit for the line.

Parameters
lineIndex int: an index of the line.

Returns
int an end hyphen edit for the line.

getLineAscent

Added in API level 29
public float getLineAscent (int lineIndex)

Returns font ascent of the line in pixels.
The units of this value are pixels.

Parameters
lineIndex int: an index of the line. Value is 0 or greater

Returns
float an entier font ascent of the line in pixels. The units of this value are pixels. {}

getLineBreakOffset

Added in API level 29
public int getLineBreakOffset (int lineIndex)

Returns character offset of the break for a given line.

Parameters
lineIndex int: an index of the line. Value is 0 or greater

Returns
int the break offset. Value is 0 or greater

getLineCount

Added in API level 29
public int getLineCount ()

Returns the number of lines in the paragraph.

Returns
int number of lines Value is 0 or greater

getLineDescent

Added in API level 29
public float getLineDescent (int lineIndex)

Returns font descent of the line in pixels.
The units of this value are pixels.

Parameters
lineIndex int: an index of the line. Value is 0 or greater

Returns
float an entier font descent of the line in pixels. The units of this value are pixels. {}

getLineWidth

Added in API level 29
public float getLineWidth (int lineIndex)

Returns width of a given line in pixels.
The units of this value are pixels.

Parameters
lineIndex int: an index of the line. Value is 0 or greater

Returns
float width of the line in pixels The units of this value are pixels. {}

getStartLineHyphenEdit

Added in API level 29
public int getStartLineHyphenEdit (int lineIndex)

Returns a start hyphen edit for the line.

Parameters
lineIndex int: an index of the line.

Returns
int a start hyphen edit for the line.

hasLineTab

Added in API level 29
public boolean hasLineTab (int lineIndex)

Returns true if the line has a TAB character.

Parameters
lineIndex int: an index of the line.

Returns
boolean true if the line has a TAB character