PdfViewerFragment

Artifact: androidx.pdf:pdf-viewer-fragment

Kotlin |Java

public class PdfViewerFragment extends Fragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	androidx.pdf.viewer.fragment.PdfViewerFragment

A Fragment that renders a PDF document.

A [PdfViewerFragment] that can display paginated PDFs. The viewer includes a FAB for annotation support and a search menu. Each page is rendered in its own View. Upon creation, this fragment displays a loading spinner.

Rendering is done in 2 passes:

Layout: Request the page data, get the dimensions and set them as measure for the image view.
Render: Create bitmap(s) at adequate dimensions and attach them to the page view.

The layout pass is progressive: starts with a few first pages of the document, then reach further as the user scrolls down (and ultimately spans the whole document). The rendering pass is tightly limited to the currently visible pages. Pages that are scrolled past (become not visible) have their bitmaps released to free up memory.

Note that every activity/fragment that uses this class has to be themed with Theme.AppCompat or a theme that extends that theme.

See also
`documentUri`

Summary

Public constructors
`PdfViewerFragment()`

Public methods
`final Uri`	`getDocumentUri()` The URI of the PDF document to display defaulting to `null`.
`final boolean`	`isTextSearchActive()` Controls whether text search mode is active.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`View`	`onCreateView( @NonNull LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState )` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView` has been detached from the fragment.
`void`	`onLoadDocumentError(@NonNull Throwable error)` Invoked when a problem arises during the loading process of the PDF document.
`void`	`onLoadDocumentSuccess()` Invoked when the document has been fully loaded, processed, and the initial pages are displayed within the viewing area.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(@NonNull Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(@NonNull View view, Bundle savedInstanceState)` Called immediately after `onCreateView` has returned, but before any saved state has been restored in to the view.
`final void`	`setDocumentUri(Uri documentUri)` The URI of the PDF document to display defaulting to `null`.
`final void`	`setTextSearchActive(boolean isTextSearchActive)` Controls whether text search mode is active.

Inherited methods

From androidx.fragment.app.Fragment

