Added in API level 33

LineBreakConfig

class LineBreakConfig : Parcelable
kotlin.Any
   ↳ android.graphics.text.LineBreakConfig

Specifies the line-break strategies for text wrapping.

See the line-break property for more information.

Summary

Nested classes

A builder for creating a LineBreakConfig instance.

Constants
static Int

The least restrictive line-break rules are used for line breaking.

static Int

No line-break rules are used for line breaking.

static Int

The most common line-break rules are used for line breaking.

static Int

The most strict line-break rules are used for line breaking.

static Int

No line-break word style is used for line breaking.

static Int

Line breaking is based on phrases, which results in text wrapping only on meaningful words.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Int

Gets the current line-break style.

Int

Gets the current line-break word style.

Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Constants

LINE_BREAK_STYLE_LOOSE

Added in API level 33
static val LINE_BREAK_STYLE_LOOSE: Int

The least restrictive line-break rules are used for line breaking. This setting is typically used for short lines.

Value: 1

LINE_BREAK_STYLE_NONE

Added in API level 33
static val LINE_BREAK_STYLE_NONE: Int

No line-break rules are used for line breaking.

Value: 0

LINE_BREAK_STYLE_NORMAL

Added in API level 33
static val LINE_BREAK_STYLE_NORMAL: Int

The most common line-break rules are used for line breaking.

Value: 2

LINE_BREAK_STYLE_STRICT

Added in API level 33
static val LINE_BREAK_STYLE_STRICT: Int

The most strict line-break rules are used for line breaking.

Value: 3

LINE_BREAK_WORD_STYLE_NONE

Added in API level 33
static val LINE_BREAK_WORD_STYLE_NONE: Int

No line-break word style is used for line breaking.

Value: 0

LINE_BREAK_WORD_STYLE_PHRASE

Added in API level 33
static val LINE_BREAK_WORD_STYLE_PHRASE: Int

Line breaking is based on phrases, which results in text wrapping only on meaningful words.

Support for this line-break word style depends on locale. If the current locale does not support phrase-based text wrapping, this setting has no effect.

Value: 1

Public methods

describeContents

fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 33
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getLineBreakStyle

Added in API level 33
fun getLineBreakStyle(): Int

Gets the current line-break style.

Return
Int The line-break style to be used for text wrapping. Value is android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_NONE, android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_LOOSE, android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_NORMAL, android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_STRICT, android.graphics.text.LineBreakConfig.LINE_BREAK_STYLE_UNSPECIFIED, android.graphics.text.LineBreakConfig.LINE_BREAK_STYLE_NO_BREAK, or android.graphics.text.LineBreakConfig.LINE_BREAK_STYLE_AUTO

getLineBreakWordStyle

Added in API level 33
fun getLineBreakWordStyle(): Int

Gets the current line-break word style.

Return
Int The line-break word style to be used for text wrapping. Value is android.graphics.text.LineBreakConfig#LINE_BREAK_WORD_STYLE_NONE, android.graphics.text.LineBreakConfig#LINE_BREAK_WORD_STYLE_PHRASE, android.graphics.text.LineBreakConfig.LINE_BREAK_WORD_STYLE_UNSPECIFIED, or android.graphics.text.LineBreakConfig.LINE_BREAK_WORD_STYLE_AUTO

hashCode

Added in API level 33
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 33
fun toString(): String
Return
String a string representation of the object.

writeToParcel

fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES