All Implemented Interfaces:

android.content.ComponentCallbacks , android.view.View.OnCreateContextMenuListener , androidx.activity.result.ActivityResultCaller , androidx.lifecycle.HasDefaultViewModelProviderFactory , androidx.lifecycle.LifecycleOwner , androidx.lifecycle.ViewModelStoreOwner , androidx.savedstate.SavedStateRegistryOwner , org.readium.r2.navigator.Navigator , org.readium.r2.navigator.OverflowableNavigator , org.readium.r2.navigator.VisualNavigator , org.readium.r2.navigator.preferences.Configurable
```
public final class PdfNavigatorFragment<S extends Configurable.Settings, P extends Configurable.Preferences<P>>
extends NavigatorFragment implements 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`PdfNavigatorFragment.Listener`
`public class`	`PdfNavigatorFragment.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final StateFlow<S>`	`settings`
`private final StateFlow<Locator>`	`currentLocator`
`private final View`	`publicationView`
`private final StateFlow<OverflowableNavigator.Overflow>`	`overflow`
`private final ReadingProgression`	`readingProgression`
`private final Integer`	`mState`
`private final Bundle`	`mSavedFragmentState`
`private final SparseArray<Parcelable>`	`mSavedViewState`
`private final Bundle`	`mSavedViewRegistryState`
`private final Boolean`	`mSavedUserVisibleHint`
`private final String`	`mWho`
`private final Bundle`	`mArguments`
`private final Fragment`	`mTarget`
`private final String`	`mTargetWho`
`private final Integer`	`mTargetRequestCode`
`private final Boolean`	`mAdded`
`private final Boolean`	`mRemoving`
`private final Boolean`	`mBeingSaved`
`private final Boolean`	`mFromLayout`
`private final Boolean`	`mInLayout`
`private final Boolean`	`mRestored`
`private final Boolean`	`mPerformedCreateView`
`private final Integer`	`mBackStackNesting`
`private final FragmentManager`	`mFragmentManager`
`private final FragmentHostCallback<?>`	`mHost`
`private final FragmentManager`	`mChildFragmentManager`
`private final Fragment`	`mParentFragment`
`private final Integer`	`mFragmentId`
`private final Integer`	`mContainerId`
`private final String`	`mTag`
`private final Boolean`	`mHidden`
`private final Boolean`	`mDetached`
`private final Boolean`	`mRetainInstance`
`private final Boolean`	`mRetainInstanceChangedWhileDetached`
`private final Boolean`	`mHasMenu`
`private final Boolean`	`mMenuVisible`
`private final ViewGroup`	`mContainer`
`private final View`	`mView`
`private final Boolean`	`mDeferStart`
`private final Boolean`	`mUserVisibleHint`
`private final Fragment.AnimationInfo`	`mAnimationInfo`
`private final Handler`	`mPostponedHandler`
`private final Runnable`	`mPostponedDurationRunnable`
`private final Boolean`	`mHiddenChanged`
`private final LayoutInflater`	`mLayoutInflater`
`private final Boolean`	`mIsCreated`
`private final String`	`mPreviousWho`
`private final Lifecycle.State`	`mMaxState`
`private final LifecycleRegistry`	`mLifecycleRegistry`
`private final FragmentViewLifecycleOwner`	`mViewLifecycleOwner`
`private final MutableLiveData<LifecycleOwner>`	`mViewLifecycleOwnerLiveData`
`private final ViewModelProvider.Factory`	`mDefaultFactory`
`private final SavedStateRegistryController`	`mSavedStateRegistryController`
`private final Lifecycle`	`lifecycle`
`private final ViewModelStore`	`viewModelStore`
`private final CreationExtras`	`defaultViewModelCreationExtras`
`private final ViewModelProvider.Factory`	`defaultViewModelProviderFactory`
`private final SavedStateRegistry`	`savedStateRegistry`
`private final Locator`	`currentLocation`
`private final StateFlow<Object>`	`presentation`

Method Summary

Modifier and Type	Method	Description
`StateFlow<S>`	`getSettings()`
`StateFlow<Locator>`	`getCurrentLocator()`
`View`	`getPublicationView()`
`StateFlow<OverflowableNavigator.Overflow>`	`getOverflow()`
`ReadingProgression`	`getReadingProgression()`
`Lifecycle`	`getLifecycle()`
`ViewModelStore`	`getViewModelStore()`
`CreationExtras`	`getDefaultViewModelCreationExtras()`
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`final SavedStateRegistry`	`getSavedStateRegistry()`
`Locator`	`getCurrentLocation()`
`StateFlow<Object>`	`getPresentation()`
`Unit`	`onCreate(Bundle savedInstanceState)`
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)`
`Unit`	`onViewCreated(View view, Bundle savedInstanceState)`
`Unit`	`onResume()`
`Unit`	`submitPreferences(P preferences)`	Submits a new set of Preferences to update the current Settings.
`Boolean`	`go(Locator locator, Boolean animated)`	Moves to the position in the publication corresponding to the given Locator.
`Boolean`	`go(Link link, Boolean animated)`	Moves to the position in the publication targeted by the given link.
`Boolean`	`goForward(Boolean animated)`	Moves to the next content portion (eg.
`Boolean`	`goBackward(Boolean animated)`	Moves to the previous content portion (eg.
`Unit`	`addInputListener(InputListener listener)`	Adds a new InputListener to receive touch, mouse or keyboard events.
`Unit`	`removeInputListener(InputListener listener)`	Removes a previously registered InputListener.

Methods inherited from class org.readium.r2.navigator.NavigatorFragment
callStartTransitionListener, createFragmentContainer, dump, equals, findFragmentByWho, generateActivityResultKey, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getAnimatingAway, getArguments, getChildFragmentManager, getContext, getEnterAnim, getEnterTransition, getEnterTransitionCallback, getExitAnim, getExitTransition, getExitTransitionCallback, getFocusedView, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLoaderManager, getNextTransition, getParentFragment, getParentFragmentManager, getPopDirection, getPopEnterAnim, getPopExitAnim, getPostOnViewCreatedAlpha, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getSharedElementSourceNames, getSharedElementTargetNames, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, hasOptionsMenu, hashCode, initState, isAdded, isDetached, isHidden, isInBackStack, isInLayout, isMenuVisible, isPostponed, isRemoving, isResumed, isStateSaved, isVisible, noteStateNotSaved, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onSaveInstanceState, onStart, onStop, onViewStateRestored, performActivityCreated, performAttach, performConfigurationChanged, performContextItemSelected, performCreate, performCreateOptionsMenu, performCreateView, performDestroy, performDestroyView, performDetach, performGetLayoutInflater, performLowMemory, performMultiWindowModeChanged, performOptionsItemSelected, performOptionsMenuClosed, performPause, performPictureInPictureModeChanged, performPrepareOptionsMenu, performPrimaryNavigationFragmentChanged, performResume, performSaveInstanceState, performStart, performStop, performViewCreated, postponeEnterTransition, postponeEnterTransition, registerForActivityResult, registerForActivityResult, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, restoreChildFragmentState, restoreViewState, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setAnimations, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setFocusedView, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setNextTransition, setPopDirection, setPostOnViewCreatedAlpha, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementNames, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
Methods inherited from class org.readium.r2.navigator.pdf.PdfNavigatorFragment
firstVisibleElementLocator
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSettings
```
 StateFlow<S> getSettings()
```

getCurrentLocator
```
 StateFlow<Locator> getCurrentLocator()
```

getPublicationView
```
 View getPublicationView()
```

getOverflow

 StateFlow<OverflowableNavigator.Overflow> getOverflow()

getReadingProgression

 ReadingProgression getReadingProgression()

getLifecycle
```
@NonNull() Lifecycle getLifecycle()
```

getViewModelStore

@NonNull() ViewModelStore getViewModelStore()

getDefaultViewModelCreationExtras

@NonNull()@CallSuper() CreationExtras getDefaultViewModelCreationExtras()

getDefaultViewModelProviderFactory

@NonNull() ViewModelProvider.Factory getDefaultViewModelProviderFactory()

getSavedStateRegistry

@NonNull() final SavedStateRegistry getSavedStateRegistry()

getCurrentLocation
```
 Locator getCurrentLocation()
```

getPresentation
```
 StateFlow<Object> getPresentation()
```

onCreate

 Unit onCreate(Bundle savedInstanceState)

onCreateView

 View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

onViewCreated

 Unit onViewCreated(View view, Bundle savedInstanceState)

onResume
```
 Unit onResume()
```

submitPreferences
```
 Unit submitPreferences(P preferences)
```
Submits a new set of Preferences to update the current Settings.
Note that the Configurable might not update its settings right away, or might even ignore some of the provided preferences. They are only used as hints to compute the new settings.

go
```
 Boolean go(Locator locator, Boolean animated)
```
Moves to the position in the publication corresponding to the given Locator.

go
```
 Boolean go(Link link, Boolean animated)
```
Moves to the position in the publication targeted by the given link.

goForward
```
 Boolean goForward(Boolean animated)
```
Moves to the next content portion (eg. page) in the reading progression direction.

goBackward
```
 Boolean goBackward(Boolean animated)
```
Moves to the previous content portion (eg. page) in the reading progression direction.

addInputListener
```
 Unit addInputListener(InputListener listener)
```
Adds a new InputListener to receive touch, mouse or keyboard events.
Registration order is critical, as listeners may consume the events and prevent others from receiving them.

removeInputListener
```
 Unit removeInputListener(InputListener listener)
```
Removes a previously registered InputListener.

Class PdfNavigatorFragment

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class org.readium.r2.navigator.NavigatorFragment

Methods inherited from class org.readium.r2.navigator.pdf.PdfNavigatorFragment

Methods inherited from class java.lang.Object

Method Detail

getSettings

getCurrentLocator

getPublicationView

getOverflow

getReadingProgression

getLifecycle

getViewModelStore

getDefaultViewModelCreationExtras

getDefaultViewModelProviderFactory

getSavedStateRegistry

getCurrentLocation

getPresentation

onCreate

onCreateView

onViewCreated

onResume

submitPreferences

go

go

goForward

goBackward

addInputListener

removeInputListener