S-index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

S

save(java.lang.String) - function in com.pspdfkit.document.PdfDocument

Saves the document to an external file even if it hasn't been changed.

save(java.lang.String,com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.PdfDocument

Saves the document to an external file even if it hasn't been changed.

save() - function in com.pspdfkit.instant.ui.InstantPdfFragment

Saves the annotations in opened document back to Instant Server (PSPDFKit Document Engine).

save() - function in com.pspdfkit.ui.PdfFragment

Saves the file held by the document view back to it's original location.

SAVE_IF_SELECTED - enum entry in com.pspdfkit.configuration.signatures.SignatureSavingStrategy

There's a checkbox available declaring if the signature should be saved. The signature will be saved if that checkbox is selected. Otherwise, it won't be saved.

SAVEAS - enum entry in com.pspdfkit.annotations.actions.NamedAction.NamedActionType

Show save as UI.

saveAsync(java.lang.String) - function in com.pspdfkit.document.PdfDocument

Saves the document to an external file even if it hasn't been changed.

saveAsync(java.lang.String,com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.PdfDocument

Saves the document to an external file even if it hasn't been changed.

saveAsync() - function in com.pspdfkit.instant.ui.InstantPdfFragment

Saves the annotations in opened document back to Instant Server (PSPDFKit Document Engine).

saveAsync() - function in com.pspdfkit.ui.PdfFragment

Saves the file held by the document view back to it's original location.

saveCheckpoint() - function in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointer

Saves the checkpoint persistently on the local storage.

saveCheckpointAsync() - function in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointer

Saves the checkpoint asynchronously.

saveCurrentlySelectedAnnotation() - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController

Saves currently selected annotations to the document.

saveCurrentlySelectedAnnotations() - function in com.pspdfkit.ui.special_mode.controller.AnnotationEditingController

Saves currently selected annotations to the document.

saveDocument(android.content.Context,com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.editor.PdfDocumentEditor

Saves all changes made to the document.

saveDocument(android.content.Context,java.io.OutputStream,com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.editor.PdfDocumentEditor

Saves all changes made to the document to a given output stream.

saveIfModified() - function in com.pspdfkit.document.ImageDocument

Saves the image document to its original location if it has been changed.

saveIfModified(boolean) - function in com.pspdfkit.document.ImageDocument

Saves the image document to its original location if it has been changed.

saveIfModified(com.pspdfkit.document.DocumentSaveOptions,boolean) - function in com.pspdfkit.document.ImageDocument

Saves the image document to its original location if it has been changed.

saveIfModified() - function in com.pspdfkit.document.PdfDocument

Saves the document to original location if it has been changed.

saveIfModified(com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.PdfDocument

Saves the document to original location if it has been changed.

saveIfModified(java.lang.String) - function in com.pspdfkit.document.PdfDocument

Saves the document to passed location if it has been changed.

saveIfModified(java.lang.String,com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.PdfDocument

Saves the document to passed location if it has been changed.

saveIfModifiedAsync() - function in com.pspdfkit.document.ImageDocument

Saves the image document to its original location if it has been changed.

saveIfModifiedAsync(boolean) - function in com.pspdfkit.document.ImageDocument

Saves the image document to its original location if it has been changed.

saveIfModifiedAsync(com.pspdfkit.document.DocumentSaveOptions,boolean) - function in com.pspdfkit.document.ImageDocument

Saves the image document to its original location if it has been changed.

saveIfModifiedAsync() - function in com.pspdfkit.document.PdfDocument

Saves the document back to original location if it has been changed.

saveIfModifiedAsync(com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.PdfDocument

Saves the document back to original location if it has been changed.

saveIfModifiedAsync(java.lang.String) - function in com.pspdfkit.document.PdfDocument

Saves the document to an external file if it has been changed.

saveIfModifiedAsync(java.lang.String,com.pspdfkit.document.DocumentSaveOptions) - function in com.pspdfkit.document.PdfDocument

Saves the document to an external file if it has been changed.

saveState() - function in com.pspdfkit.ui.ViewStatePagerAdapter

SCALE - enum entry in com.pspdfkit.annotations.configuration.AnnotationProperty

Page measurement to real-world Scale used for measurement annotations.

Scale - class in com.pspdfkit.annotations.measurements

A ratio of the size of an object as displayed on a document page to the size of a corresponding real-world object.

SCALE - enum entry in com.pspdfkit.utils.FreeTextAnnotationUtils.ScaleMode

The exact size needed will be chosen.

Scale.UnitFrom - class in com.pspdfkit.annotations.measurements.Scale

Units available for the source scale value.

Scale.UnitTo - class in com.pspdfkit.annotations.measurements.Scale

Units available for the target scale value.

ScaleAndPrecision - class in com.pspdfkit.annotations.measurements

Collects both Scale and Precision into one abstract baseclass.

ScaleCalibrationPickerInspectorView - class in com.pspdfkit.ui.inspector.views

Inspector component for setting measurement scale via calibration picker.

ScaleCalibrationPickerInspectorView.CalibrationPickerListener - class in com.pspdfkit.ui.inspector.views.ScaleCalibrationPickerInspectorView

Listener for calibration value being picked.

ScaleNameInspectorView - class in com.pspdfkit.ui.inspector.views

Inspector to display and modify the name of a MeasurementValueConfiguration

ScaleNameInspectorView.NameChangeListener - class in com.pspdfkit.ui.inspector.views.ScaleNameInspectorView

ScalePickerInspectorView - class in com.pspdfkit.ui.inspector.views

Inspector component for picking measurement annotation scale.

ScalePickerInspectorView.ScalePickerListener - class in com.pspdfkit.ui.inspector.views.ScalePickerInspectorView

Listener for scale value being picked.

ScaleSelectPickerInspectorView - class in com.pspdfkit.ui.inspector.views

Used by the AnnotationCreationInspectorFactory to display/select the default MeasurementValueConfiguration to be used for creating a measurement annotation.

SCALING - enum entry in com.pspdfkit.ui.overlay.OverlayLayoutParams.SizingMode

Your view will be measured and laid out based on zoom level 1 and a simple setScaleX and setScaleY will be applied to it based on the zoom.

SCREEN - enum entry in com.pspdfkit.annotations.AnnotationType

Embedded PDF video

SCREEN - enum entry in com.pspdfkit.annotations.BlendMode

B(cb,cs) = 1 – [(1–cb)×(1–cs)] = cb + cs – (cb × cs) Multiplies the complements of the backdrop and source colour values, then complements the result. The result colour is always at least as light as either of the two constituent colours. Screening any colour with white produces white; screening with black leaves the original colour unchanged. The effect is similar to projecting multiple photographic slides simultaneously onto a single screen.

See also PorterDuff.Mode#SCREEN

SCREEN_AWAKE - enum entry in com.pspdfkit.configuration.settings.SettingsMenuItemType

ScreenAdjustingEditText - class in com.pspdfkit.ui.editor

EditText that automatically changes the soft input mode when focused.

ScreenAdjustingTextInputEditText - class in com.pspdfkit.ui.editor

TextInputEditText that automatically changes the soft input mode when focused.

ScreenAnnotation - class in com.pspdfkit.annotations

A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played.

SCROLL_DIRECTION - enum entry in com.pspdfkit.configuration.settings.SettingsMenuItemType

ScrollableThumbnailBarLayoutManager - class in com.pspdfkit.ui.thumbnail

Layout manager for scrollable thumbnail bar.

scrollbarsEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets the document scrollbars to be enabled or disabled.

scrollbarsEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets the document scrollbars to be enabled or disabled.

scrollDirection(com.pspdfkit.configuration.page.PageScrollDirection) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets scrolling direction for the document.

scrollDirection(com.pspdfkit.configuration.page.PageScrollDirection) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets the scrolling direction (i.e.

scrollMode(com.pspdfkit.configuration.page.PageScrollMode) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets the page scrolling mode - if the scrolling position will always snap to page or not.

scrollMode(com.pspdfkit.configuration.page.PageScrollMode) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets the scrolling mode.

scrollOnEdgeTapEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets whether taps on the edge of a page scroll to the next / previous page.

scrollOnEdgeTapEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets whether taps on the edge of a page scroll to the next / previous page.

scrollOnEdgeTapMargin(java.lang.Integer) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Margin in dp in which taps on the edge of the page will trigger the page navigation.

scrollOnEdgeTapMargin(java.lang.Integer) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Margin in dp in which taps on the edge of the page will trigger the page navigation.

ScrollState - class in com.pspdfkit.listeners.scrolling

Represents the scroll state of a PdfFragment.

scrollTo(android.graphics.RectF,int,long,boolean) - function in com.pspdfkit.ui.PdfFragment

Scrolls to the given pdfRect, if necessary changing to the page.

SEARCH - enum entry in com.pspdfkit.annotations.actions.NamedAction.NamedActionType

Show search UI.

search(java.lang.String,com.pspdfkit.document.library.QueryOptions,com.pspdfkit.document.library.QueryResultListener) - function in com.pspdfkit.document.library.PdfLibrary

Query the database for a match of searchString.

searchAnnotations(boolean) - function in com.pspdfkit.document.search.SearchOptions.Builder

Enables/disables searching in annotations contents in addition to page text.

searchConfiguration(com.pspdfkit.configuration.search.SearchConfiguration) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets configuration used for searching, applied to search views.

SearchConfiguration - class in com.pspdfkit.configuration.search

Class containing search configuration properties.

searchEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enable/disable document search functionality.

SearchOptions - class in com.pspdfkit.document.search

Search options used when searching a loaded document for text.

SearchOptions.Builder - class in com.pspdfkit.document.search.SearchOptions

Builder for creating SearchOptions.

SearchResult - class in com.pspdfkit.document.search

Represents a result found when searching for text.

SearchResult.TextSnippet - class in com.pspdfkit.document.search.SearchResult

The TextSnippet can be extracted with a search result to present a preview text to the user.

SearchResultHighlighter - class in com.pspdfkit.ui.search

PdfDrawableProvider creating highlights based on a list of SearchResult instances.

searchSelectedText() - function in com.pspdfkit.ui.special_mode.controller.TextSelectionController

Search currently selected text.

SearchType - class in com.pspdfkit.configuration.search

The different search UIs that are available.

SecondaryMeasurementUnit - class in com.pspdfkit.annotations.measurements

This class holds the units to be used for the secondary unit(if enabled by the user) and just contains the MeasurementPrecision and the com.pspdfkit.annotations.measurements.Scale.UnitTo.

SEEK - enum entry in com.pspdfkit.annotations.actions.RichMediaExecuteAction.RichMediaExecuteActionType

seekTo(int) - function in com.pspdfkit.ui.audio.AudioPlaybackController

Seeks to a specified offset in the media.

select() - function in com.pspdfkit.forms.CheckBoxFormConfiguration.Builder

Selects checkbox form element button.

select() - function in com.pspdfkit.forms.EditableButtonFormElement

Selects the button.

select() - function in com.pspdfkit.forms.RadioButtonFormConfiguration.Builder

Selects checkbox form element button.

selectAudioTrack(int) - function in com.pspdfkit.annotations.sound.AudioExtractor

Selects audio track for decoding.

selectedAnnotationResizeGuidesEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enables or disables resize guides.

selectedFreetextAnnotationFontScalingOnResizeEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enables or disables font scaling.

selectNextFormElement() - function in com.pspdfkit.ui.special_mode.controller.FormEditingController

Selects the next form element in tab order.

selectPage(int) - function in com.pspdfkit.ui.thumbnail.ThumbnailAdapter

Sets selected page to highlight.

selectPreviousFormElement() - function in com.pspdfkit.ui.special_mode.controller.FormEditingController

Selects the previous form element in tab order.

selEnd(java.lang.Boolean) - function in com.pspdfkit.undo.edit.contentediting.ContentEditingNativeChangeEdit

SELF_SIGNED - enum entry in com.pspdfkit.signatures.DigitalSignatureValidationResult.ValidationProblem

Signature is self signed.

selStart(java.lang.Boolean) - function in com.pspdfkit.undo.edit.contentediting.ContentEditingNativeChangeEdit

SEND - enum entry in com.pspdfkit.document.sharing.ShareAction

Shares pdf file to all applications that can handle binary files - file managers, instant messengers etc.

SENDING_CHANGES - enum entry in com.pspdfkit.instant.document.InstantDocumentState

The document is busy syncing — currently sending its local changes to the server.

If the communication with the server fails, the document will fall back into state DIRTY (and any registered InstantDocumentListener will be notified about sync error). If all goes well, this state will transition to RECEIVING_CHANGES (and any registered InstantDocumentListener will be notified).

SEPARATE - enum entry in com.pspdfkit.configuration.annotations.AnnotationAggregationStrategy

Every stroke will result in a separate ink annotation.

This creates the maximum number of annotations.

SERBIAN - enum entry in com.pspdfkit.document.processor.ocr.OcrLanguage

Serbian language (en) selector for OCR processing. Use this value with performOcrOnPages when performing text detection for Serbian documents. When using this value, make sure you have the Serbian OCR language pack added to your app, by adding the com.pspdfkit:pspdfkit-ocr-serbian dependency inside your build.gradle file:


final String pspdfkit_version = {@value com.pspdfkit.PSPDFKit#VERSION};
dependencies {
    implementation "com.pspdfkit:pspdfkit-ocr:$pspdfkit_version"
    implementation "com.pspdfkit:pspdfkit-ocr-serbian:$pspdfkit_version"
}

SERVER_UUID_PENDING - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

The server cache could not be looked up because the server’s UUID is yet to be determined. This happens for every InstantClient in a newly installed app until it has authenticated for loading the first document.

set(java.lang.String,com.pspdfkit.document.PdfValue) - function in com.pspdfkit.document.metadata.DocumentPdfMetadata

Sets a single value in the PDF.

set(java.lang.String,java.lang.String,java.lang.String,java.lang.String) - function in com.pspdfkit.document.metadata.DocumentXmpMetadata

Sets a single metadata value inside the XMP metadata structure in PDF.

set(android.graphics.RectF) - function in com.pspdfkit.utils.PageRect

Sets new page rect.

set(com.pspdfkit.utils.PageRect) - function in com.pspdfkit.utils.PageRect

Sets another page rect.

set(float,float,float,float) - function in com.pspdfkit.utils.PageRect

Sets new page rect.

setAction(com.pspdfkit.annotations.actions.Action) - function in com.pspdfkit.annotations.LinkAnnotation

Sets the action to the annotation.

setAction(com.pspdfkit.annotations.actions.Action) - function in com.pspdfkit.document.OutlineElement.Builder

Sets action that will be executed when clicking on this outline element.

setAction(com.pspdfkit.annotations.actions.Action) - function in com.pspdfkit.forms.PushButtonFormConfiguration.Builder

Sets the action of this push button form element.

setAction(com.pspdfkit.annotations.actions.Action) - function in com.pspdfkit.forms.PushButtonFormElement

Sets action to the link annotation.

setAdditionalAction(com.pspdfkit.annotations.actions.AnnotationTriggerEvent,com.pspdfkit.annotations.actions.Action) - function in com.pspdfkit.annotations.WidgetAnnotation

Sets the action that should be executed for the given annotation trigger event.

setAdditionalAction(com.pspdfkit.annotations.actions.AnnotationTriggerEvent,com.pspdfkit.annotations.actions.Action) - function in com.pspdfkit.forms.FormElementConfiguration.BaseBuilder

Sets the action that should be executed for given annotation trigger event.

setAlpha(float) - function in com.pspdfkit.annotations.Annotation

Sets the annotation's alpha (or stroke alpha) value.

setAlpha(com.pspdfkit.ui.special_mode.controller.AnnotationTool,com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant,float) - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager

Sets annotation alpha to preferences.

setAlpha(com.pspdfkit.ui.special_mode.controller.AnnotationTool,float) - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager

Sets annotation alpha to preferences.

setAlpha(int) - function in com.pspdfkit.ui.note.NoteHinterDrawable

setAlpha(float) - function in com.pspdfkit.ui.special_mode.controller.AnnotationCreationController

Sets alpha to the annotation creation mode.

setAlternateBackgroundColor(int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuBar

setAnnotationAggregationStrategy(com.pspdfkit.configuration.annotations.AnnotationAggregationStrategy) - function in com.pspdfkit.annotations.configuration.AnnotationAggregationStrategyConfiguration.Builder

Sets annotation aggregation strategy that should be used when drawing annotations.

setAnnotationCreationInspectorController(com.pspdfkit.ui.inspector.annotation.AnnotationCreationInspectorController) - function in com.pspdfkit.ui.PdfUi

Sets controller of the annotation inspector used when creating annotations.

setAnnotationCreator(java.lang.String) - function in com.pspdfkit.preferences.PSPDFKitPreferences

Sets the annotation creator.

setAnnotationEditingEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Enables additional controls in the annotation outline view to delete annotations.

setAnnotationEditingInspectorController(com.pspdfkit.ui.inspector.annotation.AnnotationEditingInspectorController) - function in com.pspdfkit.ui.PdfUi

Sets controller of the annotation inspector used when editing annotations.

setAnnotationInspectorEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets whether the annotation inspector is enabled.

setAnnotationInspectorEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets whether the annotation inspector is enabled.

setAnnotationListReorderingEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Sets whether reordering of annotations in the annotation list is enabled.

setAnnotationListViewEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Enables annotation list view.

setAnnotationListViewEnabled(boolean,boolean) - function in com.pspdfkit.ui.PdfOutlineView

Enables annotation list view.

setAnnotationNoteHintingEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enables or disables visual indicator shown for annotations that have annotation notes.

setAnnotationOverlayRenderStrategy(com.pspdfkit.ui.rendering.AnnotationOverlayRenderStrategy) - function in com.pspdfkit.ui.PdfFragment

Sets the annotation overlay render strategy.

setAnnotationSelectionViewThemeConfiguration(com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration) - function in com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController

Sets a theme configuration to customize the annotation selection view.

setAppearanceStreamGenerator(com.pspdfkit.annotations.appearance.AppearanceStreamGenerator) - function in com.pspdfkit.annotations.Annotation

Sets custom appearance stream generator that overrides appearance stream generation of this annotation.

setApplicationPolicy(com.pspdfkit.configuration.policy.ApplicationPolicy) - function in com.pspdfkit.PSPDFKit

Sets application policy for the loaded library.

setApplyRedactions(boolean) - function in com.pspdfkit.document.DocumentSaveOptions

Sets whether saving will apply redactions or not.

setAttached(boolean) - function in com.pspdfkit.ui.toolbar.ContextualToolbar

Sets whether the toolbar is attached or detached from the layout.

setAudioData(com.pspdfkit.annotations.sound.EmbeddedAudioSource) - function in com.pspdfkit.undo.edit.annotations.AnnotationAddRemoveEdit

Sound annotation audio data (if set).

setAudioData(com.pspdfkit.annotations.sound.EmbeddedAudioSource) - function in com.pspdfkit.undo.edit.annotations.AudioResourceEdit

New value for the sound annotation's audio data.

setAudioRecordingSampleRate(int) - function in com.pspdfkit.annotations.configuration.SoundAnnotationConfiguration.Builder

Sets sample rate used for audio recording.

setAudioRecordingTimeLimit(int) - function in com.pspdfkit.annotations.configuration.SoundAnnotationConfiguration.Builder

Sets audio recording time limit.

setAudioSource(com.pspdfkit.annotations.sound.EmbeddedAudioSource) - function in com.pspdfkit.annotations.SoundAnnotation

Replaces the audio data in this annotation.

setAuthor(java.lang.String) - function in com.pspdfkit.document.metadata.DocumentPdfMetadata

Sets the author for the document.

setAutoHide(boolean) - function in com.pspdfkit.ui.scrollbar.VerticalScrollBar

This controls if the scrollbar can auto hide or stay visible all the time.

setAutomaticLinkGenerationEnabled(boolean) - function in com.pspdfkit.document.PdfDocument

Enables or disables automatic link generation.

setAvailableColors(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationColorConfiguration.Builder

Sets colors that will be available in the color picker.

setAvailableFillColors(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationFillColorConfiguration.Builder

Sets fill colors that will be available in the color picker.

setAvailableFonts(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationFontConfiguration.Builder

Sets fonts that will be available in the inspector.

setAvailableFonts(kotlin.collections.LinkedHashSet) - function in com.pspdfkit.ui.signatures.ElectronicSignatureOptions.Companion

Sets a custom LinkedHashSet of fonts to pick from when typing a signature.

setAvailableIconNames(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationNoteIconConfiguration.Builder

Sets names of note icons available in the icon picker.

setAvailableLineEnds(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationLineEndsConfiguration.Builder

Sets line end types that will be available in the inspector.

setAvailableOutlineColors(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationOutlineColorConfiguration.Builder

Sets outline colors that will be available in the color picker.

setAvailableStampPickerItems(java.util.List) - function in com.pspdfkit.annotations.configuration.StampAnnotationConfiguration.Builder

Sets default set of stamp annotations displayed in stamps picker.

setBackgroundColor(int) - function in com.pspdfkit.ui.PdfFragment

Sets the background color of the fragment.

setBackgroundColor(int) - function in com.pspdfkit.ui.PdfThumbnailBar

Sets the background color for the thumbnail bar.

setBackgroundColor(int) - function in com.pspdfkit.ui.PdfThumbnailGrid

Sets the background color of the thumbnail grid.

setBackgroundColor(int) - function in com.pspdfkit.ui.contentediting.ContentEditingStylingBar

Sets background color to the content editing bar.

setBackgroundColor(int) - function in com.pspdfkit.ui.forms.FormEditingBar

Sets background color to the form editing bar.

setBackgroundColor(int) - function in com.pspdfkit.ui.search.PdfSearchViewModular

Sets background color of the modular search view.

setBackgroundColor(int) - function in com.pspdfkit.ui.thumbnail.PdfScrollableThumbnailBar

setBackgroundColor(int) - function in com.pspdfkit.ui.thumbnail.PdfStaticThumbnailBar

setBackgroundColor(int) - function in com.pspdfkit.ui.thumbnail.PdfThumbnailBarController

Sets the background color for the thumbnail bar.

setBackgroundColor(int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuBar

setBackgroundColor(int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarSubMenu

setBackgroundDrawable(android.graphics.drawable.Drawable) - function in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration.Builder

setBackIconColorTint(int) - function in com.pspdfkit.ui.search.PdfSearchViewInline

Sets the icon color for the back icon.

setBitmap(android.graphics.Bitmap) - function in com.pspdfkit.annotations.StampAnnotation

Sets a custom bitmap for this stamp annotation.

setBitmap(kotlin.Array) - function in com.pspdfkit.annotations.StampAnnotation

Sets a custom bitmap for this stamp annotation.

setBitmap(android.graphics.Bitmap) - function in com.pspdfkit.forms.PushButtonFormElement

Sets a custom bitmap for this button form element.

setBitmap(android.graphics.Bitmap) - function in com.pspdfkit.undo.edit.annotations.AnnotationAddRemoveEdit

Stamp bitmap (if set).

setBlendMode(com.pspdfkit.annotations.BlendMode) - function in com.pspdfkit.annotations.Annotation

Sets the blend mode used when generating annotation's appearance stream.

setBookmarkAdapter(com.pspdfkit.ui.outline.BookmarkViewAdapter) - function in com.pspdfkit.ui.PdfOutlineView

Sets an adapter that handles actual bookmark data.

setBookmarkEditingEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Allows bookmark view to edit annotations.

setBookmarkRenamingEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Allows bookmark view to rename annotations.

setBookmarkViewEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Enables bookmark view.

setBookmarkViewEnabled(boolean,boolean) - function in com.pspdfkit.ui.PdfOutlineView

Enables bookmark view.

setBorderAndBackgroundColor(int,int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuBar

setBorderAndBackroundColor(int,int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarSubMenu

setBorderColor(int) - function in com.pspdfkit.annotations.Annotation

Sets the border color for this annotation.

setBorderColor(int) - function in com.pspdfkit.annotations.WidgetAnnotation

Sets the border color for this annotation.

setBorderColor(int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuBar

setBorderColor(int) - function in com.pspdfkit.ui.toolbar.ContextualToolbarSubMenu

setBorderDashArray(java.util.List) - function in com.pspdfkit.annotations.Annotation

Sets a dash style for the border.

setBorderEffect(com.pspdfkit.annotations.BorderEffect) - function in com.pspdfkit.annotations.Annotation

Sets a border effect for current annotation.

setBorderEffectIntensity(float) - function in com.pspdfkit.annotations.Annotation

Sets border effect intensity.

setBorderStyle(com.pspdfkit.annotations.BorderStyle) - function in com.pspdfkit.annotations.Annotation

Sets a border style for current annotation.

setBorderStyle(com.pspdfkit.annotations.BorderStyle) - function in com.pspdfkit.annotations.PolygonAnnotation

Sets a border style for current annotation.

setBorderStylePreset(com.pspdfkit.ui.special_mode.controller.AnnotationTool,com.pspdfkit.ui.inspector.views.BorderStylePreset) - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager

Sets annotation border preset to preferences.

setBorderStylePreset(com.pspdfkit.ui.special_mode.controller.AnnotationTool,com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant,com.pspdfkit.ui.inspector.views.BorderStylePreset) - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager

Sets annotation border preset to preferences.

setBorderStylePreset(com.pspdfkit.ui.inspector.views.BorderStylePreset) - function in com.pspdfkit.ui.special_mode.controller.AnnotationCreationController

Sets border preset to the annotation creation mode.

setBorderStylePresets(java.util.List) - function in com.pspdfkit.annotations.configuration.AnnotationBorderStyleConfiguration.Builder

Sets border style presets that will be available in the inspector.

setBorderWidth(float) - function in com.pspdfkit.annotations.Annotation

Sets border line width / thickness.

setBottomCenterScaleHandleDrawable(android.graphics.drawable.Drawable) - function in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration.Builder

setBottomInset(int) - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayout

Sets bottom inset for displayed PropertyInspectors.

setBottomInset(int) - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayoutController

Sets bottom inset for displayed PropertyInspectors.

setBottomLeftScaleHandleDrawable(android.graphics.drawable.Drawable) - function in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration.Builder

setBottomOffset(int) - function in com.pspdfkit.ui.redaction.RedactionView

Sets the bottom offset for the redaction button, used to make sure it doesn't overlay any other view.

setBottomRightScaleHandleDrawable(android.graphics.drawable.Drawable) - function in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration.Builder

setBoundingBox(android.graphics.RectF) - function in com.pspdfkit.annotations.Annotation

Sets the position and size of this annotation on the page.

setCalibration(java.lang.Float,com.pspdfkit.annotations.measurements.Scale.UnitTo,boolean) - function in com.pspdfkit.ui.inspector.views.ScaleCalibrationPickerInspectorView

Sets value to the calibration picker.

setCalibrationPicker(com.pspdfkit.ui.inspector.views.ScaleCalibrationPickerInspectorView) - function in com.pspdfkit.ui.inspector.views.ScalePickerInspectorView

setCallOutPoints(java.util.List) - function in com.pspdfkit.annotations.FreeTextAnnotation

Sets the call out points for this free text annotation.

setCancelListener(com.pspdfkit.ui.inspector.PropertyInspector.OnCancelListener) - function in com.pspdfkit.ui.inspector.PropertyInspector

Sets a listener to be notified of a cancellation.

setCancelOnTouchOutside(boolean) - function in com.pspdfkit.ui.inspector.PropertyInspector

Make inspector request PropertyInspectorCoordinatorLayout to be cancelled when touched outside its bounds.

setCenterLeftScaleHandleDrawable(android.graphics.drawable.Drawable) - function in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration.Builder

setCenterRightScaleHandleDrawable(android.graphics.drawable.Drawable) - function in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration.Builder

setCertificates(java.util.List) - function in com.pspdfkit.signatures.SignerOptions.Builder

Optionally add the certificates in the chain used for signing.

setCheckpointPath(android.content.Context,com.pspdfkit.document.DocumentSource,java.lang.String) - function in com.pspdfkit.document.checkpoint.PdfDocumentCheckpointer

Creates a local path for saving the checkpoint file.

setChildren(java.util.List) - function in com.pspdfkit.document.OutlineElement.Builder

Sets element children - outline elements are organized in a tree-like fashion.

setCloseButton(com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem) - function in com.pspdfkit.ui.toolbar.ContextualToolbar

Sets the button used to close the toolbar.

setCloseMode(com.pspdfkit.ui.tabs.PdfTabBarCloseMode) - function in com.pspdfkit.ui.tabs.PdfTabBar

Sets the tab close mode which determines how the user is able to close documents.

setCloseSubmenuOnItemClick(boolean) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem

Sets if the submenu should be hidden when any item in the submenu is clicked.

setColor(int) - function in com.pspdfkit.annotations.Annotation

Sets the color for this annotation.

setColor(com.pspdfkit.ui.special_mode.controller.AnnotationTool,com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant,int) - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager

Sets annotation color to preferences.

setColor(com.pspdfkit.ui.special_mode.controller.AnnotationTool,int) - function in com.pspdfkit.annotations.defaults.AnnotationPreferencesManager

Sets annotation color to preferences.

setColor(int) - function in com.pspdfkit.document.OutlineElement.Builder

Sets outline element text color.

setColor(int) - function in com.pspdfkit.ui.PdfPasswordView

Sets the password view color (input field, underline, icon tint).

setColor(int,boolean) - function in com.pspdfkit.ui.inspector.views.ColorPickerInspectorView

Sets value to the color picker.

setColor(int) - function in com.pspdfkit.ui.special_mode.controller.AnnotationCreationController

Sets color for the annotation creation mode.

setColorFilter(android.graphics.ColorFilter) - function in com.pspdfkit.ui.note.NoteHinterDrawable

setColorPickerDetailView(com.pspdfkit.ui.inspector.views.ColorPickerInspectorView.ColorPickerDetailView) - function in com.pspdfkit.ui.inspector.views.ColorPickerInspectorView

Sets the detail view that will be displayed when clicking on this color picker inspector.

setConfiguration(com.pspdfkit.configuration.activity.PdfActivityConfiguration) - function in com.pspdfkit.ui.PdfActivity

Replaces activity configuration.

setConfiguration(com.pspdfkit.configuration.activity.PdfActivityConfiguration) - function in com.pspdfkit.ui.PdfUi

Replaces activity configuration.

setConfiguration(com.pspdfkit.configuration.activity.PdfActivityConfiguration) - function in com.pspdfkit.ui.PdfUiFragment

Replaces activity configuration.

setConfiguration(com.pspdfkit.annotations.measurements.MeasurementValueConfiguration,boolean) - function in com.pspdfkit.ui.inspector.views.ScaleSelectPickerInspectorView

Sets value to the scale picker.

setContents(java.lang.String) - function in com.pspdfkit.annotations.Annotation

Sets text contents of the annotation.

setContentSize(android.graphics.RectF,boolean) - function in com.pspdfkit.annotations.Annotation

Sets the inner bounds that are used when rotating the annotation.

setContentSize(android.graphics.RectF,boolean) - function in com.pspdfkit.annotations.FreeTextAnnotation

Sets the inner bounds that are used when rotating the annotation.

setController(com.pspdfkit.ui.special_mode.controller.AnnotationEditingController) - function in com.pspdfkit.ui.toolbar.AnnotationEditingToolbar

setCreatedDate(java.util.Date) - function in com.pspdfkit.annotations.Annotation

Sets created date for this annotation.

setCreationDate(java.util.Date) - function in com.pspdfkit.document.metadata.DocumentPdfMetadata

Sets the creation date for the document.

setCreator(java.lang.String) - function in com.pspdfkit.annotations.Annotation

Sets the creator of this annotation.

setCreator(java.lang.String) - function in com.pspdfkit.document.metadata.DocumentPdfMetadata

Sets the creator for the document.

setCustomColorPickerEnabled(boolean) - function in com.pspdfkit.annotations.configuration.AnnotationColorConfiguration.Builder

Sets whether or not the custom color picker is used.

setCustomColorPickerEnabled(boolean) - function in com.pspdfkit.annotations.configuration.AnnotationFillColorConfiguration.Builder

Sets whether or not the custom color picker is used.

setCustomColorPickerEnabled(boolean) - function in com.pspdfkit.annotations.configuration.AnnotationOutlineColorConfiguration.Builder

Sets whether or not the custom color picker is used.

setCustomData(org.json.JSONObject) - function in com.pspdfkit.annotations.Annotation

Sets custom data to the annotation.

setCustomPdfSource(com.pspdfkit.document.DocumentSource) - function in com.pspdfkit.ui.PdfFragment

Sets the custom source for the PDF file.

setCustomPdfSources(java.util.List) - function in com.pspdfkit.ui.PdfFragment

Sets the custom sources for the PDF file.

setCustomText(java.lang.String) - function in com.pspdfkit.forms.ComboBoxFormConfiguration.Builder

Sets custom text string.

setCustomText(java.lang.String) - function in com.pspdfkit.forms.ComboBoxFormElement

Sets a custom value.

setCustomValue(java.lang.String) - function in com.pspdfkit.ui.inspector.views.OptionPickerInspectorView

Sets new custom value.

setDashArray(java.util.List) - function in com.pspdfkit.annotations.BaseLineAnnotation

Sets a dash style for the line.

setDefaultAlpha(float) - function in com.pspdfkit.annotations.configuration.AnnotationAlphaConfiguration.Builder

Sets default annotation alpha.

setDefaultBorderStylePreset(com.pspdfkit.ui.inspector.views.BorderStylePreset) - function in com.pspdfkit.annotations.configuration.AnnotationBorderStyleConfiguration.Builder

Sets default border style.

setDefaultColor(int) - function in com.pspdfkit.annotations.configuration.AnnotationColorConfiguration.Builder

Sets default foreground color.

setDefaultConfiguration(com.pspdfkit.annotations.measurements.MeasurementValueConfiguration) - function in com.pspdfkit.annotations.measurements.MeasurementValueConfiguration

setDefaultFillColor(int) - function in com.pspdfkit.annotations.configuration.AnnotationFillColorConfiguration.Builder

Sets default fill color.

setDefaultFont(com.pspdfkit.ui.fonts.Font) - function in com.pspdfkit.annotations.configuration.AnnotationFontConfiguration.Builder

Sets default font.

setDefaultIconName(java.lang.String) - function in com.pspdfkit.annotations.configuration.AnnotationNoteIconConfiguration.Builder

Sets default note annotation icon name.

setDefaultLineEnds(androidx.core.util.Pair) - function in com.pspdfkit.annotations.configuration.AnnotationLineEndsConfiguration.Builder

Sets default line end types.

setDefaultOutlineColor(int) - function in com.pspdfkit.annotations.configuration.AnnotationOutlineColorConfiguration.Builder

Sets default outline color.

setDefaultOverlayText(java.lang.String) - function in com.pspdfkit.annotations.configuration.AnnotationOverlayTextConfiguration.Builder

Sets the default overlay text for RedactionAnnotation.

setDefaultPrecision(com.pspdfkit.annotations.measurements.MeasurementPrecision) - function in com.pspdfkit.annotations.configuration.AnnotationPrecisionConfiguration.Builder

Sets default precision.

setDefaultRepeatOverlayTextSetting(boolean) - function in com.pspdfkit.annotations.configuration.AnnotationOverlayTextConfiguration.Builder

Sets default setting for the repeat overlay text property of RedactionAnnotation.

setDefaultScale(com.pspdfkit.annotations.measurements.Scale) - function in com.pspdfkit.annotations.configuration.AnnotationScaleConfiguration.Builder

Sets default scale.

setDefaultSelectedMenuItem(com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem

Sets an item that will be selected by default when this item is pressed.

setDefaultTextSize(float) - function in com.pspdfkit.annotations.configuration.AnnotationTextSizeConfiguration.Builder

Sets default text size.

setDefaultThickness(float) - function in com.pspdfkit.annotations.configuration.AnnotationThicknessConfiguration.Builder

Sets default annotation thickness.

setDefaultValue(int) - function in com.pspdfkit.ui.editor.UnitSelectionEditText

Sets default value of the unit.

setDelayForSyncingLocalChanges(long) - function in com.pspdfkit.instant.document.InstantPdfDocument

Delay in milliseconds before kicking off automatic sync after local changes are made to the document.

setDialogOnCancelListener(android.content.DialogInterface.OnCancelListener) - function in com.pspdfkit.document.download.DownloadProgressFragment

Sets a DialogInterface.OnCancelListener that will be informed when the progress dialog was cancelled by the user.

setDisplayEmbeddedFilesViewEnabled(boolean) - function in com.pspdfkit.ui.PdfOutlineView

Enables the embedded files view.

setDisplayOutsideOfSubmenuIfPossible(boolean) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem

Sets to display menu item as separate item outside of submenu if there's room in the toolbar.

setDocument(java.lang.String,java.lang.String) - function in com.pspdfkit.instant.ui.InstantPdfActivity

Loads a new Instant document in this activity and replaces the existing one.

setDocument(com.pspdfkit.ui.DocumentDescriptor) - function in com.pspdfkit.ui.DocumentCoordinator

Replaces currently visible document with another document.

setDocument(com.pspdfkit.document.PdfDocument) - function in com.pspdfkit.ui.DocumentDescriptor

Sets document instance associated with this descriptor.

setDocument(com.pspdfkit.document.PdfDocument) - function in com.pspdfkit.ui.PSPDFKitViews

Sets the document to all instantiated views.

setDocument(com.pspdfkit.document.PdfDocument,com.pspdfkit.configuration.PdfConfiguration) - function in com.pspdfkit.ui.PSPDFKitViews.PSPDFView