Added in API level 29

Summary: Inherited Constants | Ctors | Methods | Inherited Methods

LineHeightSpan.Standard

Kotlin |Java

public static class LineHeightSpan.Standard
extends Object implements LineHeightSpan, ParcelableSpan

java.lang.Object
↳	android.text.style.LineHeightSpan.Standard

Default implementation of the LineHeightSpan, which changes the line height of the attached paragraph.

For example, a paragraph with its line height equal to 100px can be set like this:

 SpannableString string = new SpannableString("This is a multiline paragraph. This is a multiline paragraph.");
 string.setSpan(new LineHeightSpan.Standard(100), 0, string.length(), Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

Text with line height set to 100 pixels.

Notice that LineHeightSpan will change the line height of the entire paragraph, even though it covers only part of the paragraph.

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Public constructors
`Standard(int height)` Set the line height of the paragraph to `height` physical pixels.
`Standard(Parcel src)` Constructor called from `TextUtils` to restore the span from a parcel

Public methods
`void`	`chooseHeight(CharSequence text, int start, int end, int spanstartv, int lineHeight, Paint.FontMetricsInt fm)` Classes that implement this should define how the height is being calculated.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getHeight()` Returns the line height specified by this span.
`int`	`getSpanTypeId()` Return a special type identifier for this span class.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.text.style.LineHeightSpan


      chooseHeight(CharSequence text, int start, int end, int spanstartv, int lineHeight, Paint.FontMetricsInt fm)

Classes that implement this should define how the height is being calculated.

From interface


        
          android.text.ParcelableSpan


      getSpanTypeId()

Return a special type identifier for this span class.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Public constructors

Standard

Added in API level 29

public Standard (int height)

Set the line height of the paragraph to height physical pixels.

Parameters
`height`	`int`: The units of this value are pixels. Value is 1 or greater

Standard

Added in API level 29

public Standard (Parcel src)

Constructor called from TextUtils to restore the span from a parcel

Parameters
`src`	`Parcel`: This value cannot be `null`.

Public methods

chooseHeight

Added in API level 29

public void chooseHeight (CharSequence text, 
                int start, 
                int end, 
                int spanstartv, 
                int lineHeight, 
                Paint.FontMetricsInt fm)

Classes that implement this should define how the height is being calculated.

Parameters
`text`	`CharSequence`: This value cannot be `null`.
`start`	`int`: the start of the line
`end`	`int`: the end of the line
`spanstartv`	`int`: the start of the span
`lineHeight`	`int`: the line height
`fm`	`Paint.FontMetricsInt`: This value cannot be `null`.

describeContents

Added in API level 29

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`

getHeight

Added in API level 29

public int getHeight ()

Returns the line height specified by this span.
The units of this value are pixels.

Returns
`int`	The units of this value are pixels. {}

getSpanTypeId

Added in API level 29

public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
`int`

writeToParcel

Added in API level 29

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. 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