core/androidx.core.text.util/LinkifyCompat/addLinks

addLinks

open fun addLinks(@NonNull text: Spannable, mask: Int): Boolean(source)

Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links. If the mask is nonzero, it also removes any existing URLSpans attached to the Spannable, to avoid problems if you call it repeatedly on the same text.

Return

True if at least one link is found and applied.

Parameters

text

Spannable whose text is to be marked-up with links

mask

Mask to define which kinds of links will be searched.

open fun addLinks(@NonNull text: TextView, mask: Int): Boolean(source)

Scans the text of the provided TextView and turns all occurrences of the link types indicated in the mask into clickable links. If matches are found the movement method for the TextView is set to LinkMovementMethod.

Return

True if at least one link is found and applied.

Parameters

text

TextView whose text is to be marked-up with links

mask

Mask to define which kinds of links will be searched.

open fun addLinks(@NonNull text: TextView, @NonNull pattern: Pattern, @Nullable scheme: String)(source)

Applies a regex to the text of a TextView turning the matches into links. If links are found then UrlSpans are applied to the link text match areas, and the movement method for the text is changed to LinkMovementMethod.

Parameters

text

TextView whose text is to be marked-up with links

pattern

Regex pattern to be used for finding links

scheme

URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.

open fun addLinks(@NonNull text: TextView, @NonNull pattern: Pattern, @Nullable scheme: String, @Nullable matchFilter: Linkify.MatchFilter, @Nullable transformFilter: Linkify.TransformFilter)(source)

Applies a regex to the text of a TextView turning the matches into links. If links are found then UrlSpans are applied to the link text match areas, and the movement method for the text is changed to LinkMovementMethod.

Parameters

text

TextView whose text is to be marked-up with links

pattern

Regex pattern to be used for finding links

scheme

URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.

matchFilter

The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.

transformFilter

Filter to allow the client code to update the link found.

open fun addLinks(@NonNull text: TextView, @NonNull pattern: Pattern, @Nullable defaultScheme: String, @Nullable schemes: Array<String>, @Nullable matchFilter: Linkify.MatchFilter, @Nullable transformFilter: Linkify.TransformFilter)(source)

Applies a regex to the text of a TextView turning the matches into links. If links are found then UrlSpans are applied to the link text match areas, and the movement method for the text is changed to LinkMovementMethod.

Parameters

text

TextView whose text is to be marked-up with links.

pattern

Regex pattern to be used for finding links.

defaultScheme

The default scheme to be prepended to links if the link does not start with one of the schemes given.

schemes

Array of schemes (eg http://) to check if the link found contains a scheme. Passing a null or empty value means prepend defaultScheme to all links.

matchFilter

The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.

transformFilter

Filter to allow the client code to update the link found.

open fun addLinks(@NonNull text: Spannable, @NonNull pattern: Pattern, @Nullable scheme: String): Boolean(source)

Applies a regex to a Spannable turning the matches into links.

Parameters

text

Spannable whose text is to be marked-up with links

pattern

Regex pattern to be used for finding links

scheme

URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.

open fun addLinks(@NonNull spannable: Spannable, @NonNull pattern: Pattern, @Nullable scheme: String, @Nullable matchFilter: Linkify.MatchFilter, @Nullable transformFilter: Linkify.TransformFilter): Boolean(source)

Applies a regex to a Spannable turning the matches into links.

Return

True if at least one link is found and applied.

Parameters

spannable

Spannable whose text is to be marked-up with links

pattern

Regex pattern to be used for finding links

scheme

URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.

matchFilter

The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.

transformFilter

Filter to allow the client code to update the link found.

open fun addLinks(@NonNull spannable: Spannable, @NonNull pattern: Pattern, @Nullable defaultScheme: String, @Nullable schemes: Array<String>, @Nullable matchFilter: Linkify.MatchFilter, @Nullable transformFilter: Linkify.TransformFilter): Boolean(source)

Applies a regex to a Spannable turning the matches into links.

Return

True if at least one link is found and applied.

Parameters

spannable

Spannable whose text is to be marked-up with links.

pattern

Regex pattern to be used for finding links.

defaultScheme

The default scheme to be prepended to links if the link does not start with one of the schemes given.

schemes

Array of schemes (eg http://) to check if the link found contains a scheme. Passing a null or empty value means prepend defaultScheme to all links.

matchFilter

The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.

transformFilter

Filter to allow the client code to update the link found.