nutrient/com.pspdfkit.ui/PdfUiFragment

PdfUiFragment

open class PdfUiFragment : Fragment, PdfUi

This fragment provides the same UI as PdfActivity. It can be used inside any view hierarchy but use is limited to one instance per Activity, unless pdfFragmentTag is used to set a unique fragment tag for each instance.

Inheritors

InstantPdfUiFragment

Constructors

PdfUiFragment

constructor()

Properties

implementation

open val implementation: PdfUiImpl

The current implementation of the PDF UI.

Functions

getConfiguration

@NonNull

open fun getConfiguration(): PdfActivityConfiguration

Returns the PdfActivityConfiguration that was provided while launching this pdf UI.

getPdfFragment

@Nullable

open fun getPdfFragment(): PdfFragment

Returns the that is used to show the document.

invalidateToolbarItems

open fun invalidateToolbarItems()

Rebuilds the toolbar items like invalidateToolbarItems.

onActivityResult

open fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent)

onBackPressed

open fun onBackPressed(): Boolean

Call this from your activity to properly close the UI when pressing back.

onConfigurationChanged

open fun onConfigurationChanged(@NonNull newConfig: Configuration)

Called when a device configuration change occurs while the fragment is running.

onCreateView

@Nullable

open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup, @Nullable savedInstanceState: Bundle): View

Called to create and return the view hierarchy for this fragment.

onDestroy

open fun onDestroy()

Called when the fragment is being destroyed.

onOptionsItemSelected

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

onPause

open fun onPause()

Called when the fragment is pausing.

onResume

open fun onResume()

Called when the fragment is visible and actively running.

onSaveInstanceState

open fun onSaveInstanceState(@NonNull outState: Bundle)

Called to save instance state before the fragment is destroyed.

onSetActivityTitle

open fun onSetActivityTitle(@NonNull configuration: PdfActivityConfiguration, @Nullable document: PdfDocument)

Called when activity title must be set - before and after document was loaded.

onStart

open fun onStart()

Called when the fragment becomes visible to the user.

onStop

open fun onStop()

Called when the fragment is no longer visible.

onUserInterfaceVisibilityChanged

open fun onUserInterfaceVisibilityChanged(visible: Boolean)

Called when user interface visibility have changed.

setConfiguration

open fun setConfiguration(@NonNull configuration: PdfActivityConfiguration)

Replaces activity configuration.

setOnToolbarItemClickListener

open fun setOnToolbarItemClickListener(@Nullable listener: OnToolbarItemClickListener)

Sets the item click listener like setOnToolbarItemClickListener, and can be called before this fragment has a view.

setOnToolbarNavigationClickListener

open fun setOnToolbarNavigationClickListener(@Nullable listener: OnToolbarNavigationClickListener)

Sets the navigation click listener like setOnToolbarNavigationClickListener, and can be called before this fragment has a view.

setToolbarItemsProvider

open fun setToolbarItemsProvider(@Nullable provider: ToolbarItemsProvider)

Sets the items provider like setToolbarItemsProvider, and can be called before this fragment has a view.

setToolbarNavigationIcon

open fun setToolbarNavigationIcon(@Nullable icon: ToolbarIcon, @Nullable contentDescription: String)

Sets the navigation icon like setToolbarNavigationIcon, and can be called before this fragment has a view.