View.java revision 197adec3656fc087d4aa56396e601bb8d04aa9fd
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.view; 18 19import android.animation.AnimatorInflater; 20import android.animation.StateListAnimator; 21import android.annotation.IntDef; 22import android.annotation.NonNull; 23import android.annotation.Nullable; 24import android.content.ClipData; 25import android.content.Context; 26import android.content.res.ColorStateList; 27import android.content.res.Configuration; 28import android.content.res.Resources; 29import android.content.res.TypedArray; 30import android.graphics.Bitmap; 31import android.graphics.Canvas; 32import android.graphics.Insets; 33import android.graphics.Interpolator; 34import android.graphics.LinearGradient; 35import android.graphics.Matrix; 36import android.graphics.Outline; 37import android.graphics.Paint; 38import android.graphics.Path; 39import android.graphics.PathMeasure; 40import android.graphics.PixelFormat; 41import android.graphics.Point; 42import android.graphics.PorterDuff; 43import android.graphics.PorterDuffXfermode; 44import android.graphics.Rect; 45import android.graphics.RectF; 46import android.graphics.Region; 47import android.graphics.Shader; 48import android.graphics.drawable.ColorDrawable; 49import android.graphics.drawable.Drawable; 50import android.hardware.display.DisplayManagerGlobal; 51import android.os.Bundle; 52import android.os.Handler; 53import android.os.IBinder; 54import android.os.Parcel; 55import android.os.Parcelable; 56import android.os.RemoteException; 57import android.os.SystemClock; 58import android.os.SystemProperties; 59import android.os.Trace; 60import android.text.TextUtils; 61import android.util.AttributeSet; 62import android.util.FloatProperty; 63import android.util.LayoutDirection; 64import android.util.Log; 65import android.util.LongSparseLongArray; 66import android.util.Pools.SynchronizedPool; 67import android.util.Property; 68import android.util.SparseArray; 69import android.util.SuperNotCalledException; 70import android.util.TypedValue; 71import android.view.ContextMenu.ContextMenuInfo; 72import android.view.AccessibilityIterators.TextSegmentIterator; 73import android.view.AccessibilityIterators.CharacterTextSegmentIterator; 74import android.view.AccessibilityIterators.WordTextSegmentIterator; 75import android.view.AccessibilityIterators.ParagraphTextSegmentIterator; 76import android.view.accessibility.AccessibilityEvent; 77import android.view.accessibility.AccessibilityEventSource; 78import android.view.accessibility.AccessibilityManager; 79import android.view.accessibility.AccessibilityNodeInfo; 80import android.view.accessibility.AccessibilityNodeProvider; 81import android.view.animation.Animation; 82import android.view.animation.AnimationUtils; 83import android.view.animation.Transformation; 84import android.view.inputmethod.EditorInfo; 85import android.view.inputmethod.InputConnection; 86import android.view.inputmethod.InputMethodManager; 87import android.widget.ScrollBarDrawable; 88 89import static android.os.Build.VERSION_CODES.*; 90import static java.lang.Math.max; 91 92import com.android.internal.R; 93import com.android.internal.util.Predicate; 94import com.android.internal.view.menu.MenuBuilder; 95import com.google.android.collect.Lists; 96import com.google.android.collect.Maps; 97 98import java.lang.annotation.Retention; 99import java.lang.annotation.RetentionPolicy; 100import java.lang.ref.WeakReference; 101import java.lang.reflect.Field; 102import java.lang.reflect.InvocationTargetException; 103import java.lang.reflect.Method; 104import java.lang.reflect.Modifier; 105import java.util.ArrayList; 106import java.util.Arrays; 107import java.util.Collections; 108import java.util.HashMap; 109import java.util.List; 110import java.util.Locale; 111import java.util.Map; 112import java.util.concurrent.CopyOnWriteArrayList; 113import java.util.concurrent.atomic.AtomicInteger; 114 115/** 116 * <p> 117 * This class represents the basic building block for user interface components. A View 118 * occupies a rectangular area on the screen and is responsible for drawing and 119 * event handling. View is the base class for <em>widgets</em>, which are 120 * used to create interactive UI components (buttons, text fields, etc.). The 121 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which 122 * are invisible containers that hold other Views (or other ViewGroups) and define 123 * their layout properties. 124 * </p> 125 * 126 * <div class="special reference"> 127 * <h3>Developer Guides</h3> 128 * <p>For information about using this class to develop your application's user interface, 129 * read the <a href="{@docRoot}guide/topics/ui/index.html">User Interface</a> developer guide. 130 * </div> 131 * 132 * <a name="Using"></a> 133 * <h3>Using Views</h3> 134 * <p> 135 * All of the views in a window are arranged in a single tree. You can add views 136 * either from code or by specifying a tree of views in one or more XML layout 137 * files. There are many specialized subclasses of views that act as controls or 138 * are capable of displaying text, images, or other content. 139 * </p> 140 * <p> 141 * Once you have created a tree of views, there are typically a few types of 142 * common operations you may wish to perform: 143 * <ul> 144 * <li><strong>Set properties:</strong> for example setting the text of a 145 * {@link android.widget.TextView}. The available properties and the methods 146 * that set them will vary among the different subclasses of views. Note that 147 * properties that are known at build time can be set in the XML layout 148 * files.</li> 149 * <li><strong>Set focus:</strong> The framework will handled moving focus in 150 * response to user input. To force focus to a specific view, call 151 * {@link #requestFocus}.</li> 152 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners 153 * that will be notified when something interesting happens to the view. For 154 * example, all views will let you set a listener to be notified when the view 155 * gains or loses focus. You can register such a listener using 156 * {@link #setOnFocusChangeListener(android.view.View.OnFocusChangeListener)}. 157 * Other view subclasses offer more specialized listeners. For example, a Button 158 * exposes a listener to notify clients when the button is clicked.</li> 159 * <li><strong>Set visibility:</strong> You can hide or show views using 160 * {@link #setVisibility(int)}.</li> 161 * </ul> 162 * </p> 163 * <p><em> 164 * Note: The Android framework is responsible for measuring, laying out and 165 * drawing views. You should not call methods that perform these actions on 166 * views yourself unless you are actually implementing a 167 * {@link android.view.ViewGroup}. 168 * </em></p> 169 * 170 * <a name="Lifecycle"></a> 171 * <h3>Implementing a Custom View</h3> 172 * 173 * <p> 174 * To implement a custom view, you will usually begin by providing overrides for 175 * some of the standard methods that the framework calls on all views. You do 176 * not need to override all of these methods. In fact, you can start by just 177 * overriding {@link #onDraw(android.graphics.Canvas)}. 178 * <table border="2" width="85%" align="center" cellpadding="5"> 179 * <thead> 180 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr> 181 * </thead> 182 * 183 * <tbody> 184 * <tr> 185 * <td rowspan="2">Creation</td> 186 * <td>Constructors</td> 187 * <td>There is a form of the constructor that are called when the view 188 * is created from code and a form that is called when the view is 189 * inflated from a layout file. The second form should parse and apply 190 * any attributes defined in the layout file. 191 * </td> 192 * </tr> 193 * <tr> 194 * <td><code>{@link #onFinishInflate()}</code></td> 195 * <td>Called after a view and all of its children has been inflated 196 * from XML.</td> 197 * </tr> 198 * 199 * <tr> 200 * <td rowspan="3">Layout</td> 201 * <td><code>{@link #onMeasure(int, int)}</code></td> 202 * <td>Called to determine the size requirements for this view and all 203 * of its children. 204 * </td> 205 * </tr> 206 * <tr> 207 * <td><code>{@link #onLayout(boolean, int, int, int, int)}</code></td> 208 * <td>Called when this view should assign a size and position to all 209 * of its children. 210 * </td> 211 * </tr> 212 * <tr> 213 * <td><code>{@link #onSizeChanged(int, int, int, int)}</code></td> 214 * <td>Called when the size of this view has changed. 215 * </td> 216 * </tr> 217 * 218 * <tr> 219 * <td>Drawing</td> 220 * <td><code>{@link #onDraw(android.graphics.Canvas)}</code></td> 221 * <td>Called when the view should render its content. 222 * </td> 223 * </tr> 224 * 225 * <tr> 226 * <td rowspan="4">Event processing</td> 227 * <td><code>{@link #onKeyDown(int, KeyEvent)}</code></td> 228 * <td>Called when a new hardware key event occurs. 229 * </td> 230 * </tr> 231 * <tr> 232 * <td><code>{@link #onKeyUp(int, KeyEvent)}</code></td> 233 * <td>Called when a hardware key up event occurs. 234 * </td> 235 * </tr> 236 * <tr> 237 * <td><code>{@link #onTrackballEvent(MotionEvent)}</code></td> 238 * <td>Called when a trackball motion event occurs. 239 * </td> 240 * </tr> 241 * <tr> 242 * <td><code>{@link #onTouchEvent(MotionEvent)}</code></td> 243 * <td>Called when a touch screen motion event occurs. 244 * </td> 245 * </tr> 246 * 247 * <tr> 248 * <td rowspan="2">Focus</td> 249 * <td><code>{@link #onFocusChanged(boolean, int, android.graphics.Rect)}</code></td> 250 * <td>Called when the view gains or loses focus. 251 * </td> 252 * </tr> 253 * 254 * <tr> 255 * <td><code>{@link #onWindowFocusChanged(boolean)}</code></td> 256 * <td>Called when the window containing the view gains or loses focus. 257 * </td> 258 * </tr> 259 * 260 * <tr> 261 * <td rowspan="3">Attaching</td> 262 * <td><code>{@link #onAttachedToWindow()}</code></td> 263 * <td>Called when the view is attached to a window. 264 * </td> 265 * </tr> 266 * 267 * <tr> 268 * <td><code>{@link #onDetachedFromWindow}</code></td> 269 * <td>Called when the view is detached from its window. 270 * </td> 271 * </tr> 272 * 273 * <tr> 274 * <td><code>{@link #onWindowVisibilityChanged(int)}</code></td> 275 * <td>Called when the visibility of the window containing the view 276 * has changed. 277 * </td> 278 * </tr> 279 * </tbody> 280 * 281 * </table> 282 * </p> 283 * 284 * <a name="IDs"></a> 285 * <h3>IDs</h3> 286 * Views may have an integer id associated with them. These ids are typically 287 * assigned in the layout XML files, and are used to find specific views within 288 * the view tree. A common pattern is to: 289 * <ul> 290 * <li>Define a Button in the layout file and assign it a unique ID. 291 * <pre> 292 * <Button 293 * android:id="@+id/my_button" 294 * android:layout_width="wrap_content" 295 * android:layout_height="wrap_content" 296 * android:text="@string/my_button_text"/> 297 * </pre></li> 298 * <li>From the onCreate method of an Activity, find the Button 299 * <pre class="prettyprint"> 300 * Button myButton = (Button) findViewById(R.id.my_button); 301 * </pre></li> 302 * </ul> 303 * <p> 304 * View IDs need not be unique throughout the tree, but it is good practice to 305 * ensure that they are at least unique within the part of the tree you are 306 * searching. 307 * </p> 308 * 309 * <a name="Position"></a> 310 * <h3>Position</h3> 311 * <p> 312 * The geometry of a view is that of a rectangle. A view has a location, 313 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and 314 * two dimensions, expressed as a width and a height. The unit for location 315 * and dimensions is the pixel. 316 * </p> 317 * 318 * <p> 319 * It is possible to retrieve the location of a view by invoking the methods 320 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X, 321 * coordinate of the rectangle representing the view. The latter returns the 322 * top, or Y, coordinate of the rectangle representing the view. These methods 323 * both return the location of the view relative to its parent. For instance, 324 * when getLeft() returns 20, that means the view is located 20 pixels to the 325 * right of the left edge of its direct parent. 326 * </p> 327 * 328 * <p> 329 * In addition, several convenience methods are offered to avoid unnecessary 330 * computations, namely {@link #getRight()} and {@link #getBottom()}. 331 * These methods return the coordinates of the right and bottom edges of the 332 * rectangle representing the view. For instance, calling {@link #getRight()} 333 * is similar to the following computation: <code>getLeft() + getWidth()</code> 334 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.) 335 * </p> 336 * 337 * <a name="SizePaddingMargins"></a> 338 * <h3>Size, padding and margins</h3> 339 * <p> 340 * The size of a view is expressed with a width and a height. A view actually 341 * possess two pairs of width and height values. 342 * </p> 343 * 344 * <p> 345 * The first pair is known as <em>measured width</em> and 346 * <em>measured height</em>. These dimensions define how big a view wants to be 347 * within its parent (see <a href="#Layout">Layout</a> for more details.) The 348 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()} 349 * and {@link #getMeasuredHeight()}. 350 * </p> 351 * 352 * <p> 353 * The second pair is simply known as <em>width</em> and <em>height</em>, or 354 * sometimes <em>drawing width</em> and <em>drawing height</em>. These 355 * dimensions define the actual size of the view on screen, at drawing time and 356 * after layout. These values may, but do not have to, be different from the 357 * measured width and height. The width and height can be obtained by calling 358 * {@link #getWidth()} and {@link #getHeight()}. 359 * </p> 360 * 361 * <p> 362 * To measure its dimensions, a view takes into account its padding. The padding 363 * is expressed in pixels for the left, top, right and bottom parts of the view. 364 * Padding can be used to offset the content of the view by a specific amount of 365 * pixels. For instance, a left padding of 2 will push the view's content by 366 * 2 pixels to the right of the left edge. Padding can be set using the 367 * {@link #setPadding(int, int, int, int)} or {@link #setPaddingRelative(int, int, int, int)} 368 * method and queried by calling {@link #getPaddingLeft()}, {@link #getPaddingTop()}, 369 * {@link #getPaddingRight()}, {@link #getPaddingBottom()}, {@link #getPaddingStart()}, 370 * {@link #getPaddingEnd()}. 371 * </p> 372 * 373 * <p> 374 * Even though a view can define a padding, it does not provide any support for 375 * margins. However, view groups provide such a support. Refer to 376 * {@link android.view.ViewGroup} and 377 * {@link android.view.ViewGroup.MarginLayoutParams} for further information. 378 * </p> 379 * 380 * <a name="Layout"></a> 381 * <h3>Layout</h3> 382 * <p> 383 * Layout is a two pass process: a measure pass and a layout pass. The measuring 384 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal 385 * of the view tree. Each view pushes dimension specifications down the tree 386 * during the recursion. At the end of the measure pass, every view has stored 387 * its measurements. The second pass happens in 388 * {@link #layout(int,int,int,int)} and is also top-down. During 389 * this pass each parent is responsible for positioning all of its children 390 * using the sizes computed in the measure pass. 391 * </p> 392 * 393 * <p> 394 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and 395 * {@link #getMeasuredHeight()} values must be set, along with those for all of 396 * that view's descendants. A view's measured width and measured height values 397 * must respect the constraints imposed by the view's parents. This guarantees 398 * that at the end of the measure pass, all parents accept all of their 399 * children's measurements. A parent view may call measure() more than once on 400 * its children. For example, the parent may measure each child once with 401 * unspecified dimensions to find out how big they want to be, then call 402 * measure() on them again with actual numbers if the sum of all the children's 403 * unconstrained sizes is too big or too small. 404 * </p> 405 * 406 * <p> 407 * The measure pass uses two classes to communicate dimensions. The 408 * {@link MeasureSpec} class is used by views to tell their parents how they 409 * want to be measured and positioned. The base LayoutParams class just 410 * describes how big the view wants to be for both width and height. For each 411 * dimension, it can specify one of: 412 * <ul> 413 * <li> an exact number 414 * <li>MATCH_PARENT, which means the view wants to be as big as its parent 415 * (minus padding) 416 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to 417 * enclose its content (plus padding). 418 * </ul> 419 * There are subclasses of LayoutParams for different subclasses of ViewGroup. 420 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds 421 * an X and Y value. 422 * </p> 423 * 424 * <p> 425 * MeasureSpecs are used to push requirements down the tree from parent to 426 * child. A MeasureSpec can be in one of three modes: 427 * <ul> 428 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension 429 * of a child view. For example, a LinearLayout may call measure() on its child 430 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how 431 * tall the child view wants to be given a width of 240 pixels. 432 * <li>EXACTLY: This is used by the parent to impose an exact size on the 433 * child. The child must use this size, and guarantee that all of its 434 * descendants will fit within this size. 435 * <li>AT_MOST: This is used by the parent to impose a maximum size on the 436 * child. The child must guarantee that it and all of its descendants will fit 437 * within this size. 438 * </ul> 439 * </p> 440 * 441 * <p> 442 * To intiate a layout, call {@link #requestLayout}. This method is typically 443 * called by a view on itself when it believes that is can no longer fit within 444 * its current bounds. 445 * </p> 446 * 447 * <a name="Drawing"></a> 448 * <h3>Drawing</h3> 449 * <p> 450 * Drawing is handled by walking the tree and recording the drawing commands of 451 * any View that needs to update. After this, the drawing commands of the 452 * entire tree are issued to screen, clipped to the newly damaged area. 453 * </p> 454 * 455 * <p> 456 * The tree is largely recorded and drawn in order, with parents drawn before 457 * (i.e., behind) their children, with siblings drawn in the order they appear 458 * in the tree. If you set a background drawable for a View, then the View will 459 * draw it before calling back to its <code>onDraw()</code> method. The child 460 * drawing order can be overridden with 461 * {@link ViewGroup#setChildrenDrawingOrderEnabled(boolean) custom child drawing order} 462 * in a ViewGroup, and with {@link #setZ(float)} custom Z values} set on Views. 463 * </p> 464 * 465 * <p> 466 * To force a view to draw, call {@link #invalidate()}. 467 * </p> 468 * 469 * <a name="EventHandlingThreading"></a> 470 * <h3>Event Handling and Threading</h3> 471 * <p> 472 * The basic cycle of a view is as follows: 473 * <ol> 474 * <li>An event comes in and is dispatched to the appropriate view. The view 475 * handles the event and notifies any listeners.</li> 476 * <li>If in the course of processing the event, the view's bounds may need 477 * to be changed, the view will call {@link #requestLayout()}.</li> 478 * <li>Similarly, if in the course of processing the event the view's appearance 479 * may need to be changed, the view will call {@link #invalidate()}.</li> 480 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called, 481 * the framework will take care of measuring, laying out, and drawing the tree 482 * as appropriate.</li> 483 * </ol> 484 * </p> 485 * 486 * <p><em>Note: The entire view tree is single threaded. You must always be on 487 * the UI thread when calling any method on any view.</em> 488 * If you are doing work on other threads and want to update the state of a view 489 * from that thread, you should use a {@link Handler}. 490 * </p> 491 * 492 * <a name="FocusHandling"></a> 493 * <h3>Focus Handling</h3> 494 * <p> 495 * The framework will handle routine focus movement in response to user input. 496 * This includes changing the focus as views are removed or hidden, or as new 497 * views become available. Views indicate their willingness to take focus 498 * through the {@link #isFocusable} method. To change whether a view can take 499 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below) 500 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode} 501 * and can change this via {@link #setFocusableInTouchMode(boolean)}. 502 * </p> 503 * <p> 504 * Focus movement is based on an algorithm which finds the nearest neighbor in a 505 * given direction. In rare cases, the default algorithm may not match the 506 * intended behavior of the developer. In these situations, you can provide 507 * explicit overrides by using these XML attributes in the layout file: 508 * <pre> 509 * nextFocusDown 510 * nextFocusLeft 511 * nextFocusRight 512 * nextFocusUp 513 * </pre> 514 * </p> 515 * 516 * 517 * <p> 518 * To get a particular view to take focus, call {@link #requestFocus()}. 519 * </p> 520 * 521 * <a name="TouchMode"></a> 522 * <h3>Touch Mode</h3> 523 * <p> 524 * When a user is navigating a user interface via directional keys such as a D-pad, it is 525 * necessary to give focus to actionable items such as buttons so the user can see 526 * what will take input. If the device has touch capabilities, however, and the user 527 * begins interacting with the interface by touching it, it is no longer necessary to 528 * always highlight, or give focus to, a particular view. This motivates a mode 529 * for interaction named 'touch mode'. 530 * </p> 531 * <p> 532 * For a touch capable device, once the user touches the screen, the device 533 * will enter touch mode. From this point onward, only views for which 534 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets. 535 * Other views that are touchable, like buttons, will not take focus when touched; they will 536 * only fire the on click listeners. 537 * </p> 538 * <p> 539 * Any time a user hits a directional key, such as a D-pad direction, the view device will 540 * exit touch mode, and find a view to take focus, so that the user may resume interacting 541 * with the user interface without touching the screen again. 542 * </p> 543 * <p> 544 * The touch mode state is maintained across {@link android.app.Activity}s. Call 545 * {@link #isInTouchMode} to see whether the device is currently in touch mode. 546 * </p> 547 * 548 * <a name="Scrolling"></a> 549 * <h3>Scrolling</h3> 550 * <p> 551 * The framework provides basic support for views that wish to internally 552 * scroll their content. This includes keeping track of the X and Y scroll 553 * offset as well as mechanisms for drawing scrollbars. See 554 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and 555 * {@link #awakenScrollBars()} for more details. 556 * </p> 557 * 558 * <a name="Tags"></a> 559 * <h3>Tags</h3> 560 * <p> 561 * Unlike IDs, tags are not used to identify views. Tags are essentially an 562 * extra piece of information that can be associated with a view. They are most 563 * often used as a convenience to store data related to views in the views 564 * themselves rather than by putting them in a separate structure. 565 * </p> 566 * 567 * <a name="Properties"></a> 568 * <h3>Properties</h3> 569 * <p> 570 * The View class exposes an {@link #ALPHA} property, as well as several transform-related 571 * properties, such as {@link #TRANSLATION_X} and {@link #TRANSLATION_Y}. These properties are 572 * available both in the {@link Property} form as well as in similarly-named setter/getter 573 * methods (such as {@link #setAlpha(float)} for {@link #ALPHA}). These properties can 574 * be used to set persistent state associated with these rendering-related properties on the view. 575 * The properties and methods can also be used in conjunction with 576 * {@link android.animation.Animator Animator}-based animations, described more in the 577 * <a href="#Animation">Animation</a> section. 578 * </p> 579 * 580 * <a name="Animation"></a> 581 * <h3>Animation</h3> 582 * <p> 583 * Starting with Android 3.0, the preferred way of animating views is to use the 584 * {@link android.animation} package APIs. These {@link android.animation.Animator Animator}-based 585 * classes change actual properties of the View object, such as {@link #setAlpha(float) alpha} and 586 * {@link #setTranslationX(float) translationX}. This behavior is contrasted to that of the pre-3.0 587 * {@link android.view.animation.Animation Animation}-based classes, which instead animate only 588 * how the view is drawn on the display. In particular, the {@link ViewPropertyAnimator} class 589 * makes animating these View properties particularly easy and efficient. 590 * </p> 591 * <p> 592 * Alternatively, you can use the pre-3.0 animation classes to animate how Views are rendered. 593 * You can attach an {@link Animation} object to a view using 594 * {@link #setAnimation(Animation)} or 595 * {@link #startAnimation(Animation)}. The animation can alter the scale, 596 * rotation, translation and alpha of a view over time. If the animation is 597 * attached to a view that has children, the animation will affect the entire 598 * subtree rooted by that node. When an animation is started, the framework will 599 * take care of redrawing the appropriate views until the animation completes. 600 * </p> 601 * 602 * <a name="Security"></a> 603 * <h3>Security</h3> 604 * <p> 605 * Sometimes it is essential that an application be able to verify that an action 606 * is being performed with the full knowledge and consent of the user, such as 607 * granting a permission request, making a purchase or clicking on an advertisement. 608 * Unfortunately, a malicious application could try to spoof the user into 609 * performing these actions, unaware, by concealing the intended purpose of the view. 610 * As a remedy, the framework offers a touch filtering mechanism that can be used to 611 * improve the security of views that provide access to sensitive functionality. 612 * </p><p> 613 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the 614 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework 615 * will discard touches that are received whenever the view's window is obscured by 616 * another visible window. As a result, the view will not receive touches whenever a 617 * toast, dialog or other window appears above the view's window. 618 * </p><p> 619 * For more fine-grained control over security, consider overriding the 620 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own 621 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}. 622 * </p> 623 * 624 * @attr ref android.R.styleable#View_alpha 625 * @attr ref android.R.styleable#View_background 626 * @attr ref android.R.styleable#View_clickable 627 * @attr ref android.R.styleable#View_contentDescription 628 * @attr ref android.R.styleable#View_drawingCacheQuality 629 * @attr ref android.R.styleable#View_duplicateParentState 630 * @attr ref android.R.styleable#View_id 631 * @attr ref android.R.styleable#View_requiresFadingEdge 632 * @attr ref android.R.styleable#View_fadeScrollbars 633 * @attr ref android.R.styleable#View_fadingEdgeLength 634 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 635 * @attr ref android.R.styleable#View_fitsSystemWindows 636 * @attr ref android.R.styleable#View_isScrollContainer 637 * @attr ref android.R.styleable#View_focusable 638 * @attr ref android.R.styleable#View_focusableInTouchMode 639 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 640 * @attr ref android.R.styleable#View_keepScreenOn 641 * @attr ref android.R.styleable#View_layerType 642 * @attr ref android.R.styleable#View_layoutDirection 643 * @attr ref android.R.styleable#View_longClickable 644 * @attr ref android.R.styleable#View_minHeight 645 * @attr ref android.R.styleable#View_minWidth 646 * @attr ref android.R.styleable#View_nextFocusDown 647 * @attr ref android.R.styleable#View_nextFocusLeft 648 * @attr ref android.R.styleable#View_nextFocusRight 649 * @attr ref android.R.styleable#View_nextFocusUp 650 * @attr ref android.R.styleable#View_onClick 651 * @attr ref android.R.styleable#View_padding 652 * @attr ref android.R.styleable#View_paddingBottom 653 * @attr ref android.R.styleable#View_paddingLeft 654 * @attr ref android.R.styleable#View_paddingRight 655 * @attr ref android.R.styleable#View_paddingTop 656 * @attr ref android.R.styleable#View_paddingStart 657 * @attr ref android.R.styleable#View_paddingEnd 658 * @attr ref android.R.styleable#View_saveEnabled 659 * @attr ref android.R.styleable#View_rotation 660 * @attr ref android.R.styleable#View_rotationX 661 * @attr ref android.R.styleable#View_rotationY 662 * @attr ref android.R.styleable#View_scaleX 663 * @attr ref android.R.styleable#View_scaleY 664 * @attr ref android.R.styleable#View_scrollX 665 * @attr ref android.R.styleable#View_scrollY 666 * @attr ref android.R.styleable#View_scrollbarSize 667 * @attr ref android.R.styleable#View_scrollbarStyle 668 * @attr ref android.R.styleable#View_scrollbars 669 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 670 * @attr ref android.R.styleable#View_scrollbarFadeDuration 671 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal 672 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal 673 * @attr ref android.R.styleable#View_scrollbarThumbVertical 674 * @attr ref android.R.styleable#View_scrollbarTrackVertical 675 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack 676 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack 677 * @attr ref android.R.styleable#View_stateListAnimator 678 * @attr ref android.R.styleable#View_transitionName 679 * @attr ref android.R.styleable#View_soundEffectsEnabled 680 * @attr ref android.R.styleable#View_tag 681 * @attr ref android.R.styleable#View_textAlignment 682 * @attr ref android.R.styleable#View_textDirection 683 * @attr ref android.R.styleable#View_transformPivotX 684 * @attr ref android.R.styleable#View_transformPivotY 685 * @attr ref android.R.styleable#View_translationX 686 * @attr ref android.R.styleable#View_translationY 687 * @attr ref android.R.styleable#View_translationZ 688 * @attr ref android.R.styleable#View_visibility 689 * 690 * @see android.view.ViewGroup 691 */ 692public class View implements Drawable.Callback, KeyEvent.Callback, 693 AccessibilityEventSource { 694 private static final boolean DBG = false; 695 696 /** 697 * The logging tag used by this class with android.util.Log. 698 */ 699 protected static final String VIEW_LOG_TAG = "View"; 700 701 /** 702 * When set to true, apps will draw debugging information about their layouts. 703 * 704 * @hide 705 */ 706 public static final String DEBUG_LAYOUT_PROPERTY = "debug.layout"; 707 708 /** 709 * When set to true, this view will save its attribute data. 710 * 711 * @hide 712 */ 713 public static boolean mDebugViewAttributes = false; 714 715 /** 716 * Used to mark a View that has no ID. 717 */ 718 public static final int NO_ID = -1; 719 720 /** 721 * Signals that compatibility booleans have been initialized according to 722 * target SDK versions. 723 */ 724 private static boolean sCompatibilityDone = false; 725 726 /** 727 * Use the old (broken) way of building MeasureSpecs. 728 */ 729 private static boolean sUseBrokenMakeMeasureSpec = false; 730 731 /** 732 * Ignore any optimizations using the measure cache. 733 */ 734 private static boolean sIgnoreMeasureCache = false; 735 736 /** 737 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when 738 * calling setFlags. 739 */ 740 private static final int NOT_FOCUSABLE = 0x00000000; 741 742 /** 743 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling 744 * setFlags. 745 */ 746 private static final int FOCUSABLE = 0x00000001; 747 748 /** 749 * Mask for use with setFlags indicating bits used for focus. 750 */ 751 private static final int FOCUSABLE_MASK = 0x00000001; 752 753 /** 754 * This view will adjust its padding to fit sytem windows (e.g. status bar) 755 */ 756 private static final int FITS_SYSTEM_WINDOWS = 0x00000002; 757 758 /** @hide */ 759 @IntDef({VISIBLE, INVISIBLE, GONE}) 760 @Retention(RetentionPolicy.SOURCE) 761 public @interface Visibility {} 762 763 /** 764 * This view is visible. 765 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 766 * android:visibility}. 767 */ 768 public static final int VISIBLE = 0x00000000; 769 770 /** 771 * This view is invisible, but it still takes up space for layout purposes. 772 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 773 * android:visibility}. 774 */ 775 public static final int INVISIBLE = 0x00000004; 776 777 /** 778 * This view is invisible, and it doesn't take any space for layout 779 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 780 * android:visibility}. 781 */ 782 public static final int GONE = 0x00000008; 783 784 /** 785 * Mask for use with setFlags indicating bits used for visibility. 786 * {@hide} 787 */ 788 static final int VISIBILITY_MASK = 0x0000000C; 789 790 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE}; 791 792 /** 793 * This view is enabled. Interpretation varies by subclass. 794 * Use with ENABLED_MASK when calling setFlags. 795 * {@hide} 796 */ 797 static final int ENABLED = 0x00000000; 798 799 /** 800 * This view is disabled. Interpretation varies by subclass. 801 * Use with ENABLED_MASK when calling setFlags. 802 * {@hide} 803 */ 804 static final int DISABLED = 0x00000020; 805 806 /** 807 * Mask for use with setFlags indicating bits used for indicating whether 808 * this view is enabled 809 * {@hide} 810 */ 811 static final int ENABLED_MASK = 0x00000020; 812 813 /** 814 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be 815 * called and further optimizations will be performed. It is okay to have 816 * this flag set and a background. Use with DRAW_MASK when calling setFlags. 817 * {@hide} 818 */ 819 static final int WILL_NOT_DRAW = 0x00000080; 820 821 /** 822 * Mask for use with setFlags indicating bits used for indicating whether 823 * this view is will draw 824 * {@hide} 825 */ 826 static final int DRAW_MASK = 0x00000080; 827 828 /** 829 * <p>This view doesn't show scrollbars.</p> 830 * {@hide} 831 */ 832 static final int SCROLLBARS_NONE = 0x00000000; 833 834 /** 835 * <p>This view shows horizontal scrollbars.</p> 836 * {@hide} 837 */ 838 static final int SCROLLBARS_HORIZONTAL = 0x00000100; 839 840 /** 841 * <p>This view shows vertical scrollbars.</p> 842 * {@hide} 843 */ 844 static final int SCROLLBARS_VERTICAL = 0x00000200; 845 846 /** 847 * <p>Mask for use with setFlags indicating bits used for indicating which 848 * scrollbars are enabled.</p> 849 * {@hide} 850 */ 851 static final int SCROLLBARS_MASK = 0x00000300; 852 853 /** 854 * Indicates that the view should filter touches when its window is obscured. 855 * Refer to the class comments for more information about this security feature. 856 * {@hide} 857 */ 858 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400; 859 860 /** 861 * Set for framework elements that use FITS_SYSTEM_WINDOWS, to indicate 862 * that they are optional and should be skipped if the window has 863 * requested system UI flags that ignore those insets for layout. 864 */ 865 static final int OPTIONAL_FITS_SYSTEM_WINDOWS = 0x00000800; 866 867 /** 868 * <p>This view doesn't show fading edges.</p> 869 * {@hide} 870 */ 871 static final int FADING_EDGE_NONE = 0x00000000; 872 873 /** 874 * <p>This view shows horizontal fading edges.</p> 875 * {@hide} 876 */ 877 static final int FADING_EDGE_HORIZONTAL = 0x00001000; 878 879 /** 880 * <p>This view shows vertical fading edges.</p> 881 * {@hide} 882 */ 883 static final int FADING_EDGE_VERTICAL = 0x00002000; 884 885 /** 886 * <p>Mask for use with setFlags indicating bits used for indicating which 887 * fading edges are enabled.</p> 888 * {@hide} 889 */ 890 static final int FADING_EDGE_MASK = 0x00003000; 891 892 /** 893 * <p>Indicates this view can be clicked. When clickable, a View reacts 894 * to clicks by notifying the OnClickListener.<p> 895 * {@hide} 896 */ 897 static final int CLICKABLE = 0x00004000; 898 899 /** 900 * <p>Indicates this view is caching its drawing into a bitmap.</p> 901 * {@hide} 902 */ 903 static final int DRAWING_CACHE_ENABLED = 0x00008000; 904 905 /** 906 * <p>Indicates that no icicle should be saved for this view.<p> 907 * {@hide} 908 */ 909 static final int SAVE_DISABLED = 0x000010000; 910 911 /** 912 * <p>Mask for use with setFlags indicating bits used for the saveEnabled 913 * property.</p> 914 * {@hide} 915 */ 916 static final int SAVE_DISABLED_MASK = 0x000010000; 917 918 /** 919 * <p>Indicates that no drawing cache should ever be created for this view.<p> 920 * {@hide} 921 */ 922 static final int WILL_NOT_CACHE_DRAWING = 0x000020000; 923 924 /** 925 * <p>Indicates this view can take / keep focus when int touch mode.</p> 926 * {@hide} 927 */ 928 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000; 929 930 /** @hide */ 931 @Retention(RetentionPolicy.SOURCE) 932 @IntDef({DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_AUTO}) 933 public @interface DrawingCacheQuality {} 934 935 /** 936 * <p>Enables low quality mode for the drawing cache.</p> 937 */ 938 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000; 939 940 /** 941 * <p>Enables high quality mode for the drawing cache.</p> 942 */ 943 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000; 944 945 /** 946 * <p>Enables automatic quality mode for the drawing cache.</p> 947 */ 948 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000; 949 950 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = { 951 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH 952 }; 953 954 /** 955 * <p>Mask for use with setFlags indicating bits used for the cache 956 * quality property.</p> 957 * {@hide} 958 */ 959 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000; 960 961 /** 962 * <p> 963 * Indicates this view can be long clicked. When long clickable, a View 964 * reacts to long clicks by notifying the OnLongClickListener or showing a 965 * context menu. 966 * </p> 967 * {@hide} 968 */ 969 static final int LONG_CLICKABLE = 0x00200000; 970 971 /** 972 * <p>Indicates that this view gets its drawable states from its direct parent 973 * and ignores its original internal states.</p> 974 * 975 * @hide 976 */ 977 static final int DUPLICATE_PARENT_STATE = 0x00400000; 978 979 /** @hide */ 980 @IntDef({ 981 SCROLLBARS_INSIDE_OVERLAY, 982 SCROLLBARS_INSIDE_INSET, 983 SCROLLBARS_OUTSIDE_OVERLAY, 984 SCROLLBARS_OUTSIDE_INSET 985 }) 986 @Retention(RetentionPolicy.SOURCE) 987 public @interface ScrollBarStyle {} 988 989 /** 990 * The scrollbar style to display the scrollbars inside the content area, 991 * without increasing the padding. The scrollbars will be overlaid with 992 * translucency on the view's content. 993 */ 994 public static final int SCROLLBARS_INSIDE_OVERLAY = 0; 995 996 /** 997 * The scrollbar style to display the scrollbars inside the padded area, 998 * increasing the padding of the view. The scrollbars will not overlap the 999 * content area of the view. 1000 */ 1001 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000; 1002 1003 /** 1004 * The scrollbar style to display the scrollbars at the edge of the view, 1005 * without increasing the padding. The scrollbars will be overlaid with 1006 * translucency. 1007 */ 1008 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000; 1009 1010 /** 1011 * The scrollbar style to display the scrollbars at the edge of the view, 1012 * increasing the padding of the view. The scrollbars will only overlap the 1013 * background, if any. 1014 */ 1015 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000; 1016 1017 /** 1018 * Mask to check if the scrollbar style is overlay or inset. 1019 * {@hide} 1020 */ 1021 static final int SCROLLBARS_INSET_MASK = 0x01000000; 1022 1023 /** 1024 * Mask to check if the scrollbar style is inside or outside. 1025 * {@hide} 1026 */ 1027 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000; 1028 1029 /** 1030 * Mask for scrollbar style. 1031 * {@hide} 1032 */ 1033 static final int SCROLLBARS_STYLE_MASK = 0x03000000; 1034 1035 /** 1036 * View flag indicating that the screen should remain on while the 1037 * window containing this view is visible to the user. This effectively 1038 * takes care of automatically setting the WindowManager's 1039 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}. 1040 */ 1041 public static final int KEEP_SCREEN_ON = 0x04000000; 1042 1043 /** 1044 * View flag indicating whether this view should have sound effects enabled 1045 * for events such as clicking and touching. 1046 */ 1047 public static final int SOUND_EFFECTS_ENABLED = 0x08000000; 1048 1049 /** 1050 * View flag indicating whether this view should have haptic feedback 1051 * enabled for events such as long presses. 1052 */ 1053 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000; 1054 1055 /** 1056 * <p>Indicates that the view hierarchy should stop saving state when 1057 * it reaches this view. If state saving is initiated immediately at 1058 * the view, it will be allowed. 1059 * {@hide} 1060 */ 1061 static final int PARENT_SAVE_DISABLED = 0x20000000; 1062 1063 /** 1064 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p> 1065 * {@hide} 1066 */ 1067 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000; 1068 1069 /** @hide */ 1070 @IntDef(flag = true, 1071 value = { 1072 FOCUSABLES_ALL, 1073 FOCUSABLES_TOUCH_MODE 1074 }) 1075 @Retention(RetentionPolicy.SOURCE) 1076 public @interface FocusableMode {} 1077 1078 /** 1079 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1080 * should add all focusable Views regardless if they are focusable in touch mode. 1081 */ 1082 public static final int FOCUSABLES_ALL = 0x00000000; 1083 1084 /** 1085 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1086 * should add only Views focusable in touch mode. 1087 */ 1088 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001; 1089 1090 /** @hide */ 1091 @IntDef({ 1092 FOCUS_BACKWARD, 1093 FOCUS_FORWARD, 1094 FOCUS_LEFT, 1095 FOCUS_UP, 1096 FOCUS_RIGHT, 1097 FOCUS_DOWN 1098 }) 1099 @Retention(RetentionPolicy.SOURCE) 1100 public @interface FocusDirection {} 1101 1102 /** @hide */ 1103 @IntDef({ 1104 FOCUS_LEFT, 1105 FOCUS_UP, 1106 FOCUS_RIGHT, 1107 FOCUS_DOWN 1108 }) 1109 @Retention(RetentionPolicy.SOURCE) 1110 public @interface FocusRealDirection {} // Like @FocusDirection, but without forward/backward 1111 1112 /** 1113 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable 1114 * item. 1115 */ 1116 public static final int FOCUS_BACKWARD = 0x00000001; 1117 1118 /** 1119 * Use with {@link #focusSearch(int)}. Move focus to the next selectable 1120 * item. 1121 */ 1122 public static final int FOCUS_FORWARD = 0x00000002; 1123 1124 /** 1125 * Use with {@link #focusSearch(int)}. Move focus to the left. 1126 */ 1127 public static final int FOCUS_LEFT = 0x00000011; 1128 1129 /** 1130 * Use with {@link #focusSearch(int)}. Move focus up. 1131 */ 1132 public static final int FOCUS_UP = 0x00000021; 1133 1134 /** 1135 * Use with {@link #focusSearch(int)}. Move focus to the right. 1136 */ 1137 public static final int FOCUS_RIGHT = 0x00000042; 1138 1139 /** 1140 * Use with {@link #focusSearch(int)}. Move focus down. 1141 */ 1142 public static final int FOCUS_DOWN = 0x00000082; 1143 1144 /** 1145 * Bits of {@link #getMeasuredWidthAndState()} and 1146 * {@link #getMeasuredWidthAndState()} that provide the actual measured size. 1147 */ 1148 public static final int MEASURED_SIZE_MASK = 0x00ffffff; 1149 1150 /** 1151 * Bits of {@link #getMeasuredWidthAndState()} and 1152 * {@link #getMeasuredWidthAndState()} that provide the additional state bits. 1153 */ 1154 public static final int MEASURED_STATE_MASK = 0xff000000; 1155 1156 /** 1157 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits 1158 * for functions that combine both width and height into a single int, 1159 * such as {@link #getMeasuredState()} and the childState argument of 1160 * {@link #resolveSizeAndState(int, int, int)}. 1161 */ 1162 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16; 1163 1164 /** 1165 * Bit of {@link #getMeasuredWidthAndState()} and 1166 * {@link #getMeasuredWidthAndState()} that indicates the measured size 1167 * is smaller that the space the view would like to have. 1168 */ 1169 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000; 1170 1171 /** 1172 * Base View state sets 1173 */ 1174 // Singles 1175 /** 1176 * Indicates the view has no states set. States are used with 1177 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1178 * view depending on its state. 1179 * 1180 * @see android.graphics.drawable.Drawable 1181 * @see #getDrawableState() 1182 */ 1183 protected static final int[] EMPTY_STATE_SET; 1184 /** 1185 * Indicates the view is enabled. States are used with 1186 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1187 * view depending on its state. 1188 * 1189 * @see android.graphics.drawable.Drawable 1190 * @see #getDrawableState() 1191 */ 1192 protected static final int[] ENABLED_STATE_SET; 1193 /** 1194 * Indicates the view is focused. States are used with 1195 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1196 * view depending on its state. 1197 * 1198 * @see android.graphics.drawable.Drawable 1199 * @see #getDrawableState() 1200 */ 1201 protected static final int[] FOCUSED_STATE_SET; 1202 /** 1203 * Indicates the view is selected. States are used with 1204 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1205 * view depending on its state. 1206 * 1207 * @see android.graphics.drawable.Drawable 1208 * @see #getDrawableState() 1209 */ 1210 protected static final int[] SELECTED_STATE_SET; 1211 /** 1212 * Indicates the view is pressed. States are used with 1213 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1214 * view depending on its state. 1215 * 1216 * @see android.graphics.drawable.Drawable 1217 * @see #getDrawableState() 1218 */ 1219 protected static final int[] PRESSED_STATE_SET; 1220 /** 1221 * Indicates the view's window has focus. States are used with 1222 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1223 * view depending on its state. 1224 * 1225 * @see android.graphics.drawable.Drawable 1226 * @see #getDrawableState() 1227 */ 1228 protected static final int[] WINDOW_FOCUSED_STATE_SET; 1229 // Doubles 1230 /** 1231 * Indicates the view is enabled and has the focus. 1232 * 1233 * @see #ENABLED_STATE_SET 1234 * @see #FOCUSED_STATE_SET 1235 */ 1236 protected static final int[] ENABLED_FOCUSED_STATE_SET; 1237 /** 1238 * Indicates the view is enabled and selected. 1239 * 1240 * @see #ENABLED_STATE_SET 1241 * @see #SELECTED_STATE_SET 1242 */ 1243 protected static final int[] ENABLED_SELECTED_STATE_SET; 1244 /** 1245 * Indicates the view is enabled and that its window has focus. 1246 * 1247 * @see #ENABLED_STATE_SET 1248 * @see #WINDOW_FOCUSED_STATE_SET 1249 */ 1250 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET; 1251 /** 1252 * Indicates the view is focused and selected. 1253 * 1254 * @see #FOCUSED_STATE_SET 1255 * @see #SELECTED_STATE_SET 1256 */ 1257 protected static final int[] FOCUSED_SELECTED_STATE_SET; 1258 /** 1259 * Indicates the view has the focus and that its window has the focus. 1260 * 1261 * @see #FOCUSED_STATE_SET 1262 * @see #WINDOW_FOCUSED_STATE_SET 1263 */ 1264 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET; 1265 /** 1266 * Indicates the view is selected and that its window has the focus. 1267 * 1268 * @see #SELECTED_STATE_SET 1269 * @see #WINDOW_FOCUSED_STATE_SET 1270 */ 1271 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET; 1272 // Triples 1273 /** 1274 * Indicates the view is enabled, focused and selected. 1275 * 1276 * @see #ENABLED_STATE_SET 1277 * @see #FOCUSED_STATE_SET 1278 * @see #SELECTED_STATE_SET 1279 */ 1280 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET; 1281 /** 1282 * Indicates the view is enabled, focused and its window has the focus. 1283 * 1284 * @see #ENABLED_STATE_SET 1285 * @see #FOCUSED_STATE_SET 1286 * @see #WINDOW_FOCUSED_STATE_SET 1287 */ 1288 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1289 /** 1290 * Indicates the view is enabled, selected and its window has the focus. 1291 * 1292 * @see #ENABLED_STATE_SET 1293 * @see #SELECTED_STATE_SET 1294 * @see #WINDOW_FOCUSED_STATE_SET 1295 */ 1296 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1297 /** 1298 * Indicates the view is focused, selected and its window has the focus. 1299 * 1300 * @see #FOCUSED_STATE_SET 1301 * @see #SELECTED_STATE_SET 1302 * @see #WINDOW_FOCUSED_STATE_SET 1303 */ 1304 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1305 /** 1306 * Indicates the view is enabled, focused, selected and its window 1307 * has the focus. 1308 * 1309 * @see #ENABLED_STATE_SET 1310 * @see #FOCUSED_STATE_SET 1311 * @see #SELECTED_STATE_SET 1312 * @see #WINDOW_FOCUSED_STATE_SET 1313 */ 1314 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1315 /** 1316 * Indicates the view is pressed and its window has the focus. 1317 * 1318 * @see #PRESSED_STATE_SET 1319 * @see #WINDOW_FOCUSED_STATE_SET 1320 */ 1321 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET; 1322 /** 1323 * Indicates the view is pressed and selected. 1324 * 1325 * @see #PRESSED_STATE_SET 1326 * @see #SELECTED_STATE_SET 1327 */ 1328 protected static final int[] PRESSED_SELECTED_STATE_SET; 1329 /** 1330 * Indicates the view is pressed, selected and its window has the focus. 1331 * 1332 * @see #PRESSED_STATE_SET 1333 * @see #SELECTED_STATE_SET 1334 * @see #WINDOW_FOCUSED_STATE_SET 1335 */ 1336 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1337 /** 1338 * Indicates the view is pressed and focused. 1339 * 1340 * @see #PRESSED_STATE_SET 1341 * @see #FOCUSED_STATE_SET 1342 */ 1343 protected static final int[] PRESSED_FOCUSED_STATE_SET; 1344 /** 1345 * Indicates the view is pressed, focused and its window has the focus. 1346 * 1347 * @see #PRESSED_STATE_SET 1348 * @see #FOCUSED_STATE_SET 1349 * @see #WINDOW_FOCUSED_STATE_SET 1350 */ 1351 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1352 /** 1353 * Indicates the view is pressed, focused and selected. 1354 * 1355 * @see #PRESSED_STATE_SET 1356 * @see #SELECTED_STATE_SET 1357 * @see #FOCUSED_STATE_SET 1358 */ 1359 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET; 1360 /** 1361 * Indicates the view is pressed, focused, selected and its window has the focus. 1362 * 1363 * @see #PRESSED_STATE_SET 1364 * @see #FOCUSED_STATE_SET 1365 * @see #SELECTED_STATE_SET 1366 * @see #WINDOW_FOCUSED_STATE_SET 1367 */ 1368 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1369 /** 1370 * Indicates the view is pressed and enabled. 1371 * 1372 * @see #PRESSED_STATE_SET 1373 * @see #ENABLED_STATE_SET 1374 */ 1375 protected static final int[] PRESSED_ENABLED_STATE_SET; 1376 /** 1377 * Indicates the view is pressed, enabled and its window has the focus. 1378 * 1379 * @see #PRESSED_STATE_SET 1380 * @see #ENABLED_STATE_SET 1381 * @see #WINDOW_FOCUSED_STATE_SET 1382 */ 1383 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET; 1384 /** 1385 * Indicates the view is pressed, enabled and selected. 1386 * 1387 * @see #PRESSED_STATE_SET 1388 * @see #ENABLED_STATE_SET 1389 * @see #SELECTED_STATE_SET 1390 */ 1391 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET; 1392 /** 1393 * Indicates the view is pressed, enabled, selected and its window has the 1394 * focus. 1395 * 1396 * @see #PRESSED_STATE_SET 1397 * @see #ENABLED_STATE_SET 1398 * @see #SELECTED_STATE_SET 1399 * @see #WINDOW_FOCUSED_STATE_SET 1400 */ 1401 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1402 /** 1403 * Indicates the view is pressed, enabled and focused. 1404 * 1405 * @see #PRESSED_STATE_SET 1406 * @see #ENABLED_STATE_SET 1407 * @see #FOCUSED_STATE_SET 1408 */ 1409 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET; 1410 /** 1411 * Indicates the view is pressed, enabled, focused and its window has the 1412 * focus. 1413 * 1414 * @see #PRESSED_STATE_SET 1415 * @see #ENABLED_STATE_SET 1416 * @see #FOCUSED_STATE_SET 1417 * @see #WINDOW_FOCUSED_STATE_SET 1418 */ 1419 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1420 /** 1421 * Indicates the view is pressed, enabled, focused and selected. 1422 * 1423 * @see #PRESSED_STATE_SET 1424 * @see #ENABLED_STATE_SET 1425 * @see #SELECTED_STATE_SET 1426 * @see #FOCUSED_STATE_SET 1427 */ 1428 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET; 1429 /** 1430 * Indicates the view is pressed, enabled, focused, selected and its window 1431 * has the focus. 1432 * 1433 * @see #PRESSED_STATE_SET 1434 * @see #ENABLED_STATE_SET 1435 * @see #SELECTED_STATE_SET 1436 * @see #FOCUSED_STATE_SET 1437 * @see #WINDOW_FOCUSED_STATE_SET 1438 */ 1439 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1440 1441 /** 1442 * The order here is very important to {@link #getDrawableState()} 1443 */ 1444 private static final int[][] VIEW_STATE_SETS; 1445 1446 static final int VIEW_STATE_WINDOW_FOCUSED = 1; 1447 static final int VIEW_STATE_SELECTED = 1 << 1; 1448 static final int VIEW_STATE_FOCUSED = 1 << 2; 1449 static final int VIEW_STATE_ENABLED = 1 << 3; 1450 static final int VIEW_STATE_PRESSED = 1 << 4; 1451 static final int VIEW_STATE_ACTIVATED = 1 << 5; 1452 static final int VIEW_STATE_ACCELERATED = 1 << 6; 1453 static final int VIEW_STATE_HOVERED = 1 << 7; 1454 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8; 1455 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9; 1456 1457 static final int[] VIEW_STATE_IDS = new int[] { 1458 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED, 1459 R.attr.state_selected, VIEW_STATE_SELECTED, 1460 R.attr.state_focused, VIEW_STATE_FOCUSED, 1461 R.attr.state_enabled, VIEW_STATE_ENABLED, 1462 R.attr.state_pressed, VIEW_STATE_PRESSED, 1463 R.attr.state_activated, VIEW_STATE_ACTIVATED, 1464 R.attr.state_accelerated, VIEW_STATE_ACCELERATED, 1465 R.attr.state_hovered, VIEW_STATE_HOVERED, 1466 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT, 1467 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED 1468 }; 1469 1470 static { 1471 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) { 1472 throw new IllegalStateException( 1473 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array"); 1474 } 1475 int[] orderedIds = new int[VIEW_STATE_IDS.length]; 1476 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) { 1477 int viewState = R.styleable.ViewDrawableStates[i]; 1478 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) { 1479 if (VIEW_STATE_IDS[j] == viewState) { 1480 orderedIds[i * 2] = viewState; 1481 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1]; 1482 } 1483 } 1484 } 1485 final int NUM_BITS = VIEW_STATE_IDS.length / 2; 1486 VIEW_STATE_SETS = new int[1 << NUM_BITS][]; 1487 for (int i = 0; i < VIEW_STATE_SETS.length; i++) { 1488 int numBits = Integer.bitCount(i); 1489 int[] set = new int[numBits]; 1490 int pos = 0; 1491 for (int j = 0; j < orderedIds.length; j += 2) { 1492 if ((i & orderedIds[j+1]) != 0) { 1493 set[pos++] = orderedIds[j]; 1494 } 1495 } 1496 VIEW_STATE_SETS[i] = set; 1497 } 1498 1499 EMPTY_STATE_SET = VIEW_STATE_SETS[0]; 1500 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED]; 1501 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED]; 1502 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1503 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED]; 1504 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED]; 1505 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1506 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED]; 1507 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1508 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED]; 1509 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1510 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1511 | VIEW_STATE_FOCUSED]; 1512 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED]; 1513 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1514 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED]; 1515 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1516 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED]; 1517 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1518 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1519 | VIEW_STATE_ENABLED]; 1520 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1521 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED]; 1522 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1523 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1524 | VIEW_STATE_ENABLED]; 1525 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1526 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1527 | VIEW_STATE_ENABLED]; 1528 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1529 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1530 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED]; 1531 1532 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED]; 1533 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1534 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED]; 1535 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1536 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED]; 1537 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1538 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1539 | VIEW_STATE_PRESSED]; 1540 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1541 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1542 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1543 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1544 | VIEW_STATE_PRESSED]; 1545 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1546 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1547 | VIEW_STATE_PRESSED]; 1548 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1549 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1550 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1551 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[ 1552 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1553 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1554 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED 1555 | VIEW_STATE_PRESSED]; 1556 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1557 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED 1558 | VIEW_STATE_PRESSED]; 1559 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1560 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1561 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1562 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1563 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED 1564 | VIEW_STATE_PRESSED]; 1565 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1566 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1567 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1568 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1569 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1570 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1571 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1572 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1573 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED 1574 | VIEW_STATE_PRESSED]; 1575 } 1576 1577 /** 1578 * Accessibility event types that are dispatched for text population. 1579 */ 1580 private static final int POPULATING_ACCESSIBILITY_EVENT_TYPES = 1581 AccessibilityEvent.TYPE_VIEW_CLICKED 1582 | AccessibilityEvent.TYPE_VIEW_LONG_CLICKED 1583 | AccessibilityEvent.TYPE_VIEW_SELECTED 1584 | AccessibilityEvent.TYPE_VIEW_FOCUSED 1585 | AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED 1586 | AccessibilityEvent.TYPE_VIEW_HOVER_ENTER 1587 | AccessibilityEvent.TYPE_VIEW_HOVER_EXIT 1588 | AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED 1589 | AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED 1590 | AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED 1591 | AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY; 1592 1593 /** 1594 * Temporary Rect currently for use in setBackground(). This will probably 1595 * be extended in the future to hold our own class with more than just 1596 * a Rect. :) 1597 */ 1598 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>(); 1599 1600 /** 1601 * Map used to store views' tags. 1602 */ 1603 private SparseArray<Object> mKeyedTags; 1604 1605 /** 1606 * The next available accessibility id. 1607 */ 1608 private static int sNextAccessibilityViewId; 1609 1610 /** 1611 * The animation currently associated with this view. 1612 * @hide 1613 */ 1614 protected Animation mCurrentAnimation = null; 1615 1616 /** 1617 * Width as measured during measure pass. 1618 * {@hide} 1619 */ 1620 @ViewDebug.ExportedProperty(category = "measurement") 1621 int mMeasuredWidth; 1622 1623 /** 1624 * Height as measured during measure pass. 1625 * {@hide} 1626 */ 1627 @ViewDebug.ExportedProperty(category = "measurement") 1628 int mMeasuredHeight; 1629 1630 /** 1631 * Flag to indicate that this view was marked INVALIDATED, or had its display list 1632 * invalidated, prior to the current drawing iteration. If true, the view must re-draw 1633 * its display list. This flag, used only when hw accelerated, allows us to clear the 1634 * flag while retaining this information until it's needed (at getDisplayList() time and 1635 * in drawChild(), when we decide to draw a view's children's display lists into our own). 1636 * 1637 * {@hide} 1638 */ 1639 boolean mRecreateDisplayList = false; 1640 1641 /** 1642 * The view's identifier. 1643 * {@hide} 1644 * 1645 * @see #setId(int) 1646 * @see #getId() 1647 */ 1648 @ViewDebug.ExportedProperty(resolveId = true) 1649 int mID = NO_ID; 1650 1651 /** 1652 * The stable ID of this view for accessibility purposes. 1653 */ 1654 int mAccessibilityViewId = NO_ID; 1655 1656 private int mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED; 1657 1658 SendViewStateChangedAccessibilityEvent mSendViewStateChangedAccessibilityEvent; 1659 1660 /** 1661 * The view's tag. 1662 * {@hide} 1663 * 1664 * @see #setTag(Object) 1665 * @see #getTag() 1666 */ 1667 protected Object mTag = null; 1668 1669 // for mPrivateFlags: 1670 /** {@hide} */ 1671 static final int PFLAG_WANTS_FOCUS = 0x00000001; 1672 /** {@hide} */ 1673 static final int PFLAG_FOCUSED = 0x00000002; 1674 /** {@hide} */ 1675 static final int PFLAG_SELECTED = 0x00000004; 1676 /** {@hide} */ 1677 static final int PFLAG_IS_ROOT_NAMESPACE = 0x00000008; 1678 /** {@hide} */ 1679 static final int PFLAG_HAS_BOUNDS = 0x00000010; 1680 /** {@hide} */ 1681 static final int PFLAG_DRAWN = 0x00000020; 1682 /** 1683 * When this flag is set, this view is running an animation on behalf of its 1684 * children and should therefore not cancel invalidate requests, even if they 1685 * lie outside of this view's bounds. 1686 * 1687 * {@hide} 1688 */ 1689 static final int PFLAG_DRAW_ANIMATION = 0x00000040; 1690 /** {@hide} */ 1691 static final int PFLAG_SKIP_DRAW = 0x00000080; 1692 /** {@hide} */ 1693 static final int PFLAG_ONLY_DRAWS_BACKGROUND = 0x00000100; 1694 /** {@hide} */ 1695 static final int PFLAG_REQUEST_TRANSPARENT_REGIONS = 0x00000200; 1696 /** {@hide} */ 1697 static final int PFLAG_DRAWABLE_STATE_DIRTY = 0x00000400; 1698 /** {@hide} */ 1699 static final int PFLAG_MEASURED_DIMENSION_SET = 0x00000800; 1700 /** {@hide} */ 1701 static final int PFLAG_FORCE_LAYOUT = 0x00001000; 1702 /** {@hide} */ 1703 static final int PFLAG_LAYOUT_REQUIRED = 0x00002000; 1704 1705 private static final int PFLAG_PRESSED = 0x00004000; 1706 1707 /** {@hide} */ 1708 static final int PFLAG_DRAWING_CACHE_VALID = 0x00008000; 1709 /** 1710 * Flag used to indicate that this view should be drawn once more (and only once 1711 * more) after its animation has completed. 1712 * {@hide} 1713 */ 1714 static final int PFLAG_ANIMATION_STARTED = 0x00010000; 1715 1716 private static final int PFLAG_SAVE_STATE_CALLED = 0x00020000; 1717 1718 /** 1719 * Indicates that the View returned true when onSetAlpha() was called and that 1720 * the alpha must be restored. 1721 * {@hide} 1722 */ 1723 static final int PFLAG_ALPHA_SET = 0x00040000; 1724 1725 /** 1726 * Set by {@link #setScrollContainer(boolean)}. 1727 */ 1728 static final int PFLAG_SCROLL_CONTAINER = 0x00080000; 1729 1730 /** 1731 * Set by {@link #setScrollContainer(boolean)}. 1732 */ 1733 static final int PFLAG_SCROLL_CONTAINER_ADDED = 0x00100000; 1734 1735 /** 1736 * View flag indicating whether this view was invalidated (fully or partially.) 1737 * 1738 * @hide 1739 */ 1740 static final int PFLAG_DIRTY = 0x00200000; 1741 1742 /** 1743 * View flag indicating whether this view was invalidated by an opaque 1744 * invalidate request. 1745 * 1746 * @hide 1747 */ 1748 static final int PFLAG_DIRTY_OPAQUE = 0x00400000; 1749 1750 /** 1751 * Mask for {@link #PFLAG_DIRTY} and {@link #PFLAG_DIRTY_OPAQUE}. 1752 * 1753 * @hide 1754 */ 1755 static final int PFLAG_DIRTY_MASK = 0x00600000; 1756 1757 /** 1758 * Indicates whether the background is opaque. 1759 * 1760 * @hide 1761 */ 1762 static final int PFLAG_OPAQUE_BACKGROUND = 0x00800000; 1763 1764 /** 1765 * Indicates whether the scrollbars are opaque. 1766 * 1767 * @hide 1768 */ 1769 static final int PFLAG_OPAQUE_SCROLLBARS = 0x01000000; 1770 1771 /** 1772 * Indicates whether the view is opaque. 1773 * 1774 * @hide 1775 */ 1776 static final int PFLAG_OPAQUE_MASK = 0x01800000; 1777 1778 /** 1779 * Indicates a prepressed state; 1780 * the short time between ACTION_DOWN and recognizing 1781 * a 'real' press. Prepressed is used to recognize quick taps 1782 * even when they are shorter than ViewConfiguration.getTapTimeout(). 1783 * 1784 * @hide 1785 */ 1786 private static final int PFLAG_PREPRESSED = 0x02000000; 1787 1788 /** 1789 * Indicates whether the view is temporarily detached. 1790 * 1791 * @hide 1792 */ 1793 static final int PFLAG_CANCEL_NEXT_UP_EVENT = 0x04000000; 1794 1795 /** 1796 * Indicates that we should awaken scroll bars once attached 1797 * 1798 * @hide 1799 */ 1800 private static final int PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000; 1801 1802 /** 1803 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT. 1804 * @hide 1805 */ 1806 private static final int PFLAG_HOVERED = 0x10000000; 1807 1808 /** 1809 * no longer needed, should be reused 1810 */ 1811 private static final int PFLAG_DOES_NOTHING_REUSE_PLEASE = 0x20000000; 1812 1813 /** {@hide} */ 1814 static final int PFLAG_ACTIVATED = 0x40000000; 1815 1816 /** 1817 * Indicates that this view was specifically invalidated, not just dirtied because some 1818 * child view was invalidated. The flag is used to determine when we need to recreate 1819 * a view's display list (as opposed to just returning a reference to its existing 1820 * display list). 1821 * 1822 * @hide 1823 */ 1824 static final int PFLAG_INVALIDATED = 0x80000000; 1825 1826 /** 1827 * Masks for mPrivateFlags2, as generated by dumpFlags(): 1828 * 1829 * |-------|-------|-------|-------| 1830 * 1 PFLAG2_DRAG_CAN_ACCEPT 1831 * 1 PFLAG2_DRAG_HOVERED 1832 * 11 PFLAG2_LAYOUT_DIRECTION_MASK 1833 * 1 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL 1834 * 1 PFLAG2_LAYOUT_DIRECTION_RESOLVED 1835 * 11 PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK 1836 * 1 PFLAG2_TEXT_DIRECTION_FLAGS[1] 1837 * 1 PFLAG2_TEXT_DIRECTION_FLAGS[2] 1838 * 11 PFLAG2_TEXT_DIRECTION_FLAGS[3] 1839 * 1 PFLAG2_TEXT_DIRECTION_FLAGS[4] 1840 * 1 1 PFLAG2_TEXT_DIRECTION_FLAGS[5] 1841 * 111 PFLAG2_TEXT_DIRECTION_MASK 1842 * 1 PFLAG2_TEXT_DIRECTION_RESOLVED 1843 * 1 PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT 1844 * 111 PFLAG2_TEXT_DIRECTION_RESOLVED_MASK 1845 * 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[1] 1846 * 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[2] 1847 * 11 PFLAG2_TEXT_ALIGNMENT_FLAGS[3] 1848 * 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[4] 1849 * 1 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[5] 1850 * 11 PFLAG2_TEXT_ALIGNMENT_FLAGS[6] 1851 * 111 PFLAG2_TEXT_ALIGNMENT_MASK 1852 * 1 PFLAG2_TEXT_ALIGNMENT_RESOLVED 1853 * 1 PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT 1854 * 111 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK 1855 * 111 PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK 1856 * 11 PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK 1857 * 1 PFLAG2_ACCESSIBILITY_FOCUSED 1858 * 1 PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED 1859 * 1 PFLAG2_VIEW_QUICK_REJECTED 1860 * 1 PFLAG2_PADDING_RESOLVED 1861 * 1 PFLAG2_DRAWABLE_RESOLVED 1862 * 1 PFLAG2_HAS_TRANSIENT_STATE 1863 * |-------|-------|-------|-------| 1864 */ 1865 1866 /** 1867 * Indicates that this view has reported that it can accept the current drag's content. 1868 * Cleared when the drag operation concludes. 1869 * @hide 1870 */ 1871 static final int PFLAG2_DRAG_CAN_ACCEPT = 0x00000001; 1872 1873 /** 1874 * Indicates that this view is currently directly under the drag location in a 1875 * drag-and-drop operation involving content that it can accept. Cleared when 1876 * the drag exits the view, or when the drag operation concludes. 1877 * @hide 1878 */ 1879 static final int PFLAG2_DRAG_HOVERED = 0x00000002; 1880 1881 /** @hide */ 1882 @IntDef({ 1883 LAYOUT_DIRECTION_LTR, 1884 LAYOUT_DIRECTION_RTL, 1885 LAYOUT_DIRECTION_INHERIT, 1886 LAYOUT_DIRECTION_LOCALE 1887 }) 1888 @Retention(RetentionPolicy.SOURCE) 1889 // Not called LayoutDirection to avoid conflict with android.util.LayoutDirection 1890 public @interface LayoutDir {} 1891 1892 /** @hide */ 1893 @IntDef({ 1894 LAYOUT_DIRECTION_LTR, 1895 LAYOUT_DIRECTION_RTL 1896 }) 1897 @Retention(RetentionPolicy.SOURCE) 1898 public @interface ResolvedLayoutDir {} 1899 1900 /** 1901 * Horizontal layout direction of this view is from Left to Right. 1902 * Use with {@link #setLayoutDirection}. 1903 */ 1904 public static final int LAYOUT_DIRECTION_LTR = LayoutDirection.LTR; 1905 1906 /** 1907 * Horizontal layout direction of this view is from Right to Left. 1908 * Use with {@link #setLayoutDirection}. 1909 */ 1910 public static final int LAYOUT_DIRECTION_RTL = LayoutDirection.RTL; 1911 1912 /** 1913 * Horizontal layout direction of this view is inherited from its parent. 1914 * Use with {@link #setLayoutDirection}. 1915 */ 1916 public static final int LAYOUT_DIRECTION_INHERIT = LayoutDirection.INHERIT; 1917 1918 /** 1919 * Horizontal layout direction of this view is from deduced from the default language 1920 * script for the locale. Use with {@link #setLayoutDirection}. 1921 */ 1922 public static final int LAYOUT_DIRECTION_LOCALE = LayoutDirection.LOCALE; 1923 1924 /** 1925 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 1926 * @hide 1927 */ 1928 static final int PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT = 2; 1929 1930 /** 1931 * Mask for use with private flags indicating bits used for horizontal layout direction. 1932 * @hide 1933 */ 1934 static final int PFLAG2_LAYOUT_DIRECTION_MASK = 0x00000003 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1935 1936 /** 1937 * Indicates whether the view horizontal layout direction has been resolved and drawn to the 1938 * right-to-left direction. 1939 * @hide 1940 */ 1941 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL = 4 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1942 1943 /** 1944 * Indicates whether the view horizontal layout direction has been resolved. 1945 * @hide 1946 */ 1947 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED = 8 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1948 1949 /** 1950 * Mask for use with private flags indicating bits used for resolved horizontal layout direction. 1951 * @hide 1952 */ 1953 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK = 0x0000000C 1954 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1955 1956 /* 1957 * Array of horizontal layout direction flags for mapping attribute "layoutDirection" to correct 1958 * flag value. 1959 * @hide 1960 */ 1961 private static final int[] LAYOUT_DIRECTION_FLAGS = { 1962 LAYOUT_DIRECTION_LTR, 1963 LAYOUT_DIRECTION_RTL, 1964 LAYOUT_DIRECTION_INHERIT, 1965 LAYOUT_DIRECTION_LOCALE 1966 }; 1967 1968 /** 1969 * Default horizontal layout direction. 1970 */ 1971 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT; 1972 1973 /** 1974 * Default horizontal layout direction. 1975 * @hide 1976 */ 1977 static final int LAYOUT_DIRECTION_RESOLVED_DEFAULT = LAYOUT_DIRECTION_LTR; 1978 1979 /** 1980 * Text direction is inherited thru {@link ViewGroup} 1981 */ 1982 public static final int TEXT_DIRECTION_INHERIT = 0; 1983 1984 /** 1985 * Text direction is using "first strong algorithm". The first strong directional character 1986 * determines the paragraph direction. If there is no strong directional character, the 1987 * paragraph direction is the view's resolved layout direction. 1988 */ 1989 public static final int TEXT_DIRECTION_FIRST_STRONG = 1; 1990 1991 /** 1992 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains 1993 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters. 1994 * If there are neither, the paragraph direction is the view's resolved layout direction. 1995 */ 1996 public static final int TEXT_DIRECTION_ANY_RTL = 2; 1997 1998 /** 1999 * Text direction is forced to LTR. 2000 */ 2001 public static final int TEXT_DIRECTION_LTR = 3; 2002 2003 /** 2004 * Text direction is forced to RTL. 2005 */ 2006 public static final int TEXT_DIRECTION_RTL = 4; 2007 2008 /** 2009 * Text direction is coming from the system Locale. 2010 */ 2011 public static final int TEXT_DIRECTION_LOCALE = 5; 2012 2013 /** 2014 * Default text direction is inherited 2015 */ 2016 private static final int TEXT_DIRECTION_DEFAULT = TEXT_DIRECTION_INHERIT; 2017 2018 /** 2019 * Default resolved text direction 2020 * @hide 2021 */ 2022 static final int TEXT_DIRECTION_RESOLVED_DEFAULT = TEXT_DIRECTION_FIRST_STRONG; 2023 2024 /** 2025 * Bit shift to get the horizontal layout direction. (bits after LAYOUT_DIRECTION_RESOLVED) 2026 * @hide 2027 */ 2028 static final int PFLAG2_TEXT_DIRECTION_MASK_SHIFT = 6; 2029 2030 /** 2031 * Mask for use with private flags indicating bits used for text direction. 2032 * @hide 2033 */ 2034 static final int PFLAG2_TEXT_DIRECTION_MASK = 0x00000007 2035 << PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 2036 2037 /** 2038 * Array of text direction flags for mapping attribute "textDirection" to correct 2039 * flag value. 2040 * @hide 2041 */ 2042 private static final int[] PFLAG2_TEXT_DIRECTION_FLAGS = { 2043 TEXT_DIRECTION_INHERIT << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 2044 TEXT_DIRECTION_FIRST_STRONG << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 2045 TEXT_DIRECTION_ANY_RTL << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 2046 TEXT_DIRECTION_LTR << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 2047 TEXT_DIRECTION_RTL << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 2048 TEXT_DIRECTION_LOCALE << PFLAG2_TEXT_DIRECTION_MASK_SHIFT 2049 }; 2050 2051 /** 2052 * Indicates whether the view text direction has been resolved. 2053 * @hide 2054 */ 2055 static final int PFLAG2_TEXT_DIRECTION_RESOLVED = 0x00000008 2056 << PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 2057 2058 /** 2059 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 2060 * @hide 2061 */ 2062 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT = 10; 2063 2064 /** 2065 * Mask for use with private flags indicating bits used for resolved text direction. 2066 * @hide 2067 */ 2068 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_MASK = 0x00000007 2069 << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 2070 2071 /** 2072 * Indicates whether the view text direction has been resolved to the "first strong" heuristic. 2073 * @hide 2074 */ 2075 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT = 2076 TEXT_DIRECTION_RESOLVED_DEFAULT << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 2077 2078 /** @hide */ 2079 @IntDef({ 2080 TEXT_ALIGNMENT_INHERIT, 2081 TEXT_ALIGNMENT_GRAVITY, 2082 TEXT_ALIGNMENT_CENTER, 2083 TEXT_ALIGNMENT_TEXT_START, 2084 TEXT_ALIGNMENT_TEXT_END, 2085 TEXT_ALIGNMENT_VIEW_START, 2086 TEXT_ALIGNMENT_VIEW_END 2087 }) 2088 @Retention(RetentionPolicy.SOURCE) 2089 public @interface TextAlignment {} 2090 2091 /** 2092 * Default text alignment. The text alignment of this View is inherited from its parent. 2093 * Use with {@link #setTextAlignment(int)} 2094 */ 2095 public static final int TEXT_ALIGNMENT_INHERIT = 0; 2096 2097 /** 2098 * Default for the root view. The gravity determines the text alignment, ALIGN_NORMAL, 2099 * ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph’s text direction. 2100 * 2101 * Use with {@link #setTextAlignment(int)} 2102 */ 2103 public static final int TEXT_ALIGNMENT_GRAVITY = 1; 2104 2105 /** 2106 * Align to the start of the paragraph, e.g. ALIGN_NORMAL. 2107 * 2108 * Use with {@link #setTextAlignment(int)} 2109 */ 2110 public static final int TEXT_ALIGNMENT_TEXT_START = 2; 2111 2112 /** 2113 * Align to the end of the paragraph, e.g. ALIGN_OPPOSITE. 2114 * 2115 * Use with {@link #setTextAlignment(int)} 2116 */ 2117 public static final int TEXT_ALIGNMENT_TEXT_END = 3; 2118 2119 /** 2120 * Center the paragraph, e.g. ALIGN_CENTER. 2121 * 2122 * Use with {@link #setTextAlignment(int)} 2123 */ 2124 public static final int TEXT_ALIGNMENT_CENTER = 4; 2125 2126 /** 2127 * Align to the start of the view, which is ALIGN_LEFT if the view’s resolved 2128 * layoutDirection is LTR, and ALIGN_RIGHT otherwise. 2129 * 2130 * Use with {@link #setTextAlignment(int)} 2131 */ 2132 public static final int TEXT_ALIGNMENT_VIEW_START = 5; 2133 2134 /** 2135 * Align to the end of the view, which is ALIGN_RIGHT if the view’s resolved 2136 * layoutDirection is LTR, and ALIGN_LEFT otherwise. 2137 * 2138 * Use with {@link #setTextAlignment(int)} 2139 */ 2140 public static final int TEXT_ALIGNMENT_VIEW_END = 6; 2141 2142 /** 2143 * Default text alignment is inherited 2144 */ 2145 private static final int TEXT_ALIGNMENT_DEFAULT = TEXT_ALIGNMENT_GRAVITY; 2146 2147 /** 2148 * Default resolved text alignment 2149 * @hide 2150 */ 2151 static final int TEXT_ALIGNMENT_RESOLVED_DEFAULT = TEXT_ALIGNMENT_GRAVITY; 2152 2153 /** 2154 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 2155 * @hide 2156 */ 2157 static final int PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT = 13; 2158 2159 /** 2160 * Mask for use with private flags indicating bits used for text alignment. 2161 * @hide 2162 */ 2163 static final int PFLAG2_TEXT_ALIGNMENT_MASK = 0x00000007 << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 2164 2165 /** 2166 * Array of text direction flags for mapping attribute "textAlignment" to correct 2167 * flag value. 2168 * @hide 2169 */ 2170 private static final int[] PFLAG2_TEXT_ALIGNMENT_FLAGS = { 2171 TEXT_ALIGNMENT_INHERIT << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2172 TEXT_ALIGNMENT_GRAVITY << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2173 TEXT_ALIGNMENT_TEXT_START << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2174 TEXT_ALIGNMENT_TEXT_END << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2175 TEXT_ALIGNMENT_CENTER << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2176 TEXT_ALIGNMENT_VIEW_START << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2177 TEXT_ALIGNMENT_VIEW_END << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT 2178 }; 2179 2180 /** 2181 * Indicates whether the view text alignment has been resolved. 2182 * @hide 2183 */ 2184 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED = 0x00000008 << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 2185 2186 /** 2187 * Bit shift to get the resolved text alignment. 2188 * @hide 2189 */ 2190 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT = 17; 2191 2192 /** 2193 * Mask for use with private flags indicating bits used for text alignment. 2194 * @hide 2195 */ 2196 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK = 0x00000007 2197 << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 2198 2199 /** 2200 * Indicates whether if the view text alignment has been resolved to gravity 2201 */ 2202 private static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT = 2203 TEXT_ALIGNMENT_RESOLVED_DEFAULT << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 2204 2205 // Accessiblity constants for mPrivateFlags2 2206 2207 /** 2208 * Shift for the bits in {@link #mPrivateFlags2} related to the 2209 * "importantForAccessibility" attribute. 2210 */ 2211 static final int PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT = 20; 2212 2213 /** 2214 * Automatically determine whether a view is important for accessibility. 2215 */ 2216 public static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0x00000000; 2217 2218 /** 2219 * The view is important for accessibility. 2220 */ 2221 public static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 0x00000001; 2222 2223 /** 2224 * The view is not important for accessibility. 2225 */ 2226 public static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 0x00000002; 2227 2228 /** 2229 * The view is not important for accessibility, nor are any of its 2230 * descendant views. 2231 */ 2232 public static final int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 0x00000004; 2233 2234 /** 2235 * The default whether the view is important for accessibility. 2236 */ 2237 static final int IMPORTANT_FOR_ACCESSIBILITY_DEFAULT = IMPORTANT_FOR_ACCESSIBILITY_AUTO; 2238 2239 /** 2240 * Mask for obtainig the bits which specify how to determine 2241 * whether a view is important for accessibility. 2242 */ 2243 static final int PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK = (IMPORTANT_FOR_ACCESSIBILITY_AUTO 2244 | IMPORTANT_FOR_ACCESSIBILITY_YES | IMPORTANT_FOR_ACCESSIBILITY_NO 2245 | IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) 2246 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2247 2248 /** 2249 * Shift for the bits in {@link #mPrivateFlags2} related to the 2250 * "accessibilityLiveRegion" attribute. 2251 */ 2252 static final int PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT = 23; 2253 2254 /** 2255 * Live region mode specifying that accessibility services should not 2256 * automatically announce changes to this view. This is the default live 2257 * region mode for most views. 2258 * <p> 2259 * Use with {@link #setAccessibilityLiveRegion(int)}. 2260 */ 2261 public static final int ACCESSIBILITY_LIVE_REGION_NONE = 0x00000000; 2262 2263 /** 2264 * Live region mode specifying that accessibility services should announce 2265 * changes to this view. 2266 * <p> 2267 * Use with {@link #setAccessibilityLiveRegion(int)}. 2268 */ 2269 public static final int ACCESSIBILITY_LIVE_REGION_POLITE = 0x00000001; 2270 2271 /** 2272 * Live region mode specifying that accessibility services should interrupt 2273 * ongoing speech to immediately announce changes to this view. 2274 * <p> 2275 * Use with {@link #setAccessibilityLiveRegion(int)}. 2276 */ 2277 public static final int ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 0x00000002; 2278 2279 /** 2280 * The default whether the view is important for accessibility. 2281 */ 2282 static final int ACCESSIBILITY_LIVE_REGION_DEFAULT = ACCESSIBILITY_LIVE_REGION_NONE; 2283 2284 /** 2285 * Mask for obtaining the bits which specify a view's accessibility live 2286 * region mode. 2287 */ 2288 static final int PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK = (ACCESSIBILITY_LIVE_REGION_NONE 2289 | ACCESSIBILITY_LIVE_REGION_POLITE | ACCESSIBILITY_LIVE_REGION_ASSERTIVE) 2290 << PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT; 2291 2292 /** 2293 * Flag indicating whether a view has accessibility focus. 2294 */ 2295 static final int PFLAG2_ACCESSIBILITY_FOCUSED = 0x04000000; 2296 2297 /** 2298 * Flag whether the accessibility state of the subtree rooted at this view changed. 2299 */ 2300 static final int PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED = 0x08000000; 2301 2302 /** 2303 * Flag indicating whether a view failed the quickReject() check in draw(). This condition 2304 * is used to check whether later changes to the view's transform should invalidate the 2305 * view to force the quickReject test to run again. 2306 */ 2307 static final int PFLAG2_VIEW_QUICK_REJECTED = 0x10000000; 2308 2309 /** 2310 * Flag indicating that start/end padding has been resolved into left/right padding 2311 * for use in measurement, layout, drawing, etc. This is set by {@link #resolvePadding()} 2312 * and checked by {@link #measure(int, int)} to determine if padding needs to be resolved 2313 * during measurement. In some special cases this is required such as when an adapter-based 2314 * view measures prospective children without attaching them to a window. 2315 */ 2316 static final int PFLAG2_PADDING_RESOLVED = 0x20000000; 2317 2318 /** 2319 * Flag indicating that the start/end drawables has been resolved into left/right ones. 2320 */ 2321 static final int PFLAG2_DRAWABLE_RESOLVED = 0x40000000; 2322 2323 /** 2324 * Indicates that the view is tracking some sort of transient state 2325 * that the app should not need to be aware of, but that the framework 2326 * should take special care to preserve. 2327 */ 2328 static final int PFLAG2_HAS_TRANSIENT_STATE = 0x80000000; 2329 2330 /** 2331 * Group of bits indicating that RTL properties resolution is done. 2332 */ 2333 static final int ALL_RTL_PROPERTIES_RESOLVED = PFLAG2_LAYOUT_DIRECTION_RESOLVED | 2334 PFLAG2_TEXT_DIRECTION_RESOLVED | 2335 PFLAG2_TEXT_ALIGNMENT_RESOLVED | 2336 PFLAG2_PADDING_RESOLVED | 2337 PFLAG2_DRAWABLE_RESOLVED; 2338 2339 // There are a couple of flags left in mPrivateFlags2 2340 2341 /* End of masks for mPrivateFlags2 */ 2342 2343 /** 2344 * Masks for mPrivateFlags3, as generated by dumpFlags(): 2345 * 2346 * |-------|-------|-------|-------| 2347 * 1 PFLAG3_VIEW_IS_ANIMATING_TRANSFORM 2348 * 1 PFLAG3_VIEW_IS_ANIMATING_ALPHA 2349 * 1 PFLAG3_IS_LAID_OUT 2350 * 1 PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT 2351 * 1 PFLAG3_CALLED_SUPER 2352 * |-------|-------|-------|-------| 2353 */ 2354 2355 /** 2356 * Flag indicating that view has a transform animation set on it. This is used to track whether 2357 * an animation is cleared between successive frames, in order to tell the associated 2358 * DisplayList to clear its animation matrix. 2359 */ 2360 static final int PFLAG3_VIEW_IS_ANIMATING_TRANSFORM = 0x1; 2361 2362 /** 2363 * Flag indicating that view has an alpha animation set on it. This is used to track whether an 2364 * animation is cleared between successive frames, in order to tell the associated 2365 * DisplayList to restore its alpha value. 2366 */ 2367 static final int PFLAG3_VIEW_IS_ANIMATING_ALPHA = 0x2; 2368 2369 /** 2370 * Flag indicating that the view has been through at least one layout since it 2371 * was last attached to a window. 2372 */ 2373 static final int PFLAG3_IS_LAID_OUT = 0x4; 2374 2375 /** 2376 * Flag indicating that a call to measure() was skipped and should be done 2377 * instead when layout() is invoked. 2378 */ 2379 static final int PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT = 0x8; 2380 2381 /** 2382 * Flag indicating that an overridden method correctly called down to 2383 * the superclass implementation as required by the API spec. 2384 */ 2385 static final int PFLAG3_CALLED_SUPER = 0x10; 2386 2387 /** 2388 * Flag indicating that we're in the process of applying window insets. 2389 */ 2390 static final int PFLAG3_APPLYING_INSETS = 0x20; 2391 2392 /** 2393 * Flag indicating that we're in the process of fitting system windows using the old method. 2394 */ 2395 static final int PFLAG3_FITTING_SYSTEM_WINDOWS = 0x40; 2396 2397 /** 2398 * Flag indicating that nested scrolling is enabled for this view. 2399 * The view will optionally cooperate with views up its parent chain to allow for 2400 * integrated nested scrolling along the same axis. 2401 */ 2402 static final int PFLAG3_NESTED_SCROLLING_ENABLED = 0x80; 2403 2404 /* End of masks for mPrivateFlags3 */ 2405 2406 static final int DRAG_MASK = PFLAG2_DRAG_CAN_ACCEPT | PFLAG2_DRAG_HOVERED; 2407 2408 /** 2409 * Always allow a user to over-scroll this view, provided it is a 2410 * view that can scroll. 2411 * 2412 * @see #getOverScrollMode() 2413 * @see #setOverScrollMode(int) 2414 */ 2415 public static final int OVER_SCROLL_ALWAYS = 0; 2416 2417 /** 2418 * Allow a user to over-scroll this view only if the content is large 2419 * enough to meaningfully scroll, provided it is a view that can scroll. 2420 * 2421 * @see #getOverScrollMode() 2422 * @see #setOverScrollMode(int) 2423 */ 2424 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1; 2425 2426 /** 2427 * Never allow a user to over-scroll this view. 2428 * 2429 * @see #getOverScrollMode() 2430 * @see #setOverScrollMode(int) 2431 */ 2432 public static final int OVER_SCROLL_NEVER = 2; 2433 2434 /** 2435 * Special constant for {@link #setSystemUiVisibility(int)}: View has 2436 * requested the system UI (status bar) to be visible (the default). 2437 * 2438 * @see #setSystemUiVisibility(int) 2439 */ 2440 public static final int SYSTEM_UI_FLAG_VISIBLE = 0; 2441 2442 /** 2443 * Flag for {@link #setSystemUiVisibility(int)}: View has requested the 2444 * system UI to enter an unobtrusive "low profile" mode. 2445 * 2446 * <p>This is for use in games, book readers, video players, or any other 2447 * "immersive" application where the usual system chrome is deemed too distracting. 2448 * 2449 * <p>In low profile mode, the status bar and/or navigation icons may dim. 2450 * 2451 * @see #setSystemUiVisibility(int) 2452 */ 2453 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001; 2454 2455 /** 2456 * Flag for {@link #setSystemUiVisibility(int)}: View has requested that the 2457 * system navigation be temporarily hidden. 2458 * 2459 * <p>This is an even less obtrusive state than that called for by 2460 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls 2461 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause 2462 * those to disappear. This is useful (in conjunction with the 2463 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and 2464 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN} 2465 * window flags) for displaying content using every last pixel on the display. 2466 * 2467 * <p>There is a limitation: because navigation controls are so important, the least user 2468 * interaction will cause them to reappear immediately. When this happens, both 2469 * this flag and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be cleared automatically, 2470 * so that both elements reappear at the same time. 2471 * 2472 * @see #setSystemUiVisibility(int) 2473 */ 2474 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002; 2475 2476 /** 2477 * Flag for {@link #setSystemUiVisibility(int)}: View has requested to go 2478 * into the normal fullscreen mode so that its content can take over the screen 2479 * while still allowing the user to interact with the application. 2480 * 2481 * <p>This has the same visual effect as 2482 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN 2483 * WindowManager.LayoutParams.FLAG_FULLSCREEN}, 2484 * meaning that non-critical screen decorations (such as the status bar) will be 2485 * hidden while the user is in the View's window, focusing the experience on 2486 * that content. Unlike the window flag, if you are using ActionBar in 2487 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY 2488 * Window.FEATURE_ACTION_BAR_OVERLAY}, then enabling this flag will also 2489 * hide the action bar. 2490 * 2491 * <p>This approach to going fullscreen is best used over the window flag when 2492 * it is a transient state -- that is, the application does this at certain 2493 * points in its user interaction where it wants to allow the user to focus 2494 * on content, but not as a continuous state. For situations where the application 2495 * would like to simply stay full screen the entire time (such as a game that 2496 * wants to take over the screen), the 2497 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN window flag} 2498 * is usually a better approach. The state set here will be removed by the system 2499 * in various situations (such as the user moving to another application) like 2500 * the other system UI states. 2501 * 2502 * <p>When using this flag, the application should provide some easy facility 2503 * for the user to go out of it. A common example would be in an e-book 2504 * reader, where tapping on the screen brings back whatever screen and UI 2505 * decorations that had been hidden while the user was immersed in reading 2506 * the book. 2507 * 2508 * @see #setSystemUiVisibility(int) 2509 */ 2510 public static final int SYSTEM_UI_FLAG_FULLSCREEN = 0x00000004; 2511 2512 /** 2513 * Flag for {@link #setSystemUiVisibility(int)}: When using other layout 2514 * flags, we would like a stable view of the content insets given to 2515 * {@link #fitSystemWindows(Rect)}. This means that the insets seen there 2516 * will always represent the worst case that the application can expect 2517 * as a continuous state. In the stock Android UI this is the space for 2518 * the system bar, nav bar, and status bar, but not more transient elements 2519 * such as an input method. 2520 * 2521 * The stable layout your UI sees is based on the system UI modes you can 2522 * switch to. That is, if you specify {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 2523 * then you will get a stable layout for changes of the 2524 * {@link #SYSTEM_UI_FLAG_FULLSCREEN} mode; if you specify 2525 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} and 2526 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, then you can transition 2527 * to {@link #SYSTEM_UI_FLAG_FULLSCREEN} and {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION} 2528 * with a stable layout. (Note that you should avoid using 2529 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} by itself.) 2530 * 2531 * If you have set the window flag {@link WindowManager.LayoutParams#FLAG_FULLSCREEN} 2532 * to hide the status bar (instead of using {@link #SYSTEM_UI_FLAG_FULLSCREEN}), 2533 * then a hidden status bar will be considered a "stable" state for purposes 2534 * here. This allows your UI to continually hide the status bar, while still 2535 * using the system UI flags to hide the action bar while still retaining 2536 * a stable layout. Note that changing the window fullscreen flag will never 2537 * provide a stable layout for a clean transition. 2538 * 2539 * <p>If you are using ActionBar in 2540 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY 2541 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the 2542 * insets it adds to those given to the application. 2543 */ 2544 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100; 2545 2546 /** 2547 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window 2548 * to be layed out as if it has requested 2549 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This 2550 * allows it to avoid artifacts when switching in and out of that mode, at 2551 * the expense that some of its user interface may be covered by screen 2552 * decorations when they are shown. You can perform layout of your inner 2553 * UI elements to account for the navigation system UI through the 2554 * {@link #fitSystemWindows(Rect)} method. 2555 */ 2556 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200; 2557 2558 /** 2559 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window 2560 * to be layed out as if it has requested 2561 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This 2562 * allows it to avoid artifacts when switching in and out of that mode, at 2563 * the expense that some of its user interface may be covered by screen 2564 * decorations when they are shown. You can perform layout of your inner 2565 * UI elements to account for non-fullscreen system UI through the 2566 * {@link #fitSystemWindows(Rect)} method. 2567 */ 2568 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400; 2569 2570 /** 2571 * Flag for {@link #setSystemUiVisibility(int)}: View would like to remain interactive when 2572 * hiding the navigation bar with {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}. If this flag is 2573 * not set, {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION} will be force cleared by the system on any 2574 * user interaction. 2575 * <p>Since this flag is a modifier for {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, it only 2576 * has an effect when used in combination with that flag.</p> 2577 */ 2578 public static final int SYSTEM_UI_FLAG_IMMERSIVE = 0x00000800; 2579 2580 /** 2581 * Flag for {@link #setSystemUiVisibility(int)}: View would like to remain interactive when 2582 * hiding the status bar with {@link #SYSTEM_UI_FLAG_FULLSCREEN} and/or hiding the navigation 2583 * bar with {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}. Use this flag to create an immersive 2584 * experience while also hiding the system bars. If this flag is not set, 2585 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION} will be force cleared by the system on any user 2586 * interaction, and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be force-cleared by the system 2587 * if the user swipes from the top of the screen. 2588 * <p>When system bars are hidden in immersive mode, they can be revealed temporarily with 2589 * system gestures, such as swiping from the top of the screen. These transient system bars 2590 * will overlay app’s content, may have some degree of transparency, and will automatically 2591 * hide after a short timeout. 2592 * </p><p>Since this flag is a modifier for {@link #SYSTEM_UI_FLAG_FULLSCREEN} and 2593 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, it only has an effect when used in combination 2594 * with one or both of those flags.</p> 2595 */ 2596 public static final int SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 0x00001000; 2597 2598 /** 2599 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead. 2600 */ 2601 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE; 2602 2603 /** 2604 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead. 2605 */ 2606 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE; 2607 2608 /** 2609 * @hide 2610 * 2611 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2612 * out of the public fields to keep the undefined bits out of the developer's way. 2613 * 2614 * Flag to make the status bar not expandable. Unless you also 2615 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show. 2616 */ 2617 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000; 2618 2619 /** 2620 * @hide 2621 * 2622 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2623 * out of the public fields to keep the undefined bits out of the developer's way. 2624 * 2625 * Flag to hide notification icons and scrolling ticker text. 2626 */ 2627 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000; 2628 2629 /** 2630 * @hide 2631 * 2632 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2633 * out of the public fields to keep the undefined bits out of the developer's way. 2634 * 2635 * Flag to disable incoming notification alerts. This will not block 2636 * icons, but it will block sound, vibrating and other visual or aural notifications. 2637 */ 2638 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000; 2639 2640 /** 2641 * @hide 2642 * 2643 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2644 * out of the public fields to keep the undefined bits out of the developer's way. 2645 * 2646 * Flag to hide only the scrolling ticker. Note that 2647 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies 2648 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}. 2649 */ 2650 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000; 2651 2652 /** 2653 * @hide 2654 * 2655 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2656 * out of the public fields to keep the undefined bits out of the developer's way. 2657 * 2658 * Flag to hide the center system info area. 2659 */ 2660 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000; 2661 2662 /** 2663 * @hide 2664 * 2665 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2666 * out of the public fields to keep the undefined bits out of the developer's way. 2667 * 2668 * Flag to hide only the home button. Don't use this 2669 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2670 */ 2671 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000; 2672 2673 /** 2674 * @hide 2675 * 2676 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2677 * out of the public fields to keep the undefined bits out of the developer's way. 2678 * 2679 * Flag to hide only the back button. Don't use this 2680 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2681 */ 2682 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000; 2683 2684 /** 2685 * @hide 2686 * 2687 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2688 * out of the public fields to keep the undefined bits out of the developer's way. 2689 * 2690 * Flag to hide only the clock. You might use this if your activity has 2691 * its own clock making the status bar's clock redundant. 2692 */ 2693 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000; 2694 2695 /** 2696 * @hide 2697 * 2698 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2699 * out of the public fields to keep the undefined bits out of the developer's way. 2700 * 2701 * Flag to hide only the recent apps button. Don't use this 2702 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2703 */ 2704 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000; 2705 2706 /** 2707 * @hide 2708 * 2709 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2710 * out of the public fields to keep the undefined bits out of the developer's way. 2711 * 2712 * Flag to disable the global search gesture. Don't use this 2713 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2714 */ 2715 public static final int STATUS_BAR_DISABLE_SEARCH = 0x02000000; 2716 2717 /** 2718 * @hide 2719 * 2720 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2721 * out of the public fields to keep the undefined bits out of the developer's way. 2722 * 2723 * Flag to specify that the status bar is displayed in transient mode. 2724 */ 2725 public static final int STATUS_BAR_TRANSIENT = 0x04000000; 2726 2727 /** 2728 * @hide 2729 * 2730 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2731 * out of the public fields to keep the undefined bits out of the developer's way. 2732 * 2733 * Flag to specify that the navigation bar is displayed in transient mode. 2734 */ 2735 public static final int NAVIGATION_BAR_TRANSIENT = 0x08000000; 2736 2737 /** 2738 * @hide 2739 * 2740 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2741 * out of the public fields to keep the undefined bits out of the developer's way. 2742 * 2743 * Flag to specify that the hidden status bar would like to be shown. 2744 */ 2745 public static final int STATUS_BAR_UNHIDE = 0x10000000; 2746 2747 /** 2748 * @hide 2749 * 2750 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2751 * out of the public fields to keep the undefined bits out of the developer's way. 2752 * 2753 * Flag to specify that the hidden navigation bar would like to be shown. 2754 */ 2755 public static final int NAVIGATION_BAR_UNHIDE = 0x20000000; 2756 2757 /** 2758 * @hide 2759 * 2760 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2761 * out of the public fields to keep the undefined bits out of the developer's way. 2762 * 2763 * Flag to specify that the status bar is displayed in translucent mode. 2764 */ 2765 public static final int STATUS_BAR_TRANSLUCENT = 0x40000000; 2766 2767 /** 2768 * @hide 2769 * 2770 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2771 * out of the public fields to keep the undefined bits out of the developer's way. 2772 * 2773 * Flag to specify that the navigation bar is displayed in translucent mode. 2774 */ 2775 public static final int NAVIGATION_BAR_TRANSLUCENT = 0x80000000; 2776 2777 /** 2778 * @hide 2779 * 2780 * Whether Recents is visible or not. 2781 */ 2782 public static final int RECENT_APPS_VISIBLE = 0x00004000; 2783 2784 /** 2785 * @hide 2786 * 2787 * Makes system ui transparent. 2788 */ 2789 public static final int SYSTEM_UI_TRANSPARENT = 0x00008000; 2790 2791 /** 2792 * @hide 2793 */ 2794 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x00003FFF; 2795 2796 /** 2797 * These are the system UI flags that can be cleared by events outside 2798 * of an application. Currently this is just the ability to tap on the 2799 * screen while hiding the navigation bar to have it return. 2800 * @hide 2801 */ 2802 public static final int SYSTEM_UI_CLEARABLE_FLAGS = 2803 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION 2804 | SYSTEM_UI_FLAG_FULLSCREEN; 2805 2806 /** 2807 * Flags that can impact the layout in relation to system UI. 2808 */ 2809 public static final int SYSTEM_UI_LAYOUT_FLAGS = 2810 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION 2811 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN; 2812 2813 /** @hide */ 2814 @IntDef(flag = true, 2815 value = { FIND_VIEWS_WITH_TEXT, FIND_VIEWS_WITH_CONTENT_DESCRIPTION }) 2816 @Retention(RetentionPolicy.SOURCE) 2817 public @interface FindViewFlags {} 2818 2819 /** 2820 * Find views that render the specified text. 2821 * 2822 * @see #findViewsWithText(ArrayList, CharSequence, int) 2823 */ 2824 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001; 2825 2826 /** 2827 * Find find views that contain the specified content description. 2828 * 2829 * @see #findViewsWithText(ArrayList, CharSequence, int) 2830 */ 2831 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002; 2832 2833 /** 2834 * Find views that contain {@link AccessibilityNodeProvider}. Such 2835 * a View is a root of virtual view hierarchy and may contain the searched 2836 * text. If this flag is set Views with providers are automatically 2837 * added and it is a responsibility of the client to call the APIs of 2838 * the provider to determine whether the virtual tree rooted at this View 2839 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s 2840 * representing the virtual views with this text. 2841 * 2842 * @see #findViewsWithText(ArrayList, CharSequence, int) 2843 * 2844 * @hide 2845 */ 2846 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004; 2847 2848 /** 2849 * The undefined cursor position. 2850 * 2851 * @hide 2852 */ 2853 public static final int ACCESSIBILITY_CURSOR_POSITION_UNDEFINED = -1; 2854 2855 /** 2856 * Indicates that the screen has changed state and is now off. 2857 * 2858 * @see #onScreenStateChanged(int) 2859 */ 2860 public static final int SCREEN_STATE_OFF = 0x0; 2861 2862 /** 2863 * Indicates that the screen has changed state and is now on. 2864 * 2865 * @see #onScreenStateChanged(int) 2866 */ 2867 public static final int SCREEN_STATE_ON = 0x1; 2868 2869 /** 2870 * Indicates no axis of view scrolling. 2871 */ 2872 public static final int SCROLL_AXIS_NONE = 0; 2873 2874 /** 2875 * Indicates scrolling along the horizontal axis. 2876 */ 2877 public static final int SCROLL_AXIS_HORIZONTAL = 1 << 0; 2878 2879 /** 2880 * Indicates scrolling along the vertical axis. 2881 */ 2882 public static final int SCROLL_AXIS_VERTICAL = 1 << 1; 2883 2884 /** 2885 * Controls the over-scroll mode for this view. 2886 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)}, 2887 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}, 2888 * and {@link #OVER_SCROLL_NEVER}. 2889 */ 2890 private int mOverScrollMode; 2891 2892 /** 2893 * The parent this view is attached to. 2894 * {@hide} 2895 * 2896 * @see #getParent() 2897 */ 2898 protected ViewParent mParent; 2899 2900 /** 2901 * {@hide} 2902 */ 2903 AttachInfo mAttachInfo; 2904 2905 /** 2906 * {@hide} 2907 */ 2908 @ViewDebug.ExportedProperty(flagMapping = { 2909 @ViewDebug.FlagToString(mask = PFLAG_FORCE_LAYOUT, equals = PFLAG_FORCE_LAYOUT, 2910 name = "FORCE_LAYOUT"), 2911 @ViewDebug.FlagToString(mask = PFLAG_LAYOUT_REQUIRED, equals = PFLAG_LAYOUT_REQUIRED, 2912 name = "LAYOUT_REQUIRED"), 2913 @ViewDebug.FlagToString(mask = PFLAG_DRAWING_CACHE_VALID, equals = PFLAG_DRAWING_CACHE_VALID, 2914 name = "DRAWING_CACHE_INVALID", outputIf = false), 2915 @ViewDebug.FlagToString(mask = PFLAG_DRAWN, equals = PFLAG_DRAWN, name = "DRAWN", outputIf = true), 2916 @ViewDebug.FlagToString(mask = PFLAG_DRAWN, equals = PFLAG_DRAWN, name = "NOT_DRAWN", outputIf = false), 2917 @ViewDebug.FlagToString(mask = PFLAG_DIRTY_MASK, equals = PFLAG_DIRTY_OPAQUE, name = "DIRTY_OPAQUE"), 2918 @ViewDebug.FlagToString(mask = PFLAG_DIRTY_MASK, equals = PFLAG_DIRTY, name = "DIRTY") 2919 }, formatToHexString = true) 2920 int mPrivateFlags; 2921 int mPrivateFlags2; 2922 int mPrivateFlags3; 2923 2924 /** 2925 * This view's request for the visibility of the status bar. 2926 * @hide 2927 */ 2928 @ViewDebug.ExportedProperty(flagMapping = { 2929 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE, 2930 equals = SYSTEM_UI_FLAG_LOW_PROFILE, 2931 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true), 2932 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2933 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2934 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true), 2935 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK, 2936 equals = SYSTEM_UI_FLAG_VISIBLE, 2937 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true) 2938 }, formatToHexString = true) 2939 int mSystemUiVisibility; 2940 2941 /** 2942 * Reference count for transient state. 2943 * @see #setHasTransientState(boolean) 2944 */ 2945 int mTransientStateCount = 0; 2946 2947 /** 2948 * Count of how many windows this view has been attached to. 2949 */ 2950 int mWindowAttachCount; 2951 2952 /** 2953 * The layout parameters associated with this view and used by the parent 2954 * {@link android.view.ViewGroup} to determine how this view should be 2955 * laid out. 2956 * {@hide} 2957 */ 2958 protected ViewGroup.LayoutParams mLayoutParams; 2959 2960 /** 2961 * The view flags hold various views states. 2962 * {@hide} 2963 */ 2964 @ViewDebug.ExportedProperty(formatToHexString = true) 2965 int mViewFlags; 2966 2967 static class TransformationInfo { 2968 /** 2969 * The transform matrix for the View. This transform is calculated internally 2970 * based on the translation, rotation, and scale properties. 2971 * 2972 * Do *not* use this variable directly; instead call getMatrix(), which will 2973 * load the value from the View's RenderNode. 2974 */ 2975 private final Matrix mMatrix = new Matrix(); 2976 2977 /** 2978 * The inverse transform matrix for the View. This transform is calculated 2979 * internally based on the translation, rotation, and scale properties. 2980 * 2981 * Do *not* use this variable directly; instead call getInverseMatrix(), 2982 * which will load the value from the View's RenderNode. 2983 */ 2984 private Matrix mInverseMatrix; 2985 2986 /** 2987 * The opacity of the View. This is a value from 0 to 1, where 0 means 2988 * completely transparent and 1 means completely opaque. 2989 */ 2990 @ViewDebug.ExportedProperty 2991 float mAlpha = 1f; 2992 2993 /** 2994 * The opacity of the view as manipulated by the Fade transition. This is a hidden 2995 * property only used by transitions, which is composited with the other alpha 2996 * values to calculate the final visual alpha value. 2997 */ 2998 float mTransitionAlpha = 1f; 2999 } 3000 3001 TransformationInfo mTransformationInfo; 3002 3003 /** 3004 * Current clip bounds. to which all drawing of this view are constrained. 3005 */ 3006 Rect mClipBounds = null; 3007 3008 private boolean mLastIsOpaque; 3009 3010 /** 3011 * The distance in pixels from the left edge of this view's parent 3012 * to the left edge of this view. 3013 * {@hide} 3014 */ 3015 @ViewDebug.ExportedProperty(category = "layout") 3016 protected int mLeft; 3017 /** 3018 * The distance in pixels from the left edge of this view's parent 3019 * to the right edge of this view. 3020 * {@hide} 3021 */ 3022 @ViewDebug.ExportedProperty(category = "layout") 3023 protected int mRight; 3024 /** 3025 * The distance in pixels from the top edge of this view's parent 3026 * to the top edge of this view. 3027 * {@hide} 3028 */ 3029 @ViewDebug.ExportedProperty(category = "layout") 3030 protected int mTop; 3031 /** 3032 * The distance in pixels from the top edge of this view's parent 3033 * to the bottom edge of this view. 3034 * {@hide} 3035 */ 3036 @ViewDebug.ExportedProperty(category = "layout") 3037 protected int mBottom; 3038 3039 /** 3040 * The offset, in pixels, by which the content of this view is scrolled 3041 * horizontally. 3042 * {@hide} 3043 */ 3044 @ViewDebug.ExportedProperty(category = "scrolling") 3045 protected int mScrollX; 3046 /** 3047 * The offset, in pixels, by which the content of this view is scrolled 3048 * vertically. 3049 * {@hide} 3050 */ 3051 @ViewDebug.ExportedProperty(category = "scrolling") 3052 protected int mScrollY; 3053 3054 /** 3055 * The left padding in pixels, that is the distance in pixels between the 3056 * left edge of this view and the left edge of its content. 3057 * {@hide} 3058 */ 3059 @ViewDebug.ExportedProperty(category = "padding") 3060 protected int mPaddingLeft = 0; 3061 /** 3062 * The right padding in pixels, that is the distance in pixels between the 3063 * right edge of this view and the right edge of its content. 3064 * {@hide} 3065 */ 3066 @ViewDebug.ExportedProperty(category = "padding") 3067 protected int mPaddingRight = 0; 3068 /** 3069 * The top padding in pixels, that is the distance in pixels between the 3070 * top edge of this view and the top edge of its content. 3071 * {@hide} 3072 */ 3073 @ViewDebug.ExportedProperty(category = "padding") 3074 protected int mPaddingTop; 3075 /** 3076 * The bottom padding in pixels, that is the distance in pixels between the 3077 * bottom edge of this view and the bottom edge of its content. 3078 * {@hide} 3079 */ 3080 @ViewDebug.ExportedProperty(category = "padding") 3081 protected int mPaddingBottom; 3082 3083 /** 3084 * The layout insets in pixels, that is the distance in pixels between the 3085 * visible edges of this view its bounds. 3086 */ 3087 private Insets mLayoutInsets; 3088 3089 /** 3090 * Briefly describes the view and is primarily used for accessibility support. 3091 */ 3092 private CharSequence mContentDescription; 3093 3094 /** 3095 * Specifies the id of a view for which this view serves as a label for 3096 * accessibility purposes. 3097 */ 3098 private int mLabelForId = View.NO_ID; 3099 3100 /** 3101 * Predicate for matching labeled view id with its label for 3102 * accessibility purposes. 3103 */ 3104 private MatchLabelForPredicate mMatchLabelForPredicate; 3105 3106 /** 3107 * Specifies a view before which this one is visited in accessibility traversal. 3108 */ 3109 private int mAccessibilityTraversalBeforeId = NO_ID; 3110 3111 /** 3112 * Specifies a view after which this one is visited in accessibility traversal. 3113 */ 3114 private int mAccessibilityTraversalAfterId = NO_ID; 3115 3116 /** 3117 * Predicate for matching a view by its id. 3118 */ 3119 private MatchIdPredicate mMatchIdPredicate; 3120 3121 /** 3122 * Cache the paddingRight set by the user to append to the scrollbar's size. 3123 * 3124 * @hide 3125 */ 3126 @ViewDebug.ExportedProperty(category = "padding") 3127 protected int mUserPaddingRight; 3128 3129 /** 3130 * Cache the paddingBottom set by the user to append to the scrollbar's size. 3131 * 3132 * @hide 3133 */ 3134 @ViewDebug.ExportedProperty(category = "padding") 3135 protected int mUserPaddingBottom; 3136 3137 /** 3138 * Cache the paddingLeft set by the user to append to the scrollbar's size. 3139 * 3140 * @hide 3141 */ 3142 @ViewDebug.ExportedProperty(category = "padding") 3143 protected int mUserPaddingLeft; 3144 3145 /** 3146 * Cache the paddingStart set by the user to append to the scrollbar's size. 3147 * 3148 */ 3149 @ViewDebug.ExportedProperty(category = "padding") 3150 int mUserPaddingStart; 3151 3152 /** 3153 * Cache the paddingEnd set by the user to append to the scrollbar's size. 3154 * 3155 */ 3156 @ViewDebug.ExportedProperty(category = "padding") 3157 int mUserPaddingEnd; 3158 3159 /** 3160 * Cache initial left padding. 3161 * 3162 * @hide 3163 */ 3164 int mUserPaddingLeftInitial; 3165 3166 /** 3167 * Cache initial right padding. 3168 * 3169 * @hide 3170 */ 3171 int mUserPaddingRightInitial; 3172 3173 /** 3174 * Default undefined padding 3175 */ 3176 private static final int UNDEFINED_PADDING = Integer.MIN_VALUE; 3177 3178 /** 3179 * Cache if a left padding has been defined 3180 */ 3181 private boolean mLeftPaddingDefined = false; 3182 3183 /** 3184 * Cache if a right padding has been defined 3185 */ 3186 private boolean mRightPaddingDefined = false; 3187 3188 /** 3189 * @hide 3190 */ 3191 int mOldWidthMeasureSpec = Integer.MIN_VALUE; 3192 /** 3193 * @hide 3194 */ 3195 int mOldHeightMeasureSpec = Integer.MIN_VALUE; 3196 3197 private LongSparseLongArray mMeasureCache; 3198 3199 @ViewDebug.ExportedProperty(deepExport = true, prefix = "bg_") 3200 private Drawable mBackground; 3201 private TintInfo mBackgroundTint; 3202 3203 /** 3204 * RenderNode used for backgrounds. 3205 * <p> 3206 * When non-null and valid, this is expected to contain an up-to-date copy 3207 * of the background drawable. It is cleared on temporary detach, and reset 3208 * on cleanup. 3209 */ 3210 private RenderNode mBackgroundRenderNode; 3211 3212 private int mBackgroundResource; 3213 private boolean mBackgroundSizeChanged; 3214 3215 private String mTransitionName; 3216 3217 private static class TintInfo { 3218 ColorStateList mTintList; 3219 PorterDuff.Mode mTintMode; 3220 boolean mHasTintMode; 3221 boolean mHasTintList; 3222 } 3223 3224 static class ListenerInfo { 3225 /** 3226 * Listener used to dispatch focus change events. 3227 * This field should be made private, so it is hidden from the SDK. 3228 * {@hide} 3229 */ 3230 protected OnFocusChangeListener mOnFocusChangeListener; 3231 3232 /** 3233 * Listeners for layout change events. 3234 */ 3235 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners; 3236 3237 protected OnScrollChangeListener mOnScrollChangeListener; 3238 3239 /** 3240 * Listeners for attach events. 3241 */ 3242 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners; 3243 3244 /** 3245 * Listener used to dispatch click events. 3246 * This field should be made private, so it is hidden from the SDK. 3247 * {@hide} 3248 */ 3249 public OnClickListener mOnClickListener; 3250 3251 /** 3252 * Listener used to dispatch long click events. 3253 * This field should be made private, so it is hidden from the SDK. 3254 * {@hide} 3255 */ 3256 protected OnLongClickListener mOnLongClickListener; 3257 3258 /** 3259 * Listener used to build the context menu. 3260 * This field should be made private, so it is hidden from the SDK. 3261 * {@hide} 3262 */ 3263 protected OnCreateContextMenuListener mOnCreateContextMenuListener; 3264 3265 private OnKeyListener mOnKeyListener; 3266 3267 private OnTouchListener mOnTouchListener; 3268 3269 private OnHoverListener mOnHoverListener; 3270 3271 private OnGenericMotionListener mOnGenericMotionListener; 3272 3273 private OnDragListener mOnDragListener; 3274 3275 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener; 3276 3277 OnApplyWindowInsetsListener mOnApplyWindowInsetsListener; 3278 } 3279 3280 ListenerInfo mListenerInfo; 3281 3282 /** 3283 * The application environment this view lives in. 3284 * This field should be made private, so it is hidden from the SDK. 3285 * {@hide} 3286 */ 3287 @ViewDebug.ExportedProperty(deepExport = true) 3288 protected Context mContext; 3289 3290 private final Resources mResources; 3291 3292 private ScrollabilityCache mScrollCache; 3293 3294 private int[] mDrawableState = null; 3295 3296 ViewOutlineProvider mOutlineProvider = ViewOutlineProvider.BACKGROUND; 3297 3298 /** 3299 * Animator that automatically runs based on state changes. 3300 */ 3301 private StateListAnimator mStateListAnimator; 3302 3303 /** 3304 * When this view has focus and the next focus is {@link #FOCUS_LEFT}, 3305 * the user may specify which view to go to next. 3306 */ 3307 private int mNextFocusLeftId = View.NO_ID; 3308 3309 /** 3310 * When this view has focus and the next focus is {@link #FOCUS_RIGHT}, 3311 * the user may specify which view to go to next. 3312 */ 3313 private int mNextFocusRightId = View.NO_ID; 3314 3315 /** 3316 * When this view has focus and the next focus is {@link #FOCUS_UP}, 3317 * the user may specify which view to go to next. 3318 */ 3319 private int mNextFocusUpId = View.NO_ID; 3320 3321 /** 3322 * When this view has focus and the next focus is {@link #FOCUS_DOWN}, 3323 * the user may specify which view to go to next. 3324 */ 3325 private int mNextFocusDownId = View.NO_ID; 3326 3327 /** 3328 * When this view has focus and the next focus is {@link #FOCUS_FORWARD}, 3329 * the user may specify which view to go to next. 3330 */ 3331 int mNextFocusForwardId = View.NO_ID; 3332 3333 private CheckForLongPress mPendingCheckForLongPress; 3334 private CheckForTap mPendingCheckForTap = null; 3335 private PerformClick mPerformClick; 3336 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent; 3337 3338 private UnsetPressedState mUnsetPressedState; 3339 3340 /** 3341 * Whether the long press's action has been invoked. The tap's action is invoked on the 3342 * up event while a long press is invoked as soon as the long press duration is reached, so 3343 * a long press could be performed before the tap is checked, in which case the tap's action 3344 * should not be invoked. 3345 */ 3346 private boolean mHasPerformedLongPress; 3347 3348 /** 3349 * The minimum height of the view. We'll try our best to have the height 3350 * of this view to at least this amount. 3351 */ 3352 @ViewDebug.ExportedProperty(category = "measurement") 3353 private int mMinHeight; 3354 3355 /** 3356 * The minimum width of the view. We'll try our best to have the width 3357 * of this view to at least this amount. 3358 */ 3359 @ViewDebug.ExportedProperty(category = "measurement") 3360 private int mMinWidth; 3361 3362 /** 3363 * The delegate to handle touch events that are physically in this view 3364 * but should be handled by another view. 3365 */ 3366 private TouchDelegate mTouchDelegate = null; 3367 3368 /** 3369 * Solid color to use as a background when creating the drawing cache. Enables 3370 * the cache to use 16 bit bitmaps instead of 32 bit. 3371 */ 3372 private int mDrawingCacheBackgroundColor = 0; 3373 3374 /** 3375 * Special tree observer used when mAttachInfo is null. 3376 */ 3377 private ViewTreeObserver mFloatingTreeObserver; 3378 3379 /** 3380 * Cache the touch slop from the context that created the view. 3381 */ 3382 private int mTouchSlop; 3383 3384 /** 3385 * Object that handles automatic animation of view properties. 3386 */ 3387 private ViewPropertyAnimator mAnimator = null; 3388 3389 /** 3390 * Flag indicating that a drag can cross window boundaries. When 3391 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called 3392 * with this flag set, all visible applications will be able to participate 3393 * in the drag operation and receive the dragged content. 3394 * 3395 * @hide 3396 */ 3397 public static final int DRAG_FLAG_GLOBAL = 1; 3398 3399 /** 3400 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}. 3401 */ 3402 private float mVerticalScrollFactor; 3403 3404 /** 3405 * Position of the vertical scroll bar. 3406 */ 3407 private int mVerticalScrollbarPosition; 3408 3409 /** 3410 * Position the scroll bar at the default position as determined by the system. 3411 */ 3412 public static final int SCROLLBAR_POSITION_DEFAULT = 0; 3413 3414 /** 3415 * Position the scroll bar along the left edge. 3416 */ 3417 public static final int SCROLLBAR_POSITION_LEFT = 1; 3418 3419 /** 3420 * Position the scroll bar along the right edge. 3421 */ 3422 public static final int SCROLLBAR_POSITION_RIGHT = 2; 3423 3424 /** 3425 * Indicates that the view does not have a layer. 3426 * 3427 * @see #getLayerType() 3428 * @see #setLayerType(int, android.graphics.Paint) 3429 * @see #LAYER_TYPE_SOFTWARE 3430 * @see #LAYER_TYPE_HARDWARE 3431 */ 3432 public static final int LAYER_TYPE_NONE = 0; 3433 3434 /** 3435 * <p>Indicates that the view has a software layer. A software layer is backed 3436 * by a bitmap and causes the view to be rendered using Android's software 3437 * rendering pipeline, even if hardware acceleration is enabled.</p> 3438 * 3439 * <p>Software layers have various usages:</p> 3440 * <p>When the application is not using hardware acceleration, a software layer 3441 * is useful to apply a specific color filter and/or blending mode and/or 3442 * translucency to a view and all its children.</p> 3443 * <p>When the application is using hardware acceleration, a software layer 3444 * is useful to render drawing primitives not supported by the hardware 3445 * accelerated pipeline. It can also be used to cache a complex view tree 3446 * into a texture and reduce the complexity of drawing operations. For instance, 3447 * when animating a complex view tree with a translation, a software layer can 3448 * be used to render the view tree only once.</p> 3449 * <p>Software layers should be avoided when the affected view tree updates 3450 * often. Every update will require to re-render the software layer, which can 3451 * potentially be slow (particularly when hardware acceleration is turned on 3452 * since the layer will have to be uploaded into a hardware texture after every 3453 * update.)</p> 3454 * 3455 * @see #getLayerType() 3456 * @see #setLayerType(int, android.graphics.Paint) 3457 * @see #LAYER_TYPE_NONE 3458 * @see #LAYER_TYPE_HARDWARE 3459 */ 3460 public static final int LAYER_TYPE_SOFTWARE = 1; 3461 3462 /** 3463 * <p>Indicates that the view has a hardware layer. A hardware layer is backed 3464 * by a hardware specific texture (generally Frame Buffer Objects or FBO on 3465 * OpenGL hardware) and causes the view to be rendered using Android's hardware 3466 * rendering pipeline, but only if hardware acceleration is turned on for the 3467 * view hierarchy. When hardware acceleration is turned off, hardware layers 3468 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p> 3469 * 3470 * <p>A hardware layer is useful to apply a specific color filter and/or 3471 * blending mode and/or translucency to a view and all its children.</p> 3472 * <p>A hardware layer can be used to cache a complex view tree into a 3473 * texture and reduce the complexity of drawing operations. For instance, 3474 * when animating a complex view tree with a translation, a hardware layer can 3475 * be used to render the view tree only once.</p> 3476 * <p>A hardware layer can also be used to increase the rendering quality when 3477 * rotation transformations are applied on a view. It can also be used to 3478 * prevent potential clipping issues when applying 3D transforms on a view.</p> 3479 * 3480 * @see #getLayerType() 3481 * @see #setLayerType(int, android.graphics.Paint) 3482 * @see #LAYER_TYPE_NONE 3483 * @see #LAYER_TYPE_SOFTWARE 3484 */ 3485 public static final int LAYER_TYPE_HARDWARE = 2; 3486 3487 @ViewDebug.ExportedProperty(category = "drawing", mapping = { 3488 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"), 3489 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"), 3490 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE") 3491 }) 3492 int mLayerType = LAYER_TYPE_NONE; 3493 Paint mLayerPaint; 3494 3495 /** 3496 * Set to true when drawing cache is enabled and cannot be created. 3497 * 3498 * @hide 3499 */ 3500 public boolean mCachingFailed; 3501 private Bitmap mDrawingCache; 3502 private Bitmap mUnscaledDrawingCache; 3503 3504 /** 3505 * RenderNode holding View properties, potentially holding a DisplayList of View content. 3506 * <p> 3507 * When non-null and valid, this is expected to contain an up-to-date copy 3508 * of the View content. Its DisplayList content is cleared on temporary detach and reset on 3509 * cleanup. 3510 */ 3511 final RenderNode mRenderNode; 3512 3513 /** 3514 * Set to true when the view is sending hover accessibility events because it 3515 * is the innermost hovered view. 3516 */ 3517 private boolean mSendingHoverAccessibilityEvents; 3518 3519 /** 3520 * Delegate for injecting accessibility functionality. 3521 */ 3522 AccessibilityDelegate mAccessibilityDelegate; 3523 3524 /** 3525 * The view's overlay layer. Developers get a reference to the overlay via getOverlay() 3526 * and add/remove objects to/from the overlay directly through the Overlay methods. 3527 */ 3528 ViewOverlay mOverlay; 3529 3530 /** 3531 * The currently active parent view for receiving delegated nested scrolling events. 3532 * This is set by {@link #startNestedScroll(int)} during a touch interaction and cleared 3533 * by {@link #stopNestedScroll()} at the same point where we clear 3534 * requestDisallowInterceptTouchEvent. 3535 */ 3536 private ViewParent mNestedScrollingParent; 3537 3538 /** 3539 * Consistency verifier for debugging purposes. 3540 * @hide 3541 */ 3542 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier = 3543 InputEventConsistencyVerifier.isInstrumentationEnabled() ? 3544 new InputEventConsistencyVerifier(this, 0) : null; 3545 3546 private static final AtomicInteger sNextGeneratedId = new AtomicInteger(1); 3547 3548 private int[] mTempNestedScrollConsumed; 3549 3550 /** 3551 * An overlay is going to draw this View instead of being drawn as part of this 3552 * View's parent. mGhostView is the View in the Overlay that must be invalidated 3553 * when this view is invalidated. 3554 */ 3555 GhostView mGhostView; 3556 3557 /** 3558 * Holds pairs of adjacent attribute data: attribute name followed by its value. 3559 * @hide 3560 */ 3561 @ViewDebug.ExportedProperty(category = "attributes", hasAdjacentMapping = true) 3562 public String[] mAttributes; 3563 3564 /** 3565 * Maps a Resource id to its name. 3566 */ 3567 private static SparseArray<String> mAttributeMap; 3568 3569 /** 3570 * Simple constructor to use when creating a view from code. 3571 * 3572 * @param context The Context the view is running in, through which it can 3573 * access the current theme, resources, etc. 3574 */ 3575 public View(Context context) { 3576 mContext = context; 3577 mResources = context != null ? context.getResources() : null; 3578 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED; 3579 // Set some flags defaults 3580 mPrivateFlags2 = 3581 (LAYOUT_DIRECTION_DEFAULT << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) | 3582 (TEXT_DIRECTION_DEFAULT << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) | 3583 (PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT) | 3584 (TEXT_ALIGNMENT_DEFAULT << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) | 3585 (PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT) | 3586 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT); 3587 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop(); 3588 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS); 3589 mUserPaddingStart = UNDEFINED_PADDING; 3590 mUserPaddingEnd = UNDEFINED_PADDING; 3591 mRenderNode = RenderNode.create(getClass().getName(), this); 3592 3593 if (!sCompatibilityDone && context != null) { 3594 final int targetSdkVersion = context.getApplicationInfo().targetSdkVersion; 3595 3596 // Older apps may need this compatibility hack for measurement. 3597 sUseBrokenMakeMeasureSpec = targetSdkVersion <= JELLY_BEAN_MR1; 3598 3599 // Older apps expect onMeasure() to always be called on a layout pass, regardless 3600 // of whether a layout was requested on that View. 3601 sIgnoreMeasureCache = targetSdkVersion < KITKAT; 3602 3603 sCompatibilityDone = true; 3604 } 3605 } 3606 3607 /** 3608 * Constructor that is called when inflating a view from XML. This is called 3609 * when a view is being constructed from an XML file, supplying attributes 3610 * that were specified in the XML file. This version uses a default style of 3611 * 0, so the only attribute values applied are those in the Context's Theme 3612 * and the given AttributeSet. 3613 * 3614 * <p> 3615 * The method onFinishInflate() will be called after all children have been 3616 * added. 3617 * 3618 * @param context The Context the view is running in, through which it can 3619 * access the current theme, resources, etc. 3620 * @param attrs The attributes of the XML tag that is inflating the view. 3621 * @see #View(Context, AttributeSet, int) 3622 */ 3623 public View(Context context, AttributeSet attrs) { 3624 this(context, attrs, 0); 3625 } 3626 3627 /** 3628 * Perform inflation from XML and apply a class-specific base style from a 3629 * theme attribute. This constructor of View allows subclasses to use their 3630 * own base style when they are inflating. For example, a Button class's 3631 * constructor would call this version of the super class constructor and 3632 * supply <code>R.attr.buttonStyle</code> for <var>defStyleAttr</var>; this 3633 * allows the theme's button style to modify all of the base view attributes 3634 * (in particular its background) as well as the Button class's attributes. 3635 * 3636 * @param context The Context the view is running in, through which it can 3637 * access the current theme, resources, etc. 3638 * @param attrs The attributes of the XML tag that is inflating the view. 3639 * @param defStyleAttr An attribute in the current theme that contains a 3640 * reference to a style resource that supplies default values for 3641 * the view. Can be 0 to not look for defaults. 3642 * @see #View(Context, AttributeSet) 3643 */ 3644 public View(Context context, AttributeSet attrs, int defStyleAttr) { 3645 this(context, attrs, defStyleAttr, 0); 3646 } 3647 3648 /** 3649 * Perform inflation from XML and apply a class-specific base style from a 3650 * theme attribute or style resource. This constructor of View allows 3651 * subclasses to use their own base style when they are inflating. 3652 * <p> 3653 * When determining the final value of a particular attribute, there are 3654 * four inputs that come into play: 3655 * <ol> 3656 * <li>Any attribute values in the given AttributeSet. 3657 * <li>The style resource specified in the AttributeSet (named "style"). 3658 * <li>The default style specified by <var>defStyleAttr</var>. 3659 * <li>The default style specified by <var>defStyleRes</var>. 3660 * <li>The base values in this theme. 3661 * </ol> 3662 * <p> 3663 * Each of these inputs is considered in-order, with the first listed taking 3664 * precedence over the following ones. In other words, if in the 3665 * AttributeSet you have supplied <code><Button * textColor="#ff000000"></code> 3666 * , then the button's text will <em>always</em> be black, regardless of 3667 * what is specified in any of the styles. 3668 * 3669 * @param context The Context the view is running in, through which it can 3670 * access the current theme, resources, etc. 3671 * @param attrs The attributes of the XML tag that is inflating the view. 3672 * @param defStyleAttr An attribute in the current theme that contains a 3673 * reference to a style resource that supplies default values for 3674 * the view. Can be 0 to not look for defaults. 3675 * @param defStyleRes A resource identifier of a style resource that 3676 * supplies default values for the view, used only if 3677 * defStyleAttr is 0 or can not be found in the theme. Can be 0 3678 * to not look for defaults. 3679 * @see #View(Context, AttributeSet, int) 3680 */ 3681 public View(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) { 3682 this(context); 3683 3684 final TypedArray a = context.obtainStyledAttributes( 3685 attrs, com.android.internal.R.styleable.View, defStyleAttr, defStyleRes); 3686 3687 if (mDebugViewAttributes) { 3688 saveAttributeData(attrs, a); 3689 } 3690 3691 Drawable background = null; 3692 3693 int leftPadding = -1; 3694 int topPadding = -1; 3695 int rightPadding = -1; 3696 int bottomPadding = -1; 3697 int startPadding = UNDEFINED_PADDING; 3698 int endPadding = UNDEFINED_PADDING; 3699 3700 int padding = -1; 3701 3702 int viewFlagValues = 0; 3703 int viewFlagMasks = 0; 3704 3705 boolean setScrollContainer = false; 3706 3707 int x = 0; 3708 int y = 0; 3709 3710 float tx = 0; 3711 float ty = 0; 3712 float tz = 0; 3713 float elevation = 0; 3714 float rotation = 0; 3715 float rotationX = 0; 3716 float rotationY = 0; 3717 float sx = 1f; 3718 float sy = 1f; 3719 boolean transformSet = false; 3720 3721 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY; 3722 int overScrollMode = mOverScrollMode; 3723 boolean initializeScrollbars = false; 3724 3725 boolean startPaddingDefined = false; 3726 boolean endPaddingDefined = false; 3727 boolean leftPaddingDefined = false; 3728 boolean rightPaddingDefined = false; 3729 3730 final int targetSdkVersion = context.getApplicationInfo().targetSdkVersion; 3731 3732 final int N = a.getIndexCount(); 3733 for (int i = 0; i < N; i++) { 3734 int attr = a.getIndex(i); 3735 switch (attr) { 3736 case com.android.internal.R.styleable.View_background: 3737 background = a.getDrawable(attr); 3738 break; 3739 case com.android.internal.R.styleable.View_padding: 3740 padding = a.getDimensionPixelSize(attr, -1); 3741 mUserPaddingLeftInitial = padding; 3742 mUserPaddingRightInitial = padding; 3743 leftPaddingDefined = true; 3744 rightPaddingDefined = true; 3745 break; 3746 case com.android.internal.R.styleable.View_paddingLeft: 3747 leftPadding = a.getDimensionPixelSize(attr, -1); 3748 mUserPaddingLeftInitial = leftPadding; 3749 leftPaddingDefined = true; 3750 break; 3751 case com.android.internal.R.styleable.View_paddingTop: 3752 topPadding = a.getDimensionPixelSize(attr, -1); 3753 break; 3754 case com.android.internal.R.styleable.View_paddingRight: 3755 rightPadding = a.getDimensionPixelSize(attr, -1); 3756 mUserPaddingRightInitial = rightPadding; 3757 rightPaddingDefined = true; 3758 break; 3759 case com.android.internal.R.styleable.View_paddingBottom: 3760 bottomPadding = a.getDimensionPixelSize(attr, -1); 3761 break; 3762 case com.android.internal.R.styleable.View_paddingStart: 3763 startPadding = a.getDimensionPixelSize(attr, UNDEFINED_PADDING); 3764 startPaddingDefined = (startPadding != UNDEFINED_PADDING); 3765 break; 3766 case com.android.internal.R.styleable.View_paddingEnd: 3767 endPadding = a.getDimensionPixelSize(attr, UNDEFINED_PADDING); 3768 endPaddingDefined = (endPadding != UNDEFINED_PADDING); 3769 break; 3770 case com.android.internal.R.styleable.View_scrollX: 3771 x = a.getDimensionPixelOffset(attr, 0); 3772 break; 3773 case com.android.internal.R.styleable.View_scrollY: 3774 y = a.getDimensionPixelOffset(attr, 0); 3775 break; 3776 case com.android.internal.R.styleable.View_alpha: 3777 setAlpha(a.getFloat(attr, 1f)); 3778 break; 3779 case com.android.internal.R.styleable.View_transformPivotX: 3780 setPivotX(a.getDimensionPixelOffset(attr, 0)); 3781 break; 3782 case com.android.internal.R.styleable.View_transformPivotY: 3783 setPivotY(a.getDimensionPixelOffset(attr, 0)); 3784 break; 3785 case com.android.internal.R.styleable.View_translationX: 3786 tx = a.getDimensionPixelOffset(attr, 0); 3787 transformSet = true; 3788 break; 3789 case com.android.internal.R.styleable.View_translationY: 3790 ty = a.getDimensionPixelOffset(attr, 0); 3791 transformSet = true; 3792 break; 3793 case com.android.internal.R.styleable.View_translationZ: 3794 tz = a.getDimensionPixelOffset(attr, 0); 3795 transformSet = true; 3796 break; 3797 case com.android.internal.R.styleable.View_elevation: 3798 elevation = a.getDimensionPixelOffset(attr, 0); 3799 transformSet = true; 3800 break; 3801 case com.android.internal.R.styleable.View_rotation: 3802 rotation = a.getFloat(attr, 0); 3803 transformSet = true; 3804 break; 3805 case com.android.internal.R.styleable.View_rotationX: 3806 rotationX = a.getFloat(attr, 0); 3807 transformSet = true; 3808 break; 3809 case com.android.internal.R.styleable.View_rotationY: 3810 rotationY = a.getFloat(attr, 0); 3811 transformSet = true; 3812 break; 3813 case com.android.internal.R.styleable.View_scaleX: 3814 sx = a.getFloat(attr, 1f); 3815 transformSet = true; 3816 break; 3817 case com.android.internal.R.styleable.View_scaleY: 3818 sy = a.getFloat(attr, 1f); 3819 transformSet = true; 3820 break; 3821 case com.android.internal.R.styleable.View_id: 3822 mID = a.getResourceId(attr, NO_ID); 3823 break; 3824 case com.android.internal.R.styleable.View_tag: 3825 mTag = a.getText(attr); 3826 break; 3827 case com.android.internal.R.styleable.View_fitsSystemWindows: 3828 if (a.getBoolean(attr, false)) { 3829 viewFlagValues |= FITS_SYSTEM_WINDOWS; 3830 viewFlagMasks |= FITS_SYSTEM_WINDOWS; 3831 } 3832 break; 3833 case com.android.internal.R.styleable.View_focusable: 3834 if (a.getBoolean(attr, false)) { 3835 viewFlagValues |= FOCUSABLE; 3836 viewFlagMasks |= FOCUSABLE_MASK; 3837 } 3838 break; 3839 case com.android.internal.R.styleable.View_focusableInTouchMode: 3840 if (a.getBoolean(attr, false)) { 3841 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE; 3842 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK; 3843 } 3844 break; 3845 case com.android.internal.R.styleable.View_clickable: 3846 if (a.getBoolean(attr, false)) { 3847 viewFlagValues |= CLICKABLE; 3848 viewFlagMasks |= CLICKABLE; 3849 } 3850 break; 3851 case com.android.internal.R.styleable.View_longClickable: 3852 if (a.getBoolean(attr, false)) { 3853 viewFlagValues |= LONG_CLICKABLE; 3854 viewFlagMasks |= LONG_CLICKABLE; 3855 } 3856 break; 3857 case com.android.internal.R.styleable.View_saveEnabled: 3858 if (!a.getBoolean(attr, true)) { 3859 viewFlagValues |= SAVE_DISABLED; 3860 viewFlagMasks |= SAVE_DISABLED_MASK; 3861 } 3862 break; 3863 case com.android.internal.R.styleable.View_duplicateParentState: 3864 if (a.getBoolean(attr, false)) { 3865 viewFlagValues |= DUPLICATE_PARENT_STATE; 3866 viewFlagMasks |= DUPLICATE_PARENT_STATE; 3867 } 3868 break; 3869 case com.android.internal.R.styleable.View_visibility: 3870 final int visibility = a.getInt(attr, 0); 3871 if (visibility != 0) { 3872 viewFlagValues |= VISIBILITY_FLAGS[visibility]; 3873 viewFlagMasks |= VISIBILITY_MASK; 3874 } 3875 break; 3876 case com.android.internal.R.styleable.View_layoutDirection: 3877 // Clear any layout direction flags (included resolved bits) already set 3878 mPrivateFlags2 &= 3879 ~(PFLAG2_LAYOUT_DIRECTION_MASK | PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK); 3880 // Set the layout direction flags depending on the value of the attribute 3881 final int layoutDirection = a.getInt(attr, -1); 3882 final int value = (layoutDirection != -1) ? 3883 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT; 3884 mPrivateFlags2 |= (value << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT); 3885 break; 3886 case com.android.internal.R.styleable.View_drawingCacheQuality: 3887 final int cacheQuality = a.getInt(attr, 0); 3888 if (cacheQuality != 0) { 3889 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality]; 3890 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK; 3891 } 3892 break; 3893 case com.android.internal.R.styleable.View_contentDescription: 3894 setContentDescription(a.getString(attr)); 3895 break; 3896 case com.android.internal.R.styleable.View_accessibilityTraversalBefore: 3897 setAccessibilityTraversalBefore(a.getResourceId(attr, NO_ID)); 3898 break; 3899 case com.android.internal.R.styleable.View_accessibilityTraversalAfter: 3900 setAccessibilityTraversalAfter(a.getResourceId(attr, NO_ID)); 3901 break; 3902 case com.android.internal.R.styleable.View_labelFor: 3903 setLabelFor(a.getResourceId(attr, NO_ID)); 3904 break; 3905 case com.android.internal.R.styleable.View_soundEffectsEnabled: 3906 if (!a.getBoolean(attr, true)) { 3907 viewFlagValues &= ~SOUND_EFFECTS_ENABLED; 3908 viewFlagMasks |= SOUND_EFFECTS_ENABLED; 3909 } 3910 break; 3911 case com.android.internal.R.styleable.View_hapticFeedbackEnabled: 3912 if (!a.getBoolean(attr, true)) { 3913 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED; 3914 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED; 3915 } 3916 break; 3917 case R.styleable.View_scrollbars: 3918 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE); 3919 if (scrollbars != SCROLLBARS_NONE) { 3920 viewFlagValues |= scrollbars; 3921 viewFlagMasks |= SCROLLBARS_MASK; 3922 initializeScrollbars = true; 3923 } 3924 break; 3925 //noinspection deprecation 3926 case R.styleable.View_fadingEdge: 3927 if (targetSdkVersion >= ICE_CREAM_SANDWICH) { 3928 // Ignore the attribute starting with ICS 3929 break; 3930 } 3931 // With builds < ICS, fall through and apply fading edges 3932 case R.styleable.View_requiresFadingEdge: 3933 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE); 3934 if (fadingEdge != FADING_EDGE_NONE) { 3935 viewFlagValues |= fadingEdge; 3936 viewFlagMasks |= FADING_EDGE_MASK; 3937 initializeFadingEdgeInternal(a); 3938 } 3939 break; 3940 case R.styleable.View_scrollbarStyle: 3941 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY); 3942 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 3943 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK; 3944 viewFlagMasks |= SCROLLBARS_STYLE_MASK; 3945 } 3946 break; 3947 case R.styleable.View_isScrollContainer: 3948 setScrollContainer = true; 3949 if (a.getBoolean(attr, false)) { 3950 setScrollContainer(true); 3951 } 3952 break; 3953 case com.android.internal.R.styleable.View_keepScreenOn: 3954 if (a.getBoolean(attr, false)) { 3955 viewFlagValues |= KEEP_SCREEN_ON; 3956 viewFlagMasks |= KEEP_SCREEN_ON; 3957 } 3958 break; 3959 case R.styleable.View_filterTouchesWhenObscured: 3960 if (a.getBoolean(attr, false)) { 3961 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED; 3962 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED; 3963 } 3964 break; 3965 case R.styleable.View_nextFocusLeft: 3966 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID); 3967 break; 3968 case R.styleable.View_nextFocusRight: 3969 mNextFocusRightId = a.getResourceId(attr, View.NO_ID); 3970 break; 3971 case R.styleable.View_nextFocusUp: 3972 mNextFocusUpId = a.getResourceId(attr, View.NO_ID); 3973 break; 3974 case R.styleable.View_nextFocusDown: 3975 mNextFocusDownId = a.getResourceId(attr, View.NO_ID); 3976 break; 3977 case R.styleable.View_nextFocusForward: 3978 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID); 3979 break; 3980 case R.styleable.View_minWidth: 3981 mMinWidth = a.getDimensionPixelSize(attr, 0); 3982 break; 3983 case R.styleable.View_minHeight: 3984 mMinHeight = a.getDimensionPixelSize(attr, 0); 3985 break; 3986 case R.styleable.View_onClick: 3987 if (context.isRestricted()) { 3988 throw new IllegalStateException("The android:onClick attribute cannot " 3989 + "be used within a restricted context"); 3990 } 3991 3992 final String handlerName = a.getString(attr); 3993 if (handlerName != null) { 3994 setOnClickListener(new OnClickListener() { 3995 private Method mHandler; 3996 3997 public void onClick(View v) { 3998 if (mHandler == null) { 3999 try { 4000 mHandler = getContext().getClass().getMethod(handlerName, 4001 View.class); 4002 } catch (NoSuchMethodException e) { 4003 int id = getId(); 4004 String idText = id == NO_ID ? "" : " with id '" 4005 + getContext().getResources().getResourceEntryName( 4006 id) + "'"; 4007 throw new IllegalStateException("Could not find a method " + 4008 handlerName + "(View) in the activity " 4009 + getContext().getClass() + " for onClick handler" 4010 + " on view " + View.this.getClass() + idText, e); 4011 } 4012 } 4013 4014 try { 4015 mHandler.invoke(getContext(), View.this); 4016 } catch (IllegalAccessException e) { 4017 throw new IllegalStateException("Could not execute non " 4018 + "public method of the activity", e); 4019 } catch (InvocationTargetException e) { 4020 throw new IllegalStateException("Could not execute " 4021 + "method of the activity", e); 4022 } 4023 } 4024 }); 4025 } 4026 break; 4027 case R.styleable.View_overScrollMode: 4028 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS); 4029 break; 4030 case R.styleable.View_verticalScrollbarPosition: 4031 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT); 4032 break; 4033 case R.styleable.View_layerType: 4034 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null); 4035 break; 4036 case R.styleable.View_textDirection: 4037 // Clear any text direction flag already set 4038 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 4039 // Set the text direction flags depending on the value of the attribute 4040 final int textDirection = a.getInt(attr, -1); 4041 if (textDirection != -1) { 4042 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_FLAGS[textDirection]; 4043 } 4044 break; 4045 case R.styleable.View_textAlignment: 4046 // Clear any text alignment flag already set 4047 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 4048 // Set the text alignment flag depending on the value of the attribute 4049 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT); 4050 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_FLAGS[textAlignment]; 4051 break; 4052 case R.styleable.View_importantForAccessibility: 4053 setImportantForAccessibility(a.getInt(attr, 4054 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT)); 4055 break; 4056 case R.styleable.View_accessibilityLiveRegion: 4057 setAccessibilityLiveRegion(a.getInt(attr, ACCESSIBILITY_LIVE_REGION_DEFAULT)); 4058 break; 4059 case R.styleable.View_transitionName: 4060 setTransitionName(a.getString(attr)); 4061 break; 4062 case R.styleable.View_nestedScrollingEnabled: 4063 setNestedScrollingEnabled(a.getBoolean(attr, false)); 4064 break; 4065 case R.styleable.View_stateListAnimator: 4066 setStateListAnimator(AnimatorInflater.loadStateListAnimator(context, 4067 a.getResourceId(attr, 0))); 4068 break; 4069 case R.styleable.View_backgroundTint: 4070 // This will get applied later during setBackground(). 4071 if (mBackgroundTint == null) { 4072 mBackgroundTint = new TintInfo(); 4073 } 4074 mBackgroundTint.mTintList = a.getColorStateList( 4075 R.styleable.View_backgroundTint); 4076 mBackgroundTint.mHasTintList = true; 4077 break; 4078 case R.styleable.View_backgroundTintMode: 4079 // This will get applied later during setBackground(). 4080 if (mBackgroundTint == null) { 4081 mBackgroundTint = new TintInfo(); 4082 } 4083 mBackgroundTint.mTintMode = Drawable.parseTintMode(a.getInt( 4084 R.styleable.View_backgroundTintMode, -1), null); 4085 mBackgroundTint.mHasTintMode = true; 4086 break; 4087 case R.styleable.View_outlineProvider: 4088 setOutlineProviderFromAttribute(a.getInt(R.styleable.View_outlineProvider, 4089 PROVIDER_BACKGROUND)); 4090 break; 4091 } 4092 } 4093 4094 setOverScrollMode(overScrollMode); 4095 4096 // Cache start/end user padding as we cannot fully resolve padding here (we dont have yet 4097 // the resolved layout direction). Those cached values will be used later during padding 4098 // resolution. 4099 mUserPaddingStart = startPadding; 4100 mUserPaddingEnd = endPadding; 4101 4102 if (background != null) { 4103 setBackground(background); 4104 } 4105 4106 // setBackground above will record that padding is currently provided by the background. 4107 // If we have padding specified via xml, record that here instead and use it. 4108 mLeftPaddingDefined = leftPaddingDefined; 4109 mRightPaddingDefined = rightPaddingDefined; 4110 4111 if (padding >= 0) { 4112 leftPadding = padding; 4113 topPadding = padding; 4114 rightPadding = padding; 4115 bottomPadding = padding; 4116 mUserPaddingLeftInitial = padding; 4117 mUserPaddingRightInitial = padding; 4118 } 4119 4120 if (isRtlCompatibilityMode()) { 4121 // RTL compatibility mode: pre Jelly Bean MR1 case OR no RTL support case. 4122 // left / right padding are used if defined (meaning here nothing to do). If they are not 4123 // defined and start / end padding are defined (e.g. in Frameworks resources), then we use 4124 // start / end and resolve them as left / right (layout direction is not taken into account). 4125 // Padding from the background drawable is stored at this point in mUserPaddingLeftInitial 4126 // and mUserPaddingRightInitial) so drawable padding will be used as ultimate default if 4127 // defined. 4128 if (!mLeftPaddingDefined && startPaddingDefined) { 4129 leftPadding = startPadding; 4130 } 4131 mUserPaddingLeftInitial = (leftPadding >= 0) ? leftPadding : mUserPaddingLeftInitial; 4132 if (!mRightPaddingDefined && endPaddingDefined) { 4133 rightPadding = endPadding; 4134 } 4135 mUserPaddingRightInitial = (rightPadding >= 0) ? rightPadding : mUserPaddingRightInitial; 4136 } else { 4137 // Jelly Bean MR1 and after case: if start/end defined, they will override any left/right 4138 // values defined. Otherwise, left /right values are used. 4139 // Padding from the background drawable is stored at this point in mUserPaddingLeftInitial 4140 // and mUserPaddingRightInitial) so drawable padding will be used as ultimate default if 4141 // defined. 4142 final boolean hasRelativePadding = startPaddingDefined || endPaddingDefined; 4143 4144 if (mLeftPaddingDefined && !hasRelativePadding) { 4145 mUserPaddingLeftInitial = leftPadding; 4146 } 4147 if (mRightPaddingDefined && !hasRelativePadding) { 4148 mUserPaddingRightInitial = rightPadding; 4149 } 4150 } 4151 4152 internalSetPadding( 4153 mUserPaddingLeftInitial, 4154 topPadding >= 0 ? topPadding : mPaddingTop, 4155 mUserPaddingRightInitial, 4156 bottomPadding >= 0 ? bottomPadding : mPaddingBottom); 4157 4158 if (viewFlagMasks != 0) { 4159 setFlags(viewFlagValues, viewFlagMasks); 4160 } 4161 4162 if (initializeScrollbars) { 4163 initializeScrollbarsInternal(a); 4164 } 4165 4166 a.recycle(); 4167 4168 // Needs to be called after mViewFlags is set 4169 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 4170 recomputePadding(); 4171 } 4172 4173 if (x != 0 || y != 0) { 4174 scrollTo(x, y); 4175 } 4176 4177 if (transformSet) { 4178 setTranslationX(tx); 4179 setTranslationY(ty); 4180 setTranslationZ(tz); 4181 setElevation(elevation); 4182 setRotation(rotation); 4183 setRotationX(rotationX); 4184 setRotationY(rotationY); 4185 setScaleX(sx); 4186 setScaleY(sy); 4187 } 4188 4189 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) { 4190 setScrollContainer(true); 4191 } 4192 4193 computeOpaqueFlags(); 4194 } 4195 4196 /** 4197 * Non-public constructor for use in testing 4198 */ 4199 View() { 4200 mResources = null; 4201 mRenderNode = RenderNode.create(getClass().getName(), this); 4202 } 4203 4204 private static SparseArray<String> getAttributeMap() { 4205 if (mAttributeMap == null) { 4206 mAttributeMap = new SparseArray<String>(); 4207 } 4208 return mAttributeMap; 4209 } 4210 4211 private void saveAttributeData(AttributeSet attrs, TypedArray a) { 4212 int length = ((attrs == null ? 0 : attrs.getAttributeCount()) + a.getIndexCount()) * 2; 4213 mAttributes = new String[length]; 4214 4215 int i = 0; 4216 if (attrs != null) { 4217 for (i = 0; i < attrs.getAttributeCount(); i += 2) { 4218 mAttributes[i] = attrs.getAttributeName(i); 4219 mAttributes[i + 1] = attrs.getAttributeValue(i); 4220 } 4221 4222 } 4223 4224 SparseArray<String> attributeMap = getAttributeMap(); 4225 for (int j = 0; j < a.length(); ++j) { 4226 if (a.hasValue(j)) { 4227 try { 4228 int resourceId = a.getResourceId(j, 0); 4229 if (resourceId == 0) { 4230 continue; 4231 } 4232 4233 String resourceName = attributeMap.get(resourceId); 4234 if (resourceName == null) { 4235 resourceName = a.getResources().getResourceName(resourceId); 4236 attributeMap.put(resourceId, resourceName); 4237 } 4238 4239 mAttributes[i] = resourceName; 4240 mAttributes[i + 1] = a.getText(j).toString(); 4241 i += 2; 4242 } catch (Resources.NotFoundException e) { 4243 // if we can't get the resource name, we just ignore it 4244 } 4245 } 4246 } 4247 } 4248 4249 public String toString() { 4250 StringBuilder out = new StringBuilder(128); 4251 out.append(getClass().getName()); 4252 out.append('{'); 4253 out.append(Integer.toHexString(System.identityHashCode(this))); 4254 out.append(' '); 4255 switch (mViewFlags&VISIBILITY_MASK) { 4256 case VISIBLE: out.append('V'); break; 4257 case INVISIBLE: out.append('I'); break; 4258 case GONE: out.append('G'); break; 4259 default: out.append('.'); break; 4260 } 4261 out.append((mViewFlags&FOCUSABLE_MASK) == FOCUSABLE ? 'F' : '.'); 4262 out.append((mViewFlags&ENABLED_MASK) == ENABLED ? 'E' : '.'); 4263 out.append((mViewFlags&DRAW_MASK) == WILL_NOT_DRAW ? '.' : 'D'); 4264 out.append((mViewFlags&SCROLLBARS_HORIZONTAL) != 0 ? 'H' : '.'); 4265 out.append((mViewFlags&SCROLLBARS_VERTICAL) != 0 ? 'V' : '.'); 4266 out.append((mViewFlags&CLICKABLE) != 0 ? 'C' : '.'); 4267 out.append((mViewFlags&LONG_CLICKABLE) != 0 ? 'L' : '.'); 4268 out.append(' '); 4269 out.append((mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0 ? 'R' : '.'); 4270 out.append((mPrivateFlags&PFLAG_FOCUSED) != 0 ? 'F' : '.'); 4271 out.append((mPrivateFlags&PFLAG_SELECTED) != 0 ? 'S' : '.'); 4272 if ((mPrivateFlags&PFLAG_PREPRESSED) != 0) { 4273 out.append('p'); 4274 } else { 4275 out.append((mPrivateFlags&PFLAG_PRESSED) != 0 ? 'P' : '.'); 4276 } 4277 out.append((mPrivateFlags&PFLAG_HOVERED) != 0 ? 'H' : '.'); 4278 out.append((mPrivateFlags&PFLAG_ACTIVATED) != 0 ? 'A' : '.'); 4279 out.append((mPrivateFlags&PFLAG_INVALIDATED) != 0 ? 'I' : '.'); 4280 out.append((mPrivateFlags&PFLAG_DIRTY_MASK) != 0 ? 'D' : '.'); 4281 out.append(' '); 4282 out.append(mLeft); 4283 out.append(','); 4284 out.append(mTop); 4285 out.append('-'); 4286 out.append(mRight); 4287 out.append(','); 4288 out.append(mBottom); 4289 final int id = getId(); 4290 if (id != NO_ID) { 4291 out.append(" #"); 4292 out.append(Integer.toHexString(id)); 4293 final Resources r = mResources; 4294 if (Resources.resourceHasPackage(id) && r != null) { 4295 try { 4296 String pkgname; 4297 switch (id&0xff000000) { 4298 case 0x7f000000: 4299 pkgname="app"; 4300 break; 4301 case 0x01000000: 4302 pkgname="android"; 4303 break; 4304 default: 4305 pkgname = r.getResourcePackageName(id); 4306 break; 4307 } 4308 String typename = r.getResourceTypeName(id); 4309 String entryname = r.getResourceEntryName(id); 4310 out.append(" "); 4311 out.append(pkgname); 4312 out.append(":"); 4313 out.append(typename); 4314 out.append("/"); 4315 out.append(entryname); 4316 } catch (Resources.NotFoundException e) { 4317 } 4318 } 4319 } 4320 out.append("}"); 4321 return out.toString(); 4322 } 4323 4324 /** 4325 * <p> 4326 * Initializes the fading edges from a given set of styled attributes. This 4327 * method should be called by subclasses that need fading edges and when an 4328 * instance of these subclasses is created programmatically rather than 4329 * being inflated from XML. This method is automatically called when the XML 4330 * is inflated. 4331 * </p> 4332 * 4333 * @param a the styled attributes set to initialize the fading edges from 4334 * 4335 * @removed 4336 */ 4337 protected void initializeFadingEdge(TypedArray a) { 4338 // This method probably shouldn't have been included in the SDK to begin with. 4339 // It relies on 'a' having been initialized using an attribute filter array that is 4340 // not publicly available to the SDK. The old method has been renamed 4341 // to initializeFadingEdgeInternal and hidden for framework use only; 4342 // this one initializes using defaults to make it safe to call for apps. 4343 4344 TypedArray arr = mContext.obtainStyledAttributes(com.android.internal.R.styleable.View); 4345 4346 initializeFadingEdgeInternal(arr); 4347 4348 arr.recycle(); 4349 } 4350 4351 /** 4352 * <p> 4353 * Initializes the fading edges from a given set of styled attributes. This 4354 * method should be called by subclasses that need fading edges and when an 4355 * instance of these subclasses is created programmatically rather than 4356 * being inflated from XML. This method is automatically called when the XML 4357 * is inflated. 4358 * </p> 4359 * 4360 * @param a the styled attributes set to initialize the fading edges from 4361 * @hide This is the real method; the public one is shimmed to be safe to call from apps. 4362 */ 4363 protected void initializeFadingEdgeInternal(TypedArray a) { 4364 initScrollCache(); 4365 4366 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize( 4367 R.styleable.View_fadingEdgeLength, 4368 ViewConfiguration.get(mContext).getScaledFadingEdgeLength()); 4369 } 4370 4371 /** 4372 * Returns the size of the vertical faded edges used to indicate that more 4373 * content in this view is visible. 4374 * 4375 * @return The size in pixels of the vertical faded edge or 0 if vertical 4376 * faded edges are not enabled for this view. 4377 * @attr ref android.R.styleable#View_fadingEdgeLength 4378 */ 4379 public int getVerticalFadingEdgeLength() { 4380 if (isVerticalFadingEdgeEnabled()) { 4381 ScrollabilityCache cache = mScrollCache; 4382 if (cache != null) { 4383 return cache.fadingEdgeLength; 4384 } 4385 } 4386 return 0; 4387 } 4388 4389 /** 4390 * Set the size of the faded edge used to indicate that more content in this 4391 * view is available. Will not change whether the fading edge is enabled; use 4392 * {@link #setVerticalFadingEdgeEnabled(boolean)} or 4393 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge 4394 * for the vertical or horizontal fading edges. 4395 * 4396 * @param length The size in pixels of the faded edge used to indicate that more 4397 * content in this view is visible. 4398 */ 4399 public void setFadingEdgeLength(int length) { 4400 initScrollCache(); 4401 mScrollCache.fadingEdgeLength = length; 4402 } 4403 4404 /** 4405 * Returns the size of the horizontal faded edges used to indicate that more 4406 * content in this view is visible. 4407 * 4408 * @return The size in pixels of the horizontal faded edge or 0 if horizontal 4409 * faded edges are not enabled for this view. 4410 * @attr ref android.R.styleable#View_fadingEdgeLength 4411 */ 4412 public int getHorizontalFadingEdgeLength() { 4413 if (isHorizontalFadingEdgeEnabled()) { 4414 ScrollabilityCache cache = mScrollCache; 4415 if (cache != null) { 4416 return cache.fadingEdgeLength; 4417 } 4418 } 4419 return 0; 4420 } 4421 4422 /** 4423 * Returns the width of the vertical scrollbar. 4424 * 4425 * @return The width in pixels of the vertical scrollbar or 0 if there 4426 * is no vertical scrollbar. 4427 */ 4428 public int getVerticalScrollbarWidth() { 4429 ScrollabilityCache cache = mScrollCache; 4430 if (cache != null) { 4431 ScrollBarDrawable scrollBar = cache.scrollBar; 4432 if (scrollBar != null) { 4433 int size = scrollBar.getSize(true); 4434 if (size <= 0) { 4435 size = cache.scrollBarSize; 4436 } 4437 return size; 4438 } 4439 return 0; 4440 } 4441 return 0; 4442 } 4443 4444 /** 4445 * Returns the height of the horizontal scrollbar. 4446 * 4447 * @return The height in pixels of the horizontal scrollbar or 0 if 4448 * there is no horizontal scrollbar. 4449 */ 4450 protected int getHorizontalScrollbarHeight() { 4451 ScrollabilityCache cache = mScrollCache; 4452 if (cache != null) { 4453 ScrollBarDrawable scrollBar = cache.scrollBar; 4454 if (scrollBar != null) { 4455 int size = scrollBar.getSize(false); 4456 if (size <= 0) { 4457 size = cache.scrollBarSize; 4458 } 4459 return size; 4460 } 4461 return 0; 4462 } 4463 return 0; 4464 } 4465 4466 /** 4467 * <p> 4468 * Initializes the scrollbars from a given set of styled attributes. This 4469 * method should be called by subclasses that need scrollbars and when an 4470 * instance of these subclasses is created programmatically rather than 4471 * being inflated from XML. This method is automatically called when the XML 4472 * is inflated. 4473 * </p> 4474 * 4475 * @param a the styled attributes set to initialize the scrollbars from 4476 * 4477 * @removed 4478 */ 4479 protected void initializeScrollbars(TypedArray a) { 4480 // It's not safe to use this method from apps. The parameter 'a' must have been obtained 4481 // using the View filter array which is not available to the SDK. As such, internal 4482 // framework usage now uses initializeScrollbarsInternal and we grab a default 4483 // TypedArray with the right filter instead here. 4484 TypedArray arr = mContext.obtainStyledAttributes(com.android.internal.R.styleable.View); 4485 4486 initializeScrollbarsInternal(arr); 4487 4488 // We ignored the method parameter. Recycle the one we actually did use. 4489 arr.recycle(); 4490 } 4491 4492 /** 4493 * <p> 4494 * Initializes the scrollbars from a given set of styled attributes. This 4495 * method should be called by subclasses that need scrollbars and when an 4496 * instance of these subclasses is created programmatically rather than 4497 * being inflated from XML. This method is automatically called when the XML 4498 * is inflated. 4499 * </p> 4500 * 4501 * @param a the styled attributes set to initialize the scrollbars from 4502 * @hide 4503 */ 4504 protected void initializeScrollbarsInternal(TypedArray a) { 4505 initScrollCache(); 4506 4507 final ScrollabilityCache scrollabilityCache = mScrollCache; 4508 4509 if (scrollabilityCache.scrollBar == null) { 4510 scrollabilityCache.scrollBar = new ScrollBarDrawable(); 4511 } 4512 4513 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true); 4514 4515 if (!fadeScrollbars) { 4516 scrollabilityCache.state = ScrollabilityCache.ON; 4517 } 4518 scrollabilityCache.fadeScrollBars = fadeScrollbars; 4519 4520 4521 scrollabilityCache.scrollBarFadeDuration = a.getInt( 4522 R.styleable.View_scrollbarFadeDuration, ViewConfiguration 4523 .getScrollBarFadeDuration()); 4524 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt( 4525 R.styleable.View_scrollbarDefaultDelayBeforeFade, 4526 ViewConfiguration.getScrollDefaultDelay()); 4527 4528 4529 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize( 4530 com.android.internal.R.styleable.View_scrollbarSize, 4531 ViewConfiguration.get(mContext).getScaledScrollBarSize()); 4532 4533 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal); 4534 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track); 4535 4536 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal); 4537 if (thumb != null) { 4538 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb); 4539 } 4540 4541 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack, 4542 false); 4543 if (alwaysDraw) { 4544 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true); 4545 } 4546 4547 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical); 4548 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track); 4549 4550 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical); 4551 if (thumb != null) { 4552 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb); 4553 } 4554 4555 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack, 4556 false); 4557 if (alwaysDraw) { 4558 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true); 4559 } 4560 4561 // Apply layout direction to the new Drawables if needed 4562 final int layoutDirection = getLayoutDirection(); 4563 if (track != null) { 4564 track.setLayoutDirection(layoutDirection); 4565 } 4566 if (thumb != null) { 4567 thumb.setLayoutDirection(layoutDirection); 4568 } 4569 4570 // Re-apply user/background padding so that scrollbar(s) get added 4571 resolvePadding(); 4572 } 4573 4574 /** 4575 * <p> 4576 * Initalizes the scrollability cache if necessary. 4577 * </p> 4578 */ 4579 private void initScrollCache() { 4580 if (mScrollCache == null) { 4581 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this); 4582 } 4583 } 4584 4585 private ScrollabilityCache getScrollCache() { 4586 initScrollCache(); 4587 return mScrollCache; 4588 } 4589 4590 /** 4591 * Set the position of the vertical scroll bar. Should be one of 4592 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or 4593 * {@link #SCROLLBAR_POSITION_RIGHT}. 4594 * 4595 * @param position Where the vertical scroll bar should be positioned. 4596 */ 4597 public void setVerticalScrollbarPosition(int position) { 4598 if (mVerticalScrollbarPosition != position) { 4599 mVerticalScrollbarPosition = position; 4600 computeOpaqueFlags(); 4601 resolvePadding(); 4602 } 4603 } 4604 4605 /** 4606 * @return The position where the vertical scroll bar will show, if applicable. 4607 * @see #setVerticalScrollbarPosition(int) 4608 */ 4609 public int getVerticalScrollbarPosition() { 4610 return mVerticalScrollbarPosition; 4611 } 4612 4613 ListenerInfo getListenerInfo() { 4614 if (mListenerInfo != null) { 4615 return mListenerInfo; 4616 } 4617 mListenerInfo = new ListenerInfo(); 4618 return mListenerInfo; 4619 } 4620 4621 /** 4622 * Register a callback to be invoked when the scroll position of this view 4623 * changed. 4624 * 4625 * @param l The callback that will run. 4626 * @hide Only used internally. 4627 */ 4628 public void setOnScrollChangeListener(OnScrollChangeListener l) { 4629 getListenerInfo().mOnScrollChangeListener = l; 4630 } 4631 4632 /** 4633 * Register a callback to be invoked when focus of this view changed. 4634 * 4635 * @param l The callback that will run. 4636 */ 4637 public void setOnFocusChangeListener(OnFocusChangeListener l) { 4638 getListenerInfo().mOnFocusChangeListener = l; 4639 } 4640 4641 /** 4642 * Add a listener that will be called when the bounds of the view change due to 4643 * layout processing. 4644 * 4645 * @param listener The listener that will be called when layout bounds change. 4646 */ 4647 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) { 4648 ListenerInfo li = getListenerInfo(); 4649 if (li.mOnLayoutChangeListeners == null) { 4650 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>(); 4651 } 4652 if (!li.mOnLayoutChangeListeners.contains(listener)) { 4653 li.mOnLayoutChangeListeners.add(listener); 4654 } 4655 } 4656 4657 /** 4658 * Remove a listener for layout changes. 4659 * 4660 * @param listener The listener for layout bounds change. 4661 */ 4662 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) { 4663 ListenerInfo li = mListenerInfo; 4664 if (li == null || li.mOnLayoutChangeListeners == null) { 4665 return; 4666 } 4667 li.mOnLayoutChangeListeners.remove(listener); 4668 } 4669 4670 /** 4671 * Add a listener for attach state changes. 4672 * 4673 * This listener will be called whenever this view is attached or detached 4674 * from a window. Remove the listener using 4675 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}. 4676 * 4677 * @param listener Listener to attach 4678 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener) 4679 */ 4680 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 4681 ListenerInfo li = getListenerInfo(); 4682 if (li.mOnAttachStateChangeListeners == null) { 4683 li.mOnAttachStateChangeListeners 4684 = new CopyOnWriteArrayList<OnAttachStateChangeListener>(); 4685 } 4686 li.mOnAttachStateChangeListeners.add(listener); 4687 } 4688 4689 /** 4690 * Remove a listener for attach state changes. The listener will receive no further 4691 * notification of window attach/detach events. 4692 * 4693 * @param listener Listener to remove 4694 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener) 4695 */ 4696 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 4697 ListenerInfo li = mListenerInfo; 4698 if (li == null || li.mOnAttachStateChangeListeners == null) { 4699 return; 4700 } 4701 li.mOnAttachStateChangeListeners.remove(listener); 4702 } 4703 4704 /** 4705 * Returns the focus-change callback registered for this view. 4706 * 4707 * @return The callback, or null if one is not registered. 4708 */ 4709 public OnFocusChangeListener getOnFocusChangeListener() { 4710 ListenerInfo li = mListenerInfo; 4711 return li != null ? li.mOnFocusChangeListener : null; 4712 } 4713 4714 /** 4715 * Register a callback to be invoked when this view is clicked. If this view is not 4716 * clickable, it becomes clickable. 4717 * 4718 * @param l The callback that will run 4719 * 4720 * @see #setClickable(boolean) 4721 */ 4722 public void setOnClickListener(OnClickListener l) { 4723 if (!isClickable()) { 4724 setClickable(true); 4725 } 4726 getListenerInfo().mOnClickListener = l; 4727 } 4728 4729 /** 4730 * Return whether this view has an attached OnClickListener. Returns 4731 * true if there is a listener, false if there is none. 4732 */ 4733 public boolean hasOnClickListeners() { 4734 ListenerInfo li = mListenerInfo; 4735 return (li != null && li.mOnClickListener != null); 4736 } 4737 4738 /** 4739 * Register a callback to be invoked when this view is clicked and held. If this view is not 4740 * long clickable, it becomes long clickable. 4741 * 4742 * @param l The callback that will run 4743 * 4744 * @see #setLongClickable(boolean) 4745 */ 4746 public void setOnLongClickListener(OnLongClickListener l) { 4747 if (!isLongClickable()) { 4748 setLongClickable(true); 4749 } 4750 getListenerInfo().mOnLongClickListener = l; 4751 } 4752 4753 /** 4754 * Register a callback to be invoked when the context menu for this view is 4755 * being built. If this view is not long clickable, it becomes long clickable. 4756 * 4757 * @param l The callback that will run 4758 * 4759 */ 4760 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) { 4761 if (!isLongClickable()) { 4762 setLongClickable(true); 4763 } 4764 getListenerInfo().mOnCreateContextMenuListener = l; 4765 } 4766 4767 /** 4768 * Call this view's OnClickListener, if it is defined. Performs all normal 4769 * actions associated with clicking: reporting accessibility event, playing 4770 * a sound, etc. 4771 * 4772 * @return True there was an assigned OnClickListener that was called, false 4773 * otherwise is returned. 4774 */ 4775 public boolean performClick() { 4776 final boolean result; 4777 final ListenerInfo li = mListenerInfo; 4778 if (li != null && li.mOnClickListener != null) { 4779 playSoundEffect(SoundEffectConstants.CLICK); 4780 li.mOnClickListener.onClick(this); 4781 result = true; 4782 } else { 4783 result = false; 4784 } 4785 4786 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED); 4787 return result; 4788 } 4789 4790 /** 4791 * Directly call any attached OnClickListener. Unlike {@link #performClick()}, 4792 * this only calls the listener, and does not do any associated clicking 4793 * actions like reporting an accessibility event. 4794 * 4795 * @return True there was an assigned OnClickListener that was called, false 4796 * otherwise is returned. 4797 */ 4798 public boolean callOnClick() { 4799 ListenerInfo li = mListenerInfo; 4800 if (li != null && li.mOnClickListener != null) { 4801 li.mOnClickListener.onClick(this); 4802 return true; 4803 } 4804 return false; 4805 } 4806 4807 /** 4808 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the 4809 * OnLongClickListener did not consume the event. 4810 * 4811 * @return True if one of the above receivers consumed the event, false otherwise. 4812 */ 4813 public boolean performLongClick() { 4814 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED); 4815 4816 boolean handled = false; 4817 ListenerInfo li = mListenerInfo; 4818 if (li != null && li.mOnLongClickListener != null) { 4819 handled = li.mOnLongClickListener.onLongClick(View.this); 4820 } 4821 if (!handled) { 4822 handled = showContextMenu(); 4823 } 4824 if (handled) { 4825 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); 4826 } 4827 return handled; 4828 } 4829 4830 /** 4831 * Performs button-related actions during a touch down event. 4832 * 4833 * @param event The event. 4834 * @return True if the down was consumed. 4835 * 4836 * @hide 4837 */ 4838 protected boolean performButtonActionOnTouchDown(MotionEvent event) { 4839 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) { 4840 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) { 4841 return true; 4842 } 4843 } 4844 return false; 4845 } 4846 4847 /** 4848 * Bring up the context menu for this view. 4849 * 4850 * @return Whether a context menu was displayed. 4851 */ 4852 public boolean showContextMenu() { 4853 return getParent().showContextMenuForChild(this); 4854 } 4855 4856 /** 4857 * Bring up the context menu for this view, referring to the item under the specified point. 4858 * 4859 * @param x The referenced x coordinate. 4860 * @param y The referenced y coordinate. 4861 * @param metaState The keyboard modifiers that were pressed. 4862 * @return Whether a context menu was displayed. 4863 * 4864 * @hide 4865 */ 4866 public boolean showContextMenu(float x, float y, int metaState) { 4867 return showContextMenu(); 4868 } 4869 4870 /** 4871 * Start an action mode. 4872 * 4873 * @param callback Callback that will control the lifecycle of the action mode 4874 * @return The new action mode if it is started, null otherwise 4875 * 4876 * @see ActionMode 4877 */ 4878 public ActionMode startActionMode(ActionMode.Callback callback) { 4879 ViewParent parent = getParent(); 4880 if (parent == null) return null; 4881 return parent.startActionModeForChild(this, callback); 4882 } 4883 4884 /** 4885 * Register a callback to be invoked when a hardware key is pressed in this view. 4886 * Key presses in software input methods will generally not trigger the methods of 4887 * this listener. 4888 * @param l the key listener to attach to this view 4889 */ 4890 public void setOnKeyListener(OnKeyListener l) { 4891 getListenerInfo().mOnKeyListener = l; 4892 } 4893 4894 /** 4895 * Register a callback to be invoked when a touch event is sent to this view. 4896 * @param l the touch listener to attach to this view 4897 */ 4898 public void setOnTouchListener(OnTouchListener l) { 4899 getListenerInfo().mOnTouchListener = l; 4900 } 4901 4902 /** 4903 * Register a callback to be invoked when a generic motion event is sent to this view. 4904 * @param l the generic motion listener to attach to this view 4905 */ 4906 public void setOnGenericMotionListener(OnGenericMotionListener l) { 4907 getListenerInfo().mOnGenericMotionListener = l; 4908 } 4909 4910 /** 4911 * Register a callback to be invoked when a hover event is sent to this view. 4912 * @param l the hover listener to attach to this view 4913 */ 4914 public void setOnHoverListener(OnHoverListener l) { 4915 getListenerInfo().mOnHoverListener = l; 4916 } 4917 4918 /** 4919 * Register a drag event listener callback object for this View. The parameter is 4920 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a 4921 * View, the system calls the 4922 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method. 4923 * @param l An implementation of {@link android.view.View.OnDragListener}. 4924 */ 4925 public void setOnDragListener(OnDragListener l) { 4926 getListenerInfo().mOnDragListener = l; 4927 } 4928 4929 /** 4930 * Give this view focus. This will cause 4931 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called. 4932 * 4933 * Note: this does not check whether this {@link View} should get focus, it just 4934 * gives it focus no matter what. It should only be called internally by framework 4935 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}. 4936 * 4937 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN}, 4938 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which 4939 * focus moved when requestFocus() is called. It may not always 4940 * apply, in which case use the default View.FOCUS_DOWN. 4941 * @param previouslyFocusedRect The rectangle of the view that had focus 4942 * prior in this View's coordinate system. 4943 */ 4944 void handleFocusGainInternal(@FocusRealDirection int direction, Rect previouslyFocusedRect) { 4945 if (DBG) { 4946 System.out.println(this + " requestFocus()"); 4947 } 4948 4949 if ((mPrivateFlags & PFLAG_FOCUSED) == 0) { 4950 mPrivateFlags |= PFLAG_FOCUSED; 4951 4952 View oldFocus = (mAttachInfo != null) ? getRootView().findFocus() : null; 4953 4954 if (mParent != null) { 4955 mParent.requestChildFocus(this, this); 4956 } 4957 4958 if (mAttachInfo != null) { 4959 mAttachInfo.mTreeObserver.dispatchOnGlobalFocusChange(oldFocus, this); 4960 } 4961 4962 onFocusChanged(true, direction, previouslyFocusedRect); 4963 refreshDrawableState(); 4964 } 4965 } 4966 4967 /** 4968 * Populates <code>outRect</code> with the hotspot bounds. By default, 4969 * the hotspot bounds are identical to the screen bounds. 4970 * 4971 * @param outRect rect to populate with hotspot bounds 4972 * @hide Only for internal use by views and widgets. 4973 */ 4974 public void getHotspotBounds(Rect outRect) { 4975 final Drawable background = getBackground(); 4976 if (background != null) { 4977 background.getHotspotBounds(outRect); 4978 } else { 4979 getBoundsOnScreen(outRect); 4980 } 4981 } 4982 4983 /** 4984 * Request that a rectangle of this view be visible on the screen, 4985 * scrolling if necessary just enough. 4986 * 4987 * <p>A View should call this if it maintains some notion of which part 4988 * of its content is interesting. For example, a text editing view 4989 * should call this when its cursor moves. 4990 * 4991 * @param rectangle The rectangle. 4992 * @return Whether any parent scrolled. 4993 */ 4994 public boolean requestRectangleOnScreen(Rect rectangle) { 4995 return requestRectangleOnScreen(rectangle, false); 4996 } 4997 4998 /** 4999 * Request that a rectangle of this view be visible on the screen, 5000 * scrolling if necessary just enough. 5001 * 5002 * <p>A View should call this if it maintains some notion of which part 5003 * of its content is interesting. For example, a text editing view 5004 * should call this when its cursor moves. 5005 * 5006 * <p>When <code>immediate</code> is set to true, scrolling will not be 5007 * animated. 5008 * 5009 * @param rectangle The rectangle. 5010 * @param immediate True to forbid animated scrolling, false otherwise 5011 * @return Whether any parent scrolled. 5012 */ 5013 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) { 5014 if (mParent == null) { 5015 return false; 5016 } 5017 5018 View child = this; 5019 5020 RectF position = (mAttachInfo != null) ? mAttachInfo.mTmpTransformRect : new RectF(); 5021 position.set(rectangle); 5022 5023 ViewParent parent = mParent; 5024 boolean scrolled = false; 5025 while (parent != null) { 5026 rectangle.set((int) position.left, (int) position.top, 5027 (int) position.right, (int) position.bottom); 5028 5029 scrolled |= parent.requestChildRectangleOnScreen(child, 5030 rectangle, immediate); 5031 5032 if (!child.hasIdentityMatrix()) { 5033 child.getMatrix().mapRect(position); 5034 } 5035 5036 position.offset(child.mLeft, child.mTop); 5037 5038 if (!(parent instanceof View)) { 5039 break; 5040 } 5041 5042 View parentView = (View) parent; 5043 5044 position.offset(-parentView.getScrollX(), -parentView.getScrollY()); 5045 5046 child = parentView; 5047 parent = child.getParent(); 5048 } 5049 5050 return scrolled; 5051 } 5052 5053 /** 5054 * Called when this view wants to give up focus. If focus is cleared 5055 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called. 5056 * <p> 5057 * <strong>Note:</strong> When a View clears focus the framework is trying 5058 * to give focus to the first focusable View from the top. Hence, if this 5059 * View is the first from the top that can take focus, then all callbacks 5060 * related to clearing focus will be invoked after which the framework will 5061 * give focus to this view. 5062 * </p> 5063 */ 5064 public void clearFocus() { 5065 if (DBG) { 5066 System.out.println(this + " clearFocus()"); 5067 } 5068 5069 clearFocusInternal(null, true, true); 5070 } 5071 5072 /** 5073 * Clears focus from the view, optionally propagating the change up through 5074 * the parent hierarchy and requesting that the root view place new focus. 5075 * 5076 * @param propagate whether to propagate the change up through the parent 5077 * hierarchy 5078 * @param refocus when propagate is true, specifies whether to request the 5079 * root view place new focus 5080 */ 5081 void clearFocusInternal(View focused, boolean propagate, boolean refocus) { 5082 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 5083 mPrivateFlags &= ~PFLAG_FOCUSED; 5084 5085 if (propagate && mParent != null) { 5086 mParent.clearChildFocus(this); 5087 } 5088 5089 onFocusChanged(false, 0, null); 5090 refreshDrawableState(); 5091 5092 if (propagate && (!refocus || !rootViewRequestFocus())) { 5093 notifyGlobalFocusCleared(this); 5094 } 5095 } 5096 } 5097 5098 void notifyGlobalFocusCleared(View oldFocus) { 5099 if (oldFocus != null && mAttachInfo != null) { 5100 mAttachInfo.mTreeObserver.dispatchOnGlobalFocusChange(oldFocus, null); 5101 } 5102 } 5103 5104 boolean rootViewRequestFocus() { 5105 final View root = getRootView(); 5106 return root != null && root.requestFocus(); 5107 } 5108 5109 /** 5110 * Called internally by the view system when a new view is getting focus. 5111 * This is what clears the old focus. 5112 * <p> 5113 * <b>NOTE:</b> The parent view's focused child must be updated manually 5114 * after calling this method. Otherwise, the view hierarchy may be left in 5115 * an inconstent state. 5116 */ 5117 void unFocus(View focused) { 5118 if (DBG) { 5119 System.out.println(this + " unFocus()"); 5120 } 5121 5122 clearFocusInternal(focused, false, false); 5123 } 5124 5125 /** 5126 * Returns true if this view has focus iteself, or is the ancestor of the 5127 * view that has focus. 5128 * 5129 * @return True if this view has or contains focus, false otherwise. 5130 */ 5131 @ViewDebug.ExportedProperty(category = "focus") 5132 public boolean hasFocus() { 5133 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 5134 } 5135 5136 /** 5137 * Returns true if this view is focusable or if it contains a reachable View 5138 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()" 5139 * is a View whose parents do not block descendants focus. 5140 * 5141 * Only {@link #VISIBLE} views are considered focusable. 5142 * 5143 * @return True if the view is focusable or if the view contains a focusable 5144 * View, false otherwise. 5145 * 5146 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS 5147 * @see ViewGroup#getTouchscreenBlocksFocus() 5148 */ 5149 public boolean hasFocusable() { 5150 if (!isFocusableInTouchMode()) { 5151 for (ViewParent p = mParent; p instanceof ViewGroup; p = p.getParent()) { 5152 final ViewGroup g = (ViewGroup) p; 5153 if (g.shouldBlockFocusForTouchscreen()) { 5154 return false; 5155 } 5156 } 5157 } 5158 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable(); 5159 } 5160 5161 /** 5162 * Called by the view system when the focus state of this view changes. 5163 * When the focus change event is caused by directional navigation, direction 5164 * and previouslyFocusedRect provide insight into where the focus is coming from. 5165 * When overriding, be sure to call up through to the super class so that 5166 * the standard focus handling will occur. 5167 * 5168 * @param gainFocus True if the View has focus; false otherwise. 5169 * @param direction The direction focus has moved when requestFocus() 5170 * is called to give this view focus. Values are 5171 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT}, 5172 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}. 5173 * It may not always apply, in which case use the default. 5174 * @param previouslyFocusedRect The rectangle, in this view's coordinate 5175 * system, of the previously focused view. If applicable, this will be 5176 * passed in as finer grained information about where the focus is coming 5177 * from (in addition to direction). Will be <code>null</code> otherwise. 5178 */ 5179 protected void onFocusChanged(boolean gainFocus, @FocusDirection int direction, 5180 @Nullable Rect previouslyFocusedRect) { 5181 if (gainFocus) { 5182 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED); 5183 } else { 5184 notifyViewAccessibilityStateChangedIfNeeded( 5185 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 5186 } 5187 5188 InputMethodManager imm = InputMethodManager.peekInstance(); 5189 if (!gainFocus) { 5190 if (isPressed()) { 5191 setPressed(false); 5192 } 5193 if (imm != null && mAttachInfo != null 5194 && mAttachInfo.mHasWindowFocus) { 5195 imm.focusOut(this); 5196 } 5197 onFocusLost(); 5198 } else if (imm != null && mAttachInfo != null 5199 && mAttachInfo.mHasWindowFocus) { 5200 imm.focusIn(this); 5201 } 5202 5203 invalidate(true); 5204 ListenerInfo li = mListenerInfo; 5205 if (li != null && li.mOnFocusChangeListener != null) { 5206 li.mOnFocusChangeListener.onFocusChange(this, gainFocus); 5207 } 5208 5209 if (mAttachInfo != null) { 5210 mAttachInfo.mKeyDispatchState.reset(this); 5211 } 5212 } 5213 5214 /** 5215 * Sends an accessibility event of the given type. If accessibility is 5216 * not enabled this method has no effect. The default implementation calls 5217 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first 5218 * to populate information about the event source (this View), then calls 5219 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to 5220 * populate the text content of the event source including its descendants, 5221 * and last calls 5222 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)} 5223 * on its parent to resuest sending of the event to interested parties. 5224 * <p> 5225 * If an {@link AccessibilityDelegate} has been specified via calling 5226 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5227 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is 5228 * responsible for handling this call. 5229 * </p> 5230 * 5231 * @param eventType The type of the event to send, as defined by several types from 5232 * {@link android.view.accessibility.AccessibilityEvent}, such as 5233 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or 5234 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}. 5235 * 5236 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 5237 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 5238 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent) 5239 * @see AccessibilityDelegate 5240 */ 5241 public void sendAccessibilityEvent(int eventType) { 5242 if (mAccessibilityDelegate != null) { 5243 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType); 5244 } else { 5245 sendAccessibilityEventInternal(eventType); 5246 } 5247 } 5248 5249 /** 5250 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT} 5251 * {@link AccessibilityEvent} to make an announcement which is related to some 5252 * sort of a context change for which none of the events representing UI transitions 5253 * is a good fit. For example, announcing a new page in a book. If accessibility 5254 * is not enabled this method does nothing. 5255 * 5256 * @param text The announcement text. 5257 */ 5258 public void announceForAccessibility(CharSequence text) { 5259 if (AccessibilityManager.getInstance(mContext).isEnabled() && mParent != null) { 5260 AccessibilityEvent event = AccessibilityEvent.obtain( 5261 AccessibilityEvent.TYPE_ANNOUNCEMENT); 5262 onInitializeAccessibilityEvent(event); 5263 event.getText().add(text); 5264 event.setContentDescription(null); 5265 mParent.requestSendAccessibilityEvent(this, event); 5266 } 5267 } 5268 5269 /** 5270 * @see #sendAccessibilityEvent(int) 5271 * 5272 * Note: Called from the default {@link AccessibilityDelegate}. 5273 */ 5274 void sendAccessibilityEventInternal(int eventType) { 5275 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 5276 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType)); 5277 } 5278 } 5279 5280 /** 5281 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but 5282 * takes as an argument an empty {@link AccessibilityEvent} and does not 5283 * perform a check whether accessibility is enabled. 5284 * <p> 5285 * If an {@link AccessibilityDelegate} has been specified via calling 5286 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5287 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)} 5288 * is responsible for handling this call. 5289 * </p> 5290 * 5291 * @param event The event to send. 5292 * 5293 * @see #sendAccessibilityEvent(int) 5294 */ 5295 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) { 5296 if (mAccessibilityDelegate != null) { 5297 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event); 5298 } else { 5299 sendAccessibilityEventUncheckedInternal(event); 5300 } 5301 } 5302 5303 /** 5304 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent) 5305 * 5306 * Note: Called from the default {@link AccessibilityDelegate}. 5307 */ 5308 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) { 5309 if (!isShown()) { 5310 return; 5311 } 5312 onInitializeAccessibilityEvent(event); 5313 // Only a subset of accessibility events populates text content. 5314 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) { 5315 dispatchPopulateAccessibilityEvent(event); 5316 } 5317 // In the beginning we called #isShown(), so we know that getParent() is not null. 5318 getParent().requestSendAccessibilityEvent(this, event); 5319 } 5320 5321 /** 5322 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then 5323 * to its children for adding their text content to the event. Note that the 5324 * event text is populated in a separate dispatch path since we add to the 5325 * event not only the text of the source but also the text of all its descendants. 5326 * A typical implementation will call 5327 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view 5328 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 5329 * on each child. Override this method if custom population of the event text 5330 * content is required. 5331 * <p> 5332 * If an {@link AccessibilityDelegate} has been specified via calling 5333 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5334 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)} 5335 * is responsible for handling this call. 5336 * </p> 5337 * <p> 5338 * <em>Note:</em> Accessibility events of certain types are not dispatched for 5339 * populating the event text via this method. For details refer to {@link AccessibilityEvent}. 5340 * </p> 5341 * 5342 * @param event The event. 5343 * 5344 * @return True if the event population was completed. 5345 */ 5346 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 5347 if (mAccessibilityDelegate != null) { 5348 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event); 5349 } else { 5350 return dispatchPopulateAccessibilityEventInternal(event); 5351 } 5352 } 5353 5354 /** 5355 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 5356 * 5357 * Note: Called from the default {@link AccessibilityDelegate}. 5358 */ 5359 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) { 5360 onPopulateAccessibilityEvent(event); 5361 return false; 5362 } 5363 5364 /** 5365 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 5366 * giving a chance to this View to populate the accessibility event with its 5367 * text content. While this method is free to modify event 5368 * attributes other than text content, doing so should normally be performed in 5369 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}. 5370 * <p> 5371 * Example: Adding formatted date string to an accessibility event in addition 5372 * to the text added by the super implementation: 5373 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 5374 * super.onPopulateAccessibilityEvent(event); 5375 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY; 5376 * String selectedDateUtterance = DateUtils.formatDateTime(mContext, 5377 * mCurrentDate.getTimeInMillis(), flags); 5378 * event.getText().add(selectedDateUtterance); 5379 * }</pre> 5380 * <p> 5381 * If an {@link AccessibilityDelegate} has been specified via calling 5382 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5383 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)} 5384 * is responsible for handling this call. 5385 * </p> 5386 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 5387 * information to the event, in case the default implementation has basic information to add. 5388 * </p> 5389 * 5390 * @param event The accessibility event which to populate. 5391 * 5392 * @see #sendAccessibilityEvent(int) 5393 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 5394 */ 5395 public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 5396 if (mAccessibilityDelegate != null) { 5397 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event); 5398 } else { 5399 onPopulateAccessibilityEventInternal(event); 5400 } 5401 } 5402 5403 /** 5404 * @see #onPopulateAccessibilityEvent(AccessibilityEvent) 5405 * 5406 * Note: Called from the default {@link AccessibilityDelegate}. 5407 */ 5408 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) { 5409 } 5410 5411 /** 5412 * Initializes an {@link AccessibilityEvent} with information about 5413 * this View which is the event source. In other words, the source of 5414 * an accessibility event is the view whose state change triggered firing 5415 * the event. 5416 * <p> 5417 * Example: Setting the password property of an event in addition 5418 * to properties set by the super implementation: 5419 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 5420 * super.onInitializeAccessibilityEvent(event); 5421 * event.setPassword(true); 5422 * }</pre> 5423 * <p> 5424 * If an {@link AccessibilityDelegate} has been specified via calling 5425 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5426 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)} 5427 * is responsible for handling this call. 5428 * </p> 5429 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 5430 * information to the event, in case the default implementation has basic information to add. 5431 * </p> 5432 * @param event The event to initialize. 5433 * 5434 * @see #sendAccessibilityEvent(int) 5435 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 5436 */ 5437 public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 5438 if (mAccessibilityDelegate != null) { 5439 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event); 5440 } else { 5441 onInitializeAccessibilityEventInternal(event); 5442 } 5443 } 5444 5445 /** 5446 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 5447 * 5448 * Note: Called from the default {@link AccessibilityDelegate}. 5449 */ 5450 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) { 5451 event.setSource(this); 5452 event.setClassName(View.class.getName()); 5453 event.setPackageName(getContext().getPackageName()); 5454 event.setEnabled(isEnabled()); 5455 event.setContentDescription(mContentDescription); 5456 5457 switch (event.getEventType()) { 5458 case AccessibilityEvent.TYPE_VIEW_FOCUSED: { 5459 ArrayList<View> focusablesTempList = (mAttachInfo != null) 5460 ? mAttachInfo.mTempArrayList : new ArrayList<View>(); 5461 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL); 5462 event.setItemCount(focusablesTempList.size()); 5463 event.setCurrentItemIndex(focusablesTempList.indexOf(this)); 5464 if (mAttachInfo != null) { 5465 focusablesTempList.clear(); 5466 } 5467 } break; 5468 case AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED: { 5469 CharSequence text = getIterableTextForAccessibility(); 5470 if (text != null && text.length() > 0) { 5471 event.setFromIndex(getAccessibilitySelectionStart()); 5472 event.setToIndex(getAccessibilitySelectionEnd()); 5473 event.setItemCount(text.length()); 5474 } 5475 } break; 5476 } 5477 } 5478 5479 /** 5480 * Returns an {@link AccessibilityNodeInfo} representing this view from the 5481 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 5482 * This method is responsible for obtaining an accessibility node info from a 5483 * pool of reusable instances and calling 5484 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to 5485 * initialize the former. 5486 * <p> 5487 * Note: The client is responsible for recycling the obtained instance by calling 5488 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation. 5489 * </p> 5490 * 5491 * @return A populated {@link AccessibilityNodeInfo}. 5492 * 5493 * @see AccessibilityNodeInfo 5494 */ 5495 public AccessibilityNodeInfo createAccessibilityNodeInfo() { 5496 if (mAccessibilityDelegate != null) { 5497 return mAccessibilityDelegate.createAccessibilityNodeInfo(this); 5498 } else { 5499 return createAccessibilityNodeInfoInternal(); 5500 } 5501 } 5502 5503 /** 5504 * @see #createAccessibilityNodeInfo() 5505 */ 5506 AccessibilityNodeInfo createAccessibilityNodeInfoInternal() { 5507 AccessibilityNodeProvider provider = getAccessibilityNodeProvider(); 5508 if (provider != null) { 5509 return provider.createAccessibilityNodeInfo(View.NO_ID); 5510 } else { 5511 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this); 5512 onInitializeAccessibilityNodeInfo(info); 5513 return info; 5514 } 5515 } 5516 5517 /** 5518 * Initializes an {@link AccessibilityNodeInfo} with information about this view. 5519 * The base implementation sets: 5520 * <ul> 5521 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li> 5522 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li> 5523 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li> 5524 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li> 5525 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li> 5526 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li> 5527 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li> 5528 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li> 5529 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li> 5530 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li> 5531 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li> 5532 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li> 5533 * </ul> 5534 * <p> 5535 * Subclasses should override this method, call the super implementation, 5536 * and set additional attributes. 5537 * </p> 5538 * <p> 5539 * If an {@link AccessibilityDelegate} has been specified via calling 5540 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5541 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)} 5542 * is responsible for handling this call. 5543 * </p> 5544 * 5545 * @param info The instance to initialize. 5546 */ 5547 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 5548 if (mAccessibilityDelegate != null) { 5549 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info); 5550 } else { 5551 onInitializeAccessibilityNodeInfoInternal(info); 5552 } 5553 } 5554 5555 /** 5556 * Gets the location of this view in screen coordintates. 5557 * 5558 * @param outRect The output location 5559 * @hide 5560 */ 5561 public void getBoundsOnScreen(Rect outRect) { 5562 if (mAttachInfo == null) { 5563 return; 5564 } 5565 5566 RectF position = mAttachInfo.mTmpTransformRect; 5567 position.set(0, 0, mRight - mLeft, mBottom - mTop); 5568 5569 if (!hasIdentityMatrix()) { 5570 getMatrix().mapRect(position); 5571 } 5572 5573 position.offset(mLeft, mTop); 5574 5575 ViewParent parent = mParent; 5576 while (parent instanceof View) { 5577 View parentView = (View) parent; 5578 5579 position.offset(-parentView.mScrollX, -parentView.mScrollY); 5580 5581 if (!parentView.hasIdentityMatrix()) { 5582 parentView.getMatrix().mapRect(position); 5583 } 5584 5585 position.offset(parentView.mLeft, parentView.mTop); 5586 5587 parent = parentView.mParent; 5588 } 5589 5590 if (parent instanceof ViewRootImpl) { 5591 ViewRootImpl viewRootImpl = (ViewRootImpl) parent; 5592 position.offset(0, -viewRootImpl.mCurScrollY); 5593 } 5594 5595 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop); 5596 5597 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f), 5598 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f)); 5599 } 5600 5601 /** 5602 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 5603 * 5604 * Note: Called from the default {@link AccessibilityDelegate}. 5605 */ 5606 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) { 5607 Rect bounds = mAttachInfo.mTmpInvalRect; 5608 5609 getDrawingRect(bounds); 5610 info.setBoundsInParent(bounds); 5611 5612 getBoundsOnScreen(bounds); 5613 info.setBoundsInScreen(bounds); 5614 5615 ViewParent parent = getParentForAccessibility(); 5616 if (parent instanceof View) { 5617 info.setParent((View) parent); 5618 } 5619 5620 if (mID != View.NO_ID) { 5621 View rootView = getRootView(); 5622 if (rootView == null) { 5623 rootView = this; 5624 } 5625 5626 View label = rootView.findLabelForView(this, mID); 5627 if (label != null) { 5628 info.setLabeledBy(label); 5629 } 5630 5631 if ((mAttachInfo.mAccessibilityFetchFlags 5632 & AccessibilityNodeInfo.FLAG_REPORT_VIEW_IDS) != 0 5633 && Resources.resourceHasPackage(mID)) { 5634 try { 5635 String viewId = getResources().getResourceName(mID); 5636 info.setViewIdResourceName(viewId); 5637 } catch (Resources.NotFoundException nfe) { 5638 /* ignore */ 5639 } 5640 } 5641 } 5642 5643 if (mLabelForId != View.NO_ID) { 5644 View rootView = getRootView(); 5645 if (rootView == null) { 5646 rootView = this; 5647 } 5648 View labeled = rootView.findViewInsideOutShouldExist(this, mLabelForId); 5649 if (labeled != null) { 5650 info.setLabelFor(labeled); 5651 } 5652 } 5653 5654 if (mAccessibilityTraversalBeforeId != View.NO_ID) { 5655 View rootView = getRootView(); 5656 if (rootView == null) { 5657 rootView = this; 5658 } 5659 View next = rootView.findViewInsideOutShouldExist(this, 5660 mAccessibilityTraversalBeforeId); 5661 if (next != null) { 5662 info.setTraversalBefore(next); 5663 } 5664 } 5665 5666 if (mAccessibilityTraversalAfterId != View.NO_ID) { 5667 View rootView = getRootView(); 5668 if (rootView == null) { 5669 rootView = this; 5670 } 5671 View next = rootView.findViewInsideOutShouldExist(this, 5672 mAccessibilityTraversalAfterId); 5673 if (next != null) { 5674 info.setTraversalAfter(next); 5675 } 5676 } 5677 5678 info.setVisibleToUser(isVisibleToUser()); 5679 5680 info.setPackageName(mContext.getPackageName()); 5681 info.setClassName(View.class.getName()); 5682 info.setContentDescription(getContentDescription()); 5683 5684 info.setEnabled(isEnabled()); 5685 info.setClickable(isClickable()); 5686 info.setFocusable(isFocusable()); 5687 info.setFocused(isFocused()); 5688 info.setAccessibilityFocused(isAccessibilityFocused()); 5689 info.setSelected(isSelected()); 5690 info.setLongClickable(isLongClickable()); 5691 info.setLiveRegion(getAccessibilityLiveRegion()); 5692 5693 // TODO: These make sense only if we are in an AdapterView but all 5694 // views can be selected. Maybe from accessibility perspective 5695 // we should report as selectable view in an AdapterView. 5696 info.addAction(AccessibilityNodeInfo.ACTION_SELECT); 5697 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION); 5698 5699 if (isFocusable()) { 5700 if (isFocused()) { 5701 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS); 5702 } else { 5703 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS); 5704 } 5705 } 5706 5707 if (!isAccessibilityFocused()) { 5708 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS); 5709 } else { 5710 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS); 5711 } 5712 5713 if (isClickable() && isEnabled()) { 5714 info.addAction(AccessibilityNodeInfo.ACTION_CLICK); 5715 } 5716 5717 if (isLongClickable() && isEnabled()) { 5718 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK); 5719 } 5720 5721 CharSequence text = getIterableTextForAccessibility(); 5722 if (text != null && text.length() > 0) { 5723 info.setTextSelection(getAccessibilitySelectionStart(), getAccessibilitySelectionEnd()); 5724 5725 info.addAction(AccessibilityNodeInfo.ACTION_SET_SELECTION); 5726 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY); 5727 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY); 5728 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER 5729 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD 5730 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH); 5731 } 5732 } 5733 5734 private View findLabelForView(View view, int labeledId) { 5735 if (mMatchLabelForPredicate == null) { 5736 mMatchLabelForPredicate = new MatchLabelForPredicate(); 5737 } 5738 mMatchLabelForPredicate.mLabeledId = labeledId; 5739 return findViewByPredicateInsideOut(view, mMatchLabelForPredicate); 5740 } 5741 5742 /** 5743 * Computes whether this view is visible to the user. Such a view is 5744 * attached, visible, all its predecessors are visible, it is not clipped 5745 * entirely by its predecessors, and has an alpha greater than zero. 5746 * 5747 * @return Whether the view is visible on the screen. 5748 * 5749 * @hide 5750 */ 5751 protected boolean isVisibleToUser() { 5752 return isVisibleToUser(null); 5753 } 5754 5755 /** 5756 * Computes whether the given portion of this view is visible to the user. 5757 * Such a view is attached, visible, all its predecessors are visible, 5758 * has an alpha greater than zero, and the specified portion is not 5759 * clipped entirely by its predecessors. 5760 * 5761 * @param boundInView the portion of the view to test; coordinates should be relative; may be 5762 * <code>null</code>, and the entire view will be tested in this case. 5763 * When <code>true</code> is returned by the function, the actual visible 5764 * region will be stored in this parameter; that is, if boundInView is fully 5765 * contained within the view, no modification will be made, otherwise regions 5766 * outside of the visible area of the view will be clipped. 5767 * 5768 * @return Whether the specified portion of the view is visible on the screen. 5769 * 5770 * @hide 5771 */ 5772 protected boolean isVisibleToUser(Rect boundInView) { 5773 if (mAttachInfo != null) { 5774 // Attached to invisible window means this view is not visible. 5775 if (mAttachInfo.mWindowVisibility != View.VISIBLE) { 5776 return false; 5777 } 5778 // An invisible predecessor or one with alpha zero means 5779 // that this view is not visible to the user. 5780 Object current = this; 5781 while (current instanceof View) { 5782 View view = (View) current; 5783 // We have attach info so this view is attached and there is no 5784 // need to check whether we reach to ViewRootImpl on the way up. 5785 if (view.getAlpha() <= 0 || view.getTransitionAlpha() <= 0 || 5786 view.getVisibility() != VISIBLE) { 5787 return false; 5788 } 5789 current = view.mParent; 5790 } 5791 // Check if the view is entirely covered by its predecessors. 5792 Rect visibleRect = mAttachInfo.mTmpInvalRect; 5793 Point offset = mAttachInfo.mPoint; 5794 if (!getGlobalVisibleRect(visibleRect, offset)) { 5795 return false; 5796 } 5797 // Check if the visible portion intersects the rectangle of interest. 5798 if (boundInView != null) { 5799 visibleRect.offset(-offset.x, -offset.y); 5800 return boundInView.intersect(visibleRect); 5801 } 5802 return true; 5803 } 5804 return false; 5805 } 5806 5807 /** 5808 * Computes a point on which a sequence of a down/up event can be sent to 5809 * trigger clicking this view. This method is for the exclusive use by the 5810 * accessibility layer to determine where to send a click event in explore 5811 * by touch mode. 5812 * 5813 * @param interactiveRegion The interactive portion of this window. 5814 * @param outPoint The point to populate. 5815 * @return True of such a point exists. 5816 */ 5817 boolean computeClickPointInScreenForAccessibility(Region interactiveRegion, 5818 Point outPoint) { 5819 // Since the interactive portion of the view is a region but as a view 5820 // may have a transformation matrix which cannot be applied to a 5821 // region we compute the view bounds rectangle and all interactive 5822 // predecessor's and sibling's (siblings of predecessors included) 5823 // rectangles that intersect the view bounds. At the 5824 // end if the view was partially covered by another interactive 5825 // view we compute the view's interactive region and pick a point 5826 // on its boundary path as regions do not offer APIs to get inner 5827 // points. Note that the the code is optimized to fail early and 5828 // avoid unnecessary allocations plus computations. 5829 5830 // The current approach has edge cases that may produce false 5831 // positives or false negatives. For example, a portion of the 5832 // view may be covered by an interactive descendant of a 5833 // predecessor, which we do not compute. Also a view may be handling 5834 // raw touch events instead registering click listeners, which 5835 // we cannot compute. Despite these limitations this approach will 5836 // work most of the time and it is a huge improvement over just 5837 // blindly sending the down and up events in the center of the 5838 // view. 5839 5840 // Cannot click on an unattached view. 5841 if (mAttachInfo == null) { 5842 return false; 5843 } 5844 5845 // Attached to an invisible window means this view is not visible. 5846 if (mAttachInfo.mWindowVisibility != View.VISIBLE) { 5847 return false; 5848 } 5849 5850 RectF bounds = mAttachInfo.mTmpTransformRect; 5851 bounds.set(0, 0, getWidth(), getHeight()); 5852 List<RectF> intersections = mAttachInfo.mTmpRectList; 5853 intersections.clear(); 5854 5855 if (mParent instanceof ViewGroup) { 5856 ViewGroup parentGroup = (ViewGroup) mParent; 5857 if (!parentGroup.translateBoundsAndIntersectionsInWindowCoordinates( 5858 this, bounds, intersections)) { 5859 intersections.clear(); 5860 return false; 5861 } 5862 } 5863 5864 // Take into account the window location. 5865 final int dx = mAttachInfo.mWindowLeft; 5866 final int dy = mAttachInfo.mWindowTop; 5867 bounds.offset(dx, dy); 5868 offsetRects(intersections, dx, dy); 5869 5870 if (intersections.isEmpty() && interactiveRegion == null) { 5871 outPoint.set((int) bounds.centerX(), (int) bounds.centerY()); 5872 } else { 5873 // This view is partially covered by other views, then compute 5874 // the not covered region and pick a point on its boundary. 5875 Region region = new Region(); 5876 region.set((int) bounds.left, (int) bounds.top, 5877 (int) bounds.right, (int) bounds.bottom); 5878 5879 final int intersectionCount = intersections.size(); 5880 for (int i = intersectionCount - 1; i >= 0; i--) { 5881 RectF intersection = intersections.remove(i); 5882 region.op((int) intersection.left, (int) intersection.top, 5883 (int) intersection.right, (int) intersection.bottom, 5884 Region.Op.DIFFERENCE); 5885 } 5886 5887 // If the view is completely covered, done. 5888 if (region.isEmpty()) { 5889 return false; 5890 } 5891 5892 // Take into account the interactive portion of the window 5893 // as the rest is covered by other windows. If no such a region 5894 // then the whole window is interactive. 5895 if (interactiveRegion != null) { 5896 region.op(interactiveRegion, Region.Op.INTERSECT); 5897 } 5898 5899 // Take into account the window bounds. 5900 final View root = getRootView(); 5901 if (root != null) { 5902 region.op(dx, dy, root.getWidth() + dx, root.getHeight() + dy, Region.Op.INTERSECT); 5903 } 5904 5905 // If the view is completely covered, done. 5906 if (region.isEmpty()) { 5907 return false; 5908 } 5909 5910 // Try a shortcut here. 5911 if (region.isRect()) { 5912 Rect regionBounds = mAttachInfo.mTmpInvalRect; 5913 region.getBounds(regionBounds); 5914 outPoint.set(regionBounds.centerX(), regionBounds.centerY()); 5915 return true; 5916 } 5917 5918 // Get the a point on the region boundary path. 5919 Path path = region.getBoundaryPath(); 5920 PathMeasure pathMeasure = new PathMeasure(path, false); 5921 final float[] coordinates = mAttachInfo.mTmpTransformLocation; 5922 5923 // Without loss of generality pick a point. 5924 final float point = pathMeasure.getLength() * 0.01f; 5925 if (!pathMeasure.getPosTan(point, coordinates, null)) { 5926 return false; 5927 } 5928 5929 outPoint.set(Math.round(coordinates[0]), Math.round(coordinates[1])); 5930 } 5931 5932 return true; 5933 } 5934 5935 static void offsetRects(List<RectF> rects, float offsetX, float offsetY) { 5936 final int rectCount = rects.size(); 5937 for (int i = 0; i < rectCount; i++) { 5938 RectF intersection = rects.get(i); 5939 intersection.offset(offsetX, offsetY); 5940 } 5941 } 5942 5943 /** 5944 * Returns the delegate for implementing accessibility support via 5945 * composition. For more details see {@link AccessibilityDelegate}. 5946 * 5947 * @return The delegate, or null if none set. 5948 * 5949 * @hide 5950 */ 5951 public AccessibilityDelegate getAccessibilityDelegate() { 5952 return mAccessibilityDelegate; 5953 } 5954 5955 /** 5956 * Sets a delegate for implementing accessibility support via composition as 5957 * opposed to inheritance. The delegate's primary use is for implementing 5958 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 5959 * 5960 * @param delegate The delegate instance. 5961 * 5962 * @see AccessibilityDelegate 5963 */ 5964 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 5965 mAccessibilityDelegate = delegate; 5966 } 5967 5968 /** 5969 * Gets the provider for managing a virtual view hierarchy rooted at this View 5970 * and reported to {@link android.accessibilityservice.AccessibilityService}s 5971 * that explore the window content. 5972 * <p> 5973 * If this method returns an instance, this instance is responsible for managing 5974 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 5975 * View including the one representing the View itself. Similarly the returned 5976 * instance is responsible for performing accessibility actions on any virtual 5977 * view or the root view itself. 5978 * </p> 5979 * <p> 5980 * If an {@link AccessibilityDelegate} has been specified via calling 5981 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5982 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 5983 * is responsible for handling this call. 5984 * </p> 5985 * 5986 * @return The provider. 5987 * 5988 * @see AccessibilityNodeProvider 5989 */ 5990 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 5991 if (mAccessibilityDelegate != null) { 5992 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 5993 } else { 5994 return null; 5995 } 5996 } 5997 5998 /** 5999 * Gets the unique identifier of this view on the screen for accessibility purposes. 6000 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 6001 * 6002 * @return The view accessibility id. 6003 * 6004 * @hide 6005 */ 6006 public int getAccessibilityViewId() { 6007 if (mAccessibilityViewId == NO_ID) { 6008 mAccessibilityViewId = sNextAccessibilityViewId++; 6009 } 6010 return mAccessibilityViewId; 6011 } 6012 6013 /** 6014 * Gets the unique identifier of the window in which this View reseides. 6015 * 6016 * @return The window accessibility id. 6017 * 6018 * @hide 6019 */ 6020 public int getAccessibilityWindowId() { 6021 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId 6022 : AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 6023 } 6024 6025 /** 6026 * Gets the {@link View} description. It briefly describes the view and is 6027 * primarily used for accessibility support. Set this property to enable 6028 * better accessibility support for your application. This is especially 6029 * true for views that do not have textual representation (For example, 6030 * ImageButton). 6031 * 6032 * @return The content description. 6033 * 6034 * @attr ref android.R.styleable#View_contentDescription 6035 */ 6036 @ViewDebug.ExportedProperty(category = "accessibility") 6037 public CharSequence getContentDescription() { 6038 return mContentDescription; 6039 } 6040 6041 /** 6042 * Sets the {@link View} description. It briefly describes the view and is 6043 * primarily used for accessibility support. Set this property to enable 6044 * better accessibility support for your application. This is especially 6045 * true for views that do not have textual representation (For example, 6046 * ImageButton). 6047 * 6048 * @param contentDescription The content description. 6049 * 6050 * @attr ref android.R.styleable#View_contentDescription 6051 */ 6052 @RemotableViewMethod 6053 public void setContentDescription(CharSequence contentDescription) { 6054 if (mContentDescription == null) { 6055 if (contentDescription == null) { 6056 return; 6057 } 6058 } else if (mContentDescription.equals(contentDescription)) { 6059 return; 6060 } 6061 mContentDescription = contentDescription; 6062 final boolean nonEmptyDesc = contentDescription != null && contentDescription.length() > 0; 6063 if (nonEmptyDesc && getImportantForAccessibility() == IMPORTANT_FOR_ACCESSIBILITY_AUTO) { 6064 setImportantForAccessibility(IMPORTANT_FOR_ACCESSIBILITY_YES); 6065 notifySubtreeAccessibilityStateChangedIfNeeded(); 6066 } else { 6067 notifyViewAccessibilityStateChangedIfNeeded( 6068 AccessibilityEvent.CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION); 6069 } 6070 } 6071 6072 /** 6073 * Sets the id of a view before which this one is visited in accessibility traversal. 6074 * A screen-reader must visit the content of this view before the content of the one 6075 * it precedes. For example, if view B is set to be before view A, then a screen-reader 6076 * will traverse the entire content of B before traversing the entire content of A, 6077 * regardles of what traversal strategy it is using. 6078 * <p> 6079 * Views that do not have specified before/after relationships are traversed in order 6080 * determined by the screen-reader. 6081 * </p> 6082 * <p> 6083 * Setting that this view is before a view that is not important for accessibility 6084 * or if this view is not important for accessibility will have no effect as the 6085 * screen-reader is not aware of unimportant views. 6086 * </p> 6087 * 6088 * @param beforeId The id of a view this one precedes in accessibility traversal. 6089 * 6090 * @attr ref android.R.styleable#View_accessibilityTraversalBefore 6091 * 6092 * @see #setImportantForAccessibility(int) 6093 */ 6094 @RemotableViewMethod 6095 public void setAccessibilityTraversalBefore(int beforeId) { 6096 if (mAccessibilityTraversalBeforeId == beforeId) { 6097 return; 6098 } 6099 mAccessibilityTraversalBeforeId = beforeId; 6100 notifyViewAccessibilityStateChangedIfNeeded( 6101 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6102 } 6103 6104 /** 6105 * Gets the id of a view before which this one is visited in accessibility traversal. 6106 * 6107 * @return The id of a view this one precedes in accessibility traversal if 6108 * specified, otherwise {@link #NO_ID}. 6109 * 6110 * @see #setAccessibilityTraversalBefore(int) 6111 */ 6112 public int getAccessibilityTraversalBefore() { 6113 return mAccessibilityTraversalBeforeId; 6114 } 6115 6116 /** 6117 * Sets the id of a view after which this one is visited in accessibility traversal. 6118 * A screen-reader must visit the content of the other view before the content of this 6119 * one. For example, if view B is set to be after view A, then a screen-reader 6120 * will traverse the entire content of A before traversing the entire content of B, 6121 * regardles of what traversal strategy it is using. 6122 * <p> 6123 * Views that do not have specified before/after relationships are traversed in order 6124 * determined by the screen-reader. 6125 * </p> 6126 * <p> 6127 * Setting that this view is after a view that is not important for accessibility 6128 * or if this view is not important for accessibility will have no effect as the 6129 * screen-reader is not aware of unimportant views. 6130 * </p> 6131 * 6132 * @param afterId The id of a view this one succedees in accessibility traversal. 6133 * 6134 * @attr ref android.R.styleable#View_accessibilityTraversalAfter 6135 * 6136 * @see #setImportantForAccessibility(int) 6137 */ 6138 @RemotableViewMethod 6139 public void setAccessibilityTraversalAfter(int afterId) { 6140 if (mAccessibilityTraversalAfterId == afterId) { 6141 return; 6142 } 6143 mAccessibilityTraversalAfterId = afterId; 6144 notifyViewAccessibilityStateChangedIfNeeded( 6145 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6146 } 6147 6148 /** 6149 * Gets the id of a view after which this one is visited in accessibility traversal. 6150 * 6151 * @return The id of a view this one succeedes in accessibility traversal if 6152 * specified, otherwise {@link #NO_ID}. 6153 * 6154 * @see #setAccessibilityTraversalAfter(int) 6155 */ 6156 public int getAccessibilityTraversalAfter() { 6157 return mAccessibilityTraversalAfterId; 6158 } 6159 6160 /** 6161 * Gets the id of a view for which this view serves as a label for 6162 * accessibility purposes. 6163 * 6164 * @return The labeled view id. 6165 */ 6166 @ViewDebug.ExportedProperty(category = "accessibility") 6167 public int getLabelFor() { 6168 return mLabelForId; 6169 } 6170 6171 /** 6172 * Sets the id of a view for which this view serves as a label for 6173 * accessibility purposes. 6174 * 6175 * @param id The labeled view id. 6176 */ 6177 @RemotableViewMethod 6178 public void setLabelFor(int id) { 6179 if (mLabelForId == id) { 6180 return; 6181 } 6182 mLabelForId = id; 6183 if (mLabelForId != View.NO_ID 6184 && mID == View.NO_ID) { 6185 mID = generateViewId(); 6186 } 6187 notifyViewAccessibilityStateChangedIfNeeded( 6188 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6189 } 6190 6191 /** 6192 * Invoked whenever this view loses focus, either by losing window focus or by losing 6193 * focus within its window. This method can be used to clear any state tied to the 6194 * focus. For instance, if a button is held pressed with the trackball and the window 6195 * loses focus, this method can be used to cancel the press. 6196 * 6197 * Subclasses of View overriding this method should always call super.onFocusLost(). 6198 * 6199 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 6200 * @see #onWindowFocusChanged(boolean) 6201 * 6202 * @hide pending API council approval 6203 */ 6204 protected void onFocusLost() { 6205 resetPressedState(); 6206 } 6207 6208 private void resetPressedState() { 6209 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 6210 return; 6211 } 6212 6213 if (isPressed()) { 6214 setPressed(false); 6215 6216 if (!mHasPerformedLongPress) { 6217 removeLongPressCallback(); 6218 } 6219 } 6220 } 6221 6222 /** 6223 * Returns true if this view has focus 6224 * 6225 * @return True if this view has focus, false otherwise. 6226 */ 6227 @ViewDebug.ExportedProperty(category = "focus") 6228 public boolean isFocused() { 6229 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 6230 } 6231 6232 /** 6233 * Find the view in the hierarchy rooted at this view that currently has 6234 * focus. 6235 * 6236 * @return The view that currently has focus, or null if no focused view can 6237 * be found. 6238 */ 6239 public View findFocus() { 6240 return (mPrivateFlags & PFLAG_FOCUSED) != 0 ? this : null; 6241 } 6242 6243 /** 6244 * Indicates whether this view is one of the set of scrollable containers in 6245 * its window. 6246 * 6247 * @return whether this view is one of the set of scrollable containers in 6248 * its window 6249 * 6250 * @attr ref android.R.styleable#View_isScrollContainer 6251 */ 6252 public boolean isScrollContainer() { 6253 return (mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0; 6254 } 6255 6256 /** 6257 * Change whether this view is one of the set of scrollable containers in 6258 * its window. This will be used to determine whether the window can 6259 * resize or must pan when a soft input area is open -- scrollable 6260 * containers allow the window to use resize mode since the container 6261 * will appropriately shrink. 6262 * 6263 * @attr ref android.R.styleable#View_isScrollContainer 6264 */ 6265 public void setScrollContainer(boolean isScrollContainer) { 6266 if (isScrollContainer) { 6267 if (mAttachInfo != null && (mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) == 0) { 6268 mAttachInfo.mScrollContainers.add(this); 6269 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 6270 } 6271 mPrivateFlags |= PFLAG_SCROLL_CONTAINER; 6272 } else { 6273 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 6274 mAttachInfo.mScrollContainers.remove(this); 6275 } 6276 mPrivateFlags &= ~(PFLAG_SCROLL_CONTAINER|PFLAG_SCROLL_CONTAINER_ADDED); 6277 } 6278 } 6279 6280 /** 6281 * Returns the quality of the drawing cache. 6282 * 6283 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6284 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6285 * 6286 * @see #setDrawingCacheQuality(int) 6287 * @see #setDrawingCacheEnabled(boolean) 6288 * @see #isDrawingCacheEnabled() 6289 * 6290 * @attr ref android.R.styleable#View_drawingCacheQuality 6291 */ 6292 @DrawingCacheQuality 6293 public int getDrawingCacheQuality() { 6294 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 6295 } 6296 6297 /** 6298 * Set the drawing cache quality of this view. This value is used only when the 6299 * drawing cache is enabled 6300 * 6301 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6302 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6303 * 6304 * @see #getDrawingCacheQuality() 6305 * @see #setDrawingCacheEnabled(boolean) 6306 * @see #isDrawingCacheEnabled() 6307 * 6308 * @attr ref android.R.styleable#View_drawingCacheQuality 6309 */ 6310 public void setDrawingCacheQuality(@DrawingCacheQuality int quality) { 6311 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 6312 } 6313 6314 /** 6315 * Returns whether the screen should remain on, corresponding to the current 6316 * value of {@link #KEEP_SCREEN_ON}. 6317 * 6318 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 6319 * 6320 * @see #setKeepScreenOn(boolean) 6321 * 6322 * @attr ref android.R.styleable#View_keepScreenOn 6323 */ 6324 public boolean getKeepScreenOn() { 6325 return (mViewFlags & KEEP_SCREEN_ON) != 0; 6326 } 6327 6328 /** 6329 * Controls whether the screen should remain on, modifying the 6330 * value of {@link #KEEP_SCREEN_ON}. 6331 * 6332 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 6333 * 6334 * @see #getKeepScreenOn() 6335 * 6336 * @attr ref android.R.styleable#View_keepScreenOn 6337 */ 6338 public void setKeepScreenOn(boolean keepScreenOn) { 6339 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 6340 } 6341 6342 /** 6343 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6344 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6345 * 6346 * @attr ref android.R.styleable#View_nextFocusLeft 6347 */ 6348 public int getNextFocusLeftId() { 6349 return mNextFocusLeftId; 6350 } 6351 6352 /** 6353 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6354 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 6355 * decide automatically. 6356 * 6357 * @attr ref android.R.styleable#View_nextFocusLeft 6358 */ 6359 public void setNextFocusLeftId(int nextFocusLeftId) { 6360 mNextFocusLeftId = nextFocusLeftId; 6361 } 6362 6363 /** 6364 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6365 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6366 * 6367 * @attr ref android.R.styleable#View_nextFocusRight 6368 */ 6369 public int getNextFocusRightId() { 6370 return mNextFocusRightId; 6371 } 6372 6373 /** 6374 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6375 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 6376 * decide automatically. 6377 * 6378 * @attr ref android.R.styleable#View_nextFocusRight 6379 */ 6380 public void setNextFocusRightId(int nextFocusRightId) { 6381 mNextFocusRightId = nextFocusRightId; 6382 } 6383 6384 /** 6385 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6386 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6387 * 6388 * @attr ref android.R.styleable#View_nextFocusUp 6389 */ 6390 public int getNextFocusUpId() { 6391 return mNextFocusUpId; 6392 } 6393 6394 /** 6395 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6396 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 6397 * decide automatically. 6398 * 6399 * @attr ref android.R.styleable#View_nextFocusUp 6400 */ 6401 public void setNextFocusUpId(int nextFocusUpId) { 6402 mNextFocusUpId = nextFocusUpId; 6403 } 6404 6405 /** 6406 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6407 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6408 * 6409 * @attr ref android.R.styleable#View_nextFocusDown 6410 */ 6411 public int getNextFocusDownId() { 6412 return mNextFocusDownId; 6413 } 6414 6415 /** 6416 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6417 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 6418 * decide automatically. 6419 * 6420 * @attr ref android.R.styleable#View_nextFocusDown 6421 */ 6422 public void setNextFocusDownId(int nextFocusDownId) { 6423 mNextFocusDownId = nextFocusDownId; 6424 } 6425 6426 /** 6427 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6428 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6429 * 6430 * @attr ref android.R.styleable#View_nextFocusForward 6431 */ 6432 public int getNextFocusForwardId() { 6433 return mNextFocusForwardId; 6434 } 6435 6436 /** 6437 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6438 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 6439 * decide automatically. 6440 * 6441 * @attr ref android.R.styleable#View_nextFocusForward 6442 */ 6443 public void setNextFocusForwardId(int nextFocusForwardId) { 6444 mNextFocusForwardId = nextFocusForwardId; 6445 } 6446 6447 /** 6448 * Returns the visibility of this view and all of its ancestors 6449 * 6450 * @return True if this view and all of its ancestors are {@link #VISIBLE} 6451 */ 6452 public boolean isShown() { 6453 View current = this; 6454 //noinspection ConstantConditions 6455 do { 6456 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6457 return false; 6458 } 6459 ViewParent parent = current.mParent; 6460 if (parent == null) { 6461 return false; // We are not attached to the view root 6462 } 6463 if (!(parent instanceof View)) { 6464 return true; 6465 } 6466 current = (View) parent; 6467 } while (current != null); 6468 6469 return false; 6470 } 6471 6472 /** 6473 * Called by the view hierarchy when the content insets for a window have 6474 * changed, to allow it to adjust its content to fit within those windows. 6475 * The content insets tell you the space that the status bar, input method, 6476 * and other system windows infringe on the application's window. 6477 * 6478 * <p>You do not normally need to deal with this function, since the default 6479 * window decoration given to applications takes care of applying it to the 6480 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 6481 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case, 6482 * and your content can be placed under those system elements. You can then 6483 * use this method within your view hierarchy if you have parts of your UI 6484 * which you would like to ensure are not being covered. 6485 * 6486 * <p>The default implementation of this method simply applies the content 6487 * insets to the view's padding, consuming that content (modifying the 6488 * insets to be 0), and returning true. This behavior is off by default, but can 6489 * be enabled through {@link #setFitsSystemWindows(boolean)}. 6490 * 6491 * <p>This function's traversal down the hierarchy is depth-first. The same content 6492 * insets object is propagated down the hierarchy, so any changes made to it will 6493 * be seen by all following views (including potentially ones above in 6494 * the hierarchy since this is a depth-first traversal). The first view 6495 * that returns true will abort the entire traversal. 6496 * 6497 * <p>The default implementation works well for a situation where it is 6498 * used with a container that covers the entire window, allowing it to 6499 * apply the appropriate insets to its content on all edges. If you need 6500 * a more complicated layout (such as two different views fitting system 6501 * windows, one on the top of the window, and one on the bottom), 6502 * you can override the method and handle the insets however you would like. 6503 * Note that the insets provided by the framework are always relative to the 6504 * far edges of the window, not accounting for the location of the called view 6505 * within that window. (In fact when this method is called you do not yet know 6506 * where the layout will place the view, as it is done before layout happens.) 6507 * 6508 * <p>Note: unlike many View methods, there is no dispatch phase to this 6509 * call. If you are overriding it in a ViewGroup and want to allow the 6510 * call to continue to your children, you must be sure to call the super 6511 * implementation. 6512 * 6513 * <p>Here is a sample layout that makes use of fitting system windows 6514 * to have controls for a video view placed inside of the window decorations 6515 * that it hides and shows. This can be used with code like the second 6516 * sample (video player) shown in {@link #setSystemUiVisibility(int)}. 6517 * 6518 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete} 6519 * 6520 * @param insets Current content insets of the window. Prior to 6521 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify 6522 * the insets or else you and Android will be unhappy. 6523 * 6524 * @return {@code true} if this view applied the insets and it should not 6525 * continue propagating further down the hierarchy, {@code false} otherwise. 6526 * @see #getFitsSystemWindows() 6527 * @see #setFitsSystemWindows(boolean) 6528 * @see #setSystemUiVisibility(int) 6529 * 6530 * @deprecated As of API 20 use {@link #dispatchApplyWindowInsets(WindowInsets)} to apply 6531 * insets to views. Views should override {@link #onApplyWindowInsets(WindowInsets)} or use 6532 * {@link #setOnApplyWindowInsetsListener(android.view.View.OnApplyWindowInsetsListener)} 6533 * to implement handling their own insets. 6534 */ 6535 protected boolean fitSystemWindows(Rect insets) { 6536 if ((mPrivateFlags3 & PFLAG3_APPLYING_INSETS) == 0) { 6537 if (insets == null) { 6538 // Null insets by definition have already been consumed. 6539 // This call cannot apply insets since there are none to apply, 6540 // so return false. 6541 return false; 6542 } 6543 // If we're not in the process of dispatching the newer apply insets call, 6544 // that means we're not in the compatibility path. Dispatch into the newer 6545 // apply insets path and take things from there. 6546 try { 6547 mPrivateFlags3 |= PFLAG3_FITTING_SYSTEM_WINDOWS; 6548 return dispatchApplyWindowInsets(new WindowInsets(insets)).isConsumed(); 6549 } finally { 6550 mPrivateFlags3 &= ~PFLAG3_FITTING_SYSTEM_WINDOWS; 6551 } 6552 } else { 6553 // We're being called from the newer apply insets path. 6554 // Perform the standard fallback behavior. 6555 return fitSystemWindowsInt(insets); 6556 } 6557 } 6558 6559 private boolean fitSystemWindowsInt(Rect insets) { 6560 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 6561 mUserPaddingStart = UNDEFINED_PADDING; 6562 mUserPaddingEnd = UNDEFINED_PADDING; 6563 Rect localInsets = sThreadLocal.get(); 6564 if (localInsets == null) { 6565 localInsets = new Rect(); 6566 sThreadLocal.set(localInsets); 6567 } 6568 boolean res = computeFitSystemWindows(insets, localInsets); 6569 mUserPaddingLeftInitial = localInsets.left; 6570 mUserPaddingRightInitial = localInsets.right; 6571 internalSetPadding(localInsets.left, localInsets.top, 6572 localInsets.right, localInsets.bottom); 6573 return res; 6574 } 6575 return false; 6576 } 6577 6578 /** 6579 * Called when the view should apply {@link WindowInsets} according to its internal policy. 6580 * 6581 * <p>This method should be overridden by views that wish to apply a policy different from or 6582 * in addition to the default behavior. Clients that wish to force a view subtree 6583 * to apply insets should call {@link #dispatchApplyWindowInsets(WindowInsets)}.</p> 6584 * 6585 * <p>Clients may supply an {@link OnApplyWindowInsetsListener} to a view. If one is set 6586 * it will be called during dispatch instead of this method. The listener may optionally 6587 * call this method from its own implementation if it wishes to apply the view's default 6588 * insets policy in addition to its own.</p> 6589 * 6590 * <p>Implementations of this method should either return the insets parameter unchanged 6591 * or a new {@link WindowInsets} cloned from the supplied insets with any insets consumed 6592 * that this view applied itself. This allows new inset types added in future platform 6593 * versions to pass through existing implementations unchanged without being erroneously 6594 * consumed.</p> 6595 * 6596 * <p>By default if a view's {@link #setFitsSystemWindows(boolean) fitsSystemWindows} 6597 * property is set then the view will consume the system window insets and apply them 6598 * as padding for the view.</p> 6599 * 6600 * @param insets Insets to apply 6601 * @return The supplied insets with any applied insets consumed 6602 */ 6603 public WindowInsets onApplyWindowInsets(WindowInsets insets) { 6604 if ((mPrivateFlags3 & PFLAG3_FITTING_SYSTEM_WINDOWS) == 0) { 6605 // We weren't called from within a direct call to fitSystemWindows, 6606 // call into it as a fallback in case we're in a class that overrides it 6607 // and has logic to perform. 6608 if (fitSystemWindows(insets.getSystemWindowInsets())) { 6609 return insets.consumeSystemWindowInsets(); 6610 } 6611 } else { 6612 // We were called from within a direct call to fitSystemWindows. 6613 if (fitSystemWindowsInt(insets.getSystemWindowInsets())) { 6614 return insets.consumeSystemWindowInsets(); 6615 } 6616 } 6617 return insets; 6618 } 6619 6620 /** 6621 * Set an {@link OnApplyWindowInsetsListener} to take over the policy for applying 6622 * window insets to this view. The listener's 6623 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 6624 * method will be called instead of the view's 6625 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 6626 * 6627 * @param listener Listener to set 6628 * 6629 * @see #onApplyWindowInsets(WindowInsets) 6630 */ 6631 public void setOnApplyWindowInsetsListener(OnApplyWindowInsetsListener listener) { 6632 getListenerInfo().mOnApplyWindowInsetsListener = listener; 6633 } 6634 6635 /** 6636 * Request to apply the given window insets to this view or another view in its subtree. 6637 * 6638 * <p>This method should be called by clients wishing to apply insets corresponding to areas 6639 * obscured by window decorations or overlays. This can include the status and navigation bars, 6640 * action bars, input methods and more. New inset categories may be added in the future. 6641 * The method returns the insets provided minus any that were applied by this view or its 6642 * children.</p> 6643 * 6644 * <p>Clients wishing to provide custom behavior should override the 6645 * {@link #onApplyWindowInsets(WindowInsets)} method or alternatively provide a 6646 * {@link OnApplyWindowInsetsListener} via the 6647 * {@link #setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) setOnApplyWindowInsetsListener} 6648 * method.</p> 6649 * 6650 * <p>This method replaces the older {@link #fitSystemWindows(Rect) fitSystemWindows} method. 6651 * </p> 6652 * 6653 * @param insets Insets to apply 6654 * @return The provided insets minus the insets that were consumed 6655 */ 6656 public WindowInsets dispatchApplyWindowInsets(WindowInsets insets) { 6657 try { 6658 mPrivateFlags3 |= PFLAG3_APPLYING_INSETS; 6659 if (mListenerInfo != null && mListenerInfo.mOnApplyWindowInsetsListener != null) { 6660 return mListenerInfo.mOnApplyWindowInsetsListener.onApplyWindowInsets(this, insets); 6661 } else { 6662 return onApplyWindowInsets(insets); 6663 } 6664 } finally { 6665 mPrivateFlags3 &= ~PFLAG3_APPLYING_INSETS; 6666 } 6667 } 6668 6669 /** 6670 * @hide Compute the insets that should be consumed by this view and the ones 6671 * that should propagate to those under it. 6672 */ 6673 protected boolean computeFitSystemWindows(Rect inoutInsets, Rect outLocalInsets) { 6674 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6675 || mAttachInfo == null 6676 || ((mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0 6677 && !mAttachInfo.mOverscanRequested)) { 6678 outLocalInsets.set(inoutInsets); 6679 inoutInsets.set(0, 0, 0, 0); 6680 return true; 6681 } else { 6682 // The application wants to take care of fitting system window for 6683 // the content... however we still need to take care of any overscan here. 6684 final Rect overscan = mAttachInfo.mOverscanInsets; 6685 outLocalInsets.set(overscan); 6686 inoutInsets.left -= overscan.left; 6687 inoutInsets.top -= overscan.top; 6688 inoutInsets.right -= overscan.right; 6689 inoutInsets.bottom -= overscan.bottom; 6690 return false; 6691 } 6692 } 6693 6694 /** 6695 * Compute insets that should be consumed by this view and the ones that should propagate 6696 * to those under it. 6697 * 6698 * @param in Insets currently being processed by this View, likely received as a parameter 6699 * to {@link #onApplyWindowInsets(WindowInsets)}. 6700 * @param outLocalInsets A Rect that will receive the insets that should be consumed 6701 * by this view 6702 * @return Insets that should be passed along to views under this one 6703 */ 6704 public WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) { 6705 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6706 || mAttachInfo == null 6707 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) { 6708 outLocalInsets.set(in.getSystemWindowInsets()); 6709 return in.consumeSystemWindowInsets(); 6710 } else { 6711 outLocalInsets.set(0, 0, 0, 0); 6712 return in; 6713 } 6714 } 6715 6716 /** 6717 * Sets whether or not this view should account for system screen decorations 6718 * such as the status bar and inset its content; that is, controlling whether 6719 * the default implementation of {@link #fitSystemWindows(Rect)} will be 6720 * executed. See that method for more details. 6721 * 6722 * <p>Note that if you are providing your own implementation of 6723 * {@link #fitSystemWindows(Rect)}, then there is no need to set this 6724 * flag to true -- your implementation will be overriding the default 6725 * implementation that checks this flag. 6726 * 6727 * @param fitSystemWindows If true, then the default implementation of 6728 * {@link #fitSystemWindows(Rect)} will be executed. 6729 * 6730 * @attr ref android.R.styleable#View_fitsSystemWindows 6731 * @see #getFitsSystemWindows() 6732 * @see #fitSystemWindows(Rect) 6733 * @see #setSystemUiVisibility(int) 6734 */ 6735 public void setFitsSystemWindows(boolean fitSystemWindows) { 6736 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 6737 } 6738 6739 /** 6740 * Check for state of {@link #setFitsSystemWindows(boolean)}. If this method 6741 * returns {@code true}, the default implementation of {@link #fitSystemWindows(Rect)} 6742 * will be executed. 6743 * 6744 * @return {@code true} if the default implementation of 6745 * {@link #fitSystemWindows(Rect)} will be executed. 6746 * 6747 * @attr ref android.R.styleable#View_fitsSystemWindows 6748 * @see #setFitsSystemWindows(boolean) 6749 * @see #fitSystemWindows(Rect) 6750 * @see #setSystemUiVisibility(int) 6751 */ 6752 @ViewDebug.ExportedProperty 6753 public boolean getFitsSystemWindows() { 6754 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 6755 } 6756 6757 /** @hide */ 6758 public boolean fitsSystemWindows() { 6759 return getFitsSystemWindows(); 6760 } 6761 6762 /** 6763 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed. 6764 * @deprecated Use {@link #requestApplyInsets()} for newer platform versions. 6765 */ 6766 public void requestFitSystemWindows() { 6767 if (mParent != null) { 6768 mParent.requestFitSystemWindows(); 6769 } 6770 } 6771 6772 /** 6773 * Ask that a new dispatch of {@link #onApplyWindowInsets(WindowInsets)} be performed. 6774 */ 6775 public void requestApplyInsets() { 6776 requestFitSystemWindows(); 6777 } 6778 6779 /** 6780 * For use by PhoneWindow to make its own system window fitting optional. 6781 * @hide 6782 */ 6783 public void makeOptionalFitsSystemWindows() { 6784 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS); 6785 } 6786 6787 /** 6788 * Returns the visibility status for this view. 6789 * 6790 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6791 * @attr ref android.R.styleable#View_visibility 6792 */ 6793 @ViewDebug.ExportedProperty(mapping = { 6794 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 6795 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 6796 @ViewDebug.IntToString(from = GONE, to = "GONE") 6797 }) 6798 @Visibility 6799 public int getVisibility() { 6800 return mViewFlags & VISIBILITY_MASK; 6801 } 6802 6803 /** 6804 * Set the enabled state of this view. 6805 * 6806 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6807 * @attr ref android.R.styleable#View_visibility 6808 */ 6809 @RemotableViewMethod 6810 public void setVisibility(@Visibility int visibility) { 6811 setFlags(visibility, VISIBILITY_MASK); 6812 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false); 6813 } 6814 6815 /** 6816 * Returns the enabled status for this view. The interpretation of the 6817 * enabled state varies by subclass. 6818 * 6819 * @return True if this view is enabled, false otherwise. 6820 */ 6821 @ViewDebug.ExportedProperty 6822 public boolean isEnabled() { 6823 return (mViewFlags & ENABLED_MASK) == ENABLED; 6824 } 6825 6826 /** 6827 * Set the enabled state of this view. The interpretation of the enabled 6828 * state varies by subclass. 6829 * 6830 * @param enabled True if this view is enabled, false otherwise. 6831 */ 6832 @RemotableViewMethod 6833 public void setEnabled(boolean enabled) { 6834 if (enabled == isEnabled()) return; 6835 6836 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 6837 6838 /* 6839 * The View most likely has to change its appearance, so refresh 6840 * the drawable state. 6841 */ 6842 refreshDrawableState(); 6843 6844 // Invalidate too, since the default behavior for views is to be 6845 // be drawn at 50% alpha rather than to change the drawable. 6846 invalidate(true); 6847 6848 if (!enabled) { 6849 cancelPendingInputEvents(); 6850 } 6851 } 6852 6853 /** 6854 * Set whether this view can receive the focus. 6855 * 6856 * Setting this to false will also ensure that this view is not focusable 6857 * in touch mode. 6858 * 6859 * @param focusable If true, this view can receive the focus. 6860 * 6861 * @see #setFocusableInTouchMode(boolean) 6862 * @attr ref android.R.styleable#View_focusable 6863 */ 6864 public void setFocusable(boolean focusable) { 6865 if (!focusable) { 6866 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 6867 } 6868 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 6869 } 6870 6871 /** 6872 * Set whether this view can receive focus while in touch mode. 6873 * 6874 * Setting this to true will also ensure that this view is focusable. 6875 * 6876 * @param focusableInTouchMode If true, this view can receive the focus while 6877 * in touch mode. 6878 * 6879 * @see #setFocusable(boolean) 6880 * @attr ref android.R.styleable#View_focusableInTouchMode 6881 */ 6882 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 6883 // Focusable in touch mode should always be set before the focusable flag 6884 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 6885 // which, in touch mode, will not successfully request focus on this view 6886 // because the focusable in touch mode flag is not set 6887 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 6888 if (focusableInTouchMode) { 6889 setFlags(FOCUSABLE, FOCUSABLE_MASK); 6890 } 6891 } 6892 6893 /** 6894 * Set whether this view should have sound effects enabled for events such as 6895 * clicking and touching. 6896 * 6897 * <p>You may wish to disable sound effects for a view if you already play sounds, 6898 * for instance, a dial key that plays dtmf tones. 6899 * 6900 * @param soundEffectsEnabled whether sound effects are enabled for this view. 6901 * @see #isSoundEffectsEnabled() 6902 * @see #playSoundEffect(int) 6903 * @attr ref android.R.styleable#View_soundEffectsEnabled 6904 */ 6905 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 6906 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 6907 } 6908 6909 /** 6910 * @return whether this view should have sound effects enabled for events such as 6911 * clicking and touching. 6912 * 6913 * @see #setSoundEffectsEnabled(boolean) 6914 * @see #playSoundEffect(int) 6915 * @attr ref android.R.styleable#View_soundEffectsEnabled 6916 */ 6917 @ViewDebug.ExportedProperty 6918 public boolean isSoundEffectsEnabled() { 6919 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 6920 } 6921 6922 /** 6923 * Set whether this view should have haptic feedback for events such as 6924 * long presses. 6925 * 6926 * <p>You may wish to disable haptic feedback if your view already controls 6927 * its own haptic feedback. 6928 * 6929 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 6930 * @see #isHapticFeedbackEnabled() 6931 * @see #performHapticFeedback(int) 6932 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6933 */ 6934 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 6935 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 6936 } 6937 6938 /** 6939 * @return whether this view should have haptic feedback enabled for events 6940 * long presses. 6941 * 6942 * @see #setHapticFeedbackEnabled(boolean) 6943 * @see #performHapticFeedback(int) 6944 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6945 */ 6946 @ViewDebug.ExportedProperty 6947 public boolean isHapticFeedbackEnabled() { 6948 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 6949 } 6950 6951 /** 6952 * Returns the layout direction for this view. 6953 * 6954 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 6955 * {@link #LAYOUT_DIRECTION_RTL}, 6956 * {@link #LAYOUT_DIRECTION_INHERIT} or 6957 * {@link #LAYOUT_DIRECTION_LOCALE}. 6958 * 6959 * @attr ref android.R.styleable#View_layoutDirection 6960 * 6961 * @hide 6962 */ 6963 @ViewDebug.ExportedProperty(category = "layout", mapping = { 6964 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 6965 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 6966 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 6967 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 6968 }) 6969 @LayoutDir 6970 public int getRawLayoutDirection() { 6971 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 6972 } 6973 6974 /** 6975 * Set the layout direction for this view. This will propagate a reset of layout direction 6976 * resolution to the view's children and resolve layout direction for this view. 6977 * 6978 * @param layoutDirection the layout direction to set. Should be one of: 6979 * 6980 * {@link #LAYOUT_DIRECTION_LTR}, 6981 * {@link #LAYOUT_DIRECTION_RTL}, 6982 * {@link #LAYOUT_DIRECTION_INHERIT}, 6983 * {@link #LAYOUT_DIRECTION_LOCALE}. 6984 * 6985 * Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution 6986 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 6987 * will return the default {@link #LAYOUT_DIRECTION_LTR}. 6988 * 6989 * @attr ref android.R.styleable#View_layoutDirection 6990 */ 6991 @RemotableViewMethod 6992 public void setLayoutDirection(@LayoutDir int layoutDirection) { 6993 if (getRawLayoutDirection() != layoutDirection) { 6994 // Reset the current layout direction and the resolved one 6995 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_MASK; 6996 resetRtlProperties(); 6997 // Set the new layout direction (filtered) 6998 mPrivateFlags2 |= 6999 ((layoutDirection << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) & PFLAG2_LAYOUT_DIRECTION_MASK); 7000 // We need to resolve all RTL properties as they all depend on layout direction 7001 resolveRtlPropertiesIfNeeded(); 7002 requestLayout(); 7003 invalidate(true); 7004 } 7005 } 7006 7007 /** 7008 * Returns the resolved layout direction for this view. 7009 * 7010 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 7011 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. 7012 * 7013 * For compatibility, this will return {@link #LAYOUT_DIRECTION_LTR} if API version 7014 * is lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}. 7015 * 7016 * @attr ref android.R.styleable#View_layoutDirection 7017 */ 7018 @ViewDebug.ExportedProperty(category = "layout", mapping = { 7019 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 7020 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 7021 }) 7022 @ResolvedLayoutDir 7023 public int getLayoutDirection() { 7024 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 7025 if (targetSdkVersion < JELLY_BEAN_MR1) { 7026 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 7027 return LAYOUT_DIRECTION_RESOLVED_DEFAULT; 7028 } 7029 return ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) == 7030 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) ? LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 7031 } 7032 7033 /** 7034 * Indicates whether or not this view's layout is right-to-left. This is resolved from 7035 * layout attribute and/or the inherited value from the parent 7036 * 7037 * @return true if the layout is right-to-left. 7038 * 7039 * @hide 7040 */ 7041 @ViewDebug.ExportedProperty(category = "layout") 7042 public boolean isLayoutRtl() { 7043 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL); 7044 } 7045 7046 /** 7047 * Indicates whether the view is currently tracking transient state that the 7048 * app should not need to concern itself with saving and restoring, but that 7049 * the framework should take special note to preserve when possible. 7050 * 7051 * <p>A view with transient state cannot be trivially rebound from an external 7052 * data source, such as an adapter binding item views in a list. This may be 7053 * because the view is performing an animation, tracking user selection 7054 * of content, or similar.</p> 7055 * 7056 * @return true if the view has transient state 7057 */ 7058 @ViewDebug.ExportedProperty(category = "layout") 7059 public boolean hasTransientState() { 7060 return (mPrivateFlags2 & PFLAG2_HAS_TRANSIENT_STATE) == PFLAG2_HAS_TRANSIENT_STATE; 7061 } 7062 7063 /** 7064 * Set whether this view is currently tracking transient state that the 7065 * framework should attempt to preserve when possible. This flag is reference counted, 7066 * so every call to setHasTransientState(true) should be paired with a later call 7067 * to setHasTransientState(false). 7068 * 7069 * <p>A view with transient state cannot be trivially rebound from an external 7070 * data source, such as an adapter binding item views in a list. This may be 7071 * because the view is performing an animation, tracking user selection 7072 * of content, or similar.</p> 7073 * 7074 * @param hasTransientState true if this view has transient state 7075 */ 7076 public void setHasTransientState(boolean hasTransientState) { 7077 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 : 7078 mTransientStateCount - 1; 7079 if (mTransientStateCount < 0) { 7080 mTransientStateCount = 0; 7081 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " + 7082 "unmatched pair of setHasTransientState calls"); 7083 } else if ((hasTransientState && mTransientStateCount == 1) || 7084 (!hasTransientState && mTransientStateCount == 0)) { 7085 // update flag if we've just incremented up from 0 or decremented down to 0 7086 mPrivateFlags2 = (mPrivateFlags2 & ~PFLAG2_HAS_TRANSIENT_STATE) | 7087 (hasTransientState ? PFLAG2_HAS_TRANSIENT_STATE : 0); 7088 if (mParent != null) { 7089 try { 7090 mParent.childHasTransientStateChanged(this, hasTransientState); 7091 } catch (AbstractMethodError e) { 7092 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 7093 " does not fully implement ViewParent", e); 7094 } 7095 } 7096 } 7097 } 7098 7099 /** 7100 * Returns true if this view is currently attached to a window. 7101 */ 7102 public boolean isAttachedToWindow() { 7103 return mAttachInfo != null; 7104 } 7105 7106 /** 7107 * Returns true if this view has been through at least one layout since it 7108 * was last attached to or detached from a window. 7109 */ 7110 public boolean isLaidOut() { 7111 return (mPrivateFlags3 & PFLAG3_IS_LAID_OUT) == PFLAG3_IS_LAID_OUT; 7112 } 7113 7114 /** 7115 * If this view doesn't do any drawing on its own, set this flag to 7116 * allow further optimizations. By default, this flag is not set on 7117 * View, but could be set on some View subclasses such as ViewGroup. 7118 * 7119 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 7120 * you should clear this flag. 7121 * 7122 * @param willNotDraw whether or not this View draw on its own 7123 */ 7124 public void setWillNotDraw(boolean willNotDraw) { 7125 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 7126 } 7127 7128 /** 7129 * Returns whether or not this View draws on its own. 7130 * 7131 * @return true if this view has nothing to draw, false otherwise 7132 */ 7133 @ViewDebug.ExportedProperty(category = "drawing") 7134 public boolean willNotDraw() { 7135 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 7136 } 7137 7138 /** 7139 * When a View's drawing cache is enabled, drawing is redirected to an 7140 * offscreen bitmap. Some views, like an ImageView, must be able to 7141 * bypass this mechanism if they already draw a single bitmap, to avoid 7142 * unnecessary usage of the memory. 7143 * 7144 * @param willNotCacheDrawing true if this view does not cache its 7145 * drawing, false otherwise 7146 */ 7147 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 7148 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 7149 } 7150 7151 /** 7152 * Returns whether or not this View can cache its drawing or not. 7153 * 7154 * @return true if this view does not cache its drawing, false otherwise 7155 */ 7156 @ViewDebug.ExportedProperty(category = "drawing") 7157 public boolean willNotCacheDrawing() { 7158 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 7159 } 7160 7161 /** 7162 * Indicates whether this view reacts to click events or not. 7163 * 7164 * @return true if the view is clickable, false otherwise 7165 * 7166 * @see #setClickable(boolean) 7167 * @attr ref android.R.styleable#View_clickable 7168 */ 7169 @ViewDebug.ExportedProperty 7170 public boolean isClickable() { 7171 return (mViewFlags & CLICKABLE) == CLICKABLE; 7172 } 7173 7174 /** 7175 * Enables or disables click events for this view. When a view 7176 * is clickable it will change its state to "pressed" on every click. 7177 * Subclasses should set the view clickable to visually react to 7178 * user's clicks. 7179 * 7180 * @param clickable true to make the view clickable, false otherwise 7181 * 7182 * @see #isClickable() 7183 * @attr ref android.R.styleable#View_clickable 7184 */ 7185 public void setClickable(boolean clickable) { 7186 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 7187 } 7188 7189 /** 7190 * Indicates whether this view reacts to long click events or not. 7191 * 7192 * @return true if the view is long clickable, false otherwise 7193 * 7194 * @see #setLongClickable(boolean) 7195 * @attr ref android.R.styleable#View_longClickable 7196 */ 7197 public boolean isLongClickable() { 7198 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 7199 } 7200 7201 /** 7202 * Enables or disables long click events for this view. When a view is long 7203 * clickable it reacts to the user holding down the button for a longer 7204 * duration than a tap. This event can either launch the listener or a 7205 * context menu. 7206 * 7207 * @param longClickable true to make the view long clickable, false otherwise 7208 * @see #isLongClickable() 7209 * @attr ref android.R.styleable#View_longClickable 7210 */ 7211 public void setLongClickable(boolean longClickable) { 7212 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 7213 } 7214 7215 /** 7216 * Sets the pressed state for this view and provides a touch coordinate for 7217 * animation hinting. 7218 * 7219 * @param pressed Pass true to set the View's internal state to "pressed", 7220 * or false to reverts the View's internal state from a 7221 * previously set "pressed" state. 7222 * @param x The x coordinate of the touch that caused the press 7223 * @param y The y coordinate of the touch that caused the press 7224 */ 7225 private void setPressed(boolean pressed, float x, float y) { 7226 if (pressed) { 7227 drawableHotspotChanged(x, y); 7228 } 7229 7230 setPressed(pressed); 7231 } 7232 7233 /** 7234 * Sets the pressed state for this view. 7235 * 7236 * @see #isClickable() 7237 * @see #setClickable(boolean) 7238 * 7239 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 7240 * the View's internal state from a previously set "pressed" state. 7241 */ 7242 public void setPressed(boolean pressed) { 7243 final boolean needsRefresh = pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED); 7244 7245 if (pressed) { 7246 mPrivateFlags |= PFLAG_PRESSED; 7247 } else { 7248 mPrivateFlags &= ~PFLAG_PRESSED; 7249 } 7250 7251 if (needsRefresh) { 7252 refreshDrawableState(); 7253 } 7254 dispatchSetPressed(pressed); 7255 } 7256 7257 /** 7258 * Dispatch setPressed to all of this View's children. 7259 * 7260 * @see #setPressed(boolean) 7261 * 7262 * @param pressed The new pressed state 7263 */ 7264 protected void dispatchSetPressed(boolean pressed) { 7265 } 7266 7267 /** 7268 * Indicates whether the view is currently in pressed state. Unless 7269 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 7270 * the pressed state. 7271 * 7272 * @see #setPressed(boolean) 7273 * @see #isClickable() 7274 * @see #setClickable(boolean) 7275 * 7276 * @return true if the view is currently pressed, false otherwise 7277 */ 7278 @ViewDebug.ExportedProperty 7279 public boolean isPressed() { 7280 return (mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED; 7281 } 7282 7283 /** 7284 * Indicates whether this view will save its state (that is, 7285 * whether its {@link #onSaveInstanceState} method will be called). 7286 * 7287 * @return Returns true if the view state saving is enabled, else false. 7288 * 7289 * @see #setSaveEnabled(boolean) 7290 * @attr ref android.R.styleable#View_saveEnabled 7291 */ 7292 public boolean isSaveEnabled() { 7293 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 7294 } 7295 7296 /** 7297 * Controls whether the saving of this view's state is 7298 * enabled (that is, whether its {@link #onSaveInstanceState} method 7299 * will be called). Note that even if freezing is enabled, the 7300 * view still must have an id assigned to it (via {@link #setId(int)}) 7301 * for its state to be saved. This flag can only disable the 7302 * saving of this view; any child views may still have their state saved. 7303 * 7304 * @param enabled Set to false to <em>disable</em> state saving, or true 7305 * (the default) to allow it. 7306 * 7307 * @see #isSaveEnabled() 7308 * @see #setId(int) 7309 * @see #onSaveInstanceState() 7310 * @attr ref android.R.styleable#View_saveEnabled 7311 */ 7312 public void setSaveEnabled(boolean enabled) { 7313 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 7314 } 7315 7316 /** 7317 * Gets whether the framework should discard touches when the view's 7318 * window is obscured by another visible window. 7319 * Refer to the {@link View} security documentation for more details. 7320 * 7321 * @return True if touch filtering is enabled. 7322 * 7323 * @see #setFilterTouchesWhenObscured(boolean) 7324 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7325 */ 7326 @ViewDebug.ExportedProperty 7327 public boolean getFilterTouchesWhenObscured() { 7328 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 7329 } 7330 7331 /** 7332 * Sets whether the framework should discard touches when the view's 7333 * window is obscured by another visible window. 7334 * Refer to the {@link View} security documentation for more details. 7335 * 7336 * @param enabled True if touch filtering should be enabled. 7337 * 7338 * @see #getFilterTouchesWhenObscured 7339 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7340 */ 7341 public void setFilterTouchesWhenObscured(boolean enabled) { 7342 setFlags(enabled ? FILTER_TOUCHES_WHEN_OBSCURED : 0, 7343 FILTER_TOUCHES_WHEN_OBSCURED); 7344 } 7345 7346 /** 7347 * Indicates whether the entire hierarchy under this view will save its 7348 * state when a state saving traversal occurs from its parent. The default 7349 * is true; if false, these views will not be saved unless 7350 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7351 * 7352 * @return Returns true if the view state saving from parent is enabled, else false. 7353 * 7354 * @see #setSaveFromParentEnabled(boolean) 7355 */ 7356 public boolean isSaveFromParentEnabled() { 7357 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 7358 } 7359 7360 /** 7361 * Controls whether the entire hierarchy under this view will save its 7362 * state when a state saving traversal occurs from its parent. The default 7363 * is true; if false, these views will not be saved unless 7364 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7365 * 7366 * @param enabled Set to false to <em>disable</em> state saving, or true 7367 * (the default) to allow it. 7368 * 7369 * @see #isSaveFromParentEnabled() 7370 * @see #setId(int) 7371 * @see #onSaveInstanceState() 7372 */ 7373 public void setSaveFromParentEnabled(boolean enabled) { 7374 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 7375 } 7376 7377 7378 /** 7379 * Returns whether this View is able to take focus. 7380 * 7381 * @return True if this view can take focus, or false otherwise. 7382 * @attr ref android.R.styleable#View_focusable 7383 */ 7384 @ViewDebug.ExportedProperty(category = "focus") 7385 public final boolean isFocusable() { 7386 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 7387 } 7388 7389 /** 7390 * When a view is focusable, it may not want to take focus when in touch mode. 7391 * For example, a button would like focus when the user is navigating via a D-pad 7392 * so that the user can click on it, but once the user starts touching the screen, 7393 * the button shouldn't take focus 7394 * @return Whether the view is focusable in touch mode. 7395 * @attr ref android.R.styleable#View_focusableInTouchMode 7396 */ 7397 @ViewDebug.ExportedProperty 7398 public final boolean isFocusableInTouchMode() { 7399 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 7400 } 7401 7402 /** 7403 * Find the nearest view in the specified direction that can take focus. 7404 * This does not actually give focus to that view. 7405 * 7406 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7407 * 7408 * @return The nearest focusable in the specified direction, or null if none 7409 * can be found. 7410 */ 7411 public View focusSearch(@FocusRealDirection int direction) { 7412 if (mParent != null) { 7413 return mParent.focusSearch(this, direction); 7414 } else { 7415 return null; 7416 } 7417 } 7418 7419 /** 7420 * This method is the last chance for the focused view and its ancestors to 7421 * respond to an arrow key. This is called when the focused view did not 7422 * consume the key internally, nor could the view system find a new view in 7423 * the requested direction to give focus to. 7424 * 7425 * @param focused The currently focused view. 7426 * @param direction The direction focus wants to move. One of FOCUS_UP, 7427 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 7428 * @return True if the this view consumed this unhandled move. 7429 */ 7430 public boolean dispatchUnhandledMove(View focused, @FocusRealDirection int direction) { 7431 return false; 7432 } 7433 7434 /** 7435 * If a user manually specified the next view id for a particular direction, 7436 * use the root to look up the view. 7437 * @param root The root view of the hierarchy containing this view. 7438 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 7439 * or FOCUS_BACKWARD. 7440 * @return The user specified next view, or null if there is none. 7441 */ 7442 View findUserSetNextFocus(View root, @FocusDirection int direction) { 7443 switch (direction) { 7444 case FOCUS_LEFT: 7445 if (mNextFocusLeftId == View.NO_ID) return null; 7446 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 7447 case FOCUS_RIGHT: 7448 if (mNextFocusRightId == View.NO_ID) return null; 7449 return findViewInsideOutShouldExist(root, mNextFocusRightId); 7450 case FOCUS_UP: 7451 if (mNextFocusUpId == View.NO_ID) return null; 7452 return findViewInsideOutShouldExist(root, mNextFocusUpId); 7453 case FOCUS_DOWN: 7454 if (mNextFocusDownId == View.NO_ID) return null; 7455 return findViewInsideOutShouldExist(root, mNextFocusDownId); 7456 case FOCUS_FORWARD: 7457 if (mNextFocusForwardId == View.NO_ID) return null; 7458 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 7459 case FOCUS_BACKWARD: { 7460 if (mID == View.NO_ID) return null; 7461 final int id = mID; 7462 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 7463 @Override 7464 public boolean apply(View t) { 7465 return t.mNextFocusForwardId == id; 7466 } 7467 }); 7468 } 7469 } 7470 return null; 7471 } 7472 7473 private View findViewInsideOutShouldExist(View root, int id) { 7474 if (mMatchIdPredicate == null) { 7475 mMatchIdPredicate = new MatchIdPredicate(); 7476 } 7477 mMatchIdPredicate.mId = id; 7478 View result = root.findViewByPredicateInsideOut(this, mMatchIdPredicate); 7479 if (result == null) { 7480 Log.w(VIEW_LOG_TAG, "couldn't find view with id " + id); 7481 } 7482 return result; 7483 } 7484 7485 /** 7486 * Find and return all focusable views that are descendants of this view, 7487 * possibly including this view if it is focusable itself. 7488 * 7489 * @param direction The direction of the focus 7490 * @return A list of focusable views 7491 */ 7492 public ArrayList<View> getFocusables(@FocusDirection int direction) { 7493 ArrayList<View> result = new ArrayList<View>(24); 7494 addFocusables(result, direction); 7495 return result; 7496 } 7497 7498 /** 7499 * Add any focusable views that are descendants of this view (possibly 7500 * including this view if it is focusable itself) to views. If we are in touch mode, 7501 * only add views that are also focusable in touch mode. 7502 * 7503 * @param views Focusable views found so far 7504 * @param direction The direction of the focus 7505 */ 7506 public void addFocusables(ArrayList<View> views, @FocusDirection int direction) { 7507 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 7508 } 7509 7510 /** 7511 * Adds any focusable views that are descendants of this view (possibly 7512 * including this view if it is focusable itself) to views. This method 7513 * adds all focusable views regardless if we are in touch mode or 7514 * only views focusable in touch mode if we are in touch mode or 7515 * only views that can take accessibility focus if accessibility is enabeld 7516 * depending on the focusable mode paramater. 7517 * 7518 * @param views Focusable views found so far or null if all we are interested is 7519 * the number of focusables. 7520 * @param direction The direction of the focus. 7521 * @param focusableMode The type of focusables to be added. 7522 * 7523 * @see #FOCUSABLES_ALL 7524 * @see #FOCUSABLES_TOUCH_MODE 7525 */ 7526 public void addFocusables(ArrayList<View> views, @FocusDirection int direction, 7527 @FocusableMode int focusableMode) { 7528 if (views == null) { 7529 return; 7530 } 7531 if (!isFocusable()) { 7532 return; 7533 } 7534 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE 7535 && isInTouchMode() && !isFocusableInTouchMode()) { 7536 return; 7537 } 7538 views.add(this); 7539 } 7540 7541 /** 7542 * Finds the Views that contain given text. The containment is case insensitive. 7543 * The search is performed by either the text that the View renders or the content 7544 * description that describes the view for accessibility purposes and the view does 7545 * not render or both. Clients can specify how the search is to be performed via 7546 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 7547 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 7548 * 7549 * @param outViews The output list of matching Views. 7550 * @param searched The text to match against. 7551 * 7552 * @see #FIND_VIEWS_WITH_TEXT 7553 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 7554 * @see #setContentDescription(CharSequence) 7555 */ 7556 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, 7557 @FindViewFlags int flags) { 7558 if (getAccessibilityNodeProvider() != null) { 7559 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 7560 outViews.add(this); 7561 } 7562 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 7563 && (searched != null && searched.length() > 0) 7564 && (mContentDescription != null && mContentDescription.length() > 0)) { 7565 String searchedLowerCase = searched.toString().toLowerCase(); 7566 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 7567 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 7568 outViews.add(this); 7569 } 7570 } 7571 } 7572 7573 /** 7574 * Find and return all touchable views that are descendants of this view, 7575 * possibly including this view if it is touchable itself. 7576 * 7577 * @return A list of touchable views 7578 */ 7579 public ArrayList<View> getTouchables() { 7580 ArrayList<View> result = new ArrayList<View>(); 7581 addTouchables(result); 7582 return result; 7583 } 7584 7585 /** 7586 * Add any touchable views that are descendants of this view (possibly 7587 * including this view if it is touchable itself) to views. 7588 * 7589 * @param views Touchable views found so far 7590 */ 7591 public void addTouchables(ArrayList<View> views) { 7592 final int viewFlags = mViewFlags; 7593 7594 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 7595 && (viewFlags & ENABLED_MASK) == ENABLED) { 7596 views.add(this); 7597 } 7598 } 7599 7600 /** 7601 * Returns whether this View is accessibility focused. 7602 * 7603 * @return True if this View is accessibility focused. 7604 */ 7605 public boolean isAccessibilityFocused() { 7606 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0; 7607 } 7608 7609 /** 7610 * Call this to try to give accessibility focus to this view. 7611 * 7612 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()} 7613 * returns false or the view is no visible or the view already has accessibility 7614 * focus. 7615 * 7616 * See also {@link #focusSearch(int)}, which is what you call to say that you 7617 * have focus, and you want your parent to look for the next one. 7618 * 7619 * @return Whether this view actually took accessibility focus. 7620 * 7621 * @hide 7622 */ 7623 public boolean requestAccessibilityFocus() { 7624 AccessibilityManager manager = AccessibilityManager.getInstance(mContext); 7625 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) { 7626 return false; 7627 } 7628 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7629 return false; 7630 } 7631 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) == 0) { 7632 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_FOCUSED; 7633 ViewRootImpl viewRootImpl = getViewRootImpl(); 7634 if (viewRootImpl != null) { 7635 viewRootImpl.setAccessibilityFocus(this, null); 7636 } 7637 invalidate(); 7638 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED); 7639 return true; 7640 } 7641 return false; 7642 } 7643 7644 /** 7645 * Call this to try to clear accessibility focus of this view. 7646 * 7647 * See also {@link #focusSearch(int)}, which is what you call to say that you 7648 * have focus, and you want your parent to look for the next one. 7649 * 7650 * @hide 7651 */ 7652 public void clearAccessibilityFocus() { 7653 clearAccessibilityFocusNoCallbacks(); 7654 // Clear the global reference of accessibility focus if this 7655 // view or any of its descendants had accessibility focus. 7656 ViewRootImpl viewRootImpl = getViewRootImpl(); 7657 if (viewRootImpl != null) { 7658 View focusHost = viewRootImpl.getAccessibilityFocusedHost(); 7659 if (focusHost != null && ViewRootImpl.isViewDescendantOf(focusHost, this)) { 7660 viewRootImpl.setAccessibilityFocus(null, null); 7661 } 7662 } 7663 } 7664 7665 private void sendAccessibilityHoverEvent(int eventType) { 7666 // Since we are not delivering to a client accessibility events from not 7667 // important views (unless the clinet request that) we need to fire the 7668 // event from the deepest view exposed to the client. As a consequence if 7669 // the user crosses a not exposed view the client will see enter and exit 7670 // of the exposed predecessor followed by and enter and exit of that same 7671 // predecessor when entering and exiting the not exposed descendant. This 7672 // is fine since the client has a clear idea which view is hovered at the 7673 // price of a couple more events being sent. This is a simple and 7674 // working solution. 7675 View source = this; 7676 while (true) { 7677 if (source.includeForAccessibility()) { 7678 source.sendAccessibilityEvent(eventType); 7679 return; 7680 } 7681 ViewParent parent = source.getParent(); 7682 if (parent instanceof View) { 7683 source = (View) parent; 7684 } else { 7685 return; 7686 } 7687 } 7688 } 7689 7690 /** 7691 * Clears accessibility focus without calling any callback methods 7692 * normally invoked in {@link #clearAccessibilityFocus()}. This method 7693 * is used for clearing accessibility focus when giving this focus to 7694 * another view. 7695 */ 7696 void clearAccessibilityFocusNoCallbacks() { 7697 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) { 7698 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED; 7699 invalidate(); 7700 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED); 7701 } 7702 } 7703 7704 /** 7705 * Call this to try to give focus to a specific view or to one of its 7706 * descendants. 7707 * 7708 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7709 * false), or if it is focusable and it is not focusable in touch mode 7710 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7711 * 7712 * See also {@link #focusSearch(int)}, which is what you call to say that you 7713 * have focus, and you want your parent to look for the next one. 7714 * 7715 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 7716 * {@link #FOCUS_DOWN} and <code>null</code>. 7717 * 7718 * @return Whether this view or one of its descendants actually took focus. 7719 */ 7720 public final boolean requestFocus() { 7721 return requestFocus(View.FOCUS_DOWN); 7722 } 7723 7724 /** 7725 * Call this to try to give focus to a specific view or to one of its 7726 * descendants and give it a hint about what direction focus is heading. 7727 * 7728 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7729 * false), or if it is focusable and it is not focusable in touch mode 7730 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7731 * 7732 * See also {@link #focusSearch(int)}, which is what you call to say that you 7733 * have focus, and you want your parent to look for the next one. 7734 * 7735 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 7736 * <code>null</code> set for the previously focused rectangle. 7737 * 7738 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7739 * @return Whether this view or one of its descendants actually took focus. 7740 */ 7741 public final boolean requestFocus(int direction) { 7742 return requestFocus(direction, null); 7743 } 7744 7745 /** 7746 * Call this to try to give focus to a specific view or to one of its descendants 7747 * and give it hints about the direction and a specific rectangle that the focus 7748 * is coming from. The rectangle can help give larger views a finer grained hint 7749 * about where focus is coming from, and therefore, where to show selection, or 7750 * forward focus change internally. 7751 * 7752 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7753 * false), or if it is focusable and it is not focusable in touch mode 7754 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7755 * 7756 * A View will not take focus if it is not visible. 7757 * 7758 * A View will not take focus if one of its parents has 7759 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 7760 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 7761 * 7762 * See also {@link #focusSearch(int)}, which is what you call to say that you 7763 * have focus, and you want your parent to look for the next one. 7764 * 7765 * You may wish to override this method if your custom {@link View} has an internal 7766 * {@link View} that it wishes to forward the request to. 7767 * 7768 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7769 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 7770 * to give a finer grained hint about where focus is coming from. May be null 7771 * if there is no hint. 7772 * @return Whether this view or one of its descendants actually took focus. 7773 */ 7774 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 7775 return requestFocusNoSearch(direction, previouslyFocusedRect); 7776 } 7777 7778 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) { 7779 // need to be focusable 7780 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 7781 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7782 return false; 7783 } 7784 7785 // need to be focusable in touch mode if in touch mode 7786 if (isInTouchMode() && 7787 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 7788 return false; 7789 } 7790 7791 // need to not have any parents blocking us 7792 if (hasAncestorThatBlocksDescendantFocus()) { 7793 return false; 7794 } 7795 7796 handleFocusGainInternal(direction, previouslyFocusedRect); 7797 return true; 7798 } 7799 7800 /** 7801 * Call this to try to give focus to a specific view or to one of its descendants. This is a 7802 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 7803 * touch mode to request focus when they are touched. 7804 * 7805 * @return Whether this view or one of its descendants actually took focus. 7806 * 7807 * @see #isInTouchMode() 7808 * 7809 */ 7810 public final boolean requestFocusFromTouch() { 7811 // Leave touch mode if we need to 7812 if (isInTouchMode()) { 7813 ViewRootImpl viewRoot = getViewRootImpl(); 7814 if (viewRoot != null) { 7815 viewRoot.ensureTouchMode(false); 7816 } 7817 } 7818 return requestFocus(View.FOCUS_DOWN); 7819 } 7820 7821 /** 7822 * @return Whether any ancestor of this view blocks descendant focus. 7823 */ 7824 private boolean hasAncestorThatBlocksDescendantFocus() { 7825 final boolean focusableInTouchMode = isFocusableInTouchMode(); 7826 ViewParent ancestor = mParent; 7827 while (ancestor instanceof ViewGroup) { 7828 final ViewGroup vgAncestor = (ViewGroup) ancestor; 7829 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS 7830 || (!focusableInTouchMode && vgAncestor.shouldBlockFocusForTouchscreen())) { 7831 return true; 7832 } else { 7833 ancestor = vgAncestor.getParent(); 7834 } 7835 } 7836 return false; 7837 } 7838 7839 /** 7840 * Gets the mode for determining whether this View is important for accessibility 7841 * which is if it fires accessibility events and if it is reported to 7842 * accessibility services that query the screen. 7843 * 7844 * @return The mode for determining whether a View is important for accessibility. 7845 * 7846 * @attr ref android.R.styleable#View_importantForAccessibility 7847 * 7848 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7849 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7850 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7851 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7852 */ 7853 @ViewDebug.ExportedProperty(category = "accessibility", mapping = { 7854 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, to = "auto"), 7855 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, to = "yes"), 7856 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, to = "no"), 7857 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, 7858 to = "noHideDescendants") 7859 }) 7860 public int getImportantForAccessibility() { 7861 return (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 7862 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 7863 } 7864 7865 /** 7866 * Sets the live region mode for this view. This indicates to accessibility 7867 * services whether they should automatically notify the user about changes 7868 * to the view's content description or text, or to the content descriptions 7869 * or text of the view's children (where applicable). 7870 * <p> 7871 * For example, in a login screen with a TextView that displays an "incorrect 7872 * password" notification, that view should be marked as a live region with 7873 * mode {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7874 * <p> 7875 * To disable change notifications for this view, use 7876 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. This is the default live region 7877 * mode for most views. 7878 * <p> 7879 * To indicate that the user should be notified of changes, use 7880 * {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7881 * <p> 7882 * If the view's changes should interrupt ongoing speech and notify the user 7883 * immediately, use {@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE}. 7884 * 7885 * @param mode The live region mode for this view, one of: 7886 * <ul> 7887 * <li>{@link #ACCESSIBILITY_LIVE_REGION_NONE} 7888 * <li>{@link #ACCESSIBILITY_LIVE_REGION_POLITE} 7889 * <li>{@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE} 7890 * </ul> 7891 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7892 */ 7893 public void setAccessibilityLiveRegion(int mode) { 7894 if (mode != getAccessibilityLiveRegion()) { 7895 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7896 mPrivateFlags2 |= (mode << PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT) 7897 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7898 notifyViewAccessibilityStateChangedIfNeeded( 7899 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7900 } 7901 } 7902 7903 /** 7904 * Gets the live region mode for this View. 7905 * 7906 * @return The live region mode for the view. 7907 * 7908 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7909 * 7910 * @see #setAccessibilityLiveRegion(int) 7911 */ 7912 public int getAccessibilityLiveRegion() { 7913 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK) 7914 >> PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT; 7915 } 7916 7917 /** 7918 * Sets how to determine whether this view is important for accessibility 7919 * which is if it fires accessibility events and if it is reported to 7920 * accessibility services that query the screen. 7921 * 7922 * @param mode How to determine whether this view is important for accessibility. 7923 * 7924 * @attr ref android.R.styleable#View_importantForAccessibility 7925 * 7926 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7927 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7928 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7929 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7930 */ 7931 public void setImportantForAccessibility(int mode) { 7932 final int oldMode = getImportantForAccessibility(); 7933 if (mode != oldMode) { 7934 // If we're moving between AUTO and another state, we might not need 7935 // to send a subtree changed notification. We'll store the computed 7936 // importance, since we'll need to check it later to make sure. 7937 final boolean maySkipNotify = oldMode == IMPORTANT_FOR_ACCESSIBILITY_AUTO 7938 || mode == IMPORTANT_FOR_ACCESSIBILITY_AUTO; 7939 final boolean oldIncludeForAccessibility = maySkipNotify && includeForAccessibility(); 7940 mPrivateFlags2 &= ~PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7941 mPrivateFlags2 |= (mode << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT) 7942 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7943 if (!maySkipNotify || oldIncludeForAccessibility != includeForAccessibility()) { 7944 notifySubtreeAccessibilityStateChangedIfNeeded(); 7945 } else { 7946 notifyViewAccessibilityStateChangedIfNeeded( 7947 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7948 } 7949 } 7950 } 7951 7952 /** 7953 * Computes whether this view should be exposed for accessibility. In 7954 * general, views that are interactive or provide information are exposed 7955 * while views that serve only as containers are hidden. 7956 * <p> 7957 * If an ancestor of this view has importance 7958 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, this method 7959 * returns <code>false</code>. 7960 * <p> 7961 * Otherwise, the value is computed according to the view's 7962 * {@link #getImportantForAccessibility()} value: 7963 * <ol> 7964 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_NO} or 7965 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, return <code>false 7966 * </code> 7967 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_YES}, return <code>true</code> 7968 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_AUTO}, return <code>true</code> if 7969 * view satisfies any of the following: 7970 * <ul> 7971 * <li>Is actionable, e.g. {@link #isClickable()}, 7972 * {@link #isLongClickable()}, or {@link #isFocusable()} 7973 * <li>Has an {@link AccessibilityDelegate} 7974 * <li>Has an interaction listener, e.g. {@link OnTouchListener}, 7975 * {@link OnKeyListener}, etc. 7976 * <li>Is an accessibility live region, e.g. 7977 * {@link #getAccessibilityLiveRegion()} is not 7978 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. 7979 * </ul> 7980 * </ol> 7981 * 7982 * @return Whether the view is exposed for accessibility. 7983 * @see #setImportantForAccessibility(int) 7984 * @see #getImportantForAccessibility() 7985 */ 7986 public boolean isImportantForAccessibility() { 7987 final int mode = (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 7988 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 7989 if (mode == IMPORTANT_FOR_ACCESSIBILITY_NO 7990 || mode == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 7991 return false; 7992 } 7993 7994 // Check parent mode to ensure we're not hidden. 7995 ViewParent parent = mParent; 7996 while (parent instanceof View) { 7997 if (((View) parent).getImportantForAccessibility() 7998 == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 7999 return false; 8000 } 8001 parent = parent.getParent(); 8002 } 8003 8004 return mode == IMPORTANT_FOR_ACCESSIBILITY_YES || isActionableForAccessibility() 8005 || hasListenersForAccessibility() || getAccessibilityNodeProvider() != null 8006 || getAccessibilityLiveRegion() != ACCESSIBILITY_LIVE_REGION_NONE; 8007 } 8008 8009 /** 8010 * Gets the parent for accessibility purposes. Note that the parent for 8011 * accessibility is not necessary the immediate parent. It is the first 8012 * predecessor that is important for accessibility. 8013 * 8014 * @return The parent for accessibility purposes. 8015 */ 8016 public ViewParent getParentForAccessibility() { 8017 if (mParent instanceof View) { 8018 View parentView = (View) mParent; 8019 if (parentView.includeForAccessibility()) { 8020 return mParent; 8021 } else { 8022 return mParent.getParentForAccessibility(); 8023 } 8024 } 8025 return null; 8026 } 8027 8028 /** 8029 * Adds the children of a given View for accessibility. Since some Views are 8030 * not important for accessibility the children for accessibility are not 8031 * necessarily direct children of the view, rather they are the first level of 8032 * descendants important for accessibility. 8033 * 8034 * @param children The list of children for accessibility. 8035 */ 8036 public void addChildrenForAccessibility(ArrayList<View> children) { 8037 8038 } 8039 8040 /** 8041 * Whether to regard this view for accessibility. A view is regarded for 8042 * accessibility if it is important for accessibility or the querying 8043 * accessibility service has explicitly requested that view not 8044 * important for accessibility are regarded. 8045 * 8046 * @return Whether to regard the view for accessibility. 8047 * 8048 * @hide 8049 */ 8050 public boolean includeForAccessibility() { 8051 if (mAttachInfo != null) { 8052 return (mAttachInfo.mAccessibilityFetchFlags 8053 & AccessibilityNodeInfo.FLAG_INCLUDE_NOT_IMPORTANT_VIEWS) != 0 8054 || isImportantForAccessibility(); 8055 } 8056 return false; 8057 } 8058 8059 /** 8060 * Returns whether the View is considered actionable from 8061 * accessibility perspective. Such view are important for 8062 * accessibility. 8063 * 8064 * @return True if the view is actionable for accessibility. 8065 * 8066 * @hide 8067 */ 8068 public boolean isActionableForAccessibility() { 8069 return (isClickable() || isLongClickable() || isFocusable()); 8070 } 8071 8072 /** 8073 * Returns whether the View has registered callbacks which makes it 8074 * important for accessibility. 8075 * 8076 * @return True if the view is actionable for accessibility. 8077 */ 8078 private boolean hasListenersForAccessibility() { 8079 ListenerInfo info = getListenerInfo(); 8080 return mTouchDelegate != null || info.mOnKeyListener != null 8081 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null 8082 || info.mOnHoverListener != null || info.mOnDragListener != null; 8083 } 8084 8085 /** 8086 * Notifies that the accessibility state of this view changed. The change 8087 * is local to this view and does not represent structural changes such 8088 * as children and parent. For example, the view became focusable. The 8089 * notification is at at most once every 8090 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 8091 * to avoid unnecessary load to the system. Also once a view has a pending 8092 * notification this method is a NOP until the notification has been sent. 8093 * 8094 * @hide 8095 */ 8096 public void notifyViewAccessibilityStateChangedIfNeeded(int changeType) { 8097 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8098 return; 8099 } 8100 if (mSendViewStateChangedAccessibilityEvent == null) { 8101 mSendViewStateChangedAccessibilityEvent = 8102 new SendViewStateChangedAccessibilityEvent(); 8103 } 8104 mSendViewStateChangedAccessibilityEvent.runOrPost(changeType); 8105 } 8106 8107 /** 8108 * Notifies that the accessibility state of this view changed. The change 8109 * is *not* local to this view and does represent structural changes such 8110 * as children and parent. For example, the view size changed. The 8111 * notification is at at most once every 8112 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 8113 * to avoid unnecessary load to the system. Also once a view has a pending 8114 * notification this method is a NOP until the notification has been sent. 8115 * 8116 * @hide 8117 */ 8118 public void notifySubtreeAccessibilityStateChangedIfNeeded() { 8119 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8120 return; 8121 } 8122 if ((mPrivateFlags2 & PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED) == 0) { 8123 mPrivateFlags2 |= PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8124 if (mParent != null) { 8125 try { 8126 mParent.notifySubtreeAccessibilityStateChanged( 8127 this, this, AccessibilityEvent.CONTENT_CHANGE_TYPE_SUBTREE); 8128 } catch (AbstractMethodError e) { 8129 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 8130 " does not fully implement ViewParent", e); 8131 } 8132 } 8133 } 8134 } 8135 8136 /** 8137 * Reset the flag indicating the accessibility state of the subtree rooted 8138 * at this view changed. 8139 */ 8140 void resetSubtreeAccessibilityStateChanged() { 8141 mPrivateFlags2 &= ~PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8142 } 8143 8144 /** 8145 * Report an accessibility action to this view's parents for delegated processing. 8146 * 8147 * <p>Implementations of {@link #performAccessibilityAction(int, Bundle)} may internally 8148 * call this method to delegate an accessibility action to a supporting parent. If the parent 8149 * returns true from its 8150 * {@link ViewParent#onNestedPrePerformAccessibilityAction(View, int, android.os.Bundle)} 8151 * method this method will return true to signify that the action was consumed.</p> 8152 * 8153 * <p>This method is useful for implementing nested scrolling child views. If 8154 * {@link #isNestedScrollingEnabled()} returns true and the action is a scrolling action 8155 * a custom view implementation may invoke this method to allow a parent to consume the 8156 * scroll first. If this method returns true the custom view should skip its own scrolling 8157 * behavior.</p> 8158 * 8159 * @param action Accessibility action to delegate 8160 * @param arguments Optional action arguments 8161 * @return true if the action was consumed by a parent 8162 */ 8163 public boolean dispatchNestedPrePerformAccessibilityAction(int action, Bundle arguments) { 8164 for (ViewParent p = getParent(); p != null; p = p.getParent()) { 8165 if (p.onNestedPrePerformAccessibilityAction(this, action, arguments)) { 8166 return true; 8167 } 8168 } 8169 return false; 8170 } 8171 8172 /** 8173 * Performs the specified accessibility action on the view. For 8174 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 8175 * <p> 8176 * If an {@link AccessibilityDelegate} has been specified via calling 8177 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 8178 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)} 8179 * is responsible for handling this call. 8180 * </p> 8181 * 8182 * <p>The default implementation will delegate 8183 * {@link AccessibilityNodeInfo#ACTION_SCROLL_BACKWARD} and 8184 * {@link AccessibilityNodeInfo#ACTION_SCROLL_FORWARD} to nested scrolling parents if 8185 * {@link #isNestedScrollingEnabled() nested scrolling is enabled} on this view.</p> 8186 * 8187 * @param action The action to perform. 8188 * @param arguments Optional action arguments. 8189 * @return Whether the action was performed. 8190 */ 8191 public boolean performAccessibilityAction(int action, Bundle arguments) { 8192 if (mAccessibilityDelegate != null) { 8193 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments); 8194 } else { 8195 return performAccessibilityActionInternal(action, arguments); 8196 } 8197 } 8198 8199 /** 8200 * @see #performAccessibilityAction(int, Bundle) 8201 * 8202 * Note: Called from the default {@link AccessibilityDelegate}. 8203 * 8204 * @hide Until we've refactored all accessibility delegation methods. 8205 */ 8206 public boolean performAccessibilityActionInternal(int action, Bundle arguments) { 8207 if (isNestedScrollingEnabled() 8208 && (action == AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD 8209 || action == AccessibilityNodeInfo.ACTION_SCROLL_FORWARD)) { 8210 if (dispatchNestedPrePerformAccessibilityAction(action, arguments)) { 8211 return true; 8212 } 8213 } 8214 8215 switch (action) { 8216 case AccessibilityNodeInfo.ACTION_CLICK: { 8217 if (isClickable()) { 8218 performClick(); 8219 return true; 8220 } 8221 } break; 8222 case AccessibilityNodeInfo.ACTION_LONG_CLICK: { 8223 if (isLongClickable()) { 8224 performLongClick(); 8225 return true; 8226 } 8227 } break; 8228 case AccessibilityNodeInfo.ACTION_FOCUS: { 8229 if (!hasFocus()) { 8230 // Get out of touch mode since accessibility 8231 // wants to move focus around. 8232 getViewRootImpl().ensureTouchMode(false); 8233 return requestFocus(); 8234 } 8235 } break; 8236 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: { 8237 if (hasFocus()) { 8238 clearFocus(); 8239 return !isFocused(); 8240 } 8241 } break; 8242 case AccessibilityNodeInfo.ACTION_SELECT: { 8243 if (!isSelected()) { 8244 setSelected(true); 8245 return isSelected(); 8246 } 8247 } break; 8248 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: { 8249 if (isSelected()) { 8250 setSelected(false); 8251 return !isSelected(); 8252 } 8253 } break; 8254 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: { 8255 if (!isAccessibilityFocused()) { 8256 return requestAccessibilityFocus(); 8257 } 8258 } break; 8259 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: { 8260 if (isAccessibilityFocused()) { 8261 clearAccessibilityFocus(); 8262 return true; 8263 } 8264 } break; 8265 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: { 8266 if (arguments != null) { 8267 final int granularity = arguments.getInt( 8268 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8269 final boolean extendSelection = arguments.getBoolean( 8270 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8271 return traverseAtGranularity(granularity, true, extendSelection); 8272 } 8273 } break; 8274 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: { 8275 if (arguments != null) { 8276 final int granularity = arguments.getInt( 8277 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8278 final boolean extendSelection = arguments.getBoolean( 8279 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8280 return traverseAtGranularity(granularity, false, extendSelection); 8281 } 8282 } break; 8283 case AccessibilityNodeInfo.ACTION_SET_SELECTION: { 8284 CharSequence text = getIterableTextForAccessibility(); 8285 if (text == null) { 8286 return false; 8287 } 8288 final int start = (arguments != null) ? arguments.getInt( 8289 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT, -1) : -1; 8290 final int end = (arguments != null) ? arguments.getInt( 8291 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT, -1) : -1; 8292 // Only cursor position can be specified (selection length == 0) 8293 if ((getAccessibilitySelectionStart() != start 8294 || getAccessibilitySelectionEnd() != end) 8295 && (start == end)) { 8296 setAccessibilitySelection(start, end); 8297 notifyViewAccessibilityStateChangedIfNeeded( 8298 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 8299 return true; 8300 } 8301 } break; 8302 } 8303 return false; 8304 } 8305 8306 private boolean traverseAtGranularity(int granularity, boolean forward, 8307 boolean extendSelection) { 8308 CharSequence text = getIterableTextForAccessibility(); 8309 if (text == null || text.length() == 0) { 8310 return false; 8311 } 8312 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 8313 if (iterator == null) { 8314 return false; 8315 } 8316 int current = getAccessibilitySelectionEnd(); 8317 if (current == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8318 current = forward ? 0 : text.length(); 8319 } 8320 final int[] range = forward ? iterator.following(current) : iterator.preceding(current); 8321 if (range == null) { 8322 return false; 8323 } 8324 final int segmentStart = range[0]; 8325 final int segmentEnd = range[1]; 8326 int selectionStart; 8327 int selectionEnd; 8328 if (extendSelection && isAccessibilitySelectionExtendable()) { 8329 selectionStart = getAccessibilitySelectionStart(); 8330 if (selectionStart == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8331 selectionStart = forward ? segmentStart : segmentEnd; 8332 } 8333 selectionEnd = forward ? segmentEnd : segmentStart; 8334 } else { 8335 selectionStart = selectionEnd= forward ? segmentEnd : segmentStart; 8336 } 8337 setAccessibilitySelection(selectionStart, selectionEnd); 8338 final int action = forward ? AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY 8339 : AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY; 8340 sendViewTextTraversedAtGranularityEvent(action, granularity, segmentStart, segmentEnd); 8341 return true; 8342 } 8343 8344 /** 8345 * Gets the text reported for accessibility purposes. 8346 * 8347 * @return The accessibility text. 8348 * 8349 * @hide 8350 */ 8351 public CharSequence getIterableTextForAccessibility() { 8352 return getContentDescription(); 8353 } 8354 8355 /** 8356 * Gets whether accessibility selection can be extended. 8357 * 8358 * @return If selection is extensible. 8359 * 8360 * @hide 8361 */ 8362 public boolean isAccessibilitySelectionExtendable() { 8363 return false; 8364 } 8365 8366 /** 8367 * @hide 8368 */ 8369 public int getAccessibilitySelectionStart() { 8370 return mAccessibilityCursorPosition; 8371 } 8372 8373 /** 8374 * @hide 8375 */ 8376 public int getAccessibilitySelectionEnd() { 8377 return getAccessibilitySelectionStart(); 8378 } 8379 8380 /** 8381 * @hide 8382 */ 8383 public void setAccessibilitySelection(int start, int end) { 8384 if (start == end && end == mAccessibilityCursorPosition) { 8385 return; 8386 } 8387 if (start >= 0 && start == end && end <= getIterableTextForAccessibility().length()) { 8388 mAccessibilityCursorPosition = start; 8389 } else { 8390 mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED; 8391 } 8392 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED); 8393 } 8394 8395 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity, 8396 int fromIndex, int toIndex) { 8397 if (mParent == null) { 8398 return; 8399 } 8400 AccessibilityEvent event = AccessibilityEvent.obtain( 8401 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY); 8402 onInitializeAccessibilityEvent(event); 8403 onPopulateAccessibilityEvent(event); 8404 event.setFromIndex(fromIndex); 8405 event.setToIndex(toIndex); 8406 event.setAction(action); 8407 event.setMovementGranularity(granularity); 8408 mParent.requestSendAccessibilityEvent(this, event); 8409 } 8410 8411 /** 8412 * @hide 8413 */ 8414 public TextSegmentIterator getIteratorForGranularity(int granularity) { 8415 switch (granularity) { 8416 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: { 8417 CharSequence text = getIterableTextForAccessibility(); 8418 if (text != null && text.length() > 0) { 8419 CharacterTextSegmentIterator iterator = 8420 CharacterTextSegmentIterator.getInstance( 8421 mContext.getResources().getConfiguration().locale); 8422 iterator.initialize(text.toString()); 8423 return iterator; 8424 } 8425 } break; 8426 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: { 8427 CharSequence text = getIterableTextForAccessibility(); 8428 if (text != null && text.length() > 0) { 8429 WordTextSegmentIterator iterator = 8430 WordTextSegmentIterator.getInstance( 8431 mContext.getResources().getConfiguration().locale); 8432 iterator.initialize(text.toString()); 8433 return iterator; 8434 } 8435 } break; 8436 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: { 8437 CharSequence text = getIterableTextForAccessibility(); 8438 if (text != null && text.length() > 0) { 8439 ParagraphTextSegmentIterator iterator = 8440 ParagraphTextSegmentIterator.getInstance(); 8441 iterator.initialize(text.toString()); 8442 return iterator; 8443 } 8444 } break; 8445 } 8446 return null; 8447 } 8448 8449 /** 8450 * @hide 8451 */ 8452 public void dispatchStartTemporaryDetach() { 8453 onStartTemporaryDetach(); 8454 } 8455 8456 /** 8457 * This is called when a container is going to temporarily detach a child, with 8458 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 8459 * It will either be followed by {@link #onFinishTemporaryDetach()} or 8460 * {@link #onDetachedFromWindow()} when the container is done. 8461 */ 8462 public void onStartTemporaryDetach() { 8463 removeUnsetPressCallback(); 8464 mPrivateFlags |= PFLAG_CANCEL_NEXT_UP_EVENT; 8465 } 8466 8467 /** 8468 * @hide 8469 */ 8470 public void dispatchFinishTemporaryDetach() { 8471 onFinishTemporaryDetach(); 8472 } 8473 8474 /** 8475 * Called after {@link #onStartTemporaryDetach} when the container is done 8476 * changing the view. 8477 */ 8478 public void onFinishTemporaryDetach() { 8479 } 8480 8481 /** 8482 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 8483 * for this view's window. Returns null if the view is not currently attached 8484 * to the window. Normally you will not need to use this directly, but 8485 * just use the standard high-level event callbacks like 8486 * {@link #onKeyDown(int, KeyEvent)}. 8487 */ 8488 public KeyEvent.DispatcherState getKeyDispatcherState() { 8489 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 8490 } 8491 8492 /** 8493 * Dispatch a key event before it is processed by any input method 8494 * associated with the view hierarchy. This can be used to intercept 8495 * key events in special situations before the IME consumes them; a 8496 * typical example would be handling the BACK key to update the application's 8497 * UI instead of allowing the IME to see it and close itself. 8498 * 8499 * @param event The key event to be dispatched. 8500 * @return True if the event was handled, false otherwise. 8501 */ 8502 public boolean dispatchKeyEventPreIme(KeyEvent event) { 8503 return onKeyPreIme(event.getKeyCode(), event); 8504 } 8505 8506 /** 8507 * Dispatch a key event to the next view on the focus path. This path runs 8508 * from the top of the view tree down to the currently focused view. If this 8509 * view has focus, it will dispatch to itself. Otherwise it will dispatch 8510 * the next node down the focus path. This method also fires any key 8511 * listeners. 8512 * 8513 * @param event The key event to be dispatched. 8514 * @return True if the event was handled, false otherwise. 8515 */ 8516 public boolean dispatchKeyEvent(KeyEvent event) { 8517 if (mInputEventConsistencyVerifier != null) { 8518 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 8519 } 8520 8521 // Give any attached key listener a first crack at the event. 8522 //noinspection SimplifiableIfStatement 8523 ListenerInfo li = mListenerInfo; 8524 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 8525 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 8526 return true; 8527 } 8528 8529 if (event.dispatch(this, mAttachInfo != null 8530 ? mAttachInfo.mKeyDispatchState : null, this)) { 8531 return true; 8532 } 8533 8534 if (mInputEventConsistencyVerifier != null) { 8535 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8536 } 8537 return false; 8538 } 8539 8540 /** 8541 * Dispatches a key shortcut event. 8542 * 8543 * @param event The key event to be dispatched. 8544 * @return True if the event was handled by the view, false otherwise. 8545 */ 8546 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 8547 return onKeyShortcut(event.getKeyCode(), event); 8548 } 8549 8550 /** 8551 * Pass the touch screen motion event down to the target view, or this 8552 * view if it is the target. 8553 * 8554 * @param event The motion event to be dispatched. 8555 * @return True if the event was handled by the view, false otherwise. 8556 */ 8557 public boolean dispatchTouchEvent(MotionEvent event) { 8558 boolean result = false; 8559 8560 if (mInputEventConsistencyVerifier != null) { 8561 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 8562 } 8563 8564 final int actionMasked = event.getActionMasked(); 8565 if (actionMasked == MotionEvent.ACTION_DOWN) { 8566 // Defensive cleanup for new gesture 8567 stopNestedScroll(); 8568 } 8569 8570 if (onFilterTouchEventForSecurity(event)) { 8571 //noinspection SimplifiableIfStatement 8572 ListenerInfo li = mListenerInfo; 8573 if (li != null && li.mOnTouchListener != null 8574 && (mViewFlags & ENABLED_MASK) == ENABLED 8575 && li.mOnTouchListener.onTouch(this, event)) { 8576 result = true; 8577 } 8578 8579 if (!result && onTouchEvent(event)) { 8580 result = true; 8581 } 8582 } 8583 8584 if (!result && mInputEventConsistencyVerifier != null) { 8585 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8586 } 8587 8588 // Clean up after nested scrolls if this is the end of a gesture; 8589 // also cancel it if we tried an ACTION_DOWN but we didn't want the rest 8590 // of the gesture. 8591 if (actionMasked == MotionEvent.ACTION_UP || 8592 actionMasked == MotionEvent.ACTION_CANCEL || 8593 (actionMasked == MotionEvent.ACTION_DOWN && !result)) { 8594 stopNestedScroll(); 8595 } 8596 8597 return result; 8598 } 8599 8600 /** 8601 * Filter the touch event to apply security policies. 8602 * 8603 * @param event The motion event to be filtered. 8604 * @return True if the event should be dispatched, false if the event should be dropped. 8605 * 8606 * @see #getFilterTouchesWhenObscured 8607 */ 8608 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 8609 //noinspection RedundantIfStatement 8610 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 8611 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 8612 // Window is obscured, drop this touch. 8613 return false; 8614 } 8615 return true; 8616 } 8617 8618 /** 8619 * Pass a trackball motion event down to the focused view. 8620 * 8621 * @param event The motion event to be dispatched. 8622 * @return True if the event was handled by the view, false otherwise. 8623 */ 8624 public boolean dispatchTrackballEvent(MotionEvent event) { 8625 if (mInputEventConsistencyVerifier != null) { 8626 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 8627 } 8628 8629 return onTrackballEvent(event); 8630 } 8631 8632 /** 8633 * Dispatch a generic motion event. 8634 * <p> 8635 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 8636 * are delivered to the view under the pointer. All other generic motion events are 8637 * delivered to the focused view. Hover events are handled specially and are delivered 8638 * to {@link #onHoverEvent(MotionEvent)}. 8639 * </p> 8640 * 8641 * @param event The motion event to be dispatched. 8642 * @return True if the event was handled by the view, false otherwise. 8643 */ 8644 public boolean dispatchGenericMotionEvent(MotionEvent event) { 8645 if (mInputEventConsistencyVerifier != null) { 8646 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 8647 } 8648 8649 final int source = event.getSource(); 8650 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 8651 final int action = event.getAction(); 8652 if (action == MotionEvent.ACTION_HOVER_ENTER 8653 || action == MotionEvent.ACTION_HOVER_MOVE 8654 || action == MotionEvent.ACTION_HOVER_EXIT) { 8655 if (dispatchHoverEvent(event)) { 8656 return true; 8657 } 8658 } else if (dispatchGenericPointerEvent(event)) { 8659 return true; 8660 } 8661 } else if (dispatchGenericFocusedEvent(event)) { 8662 return true; 8663 } 8664 8665 if (dispatchGenericMotionEventInternal(event)) { 8666 return true; 8667 } 8668 8669 if (mInputEventConsistencyVerifier != null) { 8670 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8671 } 8672 return false; 8673 } 8674 8675 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 8676 //noinspection SimplifiableIfStatement 8677 ListenerInfo li = mListenerInfo; 8678 if (li != null && li.mOnGenericMotionListener != null 8679 && (mViewFlags & ENABLED_MASK) == ENABLED 8680 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 8681 return true; 8682 } 8683 8684 if (onGenericMotionEvent(event)) { 8685 return true; 8686 } 8687 8688 if (mInputEventConsistencyVerifier != null) { 8689 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8690 } 8691 return false; 8692 } 8693 8694 /** 8695 * Dispatch a hover event. 8696 * <p> 8697 * Do not call this method directly. 8698 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8699 * </p> 8700 * 8701 * @param event The motion event to be dispatched. 8702 * @return True if the event was handled by the view, false otherwise. 8703 */ 8704 protected boolean dispatchHoverEvent(MotionEvent event) { 8705 ListenerInfo li = mListenerInfo; 8706 //noinspection SimplifiableIfStatement 8707 if (li != null && li.mOnHoverListener != null 8708 && (mViewFlags & ENABLED_MASK) == ENABLED 8709 && li.mOnHoverListener.onHover(this, event)) { 8710 return true; 8711 } 8712 8713 return onHoverEvent(event); 8714 } 8715 8716 /** 8717 * Returns true if the view has a child to which it has recently sent 8718 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 8719 * it does not have a hovered child, then it must be the innermost hovered view. 8720 * @hide 8721 */ 8722 protected boolean hasHoveredChild() { 8723 return false; 8724 } 8725 8726 /** 8727 * Dispatch a generic motion event to the view under the first pointer. 8728 * <p> 8729 * Do not call this method directly. 8730 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8731 * </p> 8732 * 8733 * @param event The motion event to be dispatched. 8734 * @return True if the event was handled by the view, false otherwise. 8735 */ 8736 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 8737 return false; 8738 } 8739 8740 /** 8741 * Dispatch a generic motion event to the currently focused view. 8742 * <p> 8743 * Do not call this method directly. 8744 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8745 * </p> 8746 * 8747 * @param event The motion event to be dispatched. 8748 * @return True if the event was handled by the view, false otherwise. 8749 */ 8750 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 8751 return false; 8752 } 8753 8754 /** 8755 * Dispatch a pointer event. 8756 * <p> 8757 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 8758 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 8759 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 8760 * and should not be expected to handle other pointing device features. 8761 * </p> 8762 * 8763 * @param event The motion event to be dispatched. 8764 * @return True if the event was handled by the view, false otherwise. 8765 * @hide 8766 */ 8767 public final boolean dispatchPointerEvent(MotionEvent event) { 8768 if (event.isTouchEvent()) { 8769 return dispatchTouchEvent(event); 8770 } else { 8771 return dispatchGenericMotionEvent(event); 8772 } 8773 } 8774 8775 /** 8776 * Called when the window containing this view gains or loses window focus. 8777 * ViewGroups should override to route to their children. 8778 * 8779 * @param hasFocus True if the window containing this view now has focus, 8780 * false otherwise. 8781 */ 8782 public void dispatchWindowFocusChanged(boolean hasFocus) { 8783 onWindowFocusChanged(hasFocus); 8784 } 8785 8786 /** 8787 * Called when the window containing this view gains or loses focus. Note 8788 * that this is separate from view focus: to receive key events, both 8789 * your view and its window must have focus. If a window is displayed 8790 * on top of yours that takes input focus, then your own window will lose 8791 * focus but the view focus will remain unchanged. 8792 * 8793 * @param hasWindowFocus True if the window containing this view now has 8794 * focus, false otherwise. 8795 */ 8796 public void onWindowFocusChanged(boolean hasWindowFocus) { 8797 InputMethodManager imm = InputMethodManager.peekInstance(); 8798 if (!hasWindowFocus) { 8799 if (isPressed()) { 8800 setPressed(false); 8801 } 8802 if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8803 imm.focusOut(this); 8804 } 8805 removeLongPressCallback(); 8806 removeTapCallback(); 8807 onFocusLost(); 8808 } else if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8809 imm.focusIn(this); 8810 } 8811 refreshDrawableState(); 8812 } 8813 8814 /** 8815 * Returns true if this view is in a window that currently has window focus. 8816 * Note that this is not the same as the view itself having focus. 8817 * 8818 * @return True if this view is in a window that currently has window focus. 8819 */ 8820 public boolean hasWindowFocus() { 8821 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 8822 } 8823 8824 /** 8825 * Dispatch a view visibility change down the view hierarchy. 8826 * ViewGroups should override to route to their children. 8827 * @param changedView The view whose visibility changed. Could be 'this' or 8828 * an ancestor view. 8829 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8830 * {@link #INVISIBLE} or {@link #GONE}. 8831 */ 8832 protected void dispatchVisibilityChanged(@NonNull View changedView, 8833 @Visibility int visibility) { 8834 onVisibilityChanged(changedView, visibility); 8835 } 8836 8837 /** 8838 * Called when the visibility of the view or an ancestor of the view is changed. 8839 * @param changedView The view whose visibility changed. Could be 'this' or 8840 * an ancestor view. 8841 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8842 * {@link #INVISIBLE} or {@link #GONE}. 8843 */ 8844 protected void onVisibilityChanged(@NonNull View changedView, @Visibility int visibility) { 8845 if (visibility == VISIBLE) { 8846 if (mAttachInfo != null) { 8847 initialAwakenScrollBars(); 8848 } else { 8849 mPrivateFlags |= PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 8850 } 8851 } 8852 } 8853 8854 /** 8855 * Dispatch a hint about whether this view is displayed. For instance, when 8856 * a View moves out of the screen, it might receives a display hint indicating 8857 * the view is not displayed. Applications should not <em>rely</em> on this hint 8858 * as there is no guarantee that they will receive one. 8859 * 8860 * @param hint A hint about whether or not this view is displayed: 8861 * {@link #VISIBLE} or {@link #INVISIBLE}. 8862 */ 8863 public void dispatchDisplayHint(@Visibility int hint) { 8864 onDisplayHint(hint); 8865 } 8866 8867 /** 8868 * Gives this view a hint about whether is displayed or not. For instance, when 8869 * a View moves out of the screen, it might receives a display hint indicating 8870 * the view is not displayed. Applications should not <em>rely</em> on this hint 8871 * as there is no guarantee that they will receive one. 8872 * 8873 * @param hint A hint about whether or not this view is displayed: 8874 * {@link #VISIBLE} or {@link #INVISIBLE}. 8875 */ 8876 protected void onDisplayHint(@Visibility int hint) { 8877 } 8878 8879 /** 8880 * Dispatch a window visibility change down the view hierarchy. 8881 * ViewGroups should override to route to their children. 8882 * 8883 * @param visibility The new visibility of the window. 8884 * 8885 * @see #onWindowVisibilityChanged(int) 8886 */ 8887 public void dispatchWindowVisibilityChanged(@Visibility int visibility) { 8888 onWindowVisibilityChanged(visibility); 8889 } 8890 8891 /** 8892 * Called when the window containing has change its visibility 8893 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 8894 * that this tells you whether or not your window is being made visible 8895 * to the window manager; this does <em>not</em> tell you whether or not 8896 * your window is obscured by other windows on the screen, even if it 8897 * is itself visible. 8898 * 8899 * @param visibility The new visibility of the window. 8900 */ 8901 protected void onWindowVisibilityChanged(@Visibility int visibility) { 8902 if (visibility == VISIBLE) { 8903 initialAwakenScrollBars(); 8904 } 8905 } 8906 8907 /** 8908 * Returns the current visibility of the window this view is attached to 8909 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 8910 * 8911 * @return Returns the current visibility of the view's window. 8912 */ 8913 @Visibility 8914 public int getWindowVisibility() { 8915 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 8916 } 8917 8918 /** 8919 * Retrieve the overall visible display size in which the window this view is 8920 * attached to has been positioned in. This takes into account screen 8921 * decorations above the window, for both cases where the window itself 8922 * is being position inside of them or the window is being placed under 8923 * then and covered insets are used for the window to position its content 8924 * inside. In effect, this tells you the available area where content can 8925 * be placed and remain visible to users. 8926 * 8927 * <p>This function requires an IPC back to the window manager to retrieve 8928 * the requested information, so should not be used in performance critical 8929 * code like drawing. 8930 * 8931 * @param outRect Filled in with the visible display frame. If the view 8932 * is not attached to a window, this is simply the raw display size. 8933 */ 8934 public void getWindowVisibleDisplayFrame(Rect outRect) { 8935 if (mAttachInfo != null) { 8936 try { 8937 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 8938 } catch (RemoteException e) { 8939 return; 8940 } 8941 // XXX This is really broken, and probably all needs to be done 8942 // in the window manager, and we need to know more about whether 8943 // we want the area behind or in front of the IME. 8944 final Rect insets = mAttachInfo.mVisibleInsets; 8945 outRect.left += insets.left; 8946 outRect.top += insets.top; 8947 outRect.right -= insets.right; 8948 outRect.bottom -= insets.bottom; 8949 return; 8950 } 8951 // The view is not attached to a display so we don't have a context. 8952 // Make a best guess about the display size. 8953 Display d = DisplayManagerGlobal.getInstance().getRealDisplay(Display.DEFAULT_DISPLAY); 8954 d.getRectSize(outRect); 8955 } 8956 8957 /** 8958 * Dispatch a notification about a resource configuration change down 8959 * the view hierarchy. 8960 * ViewGroups should override to route to their children. 8961 * 8962 * @param newConfig The new resource configuration. 8963 * 8964 * @see #onConfigurationChanged(android.content.res.Configuration) 8965 */ 8966 public void dispatchConfigurationChanged(Configuration newConfig) { 8967 onConfigurationChanged(newConfig); 8968 } 8969 8970 /** 8971 * Called when the current configuration of the resources being used 8972 * by the application have changed. You can use this to decide when 8973 * to reload resources that can changed based on orientation and other 8974 * configuration characterstics. You only need to use this if you are 8975 * not relying on the normal {@link android.app.Activity} mechanism of 8976 * recreating the activity instance upon a configuration change. 8977 * 8978 * @param newConfig The new resource configuration. 8979 */ 8980 protected void onConfigurationChanged(Configuration newConfig) { 8981 } 8982 8983 /** 8984 * Private function to aggregate all per-view attributes in to the view 8985 * root. 8986 */ 8987 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8988 performCollectViewAttributes(attachInfo, visibility); 8989 } 8990 8991 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8992 if ((visibility & VISIBILITY_MASK) == VISIBLE) { 8993 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 8994 attachInfo.mKeepScreenOn = true; 8995 } 8996 attachInfo.mSystemUiVisibility |= mSystemUiVisibility; 8997 ListenerInfo li = mListenerInfo; 8998 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 8999 attachInfo.mHasSystemUiListeners = true; 9000 } 9001 } 9002 } 9003 9004 void needGlobalAttributesUpdate(boolean force) { 9005 final AttachInfo ai = mAttachInfo; 9006 if (ai != null && !ai.mRecomputeGlobalAttributes) { 9007 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 9008 || ai.mHasSystemUiListeners) { 9009 ai.mRecomputeGlobalAttributes = true; 9010 } 9011 } 9012 } 9013 9014 /** 9015 * Returns whether the device is currently in touch mode. Touch mode is entered 9016 * once the user begins interacting with the device by touch, and affects various 9017 * things like whether focus is always visible to the user. 9018 * 9019 * @return Whether the device is in touch mode. 9020 */ 9021 @ViewDebug.ExportedProperty 9022 public boolean isInTouchMode() { 9023 if (mAttachInfo != null) { 9024 return mAttachInfo.mInTouchMode; 9025 } else { 9026 return ViewRootImpl.isInTouchMode(); 9027 } 9028 } 9029 9030 /** 9031 * Returns the context the view is running in, through which it can 9032 * access the current theme, resources, etc. 9033 * 9034 * @return The view's Context. 9035 */ 9036 @ViewDebug.CapturedViewProperty 9037 public final Context getContext() { 9038 return mContext; 9039 } 9040 9041 /** 9042 * Handle a key event before it is processed by any input method 9043 * associated with the view hierarchy. This can be used to intercept 9044 * key events in special situations before the IME consumes them; a 9045 * typical example would be handling the BACK key to update the application's 9046 * UI instead of allowing the IME to see it and close itself. 9047 * 9048 * @param keyCode The value in event.getKeyCode(). 9049 * @param event Description of the key event. 9050 * @return If you handled the event, return true. If you want to allow the 9051 * event to be handled by the next receiver, return false. 9052 */ 9053 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 9054 return false; 9055 } 9056 9057 /** 9058 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 9059 * KeyEvent.Callback.onKeyDown()}: perform press of the view 9060 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 9061 * is released, if the view is enabled and clickable. 9062 * 9063 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9064 * although some may elect to do so in some situations. Do not rely on this to 9065 * catch software key presses. 9066 * 9067 * @param keyCode A key code that represents the button pressed, from 9068 * {@link android.view.KeyEvent}. 9069 * @param event The KeyEvent object that defines the button action. 9070 */ 9071 public boolean onKeyDown(int keyCode, KeyEvent event) { 9072 boolean result = false; 9073 9074 if (KeyEvent.isConfirmKey(keyCode)) { 9075 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9076 return true; 9077 } 9078 // Long clickable items don't necessarily have to be clickable 9079 if (((mViewFlags & CLICKABLE) == CLICKABLE || 9080 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 9081 (event.getRepeatCount() == 0)) { 9082 setPressed(true); 9083 checkForLongClick(0); 9084 return true; 9085 } 9086 } 9087 return result; 9088 } 9089 9090 /** 9091 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 9092 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 9093 * the event). 9094 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9095 * although some may elect to do so in some situations. Do not rely on this to 9096 * catch software key presses. 9097 */ 9098 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 9099 return false; 9100 } 9101 9102 /** 9103 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 9104 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 9105 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 9106 * {@link KeyEvent#KEYCODE_ENTER} is released. 9107 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9108 * although some may elect to do so in some situations. Do not rely on this to 9109 * catch software key presses. 9110 * 9111 * @param keyCode A key code that represents the button pressed, from 9112 * {@link android.view.KeyEvent}. 9113 * @param event The KeyEvent object that defines the button action. 9114 */ 9115 public boolean onKeyUp(int keyCode, KeyEvent event) { 9116 if (KeyEvent.isConfirmKey(keyCode)) { 9117 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9118 return true; 9119 } 9120 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 9121 setPressed(false); 9122 9123 if (!mHasPerformedLongPress) { 9124 // This is a tap, so remove the longpress check 9125 removeLongPressCallback(); 9126 return performClick(); 9127 } 9128 } 9129 } 9130 return false; 9131 } 9132 9133 /** 9134 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 9135 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 9136 * the event). 9137 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9138 * although some may elect to do so in some situations. Do not rely on this to 9139 * catch software key presses. 9140 * 9141 * @param keyCode A key code that represents the button pressed, from 9142 * {@link android.view.KeyEvent}. 9143 * @param repeatCount The number of times the action was made. 9144 * @param event The KeyEvent object that defines the button action. 9145 */ 9146 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 9147 return false; 9148 } 9149 9150 /** 9151 * Called on the focused view when a key shortcut event is not handled. 9152 * Override this method to implement local key shortcuts for the View. 9153 * Key shortcuts can also be implemented by setting the 9154 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 9155 * 9156 * @param keyCode The value in event.getKeyCode(). 9157 * @param event Description of the key event. 9158 * @return If you handled the event, return true. If you want to allow the 9159 * event to be handled by the next receiver, return false. 9160 */ 9161 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 9162 return false; 9163 } 9164 9165 /** 9166 * Check whether the called view is a text editor, in which case it 9167 * would make sense to automatically display a soft input window for 9168 * it. Subclasses should override this if they implement 9169 * {@link #onCreateInputConnection(EditorInfo)} to return true if 9170 * a call on that method would return a non-null InputConnection, and 9171 * they are really a first-class editor that the user would normally 9172 * start typing on when the go into a window containing your view. 9173 * 9174 * <p>The default implementation always returns false. This does 9175 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 9176 * will not be called or the user can not otherwise perform edits on your 9177 * view; it is just a hint to the system that this is not the primary 9178 * purpose of this view. 9179 * 9180 * @return Returns true if this view is a text editor, else false. 9181 */ 9182 public boolean onCheckIsTextEditor() { 9183 return false; 9184 } 9185 9186 /** 9187 * Create a new InputConnection for an InputMethod to interact 9188 * with the view. The default implementation returns null, since it doesn't 9189 * support input methods. You can override this to implement such support. 9190 * This is only needed for views that take focus and text input. 9191 * 9192 * <p>When implementing this, you probably also want to implement 9193 * {@link #onCheckIsTextEditor()} to indicate you will return a 9194 * non-null InputConnection.</p> 9195 * 9196 * <p>Also, take good care to fill in the {@link android.view.inputmethod.EditorInfo} 9197 * object correctly and in its entirety, so that the connected IME can rely 9198 * on its values. For example, {@link android.view.inputmethod.EditorInfo#initialSelStart} 9199 * and {@link android.view.inputmethod.EditorInfo#initialSelEnd} members 9200 * must be filled in with the correct cursor position for IMEs to work correctly 9201 * with your application.</p> 9202 * 9203 * @param outAttrs Fill in with attribute information about the connection. 9204 */ 9205 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 9206 return null; 9207 } 9208 9209 /** 9210 * Called by the {@link android.view.inputmethod.InputMethodManager} 9211 * when a view who is not the current 9212 * input connection target is trying to make a call on the manager. The 9213 * default implementation returns false; you can override this to return 9214 * true for certain views if you are performing InputConnection proxying 9215 * to them. 9216 * @param view The View that is making the InputMethodManager call. 9217 * @return Return true to allow the call, false to reject. 9218 */ 9219 public boolean checkInputConnectionProxy(View view) { 9220 return false; 9221 } 9222 9223 /** 9224 * Show the context menu for this view. It is not safe to hold on to the 9225 * menu after returning from this method. 9226 * 9227 * You should normally not overload this method. Overload 9228 * {@link #onCreateContextMenu(ContextMenu)} or define an 9229 * {@link OnCreateContextMenuListener} to add items to the context menu. 9230 * 9231 * @param menu The context menu to populate 9232 */ 9233 public void createContextMenu(ContextMenu menu) { 9234 ContextMenuInfo menuInfo = getContextMenuInfo(); 9235 9236 // Sets the current menu info so all items added to menu will have 9237 // my extra info set. 9238 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 9239 9240 onCreateContextMenu(menu); 9241 ListenerInfo li = mListenerInfo; 9242 if (li != null && li.mOnCreateContextMenuListener != null) { 9243 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 9244 } 9245 9246 // Clear the extra information so subsequent items that aren't mine don't 9247 // have my extra info. 9248 ((MenuBuilder)menu).setCurrentMenuInfo(null); 9249 9250 if (mParent != null) { 9251 mParent.createContextMenu(menu); 9252 } 9253 } 9254 9255 /** 9256 * Views should implement this if they have extra information to associate 9257 * with the context menu. The return result is supplied as a parameter to 9258 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 9259 * callback. 9260 * 9261 * @return Extra information about the item for which the context menu 9262 * should be shown. This information will vary across different 9263 * subclasses of View. 9264 */ 9265 protected ContextMenuInfo getContextMenuInfo() { 9266 return null; 9267 } 9268 9269 /** 9270 * Views should implement this if the view itself is going to add items to 9271 * the context menu. 9272 * 9273 * @param menu the context menu to populate 9274 */ 9275 protected void onCreateContextMenu(ContextMenu menu) { 9276 } 9277 9278 /** 9279 * Implement this method to handle trackball motion events. The 9280 * <em>relative</em> movement of the trackball since the last event 9281 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 9282 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 9283 * that a movement of 1 corresponds to the user pressing one DPAD key (so 9284 * they will often be fractional values, representing the more fine-grained 9285 * movement information available from a trackball). 9286 * 9287 * @param event The motion event. 9288 * @return True if the event was handled, false otherwise. 9289 */ 9290 public boolean onTrackballEvent(MotionEvent event) { 9291 return false; 9292 } 9293 9294 /** 9295 * Implement this method to handle generic motion events. 9296 * <p> 9297 * Generic motion events describe joystick movements, mouse hovers, track pad 9298 * touches, scroll wheel movements and other input events. The 9299 * {@link MotionEvent#getSource() source} of the motion event specifies 9300 * the class of input that was received. Implementations of this method 9301 * must examine the bits in the source before processing the event. 9302 * The following code example shows how this is done. 9303 * </p><p> 9304 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 9305 * are delivered to the view under the pointer. All other generic motion events are 9306 * delivered to the focused view. 9307 * </p> 9308 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 9309 * if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) { 9310 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 9311 * // process the joystick movement... 9312 * return true; 9313 * } 9314 * } 9315 * if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) { 9316 * switch (event.getAction()) { 9317 * case MotionEvent.ACTION_HOVER_MOVE: 9318 * // process the mouse hover movement... 9319 * return true; 9320 * case MotionEvent.ACTION_SCROLL: 9321 * // process the scroll wheel movement... 9322 * return true; 9323 * } 9324 * } 9325 * return super.onGenericMotionEvent(event); 9326 * }</pre> 9327 * 9328 * @param event The generic motion event being processed. 9329 * @return True if the event was handled, false otherwise. 9330 */ 9331 public boolean onGenericMotionEvent(MotionEvent event) { 9332 return false; 9333 } 9334 9335 /** 9336 * Implement this method to handle hover events. 9337 * <p> 9338 * This method is called whenever a pointer is hovering into, over, or out of the 9339 * bounds of a view and the view is not currently being touched. 9340 * Hover events are represented as pointer events with action 9341 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 9342 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 9343 * </p> 9344 * <ul> 9345 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 9346 * when the pointer enters the bounds of the view.</li> 9347 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 9348 * when the pointer has already entered the bounds of the view and has moved.</li> 9349 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 9350 * when the pointer has exited the bounds of the view or when the pointer is 9351 * about to go down due to a button click, tap, or similar user action that 9352 * causes the view to be touched.</li> 9353 * </ul> 9354 * <p> 9355 * The view should implement this method to return true to indicate that it is 9356 * handling the hover event, such as by changing its drawable state. 9357 * </p><p> 9358 * The default implementation calls {@link #setHovered} to update the hovered state 9359 * of the view when a hover enter or hover exit event is received, if the view 9360 * is enabled and is clickable. The default implementation also sends hover 9361 * accessibility events. 9362 * </p> 9363 * 9364 * @param event The motion event that describes the hover. 9365 * @return True if the view handled the hover event. 9366 * 9367 * @see #isHovered 9368 * @see #setHovered 9369 * @see #onHoverChanged 9370 */ 9371 public boolean onHoverEvent(MotionEvent event) { 9372 // The root view may receive hover (or touch) events that are outside the bounds of 9373 // the window. This code ensures that we only send accessibility events for 9374 // hovers that are actually within the bounds of the root view. 9375 final int action = event.getActionMasked(); 9376 if (!mSendingHoverAccessibilityEvents) { 9377 if ((action == MotionEvent.ACTION_HOVER_ENTER 9378 || action == MotionEvent.ACTION_HOVER_MOVE) 9379 && !hasHoveredChild() 9380 && pointInView(event.getX(), event.getY())) { 9381 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 9382 mSendingHoverAccessibilityEvents = true; 9383 } 9384 } else { 9385 if (action == MotionEvent.ACTION_HOVER_EXIT 9386 || (action == MotionEvent.ACTION_MOVE 9387 && !pointInView(event.getX(), event.getY()))) { 9388 mSendingHoverAccessibilityEvents = false; 9389 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 9390 } 9391 } 9392 9393 if (isHoverable()) { 9394 switch (action) { 9395 case MotionEvent.ACTION_HOVER_ENTER: 9396 setHovered(true); 9397 break; 9398 case MotionEvent.ACTION_HOVER_EXIT: 9399 setHovered(false); 9400 break; 9401 } 9402 9403 // Dispatch the event to onGenericMotionEvent before returning true. 9404 // This is to provide compatibility with existing applications that 9405 // handled HOVER_MOVE events in onGenericMotionEvent and that would 9406 // break because of the new default handling for hoverable views 9407 // in onHoverEvent. 9408 // Note that onGenericMotionEvent will be called by default when 9409 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 9410 dispatchGenericMotionEventInternal(event); 9411 // The event was already handled by calling setHovered(), so always 9412 // return true. 9413 return true; 9414 } 9415 9416 return false; 9417 } 9418 9419 /** 9420 * Returns true if the view should handle {@link #onHoverEvent} 9421 * by calling {@link #setHovered} to change its hovered state. 9422 * 9423 * @return True if the view is hoverable. 9424 */ 9425 private boolean isHoverable() { 9426 final int viewFlags = mViewFlags; 9427 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9428 return false; 9429 } 9430 9431 return (viewFlags & CLICKABLE) == CLICKABLE 9432 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 9433 } 9434 9435 /** 9436 * Returns true if the view is currently hovered. 9437 * 9438 * @return True if the view is currently hovered. 9439 * 9440 * @see #setHovered 9441 * @see #onHoverChanged 9442 */ 9443 @ViewDebug.ExportedProperty 9444 public boolean isHovered() { 9445 return (mPrivateFlags & PFLAG_HOVERED) != 0; 9446 } 9447 9448 /** 9449 * Sets whether the view is currently hovered. 9450 * <p> 9451 * Calling this method also changes the drawable state of the view. This 9452 * enables the view to react to hover by using different drawable resources 9453 * to change its appearance. 9454 * </p><p> 9455 * The {@link #onHoverChanged} method is called when the hovered state changes. 9456 * </p> 9457 * 9458 * @param hovered True if the view is hovered. 9459 * 9460 * @see #isHovered 9461 * @see #onHoverChanged 9462 */ 9463 public void setHovered(boolean hovered) { 9464 if (hovered) { 9465 if ((mPrivateFlags & PFLAG_HOVERED) == 0) { 9466 mPrivateFlags |= PFLAG_HOVERED; 9467 refreshDrawableState(); 9468 onHoverChanged(true); 9469 } 9470 } else { 9471 if ((mPrivateFlags & PFLAG_HOVERED) != 0) { 9472 mPrivateFlags &= ~PFLAG_HOVERED; 9473 refreshDrawableState(); 9474 onHoverChanged(false); 9475 } 9476 } 9477 } 9478 9479 /** 9480 * Implement this method to handle hover state changes. 9481 * <p> 9482 * This method is called whenever the hover state changes as a result of a 9483 * call to {@link #setHovered}. 9484 * </p> 9485 * 9486 * @param hovered The current hover state, as returned by {@link #isHovered}. 9487 * 9488 * @see #isHovered 9489 * @see #setHovered 9490 */ 9491 public void onHoverChanged(boolean hovered) { 9492 } 9493 9494 /** 9495 * Implement this method to handle touch screen motion events. 9496 * <p> 9497 * If this method is used to detect click actions, it is recommended that 9498 * the actions be performed by implementing and calling 9499 * {@link #performClick()}. This will ensure consistent system behavior, 9500 * including: 9501 * <ul> 9502 * <li>obeying click sound preferences 9503 * <li>dispatching OnClickListener calls 9504 * <li>handling {@link AccessibilityNodeInfo#ACTION_CLICK ACTION_CLICK} when 9505 * accessibility features are enabled 9506 * </ul> 9507 * 9508 * @param event The motion event. 9509 * @return True if the event was handled, false otherwise. 9510 */ 9511 public boolean onTouchEvent(MotionEvent event) { 9512 final float x = event.getX(); 9513 final float y = event.getY(); 9514 final int viewFlags = mViewFlags; 9515 9516 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9517 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) { 9518 setPressed(false); 9519 } 9520 // A disabled view that is clickable still consumes the touch 9521 // events, it just doesn't respond to them. 9522 return (((viewFlags & CLICKABLE) == CLICKABLE || 9523 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 9524 } 9525 9526 if (mTouchDelegate != null) { 9527 if (mTouchDelegate.onTouchEvent(event)) { 9528 return true; 9529 } 9530 } 9531 9532 if (((viewFlags & CLICKABLE) == CLICKABLE || 9533 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 9534 switch (event.getAction()) { 9535 case MotionEvent.ACTION_UP: 9536 boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0; 9537 if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) { 9538 // take focus if we don't have it already and we should in 9539 // touch mode. 9540 boolean focusTaken = false; 9541 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 9542 focusTaken = requestFocus(); 9543 } 9544 9545 if (prepressed) { 9546 // The button is being released before we actually 9547 // showed it as pressed. Make it show the pressed 9548 // state now (before scheduling the click) to ensure 9549 // the user sees it. 9550 setPressed(true, x, y); 9551 } 9552 9553 if (!mHasPerformedLongPress) { 9554 // This is a tap, so remove the longpress check 9555 removeLongPressCallback(); 9556 9557 // Only perform take click actions if we were in the pressed state 9558 if (!focusTaken) { 9559 // Use a Runnable and post this rather than calling 9560 // performClick directly. This lets other visual state 9561 // of the view update before click actions start. 9562 if (mPerformClick == null) { 9563 mPerformClick = new PerformClick(); 9564 } 9565 if (!post(mPerformClick)) { 9566 performClick(); 9567 } 9568 } 9569 } 9570 9571 if (mUnsetPressedState == null) { 9572 mUnsetPressedState = new UnsetPressedState(); 9573 } 9574 9575 if (prepressed) { 9576 postDelayed(mUnsetPressedState, 9577 ViewConfiguration.getPressedStateDuration()); 9578 } else if (!post(mUnsetPressedState)) { 9579 // If the post failed, unpress right now 9580 mUnsetPressedState.run(); 9581 } 9582 9583 removeTapCallback(); 9584 } 9585 break; 9586 9587 case MotionEvent.ACTION_DOWN: 9588 mHasPerformedLongPress = false; 9589 9590 if (performButtonActionOnTouchDown(event)) { 9591 break; 9592 } 9593 9594 // Walk up the hierarchy to determine if we're inside a scrolling container. 9595 boolean isInScrollingContainer = isInScrollingContainer(); 9596 9597 // For views inside a scrolling container, delay the pressed feedback for 9598 // a short period in case this is a scroll. 9599 if (isInScrollingContainer) { 9600 mPrivateFlags |= PFLAG_PREPRESSED; 9601 if (mPendingCheckForTap == null) { 9602 mPendingCheckForTap = new CheckForTap(); 9603 } 9604 mPendingCheckForTap.x = event.getX(); 9605 mPendingCheckForTap.y = event.getY(); 9606 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 9607 } else { 9608 // Not inside a scrolling container, so show the feedback right away 9609 setPressed(true, x, y); 9610 checkForLongClick(0); 9611 } 9612 break; 9613 9614 case MotionEvent.ACTION_CANCEL: 9615 setPressed(false); 9616 removeTapCallback(); 9617 removeLongPressCallback(); 9618 break; 9619 9620 case MotionEvent.ACTION_MOVE: 9621 drawableHotspotChanged(x, y); 9622 9623 // Be lenient about moving outside of buttons 9624 if (!pointInView(x, y, mTouchSlop)) { 9625 // Outside button 9626 removeTapCallback(); 9627 if ((mPrivateFlags & PFLAG_PRESSED) != 0) { 9628 // Remove any future long press/tap checks 9629 removeLongPressCallback(); 9630 9631 setPressed(false); 9632 } 9633 } 9634 break; 9635 } 9636 9637 return true; 9638 } 9639 9640 return false; 9641 } 9642 9643 /** 9644 * @hide 9645 */ 9646 public boolean isInScrollingContainer() { 9647 ViewParent p = getParent(); 9648 while (p != null && p instanceof ViewGroup) { 9649 if (((ViewGroup) p).shouldDelayChildPressedState()) { 9650 return true; 9651 } 9652 p = p.getParent(); 9653 } 9654 return false; 9655 } 9656 9657 /** 9658 * Remove the longpress detection timer. 9659 */ 9660 private void removeLongPressCallback() { 9661 if (mPendingCheckForLongPress != null) { 9662 removeCallbacks(mPendingCheckForLongPress); 9663 } 9664 } 9665 9666 /** 9667 * Remove the pending click action 9668 */ 9669 private void removePerformClickCallback() { 9670 if (mPerformClick != null) { 9671 removeCallbacks(mPerformClick); 9672 } 9673 } 9674 9675 /** 9676 * Remove the prepress detection timer. 9677 */ 9678 private void removeUnsetPressCallback() { 9679 if ((mPrivateFlags & PFLAG_PRESSED) != 0 && mUnsetPressedState != null) { 9680 setPressed(false); 9681 removeCallbacks(mUnsetPressedState); 9682 } 9683 } 9684 9685 /** 9686 * Remove the tap detection timer. 9687 */ 9688 private void removeTapCallback() { 9689 if (mPendingCheckForTap != null) { 9690 mPrivateFlags &= ~PFLAG_PREPRESSED; 9691 removeCallbacks(mPendingCheckForTap); 9692 } 9693 } 9694 9695 /** 9696 * Cancels a pending long press. Your subclass can use this if you 9697 * want the context menu to come up if the user presses and holds 9698 * at the same place, but you don't want it to come up if they press 9699 * and then move around enough to cause scrolling. 9700 */ 9701 public void cancelLongPress() { 9702 removeLongPressCallback(); 9703 9704 /* 9705 * The prepressed state handled by the tap callback is a display 9706 * construct, but the tap callback will post a long press callback 9707 * less its own timeout. Remove it here. 9708 */ 9709 removeTapCallback(); 9710 } 9711 9712 /** 9713 * Remove the pending callback for sending a 9714 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 9715 */ 9716 private void removeSendViewScrolledAccessibilityEventCallback() { 9717 if (mSendViewScrolledAccessibilityEvent != null) { 9718 removeCallbacks(mSendViewScrolledAccessibilityEvent); 9719 mSendViewScrolledAccessibilityEvent.mIsPending = false; 9720 } 9721 } 9722 9723 /** 9724 * Sets the TouchDelegate for this View. 9725 */ 9726 public void setTouchDelegate(TouchDelegate delegate) { 9727 mTouchDelegate = delegate; 9728 } 9729 9730 /** 9731 * Gets the TouchDelegate for this View. 9732 */ 9733 public TouchDelegate getTouchDelegate() { 9734 return mTouchDelegate; 9735 } 9736 9737 /** 9738 * Request unbuffered dispatch of the given stream of MotionEvents to this View. 9739 * 9740 * Until this View receives a corresponding {@link MotionEvent#ACTION_UP}, ask that the input 9741 * system not batch {@link MotionEvent}s but instead deliver them as soon as they're 9742 * available. This method should only be called for touch events. 9743 * 9744 * <p class="note">This api is not intended for most applications. Buffered dispatch 9745 * provides many of benefits, and just requesting unbuffered dispatch on most MotionEvent 9746 * streams will not improve your input latency. Side effects include: increased latency, 9747 * jittery scrolls and inability to take advantage of system resampling. Talk to your input 9748 * professional to see if {@link #requestUnbufferedDispatch(MotionEvent)} is right for 9749 * you.</p> 9750 */ 9751 public final void requestUnbufferedDispatch(MotionEvent event) { 9752 final int action = event.getAction(); 9753 if (mAttachInfo == null 9754 || action != MotionEvent.ACTION_DOWN && action != MotionEvent.ACTION_MOVE 9755 || !event.isTouchEvent()) { 9756 return; 9757 } 9758 mAttachInfo.mUnbufferedDispatchRequested = true; 9759 } 9760 9761 /** 9762 * Set flags controlling behavior of this view. 9763 * 9764 * @param flags Constant indicating the value which should be set 9765 * @param mask Constant indicating the bit range that should be changed 9766 */ 9767 void setFlags(int flags, int mask) { 9768 final boolean accessibilityEnabled = 9769 AccessibilityManager.getInstance(mContext).isEnabled(); 9770 final boolean oldIncludeForAccessibility = accessibilityEnabled && includeForAccessibility(); 9771 9772 int old = mViewFlags; 9773 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 9774 9775 int changed = mViewFlags ^ old; 9776 if (changed == 0) { 9777 return; 9778 } 9779 int privateFlags = mPrivateFlags; 9780 9781 /* Check if the FOCUSABLE bit has changed */ 9782 if (((changed & FOCUSABLE_MASK) != 0) && 9783 ((privateFlags & PFLAG_HAS_BOUNDS) !=0)) { 9784 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 9785 && ((privateFlags & PFLAG_FOCUSED) != 0)) { 9786 /* Give up focus if we are no longer focusable */ 9787 clearFocus(); 9788 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 9789 && ((privateFlags & PFLAG_FOCUSED) == 0)) { 9790 /* 9791 * Tell the view system that we are now available to take focus 9792 * if no one else already has it. 9793 */ 9794 if (mParent != null) mParent.focusableViewAvailable(this); 9795 } 9796 } 9797 9798 final int newVisibility = flags & VISIBILITY_MASK; 9799 if (newVisibility == VISIBLE) { 9800 if ((changed & VISIBILITY_MASK) != 0) { 9801 /* 9802 * If this view is becoming visible, invalidate it in case it changed while 9803 * it was not visible. Marking it drawn ensures that the invalidation will 9804 * go through. 9805 */ 9806 mPrivateFlags |= PFLAG_DRAWN; 9807 invalidate(true); 9808 9809 needGlobalAttributesUpdate(true); 9810 9811 // a view becoming visible is worth notifying the parent 9812 // about in case nothing has focus. even if this specific view 9813 // isn't focusable, it may contain something that is, so let 9814 // the root view try to give this focus if nothing else does. 9815 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 9816 mParent.focusableViewAvailable(this); 9817 } 9818 } 9819 } 9820 9821 /* Check if the GONE bit has changed */ 9822 if ((changed & GONE) != 0) { 9823 needGlobalAttributesUpdate(false); 9824 requestLayout(); 9825 9826 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 9827 if (hasFocus()) clearFocus(); 9828 clearAccessibilityFocus(); 9829 destroyDrawingCache(); 9830 if (mParent instanceof View) { 9831 // GONE views noop invalidation, so invalidate the parent 9832 ((View) mParent).invalidate(true); 9833 } 9834 // Mark the view drawn to ensure that it gets invalidated properly the next 9835 // time it is visible and gets invalidated 9836 mPrivateFlags |= PFLAG_DRAWN; 9837 } 9838 if (mAttachInfo != null) { 9839 mAttachInfo.mViewVisibilityChanged = true; 9840 } 9841 } 9842 9843 /* Check if the VISIBLE bit has changed */ 9844 if ((changed & INVISIBLE) != 0) { 9845 needGlobalAttributesUpdate(false); 9846 /* 9847 * If this view is becoming invisible, set the DRAWN flag so that 9848 * the next invalidate() will not be skipped. 9849 */ 9850 mPrivateFlags |= PFLAG_DRAWN; 9851 9852 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE)) { 9853 // root view becoming invisible shouldn't clear focus and accessibility focus 9854 if (getRootView() != this) { 9855 if (hasFocus()) clearFocus(); 9856 clearAccessibilityFocus(); 9857 } 9858 } 9859 if (mAttachInfo != null) { 9860 mAttachInfo.mViewVisibilityChanged = true; 9861 } 9862 } 9863 9864 if ((changed & VISIBILITY_MASK) != 0) { 9865 // If the view is invisible, cleanup its display list to free up resources 9866 if (newVisibility != VISIBLE && mAttachInfo != null) { 9867 cleanupDraw(); 9868 } 9869 9870 if (mParent instanceof ViewGroup) { 9871 ((ViewGroup) mParent).onChildVisibilityChanged(this, 9872 (changed & VISIBILITY_MASK), newVisibility); 9873 ((View) mParent).invalidate(true); 9874 } else if (mParent != null) { 9875 mParent.invalidateChild(this, null); 9876 } 9877 dispatchVisibilityChanged(this, newVisibility); 9878 9879 notifySubtreeAccessibilityStateChangedIfNeeded(); 9880 } 9881 9882 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 9883 destroyDrawingCache(); 9884 } 9885 9886 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 9887 destroyDrawingCache(); 9888 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9889 invalidateParentCaches(); 9890 } 9891 9892 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 9893 destroyDrawingCache(); 9894 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9895 } 9896 9897 if ((changed & DRAW_MASK) != 0) { 9898 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 9899 if (mBackground != null) { 9900 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9901 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 9902 } else { 9903 mPrivateFlags |= PFLAG_SKIP_DRAW; 9904 } 9905 } else { 9906 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9907 } 9908 requestLayout(); 9909 invalidate(true); 9910 } 9911 9912 if ((changed & KEEP_SCREEN_ON) != 0) { 9913 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 9914 mParent.recomputeViewAttributes(this); 9915 } 9916 } 9917 9918 if (accessibilityEnabled) { 9919 if ((changed & FOCUSABLE_MASK) != 0 || (changed & VISIBILITY_MASK) != 0 9920 || (changed & CLICKABLE) != 0 || (changed & LONG_CLICKABLE) != 0) { 9921 if (oldIncludeForAccessibility != includeForAccessibility()) { 9922 notifySubtreeAccessibilityStateChangedIfNeeded(); 9923 } else { 9924 notifyViewAccessibilityStateChangedIfNeeded( 9925 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9926 } 9927 } else if ((changed & ENABLED_MASK) != 0) { 9928 notifyViewAccessibilityStateChangedIfNeeded( 9929 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9930 } 9931 } 9932 } 9933 9934 /** 9935 * Change the view's z order in the tree, so it's on top of other sibling 9936 * views. This ordering change may affect layout, if the parent container 9937 * uses an order-dependent layout scheme (e.g., LinearLayout). Prior 9938 * to {@link android.os.Build.VERSION_CODES#KITKAT} this 9939 * method should be followed by calls to {@link #requestLayout()} and 9940 * {@link View#invalidate()} on the view's parent to force the parent to redraw 9941 * with the new child ordering. 9942 * 9943 * @see ViewGroup#bringChildToFront(View) 9944 */ 9945 public void bringToFront() { 9946 if (mParent != null) { 9947 mParent.bringChildToFront(this); 9948 } 9949 } 9950 9951 /** 9952 * This is called in response to an internal scroll in this view (i.e., the 9953 * view scrolled its own contents). This is typically as a result of 9954 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 9955 * called. 9956 * 9957 * @param l Current horizontal scroll origin. 9958 * @param t Current vertical scroll origin. 9959 * @param oldl Previous horizontal scroll origin. 9960 * @param oldt Previous vertical scroll origin. 9961 */ 9962 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 9963 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 9964 postSendViewScrolledAccessibilityEventCallback(); 9965 } 9966 9967 mBackgroundSizeChanged = true; 9968 9969 final AttachInfo ai = mAttachInfo; 9970 if (ai != null) { 9971 ai.mViewScrollChanged = true; 9972 } 9973 9974 if (mListenerInfo != null && mListenerInfo.mOnScrollChangeListener != null) { 9975 mListenerInfo.mOnScrollChangeListener.onScrollChange(this, l, t, oldl, oldt); 9976 } 9977 } 9978 9979 /** 9980 * Interface definition for a callback to be invoked when the scroll 9981 * position of a view changes. 9982 * 9983 * @hide Only used internally. 9984 */ 9985 public interface OnScrollChangeListener { 9986 /** 9987 * Called when the scroll position of a view changes. 9988 * 9989 * @param v The view whose scroll position has changed. 9990 * @param scrollX Current horizontal scroll origin. 9991 * @param scrollY Current vertical scroll origin. 9992 * @param oldScrollX Previous horizontal scroll origin. 9993 * @param oldScrollY Previous vertical scroll origin. 9994 */ 9995 void onScrollChange(View v, int scrollX, int scrollY, int oldScrollX, int oldScrollY); 9996 } 9997 9998 /** 9999 * Interface definition for a callback to be invoked when the layout bounds of a view 10000 * changes due to layout processing. 10001 */ 10002 public interface OnLayoutChangeListener { 10003 /** 10004 * Called when the layout bounds of a view changes due to layout processing. 10005 * 10006 * @param v The view whose bounds have changed. 10007 * @param left The new value of the view's left property. 10008 * @param top The new value of the view's top property. 10009 * @param right The new value of the view's right property. 10010 * @param bottom The new value of the view's bottom property. 10011 * @param oldLeft The previous value of the view's left property. 10012 * @param oldTop The previous value of the view's top property. 10013 * @param oldRight The previous value of the view's right property. 10014 * @param oldBottom The previous value of the view's bottom property. 10015 */ 10016 void onLayoutChange(View v, int left, int top, int right, int bottom, 10017 int oldLeft, int oldTop, int oldRight, int oldBottom); 10018 } 10019 10020 /** 10021 * This is called during layout when the size of this view has changed. If 10022 * you were just added to the view hierarchy, you're called with the old 10023 * values of 0. 10024 * 10025 * @param w Current width of this view. 10026 * @param h Current height of this view. 10027 * @param oldw Old width of this view. 10028 * @param oldh Old height of this view. 10029 */ 10030 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 10031 } 10032 10033 /** 10034 * Called by draw to draw the child views. This may be overridden 10035 * by derived classes to gain control just before its children are drawn 10036 * (but after its own view has been drawn). 10037 * @param canvas the canvas on which to draw the view 10038 */ 10039 protected void dispatchDraw(Canvas canvas) { 10040 10041 } 10042 10043 /** 10044 * Gets the parent of this view. Note that the parent is a 10045 * ViewParent and not necessarily a View. 10046 * 10047 * @return Parent of this view. 10048 */ 10049 public final ViewParent getParent() { 10050 return mParent; 10051 } 10052 10053 /** 10054 * Set the horizontal scrolled position of your view. This will cause a call to 10055 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10056 * invalidated. 10057 * @param value the x position to scroll to 10058 */ 10059 public void setScrollX(int value) { 10060 scrollTo(value, mScrollY); 10061 } 10062 10063 /** 10064 * Set the vertical scrolled position of your view. This will cause a call to 10065 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10066 * invalidated. 10067 * @param value the y position to scroll to 10068 */ 10069 public void setScrollY(int value) { 10070 scrollTo(mScrollX, value); 10071 } 10072 10073 /** 10074 * Return the scrolled left position of this view. This is the left edge of 10075 * the displayed part of your view. You do not need to draw any pixels 10076 * farther left, since those are outside of the frame of your view on 10077 * screen. 10078 * 10079 * @return The left edge of the displayed part of your view, in pixels. 10080 */ 10081 public final int getScrollX() { 10082 return mScrollX; 10083 } 10084 10085 /** 10086 * Return the scrolled top position of this view. This is the top edge of 10087 * the displayed part of your view. You do not need to draw any pixels above 10088 * it, since those are outside of the frame of your view on screen. 10089 * 10090 * @return The top edge of the displayed part of your view, in pixels. 10091 */ 10092 public final int getScrollY() { 10093 return mScrollY; 10094 } 10095 10096 /** 10097 * Return the width of the your view. 10098 * 10099 * @return The width of your view, in pixels. 10100 */ 10101 @ViewDebug.ExportedProperty(category = "layout") 10102 public final int getWidth() { 10103 return mRight - mLeft; 10104 } 10105 10106 /** 10107 * Return the height of your view. 10108 * 10109 * @return The height of your view, in pixels. 10110 */ 10111 @ViewDebug.ExportedProperty(category = "layout") 10112 public final int getHeight() { 10113 return mBottom - mTop; 10114 } 10115 10116 /** 10117 * Return the visible drawing bounds of your view. Fills in the output 10118 * rectangle with the values from getScrollX(), getScrollY(), 10119 * getWidth(), and getHeight(). These bounds do not account for any 10120 * transformation properties currently set on the view, such as 10121 * {@link #setScaleX(float)} or {@link #setRotation(float)}. 10122 * 10123 * @param outRect The (scrolled) drawing bounds of the view. 10124 */ 10125 public void getDrawingRect(Rect outRect) { 10126 outRect.left = mScrollX; 10127 outRect.top = mScrollY; 10128 outRect.right = mScrollX + (mRight - mLeft); 10129 outRect.bottom = mScrollY + (mBottom - mTop); 10130 } 10131 10132 /** 10133 * Like {@link #getMeasuredWidthAndState()}, but only returns the 10134 * raw width component (that is the result is masked by 10135 * {@link #MEASURED_SIZE_MASK}). 10136 * 10137 * @return The raw measured width of this view. 10138 */ 10139 public final int getMeasuredWidth() { 10140 return mMeasuredWidth & MEASURED_SIZE_MASK; 10141 } 10142 10143 /** 10144 * Return the full width measurement information for this view as computed 10145 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10146 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10147 * This should be used during measurement and layout calculations only. Use 10148 * {@link #getWidth()} to see how wide a view is after layout. 10149 * 10150 * @return The measured width of this view as a bit mask. 10151 */ 10152 public final int getMeasuredWidthAndState() { 10153 return mMeasuredWidth; 10154 } 10155 10156 /** 10157 * Like {@link #getMeasuredHeightAndState()}, but only returns the 10158 * raw width component (that is the result is masked by 10159 * {@link #MEASURED_SIZE_MASK}). 10160 * 10161 * @return The raw measured height of this view. 10162 */ 10163 public final int getMeasuredHeight() { 10164 return mMeasuredHeight & MEASURED_SIZE_MASK; 10165 } 10166 10167 /** 10168 * Return the full height measurement information for this view as computed 10169 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10170 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10171 * This should be used during measurement and layout calculations only. Use 10172 * {@link #getHeight()} to see how wide a view is after layout. 10173 * 10174 * @return The measured width of this view as a bit mask. 10175 */ 10176 public final int getMeasuredHeightAndState() { 10177 return mMeasuredHeight; 10178 } 10179 10180 /** 10181 * Return only the state bits of {@link #getMeasuredWidthAndState()} 10182 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 10183 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 10184 * and the height component is at the shifted bits 10185 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 10186 */ 10187 public final int getMeasuredState() { 10188 return (mMeasuredWidth&MEASURED_STATE_MASK) 10189 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 10190 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 10191 } 10192 10193 /** 10194 * The transform matrix of this view, which is calculated based on the current 10195 * rotation, scale, and pivot properties. 10196 * 10197 * @see #getRotation() 10198 * @see #getScaleX() 10199 * @see #getScaleY() 10200 * @see #getPivotX() 10201 * @see #getPivotY() 10202 * @return The current transform matrix for the view 10203 */ 10204 public Matrix getMatrix() { 10205 ensureTransformationInfo(); 10206 final Matrix matrix = mTransformationInfo.mMatrix; 10207 mRenderNode.getMatrix(matrix); 10208 return matrix; 10209 } 10210 10211 /** 10212 * Returns true if the transform matrix is the identity matrix. 10213 * Recomputes the matrix if necessary. 10214 * 10215 * @return True if the transform matrix is the identity matrix, false otherwise. 10216 */ 10217 final boolean hasIdentityMatrix() { 10218 return mRenderNode.hasIdentityMatrix(); 10219 } 10220 10221 void ensureTransformationInfo() { 10222 if (mTransformationInfo == null) { 10223 mTransformationInfo = new TransformationInfo(); 10224 } 10225 } 10226 10227 /** 10228 * Utility method to retrieve the inverse of the current mMatrix property. 10229 * We cache the matrix to avoid recalculating it when transform properties 10230 * have not changed. 10231 * 10232 * @return The inverse of the current matrix of this view. 10233 * @hide 10234 */ 10235 public final Matrix getInverseMatrix() { 10236 ensureTransformationInfo(); 10237 if (mTransformationInfo.mInverseMatrix == null) { 10238 mTransformationInfo.mInverseMatrix = new Matrix(); 10239 } 10240 final Matrix matrix = mTransformationInfo.mInverseMatrix; 10241 mRenderNode.getInverseMatrix(matrix); 10242 return matrix; 10243 } 10244 10245 /** 10246 * Gets the distance along the Z axis from the camera to this view. 10247 * 10248 * @see #setCameraDistance(float) 10249 * 10250 * @return The distance along the Z axis. 10251 */ 10252 public float getCameraDistance() { 10253 final float dpi = mResources.getDisplayMetrics().densityDpi; 10254 return -(mRenderNode.getCameraDistance() * dpi); 10255 } 10256 10257 /** 10258 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 10259 * views are drawn) from the camera to this view. The camera's distance 10260 * affects 3D transformations, for instance rotations around the X and Y 10261 * axis. If the rotationX or rotationY properties are changed and this view is 10262 * large (more than half the size of the screen), it is recommended to always 10263 * use a camera distance that's greater than the height (X axis rotation) or 10264 * the width (Y axis rotation) of this view.</p> 10265 * 10266 * <p>The distance of the camera from the view plane can have an affect on the 10267 * perspective distortion of the view when it is rotated around the x or y axis. 10268 * For example, a large distance will result in a large viewing angle, and there 10269 * will not be much perspective distortion of the view as it rotates. A short 10270 * distance may cause much more perspective distortion upon rotation, and can 10271 * also result in some drawing artifacts if the rotated view ends up partially 10272 * behind the camera (which is why the recommendation is to use a distance at 10273 * least as far as the size of the view, if the view is to be rotated.)</p> 10274 * 10275 * <p>The distance is expressed in "depth pixels." The default distance depends 10276 * on the screen density. For instance, on a medium density display, the 10277 * default distance is 1280. On a high density display, the default distance 10278 * is 1920.</p> 10279 * 10280 * <p>If you want to specify a distance that leads to visually consistent 10281 * results across various densities, use the following formula:</p> 10282 * <pre> 10283 * float scale = context.getResources().getDisplayMetrics().density; 10284 * view.setCameraDistance(distance * scale); 10285 * </pre> 10286 * 10287 * <p>The density scale factor of a high density display is 1.5, 10288 * and 1920 = 1280 * 1.5.</p> 10289 * 10290 * @param distance The distance in "depth pixels", if negative the opposite 10291 * value is used 10292 * 10293 * @see #setRotationX(float) 10294 * @see #setRotationY(float) 10295 */ 10296 public void setCameraDistance(float distance) { 10297 final float dpi = mResources.getDisplayMetrics().densityDpi; 10298 10299 invalidateViewProperty(true, false); 10300 mRenderNode.setCameraDistance(-Math.abs(distance) / dpi); 10301 invalidateViewProperty(false, false); 10302 10303 invalidateParentIfNeededAndWasQuickRejected(); 10304 } 10305 10306 /** 10307 * The degrees that the view is rotated around the pivot point. 10308 * 10309 * @see #setRotation(float) 10310 * @see #getPivotX() 10311 * @see #getPivotY() 10312 * 10313 * @return The degrees of rotation. 10314 */ 10315 @ViewDebug.ExportedProperty(category = "drawing") 10316 public float getRotation() { 10317 return mRenderNode.getRotation(); 10318 } 10319 10320 /** 10321 * Sets the degrees that the view is rotated around the pivot point. Increasing values 10322 * result in clockwise rotation. 10323 * 10324 * @param rotation The degrees of rotation. 10325 * 10326 * @see #getRotation() 10327 * @see #getPivotX() 10328 * @see #getPivotY() 10329 * @see #setRotationX(float) 10330 * @see #setRotationY(float) 10331 * 10332 * @attr ref android.R.styleable#View_rotation 10333 */ 10334 public void setRotation(float rotation) { 10335 if (rotation != getRotation()) { 10336 // Double-invalidation is necessary to capture view's old and new areas 10337 invalidateViewProperty(true, false); 10338 mRenderNode.setRotation(rotation); 10339 invalidateViewProperty(false, true); 10340 10341 invalidateParentIfNeededAndWasQuickRejected(); 10342 notifySubtreeAccessibilityStateChangedIfNeeded(); 10343 } 10344 } 10345 10346 /** 10347 * The degrees that the view is rotated around the vertical axis through the pivot point. 10348 * 10349 * @see #getPivotX() 10350 * @see #getPivotY() 10351 * @see #setRotationY(float) 10352 * 10353 * @return The degrees of Y rotation. 10354 */ 10355 @ViewDebug.ExportedProperty(category = "drawing") 10356 public float getRotationY() { 10357 return mRenderNode.getRotationY(); 10358 } 10359 10360 /** 10361 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 10362 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 10363 * down the y axis. 10364 * 10365 * When rotating large views, it is recommended to adjust the camera distance 10366 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10367 * 10368 * @param rotationY The degrees of Y rotation. 10369 * 10370 * @see #getRotationY() 10371 * @see #getPivotX() 10372 * @see #getPivotY() 10373 * @see #setRotation(float) 10374 * @see #setRotationX(float) 10375 * @see #setCameraDistance(float) 10376 * 10377 * @attr ref android.R.styleable#View_rotationY 10378 */ 10379 public void setRotationY(float rotationY) { 10380 if (rotationY != getRotationY()) { 10381 invalidateViewProperty(true, false); 10382 mRenderNode.setRotationY(rotationY); 10383 invalidateViewProperty(false, true); 10384 10385 invalidateParentIfNeededAndWasQuickRejected(); 10386 notifySubtreeAccessibilityStateChangedIfNeeded(); 10387 } 10388 } 10389 10390 /** 10391 * The degrees that the view is rotated around the horizontal axis through the pivot point. 10392 * 10393 * @see #getPivotX() 10394 * @see #getPivotY() 10395 * @see #setRotationX(float) 10396 * 10397 * @return The degrees of X rotation. 10398 */ 10399 @ViewDebug.ExportedProperty(category = "drawing") 10400 public float getRotationX() { 10401 return mRenderNode.getRotationX(); 10402 } 10403 10404 /** 10405 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 10406 * Increasing values result in clockwise rotation from the viewpoint of looking down the 10407 * x axis. 10408 * 10409 * When rotating large views, it is recommended to adjust the camera distance 10410 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10411 * 10412 * @param rotationX The degrees of X rotation. 10413 * 10414 * @see #getRotationX() 10415 * @see #getPivotX() 10416 * @see #getPivotY() 10417 * @see #setRotation(float) 10418 * @see #setRotationY(float) 10419 * @see #setCameraDistance(float) 10420 * 10421 * @attr ref android.R.styleable#View_rotationX 10422 */ 10423 public void setRotationX(float rotationX) { 10424 if (rotationX != getRotationX()) { 10425 invalidateViewProperty(true, false); 10426 mRenderNode.setRotationX(rotationX); 10427 invalidateViewProperty(false, true); 10428 10429 invalidateParentIfNeededAndWasQuickRejected(); 10430 notifySubtreeAccessibilityStateChangedIfNeeded(); 10431 } 10432 } 10433 10434 /** 10435 * The amount that the view is scaled in x around the pivot point, as a proportion of 10436 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 10437 * 10438 * <p>By default, this is 1.0f. 10439 * 10440 * @see #getPivotX() 10441 * @see #getPivotY() 10442 * @return The scaling factor. 10443 */ 10444 @ViewDebug.ExportedProperty(category = "drawing") 10445 public float getScaleX() { 10446 return mRenderNode.getScaleX(); 10447 } 10448 10449 /** 10450 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 10451 * the view's unscaled width. A value of 1 means that no scaling is applied. 10452 * 10453 * @param scaleX The scaling factor. 10454 * @see #getPivotX() 10455 * @see #getPivotY() 10456 * 10457 * @attr ref android.R.styleable#View_scaleX 10458 */ 10459 public void setScaleX(float scaleX) { 10460 if (scaleX != getScaleX()) { 10461 invalidateViewProperty(true, false); 10462 mRenderNode.setScaleX(scaleX); 10463 invalidateViewProperty(false, true); 10464 10465 invalidateParentIfNeededAndWasQuickRejected(); 10466 notifySubtreeAccessibilityStateChangedIfNeeded(); 10467 } 10468 } 10469 10470 /** 10471 * The amount that the view is scaled in y around the pivot point, as a proportion of 10472 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 10473 * 10474 * <p>By default, this is 1.0f. 10475 * 10476 * @see #getPivotX() 10477 * @see #getPivotY() 10478 * @return The scaling factor. 10479 */ 10480 @ViewDebug.ExportedProperty(category = "drawing") 10481 public float getScaleY() { 10482 return mRenderNode.getScaleY(); 10483 } 10484 10485 /** 10486 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 10487 * the view's unscaled width. A value of 1 means that no scaling is applied. 10488 * 10489 * @param scaleY The scaling factor. 10490 * @see #getPivotX() 10491 * @see #getPivotY() 10492 * 10493 * @attr ref android.R.styleable#View_scaleY 10494 */ 10495 public void setScaleY(float scaleY) { 10496 if (scaleY != getScaleY()) { 10497 invalidateViewProperty(true, false); 10498 mRenderNode.setScaleY(scaleY); 10499 invalidateViewProperty(false, true); 10500 10501 invalidateParentIfNeededAndWasQuickRejected(); 10502 notifySubtreeAccessibilityStateChangedIfNeeded(); 10503 } 10504 } 10505 10506 /** 10507 * The x location of the point around which the view is {@link #setRotation(float) rotated} 10508 * and {@link #setScaleX(float) scaled}. 10509 * 10510 * @see #getRotation() 10511 * @see #getScaleX() 10512 * @see #getScaleY() 10513 * @see #getPivotY() 10514 * @return The x location of the pivot point. 10515 * 10516 * @attr ref android.R.styleable#View_transformPivotX 10517 */ 10518 @ViewDebug.ExportedProperty(category = "drawing") 10519 public float getPivotX() { 10520 return mRenderNode.getPivotX(); 10521 } 10522 10523 /** 10524 * Sets the x location of the point around which the view is 10525 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 10526 * By default, the pivot point is centered on the object. 10527 * Setting this property disables this behavior and causes the view to use only the 10528 * explicitly set pivotX and pivotY values. 10529 * 10530 * @param pivotX The x location of the pivot point. 10531 * @see #getRotation() 10532 * @see #getScaleX() 10533 * @see #getScaleY() 10534 * @see #getPivotY() 10535 * 10536 * @attr ref android.R.styleable#View_transformPivotX 10537 */ 10538 public void setPivotX(float pivotX) { 10539 if (!mRenderNode.isPivotExplicitlySet() || pivotX != getPivotX()) { 10540 invalidateViewProperty(true, false); 10541 mRenderNode.setPivotX(pivotX); 10542 invalidateViewProperty(false, true); 10543 10544 invalidateParentIfNeededAndWasQuickRejected(); 10545 } 10546 } 10547 10548 /** 10549 * The y location of the point around which the view is {@link #setRotation(float) rotated} 10550 * and {@link #setScaleY(float) scaled}. 10551 * 10552 * @see #getRotation() 10553 * @see #getScaleX() 10554 * @see #getScaleY() 10555 * @see #getPivotY() 10556 * @return The y location of the pivot point. 10557 * 10558 * @attr ref android.R.styleable#View_transformPivotY 10559 */ 10560 @ViewDebug.ExportedProperty(category = "drawing") 10561 public float getPivotY() { 10562 return mRenderNode.getPivotY(); 10563 } 10564 10565 /** 10566 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 10567 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 10568 * Setting this property disables this behavior and causes the view to use only the 10569 * explicitly set pivotX and pivotY values. 10570 * 10571 * @param pivotY The y location of the pivot point. 10572 * @see #getRotation() 10573 * @see #getScaleX() 10574 * @see #getScaleY() 10575 * @see #getPivotY() 10576 * 10577 * @attr ref android.R.styleable#View_transformPivotY 10578 */ 10579 public void setPivotY(float pivotY) { 10580 if (!mRenderNode.isPivotExplicitlySet() || pivotY != getPivotY()) { 10581 invalidateViewProperty(true, false); 10582 mRenderNode.setPivotY(pivotY); 10583 invalidateViewProperty(false, true); 10584 10585 invalidateParentIfNeededAndWasQuickRejected(); 10586 } 10587 } 10588 10589 /** 10590 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 10591 * completely transparent and 1 means the view is completely opaque. 10592 * 10593 * <p>By default this is 1.0f. 10594 * @return The opacity of the view. 10595 */ 10596 @ViewDebug.ExportedProperty(category = "drawing") 10597 public float getAlpha() { 10598 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 10599 } 10600 10601 /** 10602 * Returns whether this View has content which overlaps. 10603 * 10604 * <p>This function, intended to be overridden by specific View types, is an optimization when 10605 * alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to 10606 * an offscreen buffer and then composited into place, which can be expensive. If the view has 10607 * no overlapping rendering, the view can draw each primitive with the appropriate alpha value 10608 * directly. An example of overlapping rendering is a TextView with a background image, such as 10609 * a Button. An example of non-overlapping rendering is a TextView with no background, or an 10610 * ImageView with only the foreground image. The default implementation returns true; subclasses 10611 * should override if they have cases which can be optimized.</p> 10612 * 10613 * <p>The current implementation of the saveLayer and saveLayerAlpha methods in {@link Canvas} 10614 * necessitates that a View return true if it uses the methods internally without passing the 10615 * {@link Canvas#CLIP_TO_LAYER_SAVE_FLAG}.</p> 10616 * 10617 * @return true if the content in this view might overlap, false otherwise. 10618 */ 10619 @ViewDebug.ExportedProperty(category = "drawing") 10620 public boolean hasOverlappingRendering() { 10621 return true; 10622 } 10623 10624 /** 10625 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 10626 * completely transparent and 1 means the view is completely opaque.</p> 10627 * 10628 * <p> Note that setting alpha to a translucent value (0 < alpha < 1) can have significant 10629 * performance implications, especially for large views. It is best to use the alpha property 10630 * sparingly and transiently, as in the case of fading animations.</p> 10631 * 10632 * <p>For a view with a frequently changing alpha, such as during a fading animation, it is 10633 * strongly recommended for performance reasons to either override 10634 * {@link #hasOverlappingRendering()} to return false if appropriate, or setting a 10635 * {@link #setLayerType(int, android.graphics.Paint) layer type} on the view.</p> 10636 * 10637 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 10638 * responsible for applying the opacity itself.</p> 10639 * 10640 * <p>Note that if the view is backed by a 10641 * {@link #setLayerType(int, android.graphics.Paint) layer} and is associated with a 10642 * {@link #setLayerPaint(android.graphics.Paint) layer paint}, setting an alpha value less than 10643 * 1.0 will supercede the alpha of the layer paint.</p> 10644 * 10645 * @param alpha The opacity of the view. 10646 * 10647 * @see #hasOverlappingRendering() 10648 * @see #setLayerType(int, android.graphics.Paint) 10649 * 10650 * @attr ref android.R.styleable#View_alpha 10651 */ 10652 public void setAlpha(float alpha) { 10653 ensureTransformationInfo(); 10654 if (mTransformationInfo.mAlpha != alpha) { 10655 mTransformationInfo.mAlpha = alpha; 10656 if (onSetAlpha((int) (alpha * 255))) { 10657 mPrivateFlags |= PFLAG_ALPHA_SET; 10658 // subclass is handling alpha - don't optimize rendering cache invalidation 10659 invalidateParentCaches(); 10660 invalidate(true); 10661 } else { 10662 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10663 invalidateViewProperty(true, false); 10664 mRenderNode.setAlpha(getFinalAlpha()); 10665 notifyViewAccessibilityStateChangedIfNeeded( 10666 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 10667 } 10668 } 10669 } 10670 10671 /** 10672 * Faster version of setAlpha() which performs the same steps except there are 10673 * no calls to invalidate(). The caller of this function should perform proper invalidation 10674 * on the parent and this object. The return value indicates whether the subclass handles 10675 * alpha (the return value for onSetAlpha()). 10676 * 10677 * @param alpha The new value for the alpha property 10678 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 10679 * the new value for the alpha property is different from the old value 10680 */ 10681 boolean setAlphaNoInvalidation(float alpha) { 10682 ensureTransformationInfo(); 10683 if (mTransformationInfo.mAlpha != alpha) { 10684 mTransformationInfo.mAlpha = alpha; 10685 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 10686 if (subclassHandlesAlpha) { 10687 mPrivateFlags |= PFLAG_ALPHA_SET; 10688 return true; 10689 } else { 10690 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10691 mRenderNode.setAlpha(getFinalAlpha()); 10692 } 10693 } 10694 return false; 10695 } 10696 10697 /** 10698 * This property is hidden and intended only for use by the Fade transition, which 10699 * animates it to produce a visual translucency that does not side-effect (or get 10700 * affected by) the real alpha property. This value is composited with the other 10701 * alpha value (and the AlphaAnimation value, when that is present) to produce 10702 * a final visual translucency result, which is what is passed into the DisplayList. 10703 * 10704 * @hide 10705 */ 10706 public void setTransitionAlpha(float alpha) { 10707 ensureTransformationInfo(); 10708 if (mTransformationInfo.mTransitionAlpha != alpha) { 10709 mTransformationInfo.mTransitionAlpha = alpha; 10710 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10711 invalidateViewProperty(true, false); 10712 mRenderNode.setAlpha(getFinalAlpha()); 10713 } 10714 } 10715 10716 /** 10717 * Calculates the visual alpha of this view, which is a combination of the actual 10718 * alpha value and the transitionAlpha value (if set). 10719 */ 10720 private float getFinalAlpha() { 10721 if (mTransformationInfo != null) { 10722 return mTransformationInfo.mAlpha * mTransformationInfo.mTransitionAlpha; 10723 } 10724 return 1; 10725 } 10726 10727 /** 10728 * This property is hidden and intended only for use by the Fade transition, which 10729 * animates it to produce a visual translucency that does not side-effect (or get 10730 * affected by) the real alpha property. This value is composited with the other 10731 * alpha value (and the AlphaAnimation value, when that is present) to produce 10732 * a final visual translucency result, which is what is passed into the DisplayList. 10733 * 10734 * @hide 10735 */ 10736 @ViewDebug.ExportedProperty(category = "drawing") 10737 public float getTransitionAlpha() { 10738 return mTransformationInfo != null ? mTransformationInfo.mTransitionAlpha : 1; 10739 } 10740 10741 /** 10742 * Top position of this view relative to its parent. 10743 * 10744 * @return The top of this view, in pixels. 10745 */ 10746 @ViewDebug.CapturedViewProperty 10747 public final int getTop() { 10748 return mTop; 10749 } 10750 10751 /** 10752 * Sets the top position of this view relative to its parent. This method is meant to be called 10753 * by the layout system and should not generally be called otherwise, because the property 10754 * may be changed at any time by the layout. 10755 * 10756 * @param top The top of this view, in pixels. 10757 */ 10758 public final void setTop(int top) { 10759 if (top != mTop) { 10760 final boolean matrixIsIdentity = hasIdentityMatrix(); 10761 if (matrixIsIdentity) { 10762 if (mAttachInfo != null) { 10763 int minTop; 10764 int yLoc; 10765 if (top < mTop) { 10766 minTop = top; 10767 yLoc = top - mTop; 10768 } else { 10769 minTop = mTop; 10770 yLoc = 0; 10771 } 10772 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 10773 } 10774 } else { 10775 // Double-invalidation is necessary to capture view's old and new areas 10776 invalidate(true); 10777 } 10778 10779 int width = mRight - mLeft; 10780 int oldHeight = mBottom - mTop; 10781 10782 mTop = top; 10783 mRenderNode.setTop(mTop); 10784 10785 sizeChange(width, mBottom - mTop, width, oldHeight); 10786 10787 if (!matrixIsIdentity) { 10788 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10789 invalidate(true); 10790 } 10791 mBackgroundSizeChanged = true; 10792 invalidateParentIfNeeded(); 10793 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10794 // View was rejected last time it was drawn by its parent; this may have changed 10795 invalidateParentIfNeeded(); 10796 } 10797 } 10798 } 10799 10800 /** 10801 * Bottom position of this view relative to its parent. 10802 * 10803 * @return The bottom of this view, in pixels. 10804 */ 10805 @ViewDebug.CapturedViewProperty 10806 public final int getBottom() { 10807 return mBottom; 10808 } 10809 10810 /** 10811 * True if this view has changed since the last time being drawn. 10812 * 10813 * @return The dirty state of this view. 10814 */ 10815 public boolean isDirty() { 10816 return (mPrivateFlags & PFLAG_DIRTY_MASK) != 0; 10817 } 10818 10819 /** 10820 * Sets the bottom position of this view relative to its parent. This method is meant to be 10821 * called by the layout system and should not generally be called otherwise, because the 10822 * property may be changed at any time by the layout. 10823 * 10824 * @param bottom The bottom of this view, in pixels. 10825 */ 10826 public final void setBottom(int bottom) { 10827 if (bottom != mBottom) { 10828 final boolean matrixIsIdentity = hasIdentityMatrix(); 10829 if (matrixIsIdentity) { 10830 if (mAttachInfo != null) { 10831 int maxBottom; 10832 if (bottom < mBottom) { 10833 maxBottom = mBottom; 10834 } else { 10835 maxBottom = bottom; 10836 } 10837 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 10838 } 10839 } else { 10840 // Double-invalidation is necessary to capture view's old and new areas 10841 invalidate(true); 10842 } 10843 10844 int width = mRight - mLeft; 10845 int oldHeight = mBottom - mTop; 10846 10847 mBottom = bottom; 10848 mRenderNode.setBottom(mBottom); 10849 10850 sizeChange(width, mBottom - mTop, width, oldHeight); 10851 10852 if (!matrixIsIdentity) { 10853 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10854 invalidate(true); 10855 } 10856 mBackgroundSizeChanged = true; 10857 invalidateParentIfNeeded(); 10858 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10859 // View was rejected last time it was drawn by its parent; this may have changed 10860 invalidateParentIfNeeded(); 10861 } 10862 } 10863 } 10864 10865 /** 10866 * Left position of this view relative to its parent. 10867 * 10868 * @return The left edge of this view, in pixels. 10869 */ 10870 @ViewDebug.CapturedViewProperty 10871 public final int getLeft() { 10872 return mLeft; 10873 } 10874 10875 /** 10876 * Sets the left position of this view relative to its parent. This method is meant to be called 10877 * by the layout system and should not generally be called otherwise, because the property 10878 * may be changed at any time by the layout. 10879 * 10880 * @param left The left of this view, in pixels. 10881 */ 10882 public final void setLeft(int left) { 10883 if (left != mLeft) { 10884 final boolean matrixIsIdentity = hasIdentityMatrix(); 10885 if (matrixIsIdentity) { 10886 if (mAttachInfo != null) { 10887 int minLeft; 10888 int xLoc; 10889 if (left < mLeft) { 10890 minLeft = left; 10891 xLoc = left - mLeft; 10892 } else { 10893 minLeft = mLeft; 10894 xLoc = 0; 10895 } 10896 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 10897 } 10898 } else { 10899 // Double-invalidation is necessary to capture view's old and new areas 10900 invalidate(true); 10901 } 10902 10903 int oldWidth = mRight - mLeft; 10904 int height = mBottom - mTop; 10905 10906 mLeft = left; 10907 mRenderNode.setLeft(left); 10908 10909 sizeChange(mRight - mLeft, height, oldWidth, height); 10910 10911 if (!matrixIsIdentity) { 10912 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10913 invalidate(true); 10914 } 10915 mBackgroundSizeChanged = true; 10916 invalidateParentIfNeeded(); 10917 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10918 // View was rejected last time it was drawn by its parent; this may have changed 10919 invalidateParentIfNeeded(); 10920 } 10921 } 10922 } 10923 10924 /** 10925 * Right position of this view relative to its parent. 10926 * 10927 * @return The right edge of this view, in pixels. 10928 */ 10929 @ViewDebug.CapturedViewProperty 10930 public final int getRight() { 10931 return mRight; 10932 } 10933 10934 /** 10935 * Sets the right position of this view relative to its parent. This method is meant to be called 10936 * by the layout system and should not generally be called otherwise, because the property 10937 * may be changed at any time by the layout. 10938 * 10939 * @param right The right of this view, in pixels. 10940 */ 10941 public final void setRight(int right) { 10942 if (right != mRight) { 10943 final boolean matrixIsIdentity = hasIdentityMatrix(); 10944 if (matrixIsIdentity) { 10945 if (mAttachInfo != null) { 10946 int maxRight; 10947 if (right < mRight) { 10948 maxRight = mRight; 10949 } else { 10950 maxRight = right; 10951 } 10952 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 10953 } 10954 } else { 10955 // Double-invalidation is necessary to capture view's old and new areas 10956 invalidate(true); 10957 } 10958 10959 int oldWidth = mRight - mLeft; 10960 int height = mBottom - mTop; 10961 10962 mRight = right; 10963 mRenderNode.setRight(mRight); 10964 10965 sizeChange(mRight - mLeft, height, oldWidth, height); 10966 10967 if (!matrixIsIdentity) { 10968 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10969 invalidate(true); 10970 } 10971 mBackgroundSizeChanged = true; 10972 invalidateParentIfNeeded(); 10973 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10974 // View was rejected last time it was drawn by its parent; this may have changed 10975 invalidateParentIfNeeded(); 10976 } 10977 } 10978 } 10979 10980 /** 10981 * The visual x position of this view, in pixels. This is equivalent to the 10982 * {@link #setTranslationX(float) translationX} property plus the current 10983 * {@link #getLeft() left} property. 10984 * 10985 * @return The visual x position of this view, in pixels. 10986 */ 10987 @ViewDebug.ExportedProperty(category = "drawing") 10988 public float getX() { 10989 return mLeft + getTranslationX(); 10990 } 10991 10992 /** 10993 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 10994 * {@link #setTranslationX(float) translationX} property to be the difference between 10995 * the x value passed in and the current {@link #getLeft() left} property. 10996 * 10997 * @param x The visual x position of this view, in pixels. 10998 */ 10999 public void setX(float x) { 11000 setTranslationX(x - mLeft); 11001 } 11002 11003 /** 11004 * The visual y position of this view, in pixels. This is equivalent to the 11005 * {@link #setTranslationY(float) translationY} property plus the current 11006 * {@link #getTop() top} property. 11007 * 11008 * @return The visual y position of this view, in pixels. 11009 */ 11010 @ViewDebug.ExportedProperty(category = "drawing") 11011 public float getY() { 11012 return mTop + getTranslationY(); 11013 } 11014 11015 /** 11016 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 11017 * {@link #setTranslationY(float) translationY} property to be the difference between 11018 * the y value passed in and the current {@link #getTop() top} property. 11019 * 11020 * @param y The visual y position of this view, in pixels. 11021 */ 11022 public void setY(float y) { 11023 setTranslationY(y - mTop); 11024 } 11025 11026 /** 11027 * The visual z position of this view, in pixels. This is equivalent to the 11028 * {@link #setTranslationZ(float) translationZ} property plus the current 11029 * {@link #getElevation() elevation} property. 11030 * 11031 * @return The visual z position of this view, in pixels. 11032 */ 11033 @ViewDebug.ExportedProperty(category = "drawing") 11034 public float getZ() { 11035 return getElevation() + getTranslationZ(); 11036 } 11037 11038 /** 11039 * Sets the visual z position of this view, in pixels. This is equivalent to setting the 11040 * {@link #setTranslationZ(float) translationZ} property to be the difference between 11041 * the x value passed in and the current {@link #getElevation() elevation} property. 11042 * 11043 * @param z The visual z position of this view, in pixels. 11044 */ 11045 public void setZ(float z) { 11046 setTranslationZ(z - getElevation()); 11047 } 11048 11049 /** 11050 * The base elevation of this view relative to its parent, in pixels. 11051 * 11052 * @return The base depth position of the view, in pixels. 11053 */ 11054 @ViewDebug.ExportedProperty(category = "drawing") 11055 public float getElevation() { 11056 return mRenderNode.getElevation(); 11057 } 11058 11059 /** 11060 * Sets the base elevation of this view, in pixels. 11061 * 11062 * @attr ref android.R.styleable#View_elevation 11063 */ 11064 public void setElevation(float elevation) { 11065 if (elevation != getElevation()) { 11066 invalidateViewProperty(true, false); 11067 mRenderNode.setElevation(elevation); 11068 invalidateViewProperty(false, true); 11069 11070 invalidateParentIfNeededAndWasQuickRejected(); 11071 } 11072 } 11073 11074 /** 11075 * The horizontal location of this view relative to its {@link #getLeft() left} position. 11076 * This position is post-layout, in addition to wherever the object's 11077 * layout placed it. 11078 * 11079 * @return The horizontal position of this view relative to its left position, in pixels. 11080 */ 11081 @ViewDebug.ExportedProperty(category = "drawing") 11082 public float getTranslationX() { 11083 return mRenderNode.getTranslationX(); 11084 } 11085 11086 /** 11087 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 11088 * This effectively positions the object post-layout, in addition to wherever the object's 11089 * layout placed it. 11090 * 11091 * @param translationX The horizontal position of this view relative to its left position, 11092 * in pixels. 11093 * 11094 * @attr ref android.R.styleable#View_translationX 11095 */ 11096 public void setTranslationX(float translationX) { 11097 if (translationX != getTranslationX()) { 11098 invalidateViewProperty(true, false); 11099 mRenderNode.setTranslationX(translationX); 11100 invalidateViewProperty(false, true); 11101 11102 invalidateParentIfNeededAndWasQuickRejected(); 11103 notifySubtreeAccessibilityStateChangedIfNeeded(); 11104 } 11105 } 11106 11107 /** 11108 * The vertical location of this view relative to its {@link #getTop() top} position. 11109 * This position is post-layout, in addition to wherever the object's 11110 * layout placed it. 11111 * 11112 * @return The vertical position of this view relative to its top position, 11113 * in pixels. 11114 */ 11115 @ViewDebug.ExportedProperty(category = "drawing") 11116 public float getTranslationY() { 11117 return mRenderNode.getTranslationY(); 11118 } 11119 11120 /** 11121 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 11122 * This effectively positions the object post-layout, in addition to wherever the object's 11123 * layout placed it. 11124 * 11125 * @param translationY The vertical position of this view relative to its top position, 11126 * in pixels. 11127 * 11128 * @attr ref android.R.styleable#View_translationY 11129 */ 11130 public void setTranslationY(float translationY) { 11131 if (translationY != getTranslationY()) { 11132 invalidateViewProperty(true, false); 11133 mRenderNode.setTranslationY(translationY); 11134 invalidateViewProperty(false, true); 11135 11136 invalidateParentIfNeededAndWasQuickRejected(); 11137 } 11138 } 11139 11140 /** 11141 * The depth location of this view relative to its {@link #getElevation() elevation}. 11142 * 11143 * @return The depth of this view relative to its elevation. 11144 */ 11145 @ViewDebug.ExportedProperty(category = "drawing") 11146 public float getTranslationZ() { 11147 return mRenderNode.getTranslationZ(); 11148 } 11149 11150 /** 11151 * Sets the depth location of this view relative to its {@link #getElevation() elevation}. 11152 * 11153 * @attr ref android.R.styleable#View_translationZ 11154 */ 11155 public void setTranslationZ(float translationZ) { 11156 if (translationZ != getTranslationZ()) { 11157 invalidateViewProperty(true, false); 11158 mRenderNode.setTranslationZ(translationZ); 11159 invalidateViewProperty(false, true); 11160 11161 invalidateParentIfNeededAndWasQuickRejected(); 11162 } 11163 } 11164 11165 /** @hide */ 11166 public void setAnimationMatrix(Matrix matrix) { 11167 invalidateViewProperty(true, false); 11168 mRenderNode.setAnimationMatrix(matrix); 11169 invalidateViewProperty(false, true); 11170 11171 invalidateParentIfNeededAndWasQuickRejected(); 11172 } 11173 11174 /** 11175 * Returns the current StateListAnimator if exists. 11176 * 11177 * @return StateListAnimator or null if it does not exists 11178 * @see #setStateListAnimator(android.animation.StateListAnimator) 11179 */ 11180 public StateListAnimator getStateListAnimator() { 11181 return mStateListAnimator; 11182 } 11183 11184 /** 11185 * Attaches the provided StateListAnimator to this View. 11186 * <p> 11187 * Any previously attached StateListAnimator will be detached. 11188 * 11189 * @param stateListAnimator The StateListAnimator to update the view 11190 * @see {@link android.animation.StateListAnimator} 11191 */ 11192 public void setStateListAnimator(StateListAnimator stateListAnimator) { 11193 if (mStateListAnimator == stateListAnimator) { 11194 return; 11195 } 11196 if (mStateListAnimator != null) { 11197 mStateListAnimator.setTarget(null); 11198 } 11199 mStateListAnimator = stateListAnimator; 11200 if (stateListAnimator != null) { 11201 stateListAnimator.setTarget(this); 11202 if (isAttachedToWindow()) { 11203 stateListAnimator.setState(getDrawableState()); 11204 } 11205 } 11206 } 11207 11208 /** 11209 * Returns whether the Outline should be used to clip the contents of the View. 11210 * <p> 11211 * Note that this flag will only be respected if the View's Outline returns true from 11212 * {@link Outline#canClip()}. 11213 * 11214 * @see #setOutlineProvider(ViewOutlineProvider) 11215 * @see #setClipToOutline(boolean) 11216 */ 11217 public final boolean getClipToOutline() { 11218 return mRenderNode.getClipToOutline(); 11219 } 11220 11221 /** 11222 * Sets whether the View's Outline should be used to clip the contents of the View. 11223 * <p> 11224 * Only a single non-rectangular clip can be applied on a View at any time. 11225 * Circular clips from a {@link ViewAnimationUtils#createCircularReveal(View, int, int, float, float) 11226 * circular reveal} animation take priority over Outline clipping, and 11227 * child Outline clipping takes priority over Outline clipping done by a 11228 * parent. 11229 * <p> 11230 * Note that this flag will only be respected if the View's Outline returns true from 11231 * {@link Outline#canClip()}. 11232 * 11233 * @see #setOutlineProvider(ViewOutlineProvider) 11234 * @see #getClipToOutline() 11235 */ 11236 public void setClipToOutline(boolean clipToOutline) { 11237 damageInParent(); 11238 if (getClipToOutline() != clipToOutline) { 11239 mRenderNode.setClipToOutline(clipToOutline); 11240 } 11241 } 11242 11243 // correspond to the enum values of View_outlineProvider 11244 private static final int PROVIDER_BACKGROUND = 0; 11245 private static final int PROVIDER_NONE = 1; 11246 private static final int PROVIDER_BOUNDS = 2; 11247 private static final int PROVIDER_PADDED_BOUNDS = 3; 11248 private void setOutlineProviderFromAttribute(int providerInt) { 11249 switch (providerInt) { 11250 case PROVIDER_BACKGROUND: 11251 setOutlineProvider(ViewOutlineProvider.BACKGROUND); 11252 break; 11253 case PROVIDER_NONE: 11254 setOutlineProvider(null); 11255 break; 11256 case PROVIDER_BOUNDS: 11257 setOutlineProvider(ViewOutlineProvider.BOUNDS); 11258 break; 11259 case PROVIDER_PADDED_BOUNDS: 11260 setOutlineProvider(ViewOutlineProvider.PADDED_BOUNDS); 11261 break; 11262 } 11263 } 11264 11265 /** 11266 * Sets the {@link ViewOutlineProvider} of the view, which generates the Outline that defines 11267 * the shape of the shadow it casts, and enables outline clipping. 11268 * <p> 11269 * The default ViewOutlineProvider, {@link ViewOutlineProvider#BACKGROUND}, queries the Outline 11270 * from the View's background drawable, via {@link Drawable#getOutline(Outline)}. Changing the 11271 * outline provider with this method allows this behavior to be overridden. 11272 * <p> 11273 * If the ViewOutlineProvider is null, if querying it for an outline returns false, 11274 * or if the produced Outline is {@link Outline#isEmpty()}, shadows will not be cast. 11275 * <p> 11276 * Only outlines that return true from {@link Outline#canClip()} may be used for clipping. 11277 * 11278 * @see #setClipToOutline(boolean) 11279 * @see #getClipToOutline() 11280 * @see #getOutlineProvider() 11281 */ 11282 public void setOutlineProvider(ViewOutlineProvider provider) { 11283 mOutlineProvider = provider; 11284 invalidateOutline(); 11285 } 11286 11287 /** 11288 * Returns the current {@link ViewOutlineProvider} of the view, which generates the Outline 11289 * that defines the shape of the shadow it casts, and enables outline clipping. 11290 * 11291 * @see #setOutlineProvider(ViewOutlineProvider) 11292 */ 11293 public ViewOutlineProvider getOutlineProvider() { 11294 return mOutlineProvider; 11295 } 11296 11297 /** 11298 * Called to rebuild this View's Outline from its {@link ViewOutlineProvider outline provider} 11299 * 11300 * @see #setOutlineProvider(ViewOutlineProvider) 11301 */ 11302 public void invalidateOutline() { 11303 rebuildOutline(); 11304 11305 notifySubtreeAccessibilityStateChangedIfNeeded(); 11306 invalidateViewProperty(false, false); 11307 } 11308 11309 /** 11310 * Internal version of {@link #invalidateOutline()} which invalidates the 11311 * outline without invalidating the view itself. This is intended to be called from 11312 * within methods in the View class itself which are the result of the view being 11313 * invalidated already. For example, when we are drawing the background of a View, 11314 * we invalidate the outline in case it changed in the meantime, but we do not 11315 * need to invalidate the view because we're already drawing the background as part 11316 * of drawing the view in response to an earlier invalidation of the view. 11317 */ 11318 private void rebuildOutline() { 11319 // Unattached views ignore this signal, and outline is recomputed in onAttachedToWindow() 11320 if (mAttachInfo == null) return; 11321 11322 if (mOutlineProvider == null) { 11323 // no provider, remove outline 11324 mRenderNode.setOutline(null); 11325 } else { 11326 final Outline outline = mAttachInfo.mTmpOutline; 11327 outline.setEmpty(); 11328 outline.setAlpha(1.0f); 11329 11330 mOutlineProvider.getOutline(this, outline); 11331 mRenderNode.setOutline(outline); 11332 } 11333 } 11334 11335 /** 11336 * HierarchyViewer only 11337 * 11338 * @hide 11339 */ 11340 @ViewDebug.ExportedProperty(category = "drawing") 11341 public boolean hasShadow() { 11342 return mRenderNode.hasShadow(); 11343 } 11344 11345 11346 /** @hide */ 11347 public void setRevealClip(boolean shouldClip, float x, float y, float radius) { 11348 mRenderNode.setRevealClip(shouldClip, x, y, radius); 11349 invalidateViewProperty(false, false); 11350 } 11351 11352 /** 11353 * Hit rectangle in parent's coordinates 11354 * 11355 * @param outRect The hit rectangle of the view. 11356 */ 11357 public void getHitRect(Rect outRect) { 11358 if (hasIdentityMatrix() || mAttachInfo == null) { 11359 outRect.set(mLeft, mTop, mRight, mBottom); 11360 } else { 11361 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 11362 tmpRect.set(0, 0, getWidth(), getHeight()); 11363 getMatrix().mapRect(tmpRect); // TODO: mRenderNode.mapRect(tmpRect) 11364 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 11365 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 11366 } 11367 } 11368 11369 /** 11370 * Determines whether the given point, in local coordinates is inside the view. 11371 */ 11372 /*package*/ final boolean pointInView(float localX, float localY) { 11373 return localX >= 0 && localX < (mRight - mLeft) 11374 && localY >= 0 && localY < (mBottom - mTop); 11375 } 11376 11377 /** 11378 * Utility method to determine whether the given point, in local coordinates, 11379 * is inside the view, where the area of the view is expanded by the slop factor. 11380 * This method is called while processing touch-move events to determine if the event 11381 * is still within the view. 11382 * 11383 * @hide 11384 */ 11385 public boolean pointInView(float localX, float localY, float slop) { 11386 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 11387 localY < ((mBottom - mTop) + slop); 11388 } 11389 11390 /** 11391 * When a view has focus and the user navigates away from it, the next view is searched for 11392 * starting from the rectangle filled in by this method. 11393 * 11394 * By default, the rectangle is the {@link #getDrawingRect(android.graphics.Rect)}) 11395 * of the view. However, if your view maintains some idea of internal selection, 11396 * such as a cursor, or a selected row or column, you should override this method and 11397 * fill in a more specific rectangle. 11398 * 11399 * @param r The rectangle to fill in, in this view's coordinates. 11400 */ 11401 public void getFocusedRect(Rect r) { 11402 getDrawingRect(r); 11403 } 11404 11405 /** 11406 * If some part of this view is not clipped by any of its parents, then 11407 * return that area in r in global (root) coordinates. To convert r to local 11408 * coordinates (without taking possible View rotations into account), offset 11409 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 11410 * If the view is completely clipped or translated out, return false. 11411 * 11412 * @param r If true is returned, r holds the global coordinates of the 11413 * visible portion of this view. 11414 * @param globalOffset If true is returned, globalOffset holds the dx,dy 11415 * between this view and its root. globalOffet may be null. 11416 * @return true if r is non-empty (i.e. part of the view is visible at the 11417 * root level. 11418 */ 11419 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 11420 int width = mRight - mLeft; 11421 int height = mBottom - mTop; 11422 if (width > 0 && height > 0) { 11423 r.set(0, 0, width, height); 11424 if (globalOffset != null) { 11425 globalOffset.set(-mScrollX, -mScrollY); 11426 } 11427 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 11428 } 11429 return false; 11430 } 11431 11432 public final boolean getGlobalVisibleRect(Rect r) { 11433 return getGlobalVisibleRect(r, null); 11434 } 11435 11436 public final boolean getLocalVisibleRect(Rect r) { 11437 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point(); 11438 if (getGlobalVisibleRect(r, offset)) { 11439 r.offset(-offset.x, -offset.y); // make r local 11440 return true; 11441 } 11442 return false; 11443 } 11444 11445 /** 11446 * Offset this view's vertical location by the specified number of pixels. 11447 * 11448 * @param offset the number of pixels to offset the view by 11449 */ 11450 public void offsetTopAndBottom(int offset) { 11451 if (offset != 0) { 11452 final boolean matrixIsIdentity = hasIdentityMatrix(); 11453 if (matrixIsIdentity) { 11454 if (isHardwareAccelerated()) { 11455 invalidateViewProperty(false, false); 11456 } else { 11457 final ViewParent p = mParent; 11458 if (p != null && mAttachInfo != null) { 11459 final Rect r = mAttachInfo.mTmpInvalRect; 11460 int minTop; 11461 int maxBottom; 11462 int yLoc; 11463 if (offset < 0) { 11464 minTop = mTop + offset; 11465 maxBottom = mBottom; 11466 yLoc = offset; 11467 } else { 11468 minTop = mTop; 11469 maxBottom = mBottom + offset; 11470 yLoc = 0; 11471 } 11472 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 11473 p.invalidateChild(this, r); 11474 } 11475 } 11476 } else { 11477 invalidateViewProperty(false, false); 11478 } 11479 11480 mTop += offset; 11481 mBottom += offset; 11482 mRenderNode.offsetTopAndBottom(offset); 11483 if (isHardwareAccelerated()) { 11484 invalidateViewProperty(false, false); 11485 } else { 11486 if (!matrixIsIdentity) { 11487 invalidateViewProperty(false, true); 11488 } 11489 invalidateParentIfNeeded(); 11490 } 11491 notifySubtreeAccessibilityStateChangedIfNeeded(); 11492 } 11493 } 11494 11495 /** 11496 * Offset this view's horizontal location by the specified amount of pixels. 11497 * 11498 * @param offset the number of pixels to offset the view by 11499 */ 11500 public void offsetLeftAndRight(int offset) { 11501 if (offset != 0) { 11502 final boolean matrixIsIdentity = hasIdentityMatrix(); 11503 if (matrixIsIdentity) { 11504 if (isHardwareAccelerated()) { 11505 invalidateViewProperty(false, false); 11506 } else { 11507 final ViewParent p = mParent; 11508 if (p != null && mAttachInfo != null) { 11509 final Rect r = mAttachInfo.mTmpInvalRect; 11510 int minLeft; 11511 int maxRight; 11512 if (offset < 0) { 11513 minLeft = mLeft + offset; 11514 maxRight = mRight; 11515 } else { 11516 minLeft = mLeft; 11517 maxRight = mRight + offset; 11518 } 11519 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 11520 p.invalidateChild(this, r); 11521 } 11522 } 11523 } else { 11524 invalidateViewProperty(false, false); 11525 } 11526 11527 mLeft += offset; 11528 mRight += offset; 11529 mRenderNode.offsetLeftAndRight(offset); 11530 if (isHardwareAccelerated()) { 11531 invalidateViewProperty(false, false); 11532 } else { 11533 if (!matrixIsIdentity) { 11534 invalidateViewProperty(false, true); 11535 } 11536 invalidateParentIfNeeded(); 11537 } 11538 notifySubtreeAccessibilityStateChangedIfNeeded(); 11539 } 11540 } 11541 11542 /** 11543 * Get the LayoutParams associated with this view. All views should have 11544 * layout parameters. These supply parameters to the <i>parent</i> of this 11545 * view specifying how it should be arranged. There are many subclasses of 11546 * ViewGroup.LayoutParams, and these correspond to the different subclasses 11547 * of ViewGroup that are responsible for arranging their children. 11548 * 11549 * This method may return null if this View is not attached to a parent 11550 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 11551 * was not invoked successfully. When a View is attached to a parent 11552 * ViewGroup, this method must not return null. 11553 * 11554 * @return The LayoutParams associated with this view, or null if no 11555 * parameters have been set yet 11556 */ 11557 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 11558 public ViewGroup.LayoutParams getLayoutParams() { 11559 return mLayoutParams; 11560 } 11561 11562 /** 11563 * Set the layout parameters associated with this view. These supply 11564 * parameters to the <i>parent</i> of this view specifying how it should be 11565 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 11566 * correspond to the different subclasses of ViewGroup that are responsible 11567 * for arranging their children. 11568 * 11569 * @param params The layout parameters for this view, cannot be null 11570 */ 11571 public void setLayoutParams(ViewGroup.LayoutParams params) { 11572 if (params == null) { 11573 throw new NullPointerException("Layout parameters cannot be null"); 11574 } 11575 mLayoutParams = params; 11576 resolveLayoutParams(); 11577 if (mParent instanceof ViewGroup) { 11578 ((ViewGroup) mParent).onSetLayoutParams(this, params); 11579 } 11580 requestLayout(); 11581 } 11582 11583 /** 11584 * Resolve the layout parameters depending on the resolved layout direction 11585 * 11586 * @hide 11587 */ 11588 public void resolveLayoutParams() { 11589 if (mLayoutParams != null) { 11590 mLayoutParams.resolveLayoutDirection(getLayoutDirection()); 11591 } 11592 } 11593 11594 /** 11595 * Set the scrolled position of your view. This will cause a call to 11596 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11597 * invalidated. 11598 * @param x the x position to scroll to 11599 * @param y the y position to scroll to 11600 */ 11601 public void scrollTo(int x, int y) { 11602 if (mScrollX != x || mScrollY != y) { 11603 int oldX = mScrollX; 11604 int oldY = mScrollY; 11605 mScrollX = x; 11606 mScrollY = y; 11607 invalidateParentCaches(); 11608 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 11609 if (!awakenScrollBars()) { 11610 postInvalidateOnAnimation(); 11611 } 11612 } 11613 } 11614 11615 /** 11616 * Move the scrolled position of your view. This will cause a call to 11617 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11618 * invalidated. 11619 * @param x the amount of pixels to scroll by horizontally 11620 * @param y the amount of pixels to scroll by vertically 11621 */ 11622 public void scrollBy(int x, int y) { 11623 scrollTo(mScrollX + x, mScrollY + y); 11624 } 11625 11626 /** 11627 * <p>Trigger the scrollbars to draw. When invoked this method starts an 11628 * animation to fade the scrollbars out after a default delay. If a subclass 11629 * provides animated scrolling, the start delay should equal the duration 11630 * of the scrolling animation.</p> 11631 * 11632 * <p>The animation starts only if at least one of the scrollbars is 11633 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 11634 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11635 * this method returns true, and false otherwise. If the animation is 11636 * started, this method calls {@link #invalidate()}; in that case the 11637 * caller should not call {@link #invalidate()}.</p> 11638 * 11639 * <p>This method should be invoked every time a subclass directly updates 11640 * the scroll parameters.</p> 11641 * 11642 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 11643 * and {@link #scrollTo(int, int)}.</p> 11644 * 11645 * @return true if the animation is played, false otherwise 11646 * 11647 * @see #awakenScrollBars(int) 11648 * @see #scrollBy(int, int) 11649 * @see #scrollTo(int, int) 11650 * @see #isHorizontalScrollBarEnabled() 11651 * @see #isVerticalScrollBarEnabled() 11652 * @see #setHorizontalScrollBarEnabled(boolean) 11653 * @see #setVerticalScrollBarEnabled(boolean) 11654 */ 11655 protected boolean awakenScrollBars() { 11656 return mScrollCache != null && 11657 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 11658 } 11659 11660 /** 11661 * Trigger the scrollbars to draw. 11662 * This method differs from awakenScrollBars() only in its default duration. 11663 * initialAwakenScrollBars() will show the scroll bars for longer than 11664 * usual to give the user more of a chance to notice them. 11665 * 11666 * @return true if the animation is played, false otherwise. 11667 */ 11668 private boolean initialAwakenScrollBars() { 11669 return mScrollCache != null && 11670 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 11671 } 11672 11673 /** 11674 * <p> 11675 * Trigger the scrollbars to draw. When invoked this method starts an 11676 * animation to fade the scrollbars out after a fixed delay. If a subclass 11677 * provides animated scrolling, the start delay should equal the duration of 11678 * the scrolling animation. 11679 * </p> 11680 * 11681 * <p> 11682 * The animation starts only if at least one of the scrollbars is enabled, 11683 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11684 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11685 * this method returns true, and false otherwise. If the animation is 11686 * started, this method calls {@link #invalidate()}; in that case the caller 11687 * should not call {@link #invalidate()}. 11688 * </p> 11689 * 11690 * <p> 11691 * This method should be invoked everytime a subclass directly updates the 11692 * scroll parameters. 11693 * </p> 11694 * 11695 * @param startDelay the delay, in milliseconds, after which the animation 11696 * should start; when the delay is 0, the animation starts 11697 * immediately 11698 * @return true if the animation is played, false otherwise 11699 * 11700 * @see #scrollBy(int, int) 11701 * @see #scrollTo(int, int) 11702 * @see #isHorizontalScrollBarEnabled() 11703 * @see #isVerticalScrollBarEnabled() 11704 * @see #setHorizontalScrollBarEnabled(boolean) 11705 * @see #setVerticalScrollBarEnabled(boolean) 11706 */ 11707 protected boolean awakenScrollBars(int startDelay) { 11708 return awakenScrollBars(startDelay, true); 11709 } 11710 11711 /** 11712 * <p> 11713 * Trigger the scrollbars to draw. When invoked this method starts an 11714 * animation to fade the scrollbars out after a fixed delay. If a subclass 11715 * provides animated scrolling, the start delay should equal the duration of 11716 * the scrolling animation. 11717 * </p> 11718 * 11719 * <p> 11720 * The animation starts only if at least one of the scrollbars is enabled, 11721 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11722 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11723 * this method returns true, and false otherwise. If the animation is 11724 * started, this method calls {@link #invalidate()} if the invalidate parameter 11725 * is set to true; in that case the caller 11726 * should not call {@link #invalidate()}. 11727 * </p> 11728 * 11729 * <p> 11730 * This method should be invoked everytime a subclass directly updates the 11731 * scroll parameters. 11732 * </p> 11733 * 11734 * @param startDelay the delay, in milliseconds, after which the animation 11735 * should start; when the delay is 0, the animation starts 11736 * immediately 11737 * 11738 * @param invalidate Wheter this method should call invalidate 11739 * 11740 * @return true if the animation is played, false otherwise 11741 * 11742 * @see #scrollBy(int, int) 11743 * @see #scrollTo(int, int) 11744 * @see #isHorizontalScrollBarEnabled() 11745 * @see #isVerticalScrollBarEnabled() 11746 * @see #setHorizontalScrollBarEnabled(boolean) 11747 * @see #setVerticalScrollBarEnabled(boolean) 11748 */ 11749 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 11750 final ScrollabilityCache scrollCache = mScrollCache; 11751 11752 if (scrollCache == null || !scrollCache.fadeScrollBars) { 11753 return false; 11754 } 11755 11756 if (scrollCache.scrollBar == null) { 11757 scrollCache.scrollBar = new ScrollBarDrawable(); 11758 } 11759 11760 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 11761 11762 if (invalidate) { 11763 // Invalidate to show the scrollbars 11764 postInvalidateOnAnimation(); 11765 } 11766 11767 if (scrollCache.state == ScrollabilityCache.OFF) { 11768 // FIXME: this is copied from WindowManagerService. 11769 // We should get this value from the system when it 11770 // is possible to do so. 11771 final int KEY_REPEAT_FIRST_DELAY = 750; 11772 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 11773 } 11774 11775 // Tell mScrollCache when we should start fading. This may 11776 // extend the fade start time if one was already scheduled 11777 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 11778 scrollCache.fadeStartTime = fadeStartTime; 11779 scrollCache.state = ScrollabilityCache.ON; 11780 11781 // Schedule our fader to run, unscheduling any old ones first 11782 if (mAttachInfo != null) { 11783 mAttachInfo.mHandler.removeCallbacks(scrollCache); 11784 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 11785 } 11786 11787 return true; 11788 } 11789 11790 return false; 11791 } 11792 11793 /** 11794 * Do not invalidate views which are not visible and which are not running an animation. They 11795 * will not get drawn and they should not set dirty flags as if they will be drawn 11796 */ 11797 private boolean skipInvalidate() { 11798 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 11799 (!(mParent instanceof ViewGroup) || 11800 !((ViewGroup) mParent).isViewTransitioning(this)); 11801 } 11802 11803 /** 11804 * Mark the area defined by dirty as needing to be drawn. If the view is 11805 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11806 * point in the future. 11807 * <p> 11808 * This must be called from a UI thread. To call from a non-UI thread, call 11809 * {@link #postInvalidate()}. 11810 * <p> 11811 * <b>WARNING:</b> In API 19 and below, this method may be destructive to 11812 * {@code dirty}. 11813 * 11814 * @param dirty the rectangle representing the bounds of the dirty region 11815 */ 11816 public void invalidate(Rect dirty) { 11817 final int scrollX = mScrollX; 11818 final int scrollY = mScrollY; 11819 invalidateInternal(dirty.left - scrollX, dirty.top - scrollY, 11820 dirty.right - scrollX, dirty.bottom - scrollY, true, false); 11821 } 11822 11823 /** 11824 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. The 11825 * coordinates of the dirty rect are relative to the view. If the view is 11826 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11827 * point in the future. 11828 * <p> 11829 * This must be called from a UI thread. To call from a non-UI thread, call 11830 * {@link #postInvalidate()}. 11831 * 11832 * @param l the left position of the dirty region 11833 * @param t the top position of the dirty region 11834 * @param r the right position of the dirty region 11835 * @param b the bottom position of the dirty region 11836 */ 11837 public void invalidate(int l, int t, int r, int b) { 11838 final int scrollX = mScrollX; 11839 final int scrollY = mScrollY; 11840 invalidateInternal(l - scrollX, t - scrollY, r - scrollX, b - scrollY, true, false); 11841 } 11842 11843 /** 11844 * Invalidate the whole view. If the view is visible, 11845 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 11846 * the future. 11847 * <p> 11848 * This must be called from a UI thread. To call from a non-UI thread, call 11849 * {@link #postInvalidate()}. 11850 */ 11851 public void invalidate() { 11852 invalidate(true); 11853 } 11854 11855 /** 11856 * This is where the invalidate() work actually happens. A full invalidate() 11857 * causes the drawing cache to be invalidated, but this function can be 11858 * called with invalidateCache set to false to skip that invalidation step 11859 * for cases that do not need it (for example, a component that remains at 11860 * the same dimensions with the same content). 11861 * 11862 * @param invalidateCache Whether the drawing cache for this view should be 11863 * invalidated as well. This is usually true for a full 11864 * invalidate, but may be set to false if the View's contents or 11865 * dimensions have not changed. 11866 */ 11867 void invalidate(boolean invalidateCache) { 11868 invalidateInternal(0, 0, mRight - mLeft, mBottom - mTop, invalidateCache, true); 11869 } 11870 11871 void invalidateInternal(int l, int t, int r, int b, boolean invalidateCache, 11872 boolean fullInvalidate) { 11873 if (mGhostView != null) { 11874 mGhostView.invalidate(true); 11875 return; 11876 } 11877 11878 if (skipInvalidate()) { 11879 return; 11880 } 11881 11882 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) 11883 || (invalidateCache && (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) 11884 || (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED 11885 || (fullInvalidate && isOpaque() != mLastIsOpaque)) { 11886 if (fullInvalidate) { 11887 mLastIsOpaque = isOpaque(); 11888 mPrivateFlags &= ~PFLAG_DRAWN; 11889 } 11890 11891 mPrivateFlags |= PFLAG_DIRTY; 11892 11893 if (invalidateCache) { 11894 mPrivateFlags |= PFLAG_INVALIDATED; 11895 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 11896 } 11897 11898 // Propagate the damage rectangle to the parent view. 11899 final AttachInfo ai = mAttachInfo; 11900 final ViewParent p = mParent; 11901 if (p != null && ai != null && l < r && t < b) { 11902 final Rect damage = ai.mTmpInvalRect; 11903 damage.set(l, t, r, b); 11904 p.invalidateChild(this, damage); 11905 } 11906 11907 // Damage the entire projection receiver, if necessary. 11908 if (mBackground != null && mBackground.isProjected()) { 11909 final View receiver = getProjectionReceiver(); 11910 if (receiver != null) { 11911 receiver.damageInParent(); 11912 } 11913 } 11914 11915 // Damage the entire IsolatedZVolume receiving this view's shadow. 11916 if (isHardwareAccelerated() && getZ() != 0) { 11917 damageShadowReceiver(); 11918 } 11919 } 11920 } 11921 11922 /** 11923 * @return this view's projection receiver, or {@code null} if none exists 11924 */ 11925 private View getProjectionReceiver() { 11926 ViewParent p = getParent(); 11927 while (p != null && p instanceof View) { 11928 final View v = (View) p; 11929 if (v.isProjectionReceiver()) { 11930 return v; 11931 } 11932 p = p.getParent(); 11933 } 11934 11935 return null; 11936 } 11937 11938 /** 11939 * @return whether the view is a projection receiver 11940 */ 11941 private boolean isProjectionReceiver() { 11942 return mBackground != null; 11943 } 11944 11945 /** 11946 * Damage area of the screen that can be covered by this View's shadow. 11947 * 11948 * This method will guarantee that any changes to shadows cast by a View 11949 * are damaged on the screen for future redraw. 11950 */ 11951 private void damageShadowReceiver() { 11952 final AttachInfo ai = mAttachInfo; 11953 if (ai != null) { 11954 ViewParent p = getParent(); 11955 if (p != null && p instanceof ViewGroup) { 11956 final ViewGroup vg = (ViewGroup) p; 11957 vg.damageInParent(); 11958 } 11959 } 11960 } 11961 11962 /** 11963 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to 11964 * set any flags or handle all of the cases handled by the default invalidation methods. 11965 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate 11966 * dirty rect. This method calls into fast invalidation methods in ViewGroup that 11967 * walk up the hierarchy, transforming the dirty rect as necessary. 11968 * 11969 * The method also handles normal invalidation logic if display list properties are not 11970 * being used in this view. The invalidateParent and forceRedraw flags are used by that 11971 * backup approach, to handle these cases used in the various property-setting methods. 11972 * 11973 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties 11974 * are not being used in this view 11975 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display 11976 * list properties are not being used in this view 11977 */ 11978 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) { 11979 if (!isHardwareAccelerated() 11980 || !mRenderNode.isValid() 11981 || (mPrivateFlags & PFLAG_DRAW_ANIMATION) != 0) { 11982 if (invalidateParent) { 11983 invalidateParentCaches(); 11984 } 11985 if (forceRedraw) { 11986 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 11987 } 11988 invalidate(false); 11989 } else { 11990 damageInParent(); 11991 } 11992 if (isHardwareAccelerated() && invalidateParent && getZ() != 0) { 11993 damageShadowReceiver(); 11994 } 11995 } 11996 11997 /** 11998 * Tells the parent view to damage this view's bounds. 11999 * 12000 * @hide 12001 */ 12002 protected void damageInParent() { 12003 final AttachInfo ai = mAttachInfo; 12004 final ViewParent p = mParent; 12005 if (p != null && ai != null) { 12006 final Rect r = ai.mTmpInvalRect; 12007 r.set(0, 0, mRight - mLeft, mBottom - mTop); 12008 if (mParent instanceof ViewGroup) { 12009 ((ViewGroup) mParent).damageChild(this, r); 12010 } else { 12011 mParent.invalidateChild(this, r); 12012 } 12013 } 12014 } 12015 12016 /** 12017 * Utility method to transform a given Rect by the current matrix of this view. 12018 */ 12019 void transformRect(final Rect rect) { 12020 if (!getMatrix().isIdentity()) { 12021 RectF boundingRect = mAttachInfo.mTmpTransformRect; 12022 boundingRect.set(rect); 12023 getMatrix().mapRect(boundingRect); 12024 rect.set((int) Math.floor(boundingRect.left), 12025 (int) Math.floor(boundingRect.top), 12026 (int) Math.ceil(boundingRect.right), 12027 (int) Math.ceil(boundingRect.bottom)); 12028 } 12029 } 12030 12031 /** 12032 * Used to indicate that the parent of this view should clear its caches. This functionality 12033 * is used to force the parent to rebuild its display list (when hardware-accelerated), 12034 * which is necessary when various parent-managed properties of the view change, such as 12035 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 12036 * clears the parent caches and does not causes an invalidate event. 12037 * 12038 * @hide 12039 */ 12040 protected void invalidateParentCaches() { 12041 if (mParent instanceof View) { 12042 ((View) mParent).mPrivateFlags |= PFLAG_INVALIDATED; 12043 } 12044 } 12045 12046 /** 12047 * Used to indicate that the parent of this view should be invalidated. This functionality 12048 * is used to force the parent to rebuild its display list (when hardware-accelerated), 12049 * which is necessary when various parent-managed properties of the view change, such as 12050 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 12051 * an invalidation event to the parent. 12052 * 12053 * @hide 12054 */ 12055 protected void invalidateParentIfNeeded() { 12056 if (isHardwareAccelerated() && mParent instanceof View) { 12057 ((View) mParent).invalidate(true); 12058 } 12059 } 12060 12061 /** 12062 * @hide 12063 */ 12064 protected void invalidateParentIfNeededAndWasQuickRejected() { 12065 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) != 0) { 12066 // View was rejected last time it was drawn by its parent; this may have changed 12067 invalidateParentIfNeeded(); 12068 } 12069 } 12070 12071 /** 12072 * Indicates whether this View is opaque. An opaque View guarantees that it will 12073 * draw all the pixels overlapping its bounds using a fully opaque color. 12074 * 12075 * Subclasses of View should override this method whenever possible to indicate 12076 * whether an instance is opaque. Opaque Views are treated in a special way by 12077 * the View hierarchy, possibly allowing it to perform optimizations during 12078 * invalidate/draw passes. 12079 * 12080 * @return True if this View is guaranteed to be fully opaque, false otherwise. 12081 */ 12082 @ViewDebug.ExportedProperty(category = "drawing") 12083 public boolean isOpaque() { 12084 return (mPrivateFlags & PFLAG_OPAQUE_MASK) == PFLAG_OPAQUE_MASK && 12085 getFinalAlpha() >= 1.0f; 12086 } 12087 12088 /** 12089 * @hide 12090 */ 12091 protected void computeOpaqueFlags() { 12092 // Opaque if: 12093 // - Has a background 12094 // - Background is opaque 12095 // - Doesn't have scrollbars or scrollbars overlay 12096 12097 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) { 12098 mPrivateFlags |= PFLAG_OPAQUE_BACKGROUND; 12099 } else { 12100 mPrivateFlags &= ~PFLAG_OPAQUE_BACKGROUND; 12101 } 12102 12103 final int flags = mViewFlags; 12104 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 12105 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY || 12106 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_OUTSIDE_OVERLAY) { 12107 mPrivateFlags |= PFLAG_OPAQUE_SCROLLBARS; 12108 } else { 12109 mPrivateFlags &= ~PFLAG_OPAQUE_SCROLLBARS; 12110 } 12111 } 12112 12113 /** 12114 * @hide 12115 */ 12116 protected boolean hasOpaqueScrollbars() { 12117 return (mPrivateFlags & PFLAG_OPAQUE_SCROLLBARS) == PFLAG_OPAQUE_SCROLLBARS; 12118 } 12119 12120 /** 12121 * @return A handler associated with the thread running the View. This 12122 * handler can be used to pump events in the UI events queue. 12123 */ 12124 public Handler getHandler() { 12125 final AttachInfo attachInfo = mAttachInfo; 12126 if (attachInfo != null) { 12127 return attachInfo.mHandler; 12128 } 12129 return null; 12130 } 12131 12132 /** 12133 * Gets the view root associated with the View. 12134 * @return The view root, or null if none. 12135 * @hide 12136 */ 12137 public ViewRootImpl getViewRootImpl() { 12138 if (mAttachInfo != null) { 12139 return mAttachInfo.mViewRootImpl; 12140 } 12141 return null; 12142 } 12143 12144 /** 12145 * @hide 12146 */ 12147 public HardwareRenderer getHardwareRenderer() { 12148 return mAttachInfo != null ? mAttachInfo.mHardwareRenderer : null; 12149 } 12150 12151 /** 12152 * <p>Causes the Runnable to be added to the message queue. 12153 * The runnable will be run on the user interface thread.</p> 12154 * 12155 * @param action The Runnable that will be executed. 12156 * 12157 * @return Returns true if the Runnable was successfully placed in to the 12158 * message queue. Returns false on failure, usually because the 12159 * looper processing the message queue is exiting. 12160 * 12161 * @see #postDelayed 12162 * @see #removeCallbacks 12163 */ 12164 public boolean post(Runnable action) { 12165 final AttachInfo attachInfo = mAttachInfo; 12166 if (attachInfo != null) { 12167 return attachInfo.mHandler.post(action); 12168 } 12169 // Assume that post will succeed later 12170 ViewRootImpl.getRunQueue().post(action); 12171 return true; 12172 } 12173 12174 /** 12175 * <p>Causes the Runnable to be added to the message queue, to be run 12176 * after the specified amount of time elapses. 12177 * The runnable will be run on the user interface thread.</p> 12178 * 12179 * @param action The Runnable that will be executed. 12180 * @param delayMillis The delay (in milliseconds) until the Runnable 12181 * will be executed. 12182 * 12183 * @return true if the Runnable was successfully placed in to the 12184 * message queue. Returns false on failure, usually because the 12185 * looper processing the message queue is exiting. Note that a 12186 * result of true does not mean the Runnable will be processed -- 12187 * if the looper is quit before the delivery time of the message 12188 * occurs then the message will be dropped. 12189 * 12190 * @see #post 12191 * @see #removeCallbacks 12192 */ 12193 public boolean postDelayed(Runnable action, long delayMillis) { 12194 final AttachInfo attachInfo = mAttachInfo; 12195 if (attachInfo != null) { 12196 return attachInfo.mHandler.postDelayed(action, delayMillis); 12197 } 12198 // Assume that post will succeed later 12199 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12200 return true; 12201 } 12202 12203 /** 12204 * <p>Causes the Runnable to execute on the next animation time step. 12205 * The runnable will be run on the user interface thread.</p> 12206 * 12207 * @param action The Runnable that will be executed. 12208 * 12209 * @see #postOnAnimationDelayed 12210 * @see #removeCallbacks 12211 */ 12212 public void postOnAnimation(Runnable action) { 12213 final AttachInfo attachInfo = mAttachInfo; 12214 if (attachInfo != null) { 12215 attachInfo.mViewRootImpl.mChoreographer.postCallback( 12216 Choreographer.CALLBACK_ANIMATION, action, null); 12217 } else { 12218 // Assume that post will succeed later 12219 ViewRootImpl.getRunQueue().post(action); 12220 } 12221 } 12222 12223 /** 12224 * <p>Causes the Runnable to execute on the next animation time step, 12225 * after the specified amount of time elapses. 12226 * The runnable will be run on the user interface thread.</p> 12227 * 12228 * @param action The Runnable that will be executed. 12229 * @param delayMillis The delay (in milliseconds) until the Runnable 12230 * will be executed. 12231 * 12232 * @see #postOnAnimation 12233 * @see #removeCallbacks 12234 */ 12235 public void postOnAnimationDelayed(Runnable action, long delayMillis) { 12236 final AttachInfo attachInfo = mAttachInfo; 12237 if (attachInfo != null) { 12238 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 12239 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis); 12240 } else { 12241 // Assume that post will succeed later 12242 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12243 } 12244 } 12245 12246 /** 12247 * <p>Removes the specified Runnable from the message queue.</p> 12248 * 12249 * @param action The Runnable to remove from the message handling queue 12250 * 12251 * @return true if this view could ask the Handler to remove the Runnable, 12252 * false otherwise. When the returned value is true, the Runnable 12253 * may or may not have been actually removed from the message queue 12254 * (for instance, if the Runnable was not in the queue already.) 12255 * 12256 * @see #post 12257 * @see #postDelayed 12258 * @see #postOnAnimation 12259 * @see #postOnAnimationDelayed 12260 */ 12261 public boolean removeCallbacks(Runnable action) { 12262 if (action != null) { 12263 final AttachInfo attachInfo = mAttachInfo; 12264 if (attachInfo != null) { 12265 attachInfo.mHandler.removeCallbacks(action); 12266 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 12267 Choreographer.CALLBACK_ANIMATION, action, null); 12268 } 12269 // Assume that post will succeed later 12270 ViewRootImpl.getRunQueue().removeCallbacks(action); 12271 } 12272 return true; 12273 } 12274 12275 /** 12276 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 12277 * Use this to invalidate the View from a non-UI thread.</p> 12278 * 12279 * <p>This method can be invoked from outside of the UI thread 12280 * only when this View is attached to a window.</p> 12281 * 12282 * @see #invalidate() 12283 * @see #postInvalidateDelayed(long) 12284 */ 12285 public void postInvalidate() { 12286 postInvalidateDelayed(0); 12287 } 12288 12289 /** 12290 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12291 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 12292 * 12293 * <p>This method can be invoked from outside of the UI thread 12294 * only when this View is attached to a window.</p> 12295 * 12296 * @param left The left coordinate of the rectangle to invalidate. 12297 * @param top The top coordinate of the rectangle to invalidate. 12298 * @param right The right coordinate of the rectangle to invalidate. 12299 * @param bottom The bottom coordinate of the rectangle to invalidate. 12300 * 12301 * @see #invalidate(int, int, int, int) 12302 * @see #invalidate(Rect) 12303 * @see #postInvalidateDelayed(long, int, int, int, int) 12304 */ 12305 public void postInvalidate(int left, int top, int right, int bottom) { 12306 postInvalidateDelayed(0, left, top, right, bottom); 12307 } 12308 12309 /** 12310 * <p>Cause an invalidate to happen on a subsequent cycle through the event 12311 * loop. Waits for the specified amount of time.</p> 12312 * 12313 * <p>This method can be invoked from outside of the UI thread 12314 * only when this View is attached to a window.</p> 12315 * 12316 * @param delayMilliseconds the duration in milliseconds to delay the 12317 * invalidation by 12318 * 12319 * @see #invalidate() 12320 * @see #postInvalidate() 12321 */ 12322 public void postInvalidateDelayed(long delayMilliseconds) { 12323 // We try only with the AttachInfo because there's no point in invalidating 12324 // if we are not attached to our window 12325 final AttachInfo attachInfo = mAttachInfo; 12326 if (attachInfo != null) { 12327 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds); 12328 } 12329 } 12330 12331 /** 12332 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12333 * through the event loop. Waits for the specified amount of time.</p> 12334 * 12335 * <p>This method can be invoked from outside of the UI thread 12336 * only when this View is attached to a window.</p> 12337 * 12338 * @param delayMilliseconds the duration in milliseconds to delay the 12339 * invalidation by 12340 * @param left The left coordinate of the rectangle to invalidate. 12341 * @param top The top coordinate of the rectangle to invalidate. 12342 * @param right The right coordinate of the rectangle to invalidate. 12343 * @param bottom The bottom coordinate of the rectangle to invalidate. 12344 * 12345 * @see #invalidate(int, int, int, int) 12346 * @see #invalidate(Rect) 12347 * @see #postInvalidate(int, int, int, int) 12348 */ 12349 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 12350 int right, int bottom) { 12351 12352 // We try only with the AttachInfo because there's no point in invalidating 12353 // if we are not attached to our window 12354 final AttachInfo attachInfo = mAttachInfo; 12355 if (attachInfo != null) { 12356 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12357 info.target = this; 12358 info.left = left; 12359 info.top = top; 12360 info.right = right; 12361 info.bottom = bottom; 12362 12363 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds); 12364 } 12365 } 12366 12367 /** 12368 * <p>Cause an invalidate to happen on the next animation time step, typically the 12369 * next display frame.</p> 12370 * 12371 * <p>This method can be invoked from outside of the UI thread 12372 * only when this View is attached to a window.</p> 12373 * 12374 * @see #invalidate() 12375 */ 12376 public void postInvalidateOnAnimation() { 12377 // We try only with the AttachInfo because there's no point in invalidating 12378 // if we are not attached to our window 12379 final AttachInfo attachInfo = mAttachInfo; 12380 if (attachInfo != null) { 12381 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this); 12382 } 12383 } 12384 12385 /** 12386 * <p>Cause an invalidate of the specified area to happen on the next animation 12387 * time step, typically the next display frame.</p> 12388 * 12389 * <p>This method can be invoked from outside of the UI thread 12390 * only when this View is attached to a window.</p> 12391 * 12392 * @param left The left coordinate of the rectangle to invalidate. 12393 * @param top The top coordinate of the rectangle to invalidate. 12394 * @param right The right coordinate of the rectangle to invalidate. 12395 * @param bottom The bottom coordinate of the rectangle to invalidate. 12396 * 12397 * @see #invalidate(int, int, int, int) 12398 * @see #invalidate(Rect) 12399 */ 12400 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) { 12401 // We try only with the AttachInfo because there's no point in invalidating 12402 // if we are not attached to our window 12403 final AttachInfo attachInfo = mAttachInfo; 12404 if (attachInfo != null) { 12405 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12406 info.target = this; 12407 info.left = left; 12408 info.top = top; 12409 info.right = right; 12410 info.bottom = bottom; 12411 12412 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info); 12413 } 12414 } 12415 12416 /** 12417 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 12418 * This event is sent at most once every 12419 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 12420 */ 12421 private void postSendViewScrolledAccessibilityEventCallback() { 12422 if (mSendViewScrolledAccessibilityEvent == null) { 12423 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 12424 } 12425 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 12426 mSendViewScrolledAccessibilityEvent.mIsPending = true; 12427 postDelayed(mSendViewScrolledAccessibilityEvent, 12428 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 12429 } 12430 } 12431 12432 /** 12433 * Called by a parent to request that a child update its values for mScrollX 12434 * and mScrollY if necessary. This will typically be done if the child is 12435 * animating a scroll using a {@link android.widget.Scroller Scroller} 12436 * object. 12437 */ 12438 public void computeScroll() { 12439 } 12440 12441 /** 12442 * <p>Indicate whether the horizontal edges are faded when the view is 12443 * scrolled horizontally.</p> 12444 * 12445 * @return true if the horizontal edges should are faded on scroll, false 12446 * otherwise 12447 * 12448 * @see #setHorizontalFadingEdgeEnabled(boolean) 12449 * 12450 * @attr ref android.R.styleable#View_requiresFadingEdge 12451 */ 12452 public boolean isHorizontalFadingEdgeEnabled() { 12453 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 12454 } 12455 12456 /** 12457 * <p>Define whether the horizontal edges should be faded when this view 12458 * is scrolled horizontally.</p> 12459 * 12460 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 12461 * be faded when the view is scrolled 12462 * horizontally 12463 * 12464 * @see #isHorizontalFadingEdgeEnabled() 12465 * 12466 * @attr ref android.R.styleable#View_requiresFadingEdge 12467 */ 12468 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 12469 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 12470 if (horizontalFadingEdgeEnabled) { 12471 initScrollCache(); 12472 } 12473 12474 mViewFlags ^= FADING_EDGE_HORIZONTAL; 12475 } 12476 } 12477 12478 /** 12479 * <p>Indicate whether the vertical edges are faded when the view is 12480 * scrolled horizontally.</p> 12481 * 12482 * @return true if the vertical edges should are faded on scroll, false 12483 * otherwise 12484 * 12485 * @see #setVerticalFadingEdgeEnabled(boolean) 12486 * 12487 * @attr ref android.R.styleable#View_requiresFadingEdge 12488 */ 12489 public boolean isVerticalFadingEdgeEnabled() { 12490 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 12491 } 12492 12493 /** 12494 * <p>Define whether the vertical edges should be faded when this view 12495 * is scrolled vertically.</p> 12496 * 12497 * @param verticalFadingEdgeEnabled true if the vertical edges should 12498 * be faded when the view is scrolled 12499 * vertically 12500 * 12501 * @see #isVerticalFadingEdgeEnabled() 12502 * 12503 * @attr ref android.R.styleable#View_requiresFadingEdge 12504 */ 12505 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 12506 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 12507 if (verticalFadingEdgeEnabled) { 12508 initScrollCache(); 12509 } 12510 12511 mViewFlags ^= FADING_EDGE_VERTICAL; 12512 } 12513 } 12514 12515 /** 12516 * Returns the strength, or intensity, of the top faded edge. The strength is 12517 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12518 * returns 0.0 or 1.0 but no value in between. 12519 * 12520 * Subclasses should override this method to provide a smoother fade transition 12521 * when scrolling occurs. 12522 * 12523 * @return the intensity of the top fade as a float between 0.0f and 1.0f 12524 */ 12525 protected float getTopFadingEdgeStrength() { 12526 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 12527 } 12528 12529 /** 12530 * Returns the strength, or intensity, of the bottom faded edge. The strength is 12531 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12532 * returns 0.0 or 1.0 but no value in between. 12533 * 12534 * Subclasses should override this method to provide a smoother fade transition 12535 * when scrolling occurs. 12536 * 12537 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 12538 */ 12539 protected float getBottomFadingEdgeStrength() { 12540 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 12541 computeVerticalScrollRange() ? 1.0f : 0.0f; 12542 } 12543 12544 /** 12545 * Returns the strength, or intensity, of the left faded edge. The strength is 12546 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12547 * returns 0.0 or 1.0 but no value in between. 12548 * 12549 * Subclasses should override this method to provide a smoother fade transition 12550 * when scrolling occurs. 12551 * 12552 * @return the intensity of the left fade as a float between 0.0f and 1.0f 12553 */ 12554 protected float getLeftFadingEdgeStrength() { 12555 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 12556 } 12557 12558 /** 12559 * Returns the strength, or intensity, of the right faded edge. The strength is 12560 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12561 * returns 0.0 or 1.0 but no value in between. 12562 * 12563 * Subclasses should override this method to provide a smoother fade transition 12564 * when scrolling occurs. 12565 * 12566 * @return the intensity of the right fade as a float between 0.0f and 1.0f 12567 */ 12568 protected float getRightFadingEdgeStrength() { 12569 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 12570 computeHorizontalScrollRange() ? 1.0f : 0.0f; 12571 } 12572 12573 /** 12574 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 12575 * scrollbar is not drawn by default.</p> 12576 * 12577 * @return true if the horizontal scrollbar should be painted, false 12578 * otherwise 12579 * 12580 * @see #setHorizontalScrollBarEnabled(boolean) 12581 */ 12582 public boolean isHorizontalScrollBarEnabled() { 12583 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12584 } 12585 12586 /** 12587 * <p>Define whether the horizontal scrollbar should be drawn or not. The 12588 * scrollbar is not drawn by default.</p> 12589 * 12590 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 12591 * be painted 12592 * 12593 * @see #isHorizontalScrollBarEnabled() 12594 */ 12595 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 12596 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 12597 mViewFlags ^= SCROLLBARS_HORIZONTAL; 12598 computeOpaqueFlags(); 12599 resolvePadding(); 12600 } 12601 } 12602 12603 /** 12604 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 12605 * scrollbar is not drawn by default.</p> 12606 * 12607 * @return true if the vertical scrollbar should be painted, false 12608 * otherwise 12609 * 12610 * @see #setVerticalScrollBarEnabled(boolean) 12611 */ 12612 public boolean isVerticalScrollBarEnabled() { 12613 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 12614 } 12615 12616 /** 12617 * <p>Define whether the vertical scrollbar should be drawn or not. The 12618 * scrollbar is not drawn by default.</p> 12619 * 12620 * @param verticalScrollBarEnabled true if the vertical scrollbar should 12621 * be painted 12622 * 12623 * @see #isVerticalScrollBarEnabled() 12624 */ 12625 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 12626 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 12627 mViewFlags ^= SCROLLBARS_VERTICAL; 12628 computeOpaqueFlags(); 12629 resolvePadding(); 12630 } 12631 } 12632 12633 /** 12634 * @hide 12635 */ 12636 protected void recomputePadding() { 12637 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 12638 } 12639 12640 /** 12641 * Define whether scrollbars will fade when the view is not scrolling. 12642 * 12643 * @param fadeScrollbars wheter to enable fading 12644 * 12645 * @attr ref android.R.styleable#View_fadeScrollbars 12646 */ 12647 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 12648 initScrollCache(); 12649 final ScrollabilityCache scrollabilityCache = mScrollCache; 12650 scrollabilityCache.fadeScrollBars = fadeScrollbars; 12651 if (fadeScrollbars) { 12652 scrollabilityCache.state = ScrollabilityCache.OFF; 12653 } else { 12654 scrollabilityCache.state = ScrollabilityCache.ON; 12655 } 12656 } 12657 12658 /** 12659 * 12660 * Returns true if scrollbars will fade when this view is not scrolling 12661 * 12662 * @return true if scrollbar fading is enabled 12663 * 12664 * @attr ref android.R.styleable#View_fadeScrollbars 12665 */ 12666 public boolean isScrollbarFadingEnabled() { 12667 return mScrollCache != null && mScrollCache.fadeScrollBars; 12668 } 12669 12670 /** 12671 * 12672 * Returns the delay before scrollbars fade. 12673 * 12674 * @return the delay before scrollbars fade 12675 * 12676 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12677 */ 12678 public int getScrollBarDefaultDelayBeforeFade() { 12679 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() : 12680 mScrollCache.scrollBarDefaultDelayBeforeFade; 12681 } 12682 12683 /** 12684 * Define the delay before scrollbars fade. 12685 * 12686 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade 12687 * 12688 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12689 */ 12690 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) { 12691 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade; 12692 } 12693 12694 /** 12695 * 12696 * Returns the scrollbar fade duration. 12697 * 12698 * @return the scrollbar fade duration 12699 * 12700 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12701 */ 12702 public int getScrollBarFadeDuration() { 12703 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() : 12704 mScrollCache.scrollBarFadeDuration; 12705 } 12706 12707 /** 12708 * Define the scrollbar fade duration. 12709 * 12710 * @param scrollBarFadeDuration - the scrollbar fade duration 12711 * 12712 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12713 */ 12714 public void setScrollBarFadeDuration(int scrollBarFadeDuration) { 12715 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration; 12716 } 12717 12718 /** 12719 * 12720 * Returns the scrollbar size. 12721 * 12722 * @return the scrollbar size 12723 * 12724 * @attr ref android.R.styleable#View_scrollbarSize 12725 */ 12726 public int getScrollBarSize() { 12727 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() : 12728 mScrollCache.scrollBarSize; 12729 } 12730 12731 /** 12732 * Define the scrollbar size. 12733 * 12734 * @param scrollBarSize - the scrollbar size 12735 * 12736 * @attr ref android.R.styleable#View_scrollbarSize 12737 */ 12738 public void setScrollBarSize(int scrollBarSize) { 12739 getScrollCache().scrollBarSize = scrollBarSize; 12740 } 12741 12742 /** 12743 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 12744 * inset. When inset, they add to the padding of the view. And the scrollbars 12745 * can be drawn inside the padding area or on the edge of the view. For example, 12746 * if a view has a background drawable and you want to draw the scrollbars 12747 * inside the padding specified by the drawable, you can use 12748 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 12749 * appear at the edge of the view, ignoring the padding, then you can use 12750 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 12751 * @param style the style of the scrollbars. Should be one of 12752 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 12753 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 12754 * @see #SCROLLBARS_INSIDE_OVERLAY 12755 * @see #SCROLLBARS_INSIDE_INSET 12756 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12757 * @see #SCROLLBARS_OUTSIDE_INSET 12758 * 12759 * @attr ref android.R.styleable#View_scrollbarStyle 12760 */ 12761 public void setScrollBarStyle(@ScrollBarStyle int style) { 12762 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 12763 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 12764 computeOpaqueFlags(); 12765 resolvePadding(); 12766 } 12767 } 12768 12769 /** 12770 * <p>Returns the current scrollbar style.</p> 12771 * @return the current scrollbar style 12772 * @see #SCROLLBARS_INSIDE_OVERLAY 12773 * @see #SCROLLBARS_INSIDE_INSET 12774 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12775 * @see #SCROLLBARS_OUTSIDE_INSET 12776 * 12777 * @attr ref android.R.styleable#View_scrollbarStyle 12778 */ 12779 @ViewDebug.ExportedProperty(mapping = { 12780 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 12781 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 12782 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 12783 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 12784 }) 12785 @ScrollBarStyle 12786 public int getScrollBarStyle() { 12787 return mViewFlags & SCROLLBARS_STYLE_MASK; 12788 } 12789 12790 /** 12791 * <p>Compute the horizontal range that the horizontal scrollbar 12792 * represents.</p> 12793 * 12794 * <p>The range is expressed in arbitrary units that must be the same as the 12795 * units used by {@link #computeHorizontalScrollExtent()} and 12796 * {@link #computeHorizontalScrollOffset()}.</p> 12797 * 12798 * <p>The default range is the drawing width of this view.</p> 12799 * 12800 * @return the total horizontal range represented by the horizontal 12801 * scrollbar 12802 * 12803 * @see #computeHorizontalScrollExtent() 12804 * @see #computeHorizontalScrollOffset() 12805 * @see android.widget.ScrollBarDrawable 12806 */ 12807 protected int computeHorizontalScrollRange() { 12808 return getWidth(); 12809 } 12810 12811 /** 12812 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 12813 * within the horizontal range. This value is used to compute the position 12814 * of the thumb within the scrollbar's track.</p> 12815 * 12816 * <p>The range is expressed in arbitrary units that must be the same as the 12817 * units used by {@link #computeHorizontalScrollRange()} and 12818 * {@link #computeHorizontalScrollExtent()}.</p> 12819 * 12820 * <p>The default offset is the scroll offset of this view.</p> 12821 * 12822 * @return the horizontal offset of the scrollbar's thumb 12823 * 12824 * @see #computeHorizontalScrollRange() 12825 * @see #computeHorizontalScrollExtent() 12826 * @see android.widget.ScrollBarDrawable 12827 */ 12828 protected int computeHorizontalScrollOffset() { 12829 return mScrollX; 12830 } 12831 12832 /** 12833 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 12834 * within the horizontal range. This value is used to compute the length 12835 * of the thumb within the scrollbar's track.</p> 12836 * 12837 * <p>The range is expressed in arbitrary units that must be the same as the 12838 * units used by {@link #computeHorizontalScrollRange()} and 12839 * {@link #computeHorizontalScrollOffset()}.</p> 12840 * 12841 * <p>The default extent is the drawing width of this view.</p> 12842 * 12843 * @return the horizontal extent of the scrollbar's thumb 12844 * 12845 * @see #computeHorizontalScrollRange() 12846 * @see #computeHorizontalScrollOffset() 12847 * @see android.widget.ScrollBarDrawable 12848 */ 12849 protected int computeHorizontalScrollExtent() { 12850 return getWidth(); 12851 } 12852 12853 /** 12854 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 12855 * 12856 * <p>The range is expressed in arbitrary units that must be the same as the 12857 * units used by {@link #computeVerticalScrollExtent()} and 12858 * {@link #computeVerticalScrollOffset()}.</p> 12859 * 12860 * @return the total vertical range represented by the vertical scrollbar 12861 * 12862 * <p>The default range is the drawing height of this view.</p> 12863 * 12864 * @see #computeVerticalScrollExtent() 12865 * @see #computeVerticalScrollOffset() 12866 * @see android.widget.ScrollBarDrawable 12867 */ 12868 protected int computeVerticalScrollRange() { 12869 return getHeight(); 12870 } 12871 12872 /** 12873 * <p>Compute the vertical offset of the vertical scrollbar's thumb 12874 * within the horizontal range. This value is used to compute the position 12875 * of the thumb within the scrollbar's track.</p> 12876 * 12877 * <p>The range is expressed in arbitrary units that must be the same as the 12878 * units used by {@link #computeVerticalScrollRange()} and 12879 * {@link #computeVerticalScrollExtent()}.</p> 12880 * 12881 * <p>The default offset is the scroll offset of this view.</p> 12882 * 12883 * @return the vertical offset of the scrollbar's thumb 12884 * 12885 * @see #computeVerticalScrollRange() 12886 * @see #computeVerticalScrollExtent() 12887 * @see android.widget.ScrollBarDrawable 12888 */ 12889 protected int computeVerticalScrollOffset() { 12890 return mScrollY; 12891 } 12892 12893 /** 12894 * <p>Compute the vertical extent of the vertical scrollbar's thumb 12895 * within the vertical range. This value is used to compute the length 12896 * of the thumb within the scrollbar's track.</p> 12897 * 12898 * <p>The range is expressed in arbitrary units that must be the same as the 12899 * units used by {@link #computeVerticalScrollRange()} and 12900 * {@link #computeVerticalScrollOffset()}.</p> 12901 * 12902 * <p>The default extent is the drawing height of this view.</p> 12903 * 12904 * @return the vertical extent of the scrollbar's thumb 12905 * 12906 * @see #computeVerticalScrollRange() 12907 * @see #computeVerticalScrollOffset() 12908 * @see android.widget.ScrollBarDrawable 12909 */ 12910 protected int computeVerticalScrollExtent() { 12911 return getHeight(); 12912 } 12913 12914 /** 12915 * Check if this view can be scrolled horizontally in a certain direction. 12916 * 12917 * @param direction Negative to check scrolling left, positive to check scrolling right. 12918 * @return true if this view can be scrolled in the specified direction, false otherwise. 12919 */ 12920 public boolean canScrollHorizontally(int direction) { 12921 final int offset = computeHorizontalScrollOffset(); 12922 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 12923 if (range == 0) return false; 12924 if (direction < 0) { 12925 return offset > 0; 12926 } else { 12927 return offset < range - 1; 12928 } 12929 } 12930 12931 /** 12932 * Check if this view can be scrolled vertically in a certain direction. 12933 * 12934 * @param direction Negative to check scrolling up, positive to check scrolling down. 12935 * @return true if this view can be scrolled in the specified direction, false otherwise. 12936 */ 12937 public boolean canScrollVertically(int direction) { 12938 final int offset = computeVerticalScrollOffset(); 12939 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 12940 if (range == 0) return false; 12941 if (direction < 0) { 12942 return offset > 0; 12943 } else { 12944 return offset < range - 1; 12945 } 12946 } 12947 12948 /** 12949 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 12950 * scrollbars are painted only if they have been awakened first.</p> 12951 * 12952 * @param canvas the canvas on which to draw the scrollbars 12953 * 12954 * @see #awakenScrollBars(int) 12955 */ 12956 protected final void onDrawScrollBars(Canvas canvas) { 12957 // scrollbars are drawn only when the animation is running 12958 final ScrollabilityCache cache = mScrollCache; 12959 if (cache != null) { 12960 12961 int state = cache.state; 12962 12963 if (state == ScrollabilityCache.OFF) { 12964 return; 12965 } 12966 12967 boolean invalidate = false; 12968 12969 if (state == ScrollabilityCache.FADING) { 12970 // We're fading -- get our fade interpolation 12971 if (cache.interpolatorValues == null) { 12972 cache.interpolatorValues = new float[1]; 12973 } 12974 12975 float[] values = cache.interpolatorValues; 12976 12977 // Stops the animation if we're done 12978 if (cache.scrollBarInterpolator.timeToValues(values) == 12979 Interpolator.Result.FREEZE_END) { 12980 cache.state = ScrollabilityCache.OFF; 12981 } else { 12982 cache.scrollBar.setAlpha(Math.round(values[0])); 12983 } 12984 12985 // This will make the scroll bars inval themselves after 12986 // drawing. We only want this when we're fading so that 12987 // we prevent excessive redraws 12988 invalidate = true; 12989 } else { 12990 // We're just on -- but we may have been fading before so 12991 // reset alpha 12992 cache.scrollBar.setAlpha(255); 12993 } 12994 12995 12996 final int viewFlags = mViewFlags; 12997 12998 final boolean drawHorizontalScrollBar = 12999 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 13000 final boolean drawVerticalScrollBar = 13001 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 13002 && !isVerticalScrollBarHidden(); 13003 13004 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 13005 final int width = mRight - mLeft; 13006 final int height = mBottom - mTop; 13007 13008 final ScrollBarDrawable scrollBar = cache.scrollBar; 13009 13010 final int scrollX = mScrollX; 13011 final int scrollY = mScrollY; 13012 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 13013 13014 int left; 13015 int top; 13016 int right; 13017 int bottom; 13018 13019 if (drawHorizontalScrollBar) { 13020 int size = scrollBar.getSize(false); 13021 if (size <= 0) { 13022 size = cache.scrollBarSize; 13023 } 13024 13025 scrollBar.setParameters(computeHorizontalScrollRange(), 13026 computeHorizontalScrollOffset(), 13027 computeHorizontalScrollExtent(), false); 13028 final int verticalScrollBarGap = drawVerticalScrollBar ? 13029 getVerticalScrollbarWidth() : 0; 13030 top = scrollY + height - size - (mUserPaddingBottom & inside); 13031 left = scrollX + (mPaddingLeft & inside); 13032 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 13033 bottom = top + size; 13034 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 13035 if (invalidate) { 13036 invalidate(left, top, right, bottom); 13037 } 13038 } 13039 13040 if (drawVerticalScrollBar) { 13041 int size = scrollBar.getSize(true); 13042 if (size <= 0) { 13043 size = cache.scrollBarSize; 13044 } 13045 13046 scrollBar.setParameters(computeVerticalScrollRange(), 13047 computeVerticalScrollOffset(), 13048 computeVerticalScrollExtent(), true); 13049 int verticalScrollbarPosition = mVerticalScrollbarPosition; 13050 if (verticalScrollbarPosition == SCROLLBAR_POSITION_DEFAULT) { 13051 verticalScrollbarPosition = isLayoutRtl() ? 13052 SCROLLBAR_POSITION_LEFT : SCROLLBAR_POSITION_RIGHT; 13053 } 13054 switch (verticalScrollbarPosition) { 13055 default: 13056 case SCROLLBAR_POSITION_RIGHT: 13057 left = scrollX + width - size - (mUserPaddingRight & inside); 13058 break; 13059 case SCROLLBAR_POSITION_LEFT: 13060 left = scrollX + (mUserPaddingLeft & inside); 13061 break; 13062 } 13063 top = scrollY + (mPaddingTop & inside); 13064 right = left + size; 13065 bottom = scrollY + height - (mUserPaddingBottom & inside); 13066 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 13067 if (invalidate) { 13068 invalidate(left, top, right, bottom); 13069 } 13070 } 13071 } 13072 } 13073 } 13074 13075 /** 13076 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 13077 * FastScroller is visible. 13078 * @return whether to temporarily hide the vertical scrollbar 13079 * @hide 13080 */ 13081 protected boolean isVerticalScrollBarHidden() { 13082 return false; 13083 } 13084 13085 /** 13086 * <p>Draw the horizontal scrollbar if 13087 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 13088 * 13089 * @param canvas the canvas on which to draw the scrollbar 13090 * @param scrollBar the scrollbar's drawable 13091 * 13092 * @see #isHorizontalScrollBarEnabled() 13093 * @see #computeHorizontalScrollRange() 13094 * @see #computeHorizontalScrollExtent() 13095 * @see #computeHorizontalScrollOffset() 13096 * @see android.widget.ScrollBarDrawable 13097 * @hide 13098 */ 13099 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 13100 int l, int t, int r, int b) { 13101 scrollBar.setBounds(l, t, r, b); 13102 scrollBar.draw(canvas); 13103 } 13104 13105 /** 13106 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 13107 * returns true.</p> 13108 * 13109 * @param canvas the canvas on which to draw the scrollbar 13110 * @param scrollBar the scrollbar's drawable 13111 * 13112 * @see #isVerticalScrollBarEnabled() 13113 * @see #computeVerticalScrollRange() 13114 * @see #computeVerticalScrollExtent() 13115 * @see #computeVerticalScrollOffset() 13116 * @see android.widget.ScrollBarDrawable 13117 * @hide 13118 */ 13119 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 13120 int l, int t, int r, int b) { 13121 scrollBar.setBounds(l, t, r, b); 13122 scrollBar.draw(canvas); 13123 } 13124 13125 /** 13126 * Implement this to do your drawing. 13127 * 13128 * @param canvas the canvas on which the background will be drawn 13129 */ 13130 protected void onDraw(Canvas canvas) { 13131 } 13132 13133 /* 13134 * Caller is responsible for calling requestLayout if necessary. 13135 * (This allows addViewInLayout to not request a new layout.) 13136 */ 13137 void assignParent(ViewParent parent) { 13138 if (mParent == null) { 13139 mParent = parent; 13140 } else if (parent == null) { 13141 mParent = null; 13142 } else { 13143 throw new RuntimeException("view " + this + " being added, but" 13144 + " it already has a parent"); 13145 } 13146 } 13147 13148 /** 13149 * This is called when the view is attached to a window. At this point it 13150 * has a Surface and will start drawing. Note that this function is 13151 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 13152 * however it may be called any time before the first onDraw -- including 13153 * before or after {@link #onMeasure(int, int)}. 13154 * 13155 * @see #onDetachedFromWindow() 13156 */ 13157 protected void onAttachedToWindow() { 13158 if ((mPrivateFlags & PFLAG_REQUEST_TRANSPARENT_REGIONS) != 0) { 13159 mParent.requestTransparentRegion(this); 13160 } 13161 13162 if ((mPrivateFlags & PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 13163 initialAwakenScrollBars(); 13164 mPrivateFlags &= ~PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 13165 } 13166 13167 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13168 13169 jumpDrawablesToCurrentState(); 13170 13171 resetSubtreeAccessibilityStateChanged(); 13172 13173 // rebuild, since Outline not maintained while View is detached 13174 rebuildOutline(); 13175 13176 if (isFocused()) { 13177 InputMethodManager imm = InputMethodManager.peekInstance(); 13178 imm.focusIn(this); 13179 } 13180 } 13181 13182 /** 13183 * Resolve all RTL related properties. 13184 * 13185 * @return true if resolution of RTL properties has been done 13186 * 13187 * @hide 13188 */ 13189 public boolean resolveRtlPropertiesIfNeeded() { 13190 if (!needRtlPropertiesResolution()) return false; 13191 13192 // Order is important here: LayoutDirection MUST be resolved first 13193 if (!isLayoutDirectionResolved()) { 13194 resolveLayoutDirection(); 13195 resolveLayoutParams(); 13196 } 13197 // ... then we can resolve the others properties depending on the resolved LayoutDirection. 13198 if (!isTextDirectionResolved()) { 13199 resolveTextDirection(); 13200 } 13201 if (!isTextAlignmentResolved()) { 13202 resolveTextAlignment(); 13203 } 13204 // Should resolve Drawables before Padding because we need the layout direction of the 13205 // Drawable to correctly resolve Padding. 13206 if (!areDrawablesResolved()) { 13207 resolveDrawables(); 13208 } 13209 if (!isPaddingResolved()) { 13210 resolvePadding(); 13211 } 13212 onRtlPropertiesChanged(getLayoutDirection()); 13213 return true; 13214 } 13215 13216 /** 13217 * Reset resolution of all RTL related properties. 13218 * 13219 * @hide 13220 */ 13221 public void resetRtlProperties() { 13222 resetResolvedLayoutDirection(); 13223 resetResolvedTextDirection(); 13224 resetResolvedTextAlignment(); 13225 resetResolvedPadding(); 13226 resetResolvedDrawables(); 13227 } 13228 13229 /** 13230 * @see #onScreenStateChanged(int) 13231 */ 13232 void dispatchScreenStateChanged(int screenState) { 13233 onScreenStateChanged(screenState); 13234 } 13235 13236 /** 13237 * This method is called whenever the state of the screen this view is 13238 * attached to changes. A state change will usually occurs when the screen 13239 * turns on or off (whether it happens automatically or the user does it 13240 * manually.) 13241 * 13242 * @param screenState The new state of the screen. Can be either 13243 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF} 13244 */ 13245 public void onScreenStateChanged(int screenState) { 13246 } 13247 13248 /** 13249 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true 13250 */ 13251 private boolean hasRtlSupport() { 13252 return mContext.getApplicationInfo().hasRtlSupport(); 13253 } 13254 13255 /** 13256 * Return true if we are in RTL compatibility mode (either before Jelly Bean MR1 or 13257 * RTL not supported) 13258 */ 13259 private boolean isRtlCompatibilityMode() { 13260 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 13261 return targetSdkVersion < JELLY_BEAN_MR1 || !hasRtlSupport(); 13262 } 13263 13264 /** 13265 * @return true if RTL properties need resolution. 13266 * 13267 */ 13268 private boolean needRtlPropertiesResolution() { 13269 return (mPrivateFlags2 & ALL_RTL_PROPERTIES_RESOLVED) != ALL_RTL_PROPERTIES_RESOLVED; 13270 } 13271 13272 /** 13273 * Called when any RTL property (layout direction or text direction or text alignment) has 13274 * been changed. 13275 * 13276 * Subclasses need to override this method to take care of cached information that depends on the 13277 * resolved layout direction, or to inform child views that inherit their layout direction. 13278 * 13279 * The default implementation does nothing. 13280 * 13281 * @param layoutDirection the direction of the layout 13282 * 13283 * @see #LAYOUT_DIRECTION_LTR 13284 * @see #LAYOUT_DIRECTION_RTL 13285 */ 13286 public void onRtlPropertiesChanged(@ResolvedLayoutDir int layoutDirection) { 13287 } 13288 13289 /** 13290 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 13291 * that the parent directionality can and will be resolved before its children. 13292 * 13293 * @return true if resolution has been done, false otherwise. 13294 * 13295 * @hide 13296 */ 13297 public boolean resolveLayoutDirection() { 13298 // Clear any previous layout direction resolution 13299 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13300 13301 if (hasRtlSupport()) { 13302 // Set resolved depending on layout direction 13303 switch ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> 13304 PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) { 13305 case LAYOUT_DIRECTION_INHERIT: 13306 // We cannot resolve yet. LTR is by default and let the resolution happen again 13307 // later to get the correct resolved value 13308 if (!canResolveLayoutDirection()) return false; 13309 13310 // Parent has not yet resolved, LTR is still the default 13311 try { 13312 if (!mParent.isLayoutDirectionResolved()) return false; 13313 13314 if (mParent.getLayoutDirection() == LAYOUT_DIRECTION_RTL) { 13315 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13316 } 13317 } catch (AbstractMethodError e) { 13318 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13319 " does not fully implement ViewParent", e); 13320 } 13321 break; 13322 case LAYOUT_DIRECTION_RTL: 13323 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13324 break; 13325 case LAYOUT_DIRECTION_LOCALE: 13326 if((LAYOUT_DIRECTION_RTL == 13327 TextUtils.getLayoutDirectionFromLocale(Locale.getDefault()))) { 13328 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13329 } 13330 break; 13331 default: 13332 // Nothing to do, LTR by default 13333 } 13334 } 13335 13336 // Set to resolved 13337 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13338 return true; 13339 } 13340 13341 /** 13342 * Check if layout direction resolution can be done. 13343 * 13344 * @return true if layout direction resolution can be done otherwise return false. 13345 */ 13346 public boolean canResolveLayoutDirection() { 13347 switch (getRawLayoutDirection()) { 13348 case LAYOUT_DIRECTION_INHERIT: 13349 if (mParent != null) { 13350 try { 13351 return mParent.canResolveLayoutDirection(); 13352 } catch (AbstractMethodError e) { 13353 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13354 " does not fully implement ViewParent", e); 13355 } 13356 } 13357 return false; 13358 13359 default: 13360 return true; 13361 } 13362 } 13363 13364 /** 13365 * Reset the resolved layout direction. Layout direction will be resolved during a call to 13366 * {@link #onMeasure(int, int)}. 13367 * 13368 * @hide 13369 */ 13370 public void resetResolvedLayoutDirection() { 13371 // Reset the current resolved bits 13372 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13373 } 13374 13375 /** 13376 * @return true if the layout direction is inherited. 13377 * 13378 * @hide 13379 */ 13380 public boolean isLayoutDirectionInherited() { 13381 return (getRawLayoutDirection() == LAYOUT_DIRECTION_INHERIT); 13382 } 13383 13384 /** 13385 * @return true if layout direction has been resolved. 13386 */ 13387 public boolean isLayoutDirectionResolved() { 13388 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED) == PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13389 } 13390 13391 /** 13392 * Return if padding has been resolved 13393 * 13394 * @hide 13395 */ 13396 boolean isPaddingResolved() { 13397 return (mPrivateFlags2 & PFLAG2_PADDING_RESOLVED) == PFLAG2_PADDING_RESOLVED; 13398 } 13399 13400 /** 13401 * Resolves padding depending on layout direction, if applicable, and 13402 * recomputes internal padding values to adjust for scroll bars. 13403 * 13404 * @hide 13405 */ 13406 public void resolvePadding() { 13407 final int resolvedLayoutDirection = getLayoutDirection(); 13408 13409 if (!isRtlCompatibilityMode()) { 13410 // Post Jelly Bean MR1 case: we need to take the resolved layout direction into account. 13411 // If start / end padding are defined, they will be resolved (hence overriding) to 13412 // left / right or right / left depending on the resolved layout direction. 13413 // If start / end padding are not defined, use the left / right ones. 13414 if (mBackground != null && (!mLeftPaddingDefined || !mRightPaddingDefined)) { 13415 Rect padding = sThreadLocal.get(); 13416 if (padding == null) { 13417 padding = new Rect(); 13418 sThreadLocal.set(padding); 13419 } 13420 mBackground.getPadding(padding); 13421 if (!mLeftPaddingDefined) { 13422 mUserPaddingLeftInitial = padding.left; 13423 } 13424 if (!mRightPaddingDefined) { 13425 mUserPaddingRightInitial = padding.right; 13426 } 13427 } 13428 switch (resolvedLayoutDirection) { 13429 case LAYOUT_DIRECTION_RTL: 13430 if (mUserPaddingStart != UNDEFINED_PADDING) { 13431 mUserPaddingRight = mUserPaddingStart; 13432 } else { 13433 mUserPaddingRight = mUserPaddingRightInitial; 13434 } 13435 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13436 mUserPaddingLeft = mUserPaddingEnd; 13437 } else { 13438 mUserPaddingLeft = mUserPaddingLeftInitial; 13439 } 13440 break; 13441 case LAYOUT_DIRECTION_LTR: 13442 default: 13443 if (mUserPaddingStart != UNDEFINED_PADDING) { 13444 mUserPaddingLeft = mUserPaddingStart; 13445 } else { 13446 mUserPaddingLeft = mUserPaddingLeftInitial; 13447 } 13448 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13449 mUserPaddingRight = mUserPaddingEnd; 13450 } else { 13451 mUserPaddingRight = mUserPaddingRightInitial; 13452 } 13453 } 13454 13455 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 13456 } 13457 13458 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 13459 onRtlPropertiesChanged(resolvedLayoutDirection); 13460 13461 mPrivateFlags2 |= PFLAG2_PADDING_RESOLVED; 13462 } 13463 13464 /** 13465 * Reset the resolved layout direction. 13466 * 13467 * @hide 13468 */ 13469 public void resetResolvedPadding() { 13470 resetResolvedPaddingInternal(); 13471 } 13472 13473 /** 13474 * Used when we only want to reset *this* view's padding and not trigger overrides 13475 * in ViewGroup that reset children too. 13476 */ 13477 void resetResolvedPaddingInternal() { 13478 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED; 13479 } 13480 13481 /** 13482 * This is called when the view is detached from a window. At this point it 13483 * no longer has a surface for drawing. 13484 * 13485 * @see #onAttachedToWindow() 13486 */ 13487 protected void onDetachedFromWindow() { 13488 } 13489 13490 /** 13491 * This is a framework-internal mirror of onDetachedFromWindow() that's called 13492 * after onDetachedFromWindow(). 13493 * 13494 * If you override this you *MUST* call super.onDetachedFromWindowInternal()! 13495 * The super method should be called at the end of the overriden method to ensure 13496 * subclasses are destroyed first 13497 * 13498 * @hide 13499 */ 13500 protected void onDetachedFromWindowInternal() { 13501 mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT; 13502 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13503 13504 removeUnsetPressCallback(); 13505 removeLongPressCallback(); 13506 removePerformClickCallback(); 13507 removeSendViewScrolledAccessibilityEventCallback(); 13508 stopNestedScroll(); 13509 13510 // Anything that started animating right before detach should already 13511 // be in its final state when re-attached. 13512 jumpDrawablesToCurrentState(); 13513 13514 destroyDrawingCache(); 13515 13516 cleanupDraw(); 13517 mCurrentAnimation = null; 13518 } 13519 13520 private void cleanupDraw() { 13521 resetDisplayList(); 13522 if (mAttachInfo != null) { 13523 mAttachInfo.mViewRootImpl.cancelInvalidate(this); 13524 } 13525 } 13526 13527 void invalidateInheritedLayoutMode(int layoutModeOfRoot) { 13528 } 13529 13530 /** 13531 * @return The number of times this view has been attached to a window 13532 */ 13533 protected int getWindowAttachCount() { 13534 return mWindowAttachCount; 13535 } 13536 13537 /** 13538 * Retrieve a unique token identifying the window this view is attached to. 13539 * @return Return the window's token for use in 13540 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 13541 */ 13542 public IBinder getWindowToken() { 13543 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 13544 } 13545 13546 /** 13547 * Retrieve the {@link WindowId} for the window this view is 13548 * currently attached to. 13549 */ 13550 public WindowId getWindowId() { 13551 if (mAttachInfo == null) { 13552 return null; 13553 } 13554 if (mAttachInfo.mWindowId == null) { 13555 try { 13556 mAttachInfo.mIWindowId = mAttachInfo.mSession.getWindowId( 13557 mAttachInfo.mWindowToken); 13558 mAttachInfo.mWindowId = new WindowId( 13559 mAttachInfo.mIWindowId); 13560 } catch (RemoteException e) { 13561 } 13562 } 13563 return mAttachInfo.mWindowId; 13564 } 13565 13566 /** 13567 * Retrieve a unique token identifying the top-level "real" window of 13568 * the window that this view is attached to. That is, this is like 13569 * {@link #getWindowToken}, except if the window this view in is a panel 13570 * window (attached to another containing window), then the token of 13571 * the containing window is returned instead. 13572 * 13573 * @return Returns the associated window token, either 13574 * {@link #getWindowToken()} or the containing window's token. 13575 */ 13576 public IBinder getApplicationWindowToken() { 13577 AttachInfo ai = mAttachInfo; 13578 if (ai != null) { 13579 IBinder appWindowToken = ai.mPanelParentWindowToken; 13580 if (appWindowToken == null) { 13581 appWindowToken = ai.mWindowToken; 13582 } 13583 return appWindowToken; 13584 } 13585 return null; 13586 } 13587 13588 /** 13589 * Gets the logical display to which the view's window has been attached. 13590 * 13591 * @return The logical display, or null if the view is not currently attached to a window. 13592 */ 13593 public Display getDisplay() { 13594 return mAttachInfo != null ? mAttachInfo.mDisplay : null; 13595 } 13596 13597 /** 13598 * Retrieve private session object this view hierarchy is using to 13599 * communicate with the window manager. 13600 * @return the session object to communicate with the window manager 13601 */ 13602 /*package*/ IWindowSession getWindowSession() { 13603 return mAttachInfo != null ? mAttachInfo.mSession : null; 13604 } 13605 13606 /** 13607 * @param info the {@link android.view.View.AttachInfo} to associated with 13608 * this view 13609 */ 13610 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 13611 //System.out.println("Attached! " + this); 13612 mAttachInfo = info; 13613 if (mOverlay != null) { 13614 mOverlay.getOverlayView().dispatchAttachedToWindow(info, visibility); 13615 } 13616 mWindowAttachCount++; 13617 // We will need to evaluate the drawable state at least once. 13618 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 13619 if (mFloatingTreeObserver != null) { 13620 info.mTreeObserver.merge(mFloatingTreeObserver); 13621 mFloatingTreeObserver = null; 13622 } 13623 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER) != 0) { 13624 mAttachInfo.mScrollContainers.add(this); 13625 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 13626 } 13627 performCollectViewAttributes(mAttachInfo, visibility); 13628 onAttachedToWindow(); 13629 13630 ListenerInfo li = mListenerInfo; 13631 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13632 li != null ? li.mOnAttachStateChangeListeners : null; 13633 if (listeners != null && listeners.size() > 0) { 13634 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13635 // perform the dispatching. The iterator is a safe guard against listeners that 13636 // could mutate the list by calling the various add/remove methods. This prevents 13637 // the array from being modified while we iterate it. 13638 for (OnAttachStateChangeListener listener : listeners) { 13639 listener.onViewAttachedToWindow(this); 13640 } 13641 } 13642 13643 int vis = info.mWindowVisibility; 13644 if (vis != GONE) { 13645 onWindowVisibilityChanged(vis); 13646 } 13647 if ((mPrivateFlags&PFLAG_DRAWABLE_STATE_DIRTY) != 0) { 13648 // If nobody has evaluated the drawable state yet, then do it now. 13649 refreshDrawableState(); 13650 } 13651 needGlobalAttributesUpdate(false); 13652 } 13653 13654 void dispatchDetachedFromWindow() { 13655 AttachInfo info = mAttachInfo; 13656 if (info != null) { 13657 int vis = info.mWindowVisibility; 13658 if (vis != GONE) { 13659 onWindowVisibilityChanged(GONE); 13660 } 13661 } 13662 13663 onDetachedFromWindow(); 13664 onDetachedFromWindowInternal(); 13665 13666 ListenerInfo li = mListenerInfo; 13667 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13668 li != null ? li.mOnAttachStateChangeListeners : null; 13669 if (listeners != null && listeners.size() > 0) { 13670 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13671 // perform the dispatching. The iterator is a safe guard against listeners that 13672 // could mutate the list by calling the various add/remove methods. This prevents 13673 // the array from being modified while we iterate it. 13674 for (OnAttachStateChangeListener listener : listeners) { 13675 listener.onViewDetachedFromWindow(this); 13676 } 13677 } 13678 13679 if ((mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 13680 mAttachInfo.mScrollContainers.remove(this); 13681 mPrivateFlags &= ~PFLAG_SCROLL_CONTAINER_ADDED; 13682 } 13683 13684 mAttachInfo = null; 13685 if (mOverlay != null) { 13686 mOverlay.getOverlayView().dispatchDetachedFromWindow(); 13687 } 13688 } 13689 13690 /** 13691 * Cancel any deferred high-level input events that were previously posted to the event queue. 13692 * 13693 * <p>Many views post high-level events such as click handlers to the event queue 13694 * to run deferred in order to preserve a desired user experience - clearing visible 13695 * pressed states before executing, etc. This method will abort any events of this nature 13696 * that are currently in flight.</p> 13697 * 13698 * <p>Custom views that generate their own high-level deferred input events should override 13699 * {@link #onCancelPendingInputEvents()} and remove those pending events from the queue.</p> 13700 * 13701 * <p>This will also cancel pending input events for any child views.</p> 13702 * 13703 * <p>Note that this may not be sufficient as a debouncing strategy for clicks in all cases. 13704 * This will not impact newer events posted after this call that may occur as a result of 13705 * lower-level input events still waiting in the queue. If you are trying to prevent 13706 * double-submitted events for the duration of some sort of asynchronous transaction 13707 * you should also take other steps to protect against unexpected double inputs e.g. calling 13708 * {@link #setEnabled(boolean) setEnabled(false)} and re-enabling the view when 13709 * the transaction completes, tracking already submitted transaction IDs, etc.</p> 13710 */ 13711 public final void cancelPendingInputEvents() { 13712 dispatchCancelPendingInputEvents(); 13713 } 13714 13715 /** 13716 * Called by {@link #cancelPendingInputEvents()} to cancel input events in flight. 13717 * Overridden by ViewGroup to dispatch. Package scoped to prevent app-side meddling. 13718 */ 13719 void dispatchCancelPendingInputEvents() { 13720 mPrivateFlags3 &= ~PFLAG3_CALLED_SUPER; 13721 onCancelPendingInputEvents(); 13722 if ((mPrivateFlags3 & PFLAG3_CALLED_SUPER) != PFLAG3_CALLED_SUPER) { 13723 throw new SuperNotCalledException("View " + getClass().getSimpleName() + 13724 " did not call through to super.onCancelPendingInputEvents()"); 13725 } 13726 } 13727 13728 /** 13729 * Called as the result of a call to {@link #cancelPendingInputEvents()} on this view or 13730 * a parent view. 13731 * 13732 * <p>This method is responsible for removing any pending high-level input events that were 13733 * posted to the event queue to run later. Custom view classes that post their own deferred 13734 * high-level events via {@link #post(Runnable)}, {@link #postDelayed(Runnable, long)} or 13735 * {@link android.os.Handler} should override this method, call 13736 * <code>super.onCancelPendingInputEvents()</code> and remove those callbacks as appropriate. 13737 * </p> 13738 */ 13739 public void onCancelPendingInputEvents() { 13740 removePerformClickCallback(); 13741 cancelLongPress(); 13742 mPrivateFlags3 |= PFLAG3_CALLED_SUPER; 13743 } 13744 13745 /** 13746 * Store this view hierarchy's frozen state into the given container. 13747 * 13748 * @param container The SparseArray in which to save the view's state. 13749 * 13750 * @see #restoreHierarchyState(android.util.SparseArray) 13751 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13752 * @see #onSaveInstanceState() 13753 */ 13754 public void saveHierarchyState(SparseArray<Parcelable> container) { 13755 dispatchSaveInstanceState(container); 13756 } 13757 13758 /** 13759 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 13760 * this view and its children. May be overridden to modify how freezing happens to a 13761 * view's children; for example, some views may want to not store state for their children. 13762 * 13763 * @param container The SparseArray in which to save the view's state. 13764 * 13765 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13766 * @see #saveHierarchyState(android.util.SparseArray) 13767 * @see #onSaveInstanceState() 13768 */ 13769 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 13770 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 13771 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13772 Parcelable state = onSaveInstanceState(); 13773 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13774 throw new IllegalStateException( 13775 "Derived class did not call super.onSaveInstanceState()"); 13776 } 13777 if (state != null) { 13778 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 13779 // + ": " + state); 13780 container.put(mID, state); 13781 } 13782 } 13783 } 13784 13785 /** 13786 * Hook allowing a view to generate a representation of its internal state 13787 * that can later be used to create a new instance with that same state. 13788 * This state should only contain information that is not persistent or can 13789 * not be reconstructed later. For example, you will never store your 13790 * current position on screen because that will be computed again when a 13791 * new instance of the view is placed in its view hierarchy. 13792 * <p> 13793 * Some examples of things you may store here: the current cursor position 13794 * in a text view (but usually not the text itself since that is stored in a 13795 * content provider or other persistent storage), the currently selected 13796 * item in a list view. 13797 * 13798 * @return Returns a Parcelable object containing the view's current dynamic 13799 * state, or null if there is nothing interesting to save. The 13800 * default implementation returns null. 13801 * @see #onRestoreInstanceState(android.os.Parcelable) 13802 * @see #saveHierarchyState(android.util.SparseArray) 13803 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13804 * @see #setSaveEnabled(boolean) 13805 */ 13806 protected Parcelable onSaveInstanceState() { 13807 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13808 return BaseSavedState.EMPTY_STATE; 13809 } 13810 13811 /** 13812 * Restore this view hierarchy's frozen state from the given container. 13813 * 13814 * @param container The SparseArray which holds previously frozen states. 13815 * 13816 * @see #saveHierarchyState(android.util.SparseArray) 13817 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13818 * @see #onRestoreInstanceState(android.os.Parcelable) 13819 */ 13820 public void restoreHierarchyState(SparseArray<Parcelable> container) { 13821 dispatchRestoreInstanceState(container); 13822 } 13823 13824 /** 13825 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 13826 * state for this view and its children. May be overridden to modify how restoring 13827 * happens to a view's children; for example, some views may want to not store state 13828 * for their children. 13829 * 13830 * @param container The SparseArray which holds previously saved state. 13831 * 13832 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13833 * @see #restoreHierarchyState(android.util.SparseArray) 13834 * @see #onRestoreInstanceState(android.os.Parcelable) 13835 */ 13836 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 13837 if (mID != NO_ID) { 13838 Parcelable state = container.get(mID); 13839 if (state != null) { 13840 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 13841 // + ": " + state); 13842 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13843 onRestoreInstanceState(state); 13844 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13845 throw new IllegalStateException( 13846 "Derived class did not call super.onRestoreInstanceState()"); 13847 } 13848 } 13849 } 13850 } 13851 13852 /** 13853 * Hook allowing a view to re-apply a representation of its internal state that had previously 13854 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 13855 * null state. 13856 * 13857 * @param state The frozen state that had previously been returned by 13858 * {@link #onSaveInstanceState}. 13859 * 13860 * @see #onSaveInstanceState() 13861 * @see #restoreHierarchyState(android.util.SparseArray) 13862 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13863 */ 13864 protected void onRestoreInstanceState(Parcelable state) { 13865 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13866 if (state != BaseSavedState.EMPTY_STATE && state != null) { 13867 throw new IllegalArgumentException("Wrong state class, expecting View State but " 13868 + "received " + state.getClass().toString() + " instead. This usually happens " 13869 + "when two views of different type have the same id in the same hierarchy. " 13870 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 13871 + "other views do not use the same id."); 13872 } 13873 } 13874 13875 /** 13876 * <p>Return the time at which the drawing of the view hierarchy started.</p> 13877 * 13878 * @return the drawing start time in milliseconds 13879 */ 13880 public long getDrawingTime() { 13881 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 13882 } 13883 13884 /** 13885 * <p>Enables or disables the duplication of the parent's state into this view. When 13886 * duplication is enabled, this view gets its drawable state from its parent rather 13887 * than from its own internal properties.</p> 13888 * 13889 * <p>Note: in the current implementation, setting this property to true after the 13890 * view was added to a ViewGroup might have no effect at all. This property should 13891 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 13892 * 13893 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 13894 * property is enabled, an exception will be thrown.</p> 13895 * 13896 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 13897 * parent, these states should not be affected by this method.</p> 13898 * 13899 * @param enabled True to enable duplication of the parent's drawable state, false 13900 * to disable it. 13901 * 13902 * @see #getDrawableState() 13903 * @see #isDuplicateParentStateEnabled() 13904 */ 13905 public void setDuplicateParentStateEnabled(boolean enabled) { 13906 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 13907 } 13908 13909 /** 13910 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 13911 * 13912 * @return True if this view's drawable state is duplicated from the parent, 13913 * false otherwise 13914 * 13915 * @see #getDrawableState() 13916 * @see #setDuplicateParentStateEnabled(boolean) 13917 */ 13918 public boolean isDuplicateParentStateEnabled() { 13919 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 13920 } 13921 13922 /** 13923 * <p>Specifies the type of layer backing this view. The layer can be 13924 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13925 * {@link #LAYER_TYPE_HARDWARE}.</p> 13926 * 13927 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13928 * instance that controls how the layer is composed on screen. The following 13929 * properties of the paint are taken into account when composing the layer:</p> 13930 * <ul> 13931 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13932 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13933 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13934 * </ul> 13935 * 13936 * <p>If this view has an alpha value set to < 1.0 by calling 13937 * {@link #setAlpha(float)}, the alpha value of the layer's paint is superceded 13938 * by this view's alpha value.</p> 13939 * 13940 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE}, 13941 * {@link #LAYER_TYPE_SOFTWARE} and {@link #LAYER_TYPE_HARDWARE} 13942 * for more information on when and how to use layers.</p> 13943 * 13944 * @param layerType The type of layer to use with this view, must be one of 13945 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13946 * {@link #LAYER_TYPE_HARDWARE} 13947 * @param paint The paint used to compose the layer. This argument is optional 13948 * and can be null. It is ignored when the layer type is 13949 * {@link #LAYER_TYPE_NONE} 13950 * 13951 * @see #getLayerType() 13952 * @see #LAYER_TYPE_NONE 13953 * @see #LAYER_TYPE_SOFTWARE 13954 * @see #LAYER_TYPE_HARDWARE 13955 * @see #setAlpha(float) 13956 * 13957 * @attr ref android.R.styleable#View_layerType 13958 */ 13959 public void setLayerType(int layerType, Paint paint) { 13960 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 13961 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 13962 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 13963 } 13964 13965 boolean typeChanged = mRenderNode.setLayerType(layerType); 13966 13967 if (!typeChanged) { 13968 setLayerPaint(paint); 13969 return; 13970 } 13971 13972 // Destroy any previous software drawing cache if needed 13973 if (mLayerType == LAYER_TYPE_SOFTWARE) { 13974 destroyDrawingCache(); 13975 } 13976 13977 mLayerType = layerType; 13978 final boolean layerDisabled = (mLayerType == LAYER_TYPE_NONE); 13979 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 13980 mRenderNode.setLayerPaint(mLayerPaint); 13981 13982 // draw() behaves differently if we are on a layer, so we need to 13983 // invalidate() here 13984 invalidateParentCaches(); 13985 invalidate(true); 13986 } 13987 13988 /** 13989 * Updates the {@link Paint} object used with the current layer (used only if the current 13990 * layer type is not set to {@link #LAYER_TYPE_NONE}). Changed properties of the Paint 13991 * provided to {@link #setLayerType(int, android.graphics.Paint)} will be used the next time 13992 * the View is redrawn, but {@link #setLayerPaint(android.graphics.Paint)} must be called to 13993 * ensure that the view gets redrawn immediately. 13994 * 13995 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13996 * instance that controls how the layer is composed on screen. The following 13997 * properties of the paint are taken into account when composing the layer:</p> 13998 * <ul> 13999 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 14000 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 14001 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 14002 * </ul> 14003 * 14004 * <p>If this view has an alpha value set to < 1.0 by calling {@link #setAlpha(float)}, the 14005 * alpha value of the layer's paint is superceded by this view's alpha value.</p> 14006 * 14007 * @param paint The paint used to compose the layer. This argument is optional 14008 * and can be null. It is ignored when the layer type is 14009 * {@link #LAYER_TYPE_NONE} 14010 * 14011 * @see #setLayerType(int, android.graphics.Paint) 14012 */ 14013 public void setLayerPaint(Paint paint) { 14014 int layerType = getLayerType(); 14015 if (layerType != LAYER_TYPE_NONE) { 14016 mLayerPaint = paint == null ? new Paint() : paint; 14017 if (layerType == LAYER_TYPE_HARDWARE) { 14018 if (mRenderNode.setLayerPaint(mLayerPaint)) { 14019 invalidateViewProperty(false, false); 14020 } 14021 } else { 14022 invalidate(); 14023 } 14024 } 14025 } 14026 14027 /** 14028 * Indicates whether this view has a static layer. A view with layer type 14029 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 14030 * dynamic. 14031 */ 14032 boolean hasStaticLayer() { 14033 return true; 14034 } 14035 14036 /** 14037 * Indicates what type of layer is currently associated with this view. By default 14038 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 14039 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 14040 * for more information on the different types of layers. 14041 * 14042 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 14043 * {@link #LAYER_TYPE_HARDWARE} 14044 * 14045 * @see #setLayerType(int, android.graphics.Paint) 14046 * @see #buildLayer() 14047 * @see #LAYER_TYPE_NONE 14048 * @see #LAYER_TYPE_SOFTWARE 14049 * @see #LAYER_TYPE_HARDWARE 14050 */ 14051 public int getLayerType() { 14052 return mLayerType; 14053 } 14054 14055 /** 14056 * Forces this view's layer to be created and this view to be rendered 14057 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 14058 * invoking this method will have no effect. 14059 * 14060 * This method can for instance be used to render a view into its layer before 14061 * starting an animation. If this view is complex, rendering into the layer 14062 * before starting the animation will avoid skipping frames. 14063 * 14064 * @throws IllegalStateException If this view is not attached to a window 14065 * 14066 * @see #setLayerType(int, android.graphics.Paint) 14067 */ 14068 public void buildLayer() { 14069 if (mLayerType == LAYER_TYPE_NONE) return; 14070 14071 final AttachInfo attachInfo = mAttachInfo; 14072 if (attachInfo == null) { 14073 throw new IllegalStateException("This view must be attached to a window first"); 14074 } 14075 14076 if (getWidth() == 0 || getHeight() == 0) { 14077 return; 14078 } 14079 14080 switch (mLayerType) { 14081 case LAYER_TYPE_HARDWARE: 14082 updateDisplayListIfDirty(); 14083 if (attachInfo.mHardwareRenderer != null && mRenderNode.isValid()) { 14084 attachInfo.mHardwareRenderer.buildLayer(mRenderNode); 14085 } 14086 break; 14087 case LAYER_TYPE_SOFTWARE: 14088 buildDrawingCache(true); 14089 break; 14090 } 14091 } 14092 14093 /** 14094 * If this View draws with a HardwareLayer, returns it. 14095 * Otherwise returns null 14096 * 14097 * TODO: Only TextureView uses this, can we eliminate it? 14098 */ 14099 HardwareLayer getHardwareLayer() { 14100 return null; 14101 } 14102 14103 /** 14104 * Destroys all hardware rendering resources. This method is invoked 14105 * when the system needs to reclaim resources. Upon execution of this 14106 * method, you should free any OpenGL resources created by the view. 14107 * 14108 * Note: you <strong>must</strong> call 14109 * <code>super.destroyHardwareResources()</code> when overriding 14110 * this method. 14111 * 14112 * @hide 14113 */ 14114 protected void destroyHardwareResources() { 14115 // Although the Layer will be destroyed by RenderNode, we want to release 14116 // the staging display list, which is also a signal to RenderNode that it's 14117 // safe to free its copy of the display list as it knows that we will 14118 // push an updated DisplayList if we try to draw again 14119 resetDisplayList(); 14120 } 14121 14122 /** 14123 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 14124 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 14125 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 14126 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 14127 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 14128 * null.</p> 14129 * 14130 * <p>Enabling the drawing cache is similar to 14131 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 14132 * acceleration is turned off. When hardware acceleration is turned on, enabling the 14133 * drawing cache has no effect on rendering because the system uses a different mechanism 14134 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 14135 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 14136 * for information on how to enable software and hardware layers.</p> 14137 * 14138 * <p>This API can be used to manually generate 14139 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 14140 * {@link #getDrawingCache()}.</p> 14141 * 14142 * @param enabled true to enable the drawing cache, false otherwise 14143 * 14144 * @see #isDrawingCacheEnabled() 14145 * @see #getDrawingCache() 14146 * @see #buildDrawingCache() 14147 * @see #setLayerType(int, android.graphics.Paint) 14148 */ 14149 public void setDrawingCacheEnabled(boolean enabled) { 14150 mCachingFailed = false; 14151 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 14152 } 14153 14154 /** 14155 * <p>Indicates whether the drawing cache is enabled for this view.</p> 14156 * 14157 * @return true if the drawing cache is enabled 14158 * 14159 * @see #setDrawingCacheEnabled(boolean) 14160 * @see #getDrawingCache() 14161 */ 14162 @ViewDebug.ExportedProperty(category = "drawing") 14163 public boolean isDrawingCacheEnabled() { 14164 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 14165 } 14166 14167 /** 14168 * Debugging utility which recursively outputs the dirty state of a view and its 14169 * descendants. 14170 * 14171 * @hide 14172 */ 14173 @SuppressWarnings({"UnusedDeclaration"}) 14174 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 14175 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.PFLAG_DIRTY_MASK) + 14176 ") DRAWN(" + (mPrivateFlags & PFLAG_DRAWN) + ")" + " CACHE_VALID(" + 14177 (mPrivateFlags & View.PFLAG_DRAWING_CACHE_VALID) + 14178 ") INVALIDATED(" + (mPrivateFlags & PFLAG_INVALIDATED) + ")"); 14179 if (clear) { 14180 mPrivateFlags &= clearMask; 14181 } 14182 if (this instanceof ViewGroup) { 14183 ViewGroup parent = (ViewGroup) this; 14184 final int count = parent.getChildCount(); 14185 for (int i = 0; i < count; i++) { 14186 final View child = parent.getChildAt(i); 14187 child.outputDirtyFlags(indent + " ", clear, clearMask); 14188 } 14189 } 14190 } 14191 14192 /** 14193 * This method is used by ViewGroup to cause its children to restore or recreate their 14194 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 14195 * to recreate its own display list, which would happen if it went through the normal 14196 * draw/dispatchDraw mechanisms. 14197 * 14198 * @hide 14199 */ 14200 protected void dispatchGetDisplayList() {} 14201 14202 /** 14203 * A view that is not attached or hardware accelerated cannot create a display list. 14204 * This method checks these conditions and returns the appropriate result. 14205 * 14206 * @return true if view has the ability to create a display list, false otherwise. 14207 * 14208 * @hide 14209 */ 14210 public boolean canHaveDisplayList() { 14211 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 14212 } 14213 14214 private void updateDisplayListIfDirty() { 14215 final RenderNode renderNode = mRenderNode; 14216 if (!canHaveDisplayList()) { 14217 // can't populate RenderNode, don't try 14218 return; 14219 } 14220 14221 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 14222 || !renderNode.isValid() 14223 || (mRecreateDisplayList)) { 14224 // Don't need to recreate the display list, just need to tell our 14225 // children to restore/recreate theirs 14226 if (renderNode.isValid() 14227 && !mRecreateDisplayList) { 14228 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14229 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14230 dispatchGetDisplayList(); 14231 14232 return; // no work needed 14233 } 14234 14235 // If we got here, we're recreating it. Mark it as such to ensure that 14236 // we copy in child display lists into ours in drawChild() 14237 mRecreateDisplayList = true; 14238 14239 int width = mRight - mLeft; 14240 int height = mBottom - mTop; 14241 int layerType = getLayerType(); 14242 14243 final HardwareCanvas canvas = renderNode.start(width, height); 14244 canvas.setHighContrastText(mAttachInfo.mHighContrastText); 14245 14246 try { 14247 final HardwareLayer layer = getHardwareLayer(); 14248 if (layer != null && layer.isValid()) { 14249 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint); 14250 } else if (layerType == LAYER_TYPE_SOFTWARE) { 14251 buildDrawingCache(true); 14252 Bitmap cache = getDrawingCache(true); 14253 if (cache != null) { 14254 canvas.drawBitmap(cache, 0, 0, mLayerPaint); 14255 } 14256 } else { 14257 computeScroll(); 14258 14259 canvas.translate(-mScrollX, -mScrollY); 14260 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14261 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14262 14263 // Fast path for layouts with no backgrounds 14264 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14265 dispatchDraw(canvas); 14266 if (mOverlay != null && !mOverlay.isEmpty()) { 14267 mOverlay.getOverlayView().draw(canvas); 14268 } 14269 } else { 14270 draw(canvas); 14271 } 14272 } 14273 } finally { 14274 renderNode.end(canvas); 14275 setDisplayListProperties(renderNode); 14276 } 14277 } else { 14278 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14279 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14280 } 14281 } 14282 14283 /** 14284 * Returns a RenderNode with View draw content recorded, which can be 14285 * used to draw this view again without executing its draw method. 14286 * 14287 * @return A RenderNode ready to replay, or null if caching is not enabled. 14288 * 14289 * @hide 14290 */ 14291 public RenderNode getDisplayList() { 14292 updateDisplayListIfDirty(); 14293 return mRenderNode; 14294 } 14295 14296 private void resetDisplayList() { 14297 if (mRenderNode.isValid()) { 14298 mRenderNode.destroyDisplayListData(); 14299 } 14300 14301 if (mBackgroundRenderNode != null && mBackgroundRenderNode.isValid()) { 14302 mBackgroundRenderNode.destroyDisplayListData(); 14303 } 14304 } 14305 14306 /** 14307 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 14308 * 14309 * @return A non-scaled bitmap representing this view or null if cache is disabled. 14310 * 14311 * @see #getDrawingCache(boolean) 14312 */ 14313 public Bitmap getDrawingCache() { 14314 return getDrawingCache(false); 14315 } 14316 14317 /** 14318 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 14319 * is null when caching is disabled. If caching is enabled and the cache is not ready, 14320 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 14321 * draw from the cache when the cache is enabled. To benefit from the cache, you must 14322 * request the drawing cache by calling this method and draw it on screen if the 14323 * returned bitmap is not null.</p> 14324 * 14325 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14326 * this method will create a bitmap of the same size as this view. Because this bitmap 14327 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14328 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14329 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14330 * size than the view. This implies that your application must be able to handle this 14331 * size.</p> 14332 * 14333 * @param autoScale Indicates whether the generated bitmap should be scaled based on 14334 * the current density of the screen when the application is in compatibility 14335 * mode. 14336 * 14337 * @return A bitmap representing this view or null if cache is disabled. 14338 * 14339 * @see #setDrawingCacheEnabled(boolean) 14340 * @see #isDrawingCacheEnabled() 14341 * @see #buildDrawingCache(boolean) 14342 * @see #destroyDrawingCache() 14343 */ 14344 public Bitmap getDrawingCache(boolean autoScale) { 14345 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 14346 return null; 14347 } 14348 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 14349 buildDrawingCache(autoScale); 14350 } 14351 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 14352 } 14353 14354 /** 14355 * <p>Frees the resources used by the drawing cache. If you call 14356 * {@link #buildDrawingCache()} manually without calling 14357 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14358 * should cleanup the cache with this method afterwards.</p> 14359 * 14360 * @see #setDrawingCacheEnabled(boolean) 14361 * @see #buildDrawingCache() 14362 * @see #getDrawingCache() 14363 */ 14364 public void destroyDrawingCache() { 14365 if (mDrawingCache != null) { 14366 mDrawingCache.recycle(); 14367 mDrawingCache = null; 14368 } 14369 if (mUnscaledDrawingCache != null) { 14370 mUnscaledDrawingCache.recycle(); 14371 mUnscaledDrawingCache = null; 14372 } 14373 } 14374 14375 /** 14376 * Setting a solid background color for the drawing cache's bitmaps will improve 14377 * performance and memory usage. Note, though that this should only be used if this 14378 * view will always be drawn on top of a solid color. 14379 * 14380 * @param color The background color to use for the drawing cache's bitmap 14381 * 14382 * @see #setDrawingCacheEnabled(boolean) 14383 * @see #buildDrawingCache() 14384 * @see #getDrawingCache() 14385 */ 14386 public void setDrawingCacheBackgroundColor(int color) { 14387 if (color != mDrawingCacheBackgroundColor) { 14388 mDrawingCacheBackgroundColor = color; 14389 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 14390 } 14391 } 14392 14393 /** 14394 * @see #setDrawingCacheBackgroundColor(int) 14395 * 14396 * @return The background color to used for the drawing cache's bitmap 14397 */ 14398 public int getDrawingCacheBackgroundColor() { 14399 return mDrawingCacheBackgroundColor; 14400 } 14401 14402 /** 14403 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 14404 * 14405 * @see #buildDrawingCache(boolean) 14406 */ 14407 public void buildDrawingCache() { 14408 buildDrawingCache(false); 14409 } 14410 14411 /** 14412 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 14413 * 14414 * <p>If you call {@link #buildDrawingCache()} manually without calling 14415 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14416 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 14417 * 14418 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14419 * this method will create a bitmap of the same size as this view. Because this bitmap 14420 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14421 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14422 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14423 * size than the view. This implies that your application must be able to handle this 14424 * size.</p> 14425 * 14426 * <p>You should avoid calling this method when hardware acceleration is enabled. If 14427 * you do not need the drawing cache bitmap, calling this method will increase memory 14428 * usage and cause the view to be rendered in software once, thus negatively impacting 14429 * performance.</p> 14430 * 14431 * @see #getDrawingCache() 14432 * @see #destroyDrawingCache() 14433 */ 14434 public void buildDrawingCache(boolean autoScale) { 14435 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || (autoScale ? 14436 mDrawingCache == null : mUnscaledDrawingCache == null)) { 14437 if (Trace.isTagEnabled(Trace.TRACE_TAG_VIEW)) { 14438 Trace.traceBegin(Trace.TRACE_TAG_VIEW, 14439 "buildDrawingCache/SW Layer for " + getClass().getSimpleName()); 14440 } 14441 try { 14442 buildDrawingCacheImpl(autoScale); 14443 } finally { 14444 Trace.traceEnd(Trace.TRACE_TAG_VIEW); 14445 } 14446 } 14447 } 14448 14449 /** 14450 * private, internal implementation of buildDrawingCache, used to enable tracing 14451 */ 14452 private void buildDrawingCacheImpl(boolean autoScale) { 14453 mCachingFailed = false; 14454 14455 int width = mRight - mLeft; 14456 int height = mBottom - mTop; 14457 14458 final AttachInfo attachInfo = mAttachInfo; 14459 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 14460 14461 if (autoScale && scalingRequired) { 14462 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 14463 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 14464 } 14465 14466 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 14467 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 14468 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 14469 14470 final long projectedBitmapSize = width * height * (opaque && !use32BitCache ? 2 : 4); 14471 final long drawingCacheSize = 14472 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize(); 14473 if (width <= 0 || height <= 0 || projectedBitmapSize > drawingCacheSize) { 14474 if (width > 0 && height > 0) { 14475 Log.w(VIEW_LOG_TAG, "View too large to fit into drawing cache, needs " 14476 + projectedBitmapSize + " bytes, only " 14477 + drawingCacheSize + " available"); 14478 } 14479 destroyDrawingCache(); 14480 mCachingFailed = true; 14481 return; 14482 } 14483 14484 boolean clear = true; 14485 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 14486 14487 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 14488 Bitmap.Config quality; 14489 if (!opaque) { 14490 // Never pick ARGB_4444 because it looks awful 14491 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 14492 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 14493 case DRAWING_CACHE_QUALITY_AUTO: 14494 case DRAWING_CACHE_QUALITY_LOW: 14495 case DRAWING_CACHE_QUALITY_HIGH: 14496 default: 14497 quality = Bitmap.Config.ARGB_8888; 14498 break; 14499 } 14500 } else { 14501 // Optimization for translucent windows 14502 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 14503 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 14504 } 14505 14506 // Try to cleanup memory 14507 if (bitmap != null) bitmap.recycle(); 14508 14509 try { 14510 bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14511 width, height, quality); 14512 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 14513 if (autoScale) { 14514 mDrawingCache = bitmap; 14515 } else { 14516 mUnscaledDrawingCache = bitmap; 14517 } 14518 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 14519 } catch (OutOfMemoryError e) { 14520 // If there is not enough memory to create the bitmap cache, just 14521 // ignore the issue as bitmap caches are not required to draw the 14522 // view hierarchy 14523 if (autoScale) { 14524 mDrawingCache = null; 14525 } else { 14526 mUnscaledDrawingCache = null; 14527 } 14528 mCachingFailed = true; 14529 return; 14530 } 14531 14532 clear = drawingCacheBackgroundColor != 0; 14533 } 14534 14535 Canvas canvas; 14536 if (attachInfo != null) { 14537 canvas = attachInfo.mCanvas; 14538 if (canvas == null) { 14539 canvas = new Canvas(); 14540 } 14541 canvas.setBitmap(bitmap); 14542 // Temporarily clobber the cached Canvas in case one of our children 14543 // is also using a drawing cache. Without this, the children would 14544 // steal the canvas by attaching their own bitmap to it and bad, bad 14545 // thing would happen (invisible views, corrupted drawings, etc.) 14546 attachInfo.mCanvas = null; 14547 } else { 14548 // This case should hopefully never or seldom happen 14549 canvas = new Canvas(bitmap); 14550 } 14551 14552 if (clear) { 14553 bitmap.eraseColor(drawingCacheBackgroundColor); 14554 } 14555 14556 computeScroll(); 14557 final int restoreCount = canvas.save(); 14558 14559 if (autoScale && scalingRequired) { 14560 final float scale = attachInfo.mApplicationScale; 14561 canvas.scale(scale, scale); 14562 } 14563 14564 canvas.translate(-mScrollX, -mScrollY); 14565 14566 mPrivateFlags |= PFLAG_DRAWN; 14567 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 14568 mLayerType != LAYER_TYPE_NONE) { 14569 mPrivateFlags |= PFLAG_DRAWING_CACHE_VALID; 14570 } 14571 14572 // Fast path for layouts with no backgrounds 14573 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14574 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14575 dispatchDraw(canvas); 14576 if (mOverlay != null && !mOverlay.isEmpty()) { 14577 mOverlay.getOverlayView().draw(canvas); 14578 } 14579 } else { 14580 draw(canvas); 14581 } 14582 14583 canvas.restoreToCount(restoreCount); 14584 canvas.setBitmap(null); 14585 14586 if (attachInfo != null) { 14587 // Restore the cached Canvas for our siblings 14588 attachInfo.mCanvas = canvas; 14589 } 14590 } 14591 14592 /** 14593 * Create a snapshot of the view into a bitmap. We should probably make 14594 * some form of this public, but should think about the API. 14595 */ 14596 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 14597 int width = mRight - mLeft; 14598 int height = mBottom - mTop; 14599 14600 final AttachInfo attachInfo = mAttachInfo; 14601 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 14602 width = (int) ((width * scale) + 0.5f); 14603 height = (int) ((height * scale) + 0.5f); 14604 14605 Bitmap bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14606 width > 0 ? width : 1, height > 0 ? height : 1, quality); 14607 if (bitmap == null) { 14608 throw new OutOfMemoryError(); 14609 } 14610 14611 Resources resources = getResources(); 14612 if (resources != null) { 14613 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 14614 } 14615 14616 Canvas canvas; 14617 if (attachInfo != null) { 14618 canvas = attachInfo.mCanvas; 14619 if (canvas == null) { 14620 canvas = new Canvas(); 14621 } 14622 canvas.setBitmap(bitmap); 14623 // Temporarily clobber the cached Canvas in case one of our children 14624 // is also using a drawing cache. Without this, the children would 14625 // steal the canvas by attaching their own bitmap to it and bad, bad 14626 // things would happen (invisible views, corrupted drawings, etc.) 14627 attachInfo.mCanvas = null; 14628 } else { 14629 // This case should hopefully never or seldom happen 14630 canvas = new Canvas(bitmap); 14631 } 14632 14633 if ((backgroundColor & 0xff000000) != 0) { 14634 bitmap.eraseColor(backgroundColor); 14635 } 14636 14637 computeScroll(); 14638 final int restoreCount = canvas.save(); 14639 canvas.scale(scale, scale); 14640 canvas.translate(-mScrollX, -mScrollY); 14641 14642 // Temporarily remove the dirty mask 14643 int flags = mPrivateFlags; 14644 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14645 14646 // Fast path for layouts with no backgrounds 14647 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14648 dispatchDraw(canvas); 14649 if (mOverlay != null && !mOverlay.isEmpty()) { 14650 mOverlay.getOverlayView().draw(canvas); 14651 } 14652 } else { 14653 draw(canvas); 14654 } 14655 14656 mPrivateFlags = flags; 14657 14658 canvas.restoreToCount(restoreCount); 14659 canvas.setBitmap(null); 14660 14661 if (attachInfo != null) { 14662 // Restore the cached Canvas for our siblings 14663 attachInfo.mCanvas = canvas; 14664 } 14665 14666 return bitmap; 14667 } 14668 14669 /** 14670 * Indicates whether this View is currently in edit mode. A View is usually 14671 * in edit mode when displayed within a developer tool. For instance, if 14672 * this View is being drawn by a visual user interface builder, this method 14673 * should return true. 14674 * 14675 * Subclasses should check the return value of this method to provide 14676 * different behaviors if their normal behavior might interfere with the 14677 * host environment. For instance: the class spawns a thread in its 14678 * constructor, the drawing code relies on device-specific features, etc. 14679 * 14680 * This method is usually checked in the drawing code of custom widgets. 14681 * 14682 * @return True if this View is in edit mode, false otherwise. 14683 */ 14684 public boolean isInEditMode() { 14685 return false; 14686 } 14687 14688 /** 14689 * If the View draws content inside its padding and enables fading edges, 14690 * it needs to support padding offsets. Padding offsets are added to the 14691 * fading edges to extend the length of the fade so that it covers pixels 14692 * drawn inside the padding. 14693 * 14694 * Subclasses of this class should override this method if they need 14695 * to draw content inside the padding. 14696 * 14697 * @return True if padding offset must be applied, false otherwise. 14698 * 14699 * @see #getLeftPaddingOffset() 14700 * @see #getRightPaddingOffset() 14701 * @see #getTopPaddingOffset() 14702 * @see #getBottomPaddingOffset() 14703 * 14704 * @since CURRENT 14705 */ 14706 protected boolean isPaddingOffsetRequired() { 14707 return false; 14708 } 14709 14710 /** 14711 * Amount by which to extend the left fading region. Called only when 14712 * {@link #isPaddingOffsetRequired()} returns true. 14713 * 14714 * @return The left padding offset in pixels. 14715 * 14716 * @see #isPaddingOffsetRequired() 14717 * 14718 * @since CURRENT 14719 */ 14720 protected int getLeftPaddingOffset() { 14721 return 0; 14722 } 14723 14724 /** 14725 * Amount by which to extend the right fading region. Called only when 14726 * {@link #isPaddingOffsetRequired()} returns true. 14727 * 14728 * @return The right padding offset in pixels. 14729 * 14730 * @see #isPaddingOffsetRequired() 14731 * 14732 * @since CURRENT 14733 */ 14734 protected int getRightPaddingOffset() { 14735 return 0; 14736 } 14737 14738 /** 14739 * Amount by which to extend the top fading region. Called only when 14740 * {@link #isPaddingOffsetRequired()} returns true. 14741 * 14742 * @return The top padding offset in pixels. 14743 * 14744 * @see #isPaddingOffsetRequired() 14745 * 14746 * @since CURRENT 14747 */ 14748 protected int getTopPaddingOffset() { 14749 return 0; 14750 } 14751 14752 /** 14753 * Amount by which to extend the bottom fading region. Called only when 14754 * {@link #isPaddingOffsetRequired()} returns true. 14755 * 14756 * @return The bottom padding offset in pixels. 14757 * 14758 * @see #isPaddingOffsetRequired() 14759 * 14760 * @since CURRENT 14761 */ 14762 protected int getBottomPaddingOffset() { 14763 return 0; 14764 } 14765 14766 /** 14767 * @hide 14768 * @param offsetRequired 14769 */ 14770 protected int getFadeTop(boolean offsetRequired) { 14771 int top = mPaddingTop; 14772 if (offsetRequired) top += getTopPaddingOffset(); 14773 return top; 14774 } 14775 14776 /** 14777 * @hide 14778 * @param offsetRequired 14779 */ 14780 protected int getFadeHeight(boolean offsetRequired) { 14781 int padding = mPaddingTop; 14782 if (offsetRequired) padding += getTopPaddingOffset(); 14783 return mBottom - mTop - mPaddingBottom - padding; 14784 } 14785 14786 /** 14787 * <p>Indicates whether this view is attached to a hardware accelerated 14788 * window or not.</p> 14789 * 14790 * <p>Even if this method returns true, it does not mean that every call 14791 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 14792 * accelerated {@link android.graphics.Canvas}. For instance, if this view 14793 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its 14794 * window is hardware accelerated, 14795 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 14796 * return false, and this method will return true.</p> 14797 * 14798 * @return True if the view is attached to a window and the window is 14799 * hardware accelerated; false in any other case. 14800 */ 14801 @ViewDebug.ExportedProperty(category = "drawing") 14802 public boolean isHardwareAccelerated() { 14803 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14804 } 14805 14806 /** 14807 * Sets a rectangular area on this view to which the view will be clipped 14808 * when it is drawn. Setting the value to null will remove the clip bounds 14809 * and the view will draw normally, using its full bounds. 14810 * 14811 * @param clipBounds The rectangular area, in the local coordinates of 14812 * this view, to which future drawing operations will be clipped. 14813 */ 14814 public void setClipBounds(Rect clipBounds) { 14815 if (clipBounds == mClipBounds 14816 || (clipBounds != null && clipBounds.equals(mClipBounds))) { 14817 return; 14818 } 14819 if (clipBounds != null) { 14820 if (mClipBounds == null) { 14821 mClipBounds = new Rect(clipBounds); 14822 } else { 14823 mClipBounds.set(clipBounds); 14824 } 14825 } else { 14826 mClipBounds = null; 14827 } 14828 mRenderNode.setClipBounds(mClipBounds); 14829 invalidateViewProperty(false, false); 14830 } 14831 14832 /** 14833 * Returns a copy of the current {@link #setClipBounds(Rect) clipBounds}. 14834 * 14835 * @return A copy of the current clip bounds if clip bounds are set, 14836 * otherwise null. 14837 */ 14838 public Rect getClipBounds() { 14839 return (mClipBounds != null) ? new Rect(mClipBounds) : null; 14840 } 14841 14842 /** 14843 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common 14844 * case of an active Animation being run on the view. 14845 */ 14846 private boolean drawAnimation(ViewGroup parent, long drawingTime, 14847 Animation a, boolean scalingRequired) { 14848 Transformation invalidationTransform; 14849 final int flags = parent.mGroupFlags; 14850 final boolean initialized = a.isInitialized(); 14851 if (!initialized) { 14852 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight()); 14853 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop); 14854 if (mAttachInfo != null) a.setListenerHandler(mAttachInfo.mHandler); 14855 onAnimationStart(); 14856 } 14857 14858 final Transformation t = parent.getChildTransformation(); 14859 boolean more = a.getTransformation(drawingTime, t, 1f); 14860 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) { 14861 if (parent.mInvalidationTransformation == null) { 14862 parent.mInvalidationTransformation = new Transformation(); 14863 } 14864 invalidationTransform = parent.mInvalidationTransformation; 14865 a.getTransformation(drawingTime, invalidationTransform, 1f); 14866 } else { 14867 invalidationTransform = t; 14868 } 14869 14870 if (more) { 14871 if (!a.willChangeBounds()) { 14872 if ((flags & (ViewGroup.FLAG_OPTIMIZE_INVALIDATE | ViewGroup.FLAG_ANIMATION_DONE)) == 14873 ViewGroup.FLAG_OPTIMIZE_INVALIDATE) { 14874 parent.mGroupFlags |= ViewGroup.FLAG_INVALIDATE_REQUIRED; 14875 } else if ((flags & ViewGroup.FLAG_INVALIDATE_REQUIRED) == 0) { 14876 // The child need to draw an animation, potentially offscreen, so 14877 // make sure we do not cancel invalidate requests 14878 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14879 parent.invalidate(mLeft, mTop, mRight, mBottom); 14880 } 14881 } else { 14882 if (parent.mInvalidateRegion == null) { 14883 parent.mInvalidateRegion = new RectF(); 14884 } 14885 final RectF region = parent.mInvalidateRegion; 14886 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region, 14887 invalidationTransform); 14888 14889 // The child need to draw an animation, potentially offscreen, so 14890 // make sure we do not cancel invalidate requests 14891 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14892 14893 final int left = mLeft + (int) region.left; 14894 final int top = mTop + (int) region.top; 14895 parent.invalidate(left, top, left + (int) (region.width() + .5f), 14896 top + (int) (region.height() + .5f)); 14897 } 14898 } 14899 return more; 14900 } 14901 14902 /** 14903 * This method is called by getDisplayList() when a display list is recorded for a View. 14904 * It pushes any properties to the RenderNode that aren't managed by the RenderNode. 14905 */ 14906 void setDisplayListProperties(RenderNode renderNode) { 14907 if (renderNode != null) { 14908 renderNode.setHasOverlappingRendering(hasOverlappingRendering()); 14909 if (mParent instanceof ViewGroup) { 14910 renderNode.setClipToBounds( 14911 (((ViewGroup) mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0); 14912 } 14913 float alpha = 1; 14914 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags & 14915 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14916 ViewGroup parentVG = (ViewGroup) mParent; 14917 final Transformation t = parentVG.getChildTransformation(); 14918 if (parentVG.getChildStaticTransformation(this, t)) { 14919 final int transformType = t.getTransformationType(); 14920 if (transformType != Transformation.TYPE_IDENTITY) { 14921 if ((transformType & Transformation.TYPE_ALPHA) != 0) { 14922 alpha = t.getAlpha(); 14923 } 14924 if ((transformType & Transformation.TYPE_MATRIX) != 0) { 14925 renderNode.setStaticMatrix(t.getMatrix()); 14926 } 14927 } 14928 } 14929 } 14930 if (mTransformationInfo != null) { 14931 alpha *= getFinalAlpha(); 14932 if (alpha < 1) { 14933 final int multipliedAlpha = (int) (255 * alpha); 14934 if (onSetAlpha(multipliedAlpha)) { 14935 alpha = 1; 14936 } 14937 } 14938 renderNode.setAlpha(alpha); 14939 } else if (alpha < 1) { 14940 renderNode.setAlpha(alpha); 14941 } 14942 } 14943 } 14944 14945 /** 14946 * This method is called by ViewGroup.drawChild() to have each child view draw itself. 14947 * This draw() method is an implementation detail and is not intended to be overridden or 14948 * to be called from anywhere else other than ViewGroup.drawChild(). 14949 */ 14950 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) { 14951 boolean usingRenderNodeProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14952 boolean more = false; 14953 final boolean childHasIdentityMatrix = hasIdentityMatrix(); 14954 final int flags = parent.mGroupFlags; 14955 14956 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) { 14957 parent.getChildTransformation().clear(); 14958 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION; 14959 } 14960 14961 Transformation transformToApply = null; 14962 boolean concatMatrix = false; 14963 14964 boolean scalingRequired = false; 14965 boolean caching; 14966 int layerType = getLayerType(); 14967 14968 final boolean hardwareAccelerated = canvas.isHardwareAccelerated(); 14969 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 || 14970 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) { 14971 caching = true; 14972 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList 14973 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired; 14974 } else { 14975 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated; 14976 } 14977 14978 final Animation a = getAnimation(); 14979 if (a != null) { 14980 more = drawAnimation(parent, drawingTime, a, scalingRequired); 14981 concatMatrix = a.willChangeTransformationMatrix(); 14982 if (concatMatrix) { 14983 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14984 } 14985 transformToApply = parent.getChildTransformation(); 14986 } else { 14987 if ((mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_TRANSFORM) != 0) { 14988 // No longer animating: clear out old animation matrix 14989 mRenderNode.setAnimationMatrix(null); 14990 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14991 } 14992 if (!usingRenderNodeProperties && 14993 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14994 final Transformation t = parent.getChildTransformation(); 14995 final boolean hasTransform = parent.getChildStaticTransformation(this, t); 14996 if (hasTransform) { 14997 final int transformType = t.getTransformationType(); 14998 transformToApply = transformType != Transformation.TYPE_IDENTITY ? t : null; 14999 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0; 15000 } 15001 } 15002 } 15003 15004 concatMatrix |= !childHasIdentityMatrix; 15005 15006 // Sets the flag as early as possible to allow draw() implementations 15007 // to call invalidate() successfully when doing animations 15008 mPrivateFlags |= PFLAG_DRAWN; 15009 15010 if (!concatMatrix && 15011 (flags & (ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS | 15012 ViewGroup.FLAG_CLIP_CHILDREN)) == ViewGroup.FLAG_CLIP_CHILDREN && 15013 canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) && 15014 (mPrivateFlags & PFLAG_DRAW_ANIMATION) == 0) { 15015 mPrivateFlags2 |= PFLAG2_VIEW_QUICK_REJECTED; 15016 return more; 15017 } 15018 mPrivateFlags2 &= ~PFLAG2_VIEW_QUICK_REJECTED; 15019 15020 if (hardwareAccelerated) { 15021 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but 15022 // retain the flag's value temporarily in the mRecreateDisplayList flag 15023 mRecreateDisplayList = (mPrivateFlags & PFLAG_INVALIDATED) == PFLAG_INVALIDATED; 15024 mPrivateFlags &= ~PFLAG_INVALIDATED; 15025 } 15026 15027 RenderNode renderNode = null; 15028 Bitmap cache = null; 15029 boolean hasDisplayList = false; 15030 if (caching) { 15031 if (!hardwareAccelerated) { 15032 if (layerType != LAYER_TYPE_NONE) { 15033 layerType = LAYER_TYPE_SOFTWARE; 15034 buildDrawingCache(true); 15035 } 15036 cache = getDrawingCache(true); 15037 } else { 15038 switch (layerType) { 15039 case LAYER_TYPE_SOFTWARE: 15040 if (usingRenderNodeProperties) { 15041 hasDisplayList = canHaveDisplayList(); 15042 } else { 15043 buildDrawingCache(true); 15044 cache = getDrawingCache(true); 15045 } 15046 break; 15047 case LAYER_TYPE_HARDWARE: 15048 if (usingRenderNodeProperties) { 15049 hasDisplayList = canHaveDisplayList(); 15050 } 15051 break; 15052 case LAYER_TYPE_NONE: 15053 // Delay getting the display list until animation-driven alpha values are 15054 // set up and possibly passed on to the view 15055 hasDisplayList = canHaveDisplayList(); 15056 break; 15057 } 15058 } 15059 } 15060 usingRenderNodeProperties &= hasDisplayList; 15061 if (usingRenderNodeProperties) { 15062 renderNode = getDisplayList(); 15063 if (!renderNode.isValid()) { 15064 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15065 // to getDisplayList(), the display list will be marked invalid and we should not 15066 // try to use it again. 15067 renderNode = null; 15068 hasDisplayList = false; 15069 usingRenderNodeProperties = false; 15070 } 15071 } 15072 15073 int sx = 0; 15074 int sy = 0; 15075 if (!hasDisplayList) { 15076 computeScroll(); 15077 sx = mScrollX; 15078 sy = mScrollY; 15079 } 15080 15081 final boolean hasNoCache = cache == null || hasDisplayList; 15082 final boolean offsetForScroll = cache == null && !hasDisplayList && 15083 layerType != LAYER_TYPE_HARDWARE; 15084 15085 int restoreTo = -1; 15086 if (!usingRenderNodeProperties || transformToApply != null) { 15087 restoreTo = canvas.save(); 15088 } 15089 if (offsetForScroll) { 15090 canvas.translate(mLeft - sx, mTop - sy); 15091 } else { 15092 if (!usingRenderNodeProperties) { 15093 canvas.translate(mLeft, mTop); 15094 } 15095 if (scalingRequired) { 15096 if (usingRenderNodeProperties) { 15097 // TODO: Might not need this if we put everything inside the DL 15098 restoreTo = canvas.save(); 15099 } 15100 // mAttachInfo cannot be null, otherwise scalingRequired == false 15101 final float scale = 1.0f / mAttachInfo.mApplicationScale; 15102 canvas.scale(scale, scale); 15103 } 15104 } 15105 15106 float alpha = usingRenderNodeProperties ? 1 : (getAlpha() * getTransitionAlpha()); 15107 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix() || 15108 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15109 if (transformToApply != null || !childHasIdentityMatrix) { 15110 int transX = 0; 15111 int transY = 0; 15112 15113 if (offsetForScroll) { 15114 transX = -sx; 15115 transY = -sy; 15116 } 15117 15118 if (transformToApply != null) { 15119 if (concatMatrix) { 15120 if (usingRenderNodeProperties) { 15121 renderNode.setAnimationMatrix(transformToApply.getMatrix()); 15122 } else { 15123 // Undo the scroll translation, apply the transformation matrix, 15124 // then redo the scroll translate to get the correct result. 15125 canvas.translate(-transX, -transY); 15126 canvas.concat(transformToApply.getMatrix()); 15127 canvas.translate(transX, transY); 15128 } 15129 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15130 } 15131 15132 float transformAlpha = transformToApply.getAlpha(); 15133 if (transformAlpha < 1) { 15134 alpha *= transformAlpha; 15135 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15136 } 15137 } 15138 15139 if (!childHasIdentityMatrix && !usingRenderNodeProperties) { 15140 canvas.translate(-transX, -transY); 15141 canvas.concat(getMatrix()); 15142 canvas.translate(transX, transY); 15143 } 15144 } 15145 15146 // Deal with alpha if it is or used to be <1 15147 if (alpha < 1 || 15148 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15149 if (alpha < 1) { 15150 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15151 } else { 15152 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15153 } 15154 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15155 if (hasNoCache) { 15156 final int multipliedAlpha = (int) (255 * alpha); 15157 if (!onSetAlpha(multipliedAlpha)) { 15158 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15159 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 || 15160 layerType != LAYER_TYPE_NONE) { 15161 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG; 15162 } 15163 if (usingRenderNodeProperties) { 15164 renderNode.setAlpha(alpha * getAlpha() * getTransitionAlpha()); 15165 } else if (layerType == LAYER_TYPE_NONE) { 15166 final int scrollX = hasDisplayList ? 0 : sx; 15167 final int scrollY = hasDisplayList ? 0 : sy; 15168 canvas.saveLayerAlpha(scrollX, scrollY, 15169 scrollX + (mRight - mLeft), scrollY + (mBottom - mTop), 15170 multipliedAlpha, layerFlags); 15171 } 15172 } else { 15173 // Alpha is handled by the child directly, clobber the layer's alpha 15174 mPrivateFlags |= PFLAG_ALPHA_SET; 15175 } 15176 } 15177 } 15178 } else if ((mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15179 onSetAlpha(255); 15180 mPrivateFlags &= ~PFLAG_ALPHA_SET; 15181 } 15182 15183 if (!usingRenderNodeProperties) { 15184 // apply clips directly, since RenderNode won't do it for this draw 15185 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN 15186 && cache == null) { 15187 if (offsetForScroll) { 15188 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop)); 15189 } else { 15190 if (!scalingRequired || cache == null) { 15191 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop); 15192 } else { 15193 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight()); 15194 } 15195 } 15196 } 15197 15198 if (mClipBounds != null) { 15199 // clip bounds ignore scroll 15200 canvas.clipRect(mClipBounds); 15201 } 15202 } 15203 15204 15205 15206 if (!usingRenderNodeProperties && hasDisplayList) { 15207 renderNode = getDisplayList(); 15208 if (!renderNode.isValid()) { 15209 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15210 // to getDisplayList(), the display list will be marked invalid and we should not 15211 // try to use it again. 15212 renderNode = null; 15213 hasDisplayList = false; 15214 } 15215 } 15216 15217 if (hasNoCache) { 15218 boolean layerRendered = false; 15219 if (layerType == LAYER_TYPE_HARDWARE && !usingRenderNodeProperties) { 15220 final HardwareLayer layer = getHardwareLayer(); 15221 if (layer != null && layer.isValid()) { 15222 int restoreAlpha = mLayerPaint.getAlpha(); 15223 mLayerPaint.setAlpha((int) (alpha * 255)); 15224 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint); 15225 mLayerPaint.setAlpha(restoreAlpha); 15226 layerRendered = true; 15227 } else { 15228 final int scrollX = hasDisplayList ? 0 : sx; 15229 final int scrollY = hasDisplayList ? 0 : sy; 15230 canvas.saveLayer(scrollX, scrollY, 15231 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint, 15232 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG); 15233 } 15234 } 15235 15236 if (!layerRendered) { 15237 if (!hasDisplayList) { 15238 // Fast path for layouts with no backgrounds 15239 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 15240 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15241 dispatchDraw(canvas); 15242 } else { 15243 draw(canvas); 15244 } 15245 } else { 15246 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15247 ((HardwareCanvas) canvas).drawRenderNode(renderNode, null, flags); 15248 } 15249 } 15250 } else if (cache != null) { 15251 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15252 Paint cachePaint; 15253 int restoreAlpha = 0; 15254 15255 if (layerType == LAYER_TYPE_NONE) { 15256 cachePaint = parent.mCachePaint; 15257 if (cachePaint == null) { 15258 cachePaint = new Paint(); 15259 cachePaint.setDither(false); 15260 parent.mCachePaint = cachePaint; 15261 } 15262 } else { 15263 cachePaint = mLayerPaint; 15264 restoreAlpha = mLayerPaint.getAlpha(); 15265 } 15266 cachePaint.setAlpha((int) (alpha * 255)); 15267 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint); 15268 cachePaint.setAlpha(restoreAlpha); 15269 } 15270 15271 if (restoreTo >= 0) { 15272 canvas.restoreToCount(restoreTo); 15273 } 15274 15275 if (a != null && !more) { 15276 if (!hardwareAccelerated && !a.getFillAfter()) { 15277 onSetAlpha(255); 15278 } 15279 parent.finishAnimatingView(this, a); 15280 } 15281 15282 if (more && hardwareAccelerated) { 15283 if (a.hasAlpha() && (mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15284 // alpha animations should cause the child to recreate its display list 15285 invalidate(true); 15286 } 15287 } 15288 15289 mRecreateDisplayList = false; 15290 15291 return more; 15292 } 15293 15294 /** 15295 * Manually render this view (and all of its children) to the given Canvas. 15296 * The view must have already done a full layout before this function is 15297 * called. When implementing a view, implement 15298 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 15299 * If you do need to override this method, call the superclass version. 15300 * 15301 * @param canvas The Canvas to which the View is rendered. 15302 */ 15303 public void draw(Canvas canvas) { 15304 final int privateFlags = mPrivateFlags; 15305 final boolean dirtyOpaque = (privateFlags & PFLAG_DIRTY_MASK) == PFLAG_DIRTY_OPAQUE && 15306 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 15307 mPrivateFlags = (privateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN; 15308 15309 /* 15310 * Draw traversal performs several drawing steps which must be executed 15311 * in the appropriate order: 15312 * 15313 * 1. Draw the background 15314 * 2. If necessary, save the canvas' layers to prepare for fading 15315 * 3. Draw view's content 15316 * 4. Draw children 15317 * 5. If necessary, draw the fading edges and restore layers 15318 * 6. Draw decorations (scrollbars for instance) 15319 */ 15320 15321 // Step 1, draw the background, if needed 15322 int saveCount; 15323 15324 if (!dirtyOpaque) { 15325 drawBackground(canvas); 15326 } 15327 15328 // skip step 2 & 5 if possible (common case) 15329 final int viewFlags = mViewFlags; 15330 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 15331 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 15332 if (!verticalEdges && !horizontalEdges) { 15333 // Step 3, draw the content 15334 if (!dirtyOpaque) onDraw(canvas); 15335 15336 // Step 4, draw the children 15337 dispatchDraw(canvas); 15338 15339 // Step 6, draw decorations (scrollbars) 15340 onDrawScrollBars(canvas); 15341 15342 if (mOverlay != null && !mOverlay.isEmpty()) { 15343 mOverlay.getOverlayView().dispatchDraw(canvas); 15344 } 15345 15346 // we're done... 15347 return; 15348 } 15349 15350 /* 15351 * Here we do the full fledged routine... 15352 * (this is an uncommon case where speed matters less, 15353 * this is why we repeat some of the tests that have been 15354 * done above) 15355 */ 15356 15357 boolean drawTop = false; 15358 boolean drawBottom = false; 15359 boolean drawLeft = false; 15360 boolean drawRight = false; 15361 15362 float topFadeStrength = 0.0f; 15363 float bottomFadeStrength = 0.0f; 15364 float leftFadeStrength = 0.0f; 15365 float rightFadeStrength = 0.0f; 15366 15367 // Step 2, save the canvas' layers 15368 int paddingLeft = mPaddingLeft; 15369 15370 final boolean offsetRequired = isPaddingOffsetRequired(); 15371 if (offsetRequired) { 15372 paddingLeft += getLeftPaddingOffset(); 15373 } 15374 15375 int left = mScrollX + paddingLeft; 15376 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 15377 int top = mScrollY + getFadeTop(offsetRequired); 15378 int bottom = top + getFadeHeight(offsetRequired); 15379 15380 if (offsetRequired) { 15381 right += getRightPaddingOffset(); 15382 bottom += getBottomPaddingOffset(); 15383 } 15384 15385 final ScrollabilityCache scrollabilityCache = mScrollCache; 15386 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 15387 int length = (int) fadeHeight; 15388 15389 // clip the fade length if top and bottom fades overlap 15390 // overlapping fades produce odd-looking artifacts 15391 if (verticalEdges && (top + length > bottom - length)) { 15392 length = (bottom - top) / 2; 15393 } 15394 15395 // also clip horizontal fades if necessary 15396 if (horizontalEdges && (left + length > right - length)) { 15397 length = (right - left) / 2; 15398 } 15399 15400 if (verticalEdges) { 15401 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 15402 drawTop = topFadeStrength * fadeHeight > 1.0f; 15403 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 15404 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 15405 } 15406 15407 if (horizontalEdges) { 15408 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 15409 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 15410 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 15411 drawRight = rightFadeStrength * fadeHeight > 1.0f; 15412 } 15413 15414 saveCount = canvas.getSaveCount(); 15415 15416 int solidColor = getSolidColor(); 15417 if (solidColor == 0) { 15418 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15419 15420 if (drawTop) { 15421 canvas.saveLayer(left, top, right, top + length, null, flags); 15422 } 15423 15424 if (drawBottom) { 15425 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 15426 } 15427 15428 if (drawLeft) { 15429 canvas.saveLayer(left, top, left + length, bottom, null, flags); 15430 } 15431 15432 if (drawRight) { 15433 canvas.saveLayer(right - length, top, right, bottom, null, flags); 15434 } 15435 } else { 15436 scrollabilityCache.setFadeColor(solidColor); 15437 } 15438 15439 // Step 3, draw the content 15440 if (!dirtyOpaque) onDraw(canvas); 15441 15442 // Step 4, draw the children 15443 dispatchDraw(canvas); 15444 15445 // Step 5, draw the fade effect and restore layers 15446 final Paint p = scrollabilityCache.paint; 15447 final Matrix matrix = scrollabilityCache.matrix; 15448 final Shader fade = scrollabilityCache.shader; 15449 15450 if (drawTop) { 15451 matrix.setScale(1, fadeHeight * topFadeStrength); 15452 matrix.postTranslate(left, top); 15453 fade.setLocalMatrix(matrix); 15454 p.setShader(fade); 15455 canvas.drawRect(left, top, right, top + length, p); 15456 } 15457 15458 if (drawBottom) { 15459 matrix.setScale(1, fadeHeight * bottomFadeStrength); 15460 matrix.postRotate(180); 15461 matrix.postTranslate(left, bottom); 15462 fade.setLocalMatrix(matrix); 15463 p.setShader(fade); 15464 canvas.drawRect(left, bottom - length, right, bottom, p); 15465 } 15466 15467 if (drawLeft) { 15468 matrix.setScale(1, fadeHeight * leftFadeStrength); 15469 matrix.postRotate(-90); 15470 matrix.postTranslate(left, top); 15471 fade.setLocalMatrix(matrix); 15472 p.setShader(fade); 15473 canvas.drawRect(left, top, left + length, bottom, p); 15474 } 15475 15476 if (drawRight) { 15477 matrix.setScale(1, fadeHeight * rightFadeStrength); 15478 matrix.postRotate(90); 15479 matrix.postTranslate(right, top); 15480 fade.setLocalMatrix(matrix); 15481 p.setShader(fade); 15482 canvas.drawRect(right - length, top, right, bottom, p); 15483 } 15484 15485 canvas.restoreToCount(saveCount); 15486 15487 // Step 6, draw decorations (scrollbars) 15488 onDrawScrollBars(canvas); 15489 15490 if (mOverlay != null && !mOverlay.isEmpty()) { 15491 mOverlay.getOverlayView().dispatchDraw(canvas); 15492 } 15493 } 15494 15495 /** 15496 * Draws the background onto the specified canvas. 15497 * 15498 * @param canvas Canvas on which to draw the background 15499 */ 15500 private void drawBackground(Canvas canvas) { 15501 final Drawable background = mBackground; 15502 if (background == null) { 15503 return; 15504 } 15505 15506 if (mBackgroundSizeChanged) { 15507 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 15508 mBackgroundSizeChanged = false; 15509 rebuildOutline(); 15510 } 15511 15512 // Attempt to use a display list if requested. 15513 if (canvas.isHardwareAccelerated() && mAttachInfo != null 15514 && mAttachInfo.mHardwareRenderer != null) { 15515 mBackgroundRenderNode = getDrawableRenderNode(background, mBackgroundRenderNode); 15516 15517 final RenderNode renderNode = mBackgroundRenderNode; 15518 if (renderNode != null && renderNode.isValid()) { 15519 setBackgroundRenderNodeProperties(renderNode); 15520 ((HardwareCanvas) canvas).drawRenderNode(renderNode); 15521 return; 15522 } 15523 } 15524 15525 final int scrollX = mScrollX; 15526 final int scrollY = mScrollY; 15527 if ((scrollX | scrollY) == 0) { 15528 background.draw(canvas); 15529 } else { 15530 canvas.translate(scrollX, scrollY); 15531 background.draw(canvas); 15532 canvas.translate(-scrollX, -scrollY); 15533 } 15534 } 15535 15536 private void setBackgroundRenderNodeProperties(RenderNode renderNode) { 15537 renderNode.setTranslationX(mScrollX); 15538 renderNode.setTranslationY(mScrollY); 15539 } 15540 15541 /** 15542 * Creates a new display list or updates the existing display list for the 15543 * specified Drawable. 15544 * 15545 * @param drawable Drawable for which to create a display list 15546 * @param renderNode Existing RenderNode, or {@code null} 15547 * @return A valid display list for the specified drawable 15548 */ 15549 private RenderNode getDrawableRenderNode(Drawable drawable, RenderNode renderNode) { 15550 if (renderNode == null) { 15551 renderNode = RenderNode.create(drawable.getClass().getName(), this); 15552 } 15553 15554 final Rect bounds = drawable.getBounds(); 15555 final int width = bounds.width(); 15556 final int height = bounds.height(); 15557 final HardwareCanvas canvas = renderNode.start(width, height); 15558 15559 // Reverse left/top translation done by drawable canvas, which will 15560 // instead be applied by rendernode's LTRB bounds below. This way, the 15561 // drawable's bounds match with its rendernode bounds and its content 15562 // will lie within those bounds in the rendernode tree. 15563 canvas.translate(-bounds.left, -bounds.top); 15564 15565 try { 15566 drawable.draw(canvas); 15567 } finally { 15568 renderNode.end(canvas); 15569 } 15570 15571 // Set up drawable properties that are view-independent. 15572 renderNode.setLeftTopRightBottom(bounds.left, bounds.top, bounds.right, bounds.bottom); 15573 renderNode.setProjectBackwards(drawable.isProjected()); 15574 renderNode.setProjectionReceiver(true); 15575 renderNode.setClipToBounds(false); 15576 return renderNode; 15577 } 15578 15579 /** 15580 * Returns the overlay for this view, creating it if it does not yet exist. 15581 * Adding drawables to the overlay will cause them to be displayed whenever 15582 * the view itself is redrawn. Objects in the overlay should be actively 15583 * managed: remove them when they should not be displayed anymore. The 15584 * overlay will always have the same size as its host view. 15585 * 15586 * <p>Note: Overlays do not currently work correctly with {@link 15587 * SurfaceView} or {@link TextureView}; contents in overlays for these 15588 * types of views may not display correctly.</p> 15589 * 15590 * @return The ViewOverlay object for this view. 15591 * @see ViewOverlay 15592 */ 15593 public ViewOverlay getOverlay() { 15594 if (mOverlay == null) { 15595 mOverlay = new ViewOverlay(mContext, this); 15596 } 15597 return mOverlay; 15598 } 15599 15600 /** 15601 * Override this if your view is known to always be drawn on top of a solid color background, 15602 * and needs to draw fading edges. Returning a non-zero color enables the view system to 15603 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 15604 * should be set to 0xFF. 15605 * 15606 * @see #setVerticalFadingEdgeEnabled(boolean) 15607 * @see #setHorizontalFadingEdgeEnabled(boolean) 15608 * 15609 * @return The known solid color background for this view, or 0 if the color may vary 15610 */ 15611 @ViewDebug.ExportedProperty(category = "drawing") 15612 public int getSolidColor() { 15613 return 0; 15614 } 15615 15616 /** 15617 * Build a human readable string representation of the specified view flags. 15618 * 15619 * @param flags the view flags to convert to a string 15620 * @return a String representing the supplied flags 15621 */ 15622 private static String printFlags(int flags) { 15623 String output = ""; 15624 int numFlags = 0; 15625 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 15626 output += "TAKES_FOCUS"; 15627 numFlags++; 15628 } 15629 15630 switch (flags & VISIBILITY_MASK) { 15631 case INVISIBLE: 15632 if (numFlags > 0) { 15633 output += " "; 15634 } 15635 output += "INVISIBLE"; 15636 // USELESS HERE numFlags++; 15637 break; 15638 case GONE: 15639 if (numFlags > 0) { 15640 output += " "; 15641 } 15642 output += "GONE"; 15643 // USELESS HERE numFlags++; 15644 break; 15645 default: 15646 break; 15647 } 15648 return output; 15649 } 15650 15651 /** 15652 * Build a human readable string representation of the specified private 15653 * view flags. 15654 * 15655 * @param privateFlags the private view flags to convert to a string 15656 * @return a String representing the supplied flags 15657 */ 15658 private static String printPrivateFlags(int privateFlags) { 15659 String output = ""; 15660 int numFlags = 0; 15661 15662 if ((privateFlags & PFLAG_WANTS_FOCUS) == PFLAG_WANTS_FOCUS) { 15663 output += "WANTS_FOCUS"; 15664 numFlags++; 15665 } 15666 15667 if ((privateFlags & PFLAG_FOCUSED) == PFLAG_FOCUSED) { 15668 if (numFlags > 0) { 15669 output += " "; 15670 } 15671 output += "FOCUSED"; 15672 numFlags++; 15673 } 15674 15675 if ((privateFlags & PFLAG_SELECTED) == PFLAG_SELECTED) { 15676 if (numFlags > 0) { 15677 output += " "; 15678 } 15679 output += "SELECTED"; 15680 numFlags++; 15681 } 15682 15683 if ((privateFlags & PFLAG_IS_ROOT_NAMESPACE) == PFLAG_IS_ROOT_NAMESPACE) { 15684 if (numFlags > 0) { 15685 output += " "; 15686 } 15687 output += "IS_ROOT_NAMESPACE"; 15688 numFlags++; 15689 } 15690 15691 if ((privateFlags & PFLAG_HAS_BOUNDS) == PFLAG_HAS_BOUNDS) { 15692 if (numFlags > 0) { 15693 output += " "; 15694 } 15695 output += "HAS_BOUNDS"; 15696 numFlags++; 15697 } 15698 15699 if ((privateFlags & PFLAG_DRAWN) == PFLAG_DRAWN) { 15700 if (numFlags > 0) { 15701 output += " "; 15702 } 15703 output += "DRAWN"; 15704 // USELESS HERE numFlags++; 15705 } 15706 return output; 15707 } 15708 15709 /** 15710 * <p>Indicates whether or not this view's layout will be requested during 15711 * the next hierarchy layout pass.</p> 15712 * 15713 * @return true if the layout will be forced during next layout pass 15714 */ 15715 public boolean isLayoutRequested() { 15716 return (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 15717 } 15718 15719 /** 15720 * Return true if o is a ViewGroup that is laying out using optical bounds. 15721 * @hide 15722 */ 15723 public static boolean isLayoutModeOptical(Object o) { 15724 return o instanceof ViewGroup && ((ViewGroup) o).isLayoutModeOptical(); 15725 } 15726 15727 private boolean setOpticalFrame(int left, int top, int right, int bottom) { 15728 Insets parentInsets = mParent instanceof View ? 15729 ((View) mParent).getOpticalInsets() : Insets.NONE; 15730 Insets childInsets = getOpticalInsets(); 15731 return setFrame( 15732 left + parentInsets.left - childInsets.left, 15733 top + parentInsets.top - childInsets.top, 15734 right + parentInsets.left + childInsets.right, 15735 bottom + parentInsets.top + childInsets.bottom); 15736 } 15737 15738 /** 15739 * Assign a size and position to a view and all of its 15740 * descendants 15741 * 15742 * <p>This is the second phase of the layout mechanism. 15743 * (The first is measuring). In this phase, each parent calls 15744 * layout on all of its children to position them. 15745 * This is typically done using the child measurements 15746 * that were stored in the measure pass().</p> 15747 * 15748 * <p>Derived classes should not override this method. 15749 * Derived classes with children should override 15750 * onLayout. In that method, they should 15751 * call layout on each of their children.</p> 15752 * 15753 * @param l Left position, relative to parent 15754 * @param t Top position, relative to parent 15755 * @param r Right position, relative to parent 15756 * @param b Bottom position, relative to parent 15757 */ 15758 @SuppressWarnings({"unchecked"}) 15759 public void layout(int l, int t, int r, int b) { 15760 if ((mPrivateFlags3 & PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT) != 0) { 15761 onMeasure(mOldWidthMeasureSpec, mOldHeightMeasureSpec); 15762 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 15763 } 15764 15765 int oldL = mLeft; 15766 int oldT = mTop; 15767 int oldB = mBottom; 15768 int oldR = mRight; 15769 15770 boolean changed = isLayoutModeOptical(mParent) ? 15771 setOpticalFrame(l, t, r, b) : setFrame(l, t, r, b); 15772 15773 if (changed || (mPrivateFlags & PFLAG_LAYOUT_REQUIRED) == PFLAG_LAYOUT_REQUIRED) { 15774 onLayout(changed, l, t, r, b); 15775 mPrivateFlags &= ~PFLAG_LAYOUT_REQUIRED; 15776 15777 ListenerInfo li = mListenerInfo; 15778 if (li != null && li.mOnLayoutChangeListeners != null) { 15779 ArrayList<OnLayoutChangeListener> listenersCopy = 15780 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 15781 int numListeners = listenersCopy.size(); 15782 for (int i = 0; i < numListeners; ++i) { 15783 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 15784 } 15785 } 15786 } 15787 15788 mPrivateFlags &= ~PFLAG_FORCE_LAYOUT; 15789 mPrivateFlags3 |= PFLAG3_IS_LAID_OUT; 15790 } 15791 15792 /** 15793 * Called from layout when this view should 15794 * assign a size and position to each of its children. 15795 * 15796 * Derived classes with children should override 15797 * this method and call layout on each of 15798 * their children. 15799 * @param changed This is a new size or position for this view 15800 * @param left Left position, relative to parent 15801 * @param top Top position, relative to parent 15802 * @param right Right position, relative to parent 15803 * @param bottom Bottom position, relative to parent 15804 */ 15805 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 15806 } 15807 15808 /** 15809 * Assign a size and position to this view. 15810 * 15811 * This is called from layout. 15812 * 15813 * @param left Left position, relative to parent 15814 * @param top Top position, relative to parent 15815 * @param right Right position, relative to parent 15816 * @param bottom Bottom position, relative to parent 15817 * @return true if the new size and position are different than the 15818 * previous ones 15819 * {@hide} 15820 */ 15821 protected boolean setFrame(int left, int top, int right, int bottom) { 15822 boolean changed = false; 15823 15824 if (DBG) { 15825 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 15826 + right + "," + bottom + ")"); 15827 } 15828 15829 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 15830 changed = true; 15831 15832 // Remember our drawn bit 15833 int drawn = mPrivateFlags & PFLAG_DRAWN; 15834 15835 int oldWidth = mRight - mLeft; 15836 int oldHeight = mBottom - mTop; 15837 int newWidth = right - left; 15838 int newHeight = bottom - top; 15839 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 15840 15841 // Invalidate our old position 15842 invalidate(sizeChanged); 15843 15844 mLeft = left; 15845 mTop = top; 15846 mRight = right; 15847 mBottom = bottom; 15848 mRenderNode.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 15849 15850 mPrivateFlags |= PFLAG_HAS_BOUNDS; 15851 15852 15853 if (sizeChanged) { 15854 sizeChange(newWidth, newHeight, oldWidth, oldHeight); 15855 } 15856 15857 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE || mGhostView != null) { 15858 // If we are visible, force the DRAWN bit to on so that 15859 // this invalidate will go through (at least to our parent). 15860 // This is because someone may have invalidated this view 15861 // before this call to setFrame came in, thereby clearing 15862 // the DRAWN bit. 15863 mPrivateFlags |= PFLAG_DRAWN; 15864 invalidate(sizeChanged); 15865 // parent display list may need to be recreated based on a change in the bounds 15866 // of any child 15867 invalidateParentCaches(); 15868 } 15869 15870 // Reset drawn bit to original value (invalidate turns it off) 15871 mPrivateFlags |= drawn; 15872 15873 mBackgroundSizeChanged = true; 15874 15875 notifySubtreeAccessibilityStateChangedIfNeeded(); 15876 } 15877 return changed; 15878 } 15879 15880 /** 15881 * Same as setFrame, but public and hidden. For use in {@link android.transition.ChangeBounds}. 15882 * @hide 15883 */ 15884 public void setLeftTopRightBottom(int left, int top, int right, int bottom) { 15885 setFrame(left, top, right, bottom); 15886 } 15887 15888 private void sizeChange(int newWidth, int newHeight, int oldWidth, int oldHeight) { 15889 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 15890 if (mOverlay != null) { 15891 mOverlay.getOverlayView().setRight(newWidth); 15892 mOverlay.getOverlayView().setBottom(newHeight); 15893 } 15894 rebuildOutline(); 15895 } 15896 15897 /** 15898 * Finalize inflating a view from XML. This is called as the last phase 15899 * of inflation, after all child views have been added. 15900 * 15901 * <p>Even if the subclass overrides onFinishInflate, they should always be 15902 * sure to call the super method, so that we get called. 15903 */ 15904 protected void onFinishInflate() { 15905 } 15906 15907 /** 15908 * Returns the resources associated with this view. 15909 * 15910 * @return Resources object. 15911 */ 15912 public Resources getResources() { 15913 return mResources; 15914 } 15915 15916 /** 15917 * Invalidates the specified Drawable. 15918 * 15919 * @param drawable the drawable to invalidate 15920 */ 15921 @Override 15922 public void invalidateDrawable(@NonNull Drawable drawable) { 15923 if (verifyDrawable(drawable)) { 15924 final Rect dirty = drawable.getDirtyBounds(); 15925 final int scrollX = mScrollX; 15926 final int scrollY = mScrollY; 15927 15928 invalidate(dirty.left + scrollX, dirty.top + scrollY, 15929 dirty.right + scrollX, dirty.bottom + scrollY); 15930 rebuildOutline(); 15931 } 15932 } 15933 15934 /** 15935 * Schedules an action on a drawable to occur at a specified time. 15936 * 15937 * @param who the recipient of the action 15938 * @param what the action to run on the drawable 15939 * @param when the time at which the action must occur. Uses the 15940 * {@link SystemClock#uptimeMillis} timebase. 15941 */ 15942 @Override 15943 public void scheduleDrawable(Drawable who, Runnable what, long when) { 15944 if (verifyDrawable(who) && what != null) { 15945 final long delay = when - SystemClock.uptimeMillis(); 15946 if (mAttachInfo != null) { 15947 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 15948 Choreographer.CALLBACK_ANIMATION, what, who, 15949 Choreographer.subtractFrameDelay(delay)); 15950 } else { 15951 ViewRootImpl.getRunQueue().postDelayed(what, delay); 15952 } 15953 } 15954 } 15955 15956 /** 15957 * Cancels a scheduled action on a drawable. 15958 * 15959 * @param who the recipient of the action 15960 * @param what the action to cancel 15961 */ 15962 @Override 15963 public void unscheduleDrawable(Drawable who, Runnable what) { 15964 if (verifyDrawable(who) && what != null) { 15965 if (mAttachInfo != null) { 15966 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15967 Choreographer.CALLBACK_ANIMATION, what, who); 15968 } 15969 ViewRootImpl.getRunQueue().removeCallbacks(what); 15970 } 15971 } 15972 15973 /** 15974 * Unschedule any events associated with the given Drawable. This can be 15975 * used when selecting a new Drawable into a view, so that the previous 15976 * one is completely unscheduled. 15977 * 15978 * @param who The Drawable to unschedule. 15979 * 15980 * @see #drawableStateChanged 15981 */ 15982 public void unscheduleDrawable(Drawable who) { 15983 if (mAttachInfo != null && who != null) { 15984 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15985 Choreographer.CALLBACK_ANIMATION, null, who); 15986 } 15987 } 15988 15989 /** 15990 * Resolve the Drawables depending on the layout direction. This is implicitly supposing 15991 * that the View directionality can and will be resolved before its Drawables. 15992 * 15993 * Will call {@link View#onResolveDrawables} when resolution is done. 15994 * 15995 * @hide 15996 */ 15997 protected void resolveDrawables() { 15998 // Drawables resolution may need to happen before resolving the layout direction (which is 15999 // done only during the measure() call). 16000 // If the layout direction is not resolved yet, we cannot resolve the Drawables except in 16001 // one case: when the raw layout direction has not been defined as LAYOUT_DIRECTION_INHERIT. 16002 // So, if the raw layout direction is LAYOUT_DIRECTION_LTR or LAYOUT_DIRECTION_RTL or 16003 // LAYOUT_DIRECTION_LOCALE, we can "cheat" and we don't need to wait for the layout 16004 // direction to be resolved as its resolved value will be the same as its raw value. 16005 if (!isLayoutDirectionResolved() && 16006 getRawLayoutDirection() == View.LAYOUT_DIRECTION_INHERIT) { 16007 return; 16008 } 16009 16010 final int layoutDirection = isLayoutDirectionResolved() ? 16011 getLayoutDirection() : getRawLayoutDirection(); 16012 16013 if (mBackground != null) { 16014 mBackground.setLayoutDirection(layoutDirection); 16015 } 16016 mPrivateFlags2 |= PFLAG2_DRAWABLE_RESOLVED; 16017 onResolveDrawables(layoutDirection); 16018 } 16019 16020 boolean areDrawablesResolved() { 16021 return (mPrivateFlags2 & PFLAG2_DRAWABLE_RESOLVED) == PFLAG2_DRAWABLE_RESOLVED; 16022 } 16023 16024 /** 16025 * Called when layout direction has been resolved. 16026 * 16027 * The default implementation does nothing. 16028 * 16029 * @param layoutDirection The resolved layout direction. 16030 * 16031 * @see #LAYOUT_DIRECTION_LTR 16032 * @see #LAYOUT_DIRECTION_RTL 16033 * 16034 * @hide 16035 */ 16036 public void onResolveDrawables(@ResolvedLayoutDir int layoutDirection) { 16037 } 16038 16039 /** 16040 * @hide 16041 */ 16042 protected void resetResolvedDrawables() { 16043 resetResolvedDrawablesInternal(); 16044 } 16045 16046 void resetResolvedDrawablesInternal() { 16047 mPrivateFlags2 &= ~PFLAG2_DRAWABLE_RESOLVED; 16048 } 16049 16050 /** 16051 * If your view subclass is displaying its own Drawable objects, it should 16052 * override this function and return true for any Drawable it is 16053 * displaying. This allows animations for those drawables to be 16054 * scheduled. 16055 * 16056 * <p>Be sure to call through to the super class when overriding this 16057 * function. 16058 * 16059 * @param who The Drawable to verify. Return true if it is one you are 16060 * displaying, else return the result of calling through to the 16061 * super class. 16062 * 16063 * @return boolean If true than the Drawable is being displayed in the 16064 * view; else false and it is not allowed to animate. 16065 * 16066 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 16067 * @see #drawableStateChanged() 16068 */ 16069 protected boolean verifyDrawable(Drawable who) { 16070 return who == mBackground; 16071 } 16072 16073 /** 16074 * This function is called whenever the state of the view changes in such 16075 * a way that it impacts the state of drawables being shown. 16076 * <p> 16077 * If the View has a StateListAnimator, it will also be called to run necessary state 16078 * change animations. 16079 * <p> 16080 * Be sure to call through to the superclass when overriding this function. 16081 * 16082 * @see Drawable#setState(int[]) 16083 */ 16084 protected void drawableStateChanged() { 16085 final Drawable d = mBackground; 16086 if (d != null && d.isStateful()) { 16087 d.setState(getDrawableState()); 16088 } 16089 16090 if (mStateListAnimator != null) { 16091 mStateListAnimator.setState(getDrawableState()); 16092 } 16093 } 16094 16095 /** 16096 * This function is called whenever the view hotspot changes and needs to 16097 * be propagated to drawables or child views managed by the view. 16098 * <p> 16099 * Dispatching to child views is handled by 16100 * {@link #dispatchDrawableHotspotChanged(float, float)}. 16101 * <p> 16102 * Be sure to call through to the superclass when overriding this function. 16103 * 16104 * @param x hotspot x coordinate 16105 * @param y hotspot y coordinate 16106 */ 16107 public void drawableHotspotChanged(float x, float y) { 16108 if (mBackground != null) { 16109 mBackground.setHotspot(x, y); 16110 } 16111 16112 dispatchDrawableHotspotChanged(x, y); 16113 } 16114 16115 /** 16116 * Dispatches drawableHotspotChanged to all of this View's children. 16117 * 16118 * @param x hotspot x coordinate 16119 * @param y hotspot y coordinate 16120 * @see #drawableHotspotChanged(float, float) 16121 */ 16122 public void dispatchDrawableHotspotChanged(float x, float y) { 16123 } 16124 16125 /** 16126 * Call this to force a view to update its drawable state. This will cause 16127 * drawableStateChanged to be called on this view. Views that are interested 16128 * in the new state should call getDrawableState. 16129 * 16130 * @see #drawableStateChanged 16131 * @see #getDrawableState 16132 */ 16133 public void refreshDrawableState() { 16134 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 16135 drawableStateChanged(); 16136 16137 ViewParent parent = mParent; 16138 if (parent != null) { 16139 parent.childDrawableStateChanged(this); 16140 } 16141 } 16142 16143 /** 16144 * Return an array of resource IDs of the drawable states representing the 16145 * current state of the view. 16146 * 16147 * @return The current drawable state 16148 * 16149 * @see Drawable#setState(int[]) 16150 * @see #drawableStateChanged() 16151 * @see #onCreateDrawableState(int) 16152 */ 16153 public final int[] getDrawableState() { 16154 if ((mDrawableState != null) && ((mPrivateFlags & PFLAG_DRAWABLE_STATE_DIRTY) == 0)) { 16155 return mDrawableState; 16156 } else { 16157 mDrawableState = onCreateDrawableState(0); 16158 mPrivateFlags &= ~PFLAG_DRAWABLE_STATE_DIRTY; 16159 return mDrawableState; 16160 } 16161 } 16162 16163 /** 16164 * Generate the new {@link android.graphics.drawable.Drawable} state for 16165 * this view. This is called by the view 16166 * system when the cached Drawable state is determined to be invalid. To 16167 * retrieve the current state, you should use {@link #getDrawableState}. 16168 * 16169 * @param extraSpace if non-zero, this is the number of extra entries you 16170 * would like in the returned array in which you can place your own 16171 * states. 16172 * 16173 * @return Returns an array holding the current {@link Drawable} state of 16174 * the view. 16175 * 16176 * @see #mergeDrawableStates(int[], int[]) 16177 */ 16178 protected int[] onCreateDrawableState(int extraSpace) { 16179 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 16180 mParent instanceof View) { 16181 return ((View) mParent).onCreateDrawableState(extraSpace); 16182 } 16183 16184 int[] drawableState; 16185 16186 int privateFlags = mPrivateFlags; 16187 16188 int viewStateIndex = 0; 16189 if ((privateFlags & PFLAG_PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 16190 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 16191 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 16192 if ((privateFlags & PFLAG_SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 16193 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 16194 if ((privateFlags & PFLAG_ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 16195 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 16196 HardwareRenderer.isAvailable()) { 16197 // This is set if HW acceleration is requested, even if the current 16198 // process doesn't allow it. This is just to allow app preview 16199 // windows to better match their app. 16200 viewStateIndex |= VIEW_STATE_ACCELERATED; 16201 } 16202 if ((privateFlags & PFLAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 16203 16204 final int privateFlags2 = mPrivateFlags2; 16205 if ((privateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 16206 if ((privateFlags2 & PFLAG2_DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 16207 16208 drawableState = VIEW_STATE_SETS[viewStateIndex]; 16209 16210 //noinspection ConstantIfStatement 16211 if (false) { 16212 Log.i("View", "drawableStateIndex=" + viewStateIndex); 16213 Log.i("View", toString() 16214 + " pressed=" + ((privateFlags & PFLAG_PRESSED) != 0) 16215 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 16216 + " fo=" + hasFocus() 16217 + " sl=" + ((privateFlags & PFLAG_SELECTED) != 0) 16218 + " wf=" + hasWindowFocus() 16219 + ": " + Arrays.toString(drawableState)); 16220 } 16221 16222 if (extraSpace == 0) { 16223 return drawableState; 16224 } 16225 16226 final int[] fullState; 16227 if (drawableState != null) { 16228 fullState = new int[drawableState.length + extraSpace]; 16229 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 16230 } else { 16231 fullState = new int[extraSpace]; 16232 } 16233 16234 return fullState; 16235 } 16236 16237 /** 16238 * Merge your own state values in <var>additionalState</var> into the base 16239 * state values <var>baseState</var> that were returned by 16240 * {@link #onCreateDrawableState(int)}. 16241 * 16242 * @param baseState The base state values returned by 16243 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 16244 * own additional state values. 16245 * 16246 * @param additionalState The additional state values you would like 16247 * added to <var>baseState</var>; this array is not modified. 16248 * 16249 * @return As a convenience, the <var>baseState</var> array you originally 16250 * passed into the function is returned. 16251 * 16252 * @see #onCreateDrawableState(int) 16253 */ 16254 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 16255 final int N = baseState.length; 16256 int i = N - 1; 16257 while (i >= 0 && baseState[i] == 0) { 16258 i--; 16259 } 16260 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 16261 return baseState; 16262 } 16263 16264 /** 16265 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 16266 * on all Drawable objects associated with this view. 16267 * <p> 16268 * Also calls {@link StateListAnimator#jumpToCurrentState()} if there is a StateListAnimator 16269 * attached to this view. 16270 */ 16271 public void jumpDrawablesToCurrentState() { 16272 if (mBackground != null) { 16273 mBackground.jumpToCurrentState(); 16274 } 16275 if (mStateListAnimator != null) { 16276 mStateListAnimator.jumpToCurrentState(); 16277 } 16278 } 16279 16280 /** 16281 * Sets the background color for this view. 16282 * @param color the color of the background 16283 */ 16284 @RemotableViewMethod 16285 public void setBackgroundColor(int color) { 16286 if (mBackground instanceof ColorDrawable) { 16287 ((ColorDrawable) mBackground.mutate()).setColor(color); 16288 computeOpaqueFlags(); 16289 mBackgroundResource = 0; 16290 } else { 16291 setBackground(new ColorDrawable(color)); 16292 } 16293 } 16294 16295 /** 16296 * Set the background to a given resource. The resource should refer to 16297 * a Drawable object or 0 to remove the background. 16298 * @param resid The identifier of the resource. 16299 * 16300 * @attr ref android.R.styleable#View_background 16301 */ 16302 @RemotableViewMethod 16303 public void setBackgroundResource(int resid) { 16304 if (resid != 0 && resid == mBackgroundResource) { 16305 return; 16306 } 16307 16308 Drawable d = null; 16309 if (resid != 0) { 16310 d = mContext.getDrawable(resid); 16311 } 16312 setBackground(d); 16313 16314 mBackgroundResource = resid; 16315 } 16316 16317 /** 16318 * Set the background to a given Drawable, or remove the background. If the 16319 * background has padding, this View's padding is set to the background's 16320 * padding. However, when a background is removed, this View's padding isn't 16321 * touched. If setting the padding is desired, please use 16322 * {@link #setPadding(int, int, int, int)}. 16323 * 16324 * @param background The Drawable to use as the background, or null to remove the 16325 * background 16326 */ 16327 public void setBackground(Drawable background) { 16328 //noinspection deprecation 16329 setBackgroundDrawable(background); 16330 } 16331 16332 /** 16333 * @deprecated use {@link #setBackground(Drawable)} instead 16334 */ 16335 @Deprecated 16336 public void setBackgroundDrawable(Drawable background) { 16337 computeOpaqueFlags(); 16338 16339 if (background == mBackground) { 16340 return; 16341 } 16342 16343 boolean requestLayout = false; 16344 16345 mBackgroundResource = 0; 16346 16347 /* 16348 * Regardless of whether we're setting a new background or not, we want 16349 * to clear the previous drawable. 16350 */ 16351 if (mBackground != null) { 16352 mBackground.setCallback(null); 16353 unscheduleDrawable(mBackground); 16354 } 16355 16356 if (background != null) { 16357 Rect padding = sThreadLocal.get(); 16358 if (padding == null) { 16359 padding = new Rect(); 16360 sThreadLocal.set(padding); 16361 } 16362 resetResolvedDrawablesInternal(); 16363 background.setLayoutDirection(getLayoutDirection()); 16364 if (background.getPadding(padding)) { 16365 resetResolvedPaddingInternal(); 16366 switch (background.getLayoutDirection()) { 16367 case LAYOUT_DIRECTION_RTL: 16368 mUserPaddingLeftInitial = padding.right; 16369 mUserPaddingRightInitial = padding.left; 16370 internalSetPadding(padding.right, padding.top, padding.left, padding.bottom); 16371 break; 16372 case LAYOUT_DIRECTION_LTR: 16373 default: 16374 mUserPaddingLeftInitial = padding.left; 16375 mUserPaddingRightInitial = padding.right; 16376 internalSetPadding(padding.left, padding.top, padding.right, padding.bottom); 16377 } 16378 mLeftPaddingDefined = false; 16379 mRightPaddingDefined = false; 16380 } 16381 16382 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 16383 // if it has a different minimum size, we should layout again 16384 if (mBackground == null 16385 || mBackground.getMinimumHeight() != background.getMinimumHeight() 16386 || mBackground.getMinimumWidth() != background.getMinimumWidth()) { 16387 requestLayout = true; 16388 } 16389 16390 background.setCallback(this); 16391 if (background.isStateful()) { 16392 background.setState(getDrawableState()); 16393 } 16394 background.setVisible(getVisibility() == VISIBLE, false); 16395 mBackground = background; 16396 16397 applyBackgroundTint(); 16398 16399 if ((mPrivateFlags & PFLAG_SKIP_DRAW) != 0) { 16400 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 16401 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 16402 requestLayout = true; 16403 } 16404 } else { 16405 /* Remove the background */ 16406 mBackground = null; 16407 16408 if ((mPrivateFlags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0) { 16409 /* 16410 * This view ONLY drew the background before and we're removing 16411 * the background, so now it won't draw anything 16412 * (hence we SKIP_DRAW) 16413 */ 16414 mPrivateFlags &= ~PFLAG_ONLY_DRAWS_BACKGROUND; 16415 mPrivateFlags |= PFLAG_SKIP_DRAW; 16416 } 16417 16418 /* 16419 * When the background is set, we try to apply its padding to this 16420 * View. When the background is removed, we don't touch this View's 16421 * padding. This is noted in the Javadocs. Hence, we don't need to 16422 * requestLayout(), the invalidate() below is sufficient. 16423 */ 16424 16425 // The old background's minimum size could have affected this 16426 // View's layout, so let's requestLayout 16427 requestLayout = true; 16428 } 16429 16430 computeOpaqueFlags(); 16431 16432 if (requestLayout) { 16433 requestLayout(); 16434 } 16435 16436 mBackgroundSizeChanged = true; 16437 invalidate(true); 16438 } 16439 16440 /** 16441 * Gets the background drawable 16442 * 16443 * @return The drawable used as the background for this view, if any. 16444 * 16445 * @see #setBackground(Drawable) 16446 * 16447 * @attr ref android.R.styleable#View_background 16448 */ 16449 public Drawable getBackground() { 16450 return mBackground; 16451 } 16452 16453 /** 16454 * Applies a tint to the background drawable. Does not modify the current tint 16455 * mode, which is {@link PorterDuff.Mode#SRC_IN} by default. 16456 * <p> 16457 * Subsequent calls to {@link #setBackground(Drawable)} will automatically 16458 * mutate the drawable and apply the specified tint and tint mode using 16459 * {@link Drawable#setTintList(ColorStateList)}. 16460 * 16461 * @param tint the tint to apply, may be {@code null} to clear tint 16462 * 16463 * @attr ref android.R.styleable#View_backgroundTint 16464 * @see #getBackgroundTintList() 16465 * @see Drawable#setTintList(ColorStateList) 16466 */ 16467 public void setBackgroundTintList(@Nullable ColorStateList tint) { 16468 if (mBackgroundTint == null) { 16469 mBackgroundTint = new TintInfo(); 16470 } 16471 mBackgroundTint.mTintList = tint; 16472 mBackgroundTint.mHasTintList = true; 16473 16474 applyBackgroundTint(); 16475 } 16476 16477 /** 16478 * Return the tint applied to the background drawable, if specified. 16479 * 16480 * @return the tint applied to the background drawable 16481 * @attr ref android.R.styleable#View_backgroundTint 16482 * @see #setBackgroundTintList(ColorStateList) 16483 */ 16484 @Nullable 16485 public ColorStateList getBackgroundTintList() { 16486 return mBackgroundTint != null ? mBackgroundTint.mTintList : null; 16487 } 16488 16489 /** 16490 * Specifies the blending mode used to apply the tint specified by 16491 * {@link #setBackgroundTintList(ColorStateList)}} to the background 16492 * drawable. The default mode is {@link PorterDuff.Mode#SRC_IN}. 16493 * 16494 * @param tintMode the blending mode used to apply the tint, may be 16495 * {@code null} to clear tint 16496 * @attr ref android.R.styleable#View_backgroundTintMode 16497 * @see #getBackgroundTintMode() 16498 * @see Drawable#setTintMode(PorterDuff.Mode) 16499 */ 16500 public void setBackgroundTintMode(@Nullable PorterDuff.Mode tintMode) { 16501 if (mBackgroundTint == null) { 16502 mBackgroundTint = new TintInfo(); 16503 } 16504 mBackgroundTint.mTintMode = tintMode; 16505 mBackgroundTint.mHasTintMode = true; 16506 16507 applyBackgroundTint(); 16508 } 16509 16510 /** 16511 * Return the blending mode used to apply the tint to the background 16512 * drawable, if specified. 16513 * 16514 * @return the blending mode used to apply the tint to the background 16515 * drawable 16516 * @attr ref android.R.styleable#View_backgroundTintMode 16517 * @see #setBackgroundTintMode(PorterDuff.Mode) 16518 */ 16519 @Nullable 16520 public PorterDuff.Mode getBackgroundTintMode() { 16521 return mBackgroundTint != null ? mBackgroundTint.mTintMode : null; 16522 } 16523 16524 private void applyBackgroundTint() { 16525 if (mBackground != null && mBackgroundTint != null) { 16526 final TintInfo tintInfo = mBackgroundTint; 16527 if (tintInfo.mHasTintList || tintInfo.mHasTintMode) { 16528 mBackground = mBackground.mutate(); 16529 16530 if (tintInfo.mHasTintList) { 16531 mBackground.setTintList(tintInfo.mTintList); 16532 } 16533 16534 if (tintInfo.mHasTintMode) { 16535 mBackground.setTintMode(tintInfo.mTintMode); 16536 } 16537 16538 // The drawable (or one of its children) may not have been 16539 // stateful before applying the tint, so let's try again. 16540 if (mBackground.isStateful()) { 16541 mBackground.setState(getDrawableState()); 16542 } 16543 } 16544 } 16545 } 16546 16547 /** 16548 * Sets the padding. The view may add on the space required to display 16549 * the scrollbars, depending on the style and visibility of the scrollbars. 16550 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 16551 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 16552 * from the values set in this call. 16553 * 16554 * @attr ref android.R.styleable#View_padding 16555 * @attr ref android.R.styleable#View_paddingBottom 16556 * @attr ref android.R.styleable#View_paddingLeft 16557 * @attr ref android.R.styleable#View_paddingRight 16558 * @attr ref android.R.styleable#View_paddingTop 16559 * @param left the left padding in pixels 16560 * @param top the top padding in pixels 16561 * @param right the right padding in pixels 16562 * @param bottom the bottom padding in pixels 16563 */ 16564 public void setPadding(int left, int top, int right, int bottom) { 16565 resetResolvedPaddingInternal(); 16566 16567 mUserPaddingStart = UNDEFINED_PADDING; 16568 mUserPaddingEnd = UNDEFINED_PADDING; 16569 16570 mUserPaddingLeftInitial = left; 16571 mUserPaddingRightInitial = right; 16572 16573 mLeftPaddingDefined = true; 16574 mRightPaddingDefined = true; 16575 16576 internalSetPadding(left, top, right, bottom); 16577 } 16578 16579 /** 16580 * @hide 16581 */ 16582 protected void internalSetPadding(int left, int top, int right, int bottom) { 16583 mUserPaddingLeft = left; 16584 mUserPaddingRight = right; 16585 mUserPaddingBottom = bottom; 16586 16587 final int viewFlags = mViewFlags; 16588 boolean changed = false; 16589 16590 // Common case is there are no scroll bars. 16591 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 16592 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 16593 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 16594 ? 0 : getVerticalScrollbarWidth(); 16595 switch (mVerticalScrollbarPosition) { 16596 case SCROLLBAR_POSITION_DEFAULT: 16597 if (isLayoutRtl()) { 16598 left += offset; 16599 } else { 16600 right += offset; 16601 } 16602 break; 16603 case SCROLLBAR_POSITION_RIGHT: 16604 right += offset; 16605 break; 16606 case SCROLLBAR_POSITION_LEFT: 16607 left += offset; 16608 break; 16609 } 16610 } 16611 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 16612 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 16613 ? 0 : getHorizontalScrollbarHeight(); 16614 } 16615 } 16616 16617 if (mPaddingLeft != left) { 16618 changed = true; 16619 mPaddingLeft = left; 16620 } 16621 if (mPaddingTop != top) { 16622 changed = true; 16623 mPaddingTop = top; 16624 } 16625 if (mPaddingRight != right) { 16626 changed = true; 16627 mPaddingRight = right; 16628 } 16629 if (mPaddingBottom != bottom) { 16630 changed = true; 16631 mPaddingBottom = bottom; 16632 } 16633 16634 if (changed) { 16635 requestLayout(); 16636 invalidateOutline(); 16637 } 16638 } 16639 16640 /** 16641 * Sets the relative padding. The view may add on the space required to display 16642 * the scrollbars, depending on the style and visibility of the scrollbars. 16643 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 16644 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 16645 * from the values set in this call. 16646 * 16647 * @attr ref android.R.styleable#View_padding 16648 * @attr ref android.R.styleable#View_paddingBottom 16649 * @attr ref android.R.styleable#View_paddingStart 16650 * @attr ref android.R.styleable#View_paddingEnd 16651 * @attr ref android.R.styleable#View_paddingTop 16652 * @param start the start padding in pixels 16653 * @param top the top padding in pixels 16654 * @param end the end padding in pixels 16655 * @param bottom the bottom padding in pixels 16656 */ 16657 public void setPaddingRelative(int start, int top, int end, int bottom) { 16658 resetResolvedPaddingInternal(); 16659 16660 mUserPaddingStart = start; 16661 mUserPaddingEnd = end; 16662 mLeftPaddingDefined = true; 16663 mRightPaddingDefined = true; 16664 16665 switch(getLayoutDirection()) { 16666 case LAYOUT_DIRECTION_RTL: 16667 mUserPaddingLeftInitial = end; 16668 mUserPaddingRightInitial = start; 16669 internalSetPadding(end, top, start, bottom); 16670 break; 16671 case LAYOUT_DIRECTION_LTR: 16672 default: 16673 mUserPaddingLeftInitial = start; 16674 mUserPaddingRightInitial = end; 16675 internalSetPadding(start, top, end, bottom); 16676 } 16677 } 16678 16679 /** 16680 * Returns the top padding of this view. 16681 * 16682 * @return the top padding in pixels 16683 */ 16684 public int getPaddingTop() { 16685 return mPaddingTop; 16686 } 16687 16688 /** 16689 * Returns the bottom padding of this view. If there are inset and enabled 16690 * scrollbars, this value may include the space required to display the 16691 * scrollbars as well. 16692 * 16693 * @return the bottom padding in pixels 16694 */ 16695 public int getPaddingBottom() { 16696 return mPaddingBottom; 16697 } 16698 16699 /** 16700 * Returns the left padding of this view. If there are inset and enabled 16701 * scrollbars, this value may include the space required to display the 16702 * scrollbars as well. 16703 * 16704 * @return the left padding in pixels 16705 */ 16706 public int getPaddingLeft() { 16707 if (!isPaddingResolved()) { 16708 resolvePadding(); 16709 } 16710 return mPaddingLeft; 16711 } 16712 16713 /** 16714 * Returns the start padding of this view depending on its resolved layout direction. 16715 * If there are inset and enabled scrollbars, this value may include the space 16716 * required to display the scrollbars as well. 16717 * 16718 * @return the start padding in pixels 16719 */ 16720 public int getPaddingStart() { 16721 if (!isPaddingResolved()) { 16722 resolvePadding(); 16723 } 16724 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16725 mPaddingRight : mPaddingLeft; 16726 } 16727 16728 /** 16729 * Returns the right padding of this view. If there are inset and enabled 16730 * scrollbars, this value may include the space required to display the 16731 * scrollbars as well. 16732 * 16733 * @return the right padding in pixels 16734 */ 16735 public int getPaddingRight() { 16736 if (!isPaddingResolved()) { 16737 resolvePadding(); 16738 } 16739 return mPaddingRight; 16740 } 16741 16742 /** 16743 * Returns the end padding of this view depending on its resolved layout direction. 16744 * If there are inset and enabled scrollbars, this value may include the space 16745 * required to display the scrollbars as well. 16746 * 16747 * @return the end padding in pixels 16748 */ 16749 public int getPaddingEnd() { 16750 if (!isPaddingResolved()) { 16751 resolvePadding(); 16752 } 16753 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16754 mPaddingLeft : mPaddingRight; 16755 } 16756 16757 /** 16758 * Return if the padding as been set thru relative values 16759 * {@link #setPaddingRelative(int, int, int, int)} or thru 16760 * @attr ref android.R.styleable#View_paddingStart or 16761 * @attr ref android.R.styleable#View_paddingEnd 16762 * 16763 * @return true if the padding is relative or false if it is not. 16764 */ 16765 public boolean isPaddingRelative() { 16766 return (mUserPaddingStart != UNDEFINED_PADDING || mUserPaddingEnd != UNDEFINED_PADDING); 16767 } 16768 16769 Insets computeOpticalInsets() { 16770 return (mBackground == null) ? Insets.NONE : mBackground.getOpticalInsets(); 16771 } 16772 16773 /** 16774 * @hide 16775 */ 16776 public void resetPaddingToInitialValues() { 16777 if (isRtlCompatibilityMode()) { 16778 mPaddingLeft = mUserPaddingLeftInitial; 16779 mPaddingRight = mUserPaddingRightInitial; 16780 return; 16781 } 16782 if (isLayoutRtl()) { 16783 mPaddingLeft = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingLeftInitial; 16784 mPaddingRight = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingRightInitial; 16785 } else { 16786 mPaddingLeft = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingLeftInitial; 16787 mPaddingRight = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingRightInitial; 16788 } 16789 } 16790 16791 /** 16792 * @hide 16793 */ 16794 public Insets getOpticalInsets() { 16795 if (mLayoutInsets == null) { 16796 mLayoutInsets = computeOpticalInsets(); 16797 } 16798 return mLayoutInsets; 16799 } 16800 16801 /** 16802 * Set this view's optical insets. 16803 * 16804 * <p>This method should be treated similarly to setMeasuredDimension and not as a general 16805 * property. Views that compute their own optical insets should call it as part of measurement. 16806 * This method does not request layout. If you are setting optical insets outside of 16807 * measure/layout itself you will want to call requestLayout() yourself. 16808 * </p> 16809 * @hide 16810 */ 16811 public void setOpticalInsets(Insets insets) { 16812 mLayoutInsets = insets; 16813 } 16814 16815 /** 16816 * Changes the selection state of this view. A view can be selected or not. 16817 * Note that selection is not the same as focus. Views are typically 16818 * selected in the context of an AdapterView like ListView or GridView; 16819 * the selected view is the view that is highlighted. 16820 * 16821 * @param selected true if the view must be selected, false otherwise 16822 */ 16823 public void setSelected(boolean selected) { 16824 //noinspection DoubleNegation 16825 if (((mPrivateFlags & PFLAG_SELECTED) != 0) != selected) { 16826 mPrivateFlags = (mPrivateFlags & ~PFLAG_SELECTED) | (selected ? PFLAG_SELECTED : 0); 16827 if (!selected) resetPressedState(); 16828 invalidate(true); 16829 refreshDrawableState(); 16830 dispatchSetSelected(selected); 16831 if (selected) { 16832 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SELECTED); 16833 } else { 16834 notifyViewAccessibilityStateChangedIfNeeded( 16835 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 16836 } 16837 } 16838 } 16839 16840 /** 16841 * Dispatch setSelected to all of this View's children. 16842 * 16843 * @see #setSelected(boolean) 16844 * 16845 * @param selected The new selected state 16846 */ 16847 protected void dispatchSetSelected(boolean selected) { 16848 } 16849 16850 /** 16851 * Indicates the selection state of this view. 16852 * 16853 * @return true if the view is selected, false otherwise 16854 */ 16855 @ViewDebug.ExportedProperty 16856 public boolean isSelected() { 16857 return (mPrivateFlags & PFLAG_SELECTED) != 0; 16858 } 16859 16860 /** 16861 * Changes the activated state of this view. A view can be activated or not. 16862 * Note that activation is not the same as selection. Selection is 16863 * a transient property, representing the view (hierarchy) the user is 16864 * currently interacting with. Activation is a longer-term state that the 16865 * user can move views in and out of. For example, in a list view with 16866 * single or multiple selection enabled, the views in the current selection 16867 * set are activated. (Um, yeah, we are deeply sorry about the terminology 16868 * here.) The activated state is propagated down to children of the view it 16869 * is set on. 16870 * 16871 * @param activated true if the view must be activated, false otherwise 16872 */ 16873 public void setActivated(boolean activated) { 16874 //noinspection DoubleNegation 16875 if (((mPrivateFlags & PFLAG_ACTIVATED) != 0) != activated) { 16876 mPrivateFlags = (mPrivateFlags & ~PFLAG_ACTIVATED) | (activated ? PFLAG_ACTIVATED : 0); 16877 invalidate(true); 16878 refreshDrawableState(); 16879 dispatchSetActivated(activated); 16880 } 16881 } 16882 16883 /** 16884 * Dispatch setActivated to all of this View's children. 16885 * 16886 * @see #setActivated(boolean) 16887 * 16888 * @param activated The new activated state 16889 */ 16890 protected void dispatchSetActivated(boolean activated) { 16891 } 16892 16893 /** 16894 * Indicates the activation state of this view. 16895 * 16896 * @return true if the view is activated, false otherwise 16897 */ 16898 @ViewDebug.ExportedProperty 16899 public boolean isActivated() { 16900 return (mPrivateFlags & PFLAG_ACTIVATED) != 0; 16901 } 16902 16903 /** 16904 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 16905 * observer can be used to get notifications when global events, like 16906 * layout, happen. 16907 * 16908 * The returned ViewTreeObserver observer is not guaranteed to remain 16909 * valid for the lifetime of this View. If the caller of this method keeps 16910 * a long-lived reference to ViewTreeObserver, it should always check for 16911 * the return value of {@link ViewTreeObserver#isAlive()}. 16912 * 16913 * @return The ViewTreeObserver for this view's hierarchy. 16914 */ 16915 public ViewTreeObserver getViewTreeObserver() { 16916 if (mAttachInfo != null) { 16917 return mAttachInfo.mTreeObserver; 16918 } 16919 if (mFloatingTreeObserver == null) { 16920 mFloatingTreeObserver = new ViewTreeObserver(); 16921 } 16922 return mFloatingTreeObserver; 16923 } 16924 16925 /** 16926 * <p>Finds the topmost view in the current view hierarchy.</p> 16927 * 16928 * @return the topmost view containing this view 16929 */ 16930 public View getRootView() { 16931 if (mAttachInfo != null) { 16932 final View v = mAttachInfo.mRootView; 16933 if (v != null) { 16934 return v; 16935 } 16936 } 16937 16938 View parent = this; 16939 16940 while (parent.mParent != null && parent.mParent instanceof View) { 16941 parent = (View) parent.mParent; 16942 } 16943 16944 return parent; 16945 } 16946 16947 /** 16948 * Transforms a motion event from view-local coordinates to on-screen 16949 * coordinates. 16950 * 16951 * @param ev the view-local motion event 16952 * @return false if the transformation could not be applied 16953 * @hide 16954 */ 16955 public boolean toGlobalMotionEvent(MotionEvent ev) { 16956 final AttachInfo info = mAttachInfo; 16957 if (info == null) { 16958 return false; 16959 } 16960 16961 final Matrix m = info.mTmpMatrix; 16962 m.set(Matrix.IDENTITY_MATRIX); 16963 transformMatrixToGlobal(m); 16964 ev.transform(m); 16965 return true; 16966 } 16967 16968 /** 16969 * Transforms a motion event from on-screen coordinates to view-local 16970 * coordinates. 16971 * 16972 * @param ev the on-screen motion event 16973 * @return false if the transformation could not be applied 16974 * @hide 16975 */ 16976 public boolean toLocalMotionEvent(MotionEvent ev) { 16977 final AttachInfo info = mAttachInfo; 16978 if (info == null) { 16979 return false; 16980 } 16981 16982 final Matrix m = info.mTmpMatrix; 16983 m.set(Matrix.IDENTITY_MATRIX); 16984 transformMatrixToLocal(m); 16985 ev.transform(m); 16986 return true; 16987 } 16988 16989 /** 16990 * Modifies the input matrix such that it maps view-local coordinates to 16991 * on-screen coordinates. 16992 * 16993 * @param m input matrix to modify 16994 * @hide 16995 */ 16996 public void transformMatrixToGlobal(Matrix m) { 16997 final ViewParent parent = mParent; 16998 if (parent instanceof View) { 16999 final View vp = (View) parent; 17000 vp.transformMatrixToGlobal(m); 17001 m.preTranslate(-vp.mScrollX, -vp.mScrollY); 17002 } else if (parent instanceof ViewRootImpl) { 17003 final ViewRootImpl vr = (ViewRootImpl) parent; 17004 vr.transformMatrixToGlobal(m); 17005 m.preTranslate(0, -vr.mCurScrollY); 17006 } 17007 17008 m.preTranslate(mLeft, mTop); 17009 17010 if (!hasIdentityMatrix()) { 17011 m.preConcat(getMatrix()); 17012 } 17013 } 17014 17015 /** 17016 * Modifies the input matrix such that it maps on-screen coordinates to 17017 * view-local coordinates. 17018 * 17019 * @param m input matrix to modify 17020 * @hide 17021 */ 17022 public void transformMatrixToLocal(Matrix m) { 17023 final ViewParent parent = mParent; 17024 if (parent instanceof View) { 17025 final View vp = (View) parent; 17026 vp.transformMatrixToLocal(m); 17027 m.postTranslate(vp.mScrollX, vp.mScrollY); 17028 } else if (parent instanceof ViewRootImpl) { 17029 final ViewRootImpl vr = (ViewRootImpl) parent; 17030 vr.transformMatrixToLocal(m); 17031 m.postTranslate(0, vr.mCurScrollY); 17032 } 17033 17034 m.postTranslate(-mLeft, -mTop); 17035 17036 if (!hasIdentityMatrix()) { 17037 m.postConcat(getInverseMatrix()); 17038 } 17039 } 17040 17041 /** 17042 * @hide 17043 */ 17044 @ViewDebug.ExportedProperty(category = "layout", indexMapping = { 17045 @ViewDebug.IntToString(from = 0, to = "x"), 17046 @ViewDebug.IntToString(from = 1, to = "y") 17047 }) 17048 public int[] getLocationOnScreen() { 17049 int[] location = new int[2]; 17050 getLocationOnScreen(location); 17051 return location; 17052 } 17053 17054 /** 17055 * <p>Computes the coordinates of this view on the screen. The argument 17056 * must be an array of two integers. After the method returns, the array 17057 * contains the x and y location in that order.</p> 17058 * 17059 * @param location an array of two integers in which to hold the coordinates 17060 */ 17061 public void getLocationOnScreen(int[] location) { 17062 getLocationInWindow(location); 17063 17064 final AttachInfo info = mAttachInfo; 17065 if (info != null) { 17066 location[0] += info.mWindowLeft; 17067 location[1] += info.mWindowTop; 17068 } 17069 } 17070 17071 /** 17072 * <p>Computes the coordinates of this view in its window. The argument 17073 * must be an array of two integers. After the method returns, the array 17074 * contains the x and y location in that order.</p> 17075 * 17076 * @param location an array of two integers in which to hold the coordinates 17077 */ 17078 public void getLocationInWindow(int[] location) { 17079 if (location == null || location.length < 2) { 17080 throw new IllegalArgumentException("location must be an array of two integers"); 17081 } 17082 17083 if (mAttachInfo == null) { 17084 // When the view is not attached to a window, this method does not make sense 17085 location[0] = location[1] = 0; 17086 return; 17087 } 17088 17089 float[] position = mAttachInfo.mTmpTransformLocation; 17090 position[0] = position[1] = 0.0f; 17091 17092 if (!hasIdentityMatrix()) { 17093 getMatrix().mapPoints(position); 17094 } 17095 17096 position[0] += mLeft; 17097 position[1] += mTop; 17098 17099 ViewParent viewParent = mParent; 17100 while (viewParent instanceof View) { 17101 final View view = (View) viewParent; 17102 17103 position[0] -= view.mScrollX; 17104 position[1] -= view.mScrollY; 17105 17106 if (!view.hasIdentityMatrix()) { 17107 view.getMatrix().mapPoints(position); 17108 } 17109 17110 position[0] += view.mLeft; 17111 position[1] += view.mTop; 17112 17113 viewParent = view.mParent; 17114 } 17115 17116 if (viewParent instanceof ViewRootImpl) { 17117 // *cough* 17118 final ViewRootImpl vr = (ViewRootImpl) viewParent; 17119 position[1] -= vr.mCurScrollY; 17120 } 17121 17122 location[0] = (int) (position[0] + 0.5f); 17123 location[1] = (int) (position[1] + 0.5f); 17124 } 17125 17126 /** 17127 * {@hide} 17128 * @param id the id of the view to be found 17129 * @return the view of the specified id, null if cannot be found 17130 */ 17131 protected View findViewTraversal(int id) { 17132 if (id == mID) { 17133 return this; 17134 } 17135 return null; 17136 } 17137 17138 /** 17139 * {@hide} 17140 * @param tag the tag of the view to be found 17141 * @return the view of specified tag, null if cannot be found 17142 */ 17143 protected View findViewWithTagTraversal(Object tag) { 17144 if (tag != null && tag.equals(mTag)) { 17145 return this; 17146 } 17147 return null; 17148 } 17149 17150 /** 17151 * {@hide} 17152 * @param predicate The predicate to evaluate. 17153 * @param childToSkip If not null, ignores this child during the recursive traversal. 17154 * @return The first view that matches the predicate or null. 17155 */ 17156 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 17157 if (predicate.apply(this)) { 17158 return this; 17159 } 17160 return null; 17161 } 17162 17163 /** 17164 * Look for a child view with the given id. If this view has the given 17165 * id, return this view. 17166 * 17167 * @param id The id to search for. 17168 * @return The view that has the given id in the hierarchy or null 17169 */ 17170 public final View findViewById(int id) { 17171 if (id < 0) { 17172 return null; 17173 } 17174 return findViewTraversal(id); 17175 } 17176 17177 /** 17178 * Finds a view by its unuque and stable accessibility id. 17179 * 17180 * @param accessibilityId The searched accessibility id. 17181 * @return The found view. 17182 */ 17183 final View findViewByAccessibilityId(int accessibilityId) { 17184 if (accessibilityId < 0) { 17185 return null; 17186 } 17187 return findViewByAccessibilityIdTraversal(accessibilityId); 17188 } 17189 17190 /** 17191 * Performs the traversal to find a view by its unuque and stable accessibility id. 17192 * 17193 * <strong>Note:</strong>This method does not stop at the root namespace 17194 * boundary since the user can touch the screen at an arbitrary location 17195 * potentially crossing the root namespace bounday which will send an 17196 * accessibility event to accessibility services and they should be able 17197 * to obtain the event source. Also accessibility ids are guaranteed to be 17198 * unique in the window. 17199 * 17200 * @param accessibilityId The accessibility id. 17201 * @return The found view. 17202 * 17203 * @hide 17204 */ 17205 public View findViewByAccessibilityIdTraversal(int accessibilityId) { 17206 if (getAccessibilityViewId() == accessibilityId) { 17207 return this; 17208 } 17209 return null; 17210 } 17211 17212 /** 17213 * Look for a child view with the given tag. If this view has the given 17214 * tag, return this view. 17215 * 17216 * @param tag The tag to search for, using "tag.equals(getTag())". 17217 * @return The View that has the given tag in the hierarchy or null 17218 */ 17219 public final View findViewWithTag(Object tag) { 17220 if (tag == null) { 17221 return null; 17222 } 17223 return findViewWithTagTraversal(tag); 17224 } 17225 17226 /** 17227 * {@hide} 17228 * Look for a child view that matches the specified predicate. 17229 * If this view matches the predicate, return this view. 17230 * 17231 * @param predicate The predicate to evaluate. 17232 * @return The first view that matches the predicate or null. 17233 */ 17234 public final View findViewByPredicate(Predicate<View> predicate) { 17235 return findViewByPredicateTraversal(predicate, null); 17236 } 17237 17238 /** 17239 * {@hide} 17240 * Look for a child view that matches the specified predicate, 17241 * starting with the specified view and its descendents and then 17242 * recusively searching the ancestors and siblings of that view 17243 * until this view is reached. 17244 * 17245 * This method is useful in cases where the predicate does not match 17246 * a single unique view (perhaps multiple views use the same id) 17247 * and we are trying to find the view that is "closest" in scope to the 17248 * starting view. 17249 * 17250 * @param start The view to start from. 17251 * @param predicate The predicate to evaluate. 17252 * @return The first view that matches the predicate or null. 17253 */ 17254 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 17255 View childToSkip = null; 17256 for (;;) { 17257 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 17258 if (view != null || start == this) { 17259 return view; 17260 } 17261 17262 ViewParent parent = start.getParent(); 17263 if (parent == null || !(parent instanceof View)) { 17264 return null; 17265 } 17266 17267 childToSkip = start; 17268 start = (View) parent; 17269 } 17270 } 17271 17272 /** 17273 * Sets the identifier for this view. The identifier does not have to be 17274 * unique in this view's hierarchy. The identifier should be a positive 17275 * number. 17276 * 17277 * @see #NO_ID 17278 * @see #getId() 17279 * @see #findViewById(int) 17280 * 17281 * @param id a number used to identify the view 17282 * 17283 * @attr ref android.R.styleable#View_id 17284 */ 17285 public void setId(int id) { 17286 mID = id; 17287 if (mID == View.NO_ID && mLabelForId != View.NO_ID) { 17288 mID = generateViewId(); 17289 } 17290 } 17291 17292 /** 17293 * {@hide} 17294 * 17295 * @param isRoot true if the view belongs to the root namespace, false 17296 * otherwise 17297 */ 17298 public void setIsRootNamespace(boolean isRoot) { 17299 if (isRoot) { 17300 mPrivateFlags |= PFLAG_IS_ROOT_NAMESPACE; 17301 } else { 17302 mPrivateFlags &= ~PFLAG_IS_ROOT_NAMESPACE; 17303 } 17304 } 17305 17306 /** 17307 * {@hide} 17308 * 17309 * @return true if the view belongs to the root namespace, false otherwise 17310 */ 17311 public boolean isRootNamespace() { 17312 return (mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0; 17313 } 17314 17315 /** 17316 * Returns this view's identifier. 17317 * 17318 * @return a positive integer used to identify the view or {@link #NO_ID} 17319 * if the view has no ID 17320 * 17321 * @see #setId(int) 17322 * @see #findViewById(int) 17323 * @attr ref android.R.styleable#View_id 17324 */ 17325 @ViewDebug.CapturedViewProperty 17326 public int getId() { 17327 return mID; 17328 } 17329 17330 /** 17331 * Returns this view's tag. 17332 * 17333 * @return the Object stored in this view as a tag, or {@code null} if not 17334 * set 17335 * 17336 * @see #setTag(Object) 17337 * @see #getTag(int) 17338 */ 17339 @ViewDebug.ExportedProperty 17340 public Object getTag() { 17341 return mTag; 17342 } 17343 17344 /** 17345 * Sets the tag associated with this view. A tag can be used to mark 17346 * a view in its hierarchy and does not have to be unique within the 17347 * hierarchy. Tags can also be used to store data within a view without 17348 * resorting to another data structure. 17349 * 17350 * @param tag an Object to tag the view with 17351 * 17352 * @see #getTag() 17353 * @see #setTag(int, Object) 17354 */ 17355 public void setTag(final Object tag) { 17356 mTag = tag; 17357 } 17358 17359 /** 17360 * Returns the tag associated with this view and the specified key. 17361 * 17362 * @param key The key identifying the tag 17363 * 17364 * @return the Object stored in this view as a tag, or {@code null} if not 17365 * set 17366 * 17367 * @see #setTag(int, Object) 17368 * @see #getTag() 17369 */ 17370 public Object getTag(int key) { 17371 if (mKeyedTags != null) return mKeyedTags.get(key); 17372 return null; 17373 } 17374 17375 /** 17376 * Sets a tag associated with this view and a key. A tag can be used 17377 * to mark a view in its hierarchy and does not have to be unique within 17378 * the hierarchy. Tags can also be used to store data within a view 17379 * without resorting to another data structure. 17380 * 17381 * The specified key should be an id declared in the resources of the 17382 * application to ensure it is unique (see the <a 17383 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 17384 * Keys identified as belonging to 17385 * the Android framework or not associated with any package will cause 17386 * an {@link IllegalArgumentException} to be thrown. 17387 * 17388 * @param key The key identifying the tag 17389 * @param tag An Object to tag the view with 17390 * 17391 * @throws IllegalArgumentException If they specified key is not valid 17392 * 17393 * @see #setTag(Object) 17394 * @see #getTag(int) 17395 */ 17396 public void setTag(int key, final Object tag) { 17397 // If the package id is 0x00 or 0x01, it's either an undefined package 17398 // or a framework id 17399 if ((key >>> 24) < 2) { 17400 throw new IllegalArgumentException("The key must be an application-specific " 17401 + "resource id."); 17402 } 17403 17404 setKeyedTag(key, tag); 17405 } 17406 17407 /** 17408 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 17409 * framework id. 17410 * 17411 * @hide 17412 */ 17413 public void setTagInternal(int key, Object tag) { 17414 if ((key >>> 24) != 0x1) { 17415 throw new IllegalArgumentException("The key must be a framework-specific " 17416 + "resource id."); 17417 } 17418 17419 setKeyedTag(key, tag); 17420 } 17421 17422 private void setKeyedTag(int key, Object tag) { 17423 if (mKeyedTags == null) { 17424 mKeyedTags = new SparseArray<Object>(2); 17425 } 17426 17427 mKeyedTags.put(key, tag); 17428 } 17429 17430 /** 17431 * Prints information about this view in the log output, with the tag 17432 * {@link #VIEW_LOG_TAG}. 17433 * 17434 * @hide 17435 */ 17436 public void debug() { 17437 debug(0); 17438 } 17439 17440 /** 17441 * Prints information about this view in the log output, with the tag 17442 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 17443 * indentation defined by the <code>depth</code>. 17444 * 17445 * @param depth the indentation level 17446 * 17447 * @hide 17448 */ 17449 protected void debug(int depth) { 17450 String output = debugIndent(depth - 1); 17451 17452 output += "+ " + this; 17453 int id = getId(); 17454 if (id != -1) { 17455 output += " (id=" + id + ")"; 17456 } 17457 Object tag = getTag(); 17458 if (tag != null) { 17459 output += " (tag=" + tag + ")"; 17460 } 17461 Log.d(VIEW_LOG_TAG, output); 17462 17463 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 17464 output = debugIndent(depth) + " FOCUSED"; 17465 Log.d(VIEW_LOG_TAG, output); 17466 } 17467 17468 output = debugIndent(depth); 17469 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 17470 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 17471 + "} "; 17472 Log.d(VIEW_LOG_TAG, output); 17473 17474 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 17475 || mPaddingBottom != 0) { 17476 output = debugIndent(depth); 17477 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 17478 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 17479 Log.d(VIEW_LOG_TAG, output); 17480 } 17481 17482 output = debugIndent(depth); 17483 output += "mMeasureWidth=" + mMeasuredWidth + 17484 " mMeasureHeight=" + mMeasuredHeight; 17485 Log.d(VIEW_LOG_TAG, output); 17486 17487 output = debugIndent(depth); 17488 if (mLayoutParams == null) { 17489 output += "BAD! no layout params"; 17490 } else { 17491 output = mLayoutParams.debug(output); 17492 } 17493 Log.d(VIEW_LOG_TAG, output); 17494 17495 output = debugIndent(depth); 17496 output += "flags={"; 17497 output += View.printFlags(mViewFlags); 17498 output += "}"; 17499 Log.d(VIEW_LOG_TAG, output); 17500 17501 output = debugIndent(depth); 17502 output += "privateFlags={"; 17503 output += View.printPrivateFlags(mPrivateFlags); 17504 output += "}"; 17505 Log.d(VIEW_LOG_TAG, output); 17506 } 17507 17508 /** 17509 * Creates a string of whitespaces used for indentation. 17510 * 17511 * @param depth the indentation level 17512 * @return a String containing (depth * 2 + 3) * 2 white spaces 17513 * 17514 * @hide 17515 */ 17516 protected static String debugIndent(int depth) { 17517 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 17518 for (int i = 0; i < (depth * 2) + 3; i++) { 17519 spaces.append(' ').append(' '); 17520 } 17521 return spaces.toString(); 17522 } 17523 17524 /** 17525 * <p>Return the offset of the widget's text baseline from the widget's top 17526 * boundary. If this widget does not support baseline alignment, this 17527 * method returns -1. </p> 17528 * 17529 * @return the offset of the baseline within the widget's bounds or -1 17530 * if baseline alignment is not supported 17531 */ 17532 @ViewDebug.ExportedProperty(category = "layout") 17533 public int getBaseline() { 17534 return -1; 17535 } 17536 17537 /** 17538 * Returns whether the view hierarchy is currently undergoing a layout pass. This 17539 * information is useful to avoid situations such as calling {@link #requestLayout()} during 17540 * a layout pass. 17541 * 17542 * @return whether the view hierarchy is currently undergoing a layout pass 17543 */ 17544 public boolean isInLayout() { 17545 ViewRootImpl viewRoot = getViewRootImpl(); 17546 return (viewRoot != null && viewRoot.isInLayout()); 17547 } 17548 17549 /** 17550 * Call this when something has changed which has invalidated the 17551 * layout of this view. This will schedule a layout pass of the view 17552 * tree. This should not be called while the view hierarchy is currently in a layout 17553 * pass ({@link #isInLayout()}. If layout is happening, the request may be honored at the 17554 * end of the current layout pass (and then layout will run again) or after the current 17555 * frame is drawn and the next layout occurs. 17556 * 17557 * <p>Subclasses which override this method should call the superclass method to 17558 * handle possible request-during-layout errors correctly.</p> 17559 */ 17560 public void requestLayout() { 17561 if (mMeasureCache != null) mMeasureCache.clear(); 17562 17563 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == null) { 17564 // Only trigger request-during-layout logic if this is the view requesting it, 17565 // not the views in its parent hierarchy 17566 ViewRootImpl viewRoot = getViewRootImpl(); 17567 if (viewRoot != null && viewRoot.isInLayout()) { 17568 if (!viewRoot.requestLayoutDuringLayout(this)) { 17569 return; 17570 } 17571 } 17572 mAttachInfo.mViewRequestingLayout = this; 17573 } 17574 17575 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17576 mPrivateFlags |= PFLAG_INVALIDATED; 17577 17578 if (mParent != null && !mParent.isLayoutRequested()) { 17579 mParent.requestLayout(); 17580 } 17581 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == this) { 17582 mAttachInfo.mViewRequestingLayout = null; 17583 } 17584 } 17585 17586 /** 17587 * Forces this view to be laid out during the next layout pass. 17588 * This method does not call requestLayout() or forceLayout() 17589 * on the parent. 17590 */ 17591 public void forceLayout() { 17592 if (mMeasureCache != null) mMeasureCache.clear(); 17593 17594 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17595 mPrivateFlags |= PFLAG_INVALIDATED; 17596 } 17597 17598 /** 17599 * <p> 17600 * This is called to find out how big a view should be. The parent 17601 * supplies constraint information in the width and height parameters. 17602 * </p> 17603 * 17604 * <p> 17605 * The actual measurement work of a view is performed in 17606 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 17607 * {@link #onMeasure(int, int)} can and must be overridden by subclasses. 17608 * </p> 17609 * 17610 * 17611 * @param widthMeasureSpec Horizontal space requirements as imposed by the 17612 * parent 17613 * @param heightMeasureSpec Vertical space requirements as imposed by the 17614 * parent 17615 * 17616 * @see #onMeasure(int, int) 17617 */ 17618 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 17619 boolean optical = isLayoutModeOptical(this); 17620 if (optical != isLayoutModeOptical(mParent)) { 17621 Insets insets = getOpticalInsets(); 17622 int oWidth = insets.left + insets.right; 17623 int oHeight = insets.top + insets.bottom; 17624 widthMeasureSpec = MeasureSpec.adjust(widthMeasureSpec, optical ? -oWidth : oWidth); 17625 heightMeasureSpec = MeasureSpec.adjust(heightMeasureSpec, optical ? -oHeight : oHeight); 17626 } 17627 17628 // Suppress sign extension for the low bytes 17629 long key = (long) widthMeasureSpec << 32 | (long) heightMeasureSpec & 0xffffffffL; 17630 if (mMeasureCache == null) mMeasureCache = new LongSparseLongArray(2); 17631 17632 final boolean forceLayout = (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 17633 final boolean isExactly = MeasureSpec.getMode(widthMeasureSpec) == MeasureSpec.EXACTLY && 17634 MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.EXACTLY; 17635 final boolean matchingSize = isExactly && 17636 getMeasuredWidth() == MeasureSpec.getSize(widthMeasureSpec) && 17637 getMeasuredHeight() == MeasureSpec.getSize(heightMeasureSpec); 17638 if (forceLayout || !matchingSize && 17639 (widthMeasureSpec != mOldWidthMeasureSpec || 17640 heightMeasureSpec != mOldHeightMeasureSpec)) { 17641 17642 // first clears the measured dimension flag 17643 mPrivateFlags &= ~PFLAG_MEASURED_DIMENSION_SET; 17644 17645 resolveRtlPropertiesIfNeeded(); 17646 17647 int cacheIndex = forceLayout ? -1 : mMeasureCache.indexOfKey(key); 17648 if (cacheIndex < 0 || sIgnoreMeasureCache) { 17649 // measure ourselves, this should set the measured dimension flag back 17650 onMeasure(widthMeasureSpec, heightMeasureSpec); 17651 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17652 } else { 17653 long value = mMeasureCache.valueAt(cacheIndex); 17654 // Casting a long to int drops the high 32 bits, no mask needed 17655 setMeasuredDimensionRaw((int) (value >> 32), (int) value); 17656 mPrivateFlags3 |= PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17657 } 17658 17659 // flag not set, setMeasuredDimension() was not invoked, we raise 17660 // an exception to warn the developer 17661 if ((mPrivateFlags & PFLAG_MEASURED_DIMENSION_SET) != PFLAG_MEASURED_DIMENSION_SET) { 17662 throw new IllegalStateException("onMeasure() did not set the" 17663 + " measured dimension by calling" 17664 + " setMeasuredDimension()"); 17665 } 17666 17667 mPrivateFlags |= PFLAG_LAYOUT_REQUIRED; 17668 } 17669 17670 mOldWidthMeasureSpec = widthMeasureSpec; 17671 mOldHeightMeasureSpec = heightMeasureSpec; 17672 17673 mMeasureCache.put(key, ((long) mMeasuredWidth) << 32 | 17674 (long) mMeasuredHeight & 0xffffffffL); // suppress sign extension 17675 } 17676 17677 /** 17678 * <p> 17679 * Measure the view and its content to determine the measured width and the 17680 * measured height. This method is invoked by {@link #measure(int, int)} and 17681 * should be overriden by subclasses to provide accurate and efficient 17682 * measurement of their contents. 17683 * </p> 17684 * 17685 * <p> 17686 * <strong>CONTRACT:</strong> When overriding this method, you 17687 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 17688 * measured width and height of this view. Failure to do so will trigger an 17689 * <code>IllegalStateException</code>, thrown by 17690 * {@link #measure(int, int)}. Calling the superclass' 17691 * {@link #onMeasure(int, int)} is a valid use. 17692 * </p> 17693 * 17694 * <p> 17695 * The base class implementation of measure defaults to the background size, 17696 * unless a larger size is allowed by the MeasureSpec. Subclasses should 17697 * override {@link #onMeasure(int, int)} to provide better measurements of 17698 * their content. 17699 * </p> 17700 * 17701 * <p> 17702 * If this method is overridden, it is the subclass's responsibility to make 17703 * sure the measured height and width are at least the view's minimum height 17704 * and width ({@link #getSuggestedMinimumHeight()} and 17705 * {@link #getSuggestedMinimumWidth()}). 17706 * </p> 17707 * 17708 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 17709 * The requirements are encoded with 17710 * {@link android.view.View.MeasureSpec}. 17711 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 17712 * The requirements are encoded with 17713 * {@link android.view.View.MeasureSpec}. 17714 * 17715 * @see #getMeasuredWidth() 17716 * @see #getMeasuredHeight() 17717 * @see #setMeasuredDimension(int, int) 17718 * @see #getSuggestedMinimumHeight() 17719 * @see #getSuggestedMinimumWidth() 17720 * @see android.view.View.MeasureSpec#getMode(int) 17721 * @see android.view.View.MeasureSpec#getSize(int) 17722 */ 17723 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 17724 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 17725 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 17726 } 17727 17728 /** 17729 * <p>This method must be called by {@link #onMeasure(int, int)} to store the 17730 * measured width and measured height. Failing to do so will trigger an 17731 * exception at measurement time.</p> 17732 * 17733 * @param measuredWidth The measured width of this view. May be a complex 17734 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17735 * {@link #MEASURED_STATE_TOO_SMALL}. 17736 * @param measuredHeight The measured height of this view. May be a complex 17737 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17738 * {@link #MEASURED_STATE_TOO_SMALL}. 17739 */ 17740 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 17741 boolean optical = isLayoutModeOptical(this); 17742 if (optical != isLayoutModeOptical(mParent)) { 17743 Insets insets = getOpticalInsets(); 17744 int opticalWidth = insets.left + insets.right; 17745 int opticalHeight = insets.top + insets.bottom; 17746 17747 measuredWidth += optical ? opticalWidth : -opticalWidth; 17748 measuredHeight += optical ? opticalHeight : -opticalHeight; 17749 } 17750 setMeasuredDimensionRaw(measuredWidth, measuredHeight); 17751 } 17752 17753 /** 17754 * Sets the measured dimension without extra processing for things like optical bounds. 17755 * Useful for reapplying consistent values that have already been cooked with adjustments 17756 * for optical bounds, etc. such as those from the measurement cache. 17757 * 17758 * @param measuredWidth The measured width of this view. May be a complex 17759 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17760 * {@link #MEASURED_STATE_TOO_SMALL}. 17761 * @param measuredHeight The measured height of this view. May be a complex 17762 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17763 * {@link #MEASURED_STATE_TOO_SMALL}. 17764 */ 17765 private void setMeasuredDimensionRaw(int measuredWidth, int measuredHeight) { 17766 mMeasuredWidth = measuredWidth; 17767 mMeasuredHeight = measuredHeight; 17768 17769 mPrivateFlags |= PFLAG_MEASURED_DIMENSION_SET; 17770 } 17771 17772 /** 17773 * Merge two states as returned by {@link #getMeasuredState()}. 17774 * @param curState The current state as returned from a view or the result 17775 * of combining multiple views. 17776 * @param newState The new view state to combine. 17777 * @return Returns a new integer reflecting the combination of the two 17778 * states. 17779 */ 17780 public static int combineMeasuredStates(int curState, int newState) { 17781 return curState | newState; 17782 } 17783 17784 /** 17785 * Version of {@link #resolveSizeAndState(int, int, int)} 17786 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 17787 */ 17788 public static int resolveSize(int size, int measureSpec) { 17789 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 17790 } 17791 17792 /** 17793 * Utility to reconcile a desired size and state, with constraints imposed 17794 * by a MeasureSpec. Will take the desired size, unless a different size 17795 * is imposed by the constraints. The returned value is a compound integer, 17796 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 17797 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 17798 * size is smaller than the size the view wants to be. 17799 * 17800 * @param size How big the view wants to be 17801 * @param measureSpec Constraints imposed by the parent 17802 * @return Size information bit mask as defined by 17803 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 17804 */ 17805 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 17806 int result = size; 17807 int specMode = MeasureSpec.getMode(measureSpec); 17808 int specSize = MeasureSpec.getSize(measureSpec); 17809 switch (specMode) { 17810 case MeasureSpec.UNSPECIFIED: 17811 result = size; 17812 break; 17813 case MeasureSpec.AT_MOST: 17814 if (specSize < size) { 17815 result = specSize | MEASURED_STATE_TOO_SMALL; 17816 } else { 17817 result = size; 17818 } 17819 break; 17820 case MeasureSpec.EXACTLY: 17821 result = specSize; 17822 break; 17823 } 17824 return result | (childMeasuredState&MEASURED_STATE_MASK); 17825 } 17826 17827 /** 17828 * Utility to return a default size. Uses the supplied size if the 17829 * MeasureSpec imposed no constraints. Will get larger if allowed 17830 * by the MeasureSpec. 17831 * 17832 * @param size Default size for this view 17833 * @param measureSpec Constraints imposed by the parent 17834 * @return The size this view should be. 17835 */ 17836 public static int getDefaultSize(int size, int measureSpec) { 17837 int result = size; 17838 int specMode = MeasureSpec.getMode(measureSpec); 17839 int specSize = MeasureSpec.getSize(measureSpec); 17840 17841 switch (specMode) { 17842 case MeasureSpec.UNSPECIFIED: 17843 result = size; 17844 break; 17845 case MeasureSpec.AT_MOST: 17846 case MeasureSpec.EXACTLY: 17847 result = specSize; 17848 break; 17849 } 17850 return result; 17851 } 17852 17853 /** 17854 * Returns the suggested minimum height that the view should use. This 17855 * returns the maximum of the view's minimum height 17856 * and the background's minimum height 17857 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 17858 * <p> 17859 * When being used in {@link #onMeasure(int, int)}, the caller should still 17860 * ensure the returned height is within the requirements of the parent. 17861 * 17862 * @return The suggested minimum height of the view. 17863 */ 17864 protected int getSuggestedMinimumHeight() { 17865 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight()); 17866 17867 } 17868 17869 /** 17870 * Returns the suggested minimum width that the view should use. This 17871 * returns the maximum of the view's minimum width) 17872 * and the background's minimum width 17873 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 17874 * <p> 17875 * When being used in {@link #onMeasure(int, int)}, the caller should still 17876 * ensure the returned width is within the requirements of the parent. 17877 * 17878 * @return The suggested minimum width of the view. 17879 */ 17880 protected int getSuggestedMinimumWidth() { 17881 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth()); 17882 } 17883 17884 /** 17885 * Returns the minimum height of the view. 17886 * 17887 * @return the minimum height the view will try to be. 17888 * 17889 * @see #setMinimumHeight(int) 17890 * 17891 * @attr ref android.R.styleable#View_minHeight 17892 */ 17893 public int getMinimumHeight() { 17894 return mMinHeight; 17895 } 17896 17897 /** 17898 * Sets the minimum height of the view. It is not guaranteed the view will 17899 * be able to achieve this minimum height (for example, if its parent layout 17900 * constrains it with less available height). 17901 * 17902 * @param minHeight The minimum height the view will try to be. 17903 * 17904 * @see #getMinimumHeight() 17905 * 17906 * @attr ref android.R.styleable#View_minHeight 17907 */ 17908 public void setMinimumHeight(int minHeight) { 17909 mMinHeight = minHeight; 17910 requestLayout(); 17911 } 17912 17913 /** 17914 * Returns the minimum width of the view. 17915 * 17916 * @return the minimum width the view will try to be. 17917 * 17918 * @see #setMinimumWidth(int) 17919 * 17920 * @attr ref android.R.styleable#View_minWidth 17921 */ 17922 public int getMinimumWidth() { 17923 return mMinWidth; 17924 } 17925 17926 /** 17927 * Sets the minimum width of the view. It is not guaranteed the view will 17928 * be able to achieve this minimum width (for example, if its parent layout 17929 * constrains it with less available width). 17930 * 17931 * @param minWidth The minimum width the view will try to be. 17932 * 17933 * @see #getMinimumWidth() 17934 * 17935 * @attr ref android.R.styleable#View_minWidth 17936 */ 17937 public void setMinimumWidth(int minWidth) { 17938 mMinWidth = minWidth; 17939 requestLayout(); 17940 17941 } 17942 17943 /** 17944 * Get the animation currently associated with this view. 17945 * 17946 * @return The animation that is currently playing or 17947 * scheduled to play for this view. 17948 */ 17949 public Animation getAnimation() { 17950 return mCurrentAnimation; 17951 } 17952 17953 /** 17954 * Start the specified animation now. 17955 * 17956 * @param animation the animation to start now 17957 */ 17958 public void startAnimation(Animation animation) { 17959 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 17960 setAnimation(animation); 17961 invalidateParentCaches(); 17962 invalidate(true); 17963 } 17964 17965 /** 17966 * Cancels any animations for this view. 17967 */ 17968 public void clearAnimation() { 17969 if (mCurrentAnimation != null) { 17970 mCurrentAnimation.detach(); 17971 } 17972 mCurrentAnimation = null; 17973 invalidateParentIfNeeded(); 17974 } 17975 17976 /** 17977 * Sets the next animation to play for this view. 17978 * If you want the animation to play immediately, use 17979 * {@link #startAnimation(android.view.animation.Animation)} instead. 17980 * This method provides allows fine-grained 17981 * control over the start time and invalidation, but you 17982 * must make sure that 1) the animation has a start time set, and 17983 * 2) the view's parent (which controls animations on its children) 17984 * will be invalidated when the animation is supposed to 17985 * start. 17986 * 17987 * @param animation The next animation, or null. 17988 */ 17989 public void setAnimation(Animation animation) { 17990 mCurrentAnimation = animation; 17991 17992 if (animation != null) { 17993 // If the screen is off assume the animation start time is now instead of 17994 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time 17995 // would cause the animation to start when the screen turns back on 17996 if (mAttachInfo != null && mAttachInfo.mDisplayState == Display.STATE_OFF 17997 && animation.getStartTime() == Animation.START_ON_FIRST_FRAME) { 17998 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis()); 17999 } 18000 animation.reset(); 18001 } 18002 } 18003 18004 /** 18005 * Invoked by a parent ViewGroup to notify the start of the animation 18006 * currently associated with this view. If you override this method, 18007 * always call super.onAnimationStart(); 18008 * 18009 * @see #setAnimation(android.view.animation.Animation) 18010 * @see #getAnimation() 18011 */ 18012 protected void onAnimationStart() { 18013 mPrivateFlags |= PFLAG_ANIMATION_STARTED; 18014 } 18015 18016 /** 18017 * Invoked by a parent ViewGroup to notify the end of the animation 18018 * currently associated with this view. If you override this method, 18019 * always call super.onAnimationEnd(); 18020 * 18021 * @see #setAnimation(android.view.animation.Animation) 18022 * @see #getAnimation() 18023 */ 18024 protected void onAnimationEnd() { 18025 mPrivateFlags &= ~PFLAG_ANIMATION_STARTED; 18026 } 18027 18028 /** 18029 * Invoked if there is a Transform that involves alpha. Subclass that can 18030 * draw themselves with the specified alpha should return true, and then 18031 * respect that alpha when their onDraw() is called. If this returns false 18032 * then the view may be redirected to draw into an offscreen buffer to 18033 * fulfill the request, which will look fine, but may be slower than if the 18034 * subclass handles it internally. The default implementation returns false. 18035 * 18036 * @param alpha The alpha (0..255) to apply to the view's drawing 18037 * @return true if the view can draw with the specified alpha. 18038 */ 18039 protected boolean onSetAlpha(int alpha) { 18040 return false; 18041 } 18042 18043 /** 18044 * This is used by the RootView to perform an optimization when 18045 * the view hierarchy contains one or several SurfaceView. 18046 * SurfaceView is always considered transparent, but its children are not, 18047 * therefore all View objects remove themselves from the global transparent 18048 * region (passed as a parameter to this function). 18049 * 18050 * @param region The transparent region for this ViewAncestor (window). 18051 * 18052 * @return Returns true if the effective visibility of the view at this 18053 * point is opaque, regardless of the transparent region; returns false 18054 * if it is possible for underlying windows to be seen behind the view. 18055 * 18056 * {@hide} 18057 */ 18058 public boolean gatherTransparentRegion(Region region) { 18059 final AttachInfo attachInfo = mAttachInfo; 18060 if (region != null && attachInfo != null) { 18061 final int pflags = mPrivateFlags; 18062 if ((pflags & PFLAG_SKIP_DRAW) == 0) { 18063 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 18064 // remove it from the transparent region. 18065 final int[] location = attachInfo.mTransparentLocation; 18066 getLocationInWindow(location); 18067 region.op(location[0], location[1], location[0] + mRight - mLeft, 18068 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 18069 } else if ((pflags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null && 18070 mBackground.getOpacity() != PixelFormat.TRANSPARENT) { 18071 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 18072 // exists, so we remove the background drawable's non-transparent 18073 // parts from this transparent region. 18074 applyDrawableToTransparentRegion(mBackground, region); 18075 } 18076 } 18077 return true; 18078 } 18079 18080 /** 18081 * Play a sound effect for this view. 18082 * 18083 * <p>The framework will play sound effects for some built in actions, such as 18084 * clicking, but you may wish to play these effects in your widget, 18085 * for instance, for internal navigation. 18086 * 18087 * <p>The sound effect will only be played if sound effects are enabled by the user, and 18088 * {@link #isSoundEffectsEnabled()} is true. 18089 * 18090 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 18091 */ 18092 public void playSoundEffect(int soundConstant) { 18093 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 18094 return; 18095 } 18096 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 18097 } 18098 18099 /** 18100 * BZZZTT!!1! 18101 * 18102 * <p>Provide haptic feedback to the user for this view. 18103 * 18104 * <p>The framework will provide haptic feedback for some built in actions, 18105 * such as long presses, but you may wish to provide feedback for your 18106 * own widget. 18107 * 18108 * <p>The feedback will only be performed if 18109 * {@link #isHapticFeedbackEnabled()} is true. 18110 * 18111 * @param feedbackConstant One of the constants defined in 18112 * {@link HapticFeedbackConstants} 18113 */ 18114 public boolean performHapticFeedback(int feedbackConstant) { 18115 return performHapticFeedback(feedbackConstant, 0); 18116 } 18117 18118 /** 18119 * BZZZTT!!1! 18120 * 18121 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 18122 * 18123 * @param feedbackConstant One of the constants defined in 18124 * {@link HapticFeedbackConstants} 18125 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 18126 */ 18127 public boolean performHapticFeedback(int feedbackConstant, int flags) { 18128 if (mAttachInfo == null) { 18129 return false; 18130 } 18131 //noinspection SimplifiableIfStatement 18132 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 18133 && !isHapticFeedbackEnabled()) { 18134 return false; 18135 } 18136 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 18137 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 18138 } 18139 18140 /** 18141 * Request that the visibility of the status bar or other screen/window 18142 * decorations be changed. 18143 * 18144 * <p>This method is used to put the over device UI into temporary modes 18145 * where the user's attention is focused more on the application content, 18146 * by dimming or hiding surrounding system affordances. This is typically 18147 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY 18148 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content 18149 * to be placed behind the action bar (and with these flags other system 18150 * affordances) so that smooth transitions between hiding and showing them 18151 * can be done. 18152 * 18153 * <p>Two representative examples of the use of system UI visibility is 18154 * implementing a content browsing application (like a magazine reader) 18155 * and a video playing application. 18156 * 18157 * <p>The first code shows a typical implementation of a View in a content 18158 * browsing application. In this implementation, the application goes 18159 * into a content-oriented mode by hiding the status bar and action bar, 18160 * and putting the navigation elements into lights out mode. The user can 18161 * then interact with content while in this mode. Such an application should 18162 * provide an easy way for the user to toggle out of the mode (such as to 18163 * check information in the status bar or access notifications). In the 18164 * implementation here, this is done simply by tapping on the content. 18165 * 18166 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java 18167 * content} 18168 * 18169 * <p>This second code sample shows a typical implementation of a View 18170 * in a video playing application. In this situation, while the video is 18171 * playing the application would like to go into a complete full-screen mode, 18172 * to use as much of the display as possible for the video. When in this state 18173 * the user can not interact with the application; the system intercepts 18174 * touching on the screen to pop the UI out of full screen mode. See 18175 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code. 18176 * 18177 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java 18178 * content} 18179 * 18180 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18181 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18182 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18183 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18184 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18185 */ 18186 public void setSystemUiVisibility(int visibility) { 18187 if (visibility != mSystemUiVisibility) { 18188 mSystemUiVisibility = visibility; 18189 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18190 mParent.recomputeViewAttributes(this); 18191 } 18192 } 18193 } 18194 18195 /** 18196 * Returns the last {@link #setSystemUiVisibility(int)} that this view has requested. 18197 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18198 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18199 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18200 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18201 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18202 */ 18203 public int getSystemUiVisibility() { 18204 return mSystemUiVisibility; 18205 } 18206 18207 /** 18208 * Returns the current system UI visibility that is currently set for 18209 * the entire window. This is the combination of the 18210 * {@link #setSystemUiVisibility(int)} values supplied by all of the 18211 * views in the window. 18212 */ 18213 public int getWindowSystemUiVisibility() { 18214 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0; 18215 } 18216 18217 /** 18218 * Override to find out when the window's requested system UI visibility 18219 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}. 18220 * This is different from the callbacks received through 18221 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)} 18222 * in that this is only telling you about the local request of the window, 18223 * not the actual values applied by the system. 18224 */ 18225 public void onWindowSystemUiVisibilityChanged(int visible) { 18226 } 18227 18228 /** 18229 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down 18230 * the view hierarchy. 18231 */ 18232 public void dispatchWindowSystemUiVisiblityChanged(int visible) { 18233 onWindowSystemUiVisibilityChanged(visible); 18234 } 18235 18236 /** 18237 * Set a listener to receive callbacks when the visibility of the system bar changes. 18238 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 18239 */ 18240 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 18241 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 18242 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18243 mParent.recomputeViewAttributes(this); 18244 } 18245 } 18246 18247 /** 18248 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 18249 * the view hierarchy. 18250 */ 18251 public void dispatchSystemUiVisibilityChanged(int visibility) { 18252 ListenerInfo li = mListenerInfo; 18253 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 18254 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 18255 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 18256 } 18257 } 18258 18259 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) { 18260 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 18261 if (val != mSystemUiVisibility) { 18262 setSystemUiVisibility(val); 18263 return true; 18264 } 18265 return false; 18266 } 18267 18268 /** @hide */ 18269 public void setDisabledSystemUiVisibility(int flags) { 18270 if (mAttachInfo != null) { 18271 if (mAttachInfo.mDisabledSystemUiVisibility != flags) { 18272 mAttachInfo.mDisabledSystemUiVisibility = flags; 18273 if (mParent != null) { 18274 mParent.recomputeViewAttributes(this); 18275 } 18276 } 18277 } 18278 } 18279 18280 /** 18281 * Creates an image that the system displays during the drag and drop 18282 * operation. This is called a "drag shadow". The default implementation 18283 * for a DragShadowBuilder based on a View returns an image that has exactly the same 18284 * appearance as the given View. The default also positions the center of the drag shadow 18285 * directly under the touch point. If no View is provided (the constructor with no parameters 18286 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 18287 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 18288 * default is an invisible drag shadow. 18289 * <p> 18290 * You are not required to use the View you provide to the constructor as the basis of the 18291 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 18292 * anything you want as the drag shadow. 18293 * </p> 18294 * <p> 18295 * You pass a DragShadowBuilder object to the system when you start the drag. The system 18296 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 18297 * size and position of the drag shadow. It uses this data to construct a 18298 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 18299 * so that your application can draw the shadow image in the Canvas. 18300 * </p> 18301 * 18302 * <div class="special reference"> 18303 * <h3>Developer Guides</h3> 18304 * <p>For a guide to implementing drag and drop features, read the 18305 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 18306 * </div> 18307 */ 18308 public static class DragShadowBuilder { 18309 private final WeakReference<View> mView; 18310 18311 /** 18312 * Constructs a shadow image builder based on a View. By default, the resulting drag 18313 * shadow will have the same appearance and dimensions as the View, with the touch point 18314 * over the center of the View. 18315 * @param view A View. Any View in scope can be used. 18316 */ 18317 public DragShadowBuilder(View view) { 18318 mView = new WeakReference<View>(view); 18319 } 18320 18321 /** 18322 * Construct a shadow builder object with no associated View. This 18323 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 18324 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 18325 * to supply the drag shadow's dimensions and appearance without 18326 * reference to any View object. If they are not overridden, then the result is an 18327 * invisible drag shadow. 18328 */ 18329 public DragShadowBuilder() { 18330 mView = new WeakReference<View>(null); 18331 } 18332 18333 /** 18334 * Returns the View object that had been passed to the 18335 * {@link #View.DragShadowBuilder(View)} 18336 * constructor. If that View parameter was {@code null} or if the 18337 * {@link #View.DragShadowBuilder()} 18338 * constructor was used to instantiate the builder object, this method will return 18339 * null. 18340 * 18341 * @return The View object associate with this builder object. 18342 */ 18343 @SuppressWarnings({"JavadocReference"}) 18344 final public View getView() { 18345 return mView.get(); 18346 } 18347 18348 /** 18349 * Provides the metrics for the shadow image. These include the dimensions of 18350 * the shadow image, and the point within that shadow that should 18351 * be centered under the touch location while dragging. 18352 * <p> 18353 * The default implementation sets the dimensions of the shadow to be the 18354 * same as the dimensions of the View itself and centers the shadow under 18355 * the touch point. 18356 * </p> 18357 * 18358 * @param shadowSize A {@link android.graphics.Point} containing the width and height 18359 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 18360 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 18361 * image. 18362 * 18363 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 18364 * shadow image that should be underneath the touch point during the drag and drop 18365 * operation. Your application must set {@link android.graphics.Point#x} to the 18366 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 18367 */ 18368 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 18369 final View view = mView.get(); 18370 if (view != null) { 18371 shadowSize.set(view.getWidth(), view.getHeight()); 18372 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 18373 } else { 18374 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 18375 } 18376 } 18377 18378 /** 18379 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 18380 * based on the dimensions it received from the 18381 * {@link #onProvideShadowMetrics(Point, Point)} callback. 18382 * 18383 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 18384 */ 18385 public void onDrawShadow(Canvas canvas) { 18386 final View view = mView.get(); 18387 if (view != null) { 18388 view.draw(canvas); 18389 } else { 18390 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 18391 } 18392 } 18393 } 18394 18395 /** 18396 * Starts a drag and drop operation. When your application calls this method, it passes a 18397 * {@link android.view.View.DragShadowBuilder} object to the system. The 18398 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 18399 * to get metrics for the drag shadow, and then calls the object's 18400 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 18401 * <p> 18402 * Once the system has the drag shadow, it begins the drag and drop operation by sending 18403 * drag events to all the View objects in your application that are currently visible. It does 18404 * this either by calling the View object's drag listener (an implementation of 18405 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 18406 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 18407 * Both are passed a {@link android.view.DragEvent} object that has a 18408 * {@link android.view.DragEvent#getAction()} value of 18409 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 18410 * </p> 18411 * <p> 18412 * Your application can invoke startDrag() on any attached View object. The View object does not 18413 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 18414 * be related to the View the user selected for dragging. 18415 * </p> 18416 * @param data A {@link android.content.ClipData} object pointing to the data to be 18417 * transferred by the drag and drop operation. 18418 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 18419 * drag shadow. 18420 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 18421 * drop operation. This Object is put into every DragEvent object sent by the system during the 18422 * current drag. 18423 * <p> 18424 * myLocalState is a lightweight mechanism for the sending information from the dragged View 18425 * to the target Views. For example, it can contain flags that differentiate between a 18426 * a copy operation and a move operation. 18427 * </p> 18428 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 18429 * so the parameter should be set to 0. 18430 * @return {@code true} if the method completes successfully, or 18431 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 18432 * do a drag, and so no drag operation is in progress. 18433 */ 18434 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 18435 Object myLocalState, int flags) { 18436 if (ViewDebug.DEBUG_DRAG) { 18437 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 18438 } 18439 boolean okay = false; 18440 18441 Point shadowSize = new Point(); 18442 Point shadowTouchPoint = new Point(); 18443 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 18444 18445 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 18446 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 18447 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 18448 } 18449 18450 if (ViewDebug.DEBUG_DRAG) { 18451 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 18452 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 18453 } 18454 Surface surface = new Surface(); 18455 try { 18456 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 18457 flags, shadowSize.x, shadowSize.y, surface); 18458 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 18459 + " surface=" + surface); 18460 if (token != null) { 18461 Canvas canvas = surface.lockCanvas(null); 18462 try { 18463 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 18464 shadowBuilder.onDrawShadow(canvas); 18465 } finally { 18466 surface.unlockCanvasAndPost(canvas); 18467 } 18468 18469 final ViewRootImpl root = getViewRootImpl(); 18470 18471 // Cache the local state object for delivery with DragEvents 18472 root.setLocalDragState(myLocalState); 18473 18474 // repurpose 'shadowSize' for the last touch point 18475 root.getLastTouchPoint(shadowSize); 18476 18477 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 18478 shadowSize.x, shadowSize.y, 18479 shadowTouchPoint.x, shadowTouchPoint.y, data); 18480 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 18481 18482 // Off and running! Release our local surface instance; the drag 18483 // shadow surface is now managed by the system process. 18484 surface.release(); 18485 } 18486 } catch (Exception e) { 18487 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 18488 surface.destroy(); 18489 } 18490 18491 return okay; 18492 } 18493 18494 /** 18495 * Handles drag events sent by the system following a call to 18496 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 18497 *<p> 18498 * When the system calls this method, it passes a 18499 * {@link android.view.DragEvent} object. A call to 18500 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 18501 * in DragEvent. The method uses these to determine what is happening in the drag and drop 18502 * operation. 18503 * @param event The {@link android.view.DragEvent} sent by the system. 18504 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 18505 * in DragEvent, indicating the type of drag event represented by this object. 18506 * @return {@code true} if the method was successful, otherwise {@code false}. 18507 * <p> 18508 * The method should return {@code true} in response to an action type of 18509 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 18510 * operation. 18511 * </p> 18512 * <p> 18513 * The method should also return {@code true} in response to an action type of 18514 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 18515 * {@code false} if it didn't. 18516 * </p> 18517 */ 18518 public boolean onDragEvent(DragEvent event) { 18519 return false; 18520 } 18521 18522 /** 18523 * Detects if this View is enabled and has a drag event listener. 18524 * If both are true, then it calls the drag event listener with the 18525 * {@link android.view.DragEvent} it received. If the drag event listener returns 18526 * {@code true}, then dispatchDragEvent() returns {@code true}. 18527 * <p> 18528 * For all other cases, the method calls the 18529 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 18530 * method and returns its result. 18531 * </p> 18532 * <p> 18533 * This ensures that a drag event is always consumed, even if the View does not have a drag 18534 * event listener. However, if the View has a listener and the listener returns true, then 18535 * onDragEvent() is not called. 18536 * </p> 18537 */ 18538 public boolean dispatchDragEvent(DragEvent event) { 18539 ListenerInfo li = mListenerInfo; 18540 //noinspection SimplifiableIfStatement 18541 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 18542 && li.mOnDragListener.onDrag(this, event)) { 18543 return true; 18544 } 18545 return onDragEvent(event); 18546 } 18547 18548 boolean canAcceptDrag() { 18549 return (mPrivateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0; 18550 } 18551 18552 /** 18553 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 18554 * it is ever exposed at all. 18555 * @hide 18556 */ 18557 public void onCloseSystemDialogs(String reason) { 18558 } 18559 18560 /** 18561 * Given a Drawable whose bounds have been set to draw into this view, 18562 * update a Region being computed for 18563 * {@link #gatherTransparentRegion(android.graphics.Region)} so 18564 * that any non-transparent parts of the Drawable are removed from the 18565 * given transparent region. 18566 * 18567 * @param dr The Drawable whose transparency is to be applied to the region. 18568 * @param region A Region holding the current transparency information, 18569 * where any parts of the region that are set are considered to be 18570 * transparent. On return, this region will be modified to have the 18571 * transparency information reduced by the corresponding parts of the 18572 * Drawable that are not transparent. 18573 * {@hide} 18574 */ 18575 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 18576 if (DBG) { 18577 Log.i("View", "Getting transparent region for: " + this); 18578 } 18579 final Region r = dr.getTransparentRegion(); 18580 final Rect db = dr.getBounds(); 18581 final AttachInfo attachInfo = mAttachInfo; 18582 if (r != null && attachInfo != null) { 18583 final int w = getRight()-getLeft(); 18584 final int h = getBottom()-getTop(); 18585 if (db.left > 0) { 18586 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 18587 r.op(0, 0, db.left, h, Region.Op.UNION); 18588 } 18589 if (db.right < w) { 18590 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 18591 r.op(db.right, 0, w, h, Region.Op.UNION); 18592 } 18593 if (db.top > 0) { 18594 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 18595 r.op(0, 0, w, db.top, Region.Op.UNION); 18596 } 18597 if (db.bottom < h) { 18598 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 18599 r.op(0, db.bottom, w, h, Region.Op.UNION); 18600 } 18601 final int[] location = attachInfo.mTransparentLocation; 18602 getLocationInWindow(location); 18603 r.translate(location[0], location[1]); 18604 region.op(r, Region.Op.INTERSECT); 18605 } else { 18606 region.op(db, Region.Op.DIFFERENCE); 18607 } 18608 } 18609 18610 private void checkForLongClick(int delayOffset) { 18611 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 18612 mHasPerformedLongPress = false; 18613 18614 if (mPendingCheckForLongPress == null) { 18615 mPendingCheckForLongPress = new CheckForLongPress(); 18616 } 18617 mPendingCheckForLongPress.rememberWindowAttachCount(); 18618 postDelayed(mPendingCheckForLongPress, 18619 ViewConfiguration.getLongPressTimeout() - delayOffset); 18620 } 18621 } 18622 18623 /** 18624 * Inflate a view from an XML resource. This convenience method wraps the {@link 18625 * LayoutInflater} class, which provides a full range of options for view inflation. 18626 * 18627 * @param context The Context object for your activity or application. 18628 * @param resource The resource ID to inflate 18629 * @param root A view group that will be the parent. Used to properly inflate the 18630 * layout_* parameters. 18631 * @see LayoutInflater 18632 */ 18633 public static View inflate(Context context, int resource, ViewGroup root) { 18634 LayoutInflater factory = LayoutInflater.from(context); 18635 return factory.inflate(resource, root); 18636 } 18637 18638 /** 18639 * Scroll the view with standard behavior for scrolling beyond the normal 18640 * content boundaries. Views that call this method should override 18641 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 18642 * results of an over-scroll operation. 18643 * 18644 * Views can use this method to handle any touch or fling-based scrolling. 18645 * 18646 * @param deltaX Change in X in pixels 18647 * @param deltaY Change in Y in pixels 18648 * @param scrollX Current X scroll value in pixels before applying deltaX 18649 * @param scrollY Current Y scroll value in pixels before applying deltaY 18650 * @param scrollRangeX Maximum content scroll range along the X axis 18651 * @param scrollRangeY Maximum content scroll range along the Y axis 18652 * @param maxOverScrollX Number of pixels to overscroll by in either direction 18653 * along the X axis. 18654 * @param maxOverScrollY Number of pixels to overscroll by in either direction 18655 * along the Y axis. 18656 * @param isTouchEvent true if this scroll operation is the result of a touch event. 18657 * @return true if scrolling was clamped to an over-scroll boundary along either 18658 * axis, false otherwise. 18659 */ 18660 @SuppressWarnings({"UnusedParameters"}) 18661 protected boolean overScrollBy(int deltaX, int deltaY, 18662 int scrollX, int scrollY, 18663 int scrollRangeX, int scrollRangeY, 18664 int maxOverScrollX, int maxOverScrollY, 18665 boolean isTouchEvent) { 18666 final int overScrollMode = mOverScrollMode; 18667 final boolean canScrollHorizontal = 18668 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 18669 final boolean canScrollVertical = 18670 computeVerticalScrollRange() > computeVerticalScrollExtent(); 18671 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 18672 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 18673 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 18674 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 18675 18676 int newScrollX = scrollX + deltaX; 18677 if (!overScrollHorizontal) { 18678 maxOverScrollX = 0; 18679 } 18680 18681 int newScrollY = scrollY + deltaY; 18682 if (!overScrollVertical) { 18683 maxOverScrollY = 0; 18684 } 18685 18686 // Clamp values if at the limits and record 18687 final int left = -maxOverScrollX; 18688 final int right = maxOverScrollX + scrollRangeX; 18689 final int top = -maxOverScrollY; 18690 final int bottom = maxOverScrollY + scrollRangeY; 18691 18692 boolean clampedX = false; 18693 if (newScrollX > right) { 18694 newScrollX = right; 18695 clampedX = true; 18696 } else if (newScrollX < left) { 18697 newScrollX = left; 18698 clampedX = true; 18699 } 18700 18701 boolean clampedY = false; 18702 if (newScrollY > bottom) { 18703 newScrollY = bottom; 18704 clampedY = true; 18705 } else if (newScrollY < top) { 18706 newScrollY = top; 18707 clampedY = true; 18708 } 18709 18710 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 18711 18712 return clampedX || clampedY; 18713 } 18714 18715 /** 18716 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 18717 * respond to the results of an over-scroll operation. 18718 * 18719 * @param scrollX New X scroll value in pixels 18720 * @param scrollY New Y scroll value in pixels 18721 * @param clampedX True if scrollX was clamped to an over-scroll boundary 18722 * @param clampedY True if scrollY was clamped to an over-scroll boundary 18723 */ 18724 protected void onOverScrolled(int scrollX, int scrollY, 18725 boolean clampedX, boolean clampedY) { 18726 // Intentionally empty. 18727 } 18728 18729 /** 18730 * Returns the over-scroll mode for this view. The result will be 18731 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18732 * (allow over-scrolling only if the view content is larger than the container), 18733 * or {@link #OVER_SCROLL_NEVER}. 18734 * 18735 * @return This view's over-scroll mode. 18736 */ 18737 public int getOverScrollMode() { 18738 return mOverScrollMode; 18739 } 18740 18741 /** 18742 * Set the over-scroll mode for this view. Valid over-scroll modes are 18743 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18744 * (allow over-scrolling only if the view content is larger than the container), 18745 * or {@link #OVER_SCROLL_NEVER}. 18746 * 18747 * Setting the over-scroll mode of a view will have an effect only if the 18748 * view is capable of scrolling. 18749 * 18750 * @param overScrollMode The new over-scroll mode for this view. 18751 */ 18752 public void setOverScrollMode(int overScrollMode) { 18753 if (overScrollMode != OVER_SCROLL_ALWAYS && 18754 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 18755 overScrollMode != OVER_SCROLL_NEVER) { 18756 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 18757 } 18758 mOverScrollMode = overScrollMode; 18759 } 18760 18761 /** 18762 * Enable or disable nested scrolling for this view. 18763 * 18764 * <p>If this property is set to true the view will be permitted to initiate nested 18765 * scrolling operations with a compatible parent view in the current hierarchy. If this 18766 * view does not implement nested scrolling this will have no effect. Disabling nested scrolling 18767 * while a nested scroll is in progress has the effect of {@link #stopNestedScroll() stopping} 18768 * the nested scroll.</p> 18769 * 18770 * @param enabled true to enable nested scrolling, false to disable 18771 * 18772 * @see #isNestedScrollingEnabled() 18773 */ 18774 public void setNestedScrollingEnabled(boolean enabled) { 18775 if (enabled) { 18776 mPrivateFlags3 |= PFLAG3_NESTED_SCROLLING_ENABLED; 18777 } else { 18778 stopNestedScroll(); 18779 mPrivateFlags3 &= ~PFLAG3_NESTED_SCROLLING_ENABLED; 18780 } 18781 } 18782 18783 /** 18784 * Returns true if nested scrolling is enabled for this view. 18785 * 18786 * <p>If nested scrolling is enabled and this View class implementation supports it, 18787 * this view will act as a nested scrolling child view when applicable, forwarding data 18788 * about the scroll operation in progress to a compatible and cooperating nested scrolling 18789 * parent.</p> 18790 * 18791 * @return true if nested scrolling is enabled 18792 * 18793 * @see #setNestedScrollingEnabled(boolean) 18794 */ 18795 public boolean isNestedScrollingEnabled() { 18796 return (mPrivateFlags3 & PFLAG3_NESTED_SCROLLING_ENABLED) == 18797 PFLAG3_NESTED_SCROLLING_ENABLED; 18798 } 18799 18800 /** 18801 * Begin a nestable scroll operation along the given axes. 18802 * 18803 * <p>A view starting a nested scroll promises to abide by the following contract:</p> 18804 * 18805 * <p>The view will call startNestedScroll upon initiating a scroll operation. In the case 18806 * of a touch scroll this corresponds to the initial {@link MotionEvent#ACTION_DOWN}. 18807 * In the case of touch scrolling the nested scroll will be terminated automatically in 18808 * the same manner as {@link ViewParent#requestDisallowInterceptTouchEvent(boolean)}. 18809 * In the event of programmatic scrolling the caller must explicitly call 18810 * {@link #stopNestedScroll()} to indicate the end of the nested scroll.</p> 18811 * 18812 * <p>If <code>startNestedScroll</code> returns true, a cooperative parent was found. 18813 * If it returns false the caller may ignore the rest of this contract until the next scroll. 18814 * Calling startNestedScroll while a nested scroll is already in progress will return true.</p> 18815 * 18816 * <p>At each incremental step of the scroll the caller should invoke 18817 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} 18818 * once it has calculated the requested scrolling delta. If it returns true the nested scrolling 18819 * parent at least partially consumed the scroll and the caller should adjust the amount it 18820 * scrolls by.</p> 18821 * 18822 * <p>After applying the remainder of the scroll delta the caller should invoke 18823 * {@link #dispatchNestedScroll(int, int, int, int, int[]) dispatchNestedScroll}, passing 18824 * both the delta consumed and the delta unconsumed. A nested scrolling parent may treat 18825 * these values differently. See {@link ViewParent#onNestedScroll(View, int, int, int, int)}. 18826 * </p> 18827 * 18828 * @param axes Flags consisting of a combination of {@link #SCROLL_AXIS_HORIZONTAL} and/or 18829 * {@link #SCROLL_AXIS_VERTICAL}. 18830 * @return true if a cooperative parent was found and nested scrolling has been enabled for 18831 * the current gesture. 18832 * 18833 * @see #stopNestedScroll() 18834 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18835 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18836 */ 18837 public boolean startNestedScroll(int axes) { 18838 if (hasNestedScrollingParent()) { 18839 // Already in progress 18840 return true; 18841 } 18842 if (isNestedScrollingEnabled()) { 18843 ViewParent p = getParent(); 18844 View child = this; 18845 while (p != null) { 18846 try { 18847 if (p.onStartNestedScroll(child, this, axes)) { 18848 mNestedScrollingParent = p; 18849 p.onNestedScrollAccepted(child, this, axes); 18850 return true; 18851 } 18852 } catch (AbstractMethodError e) { 18853 Log.e(VIEW_LOG_TAG, "ViewParent " + p + " does not implement interface " + 18854 "method onStartNestedScroll", e); 18855 // Allow the search upward to continue 18856 } 18857 if (p instanceof View) { 18858 child = (View) p; 18859 } 18860 p = p.getParent(); 18861 } 18862 } 18863 return false; 18864 } 18865 18866 /** 18867 * Stop a nested scroll in progress. 18868 * 18869 * <p>Calling this method when a nested scroll is not currently in progress is harmless.</p> 18870 * 18871 * @see #startNestedScroll(int) 18872 */ 18873 public void stopNestedScroll() { 18874 if (mNestedScrollingParent != null) { 18875 mNestedScrollingParent.onStopNestedScroll(this); 18876 mNestedScrollingParent = null; 18877 } 18878 } 18879 18880 /** 18881 * Returns true if this view has a nested scrolling parent. 18882 * 18883 * <p>The presence of a nested scrolling parent indicates that this view has initiated 18884 * a nested scroll and it was accepted by an ancestor view further up the view hierarchy.</p> 18885 * 18886 * @return whether this view has a nested scrolling parent 18887 */ 18888 public boolean hasNestedScrollingParent() { 18889 return mNestedScrollingParent != null; 18890 } 18891 18892 /** 18893 * Dispatch one step of a nested scroll in progress. 18894 * 18895 * <p>Implementations of views that support nested scrolling should call this to report 18896 * info about a scroll in progress to the current nested scrolling parent. If a nested scroll 18897 * is not currently in progress or nested scrolling is not 18898 * {@link #isNestedScrollingEnabled() enabled} for this view this method does nothing.</p> 18899 * 18900 * <p>Compatible View implementations should also call 18901 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} before 18902 * consuming a component of the scroll event themselves.</p> 18903 * 18904 * @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step 18905 * @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step 18906 * @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view 18907 * @param dyUnconsumed Horizontal scroll distance in pixels not consumed by this view 18908 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18909 * in local view coordinates of this view from before this operation 18910 * to after it completes. View implementations may use this to adjust 18911 * expected input coordinate tracking. 18912 * @return true if the event was dispatched, false if it could not be dispatched. 18913 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18914 */ 18915 public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed, 18916 int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) { 18917 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18918 if (dxConsumed != 0 || dyConsumed != 0 || dxUnconsumed != 0 || dyUnconsumed != 0) { 18919 int startX = 0; 18920 int startY = 0; 18921 if (offsetInWindow != null) { 18922 getLocationInWindow(offsetInWindow); 18923 startX = offsetInWindow[0]; 18924 startY = offsetInWindow[1]; 18925 } 18926 18927 mNestedScrollingParent.onNestedScroll(this, dxConsumed, dyConsumed, 18928 dxUnconsumed, dyUnconsumed); 18929 18930 if (offsetInWindow != null) { 18931 getLocationInWindow(offsetInWindow); 18932 offsetInWindow[0] -= startX; 18933 offsetInWindow[1] -= startY; 18934 } 18935 return true; 18936 } else if (offsetInWindow != null) { 18937 // No motion, no dispatch. Keep offsetInWindow up to date. 18938 offsetInWindow[0] = 0; 18939 offsetInWindow[1] = 0; 18940 } 18941 } 18942 return false; 18943 } 18944 18945 /** 18946 * Dispatch one step of a nested scroll in progress before this view consumes any portion of it. 18947 * 18948 * <p>Nested pre-scroll events are to nested scroll events what touch intercept is to touch. 18949 * <code>dispatchNestedPreScroll</code> offers an opportunity for the parent view in a nested 18950 * scrolling operation to consume some or all of the scroll operation before the child view 18951 * consumes it.</p> 18952 * 18953 * @param dx Horizontal scroll distance in pixels 18954 * @param dy Vertical scroll distance in pixels 18955 * @param consumed Output. If not null, consumed[0] will contain the consumed component of dx 18956 * and consumed[1] the consumed dy. 18957 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18958 * in local view coordinates of this view from before this operation 18959 * to after it completes. View implementations may use this to adjust 18960 * expected input coordinate tracking. 18961 * @return true if the parent consumed some or all of the scroll delta 18962 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18963 */ 18964 public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) { 18965 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18966 if (dx != 0 || dy != 0) { 18967 int startX = 0; 18968 int startY = 0; 18969 if (offsetInWindow != null) { 18970 getLocationInWindow(offsetInWindow); 18971 startX = offsetInWindow[0]; 18972 startY = offsetInWindow[1]; 18973 } 18974 18975 if (consumed == null) { 18976 if (mTempNestedScrollConsumed == null) { 18977 mTempNestedScrollConsumed = new int[2]; 18978 } 18979 consumed = mTempNestedScrollConsumed; 18980 } 18981 consumed[0] = 0; 18982 consumed[1] = 0; 18983 mNestedScrollingParent.onNestedPreScroll(this, dx, dy, consumed); 18984 18985 if (offsetInWindow != null) { 18986 getLocationInWindow(offsetInWindow); 18987 offsetInWindow[0] -= startX; 18988 offsetInWindow[1] -= startY; 18989 } 18990 return consumed[0] != 0 || consumed[1] != 0; 18991 } else if (offsetInWindow != null) { 18992 offsetInWindow[0] = 0; 18993 offsetInWindow[1] = 0; 18994 } 18995 } 18996 return false; 18997 } 18998 18999 /** 19000 * Dispatch a fling to a nested scrolling parent. 19001 * 19002 * <p>This method should be used to indicate that a nested scrolling child has detected 19003 * suitable conditions for a fling. Generally this means that a touch scroll has ended with a 19004 * {@link VelocityTracker velocity} in the direction of scrolling that meets or exceeds 19005 * the {@link ViewConfiguration#getScaledMinimumFlingVelocity() minimum fling velocity} 19006 * along a scrollable axis.</p> 19007 * 19008 * <p>If a nested scrolling child view would normally fling but it is at the edge of 19009 * its own content, it can use this method to delegate the fling to its nested scrolling 19010 * parent instead. The parent may optionally consume the fling or observe a child fling.</p> 19011 * 19012 * @param velocityX Horizontal fling velocity in pixels per second 19013 * @param velocityY Vertical fling velocity in pixels per second 19014 * @param consumed true if the child consumed the fling, false otherwise 19015 * @return true if the nested scrolling parent consumed or otherwise reacted to the fling 19016 */ 19017 public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) { 19018 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 19019 return mNestedScrollingParent.onNestedFling(this, velocityX, velocityY, consumed); 19020 } 19021 return false; 19022 } 19023 19024 /** 19025 * Dispatch a fling to a nested scrolling parent before it is processed by this view. 19026 * 19027 * <p>Nested pre-fling events are to nested fling events what touch intercept is to touch 19028 * and what nested pre-scroll is to nested scroll. <code>dispatchNestedPreFling</code> 19029 * offsets an opportunity for the parent view in a nested fling to fully consume the fling 19030 * before the child view consumes it. If this method returns <code>true</code>, a nested 19031 * parent view consumed the fling and this view should not scroll as a result.</p> 19032 * 19033 * <p>For a better user experience, only one view in a nested scrolling chain should consume 19034 * the fling at a time. If a parent view consumed the fling this method will return false. 19035 * Custom view implementations should account for this in two ways:</p> 19036 * 19037 * <ul> 19038 * <li>If a custom view is paged and needs to settle to a fixed page-point, do not 19039 * call <code>dispatchNestedPreFling</code>; consume the fling and settle to a valid 19040 * position regardless.</li> 19041 * <li>If a nested parent does consume the fling, this view should not scroll at all, 19042 * even to settle back to a valid idle position.</li> 19043 * </ul> 19044 * 19045 * <p>Views should also not offer fling velocities to nested parent views along an axis 19046 * where scrolling is not currently supported; a {@link android.widget.ScrollView ScrollView} 19047 * should not offer a horizontal fling velocity to its parents since scrolling along that 19048 * axis is not permitted and carrying velocity along that motion does not make sense.</p> 19049 * 19050 * @param velocityX Horizontal fling velocity in pixels per second 19051 * @param velocityY Vertical fling velocity in pixels per second 19052 * @return true if a nested scrolling parent consumed the fling 19053 */ 19054 public boolean dispatchNestedPreFling(float velocityX, float velocityY) { 19055 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 19056 return mNestedScrollingParent.onNestedPreFling(this, velocityX, velocityY); 19057 } 19058 return false; 19059 } 19060 19061 /** 19062 * Gets a scale factor that determines the distance the view should scroll 19063 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 19064 * @return The vertical scroll scale factor. 19065 * @hide 19066 */ 19067 protected float getVerticalScrollFactor() { 19068 if (mVerticalScrollFactor == 0) { 19069 TypedValue outValue = new TypedValue(); 19070 if (!mContext.getTheme().resolveAttribute( 19071 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 19072 throw new IllegalStateException( 19073 "Expected theme to define listPreferredItemHeight."); 19074 } 19075 mVerticalScrollFactor = outValue.getDimension( 19076 mContext.getResources().getDisplayMetrics()); 19077 } 19078 return mVerticalScrollFactor; 19079 } 19080 19081 /** 19082 * Gets a scale factor that determines the distance the view should scroll 19083 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 19084 * @return The horizontal scroll scale factor. 19085 * @hide 19086 */ 19087 protected float getHorizontalScrollFactor() { 19088 // TODO: Should use something else. 19089 return getVerticalScrollFactor(); 19090 } 19091 19092 /** 19093 * Return the value specifying the text direction or policy that was set with 19094 * {@link #setTextDirection(int)}. 19095 * 19096 * @return the defined text direction. It can be one of: 19097 * 19098 * {@link #TEXT_DIRECTION_INHERIT}, 19099 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19100 * {@link #TEXT_DIRECTION_ANY_RTL}, 19101 * {@link #TEXT_DIRECTION_LTR}, 19102 * {@link #TEXT_DIRECTION_RTL}, 19103 * {@link #TEXT_DIRECTION_LOCALE} 19104 * 19105 * @attr ref android.R.styleable#View_textDirection 19106 * 19107 * @hide 19108 */ 19109 @ViewDebug.ExportedProperty(category = "text", mapping = { 19110 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19111 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19112 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19113 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19114 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19115 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19116 }) 19117 public int getRawTextDirection() { 19118 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_MASK) >> PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 19119 } 19120 19121 /** 19122 * Set the text direction. 19123 * 19124 * @param textDirection the direction to set. Should be one of: 19125 * 19126 * {@link #TEXT_DIRECTION_INHERIT}, 19127 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19128 * {@link #TEXT_DIRECTION_ANY_RTL}, 19129 * {@link #TEXT_DIRECTION_LTR}, 19130 * {@link #TEXT_DIRECTION_RTL}, 19131 * {@link #TEXT_DIRECTION_LOCALE} 19132 * 19133 * Resolution will be done if the value is set to TEXT_DIRECTION_INHERIT. The resolution 19134 * proceeds up the parent chain of the view to get the value. If there is no parent, then it will 19135 * return the default {@link #TEXT_DIRECTION_FIRST_STRONG}. 19136 * 19137 * @attr ref android.R.styleable#View_textDirection 19138 */ 19139 public void setTextDirection(int textDirection) { 19140 if (getRawTextDirection() != textDirection) { 19141 // Reset the current text direction and the resolved one 19142 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 19143 resetResolvedTextDirection(); 19144 // Set the new text direction 19145 mPrivateFlags2 |= ((textDirection << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) & PFLAG2_TEXT_DIRECTION_MASK); 19146 // Do resolution 19147 resolveTextDirection(); 19148 // Notify change 19149 onRtlPropertiesChanged(getLayoutDirection()); 19150 // Refresh 19151 requestLayout(); 19152 invalidate(true); 19153 } 19154 } 19155 19156 /** 19157 * Return the resolved text direction. 19158 * 19159 * @return the resolved text direction. Returns one of: 19160 * 19161 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19162 * {@link #TEXT_DIRECTION_ANY_RTL}, 19163 * {@link #TEXT_DIRECTION_LTR}, 19164 * {@link #TEXT_DIRECTION_RTL}, 19165 * {@link #TEXT_DIRECTION_LOCALE} 19166 * 19167 * @attr ref android.R.styleable#View_textDirection 19168 */ 19169 @ViewDebug.ExportedProperty(category = "text", mapping = { 19170 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19171 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19172 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19173 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19174 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19175 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19176 }) 19177 public int getTextDirection() { 19178 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED_MASK) >> PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 19179 } 19180 19181 /** 19182 * Resolve the text direction. 19183 * 19184 * @return true if resolution has been done, false otherwise. 19185 * 19186 * @hide 19187 */ 19188 public boolean resolveTextDirection() { 19189 // Reset any previous text direction resolution 19190 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19191 19192 if (hasRtlSupport()) { 19193 // Set resolved text direction flag depending on text direction flag 19194 final int textDirection = getRawTextDirection(); 19195 switch(textDirection) { 19196 case TEXT_DIRECTION_INHERIT: 19197 if (!canResolveTextDirection()) { 19198 // We cannot do the resolution if there is no parent, so use the default one 19199 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19200 // Resolution will need to happen again later 19201 return false; 19202 } 19203 19204 // Parent has not yet resolved, so we still return the default 19205 try { 19206 if (!mParent.isTextDirectionResolved()) { 19207 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19208 // Resolution will need to happen again later 19209 return false; 19210 } 19211 } catch (AbstractMethodError e) { 19212 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19213 " does not fully implement ViewParent", e); 19214 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED | 19215 PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19216 return true; 19217 } 19218 19219 // Set current resolved direction to the same value as the parent's one 19220 int parentResolvedDirection; 19221 try { 19222 parentResolvedDirection = mParent.getTextDirection(); 19223 } catch (AbstractMethodError e) { 19224 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19225 " does not fully implement ViewParent", e); 19226 parentResolvedDirection = TEXT_DIRECTION_LTR; 19227 } 19228 switch (parentResolvedDirection) { 19229 case TEXT_DIRECTION_FIRST_STRONG: 19230 case TEXT_DIRECTION_ANY_RTL: 19231 case TEXT_DIRECTION_LTR: 19232 case TEXT_DIRECTION_RTL: 19233 case TEXT_DIRECTION_LOCALE: 19234 mPrivateFlags2 |= 19235 (parentResolvedDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19236 break; 19237 default: 19238 // Default resolved direction is "first strong" heuristic 19239 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19240 } 19241 break; 19242 case TEXT_DIRECTION_FIRST_STRONG: 19243 case TEXT_DIRECTION_ANY_RTL: 19244 case TEXT_DIRECTION_LTR: 19245 case TEXT_DIRECTION_RTL: 19246 case TEXT_DIRECTION_LOCALE: 19247 // Resolved direction is the same as text direction 19248 mPrivateFlags2 |= (textDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19249 break; 19250 default: 19251 // Default resolved direction is "first strong" heuristic 19252 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19253 } 19254 } else { 19255 // Default resolved direction is "first strong" heuristic 19256 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19257 } 19258 19259 // Set to resolved 19260 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED; 19261 return true; 19262 } 19263 19264 /** 19265 * Check if text direction resolution can be done. 19266 * 19267 * @return true if text direction resolution can be done otherwise return false. 19268 */ 19269 public boolean canResolveTextDirection() { 19270 switch (getRawTextDirection()) { 19271 case TEXT_DIRECTION_INHERIT: 19272 if (mParent != null) { 19273 try { 19274 return mParent.canResolveTextDirection(); 19275 } catch (AbstractMethodError e) { 19276 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19277 " does not fully implement ViewParent", e); 19278 } 19279 } 19280 return false; 19281 19282 default: 19283 return true; 19284 } 19285 } 19286 19287 /** 19288 * Reset resolved text direction. Text direction will be resolved during a call to 19289 * {@link #onMeasure(int, int)}. 19290 * 19291 * @hide 19292 */ 19293 public void resetResolvedTextDirection() { 19294 // Reset any previous text direction resolution 19295 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19296 // Set to default value 19297 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19298 } 19299 19300 /** 19301 * @return true if text direction is inherited. 19302 * 19303 * @hide 19304 */ 19305 public boolean isTextDirectionInherited() { 19306 return (getRawTextDirection() == TEXT_DIRECTION_INHERIT); 19307 } 19308 19309 /** 19310 * @return true if text direction is resolved. 19311 */ 19312 public boolean isTextDirectionResolved() { 19313 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED) == PFLAG2_TEXT_DIRECTION_RESOLVED; 19314 } 19315 19316 /** 19317 * Return the value specifying the text alignment or policy that was set with 19318 * {@link #setTextAlignment(int)}. 19319 * 19320 * @return the defined text alignment. It can be one of: 19321 * 19322 * {@link #TEXT_ALIGNMENT_INHERIT}, 19323 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19324 * {@link #TEXT_ALIGNMENT_CENTER}, 19325 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19326 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19327 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19328 * {@link #TEXT_ALIGNMENT_VIEW_END} 19329 * 19330 * @attr ref android.R.styleable#View_textAlignment 19331 * 19332 * @hide 19333 */ 19334 @ViewDebug.ExportedProperty(category = "text", mapping = { 19335 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19336 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19337 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19338 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19339 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19340 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19341 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19342 }) 19343 @TextAlignment 19344 public int getRawTextAlignment() { 19345 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_MASK) >> PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 19346 } 19347 19348 /** 19349 * Set the text alignment. 19350 * 19351 * @param textAlignment The text alignment to set. Should be one of 19352 * 19353 * {@link #TEXT_ALIGNMENT_INHERIT}, 19354 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19355 * {@link #TEXT_ALIGNMENT_CENTER}, 19356 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19357 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19358 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19359 * {@link #TEXT_ALIGNMENT_VIEW_END} 19360 * 19361 * Resolution will be done if the value is set to TEXT_ALIGNMENT_INHERIT. The resolution 19362 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 19363 * will return the default {@link #TEXT_ALIGNMENT_GRAVITY}. 19364 * 19365 * @attr ref android.R.styleable#View_textAlignment 19366 */ 19367 public void setTextAlignment(@TextAlignment int textAlignment) { 19368 if (textAlignment != getRawTextAlignment()) { 19369 // Reset the current and resolved text alignment 19370 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 19371 resetResolvedTextAlignment(); 19372 // Set the new text alignment 19373 mPrivateFlags2 |= 19374 ((textAlignment << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) & PFLAG2_TEXT_ALIGNMENT_MASK); 19375 // Do resolution 19376 resolveTextAlignment(); 19377 // Notify change 19378 onRtlPropertiesChanged(getLayoutDirection()); 19379 // Refresh 19380 requestLayout(); 19381 invalidate(true); 19382 } 19383 } 19384 19385 /** 19386 * Return the resolved text alignment. 19387 * 19388 * @return the resolved text alignment. Returns one of: 19389 * 19390 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19391 * {@link #TEXT_ALIGNMENT_CENTER}, 19392 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19393 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19394 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19395 * {@link #TEXT_ALIGNMENT_VIEW_END} 19396 * 19397 * @attr ref android.R.styleable#View_textAlignment 19398 */ 19399 @ViewDebug.ExportedProperty(category = "text", mapping = { 19400 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19401 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19402 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19403 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19404 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19405 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19406 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19407 }) 19408 @TextAlignment 19409 public int getTextAlignment() { 19410 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK) >> 19411 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 19412 } 19413 19414 /** 19415 * Resolve the text alignment. 19416 * 19417 * @return true if resolution has been done, false otherwise. 19418 * 19419 * @hide 19420 */ 19421 public boolean resolveTextAlignment() { 19422 // Reset any previous text alignment resolution 19423 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19424 19425 if (hasRtlSupport()) { 19426 // Set resolved text alignment flag depending on text alignment flag 19427 final int textAlignment = getRawTextAlignment(); 19428 switch (textAlignment) { 19429 case TEXT_ALIGNMENT_INHERIT: 19430 // Check if we can resolve the text alignment 19431 if (!canResolveTextAlignment()) { 19432 // We cannot do the resolution if there is no parent so use the default 19433 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19434 // Resolution will need to happen again later 19435 return false; 19436 } 19437 19438 // Parent has not yet resolved, so we still return the default 19439 try { 19440 if (!mParent.isTextAlignmentResolved()) { 19441 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19442 // Resolution will need to happen again later 19443 return false; 19444 } 19445 } catch (AbstractMethodError e) { 19446 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19447 " does not fully implement ViewParent", e); 19448 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED | 19449 PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19450 return true; 19451 } 19452 19453 int parentResolvedTextAlignment; 19454 try { 19455 parentResolvedTextAlignment = mParent.getTextAlignment(); 19456 } catch (AbstractMethodError e) { 19457 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19458 " does not fully implement ViewParent", e); 19459 parentResolvedTextAlignment = TEXT_ALIGNMENT_GRAVITY; 19460 } 19461 switch (parentResolvedTextAlignment) { 19462 case TEXT_ALIGNMENT_GRAVITY: 19463 case TEXT_ALIGNMENT_TEXT_START: 19464 case TEXT_ALIGNMENT_TEXT_END: 19465 case TEXT_ALIGNMENT_CENTER: 19466 case TEXT_ALIGNMENT_VIEW_START: 19467 case TEXT_ALIGNMENT_VIEW_END: 19468 // Resolved text alignment is the same as the parent resolved 19469 // text alignment 19470 mPrivateFlags2 |= 19471 (parentResolvedTextAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19472 break; 19473 default: 19474 // Use default resolved text alignment 19475 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19476 } 19477 break; 19478 case TEXT_ALIGNMENT_GRAVITY: 19479 case TEXT_ALIGNMENT_TEXT_START: 19480 case TEXT_ALIGNMENT_TEXT_END: 19481 case TEXT_ALIGNMENT_CENTER: 19482 case TEXT_ALIGNMENT_VIEW_START: 19483 case TEXT_ALIGNMENT_VIEW_END: 19484 // Resolved text alignment is the same as text alignment 19485 mPrivateFlags2 |= (textAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19486 break; 19487 default: 19488 // Use default resolved text alignment 19489 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19490 } 19491 } else { 19492 // Use default resolved text alignment 19493 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19494 } 19495 19496 // Set the resolved 19497 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19498 return true; 19499 } 19500 19501 /** 19502 * Check if text alignment resolution can be done. 19503 * 19504 * @return true if text alignment resolution can be done otherwise return false. 19505 */ 19506 public boolean canResolveTextAlignment() { 19507 switch (getRawTextAlignment()) { 19508 case TEXT_DIRECTION_INHERIT: 19509 if (mParent != null) { 19510 try { 19511 return mParent.canResolveTextAlignment(); 19512 } catch (AbstractMethodError e) { 19513 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19514 " does not fully implement ViewParent", e); 19515 } 19516 } 19517 return false; 19518 19519 default: 19520 return true; 19521 } 19522 } 19523 19524 /** 19525 * Reset resolved text alignment. Text alignment will be resolved during a call to 19526 * {@link #onMeasure(int, int)}. 19527 * 19528 * @hide 19529 */ 19530 public void resetResolvedTextAlignment() { 19531 // Reset any previous text alignment resolution 19532 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19533 // Set to default 19534 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19535 } 19536 19537 /** 19538 * @return true if text alignment is inherited. 19539 * 19540 * @hide 19541 */ 19542 public boolean isTextAlignmentInherited() { 19543 return (getRawTextAlignment() == TEXT_ALIGNMENT_INHERIT); 19544 } 19545 19546 /** 19547 * @return true if text alignment is resolved. 19548 */ 19549 public boolean isTextAlignmentResolved() { 19550 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED) == PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19551 } 19552 19553 /** 19554 * Generate a value suitable for use in {@link #setId(int)}. 19555 * This value will not collide with ID values generated at build time by aapt for R.id. 19556 * 19557 * @return a generated ID value 19558 */ 19559 public static int generateViewId() { 19560 for (;;) { 19561 final int result = sNextGeneratedId.get(); 19562 // aapt-generated IDs have the high byte nonzero; clamp to the range under that. 19563 int newValue = result + 1; 19564 if (newValue > 0x00FFFFFF) newValue = 1; // Roll over to 1, not 0. 19565 if (sNextGeneratedId.compareAndSet(result, newValue)) { 19566 return result; 19567 } 19568 } 19569 } 19570 19571 /** 19572 * Gets the Views in the hierarchy affected by entering and exiting Activity Scene transitions. 19573 * @param transitioningViews This View will be added to transitioningViews if it is VISIBLE and 19574 * a normal View or a ViewGroup with 19575 * {@link android.view.ViewGroup#isTransitionGroup()} true. 19576 * @hide 19577 */ 19578 public void captureTransitioningViews(List<View> transitioningViews) { 19579 if (getVisibility() == View.VISIBLE) { 19580 transitioningViews.add(this); 19581 } 19582 } 19583 19584 /** 19585 * Adds all Views that have {@link #getTransitionName()} non-null to namedElements. 19586 * @param namedElements Will contain all Views in the hierarchy having a transitionName. 19587 * @hide 19588 */ 19589 public void findNamedViews(Map<String, View> namedElements) { 19590 if (getVisibility() == VISIBLE || mGhostView != null) { 19591 String transitionName = getTransitionName(); 19592 if (transitionName != null) { 19593 namedElements.put(transitionName, this); 19594 } 19595 } 19596 } 19597 19598 // 19599 // Properties 19600 // 19601 /** 19602 * A Property wrapper around the <code>alpha</code> functionality handled by the 19603 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 19604 */ 19605 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 19606 @Override 19607 public void setValue(View object, float value) { 19608 object.setAlpha(value); 19609 } 19610 19611 @Override 19612 public Float get(View object) { 19613 return object.getAlpha(); 19614 } 19615 }; 19616 19617 /** 19618 * A Property wrapper around the <code>translationX</code> functionality handled by the 19619 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 19620 */ 19621 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 19622 @Override 19623 public void setValue(View object, float value) { 19624 object.setTranslationX(value); 19625 } 19626 19627 @Override 19628 public Float get(View object) { 19629 return object.getTranslationX(); 19630 } 19631 }; 19632 19633 /** 19634 * A Property wrapper around the <code>translationY</code> functionality handled by the 19635 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 19636 */ 19637 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 19638 @Override 19639 public void setValue(View object, float value) { 19640 object.setTranslationY(value); 19641 } 19642 19643 @Override 19644 public Float get(View object) { 19645 return object.getTranslationY(); 19646 } 19647 }; 19648 19649 /** 19650 * A Property wrapper around the <code>translationZ</code> functionality handled by the 19651 * {@link View#setTranslationZ(float)} and {@link View#getTranslationZ()} methods. 19652 */ 19653 public static final Property<View, Float> TRANSLATION_Z = new FloatProperty<View>("translationZ") { 19654 @Override 19655 public void setValue(View object, float value) { 19656 object.setTranslationZ(value); 19657 } 19658 19659 @Override 19660 public Float get(View object) { 19661 return object.getTranslationZ(); 19662 } 19663 }; 19664 19665 /** 19666 * A Property wrapper around the <code>x</code> functionality handled by the 19667 * {@link View#setX(float)} and {@link View#getX()} methods. 19668 */ 19669 public static final Property<View, Float> X = new FloatProperty<View>("x") { 19670 @Override 19671 public void setValue(View object, float value) { 19672 object.setX(value); 19673 } 19674 19675 @Override 19676 public Float get(View object) { 19677 return object.getX(); 19678 } 19679 }; 19680 19681 /** 19682 * A Property wrapper around the <code>y</code> functionality handled by the 19683 * {@link View#setY(float)} and {@link View#getY()} methods. 19684 */ 19685 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 19686 @Override 19687 public void setValue(View object, float value) { 19688 object.setY(value); 19689 } 19690 19691 @Override 19692 public Float get(View object) { 19693 return object.getY(); 19694 } 19695 }; 19696 19697 /** 19698 * A Property wrapper around the <code>z</code> functionality handled by the 19699 * {@link View#setZ(float)} and {@link View#getZ()} methods. 19700 */ 19701 public static final Property<View, Float> Z = new FloatProperty<View>("z") { 19702 @Override 19703 public void setValue(View object, float value) { 19704 object.setZ(value); 19705 } 19706 19707 @Override 19708 public Float get(View object) { 19709 return object.getZ(); 19710 } 19711 }; 19712 19713 /** 19714 * A Property wrapper around the <code>rotation</code> functionality handled by the 19715 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 19716 */ 19717 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 19718 @Override 19719 public void setValue(View object, float value) { 19720 object.setRotation(value); 19721 } 19722 19723 @Override 19724 public Float get(View object) { 19725 return object.getRotation(); 19726 } 19727 }; 19728 19729 /** 19730 * A Property wrapper around the <code>rotationX</code> functionality handled by the 19731 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 19732 */ 19733 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 19734 @Override 19735 public void setValue(View object, float value) { 19736 object.setRotationX(value); 19737 } 19738 19739 @Override 19740 public Float get(View object) { 19741 return object.getRotationX(); 19742 } 19743 }; 19744 19745 /** 19746 * A Property wrapper around the <code>rotationY</code> functionality handled by the 19747 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 19748 */ 19749 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 19750 @Override 19751 public void setValue(View object, float value) { 19752 object.setRotationY(value); 19753 } 19754 19755 @Override 19756 public Float get(View object) { 19757 return object.getRotationY(); 19758 } 19759 }; 19760 19761 /** 19762 * A Property wrapper around the <code>scaleX</code> functionality handled by the 19763 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 19764 */ 19765 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 19766 @Override 19767 public void setValue(View object, float value) { 19768 object.setScaleX(value); 19769 } 19770 19771 @Override 19772 public Float get(View object) { 19773 return object.getScaleX(); 19774 } 19775 }; 19776 19777 /** 19778 * A Property wrapper around the <code>scaleY</code> functionality handled by the 19779 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 19780 */ 19781 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 19782 @Override 19783 public void setValue(View object, float value) { 19784 object.setScaleY(value); 19785 } 19786 19787 @Override 19788 public Float get(View object) { 19789 return object.getScaleY(); 19790 } 19791 }; 19792 19793 /** 19794 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 19795 * Each MeasureSpec represents a requirement for either the width or the height. 19796 * A MeasureSpec is comprised of a size and a mode. There are three possible 19797 * modes: 19798 * <dl> 19799 * <dt>UNSPECIFIED</dt> 19800 * <dd> 19801 * The parent has not imposed any constraint on the child. It can be whatever size 19802 * it wants. 19803 * </dd> 19804 * 19805 * <dt>EXACTLY</dt> 19806 * <dd> 19807 * The parent has determined an exact size for the child. The child is going to be 19808 * given those bounds regardless of how big it wants to be. 19809 * </dd> 19810 * 19811 * <dt>AT_MOST</dt> 19812 * <dd> 19813 * The child can be as large as it wants up to the specified size. 19814 * </dd> 19815 * </dl> 19816 * 19817 * MeasureSpecs are implemented as ints to reduce object allocation. This class 19818 * is provided to pack and unpack the <size, mode> tuple into the int. 19819 */ 19820 public static class MeasureSpec { 19821 private static final int MODE_SHIFT = 30; 19822 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 19823 19824 /** 19825 * Measure specification mode: The parent has not imposed any constraint 19826 * on the child. It can be whatever size it wants. 19827 */ 19828 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 19829 19830 /** 19831 * Measure specification mode: The parent has determined an exact size 19832 * for the child. The child is going to be given those bounds regardless 19833 * of how big it wants to be. 19834 */ 19835 public static final int EXACTLY = 1 << MODE_SHIFT; 19836 19837 /** 19838 * Measure specification mode: The child can be as large as it wants up 19839 * to the specified size. 19840 */ 19841 public static final int AT_MOST = 2 << MODE_SHIFT; 19842 19843 /** 19844 * Creates a measure specification based on the supplied size and mode. 19845 * 19846 * The mode must always be one of the following: 19847 * <ul> 19848 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 19849 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 19850 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 19851 * </ul> 19852 * 19853 * <p><strong>Note:</strong> On API level 17 and lower, makeMeasureSpec's 19854 * implementation was such that the order of arguments did not matter 19855 * and overflow in either value could impact the resulting MeasureSpec. 19856 * {@link android.widget.RelativeLayout} was affected by this bug. 19857 * Apps targeting API levels greater than 17 will get the fixed, more strict 19858 * behavior.</p> 19859 * 19860 * @param size the size of the measure specification 19861 * @param mode the mode of the measure specification 19862 * @return the measure specification based on size and mode 19863 */ 19864 public static int makeMeasureSpec(int size, int mode) { 19865 if (sUseBrokenMakeMeasureSpec) { 19866 return size + mode; 19867 } else { 19868 return (size & ~MODE_MASK) | (mode & MODE_MASK); 19869 } 19870 } 19871 19872 /** 19873 * Extracts the mode from the supplied measure specification. 19874 * 19875 * @param measureSpec the measure specification to extract the mode from 19876 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 19877 * {@link android.view.View.MeasureSpec#AT_MOST} or 19878 * {@link android.view.View.MeasureSpec#EXACTLY} 19879 */ 19880 public static int getMode(int measureSpec) { 19881 return (measureSpec & MODE_MASK); 19882 } 19883 19884 /** 19885 * Extracts the size from the supplied measure specification. 19886 * 19887 * @param measureSpec the measure specification to extract the size from 19888 * @return the size in pixels defined in the supplied measure specification 19889 */ 19890 public static int getSize(int measureSpec) { 19891 return (measureSpec & ~MODE_MASK); 19892 } 19893 19894 static int adjust(int measureSpec, int delta) { 19895 final int mode = getMode(measureSpec); 19896 if (mode == UNSPECIFIED) { 19897 // No need to adjust size for UNSPECIFIED mode. 19898 return makeMeasureSpec(0, UNSPECIFIED); 19899 } 19900 int size = getSize(measureSpec) + delta; 19901 if (size < 0) { 19902 Log.e(VIEW_LOG_TAG, "MeasureSpec.adjust: new size would be negative! (" + size + 19903 ") spec: " + toString(measureSpec) + " delta: " + delta); 19904 size = 0; 19905 } 19906 return makeMeasureSpec(size, mode); 19907 } 19908 19909 /** 19910 * Returns a String representation of the specified measure 19911 * specification. 19912 * 19913 * @param measureSpec the measure specification to convert to a String 19914 * @return a String with the following format: "MeasureSpec: MODE SIZE" 19915 */ 19916 public static String toString(int measureSpec) { 19917 int mode = getMode(measureSpec); 19918 int size = getSize(measureSpec); 19919 19920 StringBuilder sb = new StringBuilder("MeasureSpec: "); 19921 19922 if (mode == UNSPECIFIED) 19923 sb.append("UNSPECIFIED "); 19924 else if (mode == EXACTLY) 19925 sb.append("EXACTLY "); 19926 else if (mode == AT_MOST) 19927 sb.append("AT_MOST "); 19928 else 19929 sb.append(mode).append(" "); 19930 19931 sb.append(size); 19932 return sb.toString(); 19933 } 19934 } 19935 19936 private final class CheckForLongPress implements Runnable { 19937 private int mOriginalWindowAttachCount; 19938 19939 @Override 19940 public void run() { 19941 if (isPressed() && (mParent != null) 19942 && mOriginalWindowAttachCount == mWindowAttachCount) { 19943 if (performLongClick()) { 19944 mHasPerformedLongPress = true; 19945 } 19946 } 19947 } 19948 19949 public void rememberWindowAttachCount() { 19950 mOriginalWindowAttachCount = mWindowAttachCount; 19951 } 19952 } 19953 19954 private final class CheckForTap implements Runnable { 19955 public float x; 19956 public float y; 19957 19958 @Override 19959 public void run() { 19960 mPrivateFlags &= ~PFLAG_PREPRESSED; 19961 setPressed(true, x, y); 19962 checkForLongClick(ViewConfiguration.getTapTimeout()); 19963 } 19964 } 19965 19966 private final class PerformClick implements Runnable { 19967 @Override 19968 public void run() { 19969 performClick(); 19970 } 19971 } 19972 19973 /** @hide */ 19974 public void hackTurnOffWindowResizeAnim(boolean off) { 19975 mAttachInfo.mTurnOffWindowResizeAnim = off; 19976 } 19977 19978 /** 19979 * This method returns a ViewPropertyAnimator object, which can be used to animate 19980 * specific properties on this View. 19981 * 19982 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 19983 */ 19984 public ViewPropertyAnimator animate() { 19985 if (mAnimator == null) { 19986 mAnimator = new ViewPropertyAnimator(this); 19987 } 19988 return mAnimator; 19989 } 19990 19991 /** 19992 * Sets the name of the View to be used to identify Views in Transitions. 19993 * Names should be unique in the View hierarchy. 19994 * 19995 * @param transitionName The name of the View to uniquely identify it for Transitions. 19996 */ 19997 public final void setTransitionName(String transitionName) { 19998 mTransitionName = transitionName; 19999 } 20000 20001 /** 20002 * Returns the name of the View to be used to identify Views in Transitions. 20003 * Names should be unique in the View hierarchy. 20004 * 20005 * <p>This returns null if the View has not been given a name.</p> 20006 * 20007 * @return The name used of the View to be used to identify Views in Transitions or null 20008 * if no name has been given. 20009 */ 20010 @ViewDebug.ExportedProperty 20011 public String getTransitionName() { 20012 return mTransitionName; 20013 } 20014 20015 /** 20016 * Interface definition for a callback to be invoked when a hardware key event is 20017 * dispatched to this view. The callback will be invoked before the key event is 20018 * given to the view. This is only useful for hardware keyboards; a software input 20019 * method has no obligation to trigger this listener. 20020 */ 20021 public interface OnKeyListener { 20022 /** 20023 * Called when a hardware key is dispatched to a view. This allows listeners to 20024 * get a chance to respond before the target view. 20025 * <p>Key presses in software keyboards will generally NOT trigger this method, 20026 * although some may elect to do so in some situations. Do not assume a 20027 * software input method has to be key-based; even if it is, it may use key presses 20028 * in a different way than you expect, so there is no way to reliably catch soft 20029 * input key presses. 20030 * 20031 * @param v The view the key has been dispatched to. 20032 * @param keyCode The code for the physical key that was pressed 20033 * @param event The KeyEvent object containing full information about 20034 * the event. 20035 * @return True if the listener has consumed the event, false otherwise. 20036 */ 20037 boolean onKey(View v, int keyCode, KeyEvent event); 20038 } 20039 20040 /** 20041 * Interface definition for a callback to be invoked when a touch event is 20042 * dispatched to this view. The callback will be invoked before the touch 20043 * event is given to the view. 20044 */ 20045 public interface OnTouchListener { 20046 /** 20047 * Called when a touch event is dispatched to a view. This allows listeners to 20048 * get a chance to respond before the target view. 20049 * 20050 * @param v The view the touch event has been dispatched to. 20051 * @param event The MotionEvent object containing full information about 20052 * the event. 20053 * @return True if the listener has consumed the event, false otherwise. 20054 */ 20055 boolean onTouch(View v, MotionEvent event); 20056 } 20057 20058 /** 20059 * Interface definition for a callback to be invoked when a hover event is 20060 * dispatched to this view. The callback will be invoked before the hover 20061 * event is given to the view. 20062 */ 20063 public interface OnHoverListener { 20064 /** 20065 * Called when a hover event is dispatched to a view. This allows listeners to 20066 * get a chance to respond before the target view. 20067 * 20068 * @param v The view the hover event has been dispatched to. 20069 * @param event The MotionEvent object containing full information about 20070 * the event. 20071 * @return True if the listener has consumed the event, false otherwise. 20072 */ 20073 boolean onHover(View v, MotionEvent event); 20074 } 20075 20076 /** 20077 * Interface definition for a callback to be invoked when a generic motion event is 20078 * dispatched to this view. The callback will be invoked before the generic motion 20079 * event is given to the view. 20080 */ 20081 public interface OnGenericMotionListener { 20082 /** 20083 * Called when a generic motion event is dispatched to a view. This allows listeners to 20084 * get a chance to respond before the target view. 20085 * 20086 * @param v The view the generic motion event has been dispatched to. 20087 * @param event The MotionEvent object containing full information about 20088 * the event. 20089 * @return True if the listener has consumed the event, false otherwise. 20090 */ 20091 boolean onGenericMotion(View v, MotionEvent event); 20092 } 20093 20094 /** 20095 * Interface definition for a callback to be invoked when a view has been clicked and held. 20096 */ 20097 public interface OnLongClickListener { 20098 /** 20099 * Called when a view has been clicked and held. 20100 * 20101 * @param v The view that was clicked and held. 20102 * 20103 * @return true if the callback consumed the long click, false otherwise. 20104 */ 20105 boolean onLongClick(View v); 20106 } 20107 20108 /** 20109 * Interface definition for a callback to be invoked when a drag is being dispatched 20110 * to this view. The callback will be invoked before the hosting view's own 20111 * onDrag(event) method. If the listener wants to fall back to the hosting view's 20112 * onDrag(event) behavior, it should return 'false' from this callback. 20113 * 20114 * <div class="special reference"> 20115 * <h3>Developer Guides</h3> 20116 * <p>For a guide to implementing drag and drop features, read the 20117 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 20118 * </div> 20119 */ 20120 public interface OnDragListener { 20121 /** 20122 * Called when a drag event is dispatched to a view. This allows listeners 20123 * to get a chance to override base View behavior. 20124 * 20125 * @param v The View that received the drag event. 20126 * @param event The {@link android.view.DragEvent} object for the drag event. 20127 * @return {@code true} if the drag event was handled successfully, or {@code false} 20128 * if the drag event was not handled. Note that {@code false} will trigger the View 20129 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 20130 */ 20131 boolean onDrag(View v, DragEvent event); 20132 } 20133 20134 /** 20135 * Interface definition for a callback to be invoked when the focus state of 20136 * a view changed. 20137 */ 20138 public interface OnFocusChangeListener { 20139 /** 20140 * Called when the focus state of a view has changed. 20141 * 20142 * @param v The view whose state has changed. 20143 * @param hasFocus The new focus state of v. 20144 */ 20145 void onFocusChange(View v, boolean hasFocus); 20146 } 20147 20148 /** 20149 * Interface definition for a callback to be invoked when a view is clicked. 20150 */ 20151 public interface OnClickListener { 20152 /** 20153 * Called when a view has been clicked. 20154 * 20155 * @param v The view that was clicked. 20156 */ 20157 void onClick(View v); 20158 } 20159 20160 /** 20161 * Interface definition for a callback to be invoked when the context menu 20162 * for this view is being built. 20163 */ 20164 public interface OnCreateContextMenuListener { 20165 /** 20166 * Called when the context menu for this view is being built. It is not 20167 * safe to hold onto the menu after this method returns. 20168 * 20169 * @param menu The context menu that is being built 20170 * @param v The view for which the context menu is being built 20171 * @param menuInfo Extra information about the item for which the 20172 * context menu should be shown. This information will vary 20173 * depending on the class of v. 20174 */ 20175 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 20176 } 20177 20178 /** 20179 * Interface definition for a callback to be invoked when the status bar changes 20180 * visibility. This reports <strong>global</strong> changes to the system UI 20181 * state, not what the application is requesting. 20182 * 20183 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 20184 */ 20185 public interface OnSystemUiVisibilityChangeListener { 20186 /** 20187 * Called when the status bar changes visibility because of a call to 20188 * {@link View#setSystemUiVisibility(int)}. 20189 * 20190 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 20191 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}. 20192 * This tells you the <strong>global</strong> state of these UI visibility 20193 * flags, not what your app is currently applying. 20194 */ 20195 public void onSystemUiVisibilityChange(int visibility); 20196 } 20197 20198 /** 20199 * Interface definition for a callback to be invoked when this view is attached 20200 * or detached from its window. 20201 */ 20202 public interface OnAttachStateChangeListener { 20203 /** 20204 * Called when the view is attached to a window. 20205 * @param v The view that was attached 20206 */ 20207 public void onViewAttachedToWindow(View v); 20208 /** 20209 * Called when the view is detached from a window. 20210 * @param v The view that was detached 20211 */ 20212 public void onViewDetachedFromWindow(View v); 20213 } 20214 20215 /** 20216 * Listener for applying window insets on a view in a custom way. 20217 * 20218 * <p>Apps may choose to implement this interface if they want to apply custom policy 20219 * to the way that window insets are treated for a view. If an OnApplyWindowInsetsListener 20220 * is set, its 20221 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 20222 * method will be called instead of the View's own 20223 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. The listener 20224 * may optionally call the parameter View's <code>onApplyWindowInsets</code> method to apply 20225 * the View's normal behavior as part of its own.</p> 20226 */ 20227 public interface OnApplyWindowInsetsListener { 20228 /** 20229 * When {@link View#setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) set} 20230 * on a View, this listener method will be called instead of the view's own 20231 * {@link View#onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 20232 * 20233 * @param v The view applying window insets 20234 * @param insets The insets to apply 20235 * @return The insets supplied, minus any insets that were consumed 20236 */ 20237 public WindowInsets onApplyWindowInsets(View v, WindowInsets insets); 20238 } 20239 20240 private final class UnsetPressedState implements Runnable { 20241 @Override 20242 public void run() { 20243 setPressed(false); 20244 } 20245 } 20246 20247 /** 20248 * Base class for derived classes that want to save and restore their own 20249 * state in {@link android.view.View#onSaveInstanceState()}. 20250 */ 20251 public static class BaseSavedState extends AbsSavedState { 20252 /** 20253 * Constructor used when reading from a parcel. Reads the state of the superclass. 20254 * 20255 * @param source 20256 */ 20257 public BaseSavedState(Parcel source) { 20258 super(source); 20259 } 20260 20261 /** 20262 * Constructor called by derived classes when creating their SavedState objects 20263 * 20264 * @param superState The state of the superclass of this view 20265 */ 20266 public BaseSavedState(Parcelable superState) { 20267 super(superState); 20268 } 20269 20270 public static final Parcelable.Creator<BaseSavedState> CREATOR = 20271 new Parcelable.Creator<BaseSavedState>() { 20272 public BaseSavedState createFromParcel(Parcel in) { 20273 return new BaseSavedState(in); 20274 } 20275 20276 public BaseSavedState[] newArray(int size) { 20277 return new BaseSavedState[size]; 20278 } 20279 }; 20280 } 20281 20282 /** 20283 * A set of information given to a view when it is attached to its parent 20284 * window. 20285 */ 20286 final static class AttachInfo { 20287 interface Callbacks { 20288 void playSoundEffect(int effectId); 20289 boolean performHapticFeedback(int effectId, boolean always); 20290 } 20291 20292 /** 20293 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 20294 * to a Handler. This class contains the target (View) to invalidate and 20295 * the coordinates of the dirty rectangle. 20296 * 20297 * For performance purposes, this class also implements a pool of up to 20298 * POOL_LIMIT objects that get reused. This reduces memory allocations 20299 * whenever possible. 20300 */ 20301 static class InvalidateInfo { 20302 private static final int POOL_LIMIT = 10; 20303 20304 private static final SynchronizedPool<InvalidateInfo> sPool = 20305 new SynchronizedPool<InvalidateInfo>(POOL_LIMIT); 20306 20307 View target; 20308 20309 int left; 20310 int top; 20311 int right; 20312 int bottom; 20313 20314 public static InvalidateInfo obtain() { 20315 InvalidateInfo instance = sPool.acquire(); 20316 return (instance != null) ? instance : new InvalidateInfo(); 20317 } 20318 20319 public void recycle() { 20320 target = null; 20321 sPool.release(this); 20322 } 20323 } 20324 20325 final IWindowSession mSession; 20326 20327 final IWindow mWindow; 20328 20329 final IBinder mWindowToken; 20330 20331 final Display mDisplay; 20332 20333 final Callbacks mRootCallbacks; 20334 20335 IWindowId mIWindowId; 20336 WindowId mWindowId; 20337 20338 /** 20339 * The top view of the hierarchy. 20340 */ 20341 View mRootView; 20342 20343 IBinder mPanelParentWindowToken; 20344 20345 boolean mHardwareAccelerated; 20346 boolean mHardwareAccelerationRequested; 20347 HardwareRenderer mHardwareRenderer; 20348 List<RenderNode> mPendingAnimatingRenderNodes; 20349 20350 /** 20351 * The state of the display to which the window is attached, as reported 20352 * by {@link Display#getState()}. Note that the display state constants 20353 * declared by {@link Display} do not exactly line up with the screen state 20354 * constants declared by {@link View} (there are more display states than 20355 * screen states). 20356 */ 20357 int mDisplayState = Display.STATE_UNKNOWN; 20358 20359 /** 20360 * Scale factor used by the compatibility mode 20361 */ 20362 float mApplicationScale; 20363 20364 /** 20365 * Indicates whether the application is in compatibility mode 20366 */ 20367 boolean mScalingRequired; 20368 20369 /** 20370 * If set, ViewRootImpl doesn't use its lame animation for when the window resizes. 20371 */ 20372 boolean mTurnOffWindowResizeAnim; 20373 20374 /** 20375 * Left position of this view's window 20376 */ 20377 int mWindowLeft; 20378 20379 /** 20380 * Top position of this view's window 20381 */ 20382 int mWindowTop; 20383 20384 /** 20385 * Indicates whether views need to use 32-bit drawing caches 20386 */ 20387 boolean mUse32BitDrawingCache; 20388 20389 /** 20390 * For windows that are full-screen but using insets to layout inside 20391 * of the screen areas, these are the current insets to appear inside 20392 * the overscan area of the display. 20393 */ 20394 final Rect mOverscanInsets = new Rect(); 20395 20396 /** 20397 * For windows that are full-screen but using insets to layout inside 20398 * of the screen decorations, these are the current insets for the 20399 * content of the window. 20400 */ 20401 final Rect mContentInsets = new Rect(); 20402 20403 /** 20404 * For windows that are full-screen but using insets to layout inside 20405 * of the screen decorations, these are the current insets for the 20406 * actual visible parts of the window. 20407 */ 20408 final Rect mVisibleInsets = new Rect(); 20409 20410 /** 20411 * For windows that are full-screen but using insets to layout inside 20412 * of the screen decorations, these are the current insets for the 20413 * stable system windows. 20414 */ 20415 final Rect mStableInsets = new Rect(); 20416 20417 /** 20418 * The internal insets given by this window. This value is 20419 * supplied by the client (through 20420 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 20421 * be given to the window manager when changed to be used in laying 20422 * out windows behind it. 20423 */ 20424 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 20425 = new ViewTreeObserver.InternalInsetsInfo(); 20426 20427 /** 20428 * Set to true when mGivenInternalInsets is non-empty. 20429 */ 20430 boolean mHasNonEmptyGivenInternalInsets; 20431 20432 /** 20433 * All views in the window's hierarchy that serve as scroll containers, 20434 * used to determine if the window can be resized or must be panned 20435 * to adjust for a soft input area. 20436 */ 20437 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 20438 20439 final KeyEvent.DispatcherState mKeyDispatchState 20440 = new KeyEvent.DispatcherState(); 20441 20442 /** 20443 * Indicates whether the view's window currently has the focus. 20444 */ 20445 boolean mHasWindowFocus; 20446 20447 /** 20448 * The current visibility of the window. 20449 */ 20450 int mWindowVisibility; 20451 20452 /** 20453 * Indicates the time at which drawing started to occur. 20454 */ 20455 long mDrawingTime; 20456 20457 /** 20458 * Indicates whether or not ignoring the DIRTY_MASK flags. 20459 */ 20460 boolean mIgnoreDirtyState; 20461 20462 /** 20463 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 20464 * to avoid clearing that flag prematurely. 20465 */ 20466 boolean mSetIgnoreDirtyState = false; 20467 20468 /** 20469 * Indicates whether the view's window is currently in touch mode. 20470 */ 20471 boolean mInTouchMode; 20472 20473 /** 20474 * Indicates whether the view has requested unbuffered input dispatching for the current 20475 * event stream. 20476 */ 20477 boolean mUnbufferedDispatchRequested; 20478 20479 /** 20480 * Indicates that ViewAncestor should trigger a global layout change 20481 * the next time it performs a traversal 20482 */ 20483 boolean mRecomputeGlobalAttributes; 20484 20485 /** 20486 * Always report new attributes at next traversal. 20487 */ 20488 boolean mForceReportNewAttributes; 20489 20490 /** 20491 * Set during a traveral if any views want to keep the screen on. 20492 */ 20493 boolean mKeepScreenOn; 20494 20495 /** 20496 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 20497 */ 20498 int mSystemUiVisibility; 20499 20500 /** 20501 * Hack to force certain system UI visibility flags to be cleared. 20502 */ 20503 int mDisabledSystemUiVisibility; 20504 20505 /** 20506 * Last global system UI visibility reported by the window manager. 20507 */ 20508 int mGlobalSystemUiVisibility; 20509 20510 /** 20511 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 20512 * attached. 20513 */ 20514 boolean mHasSystemUiListeners; 20515 20516 /** 20517 * Set if the window has requested to extend into the overscan region 20518 * via WindowManager.LayoutParams.FLAG_LAYOUT_IN_OVERSCAN. 20519 */ 20520 boolean mOverscanRequested; 20521 20522 /** 20523 * Set if the visibility of any views has changed. 20524 */ 20525 boolean mViewVisibilityChanged; 20526 20527 /** 20528 * Set to true if a view has been scrolled. 20529 */ 20530 boolean mViewScrollChanged; 20531 20532 /** 20533 * Set to true if high contrast mode enabled 20534 */ 20535 boolean mHighContrastText; 20536 20537 /** 20538 * Global to the view hierarchy used as a temporary for dealing with 20539 * x/y points in the transparent region computations. 20540 */ 20541 final int[] mTransparentLocation = new int[2]; 20542 20543 /** 20544 * Global to the view hierarchy used as a temporary for dealing with 20545 * x/y points in the ViewGroup.invalidateChild implementation. 20546 */ 20547 final int[] mInvalidateChildLocation = new int[2]; 20548 20549 /** 20550 * Global to the view hierarchy used as a temporary for dealng with 20551 * computing absolute on-screen location. 20552 */ 20553 final int[] mTmpLocation = new int[2]; 20554 20555 /** 20556 * Global to the view hierarchy used as a temporary for dealing with 20557 * x/y location when view is transformed. 20558 */ 20559 final float[] mTmpTransformLocation = new float[2]; 20560 20561 /** 20562 * The view tree observer used to dispatch global events like 20563 * layout, pre-draw, touch mode change, etc. 20564 */ 20565 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 20566 20567 /** 20568 * A Canvas used by the view hierarchy to perform bitmap caching. 20569 */ 20570 Canvas mCanvas; 20571 20572 /** 20573 * The view root impl. 20574 */ 20575 final ViewRootImpl mViewRootImpl; 20576 20577 /** 20578 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 20579 * handler can be used to pump events in the UI events queue. 20580 */ 20581 final Handler mHandler; 20582 20583 /** 20584 * Temporary for use in computing invalidate rectangles while 20585 * calling up the hierarchy. 20586 */ 20587 final Rect mTmpInvalRect = new Rect(); 20588 20589 /** 20590 * Temporary for use in computing hit areas with transformed views 20591 */ 20592 final RectF mTmpTransformRect = new RectF(); 20593 20594 /** 20595 * Temporary for use in computing hit areas with transformed views 20596 */ 20597 final RectF mTmpTransformRect1 = new RectF(); 20598 20599 /** 20600 * Temporary list of rectanges. 20601 */ 20602 final List<RectF> mTmpRectList = new ArrayList<>(); 20603 20604 /** 20605 * Temporary for use in transforming invalidation rect 20606 */ 20607 final Matrix mTmpMatrix = new Matrix(); 20608 20609 /** 20610 * Temporary for use in transforming invalidation rect 20611 */ 20612 final Transformation mTmpTransformation = new Transformation(); 20613 20614 /** 20615 * Temporary for use in querying outlines from OutlineProviders 20616 */ 20617 final Outline mTmpOutline = new Outline(); 20618 20619 /** 20620 * Temporary list for use in collecting focusable descendents of a view. 20621 */ 20622 final ArrayList<View> mTempArrayList = new ArrayList<View>(24); 20623 20624 /** 20625 * The id of the window for accessibility purposes. 20626 */ 20627 int mAccessibilityWindowId = AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 20628 20629 /** 20630 * Flags related to accessibility processing. 20631 * 20632 * @see AccessibilityNodeInfo#FLAG_INCLUDE_NOT_IMPORTANT_VIEWS 20633 * @see AccessibilityNodeInfo#FLAG_REPORT_VIEW_IDS 20634 */ 20635 int mAccessibilityFetchFlags; 20636 20637 /** 20638 * The drawable for highlighting accessibility focus. 20639 */ 20640 Drawable mAccessibilityFocusDrawable; 20641 20642 /** 20643 * Show where the margins, bounds and layout bounds are for each view. 20644 */ 20645 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false); 20646 20647 /** 20648 * Point used to compute visible regions. 20649 */ 20650 final Point mPoint = new Point(); 20651 20652 /** 20653 * Used to track which View originated a requestLayout() call, used when 20654 * requestLayout() is called during layout. 20655 */ 20656 View mViewRequestingLayout; 20657 20658 /** 20659 * Creates a new set of attachment information with the specified 20660 * events handler and thread. 20661 * 20662 * @param handler the events handler the view must use 20663 */ 20664 AttachInfo(IWindowSession session, IWindow window, Display display, 20665 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) { 20666 mSession = session; 20667 mWindow = window; 20668 mWindowToken = window.asBinder(); 20669 mDisplay = display; 20670 mViewRootImpl = viewRootImpl; 20671 mHandler = handler; 20672 mRootCallbacks = effectPlayer; 20673 } 20674 } 20675 20676 /** 20677 * <p>ScrollabilityCache holds various fields used by a View when scrolling 20678 * is supported. This avoids keeping too many unused fields in most 20679 * instances of View.</p> 20680 */ 20681 private static class ScrollabilityCache implements Runnable { 20682 20683 /** 20684 * Scrollbars are not visible 20685 */ 20686 public static final int OFF = 0; 20687 20688 /** 20689 * Scrollbars are visible 20690 */ 20691 public static final int ON = 1; 20692 20693 /** 20694 * Scrollbars are fading away 20695 */ 20696 public static final int FADING = 2; 20697 20698 public boolean fadeScrollBars; 20699 20700 public int fadingEdgeLength; 20701 public int scrollBarDefaultDelayBeforeFade; 20702 public int scrollBarFadeDuration; 20703 20704 public int scrollBarSize; 20705 public ScrollBarDrawable scrollBar; 20706 public float[] interpolatorValues; 20707 public View host; 20708 20709 public final Paint paint; 20710 public final Matrix matrix; 20711 public Shader shader; 20712 20713 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 20714 20715 private static final float[] OPAQUE = { 255 }; 20716 private static final float[] TRANSPARENT = { 0.0f }; 20717 20718 /** 20719 * When fading should start. This time moves into the future every time 20720 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 20721 */ 20722 public long fadeStartTime; 20723 20724 20725 /** 20726 * The current state of the scrollbars: ON, OFF, or FADING 20727 */ 20728 public int state = OFF; 20729 20730 private int mLastColor; 20731 20732 public ScrollabilityCache(ViewConfiguration configuration, View host) { 20733 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 20734 scrollBarSize = configuration.getScaledScrollBarSize(); 20735 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 20736 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 20737 20738 paint = new Paint(); 20739 matrix = new Matrix(); 20740 // use use a height of 1, and then wack the matrix each time we 20741 // actually use it. 20742 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20743 paint.setShader(shader); 20744 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20745 20746 this.host = host; 20747 } 20748 20749 public void setFadeColor(int color) { 20750 if (color != mLastColor) { 20751 mLastColor = color; 20752 20753 if (color != 0) { 20754 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 20755 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 20756 paint.setShader(shader); 20757 // Restore the default transfer mode (src_over) 20758 paint.setXfermode(null); 20759 } else { 20760 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20761 paint.setShader(shader); 20762 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20763 } 20764 } 20765 } 20766 20767 public void run() { 20768 long now = AnimationUtils.currentAnimationTimeMillis(); 20769 if (now >= fadeStartTime) { 20770 20771 // the animation fades the scrollbars out by changing 20772 // the opacity (alpha) from fully opaque to fully 20773 // transparent 20774 int nextFrame = (int) now; 20775 int framesCount = 0; 20776 20777 Interpolator interpolator = scrollBarInterpolator; 20778 20779 // Start opaque 20780 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 20781 20782 // End transparent 20783 nextFrame += scrollBarFadeDuration; 20784 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 20785 20786 state = FADING; 20787 20788 // Kick off the fade animation 20789 host.invalidate(true); 20790 } 20791 } 20792 } 20793 20794 /** 20795 * Resuable callback for sending 20796 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 20797 */ 20798 private class SendViewScrolledAccessibilityEvent implements Runnable { 20799 public volatile boolean mIsPending; 20800 20801 public void run() { 20802 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 20803 mIsPending = false; 20804 } 20805 } 20806 20807 /** 20808 * <p> 20809 * This class represents a delegate that can be registered in a {@link View} 20810 * to enhance accessibility support via composition rather via inheritance. 20811 * It is specifically targeted to widget developers that extend basic View 20812 * classes i.e. classes in package android.view, that would like their 20813 * applications to be backwards compatible. 20814 * </p> 20815 * <div class="special reference"> 20816 * <h3>Developer Guides</h3> 20817 * <p>For more information about making applications accessible, read the 20818 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a> 20819 * developer guide.</p> 20820 * </div> 20821 * <p> 20822 * A scenario in which a developer would like to use an accessibility delegate 20823 * is overriding a method introduced in a later API version then the minimal API 20824 * version supported by the application. For example, the method 20825 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 20826 * in API version 4 when the accessibility APIs were first introduced. If a 20827 * developer would like his application to run on API version 4 devices (assuming 20828 * all other APIs used by the application are version 4 or lower) and take advantage 20829 * of this method, instead of overriding the method which would break the application's 20830 * backwards compatibility, he can override the corresponding method in this 20831 * delegate and register the delegate in the target View if the API version of 20832 * the system is high enough i.e. the API version is same or higher to the API 20833 * version that introduced 20834 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 20835 * </p> 20836 * <p> 20837 * Here is an example implementation: 20838 * </p> 20839 * <code><pre><p> 20840 * if (Build.VERSION.SDK_INT >= 14) { 20841 * // If the API version is equal of higher than the version in 20842 * // which onInitializeAccessibilityNodeInfo was introduced we 20843 * // register a delegate with a customized implementation. 20844 * View view = findViewById(R.id.view_id); 20845 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 20846 * public void onInitializeAccessibilityNodeInfo(View host, 20847 * AccessibilityNodeInfo info) { 20848 * // Let the default implementation populate the info. 20849 * super.onInitializeAccessibilityNodeInfo(host, info); 20850 * // Set some other information. 20851 * info.setEnabled(host.isEnabled()); 20852 * } 20853 * }); 20854 * } 20855 * </code></pre></p> 20856 * <p> 20857 * This delegate contains methods that correspond to the accessibility methods 20858 * in View. If a delegate has been specified the implementation in View hands 20859 * off handling to the corresponding method in this delegate. The default 20860 * implementation the delegate methods behaves exactly as the corresponding 20861 * method in View for the case of no accessibility delegate been set. Hence, 20862 * to customize the behavior of a View method, clients can override only the 20863 * corresponding delegate method without altering the behavior of the rest 20864 * accessibility related methods of the host view. 20865 * </p> 20866 */ 20867 public static class AccessibilityDelegate { 20868 20869 /** 20870 * Sends an accessibility event of the given type. If accessibility is not 20871 * enabled this method has no effect. 20872 * <p> 20873 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 20874 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 20875 * been set. 20876 * </p> 20877 * 20878 * @param host The View hosting the delegate. 20879 * @param eventType The type of the event to send. 20880 * 20881 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 20882 */ 20883 public void sendAccessibilityEvent(View host, int eventType) { 20884 host.sendAccessibilityEventInternal(eventType); 20885 } 20886 20887 /** 20888 * Performs the specified accessibility action on the view. For 20889 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 20890 * <p> 20891 * The default implementation behaves as 20892 * {@link View#performAccessibilityAction(int, Bundle) 20893 * View#performAccessibilityAction(int, Bundle)} for the case of 20894 * no accessibility delegate been set. 20895 * </p> 20896 * 20897 * @param action The action to perform. 20898 * @return Whether the action was performed. 20899 * 20900 * @see View#performAccessibilityAction(int, Bundle) 20901 * View#performAccessibilityAction(int, Bundle) 20902 */ 20903 public boolean performAccessibilityAction(View host, int action, Bundle args) { 20904 return host.performAccessibilityActionInternal(action, args); 20905 } 20906 20907 /** 20908 * Sends an accessibility event. This method behaves exactly as 20909 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 20910 * empty {@link AccessibilityEvent} and does not perform a check whether 20911 * accessibility is enabled. 20912 * <p> 20913 * The default implementation behaves as 20914 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20915 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 20916 * the case of no accessibility delegate been set. 20917 * </p> 20918 * 20919 * @param host The View hosting the delegate. 20920 * @param event The event to send. 20921 * 20922 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20923 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20924 */ 20925 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 20926 host.sendAccessibilityEventUncheckedInternal(event); 20927 } 20928 20929 /** 20930 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 20931 * to its children for adding their text content to the event. 20932 * <p> 20933 * The default implementation behaves as 20934 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20935 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 20936 * the case of no accessibility delegate been set. 20937 * </p> 20938 * 20939 * @param host The View hosting the delegate. 20940 * @param event The event. 20941 * @return True if the event population was completed. 20942 * 20943 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20944 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20945 */ 20946 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20947 return host.dispatchPopulateAccessibilityEventInternal(event); 20948 } 20949 20950 /** 20951 * Gives a chance to the host View to populate the accessibility event with its 20952 * text content. 20953 * <p> 20954 * The default implementation behaves as 20955 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 20956 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 20957 * the case of no accessibility delegate been set. 20958 * </p> 20959 * 20960 * @param host The View hosting the delegate. 20961 * @param event The accessibility event which to populate. 20962 * 20963 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 20964 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 20965 */ 20966 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20967 host.onPopulateAccessibilityEventInternal(event); 20968 } 20969 20970 /** 20971 * Initializes an {@link AccessibilityEvent} with information about the 20972 * the host View which is the event source. 20973 * <p> 20974 * The default implementation behaves as 20975 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 20976 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 20977 * the case of no accessibility delegate been set. 20978 * </p> 20979 * 20980 * @param host The View hosting the delegate. 20981 * @param event The event to initialize. 20982 * 20983 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 20984 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 20985 */ 20986 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 20987 host.onInitializeAccessibilityEventInternal(event); 20988 } 20989 20990 /** 20991 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 20992 * <p> 20993 * The default implementation behaves as 20994 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20995 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 20996 * the case of no accessibility delegate been set. 20997 * </p> 20998 * 20999 * @param host The View hosting the delegate. 21000 * @param info The instance to initialize. 21001 * 21002 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 21003 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 21004 */ 21005 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 21006 host.onInitializeAccessibilityNodeInfoInternal(info); 21007 } 21008 21009 /** 21010 * Called when a child of the host View has requested sending an 21011 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 21012 * to augment the event. 21013 * <p> 21014 * The default implementation behaves as 21015 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 21016 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 21017 * the case of no accessibility delegate been set. 21018 * </p> 21019 * 21020 * @param host The View hosting the delegate. 21021 * @param child The child which requests sending the event. 21022 * @param event The event to be sent. 21023 * @return True if the event should be sent 21024 * 21025 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 21026 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 21027 */ 21028 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 21029 AccessibilityEvent event) { 21030 return host.onRequestSendAccessibilityEventInternal(child, event); 21031 } 21032 21033 /** 21034 * Gets the provider for managing a virtual view hierarchy rooted at this View 21035 * and reported to {@link android.accessibilityservice.AccessibilityService}s 21036 * that explore the window content. 21037 * <p> 21038 * The default implementation behaves as 21039 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 21040 * the case of no accessibility delegate been set. 21041 * </p> 21042 * 21043 * @return The provider. 21044 * 21045 * @see AccessibilityNodeProvider 21046 */ 21047 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 21048 return null; 21049 } 21050 21051 /** 21052 * Returns an {@link AccessibilityNodeInfo} representing the host view from the 21053 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 21054 * This method is responsible for obtaining an accessibility node info from a 21055 * pool of reusable instances and calling 21056 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on the host 21057 * view to initialize the former. 21058 * <p> 21059 * <strong>Note:</strong> The client is responsible for recycling the obtained 21060 * instance by calling {@link AccessibilityNodeInfo#recycle()} to minimize object 21061 * creation. 21062 * </p> 21063 * <p> 21064 * The default implementation behaves as 21065 * {@link View#createAccessibilityNodeInfo() View#createAccessibilityNodeInfo()} for 21066 * the case of no accessibility delegate been set. 21067 * </p> 21068 * @return A populated {@link AccessibilityNodeInfo}. 21069 * 21070 * @see AccessibilityNodeInfo 21071 * 21072 * @hide 21073 */ 21074 public AccessibilityNodeInfo createAccessibilityNodeInfo(View host) { 21075 return host.createAccessibilityNodeInfoInternal(); 21076 } 21077 } 21078 21079 private class MatchIdPredicate implements Predicate<View> { 21080 public int mId; 21081 21082 @Override 21083 public boolean apply(View view) { 21084 return (view.mID == mId); 21085 } 21086 } 21087 21088 private class MatchLabelForPredicate implements Predicate<View> { 21089 private int mLabeledId; 21090 21091 @Override 21092 public boolean apply(View view) { 21093 return (view.mLabelForId == mLabeledId); 21094 } 21095 } 21096 21097 private class SendViewStateChangedAccessibilityEvent implements Runnable { 21098 private int mChangeTypes = 0; 21099 private boolean mPosted; 21100 private boolean mPostedWithDelay; 21101 private long mLastEventTimeMillis; 21102 21103 @Override 21104 public void run() { 21105 mPosted = false; 21106 mPostedWithDelay = false; 21107 mLastEventTimeMillis = SystemClock.uptimeMillis(); 21108 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 21109 final AccessibilityEvent event = AccessibilityEvent.obtain(); 21110 event.setEventType(AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED); 21111 event.setContentChangeTypes(mChangeTypes); 21112 sendAccessibilityEventUnchecked(event); 21113 } 21114 mChangeTypes = 0; 21115 } 21116 21117 public void runOrPost(int changeType) { 21118 mChangeTypes |= changeType; 21119 21120 // If this is a live region or the child of a live region, collect 21121 // all events from this frame and send them on the next frame. 21122 if (inLiveRegion()) { 21123 // If we're already posted with a delay, remove that. 21124 if (mPostedWithDelay) { 21125 removeCallbacks(this); 21126 mPostedWithDelay = false; 21127 } 21128 // Only post if we're not already posted. 21129 if (!mPosted) { 21130 post(this); 21131 mPosted = true; 21132 } 21133 return; 21134 } 21135 21136 if (mPosted) { 21137 return; 21138 } 21139 21140 final long timeSinceLastMillis = SystemClock.uptimeMillis() - mLastEventTimeMillis; 21141 final long minEventIntevalMillis = 21142 ViewConfiguration.getSendRecurringAccessibilityEventsInterval(); 21143 if (timeSinceLastMillis >= minEventIntevalMillis) { 21144 removeCallbacks(this); 21145 run(); 21146 } else { 21147 postDelayed(this, minEventIntevalMillis - timeSinceLastMillis); 21148 mPostedWithDelay = true; 21149 } 21150 } 21151 } 21152 21153 private boolean inLiveRegion() { 21154 if (getAccessibilityLiveRegion() != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21155 return true; 21156 } 21157 21158 ViewParent parent = getParent(); 21159 while (parent instanceof View) { 21160 if (((View) parent).getAccessibilityLiveRegion() 21161 != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21162 return true; 21163 } 21164 parent = parent.getParent(); 21165 } 21166 21167 return false; 21168 } 21169 21170 /** 21171 * Dump all private flags in readable format, useful for documentation and 21172 * sanity checking. 21173 */ 21174 private static void dumpFlags() { 21175 final HashMap<String, String> found = Maps.newHashMap(); 21176 try { 21177 for (Field field : View.class.getDeclaredFields()) { 21178 final int modifiers = field.getModifiers(); 21179 if (Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers)) { 21180 if (field.getType().equals(int.class)) { 21181 final int value = field.getInt(null); 21182 dumpFlag(found, field.getName(), value); 21183 } else if (field.getType().equals(int[].class)) { 21184 final int[] values = (int[]) field.get(null); 21185 for (int i = 0; i < values.length; i++) { 21186 dumpFlag(found, field.getName() + "[" + i + "]", values[i]); 21187 } 21188 } 21189 } 21190 } 21191 } catch (IllegalAccessException e) { 21192 throw new RuntimeException(e); 21193 } 21194 21195 final ArrayList<String> keys = Lists.newArrayList(); 21196 keys.addAll(found.keySet()); 21197 Collections.sort(keys); 21198 for (String key : keys) { 21199 Log.d(VIEW_LOG_TAG, found.get(key)); 21200 } 21201 } 21202 21203 private static void dumpFlag(HashMap<String, String> found, String name, int value) { 21204 // Sort flags by prefix, then by bits, always keeping unique keys 21205 final String bits = String.format("%32s", Integer.toBinaryString(value)).replace('0', ' '); 21206 final int prefix = name.indexOf('_'); 21207 final String key = (prefix > 0 ? name.substring(0, prefix) : name) + bits + name; 21208 final String output = bits + " " + name; 21209 found.put(key, output); 21210 } 21211} 21212