net.zer0bandwidth.android.lib.content

Class ContentUtils

java.lang.Object

net.zer0bandwidth.android.lib.content.ContentUtils

public class ContentUtils
extends java.lang.Object

Provides convenience methods and canonical implementations of methods for working with content in general.

Since:

zer0bandwidth-net/android 0.1.2 (#27)

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LOG_TAG
static java.lang.String	MIMETYPE_TEXT_PLAIN MIME type "text/plain"
static java.lang.String	QUERY_ORDER_ASCENDING The magic word used by ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String) to specify that results should be sorted in ascending order.
static java.lang.String	QUERY_ORDER_DESCENDING The magic word used by ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String) to specify that results should be sorted in descending order.
static java.lang.String	QUERY_VARIABLE_MARKER The character that stands in for a variable value in the Android format string that is supplied to methods of ContentResolver.
static android.content.ClipboardManager	s_mgrClipboard A persistent reference to the system's clipboard manager.

Constructor Summary

Constructors

Constructor and Description
ContentUtils()

Method Summary

Modifier and Type	Method and Description
static void	copyTextToClipboard(android.content.Context ctx, int resText) Copies the specified plain text into the clipboard.
static void	copyTextToClipboard(android.content.Context ctx, java.lang.String sText) Copies the specified plain text into the clipboard.
static void	copyTextToClipboard(android.content.Context ctx, java.lang.String sClipLabel, int resText) Copies the specified plain text into the clipboard.
static void	copyTextToClipboard(android.content.Context ctx, java.lang.String sClipLabel, java.lang.String sText) Copies the specified plain text into the clipboard.
static android.content.ClipboardManager	getClipboardManager(android.content.Context ctx) Retrieves the system's clipboard manager.
static void	shareText(android.content.Context ctx, java.lang.String sText) Opens the OS-standard "share" dialog, using the specified text content to be shared.
static void	shareText(android.content.Context ctx, java.lang.String sText, int resTitle) Opens the OS-standard "share" dialog, using the specified text content to be shared.
static void	shareText(android.content.Context ctx, java.lang.String sText, java.lang.String sTitle) Opens the OS-standard "share" dialog, using the specified text content to be shared.
static boolean	tryToTweetText(android.content.Context ctx, java.lang.String sTweet) As tweetText(Context, String), but catches the possible UnsupportedEncodingException internally, by logging an error.
static void	tweetText(android.content.Context ctx, java.lang.String sTweet) Dispatches an intent to view Twitter's "tweet" intent page, using the specified text as the contents of the tweet.
static boolean	unregister(android.content.Context ctx, android.content.BroadcastReceiver rcv) Safe and idempotent method for unregistering a BroadcastReceiver which might or might not still be registered in the given Context.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final java.lang.String LOG_TAG

QUERY_ORDER_ASCENDING

public static final java.lang.String QUERY_ORDER_ASCENDING

The magic word used by ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String) to specify that results should be sorted in ascending order.

Since:

zer0bandwidth-net/android 0.1.7 (#39)

See Also:

Constant Field Values

QUERY_ORDER_DESCENDING

public static final java.lang.String QUERY_ORDER_DESCENDING

The magic word used by ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String) to specify that results should be sorted in descending order.

Since:

