open-keychain/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/util/Notify.java

/*
 * Copyright (C) 2017 Schürmann & Breitmoser GbR
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.sufficientlysecure.keychain.ui.util;

import android.app.Activity;
import androidx.annotation.CheckResult;
import androidx.fragment.app.Fragment;
import android.view.View;
import android.view.ViewGroup;

import com.nispok.snackbar.Snackbar;
import com.nispok.snackbar.Snackbar.SnackbarDuration;
import com.nispok.snackbar.SnackbarManager;
import com.nispok.snackbar.enums.SnackbarType;
import com.nispok.snackbar.listeners.ActionClickListener;
import com.nispok.snackbar.listeners.EventListenerAdapter;

import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.util.FabContainer;

/**
 * Notify wrapper which allows a more easy use of different notification libraries
 */
public class Notify {

    public enum Style {
        OK (R.color.android_green_light), WARN(R.color.android_orange_light), ERROR(R.color.android_red_light);

        public final int mLineColor;

        Style(int color) {
            mLineColor = color;
        }

        public void applyToBar(Snackbar bar) {
            bar.lineColorResource(mLineColor);
        }
    }

    public static final int LENGTH_INDEFINITE = 0;
    public static final int LENGTH_LONG = 3500;
    public static final int LENGTH_SHORT = 1500;

    @CheckResult
    public static Showable create(final Activity activity, String text, int duration, Style style,
                                  final ActionListener actionListener, Integer actionResId) {
        final Snackbar snackbar = Snackbar.with(activity)
                .type(SnackbarType.MULTI_LINE)
                .text(text);

        if (duration == LENGTH_INDEFINITE) {
            snackbar.duration(SnackbarDuration.LENGTH_INDEFINITE);
        } else {
            snackbar.duration(duration);
        }

        style.applyToBar(snackbar);

        if (actionResId != null) {
            snackbar.actionLabel(actionResId);
        }
        if (actionListener != null) {
            snackbar.actionListener(new ActionClickListener() {
                @Override
                public void onActionClicked(Snackbar snackbar) {
                    actionListener.onAction();
                }
            });
        }

        if (activity instanceof FabContainer) {
            snackbar.eventListener(new EventListenerAdapter() {
                @Override
                public void onShow(Snackbar snackbar) {
                    ((FabContainer) activity).fabMoveUp(snackbar.getHeight());
                }

                @Override
                public void onDismiss(Snackbar snackbar) {
                    ((FabContainer) activity).fabRestorePosition();
                }
            });
        }

        return new Showable() {
            @Override
            public void show() {
                SnackbarManager.show(snackbar, activity);
            }

            @Override
            public void show(Fragment fragment, boolean animate) {
                snackbar.animation(animate);
                snackbar.dismissOnActionClicked(animate);
                show(fragment);
            }

            @Override
            public void show(Fragment fragment) {
                if (fragment != null) {
                    View view = fragment.getView();

                    if (view != null && view instanceof ViewGroup) {
                        SnackbarManager.show(snackbar, (ViewGroup) view);
                        return;
                    }
                }

                show();
            }

            @Override
            public void show(ViewGroup viewGroup) {
                if (viewGroup != null) {
                    SnackbarManager.show(snackbar, viewGroup);
                    return;
                }

                show();
            }
        };
    }

    @CheckResult
    public static Showable create(Activity activity, String text, int duration, Style style) {
        return create(activity, text, duration, style, null, null);
    }

    @CheckResult
    public static Showable create(Activity activity, String text, Style style) {
        return create(activity, text, LENGTH_LONG, style);
    }

    @CheckResult
    public static Showable create(Activity activity, int textResId, Style style,
            ActionListener actionListener, int actionResId) {
        return create(activity, textResId, LENGTH_LONG, style, actionListener, actionResId);
    }

    @CheckResult
    public static Showable create(Activity activity, int textResId, int duration, Style style,
                                  ActionListener actionListener, int actionResId) {
        return create(activity, activity.getString(textResId), duration, style, actionListener, actionResId);
    }

    @CheckResult
    public static Showable create(Activity activity, int textResId, int duration, Style style) {
        return create(activity, activity.getString(textResId), duration, style);
    }

    @CheckResult
    public static Showable create(Activity activity, int textResId, Style style) {
        return create(activity, activity.getString(textResId), style);
    }

    public interface Showable {

        /**
         * Shows the notification on the bottom of the Activity.
         */
        void show();

        void show(Fragment fragment, boolean animate);

        /**
         * Shows the notification on the bottom of the Fragment.
         */
        void show(Fragment fragment);

        /**
         * Shows the notification on the given ViewGroup.
         * The viewGroup should be either a RelativeLayout or FrameLayout.
         */
        void show(ViewGroup viewGroup);

    }

    public interface ActionListener {

        void onAction();

    }

}