components/browser_ui/widget/android/java/src/org/chromium/components/browser_ui/widget/PromoDialog.java

// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.components.browser_ui.widget;

import android.app.Activity;
import android.content.DialogInterface;
import android.graphics.Color;
import android.graphics.drawable.ColorDrawable;
import android.graphics.drawable.Drawable;
import android.graphics.drawable.LayerDrawable;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup.LayoutParams;
import android.widget.FrameLayout;

import org.chromium.base.ApiCompatibilityUtils;

/**
 * Generic builder for promo dialogs.
 */
public abstract class PromoDialog extends AlwaysDismissedDialog
        implements View.OnClickListener, DialogInterface.OnDismissListener {
    /** Parameters that can be used to create a new PromoDialog. */
    public static class DialogParams {
        /**
         * Optional: Resource ID of the Drawable to use for the promo illustration.
         * This parameter is mutually exclusive with {@link #vectorDrawableResource} and
         * {@link #drawableInstance}.
         */
        public int drawableResource;

        /**
         * Optional: Resource ID of the VectorDrawable to use for the promo illustration.
         * This parameter is mutually exclusive with {@link #drawableResource} and
         * {@link #drawableInstance}.
         */
        public int vectorDrawableResource;

        /**
         * Optional: Drawable instance to use for the promo illustration.
         * This parameter is mutually exclusive with {@link #drawableResource} and
         * {@link #vectorDrawableResource}.
         */
        public Drawable drawableInstance;

        /** Resource ID of the String to show as the promo title. */
        public int headerStringResource;

        /**
         * Optional: CharSequence to show as promo title.
         * This parameter takes precedence over {@link #headerStringResoruce}
         */
        public CharSequence headerCharSequence;

        /**
         * Optional: CharSequence to show as descriptive text.
         * This parameter takes precedence over {@link #subheaderStringResoruce}
         */
        public CharSequence subheaderCharSequence;

        /** Optional: Boolean flag set to true if descriptive text has a link. */
        public boolean subheaderIsLink;

        /** Optional: Resource ID of the String to show as descriptive text. */
        public int subheaderStringResource;

        /** Optional: Resource ID of the String to show as footer text. */
        public int footerStringResource;

        /** Optional: Resource ID of the String to show on the primary/ok button. */
        public int primaryButtonStringResource;

        /**
         * Optional: CharSequence to show on the primary/ok button.
         * This parameter takes precedence over {@link #primaryButtonStringResource}
         */
        public CharSequence primaryButtonCharSequence;

        /** Optional: Resource ID of the String to show on the secondary/cancel button. */
        public int secondaryButtonStringResource;
    }

    private static final int[] CLICKABLE_BUTTON_IDS = {R.id.button_primary, R.id.button_secondary};

    private final FrameLayout mScrimView;
    private PromoDialogLayout mDialogLayout;

    protected PromoDialog(Activity activity) {
        super(activity, R.style.PromoDialog);

        mScrimView = new FrameLayout(activity);
        mScrimView.setBackgroundColor(ApiCompatibilityUtils.getColor(
                activity.getResources(), R.color.modal_dialog_scrim_color));
        LayoutInflater.from(activity).inflate(R.layout.promo_dialog_layout, mScrimView, true);

        mDialogLayout = (PromoDialogLayout) mScrimView.findViewById(R.id.promo_dialog_layout);
    }

    /**
     * Force the promo dialog to have a fully opaque background hiding any underlying content.
     */
    protected void forceOpaqueBackground() {
        LayerDrawable background = new LayerDrawable(new Drawable[] {new ColorDrawable(Color.WHITE),
                new ColorDrawable(ApiCompatibilityUtils.getColor(
                        getContext().getResources(), R.color.modal_dialog_scrim_color))});
        mScrimView.setBackground(background);
    }

    /**
     * Adds a View to the layout within the scrollable area.
     * See {@link PromoDialogLayout#addControl}.
     */
    protected void addControl(View control) {
        mDialogLayout.addControl(control);
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(mScrimView);

        mDialogLayout.initialize(getDialogParams());

        // Force the window to allow the dialog contents be as wide as necessary.
        getWindow().setLayout(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT);

        // Connect all the buttons to this class.
        for (int interactiveViewId : CLICKABLE_BUTTON_IDS) {
            View view = findViewById(interactiveViewId);
            if (view != null) view.setOnClickListener(this);
        }
    }

    @Override
    public void onClick(View view) {}

    /** Returns a set of {@link DialogParams} that define what is shown in the promo dialog. */
    protected abstract DialogParams getDialogParams();
}