com.codemonkeylabs.fpslibrary

Class Foreground

java.lang.Object

com.codemonkeylabs.fpslibrary.Foreground

All Implemented Interfaces:

android.app.Application.ActivityLifecycleCallbacks

public class Foreground
extends java.lang.Object
implements android.app.Application.ActivityLifecycleCallbacks

Usage: 1. Get the Foreground Singleton, passing a Context or Application object unless you are sure that the Singleton has definitely already been initialised elsewhere. 2.a) Perform a direct, synchronous check: Foreground.isForeground() / .isBackground() or 2.b) Register to be notified (useful in Service or other non-UI components): Foreground.Listener myListener = new Foreground.Listener(){ public void onBecameForeground(){ // ... whatever you want to do } public void onBecameBackground(){ // ... whatever you want to do } } public void onCreate(){ super.onCreate(); Foreground.get(this).addListener(listener); } public void onDestroy(){ super.onCreate(); Foreground.get(this).removeListener(listener); }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Foreground.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static long	CHECK_DELAY
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
Foreground()

Method Summary

Modifier and Type	Method and Description
void	addListener(Foreground.Listener listener)
static Foreground	get()
static Foreground	get(android.app.Application application)
static Foreground	get(android.content.Context ctx)
static Foreground	init(android.app.Application application) Its not strictly necessary to use this method - _usually_ invoking get with a Context gives us a path to retrieve the Application and initialise, but sometimes (e.g.
boolean	isBackground()
boolean	isForeground()
void	onActivityCreated(android.app.Activity activity, android.os.Bundle savedInstanceState)
void	onActivityDestroyed(android.app.Activity activity)
void	onActivityPaused(android.app.Activity activity)
void	onActivityResumed(android.app.Activity activity)
void	onActivitySaveInstanceState(android.app.Activity activity, android.os.Bundle outState)
void	onActivityStarted(android.app.Activity activity)
void	onActivityStopped(android.app.Activity activity)
void	removeListener(Foreground.Listener listener)

Methods inherited from class java.lang.Object

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

Field Detail

CHECK_DELAY

public static final long CHECK_DELAY

See Also:

Constant Field Values

TAG

public static final java.lang.String TAG

Constructor Detail

Foreground

public Foreground()

Method Detail

init

public static Foreground init(android.app.Application application)

Its not strictly necessary to use this method - _usually_ invoking get with a Context gives us a path to retrieve the Application and initialise, but sometimes (e.g. in test harness) the ApplicationContext is != the Application, and the docs make no guarantees.

Parameters:

application -

Returns:

an initialised Foreground instance

get

public static Foreground get(android.app.Application application)

get

public static Foreground get(android.content.Context ctx)

get

public static Foreground get()

isForeground

public boolean isForeground()

isBackground

public boolean isBackground()

addListener

public void addListener(Foreground.Listener listener)

removeListener

public void removeListener(Foreground.Listener listener)

onActivityResumed

public void onActivityResumed(android.app.Activity activity)

Specified by:

onActivityResumed in interface android.app.Application.ActivityLifecycleCallbacks

onActivityPaused

public void onActivityPaused(android.app.Activity activity)

Specified by:

onActivityPaused in interface android.app.Application.ActivityLifecycleCallbacks

onActivityCreated

public void onActivityCreated(android.app.Activity activity,
                              android.os.Bundle savedInstanceState)

Specified by:

onActivityCreated in interface android.app.Application.ActivityLifecycleCallbacks

onActivityStarted

public void onActivityStarted(android.app.Activity activity)

Specified by:

onActivityStarted in interface android.app.Application.ActivityLifecycleCallbacks

onActivityStopped

public void onActivityStopped(android.app.Activity activity)

Specified by:

onActivityStopped in interface android.app.Application.ActivityLifecycleCallbacks

onActivitySaveInstanceState

public void onActivitySaveInstanceState(android.app.Activity activity,
                                        android.os.Bundle outState)

Specified by:

onActivitySaveInstanceState in interface android.app.Application.ActivityLifecycleCallbacks

onActivityDestroyed

public void onActivityDestroyed(android.app.Activity activity)

Specified by:

onActivityDestroyed in interface android.app.Application.ActivityLifecycleCallbacks