net.zer0bandwidth.android.lib.app

Class AppUtils

java.lang.Object

net.zer0bandwidth.android.lib.app.AppUtils

Direct Known Subclasses:

AppUtils

public class AppUtils
extends java.lang.Object

Provides utilities for dealing with common Android app tasks.

Since:

zer0bandwidth-net/android 0.0.1 (#5), moved in 0.0.4 (#13)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_VERSION_NOT_FOUND Replacement text to be used if the app's version name can't be found.
static java.lang.String	LOG_TAG A logging tag.

Constructor Summary

Constructors

Constructor and Description
AppUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAppNameAndVersion(android.content.Context ctx) Returns a string containing the app's name and version (if found).
static java.lang.String	getAppNameAndVersion(android.content.Context ctx, int resFormat) Returns a string containing the app's name and version (if found).
static java.lang.String	getAppVersion(android.content.Context ctx) Returns the string containing the app's current version.
static void	initBackButtonForActivity(android.app.Activity act) Initializes a back button for the activity.
static void	initBackButtonForActivity(android.support.v7.app.AppCompatActivity act) Initializes a back button for the activity.
static boolean	isTextCompatRTL(android.content.Context ctx) (in AppCompat context) Determines whether the current text layout is right-to-left.
static boolean	isTextRTL(android.content.Context ctx) (in non-compat context) Determines whether the current text layout is right-to-left.
protected static boolean	legacyIsTextRTL(android.content.res.Configuration cfg) (prior to API 17) Determines whether the current text layout is right-to-left.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

A logging tag.

APP_VERSION_NOT_FOUND

public static final java.lang.String APP_VERSION_NOT_FOUND

Replacement text to be used if the app's version name can't be found. In version 0.2.1 of this library, the value changed from an empty string to "(unknown)".

See Also:

getAppVersion(android.content.Context), getAppNameAndVersion(android.content.Context), Constant Field Values

Constructor Detail

AppUtils

public AppUtils()

Method Detail

getAppVersion

public static java.lang.String getAppVersion(android.content.Context ctx)

Returns the string containing the app's current version.

Parameters:

ctx - a context in which to fetch a package manager

Returns:

the app version as a string, or an empty string if not found

getAppNameAndVersion

public static java.lang.String getAppNameAndVersion(android.content.Context ctx)

Returns a string containing the app's name and version (if found).

Parameters:

ctx - a context in which to fetch resources

Returns:

the app's name and version, formatted as specified by the default string resource

See Also:

R.string#app_name_and_version_format

getAppNameAndVersion

public static java.lang.String getAppNameAndVersion(android.content.Context ctx,
                                                    int resFormat)

Returns a string containing the app's name and version (if found).

Parameters:

ctx - a context in which to fetch resources

resFormat - a custom string resource specifying the format in which the string should be rendered; must contain two string variables (one for the name, one for the version)

Returns:

the app's name and version, formatted as specified by the supplied string resource

initBackButtonForActivity

public static void initBackButtonForActivity(android.app.Activity act)

Initializes a back button for the activity. Call this method in your activity's onCreate method. Then, in the activity's onOptionsItemSelected method, remember to set a handler for this button.

     public boolean onOptionsItemSelected( MenuItem item )
     {
         switch( item.getItemId() )
         {
             case android.R.id.home:
                 this.onBackPressed() ;
                 break ;
             // (other items...)
         }
     }
 

Parameters:

act - an activity.

See Also:

StackOverflow answer #33041114

initBackButtonForActivity

public static void initBackButtonForActivity(android.support.v7.app.AppCompatActivity act)

Initializes a back button for the activity. Call this method in your activity's onCreate method. Then, in the activity's onOptionsItemSelected method, remember to set a handler for this button.

     public boolean onOptionsItemSelected( MenuItem item )
     {
         switch( item.getItemId() )
         {
             case android.R.id.home:
                 this.onBackPressed() ;
                 break ;
             // (other items...)
         }
     }
 

Parameters:

act - an activity.

See Also:

StackOverflow answer #33041114

isTextCompatRTL

public static boolean isTextCompatRTL(android.content.Context ctx)

(in AppCompat context) Determines whether the current text layout is right-to-left.

Parameters:

ctx - the context in which to evaluate text directionality

Returns:

true if text layout is right-to-left

Since:

zer0bandwidth-net/android 0.0.2 (#8)

See Also:

TextUtilsCompat.getLayoutDirectionFromLocale(java.util.Locale), Stack Overflow answer #14389640, Stack Overflow answer #23203698

isTextRTL

public static boolean isTextRTL(android.content.Context ctx)

(in non-compat context) Determines whether the current text layout is right-to-left.

Parameters:

ctx - the context in which to evaluate text directionality

Returns:

true if text layout is right-to-left

Since:

zer0bandwidth-net/android 0.0.2 (#8)

See Also:

TextUtils.getLayoutDirectionFromLocale(java.util.Locale), Stack Overflow answer #14389640, Stack Overflow answer #23203698

legacyIsTextRTL

protected static boolean legacyIsTextRTL(android.content.res.Configuration cfg)

(prior to API 17) Determines whether the current text layout is right-to-left. Consumed by isTextRTL(android.content.Context) and isTextCompatRTL(android.content.Context).

Parameters:

cfg - the current context's configuration

Returns:

true if text layout is right-to-left

Since:

zer0bandwidth-net/android 0.1.5 (#32)

See Also:

Stack Overflow answer #23203698