I
- i(java.lang.String,java.lang.String,kotlin.Array) - function in com.pspdfkit.utils.PdfLog
- Logs a INFO log message.
- i(java.lang.String,java.lang.Throwable,java.lang.String,kotlin.Array) - function in com.pspdfkit.utils.PdfLog
- Logs a INFO log message.
- i(java.lang.String,java.util.concurrent.Callable) - function in com.pspdfkit.utils.PdfLog
- Logs a INFO log message.
- IDENTITY - enum entry in com.pspdfkit.signatures.DigitalSignatureInfo.ReferenceTransformMethod
Identity — Used when signing a single object, which is specified by the value of Data in the signature reference dictionary. This transform method supports signing of FDF files.
- IDLE - enum entry in com.pspdfkit.listeners.scrolling.ScrollState
Signifies that the document is currently not moving.
- ignoreAnnotations(boolean) - function in com.pspdfkit.document.library.QueryOptions.Builder
- Prevents querying of indexed annotations.
- ignoreDocumentText(boolean) - function in com.pspdfkit.document.library.QueryOptions.Builder
- Prevents querying of indexed document text.
- IMAGE - enum entry in com.pspdfkit.configuration.signatures.SignatureCreationMode
The user selects an existing image of their signature from their photo library or files, or takes a photo of their signature written on a piece of paper.
- IMAGE - enum entry in com.pspdfkit.ui.special_mode.controller.AnnotationTool
Creates stamp annotation from user supplied bitmaps.
- IMAGE_DOCUMENT - enum entry in com.pspdfkit.LicenseFeature
Create documents from images.
- IMAGE_SHARING - enum entry in com.pspdfkit.configuration.sharing.ShareFeatures
Sharing selected image stamp annotations. Enables sharing button in the annotation editing toolbar for selected image stamp annotations.
- ImageDocument - class in com.pspdfkit.document
- An image document.
- imageDocumentFromDataProvider(com.pspdfkit.document.providers.DataProvider) - function in com.pspdfkit.ui.DocumentDescriptor
- Creates descriptor for image document loaded from data provider.
- imageDocumentFromDocumentSource(com.pspdfkit.document.DocumentSource) - function in com.pspdfkit.ui.DocumentDescriptor
- Creates descriptor for image document loaded from a document source.
- imageDocumentFromUri(android.net.Uri) - function in com.pspdfkit.ui.DocumentDescriptor
- Creates descriptor for image document loaded from URI.
- ImageDocumentLoader - class in com.pspdfkit.document
- Helper class for loading ImageDocument from a DocumentSource.
- ImageDocumentUtils - class in com.pspdfkit.document
- Collection of helper methods for working with ImageDocuments.
- ImageDocumentView(android.net.Uri,androidx.compose.ui.Modifier,com.pspdfkit.jetpack.compose.interactors.DocumentManager) - function in com.pspdfkit.jetpack.compose.views.ImageDocumentViewKt
- Composable that displays the Image in the specified Uri.
- ImageDocumentView(com.pspdfkit.jetpack.compose.interactors.DocumentState,androidx.compose.ui.Modifier,com.pspdfkit.jetpack.compose.interactors.DocumentManager) - function in com.pspdfkit.jetpack.compose.views.ImageDocumentViewKt
- Composable that displays the Document in the specified Uri.
- ImageDocumentViewKt - class in com.pspdfkit.jetpack.compose.views
- ImagePicker - class in com.pspdfkit.document.image
- A helper class for launching gallery image picker or a camera for taking a picture.
- ImagePicker.OnImagePickedListener - class in com.pspdfkit.document.image.ImagePicker
- Interface for listening for image picker results.
- IMMEDIATE - enum entry in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointingStrategy
A checkpoint is created as soon as the annotations in the document are modified, added, or removed.
- ImmersiveModeCallback - class in com.pspdfkit.ui
- IMPORT_DATA - enum entry in com.pspdfkit.annotations.actions.ActionType
- ImportDataAction - class in com.pspdfkit.annotations.actions
- Action representing request to import data.
- importDocument(android.content.Context,com.pspdfkit.document.DocumentSource,int) - function in com.pspdfkit.document.editor.PdfDocumentEditor
- Imports all the pages from a given document source to a destination index.
- importDocument(android.content.Context) - function in com.pspdfkit.ui.special_mode.controller.DocumentEditingController
- Imports all the pages from a given document source to a destination index, if no page is selected the imported document will be appended.
- importDocumentJson(com.pspdfkit.document.PdfDocument,com.pspdfkit.document.providers.DataProvider) - function in com.pspdfkit.document.formatters.DocumentJsonFormatter
- Imports a document JSON and applies its changes to the given
document
. - importDocumentJsonAsync(com.pspdfkit.document.PdfDocument,com.pspdfkit.document.providers.DataProvider) - function in com.pspdfkit.document.formatters.DocumentJsonFormatter
- Asynchronously imports a document JSON and applies its changes to the given
document
. - IN - enum entry in com.pspdfkit.annotations.measurements.Scale.UnitFrom
Inches
- IN - enum entry in com.pspdfkit.annotations.measurements.Scale.UnitTo
Inches
- INCLUDE_ANNOTATIONS - enum entry in com.pspdfkit.annotations.actions.SubmitFormAction.SubmitFormActionFlag
If set, the submitted FDF file shall include all annotations in the underlying PDF document.
This flag shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and EXPORT_FORMAT flags are clear).
- INCLUDE_APPEND_SAVES - enum entry in com.pspdfkit.annotations.actions.SubmitFormAction.SubmitFormActionFlag
If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document.
This flag shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and EXPORT_FORMAT flags are clear).
- INCLUDE_EXCLUDE - enum entry in com.pspdfkit.annotations.actions.SubmitFormAction.SubmitFormActionFlag
If set, the getFieldNames specifies fields to exclude from submit action. If not set, the getFieldNames specifies which fields to include in the submission.
- INCLUDE_NO_VALUE_FIELDS - enum entry in com.pspdfkit.annotations.actions.SubmitFormAction.SubmitFormActionFlag
If set, the target fields (getFormFieldsAsync) shall be submitted regardless of whether they have a value. If not set, fields without a value shall not be submitted.
- INDEXED_FTS - enum entry in com.pspdfkit.LicenseFeature
Use the indexed full-text-search.
- IndexingOptions - class in com.pspdfkit.document.library
- Options that can be passed to enqueueDocuments
- IndexingOptions.Builder - class in com.pspdfkit.document.library.IndexingOptions
- Builder for creating IndexingOptions that can be used with enqueueDocuments.
- indexOfInspectorView(com.pspdfkit.ui.inspector.PropertyInspectorView) - function in com.pspdfkit.ui.inspector.PropertyInspector
- Find index of specified inspector view.
- INDONESIAN - enum entry in com.pspdfkit.document.processor.ocr.OcrLanguage
Indonesian language (en) selector for OCR processing. Use this value with performOcrOnPages when performing text detection for Indonesian documents. When using this value, make sure you have the Indonesian OCR language pack added to your app, by adding the
com.pspdfkit:pspdfkit-ocr-indonesian
dependency inside yourbuild.gradle
file:final String pspdfkit_version = {@value com.pspdfkit.PSPDFKit#VERSION}; dependencies { implementation "com.pspdfkit:pspdfkit-ocr:$pspdfkit_version" implementation "com.pspdfkit:pspdfkit-ocr-indonesian:$pspdfkit_version" }
- INFO - enum entry in com.pspdfkit.annotations.actions.NamedAction.NamedActionType
Show document info dialog.
- INFORMATION_ONLY - enum entry in com.pspdfkit.annotations.stamps.PredefinedStampType
- INITIAL_HERE - enum entry in com.pspdfkit.annotations.stamps.PredefinedStampType
- initialDocumentName(java.lang.String) - function in com.pspdfkit.ui.dialog.DocumentSharingDialogConfiguration.Builder
- Sets the initial document name shown in dialog.
- InitializationOptions - class in com.pspdfkit.initialization
- Extra initialization options for PSPDFKit.
- InitializationProvider - class in com.pspdfkit.initialization
- A provider used for initializing the PSPDFKit framework.
- initialize(android.content.Context,com.pspdfkit.initialization.InitializationOptions) - function in com.pspdfkit.PSPDFKit
- Initializes PSPDFKit with a license key.
- initialize(android.content.Context,java.lang.String) - function in com.pspdfkit.PSPDFKit
- Helper for the main initialise method.
- initialize(android.content.Context,java.lang.String,com.pspdfkit.configuration.policy.ApplicationPolicy) - function in com.pspdfkit.PSPDFKit
- Initializes PSPDFKit with a license key and a specific application policy.
- initialize(android.content.Context,java.lang.String,com.pspdfkit.configuration.policy.ApplicationPolicy,java.util.List) - function in com.pspdfkit.PSPDFKit
- Initializes PSPDFKit with a license key and a specific application policy.
- initialize(android.content.Context,java.lang.String,java.util.List) - function in com.pspdfkit.PSPDFKit
- Initializes PSPDFKit with a license key.
- initialize(android.content.Context,java.lang.String,java.util.List,java.lang.String) - function in com.pspdfkit.PSPDFKit
- Initializes PSPDFKit with a license key.
- initPageCache() - function in com.pspdfkit.document.PdfDocument
- Pre-fetches rotations, sizes and labels for all pages on a background thread.
- initPageCacheAsync() - function in com.pspdfkit.document.PdfDocument
- Pre-fetches rotations, sizes and labels for all pages on a background thread.
- INK - enum entry in com.pspdfkit.annotations.AnnotationType
Ink (includes Signatures)
- INK - enum entry in com.pspdfkit.ui.special_mode.controller.AnnotationTool
Creates ink annotations.
- InkAnnotation - class in com.pspdfkit.annotations
- Represents a freehand drawing on the page.
- InkAnnotationConfiguration - class in com.pspdfkit.annotations.configuration
- Configuration for ink annotations.
- InkAnnotationConfiguration.Builder - class in com.pspdfkit.annotations.configuration.InkAnnotationConfiguration
- Interface for configuration builder.
- InkAnnotationPreviewInspectorView - class in com.pspdfkit.ui.inspector.views
- Inspector view used for displaying annotation preview in annotation creation mode.
- INLINE - enum entry in com.pspdfkit.configuration.search.SearchType
Inline search replaces the toolbar with a search bar.
- InputStreamDataProvider - class in com.pspdfkit.document.providers
- Abstract data provider that handles serving a PDF document from an InputStream.
- insert(android.net.Uri,android.content.ContentValues) - function in com.pspdfkit.initialization.InitializationProvider
- insert(android.net.Uri,android.content.ContentValues) - function in com.pspdfkit.media.AssetsContentProvider
- INSERT - enum entry in com.pspdfkit.undo.EditingOperation
One page was inserted.
- INSERTREFERENCE - enum entry in com.pspdfkit.undo.EditingOperation
One page reference was inserted.
- INSET - enum entry in com.pspdfkit.annotations.BorderStyle
- inset(float,float) - function in com.pspdfkit.utils.PageRect
- Inset the page rectangle by (dx,dy).
- InspectorViewsContainer - class in com.pspdfkit.ui.inspector
- View that holds vertical list of PropertyInspectorView.
- INSTANT_COMMENT_MARKER - enum entry in com.pspdfkit.ui.special_mode.controller.AnnotationTool
A freely placeable Instant Comments thread.
- INSTANT_HIGHLIGHT_COMMENT - enum entry in com.pspdfkit.ui.special_mode.controller.AnnotationTool
A text highlight that acts as the root for an Instant Comments thread.
- InstantAnnotationProvider - class in com.pspdfkit.instant.annotations
- Handles all annotation related operations on the owning Instant document.
- InstantAnnotationProvider.NonAnnotationChange - class in com.pspdfkit.instant.annotations.InstantAnnotationProvider
- Possible non-annotation changes
- InstantAnnotationProvider.OnNonAnnotationChangeListener - class in com.pspdfkit.instant.annotations.InstantAnnotationProvider
- Object to be notified whenever a local non-annotation change happens.
- InstantClient - class in com.pspdfkit.instant.client
- The entry point to PSPDFKit Instant, representing a client’s connection to the Instant Server (PSPDFKit Document Engine).
- InstantDocumentDescriptor - class in com.pspdfkit.instant.client
- Descriptor/handle for InstantPdfDocument that provides methods for downloading/opening instant documents.
- InstantDocumentListener - class in com.pspdfkit.instant.listeners
- Listener for com.pspdfkit.instant.document.InstantPdfDocument events.
- InstantDocumentState - class in com.pspdfkit.instant.document
- Lists the observable states of an Instant document and its sync cycle.
- InstantDownloadException - class in com.pspdfkit.instant.exceptions
- Thrown when there's an error while downloading instant document.
- InstantErrorCode - class in com.pspdfkit.instant.exceptions
- Code used inside InstantException to indicate instant error source.
- InstantException - class in com.pspdfkit.instant.exceptions
- Thrown when there's an error while communicating with Instant Server (PSPDFKit Document Engine).
- instantiateItem(android.view.ViewGroup,int) - function in com.pspdfkit.ui.ViewStatePagerAdapter
- InstantJsonVersion - class in com.pspdfkit.instant.client
- Currently supported Instant JSON format versions.
- InstantPdfActivity - class in com.pspdfkit.instant.ui
- Activity with fully integrated views and behaviour.
- InstantPdfActivityIntentBuilder - class in com.pspdfkit.instant.ui
- Builder used for creating an intent for starting InstantPdfActivity.
- InstantPdfActivityIntentBuilder.Companion - class in com.pspdfkit.instant.ui.InstantPdfActivityIntentBuilder
- InstantPdfActivityListener - class in com.pspdfkit.instant.listeners
- This listener allows PdfActivity to receive instant document events.
- InstantPdfDocument - class in com.pspdfkit.instant.document
- PDF document managed by Instant.
- InstantPdfFragment - class in com.pspdfkit.instant.ui
- Fragment that actually displays instant PDF document.
- InstantProgress - class in com.pspdfkit.instant.client
- Object representing instant document download or annotations sync progress.
- InstantSyncException - class in com.pspdfkit.instant.exceptions
- Thrown when there's an error while syncing annotations with Instant Server (PSPDFKit Document Engine).
- INTEGER - enum entry in com.pspdfkit.document.PdfValue.PdfValueType
- IntentExtensions - class in com.pspdfkit.utils
- INVALID - enum entry in com.pspdfkit.instant.document.InstantDocumentState
The document is invalid and cannot be used any longer.
Document transitions into this state when it gets invalidated due to:
- Removing document storage via removeLocalStorage or removeLocalStorage.
- Removing instant client storage via removeLocalStorage
- When document gets invalidated due to an error - corrupted database/storage etc.
You may want to remove its local storage via removeLocalStorage, but that‘s about all you can do with it.
- INVALID - enum entry in com.pspdfkit.signatures.DigitalSignatureValidationResult.CertificateStatus
The certificate is not valid against a CA.
- INVALID_CUSTOM_DATA - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode
The operation failed because the custom data of an Instant comment was not valid JSON.
Only JSON types (strings, numbers, booleans, nulls and arrays or dictionaries of these types) are allowed as custom data on Instant Comments.
- INVALID_JSON_STRUCTURE - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode
The operation failed because a JSON structure was found to be invalid.
This can happen if the database for a layer has been tampered with. If you see this error, please first check that you do not modify any data in the client directory of PSPDFKit Instant, and that you didn’t customise the storage location in such a way that other applications might access it. Once you ruled out this possibility and still see this error in a fresh client please contact support.
- INVALID_JWT - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode
The given string is not a valid Instant JWT. It is either malformed or missing mandatory claims.
- INVALID_REQUEST - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode
The server rejected our request for a reason other than an authentication failure.
If you ever see this error, please contact support..
- INVALID_SERVER_DATA - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode
The data from the server has been ignored because it was invalid.
If you ever see this error, please contact support..
- invalidateCache() - function in com.pspdfkit.document.PdfDocument
- Invalidates the rendered cache of all the pages for this
document
. - invalidateCacheForPage(int) - function in com.pspdfkit.document.PdfDocument
- Invalidates the rendered cache of the given
pageIndex
for thisdocument
. - InvalidLayoutException - class in com.pspdfkit.exceptions
- Thrown when the used layout is missing a required view, or makes wrong use of internal view ids.
- InvalidPasswordException - class in com.pspdfkit.exceptions
- Thrown when attempting to open a password protected PDF document with wrong password.
- InvalidPSPDFKitLicenseException - class in com.pspdfkit.exceptions
- Thrown when invalid license is passed during PSPDFKit initialization.
- InvalidSignatureException - class in com.pspdfkit.exceptions
- Thrown when attempting to open a document using an invalid signature.
- InvalidThemeException - class in com.pspdfkit.exceptions
- Thrown when the used Context uses a theme incompatible with PSPDFKit.
- invertColors(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder
- Sets if the colors will be inverted in the document.
- invertColors(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder
- Sets if the colors will be inverted in the document.
- invertColors(boolean) - function in com.pspdfkit.configuration.rendering.AnnotationRenderConfiguration.Builder
- Sets whether annotation colors will be inverted in the rendering.
- invertColors(boolean) - function in com.pspdfkit.configuration.rendering.PageRenderConfiguration.Builder
- Sets if the colors will be inverted in the document.
- inverted() - function in com.pspdfkit.utils.EdgeInsets
- INVISIBLE - enum entry in com.pspdfkit.annotations.AnnotationFlags
If set, ignore annotation AP stream if there is no handler available.
- isAnnotationCreatorSet() - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager
- Checks if the annotation creator has been set.
- isAnnotationCreatorSet() - function in com.pspdfkit.preferences.PSPDFKitPreferences
- Checks if the annotation creator has been set
- isAnnotationEditingEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the annotation editing is enabled or not.
- isAnnotationInspectorEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the annotation creation and editing inspectors are enabled.
- isAnnotationInspectorVisible() - function in com.pspdfkit.ui.special_mode.controller.AnnotationInspectorController
- Check if inspector is currently displayed.
- isAnnotationLimitedToPageBounds() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the annotations are limited to the page bounds.
- isAnnotationListEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the list of annotations is enabled or not.
- isAnnotationListReorderingEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether reordering annotations in the annotation list is enabled.
- isAnnotationNoteHintingEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether to show visual indicators for annotations that have annotation notes.
- isAnnotationPopupToolbarEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether the annotation popup toolbar is enabled or not.
- isAnnotationPropertySupported(com.pspdfkit.annotations.AnnotationType,com.pspdfkit.annotations.configuration.AnnotationProperty) - function in com.pspdfkit.annotations.configuration.AnnotationConfigurationRegistry
- Tests if annotation type supports editing given property.
- isAnnotationPropertySupported(com.pspdfkit.ui.special_mode.controller.AnnotationTool,com.pspdfkit.annotations.configuration.AnnotationProperty) - function in com.pspdfkit.annotations.configuration.AnnotationConfigurationRegistry
- Tests if annotation tool supports editing given property.
- isAnnotationPropertySupported(com.pspdfkit.ui.special_mode.controller.AnnotationTool,com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant,com.pspdfkit.annotations.configuration.AnnotationProperty) - function in com.pspdfkit.annotations.configuration.AnnotationConfigurationRegistry
- Tests if annotation tool variant supports editing given property.
- isAnnotationRotationEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the annotation rotation is enabled or not.
- isAttached() - function in com.pspdfkit.annotations.Annotation
- Tells whether this annotation is attached to a document.
- isAttached() - function in com.pspdfkit.ui.toolbar.ContextualToolbar
- Indicates whether the toolbar is attached or detached.
- isAutomaticLinkGenerationEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether we automatically generating link annotations for links in the document text is enabled or not.
- isAutomaticLinkGenerationEnabled() - function in com.pspdfkit.document.PdfDocument
- Whether or not automatic link generation is enabled.
- isAutosaveEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether document autosave is enabled.
- isAutoSelectNextFormElementEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the auto select next form element functionality is enabled or not (defaults to
false
). - isBackgroundTransparent() - function in com.pspdfkit.ui.PdfThumbnailBar
- isBackgroundTransparent() - function in com.pspdfkit.ui.thumbnail.PdfScrollableThumbnailBar
- isBackgroundTransparent() - function in com.pspdfkit.ui.thumbnail.PdfStaticThumbnailBar
- isBackgroundTransparent() - function in com.pspdfkit.ui.thumbnail.PdfThumbnailBarController
- isBitmap() - function in com.pspdfkit.signatures.SignatureGraphic
- Whether or not this SignatureGraphic is a bitmap.
- isBoldStyleButtonEnabled(com.pspdfkit.internal.contentediting.models.StyleInfo) - function in com.pspdfkit.ui.special_mode.controller.ContentEditingController
- Evaluates the enabled state for the "bold" button in the ContentEditingStylingBar
- isBookmarkAddButtonEnabled() - function in com.pspdfkit.ui.outline.BookmarkViewAdapter
- Called to determine bookmark add button enabled state.
- isBookmarkAddButtonEnabled() - function in com.pspdfkit.ui.outline.DefaultBookmarkAdapter
- Called to determine bookmark add button enabled state.
- isBookmarkEditingEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the bookmarks can be edited or not.
- isBookmarkListEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the list of bookmarks is enabled or not.
- isButtonRedactionButtonVisible() - function in com.pspdfkit.ui.redaction.RedactionView
- Returns
true
if redaction button is visible. - isCaCertificate() - function in com.pspdfkit.signatures.X509CertificateData
- Returns true if the certificate is a CA certificate, false otherwise.
- isCalibration() - function in com.pspdfkit.annotations.LineAnnotation
- Internal use only - for temporary annotations used with the calibration tool createCalibrationLineAnnotation
- isCanceled() - function in com.pspdfkit.ui.PdfReaderView
- Returns true if the reflow operation has been canceled.
- isCancelOnTouchOutside() - function in com.pspdfkit.ui.inspector.PropertyInspector
- Returns True when the inspector should be cancelled when touched outside of its bounds.
- isCheckpointAlreadyCreated() - function in com.pspdfkit.document.DocumentSource
- Indicates whether the checkpoint was already created.
- isCheckpointSupported(com.pspdfkit.document.DocumentSource) - function in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointer
- Returns
true
if the checkpoint is supported. - isClearContentEditingEnabled() - function in com.pspdfkit.ui.special_mode.controller.ContentEditingController
- Check function for the ContentEditingStylingBar bar if it should enable or disable its "Clear" button.
- isComb() - function in com.pspdfkit.forms.TextFormElement
- Returns whether the field shall be automatically divided into as many equally space positions, or combs, as the value of getMaxLength, and the text is laid out into those combs.
- isCommitOnSelectionChangeEnabled() - function in com.pspdfkit.forms.ChoiceFormElement
- When set, don't wait for the focus to exit the control, but immediately commit actions.
- isComparisonFirstLaunch() - function in com.pspdfkit.preferences.PSPDFKitPreferences
- Returns True if it's the first time launching comparison alignment dialog and false when it has been launched before.
- isComplete() - function in com.pspdfkit.document.download.DownloadJob
- Returns
true
if the download has been successfully completed. - isCompleted() - function in com.pspdfkit.instant.client.InstantProgress
- Whether or not the progress reporter has reached a final state.
- isContentEditingEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the content editing is enabled or not.
- isContentEditingInspectorVisible() - function in com.pspdfkit.ui.inspector.contentediting.DefaultContentEditingInspectorController
- Check if inspector is currently displayed.
- isContentEditingInspectorVisible() - function in com.pspdfkit.ui.special_mode.controller.ContentEditingInspectorController
- Check if inspector is currently displayed.
- isControllerBound() - function in com.pspdfkit.ui.toolbar.AnnotationCreationToolbar
- Returns
true
if the controller is bound. - isControllerBound() - function in com.pspdfkit.ui.toolbar.AnnotationEditingToolbar
- Returns
true
if the controller is bound. - isControllerBound() - function in com.pspdfkit.ui.toolbar.ContentEditingToolbar
- Returns
true
if the controller is bound. - isControllerBound() - function in com.pspdfkit.ui.toolbar.ContextualToolbar
- Returns
true
if the controller is bound. - isControllerBound() - function in com.pspdfkit.ui.toolbar.DocumentEditingToolbar
- Returns
true
if the controller is bound. - isControllerBound() - function in com.pspdfkit.ui.toolbar.TextSelectionToolbar
- Returns
true
if the controller is bound. - isCopyEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController
- Checks if all currently edited annotations can be copied.
- isCopyEnabled(java.util.List) - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController
- Checks if all provided annotations can be copied.
- isCopyPasteEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether copy and paste operations are enabled for annotations.
- isCustomStamp() - function in com.pspdfkit.annotations.stamps.StampPickerItem
- Returns
true
for special custom stamp can be personalized by users. - isCustomTextSet() - function in com.pspdfkit.forms.ComboBoxFormElement
- Check whether custom value is set.
- isCutEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController
- Checks if all currently edited annotations can be cut.
- isCutEnabled(java.util.List) - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController
- Checks if all provided annotations can be cut.
- isDefaultToolbarEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Whether or not the default toolbar is enabled.
- isDefaultViewerActive() - function in com.pspdfkit.jetpack.compose.interactors.DocumentState
- Checks if viewer is visible or not.
- isDeleted(java.lang.Boolean) - function in com.pspdfkit.undo.edit.contentediting.ContentEditingNativeChangeEdit
- isDeleteEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController
- Checks if all currently edited annotations can be deleted.
- isDeleteEnabled(java.util.List) - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController
- Checks if all provided annotations can be deleted.
- isDirty() - function in com.pspdfkit.bookmarks.Bookmark
- Returns true if this bookmark was changed since document was saved.
- isDirty() - function in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointer
- Returns
true
if the document has been modified since the last saving. - isDirty() - function in com.pspdfkit.forms.FormField
- Checks whether the form field is dirty (any value was modified).
- isDisplayed() - function in com.pspdfkit.ui.PSPDFKitViews.PSPDFView
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.PdfOutlineView
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.PdfReaderView
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.PdfThumbnailBar
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.PdfThumbnailGrid
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.contentediting.ContentEditingStylingBar
- True when content editing bar is currently displayed on the screen.
- isDisplayed() - function in com.pspdfkit.ui.forms.FormEditingBar
- True when form input bar is currently displayed on the screen.
- isDisplayed() - function in com.pspdfkit.ui.search.PdfSearchViewInline
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.search.PdfSearchViewLazy
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.search.PdfSearchViewModular
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.thumbnail.PdfScrollableThumbnailBar
- Called when the activity needs to know the visibility of this view.
- isDisplayed() - function in com.pspdfkit.ui.thumbnail.PdfStaticThumbnailBar
- Called when the activity needs to know the visibility of this view.
- isDisplayingContextualToolbar() - function in com.pspdfkit.ui.toolbar.ToolbarCoordinatorLayout
- Indicates whether the contextual toolbar is being currently displayed.
- isDocumentEditorEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the document editor is enabled or not.
- isDocumentEditorEnabled() - function in com.pspdfkit.ui.PdfThumbnailGrid
- isDocumentEmpty() - function in com.pspdfkit.ui.special_mode.controller.DocumentEditingController
- Checks if document editor has removed every document page.
- isDocumentInfoListViewAvailable() - function in com.pspdfkit.ui.PdfOutlineView.OutlinePagerAdapter
- isDocumentInfoViewEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the document info view is enabled or not.
- isDocumentInfoViewSeparated() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the document info view is a separate window, or displayed as a tab in the outline
- isDocumentInteractionEnabled() - function in com.pspdfkit.ui.PdfFragment
- Indicates whether interaction with the document is enabled right now.
- isDocumentInteractionEnabled() - function in com.pspdfkit.ui.PdfUi
- Indicates whether interaction with the document is enabled right now.
- isDownloaded() - function in com.pspdfkit.instant.client.InstantDocumentDescriptor
- Check whether document is already downloaded.
- isDraggable() - function in com.pspdfkit.ui.toolbar.ContentEditingToolbar
- Returns
true
when toolbar is draggable. - isDraggable() - function in com.pspdfkit.ui.toolbar.ContextualToolbar
- Returns
true
when toolbar is draggable. - isDraggingEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController
- Test whether selection dragging is enabled.
- isDrawAllowed() - function in com.pspdfkit.ui.note.NoteHinterDrawable
- isEditable() - function in com.pspdfkit.forms.ComboBoxFormConfiguration
- Returns
true
when the form element is editable,false
otherwise. - isEditable() - function in com.pspdfkit.forms.ComboBoxFormElement
- Check whether the combo box has a text field attached and a custom value is allowed.
- isEmbeddedFilesViewEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the embedded files view is enabled or not.
- isEnabled() - function in com.pspdfkit.ui.actionmenu.ActionMenuItem
- Returns True if this menu item is enabled, false otherwise.
- isEnabled() - function in com.pspdfkit.ui.toolbar.popup.PopupToolbarMenuItem
- Gets whether the menu item is enabled or not.
- isExpanded() - function in com.pspdfkit.document.OutlineElement
- Returns whether the outline element is expanded or not.
- isExported() - function in com.pspdfkit.forms.FormField
- If set, the field shall be exported by a submit-form action.
- isExportEnabled() - function in com.pspdfkit.ui.special_mode.controller.DocumentEditingController
- Indicates whether the exporting of the pages is enabled.
- isFileSelect() - function in com.pspdfkit.forms.TextFormElement
- Returns whether text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.
- isFileSource() - function in com.pspdfkit.document.DocumentSource
- Returns true if the source is a file URI not a data provider.
- isFirstPageAlwaysSingle() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether the first page should always be displayed as a single or not,
false
by default. - isFormEditingEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the form editing is enabled or not.
- isFormElementClickable(com.pspdfkit.forms.FormElement) - function in com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementClickedListener
- Called when user clicks on a form element.
- isFormElementDateAndTimePickerEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the date and time pickers should be enabled for according form elements (defaults to
true
) - isFullscreen(android.content.res.Resources) - function in com.pspdfkit.ui.settings.SettingsDialog.Companion
- isHorizontalResizingEnabled() - function in com.pspdfkit.annotations.configuration.AnnotationTextResizingConfiguration
- Controls whether annotations will automatically resize horizontally when entering text.
- isIconTintingEnabled() - function in com.pspdfkit.ui.PdfPasswordView
- Returns whether tinting of the password view icon is enabled or not.
- isIdle() - function in com.pspdfkit.ui.search.PdfSearchViewInline
- isIdle() - function in com.pspdfkit.ui.search.PdfSearchViewModular
- isImageDocument() - function in com.pspdfkit.ui.DocumentDescriptor
- Checks whether descriptor describes an image document.
- isImageDocument() - function in com.pspdfkit.ui.PdfFragment
- Indicates whether the displayed document is an image or not.
- isImageDocument() - function in com.pspdfkit.ui.PdfUi
- Indicates whether the displayed document is an image or not.
- isImageUri(android.content.Context,android.net.Uri) - function in com.pspdfkit.document.ImageDocumentUtils
- Checks whether the content returned by resolving
uri
has an image MIME type. - isImmersiveMode() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the immersive mode is activated or not.
- isImmersiveModeEnabled(java.lang.Boolean) - function in com.pspdfkit.ui.ImmersiveModeCallback
- isIncremental() - function in com.pspdfkit.document.DocumentSaveOptions
- Indicates whether the saving is set to be incremental or not.
- isIndexing() - function in com.pspdfkit.document.library.PdfLibrary
- Indicates whether the indexing is in progress or not.
- isInitialized() - function in com.pspdfkit.PSPDFKit
- Returns
true
if PSPDFKit is initialized and ready to use. - isInitialPagesSpinnerAllPages() - function in com.pspdfkit.ui.dialog.DocumentSharingDialogConfiguration
- Returns
true
if the initial position for Pages spinner is set to 'All pages',false
otherwise. - isInSpecialMode() - function in com.pspdfkit.ui.PdfFragment
- Returns
true
if any of the special modes is active. - isInspectorVisible() - function in com.pspdfkit.ui.inspector.AbstractPropertyInspectorController
- Returns
true
when inspector is shown. - isInspectorVisible() - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayout
- Tests if coordinator has any active inspector currently visible.
- isInspectorVisible(com.pspdfkit.ui.inspector.PropertyInspector) - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayout
- Tests if
inspector
is currently active in coordinator. - isInspectorVisible() - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayoutController
- Tests if coordinator has any active inspector currently visible.
- isInspectorVisible(com.pspdfkit.ui.inspector.PropertyInspector) - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayoutController
- Tests if
inspector
is currently active in coordinator. - isInstantHighlightCommentingEnabledByConfiguration() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether Instant Comments on text highlights are enabled by configuration
- isInvertColors() - function in com.pspdfkit.configuration.PdfConfiguration
- If the page colors should be inverted (defaults to
false
). - isItalicStyleButtonEnabled(com.pspdfkit.internal.contentediting.models.StyleInfo) - function in com.pspdfkit.ui.special_mode.controller.ContentEditingController
- Evaluates the enabled state for the "italic" button in the ContentEditingStylingBar
- isJavaScriptEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Controls whether JavaScript processing is enabled.
- isJavaScriptEnabled() - function in com.pspdfkit.javascript.JavaScriptProvider
- Returns
true
if JavaScript processing is enabled for this document. - isKeepAspectRatioEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController
- Test whether aspect ratio is maintained when resizing.
- isLastViewedPageRestorationEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether restoration of the last viewed page when reopening a document is enabled or not.
- isLinkCreationEnabledByConfiguration() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether annotation editing is enabled by configuration and link annotations are editable.
- isListeningToServerChanges() - function in com.pspdfkit.instant.document.InstantPdfDocument
- Checks whether this document listens to server changes.
- isLocalFileUri(android.content.Context,android.net.Uri) - function in com.pspdfkit.PSPDFKit
- Checks whether or not PSPDFKit can extract a local filesystem path from the
uri
. - isLocked() - function in com.pspdfkit.annotations.Annotation
- Check if the annotation is locked - i.e.
- isLocked() - function in com.pspdfkit.annotations.FileAnnotation
- Check if the annotation is locked - i.e.
- isLocked() - function in com.pspdfkit.annotations.SoundAnnotation
- Check if the annotation is locked - i.e.
- isLogged(int,java.lang.String) - function in com.pspdfkit.utils.LogCatLogger
- Override this method to enable or disable logging for log with given
priority
andtag
. - isLogged(int,java.lang.String) - function in com.pspdfkit.utils.PdfLog.Logger
- Override this method to enable or disable logging for log with given
priority
andtag
. - isMagnifierEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the magnifier is shown when:
The text selection handles are touched.
The measurement annotations are created. Defaults to
true
.
- isMeasurement() - function in com.pspdfkit.annotations.Annotation
- Returns
true
when the annotation is a measurement annotation. - isMeasurement() - function in com.pspdfkit.annotations.ShapeAnnotation
- Returns
true
when the annotation is a measurement annotation. - isMeasurementsEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Indicates whether the measurement tools are enabled or not.
- isMeasurementSnappingEnabled() - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager
- Returns
true
if snapping to page graphics for measurement tools is enabled. - isMeasurementSnappingEnabled() - function in com.pspdfkit.preferences.PSPDFKitPreferences
- Returns
true
if snapping to page graphics for measurement tools is enabled. - isModified() - function in com.pspdfkit.annotations.Annotation
- Returns whether the annotation is modified or not.
- isMultiLine() - function in com.pspdfkit.forms.TextFormConfiguration
- Returns whether text is allowed to have multiple lines or not.
- isMultiLine() - function in com.pspdfkit.forms.TextFormElement
- Returns whether text is allowed to have multiple lines or not.
- isMultiSelectEnabled() - function in com.pspdfkit.forms.ChoiceFormElement
- Check whether more than one of the element's options may be selected simultaneously.
- isMultiSelectionEnabled() - function in com.pspdfkit.forms.ComboBoxFormConfiguration
- Returns
true
when multiselection is enabled,false
otherwise. - isMultiSelectionEnabled() - function in com.pspdfkit.forms.ListBoxFormConfiguration
- Returns
true
when multi selection is enabled,false
otherwise. - isMultithreadedRenderingEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Controls whether multithreaded rendering is enabled, defaults to
true
. - isNewWindow() - function in com.pspdfkit.annotations.actions.GoToEmbeddedAction
- Whether or not a new window should be created for displaying the embedded document.
- isNonEmbeddedFontNoWarn() - function in com.pspdfkit.signatures.DigitalSignatureInfo.BuildData
- Flag if no warning should be displayed about not embedded fonts.
- isNoteAnnotationNoZoomHandlingEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether handling for AnnotationFlags.NOZOOM flag for note annotations is enabled.
- isOpen() - function in com.pspdfkit.annotations.NoteAnnotation
- Checks if the popup of this annotation is opened.
- isOpenableUri(android.content.Context,android.net.Uri) - function in com.pspdfkit.PSPDFKit
- PSPDFKit can only open URIs from content providers that also provide size information.
- isOutlineEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the outline is enabled or not.
- isOutlineListViewAvailable() - function in com.pspdfkit.ui.PdfOutlineView.OutlinePagerAdapter
- isPassword() - function in com.pspdfkit.forms.TextFormConfiguration
- Returns whether text is intended for entering a secure password that should not be visible on the screen.
- isPassword() - function in com.pspdfkit.forms.TextFormElement
- Returns whether text is intended for entering a secure password that should not be visible on the screen.
- isPlayingMultipleMediaInstancesEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether playing multiple media instances is enabled or not.
- isPortrait() - function in com.pspdfkit.utils.Size
- Check if size has portrait orientation.
- isPreRelease() - function in com.pspdfkit.signatures.DigitalSignatureInfo.BuildData
- Flag indicating that the signature was created with unreleased software.
- isPreviewEnabled() - function in com.pspdfkit.annotations.configuration.AnnotationPreviewConfiguration
- Controls whether annotation preview is enabled when creating annotations.
- isPrintingAvailable(com.pspdfkit.configuration.activity.PdfActivityConfiguration) - function in com.pspdfkit.document.printing.DocumentPrintManager
- Test if printing is available on current device and is enabled in .
- isPrintingEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the printing support is enabled or not.
- isPrintingEnabled(com.pspdfkit.configuration.activity.PdfActivityConfiguration,com.pspdfkit.document.PdfDocument) - function in com.pspdfkit.document.printing.DocumentPrintManager
- Test if printing is enabled.
- isReaderViewEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether we display the reader view and its action icon in the main toolbar.
- isReadOnly() - function in com.pspdfkit.forms.FormElement
- If set, the user may not change the value of this form field.
- isReadOnly() - function in com.pspdfkit.forms.FormElementConfiguration
- If set, the user may not change the value of this form field.
- isReadOnly() - function in com.pspdfkit.forms.FormField
- If set, the user may not change the value of this field.
- isReady() - function in com.pspdfkit.ui.audio.AudioPlaybackController
- Checks whether the media is ready to be played.
- isReady() - function in com.pspdfkit.ui.audio.AudioRecordingController
- Checks whether the controller is ready for recording.
- isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.PdfFragment
- Returns redaction annotation preview mode,
false
by default. - isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.PdfThumbnailBar
- Returns whether the redaction annotation preview mode is enabled or not.
- isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.PdfThumbnailGrid
- Returns redaction annotation preview mode,
false
by default. - isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.redaction.RedactionView
- Returns whether the redaction annotation preview mode is enabled or not.
- isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.thumbnail.PdfScrollableThumbnailBar
- Returns redaction annotation preview mode,
false
by default. - isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.thumbnail.PdfStaticThumbnailBar
- Returns redaction annotation preview mode,
false
by default. - isRedactionAnnotationPreviewEnabled() - function in com.pspdfkit.ui.thumbnail.PdfThumbnailBarController
- Returns redaction annotation preview mode,
false
by default. - isRedactionButtonExpanded() - function in com.pspdfkit.ui.redaction.RedactionView
- Returns
true
if redaction button is visible and expanded. - isRedactionEnabledByConfiguration() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether text redaction is enabled by configuration-
- isRedactionUiEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether we show the UI to apply redactions when there are com.pspdfkit.annotations.RedactionAnnotation in the document.
- isRedoEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether redoing undone edits is enabled.
- isRedoEnabled() - function in com.pspdfkit.ui.special_mode.controller.ContentEditingController
- Checks whether the redo button is enabled
- isRedoEnabled() - function in com.pspdfkit.ui.special_mode.controller.DocumentEditingController
- Checks if redo operation is possible on document editor.
- isReply() - function in com.pspdfkit.annotations.Annotation
- Whether the annotations is a reply to another annotation.
- isRequired() - function in com.pspdfkit.forms.FormElement
- If set, the field shall have a value at the time it is exported by a submit-form action.
- isRequired() - function in com.pspdfkit.forms.FormElementConfiguration
- If set, the field is required to have a value at the time it is exported by a submit form action.
- isRequired() - function in com.pspdfkit.forms.FormField
- If set, the field shall have a value at the time it is exported by a submit-form action.
- isResizable() - function in com.pspdfkit.annotations.Annotation
- Check if the annotation is resizable, or if this is a non-resizable annotation.
- isResizable() - function in com.pspdfkit.annotations.BaseRectsAnnotation
- Check if the annotation is resizable, or if this is a non-resizable annotation.
- isResizable() - function in com.pspdfkit.annotations.FileAnnotation
- Check if the annotation is resizable, or if this is a non-resizable annotation.
- isResizable() - function in com.pspdfkit.annotations.FreeTextAnnotation
- Check if the annotation is resizable, or if this is a non-resizable annotation.
- isResizable() - function in com.pspdfkit.annotations.InkAnnotation
- Check if the annotation is resizable, or if this is a non-resizable annotation.
- isResizable() - function in com.pspdfkit.annotations.NoteAnnotation
- Always returns
false
, since note annotations are not resizable. - isResizable() - function in com.pspdfkit.annotations.SoundAnnotation
- Check if the annotation is resizable, or if this is a non-resizable annotation.
- isResizeEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController
- Test if selection resizing is enabled.
- isResizeGuidesEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController
- Test whether resize guides are enabled.
- isResumed() - function in com.pspdfkit.ui.audio.AudioPlaybackController
- Checks whether the media playback is currently resumed.
- isResumed() - function in com.pspdfkit.ui.audio.AudioRecordingController
- Checks whether the audio is currently recording.
- isRichText() - function in com.pspdfkit.forms.TextFormElement
- Returns whether the value of this field can be a rich text string.
- isRotationEnabled() - function in com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController
- Check whether rotating annotations (that support it) is enabled.
- isSaveAsEnabled() - function in com.pspdfkit.ui.special_mode.controller.DocumentEditingController
- Indicates whether the 'Save As' is enabled on the selected pages, meaning the new document is created once the editing is finished.
- isSaveEnabled() - function in com.pspdfkit.ui.special_mode.controller.ContentEditingController
- Checks whether the save button is enabled.
- isSaving() - function in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointer
- Returns whether or not the checkpointer is currently saving to the document.
- isSavingFlow() - function in com.pspdfkit.ui.dialog.DocumentSharingDialogConfiguration
- Returns
true
if saving flow is enabled, and the layout will reflect the change accordingly. - isScrollbarsEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- If the default document scrollbars should be enabled (defaults to
true
). - isScrollEnabled() - function in com.pspdfkit.forms.TextFormElement
- Returns whether the text field can be scrolled (horizontally for single-line fields, vertically for multi-line fields).
- isScrollingEnabled() - function in com.pspdfkit.ui.PdfFragment
- Indicates whether the scrolling is enabled, or not.
- isSearchEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the search is enabled or not.
- isSelectable() - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem
- Indicates whether the item is selectable, or just clickable.
- isSelected() - function in com.pspdfkit.forms.CheckBoxFormConfiguration
- Returns
true
if the checkbox form button will be selected,false
otherwise. - isSelected() - function in com.pspdfkit.forms.EditableButtonFormElement
- Checks if button is selected.
- isSelected() - function in com.pspdfkit.forms.RadioButtonFormConfiguration
- Returns
true
if the radio button will be selected,false
otherwise. - isSelected() - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem
- isSelfSigned() - function in com.pspdfkit.signatures.X509CertificateData
- Returns true if the certificate is self-signed, false otherwise.
- isSettingsItemEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the settings menu item is shown or not.
- isShowDocumentTitleOverlayEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the document title overlay is set to show or not.
- isShowing() - function in com.pspdfkit.ui.PopupToolbar
- Gets whether the popup toolbar is currently showing or not.
- isShowing() - function in com.pspdfkit.ui.actionmenu.ActionMenu
- Check if action menu is currently visible.
- isShown() - function in com.pspdfkit.ui.search.PdfSearchView
- Returns the value returned when callingView.isShown on the search view.
- isShown() - function in com.pspdfkit.ui.search.PdfSearchViewLazy
- isShowNavigationButtonsEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the navigation buttons are set to show or not.
- isShowPageLabels() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the page labels are set to show or not.
- isShowPageLabels() - function in com.pspdfkit.ui.PdfThumbnailGrid
- Returns
true
if page labels are shown,false
otherwise. - isShowPageNumberOverlay() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the page number overlay is set to show or not.
- isSignature() - function in com.pspdfkit.annotations.Annotation
- Returns
true
when the annotation is a signature annotation. - isSignatureButtonPositionForcedInMainToolbar() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the signature button position is forced in the main toolbar or not.
- isSigned() - function in com.pspdfkit.forms.SignatureFormElement
- Returns if this form element is digitally signed.
- isSigned() - function in com.pspdfkit.signatures.DigitalSignatureInfo
- Returns if form field is actually signed.
- isSigned() - function in com.pspdfkit.signatures.DocumentSignatureInfo
- Returns
true
if the document contains a signature. - isSmartGuidesEnabled() - function in com.pspdfkit.preferences.PSPDFKitPreferences
- Returns
true
if smart guides for various angles is enabled. - isSnapToSelfEnabled() - function in com.pspdfkit.preferences.PSPDFKitPreferences
- Returns
true
if snapping to self is enabled. - isSpellCheckEnabled() - function in com.pspdfkit.forms.ComboBoxFormElement
- Returns whether text entered in the combo box shall be spell-checked.
- isSpellCheckEnabled() - function in com.pspdfkit.forms.TextFormConfiguration
- Returns whether text entered in the field shall be spell-checked.
- isSpellCheckEnabled() - function in com.pspdfkit.forms.TextFormElement
- Returns whether text entered in the field shall be spell-checked.
- isStandard() - function in com.pspdfkit.annotations.stamps.PredefinedStampType
- Whether this is a standard stamp type.
- isStandard() - function in com.pspdfkit.annotations.stamps.StampType
- Checks whether this is a standard stamp type known to PSPDFKit, in which case the title and subtitle are supplied automatically based on the type.
- isStyleIndicatorCircleEnabled(int) - function in com.pspdfkit.ui.toolbar.AnnotationCreationToolbar.ItemToAnnotationToolMapper
- Whether the icon of item with specified ID should display the current properties used by its mapped tool.
- isTextExtractionEnabledByDocumentPermissions() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether the text extraction is enabled by document permissions, meaning the document contains EXTRACT permission.
- isTextHighlightingEnabledByConfiguration() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether annotation editing (text highlights are annotations) is enabled by configuration.
- isTextItemFirstFromEnd() - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem
- Gets whether the item is a text button and the first from the end
- isTextSelectionEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- If text selection (programmatically and via long-press) is enabled (defaults to
true
). - isTextSelectionPopupToolbarEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether the text selection popup toolbar is enabled or not.
- isTextSharingEnabledByConfiguration() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether text sharing is enabled by configuration.
- isTextSpeakEnabledByDocumentPermissions() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController
- Indicates whether the text extraction for accessibility purposes is enabled by document permissions, meaning the document contains EXTRACT_ACCESSIBILITY permission.
- isThumbnailGridEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether the thumbnail grid is enabled or not.
- isToGrayscale() - function in com.pspdfkit.configuration.PdfConfiguration
- Should the page colors be converted to grayscale (defaults to
false
). - isTransactionActive() - function in com.pspdfkit.document.editor.PdfDocumentEditor
- Checks if there's currently an active document editor transaction.
- isTrustedMode() - function in com.pspdfkit.signatures.DigitalSignatureInfo.BuildData
- Flag that indicates that the software used for creating the digital signature was running in trusted mode (usually
false
). - isUiRotationSupported() - function in com.pspdfkit.annotations.Annotation
- Returns true if this Annotation can be rotated in the UI.
- isUiRotationSupported() - function in com.pspdfkit.annotations.FreeTextAnnotation
- Returns true if this Annotation can be rotated in the UI.
- isUiRotationSupported() - function in com.pspdfkit.annotations.StampAnnotation
- Returns true if this Annotation can be rotated in the UI.
- isUndoEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether undoing edits is enabled.
- isUndoEnabled() - function in com.pspdfkit.ui.special_mode.controller.ContentEditingController
- Checks whether the undo button is enabled
- isUndoEnabled() - function in com.pspdfkit.ui.special_mode.controller.DocumentEditingController
- Checks if undo operation is possible on document editor.
- isUserInterfaceEnabled() - function in com.pspdfkit.ui.PdfFragment
- Indicates whether UI is enabled right now.
- isUserInterfaceEnabled() - function in com.pspdfkit.ui.PdfUi
- Indicates whether UI is enabled right now.
- isUserInterfaceVisible() - function in com.pspdfkit.ui.PdfUi
- Checks whether user interface controls are currently visible.
- isUsingPageAspectRatio() - function in com.pspdfkit.ui.thumbnail.PdfScrollableThumbnailBar
- Returns whether the page aspect ratio is used to determine the thumbnail width.
- isUsingPageAspectRatio() - function in com.pspdfkit.ui.thumbnail.PdfStaticThumbnailBar
- Returns whether the page aspect ratio is used to determine the thumbnail width.
- isUsingPageAspectRatio() - function in com.pspdfkit.ui.thumbnail.PdfThumbnailBarController
- Returns whether the page aspect ratio is used to determine the thumbnail width.
- isValid() - function in com.pspdfkit.signatures.DocumentSignatureInfo
- Validates signatures in the document and returns an overall status.
- isValidForEditing() - function in com.pspdfkit.document.ImageDocument
- Returns
true
if the document is editable (comes from a file URI or from another source that supports writing),false
otherwise. - isVerticalResizingEnabled() - function in com.pspdfkit.annotations.configuration.AnnotationTextResizingConfiguration
- Controls whether annotations will automatically resize vertically when entering text.
- isVideoPlaybackEnabled() - function in com.pspdfkit.configuration.PdfConfiguration
- Whether video playback is enabled in document.
- isVideoUri() - function in com.pspdfkit.media.MediaUri
- Test if media uri is pointing to a video resource.
- isViewFromObject(android.view.View,Object) - function in com.pspdfkit.ui.ViewStatePagerAdapter
- isViewStateRestorationEnabled() - function in com.pspdfkit.ui.inspector.PropertyInspectorView
- Flag to determine whether to save the state by calling on the view the saveHierarchyState to save its state and restoreHierarchyState to restore it.
- isViewStateRestorationEnabled() - function in com.pspdfkit.ui.inspector.views.ColorPickerInspectorView
- Flag to determine whether to save the state by calling on the view the saveHierarchyState to save its state and restoreHierarchyState to restore it.
- isViewStateRestorationEnabled() - function in com.pspdfkit.ui.inspector.views.FontPickerInspectorView
- Flag to determine whether to save the state by calling on the view the saveHierarchyState to save its state and restoreHierarchyState to restore it.
- isViewStateRestorationEnabled() - function in com.pspdfkit.ui.inspector.views.TextInputInspectorView
- Flag to determine whether to save the state by calling on the view the saveHierarchyState to save its state and restoreHierarchyState to restore it.
- isVisible() - function in com.pspdfkit.ui.audio.AudioView
- Indicates whether audio inspector is visible.
- isVisible(androidx.fragment.app.FragmentManager) - function in com.pspdfkit.ui.dialog.DocumentPrintDialog
- Test if document print dialog is visible.
- isVisible(androidx.fragment.app.FragmentManager) - function in com.pspdfkit.ui.dialog.DocumentSharingDialog
- Test if document sharing dialog is visible.
- isVolumeButtonsNavigationEnabled() - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration
- Indicates whether to use volume buttons for navigation between document pages.
- isWatermarkFilteringEnabled() - function in com.pspdfkit.document.PdfDocument
- Whether or not watermark filtering is enabled.
- isWritableAndCanSave() - function in com.pspdfkit.document.PdfDocument
- Query whether the document data source is read/write (is not compounded and comes from a supported source) and whether saving is enabled.
- isZIndexEditingEnabled() - function in com.pspdfkit.annotations.configuration.AnnotationConfiguration
- Indicates whether the z-index editing is enabled for this annotation type.
- isZIndexEditingSupported(com.pspdfkit.annotations.AnnotationType) - function in com.pspdfkit.annotations.configuration.AnnotationConfigurationRegistry
- Tests if annotation tool supports editing z-index on a given annotation type.
- isZoomingEnabled() - function in com.pspdfkit.ui.PdfFragment
- Indicates whether the zooming is enabled, or not.
- ITALIAN - enum entry in com.pspdfkit.document.processor.ocr.OcrLanguage
Italian language (en) selector for OCR processing. Use this value with performOcrOnPages when performing text detection for Italian documents. When using this value, make sure you have the Italian OCR language pack added to your app, by adding the
com.pspdfkit:pspdfkit-ocr-italian
dependency inside yourbuild.gradle
file:final String pspdfkit_version = {@value com.pspdfkit.PSPDFKit#VERSION}; dependencies { implementation "com.pspdfkit:pspdfkit-ocr:$pspdfkit_version" implementation "com.pspdfkit:pspdfkit-ocr-italian:$pspdfkit_version" }