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
```
public abstract class PdfDocumentFragment<S extends Configurable.Settings>
extends Fragment
                    
```
A PdfDocumentFragment renders a single PDF document.

Field Summary

Fields
Modifier and Type	Field	Description
`private final StateFlow<Integer>`	`pageIndex`
`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`

Constructor Summary

Constructors
Constructor	Description
`PdfDocumentFragment()`

Method Summary

Modifier and Type	Method	Description
`abstract StateFlow<Integer>`	`getPageIndex()`	Current page index displayed in the PDF document.
`Lifecycle`	`getLifecycle()`
`ViewModelStore`	`getViewModelStore()`
`CreationExtras`	`getDefaultViewModelCreationExtras()`
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`final SavedStateRegistry`	`getSavedStateRegistry()`
`abstract Boolean`	`goToPageIndex(Integer index, Boolean animated)`	Jumps to the given page index.
`abstract Unit`	`applySettings(S settings)`	Submits a new set of settings.

Methods inherited from class org.readium.r2.navigator.pdf.PdfDocumentFragment
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, onCreate, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onResume, onSaveInstanceState, onStart, onStop, onViewCreated, 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PdfDocumentFragment
```
PdfDocumentFragment()
```

Method Detail

getPageIndex
```
 abstract StateFlow<Integer> getPageIndex()
```
Current page index displayed in the PDF document.

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

getViewModelStore

@NonNull() ViewModelStore getViewModelStore()

getDefaultViewModelCreationExtras

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

getDefaultViewModelProviderFactory

@NonNull() ViewModelProvider.Factory getDefaultViewModelProviderFactory()

getSavedStateRegistry

@NonNull() final SavedStateRegistry getSavedStateRegistry()

goToPageIndex
```
 abstract Boolean goToPageIndex(Integer index, Boolean animated)
```
Jumps to the given page index.

Parameters:

animated - Indicates if the transition should be animated.

applySettings

 abstract Unit applySettings(S settings)

Submits a new set of settings.

Class PdfDocumentFragment

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PdfDocumentFragment

Method Detail

getPageIndex

getLifecycle

getViewModelStore

getDefaultViewModelCreationExtras

getDefaultViewModelProviderFactory

getSavedStateRegistry

goToPageIndex

applySettings