org.dmfs.android.microfragments.transitions.ResetTransition.java Source code

Introduction

Here is the source code for org.dmfs.android.microfragments.transitions.ResetTransition.java

Source

/*
 * Copyright 2016 dmfs GmbH
 *
 *
 * 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 org.dmfs.android.microfragments.transitions;

import android.content.Context;
import android.os.Bundle;
import android.os.Parcel;
import android.os.Parcelable;
import android.support.annotation.MainThread;
import android.support.annotation.NonNull;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentTransaction;

import org.dmfs.android.microfragments.BasicMicroFragmentEnvironment;
import org.dmfs.android.microfragments.MicroFragment;
import org.dmfs.android.microfragments.MicroFragmentHost;
import org.dmfs.android.microfragments.R;
import org.dmfs.android.microfragments.Timestamp;
import org.dmfs.android.microfragments.timestamps.UiTimestamp;

import static org.dmfs.android.microfragments.MicroFragment.ARG_ENVIRONMENT;

/**
 * A {@link FragmentTransition} that clears the back stack and starts over with a new {@link MicroFragment} using a "back" animation.
 *
 * @author Marten Gajda
 */
public final class ResetTransition<T> implements FragmentTransition, Parcelable {
    private final MicroFragment<T> mNextStep;
    private final Timestamp mTimestamp;

    /**
     * Creates a {@link FragmentTransition} that resets the back stack and starts over with the given {@link MicroFragment}.
     *
     * @param nextStep
     *         The initial {@link MicroFragment}.
     */
    @MainThread
    public ResetTransition(@NonNull MicroFragment<T> nextStep) {
        this(nextStep, new UiTimestamp());
    }

    /**
     * Creates a {@link FragmentTransition} that resets the back stack and starts over with the given {@link MicroFragment}.
     *
     * @param nextStep
     *         The initial {@link MicroFragment}.
     */
    public ResetTransition(@NonNull MicroFragment<T> nextStep, @NonNull Timestamp timestamp) {
        mNextStep = nextStep;
        mTimestamp = timestamp;
    }

    @NonNull
    @Override
    public Timestamp timestamp() {
        return mTimestamp;
    }

    @Override
    public void prepare(@NonNull Context context, @NonNull FragmentManager fragmentManager,
            @NonNull MicroFragmentHost host, @NonNull MicroFragment<?> previousStep) {
        fragmentManager.popBackStack(null, FragmentManager.POP_BACK_STACK_INCLUSIVE);
    }

    @NonNull
    @Override
    public FragmentTransaction updateTransaction(@NonNull Context context,
            @NonNull FragmentTransaction fragmentTransaction, @NonNull FragmentManager fragmentManager,
            @NonNull MicroFragmentHost host, @NonNull MicroFragment<?> previousStep) {
        Fragment fragment = mNextStep.fragment(context, host);
        Bundle args = new Bundle(1);
        args.putParcelable(ARG_ENVIRONMENT, new BasicMicroFragmentEnvironment<>(mNextStep, host));
        fragment.setArguments(args);

        fragmentTransaction.replace(R.id.microfragments_host, fragment);
        return fragmentTransaction;
    }

    @Override
    public void cleanup(@NonNull Context context, @NonNull FragmentManager fragmentManager,
            @NonNull MicroFragmentHost host, @NonNull MicroFragment<?> previousStep) {
        // nothing to be done
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeParcelable(mNextStep, flags);
        dest.writeParcelable(mTimestamp, flags);
    }

    public final static Parcelable.Creator<ResetTransition> CREATOR = new Parcelable.Creator<ResetTransition>() {
        @Override
        public ResetTransition createFromParcel(Parcel source) {
            ClassLoader loader = getClass().getClassLoader();
            MicroFragment<?> microFragment = source.readParcelable(loader);
            Timestamp timestamp = source.readParcelable(loader);
            return new ResetTransition<>(microFragment, timestamp);
        }

        @Override
        public ResetTransition[] newArray(int size) {
            return new ResetTransition[size];
        }
    };
}