LineBreakConfig

public final class LineBreakConfig
extends Object implements Parcelable

java.lang.Object
   ↳ android.graphics.text.LineBreakConfig


Specifies the line-break strategies for text wrapping.

See the line-break property for more information.

Summary

Nested classes

class LineBreakConfig.Builder

A builder for creating a LineBreakConfig instance. 

Constants

int LINE_BREAK_STYLE_LOOSE

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

int LINE_BREAK_STYLE_NONE

No line-break rules are used for line breaking.

int LINE_BREAK_STYLE_NORMAL

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

int LINE_BREAK_STYLE_STRICT

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

int LINE_BREAK_WORD_STYLE_NONE

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

int LINE_BREAK_WORD_STYLE_PHRASE

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

Inherited constants

Public methods

int describeContents()

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

boolean equals(Object o)

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

int getLineBreakStyle()

Gets the current line-break style.

int getLineBreakWordStyle()

Gets the current line-break word style.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

LINE_BREAK_STYLE_LOOSE

Added in API level 33
public static final int LINE_BREAK_STYLE_LOOSE

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

Constant Value: 1 (0x00000001)

LINE_BREAK_STYLE_NONE

Added in API level 33
public static final int LINE_BREAK_STYLE_NONE

No line-break rules are used for line breaking.

Constant Value: 0 (0x00000000)

LINE_BREAK_STYLE_NORMAL

Added in API level 33
public static final int LINE_BREAK_STYLE_NORMAL

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

Constant Value: 2 (0x00000002)

LINE_BREAK_STYLE_STRICT

Added in API level 33
public static final int LINE_BREAK_STYLE_STRICT

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

Constant Value: 3 (0x00000003)

LINE_BREAK_WORD_STYLE_NONE

Added in API level 33
public static final int LINE_BREAK_WORD_STYLE_NONE

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

Constant Value: 0 (0x00000000)

LINE_BREAK_WORD_STYLE_PHRASE

Added in API level 33
public static final int LINE_BREAK_WORD_STYLE_PHRASE

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.

Constant Value: 1 (0x00000001)

Public methods

describeContents

public int describeContents ()

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.

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

equals

Added in API level 33
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:

  • 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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getLineBreakStyle

Added in API level 33
public int getLineBreakStyle ()

Gets the current line-break style.

Returns
int The line-break style to be used for text wrapping. Value is LINE_BREAK_STYLE_NONE, LINE_BREAK_STYLE_LOOSE, LINE_BREAK_STYLE_NORMAL, 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
public int getLineBreakWordStyle ()

Gets the current line-break word style.

Returns
int The line-break word style to be used for text wrapping. Value is LINE_BREAK_WORD_STYLE_NONE, 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
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:

  • 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.

Returns
int a hash code value for this object.

toString

Added in API level 33
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES