aboutsummaryrefslogtreecommitdiff
path: root/ui/transition/CustomTransition/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'ui/transition/CustomTransition/README.md')
-rw-r--r--ui/transition/CustomTransition/README.md41
1 files changed, 36 insertions, 5 deletions
diff --git a/ui/transition/CustomTransition/README.md b/ui/transition/CustomTransition/README.md
index 76ac022e..591d9000 100644
--- a/ui/transition/CustomTransition/README.md
+++ b/ui/transition/CustomTransition/README.md
@@ -1,15 +1,46 @@
+
Android CustomTransition Sample
-==============================
+===================================
+
+This sample shows how to implement a custom Transition extending the
+standard Transition class.
+
+Introduction
+------------
+
+In order to create a custom Transition, you first need to override
+[captureStartValues][1] and [captureEndValues][2]. In those method, you have to
+extract all the relevant properties from a View. These methods are called for
+each of the Views in the hierarchy.
+
+Then, you need to override [createAnimator][3] and create an Animator based on
+the property values you extracted. This method will also be called for each of
+the Views in the hierarchy. If you want to skip some Views, simply return null.
-This sample demonstrates how to create and use a custom Transition.
+The instantiated custom Transition can be applied by passing it as the second
+parameter of [TransitionManager.go][4].
+
+```java
+TransitionManager.go(mScenes[mCurrentScene], mTransition);
+```
+
+[1]: https://developer.android.com/reference/android/transition/Transition.html#captureStartValues(android.transition.TransitionValues)
+[2]: https://developer.android.com/reference/android/transition/Transition.html#captureEndValues(android.transition.TransitionValues)
+[3]: https://developer.android.com/reference/android/transition/Transition.html#createAnimator(android.view.ViewGroup, android.transition.TransitionValues, android.transition.TransitionValues)
+[4]: https://developer.android.com/reference/android/transition/TransitionManager.html#go(android.transition.Scene, android.transition.Transition)
Pre-requisites
--------------
-- Android SDK v20
-- Android Build Tools v20
+- Android SDK v23
+- Android Build Tools v22.0.1
- Android Support Repository
+Screenshots
+-------------
+
+<img src="screenshots/main.png" height="400" alt="Screenshot"/>
+
Getting Started
---------------
@@ -40,7 +71,7 @@ file to you 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
+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