com.badlogic.gdx.backends.android

Class AndroidFragmentApplication

java.lang.Object

androidx.fragment.app.Fragment

com.badlogic.gdx.backends.android.AndroidFragmentApplication

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.HasDefaultViewModelProviderFactory, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, androidx.savedstate.SavedStateRegistryOwner, Application, AndroidApplicationBase

public class AndroidFragmentApplication
extends androidx.fragment.app.Fragment
implements AndroidApplicationBase

Implementation of the AndroidApplicationBase that is based on the Fragment class. This class is similar in use to the AndroidApplication class, which is based on an Activity.

Author:

Bartol Karuza (me@bartolkaruza.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AndroidFragmentApplication.Callbacks Callbacks interface for letting the fragment interact with the Activitiy, parent fragment or target fragment.

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Nested classes/interfaces inherited from interface com.badlogic.gdx.Application

Application.ApplicationType

Field Summary

Fields

Modifier and Type	Field and Description
android.os.Handler	handler

Fields inherited from interface com.badlogic.gdx.backends.android.AndroidApplicationBase

MINIMUM_SDK

Fields inherited from interface com.badlogic.gdx.Application

LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_NONE

Constructor Summary

Constructors

Constructor and Description
AndroidFragmentApplication()

Method Summary

Modifier and Type	Method and Description
void	addAndroidEventListener(AndroidEventListener listener) Adds an event listener for Android specific event such as onActivityResult(...).
void	addLifecycleListener(LifecycleListener listener)
AndroidAudio	createAudio(android.content.Context context, AndroidApplicationConfiguration config) Returns the AndroidAudio to be used by the application
AndroidInput	createInput(Application activity, android.content.Context context, Object view, AndroidApplicationConfiguration config) Returns the AndroidInput to be used by the application
void	debug(String tag, String message)
void	debug(String tag, String message, Throwable exception)
void	error(String tag, String message)
void	error(String tag, String message, Throwable exception)
void	exit()
ApplicationListener	getApplicationListener()
ApplicationLogger	getApplicationLogger()
android.view.Window	getApplicationWindow() Returns the Window associated with the application
Audio	getAudio()
Clipboard	getClipboard()
android.content.Context	getContext() The application or activity context
Array<Runnable>	getExecutedRunnables() The currently executed runnables
Files	getFiles()
Graphics	getGraphics()
android.os.Handler	getHandler() Returns the Handler object created by the application
AndroidInput	getInput() Returns the AndroidInput object associated with this AndroidApplicationBase
long	getJavaHeap()
SnapshotArray<LifecycleListener>	getLifecycleListeners() Returns the LifecycleListener array associated with this AndroidApplicationBase
int	getLogLevel()
long	getNativeHeap()
Net	getNet()
Preferences	getPreferences(String name)
Array<Runnable>	getRunnables() A set of usable runnables
Application.ApplicationType	getType()
int	getVersion()
android.view.WindowManager	getWindowManager() Returns the WindowManager associated with the application
android.view.View	initializeForView(ApplicationListener listener) This method has to be called in the Fragment.onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle) method.
android.view.View	initializeForView(ApplicationListener listener, AndroidApplicationConfiguration config) This method has to be called in the Fragment.onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle) method.
void	log(String tag, String message)
void	log(String tag, String message, Throwable exception)
void	onActivityResult(int requestCode, int resultCode, android.content.Intent data)
void	onAttach(android.app.Activity activity)
void	onConfigurationChanged(android.content.res.Configuration config)
void	onDetach()
void	onPause()
void	onResume()
void	postRunnable(Runnable runnable)
void	removeAndroidEventListener(AndroidEventListener listener) Removes an event listener for Android specific event such as onActivityResult(...).
void	removeLifecycleListener(LifecycleListener listener)
void	runOnUiThread(Runnable runnable) Method signifies an intent of the caller to execute some action on the UI Thread.
void	setApplicationLogger(ApplicationLogger applicationLogger)
void	setLogLevel(int logLevel)
void	useImmersiveMode(boolean use) Activates Android 4.4 KitKat's 'Immersive Mode' feature.

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getDefaultViewModelProviderFactory, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getParentFragmentManager, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onAttach, onAttachFragment, onContextItemSelected, onCreate, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onDestroyView, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.badlogic.gdx.backends.android.AndroidApplicationBase

