me.saket.bettermovementmethod

Class BetterLinkMovementMethod

java.lang.Object

android.text.method.BaseMovementMethod

android.text.method.ScrollingMovementMethod

android.text.method.LinkMovementMethod

me.saket.bettermovementmethod.BetterLinkMovementMethod

All Implemented Interfaces:

android.text.method.MovementMethod

public class BetterLinkMovementMethod
extends android.text.method.LinkMovementMethod

Handles URL clicks on TextViews. Unlike the default implementation, this:

• Reliably applies a highlight color on links when they're touched.
• Let's you handle single and long clicks on URLs
• Correctly identifies focused URLs (Unlike the default implementation where a click is registered even if it's made outside of the URL's bounds if there is no more text in that direction.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BetterLinkMovementMethod.ClickableSpanWithText A wrapper to support all ClickableSpans that may or may not provide URLs.
protected static class	BetterLinkMovementMethod.LongPressTimer
static interface	BetterLinkMovementMethod.OnLinkClickListener
static interface	BetterLinkMovementMethod.OnLinkLongClickListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BetterLinkMovementMethod()

Method Summary

Modifier and Type	Method and Description
protected void	dispatchUrlClick(android.widget.TextView textView, android.text.style.ClickableSpan clickableSpan)
protected void	dispatchUrlLongClick(android.widget.TextView textView, android.text.style.ClickableSpan clickableSpan)
protected android.text.style.ClickableSpan	findClickableSpanUnderTouch(android.widget.TextView textView, android.text.Spannable text, android.view.MotionEvent event) Determines the touched location inside the TextView's text and returns the ClickableSpan found under it (if any).
static BetterLinkMovementMethod	getInstance() Get a static instance of BetterLinkMovementMethod.
protected void	highlightUrl(android.widget.TextView textView, android.text.style.ClickableSpan clickableSpan, android.text.Spannable text) Adds a background color span at clickableSpan's location.
static BetterLinkMovementMethod	linkify(int linkifyMask, android.app.Activity activity) Recursively register a BetterLinkMovementMethod on every TextView inside a layout.
static BetterLinkMovementMethod	linkify(int linkifyMask, android.widget.TextView... textViews)
static BetterLinkMovementMethod	linkify(int linkifyMask, android.view.ViewGroup viewGroup) Recursively register a BetterLinkMovementMethod on every TextView inside a layout.
static BetterLinkMovementMethod	linkifyHtml(android.app.Activity activity) Like linkify(int, TextView...), but can be used for TextViews with HTML links.
static BetterLinkMovementMethod	linkifyHtml(android.widget.TextView... textViews) Like linkify(int, TextView...), but can be used for TextViews with HTML links.
static BetterLinkMovementMethod	linkifyHtml(android.view.ViewGroup viewGroup) Like linkify(int, TextView...), but can be used for TextViews with HTML links.
static BetterLinkMovementMethod	newInstance() Return a new instance of BetterLinkMovementMethod.
boolean	onTouchEvent(android.widget.TextView textView, android.text.Spannable text, android.view.MotionEvent event)
protected void	removeLongPressCallback(android.widget.TextView textView) Remove the long-press detection timer.
protected void	removeUrlHighlightColor(android.widget.TextView textView) Removes the highlight color under the Url.
BetterLinkMovementMethod	setOnLinkClickListener(BetterLinkMovementMethod.OnLinkClickListener clickListener) Set a listener that will get called whenever any link is clicked on the TextView.
BetterLinkMovementMethod	setOnLinkLongClickListener(BetterLinkMovementMethod.OnLinkLongClickListener longClickListener) Set a listener that will get called whenever any link is clicked on the TextView.
protected void	startTimerForRegisteringLongClick(android.widget.TextView textView, BetterLinkMovementMethod.LongPressTimer.OnTimerReachedListener longClickListener)

Methods inherited from class android.text.method.LinkMovementMethod

canSelectArbitrarily, down, handleMovementKey, initialize, left, onTakeFocus, right, up

Methods inherited from class android.text.method.ScrollingMovementMethod

bottom, end, home, lineEnd, lineStart, pageDown, pageUp, top

Methods inherited from class android.text.method.BaseMovementMethod

getMovementMetaState, onGenericMotionEvent, onKeyDown, onKeyOther, onKeyUp, onTrackballEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.text.method.MovementMethod

onGenericMotionEvent, onKeyDown, onKeyOther, onKeyUp, onTrackballEvent

Constructor Detail

BetterLinkMovementMethod

protected BetterLinkMovementMethod()

Method Detail

newInstance

public static BetterLinkMovementMethod newInstance()

Return a new instance of BetterLinkMovementMethod.

linkify

public static BetterLinkMovementMethod linkify(int linkifyMask,
                                               android.widget.TextView... textViews)

Parameters:

linkifyMask - One of Linkify.ALL, Linkify.PHONE_NUMBERS, Linkify.MAP_ADDRESSES, Linkify.WEB_URLS and Linkify.EMAIL_ADDRESSES.

textViews - The TextViews on which a BetterLinkMovementMethod should be registered.

Returns:

The registered BetterLinkMovementMethod on the TextViews.

linkifyHtml

public static BetterLinkMovementMethod linkifyHtml(android.widget.TextView... textViews)

Like linkify(int, TextView...), but can be used for TextViews with HTML links.

Parameters:

textViews - The TextViews on which a BetterLinkMovementMethod should be registered.

Returns:

The registered BetterLinkMovementMethod on the TextViews.

linkify

public static BetterLinkMovementMethod linkify(int linkifyMask,
                                               android.view.ViewGroup viewGroup)

Recursively register a BetterLinkMovementMethod on every TextView inside a layout.

Parameters:

linkifyMask - One of Linkify.ALL, Linkify.PHONE_NUMBERS, Linkify.MAP_ADDRESSES, Linkify.WEB_URLS and Linkify.EMAIL_ADDRESSES.

Returns:

The registered BetterLinkMovementMethod on the TextViews.

linkifyHtml

public static BetterLinkMovementMethod linkifyHtml(android.view.ViewGroup viewGroup)

Like linkify(int, TextView...), but can be used for TextViews with HTML links.

Returns:

The registered BetterLinkMovementMethod on the TextViews.

linkify

public static BetterLinkMovementMethod linkify(int linkifyMask,
                                               android.app.Activity activity)

Recursively register a BetterLinkMovementMethod on every TextView inside a layout.

Parameters:

linkifyMask - One of Linkify.ALL, Linkify.PHONE_NUMBERS, Linkify.MAP_ADDRESSES, Linkify.WEB_URLS and Linkify.EMAIL_ADDRESSES.

Returns:

The registered BetterLinkMovementMethod on the TextViews.

linkifyHtml

public static BetterLinkMovementMethod linkifyHtml(android.app.Activity activity)

Like linkify(int, TextView...), but can be used for TextViews with HTML links.

Returns:

The registered BetterLinkMovementMethod on the TextViews.

getInstance

public static BetterLinkMovementMethod getInstance()

Get a static instance of BetterLinkMovementMethod. Do note that registering a click listener on the returned instance is not supported because it will potentially be shared on multiple TextViews.

setOnLinkClickListener

public BetterLinkMovementMethod setOnLinkClickListener(BetterLinkMovementMethod.OnLinkClickListener clickListener)

Set a listener that will get called whenever any link is clicked on the TextView.

setOnLinkLongClickListener

public BetterLinkMovementMethod setOnLinkLongClickListener(BetterLinkMovementMethod.OnLinkLongClickListener longClickListener)

Set a listener that will get called whenever any link is clicked on the TextView.

onTouchEvent

public boolean onTouchEvent(android.widget.TextView textView,
                            android.text.Spannable text,
                            android.view.MotionEvent event)

Specified by:

onTouchEvent in interface android.text.method.MovementMethod

Overrides:

onTouchEvent in class android.text.method.LinkMovementMethod

findClickableSpanUnderTouch

protected android.text.style.ClickableSpan findClickableSpanUnderTouch(android.widget.TextView textView,
                                                                       android.text.Spannable text,
                                                                       android.view.MotionEvent event)

Determines the touched location inside the TextView's text and returns the ClickableSpan found under it (if any).

Returns:

The touched ClickableSpan or null.

highlightUrl

protected void highlightUrl(android.widget.TextView textView,
                            android.text.style.ClickableSpan clickableSpan,
                            android.text.Spannable text)

Adds a background color span at clickableSpan's location.

removeUrlHighlightColor

protected void removeUrlHighlightColor(android.widget.TextView textView)

Removes the highlight color under the Url.

startTimerForRegisteringLongClick

protected void startTimerForRegisteringLongClick(android.widget.TextView textView,
                                                 BetterLinkMovementMethod.LongPressTimer.OnTimerReachedListener longClickListener)

removeLongPressCallback

protected void removeLongPressCallback(android.widget.TextView textView)

Remove the long-press detection timer.

dispatchUrlClick

protected void dispatchUrlClick(android.widget.TextView textView,
                                android.text.style.ClickableSpan clickableSpan)

dispatchUrlLongClick

protected void dispatchUrlLongClick(android.widget.TextView textView,
                                    android.text.style.ClickableSpan clickableSpan)