Customize inline PDF search in Java for Android

1
/*
2
 *   Copyright © 2017-2025 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.java;
9

10
import static com.pspdfkit.catalog.tasks.ExtractAssetTask.extract;
11

12
import android.content.Context;
13
import android.content.Intent;
14
import android.net.Uri;
15
import androidx.annotation.NonNull;
16
import com.pspdfkit.catalog.R;
17
import com.pspdfkit.catalog.SdkExample;
18
import com.pspdfkit.catalog.examples.java.activities.CustomInlineSearchExampleActivity;
19
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
20
import com.pspdfkit.configuration.search.SearchType;
21
import com.pspdfkit.ui.PdfActivityIntentBuilder;
22
import com.pspdfkit.ui.search.PdfSearchViewInline;
23

24
/**
25
 * This example takes the {@link PdfSearchViewInline} and places it inside a custom layout. To do so
26
 * it uses a custom activity {@link CustomInlineSearchExampleActivity} which will manage creation of
27
 * the new layout as well as showing and hiding of the inline search.
28
 */
29
public class CustomInlineSearchExample extends SdkExample {
30

31
    public CustomInlineSearchExample(@NonNull final Context context) {
32
        super(
33
                context.getString(R.string.customInlineSearchExampleTitle),
34
                context.getString(R.string.customInlineSearchExampleDescription));
35
    }
36

37
    @Override
38
    public void launchExample(
39
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
40
        // This example requires inline search, so override any catalog configuration.
41
        // To change the location of the PdfSearchViewInline as well as the way it is integrated,
42
        // you have to use a custom activity.
43
        configuration.setSearchType(SearchType.INLINE).searchEnabled(true);
44

45
        // Load the example document from the assets and launch the activity.
46
        extract(WELCOME_DOC, getTitle(), context, documentFile -> {
47
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
48
                    .configuration(configuration.build())
49
                    .activityClass(CustomInlineSearchExampleActivity.class)
50
                    .build();
51

52
            // Start the CustomInlineSearchExampleActivity for the extracted document.
53
            context.startActivity(intent);
54
        });
55
    }
56
}