startActivity

Field Detail

handler

public android.os.Handler handler

Constructor Detail

AndroidFragmentApplication

public AndroidFragmentApplication()

Method Detail

onAttach

public void onAttach(android.app.Activity activity)

Overrides:

onAttach in class androidx.fragment.app.Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class androidx.fragment.app.Fragment

useImmersiveMode

public void useImmersiveMode(boolean use)

Description copied from interface: AndroidApplicationBase

Activates Android 4.4 KitKat's 'Immersive Mode' feature.

Specified by:

useImmersiveMode in interface AndroidApplicationBase

Parameters:

use - Whether or not to use immersive mode

initializeForView

public android.view.View initializeForView(ApplicationListener listener)

This method has to be called in the Fragment.onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle) method. It sets up all the things necessary to get input, render via OpenGL and so on. Uses a default AndroidApplicationConfiguration.

Note: you have to return the returned view from the Fragment.onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)!

Parameters:

listener - the ApplicationListener implementing the program logic

Returns:

the GLSurfaceView of the application

initializeForView

public android.view.View initializeForView(ApplicationListener listener,
                                           AndroidApplicationConfiguration config)

This method has to be called in the Fragment.onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle) method. It sets up all the things necessary to get input, render via OpenGL and so on. You can configure other aspects of the application with the rest of the fields in the AndroidApplicationConfiguration instance.

Note: you have to return the returned view from Fragment.onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle)

Parameters:

listener - the ApplicationListener implementing the program logic

config - the AndroidApplicationConfiguration, defining various settings of the application (use accelerometer, etc.).

Returns:

the GLSurfaceView of the application

onPause

public void onPause()

Overrides:

onPause in class androidx.fragment.app.Fragment

onResume

public void onResume()

Overrides:

onResume in class androidx.fragment.app.Fragment

getApplicationListener

public ApplicationListener getApplicationListener()

Specified by:

getApplicationListener in interface Application

getAudio

public Audio getAudio()

Specified by:

getAudio in interface Application

getFiles

public Files getFiles()

Specified by:

getFiles in interface Application

getGraphics

public Graphics getGraphics()

Specified by:

getGraphics in interface Application

getInput

public AndroidInput getInput()

Description copied from interface: AndroidApplicationBase

Returns the AndroidInput object associated with this AndroidApplicationBase

Specified by:

getInput in interface Application

Specified by:

getInput in interface AndroidApplicationBase

Returns:

the AndroidInput object

getNet

public Net getNet()

Specified by:

getNet in interface Application

getType

public Application.ApplicationType getType()

Specified by:

getType in interface Application

getVersion

public int getVersion()

Specified by:

getVersion in interface Application

getJavaHeap

public long getJavaHeap()

Specified by:

getJavaHeap in interface Application

getNativeHeap

public long getNativeHeap()

Specified by:

getNativeHeap in interface Application

getPreferences

public Preferences getPreferences(String name)

Specified by:

getPreferences in interface Application

getClipboard

public Clipboard getClipboard()

Specified by:

getClipboard in interface Application

postRunnable

public void postRunnable(Runnable runnable)

Specified by:

postRunnable in interface Application

onConfigurationChanged

public void onConfigurationChanged(android.content.res.Configuration config)

Specified by:

onConfigurationChanged in interface android.content.ComponentCallbacks

Overrides:

onConfigurationChanged in class androidx.fragment.app.Fragment

exit

public void exit()

Specified by:

exit in interface Application

debug

public void debug(String tag,
                  String message)

Specified by:

debug in interface Application

debug

public void debug(String tag,
                  String message,
                  Throwable exception)

Specified by:

debug in interface Application

log

public void log(String tag,
                String message)

Specified by:

log in interface Application

log

