Added in API level 35

LineBreakConfigSpan


class LineBreakConfigSpan : ParcelableSpan
kotlin.Any
   ↳ android.text.style.LineBreakConfigSpan

LineBreakSpan for changing line break style of the specific region of the text.

Summary

Public constructors

Construct a new LineBreakConfigSpan

Public methods
static LineBreakConfigSpan

A specialized LineBreakConfigSpan that used for preventing line break.

static LineBreakConfigSpan

A specialized LineBreakConfigSpan that used for preventing hyphenation.

Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

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

LineBreakConfig

Gets an associated line break config.

Int

Return a special type identifier for this span class.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<LineBreakConfigSpan!>

Public constructors

LineBreakConfigSpan

Added in API level 35
LineBreakConfigSpan(lineBreakConfig: LineBreakConfig)

Construct a new LineBreakConfigSpan

Parameters
lineBreakConfig LineBreakConfig: a line break config.
This value cannot be null.

Public methods

createNoBreakSpan

Added in API level 35
static fun createNoBreakSpan(): LineBreakConfigSpan

A specialized LineBreakConfigSpan that used for preventing line break. This is useful when you want to preserve some words in the same line. Note that even if this style is specified, the grapheme based line break is still performed for preventing clipping text.

Return
LineBreakConfigSpan This value cannot be null.

createNoHyphenationSpan

Added in API level 35
static fun createNoHyphenationSpan(): LineBreakConfigSpan

A specialized LineBreakConfigSpan that used for preventing hyphenation.

Return
LineBreakConfigSpan This value cannot be null.

describeContents

Added in API level 35
fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 35
fun equals(other: Any?): Boolean

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.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getLineBreakConfig

Added in API level 35
fun getLineBreakConfig(): LineBreakConfig

Gets an associated line break config.

Return
LineBreakConfig associated line break config.
This value cannot be null.

getSpanTypeId

Added in API level 35
fun getSpanTypeId(): Int

Return a special type identifier for this span class.

hashCode

Added in API level 35
fun hashCode(): Int

Returns a hash code value for the 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.
Return
Int a hash code value for this object.

toString

Added in API level 35
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 35
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 the following:

Properties

CREATOR

Added in API level 35
static val CREATOR: Parcelable.Creator<LineBreakConfigSpan!>