Custom Inline Search

1
/*
2
 *   Copyright © 2017-2026 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.animation.Animator;
13
import android.animation.AnimatorListenerAdapter;
14
import android.content.Context;
15
import android.content.Intent;
16
import android.net.Uri;
17
import android.os.Bundle;
18
import android.view.Gravity;
19
import android.view.View;
20
import android.view.ViewGroup;
21
import android.widget.FrameLayout;
22
import androidx.annotation.NonNull;
23
import androidx.core.view.ViewCompat;
24
import com.pspdfkit.catalog.R;
25
import com.pspdfkit.catalog.SdkExample;
26
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
27
import com.pspdfkit.configuration.search.SearchType;
28
import com.pspdfkit.listeners.OnVisibilityChangedListener;
29
import com.pspdfkit.ui.PdfActivity;
30
import com.pspdfkit.ui.PdfActivityIntentBuilder;
31
import com.pspdfkit.ui.search.PdfSearchViewInline;
32

33
/**
34
 * This example takes the {@link PdfSearchViewInline} and places it inside a custom layout. To do so
35
 * it uses a custom activity {@link CustomInlineSearchExampleActivity} which will manage creation of
36
 * the new layout as well as showing and hiding of the inline search.
37
 */
38
public class CustomInlineSearchExample extends SdkExample {
39

40
    public CustomInlineSearchExample(@NonNull final Context context) {
41
        super(context, R.string.customInlineSearchExampleTitle, R.string.customInlineSearchExampleDescription);
42
    }
43

44
    @Override
45
    public void launchExample(
46
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
47
        // This example requires inline search, so override any catalog configuration.
48
        // To change the location of the PdfSearchViewInline as well as the way it is integrated,
49
        // you have to use a custom activity.
50
        configuration.setSearchType(SearchType.INLINE).searchEnabled(true);
51

52
        // Load the example document from the assets and launch the activity.
53
        extract(WELCOME_DOC, getTitle(), context, documentFile -> {
54
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
55
                    .configuration(configuration.build())
56
                    .activityClass(CustomInlineSearchExampleActivity.class)
57
                    .build();
58

59
            // Start the CustomInlineSearchExampleActivity for the extracted document.
60
            context.startActivity(intent);
61
        });
62
    }
63

64
    /**
65
     * This activity supports all features of the original {@link PdfActivity} and uses its {@link
66
     * PdfSearchViewInline} in a custom layout.
67
     */
68
    public static class CustomInlineSearchExampleActivity extends PdfActivity {
69

70
        @Override
71
        protected void onCreate(Bundle savedInstanceState) {
72
            super.onCreate(savedInstanceState);
73

74
            setSupportActionBar(null);
75
            // Extract the content area of the PdfActivity. It is a FrameLayout and will be used as a
76
            // top-level view group holding our
77
            // inline search view.
78
            final FrameLayout content = findViewById(R.id.pspdf__activity_content);
79
            assert content != null;
80

81
            // The inline search is retrieved from the PdfActivity. That way it is already hooked up to
82
            // the fragment and will handle search
83
            // result highlighting, and showing of results.
84
            final PdfSearchViewInline inlineSearchView =
85
                    (PdfSearchViewInline) getPSPDFKitViews().getSearchView();
86
            if (inlineSearchView == null) {
87
                throw new IllegalStateException("Inline search view was null!");
88
            }
89

90
            // This example will add the inline search on the top of the activity, as a sliding panel –
91
            // right below the action bar.
92
            final FrameLayout container = (FrameLayout)
93
                    getLayoutInflater().inflate(R.layout.activity_custom_inline_search_container, content, false);
94
            // Remove the inline search from it's original parent.
95
            if (inlineSearchView.getParent() != null) {
96
                ((ViewGroup) inlineSearchView.getParent()).removeView(inlineSearchView);
97
            }
98
            // Add the inline search to the sliding panel container.
99
            container.addView(
100
                    inlineSearchView,
101
                    new FrameLayout.LayoutParams(
102
                            ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT));
103
            // Add the container to the activity layout.
104
            content.addView(
105
                    container,
106
                    new FrameLayout.LayoutParams(
107
                            ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT, Gravity.TOP));
108
            // And make it invisible by default.
109
            container.setVisibility(View.INVISIBLE);
110

111
            // Apply any system window insets from the top (without actually consuming them) so that the
112
            // inline search is not covered
113
            // by the action bar or the status bar.
114
            ViewCompat.setOnApplyWindowInsetsListener(container, (v, insets) -> {
115
                ((ViewGroup.MarginLayoutParams) container.getLayoutParams()).topMargin =
116
                        insets.getSystemWindowInsetTop();
117
                return insets;
118
            });
119

120
            // To show and hide the inline search, register an OnVisibilityChangedListener which will be
121
            // called every time the view was
122
            // requested or dismissed by the user. Since the PdfActivity has by default its own listener
123
            // which handles attaching it to the
124
            // action bar, existing listeners have to be cleared first.
125
            inlineSearchView.clearOnVisibilityChangedListeners();
126
            inlineSearchView.addOnVisibilityChangedListener(new OnVisibilityChangedListener() {
127
                @Override
128
                public void onShow(@NonNull View view) {
129
                    container.setVisibility(View.VISIBLE);
130
                    container.setTranslationY(-view.getHeight());
131
                    container.animate().translationY(0).start();
132
                }
133

134
                @Override
135
                public void onHide(@NonNull final View view) {
136
                    container
137
                            .animate()
138
                            .translationY(-container.getHeight())
139
                            .setListener(new AnimatorListenerAdapter() {
140
                                @Override
141
                                public void onAnimationEnd(Animator animation) {
142
                                    container.setVisibility(View.INVISIBLE);
143
                                    container.animate().setListener(null);
144
                                }
145
                            })
146
                            .start();
147
                }
148
            });
149
        }
150
    }
151
}