public void log(String tag,
                String message,
                Throwable exception)

Specified by:

log in interface Application

error

public void error(String tag,
                  String message)

Specified by:

error in interface Application

error

public void error(String tag,
                  String message,
                  Throwable exception)

Specified by:

error in interface Application

setLogLevel

public void setLogLevel(int logLevel)

Specified by:

setLogLevel in interface Application

getLogLevel

public int getLogLevel()

Specified by:

getLogLevel in interface Application

setApplicationLogger

public void setApplicationLogger(ApplicationLogger applicationLogger)

Specified by:

setApplicationLogger in interface Application

getApplicationLogger

public ApplicationLogger getApplicationLogger()

Specified by:

getApplicationLogger in interface Application

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Specified by:

addLifecycleListener in interface Application

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Specified by:

removeLifecycleListener in interface Application

getContext

public android.content.Context getContext()

Description copied from interface: AndroidApplicationBase

The application or activity context

Specified by:

getContext in interface AndroidApplicationBase

Overrides:

getContext in class androidx.fragment.app.Fragment

Returns:

the Context

getRunnables

public Array<Runnable> getRunnables()

Description copied from interface: AndroidApplicationBase

A set of usable runnables

Specified by:

getRunnables in interface AndroidApplicationBase

Returns:

the Runnable array

getExecutedRunnables

public Array<Runnable> getExecutedRunnables()

Description copied from interface: AndroidApplicationBase

The currently executed runnables

Specified by:

getExecutedRunnables in interface AndroidApplicationBase

Returns:

the Runnable array

runOnUiThread

public void runOnUiThread(Runnable runnable)

Description copied from interface: AndroidApplicationBase

Method signifies an intent of the caller to execute some action on the UI Thread.

Specified by:

runOnUiThread in interface AndroidApplicationBase

Parameters:

runnable - The runnable to be executed

getLifecycleListeners

public SnapshotArray<LifecycleListener> getLifecycleListeners()

Description copied from interface: AndroidApplicationBase

Returns the LifecycleListener array associated with this AndroidApplicationBase

Specified by:

getLifecycleListeners in interface AndroidApplicationBase

Returns:

the array of LifecycleListener's

onActivityResult

public void onActivityResult(int requestCode,
                             int resultCode,
                             android.content.Intent data)

Overrides:

onActivityResult in class androidx.fragment.app.Fragment

addAndroidEventListener

public void addAndroidEventListener(AndroidEventListener listener)

Adds an event listener for Android specific event such as onActivityResult(...).

removeAndroidEventListener

public void removeAndroidEventListener(AndroidEventListener listener)

Removes an event listener for Android specific event such as onActivityResult(...).

getApplicationWindow

public android.view.Window getApplicationWindow()

Description copied from interface: AndroidApplicationBase

Returns the Window associated with the application

Specified by:

getApplicationWindow in interface AndroidApplicationBase

Returns:

The Window associated with the application

getHandler

public android.os.Handler getHandler()

Description copied from interface: AndroidApplicationBase

Returns the Handler object created by the application

Specified by:

getHandler in interface AndroidApplicationBase

Returns:

The Handler object created by the application

createAudio

public AndroidAudio createAudio(android.content.Context context,
                                AndroidApplicationConfiguration config)

Description copied from interface: AndroidApplicationBase

Returns the AndroidAudio to be used by the application

Specified by:

createAudio in interface AndroidApplicationBase

Returns:

the created AndroidAudio

createInput

public AndroidInput createInput(Application activity,
                                android.content.Context context,
                                Object view,
                                AndroidApplicationConfiguration config)

Description copied from interface: AndroidApplicationBase

Returns the AndroidInput to be used by the application

Specified by:

createInput in interface AndroidApplicationBase

Returns:

the created AndroidInput

getWindowManager

public android.view.WindowManager getWindowManager()

Description copied from interface: AndroidApplicationBase

Returns the WindowManager associated with the application

Specified by:

getWindowManager in interface AndroidApplicationBase

Returns:

The WindowManager associated with the application