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

Companion

object Companion

Listener

interface Listener : VisualNavigator.Listener

Properties

activity

@get:Nullable

val activity: FragmentActivity?

allowEnterTransitionOverlap

open var allowEnterTransitionOverlap: Boolean

allowReturnTransitionOverlap

open var allowReturnTransitionOverlap: Boolean

arguments

@get:Nullable

var arguments: Bundle?

childFragmentManager

@get:NonNull

val childFragmentManager: FragmentManager

context

@get:Nullable

open val context: Context?

currentLocator

open override val currentLocator: StateFlow<Locator>

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

defaultViewModelCreationExtras

@get:NonNull

@get:CallSuper

open val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

@get:NonNull

open val defaultViewModelProviderFactory: ViewModelProvider.Factory

enterTransition

@get:Nullable

open var enterTransition: Any?

exitTransition

@get:Nullable

open var exitTransition: Any?

fragmentManager

val fragmentManager: FragmentManager?

host

@get:Nullable

val host: Any?

val id: Int

isAdded

val isAdded: Boolean

isDetached

val isDetached: Boolean

isHidden

val isHidden: Boolean

isInLayout

val isInLayout: Boolean

isMenuVisible

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

val isMenuVisible: Boolean

isRemoving

val isRemoving: Boolean

isResumed

val isResumed: Boolean

isStateSaved

val isStateSaved: Boolean

isVisible

val isVisible: Boolean

layoutInflater

@get:NonNull

val layoutInflater: LayoutInflater

lifecycle

@get:NonNull

open val lifecycle: Lifecycle

loaderManager

open val loaderManager: LoaderManager

mPreviousWho

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

@Nullable

var mPreviousWho: String?

overflow

open override val overflow: StateFlow<OverflowableNavigator.Overflow>

Current presentation rendered by the navigator.

parentFragment

@get:Nullable

val parentFragment: Fragment?

parentFragmentManager

@get:NonNull

val parentFragmentManager: FragmentManager

publicationView

open override val publicationView: View

View displaying the publication.

reenterTransition

@get:Nullable

open var reenterTransition: Any?

resources

@get:NonNull

val resources: Resources

retainInstance

var retainInstance: Boolean

returnTransition

@get:Nullable

open var returnTransition: Any?

savedStateRegistry

@get:NonNull

val savedStateRegistry: SavedStateRegistry

settings

open override val settings: StateFlow<S>

Current Settings values.

sharedElementEnterTransition

@get:Nullable

open var sharedElementEnterTransition: Any?

sharedElementReturnTransition

@get:Nullable

open var sharedElementReturnTransition: Any?

tag

@get:Nullable

val tag: String?

targetFragment

val targetFragment: Fragment?

targetRequestCode

val targetRequestCode: Int

userVisibleHint

open var userVisibleHint: Boolean

view

@get:Nullable

open val view: View?

viewLifecycleOwner

@get:MainThread

@get:NonNull

open val viewLifecycleOwner: LifecycleOwner

viewLifecycleOwnerLiveData

@get:NonNull

open val viewLifecycleOwnerLiveData: LiveData<LifecycleOwner?>

viewModelStore

@get:NonNull

open val viewModelStore: ViewModelStore

Functions

addInputListener

open override fun addInputListener(listener: InputListener)

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

dump

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

firstVisibleElementLocator

open suspend fun firstVisibleElementLocator(): Locator?

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

getString

@NonNull

fun getString(@StringRes resId: Int): String

@NonNull

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

getText

@NonNull

fun getText(@StringRes resId: Int): CharSequence

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

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

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

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

goBackward

open override fun goBackward(animated: Boolean): Boolean

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

goForward

open override fun goForward(animated: Boolean): Boolean

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

hasOptionsMenu

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

fun hasOptionsMenu(): Boolean

onAttach

@MainThread

@CallSuper

open fun onAttach(@NonNull context: Context)

onConfigurationChanged

@CallSuper

open fun onConfigurationChanged(@NonNull newConfig: Configuration)

onContextItemSelected

@MainThread

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

onCreate

open override fun onCreate(savedInstanceState: Bundle?)

onCreateAnimation

@MainThread

@Nullable

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

onCreateAnimator

@MainThread

@Nullable

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

onCreateContextMenu

@MainThread

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

onCreateView

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

open fun onDestroy()

open fun onDestroyView()

open fun onDetach()

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

onHiddenChanged

@MainThread

open fun onHiddenChanged(hidden: Boolean)

onInflate

@UiThread

@CallSuper

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

onLowMemory

@MainThread

@CallSuper

open fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

onPause

@MainThread

@CallSuper

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrimaryNavigationFragmentChanged

@MainThread

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

onResume

open override fun onResume()

onSaveInstanceState

@MainThread

open fun onSaveInstanceState(@NonNull outState: Bundle)

open fun onStart()

open fun onStop()

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

onViewStateRestored

@MainThread

@CallSuper

open fun onViewStateRestored(@Nullable savedInstanceState: Bundle?)

postponeEnterTransition

open fun postponeEnterTransition()

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

registerForActivityResult

@MainThread

@NonNull

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

@MainThread

@NonNull

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)

removeInputListener

open override fun removeInputListener(listener: InputListener)

Removes a previously registered InputListener.

requireActivity

@NonNull

fun requireActivity(): FragmentActivity

requireArguments

@NonNull

fun requireArguments(): Bundle

requireContext

@NonNull

fun requireContext(): Context

requireHost

@NonNull

fun requireHost(): Any

requireParentFragment

@NonNull

fun requireParentFragment(): Fragment

requireView

@NonNull

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

startActivity

open fun startActivity(@NonNull intent: Intent)

open fun startActivity(@NonNull intent: Intent, @Nullable options: 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(@NonNull view: View)