readium-navigator/org.readium.r2.navigator/NavigatorFragment

NavigatorFragment

abstract class NavigatorFragment : Fragment, Navigator

Inheritors

EpubNavigatorFragment

ImageNavigatorFragment

PdfNavigatorFragment

Properties

val activity: FragmentActivity?

allowEnterTransitionOverlap

open var allowEnterTransitionOverlap: Boolean

allowReturnTransitionOverlap

open var allowReturnTransitionOverlap: Boolean

var arguments: Bundle?

childFragmentManager

val childFragmentManager: FragmentManager

open val context: Context?

abstract val currentLocator: StateFlow<Locator>

Current position in the publication. Can be used to save a bookmark to the current position.

defaultViewModelCreationExtras

open val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

open val defaultViewModelProviderFactory: ViewModelProvider.Factory

enterTransition

open var enterTransition: Any?

open var exitTransition: Any?

fragmentManager

val fragmentManager: FragmentManager?

val host: Any?

val id: Int

val isAdded: Boolean

val isDetached: Boolean

val isHidden: Boolean

val isInLayout: Boolean

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

val isMenuVisible: Boolean

val isRemoving: Boolean

val isResumed: Boolean

val isStateSaved: Boolean

val isVisible: Boolean

val layoutInflater: LayoutInflater

open val lifecycle: Lifecycle

open val loaderManager: LoaderManager

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

var mPreviousWho: String?

val parentFragment: Fragment?

parentFragmentManager

val parentFragmentManager: FragmentManager

reenterTransition

open var reenterTransition: Any?

val resources: Resources

var retainInstance: Boolean

returnTransition

open var returnTransition: Any?

savedStateRegistry

val savedStateRegistry: SavedStateRegistry

sharedElementEnterTransition

open var sharedElementEnterTransition: Any?

sharedElementReturnTransition

open var sharedElementReturnTransition: Any?

val tag: String?

val targetFragment: Fragment?

targetRequestCode

val targetRequestCode: Int

userVisibleHint

open var userVisibleHint: Boolean

open val view: View?

viewLifecycleOwner

@get:MainThread

open val viewLifecycleOwner: LifecycleOwner

viewLifecycleOwnerLiveData

open val viewLifecycleOwnerLiveData: LiveData<LifecycleOwner?>

open val viewModelStore: ViewModelStore

Functions

open fun dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<out String?>??)

fun getString(@StringRes resId: Int): String

fun getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any?): String

fun getText(@StringRes resId: Int): CharSequence

abstract fun go(link: Link, animated: Boolean = false): Boolean

Moves to the position in the publication targeted by the given link.

abstract fun go(locator: Locator, animated: Boolean = false): Boolean

Moves to the position in the publication corresponding to the given Locator.

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

fun hasOptionsMenu(): Boolean

open fun onAttach(@NonNull context: Context)

onConfigurationChanged

open fun onConfigurationChanged(@NonNull newConfig: Configuration)

onContextItemSelected

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

open override fun onCreate(savedInstanceState: Bundle?)

onCreateAnimation

open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation?

onCreateAnimator

open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator?

onCreateContextMenu

open fun onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenu.ContextMenuInfo?)

open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?): View?

open fun onDestroy()

open fun onDestroyView()

open fun onDetach()

onGetLayoutInflater

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

onHiddenChanged

open fun onHiddenChanged(hidden: Boolean)

open fun onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)

open fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

open fun onResume()

onSaveInstanceState

open fun onSaveInstanceState(@NonNull outState: Bundle)

open fun onStart()

open fun onStop()

open fun onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)

onViewStateRestored

open fun onViewStateRestored(@Nullable savedInstanceState: Bundle?)

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit)

registerForActivityResult

fun <I : Any?, O : Any?> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>): ActivityResultLauncher<I?>

fun <I : Any?, O : Any?> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>): ActivityResultLauncher<I?>

registerForContextMenu

open fun registerForContextMenu(@NonNull view: View)

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

fun requireContext(): Context

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

fun requireView(): View

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable callback: SharedElementCallback?)

setInitialSavedState

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

setMenuVisibility

open fun setMenuVisibility(menuVisible: Boolean)

shouldShowRequestPermissionRationale

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

open fun startActivity(@NonNull intent: Intent)

open fun startActivity(@NonNull intent: Intent, @Nullable options: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull view: View)