readium-navigator/org.readium.r2.navigator.pdf/PdfNavigatorFragment

PdfNavigatorFragment

class PdfNavigatorFragment<S : Configurable.Settings, P : Configurable.Preferences<P>> : NavigatorFragment, VisualNavigator, OverflowableNavigator, Configurable<S, P>

Navigator for PDF publications.

The PDF navigator delegates the actual PDF rendering to third-party engines like PDFium or PSPDFKit.

To use this Fragment, create a factory with PdfNavigatorFactory.createFragmentFactory.

Types

object Companion

interface Listener : VisualNavigator.Listener

Properties

val activity: @Nullable FragmentActivity?

allowEnterTransitionOverlap

open var allowEnterTransitionOverlap: Boolean

allowReturnTransitionOverlap

open var allowReturnTransitionOverlap: Boolean

var arguments: @Nullable Bundle?

childFragmentManager

val childFragmentManager: @NonNull FragmentManager

open val context: @Nullable Context?

open override val currentLocator: StateFlow<Locator>

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

defaultViewModelCreationExtras

open val defaultViewModelCreationExtras: @NonNull CreationExtras

defaultViewModelProviderFactory

open val defaultViewModelProviderFactory: @NonNull ViewModelProvider.Factory

enterTransition

open var enterTransition: @Nullable Any?

open var exitTransition: @Nullable Any?

fragmentManager

val fragmentManager: @Nullable FragmentManager?

val host: @Nullable 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: @NonNull LayoutInflater

open val lifecycle: @NonNull Lifecycle

open val loaderManager: @NonNull LoaderManager

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

var mPreviousWho: @Nullable String?

open override val overflow: StateFlow<OverflowableNavigator.Overflow>

Current presentation rendered by the navigator.

val parentFragment: @Nullable Fragment?

parentFragmentManager

val parentFragmentManager: @NonNull FragmentManager

publicationView

open override val publicationView: View

View displaying the publication.

reenterTransition

open var reenterTransition: @Nullable Any?

val resources: @NonNull Resources

var retainInstance: Boolean

returnTransition

open var returnTransition: @Nullable Any?

savedStateRegistry

val savedStateRegistry: @NonNull SavedStateRegistry

open override val settings: StateFlow<S>

Current Settings values.

sharedElementEnterTransition

open var sharedElementEnterTransition: @Nullable Any?

sharedElementReturnTransition

open var sharedElementReturnTransition: @Nullable Any?

val tag: @Nullable String?

val targetFragment: @Nullable Fragment?

targetRequestCode

val targetRequestCode: Int

userVisibleHint

open var userVisibleHint: Boolean

open val view: @Nullable View?

viewLifecycleOwner

@get:MainThread

open val viewLifecycleOwner: @NonNull LifecycleOwner

viewLifecycleOwnerLiveData

open val viewLifecycleOwnerLiveData: @NonNull LiveData<LifecycleOwner?>

open val viewModelStore: @NonNull ViewModelStore

Functions

addInputListener

open override fun addInputListener(listener: InputListener)

Adds a new InputListener to receive touch, mouse or keyboard events.

addOnContextAvailableListener

open fun addOnContextAvailableListener(listener: @NonNull OnContextAvailableListener)

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

firstVisibleElementLocator

open suspend fun firstVisibleElementLocator(): Locator?

Returns the Locator to the first content element that begins on the current screen.

fun getString(@StringRes resId: Int): @NonNull String

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

fun getText(@StringRes resId: Int): @NonNull CharSequence

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

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

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

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

open override fun goBackward(animated: Boolean = false): Boolean

Moves to the previous content portion (eg. page) in the reading progression direction.

open override fun goForward(animated: Boolean = false): Boolean

Moves to the next content portion (eg. page) in the reading progression direction.

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

fun hasOptionsMenu(): Boolean

onActivityCreated

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

onActivityResult

open fun ~~onActivityResult~~(requestCode: Int, resultCode: Int, data: @Nullable Intent?)

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

open fun onAttach(context: @NonNull Context)

onAttachFragment

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

onConfigurationChanged

open fun onConfigurationChanged(newConfig: @NonNull Configuration)

onContextItemSelected

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

open override fun onCreate(savedInstanceState: Bundle?)

onCreateAnimation

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

onCreateAnimator

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

onCreateContextMenu

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

onCreateOptionsMenu

open fun ~~onCreateOptionsMenu~~(menu: @NonNull Menu, inflater: @NonNull MenuInflater)

open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View

open fun onDestroy()

onDestroyOptionsMenu

open fun ~~onDestroyOptionsMenu~~()

open fun onDestroyView()

open fun onDetach()

onGetLayoutInflater

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

onHiddenChanged

open fun onHiddenChanged(hidden: Boolean)

open fun ~~onInflate~~(activity: @NonNull Activity, attrs: @NonNull AttributeSet, savedInstanceState: @Nullable Bundle?)

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

open fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

onOptionsItemSelected

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

onOptionsMenuClosed

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

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrepareOptionsMenu

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

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

onRequestPermissionsResult

open fun ~~onRequestPermissionsResult~~(requestCode: Int, permissions: @NonNull Array<out String?>, grantResults: @NonNull IntArray)

open override fun onResume()

onSaveInstanceState

open fun onSaveInstanceState(outState: @NonNull Bundle)

open fun onStart()

open fun onStop()

open override fun onViewCreated(view: View, savedInstanceState: Bundle?)

onViewStateRestored

open fun onViewStateRestored(savedInstanceState: @Nullable Bundle?)

peekAvailableContext

open fun peekAvailableContext(): @Nullable Context?

postponeEnterTransition

open fun postponeEnterTransition()

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

registerForActivityResult

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

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

registerForContextMenu

open fun registerForContextMenu(view: @NonNull View)

removeInputListener

open override fun removeInputListener(listener: InputListener)

Removes a previously registered InputListener.

removeOnContextAvailableListener

open fun removeOnContextAvailableListener(listener: @NonNull OnContextAvailableListener)

requestPermissions

fun ~~requestPermissions~~(permissions: @NonNull Array<out String?>, requestCode: Int)

requireActivity

fun requireActivity(): @NonNull FragmentActivity

requireArguments

fun requireArguments(): @NonNull Bundle

fun requireContext(): @NonNull Context

requireFragmentManager

fun ~~requireFragmentManager~~(): @NonNull FragmentManager

fun requireHost(): @NonNull Any

requireParentFragment

fun requireParentFragment(): @NonNull Fragment

fun requireView(): @NonNull View

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(callback: @Nullable SharedElementCallback?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(callback: @Nullable SharedElementCallback?)

setHasOptionsMenu

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

setInitialSavedState

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

setMenuVisibility

open fun setMenuVisibility(menuVisible: Boolean)

setTargetFragment

open fun ~~setTargetFragment~~(fragment: @Nullable Fragment?, requestCode: Int)

shouldShowRequestPermissionRationale

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

open fun startActivity(intent: @NonNull Intent)

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

startActivityForResult

open fun ~~startActivityForResult~~(intent: @NonNull Intent, requestCode: Int)

open fun ~~startActivityForResult~~(intent: @NonNull Intent, requestCode: Int, options: @Nullable Bundle?)

startIntentSenderForResult

open fun ~~startIntentSenderForResult~~(intent: @NonNull IntentSender, requestCode: Int, fillInIntent: @Nullable Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: @Nullable Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

submitPreferences

open override fun submitPreferences(preferences: P)

Submits a new set of Preferences to update the current Settings.

unregisterForContextMenu

open fun unregisterForContextMenu(view: @NonNull View)