zer0bandwidth-net/android 0.1.7 (#39)

See Also:

Constant Field Values

QUERY_VARIABLE_MARKER

public static final java.lang.String QUERY_VARIABLE_MARKER

The character that stands in for a variable value in the Android format string that is supplied to methods of ContentResolver.

Since:

zer0bandwidth-net/android 0.1.7 (#39)

See Also:

Constant Field Values

MIMETYPE_TEXT_PLAIN

public static final java.lang.String MIMETYPE_TEXT_PLAIN

MIME type "text/plain"

See Also:

Constant Field Values

s_mgrClipboard

public static android.content.ClipboardManager s_mgrClipboard

A persistent reference to the system's clipboard manager.

Constructor Detail

ContentUtils

public ContentUtils()

Method Detail

getClipboardManager

public static android.content.ClipboardManager getClipboardManager(android.content.Context ctx)

Retrieves the system's clipboard manager. If an instance is not already maintained in the class, then it will be fetched and bound there.

Parameters:

ctx - the context from which to retrieve the manager instance

Returns:

the manager instance

copyTextToClipboard

public static void copyTextToClipboard(android.content.Context ctx,
                                       java.lang.String sClipLabel,
                                       java.lang.String sText)

Copies the specified plain text into the clipboard.

Parameters:

ctx - the context in which to operate

sClipLabel - the "label" of the new clipboard item

sText - the plain text to be copied

See Also:

ClipboardManager.setPrimaryClip(ClipData)

copyTextToClipboard

public static void copyTextToClipboard(android.content.Context ctx,
                                       java.lang.String sText)

Copies the specified plain text into the clipboard. The "label" of the new clipboard item is defaulted to the value of the R.string#app_name resource, which is usually the name of the current app.

Parameters:

ctx - the context in which to operate

sText - the plain text to be copied

See Also:

ClipboardManager.setPrimaryClip(ClipData)

copyTextToClipboard

public static void copyTextToClipboard(android.content.Context ctx,
                                       java.lang.String sClipLabel,
                                       int resText)

Copies the specified plain text into the clipboard.

Parameters:

ctx - the context in which to operate

sClipLabel - the "label" of the new clipboard item

resText - the resource ID of the text to be added to the clipboard

See Also:

ClipboardManager.setPrimaryClip(ClipData)

copyTextToClipboard

public static void copyTextToClipboard(android.content.Context ctx,
                                       int resText)

Copies the specified plain text into the clipboard. The "label" of the new clipboard item is defaulted to the value of the R.string#app_name resource, which is usually the name of the current app.

Parameters:

ctx - the context in which to operate

resText - the resource ID of the text to be added to the clipboard

See Also:

ClipboardManager.setPrimaryClip(ClipData)

shareText

public static void shareText(android.content.Context ctx,
                             java.lang.String sText,
                             java.lang.String sTitle)

Opens the OS-standard "share" dialog, using the specified text content to be shared.

Parameters:

ctx - the context in which to open the dialog

sText - the text to be shared

sTitle - the title of the dialog

shareText

public static void shareText(android.content.Context ctx,
                             java.lang.String sText,
                             int resTitle)

Opens the OS-standard "share" dialog, using the specified text content to be shared.

Parameters:

ctx - the context in which to open the dialog

sText - the text to be shared

resTitle - the resource ID of the string for the dialog title

shareText

public static void shareText(android.content.Context ctx,
                             java.lang.String sText)

Opens the OS-standard "share" dialog, using the specified text content to be shared. The title of the dialog is defaulted to the value of R.string#title_diaShare_default provided by this library, which may be overridden in the app that consumes this library.

Parameters:

ctx - the context in which to operate

sText - the text to be shared

tweetText

public static void tweetText(android.content.Context ctx,
                             java.lang.String sTweet)
                      throws java.io.UnsupportedEncodingException

Dispatches an intent to view Twitter's "tweet" intent page, using the specified text as the contents of the tweet. This will usually trigger either the Twitter app or a browser window to open, allowing the user to confirm the tweet.

Parameters:

ctx - the context in which to attempt the tweet

sTweet - the tweet text

Throws:

java.io.UnsupportedEncodingException - if the tweet text cannot be URL-encoded in UTF-8, as specified within the function

tryToTweetText

public static boolean tryToTweetText(android.content.Context ctx,
                                     java.lang.String sTweet)

As tweetText(Context, String), but catches the possible UnsupportedEncodingException internally, by logging an error.

Parameters:

ctx - the context in which to attempt the tweet

sTweet - the tweet text

Returns:

true if the attempt succeeded, or false if an UnsupportedEncodingException was caught

unregister

public static boolean unregister(android.content.Context ctx,
                                 android.content.BroadcastReceiver rcv)

Safe and idempotent method for unregistering a BroadcastReceiver which might or might not still be registered in the given Context.

Parameters:

ctx - the context in which the receiver might be registered

rcv - the receiver to be unregistered

Returns:

true only if the unregister operation was completed without throwing an exception

Since:

zer0bandwidth-net/android 0.1.7 (#50)