MaskFilterSpan

Kotlin |Java

public class MaskFilterSpan
extends CharacterStyle implements UpdateAppearance

java.lang.Object
↳	android.text.style.CharacterStyle
	↳	android.text.style.MaskFilterSpan

Span that allows setting a MaskFilter to the text it's attached to.

For example, to blur a text, a BlurMaskFilter can be used:

 MaskFilter blurMask = new BlurMaskFilter(5f, BlurMaskFilter.Blur.NORMAL);
 SpannableString string = new SpannableString("Text with blur mask");
 string.setSpan(new MaskFilterSpan(blurMask), 10, 15, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

Text blurred with the MaskFilterSpan.

Summary

Public constructors
`MaskFilterSpan(MaskFilter filter)` Creates a `MaskFilterSpan` from a `MaskFilter`.

Public methods
`MaskFilter`	`getMaskFilter()` Return the mask filter for this span.
`String`	`toString()` Returns a string representation of the object.
`void`	`updateDrawState(TextPaint ds)`

Inherited methods

From class


        
          android.text.style.CharacterStyle

`CharacterStyle`	`getUnderlying()` Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by `wrap(CharacterStyle)`, returns the underlying CharacterStyle.
`abstract void`	`updateDrawState(TextPaint tp)`
`static CharacterStyle`	`wrap(CharacterStyle cs)` A given CharacterStyle can only applied to a single region of a given Spanned.

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.

Public constructors

MaskFilterSpan

Added in API level 1

public MaskFilterSpan (MaskFilter filter)

Creates a MaskFilterSpan from a MaskFilter.

Parameters
`filter`	`MaskFilter`: the filter to be applied to the `TextPaint`

Public methods

getMaskFilter

Added in API level 1

public MaskFilter getMaskFilter ()

Return the mask filter for this span.

Returns
`MaskFilter`	the mask filter for this span

toString

Added in API level 1

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

updateDrawState

Added in API level 1

public void updateDrawState (TextPaint ds)

Parameters
`ds`	`TextPaint`