com.atakmap.android.preference

Class AtakPreferenceFragment

java.lang.Object

android.app.Fragment

android.preference.PreferenceFragment

com.atakmap.android.preference.AtakPreferenceFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.view.View.OnCreateContextMenuListener

Direct Known Subclasses:

ActionBarPreferences, AdvancedLoggingPreferenceFragment, AlertPreferenceFragment, AppMgmtPreferenceFragment, AtakAccountsFragment, BloodHoundPreferenceFragment, BluetoothPrefsFragment, ChatPrefsFragment, ControlPrefsFragment, CustomActionBarFragment, DevicePreferenceFragment, DisplayPrefsFragment, ElevationOverlaysPreferenceFragment, FiresPreferenceFragment, GeocoderPreferenceFragment, GridLinesPreferenceFragment, ImportStyleDefaultPreferenceFragment, IsrvNetworkPreferenceFragment, LayerPreferenceFragment, LoggingPreferenceFragment, LRFPreferenceFragment, MainPreferencesFragment, MediaPreferenceFragment, MissionPackagePreferenceFragment, MyPreferenceFragment, NetworkConnectionPreferenceFragment, NetworkGPSPreferenceFragment, NetworkPreferenceFragment, NightVisionPreferenceFragment, OffscreenIndicatorsPrefsFragment, PluginPreferenceFragment, ReportingPreferenceFragment, RoutePreferenceFragment, SelfMarkerCustomFragment, SupportPreferenceFragment, TadilJPreferenceFragment, ToolsPreferenceFragment, TrackHistoryPrefsFragment, UnitDisplayPreferenceFragment, WMSPreferenceFragment

public abstract class AtakPreferenceFragment
extends android.preference.PreferenceFragment

Nested Class Summary

Nested classes/interfaces inherited from class android.preference.PreferenceFragment

android.preference.PreferenceFragment.OnPreferenceStartFragmentCallback

Nested classes/interfaces inherited from class android.app.Fragment

android.app.Fragment.InstantiationException, android.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
protected android.os.Bundle	_externalPreferenceBundle
static java.lang.String	TAG

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
AtakPreferenceFragment(int resourceID, int summaryID) Construct a preference fragment with a provided resource identifier

Method Summary

Modifier and Type	Method and Description
void	addPreferences(android.os.Bundle bundle)
void	addPreferencesFromIntent(android.content.Intent intent)
void	addPreferencesFromResource(int preferencesResId)
static void	checkKeyGuard(android.app.Activity activity)
static void	checkScreenLock(android.app.Activity activity)
android.preference.Preference	findPreference(java.lang.CharSequence key)
static int	getOrientation(android.content.Context context)
int	getResourceID()
java.lang.String	getSubTitle() Fragment implementations should return the sub title for display in action bar
static java.lang.String	getSubTitle(android.content.Context context, java.lang.String parent, java.lang.String title)
java.lang.String	getSubTitle(java.lang.String parent, java.lang.String title)
java.lang.String	getSummary()
int	getSummaryID()
protected static java.util.List<PreferenceSearchIndex>	index(android.content.Context context, java.lang.Class<? extends AtakPreferenceFragment> clazz, int summaryResourceId, int drawableResourceId)
protected static java.util.List<PreferenceSearchIndex>	index(android.content.Context context, java.lang.Class<? extends AtakPreferenceFragment> clazz, int summaryResourceId, java.lang.Integer parentSummaryResourceId, int drawableResourceId) Create search index for the specific preference fragment
protected static java.util.List<PreferenceSearchIndex>	index(android.content.Context context, java.lang.Class<? extends AtakPreferenceFragment> clazz, java.lang.String key, int summaryResourceId, int parentSummaryResourceId, int drawableResourceId, java.lang.String... terms)
static java.util.List<PreferenceSearchIndex>	index(ToolsPreferenceFragment.ToolPreference pref)
void	onCreate(android.os.Bundle savedInstanceState)
void	onDestroy()
void	onResume()
protected void	printBundleContents(java.lang.String tag, android.os.Bundle bundle)
static void	removeMainWindowActivity()
protected void	removePreference(android.preference.Preference preference) Method to assist in removal of a preference.
static void	setContext(android.content.Context c) For plugins we are REQUIRED to set the application context to the ATAK owned Activity and not the context owned by the plugin.
static void	setMainWindowActivity(android.app.Activity activity)
static void	setOrientation(android.app.Activity activity)
static void	setOrientation(android.app.Activity activity, boolean force) sets the orientation of the screen.
protected void	setPreferenceState(android.preference.Preference p, boolean state) Ability to programatically toggle on or off the state of the preference
static void	setSoftKeyIllumination(android.app.Activity activity) Based on the curent preferences, set the soft illumination key based according to the google android documentation.
protected void	showScreen(android.preference.PreferenceFragment pf)
protected void	showScreen(android.preference.PreferenceFragment pf, java.lang.String title)

Methods inherited from class android.preference.PreferenceFragment

