platform_frontend_api_common_uicontrols/com.tomtom.ivi.platform.frontend.api.common.uicontrols.popover/IviPopOverFragment

IviPopOverFragment

@IviExperimental(reasons = [])

abstract class IviPopOverFragment<CTX : IviPopOverContext, VM : IviPopOverViewModel<CTX>>(viewModelClass: KClass<VM>) : Fragment, HasDefaultViewModelProviderFactory

The abstract class for fragments intended to be the content of a pop over. It has built-in mechanism to reinitialize itself with its dependencies after being recreated following a configuration change.

All dependencies which shall be retained across configuration change are stored in IviPopOverContext (or its derivations) and accessible as popOverContext after onAttach has been called on this fragment. IviPopOverContext contains basic dependencies to get IVI related information and access to its services and configuration.

If a concrete class has other dependencies than the ones available in IviPopOverContext, then define a subclass of IviPopOverContext to hold the additional dependencies.

Example of a concrete class without additional dependencies:

class ExampleViewModel(iviPopOverContext: IviPopOverContext) :
    IviPopOverViewModel<IviPopOverContext>(iviPopOverContext) {
    // ...
}

class ExampleFragment : IviPopOverFragment<IviPopOverContext, ExampleViewModel>(
    ExampleViewModel::class
) {
    // ...
}

// Usage:
val examplePopOverFragment = IviPopOverFragment.Initializer(
    ExampleFragment(),
    IviPopOverContext(frontendContext)
).popOverFragment

Example of a concrete class with additional dependency "extra":

class ExampleContext(frontendContext: FrontendContext, val extra: String) :
    IviPopOverContext(frontendContext)

class ExampleViewModel(exampleContext: ExampleContext) :
    IviPopOverViewModel<ExampleContext>(exampleContext) {
    // ...
}

class ExampleFragment : IviPopOverFragment<ExampleContext, ExampleViewModel>(
    ExampleViewModel::class
) {
    override fun onAttach(context: Context) {
        super.onAttach(context)
        Log.d("ExampleFragment", "extra = ${popOverContext.extra}")
    }
}

// Usage:
val examplePopOverFragment = IviPopOverFragment.Initializer(
   ExampleFragment(),
   ExampleContext(frontendContext, "This is an additional dependency.")
).popOverFragment

Parameters

CTX

The type of the context used to hold this fragment's dependencies.

VM

The type of the view model to be used by this fragment.

viewModelClass

The KClass information of VM.

Constructors

IviPopOverFragment

constructor(viewModelClass: KClass<VM>)

Types

open class Initializer<CTX : IviPopOverContext, F : IviPopOverFragment<CTX, *>>(val popOverFragment: F, iviPopOverContext: CTX)

Helper class to initialize the given popOverFragment with IviPopOverContext or its derivation.

Properties

defaultViewModelProviderFactory

open override val defaultViewModelProviderFactory: ViewModelProvider.Factory

Inherited properties

defaultViewModelCreationExtras

open override val defaultViewModelCreationExtras: CreationExtras

open override val lifecycle: Lifecycle

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

var mPreviousWho: String?

savedStateRegistry

override val savedStateRegistry: SavedStateRegistry

open override val viewModelStore: ViewModelStore

Functions

open override fun onAttach(context: Context)

Inherited functions

open fun dump(@NonNull p0: String, @Nullable p1: FileDescriptor?, @NonNull p2: PrintWriter, @Nullable p3: Array<String>?)

operator override fun equals(@Nullable other: Any?): Boolean

fun getActivity(): FragmentActivity?

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

fun getArguments(): Bundle?

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

open fun getContext(): Context?

getEnterTransition

open fun getEnterTransition(): Any?

getExitTransition

open fun getExitTransition(): Any?

getFragmentManager

fun ~~getFragmentManager~~(): FragmentManager?

fun getHost(): Any?

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

open fun ~~getLayoutInflater~~(@Nullable p0: Bundle?): LayoutInflater

getLoaderManager

open fun ~~getLoaderManager~~(): LoaderManager

getParentFragment

fun getParentFragment(): Fragment?

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any?

fun getResources(): Resources

getRetainInstance

fun ~~getRetainInstance~~(): Boolean

getReturnTransition

open fun getReturnTransition(): Any?

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any?

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any?

fun getString(@StringRes p0: Int): String

fun getString(@StringRes p0: Int, @Nullable vararg p1: Any): String

fun getTag(): String?

getTargetFragment

fun ~~getTargetFragment~~(): Fragment?

getTargetRequestCode

fun ~~getTargetRequestCode~~(): Int

fun getText(@StringRes p0: Int): CharSequence

getUserVisibleHint

open fun ~~getUserVisibleHint~~(): Boolean

open fun getView(): View?

getViewLifecycleOwner

open fun getViewLifecycleOwner(): LifecycleOwner

getViewLifecycleOwnerLiveData

open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>

override fun hashCode(): Int

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun hasOptionsMenu(): Boolean

fun isAdded(): Boolean

fun isDetached(): Boolean

fun isHidden(): Boolean

fun isInLayout(): Boolean

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun isMenuVisible(): Boolean

