android.animation.StateListAnimator Maven / Gradle / Ivy
Show all versions of android-all Show documentation
/*
* Copyright (C) 2014 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.animation;
import android.util.StateSet;
import android.view.View;
import java.lang.ref.WeakReference;
import java.util.ArrayList;
/**
* Lets you define a number of Animators that will run on the attached View depending on the View's
* drawable state.
*
* It can be defined in an XML file with the <selector> element.
* Each State Animator is defined in a nested <item> element.
*
* @attr ref android.R.styleable#DrawableStates_state_focused
* @attr ref android.R.styleable#DrawableStates_state_window_focused
* @attr ref android.R.styleable#DrawableStates_state_enabled
* @attr ref android.R.styleable#DrawableStates_state_checkable
* @attr ref android.R.styleable#DrawableStates_state_checked
* @attr ref android.R.styleable#DrawableStates_state_selected
* @attr ref android.R.styleable#DrawableStates_state_activated
* @attr ref android.R.styleable#DrawableStates_state_active
* @attr ref android.R.styleable#DrawableStates_state_single
* @attr ref android.R.styleable#DrawableStates_state_first
* @attr ref android.R.styleable#DrawableStates_state_middle
* @attr ref android.R.styleable#DrawableStates_state_last
* @attr ref android.R.styleable#DrawableStates_state_pressed
* @attr ref android.R.styleable#StateListAnimatorItem_animation
*/
public class StateListAnimator {
private final ArrayList mTuples = new ArrayList();
private Tuple mLastMatch = null;
private Animator mRunningAnimator = null;
private WeakReference mViewRef;
private AnimatorListenerAdapter mAnimatorListener = new AnimatorListenerAdapter() {
@Override
public void onAnimationEnd(Animator animation) {
animation.setTarget(null);
if (mRunningAnimator == animation) {
mRunningAnimator = null;
}
}
};
/**
* Associates the given animator with the provided drawable state specs so that it will be run
* when the View's drawable state matches the specs.
*
* @param specs The drawable state specs to match against
* @param animator The animator to run when the specs match
*/
public void addState(int[] specs, Animator animator) {
Tuple tuple = new Tuple(specs, animator);
tuple.mAnimator.addListener(mAnimatorListener);
mTuples.add(tuple);
}
/**
* Returns the current {@link android.animation.Animator} which is started because of a state
* change.
*
* @return The currently running Animator or null if no Animator is running
* @hide
*/
public Animator getRunningAnimator() {
return mRunningAnimator;
}
/**
* @hide
*/
public View getTarget() {
return mViewRef == null ? null : mViewRef.get();
}
/**
* Called by View
* @hide
*/
public void setTarget(View view) {
final View current = getTarget();
if (current == view) {
return;
}
if (current != null) {
clearTarget();
}
if (view != null) {
mViewRef = new WeakReference(view);
}
}
private void clearTarget() {
final int size = mTuples.size();
for (int i = 0; i < size; i++) {
mTuples.get(i).mAnimator.setTarget(null);
}
mViewRef = null;
mLastMatch = null;
mRunningAnimator = null;
}
/**
* Called by View
* @hide
*/
public void setState(int[] state) {
Tuple match = null;
final int count = mTuples.size();
for (int i = 0; i < count; i++) {
final Tuple tuple = mTuples.get(i);
if (StateSet.stateSetMatches(tuple.mSpecs, state)) {
match = tuple;
break;
}
}
if (match == mLastMatch) {
return;
}
if (mLastMatch != null) {
cancel();
}
mLastMatch = match;
if (match != null) {
start(match);
}
}
private void start(Tuple match) {
match.mAnimator.setTarget(getTarget());
mRunningAnimator = match.mAnimator;
mRunningAnimator.start();
}
private void cancel() {
if (mRunningAnimator != null) {
mRunningAnimator.cancel();
mRunningAnimator = null;
}
}
/**
* @hide
*/
public ArrayList getTuples() {
return mTuples;
}
/**
* If there is an animation running for a recent state change, ends it.
*
* This causes the animation to assign the end value(s) to the View.
*/
public void jumpToCurrentState() {
if (mRunningAnimator != null) {
mRunningAnimator.end();
}
}
/**
* @hide
*/
public static class Tuple {
final int[] mSpecs;
final Animator mAnimator;
private Tuple(int[] specs, Animator animator) {
mSpecs = specs;
mAnimator = animator;
}
/**
* @hide
*/
public int[] getSpecs() {
return mSpecs;
}
/**
* @hide
*/
public Animator getAnimator() {
return mAnimator;
}
}
}