xref: /aosp_15_r20/developers/build/prebuilts/gradle/ElevationBasic/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid ElevationBasic Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates ways to move a view in the z-axis using
6*d353a188SXin Li`setTranslationZ()`. This method was introduced in API Level 21 ('Lollipop').
7*d353a188SXin Li
8*d353a188SXin LiIntroduction
9*d353a188SXin Li------------
10*d353a188SXin Li
11*d353a188SXin LiThis sample uses two shapes, a circle and a square, and it demonstrates two
12*d353a188SXin Lialternative ways to move a view in the z-axis. The first shape, the circle,
13*d353a188SXin Lihas a fixed elevation, which is defined in XML. The second view, the square,
14*d353a188SXin Lichanges its elevation using [setTranslationZ()][1] when a user touches it:
15*d353a188SXin Li
16*d353a188SXin Li    shape2.setOnTouchListener(new View.OnTouchListener() {
17*d353a188SXin Li        @Override
18*d353a188SXin Li        public boolean onTouch(View view, MotionEvent motionEvent) {
19*d353a188SXin Li            int action = motionEvent.getActionMasked();
20*d353a188SXin Li            /* Raise view on ACTION_DOWN and lower it on ACTION_UP. */
21*d353a188SXin Li            switch (action) {
22*d353a188SXin Li                case MotionEvent.ACTION_DOWN:
23*d353a188SXin Li                    Log.d(TAG, "ACTION_DOWN on view.");
24*d353a188SXin Li                    view.setTranslationZ(120);
25*d353a188SXin Li                    break;
26*d353a188SXin Li                case MotionEvent.ACTION_UP:
27*d353a188SXin Li                    Log.d(TAG, "ACTION_UP on view.");
28*d353a188SXin Li                    view.setTranslationZ(0);
29*d353a188SXin Li                    break;
30*d353a188SXin Li                default:
31*d353a188SXin Li                    return false;
32*d353a188SXin Li            }
33*d353a188SXin Li            return true;
34*d353a188SXin Li        }
35*d353a188SXin Li    });
36*d353a188SXin Li
37*d353a188SXin LiThe elevation reverts back once the touch is removed.
38*d353a188SXin Li
39*d353a188SXin Li[1]: https://developer.android.com/training/material/shadows-clipping.html#Elevation
40*d353a188SXin Li
41*d353a188SXin LiPre-requisites
42*d353a188SXin Li--------------
43*d353a188SXin Li
44*d353a188SXin Li- Android SDK 27
45*d353a188SXin Li- Android Build Tools v27.0.2
46*d353a188SXin Li- Android Support Repository
47*d353a188SXin Li
48*d353a188SXin LiScreenshots
49*d353a188SXin Li-------------
50*d353a188SXin Li
51*d353a188SXin Li<img src="screenshots/fixed.png" height="400" alt="Screenshot"/> <img src="screenshots/raised.png" height="400" alt="Screenshot"/>
52*d353a188SXin Li
53*d353a188SXin LiGetting Started
54*d353a188SXin Li---------------
55*d353a188SXin Li
56*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
57*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
58*d353a188SXin Li
59*d353a188SXin LiSupport
60*d353a188SXin Li-------
61*d353a188SXin Li
62*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
63*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
64*d353a188SXin Li
65*d353a188SXin LiIf you've found an error in this sample, please file an issue:
66*d353a188SXin Lihttps://github.com/googlesamples/android-ElevationBasic
67*d353a188SXin Li
68*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
69*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
70*d353a188SXin Li
71*d353a188SXin LiLicense
72*d353a188SXin Li-------
73*d353a188SXin Li
74*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
75*d353a188SXin Li
76*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
77*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
78*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
79*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
80*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
81*d353a188SXin Lithe License at
82*d353a188SXin Li
83*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
84*d353a188SXin Li
85*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
86*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
87*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
88*d353a188SXin LiLicense for the specific language governing permissions and limitations under
89*d353a188SXin Lithe License.
90