fun isRemoving(): Boolean

fun isResumed(): Boolean

fun isStateSaved(): Boolean

fun isVisible(): Boolean

onActivityCreated

open fun ~~onActivityCreated~~(@Nullable p0: Bundle?)

onActivityResult

open fun ~~onActivityResult~~(p0: Int, p1: Int, @Nullable p2: Intent?)

open fun ~~onAttach~~(@NonNull p0: Activity)

onAttachFragment

open fun ~~onAttachFragment~~(@NonNull p0: Fragment)

onConfigurationChanged

open override fun onConfigurationChanged(@NonNull p0: Configuration)

onContextItemSelected

open fun onContextItemSelected(@NonNull p0: MenuItem): Boolean

open fun onCreate(@Nullable p0: Bundle?)

onCreateAnimation

open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?

onCreateAnimator

open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?

onCreateContextMenu

open override fun onCreateContextMenu(@NonNull p0: ContextMenu, @NonNull p1: View, @Nullable p2: ContextMenu.ContextMenuInfo?)

onCreateOptionsMenu

open fun ~~onCreateOptionsMenu~~(@NonNull p0: Menu, @NonNull p1: MenuInflater)

open fun onCreateView(@NonNull p0: LayoutInflater, @Nullable p1: ViewGroup?, @Nullable p2: Bundle?): View?

open fun onDestroy()

onDestroyOptionsMenu

open fun ~~onDestroyOptionsMenu~~()

open fun onDestroyView()

open fun onDetach()

onGetLayoutInflater

open fun onGetLayoutInflater(@Nullable p0: Bundle?): LayoutInflater

onHiddenChanged

open fun onHiddenChanged(p0: Boolean)

open fun ~~onInflate~~(@NonNull p0: Activity, @NonNull p1: AttributeSet, @Nullable p2: Bundle?)

open fun onInflate(@NonNull p0: Context, @NonNull p1: AttributeSet, @Nullable p2: Bundle?)

open override fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(p0: Boolean)

onOptionsItemSelected

open fun ~~onOptionsItemSelected~~(@NonNull p0: MenuItem): Boolean

onOptionsMenuClosed

open fun ~~onOptionsMenuClosed~~(@NonNull p0: Menu)

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrepareOptionsMenu

open fun ~~onPrepareOptionsMenu~~(@NonNull p0: Menu)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

onRequestPermissionsResult

open fun ~~onRequestPermissionsResult~~(p0: Int, @NonNull p1: Array<String>, @NonNull p2: IntArray)

open fun onResume()

onSaveInstanceState

open fun onSaveInstanceState(@NonNull p0: Bundle)

open fun onStart()

open fun onStop()

open fun onViewCreated(@NonNull p0: View, @Nullable p1: Bundle?)

onViewStateRestored

open fun onViewStateRestored(@Nullable p0: Bundle?)

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(p0: Long, @NonNull p1: TimeUnit)

registerForActivityResult

override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultCallback<O>): ActivityResultLauncher<I>

override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultRegistry, @NonNull p2: ActivityResultCallback<O>): ActivityResultLauncher<I>

registerForContextMenu

open fun registerForContextMenu(@NonNull p0: View)

requestPermissions

fun ~~requestPermissions~~(@NonNull p0: Array<String>, p1: Int)

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

fun requireContext(): Context

requireFragmentManager

fun ~~requireFragmentManager~~(): FragmentManager

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

fun requireView(): View

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(p0: Boolean)

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(p0: Boolean)

open fun setArguments(@Nullable p0: Bundle?)

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable p0: SharedElementCallback?)

setEnterTransition

open fun setEnterTransition(@Nullable p0: Any?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable p0: SharedElementCallback?)

setExitTransition

open fun setExitTransition(@Nullable p0: Any?)

setHasOptionsMenu

open fun ~~setHasOptionsMenu~~(p0: Boolean)

setInitialSavedState

open fun setInitialSavedState(@Nullable p0: Fragment.SavedState?)

setMenuVisibility

open fun setMenuVisibility(p0: Boolean)

setReenterTransition

open fun setReenterTransition(@Nullable p0: Any?)

setRetainInstance

open fun ~~setRetainInstance~~(p0: Boolean)

setReturnTransition

open fun setReturnTransition(@Nullable p0: Any?)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(@Nullable p0: Any?)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(@Nullable p0: Any?)

setTargetFragment

open fun ~~setTargetFragment~~(@Nullable p0: Fragment?, p1: Int)

setUserVisibleHint

open fun ~~setUserVisibleHint~~(p0: Boolean)

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(@NonNull p0: String): Boolean

open fun startActivity(p0: Intent)

open fun startActivity(p0: Intent, @Nullable p1: Bundle?)

startActivityForResult

open fun ~~startActivityForResult~~(p0: Intent, p1: Int)

open fun ~~startActivityForResult~~(p0: Intent, p1: Int, @Nullable p2: Bundle?)

startIntentSenderForResult

open fun ~~startIntentSenderForResult~~(p0: IntentSender, p1: Int, @Nullable p2: Intent?, p3: Int, p4: Int, p5: Int, @Nullable p6: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull p0: View)