getPreferenceManager, getPreferenceScreen, onActivityCreated, onActivityResult, onCreateView, onDestroyView, onPreferenceTreeClick, onSaveInstanceState, onStart, onStop, onViewCreated, setPreferenceScreen

Methods inherited from class android.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isRemoving, isResumed, isStateSaved, isVisible, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onTrimMemory, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

_externalPreferenceBundle

protected android.os.Bundle _externalPreferenceBundle

Constructor Detail

AtakPreferenceFragment

public AtakPreferenceFragment(int resourceID,
                              int summaryID)

Construct a preference fragment with a provided resource identifier

Parameters:

resourceID - the resource id that describes the preference fragment.

summaryID - the resource id that describes the summary/label.

Method Detail

setContext

public static void setContext(android.content.Context c)

For plugins we are REQUIRED to set the application context to the ATAK owned Activity and not the context owned by the plugin.

getResourceID

public final int getResourceID()

getSummaryID

public final int getSummaryID()

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class android.preference.PreferenceFragment

addPreferencesFromResource

public void addPreferencesFromResource(int preferencesResId)

Overrides:

addPreferencesFromResource in class android.preference.PreferenceFragment

addPreferencesFromIntent

public void addPreferencesFromIntent(android.content.Intent intent)

Overrides:

addPreferencesFromIntent in class android.preference.PreferenceFragment

findPreference

public android.preference.Preference findPreference(java.lang.CharSequence key)

Overrides:

findPreference in class android.preference.PreferenceFragment

onResume

public void onResume()

Overrides:

onResume in class android.app.Fragment

onDestroy

public void onDestroy()

Overrides:

onDestroy in class android.preference.PreferenceFragment

showScreen

protected void showScreen(android.preference.PreferenceFragment pf)

showScreen

protected void showScreen(android.preference.PreferenceFragment pf,
                          java.lang.String title)

getSummary

public java.lang.String getSummary()

getSubTitle

public java.lang.String getSubTitle()

Fragment implementations should return the sub title for display in action bar

Returns:

returns a subtitle.

getSubTitle

public java.lang.String getSubTitle(java.lang.String parent,
                                    java.lang.String title)

getSubTitle

public static java.lang.String getSubTitle(android.content.Context context,
                                           java.lang.String parent,
                                           java.lang.String title)

printBundleContents

protected void printBundleContents(java.lang.String tag,
                                   android.os.Bundle bundle)

getOrientation

public static int getOrientation(android.content.Context context)

setSoftKeyIllumination

public static void setSoftKeyIllumination(android.app.Activity activity)

Based on the curent preferences, set the soft illumination key based according to the google android documentation.

setOrientation

public static void setOrientation(android.app.Activity activity)

setOrientation

public static void setOrientation(android.app.Activity activity,
                                  boolean force)

sets the orientation of the screen.

Parameters:

activity - the activity to set the orientation on.

force - forces the orientation change request even if the orientation is already set correctly.

checkScreenLock

public static void checkScreenLock(android.app.Activity activity)

checkKeyGuard

public static void checkKeyGuard(android.app.Activity activity)

setMainWindowActivity

public static void setMainWindowActivity(android.app.Activity activity)

removeMainWindowActivity

public static void removeMainWindowActivity()

addPreferences

public void addPreferences(android.os.Bundle bundle)

setPreferenceState

protected void setPreferenceState(android.preference.Preference p,
                                  boolean state)

Ability to programatically toggle on or off the state of the preference

Parameters:

p - the preference to enable or disable.

state - the state of the preference (true enabled, false disabled)

removePreference

protected void removePreference(android.preference.Preference preference)

Method to assist in removal of a preference. Once removed there really is no way to add it back in.

Parameters:

preference - the preference to remove

index

protected static java.util.List<PreferenceSearchIndex> index(android.content.Context context,
                                                             java.lang.Class<? extends AtakPreferenceFragment> clazz,
                                                             int summaryResourceId,
                                                             int drawableResourceId)

index

protected static java.util.List<PreferenceSearchIndex> index(android.content.Context context,
                                                             java.lang.Class<? extends AtakPreferenceFragment> clazz,
                                                             int summaryResourceId,
                                                             java.lang.Integer parentSummaryResourceId,
                                                             int drawableResourceId)

Create search index for the specific preference fragment

Parameters:

context -

clazz -

summaryResourceId -

drawableResourceId -

Returns:

null if there is an error, otherwise returns a PreferenceSearchIndex object created from the provided AtakPreferenceFragment.class.

index

protected static java.util.List<PreferenceSearchIndex> index(android.content.Context context,
                                                             java.lang.Class<? extends AtakPreferenceFragment> clazz,
                                                             java.lang.String key,
                                                             int summaryResourceId,
                                                             int parentSummaryResourceId,
                                                             int drawableResourceId,
                                                             java.lang.String... terms)

index

public static java.util.List<PreferenceSearchIndex> index(ToolsPreferenceFragment.ToolPreference pref)