summaryrefslogtreecommitdiffstats
path: root/library/main/src/com/android/setupwizardlib/util/RequireScrollHelper.java
blob: 8d796d70ffd93aa974d04a17ae2bfd3e52870e62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.setupwizardlib.util;

import android.view.View;
import android.widget.ScrollView;

import com.android.setupwizardlib.view.BottomScrollView;
import com.android.setupwizardlib.view.NavigationBar;

/**
 * Add this helper to require the scroll view to be scrolled to the bottom, making sure that the
 * user sees all content on the screen. This will change the navigation bar to show the more button
 * instead of the next button when there is more content to be seen. When the more button is
 * clicked, the scroll view will be scrolled one page down.
 */
public class RequireScrollHelper implements BottomScrollView.BottomScrollListener,
        View.OnClickListener {

    /**
     * Require scrolling on the scrollView, so that if the scrollView has content hidden beneath the
     * fold, the next button will be hidden and the more button will be shown instead. The more
     * button will scroll the scrollView downwards when clicked until the bottom is reached.
     *
     * @param navigationBar The navigation bar in which the next button's label will be changed.
     * @param scrollView The {@link BottomScrollView} to be scrolled.
     */
    public static RequireScrollHelper requireScroll(NavigationBar navigationBar,
            BottomScrollView scrollView) {
        final RequireScrollHelper helper = new RequireScrollHelper(navigationBar, scrollView);
        helper.requireScroll();
        return helper;
    }

    private final BottomScrollView mScrollView;
    private final NavigationBar mNavigationBar;

    private boolean mScrollNeeded;

    private RequireScrollHelper(NavigationBar navigationBar, BottomScrollView scrollView) {
        mNavigationBar = navigationBar;
        mScrollView = scrollView;
    }

    private void requireScroll() {
        mNavigationBar.getMoreButton().setOnClickListener(this);
        mScrollView.setBottomScrollListener(this);
    }

    @Override
    public void onScrolledToBottom() {
        if (mScrollNeeded) {
            mNavigationBar.getNextButton().setVisibility(View.VISIBLE);
            mNavigationBar.getMoreButton().setVisibility(View.GONE);
            mScrollNeeded = false;
        }
    }

    @Override
    public void onRequiresScroll() {
        if (!mScrollNeeded) {
            mNavigationBar.getNextButton().setVisibility(View.GONE);
            mNavigationBar.getMoreButton().setVisibility(View.VISIBLE);
            mScrollNeeded = true;
        }
    }

    @Override
    public void onClick(View view) {
        mScrollView.pageScroll(ScrollView.FOCUS_DOWN);
    }
}