core/java/android/transition/TransitionSet.java - platform/frameworks/base - Git at Google

 /*
  * Copyright (C) 2013 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 android.transition;

 import android.animation.TimeInterpolator;
 import android.util.AndroidRuntimeException;
 import android.view.View;
 import android.view.ViewGroup;

 import java.util.ArrayList;

 /**
  * A TransitionSet is a parent of child transitions (including other
  * TransitionSets). Using TransitionSets enables more complex
  * choreography of transitions, where some sets play {@link #ORDERING_TOGETHER} and
  * others play {@link #ORDERING_SEQUENTIAL}. For example, {@link AutoTransition}
  * uses a TransitionSet to sequentially play a Fade(Fade.OUT), followed by
  * a {@link ChangeBounds}, followed by a Fade(Fade.OUT) transition.
  */
 public class TransitionSet extends Transition {

     ArrayList<Transition> mTransitions = new ArrayList<Transition>();
     private boolean mPlayTogether = true;
     int mCurrentListeners;
     boolean mStarted = false;

     /**
      * A flag used to indicate that the child transitions of this set
      * should all start at the same time.
      */
     public static final int ORDERING_TOGETHER = 0;
     /**
      * A flag used to indicate that the child transitions of this set should
      * play in sequence; when one child transition ends, the next child
      * transition begins. Note that a transition does not end until all
      * instances of it (which are playing on all applicable targets of the
      * transition) end.
      */
     public static final int ORDERING_SEQUENTIAL = 1;

     /**
      * Constructs an empty transition set. Add child transitions to the
      * set by calling {@link #addTransition(Transition)} )}. By default,
      * child transitions will play {@link #ORDERING_TOGETHER together}.
      */
     public TransitionSet() {
     }

     /**
      * Sets the play order of this set's child transitions.
      *
      * @param ordering {@link #ORDERING_TOGETHER} to play this set's child
      * transitions together, {@link #ORDERING_SEQUENTIAL} to play the child
      * transitions in sequence.
      * @return This transitionSet object.
      */
     public TransitionSet setOrdering(int ordering) {
         switch (ordering) {
             case ORDERING_SEQUENTIAL:
                 mPlayTogether = false;
                 break;
             case ORDERING_TOGETHER:
                 mPlayTogether = true;
                 break;
             default:
                 throw new AndroidRuntimeException("Invalid parameter for TransitionSet " +
                         "ordering: " + ordering);
         }
         return this;
     }

     /**
      * Returns the ordering of this TransitionSet. By default, the value is
      * {@link #ORDERING_TOGETHER}.
      *
      * @return {@link #ORDERING_TOGETHER} if child transitions will play at the same
      * time, {@link #ORDERING_SEQUENTIAL} if they will play in sequence.
      *
      * @see #setOrdering(int)
      */
     public int getOrdering() {
         return mPlayTogether ? ORDERING_TOGETHER : ORDERING_SEQUENTIAL;
     }

     /**
      * Adds child transition to this set. The order in which this child transition
      * is added relative to other child transitions that are added, in addition to
      * the {@link #getOrdering() ordering} property, determines the
      * order in which the transitions are started.
      *
      * <p>If this transitionSet has a {@link #getDuration() duration} set on it, the
      * child transition will inherit that duration. Transitions are assumed to have
      * a maximum of one transitionSet parent.</p>
      *
      * @param transition A non-null child transition to be added to this set.
      * @return This transitionSet object.
      */
     public TransitionSet addTransition(Transition transition) {
         if (transition != null) {
             mTransitions.add(transition);
             transition.mParent = this;
             if (mDuration >= 0) {
                 transition.setDuration(mDuration);
             }
         }
         return this;
     }

     /**
      * Setting a non-negative duration on a TransitionSet causes all of the child
      * transitions (current and future) to inherit this duration.
      *
      * @param duration The length of the animation, in milliseconds.
      * @return This transitionSet object.
      */
     @Override
     public TransitionSet setDuration(long duration) {
         super.setDuration(duration);
         if (mDuration >= 0) {
             int numTransitions = mTransitions.size();
             for (int i = 0; i < numTransitions; ++i) {
                 mTransitions.get(i).setDuration(duration);
             }
         }
         return this;
     }

     @Override
     public TransitionSet setStartDelay(long startDelay) {
         return (TransitionSet) super.setStartDelay(startDelay);
     }

     @Override
     public TransitionSet setInterpolator(TimeInterpolator interpolator) {
         return (TransitionSet) super.setInterpolator(interpolator);
     }

     @Override
     public TransitionSet addTarget(View target) {
         return (TransitionSet) super.addTarget(target);
     }

     @Override
     public TransitionSet addTarget(int targetId) {
         return (TransitionSet) super.addTarget(targetId);
     }

     @Override
     public TransitionSet addListener(TransitionListener listener) {
         return (TransitionSet) super.addListener(listener);
     }

     @Override
     public TransitionSet removeTarget(int targetId) {
         return (TransitionSet) super.removeTarget(targetId);
     }

     @Override
     public TransitionSet removeTarget(View target) {
         return (TransitionSet) super.removeTarget(target);
     }

     @Override
     public TransitionSet removeListener(TransitionListener listener) {
         return (TransitionSet) super.removeListener(listener);
     }

     /**
      * Removes the specified child transition from this set.
      *
      * @param transition The transition to be removed.
      * @return This transitionSet object.
      */
     public TransitionSet removeTransition(Transition transition) {
         mTransitions.remove(transition);
         transition.mParent = null;
         return this;
     }

     /**
      * Sets up listeners for each of the child transitions. This is used to
      * determine when this transition set is finished (all child transitions
      * must finish first).
      */
     private void setupStartEndListeners() {
         TransitionSetListener listener = new TransitionSetListener(this);
         for (Transition childTransition : mTransitions) {
             childTransition.addListener(listener);
         }
         mCurrentListeners = mTransitions.size();
     }

     /**
      * This listener is used to detect when all child transitions are done, at
      * which point this transition set is also done.
      */
     static class TransitionSetListener extends TransitionListenerAdapter {
         TransitionSet mTransitionSet;
         TransitionSetListener(TransitionSet transitionSet) {
             mTransitionSet = transitionSet;
         }
         @Override
         public void onTransitionStart(Transition transition) {
             if (!mTransitionSet.mStarted) {
                 mTransitionSet.start();
                 mTransitionSet.mStarted = true;
             }
         }

         @Override
         public void onTransitionEnd(Transition transition) {
             --mTransitionSet.mCurrentListeners;
             if (mTransitionSet.mCurrentListeners == 0) {
                 // All child trans
                 mTransitionSet.mStarted = false;
                 mTransitionSet.end();
             }
             transition.removeListener(this);
         }
     }

     /**
      * @hide
      */
     @Override
     protected void createAnimators(ViewGroup sceneRoot, TransitionValuesMaps startValues,
             TransitionValuesMaps endValues) {
         for (Transition childTransition : mTransitions) {
             childTransition.createAnimators(sceneRoot, startValues, endValues);
         }
     }

     /**
      * @hide
      */
     @Override
     protected void runAnimators() {
         setupStartEndListeners();
         if (!mPlayTogether) {
             // Setup sequence with listeners
             // TODO: Need to add listeners in such a way that we can remove them later if canceled
             for (int i = 1; i < mTransitions.size(); ++i) {
                 Transition previousTransition = mTransitions.get(i - 1);
                 final Transition nextTransition = mTransitions.get(i);
                 previousTransition.addListener(new TransitionListenerAdapter() {
                     @Override
                     public void onTransitionEnd(Transition transition) {
                         nextTransition.runAnimators();
                         transition.removeListener(this);
                     }
                 });
             }
             Transition firstTransition = mTransitions.get(0);
             if (firstTransition != null) {
                 firstTransition.runAnimators();
             }
         } else {
             for (Transition childTransition : mTransitions) {
                 childTransition.runAnimators();
             }
         }
     }

     @Override
     public void captureStartValues(TransitionValues transitionValues) {
         int targetId = transitionValues.view.getId();
         if (isValidTarget(transitionValues.view, targetId)) {
             for (Transition childTransition : mTransitions) {
                 if (childTransition.isValidTarget(transitionValues.view, targetId)) {
                     childTransition.captureStartValues(transitionValues);
                 }
             }
         }
     }

     @Override
     public void captureEndValues(TransitionValues transitionValues) {
         int targetId = transitionValues.view.getId();
         if (isValidTarget(transitionValues.view, targetId)) {
             for (Transition childTransition : mTransitions) {
                 if (childTransition.isValidTarget(transitionValues.view, targetId)) {
                     childTransition.captureEndValues(transitionValues);
                 }
             }
         }
     }

     /** @hide */
     @Override
     public void pause() {
         super.pause();
         int numTransitions = mTransitions.size();
         for (int i = 0; i < numTransitions; ++i) {
             mTransitions.get(i).pause();
         }
     }

     /** @hide */
     @Override
     public void resume() {
         super.resume();
         int numTransitions = mTransitions.size();
         for (int i = 0; i < numTransitions; ++i) {
             mTransitions.get(i).resume();
         }
     }

     /** @hide */
     @Override
     protected void cancel() {
         super.cancel();
         int numTransitions = mTransitions.size();
         for (int i = 0; i < numTransitions; ++i) {
             mTransitions.get(i).cancel();
         }
     }

     @Override
     TransitionSet setSceneRoot(ViewGroup sceneRoot) {
         super.setSceneRoot(sceneRoot);
         int numTransitions = mTransitions.size();
         for (int i = 0; i < numTransitions; ++i) {
             mTransitions.get(i).setSceneRoot(sceneRoot);
         }
         return (TransitionSet) this;
     }

     @Override
     String toString(String indent) {
         String result = super.toString(indent);
         for (int i = 0; i < mTransitions.size(); ++i) {
             result += "\n" + mTransitions.get(i).toString(indent + "  ");
         }
         return result;
     }

     @Override
     public TransitionSet clone() {
         TransitionSet clone = (TransitionSet) super.clone();
         clone.mTransitions = new ArrayList<Transition>();
         int numTransitions = mTransitions.size();
         for (int i = 0; i < numTransitions; ++i) {
             clone.addTransition((Transition) mTransitions.get(i).clone());
         }
         return clone;
     }

 }
	/*
	* Copyright (C) 2013 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 android.transition;

	import android.animation.TimeInterpolator;
	import android.util.AndroidRuntimeException;
	import android.view.View;
	import android.view.ViewGroup;

	import java.util.ArrayList;

	/**
	* A TransitionSet is a parent of child transitions (including other
	* TransitionSets). Using TransitionSets enables more complex
	* choreography of transitions, where some sets play {@link #ORDERING_TOGETHER} and
	* others play {@link #ORDERING_SEQUENTIAL}. For example, {@link AutoTransition}
	* uses a TransitionSet to sequentially play a Fade(Fade.OUT), followed by
	* a {@link ChangeBounds}, followed by a Fade(Fade.OUT) transition.
	*/
	public class TransitionSet extends Transition {

	ArrayList<Transition> mTransitions = new ArrayList<Transition>();
	private boolean mPlayTogether = true;
	int mCurrentListeners;
	boolean mStarted = false;

	/**
	* A flag used to indicate that the child transitions of this set
	* should all start at the same time.
	*/
	public static final int ORDERING_TOGETHER = 0;
	/**
	* A flag used to indicate that the child transitions of this set should
	* play in sequence; when one child transition ends, the next child
	* transition begins. Note that a transition does not end until all
	* instances of it (which are playing on all applicable targets of the
	* transition) end.
	*/
	public static final int ORDERING_SEQUENTIAL = 1;

	/**
	* Constructs an empty transition set. Add child transitions to the
	* set by calling {@link #addTransition(Transition)} )}. By default,
	* child transitions will play {@link #ORDERING_TOGETHER together}.
	*/
	public TransitionSet() {
	}

	/**
	* Sets the play order of this set's child transitions.
	*
	* @param ordering {@link #ORDERING_TOGETHER} to play this set's child
	* transitions together, {@link #ORDERING_SEQUENTIAL} to play the child
	* transitions in sequence.
	* @return This transitionSet object.
	*/
	public TransitionSet setOrdering(int ordering) {
	switch (ordering) {
	case ORDERING_SEQUENTIAL:
	mPlayTogether = false;
	break;
	case ORDERING_TOGETHER:
	mPlayTogether = true;
	break;
	default:
	throw new AndroidRuntimeException("Invalid parameter for TransitionSet " +
	"ordering: " + ordering);
	}
	return this;
	}

	/**
	* Returns the ordering of this TransitionSet. By default, the value is
	* {@link #ORDERING_TOGETHER}.
	*
	* @return {@link #ORDERING_TOGETHER} if child transitions will play at the same
	* time, {@link #ORDERING_SEQUENTIAL} if they will play in sequence.
	*
	* @see #setOrdering(int)
	*/
	public int getOrdering() {
	return mPlayTogether ? ORDERING_TOGETHER : ORDERING_SEQUENTIAL;
	}

	/**
	* Adds child transition to this set. The order in which this child transition
	* is added relative to other child transitions that are added, in addition to
	* the {@link #getOrdering() ordering} property, determines the
	* order in which the transitions are started.
	*
	* <p>If this transitionSet has a {@link #getDuration() duration} set on it, the
	* child transition will inherit that duration. Transitions are assumed to have
	* a maximum of one transitionSet parent.</p>
	*
	* @param transition A non-null child transition to be added to this set.
	* @return This transitionSet object.
	*/
	public TransitionSet addTransition(Transition transition) {
	if (transition != null) {
	mTransitions.add(transition);
	transition.mParent = this;
	if (mDuration >= 0) {
	transition.setDuration(mDuration);
	}
	}
	return this;
	}

	/**
	* Setting a non-negative duration on a TransitionSet causes all of the child
	* transitions (current and future) to inherit this duration.
	*
	* @param duration The length of the animation, in milliseconds.
	* @return This transitionSet object.
	*/
	@Override
	public TransitionSet setDuration(long duration) {
	super.setDuration(duration);
	if (mDuration >= 0) {
	int numTransitions = mTransitions.size();
	for (int i = 0; i < numTransitions; ++i) {
	mTransitions.get(i).setDuration(duration);
	}
	}
	return this;
	}

	@Override
	public TransitionSet setStartDelay(long startDelay) {
	return (TransitionSet) super.setStartDelay(startDelay);
	}

	@Override
	public TransitionSet setInterpolator(TimeInterpolator interpolator) {
	return (TransitionSet) super.setInterpolator(interpolator);
	}

	@Override
	public TransitionSet addTarget(View target) {
	return (TransitionSet) super.addTarget(target);
	}

	@Override
	public TransitionSet addTarget(int targetId) {
	return (TransitionSet) super.addTarget(targetId);
	}

	@Override
	public TransitionSet addListener(TransitionListener listener) {
	return (TransitionSet) super.addListener(listener);
	}

	@Override
	public TransitionSet removeTarget(int targetId) {
	return (TransitionSet) super.removeTarget(targetId);
	}

	@Override
	public TransitionSet removeTarget(View target) {
	return (TransitionSet) super.removeTarget(target);
	}

	@Override
	public TransitionSet removeListener(TransitionListener listener) {
	return (TransitionSet) super.removeListener(listener);
	}

	/**
	* Removes the specified child transition from this set.
	*
	* @param transition The transition to be removed.
	* @return This transitionSet object.
	*/
	public TransitionSet removeTransition(Transition transition) {
	mTransitions.remove(transition);
	transition.mParent = null;
	return this;
	}

	/**
	* Sets up listeners for each of the child transitions. This is used to
	* determine when this transition set is finished (all child transitions
	* must finish first).
	*/
	private void setupStartEndListeners() {
	TransitionSetListener listener = new TransitionSetListener(this);
	for (Transition childTransition : mTransitions) {
	childTransition.addListener(listener);
	}
	mCurrentListeners = mTransitions.size();
	}

	/**
	* This listener is used to detect when all child transitions are done, at
	* which point this transition set is also done.
	*/
	static class TransitionSetListener extends TransitionListenerAdapter {
	TransitionSet mTransitionSet;
	TransitionSetListener(TransitionSet transitionSet) {
	mTransitionSet = transitionSet;
	}
	@Override
	public void onTransitionStart(Transition transition) {
	if (!mTransitionSet.mStarted) {
	mTransitionSet.start();
	mTransitionSet.mStarted = true;
	}
	}

	@Override
	public void onTransitionEnd(Transition transition) {
	--mTransitionSet.mCurrentListeners;
	if (mTransitionSet.mCurrentListeners == 0) {
	// All child trans
	mTransitionSet.mStarted = false;
	mTransitionSet.end();
	}
	transition.removeListener(this);
	}
	}

	/**
	* @hide
	*/
	@Override
	protected void createAnimators(ViewGroup sceneRoot, TransitionValuesMaps startValues,
	TransitionValuesMaps endValues) {
	for (Transition childTransition : mTransitions) {
	childTransition.createAnimators(sceneRoot, startValues, endValues);
	}
	}

	/**
	* @hide
	*/
	@Override
	protected void runAnimators() {
	setupStartEndListeners();
	if (!mPlayTogether) {
	// Setup sequence with listeners
	// TODO: Need to add listeners in such a way that we can remove them later if canceled
	for (int i = 1; i < mTransitions.size(); ++i) {
	Transition previousTransition = mTransitions.get(i - 1);
	final Transition nextTransition = mTransitions.get(i);
	previousTransition.addListener(new TransitionListenerAdapter() {
	@Override
	public void onTransitionEnd(Transition transition) {
	nextTransition.runAnimators();
	transition.removeListener(this);
	}
	});
	}
	Transition firstTransition = mTransitions.get(0);
	if (firstTransition != null) {
	firstTransition.runAnimators();
	}
	} else {
	for (Transition childTransition : mTransitions) {
	childTransition.runAnimators();
	}
	}
	}

	@Override
	public void captureStartValues(TransitionValues transitionValues) {
	int targetId = transitionValues.view.getId();
	if (isValidTarget(transitionValues.view, targetId)) {
	for (Transition childTransition : mTransitions) {
	if (childTransition.isValidTarget(transitionValues.view, targetId)) {
	childTransition.captureStartValues(transitionValues);
	}
	}
	}
	}

	@Override
	public void captureEndValues(TransitionValues transitionValues) {
	int targetId = transitionValues.view.getId();
	if (isValidTarget(transitionValues.view, targetId)) {
	for (Transition childTransition : mTransitions) {
	if (childTransition.isValidTarget(transitionValues.view, targetId)) {
	childTransition.captureEndValues(transitionValues);
	}
	}
	}
	}

	/** @hide */
	@Override
	public void pause() {
	super.pause();
	int numTransitions = mTransitions.size();
	for (int i = 0; i < numTransitions; ++i) {
	mTransitions.get(i).pause();
	}
	}

	/** @hide */
	@Override
	public void resume() {
	super.resume();
	int numTransitions = mTransitions.size();
	for (int i = 0; i < numTransitions; ++i) {
	mTransitions.get(i).resume();
	}
	}

	/** @hide */
	@Override
	protected void cancel() {
	super.cancel();
	int numTransitions = mTransitions.size();
	for (int i = 0; i < numTransitions; ++i) {
	mTransitions.get(i).cancel();
	}
	}

	@Override
	TransitionSet setSceneRoot(ViewGroup sceneRoot) {
	super.setSceneRoot(sceneRoot);
	int numTransitions = mTransitions.size();
	for (int i = 0; i < numTransitions; ++i) {
	mTransitions.get(i).setSceneRoot(sceneRoot);
	}
	return (TransitionSet) this;
	}

	@Override
	String toString(String indent) {
	String result = super.toString(indent);
	for (int i = 0; i < mTransitions.size(); ++i) {
	result += "\n" + mTransitions.get(i).toString(indent + " ");
	}
	return result;
	}

	@Override
	public TransitionSet clone() {
	TransitionSet clone = (TransitionSet) super.clone();
	clone.mTransitions = new ArrayList<Transition>();
	int numTransitions = mTransitions.size();
	for (int i = 0; i < numTransitions; ++i) {
	clone.addTransition((Transition) mTransitions.get(i).clone());
	}
	return clone;
	}

	}