Skip to content

Most visited

Recently visited

navigation

Linkify

public class Linkify
extends Object

java.lang.Object
   ↳ android.text.util.Linkify


Linkify take a piece of text and a regular expression and turns all of the regex matches in the text into clickable links. This is particularly useful for matching things like email addresses, web URLs, etc. and making them actionable. Alone with the pattern that is to be matched, a URL scheme prefix is also required. Any pattern match that does not begin with the supplied scheme will have the scheme prepended to the matched text when the clickable URL is created. For instance, if you are matching web URLs you would supply the scheme http://. If the pattern matches example.com, which does not have a URL scheme prefix, the supplied scheme will be prepended to create http://example.com when the clickable URL link is created.

Summary

Nested classes

interface Linkify.MatchFilter

MatchFilter enables client code to have more control over what is allowed to match and become a link, and what is not. 

interface Linkify.TransformFilter

TransformFilter enables client code to have more control over how matched patterns are represented as URLs. 

Constants

int ALL

Bit mask indicating that all available patterns should be matched in methods that take an options mask

int EMAIL_ADDRESSES

Bit field indicating that email addresses should be matched in methods that take an options mask

int MAP_ADDRESSES

Bit field indicating that street addresses should be matched in methods that take an options mask.

int PHONE_NUMBERS

Bit field indicating that phone numbers should be matched in methods that take an options mask

int WEB_URLS

Bit field indicating that web URLs should be matched in methods that take an options mask

Fields

public static final Linkify.MatchFilter sPhoneNumberMatchFilter

Filters out URL matches that don't have enough digits to be a phone number.

public static final Linkify.TransformFilter sPhoneNumberTransformFilter

Transforms matched phone number text into something suitable to be used in a tel: URL.

public static final Linkify.MatchFilter sUrlMatchFilter

Filters out web URL matches that occur after an at-sign (@).

Public constructors

Linkify()

Public methods

static final void addLinks(TextView text, Pattern pattern, String scheme, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter)

Applies a regex to the text of a TextView turning the matches into links.

static final void addLinks(TextView text, Pattern pattern, String defaultScheme, String[] schemes, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter)

Applies a regex to the text of a TextView turning the matches into links.

static final boolean addLinks(Spannable spannable, Pattern pattern, String defaultScheme, String[] schemes, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter)

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

static final boolean addLinks(Spannable text, Pattern pattern, String scheme)

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

static final boolean addLinks(Spannable text, int mask)

Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links.

static final void addLinks(TextView text, Pattern pattern, String scheme)

Applies a regex to the text of a TextView turning the matches into links.

static final boolean addLinks(Spannable spannable, Pattern pattern, String scheme, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter)

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

static final boolean addLinks(TextView text, int mask)

Scans the text of the provided TextView and turns all occurrences of the link types indicated in the mask into clickable links.

Inherited methods

From class java.lang.Object

Constants

ALL

Added in API level 1
int ALL

Bit mask indicating that all available patterns should be matched in methods that take an options mask

Constant Value: 15 (0x0000000f)

EMAIL_ADDRESSES

Added in API level 1
int EMAIL_ADDRESSES

Bit field indicating that email addresses should be matched in methods that take an options mask

Constant Value: 2 (0x00000002)

MAP_ADDRESSES

Added in API level 1
int MAP_ADDRESSES

Bit field indicating that street addresses should be matched in methods that take an options mask. Note that this uses the findAddress() method in WebView for finding addresses, which has various limitations.

Constant Value: 8 (0x00000008)

PHONE_NUMBERS

Added in API level 1
int PHONE_NUMBERS

Bit field indicating that phone numbers should be matched in methods that take an options mask

Constant Value: 4 (0x00000004)

WEB_URLS

Added in API level 1
int WEB_URLS

Bit field indicating that web URLs should be matched in methods that take an options mask

Constant Value: 1 (0x00000001)

Fields

sPhoneNumberMatchFilter

Added in API level 1
Linkify.MatchFilter sPhoneNumberMatchFilter

Filters out URL matches that don't have enough digits to be a phone number.

sPhoneNumberTransformFilter

Added in API level 1
Linkify.TransformFilter sPhoneNumberTransformFilter

Transforms matched phone number text into something suitable to be used in a tel: URL. It does this by removing everything but the digits and plus signs. For instance: '+1 (919) 555-1212' becomes '+19195551212'

sUrlMatchFilter

Added in API level 1
Linkify.MatchFilter sUrlMatchFilter

Filters out web URL matches that occur after an at-sign (@). This is to prevent turning the domain name in an email address into a web link.

Public constructors

Linkify

Added in API level 1
Linkify ()

Public methods

addLinks

Added in API level 1
void addLinks (TextView text, 
                Pattern pattern, 
                String scheme, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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: TextView whose text is to be marked-up with links
pattern Pattern: Regex pattern to be used for finding links
scheme String: URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.
matchFilter Linkify.MatchFilter: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.
transformFilter Linkify.TransformFilter

addLinks

Added in API level 24
void addLinks (TextView text, 
                Pattern pattern, 
                String defaultScheme, 
                String[] schemes, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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: TextView whose text is to be marked-up with links.
pattern Pattern: Regex pattern to be used for finding links.
defaultScheme String: The default scheme to be prepended to links if the link does not start with one of the schemes given.
schemes String: 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 Linkify.MatchFilter: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.
transformFilter Linkify.TransformFilter: Filter to allow the client code to update the link found.

addLinks

Added in API level 24
boolean addLinks (Spannable spannable, 
                Pattern pattern, 
                String defaultScheme, 
                String[] schemes, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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

Parameters
spannable Spannable: Spannable whose text is to be marked-up with links.
pattern Pattern: Regex pattern to be used for finding links.
defaultScheme String: The default scheme to be prepended to links if the link does not start with one of the schemes given.
schemes String: 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 Linkify.MatchFilter: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.
transformFilter Linkify.TransformFilter: Filter to allow the client code to update the link found.
Returns
boolean True if at least one link is found and applied.

addLinks

Added in API level 1
boolean addLinks (Spannable text, 
                Pattern pattern, 
                String scheme)

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

Parameters
text Spannable: Spannable whose text is to be marked-up with links
pattern Pattern: Regex pattern to be used for finding links
scheme String: URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.
Returns
boolean

addLinks

Added in API level 1
boolean addLinks (Spannable text, 
                int mask)

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.

Parameters
text Spannable: Spannable whose text is to be marked-up with links
mask int: Mask to define which kinds of links will be searched.
Returns
boolean True if at least one link is found and applied.

addLinks

Added in API level 1
void addLinks (TextView text, 
                Pattern pattern, 
                String scheme)

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: TextView whose text is to be marked-up with links
pattern Pattern: Regex pattern to be used for finding links
scheme String: URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.

addLinks

Added in API level 1
boolean addLinks (Spannable spannable, 
                Pattern pattern, 
                String scheme, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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

Parameters
spannable Spannable: Spannable whose text is to be marked-up with links
pattern Pattern: Regex pattern to be used for finding links
scheme String: URL scheme string (eg http://) to be prepended to the links that do not start with this scheme.
matchFilter Linkify.MatchFilter: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links.
transformFilter Linkify.TransformFilter: Filter to allow the client code to update the link found.
Returns
boolean True if at least one link is found and applied.

addLinks

Added in API level 1
boolean addLinks (TextView text, 
                int mask)

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.

Parameters
text TextView: TextView whose text is to be marked-up with links
mask int: Mask to define which kinds of links will be searched.
Returns
boolean True if at least one link is found and applied.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.