`void`	`dump( @NonNull String prefix, @Nullable FileDescriptor fd, @NonNull PrintWriter writer, @Nullable String[] args )` Print the Fragments's state into the given stream.
`final boolean`	`equals(@Nullable Object other)` Subclasses can not override equals().
`final @Nullable FragmentActivity`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`final @Nullable Bundle`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`final @NonNull FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`@Nullable Context`	`getContext()` Return the `Context` this fragment is currently associated with.
`@NonNull CreationExtras`	`@CallSuper getDefaultViewModelCreationExtras()` The `Fragment's arguments` when this is first called will be used as the defaults to any `androidx.lifecycle.SavedStateHandle` passed to a view model created using this extra.
`@NonNull ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`@Nullable Object`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`@Nullable Object`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`final @Nullable FragmentManager`	`getFragmentManager()` This method is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null.
`final @Nullable Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final @NonNull LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`@NonNull Lifecycle`	`getLifecycle()` Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`@NonNull LoaderManager`	`getLoaderManager()` This method is deprecated. Use `LoaderManager.getInstance(this)`.
`final @Nullable Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`final @NonNull FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`@Nullable Object`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final @NonNull Resources`	`getResources()` Return `requireActivity().getResources()`.
`final boolean`	`getRetainInstance()` This method is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`@Nullable Object`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`final @NonNull SavedStateRegistry`	`getSavedStateRegistry()`
`@Nullable Object`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`@Nullable Object`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final @NonNull String`	`getString(@StringRes int resId)` Return a localized string from the application's package's default string table.
`final @NonNull String`	`getString(@StringRes int resId, @Nullable Object formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `java.util.Formatter` and format.
`final @Nullable String`	`getTag()` Get the tag name of the fragment, if specified.
`final @Nullable Fragment`	`getTargetFragment()` This method is deprecated. Instead of using a target fragment to pass results, use `setFragmentResult` to deliver results to `FragmentResultListener` instances registered by other fragments via `setFragmentResultListener`.
`final int`	`getTargetRequestCode()` This method is deprecated. When using the target fragment replacement of `setFragmentResultListener` and `setFragmentResult`, consider using `setArguments` to pass a `requestKey` if you need to support dynamic request keys.
`final @NonNull CharSequence`	`getText(@StringRes int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()` This method is deprecated. Use `setMaxLifecycle` instead.
`@Nullable View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView`), if provided.
`@NonNull LifecycleOwner`	`@MainThread getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`@NonNull LiveData<@NonNull LifecycleOwner>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`@NonNull ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment
`final int`	`hashCode()` Subclasses can not override hashCode().
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`@MainThread @CallSuper onActivityCreated(@Nullable Bundle savedInstanceState)` This method is deprecated. use `onViewCreated` for code touching the view created by `onCreateView` and `onCreate` for other initialization.
`void`	`onActivityResult(int requestCode, int resultCode, @Nullable Intent data)` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`@MainThread @CallSuper onAttach(@NonNull Activity activity)` This method is deprecated. See `onAttach`.
`void`	`@MainThread @CallSuper onAttach(@NonNull Context context)` Called when a fragment is first attached to its context.
`void`	`@MainThread onAttachFragment(@NonNull Fragment childFragment)` This method is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager.
`void`	`@CallSuper onConfigurationChanged(@NonNull Configuration newConfig)`
`boolean`	`@MainThread onContextItemSelected(@NonNull MenuItem item)` This hook is called whenever an item in a context menu is selected.
`@Nullable Animation`	`@MainThread onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`@Nullable Animator`	`@MainThread onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`@MainThread onCreateContextMenu( @NonNull ContextMenu menu, @NonNull View v, @Nullable ContextMenu.ContextMenuInfo menuInfo )` Called when a context menu for the `view` is about to be shown.
`void`	`@MainThread onCreateOptionsMenu(@NonNull Menu menu, @NonNull MenuInflater inflater)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread onDestroyOptionsMenu()` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread @CallSuper onDetach()` Called when the fragment is no longer attached to its activity.
`@NonNull LayoutInflater`	`onGetLayoutInflater(@Nullable Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`@MainThread onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden` of the fragment or another fragment in its hierarchy has changed.
`void`	`@UiThread @CallSuper onInflate( @NonNull Activity activity, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )` This method is deprecated. See `onInflate`.
`void`	`@UiThread @CallSuper onInflate( @NonNull Context context, @NonNull AttributeSet attrs, @Nullable Bundle savedInstanceState )` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`@MainThread @CallSuper onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`@MainThread onOptionsItemSelected(@NonNull MenuItem item)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread onOptionsMenuClosed(@NonNull Menu menu)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread @CallSuper onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`@MainThread onPrepareOptionsMenu(@NonNull Menu menu)` This method is deprecated. `androidx.activity.ComponentActivity` now implements `MenuHost`, an interface that allows any component, including your activity itself, to add menu items by calling addMenuProvider without forcing all components through this single method override.
`void`	`@MainThread onPrimaryNavigationFragmentChanged( boolean isPrimaryNavigationFragment )` Callback for when the primary navigation state of this Fragment has changed.
`void`	`onRequestPermissionsResult( int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults )` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`@MainThread @CallSuper onViewStateRestored(@Nullable Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition` or `executePendingTransactions` has been called.
`final void`	`postponeEnterTransition(long duration, @NonNull TimeUnit timeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition`.
`final @NonNull ActivityResultLauncher<@NonNull I>`	`@MainThread <I extends Object, O extends Object> registerForActivityResult( @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract, @NonNull ActivityResultCallback<@NonNull O> callback )` Register a request to `start an activity for result`, designated by the given `contract`.
`final @NonNull ActivityResultLauncher<@NonNull I>`	`@MainThread <I extends Object, O extends Object> registerForActivityResult( @NonNull ActivityResultContract<@NonNull I, @NonNull O> contract, @NonNull ActivityResultRegistry registry, @NonNull ActivityResultCallback<@NonNull O> callback )` Register a request to `start an activity for result`, designated by the given `contract`.
`void`	`registerForContextMenu(@NonNull View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(@NonNull String[] permissions, int requestCode)` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`final @NonNull FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final @NonNull Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`final @NonNull Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final @NonNull FragmentManager`	`requireFragmentManager()` This method is deprecated. This has been renamed to `getParentFragmentManager()` to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.
`final @NonNull Object`	`requireHost()` Return the host object of this fragment.
`final @NonNull Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`final @NonNull View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView`).
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the the return transition and reenter transition overlap or not.
`void`	`setArguments(@Nullable Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(@Nullable SharedElementCallback callback)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`void`	`setEnterTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(@Nullable SharedElementCallback callback)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`void`	`setExitTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`void`	`setHasOptionsMenu(boolean hasMenu)` This method is deprecated. This method is no longer needed when using a `MenuProvider` to provide a `Menu` to your activity, which replaces `onCreateOptionsMenu` as the recommended way to provide a consistent, optionally `Lifecycle`-aware, and modular way to handle menu creation and item selection.
`void`	`setInitialSavedState(@Nullable Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void`	`setRetainInstance(boolean retain)` This method is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment.
`void`	`setReturnTransition(@Nullable Object transition)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`void`	`setSharedElementEnterTransition(@Nullable Object transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(@Nullable Object transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(@Nullable Fragment fragment, int requestCode)` This method is deprecated. Instead of using a target fragment to pass results, the fragment requesting a result should use `setFragmentResultListener` to register a `FragmentResultListener` with a `requestKey` using its `parent fragment manager`.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated. If you are manually calling this method, use `setMaxLifecycle` instead.
`boolean`	`shouldShowRequestPermissionRationale(@NonNull String permission)` Gets whether you should show UI with rationale before requesting a permission.
`void`	`startActivity(@NonNull Intent intent)` Call startActivity from the fragment's containing Activity.
`void`	`startActivity(@NonNull Intent intent, @Nullable Bundle options)` Call startActivity from the fragment's containing Activity.
`void`	`startActivityForResult(@NonNull Intent intent, int requestCode)` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`startActivityForResult( @NonNull Intent intent, int requestCode, @Nullable Bundle options )` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`startIntentSenderForResult( @NonNull IntentSender intent, int requestCode, @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, @Nullable Bundle options )` This method is deprecated. This method has been deprecated in favor of using the Activity Result API which brings increased type safety via an `ActivityResultContract` and the prebuilt contracts for common intents available in `androidx.activity.result.contract.ActivityResultContracts`, provides hooks for testing, and allow receiving results in separate, testable classes independent from your fragment.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition` was called.
`@NonNull String`	`toString()`
`void`	`unregisterForContextMenu(@NonNull View view)` Prevents a context menu to be shown for the given view.

Public constructors

PdfViewerFragment

Added in 1.0.0-alpha01

public PdfViewerFragment()

Public methods

getDocumentUri

Added in 1.0.0-alpha01

public final Uri getDocumentUri()

The URI of the PDF document to display defaulting to null.

When this property is set, the fragment begins loading the PDF document. A visual indicator is displayed while the document is being loaded. Once the loading is fully completed, the onLoadDocumentSuccess callback is invoked. If an error occurs during the loading phase, the onLoadDocumentError callback is invoked with the exception.

Note: This property should only be set when the fragment is in the started state.

isTextSearchActive

Added in 1.0.0-alpha01

public final boolean isTextSearchActive()

Controls whether text search mode is active. Defaults to false.

When text search mode is activated, the search menu becomes visible, and search functionality is enabled. Deactivating text search mode hides the search menu, clears search results, and removes any search-related highlights.

Note: This property should only be set once the [documentUri] is set.

onCreate

public void onCreate(Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach and before onCreateView.

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a androidx.lifecycle.LifecycleObserver on the activity's Lifecycle, removing it when it receives the CREATED callback.

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Parameters
`Bundle savedInstanceState`	If the fragment is being re-created from a previous saved state, this is the state.

onCreateView

public View onCreateView(
    @NonNull LayoutInflater inflater,
    ViewGroup container,
    Bundle savedInstanceState
)

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between onCreate and onViewCreated.

A default View can be returned by calling Fragment in your constructor. Otherwise, this method returns null.

It is recommended to only inflate the layout in this method and move logic that operates on the returned View to onViewCreated.

If you return a View from here, you will later be called in onDestroyView when the view is being released.

Parameters
`@NonNull LayoutInflater inflater`	The LayoutInflater object that can be used to inflate any views in the fragment,
`ViewGroup container`	If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
`Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View`	Return the View for the fragment's UI, or null.

onDestroy

public void onDestroy()

Called when the fragment is no longer in use. This is called after onStop and before onDetach.

onDestroyView

public void onDestroyView()

Called when the view previously created by onCreateView has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after onStop and before onDestroy. It is called regardless of whether onCreateView returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

onLoadDocumentError

Added in 1.0.0-alpha01

public void onLoadDocumentError(@NonNull Throwable error)

Invoked when a problem arises during the loading process of the PDF document. This callback provides details about the encountered error, allowing for appropriate error handling and user notification.

Note that this callback is dispatched only when the fragment is fully created and not yet destroyed, i.e., after [onCreate] has fully run and before [onDestroy] runs, and only on the main thread.

Parameters
`@NonNull Throwable error`	`Throwable` that occurred during document loading.

onLoadDocumentSuccess

Added in 1.0.0-alpha01

public void onLoadDocumentSuccess()

Invoked when the document has been fully loaded, processed, and the initial pages are displayed within the viewing area. This callback signifies that the document is ready for user interaction.

Note that this callback is dispatched only when the fragment is fully created and not yet destroyed, i.e., after [onCreate] has fully run and before [onDestroy] runs, and only on the main thread.

onResume

public void onResume()

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

onSaveInstanceState

public void onSaveInstanceState(@NonNull Bundle outState)

Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to onCreate, onCreateView, and onViewCreated.

This corresponds to Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: this method may be called at any time before onDestroy. There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Parameters
`@NonNull Bundle outState`	Bundle in which to place your saved state.

onStart

public void onStart()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

onStop

public void onStop()

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

onViewCreated

public void onViewCreated(@NonNull View view, Bundle savedInstanceState)

Called immediately after onCreateView has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point.

Parameters
`@NonNull View view`	The View returned by `onCreateView`.
`Bundle savedInstanceState`	If non-null, this fragment is being re-constructed from a previous saved state as given here.

setDocumentUri

Added in 1.0.0-alpha01

public final void setDocumentUri(Uri documentUri)

The URI of the PDF document to display defaulting to null.

Note: This property should only be set when the fragment is in the started state.

setTextSearchActive

Added in 1.0.0-alpha01

public final void setTextSearchActive(boolean isTextSearchActive)

Controls whether text search mode is active. Defaults to false.

Note: This property should only be set once the [documentUri] is set.