xref: /external/robolectric/src/main/java/com/xtremelabs/robolectric/shadows/ShadowToast.java

package com.xtremelabs.robolectric.shadows;

import android.content.Context;
import android.view.View;
import android.widget.TextView;
import android.widget.Toast;
import com.xtremelabs.robolectric.Robolectric;
import com.xtremelabs.robolectric.internal.Implementation;
import com.xtremelabs.robolectric.internal.Implements;
import com.xtremelabs.robolectric.internal.RealObject;

import java.util.List;

import static com.xtremelabs.robolectric.Robolectric.shadowOf;

/**
 * Shadow of {@code Toast} that tracks {@code Toast} requests. Hear hear! (*clink*)
 */
@SuppressWarnings({"UnusedDeclaration"})
@Implements(Toast.class)
public class ShadowToast {
    private String text;
    private int duration;
    private int gravity;
    private View view;

    @RealObject Toast toast;

    @Implementation
    public static Toast makeText(Context context, int resId, int duration) {
        return makeText(context, context.getResources().getString(resId), duration);
    }

    @Implementation(i18nSafe=false)
    public static Toast makeText(Context context, CharSequence text, int duration) {
        Toast toast = new Toast(null);
        toast.setDuration(duration);
        shadowOf(toast).text = text.toString();
        return toast;
    }

    @Implementation
    public void show() {
        Robolectric.getShadowApplication().getShownToasts().add(toast);
    }

    @Implementation
    public void setView(View view) {
        this.view = view;
    }

    @Implementation
    public View getView() {
        return view;
    }

    @Implementation
    public void setGravity(int gravity, int xOffset, int yOffset) {
        this.gravity = gravity;
    }

    @Implementation
    public int getGravity() {
        return gravity;
    }

    @Implementation
    public void setDuration(int duration) {
        this.duration = duration;
    }

    @Implementation
    public int getDuration() {
        return duration;
    }

    /**
     * Non-Android accessor that discards the recorded {@code Toast}s
     */
    public static void reset() {
        Robolectric.getShadowApplication().getShownToasts().clear();
    }

    /**
     * Non-Android accessor that returns the number of {@code Toast} requests that have been made during this test run
     * or since {@link #reset()} has been called.
     *
     * @return the number of {@code Toast} requests that have been made during this test run
     *         or since {@link #reset()} has been called.
     */
    public static int shownToastCount() {
        return Robolectric.getShadowApplication().getShownToasts().size();
    }

    /**
     * Non-Android query method that returns whether or not a particular custom {@code Toast} has been shown.
     *
     * @param message the message to search for
     * @param layoutResourceIdToCheckForMessage
     *                the id of the resource that contains the toast messages
     * @return whether the {@code Toast} was requested
     */
    public static boolean showedCustomToast(CharSequence message, int layoutResourceIdToCheckForMessage) {
        for (Toast toast : Robolectric.getShadowApplication().getShownToasts()) {
            String text = ((TextView) toast.getView().findViewById(layoutResourceIdToCheckForMessage)).getText().toString();
            if (text.equals(message.toString())) {
                return true;
            }
        }
        return false;
    }

    /**
     * query method that returns whether or not a particular {@code Toast} has been shown.
     *
     * @param message the message to search for
     * @return whether the {@code Toast} was requested
     */
    public static boolean showedToast(CharSequence message) {
        for (Toast toast : Robolectric.getShadowApplication().getShownToasts()) {
            String text = shadowOf(toast).text;
            if (text != null && text.equals(message.toString())) {
                return true;
            }
        }
        return false;
    }

    /**
     * Non-Android accessor that returns the text of the most recently shown {@code Toast}
     *
     * @return the text of the most recently shown {@code Toast}
     */
    public static String getTextOfLatestToast() {
        List<Toast> shownToasts = Robolectric.getShadowApplication().getShownToasts();
        return (shownToasts.size() == 0) ? null : shadowOf(shownToasts.get(shownToasts.size() - 1)).text;
    }

    /**
     * Non-Android accessor that returns the most recently shown {@code Toast}
     *
     * @return the most recently shown {@code Toast}
     */
    public static Toast getLatestToast() {
        List<Toast> shownToasts = Robolectric.getShadowApplication().getShownToasts();
        return (shownToasts.size() == 0) ? null : shownToasts.get(shownToasts.size() - 1);
    }
}