TextAlign

Artifact: androidx.compose.ui:ui-text

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  value class TextAlign

---

Aligns text horizontally within its container.

Summary

Public companion functions
TextAlign	valueOf(value: Int) Creates TextAlign from value.	Cmn
List<TextAlign>	values() Return a list containing all possible values of TextAlign.	Cmn

Public companion properties
TextAlign	Center Aligns text to the center.	Cmn
TextAlign	End Aligns text to the trailing edge.	Cmn
TextAlign	Justify Stretches lines of text to fill the container width.	Cmn
TextAlign	Left Aligns text to the left edge.	Cmn
TextAlign	Right Aligns text to the right edge.	Cmn
TextAlign	Start Aligns text to the leading edge.	Cmn
TextAlign	Unspecified Represents an unset TextAlign value.	Cmn

Public functions
open String	toString()	Cmn

Public properties
Int	value internal integer representation of the text alignment.	Cmn

Extension functions
inline TextAlign	TextAlign.takeOrElse(block: () -> TextAlign) If isSpecified is true then this is returned, otherwise block is executed and its result is returned.	Cmn

Extension properties
Boolean	TextAlign.isSpecified Returns true if this TextAlign is not TextAlign.Unspecified.	Cmn

Public companion functions

valueOf

Cmn

Added in 1.10.0

fun valueOf(value: Int): TextAlign

Creates TextAlign from value.

Useful for serialization/deserialization.

Parameters
value: Int	internal integer representation.

Throws
IllegalArgumentException	if value is invalid.

See also
value

values

Cmn

Added in 1.0.0

fun values(): List<TextAlign>

Return a list containing all possible values of TextAlign.

Public companion properties

Center

Cmn

Added in 1.0.0

val Center: TextAlign

Aligns text to the center.

End

Cmn

Added in 1.0.0

val End: TextAlign

Aligns text to the trailing edge.

Maps to the right edge for LTR, and the left edge for RTL.

Justify

Cmn

Added in 1.0.0

val Justify: TextAlign

Stretches lines of text to fill the container width.

Lines ending with hard line breaks align to Start.

Left

Cmn

Added in 1.0.0

val Left: TextAlign

Aligns text to the left edge.

Right

Cmn

Added in 1.0.0

val Right: TextAlign

Aligns text to the right edge.

Start

Cmn

Added in 1.0.0

val Start: TextAlign

Aligns text to the leading edge.

Maps to the left edge for LTR, and the right edge for RTL.

Unspecified

Cmn

Added in 1.6.0

val Unspecified: TextAlign

Represents an unset TextAlign value.

Public functions

toString

Cmn

open fun toString(): String

Public properties

value

Cmn

Added in 1.10.0

val value: Int

internal integer representation of the text alignment.

Extension functions

TextAlign.takeOrElse

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

inline fun TextAlign.takeOrElse(block: () -> TextAlign): TextAlign

If isSpecified is true then this is returned, otherwise block is executed and its result is returned.

Extension properties

TextAlign.isSpecified

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

val TextAlign.isSpecified: Boolean

Returns true if this TextAlign is not TextAlign.Unspecified.

See also
Unspecified