nutrient/com.pspdfkit.ui

Package-level declarations

UI components (activities, fragments and views).

Types

open class AnnotationCreatorInputDialogFragment : DialogFragment

AnnotationCreatorInputDialogFragment facilitates setting the annotation creator.

open class AppCompatTextViewTint : AppCompatTextView

TextView class that extends support to drawable tint for Android API lower than 23 by using style attribute pspdf__drawableTint.

DocumentCoordinator

interface DocumentCoordinator

Coordinates loading and display of multiple documents in com.pspdfkit.ui.PdfActivity.

DocumentDescriptor

open class DocumentDescriptor : Parcelable

Describes a document and its UI state.

EmptyPdfActivityView

open class EmptyPdfActivityView : LinearLayout

The view that is displayed in the PdfActivity when no document is set.

FloatingHintEditText

open class FloatingHintEditText : LocalizedEditText

An AppCompatEditText extension containing a floating hint text, a colored underline and bottom error text.

FloatingHintPasswordEditText

open class FloatingHintPasswordEditText : FloatingHintEditText

An AppCompatEditText extension for passwords containing a floating hint text, a colored underline and bottom error text.

LocalizedButton

open class LocalizedButton : AppCompatButton

This is a Button that will use registered com.pspdfkit.listeners.LocalizationListener to localize its contents.

LocalizedEditText

open class LocalizedEditText : AppCompatEditText

This is an EditText that will use registered com.pspdfkit.listeners.LocalizationListener to localize its contents.

LocalizedSwitch

open class LocalizedSwitch : SwitchCompat

This is a Switch that will use registered com.pspdfkit.listeners.LocalizationListener to localize its contents.

LocalizedTextView

open class LocalizedTextView : AppCompatTextViewTint

This is a TextView that will use registered com.pspdfkit.listeners.LocalizationListener to localize its contents.

PageObjectProvider

interface PageObjectProvider

Base class for com.pspdfkit.ui.drawable.PdfDrawableProvider and [ ]. You don't need to override this class in your application.

PdfActivity

open class PdfActivity : AppCompatActivity, PdfUi, PdfActivityListener, PdfActivityComponentsApi

Activity with fully integrated views and behaviour.

PdfActivityIntentBuilder

class PdfActivityIntentBuilder : BasePdfUiBuilder<PdfActivityIntentBuilder>

Builder used for creating an intent for starting PdfActivity.

PdfDocumentInfoView

open class PdfDocumentInfoView : PdfOutlineView

A specialized view that displays only the document information section.

PdfFocusRelativeLayout

open class PdfFocusRelativeLayout : RelativeLayout

Implements custom focus searching logic to make keyboard navigation in PdfActivity more intuitive.

PdfFragment

open class PdfFragment : Fragment, DocumentListener, DocumentScrollListener, PdfDrawableManager, ContentEditingManager, FormManager, TextSelectionManager, SpecialModeManager, PageNavigator, OnAnnotationSelectedListener, ActionResolver, FormManager.OnFormElementSelectedListener, FormManager.OnFormElementDeselectedListener, DocumentSaver.DocumentSaveListener, CopyPasteManagerClient

Fragment that actually displays the PDF document.

PdfFrameLayout

open class PdfFrameLayout : FrameLayout

Custom implementation of framework FrameLayout that correctly supports window insets.

PdfMediaDialog

open class PdfMediaDialog : Activity, MediaViewListener

A dialog used for displaying media playback.

PdfOutlineView

open class PdfOutlineView : FrameLayout, OutlinePagerBaseView.OnHideListener, PSPDFKitViews.PSPDFView, PdfDrawableManager

A layout containing the tab on the top and a view pager for switching between the outline, the list of annotations and the bookmarks.

PdfPasswordView

open class PdfPasswordView : LinearLayoutCompat, FloatingHintEditText.EditTextListener

Password view used when accessing password protected documents.

PdfReaderView

open class PdfReaderView : FrameLayout, PSPDFKitViews.PSPDFView, ReflowProcessorListener

Reader View component containing a styled web view for showing the reflowed text.

PdfThumbnailBar

class PdfThumbnailBar @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.pspdf__thumbnailBarStyle) : AbstractComposeView, PSPDFKitViews.PSPDFView, PdfDrawableManager

Bar showing thumbnails of pages for quick selection. This view extends AbstractComposeView and uses Jetpack Compose for rendering the static thumbnail bar modes (FLOATING and PINNED). For SCROLLABLE mode, it wraps the existing PdfScrollableThumbnailBar implementation.

PdfThumbnailGrid

open class PdfThumbnailGrid : RelativeLayout, PSPDFKitViews.PSPDFView, DocumentListener, PdfDrawableManager, OnFileWriteCompleteListener

Scrollable grid view of document pages.

PdfUi

interface PdfUi : PdfActivityListener, OnMenuItemsGenerateListener, PdfActivityMenu.OnPrepareDefaultMenuItemListener, PdfActivityComponentsApi

The API that is shared between PdfActivity and PdfUiFragment.

PdfUiFragment

open class PdfUiFragment : Fragment, PdfUi

This fragment provides the same UI as PdfActivity.

PdfUiFragmentBuilder

class PdfUiFragmentBuilder : BasePdfUiBuilder<PdfUiFragmentBuilder>

Builder used for creating an PdfUiFragment.

PopupToolbar

open class PopupToolbar(pdfFragment: PdfFragment)

A class used for displaying a toolbar as a popup. It's a remake of a default Android text selection toolbar, where the items are displayed horizontally, with overflow button if there are items that don't fit the screen. Then once the overflow button is pressed, the toolbar displays other items vertically, with back button on the bottom to return to the main items.

PSPDFKitViews

interface PSPDFKitViews

Interface for convenient access to views in a PSPDFKit activity.

RecyclableFrameLayout

class RecyclableFrameLayout @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout, Recyclable

A FrameLayout that dispatches recycle calls to its child views.

UiVisibleCallback

interface UiVisibleCallback

Callback interface for receiving UI visibility state changes.

ViewStatePagerAdapter

abstract class ViewStatePagerAdapter : PagerAdapter

A simple implementation of PagerAdapter that automatically saves and restores view states when returning to pages previously removed and after view pager's state restoration.