View.java revision b3fa2787eabd2be6d7780e215db0d9a5904ba47c
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 /** 5936 * Adds the clickable rectangles withing the bounds of this view. They 5937 * may overlap. This method is intended for use only by the accessibility 5938 * layer. 5939 * 5940 * @param outRects List to which to add clickable areas. 5941 * 5942 * @hide 5943 */ 5944 public void addClickableRectsForAccessibility(List<RectF> outRects) { 5945 if (isClickable() || isLongClickable() 5946 || (mListenerInfo != null && mListenerInfo.mOnTouchListener != null)) { 5947 RectF bounds = new RectF(); 5948 bounds.set(0, 0, getWidth(), getHeight()); 5949 outRects.add(bounds); 5950 } 5951 } 5952 5953 static void offsetRects(List<RectF> rects, float offsetX, float offsetY) { 5954 final int rectCount = rects.size(); 5955 for (int i = 0; i < rectCount; i++) { 5956 RectF intersection = rects.get(i); 5957 intersection.offset(offsetX, offsetY); 5958 } 5959 } 5960 5961 /** 5962 * Returns the delegate for implementing accessibility support via 5963 * composition. For more details see {@link AccessibilityDelegate}. 5964 * 5965 * @return The delegate, or null if none set. 5966 * 5967 * @hide 5968 */ 5969 public AccessibilityDelegate getAccessibilityDelegate() { 5970 return mAccessibilityDelegate; 5971 } 5972 5973 /** 5974 * Sets a delegate for implementing accessibility support via composition as 5975 * opposed to inheritance. The delegate's primary use is for implementing 5976 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 5977 * 5978 * @param delegate The delegate instance. 5979 * 5980 * @see AccessibilityDelegate 5981 */ 5982 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 5983 mAccessibilityDelegate = delegate; 5984 } 5985 5986 /** 5987 * Gets the provider for managing a virtual view hierarchy rooted at this View 5988 * and reported to {@link android.accessibilityservice.AccessibilityService}s 5989 * that explore the window content. 5990 * <p> 5991 * If this method returns an instance, this instance is responsible for managing 5992 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 5993 * View including the one representing the View itself. Similarly the returned 5994 * instance is responsible for performing accessibility actions on any virtual 5995 * view or the root view itself. 5996 * </p> 5997 * <p> 5998 * If an {@link AccessibilityDelegate} has been specified via calling 5999 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 6000 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 6001 * is responsible for handling this call. 6002 * </p> 6003 * 6004 * @return The provider. 6005 * 6006 * @see AccessibilityNodeProvider 6007 */ 6008 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 6009 if (mAccessibilityDelegate != null) { 6010 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 6011 } else { 6012 return null; 6013 } 6014 } 6015 6016 /** 6017 * Gets the unique identifier of this view on the screen for accessibility purposes. 6018 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 6019 * 6020 * @return The view accessibility id. 6021 * 6022 * @hide 6023 */ 6024 public int getAccessibilityViewId() { 6025 if (mAccessibilityViewId == NO_ID) { 6026 mAccessibilityViewId = sNextAccessibilityViewId++; 6027 } 6028 return mAccessibilityViewId; 6029 } 6030 6031 /** 6032 * Gets the unique identifier of the window in which this View reseides. 6033 * 6034 * @return The window accessibility id. 6035 * 6036 * @hide 6037 */ 6038 public int getAccessibilityWindowId() { 6039 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId 6040 : AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 6041 } 6042 6043 /** 6044 * Gets the {@link View} description. It briefly describes the view and is 6045 * primarily used for accessibility support. Set this property to enable 6046 * better accessibility support for your application. This is especially 6047 * true for views that do not have textual representation (For example, 6048 * ImageButton). 6049 * 6050 * @return The content description. 6051 * 6052 * @attr ref android.R.styleable#View_contentDescription 6053 */ 6054 @ViewDebug.ExportedProperty(category = "accessibility") 6055 public CharSequence getContentDescription() { 6056 return mContentDescription; 6057 } 6058 6059 /** 6060 * Sets the {@link View} description. It briefly describes the view and is 6061 * primarily used for accessibility support. Set this property to enable 6062 * better accessibility support for your application. This is especially 6063 * true for views that do not have textual representation (For example, 6064 * ImageButton). 6065 * 6066 * @param contentDescription The content description. 6067 * 6068 * @attr ref android.R.styleable#View_contentDescription 6069 */ 6070 @RemotableViewMethod 6071 public void setContentDescription(CharSequence contentDescription) { 6072 if (mContentDescription == null) { 6073 if (contentDescription == null) { 6074 return; 6075 } 6076 } else if (mContentDescription.equals(contentDescription)) { 6077 return; 6078 } 6079 mContentDescription = contentDescription; 6080 final boolean nonEmptyDesc = contentDescription != null && contentDescription.length() > 0; 6081 if (nonEmptyDesc && getImportantForAccessibility() == IMPORTANT_FOR_ACCESSIBILITY_AUTO) { 6082 setImportantForAccessibility(IMPORTANT_FOR_ACCESSIBILITY_YES); 6083 notifySubtreeAccessibilityStateChangedIfNeeded(); 6084 } else { 6085 notifyViewAccessibilityStateChangedIfNeeded( 6086 AccessibilityEvent.CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION); 6087 } 6088 } 6089 6090 /** 6091 * Sets the id of a view before which this one is visited in accessibility traversal. 6092 * A screen-reader must visit the content of this view before the content of the one 6093 * it precedes. For example, if view B is set to be before view A, then a screen-reader 6094 * will traverse the entire content of B before traversing the entire content of A, 6095 * regardles of what traversal strategy it is using. 6096 * <p> 6097 * Views that do not have specified before/after relationships are traversed in order 6098 * determined by the screen-reader. 6099 * </p> 6100 * <p> 6101 * Setting that this view is before a view that is not important for accessibility 6102 * or if this view is not important for accessibility will have no effect as the 6103 * screen-reader is not aware of unimportant views. 6104 * </p> 6105 * 6106 * @param beforeId The id of a view this one precedes in accessibility traversal. 6107 * 6108 * @attr ref android.R.styleable#View_accessibilityTraversalBefore 6109 * 6110 * @see #setImportantForAccessibility(int) 6111 */ 6112 @RemotableViewMethod 6113 public void setAccessibilityTraversalBefore(int beforeId) { 6114 if (mAccessibilityTraversalBeforeId == beforeId) { 6115 return; 6116 } 6117 mAccessibilityTraversalBeforeId = beforeId; 6118 notifyViewAccessibilityStateChangedIfNeeded( 6119 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6120 } 6121 6122 /** 6123 * Gets the id of a view before which this one is visited in accessibility traversal. 6124 * 6125 * @return The id of a view this one precedes in accessibility traversal if 6126 * specified, otherwise {@link #NO_ID}. 6127 * 6128 * @see #setAccessibilityTraversalBefore(int) 6129 */ 6130 public int getAccessibilityTraversalBefore() { 6131 return mAccessibilityTraversalBeforeId; 6132 } 6133 6134 /** 6135 * Sets the id of a view after which this one is visited in accessibility traversal. 6136 * A screen-reader must visit the content of the other view before the content of this 6137 * one. For example, if view B is set to be after view A, then a screen-reader 6138 * will traverse the entire content of A before traversing the entire content of B, 6139 * regardles of what traversal strategy it is using. 6140 * <p> 6141 * Views that do not have specified before/after relationships are traversed in order 6142 * determined by the screen-reader. 6143 * </p> 6144 * <p> 6145 * Setting that this view is after a view that is not important for accessibility 6146 * or if this view is not important for accessibility will have no effect as the 6147 * screen-reader is not aware of unimportant views. 6148 * </p> 6149 * 6150 * @param afterId The id of a view this one succedees in accessibility traversal. 6151 * 6152 * @attr ref android.R.styleable#View_accessibilityTraversalAfter 6153 * 6154 * @see #setImportantForAccessibility(int) 6155 */ 6156 @RemotableViewMethod 6157 public void setAccessibilityTraversalAfter(int afterId) { 6158 if (mAccessibilityTraversalAfterId == afterId) { 6159 return; 6160 } 6161 mAccessibilityTraversalAfterId = afterId; 6162 notifyViewAccessibilityStateChangedIfNeeded( 6163 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6164 } 6165 6166 /** 6167 * Gets the id of a view after which this one is visited in accessibility traversal. 6168 * 6169 * @return The id of a view this one succeedes in accessibility traversal if 6170 * specified, otherwise {@link #NO_ID}. 6171 * 6172 * @see #setAccessibilityTraversalAfter(int) 6173 */ 6174 public int getAccessibilityTraversalAfter() { 6175 return mAccessibilityTraversalAfterId; 6176 } 6177 6178 /** 6179 * Gets the id of a view for which this view serves as a label for 6180 * accessibility purposes. 6181 * 6182 * @return The labeled view id. 6183 */ 6184 @ViewDebug.ExportedProperty(category = "accessibility") 6185 public int getLabelFor() { 6186 return mLabelForId; 6187 } 6188 6189 /** 6190 * Sets the id of a view for which this view serves as a label for 6191 * accessibility purposes. 6192 * 6193 * @param id The labeled view id. 6194 */ 6195 @RemotableViewMethod 6196 public void setLabelFor(int id) { 6197 if (mLabelForId == id) { 6198 return; 6199 } 6200 mLabelForId = id; 6201 if (mLabelForId != View.NO_ID 6202 && mID == View.NO_ID) { 6203 mID = generateViewId(); 6204 } 6205 notifyViewAccessibilityStateChangedIfNeeded( 6206 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6207 } 6208 6209 /** 6210 * Invoked whenever this view loses focus, either by losing window focus or by losing 6211 * focus within its window. This method can be used to clear any state tied to the 6212 * focus. For instance, if a button is held pressed with the trackball and the window 6213 * loses focus, this method can be used to cancel the press. 6214 * 6215 * Subclasses of View overriding this method should always call super.onFocusLost(). 6216 * 6217 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 6218 * @see #onWindowFocusChanged(boolean) 6219 * 6220 * @hide pending API council approval 6221 */ 6222 protected void onFocusLost() { 6223 resetPressedState(); 6224 } 6225 6226 private void resetPressedState() { 6227 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 6228 return; 6229 } 6230 6231 if (isPressed()) { 6232 setPressed(false); 6233 6234 if (!mHasPerformedLongPress) { 6235 removeLongPressCallback(); 6236 } 6237 } 6238 } 6239 6240 /** 6241 * Returns true if this view has focus 6242 * 6243 * @return True if this view has focus, false otherwise. 6244 */ 6245 @ViewDebug.ExportedProperty(category = "focus") 6246 public boolean isFocused() { 6247 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 6248 } 6249 6250 /** 6251 * Find the view in the hierarchy rooted at this view that currently has 6252 * focus. 6253 * 6254 * @return The view that currently has focus, or null if no focused view can 6255 * be found. 6256 */ 6257 public View findFocus() { 6258 return (mPrivateFlags & PFLAG_FOCUSED) != 0 ? this : null; 6259 } 6260 6261 /** 6262 * Indicates whether this view is one of the set of scrollable containers in 6263 * its window. 6264 * 6265 * @return whether this view is one of the set of scrollable containers in 6266 * its window 6267 * 6268 * @attr ref android.R.styleable#View_isScrollContainer 6269 */ 6270 public boolean isScrollContainer() { 6271 return (mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0; 6272 } 6273 6274 /** 6275 * Change whether this view is one of the set of scrollable containers in 6276 * its window. This will be used to determine whether the window can 6277 * resize or must pan when a soft input area is open -- scrollable 6278 * containers allow the window to use resize mode since the container 6279 * will appropriately shrink. 6280 * 6281 * @attr ref android.R.styleable#View_isScrollContainer 6282 */ 6283 public void setScrollContainer(boolean isScrollContainer) { 6284 if (isScrollContainer) { 6285 if (mAttachInfo != null && (mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) == 0) { 6286 mAttachInfo.mScrollContainers.add(this); 6287 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 6288 } 6289 mPrivateFlags |= PFLAG_SCROLL_CONTAINER; 6290 } else { 6291 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 6292 mAttachInfo.mScrollContainers.remove(this); 6293 } 6294 mPrivateFlags &= ~(PFLAG_SCROLL_CONTAINER|PFLAG_SCROLL_CONTAINER_ADDED); 6295 } 6296 } 6297 6298 /** 6299 * Returns the quality of the drawing cache. 6300 * 6301 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6302 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6303 * 6304 * @see #setDrawingCacheQuality(int) 6305 * @see #setDrawingCacheEnabled(boolean) 6306 * @see #isDrawingCacheEnabled() 6307 * 6308 * @attr ref android.R.styleable#View_drawingCacheQuality 6309 */ 6310 @DrawingCacheQuality 6311 public int getDrawingCacheQuality() { 6312 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 6313 } 6314 6315 /** 6316 * Set the drawing cache quality of this view. This value is used only when the 6317 * drawing cache is enabled 6318 * 6319 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6320 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6321 * 6322 * @see #getDrawingCacheQuality() 6323 * @see #setDrawingCacheEnabled(boolean) 6324 * @see #isDrawingCacheEnabled() 6325 * 6326 * @attr ref android.R.styleable#View_drawingCacheQuality 6327 */ 6328 public void setDrawingCacheQuality(@DrawingCacheQuality int quality) { 6329 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 6330 } 6331 6332 /** 6333 * Returns whether the screen should remain on, corresponding to the current 6334 * value of {@link #KEEP_SCREEN_ON}. 6335 * 6336 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 6337 * 6338 * @see #setKeepScreenOn(boolean) 6339 * 6340 * @attr ref android.R.styleable#View_keepScreenOn 6341 */ 6342 public boolean getKeepScreenOn() { 6343 return (mViewFlags & KEEP_SCREEN_ON) != 0; 6344 } 6345 6346 /** 6347 * Controls whether the screen should remain on, modifying the 6348 * value of {@link #KEEP_SCREEN_ON}. 6349 * 6350 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 6351 * 6352 * @see #getKeepScreenOn() 6353 * 6354 * @attr ref android.R.styleable#View_keepScreenOn 6355 */ 6356 public void setKeepScreenOn(boolean keepScreenOn) { 6357 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 6358 } 6359 6360 /** 6361 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6362 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6363 * 6364 * @attr ref android.R.styleable#View_nextFocusLeft 6365 */ 6366 public int getNextFocusLeftId() { 6367 return mNextFocusLeftId; 6368 } 6369 6370 /** 6371 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6372 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 6373 * decide automatically. 6374 * 6375 * @attr ref android.R.styleable#View_nextFocusLeft 6376 */ 6377 public void setNextFocusLeftId(int nextFocusLeftId) { 6378 mNextFocusLeftId = nextFocusLeftId; 6379 } 6380 6381 /** 6382 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6383 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6384 * 6385 * @attr ref android.R.styleable#View_nextFocusRight 6386 */ 6387 public int getNextFocusRightId() { 6388 return mNextFocusRightId; 6389 } 6390 6391 /** 6392 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6393 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 6394 * decide automatically. 6395 * 6396 * @attr ref android.R.styleable#View_nextFocusRight 6397 */ 6398 public void setNextFocusRightId(int nextFocusRightId) { 6399 mNextFocusRightId = nextFocusRightId; 6400 } 6401 6402 /** 6403 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6404 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6405 * 6406 * @attr ref android.R.styleable#View_nextFocusUp 6407 */ 6408 public int getNextFocusUpId() { 6409 return mNextFocusUpId; 6410 } 6411 6412 /** 6413 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6414 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 6415 * decide automatically. 6416 * 6417 * @attr ref android.R.styleable#View_nextFocusUp 6418 */ 6419 public void setNextFocusUpId(int nextFocusUpId) { 6420 mNextFocusUpId = nextFocusUpId; 6421 } 6422 6423 /** 6424 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6425 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6426 * 6427 * @attr ref android.R.styleable#View_nextFocusDown 6428 */ 6429 public int getNextFocusDownId() { 6430 return mNextFocusDownId; 6431 } 6432 6433 /** 6434 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6435 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 6436 * decide automatically. 6437 * 6438 * @attr ref android.R.styleable#View_nextFocusDown 6439 */ 6440 public void setNextFocusDownId(int nextFocusDownId) { 6441 mNextFocusDownId = nextFocusDownId; 6442 } 6443 6444 /** 6445 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6446 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6447 * 6448 * @attr ref android.R.styleable#View_nextFocusForward 6449 */ 6450 public int getNextFocusForwardId() { 6451 return mNextFocusForwardId; 6452 } 6453 6454 /** 6455 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6456 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 6457 * decide automatically. 6458 * 6459 * @attr ref android.R.styleable#View_nextFocusForward 6460 */ 6461 public void setNextFocusForwardId(int nextFocusForwardId) { 6462 mNextFocusForwardId = nextFocusForwardId; 6463 } 6464 6465 /** 6466 * Returns the visibility of this view and all of its ancestors 6467 * 6468 * @return True if this view and all of its ancestors are {@link #VISIBLE} 6469 */ 6470 public boolean isShown() { 6471 View current = this; 6472 //noinspection ConstantConditions 6473 do { 6474 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6475 return false; 6476 } 6477 ViewParent parent = current.mParent; 6478 if (parent == null) { 6479 return false; // We are not attached to the view root 6480 } 6481 if (!(parent instanceof View)) { 6482 return true; 6483 } 6484 current = (View) parent; 6485 } while (current != null); 6486 6487 return false; 6488 } 6489 6490 /** 6491 * Called by the view hierarchy when the content insets for a window have 6492 * changed, to allow it to adjust its content to fit within those windows. 6493 * The content insets tell you the space that the status bar, input method, 6494 * and other system windows infringe on the application's window. 6495 * 6496 * <p>You do not normally need to deal with this function, since the default 6497 * window decoration given to applications takes care of applying it to the 6498 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 6499 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case, 6500 * and your content can be placed under those system elements. You can then 6501 * use this method within your view hierarchy if you have parts of your UI 6502 * which you would like to ensure are not being covered. 6503 * 6504 * <p>The default implementation of this method simply applies the content 6505 * insets to the view's padding, consuming that content (modifying the 6506 * insets to be 0), and returning true. This behavior is off by default, but can 6507 * be enabled through {@link #setFitsSystemWindows(boolean)}. 6508 * 6509 * <p>This function's traversal down the hierarchy is depth-first. The same content 6510 * insets object is propagated down the hierarchy, so any changes made to it will 6511 * be seen by all following views (including potentially ones above in 6512 * the hierarchy since this is a depth-first traversal). The first view 6513 * that returns true will abort the entire traversal. 6514 * 6515 * <p>The default implementation works well for a situation where it is 6516 * used with a container that covers the entire window, allowing it to 6517 * apply the appropriate insets to its content on all edges. If you need 6518 * a more complicated layout (such as two different views fitting system 6519 * windows, one on the top of the window, and one on the bottom), 6520 * you can override the method and handle the insets however you would like. 6521 * Note that the insets provided by the framework are always relative to the 6522 * far edges of the window, not accounting for the location of the called view 6523 * within that window. (In fact when this method is called you do not yet know 6524 * where the layout will place the view, as it is done before layout happens.) 6525 * 6526 * <p>Note: unlike many View methods, there is no dispatch phase to this 6527 * call. If you are overriding it in a ViewGroup and want to allow the 6528 * call to continue to your children, you must be sure to call the super 6529 * implementation. 6530 * 6531 * <p>Here is a sample layout that makes use of fitting system windows 6532 * to have controls for a video view placed inside of the window decorations 6533 * that it hides and shows. This can be used with code like the second 6534 * sample (video player) shown in {@link #setSystemUiVisibility(int)}. 6535 * 6536 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete} 6537 * 6538 * @param insets Current content insets of the window. Prior to 6539 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify 6540 * the insets or else you and Android will be unhappy. 6541 * 6542 * @return {@code true} if this view applied the insets and it should not 6543 * continue propagating further down the hierarchy, {@code false} otherwise. 6544 * @see #getFitsSystemWindows() 6545 * @see #setFitsSystemWindows(boolean) 6546 * @see #setSystemUiVisibility(int) 6547 * 6548 * @deprecated As of API 20 use {@link #dispatchApplyWindowInsets(WindowInsets)} to apply 6549 * insets to views. Views should override {@link #onApplyWindowInsets(WindowInsets)} or use 6550 * {@link #setOnApplyWindowInsetsListener(android.view.View.OnApplyWindowInsetsListener)} 6551 * to implement handling their own insets. 6552 */ 6553 protected boolean fitSystemWindows(Rect insets) { 6554 if ((mPrivateFlags3 & PFLAG3_APPLYING_INSETS) == 0) { 6555 if (insets == null) { 6556 // Null insets by definition have already been consumed. 6557 // This call cannot apply insets since there are none to apply, 6558 // so return false. 6559 return false; 6560 } 6561 // If we're not in the process of dispatching the newer apply insets call, 6562 // that means we're not in the compatibility path. Dispatch into the newer 6563 // apply insets path and take things from there. 6564 try { 6565 mPrivateFlags3 |= PFLAG3_FITTING_SYSTEM_WINDOWS; 6566 return dispatchApplyWindowInsets(new WindowInsets(insets)).isConsumed(); 6567 } finally { 6568 mPrivateFlags3 &= ~PFLAG3_FITTING_SYSTEM_WINDOWS; 6569 } 6570 } else { 6571 // We're being called from the newer apply insets path. 6572 // Perform the standard fallback behavior. 6573 return fitSystemWindowsInt(insets); 6574 } 6575 } 6576 6577 private boolean fitSystemWindowsInt(Rect insets) { 6578 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 6579 mUserPaddingStart = UNDEFINED_PADDING; 6580 mUserPaddingEnd = UNDEFINED_PADDING; 6581 Rect localInsets = sThreadLocal.get(); 6582 if (localInsets == null) { 6583 localInsets = new Rect(); 6584 sThreadLocal.set(localInsets); 6585 } 6586 boolean res = computeFitSystemWindows(insets, localInsets); 6587 mUserPaddingLeftInitial = localInsets.left; 6588 mUserPaddingRightInitial = localInsets.right; 6589 internalSetPadding(localInsets.left, localInsets.top, 6590 localInsets.right, localInsets.bottom); 6591 return res; 6592 } 6593 return false; 6594 } 6595 6596 /** 6597 * Called when the view should apply {@link WindowInsets} according to its internal policy. 6598 * 6599 * <p>This method should be overridden by views that wish to apply a policy different from or 6600 * in addition to the default behavior. Clients that wish to force a view subtree 6601 * to apply insets should call {@link #dispatchApplyWindowInsets(WindowInsets)}.</p> 6602 * 6603 * <p>Clients may supply an {@link OnApplyWindowInsetsListener} to a view. If one is set 6604 * it will be called during dispatch instead of this method. The listener may optionally 6605 * call this method from its own implementation if it wishes to apply the view's default 6606 * insets policy in addition to its own.</p> 6607 * 6608 * <p>Implementations of this method should either return the insets parameter unchanged 6609 * or a new {@link WindowInsets} cloned from the supplied insets with any insets consumed 6610 * that this view applied itself. This allows new inset types added in future platform 6611 * versions to pass through existing implementations unchanged without being erroneously 6612 * consumed.</p> 6613 * 6614 * <p>By default if a view's {@link #setFitsSystemWindows(boolean) fitsSystemWindows} 6615 * property is set then the view will consume the system window insets and apply them 6616 * as padding for the view.</p> 6617 * 6618 * @param insets Insets to apply 6619 * @return The supplied insets with any applied insets consumed 6620 */ 6621 public WindowInsets onApplyWindowInsets(WindowInsets insets) { 6622 if ((mPrivateFlags3 & PFLAG3_FITTING_SYSTEM_WINDOWS) == 0) { 6623 // We weren't called from within a direct call to fitSystemWindows, 6624 // call into it as a fallback in case we're in a class that overrides it 6625 // and has logic to perform. 6626 if (fitSystemWindows(insets.getSystemWindowInsets())) { 6627 return insets.consumeSystemWindowInsets(); 6628 } 6629 } else { 6630 // We were called from within a direct call to fitSystemWindows. 6631 if (fitSystemWindowsInt(insets.getSystemWindowInsets())) { 6632 return insets.consumeSystemWindowInsets(); 6633 } 6634 } 6635 return insets; 6636 } 6637 6638 /** 6639 * Set an {@link OnApplyWindowInsetsListener} to take over the policy for applying 6640 * window insets to this view. The listener's 6641 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 6642 * method will be called instead of the view's 6643 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 6644 * 6645 * @param listener Listener to set 6646 * 6647 * @see #onApplyWindowInsets(WindowInsets) 6648 */ 6649 public void setOnApplyWindowInsetsListener(OnApplyWindowInsetsListener listener) { 6650 getListenerInfo().mOnApplyWindowInsetsListener = listener; 6651 } 6652 6653 /** 6654 * Request to apply the given window insets to this view or another view in its subtree. 6655 * 6656 * <p>This method should be called by clients wishing to apply insets corresponding to areas 6657 * obscured by window decorations or overlays. This can include the status and navigation bars, 6658 * action bars, input methods and more. New inset categories may be added in the future. 6659 * The method returns the insets provided minus any that were applied by this view or its 6660 * children.</p> 6661 * 6662 * <p>Clients wishing to provide custom behavior should override the 6663 * {@link #onApplyWindowInsets(WindowInsets)} method or alternatively provide a 6664 * {@link OnApplyWindowInsetsListener} via the 6665 * {@link #setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) setOnApplyWindowInsetsListener} 6666 * method.</p> 6667 * 6668 * <p>This method replaces the older {@link #fitSystemWindows(Rect) fitSystemWindows} method. 6669 * </p> 6670 * 6671 * @param insets Insets to apply 6672 * @return The provided insets minus the insets that were consumed 6673 */ 6674 public WindowInsets dispatchApplyWindowInsets(WindowInsets insets) { 6675 try { 6676 mPrivateFlags3 |= PFLAG3_APPLYING_INSETS; 6677 if (mListenerInfo != null && mListenerInfo.mOnApplyWindowInsetsListener != null) { 6678 return mListenerInfo.mOnApplyWindowInsetsListener.onApplyWindowInsets(this, insets); 6679 } else { 6680 return onApplyWindowInsets(insets); 6681 } 6682 } finally { 6683 mPrivateFlags3 &= ~PFLAG3_APPLYING_INSETS; 6684 } 6685 } 6686 6687 /** 6688 * @hide Compute the insets that should be consumed by this view and the ones 6689 * that should propagate to those under it. 6690 */ 6691 protected boolean computeFitSystemWindows(Rect inoutInsets, Rect outLocalInsets) { 6692 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6693 || mAttachInfo == null 6694 || ((mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0 6695 && !mAttachInfo.mOverscanRequested)) { 6696 outLocalInsets.set(inoutInsets); 6697 inoutInsets.set(0, 0, 0, 0); 6698 return true; 6699 } else { 6700 // The application wants to take care of fitting system window for 6701 // the content... however we still need to take care of any overscan here. 6702 final Rect overscan = mAttachInfo.mOverscanInsets; 6703 outLocalInsets.set(overscan); 6704 inoutInsets.left -= overscan.left; 6705 inoutInsets.top -= overscan.top; 6706 inoutInsets.right -= overscan.right; 6707 inoutInsets.bottom -= overscan.bottom; 6708 return false; 6709 } 6710 } 6711 6712 /** 6713 * Compute insets that should be consumed by this view and the ones that should propagate 6714 * to those under it. 6715 * 6716 * @param in Insets currently being processed by this View, likely received as a parameter 6717 * to {@link #onApplyWindowInsets(WindowInsets)}. 6718 * @param outLocalInsets A Rect that will receive the insets that should be consumed 6719 * by this view 6720 * @return Insets that should be passed along to views under this one 6721 */ 6722 public WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) { 6723 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6724 || mAttachInfo == null 6725 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) { 6726 outLocalInsets.set(in.getSystemWindowInsets()); 6727 return in.consumeSystemWindowInsets(); 6728 } else { 6729 outLocalInsets.set(0, 0, 0, 0); 6730 return in; 6731 } 6732 } 6733 6734 /** 6735 * Sets whether or not this view should account for system screen decorations 6736 * such as the status bar and inset its content; that is, controlling whether 6737 * the default implementation of {@link #fitSystemWindows(Rect)} will be 6738 * executed. See that method for more details. 6739 * 6740 * <p>Note that if you are providing your own implementation of 6741 * {@link #fitSystemWindows(Rect)}, then there is no need to set this 6742 * flag to true -- your implementation will be overriding the default 6743 * implementation that checks this flag. 6744 * 6745 * @param fitSystemWindows If true, then the default implementation of 6746 * {@link #fitSystemWindows(Rect)} will be executed. 6747 * 6748 * @attr ref android.R.styleable#View_fitsSystemWindows 6749 * @see #getFitsSystemWindows() 6750 * @see #fitSystemWindows(Rect) 6751 * @see #setSystemUiVisibility(int) 6752 */ 6753 public void setFitsSystemWindows(boolean fitSystemWindows) { 6754 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 6755 } 6756 6757 /** 6758 * Check for state of {@link #setFitsSystemWindows(boolean)}. If this method 6759 * returns {@code true}, the default implementation of {@link #fitSystemWindows(Rect)} 6760 * will be executed. 6761 * 6762 * @return {@code true} if the default implementation of 6763 * {@link #fitSystemWindows(Rect)} will be executed. 6764 * 6765 * @attr ref android.R.styleable#View_fitsSystemWindows 6766 * @see #setFitsSystemWindows(boolean) 6767 * @see #fitSystemWindows(Rect) 6768 * @see #setSystemUiVisibility(int) 6769 */ 6770 @ViewDebug.ExportedProperty 6771 public boolean getFitsSystemWindows() { 6772 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 6773 } 6774 6775 /** @hide */ 6776 public boolean fitsSystemWindows() { 6777 return getFitsSystemWindows(); 6778 } 6779 6780 /** 6781 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed. 6782 * @deprecated Use {@link #requestApplyInsets()} for newer platform versions. 6783 */ 6784 public void requestFitSystemWindows() { 6785 if (mParent != null) { 6786 mParent.requestFitSystemWindows(); 6787 } 6788 } 6789 6790 /** 6791 * Ask that a new dispatch of {@link #onApplyWindowInsets(WindowInsets)} be performed. 6792 */ 6793 public void requestApplyInsets() { 6794 requestFitSystemWindows(); 6795 } 6796 6797 /** 6798 * For use by PhoneWindow to make its own system window fitting optional. 6799 * @hide 6800 */ 6801 public void makeOptionalFitsSystemWindows() { 6802 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS); 6803 } 6804 6805 /** 6806 * Returns the visibility status for this view. 6807 * 6808 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6809 * @attr ref android.R.styleable#View_visibility 6810 */ 6811 @ViewDebug.ExportedProperty(mapping = { 6812 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 6813 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 6814 @ViewDebug.IntToString(from = GONE, to = "GONE") 6815 }) 6816 @Visibility 6817 public int getVisibility() { 6818 return mViewFlags & VISIBILITY_MASK; 6819 } 6820 6821 /** 6822 * Set the enabled state of this view. 6823 * 6824 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6825 * @attr ref android.R.styleable#View_visibility 6826 */ 6827 @RemotableViewMethod 6828 public void setVisibility(@Visibility int visibility) { 6829 setFlags(visibility, VISIBILITY_MASK); 6830 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false); 6831 } 6832 6833 /** 6834 * Returns the enabled status for this view. The interpretation of the 6835 * enabled state varies by subclass. 6836 * 6837 * @return True if this view is enabled, false otherwise. 6838 */ 6839 @ViewDebug.ExportedProperty 6840 public boolean isEnabled() { 6841 return (mViewFlags & ENABLED_MASK) == ENABLED; 6842 } 6843 6844 /** 6845 * Set the enabled state of this view. The interpretation of the enabled 6846 * state varies by subclass. 6847 * 6848 * @param enabled True if this view is enabled, false otherwise. 6849 */ 6850 @RemotableViewMethod 6851 public void setEnabled(boolean enabled) { 6852 if (enabled == isEnabled()) return; 6853 6854 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 6855 6856 /* 6857 * The View most likely has to change its appearance, so refresh 6858 * the drawable state. 6859 */ 6860 refreshDrawableState(); 6861 6862 // Invalidate too, since the default behavior for views is to be 6863 // be drawn at 50% alpha rather than to change the drawable. 6864 invalidate(true); 6865 6866 if (!enabled) { 6867 cancelPendingInputEvents(); 6868 } 6869 } 6870 6871 /** 6872 * Set whether this view can receive the focus. 6873 * 6874 * Setting this to false will also ensure that this view is not focusable 6875 * in touch mode. 6876 * 6877 * @param focusable If true, this view can receive the focus. 6878 * 6879 * @see #setFocusableInTouchMode(boolean) 6880 * @attr ref android.R.styleable#View_focusable 6881 */ 6882 public void setFocusable(boolean focusable) { 6883 if (!focusable) { 6884 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 6885 } 6886 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 6887 } 6888 6889 /** 6890 * Set whether this view can receive focus while in touch mode. 6891 * 6892 * Setting this to true will also ensure that this view is focusable. 6893 * 6894 * @param focusableInTouchMode If true, this view can receive the focus while 6895 * in touch mode. 6896 * 6897 * @see #setFocusable(boolean) 6898 * @attr ref android.R.styleable#View_focusableInTouchMode 6899 */ 6900 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 6901 // Focusable in touch mode should always be set before the focusable flag 6902 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 6903 // which, in touch mode, will not successfully request focus on this view 6904 // because the focusable in touch mode flag is not set 6905 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 6906 if (focusableInTouchMode) { 6907 setFlags(FOCUSABLE, FOCUSABLE_MASK); 6908 } 6909 } 6910 6911 /** 6912 * Set whether this view should have sound effects enabled for events such as 6913 * clicking and touching. 6914 * 6915 * <p>You may wish to disable sound effects for a view if you already play sounds, 6916 * for instance, a dial key that plays dtmf tones. 6917 * 6918 * @param soundEffectsEnabled whether sound effects are enabled for this view. 6919 * @see #isSoundEffectsEnabled() 6920 * @see #playSoundEffect(int) 6921 * @attr ref android.R.styleable#View_soundEffectsEnabled 6922 */ 6923 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 6924 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 6925 } 6926 6927 /** 6928 * @return whether this view should have sound effects enabled for events such as 6929 * clicking and touching. 6930 * 6931 * @see #setSoundEffectsEnabled(boolean) 6932 * @see #playSoundEffect(int) 6933 * @attr ref android.R.styleable#View_soundEffectsEnabled 6934 */ 6935 @ViewDebug.ExportedProperty 6936 public boolean isSoundEffectsEnabled() { 6937 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 6938 } 6939 6940 /** 6941 * Set whether this view should have haptic feedback for events such as 6942 * long presses. 6943 * 6944 * <p>You may wish to disable haptic feedback if your view already controls 6945 * its own haptic feedback. 6946 * 6947 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 6948 * @see #isHapticFeedbackEnabled() 6949 * @see #performHapticFeedback(int) 6950 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6951 */ 6952 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 6953 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 6954 } 6955 6956 /** 6957 * @return whether this view should have haptic feedback enabled for events 6958 * long presses. 6959 * 6960 * @see #setHapticFeedbackEnabled(boolean) 6961 * @see #performHapticFeedback(int) 6962 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6963 */ 6964 @ViewDebug.ExportedProperty 6965 public boolean isHapticFeedbackEnabled() { 6966 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 6967 } 6968 6969 /** 6970 * Returns the layout direction for this view. 6971 * 6972 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 6973 * {@link #LAYOUT_DIRECTION_RTL}, 6974 * {@link #LAYOUT_DIRECTION_INHERIT} or 6975 * {@link #LAYOUT_DIRECTION_LOCALE}. 6976 * 6977 * @attr ref android.R.styleable#View_layoutDirection 6978 * 6979 * @hide 6980 */ 6981 @ViewDebug.ExportedProperty(category = "layout", mapping = { 6982 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 6983 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 6984 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 6985 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 6986 }) 6987 @LayoutDir 6988 public int getRawLayoutDirection() { 6989 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 6990 } 6991 6992 /** 6993 * Set the layout direction for this view. This will propagate a reset of layout direction 6994 * resolution to the view's children and resolve layout direction for this view. 6995 * 6996 * @param layoutDirection the layout direction to set. Should be one of: 6997 * 6998 * {@link #LAYOUT_DIRECTION_LTR}, 6999 * {@link #LAYOUT_DIRECTION_RTL}, 7000 * {@link #LAYOUT_DIRECTION_INHERIT}, 7001 * {@link #LAYOUT_DIRECTION_LOCALE}. 7002 * 7003 * Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution 7004 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 7005 * will return the default {@link #LAYOUT_DIRECTION_LTR}. 7006 * 7007 * @attr ref android.R.styleable#View_layoutDirection 7008 */ 7009 @RemotableViewMethod 7010 public void setLayoutDirection(@LayoutDir int layoutDirection) { 7011 if (getRawLayoutDirection() != layoutDirection) { 7012 // Reset the current layout direction and the resolved one 7013 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_MASK; 7014 resetRtlProperties(); 7015 // Set the new layout direction (filtered) 7016 mPrivateFlags2 |= 7017 ((layoutDirection << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) & PFLAG2_LAYOUT_DIRECTION_MASK); 7018 // We need to resolve all RTL properties as they all depend on layout direction 7019 resolveRtlPropertiesIfNeeded(); 7020 requestLayout(); 7021 invalidate(true); 7022 } 7023 } 7024 7025 /** 7026 * Returns the resolved layout direction for this view. 7027 * 7028 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 7029 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. 7030 * 7031 * For compatibility, this will return {@link #LAYOUT_DIRECTION_LTR} if API version 7032 * is lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}. 7033 * 7034 * @attr ref android.R.styleable#View_layoutDirection 7035 */ 7036 @ViewDebug.ExportedProperty(category = "layout", mapping = { 7037 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 7038 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 7039 }) 7040 @ResolvedLayoutDir 7041 public int getLayoutDirection() { 7042 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 7043 if (targetSdkVersion < JELLY_BEAN_MR1) { 7044 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 7045 return LAYOUT_DIRECTION_RESOLVED_DEFAULT; 7046 } 7047 return ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) == 7048 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) ? LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 7049 } 7050 7051 /** 7052 * Indicates whether or not this view's layout is right-to-left. This is resolved from 7053 * layout attribute and/or the inherited value from the parent 7054 * 7055 * @return true if the layout is right-to-left. 7056 * 7057 * @hide 7058 */ 7059 @ViewDebug.ExportedProperty(category = "layout") 7060 public boolean isLayoutRtl() { 7061 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL); 7062 } 7063 7064 /** 7065 * Indicates whether the view is currently tracking transient state that the 7066 * app should not need to concern itself with saving and restoring, but that 7067 * the framework should take special note to preserve when possible. 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 * @return true if the view has transient state 7075 */ 7076 @ViewDebug.ExportedProperty(category = "layout") 7077 public boolean hasTransientState() { 7078 return (mPrivateFlags2 & PFLAG2_HAS_TRANSIENT_STATE) == PFLAG2_HAS_TRANSIENT_STATE; 7079 } 7080 7081 /** 7082 * Set whether this view is currently tracking transient state that the 7083 * framework should attempt to preserve when possible. This flag is reference counted, 7084 * so every call to setHasTransientState(true) should be paired with a later call 7085 * to setHasTransientState(false). 7086 * 7087 * <p>A view with transient state cannot be trivially rebound from an external 7088 * data source, such as an adapter binding item views in a list. This may be 7089 * because the view is performing an animation, tracking user selection 7090 * of content, or similar.</p> 7091 * 7092 * @param hasTransientState true if this view has transient state 7093 */ 7094 public void setHasTransientState(boolean hasTransientState) { 7095 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 : 7096 mTransientStateCount - 1; 7097 if (mTransientStateCount < 0) { 7098 mTransientStateCount = 0; 7099 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " + 7100 "unmatched pair of setHasTransientState calls"); 7101 } else if ((hasTransientState && mTransientStateCount == 1) || 7102 (!hasTransientState && mTransientStateCount == 0)) { 7103 // update flag if we've just incremented up from 0 or decremented down to 0 7104 mPrivateFlags2 = (mPrivateFlags2 & ~PFLAG2_HAS_TRANSIENT_STATE) | 7105 (hasTransientState ? PFLAG2_HAS_TRANSIENT_STATE : 0); 7106 if (mParent != null) { 7107 try { 7108 mParent.childHasTransientStateChanged(this, hasTransientState); 7109 } catch (AbstractMethodError e) { 7110 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 7111 " does not fully implement ViewParent", e); 7112 } 7113 } 7114 } 7115 } 7116 7117 /** 7118 * Returns true if this view is currently attached to a window. 7119 */ 7120 public boolean isAttachedToWindow() { 7121 return mAttachInfo != null; 7122 } 7123 7124 /** 7125 * Returns true if this view has been through at least one layout since it 7126 * was last attached to or detached from a window. 7127 */ 7128 public boolean isLaidOut() { 7129 return (mPrivateFlags3 & PFLAG3_IS_LAID_OUT) == PFLAG3_IS_LAID_OUT; 7130 } 7131 7132 /** 7133 * If this view doesn't do any drawing on its own, set this flag to 7134 * allow further optimizations. By default, this flag is not set on 7135 * View, but could be set on some View subclasses such as ViewGroup. 7136 * 7137 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 7138 * you should clear this flag. 7139 * 7140 * @param willNotDraw whether or not this View draw on its own 7141 */ 7142 public void setWillNotDraw(boolean willNotDraw) { 7143 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 7144 } 7145 7146 /** 7147 * Returns whether or not this View draws on its own. 7148 * 7149 * @return true if this view has nothing to draw, false otherwise 7150 */ 7151 @ViewDebug.ExportedProperty(category = "drawing") 7152 public boolean willNotDraw() { 7153 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 7154 } 7155 7156 /** 7157 * When a View's drawing cache is enabled, drawing is redirected to an 7158 * offscreen bitmap. Some views, like an ImageView, must be able to 7159 * bypass this mechanism if they already draw a single bitmap, to avoid 7160 * unnecessary usage of the memory. 7161 * 7162 * @param willNotCacheDrawing true if this view does not cache its 7163 * drawing, false otherwise 7164 */ 7165 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 7166 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 7167 } 7168 7169 /** 7170 * Returns whether or not this View can cache its drawing or not. 7171 * 7172 * @return true if this view does not cache its drawing, false otherwise 7173 */ 7174 @ViewDebug.ExportedProperty(category = "drawing") 7175 public boolean willNotCacheDrawing() { 7176 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 7177 } 7178 7179 /** 7180 * Indicates whether this view reacts to click events or not. 7181 * 7182 * @return true if the view is clickable, false otherwise 7183 * 7184 * @see #setClickable(boolean) 7185 * @attr ref android.R.styleable#View_clickable 7186 */ 7187 @ViewDebug.ExportedProperty 7188 public boolean isClickable() { 7189 return (mViewFlags & CLICKABLE) == CLICKABLE; 7190 } 7191 7192 /** 7193 * Enables or disables click events for this view. When a view 7194 * is clickable it will change its state to "pressed" on every click. 7195 * Subclasses should set the view clickable to visually react to 7196 * user's clicks. 7197 * 7198 * @param clickable true to make the view clickable, false otherwise 7199 * 7200 * @see #isClickable() 7201 * @attr ref android.R.styleable#View_clickable 7202 */ 7203 public void setClickable(boolean clickable) { 7204 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 7205 } 7206 7207 /** 7208 * Indicates whether this view reacts to long click events or not. 7209 * 7210 * @return true if the view is long clickable, false otherwise 7211 * 7212 * @see #setLongClickable(boolean) 7213 * @attr ref android.R.styleable#View_longClickable 7214 */ 7215 public boolean isLongClickable() { 7216 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 7217 } 7218 7219 /** 7220 * Enables or disables long click events for this view. When a view is long 7221 * clickable it reacts to the user holding down the button for a longer 7222 * duration than a tap. This event can either launch the listener or a 7223 * context menu. 7224 * 7225 * @param longClickable true to make the view long clickable, false otherwise 7226 * @see #isLongClickable() 7227 * @attr ref android.R.styleable#View_longClickable 7228 */ 7229 public void setLongClickable(boolean longClickable) { 7230 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 7231 } 7232 7233 /** 7234 * Sets the pressed state for this view and provides a touch coordinate for 7235 * animation hinting. 7236 * 7237 * @param pressed Pass true to set the View's internal state to "pressed", 7238 * or false to reverts the View's internal state from a 7239 * previously set "pressed" state. 7240 * @param x The x coordinate of the touch that caused the press 7241 * @param y The y coordinate of the touch that caused the press 7242 */ 7243 private void setPressed(boolean pressed, float x, float y) { 7244 if (pressed) { 7245 drawableHotspotChanged(x, y); 7246 } 7247 7248 setPressed(pressed); 7249 } 7250 7251 /** 7252 * Sets the pressed state for this view. 7253 * 7254 * @see #isClickable() 7255 * @see #setClickable(boolean) 7256 * 7257 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 7258 * the View's internal state from a previously set "pressed" state. 7259 */ 7260 public void setPressed(boolean pressed) { 7261 final boolean needsRefresh = pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED); 7262 7263 if (pressed) { 7264 mPrivateFlags |= PFLAG_PRESSED; 7265 } else { 7266 mPrivateFlags &= ~PFLAG_PRESSED; 7267 } 7268 7269 if (needsRefresh) { 7270 refreshDrawableState(); 7271 } 7272 dispatchSetPressed(pressed); 7273 } 7274 7275 /** 7276 * Dispatch setPressed to all of this View's children. 7277 * 7278 * @see #setPressed(boolean) 7279 * 7280 * @param pressed The new pressed state 7281 */ 7282 protected void dispatchSetPressed(boolean pressed) { 7283 } 7284 7285 /** 7286 * Indicates whether the view is currently in pressed state. Unless 7287 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 7288 * the pressed state. 7289 * 7290 * @see #setPressed(boolean) 7291 * @see #isClickable() 7292 * @see #setClickable(boolean) 7293 * 7294 * @return true if the view is currently pressed, false otherwise 7295 */ 7296 @ViewDebug.ExportedProperty 7297 public boolean isPressed() { 7298 return (mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED; 7299 } 7300 7301 /** 7302 * Indicates whether this view will save its state (that is, 7303 * whether its {@link #onSaveInstanceState} method will be called). 7304 * 7305 * @return Returns true if the view state saving is enabled, else false. 7306 * 7307 * @see #setSaveEnabled(boolean) 7308 * @attr ref android.R.styleable#View_saveEnabled 7309 */ 7310 public boolean isSaveEnabled() { 7311 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 7312 } 7313 7314 /** 7315 * Controls whether the saving of this view's state is 7316 * enabled (that is, whether its {@link #onSaveInstanceState} method 7317 * will be called). Note that even if freezing is enabled, the 7318 * view still must have an id assigned to it (via {@link #setId(int)}) 7319 * for its state to be saved. This flag can only disable the 7320 * saving of this view; any child views may still have their state saved. 7321 * 7322 * @param enabled Set to false to <em>disable</em> state saving, or true 7323 * (the default) to allow it. 7324 * 7325 * @see #isSaveEnabled() 7326 * @see #setId(int) 7327 * @see #onSaveInstanceState() 7328 * @attr ref android.R.styleable#View_saveEnabled 7329 */ 7330 public void setSaveEnabled(boolean enabled) { 7331 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 7332 } 7333 7334 /** 7335 * Gets whether the framework should discard touches when the view's 7336 * window is obscured by another visible window. 7337 * Refer to the {@link View} security documentation for more details. 7338 * 7339 * @return True if touch filtering is enabled. 7340 * 7341 * @see #setFilterTouchesWhenObscured(boolean) 7342 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7343 */ 7344 @ViewDebug.ExportedProperty 7345 public boolean getFilterTouchesWhenObscured() { 7346 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 7347 } 7348 7349 /** 7350 * Sets whether the framework should discard touches when the view's 7351 * window is obscured by another visible window. 7352 * Refer to the {@link View} security documentation for more details. 7353 * 7354 * @param enabled True if touch filtering should be enabled. 7355 * 7356 * @see #getFilterTouchesWhenObscured 7357 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7358 */ 7359 public void setFilterTouchesWhenObscured(boolean enabled) { 7360 setFlags(enabled ? FILTER_TOUCHES_WHEN_OBSCURED : 0, 7361 FILTER_TOUCHES_WHEN_OBSCURED); 7362 } 7363 7364 /** 7365 * Indicates whether the entire hierarchy under this view will save its 7366 * state when a state saving traversal occurs from its parent. The default 7367 * is true; if false, these views will not be saved unless 7368 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7369 * 7370 * @return Returns true if the view state saving from parent is enabled, else false. 7371 * 7372 * @see #setSaveFromParentEnabled(boolean) 7373 */ 7374 public boolean isSaveFromParentEnabled() { 7375 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 7376 } 7377 7378 /** 7379 * Controls whether the entire hierarchy under this view will save its 7380 * state when a state saving traversal occurs from its parent. The default 7381 * is true; if false, these views will not be saved unless 7382 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7383 * 7384 * @param enabled Set to false to <em>disable</em> state saving, or true 7385 * (the default) to allow it. 7386 * 7387 * @see #isSaveFromParentEnabled() 7388 * @see #setId(int) 7389 * @see #onSaveInstanceState() 7390 */ 7391 public void setSaveFromParentEnabled(boolean enabled) { 7392 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 7393 } 7394 7395 7396 /** 7397 * Returns whether this View is able to take focus. 7398 * 7399 * @return True if this view can take focus, or false otherwise. 7400 * @attr ref android.R.styleable#View_focusable 7401 */ 7402 @ViewDebug.ExportedProperty(category = "focus") 7403 public final boolean isFocusable() { 7404 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 7405 } 7406 7407 /** 7408 * When a view is focusable, it may not want to take focus when in touch mode. 7409 * For example, a button would like focus when the user is navigating via a D-pad 7410 * so that the user can click on it, but once the user starts touching the screen, 7411 * the button shouldn't take focus 7412 * @return Whether the view is focusable in touch mode. 7413 * @attr ref android.R.styleable#View_focusableInTouchMode 7414 */ 7415 @ViewDebug.ExportedProperty 7416 public final boolean isFocusableInTouchMode() { 7417 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 7418 } 7419 7420 /** 7421 * Find the nearest view in the specified direction that can take focus. 7422 * This does not actually give focus to that view. 7423 * 7424 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7425 * 7426 * @return The nearest focusable in the specified direction, or null if none 7427 * can be found. 7428 */ 7429 public View focusSearch(@FocusRealDirection int direction) { 7430 if (mParent != null) { 7431 return mParent.focusSearch(this, direction); 7432 } else { 7433 return null; 7434 } 7435 } 7436 7437 /** 7438 * This method is the last chance for the focused view and its ancestors to 7439 * respond to an arrow key. This is called when the focused view did not 7440 * consume the key internally, nor could the view system find a new view in 7441 * the requested direction to give focus to. 7442 * 7443 * @param focused The currently focused view. 7444 * @param direction The direction focus wants to move. One of FOCUS_UP, 7445 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 7446 * @return True if the this view consumed this unhandled move. 7447 */ 7448 public boolean dispatchUnhandledMove(View focused, @FocusRealDirection int direction) { 7449 return false; 7450 } 7451 7452 /** 7453 * If a user manually specified the next view id for a particular direction, 7454 * use the root to look up the view. 7455 * @param root The root view of the hierarchy containing this view. 7456 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 7457 * or FOCUS_BACKWARD. 7458 * @return The user specified next view, or null if there is none. 7459 */ 7460 View findUserSetNextFocus(View root, @FocusDirection int direction) { 7461 switch (direction) { 7462 case FOCUS_LEFT: 7463 if (mNextFocusLeftId == View.NO_ID) return null; 7464 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 7465 case FOCUS_RIGHT: 7466 if (mNextFocusRightId == View.NO_ID) return null; 7467 return findViewInsideOutShouldExist(root, mNextFocusRightId); 7468 case FOCUS_UP: 7469 if (mNextFocusUpId == View.NO_ID) return null; 7470 return findViewInsideOutShouldExist(root, mNextFocusUpId); 7471 case FOCUS_DOWN: 7472 if (mNextFocusDownId == View.NO_ID) return null; 7473 return findViewInsideOutShouldExist(root, mNextFocusDownId); 7474 case FOCUS_FORWARD: 7475 if (mNextFocusForwardId == View.NO_ID) return null; 7476 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 7477 case FOCUS_BACKWARD: { 7478 if (mID == View.NO_ID) return null; 7479 final int id = mID; 7480 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 7481 @Override 7482 public boolean apply(View t) { 7483 return t.mNextFocusForwardId == id; 7484 } 7485 }); 7486 } 7487 } 7488 return null; 7489 } 7490 7491 private View findViewInsideOutShouldExist(View root, int id) { 7492 if (mMatchIdPredicate == null) { 7493 mMatchIdPredicate = new MatchIdPredicate(); 7494 } 7495 mMatchIdPredicate.mId = id; 7496 View result = root.findViewByPredicateInsideOut(this, mMatchIdPredicate); 7497 if (result == null) { 7498 Log.w(VIEW_LOG_TAG, "couldn't find view with id " + id); 7499 } 7500 return result; 7501 } 7502 7503 /** 7504 * Find and return all focusable views that are descendants of this view, 7505 * possibly including this view if it is focusable itself. 7506 * 7507 * @param direction The direction of the focus 7508 * @return A list of focusable views 7509 */ 7510 public ArrayList<View> getFocusables(@FocusDirection int direction) { 7511 ArrayList<View> result = new ArrayList<View>(24); 7512 addFocusables(result, direction); 7513 return result; 7514 } 7515 7516 /** 7517 * Add any focusable views that are descendants of this view (possibly 7518 * including this view if it is focusable itself) to views. If we are in touch mode, 7519 * only add views that are also focusable in touch mode. 7520 * 7521 * @param views Focusable views found so far 7522 * @param direction The direction of the focus 7523 */ 7524 public void addFocusables(ArrayList<View> views, @FocusDirection int direction) { 7525 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 7526 } 7527 7528 /** 7529 * Adds any focusable views that are descendants of this view (possibly 7530 * including this view if it is focusable itself) to views. This method 7531 * adds all focusable views regardless if we are in touch mode or 7532 * only views focusable in touch mode if we are in touch mode or 7533 * only views that can take accessibility focus if accessibility is enabeld 7534 * depending on the focusable mode paramater. 7535 * 7536 * @param views Focusable views found so far or null if all we are interested is 7537 * the number of focusables. 7538 * @param direction The direction of the focus. 7539 * @param focusableMode The type of focusables to be added. 7540 * 7541 * @see #FOCUSABLES_ALL 7542 * @see #FOCUSABLES_TOUCH_MODE 7543 */ 7544 public void addFocusables(ArrayList<View> views, @FocusDirection int direction, 7545 @FocusableMode int focusableMode) { 7546 if (views == null) { 7547 return; 7548 } 7549 if (!isFocusable()) { 7550 return; 7551 } 7552 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE 7553 && isInTouchMode() && !isFocusableInTouchMode()) { 7554 return; 7555 } 7556 views.add(this); 7557 } 7558 7559 /** 7560 * Finds the Views that contain given text. The containment is case insensitive. 7561 * The search is performed by either the text that the View renders or the content 7562 * description that describes the view for accessibility purposes and the view does 7563 * not render or both. Clients can specify how the search is to be performed via 7564 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 7565 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 7566 * 7567 * @param outViews The output list of matching Views. 7568 * @param searched The text to match against. 7569 * 7570 * @see #FIND_VIEWS_WITH_TEXT 7571 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 7572 * @see #setContentDescription(CharSequence) 7573 */ 7574 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, 7575 @FindViewFlags int flags) { 7576 if (getAccessibilityNodeProvider() != null) { 7577 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 7578 outViews.add(this); 7579 } 7580 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 7581 && (searched != null && searched.length() > 0) 7582 && (mContentDescription != null && mContentDescription.length() > 0)) { 7583 String searchedLowerCase = searched.toString().toLowerCase(); 7584 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 7585 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 7586 outViews.add(this); 7587 } 7588 } 7589 } 7590 7591 /** 7592 * Find and return all touchable views that are descendants of this view, 7593 * possibly including this view if it is touchable itself. 7594 * 7595 * @return A list of touchable views 7596 */ 7597 public ArrayList<View> getTouchables() { 7598 ArrayList<View> result = new ArrayList<View>(); 7599 addTouchables(result); 7600 return result; 7601 } 7602 7603 /** 7604 * Add any touchable views that are descendants of this view (possibly 7605 * including this view if it is touchable itself) to views. 7606 * 7607 * @param views Touchable views found so far 7608 */ 7609 public void addTouchables(ArrayList<View> views) { 7610 final int viewFlags = mViewFlags; 7611 7612 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 7613 && (viewFlags & ENABLED_MASK) == ENABLED) { 7614 views.add(this); 7615 } 7616 } 7617 7618 /** 7619 * Returns whether this View is accessibility focused. 7620 * 7621 * @return True if this View is accessibility focused. 7622 */ 7623 public boolean isAccessibilityFocused() { 7624 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0; 7625 } 7626 7627 /** 7628 * Call this to try to give accessibility focus to this view. 7629 * 7630 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()} 7631 * returns false or the view is no visible or the view already has accessibility 7632 * focus. 7633 * 7634 * See also {@link #focusSearch(int)}, which is what you call to say that you 7635 * have focus, and you want your parent to look for the next one. 7636 * 7637 * @return Whether this view actually took accessibility focus. 7638 * 7639 * @hide 7640 */ 7641 public boolean requestAccessibilityFocus() { 7642 AccessibilityManager manager = AccessibilityManager.getInstance(mContext); 7643 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) { 7644 return false; 7645 } 7646 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7647 return false; 7648 } 7649 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) == 0) { 7650 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_FOCUSED; 7651 ViewRootImpl viewRootImpl = getViewRootImpl(); 7652 if (viewRootImpl != null) { 7653 viewRootImpl.setAccessibilityFocus(this, null); 7654 } 7655 invalidate(); 7656 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED); 7657 return true; 7658 } 7659 return false; 7660 } 7661 7662 /** 7663 * Call this to try to clear accessibility focus of this view. 7664 * 7665 * See also {@link #focusSearch(int)}, which is what you call to say that you 7666 * have focus, and you want your parent to look for the next one. 7667 * 7668 * @hide 7669 */ 7670 public void clearAccessibilityFocus() { 7671 clearAccessibilityFocusNoCallbacks(); 7672 // Clear the global reference of accessibility focus if this 7673 // view or any of its descendants had accessibility focus. 7674 ViewRootImpl viewRootImpl = getViewRootImpl(); 7675 if (viewRootImpl != null) { 7676 View focusHost = viewRootImpl.getAccessibilityFocusedHost(); 7677 if (focusHost != null && ViewRootImpl.isViewDescendantOf(focusHost, this)) { 7678 viewRootImpl.setAccessibilityFocus(null, null); 7679 } 7680 } 7681 } 7682 7683 private void sendAccessibilityHoverEvent(int eventType) { 7684 // Since we are not delivering to a client accessibility events from not 7685 // important views (unless the clinet request that) we need to fire the 7686 // event from the deepest view exposed to the client. As a consequence if 7687 // the user crosses a not exposed view the client will see enter and exit 7688 // of the exposed predecessor followed by and enter and exit of that same 7689 // predecessor when entering and exiting the not exposed descendant. This 7690 // is fine since the client has a clear idea which view is hovered at the 7691 // price of a couple more events being sent. This is a simple and 7692 // working solution. 7693 View source = this; 7694 while (true) { 7695 if (source.includeForAccessibility()) { 7696 source.sendAccessibilityEvent(eventType); 7697 return; 7698 } 7699 ViewParent parent = source.getParent(); 7700 if (parent instanceof View) { 7701 source = (View) parent; 7702 } else { 7703 return; 7704 } 7705 } 7706 } 7707 7708 /** 7709 * Clears accessibility focus without calling any callback methods 7710 * normally invoked in {@link #clearAccessibilityFocus()}. This method 7711 * is used for clearing accessibility focus when giving this focus to 7712 * another view. 7713 */ 7714 void clearAccessibilityFocusNoCallbacks() { 7715 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) { 7716 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED; 7717 invalidate(); 7718 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED); 7719 } 7720 } 7721 7722 /** 7723 * Call this to try to give focus to a specific view or to one of its 7724 * descendants. 7725 * 7726 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7727 * false), or if it is focusable and it is not focusable in touch mode 7728 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7729 * 7730 * See also {@link #focusSearch(int)}, which is what you call to say that you 7731 * have focus, and you want your parent to look for the next one. 7732 * 7733 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 7734 * {@link #FOCUS_DOWN} and <code>null</code>. 7735 * 7736 * @return Whether this view or one of its descendants actually took focus. 7737 */ 7738 public final boolean requestFocus() { 7739 return requestFocus(View.FOCUS_DOWN); 7740 } 7741 7742 /** 7743 * Call this to try to give focus to a specific view or to one of its 7744 * descendants and give it a hint about what direction focus is heading. 7745 * 7746 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7747 * false), or if it is focusable and it is not focusable in touch mode 7748 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7749 * 7750 * See also {@link #focusSearch(int)}, which is what you call to say that you 7751 * have focus, and you want your parent to look for the next one. 7752 * 7753 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 7754 * <code>null</code> set for the previously focused rectangle. 7755 * 7756 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7757 * @return Whether this view or one of its descendants actually took focus. 7758 */ 7759 public final boolean requestFocus(int direction) { 7760 return requestFocus(direction, null); 7761 } 7762 7763 /** 7764 * Call this to try to give focus to a specific view or to one of its descendants 7765 * and give it hints about the direction and a specific rectangle that the focus 7766 * is coming from. The rectangle can help give larger views a finer grained hint 7767 * about where focus is coming from, and therefore, where to show selection, or 7768 * forward focus change internally. 7769 * 7770 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7771 * false), or if it is focusable and it is not focusable in touch mode 7772 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7773 * 7774 * A View will not take focus if it is not visible. 7775 * 7776 * A View will not take focus if one of its parents has 7777 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 7778 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 7779 * 7780 * See also {@link #focusSearch(int)}, which is what you call to say that you 7781 * have focus, and you want your parent to look for the next one. 7782 * 7783 * You may wish to override this method if your custom {@link View} has an internal 7784 * {@link View} that it wishes to forward the request to. 7785 * 7786 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7787 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 7788 * to give a finer grained hint about where focus is coming from. May be null 7789 * if there is no hint. 7790 * @return Whether this view or one of its descendants actually took focus. 7791 */ 7792 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 7793 return requestFocusNoSearch(direction, previouslyFocusedRect); 7794 } 7795 7796 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) { 7797 // need to be focusable 7798 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 7799 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7800 return false; 7801 } 7802 7803 // need to be focusable in touch mode if in touch mode 7804 if (isInTouchMode() && 7805 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 7806 return false; 7807 } 7808 7809 // need to not have any parents blocking us 7810 if (hasAncestorThatBlocksDescendantFocus()) { 7811 return false; 7812 } 7813 7814 handleFocusGainInternal(direction, previouslyFocusedRect); 7815 return true; 7816 } 7817 7818 /** 7819 * Call this to try to give focus to a specific view or to one of its descendants. This is a 7820 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 7821 * touch mode to request focus when they are touched. 7822 * 7823 * @return Whether this view or one of its descendants actually took focus. 7824 * 7825 * @see #isInTouchMode() 7826 * 7827 */ 7828 public final boolean requestFocusFromTouch() { 7829 // Leave touch mode if we need to 7830 if (isInTouchMode()) { 7831 ViewRootImpl viewRoot = getViewRootImpl(); 7832 if (viewRoot != null) { 7833 viewRoot.ensureTouchMode(false); 7834 } 7835 } 7836 return requestFocus(View.FOCUS_DOWN); 7837 } 7838 7839 /** 7840 * @return Whether any ancestor of this view blocks descendant focus. 7841 */ 7842 private boolean hasAncestorThatBlocksDescendantFocus() { 7843 final boolean focusableInTouchMode = isFocusableInTouchMode(); 7844 ViewParent ancestor = mParent; 7845 while (ancestor instanceof ViewGroup) { 7846 final ViewGroup vgAncestor = (ViewGroup) ancestor; 7847 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS 7848 || (!focusableInTouchMode && vgAncestor.shouldBlockFocusForTouchscreen())) { 7849 return true; 7850 } else { 7851 ancestor = vgAncestor.getParent(); 7852 } 7853 } 7854 return false; 7855 } 7856 7857 /** 7858 * Gets the mode for determining whether this View is important for accessibility 7859 * which is if it fires accessibility events and if it is reported to 7860 * accessibility services that query the screen. 7861 * 7862 * @return The mode for determining whether a View is important for accessibility. 7863 * 7864 * @attr ref android.R.styleable#View_importantForAccessibility 7865 * 7866 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7867 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7868 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7869 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7870 */ 7871 @ViewDebug.ExportedProperty(category = "accessibility", mapping = { 7872 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, to = "auto"), 7873 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, to = "yes"), 7874 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, to = "no"), 7875 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, 7876 to = "noHideDescendants") 7877 }) 7878 public int getImportantForAccessibility() { 7879 return (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 7880 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 7881 } 7882 7883 /** 7884 * Sets the live region mode for this view. This indicates to accessibility 7885 * services whether they should automatically notify the user about changes 7886 * to the view's content description or text, or to the content descriptions 7887 * or text of the view's children (where applicable). 7888 * <p> 7889 * For example, in a login screen with a TextView that displays an "incorrect 7890 * password" notification, that view should be marked as a live region with 7891 * mode {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7892 * <p> 7893 * To disable change notifications for this view, use 7894 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. This is the default live region 7895 * mode for most views. 7896 * <p> 7897 * To indicate that the user should be notified of changes, use 7898 * {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7899 * <p> 7900 * If the view's changes should interrupt ongoing speech and notify the user 7901 * immediately, use {@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE}. 7902 * 7903 * @param mode The live region mode for this view, one of: 7904 * <ul> 7905 * <li>{@link #ACCESSIBILITY_LIVE_REGION_NONE} 7906 * <li>{@link #ACCESSIBILITY_LIVE_REGION_POLITE} 7907 * <li>{@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE} 7908 * </ul> 7909 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7910 */ 7911 public void setAccessibilityLiveRegion(int mode) { 7912 if (mode != getAccessibilityLiveRegion()) { 7913 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7914 mPrivateFlags2 |= (mode << PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT) 7915 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7916 notifyViewAccessibilityStateChangedIfNeeded( 7917 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7918 } 7919 } 7920 7921 /** 7922 * Gets the live region mode for this View. 7923 * 7924 * @return The live region mode for the view. 7925 * 7926 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7927 * 7928 * @see #setAccessibilityLiveRegion(int) 7929 */ 7930 public int getAccessibilityLiveRegion() { 7931 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK) 7932 >> PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT; 7933 } 7934 7935 /** 7936 * Sets how to determine whether this view is important for accessibility 7937 * which is if it fires accessibility events and if it is reported to 7938 * accessibility services that query the screen. 7939 * 7940 * @param mode How to determine whether this view is important for accessibility. 7941 * 7942 * @attr ref android.R.styleable#View_importantForAccessibility 7943 * 7944 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7945 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7946 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7947 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7948 */ 7949 public void setImportantForAccessibility(int mode) { 7950 final int oldMode = getImportantForAccessibility(); 7951 if (mode != oldMode) { 7952 // If we're moving between AUTO and another state, we might not need 7953 // to send a subtree changed notification. We'll store the computed 7954 // importance, since we'll need to check it later to make sure. 7955 final boolean maySkipNotify = oldMode == IMPORTANT_FOR_ACCESSIBILITY_AUTO 7956 || mode == IMPORTANT_FOR_ACCESSIBILITY_AUTO; 7957 final boolean oldIncludeForAccessibility = maySkipNotify && includeForAccessibility(); 7958 mPrivateFlags2 &= ~PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7959 mPrivateFlags2 |= (mode << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT) 7960 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7961 if (!maySkipNotify || oldIncludeForAccessibility != includeForAccessibility()) { 7962 notifySubtreeAccessibilityStateChangedIfNeeded(); 7963 } else { 7964 notifyViewAccessibilityStateChangedIfNeeded( 7965 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7966 } 7967 } 7968 } 7969 7970 /** 7971 * Computes whether this view should be exposed for accessibility. In 7972 * general, views that are interactive or provide information are exposed 7973 * while views that serve only as containers are hidden. 7974 * <p> 7975 * If an ancestor of this view has importance 7976 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, this method 7977 * returns <code>false</code>. 7978 * <p> 7979 * Otherwise, the value is computed according to the view's 7980 * {@link #getImportantForAccessibility()} value: 7981 * <ol> 7982 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_NO} or 7983 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, return <code>false 7984 * </code> 7985 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_YES}, return <code>true</code> 7986 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_AUTO}, return <code>true</code> if 7987 * view satisfies any of the following: 7988 * <ul> 7989 * <li>Is actionable, e.g. {@link #isClickable()}, 7990 * {@link #isLongClickable()}, or {@link #isFocusable()} 7991 * <li>Has an {@link AccessibilityDelegate} 7992 * <li>Has an interaction listener, e.g. {@link OnTouchListener}, 7993 * {@link OnKeyListener}, etc. 7994 * <li>Is an accessibility live region, e.g. 7995 * {@link #getAccessibilityLiveRegion()} is not 7996 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. 7997 * </ul> 7998 * </ol> 7999 * 8000 * @return Whether the view is exposed for accessibility. 8001 * @see #setImportantForAccessibility(int) 8002 * @see #getImportantForAccessibility() 8003 */ 8004 public boolean isImportantForAccessibility() { 8005 final int mode = (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 8006 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 8007 if (mode == IMPORTANT_FOR_ACCESSIBILITY_NO 8008 || mode == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 8009 return false; 8010 } 8011 8012 // Check parent mode to ensure we're not hidden. 8013 ViewParent parent = mParent; 8014 while (parent instanceof View) { 8015 if (((View) parent).getImportantForAccessibility() 8016 == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 8017 return false; 8018 } 8019 parent = parent.getParent(); 8020 } 8021 8022 return mode == IMPORTANT_FOR_ACCESSIBILITY_YES || isActionableForAccessibility() 8023 || hasListenersForAccessibility() || getAccessibilityNodeProvider() != null 8024 || getAccessibilityLiveRegion() != ACCESSIBILITY_LIVE_REGION_NONE; 8025 } 8026 8027 /** 8028 * Gets the parent for accessibility purposes. Note that the parent for 8029 * accessibility is not necessary the immediate parent. It is the first 8030 * predecessor that is important for accessibility. 8031 * 8032 * @return The parent for accessibility purposes. 8033 */ 8034 public ViewParent getParentForAccessibility() { 8035 if (mParent instanceof View) { 8036 View parentView = (View) mParent; 8037 if (parentView.includeForAccessibility()) { 8038 return mParent; 8039 } else { 8040 return mParent.getParentForAccessibility(); 8041 } 8042 } 8043 return null; 8044 } 8045 8046 /** 8047 * Adds the children of a given View for accessibility. Since some Views are 8048 * not important for accessibility the children for accessibility are not 8049 * necessarily direct children of the view, rather they are the first level of 8050 * descendants important for accessibility. 8051 * 8052 * @param children The list of children for accessibility. 8053 */ 8054 public void addChildrenForAccessibility(ArrayList<View> children) { 8055 8056 } 8057 8058 /** 8059 * Whether to regard this view for accessibility. A view is regarded for 8060 * accessibility if it is important for accessibility or the querying 8061 * accessibility service has explicitly requested that view not 8062 * important for accessibility are regarded. 8063 * 8064 * @return Whether to regard the view for accessibility. 8065 * 8066 * @hide 8067 */ 8068 public boolean includeForAccessibility() { 8069 if (mAttachInfo != null) { 8070 return (mAttachInfo.mAccessibilityFetchFlags 8071 & AccessibilityNodeInfo.FLAG_INCLUDE_NOT_IMPORTANT_VIEWS) != 0 8072 || isImportantForAccessibility(); 8073 } 8074 return false; 8075 } 8076 8077 /** 8078 * Returns whether the View is considered actionable from 8079 * accessibility perspective. Such view are important for 8080 * accessibility. 8081 * 8082 * @return True if the view is actionable for accessibility. 8083 * 8084 * @hide 8085 */ 8086 public boolean isActionableForAccessibility() { 8087 return (isClickable() || isLongClickable() || isFocusable()); 8088 } 8089 8090 /** 8091 * Returns whether the View has registered callbacks which makes it 8092 * important for accessibility. 8093 * 8094 * @return True if the view is actionable for accessibility. 8095 */ 8096 private boolean hasListenersForAccessibility() { 8097 ListenerInfo info = getListenerInfo(); 8098 return mTouchDelegate != null || info.mOnKeyListener != null 8099 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null 8100 || info.mOnHoverListener != null || info.mOnDragListener != null; 8101 } 8102 8103 /** 8104 * Notifies that the accessibility state of this view changed. The change 8105 * is local to this view and does not represent structural changes such 8106 * as children and parent. For example, the view became focusable. The 8107 * notification is at at most once every 8108 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 8109 * to avoid unnecessary load to the system. Also once a view has a pending 8110 * notification this method is a NOP until the notification has been sent. 8111 * 8112 * @hide 8113 */ 8114 public void notifyViewAccessibilityStateChangedIfNeeded(int changeType) { 8115 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8116 return; 8117 } 8118 if (mSendViewStateChangedAccessibilityEvent == null) { 8119 mSendViewStateChangedAccessibilityEvent = 8120 new SendViewStateChangedAccessibilityEvent(); 8121 } 8122 mSendViewStateChangedAccessibilityEvent.runOrPost(changeType); 8123 } 8124 8125 /** 8126 * Notifies that the accessibility state of this view changed. The change 8127 * is *not* local to this view and does represent structural changes such 8128 * as children and parent. For example, the view size changed. The 8129 * notification is at at most once every 8130 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 8131 * to avoid unnecessary load to the system. Also once a view has a pending 8132 * notification this method is a NOP until the notification has been sent. 8133 * 8134 * @hide 8135 */ 8136 public void notifySubtreeAccessibilityStateChangedIfNeeded() { 8137 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8138 return; 8139 } 8140 if ((mPrivateFlags2 & PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED) == 0) { 8141 mPrivateFlags2 |= PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8142 if (mParent != null) { 8143 try { 8144 mParent.notifySubtreeAccessibilityStateChanged( 8145 this, this, AccessibilityEvent.CONTENT_CHANGE_TYPE_SUBTREE); 8146 } catch (AbstractMethodError e) { 8147 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 8148 " does not fully implement ViewParent", e); 8149 } 8150 } 8151 } 8152 } 8153 8154 /** 8155 * Reset the flag indicating the accessibility state of the subtree rooted 8156 * at this view changed. 8157 */ 8158 void resetSubtreeAccessibilityStateChanged() { 8159 mPrivateFlags2 &= ~PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8160 } 8161 8162 /** 8163 * Performs the specified accessibility action on the view. For 8164 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 8165 * <p> 8166 * If an {@link AccessibilityDelegate} has been specified via calling 8167 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 8168 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)} 8169 * is responsible for handling this call. 8170 * </p> 8171 * 8172 * @param action The action to perform. 8173 * @param arguments Optional action arguments. 8174 * @return Whether the action was performed. 8175 */ 8176 public boolean performAccessibilityAction(int action, Bundle arguments) { 8177 if (mAccessibilityDelegate != null) { 8178 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments); 8179 } else { 8180 return performAccessibilityActionInternal(action, arguments); 8181 } 8182 } 8183 8184 /** 8185 * @see #performAccessibilityAction(int, Bundle) 8186 * 8187 * Note: Called from the default {@link AccessibilityDelegate}. 8188 */ 8189 boolean performAccessibilityActionInternal(int action, Bundle arguments) { 8190 switch (action) { 8191 case AccessibilityNodeInfo.ACTION_CLICK: { 8192 if (isClickable()) { 8193 performClick(); 8194 return true; 8195 } 8196 } break; 8197 case AccessibilityNodeInfo.ACTION_LONG_CLICK: { 8198 if (isLongClickable()) { 8199 performLongClick(); 8200 return true; 8201 } 8202 } break; 8203 case AccessibilityNodeInfo.ACTION_FOCUS: { 8204 if (!hasFocus()) { 8205 // Get out of touch mode since accessibility 8206 // wants to move focus around. 8207 getViewRootImpl().ensureTouchMode(false); 8208 return requestFocus(); 8209 } 8210 } break; 8211 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: { 8212 if (hasFocus()) { 8213 clearFocus(); 8214 return !isFocused(); 8215 } 8216 } break; 8217 case AccessibilityNodeInfo.ACTION_SELECT: { 8218 if (!isSelected()) { 8219 setSelected(true); 8220 return isSelected(); 8221 } 8222 } break; 8223 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: { 8224 if (isSelected()) { 8225 setSelected(false); 8226 return !isSelected(); 8227 } 8228 } break; 8229 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: { 8230 if (!isAccessibilityFocused()) { 8231 return requestAccessibilityFocus(); 8232 } 8233 } break; 8234 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: { 8235 if (isAccessibilityFocused()) { 8236 clearAccessibilityFocus(); 8237 return true; 8238 } 8239 } break; 8240 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: { 8241 if (arguments != null) { 8242 final int granularity = arguments.getInt( 8243 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8244 final boolean extendSelection = arguments.getBoolean( 8245 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8246 return traverseAtGranularity(granularity, true, extendSelection); 8247 } 8248 } break; 8249 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: { 8250 if (arguments != null) { 8251 final int granularity = arguments.getInt( 8252 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8253 final boolean extendSelection = arguments.getBoolean( 8254 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8255 return traverseAtGranularity(granularity, false, extendSelection); 8256 } 8257 } break; 8258 case AccessibilityNodeInfo.ACTION_SET_SELECTION: { 8259 CharSequence text = getIterableTextForAccessibility(); 8260 if (text == null) { 8261 return false; 8262 } 8263 final int start = (arguments != null) ? arguments.getInt( 8264 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT, -1) : -1; 8265 final int end = (arguments != null) ? arguments.getInt( 8266 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT, -1) : -1; 8267 // Only cursor position can be specified (selection length == 0) 8268 if ((getAccessibilitySelectionStart() != start 8269 || getAccessibilitySelectionEnd() != end) 8270 && (start == end)) { 8271 setAccessibilitySelection(start, end); 8272 notifyViewAccessibilityStateChangedIfNeeded( 8273 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 8274 return true; 8275 } 8276 } break; 8277 } 8278 return false; 8279 } 8280 8281 private boolean traverseAtGranularity(int granularity, boolean forward, 8282 boolean extendSelection) { 8283 CharSequence text = getIterableTextForAccessibility(); 8284 if (text == null || text.length() == 0) { 8285 return false; 8286 } 8287 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 8288 if (iterator == null) { 8289 return false; 8290 } 8291 int current = getAccessibilitySelectionEnd(); 8292 if (current == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8293 current = forward ? 0 : text.length(); 8294 } 8295 final int[] range = forward ? iterator.following(current) : iterator.preceding(current); 8296 if (range == null) { 8297 return false; 8298 } 8299 final int segmentStart = range[0]; 8300 final int segmentEnd = range[1]; 8301 int selectionStart; 8302 int selectionEnd; 8303 if (extendSelection && isAccessibilitySelectionExtendable()) { 8304 selectionStart = getAccessibilitySelectionStart(); 8305 if (selectionStart == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8306 selectionStart = forward ? segmentStart : segmentEnd; 8307 } 8308 selectionEnd = forward ? segmentEnd : segmentStart; 8309 } else { 8310 selectionStart = selectionEnd= forward ? segmentEnd : segmentStart; 8311 } 8312 setAccessibilitySelection(selectionStart, selectionEnd); 8313 final int action = forward ? AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY 8314 : AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY; 8315 sendViewTextTraversedAtGranularityEvent(action, granularity, segmentStart, segmentEnd); 8316 return true; 8317 } 8318 8319 /** 8320 * Gets the text reported for accessibility purposes. 8321 * 8322 * @return The accessibility text. 8323 * 8324 * @hide 8325 */ 8326 public CharSequence getIterableTextForAccessibility() { 8327 return getContentDescription(); 8328 } 8329 8330 /** 8331 * Gets whether accessibility selection can be extended. 8332 * 8333 * @return If selection is extensible. 8334 * 8335 * @hide 8336 */ 8337 public boolean isAccessibilitySelectionExtendable() { 8338 return false; 8339 } 8340 8341 /** 8342 * @hide 8343 */ 8344 public int getAccessibilitySelectionStart() { 8345 return mAccessibilityCursorPosition; 8346 } 8347 8348 /** 8349 * @hide 8350 */ 8351 public int getAccessibilitySelectionEnd() { 8352 return getAccessibilitySelectionStart(); 8353 } 8354 8355 /** 8356 * @hide 8357 */ 8358 public void setAccessibilitySelection(int start, int end) { 8359 if (start == end && end == mAccessibilityCursorPosition) { 8360 return; 8361 } 8362 if (start >= 0 && start == end && end <= getIterableTextForAccessibility().length()) { 8363 mAccessibilityCursorPosition = start; 8364 } else { 8365 mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED; 8366 } 8367 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED); 8368 } 8369 8370 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity, 8371 int fromIndex, int toIndex) { 8372 if (mParent == null) { 8373 return; 8374 } 8375 AccessibilityEvent event = AccessibilityEvent.obtain( 8376 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY); 8377 onInitializeAccessibilityEvent(event); 8378 onPopulateAccessibilityEvent(event); 8379 event.setFromIndex(fromIndex); 8380 event.setToIndex(toIndex); 8381 event.setAction(action); 8382 event.setMovementGranularity(granularity); 8383 mParent.requestSendAccessibilityEvent(this, event); 8384 } 8385 8386 /** 8387 * @hide 8388 */ 8389 public TextSegmentIterator getIteratorForGranularity(int granularity) { 8390 switch (granularity) { 8391 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: { 8392 CharSequence text = getIterableTextForAccessibility(); 8393 if (text != null && text.length() > 0) { 8394 CharacterTextSegmentIterator iterator = 8395 CharacterTextSegmentIterator.getInstance( 8396 mContext.getResources().getConfiguration().locale); 8397 iterator.initialize(text.toString()); 8398 return iterator; 8399 } 8400 } break; 8401 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: { 8402 CharSequence text = getIterableTextForAccessibility(); 8403 if (text != null && text.length() > 0) { 8404 WordTextSegmentIterator iterator = 8405 WordTextSegmentIterator.getInstance( 8406 mContext.getResources().getConfiguration().locale); 8407 iterator.initialize(text.toString()); 8408 return iterator; 8409 } 8410 } break; 8411 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: { 8412 CharSequence text = getIterableTextForAccessibility(); 8413 if (text != null && text.length() > 0) { 8414 ParagraphTextSegmentIterator iterator = 8415 ParagraphTextSegmentIterator.getInstance(); 8416 iterator.initialize(text.toString()); 8417 return iterator; 8418 } 8419 } break; 8420 } 8421 return null; 8422 } 8423 8424 /** 8425 * @hide 8426 */ 8427 public void dispatchStartTemporaryDetach() { 8428 onStartTemporaryDetach(); 8429 } 8430 8431 /** 8432 * This is called when a container is going to temporarily detach a child, with 8433 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 8434 * It will either be followed by {@link #onFinishTemporaryDetach()} or 8435 * {@link #onDetachedFromWindow()} when the container is done. 8436 */ 8437 public void onStartTemporaryDetach() { 8438 removeUnsetPressCallback(); 8439 mPrivateFlags |= PFLAG_CANCEL_NEXT_UP_EVENT; 8440 } 8441 8442 /** 8443 * @hide 8444 */ 8445 public void dispatchFinishTemporaryDetach() { 8446 onFinishTemporaryDetach(); 8447 } 8448 8449 /** 8450 * Called after {@link #onStartTemporaryDetach} when the container is done 8451 * changing the view. 8452 */ 8453 public void onFinishTemporaryDetach() { 8454 } 8455 8456 /** 8457 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 8458 * for this view's window. Returns null if the view is not currently attached 8459 * to the window. Normally you will not need to use this directly, but 8460 * just use the standard high-level event callbacks like 8461 * {@link #onKeyDown(int, KeyEvent)}. 8462 */ 8463 public KeyEvent.DispatcherState getKeyDispatcherState() { 8464 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 8465 } 8466 8467 /** 8468 * Dispatch a key event before it is processed by any input method 8469 * associated with the view hierarchy. This can be used to intercept 8470 * key events in special situations before the IME consumes them; a 8471 * typical example would be handling the BACK key to update the application's 8472 * UI instead of allowing the IME to see it and close itself. 8473 * 8474 * @param event The key event to be dispatched. 8475 * @return True if the event was handled, false otherwise. 8476 */ 8477 public boolean dispatchKeyEventPreIme(KeyEvent event) { 8478 return onKeyPreIme(event.getKeyCode(), event); 8479 } 8480 8481 /** 8482 * Dispatch a key event to the next view on the focus path. This path runs 8483 * from the top of the view tree down to the currently focused view. If this 8484 * view has focus, it will dispatch to itself. Otherwise it will dispatch 8485 * the next node down the focus path. This method also fires any key 8486 * listeners. 8487 * 8488 * @param event The key event to be dispatched. 8489 * @return True if the event was handled, false otherwise. 8490 */ 8491 public boolean dispatchKeyEvent(KeyEvent event) { 8492 if (mInputEventConsistencyVerifier != null) { 8493 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 8494 } 8495 8496 // Give any attached key listener a first crack at the event. 8497 //noinspection SimplifiableIfStatement 8498 ListenerInfo li = mListenerInfo; 8499 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 8500 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 8501 return true; 8502 } 8503 8504 if (event.dispatch(this, mAttachInfo != null 8505 ? mAttachInfo.mKeyDispatchState : null, this)) { 8506 return true; 8507 } 8508 8509 if (mInputEventConsistencyVerifier != null) { 8510 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8511 } 8512 return false; 8513 } 8514 8515 /** 8516 * Dispatches a key shortcut event. 8517 * 8518 * @param event The key event to be dispatched. 8519 * @return True if the event was handled by the view, false otherwise. 8520 */ 8521 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 8522 return onKeyShortcut(event.getKeyCode(), event); 8523 } 8524 8525 /** 8526 * Pass the touch screen motion event down to the target view, or this 8527 * view if it is the target. 8528 * 8529 * @param event The motion event to be dispatched. 8530 * @return True if the event was handled by the view, false otherwise. 8531 */ 8532 public boolean dispatchTouchEvent(MotionEvent event) { 8533 boolean result = false; 8534 8535 if (mInputEventConsistencyVerifier != null) { 8536 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 8537 } 8538 8539 final int actionMasked = event.getActionMasked(); 8540 if (actionMasked == MotionEvent.ACTION_DOWN) { 8541 // Defensive cleanup for new gesture 8542 stopNestedScroll(); 8543 } 8544 8545 if (onFilterTouchEventForSecurity(event)) { 8546 //noinspection SimplifiableIfStatement 8547 ListenerInfo li = mListenerInfo; 8548 if (li != null && li.mOnTouchListener != null 8549 && (mViewFlags & ENABLED_MASK) == ENABLED 8550 && li.mOnTouchListener.onTouch(this, event)) { 8551 result = true; 8552 } 8553 8554 if (!result && onTouchEvent(event)) { 8555 result = true; 8556 } 8557 } 8558 8559 if (!result && mInputEventConsistencyVerifier != null) { 8560 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8561 } 8562 8563 // Clean up after nested scrolls if this is the end of a gesture; 8564 // also cancel it if we tried an ACTION_DOWN but we didn't want the rest 8565 // of the gesture. 8566 if (actionMasked == MotionEvent.ACTION_UP || 8567 actionMasked == MotionEvent.ACTION_CANCEL || 8568 (actionMasked == MotionEvent.ACTION_DOWN && !result)) { 8569 stopNestedScroll(); 8570 } 8571 8572 return result; 8573 } 8574 8575 /** 8576 * Filter the touch event to apply security policies. 8577 * 8578 * @param event The motion event to be filtered. 8579 * @return True if the event should be dispatched, false if the event should be dropped. 8580 * 8581 * @see #getFilterTouchesWhenObscured 8582 */ 8583 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 8584 //noinspection RedundantIfStatement 8585 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 8586 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 8587 // Window is obscured, drop this touch. 8588 return false; 8589 } 8590 return true; 8591 } 8592 8593 /** 8594 * Pass a trackball motion event down to the focused view. 8595 * 8596 * @param event The motion event to be dispatched. 8597 * @return True if the event was handled by the view, false otherwise. 8598 */ 8599 public boolean dispatchTrackballEvent(MotionEvent event) { 8600 if (mInputEventConsistencyVerifier != null) { 8601 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 8602 } 8603 8604 return onTrackballEvent(event); 8605 } 8606 8607 /** 8608 * Dispatch a generic motion event. 8609 * <p> 8610 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 8611 * are delivered to the view under the pointer. All other generic motion events are 8612 * delivered to the focused view. Hover events are handled specially and are delivered 8613 * to {@link #onHoverEvent(MotionEvent)}. 8614 * </p> 8615 * 8616 * @param event The motion event to be dispatched. 8617 * @return True if the event was handled by the view, false otherwise. 8618 */ 8619 public boolean dispatchGenericMotionEvent(MotionEvent event) { 8620 if (mInputEventConsistencyVerifier != null) { 8621 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 8622 } 8623 8624 final int source = event.getSource(); 8625 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 8626 final int action = event.getAction(); 8627 if (action == MotionEvent.ACTION_HOVER_ENTER 8628 || action == MotionEvent.ACTION_HOVER_MOVE 8629 || action == MotionEvent.ACTION_HOVER_EXIT) { 8630 if (dispatchHoverEvent(event)) { 8631 return true; 8632 } 8633 } else if (dispatchGenericPointerEvent(event)) { 8634 return true; 8635 } 8636 } else if (dispatchGenericFocusedEvent(event)) { 8637 return true; 8638 } 8639 8640 if (dispatchGenericMotionEventInternal(event)) { 8641 return true; 8642 } 8643 8644 if (mInputEventConsistencyVerifier != null) { 8645 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8646 } 8647 return false; 8648 } 8649 8650 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 8651 //noinspection SimplifiableIfStatement 8652 ListenerInfo li = mListenerInfo; 8653 if (li != null && li.mOnGenericMotionListener != null 8654 && (mViewFlags & ENABLED_MASK) == ENABLED 8655 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 8656 return true; 8657 } 8658 8659 if (onGenericMotionEvent(event)) { 8660 return true; 8661 } 8662 8663 if (mInputEventConsistencyVerifier != null) { 8664 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8665 } 8666 return false; 8667 } 8668 8669 /** 8670 * Dispatch a hover event. 8671 * <p> 8672 * Do not call this method directly. 8673 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8674 * </p> 8675 * 8676 * @param event The motion event to be dispatched. 8677 * @return True if the event was handled by the view, false otherwise. 8678 */ 8679 protected boolean dispatchHoverEvent(MotionEvent event) { 8680 ListenerInfo li = mListenerInfo; 8681 //noinspection SimplifiableIfStatement 8682 if (li != null && li.mOnHoverListener != null 8683 && (mViewFlags & ENABLED_MASK) == ENABLED 8684 && li.mOnHoverListener.onHover(this, event)) { 8685 return true; 8686 } 8687 8688 return onHoverEvent(event); 8689 } 8690 8691 /** 8692 * Returns true if the view has a child to which it has recently sent 8693 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 8694 * it does not have a hovered child, then it must be the innermost hovered view. 8695 * @hide 8696 */ 8697 protected boolean hasHoveredChild() { 8698 return false; 8699 } 8700 8701 /** 8702 * Dispatch a generic motion event to the view under the first pointer. 8703 * <p> 8704 * Do not call this method directly. 8705 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8706 * </p> 8707 * 8708 * @param event The motion event to be dispatched. 8709 * @return True if the event was handled by the view, false otherwise. 8710 */ 8711 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 8712 return false; 8713 } 8714 8715 /** 8716 * Dispatch a generic motion event to the currently focused view. 8717 * <p> 8718 * Do not call this method directly. 8719 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8720 * </p> 8721 * 8722 * @param event The motion event to be dispatched. 8723 * @return True if the event was handled by the view, false otherwise. 8724 */ 8725 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 8726 return false; 8727 } 8728 8729 /** 8730 * Dispatch a pointer event. 8731 * <p> 8732 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 8733 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 8734 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 8735 * and should not be expected to handle other pointing device features. 8736 * </p> 8737 * 8738 * @param event The motion event to be dispatched. 8739 * @return True if the event was handled by the view, false otherwise. 8740 * @hide 8741 */ 8742 public final boolean dispatchPointerEvent(MotionEvent event) { 8743 if (event.isTouchEvent()) { 8744 return dispatchTouchEvent(event); 8745 } else { 8746 return dispatchGenericMotionEvent(event); 8747 } 8748 } 8749 8750 /** 8751 * Called when the window containing this view gains or loses window focus. 8752 * ViewGroups should override to route to their children. 8753 * 8754 * @param hasFocus True if the window containing this view now has focus, 8755 * false otherwise. 8756 */ 8757 public void dispatchWindowFocusChanged(boolean hasFocus) { 8758 onWindowFocusChanged(hasFocus); 8759 } 8760 8761 /** 8762 * Called when the window containing this view gains or loses focus. Note 8763 * that this is separate from view focus: to receive key events, both 8764 * your view and its window must have focus. If a window is displayed 8765 * on top of yours that takes input focus, then your own window will lose 8766 * focus but the view focus will remain unchanged. 8767 * 8768 * @param hasWindowFocus True if the window containing this view now has 8769 * focus, false otherwise. 8770 */ 8771 public void onWindowFocusChanged(boolean hasWindowFocus) { 8772 InputMethodManager imm = InputMethodManager.peekInstance(); 8773 if (!hasWindowFocus) { 8774 if (isPressed()) { 8775 setPressed(false); 8776 } 8777 if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8778 imm.focusOut(this); 8779 } 8780 removeLongPressCallback(); 8781 removeTapCallback(); 8782 onFocusLost(); 8783 } else if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8784 imm.focusIn(this); 8785 } 8786 refreshDrawableState(); 8787 } 8788 8789 /** 8790 * Returns true if this view is in a window that currently has window focus. 8791 * Note that this is not the same as the view itself having focus. 8792 * 8793 * @return True if this view is in a window that currently has window focus. 8794 */ 8795 public boolean hasWindowFocus() { 8796 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 8797 } 8798 8799 /** 8800 * Dispatch a view visibility change down the view hierarchy. 8801 * ViewGroups should override to route to their children. 8802 * @param changedView The view whose visibility changed. Could be 'this' or 8803 * an ancestor view. 8804 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8805 * {@link #INVISIBLE} or {@link #GONE}. 8806 */ 8807 protected void dispatchVisibilityChanged(@NonNull View changedView, 8808 @Visibility int visibility) { 8809 onVisibilityChanged(changedView, visibility); 8810 } 8811 8812 /** 8813 * Called when the visibility of the view or an ancestor of the view is changed. 8814 * @param changedView The view whose visibility changed. Could be 'this' or 8815 * an ancestor view. 8816 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8817 * {@link #INVISIBLE} or {@link #GONE}. 8818 */ 8819 protected void onVisibilityChanged(@NonNull View changedView, @Visibility int visibility) { 8820 if (visibility == VISIBLE) { 8821 if (mAttachInfo != null) { 8822 initialAwakenScrollBars(); 8823 } else { 8824 mPrivateFlags |= PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 8825 } 8826 } 8827 } 8828 8829 /** 8830 * Dispatch a hint about whether this view is displayed. For instance, when 8831 * a View moves out of the screen, it might receives a display hint indicating 8832 * the view is not displayed. Applications should not <em>rely</em> on this hint 8833 * as there is no guarantee that they will receive one. 8834 * 8835 * @param hint A hint about whether or not this view is displayed: 8836 * {@link #VISIBLE} or {@link #INVISIBLE}. 8837 */ 8838 public void dispatchDisplayHint(@Visibility int hint) { 8839 onDisplayHint(hint); 8840 } 8841 8842 /** 8843 * Gives this view a hint about whether is displayed or not. For instance, when 8844 * a View moves out of the screen, it might receives a display hint indicating 8845 * the view is not displayed. Applications should not <em>rely</em> on this hint 8846 * as there is no guarantee that they will receive one. 8847 * 8848 * @param hint A hint about whether or not this view is displayed: 8849 * {@link #VISIBLE} or {@link #INVISIBLE}. 8850 */ 8851 protected void onDisplayHint(@Visibility int hint) { 8852 } 8853 8854 /** 8855 * Dispatch a window visibility change down the view hierarchy. 8856 * ViewGroups should override to route to their children. 8857 * 8858 * @param visibility The new visibility of the window. 8859 * 8860 * @see #onWindowVisibilityChanged(int) 8861 */ 8862 public void dispatchWindowVisibilityChanged(@Visibility int visibility) { 8863 onWindowVisibilityChanged(visibility); 8864 } 8865 8866 /** 8867 * Called when the window containing has change its visibility 8868 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 8869 * that this tells you whether or not your window is being made visible 8870 * to the window manager; this does <em>not</em> tell you whether or not 8871 * your window is obscured by other windows on the screen, even if it 8872 * is itself visible. 8873 * 8874 * @param visibility The new visibility of the window. 8875 */ 8876 protected void onWindowVisibilityChanged(@Visibility int visibility) { 8877 if (visibility == VISIBLE) { 8878 initialAwakenScrollBars(); 8879 } 8880 } 8881 8882 /** 8883 * Returns the current visibility of the window this view is attached to 8884 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 8885 * 8886 * @return Returns the current visibility of the view's window. 8887 */ 8888 @Visibility 8889 public int getWindowVisibility() { 8890 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 8891 } 8892 8893 /** 8894 * Retrieve the overall visible display size in which the window this view is 8895 * attached to has been positioned in. This takes into account screen 8896 * decorations above the window, for both cases where the window itself 8897 * is being position inside of them or the window is being placed under 8898 * then and covered insets are used for the window to position its content 8899 * inside. In effect, this tells you the available area where content can 8900 * be placed and remain visible to users. 8901 * 8902 * <p>This function requires an IPC back to the window manager to retrieve 8903 * the requested information, so should not be used in performance critical 8904 * code like drawing. 8905 * 8906 * @param outRect Filled in with the visible display frame. If the view 8907 * is not attached to a window, this is simply the raw display size. 8908 */ 8909 public void getWindowVisibleDisplayFrame(Rect outRect) { 8910 if (mAttachInfo != null) { 8911 try { 8912 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 8913 } catch (RemoteException e) { 8914 return; 8915 } 8916 // XXX This is really broken, and probably all needs to be done 8917 // in the window manager, and we need to know more about whether 8918 // we want the area behind or in front of the IME. 8919 final Rect insets = mAttachInfo.mVisibleInsets; 8920 outRect.left += insets.left; 8921 outRect.top += insets.top; 8922 outRect.right -= insets.right; 8923 outRect.bottom -= insets.bottom; 8924 return; 8925 } 8926 // The view is not attached to a display so we don't have a context. 8927 // Make a best guess about the display size. 8928 Display d = DisplayManagerGlobal.getInstance().getRealDisplay(Display.DEFAULT_DISPLAY); 8929 d.getRectSize(outRect); 8930 } 8931 8932 /** 8933 * Dispatch a notification about a resource configuration change down 8934 * the view hierarchy. 8935 * ViewGroups should override to route to their children. 8936 * 8937 * @param newConfig The new resource configuration. 8938 * 8939 * @see #onConfigurationChanged(android.content.res.Configuration) 8940 */ 8941 public void dispatchConfigurationChanged(Configuration newConfig) { 8942 onConfigurationChanged(newConfig); 8943 } 8944 8945 /** 8946 * Called when the current configuration of the resources being used 8947 * by the application have changed. You can use this to decide when 8948 * to reload resources that can changed based on orientation and other 8949 * configuration characterstics. You only need to use this if you are 8950 * not relying on the normal {@link android.app.Activity} mechanism of 8951 * recreating the activity instance upon a configuration change. 8952 * 8953 * @param newConfig The new resource configuration. 8954 */ 8955 protected void onConfigurationChanged(Configuration newConfig) { 8956 } 8957 8958 /** 8959 * Private function to aggregate all per-view attributes in to the view 8960 * root. 8961 */ 8962 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8963 performCollectViewAttributes(attachInfo, visibility); 8964 } 8965 8966 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8967 if ((visibility & VISIBILITY_MASK) == VISIBLE) { 8968 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 8969 attachInfo.mKeepScreenOn = true; 8970 } 8971 attachInfo.mSystemUiVisibility |= mSystemUiVisibility; 8972 ListenerInfo li = mListenerInfo; 8973 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 8974 attachInfo.mHasSystemUiListeners = true; 8975 } 8976 } 8977 } 8978 8979 void needGlobalAttributesUpdate(boolean force) { 8980 final AttachInfo ai = mAttachInfo; 8981 if (ai != null && !ai.mRecomputeGlobalAttributes) { 8982 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 8983 || ai.mHasSystemUiListeners) { 8984 ai.mRecomputeGlobalAttributes = true; 8985 } 8986 } 8987 } 8988 8989 /** 8990 * Returns whether the device is currently in touch mode. Touch mode is entered 8991 * once the user begins interacting with the device by touch, and affects various 8992 * things like whether focus is always visible to the user. 8993 * 8994 * @return Whether the device is in touch mode. 8995 */ 8996 @ViewDebug.ExportedProperty 8997 public boolean isInTouchMode() { 8998 if (mAttachInfo != null) { 8999 return mAttachInfo.mInTouchMode; 9000 } else { 9001 return ViewRootImpl.isInTouchMode(); 9002 } 9003 } 9004 9005 /** 9006 * Returns the context the view is running in, through which it can 9007 * access the current theme, resources, etc. 9008 * 9009 * @return The view's Context. 9010 */ 9011 @ViewDebug.CapturedViewProperty 9012 public final Context getContext() { 9013 return mContext; 9014 } 9015 9016 /** 9017 * Handle a key event before it is processed by any input method 9018 * associated with the view hierarchy. This can be used to intercept 9019 * key events in special situations before the IME consumes them; a 9020 * typical example would be handling the BACK key to update the application's 9021 * UI instead of allowing the IME to see it and close itself. 9022 * 9023 * @param keyCode The value in event.getKeyCode(). 9024 * @param event Description of the key event. 9025 * @return If you handled the event, return true. If you want to allow the 9026 * event to be handled by the next receiver, return false. 9027 */ 9028 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 9029 return false; 9030 } 9031 9032 /** 9033 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 9034 * KeyEvent.Callback.onKeyDown()}: perform press of the view 9035 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 9036 * is released, if the view is enabled and clickable. 9037 * 9038 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9039 * although some may elect to do so in some situations. Do not rely on this to 9040 * catch software key presses. 9041 * 9042 * @param keyCode A key code that represents the button pressed, from 9043 * {@link android.view.KeyEvent}. 9044 * @param event The KeyEvent object that defines the button action. 9045 */ 9046 public boolean onKeyDown(int keyCode, KeyEvent event) { 9047 boolean result = false; 9048 9049 if (KeyEvent.isConfirmKey(keyCode)) { 9050 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9051 return true; 9052 } 9053 // Long clickable items don't necessarily have to be clickable 9054 if (((mViewFlags & CLICKABLE) == CLICKABLE || 9055 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 9056 (event.getRepeatCount() == 0)) { 9057 setPressed(true); 9058 checkForLongClick(0); 9059 return true; 9060 } 9061 } 9062 return result; 9063 } 9064 9065 /** 9066 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 9067 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 9068 * the event). 9069 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9070 * although some may elect to do so in some situations. Do not rely on this to 9071 * catch software key presses. 9072 */ 9073 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 9074 return false; 9075 } 9076 9077 /** 9078 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 9079 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 9080 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 9081 * {@link KeyEvent#KEYCODE_ENTER} is released. 9082 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9083 * although some may elect to do so in some situations. Do not rely on this to 9084 * catch software key presses. 9085 * 9086 * @param keyCode A key code that represents the button pressed, from 9087 * {@link android.view.KeyEvent}. 9088 * @param event The KeyEvent object that defines the button action. 9089 */ 9090 public boolean onKeyUp(int keyCode, KeyEvent event) { 9091 if (KeyEvent.isConfirmKey(keyCode)) { 9092 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9093 return true; 9094 } 9095 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 9096 setPressed(false); 9097 9098 if (!mHasPerformedLongPress) { 9099 // This is a tap, so remove the longpress check 9100 removeLongPressCallback(); 9101 return performClick(); 9102 } 9103 } 9104 } 9105 return false; 9106 } 9107 9108 /** 9109 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 9110 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 9111 * the event). 9112 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9113 * although some may elect to do so in some situations. Do not rely on this to 9114 * catch software key presses. 9115 * 9116 * @param keyCode A key code that represents the button pressed, from 9117 * {@link android.view.KeyEvent}. 9118 * @param repeatCount The number of times the action was made. 9119 * @param event The KeyEvent object that defines the button action. 9120 */ 9121 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 9122 return false; 9123 } 9124 9125 /** 9126 * Called on the focused view when a key shortcut event is not handled. 9127 * Override this method to implement local key shortcuts for the View. 9128 * Key shortcuts can also be implemented by setting the 9129 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 9130 * 9131 * @param keyCode The value in event.getKeyCode(). 9132 * @param event Description of the key event. 9133 * @return If you handled the event, return true. If you want to allow the 9134 * event to be handled by the next receiver, return false. 9135 */ 9136 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 9137 return false; 9138 } 9139 9140 /** 9141 * Check whether the called view is a text editor, in which case it 9142 * would make sense to automatically display a soft input window for 9143 * it. Subclasses should override this if they implement 9144 * {@link #onCreateInputConnection(EditorInfo)} to return true if 9145 * a call on that method would return a non-null InputConnection, and 9146 * they are really a first-class editor that the user would normally 9147 * start typing on when the go into a window containing your view. 9148 * 9149 * <p>The default implementation always returns false. This does 9150 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 9151 * will not be called or the user can not otherwise perform edits on your 9152 * view; it is just a hint to the system that this is not the primary 9153 * purpose of this view. 9154 * 9155 * @return Returns true if this view is a text editor, else false. 9156 */ 9157 public boolean onCheckIsTextEditor() { 9158 return false; 9159 } 9160 9161 /** 9162 * Create a new InputConnection for an InputMethod to interact 9163 * with the view. The default implementation returns null, since it doesn't 9164 * support input methods. You can override this to implement such support. 9165 * This is only needed for views that take focus and text input. 9166 * 9167 * <p>When implementing this, you probably also want to implement 9168 * {@link #onCheckIsTextEditor()} to indicate you will return a 9169 * non-null InputConnection.</p> 9170 * 9171 * <p>Also, take good care to fill in the {@link android.view.inputmethod.EditorInfo} 9172 * object correctly and in its entirety, so that the connected IME can rely 9173 * on its values. For example, {@link android.view.inputmethod.EditorInfo#initialSelStart} 9174 * and {@link android.view.inputmethod.EditorInfo#initialSelEnd} members 9175 * must be filled in with the correct cursor position for IMEs to work correctly 9176 * with your application.</p> 9177 * 9178 * @param outAttrs Fill in with attribute information about the connection. 9179 */ 9180 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 9181 return null; 9182 } 9183 9184 /** 9185 * Called by the {@link android.view.inputmethod.InputMethodManager} 9186 * when a view who is not the current 9187 * input connection target is trying to make a call on the manager. The 9188 * default implementation returns false; you can override this to return 9189 * true for certain views if you are performing InputConnection proxying 9190 * to them. 9191 * @param view The View that is making the InputMethodManager call. 9192 * @return Return true to allow the call, false to reject. 9193 */ 9194 public boolean checkInputConnectionProxy(View view) { 9195 return false; 9196 } 9197 9198 /** 9199 * Show the context menu for this view. It is not safe to hold on to the 9200 * menu after returning from this method. 9201 * 9202 * You should normally not overload this method. Overload 9203 * {@link #onCreateContextMenu(ContextMenu)} or define an 9204 * {@link OnCreateContextMenuListener} to add items to the context menu. 9205 * 9206 * @param menu The context menu to populate 9207 */ 9208 public void createContextMenu(ContextMenu menu) { 9209 ContextMenuInfo menuInfo = getContextMenuInfo(); 9210 9211 // Sets the current menu info so all items added to menu will have 9212 // my extra info set. 9213 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 9214 9215 onCreateContextMenu(menu); 9216 ListenerInfo li = mListenerInfo; 9217 if (li != null && li.mOnCreateContextMenuListener != null) { 9218 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 9219 } 9220 9221 // Clear the extra information so subsequent items that aren't mine don't 9222 // have my extra info. 9223 ((MenuBuilder)menu).setCurrentMenuInfo(null); 9224 9225 if (mParent != null) { 9226 mParent.createContextMenu(menu); 9227 } 9228 } 9229 9230 /** 9231 * Views should implement this if they have extra information to associate 9232 * with the context menu. The return result is supplied as a parameter to 9233 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 9234 * callback. 9235 * 9236 * @return Extra information about the item for which the context menu 9237 * should be shown. This information will vary across different 9238 * subclasses of View. 9239 */ 9240 protected ContextMenuInfo getContextMenuInfo() { 9241 return null; 9242 } 9243 9244 /** 9245 * Views should implement this if the view itself is going to add items to 9246 * the context menu. 9247 * 9248 * @param menu the context menu to populate 9249 */ 9250 protected void onCreateContextMenu(ContextMenu menu) { 9251 } 9252 9253 /** 9254 * Implement this method to handle trackball motion events. The 9255 * <em>relative</em> movement of the trackball since the last event 9256 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 9257 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 9258 * that a movement of 1 corresponds to the user pressing one DPAD key (so 9259 * they will often be fractional values, representing the more fine-grained 9260 * movement information available from a trackball). 9261 * 9262 * @param event The motion event. 9263 * @return True if the event was handled, false otherwise. 9264 */ 9265 public boolean onTrackballEvent(MotionEvent event) { 9266 return false; 9267 } 9268 9269 /** 9270 * Implement this method to handle generic motion events. 9271 * <p> 9272 * Generic motion events describe joystick movements, mouse hovers, track pad 9273 * touches, scroll wheel movements and other input events. The 9274 * {@link MotionEvent#getSource() source} of the motion event specifies 9275 * the class of input that was received. Implementations of this method 9276 * must examine the bits in the source before processing the event. 9277 * The following code example shows how this is done. 9278 * </p><p> 9279 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 9280 * are delivered to the view under the pointer. All other generic motion events are 9281 * delivered to the focused view. 9282 * </p> 9283 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 9284 * if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) { 9285 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 9286 * // process the joystick movement... 9287 * return true; 9288 * } 9289 * } 9290 * if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) { 9291 * switch (event.getAction()) { 9292 * case MotionEvent.ACTION_HOVER_MOVE: 9293 * // process the mouse hover movement... 9294 * return true; 9295 * case MotionEvent.ACTION_SCROLL: 9296 * // process the scroll wheel movement... 9297 * return true; 9298 * } 9299 * } 9300 * return super.onGenericMotionEvent(event); 9301 * }</pre> 9302 * 9303 * @param event The generic motion event being processed. 9304 * @return True if the event was handled, false otherwise. 9305 */ 9306 public boolean onGenericMotionEvent(MotionEvent event) { 9307 return false; 9308 } 9309 9310 /** 9311 * Implement this method to handle hover events. 9312 * <p> 9313 * This method is called whenever a pointer is hovering into, over, or out of the 9314 * bounds of a view and the view is not currently being touched. 9315 * Hover events are represented as pointer events with action 9316 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 9317 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 9318 * </p> 9319 * <ul> 9320 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 9321 * when the pointer enters the bounds of the view.</li> 9322 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 9323 * when the pointer has already entered the bounds of the view and has moved.</li> 9324 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 9325 * when the pointer has exited the bounds of the view or when the pointer is 9326 * about to go down due to a button click, tap, or similar user action that 9327 * causes the view to be touched.</li> 9328 * </ul> 9329 * <p> 9330 * The view should implement this method to return true to indicate that it is 9331 * handling the hover event, such as by changing its drawable state. 9332 * </p><p> 9333 * The default implementation calls {@link #setHovered} to update the hovered state 9334 * of the view when a hover enter or hover exit event is received, if the view 9335 * is enabled and is clickable. The default implementation also sends hover 9336 * accessibility events. 9337 * </p> 9338 * 9339 * @param event The motion event that describes the hover. 9340 * @return True if the view handled the hover event. 9341 * 9342 * @see #isHovered 9343 * @see #setHovered 9344 * @see #onHoverChanged 9345 */ 9346 public boolean onHoverEvent(MotionEvent event) { 9347 // The root view may receive hover (or touch) events that are outside the bounds of 9348 // the window. This code ensures that we only send accessibility events for 9349 // hovers that are actually within the bounds of the root view. 9350 final int action = event.getActionMasked(); 9351 if (!mSendingHoverAccessibilityEvents) { 9352 if ((action == MotionEvent.ACTION_HOVER_ENTER 9353 || action == MotionEvent.ACTION_HOVER_MOVE) 9354 && !hasHoveredChild() 9355 && pointInView(event.getX(), event.getY())) { 9356 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 9357 mSendingHoverAccessibilityEvents = true; 9358 } 9359 } else { 9360 if (action == MotionEvent.ACTION_HOVER_EXIT 9361 || (action == MotionEvent.ACTION_MOVE 9362 && !pointInView(event.getX(), event.getY()))) { 9363 mSendingHoverAccessibilityEvents = false; 9364 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 9365 } 9366 } 9367 9368 if (isHoverable()) { 9369 switch (action) { 9370 case MotionEvent.ACTION_HOVER_ENTER: 9371 setHovered(true); 9372 break; 9373 case MotionEvent.ACTION_HOVER_EXIT: 9374 setHovered(false); 9375 break; 9376 } 9377 9378 // Dispatch the event to onGenericMotionEvent before returning true. 9379 // This is to provide compatibility with existing applications that 9380 // handled HOVER_MOVE events in onGenericMotionEvent and that would 9381 // break because of the new default handling for hoverable views 9382 // in onHoverEvent. 9383 // Note that onGenericMotionEvent will be called by default when 9384 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 9385 dispatchGenericMotionEventInternal(event); 9386 // The event was already handled by calling setHovered(), so always 9387 // return true. 9388 return true; 9389 } 9390 9391 return false; 9392 } 9393 9394 /** 9395 * Returns true if the view should handle {@link #onHoverEvent} 9396 * by calling {@link #setHovered} to change its hovered state. 9397 * 9398 * @return True if the view is hoverable. 9399 */ 9400 private boolean isHoverable() { 9401 final int viewFlags = mViewFlags; 9402 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9403 return false; 9404 } 9405 9406 return (viewFlags & CLICKABLE) == CLICKABLE 9407 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 9408 } 9409 9410 /** 9411 * Returns true if the view is currently hovered. 9412 * 9413 * @return True if the view is currently hovered. 9414 * 9415 * @see #setHovered 9416 * @see #onHoverChanged 9417 */ 9418 @ViewDebug.ExportedProperty 9419 public boolean isHovered() { 9420 return (mPrivateFlags & PFLAG_HOVERED) != 0; 9421 } 9422 9423 /** 9424 * Sets whether the view is currently hovered. 9425 * <p> 9426 * Calling this method also changes the drawable state of the view. This 9427 * enables the view to react to hover by using different drawable resources 9428 * to change its appearance. 9429 * </p><p> 9430 * The {@link #onHoverChanged} method is called when the hovered state changes. 9431 * </p> 9432 * 9433 * @param hovered True if the view is hovered. 9434 * 9435 * @see #isHovered 9436 * @see #onHoverChanged 9437 */ 9438 public void setHovered(boolean hovered) { 9439 if (hovered) { 9440 if ((mPrivateFlags & PFLAG_HOVERED) == 0) { 9441 mPrivateFlags |= PFLAG_HOVERED; 9442 refreshDrawableState(); 9443 onHoverChanged(true); 9444 } 9445 } else { 9446 if ((mPrivateFlags & PFLAG_HOVERED) != 0) { 9447 mPrivateFlags &= ~PFLAG_HOVERED; 9448 refreshDrawableState(); 9449 onHoverChanged(false); 9450 } 9451 } 9452 } 9453 9454 /** 9455 * Implement this method to handle hover state changes. 9456 * <p> 9457 * This method is called whenever the hover state changes as a result of a 9458 * call to {@link #setHovered}. 9459 * </p> 9460 * 9461 * @param hovered The current hover state, as returned by {@link #isHovered}. 9462 * 9463 * @see #isHovered 9464 * @see #setHovered 9465 */ 9466 public void onHoverChanged(boolean hovered) { 9467 } 9468 9469 /** 9470 * Implement this method to handle touch screen motion events. 9471 * <p> 9472 * If this method is used to detect click actions, it is recommended that 9473 * the actions be performed by implementing and calling 9474 * {@link #performClick()}. This will ensure consistent system behavior, 9475 * including: 9476 * <ul> 9477 * <li>obeying click sound preferences 9478 * <li>dispatching OnClickListener calls 9479 * <li>handling {@link AccessibilityNodeInfo#ACTION_CLICK ACTION_CLICK} when 9480 * accessibility features are enabled 9481 * </ul> 9482 * 9483 * @param event The motion event. 9484 * @return True if the event was handled, false otherwise. 9485 */ 9486 public boolean onTouchEvent(MotionEvent event) { 9487 final float x = event.getX(); 9488 final float y = event.getY(); 9489 final int viewFlags = mViewFlags; 9490 9491 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9492 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) { 9493 setPressed(false); 9494 } 9495 // A disabled view that is clickable still consumes the touch 9496 // events, it just doesn't respond to them. 9497 return (((viewFlags & CLICKABLE) == CLICKABLE || 9498 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 9499 } 9500 9501 if (mTouchDelegate != null) { 9502 if (mTouchDelegate.onTouchEvent(event)) { 9503 return true; 9504 } 9505 } 9506 9507 if (((viewFlags & CLICKABLE) == CLICKABLE || 9508 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 9509 switch (event.getAction()) { 9510 case MotionEvent.ACTION_UP: 9511 boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0; 9512 if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) { 9513 // take focus if we don't have it already and we should in 9514 // touch mode. 9515 boolean focusTaken = false; 9516 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 9517 focusTaken = requestFocus(); 9518 } 9519 9520 if (prepressed) { 9521 // The button is being released before we actually 9522 // showed it as pressed. Make it show the pressed 9523 // state now (before scheduling the click) to ensure 9524 // the user sees it. 9525 setPressed(true, x, y); 9526 } 9527 9528 if (!mHasPerformedLongPress) { 9529 // This is a tap, so remove the longpress check 9530 removeLongPressCallback(); 9531 9532 // Only perform take click actions if we were in the pressed state 9533 if (!focusTaken) { 9534 // Use a Runnable and post this rather than calling 9535 // performClick directly. This lets other visual state 9536 // of the view update before click actions start. 9537 if (mPerformClick == null) { 9538 mPerformClick = new PerformClick(); 9539 } 9540 if (!post(mPerformClick)) { 9541 performClick(); 9542 } 9543 } 9544 } 9545 9546 if (mUnsetPressedState == null) { 9547 mUnsetPressedState = new UnsetPressedState(); 9548 } 9549 9550 if (prepressed) { 9551 postDelayed(mUnsetPressedState, 9552 ViewConfiguration.getPressedStateDuration()); 9553 } else if (!post(mUnsetPressedState)) { 9554 // If the post failed, unpress right now 9555 mUnsetPressedState.run(); 9556 } 9557 9558 removeTapCallback(); 9559 } 9560 break; 9561 9562 case MotionEvent.ACTION_DOWN: 9563 mHasPerformedLongPress = false; 9564 9565 if (performButtonActionOnTouchDown(event)) { 9566 break; 9567 } 9568 9569 // Walk up the hierarchy to determine if we're inside a scrolling container. 9570 boolean isInScrollingContainer = isInScrollingContainer(); 9571 9572 // For views inside a scrolling container, delay the pressed feedback for 9573 // a short period in case this is a scroll. 9574 if (isInScrollingContainer) { 9575 mPrivateFlags |= PFLAG_PREPRESSED; 9576 if (mPendingCheckForTap == null) { 9577 mPendingCheckForTap = new CheckForTap(); 9578 } 9579 mPendingCheckForTap.x = event.getX(); 9580 mPendingCheckForTap.y = event.getY(); 9581 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 9582 } else { 9583 // Not inside a scrolling container, so show the feedback right away 9584 setPressed(true, x, y); 9585 checkForLongClick(0); 9586 } 9587 break; 9588 9589 case MotionEvent.ACTION_CANCEL: 9590 setPressed(false); 9591 removeTapCallback(); 9592 removeLongPressCallback(); 9593 break; 9594 9595 case MotionEvent.ACTION_MOVE: 9596 drawableHotspotChanged(x, y); 9597 9598 // Be lenient about moving outside of buttons 9599 if (!pointInView(x, y, mTouchSlop)) { 9600 // Outside button 9601 removeTapCallback(); 9602 if ((mPrivateFlags & PFLAG_PRESSED) != 0) { 9603 // Remove any future long press/tap checks 9604 removeLongPressCallback(); 9605 9606 setPressed(false); 9607 } 9608 } 9609 break; 9610 } 9611 9612 return true; 9613 } 9614 9615 return false; 9616 } 9617 9618 /** 9619 * @hide 9620 */ 9621 public boolean isInScrollingContainer() { 9622 ViewParent p = getParent(); 9623 while (p != null && p instanceof ViewGroup) { 9624 if (((ViewGroup) p).shouldDelayChildPressedState()) { 9625 return true; 9626 } 9627 p = p.getParent(); 9628 } 9629 return false; 9630 } 9631 9632 /** 9633 * Remove the longpress detection timer. 9634 */ 9635 private void removeLongPressCallback() { 9636 if (mPendingCheckForLongPress != null) { 9637 removeCallbacks(mPendingCheckForLongPress); 9638 } 9639 } 9640 9641 /** 9642 * Remove the pending click action 9643 */ 9644 private void removePerformClickCallback() { 9645 if (mPerformClick != null) { 9646 removeCallbacks(mPerformClick); 9647 } 9648 } 9649 9650 /** 9651 * Remove the prepress detection timer. 9652 */ 9653 private void removeUnsetPressCallback() { 9654 if ((mPrivateFlags & PFLAG_PRESSED) != 0 && mUnsetPressedState != null) { 9655 setPressed(false); 9656 removeCallbacks(mUnsetPressedState); 9657 } 9658 } 9659 9660 /** 9661 * Remove the tap detection timer. 9662 */ 9663 private void removeTapCallback() { 9664 if (mPendingCheckForTap != null) { 9665 mPrivateFlags &= ~PFLAG_PREPRESSED; 9666 removeCallbacks(mPendingCheckForTap); 9667 } 9668 } 9669 9670 /** 9671 * Cancels a pending long press. Your subclass can use this if you 9672 * want the context menu to come up if the user presses and holds 9673 * at the same place, but you don't want it to come up if they press 9674 * and then move around enough to cause scrolling. 9675 */ 9676 public void cancelLongPress() { 9677 removeLongPressCallback(); 9678 9679 /* 9680 * The prepressed state handled by the tap callback is a display 9681 * construct, but the tap callback will post a long press callback 9682 * less its own timeout. Remove it here. 9683 */ 9684 removeTapCallback(); 9685 } 9686 9687 /** 9688 * Remove the pending callback for sending a 9689 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 9690 */ 9691 private void removeSendViewScrolledAccessibilityEventCallback() { 9692 if (mSendViewScrolledAccessibilityEvent != null) { 9693 removeCallbacks(mSendViewScrolledAccessibilityEvent); 9694 mSendViewScrolledAccessibilityEvent.mIsPending = false; 9695 } 9696 } 9697 9698 /** 9699 * Sets the TouchDelegate for this View. 9700 */ 9701 public void setTouchDelegate(TouchDelegate delegate) { 9702 mTouchDelegate = delegate; 9703 } 9704 9705 /** 9706 * Gets the TouchDelegate for this View. 9707 */ 9708 public TouchDelegate getTouchDelegate() { 9709 return mTouchDelegate; 9710 } 9711 9712 /** 9713 * Request unbuffered dispatch of the given stream of MotionEvents to this View. 9714 * 9715 * Until this View receives a corresponding {@link MotionEvent#ACTION_UP}, ask that the input 9716 * system not batch {@link MotionEvent}s but instead deliver them as soon as they're 9717 * available. This method should only be called for touch events. 9718 * 9719 * <p class="note">This api is not intended for most applications. Buffered dispatch 9720 * provides many of benefits, and just requesting unbuffered dispatch on most MotionEvent 9721 * streams will not improve your input latency. Side effects include: increased latency, 9722 * jittery scrolls and inability to take advantage of system resampling. Talk to your input 9723 * professional to see if {@link #requestUnbufferedDispatch(MotionEvent)} is right for 9724 * you.</p> 9725 */ 9726 public final void requestUnbufferedDispatch(MotionEvent event) { 9727 final int action = event.getAction(); 9728 if (mAttachInfo == null 9729 || action != MotionEvent.ACTION_DOWN && action != MotionEvent.ACTION_MOVE 9730 || !event.isTouchEvent()) { 9731 return; 9732 } 9733 mAttachInfo.mUnbufferedDispatchRequested = true; 9734 } 9735 9736 /** 9737 * Set flags controlling behavior of this view. 9738 * 9739 * @param flags Constant indicating the value which should be set 9740 * @param mask Constant indicating the bit range that should be changed 9741 */ 9742 void setFlags(int flags, int mask) { 9743 final boolean accessibilityEnabled = 9744 AccessibilityManager.getInstance(mContext).isEnabled(); 9745 final boolean oldIncludeForAccessibility = accessibilityEnabled && includeForAccessibility(); 9746 9747 int old = mViewFlags; 9748 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 9749 9750 int changed = mViewFlags ^ old; 9751 if (changed == 0) { 9752 return; 9753 } 9754 int privateFlags = mPrivateFlags; 9755 9756 /* Check if the FOCUSABLE bit has changed */ 9757 if (((changed & FOCUSABLE_MASK) != 0) && 9758 ((privateFlags & PFLAG_HAS_BOUNDS) !=0)) { 9759 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 9760 && ((privateFlags & PFLAG_FOCUSED) != 0)) { 9761 /* Give up focus if we are no longer focusable */ 9762 clearFocus(); 9763 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 9764 && ((privateFlags & PFLAG_FOCUSED) == 0)) { 9765 /* 9766 * Tell the view system that we are now available to take focus 9767 * if no one else already has it. 9768 */ 9769 if (mParent != null) mParent.focusableViewAvailable(this); 9770 } 9771 } 9772 9773 final int newVisibility = flags & VISIBILITY_MASK; 9774 if (newVisibility == VISIBLE) { 9775 if ((changed & VISIBILITY_MASK) != 0) { 9776 /* 9777 * If this view is becoming visible, invalidate it in case it changed while 9778 * it was not visible. Marking it drawn ensures that the invalidation will 9779 * go through. 9780 */ 9781 mPrivateFlags |= PFLAG_DRAWN; 9782 invalidate(true); 9783 9784 needGlobalAttributesUpdate(true); 9785 9786 // a view becoming visible is worth notifying the parent 9787 // about in case nothing has focus. even if this specific view 9788 // isn't focusable, it may contain something that is, so let 9789 // the root view try to give this focus if nothing else does. 9790 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 9791 mParent.focusableViewAvailable(this); 9792 } 9793 } 9794 } 9795 9796 /* Check if the GONE bit has changed */ 9797 if ((changed & GONE) != 0) { 9798 needGlobalAttributesUpdate(false); 9799 requestLayout(); 9800 9801 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 9802 if (hasFocus()) clearFocus(); 9803 clearAccessibilityFocus(); 9804 destroyDrawingCache(); 9805 if (mParent instanceof View) { 9806 // GONE views noop invalidation, so invalidate the parent 9807 ((View) mParent).invalidate(true); 9808 } 9809 // Mark the view drawn to ensure that it gets invalidated properly the next 9810 // time it is visible and gets invalidated 9811 mPrivateFlags |= PFLAG_DRAWN; 9812 } 9813 if (mAttachInfo != null) { 9814 mAttachInfo.mViewVisibilityChanged = true; 9815 } 9816 } 9817 9818 /* Check if the VISIBLE bit has changed */ 9819 if ((changed & INVISIBLE) != 0) { 9820 needGlobalAttributesUpdate(false); 9821 /* 9822 * If this view is becoming invisible, set the DRAWN flag so that 9823 * the next invalidate() will not be skipped. 9824 */ 9825 mPrivateFlags |= PFLAG_DRAWN; 9826 9827 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE)) { 9828 // root view becoming invisible shouldn't clear focus and accessibility focus 9829 if (getRootView() != this) { 9830 if (hasFocus()) clearFocus(); 9831 clearAccessibilityFocus(); 9832 } 9833 } 9834 if (mAttachInfo != null) { 9835 mAttachInfo.mViewVisibilityChanged = true; 9836 } 9837 } 9838 9839 if ((changed & VISIBILITY_MASK) != 0) { 9840 // If the view is invisible, cleanup its display list to free up resources 9841 if (newVisibility != VISIBLE && mAttachInfo != null) { 9842 cleanupDraw(); 9843 } 9844 9845 if (mParent instanceof ViewGroup) { 9846 ((ViewGroup) mParent).onChildVisibilityChanged(this, 9847 (changed & VISIBILITY_MASK), newVisibility); 9848 ((View) mParent).invalidate(true); 9849 } else if (mParent != null) { 9850 mParent.invalidateChild(this, null); 9851 } 9852 dispatchVisibilityChanged(this, newVisibility); 9853 9854 notifySubtreeAccessibilityStateChangedIfNeeded(); 9855 } 9856 9857 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 9858 destroyDrawingCache(); 9859 } 9860 9861 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 9862 destroyDrawingCache(); 9863 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9864 invalidateParentCaches(); 9865 } 9866 9867 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 9868 destroyDrawingCache(); 9869 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9870 } 9871 9872 if ((changed & DRAW_MASK) != 0) { 9873 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 9874 if (mBackground != null) { 9875 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9876 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 9877 } else { 9878 mPrivateFlags |= PFLAG_SKIP_DRAW; 9879 } 9880 } else { 9881 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9882 } 9883 requestLayout(); 9884 invalidate(true); 9885 } 9886 9887 if ((changed & KEEP_SCREEN_ON) != 0) { 9888 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 9889 mParent.recomputeViewAttributes(this); 9890 } 9891 } 9892 9893 if (accessibilityEnabled) { 9894 if ((changed & FOCUSABLE_MASK) != 0 || (changed & VISIBILITY_MASK) != 0 9895 || (changed & CLICKABLE) != 0 || (changed & LONG_CLICKABLE) != 0) { 9896 if (oldIncludeForAccessibility != includeForAccessibility()) { 9897 notifySubtreeAccessibilityStateChangedIfNeeded(); 9898 } else { 9899 notifyViewAccessibilityStateChangedIfNeeded( 9900 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9901 } 9902 } else if ((changed & ENABLED_MASK) != 0) { 9903 notifyViewAccessibilityStateChangedIfNeeded( 9904 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9905 } 9906 } 9907 } 9908 9909 /** 9910 * Change the view's z order in the tree, so it's on top of other sibling 9911 * views. This ordering change may affect layout, if the parent container 9912 * uses an order-dependent layout scheme (e.g., LinearLayout). Prior 9913 * to {@link android.os.Build.VERSION_CODES#KITKAT} this 9914 * method should be followed by calls to {@link #requestLayout()} and 9915 * {@link View#invalidate()} on the view's parent to force the parent to redraw 9916 * with the new child ordering. 9917 * 9918 * @see ViewGroup#bringChildToFront(View) 9919 */ 9920 public void bringToFront() { 9921 if (mParent != null) { 9922 mParent.bringChildToFront(this); 9923 } 9924 } 9925 9926 /** 9927 * This is called in response to an internal scroll in this view (i.e., the 9928 * view scrolled its own contents). This is typically as a result of 9929 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 9930 * called. 9931 * 9932 * @param l Current horizontal scroll origin. 9933 * @param t Current vertical scroll origin. 9934 * @param oldl Previous horizontal scroll origin. 9935 * @param oldt Previous vertical scroll origin. 9936 */ 9937 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 9938 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 9939 postSendViewScrolledAccessibilityEventCallback(); 9940 } 9941 9942 mBackgroundSizeChanged = true; 9943 9944 final AttachInfo ai = mAttachInfo; 9945 if (ai != null) { 9946 ai.mViewScrollChanged = true; 9947 } 9948 9949 if (mListenerInfo != null && mListenerInfo.mOnScrollChangeListener != null) { 9950 mListenerInfo.mOnScrollChangeListener.onScrollChange(this, l, t, oldl, oldt); 9951 } 9952 } 9953 9954 /** 9955 * Interface definition for a callback to be invoked when the scroll 9956 * position of a view changes. 9957 * 9958 * @hide Only used internally. 9959 */ 9960 public interface OnScrollChangeListener { 9961 /** 9962 * Called when the scroll position of a view changes. 9963 * 9964 * @param v The view whose scroll position has changed. 9965 * @param scrollX Current horizontal scroll origin. 9966 * @param scrollY Current vertical scroll origin. 9967 * @param oldScrollX Previous horizontal scroll origin. 9968 * @param oldScrollY Previous vertical scroll origin. 9969 */ 9970 void onScrollChange(View v, int scrollX, int scrollY, int oldScrollX, int oldScrollY); 9971 } 9972 9973 /** 9974 * Interface definition for a callback to be invoked when the layout bounds of a view 9975 * changes due to layout processing. 9976 */ 9977 public interface OnLayoutChangeListener { 9978 /** 9979 * Called when the layout bounds of a view changes due to layout processing. 9980 * 9981 * @param v The view whose bounds have changed. 9982 * @param left The new value of the view's left property. 9983 * @param top The new value of the view's top property. 9984 * @param right The new value of the view's right property. 9985 * @param bottom The new value of the view's bottom property. 9986 * @param oldLeft The previous value of the view's left property. 9987 * @param oldTop The previous value of the view's top property. 9988 * @param oldRight The previous value of the view's right property. 9989 * @param oldBottom The previous value of the view's bottom property. 9990 */ 9991 void onLayoutChange(View v, int left, int top, int right, int bottom, 9992 int oldLeft, int oldTop, int oldRight, int oldBottom); 9993 } 9994 9995 /** 9996 * This is called during layout when the size of this view has changed. If 9997 * you were just added to the view hierarchy, you're called with the old 9998 * values of 0. 9999 * 10000 * @param w Current width of this view. 10001 * @param h Current height of this view. 10002 * @param oldw Old width of this view. 10003 * @param oldh Old height of this view. 10004 */ 10005 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 10006 } 10007 10008 /** 10009 * Called by draw to draw the child views. This may be overridden 10010 * by derived classes to gain control just before its children are drawn 10011 * (but after its own view has been drawn). 10012 * @param canvas the canvas on which to draw the view 10013 */ 10014 protected void dispatchDraw(Canvas canvas) { 10015 10016 } 10017 10018 /** 10019 * Gets the parent of this view. Note that the parent is a 10020 * ViewParent and not necessarily a View. 10021 * 10022 * @return Parent of this view. 10023 */ 10024 public final ViewParent getParent() { 10025 return mParent; 10026 } 10027 10028 /** 10029 * Set the horizontal scrolled position of your view. This will cause a call to 10030 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10031 * invalidated. 10032 * @param value the x position to scroll to 10033 */ 10034 public void setScrollX(int value) { 10035 scrollTo(value, mScrollY); 10036 } 10037 10038 /** 10039 * Set the vertical scrolled position of your view. This will cause a call to 10040 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10041 * invalidated. 10042 * @param value the y position to scroll to 10043 */ 10044 public void setScrollY(int value) { 10045 scrollTo(mScrollX, value); 10046 } 10047 10048 /** 10049 * Return the scrolled left position of this view. This is the left edge of 10050 * the displayed part of your view. You do not need to draw any pixels 10051 * farther left, since those are outside of the frame of your view on 10052 * screen. 10053 * 10054 * @return The left edge of the displayed part of your view, in pixels. 10055 */ 10056 public final int getScrollX() { 10057 return mScrollX; 10058 } 10059 10060 /** 10061 * Return the scrolled top position of this view. This is the top edge of 10062 * the displayed part of your view. You do not need to draw any pixels above 10063 * it, since those are outside of the frame of your view on screen. 10064 * 10065 * @return The top edge of the displayed part of your view, in pixels. 10066 */ 10067 public final int getScrollY() { 10068 return mScrollY; 10069 } 10070 10071 /** 10072 * Return the width of the your view. 10073 * 10074 * @return The width of your view, in pixels. 10075 */ 10076 @ViewDebug.ExportedProperty(category = "layout") 10077 public final int getWidth() { 10078 return mRight - mLeft; 10079 } 10080 10081 /** 10082 * Return the height of your view. 10083 * 10084 * @return The height of your view, in pixels. 10085 */ 10086 @ViewDebug.ExportedProperty(category = "layout") 10087 public final int getHeight() { 10088 return mBottom - mTop; 10089 } 10090 10091 /** 10092 * Return the visible drawing bounds of your view. Fills in the output 10093 * rectangle with the values from getScrollX(), getScrollY(), 10094 * getWidth(), and getHeight(). These bounds do not account for any 10095 * transformation properties currently set on the view, such as 10096 * {@link #setScaleX(float)} or {@link #setRotation(float)}. 10097 * 10098 * @param outRect The (scrolled) drawing bounds of the view. 10099 */ 10100 public void getDrawingRect(Rect outRect) { 10101 outRect.left = mScrollX; 10102 outRect.top = mScrollY; 10103 outRect.right = mScrollX + (mRight - mLeft); 10104 outRect.bottom = mScrollY + (mBottom - mTop); 10105 } 10106 10107 /** 10108 * Like {@link #getMeasuredWidthAndState()}, but only returns the 10109 * raw width component (that is the result is masked by 10110 * {@link #MEASURED_SIZE_MASK}). 10111 * 10112 * @return The raw measured width of this view. 10113 */ 10114 public final int getMeasuredWidth() { 10115 return mMeasuredWidth & MEASURED_SIZE_MASK; 10116 } 10117 10118 /** 10119 * Return the full width measurement information for this view as computed 10120 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10121 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10122 * This should be used during measurement and layout calculations only. Use 10123 * {@link #getWidth()} to see how wide a view is after layout. 10124 * 10125 * @return The measured width of this view as a bit mask. 10126 */ 10127 public final int getMeasuredWidthAndState() { 10128 return mMeasuredWidth; 10129 } 10130 10131 /** 10132 * Like {@link #getMeasuredHeightAndState()}, but only returns the 10133 * raw width component (that is the result is masked by 10134 * {@link #MEASURED_SIZE_MASK}). 10135 * 10136 * @return The raw measured height of this view. 10137 */ 10138 public final int getMeasuredHeight() { 10139 return mMeasuredHeight & MEASURED_SIZE_MASK; 10140 } 10141 10142 /** 10143 * Return the full height measurement information for this view as computed 10144 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10145 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10146 * This should be used during measurement and layout calculations only. Use 10147 * {@link #getHeight()} to see how wide a view is after layout. 10148 * 10149 * @return The measured width of this view as a bit mask. 10150 */ 10151 public final int getMeasuredHeightAndState() { 10152 return mMeasuredHeight; 10153 } 10154 10155 /** 10156 * Return only the state bits of {@link #getMeasuredWidthAndState()} 10157 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 10158 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 10159 * and the height component is at the shifted bits 10160 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 10161 */ 10162 public final int getMeasuredState() { 10163 return (mMeasuredWidth&MEASURED_STATE_MASK) 10164 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 10165 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 10166 } 10167 10168 /** 10169 * The transform matrix of this view, which is calculated based on the current 10170 * rotation, scale, and pivot properties. 10171 * 10172 * @see #getRotation() 10173 * @see #getScaleX() 10174 * @see #getScaleY() 10175 * @see #getPivotX() 10176 * @see #getPivotY() 10177 * @return The current transform matrix for the view 10178 */ 10179 public Matrix getMatrix() { 10180 ensureTransformationInfo(); 10181 final Matrix matrix = mTransformationInfo.mMatrix; 10182 mRenderNode.getMatrix(matrix); 10183 return matrix; 10184 } 10185 10186 /** 10187 * Returns true if the transform matrix is the identity matrix. 10188 * Recomputes the matrix if necessary. 10189 * 10190 * @return True if the transform matrix is the identity matrix, false otherwise. 10191 */ 10192 final boolean hasIdentityMatrix() { 10193 return mRenderNode.hasIdentityMatrix(); 10194 } 10195 10196 void ensureTransformationInfo() { 10197 if (mTransformationInfo == null) { 10198 mTransformationInfo = new TransformationInfo(); 10199 } 10200 } 10201 10202 /** 10203 * Utility method to retrieve the inverse of the current mMatrix property. 10204 * We cache the matrix to avoid recalculating it when transform properties 10205 * have not changed. 10206 * 10207 * @return The inverse of the current matrix of this view. 10208 * @hide 10209 */ 10210 public final Matrix getInverseMatrix() { 10211 ensureTransformationInfo(); 10212 if (mTransformationInfo.mInverseMatrix == null) { 10213 mTransformationInfo.mInverseMatrix = new Matrix(); 10214 } 10215 final Matrix matrix = mTransformationInfo.mInverseMatrix; 10216 mRenderNode.getInverseMatrix(matrix); 10217 return matrix; 10218 } 10219 10220 /** 10221 * Gets the distance along the Z axis from the camera to this view. 10222 * 10223 * @see #setCameraDistance(float) 10224 * 10225 * @return The distance along the Z axis. 10226 */ 10227 public float getCameraDistance() { 10228 final float dpi = mResources.getDisplayMetrics().densityDpi; 10229 return -(mRenderNode.getCameraDistance() * dpi); 10230 } 10231 10232 /** 10233 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 10234 * views are drawn) from the camera to this view. The camera's distance 10235 * affects 3D transformations, for instance rotations around the X and Y 10236 * axis. If the rotationX or rotationY properties are changed and this view is 10237 * large (more than half the size of the screen), it is recommended to always 10238 * use a camera distance that's greater than the height (X axis rotation) or 10239 * the width (Y axis rotation) of this view.</p> 10240 * 10241 * <p>The distance of the camera from the view plane can have an affect on the 10242 * perspective distortion of the view when it is rotated around the x or y axis. 10243 * For example, a large distance will result in a large viewing angle, and there 10244 * will not be much perspective distortion of the view as it rotates. A short 10245 * distance may cause much more perspective distortion upon rotation, and can 10246 * also result in some drawing artifacts if the rotated view ends up partially 10247 * behind the camera (which is why the recommendation is to use a distance at 10248 * least as far as the size of the view, if the view is to be rotated.)</p> 10249 * 10250 * <p>The distance is expressed in "depth pixels." The default distance depends 10251 * on the screen density. For instance, on a medium density display, the 10252 * default distance is 1280. On a high density display, the default distance 10253 * is 1920.</p> 10254 * 10255 * <p>If you want to specify a distance that leads to visually consistent 10256 * results across various densities, use the following formula:</p> 10257 * <pre> 10258 * float scale = context.getResources().getDisplayMetrics().density; 10259 * view.setCameraDistance(distance * scale); 10260 * </pre> 10261 * 10262 * <p>The density scale factor of a high density display is 1.5, 10263 * and 1920 = 1280 * 1.5.</p> 10264 * 10265 * @param distance The distance in "depth pixels", if negative the opposite 10266 * value is used 10267 * 10268 * @see #setRotationX(float) 10269 * @see #setRotationY(float) 10270 */ 10271 public void setCameraDistance(float distance) { 10272 final float dpi = mResources.getDisplayMetrics().densityDpi; 10273 10274 invalidateViewProperty(true, false); 10275 mRenderNode.setCameraDistance(-Math.abs(distance) / dpi); 10276 invalidateViewProperty(false, false); 10277 10278 invalidateParentIfNeededAndWasQuickRejected(); 10279 } 10280 10281 /** 10282 * The degrees that the view is rotated around the pivot point. 10283 * 10284 * @see #setRotation(float) 10285 * @see #getPivotX() 10286 * @see #getPivotY() 10287 * 10288 * @return The degrees of rotation. 10289 */ 10290 @ViewDebug.ExportedProperty(category = "drawing") 10291 public float getRotation() { 10292 return mRenderNode.getRotation(); 10293 } 10294 10295 /** 10296 * Sets the degrees that the view is rotated around the pivot point. Increasing values 10297 * result in clockwise rotation. 10298 * 10299 * @param rotation The degrees of rotation. 10300 * 10301 * @see #getRotation() 10302 * @see #getPivotX() 10303 * @see #getPivotY() 10304 * @see #setRotationX(float) 10305 * @see #setRotationY(float) 10306 * 10307 * @attr ref android.R.styleable#View_rotation 10308 */ 10309 public void setRotation(float rotation) { 10310 if (rotation != getRotation()) { 10311 // Double-invalidation is necessary to capture view's old and new areas 10312 invalidateViewProperty(true, false); 10313 mRenderNode.setRotation(rotation); 10314 invalidateViewProperty(false, true); 10315 10316 invalidateParentIfNeededAndWasQuickRejected(); 10317 notifySubtreeAccessibilityStateChangedIfNeeded(); 10318 } 10319 } 10320 10321 /** 10322 * The degrees that the view is rotated around the vertical axis through the pivot point. 10323 * 10324 * @see #getPivotX() 10325 * @see #getPivotY() 10326 * @see #setRotationY(float) 10327 * 10328 * @return The degrees of Y rotation. 10329 */ 10330 @ViewDebug.ExportedProperty(category = "drawing") 10331 public float getRotationY() { 10332 return mRenderNode.getRotationY(); 10333 } 10334 10335 /** 10336 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 10337 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 10338 * down the y axis. 10339 * 10340 * When rotating large views, it is recommended to adjust the camera distance 10341 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10342 * 10343 * @param rotationY The degrees of Y rotation. 10344 * 10345 * @see #getRotationY() 10346 * @see #getPivotX() 10347 * @see #getPivotY() 10348 * @see #setRotation(float) 10349 * @see #setRotationX(float) 10350 * @see #setCameraDistance(float) 10351 * 10352 * @attr ref android.R.styleable#View_rotationY 10353 */ 10354 public void setRotationY(float rotationY) { 10355 if (rotationY != getRotationY()) { 10356 invalidateViewProperty(true, false); 10357 mRenderNode.setRotationY(rotationY); 10358 invalidateViewProperty(false, true); 10359 10360 invalidateParentIfNeededAndWasQuickRejected(); 10361 notifySubtreeAccessibilityStateChangedIfNeeded(); 10362 } 10363 } 10364 10365 /** 10366 * The degrees that the view is rotated around the horizontal axis through the pivot point. 10367 * 10368 * @see #getPivotX() 10369 * @see #getPivotY() 10370 * @see #setRotationX(float) 10371 * 10372 * @return The degrees of X rotation. 10373 */ 10374 @ViewDebug.ExportedProperty(category = "drawing") 10375 public float getRotationX() { 10376 return mRenderNode.getRotationX(); 10377 } 10378 10379 /** 10380 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 10381 * Increasing values result in clockwise rotation from the viewpoint of looking down the 10382 * x axis. 10383 * 10384 * When rotating large views, it is recommended to adjust the camera distance 10385 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10386 * 10387 * @param rotationX The degrees of X rotation. 10388 * 10389 * @see #getRotationX() 10390 * @see #getPivotX() 10391 * @see #getPivotY() 10392 * @see #setRotation(float) 10393 * @see #setRotationY(float) 10394 * @see #setCameraDistance(float) 10395 * 10396 * @attr ref android.R.styleable#View_rotationX 10397 */ 10398 public void setRotationX(float rotationX) { 10399 if (rotationX != getRotationX()) { 10400 invalidateViewProperty(true, false); 10401 mRenderNode.setRotationX(rotationX); 10402 invalidateViewProperty(false, true); 10403 10404 invalidateParentIfNeededAndWasQuickRejected(); 10405 notifySubtreeAccessibilityStateChangedIfNeeded(); 10406 } 10407 } 10408 10409 /** 10410 * The amount that the view is scaled in x around the pivot point, as a proportion of 10411 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 10412 * 10413 * <p>By default, this is 1.0f. 10414 * 10415 * @see #getPivotX() 10416 * @see #getPivotY() 10417 * @return The scaling factor. 10418 */ 10419 @ViewDebug.ExportedProperty(category = "drawing") 10420 public float getScaleX() { 10421 return mRenderNode.getScaleX(); 10422 } 10423 10424 /** 10425 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 10426 * the view's unscaled width. A value of 1 means that no scaling is applied. 10427 * 10428 * @param scaleX The scaling factor. 10429 * @see #getPivotX() 10430 * @see #getPivotY() 10431 * 10432 * @attr ref android.R.styleable#View_scaleX 10433 */ 10434 public void setScaleX(float scaleX) { 10435 if (scaleX != getScaleX()) { 10436 invalidateViewProperty(true, false); 10437 mRenderNode.setScaleX(scaleX); 10438 invalidateViewProperty(false, true); 10439 10440 invalidateParentIfNeededAndWasQuickRejected(); 10441 notifySubtreeAccessibilityStateChangedIfNeeded(); 10442 } 10443 } 10444 10445 /** 10446 * The amount that the view is scaled in y around the pivot point, as a proportion of 10447 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 10448 * 10449 * <p>By default, this is 1.0f. 10450 * 10451 * @see #getPivotX() 10452 * @see #getPivotY() 10453 * @return The scaling factor. 10454 */ 10455 @ViewDebug.ExportedProperty(category = "drawing") 10456 public float getScaleY() { 10457 return mRenderNode.getScaleY(); 10458 } 10459 10460 /** 10461 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 10462 * the view's unscaled width. A value of 1 means that no scaling is applied. 10463 * 10464 * @param scaleY The scaling factor. 10465 * @see #getPivotX() 10466 * @see #getPivotY() 10467 * 10468 * @attr ref android.R.styleable#View_scaleY 10469 */ 10470 public void setScaleY(float scaleY) { 10471 if (scaleY != getScaleY()) { 10472 invalidateViewProperty(true, false); 10473 mRenderNode.setScaleY(scaleY); 10474 invalidateViewProperty(false, true); 10475 10476 invalidateParentIfNeededAndWasQuickRejected(); 10477 notifySubtreeAccessibilityStateChangedIfNeeded(); 10478 } 10479 } 10480 10481 /** 10482 * The x location of the point around which the view is {@link #setRotation(float) rotated} 10483 * and {@link #setScaleX(float) scaled}. 10484 * 10485 * @see #getRotation() 10486 * @see #getScaleX() 10487 * @see #getScaleY() 10488 * @see #getPivotY() 10489 * @return The x location of the pivot point. 10490 * 10491 * @attr ref android.R.styleable#View_transformPivotX 10492 */ 10493 @ViewDebug.ExportedProperty(category = "drawing") 10494 public float getPivotX() { 10495 return mRenderNode.getPivotX(); 10496 } 10497 10498 /** 10499 * Sets the x location of the point around which the view is 10500 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 10501 * By default, the pivot point is centered on the object. 10502 * Setting this property disables this behavior and causes the view to use only the 10503 * explicitly set pivotX and pivotY values. 10504 * 10505 * @param pivotX The x location of the pivot point. 10506 * @see #getRotation() 10507 * @see #getScaleX() 10508 * @see #getScaleY() 10509 * @see #getPivotY() 10510 * 10511 * @attr ref android.R.styleable#View_transformPivotX 10512 */ 10513 public void setPivotX(float pivotX) { 10514 if (!mRenderNode.isPivotExplicitlySet() || pivotX != getPivotX()) { 10515 invalidateViewProperty(true, false); 10516 mRenderNode.setPivotX(pivotX); 10517 invalidateViewProperty(false, true); 10518 10519 invalidateParentIfNeededAndWasQuickRejected(); 10520 } 10521 } 10522 10523 /** 10524 * The y location of the point around which the view is {@link #setRotation(float) rotated} 10525 * and {@link #setScaleY(float) scaled}. 10526 * 10527 * @see #getRotation() 10528 * @see #getScaleX() 10529 * @see #getScaleY() 10530 * @see #getPivotY() 10531 * @return The y location of the pivot point. 10532 * 10533 * @attr ref android.R.styleable#View_transformPivotY 10534 */ 10535 @ViewDebug.ExportedProperty(category = "drawing") 10536 public float getPivotY() { 10537 return mRenderNode.getPivotY(); 10538 } 10539 10540 /** 10541 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 10542 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 10543 * Setting this property disables this behavior and causes the view to use only the 10544 * explicitly set pivotX and pivotY values. 10545 * 10546 * @param pivotY The y location of the pivot point. 10547 * @see #getRotation() 10548 * @see #getScaleX() 10549 * @see #getScaleY() 10550 * @see #getPivotY() 10551 * 10552 * @attr ref android.R.styleable#View_transformPivotY 10553 */ 10554 public void setPivotY(float pivotY) { 10555 if (!mRenderNode.isPivotExplicitlySet() || pivotY != getPivotY()) { 10556 invalidateViewProperty(true, false); 10557 mRenderNode.setPivotY(pivotY); 10558 invalidateViewProperty(false, true); 10559 10560 invalidateParentIfNeededAndWasQuickRejected(); 10561 } 10562 } 10563 10564 /** 10565 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 10566 * completely transparent and 1 means the view is completely opaque. 10567 * 10568 * <p>By default this is 1.0f. 10569 * @return The opacity of the view. 10570 */ 10571 @ViewDebug.ExportedProperty(category = "drawing") 10572 public float getAlpha() { 10573 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 10574 } 10575 10576 /** 10577 * Returns whether this View has content which overlaps. 10578 * 10579 * <p>This function, intended to be overridden by specific View types, is an optimization when 10580 * alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to 10581 * an offscreen buffer and then composited into place, which can be expensive. If the view has 10582 * no overlapping rendering, the view can draw each primitive with the appropriate alpha value 10583 * directly. An example of overlapping rendering is a TextView with a background image, such as 10584 * a Button. An example of non-overlapping rendering is a TextView with no background, or an 10585 * ImageView with only the foreground image. The default implementation returns true; subclasses 10586 * should override if they have cases which can be optimized.</p> 10587 * 10588 * <p>The current implementation of the saveLayer and saveLayerAlpha methods in {@link Canvas} 10589 * necessitates that a View return true if it uses the methods internally without passing the 10590 * {@link Canvas#CLIP_TO_LAYER_SAVE_FLAG}.</p> 10591 * 10592 * @return true if the content in this view might overlap, false otherwise. 10593 */ 10594 @ViewDebug.ExportedProperty(category = "drawing") 10595 public boolean hasOverlappingRendering() { 10596 return true; 10597 } 10598 10599 /** 10600 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 10601 * completely transparent and 1 means the view is completely opaque.</p> 10602 * 10603 * <p> Note that setting alpha to a translucent value (0 < alpha < 1) can have significant 10604 * performance implications, especially for large views. It is best to use the alpha property 10605 * sparingly and transiently, as in the case of fading animations.</p> 10606 * 10607 * <p>For a view with a frequently changing alpha, such as during a fading animation, it is 10608 * strongly recommended for performance reasons to either override 10609 * {@link #hasOverlappingRendering()} to return false if appropriate, or setting a 10610 * {@link #setLayerType(int, android.graphics.Paint) layer type} on the view.</p> 10611 * 10612 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 10613 * responsible for applying the opacity itself.</p> 10614 * 10615 * <p>Note that if the view is backed by a 10616 * {@link #setLayerType(int, android.graphics.Paint) layer} and is associated with a 10617 * {@link #setLayerPaint(android.graphics.Paint) layer paint}, setting an alpha value less than 10618 * 1.0 will supercede the alpha of the layer paint.</p> 10619 * 10620 * @param alpha The opacity of the view. 10621 * 10622 * @see #hasOverlappingRendering() 10623 * @see #setLayerType(int, android.graphics.Paint) 10624 * 10625 * @attr ref android.R.styleable#View_alpha 10626 */ 10627 public void setAlpha(float alpha) { 10628 ensureTransformationInfo(); 10629 if (mTransformationInfo.mAlpha != alpha) { 10630 mTransformationInfo.mAlpha = alpha; 10631 if (onSetAlpha((int) (alpha * 255))) { 10632 mPrivateFlags |= PFLAG_ALPHA_SET; 10633 // subclass is handling alpha - don't optimize rendering cache invalidation 10634 invalidateParentCaches(); 10635 invalidate(true); 10636 } else { 10637 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10638 invalidateViewProperty(true, false); 10639 mRenderNode.setAlpha(getFinalAlpha()); 10640 notifyViewAccessibilityStateChangedIfNeeded( 10641 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 10642 } 10643 } 10644 } 10645 10646 /** 10647 * Faster version of setAlpha() which performs the same steps except there are 10648 * no calls to invalidate(). The caller of this function should perform proper invalidation 10649 * on the parent and this object. The return value indicates whether the subclass handles 10650 * alpha (the return value for onSetAlpha()). 10651 * 10652 * @param alpha The new value for the alpha property 10653 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 10654 * the new value for the alpha property is different from the old value 10655 */ 10656 boolean setAlphaNoInvalidation(float alpha) { 10657 ensureTransformationInfo(); 10658 if (mTransformationInfo.mAlpha != alpha) { 10659 mTransformationInfo.mAlpha = alpha; 10660 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 10661 if (subclassHandlesAlpha) { 10662 mPrivateFlags |= PFLAG_ALPHA_SET; 10663 return true; 10664 } else { 10665 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10666 mRenderNode.setAlpha(getFinalAlpha()); 10667 } 10668 } 10669 return false; 10670 } 10671 10672 /** 10673 * This property is hidden and intended only for use by the Fade transition, which 10674 * animates it to produce a visual translucency that does not side-effect (or get 10675 * affected by) the real alpha property. This value is composited with the other 10676 * alpha value (and the AlphaAnimation value, when that is present) to produce 10677 * a final visual translucency result, which is what is passed into the DisplayList. 10678 * 10679 * @hide 10680 */ 10681 public void setTransitionAlpha(float alpha) { 10682 ensureTransformationInfo(); 10683 if (mTransformationInfo.mTransitionAlpha != alpha) { 10684 mTransformationInfo.mTransitionAlpha = alpha; 10685 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10686 invalidateViewProperty(true, false); 10687 mRenderNode.setAlpha(getFinalAlpha()); 10688 } 10689 } 10690 10691 /** 10692 * Calculates the visual alpha of this view, which is a combination of the actual 10693 * alpha value and the transitionAlpha value (if set). 10694 */ 10695 private float getFinalAlpha() { 10696 if (mTransformationInfo != null) { 10697 return mTransformationInfo.mAlpha * mTransformationInfo.mTransitionAlpha; 10698 } 10699 return 1; 10700 } 10701 10702 /** 10703 * This property is hidden and intended only for use by the Fade transition, which 10704 * animates it to produce a visual translucency that does not side-effect (or get 10705 * affected by) the real alpha property. This value is composited with the other 10706 * alpha value (and the AlphaAnimation value, when that is present) to produce 10707 * a final visual translucency result, which is what is passed into the DisplayList. 10708 * 10709 * @hide 10710 */ 10711 @ViewDebug.ExportedProperty(category = "drawing") 10712 public float getTransitionAlpha() { 10713 return mTransformationInfo != null ? mTransformationInfo.mTransitionAlpha : 1; 10714 } 10715 10716 /** 10717 * Top position of this view relative to its parent. 10718 * 10719 * @return The top of this view, in pixels. 10720 */ 10721 @ViewDebug.CapturedViewProperty 10722 public final int getTop() { 10723 return mTop; 10724 } 10725 10726 /** 10727 * Sets the top position of this view relative to its parent. This method is meant to be called 10728 * by the layout system and should not generally be called otherwise, because the property 10729 * may be changed at any time by the layout. 10730 * 10731 * @param top The top of this view, in pixels. 10732 */ 10733 public final void setTop(int top) { 10734 if (top != mTop) { 10735 final boolean matrixIsIdentity = hasIdentityMatrix(); 10736 if (matrixIsIdentity) { 10737 if (mAttachInfo != null) { 10738 int minTop; 10739 int yLoc; 10740 if (top < mTop) { 10741 minTop = top; 10742 yLoc = top - mTop; 10743 } else { 10744 minTop = mTop; 10745 yLoc = 0; 10746 } 10747 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 10748 } 10749 } else { 10750 // Double-invalidation is necessary to capture view's old and new areas 10751 invalidate(true); 10752 } 10753 10754 int width = mRight - mLeft; 10755 int oldHeight = mBottom - mTop; 10756 10757 mTop = top; 10758 mRenderNode.setTop(mTop); 10759 10760 sizeChange(width, mBottom - mTop, width, oldHeight); 10761 10762 if (!matrixIsIdentity) { 10763 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10764 invalidate(true); 10765 } 10766 mBackgroundSizeChanged = true; 10767 invalidateParentIfNeeded(); 10768 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10769 // View was rejected last time it was drawn by its parent; this may have changed 10770 invalidateParentIfNeeded(); 10771 } 10772 } 10773 } 10774 10775 /** 10776 * Bottom position of this view relative to its parent. 10777 * 10778 * @return The bottom of this view, in pixels. 10779 */ 10780 @ViewDebug.CapturedViewProperty 10781 public final int getBottom() { 10782 return mBottom; 10783 } 10784 10785 /** 10786 * True if this view has changed since the last time being drawn. 10787 * 10788 * @return The dirty state of this view. 10789 */ 10790 public boolean isDirty() { 10791 return (mPrivateFlags & PFLAG_DIRTY_MASK) != 0; 10792 } 10793 10794 /** 10795 * Sets the bottom position of this view relative to its parent. This method is meant to be 10796 * called by the layout system and should not generally be called otherwise, because the 10797 * property may be changed at any time by the layout. 10798 * 10799 * @param bottom The bottom of this view, in pixels. 10800 */ 10801 public final void setBottom(int bottom) { 10802 if (bottom != mBottom) { 10803 final boolean matrixIsIdentity = hasIdentityMatrix(); 10804 if (matrixIsIdentity) { 10805 if (mAttachInfo != null) { 10806 int maxBottom; 10807 if (bottom < mBottom) { 10808 maxBottom = mBottom; 10809 } else { 10810 maxBottom = bottom; 10811 } 10812 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 10813 } 10814 } else { 10815 // Double-invalidation is necessary to capture view's old and new areas 10816 invalidate(true); 10817 } 10818 10819 int width = mRight - mLeft; 10820 int oldHeight = mBottom - mTop; 10821 10822 mBottom = bottom; 10823 mRenderNode.setBottom(mBottom); 10824 10825 sizeChange(width, mBottom - mTop, width, oldHeight); 10826 10827 if (!matrixIsIdentity) { 10828 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10829 invalidate(true); 10830 } 10831 mBackgroundSizeChanged = true; 10832 invalidateParentIfNeeded(); 10833 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10834 // View was rejected last time it was drawn by its parent; this may have changed 10835 invalidateParentIfNeeded(); 10836 } 10837 } 10838 } 10839 10840 /** 10841 * Left position of this view relative to its parent. 10842 * 10843 * @return The left edge of this view, in pixels. 10844 */ 10845 @ViewDebug.CapturedViewProperty 10846 public final int getLeft() { 10847 return mLeft; 10848 } 10849 10850 /** 10851 * Sets the left position of this view relative to its parent. This method is meant to be called 10852 * by the layout system and should not generally be called otherwise, because the property 10853 * may be changed at any time by the layout. 10854 * 10855 * @param left The left of this view, in pixels. 10856 */ 10857 public final void setLeft(int left) { 10858 if (left != mLeft) { 10859 final boolean matrixIsIdentity = hasIdentityMatrix(); 10860 if (matrixIsIdentity) { 10861 if (mAttachInfo != null) { 10862 int minLeft; 10863 int xLoc; 10864 if (left < mLeft) { 10865 minLeft = left; 10866 xLoc = left - mLeft; 10867 } else { 10868 minLeft = mLeft; 10869 xLoc = 0; 10870 } 10871 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 10872 } 10873 } else { 10874 // Double-invalidation is necessary to capture view's old and new areas 10875 invalidate(true); 10876 } 10877 10878 int oldWidth = mRight - mLeft; 10879 int height = mBottom - mTop; 10880 10881 mLeft = left; 10882 mRenderNode.setLeft(left); 10883 10884 sizeChange(mRight - mLeft, height, oldWidth, height); 10885 10886 if (!matrixIsIdentity) { 10887 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10888 invalidate(true); 10889 } 10890 mBackgroundSizeChanged = true; 10891 invalidateParentIfNeeded(); 10892 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10893 // View was rejected last time it was drawn by its parent; this may have changed 10894 invalidateParentIfNeeded(); 10895 } 10896 } 10897 } 10898 10899 /** 10900 * Right position of this view relative to its parent. 10901 * 10902 * @return The right edge of this view, in pixels. 10903 */ 10904 @ViewDebug.CapturedViewProperty 10905 public final int getRight() { 10906 return mRight; 10907 } 10908 10909 /** 10910 * Sets the right position of this view relative to its parent. This method is meant to be called 10911 * by the layout system and should not generally be called otherwise, because the property 10912 * may be changed at any time by the layout. 10913 * 10914 * @param right The right of this view, in pixels. 10915 */ 10916 public final void setRight(int right) { 10917 if (right != mRight) { 10918 final boolean matrixIsIdentity = hasIdentityMatrix(); 10919 if (matrixIsIdentity) { 10920 if (mAttachInfo != null) { 10921 int maxRight; 10922 if (right < mRight) { 10923 maxRight = mRight; 10924 } else { 10925 maxRight = right; 10926 } 10927 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 10928 } 10929 } else { 10930 // Double-invalidation is necessary to capture view's old and new areas 10931 invalidate(true); 10932 } 10933 10934 int oldWidth = mRight - mLeft; 10935 int height = mBottom - mTop; 10936 10937 mRight = right; 10938 mRenderNode.setRight(mRight); 10939 10940 sizeChange(mRight - mLeft, height, oldWidth, height); 10941 10942 if (!matrixIsIdentity) { 10943 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10944 invalidate(true); 10945 } 10946 mBackgroundSizeChanged = true; 10947 invalidateParentIfNeeded(); 10948 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10949 // View was rejected last time it was drawn by its parent; this may have changed 10950 invalidateParentIfNeeded(); 10951 } 10952 } 10953 } 10954 10955 /** 10956 * The visual x position of this view, in pixels. This is equivalent to the 10957 * {@link #setTranslationX(float) translationX} property plus the current 10958 * {@link #getLeft() left} property. 10959 * 10960 * @return The visual x position of this view, in pixels. 10961 */ 10962 @ViewDebug.ExportedProperty(category = "drawing") 10963 public float getX() { 10964 return mLeft + getTranslationX(); 10965 } 10966 10967 /** 10968 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 10969 * {@link #setTranslationX(float) translationX} property to be the difference between 10970 * the x value passed in and the current {@link #getLeft() left} property. 10971 * 10972 * @param x The visual x position of this view, in pixels. 10973 */ 10974 public void setX(float x) { 10975 setTranslationX(x - mLeft); 10976 } 10977 10978 /** 10979 * The visual y position of this view, in pixels. This is equivalent to the 10980 * {@link #setTranslationY(float) translationY} property plus the current 10981 * {@link #getTop() top} property. 10982 * 10983 * @return The visual y position of this view, in pixels. 10984 */ 10985 @ViewDebug.ExportedProperty(category = "drawing") 10986 public float getY() { 10987 return mTop + getTranslationY(); 10988 } 10989 10990 /** 10991 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 10992 * {@link #setTranslationY(float) translationY} property to be the difference between 10993 * the y value passed in and the current {@link #getTop() top} property. 10994 * 10995 * @param y The visual y position of this view, in pixels. 10996 */ 10997 public void setY(float y) { 10998 setTranslationY(y - mTop); 10999 } 11000 11001 /** 11002 * The visual z position of this view, in pixels. This is equivalent to the 11003 * {@link #setTranslationZ(float) translationZ} property plus the current 11004 * {@link #getElevation() elevation} property. 11005 * 11006 * @return The visual z position of this view, in pixels. 11007 */ 11008 @ViewDebug.ExportedProperty(category = "drawing") 11009 public float getZ() { 11010 return getElevation() + getTranslationZ(); 11011 } 11012 11013 /** 11014 * Sets the visual z position of this view, in pixels. This is equivalent to setting the 11015 * {@link #setTranslationZ(float) translationZ} property to be the difference between 11016 * the x value passed in and the current {@link #getElevation() elevation} property. 11017 * 11018 * @param z The visual z position of this view, in pixels. 11019 */ 11020 public void setZ(float z) { 11021 setTranslationZ(z - getElevation()); 11022 } 11023 11024 /** 11025 * The base elevation of this view relative to its parent, in pixels. 11026 * 11027 * @return The base depth position of the view, in pixels. 11028 */ 11029 @ViewDebug.ExportedProperty(category = "drawing") 11030 public float getElevation() { 11031 return mRenderNode.getElevation(); 11032 } 11033 11034 /** 11035 * Sets the base elevation of this view, in pixels. 11036 * 11037 * @attr ref android.R.styleable#View_elevation 11038 */ 11039 public void setElevation(float elevation) { 11040 if (elevation != getElevation()) { 11041 invalidateViewProperty(true, false); 11042 mRenderNode.setElevation(elevation); 11043 invalidateViewProperty(false, true); 11044 11045 invalidateParentIfNeededAndWasQuickRejected(); 11046 } 11047 } 11048 11049 /** 11050 * The horizontal location of this view relative to its {@link #getLeft() left} position. 11051 * This position is post-layout, in addition to wherever the object's 11052 * layout placed it. 11053 * 11054 * @return The horizontal position of this view relative to its left position, in pixels. 11055 */ 11056 @ViewDebug.ExportedProperty(category = "drawing") 11057 public float getTranslationX() { 11058 return mRenderNode.getTranslationX(); 11059 } 11060 11061 /** 11062 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 11063 * This effectively positions the object post-layout, in addition to wherever the object's 11064 * layout placed it. 11065 * 11066 * @param translationX The horizontal position of this view relative to its left position, 11067 * in pixels. 11068 * 11069 * @attr ref android.R.styleable#View_translationX 11070 */ 11071 public void setTranslationX(float translationX) { 11072 if (translationX != getTranslationX()) { 11073 invalidateViewProperty(true, false); 11074 mRenderNode.setTranslationX(translationX); 11075 invalidateViewProperty(false, true); 11076 11077 invalidateParentIfNeededAndWasQuickRejected(); 11078 notifySubtreeAccessibilityStateChangedIfNeeded(); 11079 } 11080 } 11081 11082 /** 11083 * The vertical location of this view relative to its {@link #getTop() top} position. 11084 * This position is post-layout, in addition to wherever the object's 11085 * layout placed it. 11086 * 11087 * @return The vertical position of this view relative to its top position, 11088 * in pixels. 11089 */ 11090 @ViewDebug.ExportedProperty(category = "drawing") 11091 public float getTranslationY() { 11092 return mRenderNode.getTranslationY(); 11093 } 11094 11095 /** 11096 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 11097 * This effectively positions the object post-layout, in addition to wherever the object's 11098 * layout placed it. 11099 * 11100 * @param translationY The vertical position of this view relative to its top position, 11101 * in pixels. 11102 * 11103 * @attr ref android.R.styleable#View_translationY 11104 */ 11105 public void setTranslationY(float translationY) { 11106 if (translationY != getTranslationY()) { 11107 invalidateViewProperty(true, false); 11108 mRenderNode.setTranslationY(translationY); 11109 invalidateViewProperty(false, true); 11110 11111 invalidateParentIfNeededAndWasQuickRejected(); 11112 } 11113 } 11114 11115 /** 11116 * The depth location of this view relative to its {@link #getElevation() elevation}. 11117 * 11118 * @return The depth of this view relative to its elevation. 11119 */ 11120 @ViewDebug.ExportedProperty(category = "drawing") 11121 public float getTranslationZ() { 11122 return mRenderNode.getTranslationZ(); 11123 } 11124 11125 /** 11126 * Sets the depth location of this view relative to its {@link #getElevation() elevation}. 11127 * 11128 * @attr ref android.R.styleable#View_translationZ 11129 */ 11130 public void setTranslationZ(float translationZ) { 11131 if (translationZ != getTranslationZ()) { 11132 invalidateViewProperty(true, false); 11133 mRenderNode.setTranslationZ(translationZ); 11134 invalidateViewProperty(false, true); 11135 11136 invalidateParentIfNeededAndWasQuickRejected(); 11137 } 11138 } 11139 11140 /** @hide */ 11141 public void setAnimationMatrix(Matrix matrix) { 11142 invalidateViewProperty(true, false); 11143 mRenderNode.setAnimationMatrix(matrix); 11144 invalidateViewProperty(false, true); 11145 11146 invalidateParentIfNeededAndWasQuickRejected(); 11147 } 11148 11149 /** 11150 * Returns the current StateListAnimator if exists. 11151 * 11152 * @return StateListAnimator or null if it does not exists 11153 * @see #setStateListAnimator(android.animation.StateListAnimator) 11154 */ 11155 public StateListAnimator getStateListAnimator() { 11156 return mStateListAnimator; 11157 } 11158 11159 /** 11160 * Attaches the provided StateListAnimator to this View. 11161 * <p> 11162 * Any previously attached StateListAnimator will be detached. 11163 * 11164 * @param stateListAnimator The StateListAnimator to update the view 11165 * @see {@link android.animation.StateListAnimator} 11166 */ 11167 public void setStateListAnimator(StateListAnimator stateListAnimator) { 11168 if (mStateListAnimator == stateListAnimator) { 11169 return; 11170 } 11171 if (mStateListAnimator != null) { 11172 mStateListAnimator.setTarget(null); 11173 } 11174 mStateListAnimator = stateListAnimator; 11175 if (stateListAnimator != null) { 11176 stateListAnimator.setTarget(this); 11177 if (isAttachedToWindow()) { 11178 stateListAnimator.setState(getDrawableState()); 11179 } 11180 } 11181 } 11182 11183 /** 11184 * Returns whether the Outline should be used to clip the contents of the View. 11185 * <p> 11186 * Note that this flag will only be respected if the View's Outline returns true from 11187 * {@link Outline#canClip()}. 11188 * 11189 * @see #setOutlineProvider(ViewOutlineProvider) 11190 * @see #setClipToOutline(boolean) 11191 */ 11192 public final boolean getClipToOutline() { 11193 return mRenderNode.getClipToOutline(); 11194 } 11195 11196 /** 11197 * Sets whether the View's Outline should be used to clip the contents of the View. 11198 * <p> 11199 * Only a single non-rectangular clip can be applied on a View at any time. 11200 * Circular clips from a {@link ViewAnimationUtils#createCircularReveal(View, int, int, float, float) 11201 * circular reveal} animation take priority over Outline clipping, and 11202 * child Outline clipping takes priority over Outline clipping done by a 11203 * parent. 11204 * <p> 11205 * Note that this flag will only be respected if the View's Outline returns true from 11206 * {@link Outline#canClip()}. 11207 * 11208 * @see #setOutlineProvider(ViewOutlineProvider) 11209 * @see #getClipToOutline() 11210 */ 11211 public void setClipToOutline(boolean clipToOutline) { 11212 damageInParent(); 11213 if (getClipToOutline() != clipToOutline) { 11214 mRenderNode.setClipToOutline(clipToOutline); 11215 } 11216 } 11217 11218 // correspond to the enum values of View_outlineProvider 11219 private static final int PROVIDER_BACKGROUND = 0; 11220 private static final int PROVIDER_NONE = 1; 11221 private static final int PROVIDER_BOUNDS = 2; 11222 private static final int PROVIDER_PADDED_BOUNDS = 3; 11223 private void setOutlineProviderFromAttribute(int providerInt) { 11224 switch (providerInt) { 11225 case PROVIDER_BACKGROUND: 11226 setOutlineProvider(ViewOutlineProvider.BACKGROUND); 11227 break; 11228 case PROVIDER_NONE: 11229 setOutlineProvider(null); 11230 break; 11231 case PROVIDER_BOUNDS: 11232 setOutlineProvider(ViewOutlineProvider.BOUNDS); 11233 break; 11234 case PROVIDER_PADDED_BOUNDS: 11235 setOutlineProvider(ViewOutlineProvider.PADDED_BOUNDS); 11236 break; 11237 } 11238 } 11239 11240 /** 11241 * Sets the {@link ViewOutlineProvider} of the view, which generates the Outline that defines 11242 * the shape of the shadow it casts, and enables outline clipping. 11243 * <p> 11244 * The default ViewOutlineProvider, {@link ViewOutlineProvider#BACKGROUND}, queries the Outline 11245 * from the View's background drawable, via {@link Drawable#getOutline(Outline)}. Changing the 11246 * outline provider with this method allows this behavior to be overridden. 11247 * <p> 11248 * If the ViewOutlineProvider is null, if querying it for an outline returns false, 11249 * or if the produced Outline is {@link Outline#isEmpty()}, shadows will not be cast. 11250 * <p> 11251 * Only outlines that return true from {@link Outline#canClip()} may be used for clipping. 11252 * 11253 * @see #setClipToOutline(boolean) 11254 * @see #getClipToOutline() 11255 * @see #getOutlineProvider() 11256 */ 11257 public void setOutlineProvider(ViewOutlineProvider provider) { 11258 mOutlineProvider = provider; 11259 invalidateOutline(); 11260 } 11261 11262 /** 11263 * Returns the current {@link ViewOutlineProvider} of the view, which generates the Outline 11264 * that defines the shape of the shadow it casts, and enables outline clipping. 11265 * 11266 * @see #setOutlineProvider(ViewOutlineProvider) 11267 */ 11268 public ViewOutlineProvider getOutlineProvider() { 11269 return mOutlineProvider; 11270 } 11271 11272 /** 11273 * Called to rebuild this View's Outline from its {@link ViewOutlineProvider outline provider} 11274 * 11275 * @see #setOutlineProvider(ViewOutlineProvider) 11276 */ 11277 public void invalidateOutline() { 11278 rebuildOutline(); 11279 11280 notifySubtreeAccessibilityStateChangedIfNeeded(); 11281 invalidateViewProperty(false, false); 11282 } 11283 11284 /** 11285 * Internal version of {@link #invalidateOutline()} which invalidates the 11286 * outline without invalidating the view itself. This is intended to be called from 11287 * within methods in the View class itself which are the result of the view being 11288 * invalidated already. For example, when we are drawing the background of a View, 11289 * we invalidate the outline in case it changed in the meantime, but we do not 11290 * need to invalidate the view because we're already drawing the background as part 11291 * of drawing the view in response to an earlier invalidation of the view. 11292 */ 11293 private void rebuildOutline() { 11294 // Unattached views ignore this signal, and outline is recomputed in onAttachedToWindow() 11295 if (mAttachInfo == null) return; 11296 11297 if (mOutlineProvider == null) { 11298 // no provider, remove outline 11299 mRenderNode.setOutline(null); 11300 } else { 11301 final Outline outline = mAttachInfo.mTmpOutline; 11302 outline.setEmpty(); 11303 outline.setAlpha(1.0f); 11304 11305 mOutlineProvider.getOutline(this, outline); 11306 mRenderNode.setOutline(outline); 11307 } 11308 } 11309 11310 /** 11311 * HierarchyViewer only 11312 * 11313 * @hide 11314 */ 11315 @ViewDebug.ExportedProperty(category = "drawing") 11316 public boolean hasShadow() { 11317 return mRenderNode.hasShadow(); 11318 } 11319 11320 11321 /** @hide */ 11322 public void setRevealClip(boolean shouldClip, float x, float y, float radius) { 11323 mRenderNode.setRevealClip(shouldClip, x, y, radius); 11324 invalidateViewProperty(false, false); 11325 } 11326 11327 /** 11328 * Hit rectangle in parent's coordinates 11329 * 11330 * @param outRect The hit rectangle of the view. 11331 */ 11332 public void getHitRect(Rect outRect) { 11333 if (hasIdentityMatrix() || mAttachInfo == null) { 11334 outRect.set(mLeft, mTop, mRight, mBottom); 11335 } else { 11336 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 11337 tmpRect.set(0, 0, getWidth(), getHeight()); 11338 getMatrix().mapRect(tmpRect); // TODO: mRenderNode.mapRect(tmpRect) 11339 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 11340 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 11341 } 11342 } 11343 11344 /** 11345 * Determines whether the given point, in local coordinates is inside the view. 11346 */ 11347 /*package*/ final boolean pointInView(float localX, float localY) { 11348 return localX >= 0 && localX < (mRight - mLeft) 11349 && localY >= 0 && localY < (mBottom - mTop); 11350 } 11351 11352 /** 11353 * Utility method to determine whether the given point, in local coordinates, 11354 * is inside the view, where the area of the view is expanded by the slop factor. 11355 * This method is called while processing touch-move events to determine if the event 11356 * is still within the view. 11357 * 11358 * @hide 11359 */ 11360 public boolean pointInView(float localX, float localY, float slop) { 11361 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 11362 localY < ((mBottom - mTop) + slop); 11363 } 11364 11365 /** 11366 * When a view has focus and the user navigates away from it, the next view is searched for 11367 * starting from the rectangle filled in by this method. 11368 * 11369 * By default, the rectangle is the {@link #getDrawingRect(android.graphics.Rect)}) 11370 * of the view. However, if your view maintains some idea of internal selection, 11371 * such as a cursor, or a selected row or column, you should override this method and 11372 * fill in a more specific rectangle. 11373 * 11374 * @param r The rectangle to fill in, in this view's coordinates. 11375 */ 11376 public void getFocusedRect(Rect r) { 11377 getDrawingRect(r); 11378 } 11379 11380 /** 11381 * If some part of this view is not clipped by any of its parents, then 11382 * return that area in r in global (root) coordinates. To convert r to local 11383 * coordinates (without taking possible View rotations into account), offset 11384 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 11385 * If the view is completely clipped or translated out, return false. 11386 * 11387 * @param r If true is returned, r holds the global coordinates of the 11388 * visible portion of this view. 11389 * @param globalOffset If true is returned, globalOffset holds the dx,dy 11390 * between this view and its root. globalOffet may be null. 11391 * @return true if r is non-empty (i.e. part of the view is visible at the 11392 * root level. 11393 */ 11394 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 11395 int width = mRight - mLeft; 11396 int height = mBottom - mTop; 11397 if (width > 0 && height > 0) { 11398 r.set(0, 0, width, height); 11399 if (globalOffset != null) { 11400 globalOffset.set(-mScrollX, -mScrollY); 11401 } 11402 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 11403 } 11404 return false; 11405 } 11406 11407 public final boolean getGlobalVisibleRect(Rect r) { 11408 return getGlobalVisibleRect(r, null); 11409 } 11410 11411 public final boolean getLocalVisibleRect(Rect r) { 11412 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point(); 11413 if (getGlobalVisibleRect(r, offset)) { 11414 r.offset(-offset.x, -offset.y); // make r local 11415 return true; 11416 } 11417 return false; 11418 } 11419 11420 /** 11421 * Offset this view's vertical location by the specified number of pixels. 11422 * 11423 * @param offset the number of pixels to offset the view by 11424 */ 11425 public void offsetTopAndBottom(int offset) { 11426 if (offset != 0) { 11427 final boolean matrixIsIdentity = hasIdentityMatrix(); 11428 if (matrixIsIdentity) { 11429 if (isHardwareAccelerated()) { 11430 invalidateViewProperty(false, false); 11431 } else { 11432 final ViewParent p = mParent; 11433 if (p != null && mAttachInfo != null) { 11434 final Rect r = mAttachInfo.mTmpInvalRect; 11435 int minTop; 11436 int maxBottom; 11437 int yLoc; 11438 if (offset < 0) { 11439 minTop = mTop + offset; 11440 maxBottom = mBottom; 11441 yLoc = offset; 11442 } else { 11443 minTop = mTop; 11444 maxBottom = mBottom + offset; 11445 yLoc = 0; 11446 } 11447 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 11448 p.invalidateChild(this, r); 11449 } 11450 } 11451 } else { 11452 invalidateViewProperty(false, false); 11453 } 11454 11455 mTop += offset; 11456 mBottom += offset; 11457 mRenderNode.offsetTopAndBottom(offset); 11458 if (isHardwareAccelerated()) { 11459 invalidateViewProperty(false, false); 11460 } else { 11461 if (!matrixIsIdentity) { 11462 invalidateViewProperty(false, true); 11463 } 11464 invalidateParentIfNeeded(); 11465 } 11466 notifySubtreeAccessibilityStateChangedIfNeeded(); 11467 } 11468 } 11469 11470 /** 11471 * Offset this view's horizontal location by the specified amount of pixels. 11472 * 11473 * @param offset the number of pixels to offset the view by 11474 */ 11475 public void offsetLeftAndRight(int offset) { 11476 if (offset != 0) { 11477 final boolean matrixIsIdentity = hasIdentityMatrix(); 11478 if (matrixIsIdentity) { 11479 if (isHardwareAccelerated()) { 11480 invalidateViewProperty(false, false); 11481 } else { 11482 final ViewParent p = mParent; 11483 if (p != null && mAttachInfo != null) { 11484 final Rect r = mAttachInfo.mTmpInvalRect; 11485 int minLeft; 11486 int maxRight; 11487 if (offset < 0) { 11488 minLeft = mLeft + offset; 11489 maxRight = mRight; 11490 } else { 11491 minLeft = mLeft; 11492 maxRight = mRight + offset; 11493 } 11494 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 11495 p.invalidateChild(this, r); 11496 } 11497 } 11498 } else { 11499 invalidateViewProperty(false, false); 11500 } 11501 11502 mLeft += offset; 11503 mRight += offset; 11504 mRenderNode.offsetLeftAndRight(offset); 11505 if (isHardwareAccelerated()) { 11506 invalidateViewProperty(false, false); 11507 } else { 11508 if (!matrixIsIdentity) { 11509 invalidateViewProperty(false, true); 11510 } 11511 invalidateParentIfNeeded(); 11512 } 11513 notifySubtreeAccessibilityStateChangedIfNeeded(); 11514 } 11515 } 11516 11517 /** 11518 * Get the LayoutParams associated with this view. All views should have 11519 * layout parameters. These supply parameters to the <i>parent</i> of this 11520 * view specifying how it should be arranged. There are many subclasses of 11521 * ViewGroup.LayoutParams, and these correspond to the different subclasses 11522 * of ViewGroup that are responsible for arranging their children. 11523 * 11524 * This method may return null if this View is not attached to a parent 11525 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 11526 * was not invoked successfully. When a View is attached to a parent 11527 * ViewGroup, this method must not return null. 11528 * 11529 * @return The LayoutParams associated with this view, or null if no 11530 * parameters have been set yet 11531 */ 11532 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 11533 public ViewGroup.LayoutParams getLayoutParams() { 11534 return mLayoutParams; 11535 } 11536 11537 /** 11538 * Set the layout parameters associated with this view. These supply 11539 * parameters to the <i>parent</i> of this view specifying how it should be 11540 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 11541 * correspond to the different subclasses of ViewGroup that are responsible 11542 * for arranging their children. 11543 * 11544 * @param params The layout parameters for this view, cannot be null 11545 */ 11546 public void setLayoutParams(ViewGroup.LayoutParams params) { 11547 if (params == null) { 11548 throw new NullPointerException("Layout parameters cannot be null"); 11549 } 11550 mLayoutParams = params; 11551 resolveLayoutParams(); 11552 if (mParent instanceof ViewGroup) { 11553 ((ViewGroup) mParent).onSetLayoutParams(this, params); 11554 } 11555 requestLayout(); 11556 } 11557 11558 /** 11559 * Resolve the layout parameters depending on the resolved layout direction 11560 * 11561 * @hide 11562 */ 11563 public void resolveLayoutParams() { 11564 if (mLayoutParams != null) { 11565 mLayoutParams.resolveLayoutDirection(getLayoutDirection()); 11566 } 11567 } 11568 11569 /** 11570 * Set the scrolled position of your view. This will cause a call to 11571 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11572 * invalidated. 11573 * @param x the x position to scroll to 11574 * @param y the y position to scroll to 11575 */ 11576 public void scrollTo(int x, int y) { 11577 if (mScrollX != x || mScrollY != y) { 11578 int oldX = mScrollX; 11579 int oldY = mScrollY; 11580 mScrollX = x; 11581 mScrollY = y; 11582 invalidateParentCaches(); 11583 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 11584 if (!awakenScrollBars()) { 11585 postInvalidateOnAnimation(); 11586 } 11587 } 11588 } 11589 11590 /** 11591 * Move the scrolled position of your view. This will cause a call to 11592 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11593 * invalidated. 11594 * @param x the amount of pixels to scroll by horizontally 11595 * @param y the amount of pixels to scroll by vertically 11596 */ 11597 public void scrollBy(int x, int y) { 11598 scrollTo(mScrollX + x, mScrollY + y); 11599 } 11600 11601 /** 11602 * <p>Trigger the scrollbars to draw. When invoked this method starts an 11603 * animation to fade the scrollbars out after a default delay. If a subclass 11604 * provides animated scrolling, the start delay should equal the duration 11605 * of the scrolling animation.</p> 11606 * 11607 * <p>The animation starts only if at least one of the scrollbars is 11608 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 11609 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11610 * this method returns true, and false otherwise. If the animation is 11611 * started, this method calls {@link #invalidate()}; in that case the 11612 * caller should not call {@link #invalidate()}.</p> 11613 * 11614 * <p>This method should be invoked every time a subclass directly updates 11615 * the scroll parameters.</p> 11616 * 11617 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 11618 * and {@link #scrollTo(int, int)}.</p> 11619 * 11620 * @return true if the animation is played, false otherwise 11621 * 11622 * @see #awakenScrollBars(int) 11623 * @see #scrollBy(int, int) 11624 * @see #scrollTo(int, int) 11625 * @see #isHorizontalScrollBarEnabled() 11626 * @see #isVerticalScrollBarEnabled() 11627 * @see #setHorizontalScrollBarEnabled(boolean) 11628 * @see #setVerticalScrollBarEnabled(boolean) 11629 */ 11630 protected boolean awakenScrollBars() { 11631 return mScrollCache != null && 11632 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 11633 } 11634 11635 /** 11636 * Trigger the scrollbars to draw. 11637 * This method differs from awakenScrollBars() only in its default duration. 11638 * initialAwakenScrollBars() will show the scroll bars for longer than 11639 * usual to give the user more of a chance to notice them. 11640 * 11641 * @return true if the animation is played, false otherwise. 11642 */ 11643 private boolean initialAwakenScrollBars() { 11644 return mScrollCache != null && 11645 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 11646 } 11647 11648 /** 11649 * <p> 11650 * Trigger the scrollbars to draw. When invoked this method starts an 11651 * animation to fade the scrollbars out after a fixed delay. If a subclass 11652 * provides animated scrolling, the start delay should equal the duration of 11653 * the scrolling animation. 11654 * </p> 11655 * 11656 * <p> 11657 * The animation starts only if at least one of the scrollbars is enabled, 11658 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11659 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11660 * this method returns true, and false otherwise. If the animation is 11661 * started, this method calls {@link #invalidate()}; in that case the caller 11662 * should not call {@link #invalidate()}. 11663 * </p> 11664 * 11665 * <p> 11666 * This method should be invoked everytime a subclass directly updates the 11667 * scroll parameters. 11668 * </p> 11669 * 11670 * @param startDelay the delay, in milliseconds, after which the animation 11671 * should start; when the delay is 0, the animation starts 11672 * immediately 11673 * @return true if the animation is played, false otherwise 11674 * 11675 * @see #scrollBy(int, int) 11676 * @see #scrollTo(int, int) 11677 * @see #isHorizontalScrollBarEnabled() 11678 * @see #isVerticalScrollBarEnabled() 11679 * @see #setHorizontalScrollBarEnabled(boolean) 11680 * @see #setVerticalScrollBarEnabled(boolean) 11681 */ 11682 protected boolean awakenScrollBars(int startDelay) { 11683 return awakenScrollBars(startDelay, true); 11684 } 11685 11686 /** 11687 * <p> 11688 * Trigger the scrollbars to draw. When invoked this method starts an 11689 * animation to fade the scrollbars out after a fixed delay. If a subclass 11690 * provides animated scrolling, the start delay should equal the duration of 11691 * the scrolling animation. 11692 * </p> 11693 * 11694 * <p> 11695 * The animation starts only if at least one of the scrollbars is enabled, 11696 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11697 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11698 * this method returns true, and false otherwise. If the animation is 11699 * started, this method calls {@link #invalidate()} if the invalidate parameter 11700 * is set to true; in that case the caller 11701 * should not call {@link #invalidate()}. 11702 * </p> 11703 * 11704 * <p> 11705 * This method should be invoked everytime a subclass directly updates the 11706 * scroll parameters. 11707 * </p> 11708 * 11709 * @param startDelay the delay, in milliseconds, after which the animation 11710 * should start; when the delay is 0, the animation starts 11711 * immediately 11712 * 11713 * @param invalidate Wheter this method should call invalidate 11714 * 11715 * @return true if the animation is played, false otherwise 11716 * 11717 * @see #scrollBy(int, int) 11718 * @see #scrollTo(int, int) 11719 * @see #isHorizontalScrollBarEnabled() 11720 * @see #isVerticalScrollBarEnabled() 11721 * @see #setHorizontalScrollBarEnabled(boolean) 11722 * @see #setVerticalScrollBarEnabled(boolean) 11723 */ 11724 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 11725 final ScrollabilityCache scrollCache = mScrollCache; 11726 11727 if (scrollCache == null || !scrollCache.fadeScrollBars) { 11728 return false; 11729 } 11730 11731 if (scrollCache.scrollBar == null) { 11732 scrollCache.scrollBar = new ScrollBarDrawable(); 11733 } 11734 11735 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 11736 11737 if (invalidate) { 11738 // Invalidate to show the scrollbars 11739 postInvalidateOnAnimation(); 11740 } 11741 11742 if (scrollCache.state == ScrollabilityCache.OFF) { 11743 // FIXME: this is copied from WindowManagerService. 11744 // We should get this value from the system when it 11745 // is possible to do so. 11746 final int KEY_REPEAT_FIRST_DELAY = 750; 11747 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 11748 } 11749 11750 // Tell mScrollCache when we should start fading. This may 11751 // extend the fade start time if one was already scheduled 11752 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 11753 scrollCache.fadeStartTime = fadeStartTime; 11754 scrollCache.state = ScrollabilityCache.ON; 11755 11756 // Schedule our fader to run, unscheduling any old ones first 11757 if (mAttachInfo != null) { 11758 mAttachInfo.mHandler.removeCallbacks(scrollCache); 11759 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 11760 } 11761 11762 return true; 11763 } 11764 11765 return false; 11766 } 11767 11768 /** 11769 * Do not invalidate views which are not visible and which are not running an animation. They 11770 * will not get drawn and they should not set dirty flags as if they will be drawn 11771 */ 11772 private boolean skipInvalidate() { 11773 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 11774 (!(mParent instanceof ViewGroup) || 11775 !((ViewGroup) mParent).isViewTransitioning(this)); 11776 } 11777 11778 /** 11779 * Mark the area defined by dirty as needing to be drawn. If the view is 11780 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11781 * point in the future. 11782 * <p> 11783 * This must be called from a UI thread. To call from a non-UI thread, call 11784 * {@link #postInvalidate()}. 11785 * <p> 11786 * <b>WARNING:</b> In API 19 and below, this method may be destructive to 11787 * {@code dirty}. 11788 * 11789 * @param dirty the rectangle representing the bounds of the dirty region 11790 */ 11791 public void invalidate(Rect dirty) { 11792 final int scrollX = mScrollX; 11793 final int scrollY = mScrollY; 11794 invalidateInternal(dirty.left - scrollX, dirty.top - scrollY, 11795 dirty.right - scrollX, dirty.bottom - scrollY, true, false); 11796 } 11797 11798 /** 11799 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. The 11800 * coordinates of the dirty rect are relative to the view. If the view is 11801 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11802 * point in the future. 11803 * <p> 11804 * This must be called from a UI thread. To call from a non-UI thread, call 11805 * {@link #postInvalidate()}. 11806 * 11807 * @param l the left position of the dirty region 11808 * @param t the top position of the dirty region 11809 * @param r the right position of the dirty region 11810 * @param b the bottom position of the dirty region 11811 */ 11812 public void invalidate(int l, int t, int r, int b) { 11813 final int scrollX = mScrollX; 11814 final int scrollY = mScrollY; 11815 invalidateInternal(l - scrollX, t - scrollY, r - scrollX, b - scrollY, true, false); 11816 } 11817 11818 /** 11819 * Invalidate the whole view. If the view is visible, 11820 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 11821 * the future. 11822 * <p> 11823 * This must be called from a UI thread. To call from a non-UI thread, call 11824 * {@link #postInvalidate()}. 11825 */ 11826 public void invalidate() { 11827 invalidate(true); 11828 } 11829 11830 /** 11831 * This is where the invalidate() work actually happens. A full invalidate() 11832 * causes the drawing cache to be invalidated, but this function can be 11833 * called with invalidateCache set to false to skip that invalidation step 11834 * for cases that do not need it (for example, a component that remains at 11835 * the same dimensions with the same content). 11836 * 11837 * @param invalidateCache Whether the drawing cache for this view should be 11838 * invalidated as well. This is usually true for a full 11839 * invalidate, but may be set to false if the View's contents or 11840 * dimensions have not changed. 11841 */ 11842 void invalidate(boolean invalidateCache) { 11843 invalidateInternal(0, 0, mRight - mLeft, mBottom - mTop, invalidateCache, true); 11844 } 11845 11846 void invalidateInternal(int l, int t, int r, int b, boolean invalidateCache, 11847 boolean fullInvalidate) { 11848 if (mGhostView != null) { 11849 mGhostView.invalidate(true); 11850 return; 11851 } 11852 11853 if (skipInvalidate()) { 11854 return; 11855 } 11856 11857 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) 11858 || (invalidateCache && (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) 11859 || (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED 11860 || (fullInvalidate && isOpaque() != mLastIsOpaque)) { 11861 if (fullInvalidate) { 11862 mLastIsOpaque = isOpaque(); 11863 mPrivateFlags &= ~PFLAG_DRAWN; 11864 } 11865 11866 mPrivateFlags |= PFLAG_DIRTY; 11867 11868 if (invalidateCache) { 11869 mPrivateFlags |= PFLAG_INVALIDATED; 11870 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 11871 } 11872 11873 // Propagate the damage rectangle to the parent view. 11874 final AttachInfo ai = mAttachInfo; 11875 final ViewParent p = mParent; 11876 if (p != null && ai != null && l < r && t < b) { 11877 final Rect damage = ai.mTmpInvalRect; 11878 damage.set(l, t, r, b); 11879 p.invalidateChild(this, damage); 11880 } 11881 11882 // Damage the entire projection receiver, if necessary. 11883 if (mBackground != null && mBackground.isProjected()) { 11884 final View receiver = getProjectionReceiver(); 11885 if (receiver != null) { 11886 receiver.damageInParent(); 11887 } 11888 } 11889 11890 // Damage the entire IsolatedZVolume receiving this view's shadow. 11891 if (isHardwareAccelerated() && getZ() != 0) { 11892 damageShadowReceiver(); 11893 } 11894 } 11895 } 11896 11897 /** 11898 * @return this view's projection receiver, or {@code null} if none exists 11899 */ 11900 private View getProjectionReceiver() { 11901 ViewParent p = getParent(); 11902 while (p != null && p instanceof View) { 11903 final View v = (View) p; 11904 if (v.isProjectionReceiver()) { 11905 return v; 11906 } 11907 p = p.getParent(); 11908 } 11909 11910 return null; 11911 } 11912 11913 /** 11914 * @return whether the view is a projection receiver 11915 */ 11916 private boolean isProjectionReceiver() { 11917 return mBackground != null; 11918 } 11919 11920 /** 11921 * Damage area of the screen that can be covered by this View's shadow. 11922 * 11923 * This method will guarantee that any changes to shadows cast by a View 11924 * are damaged on the screen for future redraw. 11925 */ 11926 private void damageShadowReceiver() { 11927 final AttachInfo ai = mAttachInfo; 11928 if (ai != null) { 11929 ViewParent p = getParent(); 11930 if (p != null && p instanceof ViewGroup) { 11931 final ViewGroup vg = (ViewGroup) p; 11932 vg.damageInParent(); 11933 } 11934 } 11935 } 11936 11937 /** 11938 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to 11939 * set any flags or handle all of the cases handled by the default invalidation methods. 11940 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate 11941 * dirty rect. This method calls into fast invalidation methods in ViewGroup that 11942 * walk up the hierarchy, transforming the dirty rect as necessary. 11943 * 11944 * The method also handles normal invalidation logic if display list properties are not 11945 * being used in this view. The invalidateParent and forceRedraw flags are used by that 11946 * backup approach, to handle these cases used in the various property-setting methods. 11947 * 11948 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties 11949 * are not being used in this view 11950 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display 11951 * list properties are not being used in this view 11952 */ 11953 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) { 11954 if (!isHardwareAccelerated() 11955 || !mRenderNode.isValid() 11956 || (mPrivateFlags & PFLAG_DRAW_ANIMATION) != 0) { 11957 if (invalidateParent) { 11958 invalidateParentCaches(); 11959 } 11960 if (forceRedraw) { 11961 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 11962 } 11963 invalidate(false); 11964 } else { 11965 damageInParent(); 11966 } 11967 if (isHardwareAccelerated() && invalidateParent && getZ() != 0) { 11968 damageShadowReceiver(); 11969 } 11970 } 11971 11972 /** 11973 * Tells the parent view to damage this view's bounds. 11974 * 11975 * @hide 11976 */ 11977 protected void damageInParent() { 11978 final AttachInfo ai = mAttachInfo; 11979 final ViewParent p = mParent; 11980 if (p != null && ai != null) { 11981 final Rect r = ai.mTmpInvalRect; 11982 r.set(0, 0, mRight - mLeft, mBottom - mTop); 11983 if (mParent instanceof ViewGroup) { 11984 ((ViewGroup) mParent).damageChild(this, r); 11985 } else { 11986 mParent.invalidateChild(this, r); 11987 } 11988 } 11989 } 11990 11991 /** 11992 * Utility method to transform a given Rect by the current matrix of this view. 11993 */ 11994 void transformRect(final Rect rect) { 11995 if (!getMatrix().isIdentity()) { 11996 RectF boundingRect = mAttachInfo.mTmpTransformRect; 11997 boundingRect.set(rect); 11998 getMatrix().mapRect(boundingRect); 11999 rect.set((int) Math.floor(boundingRect.left), 12000 (int) Math.floor(boundingRect.top), 12001 (int) Math.ceil(boundingRect.right), 12002 (int) Math.ceil(boundingRect.bottom)); 12003 } 12004 } 12005 12006 /** 12007 * Used to indicate that the parent of this view should clear its caches. This functionality 12008 * is used to force the parent to rebuild its display list (when hardware-accelerated), 12009 * which is necessary when various parent-managed properties of the view change, such as 12010 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 12011 * clears the parent caches and does not causes an invalidate event. 12012 * 12013 * @hide 12014 */ 12015 protected void invalidateParentCaches() { 12016 if (mParent instanceof View) { 12017 ((View) mParent).mPrivateFlags |= PFLAG_INVALIDATED; 12018 } 12019 } 12020 12021 /** 12022 * Used to indicate that the parent of this view should be invalidated. This functionality 12023 * is used to force the parent to rebuild its display list (when hardware-accelerated), 12024 * which is necessary when various parent-managed properties of the view change, such as 12025 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 12026 * an invalidation event to the parent. 12027 * 12028 * @hide 12029 */ 12030 protected void invalidateParentIfNeeded() { 12031 if (isHardwareAccelerated() && mParent instanceof View) { 12032 ((View) mParent).invalidate(true); 12033 } 12034 } 12035 12036 /** 12037 * @hide 12038 */ 12039 protected void invalidateParentIfNeededAndWasQuickRejected() { 12040 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) != 0) { 12041 // View was rejected last time it was drawn by its parent; this may have changed 12042 invalidateParentIfNeeded(); 12043 } 12044 } 12045 12046 /** 12047 * Indicates whether this View is opaque. An opaque View guarantees that it will 12048 * draw all the pixels overlapping its bounds using a fully opaque color. 12049 * 12050 * Subclasses of View should override this method whenever possible to indicate 12051 * whether an instance is opaque. Opaque Views are treated in a special way by 12052 * the View hierarchy, possibly allowing it to perform optimizations during 12053 * invalidate/draw passes. 12054 * 12055 * @return True if this View is guaranteed to be fully opaque, false otherwise. 12056 */ 12057 @ViewDebug.ExportedProperty(category = "drawing") 12058 public boolean isOpaque() { 12059 return (mPrivateFlags & PFLAG_OPAQUE_MASK) == PFLAG_OPAQUE_MASK && 12060 getFinalAlpha() >= 1.0f; 12061 } 12062 12063 /** 12064 * @hide 12065 */ 12066 protected void computeOpaqueFlags() { 12067 // Opaque if: 12068 // - Has a background 12069 // - Background is opaque 12070 // - Doesn't have scrollbars or scrollbars overlay 12071 12072 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) { 12073 mPrivateFlags |= PFLAG_OPAQUE_BACKGROUND; 12074 } else { 12075 mPrivateFlags &= ~PFLAG_OPAQUE_BACKGROUND; 12076 } 12077 12078 final int flags = mViewFlags; 12079 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 12080 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY || 12081 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_OUTSIDE_OVERLAY) { 12082 mPrivateFlags |= PFLAG_OPAQUE_SCROLLBARS; 12083 } else { 12084 mPrivateFlags &= ~PFLAG_OPAQUE_SCROLLBARS; 12085 } 12086 } 12087 12088 /** 12089 * @hide 12090 */ 12091 protected boolean hasOpaqueScrollbars() { 12092 return (mPrivateFlags & PFLAG_OPAQUE_SCROLLBARS) == PFLAG_OPAQUE_SCROLLBARS; 12093 } 12094 12095 /** 12096 * @return A handler associated with the thread running the View. This 12097 * handler can be used to pump events in the UI events queue. 12098 */ 12099 public Handler getHandler() { 12100 final AttachInfo attachInfo = mAttachInfo; 12101 if (attachInfo != null) { 12102 return attachInfo.mHandler; 12103 } 12104 return null; 12105 } 12106 12107 /** 12108 * Gets the view root associated with the View. 12109 * @return The view root, or null if none. 12110 * @hide 12111 */ 12112 public ViewRootImpl getViewRootImpl() { 12113 if (mAttachInfo != null) { 12114 return mAttachInfo.mViewRootImpl; 12115 } 12116 return null; 12117 } 12118 12119 /** 12120 * @hide 12121 */ 12122 public HardwareRenderer getHardwareRenderer() { 12123 return mAttachInfo != null ? mAttachInfo.mHardwareRenderer : null; 12124 } 12125 12126 /** 12127 * <p>Causes the Runnable to be added to the message queue. 12128 * The runnable will be run on the user interface thread.</p> 12129 * 12130 * @param action The Runnable that will be executed. 12131 * 12132 * @return Returns true if the Runnable was successfully placed in to the 12133 * message queue. Returns false on failure, usually because the 12134 * looper processing the message queue is exiting. 12135 * 12136 * @see #postDelayed 12137 * @see #removeCallbacks 12138 */ 12139 public boolean post(Runnable action) { 12140 final AttachInfo attachInfo = mAttachInfo; 12141 if (attachInfo != null) { 12142 return attachInfo.mHandler.post(action); 12143 } 12144 // Assume that post will succeed later 12145 ViewRootImpl.getRunQueue().post(action); 12146 return true; 12147 } 12148 12149 /** 12150 * <p>Causes the Runnable to be added to the message queue, to be run 12151 * after the specified amount of time elapses. 12152 * The runnable will be run on the user interface thread.</p> 12153 * 12154 * @param action The Runnable that will be executed. 12155 * @param delayMillis The delay (in milliseconds) until the Runnable 12156 * will be executed. 12157 * 12158 * @return true if the Runnable was successfully placed in to the 12159 * message queue. Returns false on failure, usually because the 12160 * looper processing the message queue is exiting. Note that a 12161 * result of true does not mean the Runnable will be processed -- 12162 * if the looper is quit before the delivery time of the message 12163 * occurs then the message will be dropped. 12164 * 12165 * @see #post 12166 * @see #removeCallbacks 12167 */ 12168 public boolean postDelayed(Runnable action, long delayMillis) { 12169 final AttachInfo attachInfo = mAttachInfo; 12170 if (attachInfo != null) { 12171 return attachInfo.mHandler.postDelayed(action, delayMillis); 12172 } 12173 // Assume that post will succeed later 12174 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12175 return true; 12176 } 12177 12178 /** 12179 * <p>Causes the Runnable to execute on the next animation time step. 12180 * The runnable will be run on the user interface thread.</p> 12181 * 12182 * @param action The Runnable that will be executed. 12183 * 12184 * @see #postOnAnimationDelayed 12185 * @see #removeCallbacks 12186 */ 12187 public void postOnAnimation(Runnable action) { 12188 final AttachInfo attachInfo = mAttachInfo; 12189 if (attachInfo != null) { 12190 attachInfo.mViewRootImpl.mChoreographer.postCallback( 12191 Choreographer.CALLBACK_ANIMATION, action, null); 12192 } else { 12193 // Assume that post will succeed later 12194 ViewRootImpl.getRunQueue().post(action); 12195 } 12196 } 12197 12198 /** 12199 * <p>Causes the Runnable to execute on the next animation time step, 12200 * after the specified amount of time elapses. 12201 * The runnable will be run on the user interface thread.</p> 12202 * 12203 * @param action The Runnable that will be executed. 12204 * @param delayMillis The delay (in milliseconds) until the Runnable 12205 * will be executed. 12206 * 12207 * @see #postOnAnimation 12208 * @see #removeCallbacks 12209 */ 12210 public void postOnAnimationDelayed(Runnable action, long delayMillis) { 12211 final AttachInfo attachInfo = mAttachInfo; 12212 if (attachInfo != null) { 12213 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 12214 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis); 12215 } else { 12216 // Assume that post will succeed later 12217 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12218 } 12219 } 12220 12221 /** 12222 * <p>Removes the specified Runnable from the message queue.</p> 12223 * 12224 * @param action The Runnable to remove from the message handling queue 12225 * 12226 * @return true if this view could ask the Handler to remove the Runnable, 12227 * false otherwise. When the returned value is true, the Runnable 12228 * may or may not have been actually removed from the message queue 12229 * (for instance, if the Runnable was not in the queue already.) 12230 * 12231 * @see #post 12232 * @see #postDelayed 12233 * @see #postOnAnimation 12234 * @see #postOnAnimationDelayed 12235 */ 12236 public boolean removeCallbacks(Runnable action) { 12237 if (action != null) { 12238 final AttachInfo attachInfo = mAttachInfo; 12239 if (attachInfo != null) { 12240 attachInfo.mHandler.removeCallbacks(action); 12241 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 12242 Choreographer.CALLBACK_ANIMATION, action, null); 12243 } 12244 // Assume that post will succeed later 12245 ViewRootImpl.getRunQueue().removeCallbacks(action); 12246 } 12247 return true; 12248 } 12249 12250 /** 12251 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 12252 * Use this to invalidate the View from a non-UI thread.</p> 12253 * 12254 * <p>This method can be invoked from outside of the UI thread 12255 * only when this View is attached to a window.</p> 12256 * 12257 * @see #invalidate() 12258 * @see #postInvalidateDelayed(long) 12259 */ 12260 public void postInvalidate() { 12261 postInvalidateDelayed(0); 12262 } 12263 12264 /** 12265 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12266 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 12267 * 12268 * <p>This method can be invoked from outside of the UI thread 12269 * only when this View is attached to a window.</p> 12270 * 12271 * @param left The left coordinate of the rectangle to invalidate. 12272 * @param top The top coordinate of the rectangle to invalidate. 12273 * @param right The right coordinate of the rectangle to invalidate. 12274 * @param bottom The bottom coordinate of the rectangle to invalidate. 12275 * 12276 * @see #invalidate(int, int, int, int) 12277 * @see #invalidate(Rect) 12278 * @see #postInvalidateDelayed(long, int, int, int, int) 12279 */ 12280 public void postInvalidate(int left, int top, int right, int bottom) { 12281 postInvalidateDelayed(0, left, top, right, bottom); 12282 } 12283 12284 /** 12285 * <p>Cause an invalidate to happen on a subsequent cycle through the event 12286 * loop. Waits for the specified amount of time.</p> 12287 * 12288 * <p>This method can be invoked from outside of the UI thread 12289 * only when this View is attached to a window.</p> 12290 * 12291 * @param delayMilliseconds the duration in milliseconds to delay the 12292 * invalidation by 12293 * 12294 * @see #invalidate() 12295 * @see #postInvalidate() 12296 */ 12297 public void postInvalidateDelayed(long delayMilliseconds) { 12298 // We try only with the AttachInfo because there's no point in invalidating 12299 // if we are not attached to our window 12300 final AttachInfo attachInfo = mAttachInfo; 12301 if (attachInfo != null) { 12302 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds); 12303 } 12304 } 12305 12306 /** 12307 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12308 * through the event loop. Waits for the specified amount of time.</p> 12309 * 12310 * <p>This method can be invoked from outside of the UI thread 12311 * only when this View is attached to a window.</p> 12312 * 12313 * @param delayMilliseconds the duration in milliseconds to delay the 12314 * invalidation by 12315 * @param left The left coordinate of the rectangle to invalidate. 12316 * @param top The top coordinate of the rectangle to invalidate. 12317 * @param right The right coordinate of the rectangle to invalidate. 12318 * @param bottom The bottom coordinate of the rectangle to invalidate. 12319 * 12320 * @see #invalidate(int, int, int, int) 12321 * @see #invalidate(Rect) 12322 * @see #postInvalidate(int, int, int, int) 12323 */ 12324 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 12325 int right, int bottom) { 12326 12327 // We try only with the AttachInfo because there's no point in invalidating 12328 // if we are not attached to our window 12329 final AttachInfo attachInfo = mAttachInfo; 12330 if (attachInfo != null) { 12331 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12332 info.target = this; 12333 info.left = left; 12334 info.top = top; 12335 info.right = right; 12336 info.bottom = bottom; 12337 12338 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds); 12339 } 12340 } 12341 12342 /** 12343 * <p>Cause an invalidate to happen on the next animation time step, typically the 12344 * next display frame.</p> 12345 * 12346 * <p>This method can be invoked from outside of the UI thread 12347 * only when this View is attached to a window.</p> 12348 * 12349 * @see #invalidate() 12350 */ 12351 public void postInvalidateOnAnimation() { 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 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this); 12357 } 12358 } 12359 12360 /** 12361 * <p>Cause an invalidate of the specified area to happen on the next animation 12362 * time step, typically the next display frame.</p> 12363 * 12364 * <p>This method can be invoked from outside of the UI thread 12365 * only when this View is attached to a window.</p> 12366 * 12367 * @param left The left coordinate of the rectangle to invalidate. 12368 * @param top The top coordinate of the rectangle to invalidate. 12369 * @param right The right coordinate of the rectangle to invalidate. 12370 * @param bottom The bottom coordinate of the rectangle to invalidate. 12371 * 12372 * @see #invalidate(int, int, int, int) 12373 * @see #invalidate(Rect) 12374 */ 12375 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) { 12376 // We try only with the AttachInfo because there's no point in invalidating 12377 // if we are not attached to our window 12378 final AttachInfo attachInfo = mAttachInfo; 12379 if (attachInfo != null) { 12380 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12381 info.target = this; 12382 info.left = left; 12383 info.top = top; 12384 info.right = right; 12385 info.bottom = bottom; 12386 12387 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info); 12388 } 12389 } 12390 12391 /** 12392 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 12393 * This event is sent at most once every 12394 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 12395 */ 12396 private void postSendViewScrolledAccessibilityEventCallback() { 12397 if (mSendViewScrolledAccessibilityEvent == null) { 12398 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 12399 } 12400 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 12401 mSendViewScrolledAccessibilityEvent.mIsPending = true; 12402 postDelayed(mSendViewScrolledAccessibilityEvent, 12403 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 12404 } 12405 } 12406 12407 /** 12408 * Called by a parent to request that a child update its values for mScrollX 12409 * and mScrollY if necessary. This will typically be done if the child is 12410 * animating a scroll using a {@link android.widget.Scroller Scroller} 12411 * object. 12412 */ 12413 public void computeScroll() { 12414 } 12415 12416 /** 12417 * <p>Indicate whether the horizontal edges are faded when the view is 12418 * scrolled horizontally.</p> 12419 * 12420 * @return true if the horizontal edges should are faded on scroll, false 12421 * otherwise 12422 * 12423 * @see #setHorizontalFadingEdgeEnabled(boolean) 12424 * 12425 * @attr ref android.R.styleable#View_requiresFadingEdge 12426 */ 12427 public boolean isHorizontalFadingEdgeEnabled() { 12428 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 12429 } 12430 12431 /** 12432 * <p>Define whether the horizontal edges should be faded when this view 12433 * is scrolled horizontally.</p> 12434 * 12435 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 12436 * be faded when the view is scrolled 12437 * horizontally 12438 * 12439 * @see #isHorizontalFadingEdgeEnabled() 12440 * 12441 * @attr ref android.R.styleable#View_requiresFadingEdge 12442 */ 12443 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 12444 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 12445 if (horizontalFadingEdgeEnabled) { 12446 initScrollCache(); 12447 } 12448 12449 mViewFlags ^= FADING_EDGE_HORIZONTAL; 12450 } 12451 } 12452 12453 /** 12454 * <p>Indicate whether the vertical edges are faded when the view is 12455 * scrolled horizontally.</p> 12456 * 12457 * @return true if the vertical edges should are faded on scroll, false 12458 * otherwise 12459 * 12460 * @see #setVerticalFadingEdgeEnabled(boolean) 12461 * 12462 * @attr ref android.R.styleable#View_requiresFadingEdge 12463 */ 12464 public boolean isVerticalFadingEdgeEnabled() { 12465 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 12466 } 12467 12468 /** 12469 * <p>Define whether the vertical edges should be faded when this view 12470 * is scrolled vertically.</p> 12471 * 12472 * @param verticalFadingEdgeEnabled true if the vertical edges should 12473 * be faded when the view is scrolled 12474 * vertically 12475 * 12476 * @see #isVerticalFadingEdgeEnabled() 12477 * 12478 * @attr ref android.R.styleable#View_requiresFadingEdge 12479 */ 12480 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 12481 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 12482 if (verticalFadingEdgeEnabled) { 12483 initScrollCache(); 12484 } 12485 12486 mViewFlags ^= FADING_EDGE_VERTICAL; 12487 } 12488 } 12489 12490 /** 12491 * Returns the strength, or intensity, of the top faded edge. The strength is 12492 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12493 * returns 0.0 or 1.0 but no value in between. 12494 * 12495 * Subclasses should override this method to provide a smoother fade transition 12496 * when scrolling occurs. 12497 * 12498 * @return the intensity of the top fade as a float between 0.0f and 1.0f 12499 */ 12500 protected float getTopFadingEdgeStrength() { 12501 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 12502 } 12503 12504 /** 12505 * Returns the strength, or intensity, of the bottom faded edge. The strength is 12506 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12507 * returns 0.0 or 1.0 but no value in between. 12508 * 12509 * Subclasses should override this method to provide a smoother fade transition 12510 * when scrolling occurs. 12511 * 12512 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 12513 */ 12514 protected float getBottomFadingEdgeStrength() { 12515 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 12516 computeVerticalScrollRange() ? 1.0f : 0.0f; 12517 } 12518 12519 /** 12520 * Returns the strength, or intensity, of the left faded edge. The strength is 12521 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12522 * returns 0.0 or 1.0 but no value in between. 12523 * 12524 * Subclasses should override this method to provide a smoother fade transition 12525 * when scrolling occurs. 12526 * 12527 * @return the intensity of the left fade as a float between 0.0f and 1.0f 12528 */ 12529 protected float getLeftFadingEdgeStrength() { 12530 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 12531 } 12532 12533 /** 12534 * Returns the strength, or intensity, of the right faded edge. The strength is 12535 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12536 * returns 0.0 or 1.0 but no value in between. 12537 * 12538 * Subclasses should override this method to provide a smoother fade transition 12539 * when scrolling occurs. 12540 * 12541 * @return the intensity of the right fade as a float between 0.0f and 1.0f 12542 */ 12543 protected float getRightFadingEdgeStrength() { 12544 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 12545 computeHorizontalScrollRange() ? 1.0f : 0.0f; 12546 } 12547 12548 /** 12549 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 12550 * scrollbar is not drawn by default.</p> 12551 * 12552 * @return true if the horizontal scrollbar should be painted, false 12553 * otherwise 12554 * 12555 * @see #setHorizontalScrollBarEnabled(boolean) 12556 */ 12557 public boolean isHorizontalScrollBarEnabled() { 12558 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12559 } 12560 12561 /** 12562 * <p>Define whether the horizontal scrollbar should be drawn or not. The 12563 * scrollbar is not drawn by default.</p> 12564 * 12565 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 12566 * be painted 12567 * 12568 * @see #isHorizontalScrollBarEnabled() 12569 */ 12570 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 12571 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 12572 mViewFlags ^= SCROLLBARS_HORIZONTAL; 12573 computeOpaqueFlags(); 12574 resolvePadding(); 12575 } 12576 } 12577 12578 /** 12579 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 12580 * scrollbar is not drawn by default.</p> 12581 * 12582 * @return true if the vertical scrollbar should be painted, false 12583 * otherwise 12584 * 12585 * @see #setVerticalScrollBarEnabled(boolean) 12586 */ 12587 public boolean isVerticalScrollBarEnabled() { 12588 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 12589 } 12590 12591 /** 12592 * <p>Define whether the vertical scrollbar should be drawn or not. The 12593 * scrollbar is not drawn by default.</p> 12594 * 12595 * @param verticalScrollBarEnabled true if the vertical scrollbar should 12596 * be painted 12597 * 12598 * @see #isVerticalScrollBarEnabled() 12599 */ 12600 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 12601 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 12602 mViewFlags ^= SCROLLBARS_VERTICAL; 12603 computeOpaqueFlags(); 12604 resolvePadding(); 12605 } 12606 } 12607 12608 /** 12609 * @hide 12610 */ 12611 protected void recomputePadding() { 12612 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 12613 } 12614 12615 /** 12616 * Define whether scrollbars will fade when the view is not scrolling. 12617 * 12618 * @param fadeScrollbars wheter to enable fading 12619 * 12620 * @attr ref android.R.styleable#View_fadeScrollbars 12621 */ 12622 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 12623 initScrollCache(); 12624 final ScrollabilityCache scrollabilityCache = mScrollCache; 12625 scrollabilityCache.fadeScrollBars = fadeScrollbars; 12626 if (fadeScrollbars) { 12627 scrollabilityCache.state = ScrollabilityCache.OFF; 12628 } else { 12629 scrollabilityCache.state = ScrollabilityCache.ON; 12630 } 12631 } 12632 12633 /** 12634 * 12635 * Returns true if scrollbars will fade when this view is not scrolling 12636 * 12637 * @return true if scrollbar fading is enabled 12638 * 12639 * @attr ref android.R.styleable#View_fadeScrollbars 12640 */ 12641 public boolean isScrollbarFadingEnabled() { 12642 return mScrollCache != null && mScrollCache.fadeScrollBars; 12643 } 12644 12645 /** 12646 * 12647 * Returns the delay before scrollbars fade. 12648 * 12649 * @return the delay before scrollbars fade 12650 * 12651 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12652 */ 12653 public int getScrollBarDefaultDelayBeforeFade() { 12654 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() : 12655 mScrollCache.scrollBarDefaultDelayBeforeFade; 12656 } 12657 12658 /** 12659 * Define the delay before scrollbars fade. 12660 * 12661 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade 12662 * 12663 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12664 */ 12665 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) { 12666 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade; 12667 } 12668 12669 /** 12670 * 12671 * Returns the scrollbar fade duration. 12672 * 12673 * @return the scrollbar fade duration 12674 * 12675 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12676 */ 12677 public int getScrollBarFadeDuration() { 12678 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() : 12679 mScrollCache.scrollBarFadeDuration; 12680 } 12681 12682 /** 12683 * Define the scrollbar fade duration. 12684 * 12685 * @param scrollBarFadeDuration - the scrollbar fade duration 12686 * 12687 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12688 */ 12689 public void setScrollBarFadeDuration(int scrollBarFadeDuration) { 12690 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration; 12691 } 12692 12693 /** 12694 * 12695 * Returns the scrollbar size. 12696 * 12697 * @return the scrollbar size 12698 * 12699 * @attr ref android.R.styleable#View_scrollbarSize 12700 */ 12701 public int getScrollBarSize() { 12702 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() : 12703 mScrollCache.scrollBarSize; 12704 } 12705 12706 /** 12707 * Define the scrollbar size. 12708 * 12709 * @param scrollBarSize - the scrollbar size 12710 * 12711 * @attr ref android.R.styleable#View_scrollbarSize 12712 */ 12713 public void setScrollBarSize(int scrollBarSize) { 12714 getScrollCache().scrollBarSize = scrollBarSize; 12715 } 12716 12717 /** 12718 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 12719 * inset. When inset, they add to the padding of the view. And the scrollbars 12720 * can be drawn inside the padding area or on the edge of the view. For example, 12721 * if a view has a background drawable and you want to draw the scrollbars 12722 * inside the padding specified by the drawable, you can use 12723 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 12724 * appear at the edge of the view, ignoring the padding, then you can use 12725 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 12726 * @param style the style of the scrollbars. Should be one of 12727 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 12728 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 12729 * @see #SCROLLBARS_INSIDE_OVERLAY 12730 * @see #SCROLLBARS_INSIDE_INSET 12731 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12732 * @see #SCROLLBARS_OUTSIDE_INSET 12733 * 12734 * @attr ref android.R.styleable#View_scrollbarStyle 12735 */ 12736 public void setScrollBarStyle(@ScrollBarStyle int style) { 12737 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 12738 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 12739 computeOpaqueFlags(); 12740 resolvePadding(); 12741 } 12742 } 12743 12744 /** 12745 * <p>Returns the current scrollbar style.</p> 12746 * @return the current scrollbar style 12747 * @see #SCROLLBARS_INSIDE_OVERLAY 12748 * @see #SCROLLBARS_INSIDE_INSET 12749 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12750 * @see #SCROLLBARS_OUTSIDE_INSET 12751 * 12752 * @attr ref android.R.styleable#View_scrollbarStyle 12753 */ 12754 @ViewDebug.ExportedProperty(mapping = { 12755 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 12756 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 12757 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 12758 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 12759 }) 12760 @ScrollBarStyle 12761 public int getScrollBarStyle() { 12762 return mViewFlags & SCROLLBARS_STYLE_MASK; 12763 } 12764 12765 /** 12766 * <p>Compute the horizontal range that the horizontal scrollbar 12767 * represents.</p> 12768 * 12769 * <p>The range is expressed in arbitrary units that must be the same as the 12770 * units used by {@link #computeHorizontalScrollExtent()} and 12771 * {@link #computeHorizontalScrollOffset()}.</p> 12772 * 12773 * <p>The default range is the drawing width of this view.</p> 12774 * 12775 * @return the total horizontal range represented by the horizontal 12776 * scrollbar 12777 * 12778 * @see #computeHorizontalScrollExtent() 12779 * @see #computeHorizontalScrollOffset() 12780 * @see android.widget.ScrollBarDrawable 12781 */ 12782 protected int computeHorizontalScrollRange() { 12783 return getWidth(); 12784 } 12785 12786 /** 12787 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 12788 * within the horizontal range. This value is used to compute the position 12789 * of the thumb within the scrollbar's track.</p> 12790 * 12791 * <p>The range is expressed in arbitrary units that must be the same as the 12792 * units used by {@link #computeHorizontalScrollRange()} and 12793 * {@link #computeHorizontalScrollExtent()}.</p> 12794 * 12795 * <p>The default offset is the scroll offset of this view.</p> 12796 * 12797 * @return the horizontal offset of the scrollbar's thumb 12798 * 12799 * @see #computeHorizontalScrollRange() 12800 * @see #computeHorizontalScrollExtent() 12801 * @see android.widget.ScrollBarDrawable 12802 */ 12803 protected int computeHorizontalScrollOffset() { 12804 return mScrollX; 12805 } 12806 12807 /** 12808 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 12809 * within the horizontal range. This value is used to compute the length 12810 * of the thumb within the scrollbar's track.</p> 12811 * 12812 * <p>The range is expressed in arbitrary units that must be the same as the 12813 * units used by {@link #computeHorizontalScrollRange()} and 12814 * {@link #computeHorizontalScrollOffset()}.</p> 12815 * 12816 * <p>The default extent is the drawing width of this view.</p> 12817 * 12818 * @return the horizontal extent of the scrollbar's thumb 12819 * 12820 * @see #computeHorizontalScrollRange() 12821 * @see #computeHorizontalScrollOffset() 12822 * @see android.widget.ScrollBarDrawable 12823 */ 12824 protected int computeHorizontalScrollExtent() { 12825 return getWidth(); 12826 } 12827 12828 /** 12829 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 12830 * 12831 * <p>The range is expressed in arbitrary units that must be the same as the 12832 * units used by {@link #computeVerticalScrollExtent()} and 12833 * {@link #computeVerticalScrollOffset()}.</p> 12834 * 12835 * @return the total vertical range represented by the vertical scrollbar 12836 * 12837 * <p>The default range is the drawing height of this view.</p> 12838 * 12839 * @see #computeVerticalScrollExtent() 12840 * @see #computeVerticalScrollOffset() 12841 * @see android.widget.ScrollBarDrawable 12842 */ 12843 protected int computeVerticalScrollRange() { 12844 return getHeight(); 12845 } 12846 12847 /** 12848 * <p>Compute the vertical offset of the vertical scrollbar's thumb 12849 * within the horizontal range. This value is used to compute the position 12850 * of the thumb within the scrollbar's track.</p> 12851 * 12852 * <p>The range is expressed in arbitrary units that must be the same as the 12853 * units used by {@link #computeVerticalScrollRange()} and 12854 * {@link #computeVerticalScrollExtent()}.</p> 12855 * 12856 * <p>The default offset is the scroll offset of this view.</p> 12857 * 12858 * @return the vertical offset of the scrollbar's thumb 12859 * 12860 * @see #computeVerticalScrollRange() 12861 * @see #computeVerticalScrollExtent() 12862 * @see android.widget.ScrollBarDrawable 12863 */ 12864 protected int computeVerticalScrollOffset() { 12865 return mScrollY; 12866 } 12867 12868 /** 12869 * <p>Compute the vertical extent of the vertical scrollbar's thumb 12870 * within the vertical range. This value is used to compute the length 12871 * of the thumb within the scrollbar's track.</p> 12872 * 12873 * <p>The range is expressed in arbitrary units that must be the same as the 12874 * units used by {@link #computeVerticalScrollRange()} and 12875 * {@link #computeVerticalScrollOffset()}.</p> 12876 * 12877 * <p>The default extent is the drawing height of this view.</p> 12878 * 12879 * @return the vertical extent of the scrollbar's thumb 12880 * 12881 * @see #computeVerticalScrollRange() 12882 * @see #computeVerticalScrollOffset() 12883 * @see android.widget.ScrollBarDrawable 12884 */ 12885 protected int computeVerticalScrollExtent() { 12886 return getHeight(); 12887 } 12888 12889 /** 12890 * Check if this view can be scrolled horizontally in a certain direction. 12891 * 12892 * @param direction Negative to check scrolling left, positive to check scrolling right. 12893 * @return true if this view can be scrolled in the specified direction, false otherwise. 12894 */ 12895 public boolean canScrollHorizontally(int direction) { 12896 final int offset = computeHorizontalScrollOffset(); 12897 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 12898 if (range == 0) return false; 12899 if (direction < 0) { 12900 return offset > 0; 12901 } else { 12902 return offset < range - 1; 12903 } 12904 } 12905 12906 /** 12907 * Check if this view can be scrolled vertically in a certain direction. 12908 * 12909 * @param direction Negative to check scrolling up, positive to check scrolling down. 12910 * @return true if this view can be scrolled in the specified direction, false otherwise. 12911 */ 12912 public boolean canScrollVertically(int direction) { 12913 final int offset = computeVerticalScrollOffset(); 12914 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 12915 if (range == 0) return false; 12916 if (direction < 0) { 12917 return offset > 0; 12918 } else { 12919 return offset < range - 1; 12920 } 12921 } 12922 12923 /** 12924 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 12925 * scrollbars are painted only if they have been awakened first.</p> 12926 * 12927 * @param canvas the canvas on which to draw the scrollbars 12928 * 12929 * @see #awakenScrollBars(int) 12930 */ 12931 protected final void onDrawScrollBars(Canvas canvas) { 12932 // scrollbars are drawn only when the animation is running 12933 final ScrollabilityCache cache = mScrollCache; 12934 if (cache != null) { 12935 12936 int state = cache.state; 12937 12938 if (state == ScrollabilityCache.OFF) { 12939 return; 12940 } 12941 12942 boolean invalidate = false; 12943 12944 if (state == ScrollabilityCache.FADING) { 12945 // We're fading -- get our fade interpolation 12946 if (cache.interpolatorValues == null) { 12947 cache.interpolatorValues = new float[1]; 12948 } 12949 12950 float[] values = cache.interpolatorValues; 12951 12952 // Stops the animation if we're done 12953 if (cache.scrollBarInterpolator.timeToValues(values) == 12954 Interpolator.Result.FREEZE_END) { 12955 cache.state = ScrollabilityCache.OFF; 12956 } else { 12957 cache.scrollBar.setAlpha(Math.round(values[0])); 12958 } 12959 12960 // This will make the scroll bars inval themselves after 12961 // drawing. We only want this when we're fading so that 12962 // we prevent excessive redraws 12963 invalidate = true; 12964 } else { 12965 // We're just on -- but we may have been fading before so 12966 // reset alpha 12967 cache.scrollBar.setAlpha(255); 12968 } 12969 12970 12971 final int viewFlags = mViewFlags; 12972 12973 final boolean drawHorizontalScrollBar = 12974 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12975 final boolean drawVerticalScrollBar = 12976 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 12977 && !isVerticalScrollBarHidden(); 12978 12979 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 12980 final int width = mRight - mLeft; 12981 final int height = mBottom - mTop; 12982 12983 final ScrollBarDrawable scrollBar = cache.scrollBar; 12984 12985 final int scrollX = mScrollX; 12986 final int scrollY = mScrollY; 12987 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 12988 12989 int left; 12990 int top; 12991 int right; 12992 int bottom; 12993 12994 if (drawHorizontalScrollBar) { 12995 int size = scrollBar.getSize(false); 12996 if (size <= 0) { 12997 size = cache.scrollBarSize; 12998 } 12999 13000 scrollBar.setParameters(computeHorizontalScrollRange(), 13001 computeHorizontalScrollOffset(), 13002 computeHorizontalScrollExtent(), false); 13003 final int verticalScrollBarGap = drawVerticalScrollBar ? 13004 getVerticalScrollbarWidth() : 0; 13005 top = scrollY + height - size - (mUserPaddingBottom & inside); 13006 left = scrollX + (mPaddingLeft & inside); 13007 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 13008 bottom = top + size; 13009 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 13010 if (invalidate) { 13011 invalidate(left, top, right, bottom); 13012 } 13013 } 13014 13015 if (drawVerticalScrollBar) { 13016 int size = scrollBar.getSize(true); 13017 if (size <= 0) { 13018 size = cache.scrollBarSize; 13019 } 13020 13021 scrollBar.setParameters(computeVerticalScrollRange(), 13022 computeVerticalScrollOffset(), 13023 computeVerticalScrollExtent(), true); 13024 int verticalScrollbarPosition = mVerticalScrollbarPosition; 13025 if (verticalScrollbarPosition == SCROLLBAR_POSITION_DEFAULT) { 13026 verticalScrollbarPosition = isLayoutRtl() ? 13027 SCROLLBAR_POSITION_LEFT : SCROLLBAR_POSITION_RIGHT; 13028 } 13029 switch (verticalScrollbarPosition) { 13030 default: 13031 case SCROLLBAR_POSITION_RIGHT: 13032 left = scrollX + width - size - (mUserPaddingRight & inside); 13033 break; 13034 case SCROLLBAR_POSITION_LEFT: 13035 left = scrollX + (mUserPaddingLeft & inside); 13036 break; 13037 } 13038 top = scrollY + (mPaddingTop & inside); 13039 right = left + size; 13040 bottom = scrollY + height - (mUserPaddingBottom & inside); 13041 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 13042 if (invalidate) { 13043 invalidate(left, top, right, bottom); 13044 } 13045 } 13046 } 13047 } 13048 } 13049 13050 /** 13051 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 13052 * FastScroller is visible. 13053 * @return whether to temporarily hide the vertical scrollbar 13054 * @hide 13055 */ 13056 protected boolean isVerticalScrollBarHidden() { 13057 return false; 13058 } 13059 13060 /** 13061 * <p>Draw the horizontal scrollbar if 13062 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 13063 * 13064 * @param canvas the canvas on which to draw the scrollbar 13065 * @param scrollBar the scrollbar's drawable 13066 * 13067 * @see #isHorizontalScrollBarEnabled() 13068 * @see #computeHorizontalScrollRange() 13069 * @see #computeHorizontalScrollExtent() 13070 * @see #computeHorizontalScrollOffset() 13071 * @see android.widget.ScrollBarDrawable 13072 * @hide 13073 */ 13074 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 13075 int l, int t, int r, int b) { 13076 scrollBar.setBounds(l, t, r, b); 13077 scrollBar.draw(canvas); 13078 } 13079 13080 /** 13081 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 13082 * returns true.</p> 13083 * 13084 * @param canvas the canvas on which to draw the scrollbar 13085 * @param scrollBar the scrollbar's drawable 13086 * 13087 * @see #isVerticalScrollBarEnabled() 13088 * @see #computeVerticalScrollRange() 13089 * @see #computeVerticalScrollExtent() 13090 * @see #computeVerticalScrollOffset() 13091 * @see android.widget.ScrollBarDrawable 13092 * @hide 13093 */ 13094 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 13095 int l, int t, int r, int b) { 13096 scrollBar.setBounds(l, t, r, b); 13097 scrollBar.draw(canvas); 13098 } 13099 13100 /** 13101 * Implement this to do your drawing. 13102 * 13103 * @param canvas the canvas on which the background will be drawn 13104 */ 13105 protected void onDraw(Canvas canvas) { 13106 } 13107 13108 /* 13109 * Caller is responsible for calling requestLayout if necessary. 13110 * (This allows addViewInLayout to not request a new layout.) 13111 */ 13112 void assignParent(ViewParent parent) { 13113 if (mParent == null) { 13114 mParent = parent; 13115 } else if (parent == null) { 13116 mParent = null; 13117 } else { 13118 throw new RuntimeException("view " + this + " being added, but" 13119 + " it already has a parent"); 13120 } 13121 } 13122 13123 /** 13124 * This is called when the view is attached to a window. At this point it 13125 * has a Surface and will start drawing. Note that this function is 13126 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 13127 * however it may be called any time before the first onDraw -- including 13128 * before or after {@link #onMeasure(int, int)}. 13129 * 13130 * @see #onDetachedFromWindow() 13131 */ 13132 protected void onAttachedToWindow() { 13133 if ((mPrivateFlags & PFLAG_REQUEST_TRANSPARENT_REGIONS) != 0) { 13134 mParent.requestTransparentRegion(this); 13135 } 13136 13137 if ((mPrivateFlags & PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 13138 initialAwakenScrollBars(); 13139 mPrivateFlags &= ~PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 13140 } 13141 13142 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13143 13144 jumpDrawablesToCurrentState(); 13145 13146 resetSubtreeAccessibilityStateChanged(); 13147 13148 // rebuild, since Outline not maintained while View is detached 13149 rebuildOutline(); 13150 13151 if (isFocused()) { 13152 InputMethodManager imm = InputMethodManager.peekInstance(); 13153 imm.focusIn(this); 13154 } 13155 } 13156 13157 /** 13158 * Resolve all RTL related properties. 13159 * 13160 * @return true if resolution of RTL properties has been done 13161 * 13162 * @hide 13163 */ 13164 public boolean resolveRtlPropertiesIfNeeded() { 13165 if (!needRtlPropertiesResolution()) return false; 13166 13167 // Order is important here: LayoutDirection MUST be resolved first 13168 if (!isLayoutDirectionResolved()) { 13169 resolveLayoutDirection(); 13170 resolveLayoutParams(); 13171 } 13172 // ... then we can resolve the others properties depending on the resolved LayoutDirection. 13173 if (!isTextDirectionResolved()) { 13174 resolveTextDirection(); 13175 } 13176 if (!isTextAlignmentResolved()) { 13177 resolveTextAlignment(); 13178 } 13179 // Should resolve Drawables before Padding because we need the layout direction of the 13180 // Drawable to correctly resolve Padding. 13181 if (!areDrawablesResolved()) { 13182 resolveDrawables(); 13183 } 13184 if (!isPaddingResolved()) { 13185 resolvePadding(); 13186 } 13187 onRtlPropertiesChanged(getLayoutDirection()); 13188 return true; 13189 } 13190 13191 /** 13192 * Reset resolution of all RTL related properties. 13193 * 13194 * @hide 13195 */ 13196 public void resetRtlProperties() { 13197 resetResolvedLayoutDirection(); 13198 resetResolvedTextDirection(); 13199 resetResolvedTextAlignment(); 13200 resetResolvedPadding(); 13201 resetResolvedDrawables(); 13202 } 13203 13204 /** 13205 * @see #onScreenStateChanged(int) 13206 */ 13207 void dispatchScreenStateChanged(int screenState) { 13208 onScreenStateChanged(screenState); 13209 } 13210 13211 /** 13212 * This method is called whenever the state of the screen this view is 13213 * attached to changes. A state change will usually occurs when the screen 13214 * turns on or off (whether it happens automatically or the user does it 13215 * manually.) 13216 * 13217 * @param screenState The new state of the screen. Can be either 13218 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF} 13219 */ 13220 public void onScreenStateChanged(int screenState) { 13221 } 13222 13223 /** 13224 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true 13225 */ 13226 private boolean hasRtlSupport() { 13227 return mContext.getApplicationInfo().hasRtlSupport(); 13228 } 13229 13230 /** 13231 * Return true if we are in RTL compatibility mode (either before Jelly Bean MR1 or 13232 * RTL not supported) 13233 */ 13234 private boolean isRtlCompatibilityMode() { 13235 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 13236 return targetSdkVersion < JELLY_BEAN_MR1 || !hasRtlSupport(); 13237 } 13238 13239 /** 13240 * @return true if RTL properties need resolution. 13241 * 13242 */ 13243 private boolean needRtlPropertiesResolution() { 13244 return (mPrivateFlags2 & ALL_RTL_PROPERTIES_RESOLVED) != ALL_RTL_PROPERTIES_RESOLVED; 13245 } 13246 13247 /** 13248 * Called when any RTL property (layout direction or text direction or text alignment) has 13249 * been changed. 13250 * 13251 * Subclasses need to override this method to take care of cached information that depends on the 13252 * resolved layout direction, or to inform child views that inherit their layout direction. 13253 * 13254 * The default implementation does nothing. 13255 * 13256 * @param layoutDirection the direction of the layout 13257 * 13258 * @see #LAYOUT_DIRECTION_LTR 13259 * @see #LAYOUT_DIRECTION_RTL 13260 */ 13261 public void onRtlPropertiesChanged(@ResolvedLayoutDir int layoutDirection) { 13262 } 13263 13264 /** 13265 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 13266 * that the parent directionality can and will be resolved before its children. 13267 * 13268 * @return true if resolution has been done, false otherwise. 13269 * 13270 * @hide 13271 */ 13272 public boolean resolveLayoutDirection() { 13273 // Clear any previous layout direction resolution 13274 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13275 13276 if (hasRtlSupport()) { 13277 // Set resolved depending on layout direction 13278 switch ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> 13279 PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) { 13280 case LAYOUT_DIRECTION_INHERIT: 13281 // We cannot resolve yet. LTR is by default and let the resolution happen again 13282 // later to get the correct resolved value 13283 if (!canResolveLayoutDirection()) return false; 13284 13285 // Parent has not yet resolved, LTR is still the default 13286 try { 13287 if (!mParent.isLayoutDirectionResolved()) return false; 13288 13289 if (mParent.getLayoutDirection() == LAYOUT_DIRECTION_RTL) { 13290 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13291 } 13292 } catch (AbstractMethodError e) { 13293 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13294 " does not fully implement ViewParent", e); 13295 } 13296 break; 13297 case LAYOUT_DIRECTION_RTL: 13298 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13299 break; 13300 case LAYOUT_DIRECTION_LOCALE: 13301 if((LAYOUT_DIRECTION_RTL == 13302 TextUtils.getLayoutDirectionFromLocale(Locale.getDefault()))) { 13303 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13304 } 13305 break; 13306 default: 13307 // Nothing to do, LTR by default 13308 } 13309 } 13310 13311 // Set to resolved 13312 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13313 return true; 13314 } 13315 13316 /** 13317 * Check if layout direction resolution can be done. 13318 * 13319 * @return true if layout direction resolution can be done otherwise return false. 13320 */ 13321 public boolean canResolveLayoutDirection() { 13322 switch (getRawLayoutDirection()) { 13323 case LAYOUT_DIRECTION_INHERIT: 13324 if (mParent != null) { 13325 try { 13326 return mParent.canResolveLayoutDirection(); 13327 } catch (AbstractMethodError e) { 13328 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13329 " does not fully implement ViewParent", e); 13330 } 13331 } 13332 return false; 13333 13334 default: 13335 return true; 13336 } 13337 } 13338 13339 /** 13340 * Reset the resolved layout direction. Layout direction will be resolved during a call to 13341 * {@link #onMeasure(int, int)}. 13342 * 13343 * @hide 13344 */ 13345 public void resetResolvedLayoutDirection() { 13346 // Reset the current resolved bits 13347 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13348 } 13349 13350 /** 13351 * @return true if the layout direction is inherited. 13352 * 13353 * @hide 13354 */ 13355 public boolean isLayoutDirectionInherited() { 13356 return (getRawLayoutDirection() == LAYOUT_DIRECTION_INHERIT); 13357 } 13358 13359 /** 13360 * @return true if layout direction has been resolved. 13361 */ 13362 public boolean isLayoutDirectionResolved() { 13363 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED) == PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13364 } 13365 13366 /** 13367 * Return if padding has been resolved 13368 * 13369 * @hide 13370 */ 13371 boolean isPaddingResolved() { 13372 return (mPrivateFlags2 & PFLAG2_PADDING_RESOLVED) == PFLAG2_PADDING_RESOLVED; 13373 } 13374 13375 /** 13376 * Resolves padding depending on layout direction, if applicable, and 13377 * recomputes internal padding values to adjust for scroll bars. 13378 * 13379 * @hide 13380 */ 13381 public void resolvePadding() { 13382 final int resolvedLayoutDirection = getLayoutDirection(); 13383 13384 if (!isRtlCompatibilityMode()) { 13385 // Post Jelly Bean MR1 case: we need to take the resolved layout direction into account. 13386 // If start / end padding are defined, they will be resolved (hence overriding) to 13387 // left / right or right / left depending on the resolved layout direction. 13388 // If start / end padding are not defined, use the left / right ones. 13389 if (mBackground != null && (!mLeftPaddingDefined || !mRightPaddingDefined)) { 13390 Rect padding = sThreadLocal.get(); 13391 if (padding == null) { 13392 padding = new Rect(); 13393 sThreadLocal.set(padding); 13394 } 13395 mBackground.getPadding(padding); 13396 if (!mLeftPaddingDefined) { 13397 mUserPaddingLeftInitial = padding.left; 13398 } 13399 if (!mRightPaddingDefined) { 13400 mUserPaddingRightInitial = padding.right; 13401 } 13402 } 13403 switch (resolvedLayoutDirection) { 13404 case LAYOUT_DIRECTION_RTL: 13405 if (mUserPaddingStart != UNDEFINED_PADDING) { 13406 mUserPaddingRight = mUserPaddingStart; 13407 } else { 13408 mUserPaddingRight = mUserPaddingRightInitial; 13409 } 13410 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13411 mUserPaddingLeft = mUserPaddingEnd; 13412 } else { 13413 mUserPaddingLeft = mUserPaddingLeftInitial; 13414 } 13415 break; 13416 case LAYOUT_DIRECTION_LTR: 13417 default: 13418 if (mUserPaddingStart != UNDEFINED_PADDING) { 13419 mUserPaddingLeft = mUserPaddingStart; 13420 } else { 13421 mUserPaddingLeft = mUserPaddingLeftInitial; 13422 } 13423 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13424 mUserPaddingRight = mUserPaddingEnd; 13425 } else { 13426 mUserPaddingRight = mUserPaddingRightInitial; 13427 } 13428 } 13429 13430 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 13431 } 13432 13433 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 13434 onRtlPropertiesChanged(resolvedLayoutDirection); 13435 13436 mPrivateFlags2 |= PFLAG2_PADDING_RESOLVED; 13437 } 13438 13439 /** 13440 * Reset the resolved layout direction. 13441 * 13442 * @hide 13443 */ 13444 public void resetResolvedPadding() { 13445 resetResolvedPaddingInternal(); 13446 } 13447 13448 /** 13449 * Used when we only want to reset *this* view's padding and not trigger overrides 13450 * in ViewGroup that reset children too. 13451 */ 13452 void resetResolvedPaddingInternal() { 13453 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED; 13454 } 13455 13456 /** 13457 * This is called when the view is detached from a window. At this point it 13458 * no longer has a surface for drawing. 13459 * 13460 * @see #onAttachedToWindow() 13461 */ 13462 protected void onDetachedFromWindow() { 13463 } 13464 13465 /** 13466 * This is a framework-internal mirror of onDetachedFromWindow() that's called 13467 * after onDetachedFromWindow(). 13468 * 13469 * If you override this you *MUST* call super.onDetachedFromWindowInternal()! 13470 * The super method should be called at the end of the overriden method to ensure 13471 * subclasses are destroyed first 13472 * 13473 * @hide 13474 */ 13475 protected void onDetachedFromWindowInternal() { 13476 mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT; 13477 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13478 13479 removeUnsetPressCallback(); 13480 removeLongPressCallback(); 13481 removePerformClickCallback(); 13482 removeSendViewScrolledAccessibilityEventCallback(); 13483 stopNestedScroll(); 13484 13485 // Anything that started animating right before detach should already 13486 // be in its final state when re-attached. 13487 jumpDrawablesToCurrentState(); 13488 13489 destroyDrawingCache(); 13490 13491 cleanupDraw(); 13492 mCurrentAnimation = null; 13493 } 13494 13495 private void cleanupDraw() { 13496 resetDisplayList(); 13497 if (mAttachInfo != null) { 13498 mAttachInfo.mViewRootImpl.cancelInvalidate(this); 13499 } 13500 } 13501 13502 void invalidateInheritedLayoutMode(int layoutModeOfRoot) { 13503 } 13504 13505 /** 13506 * @return The number of times this view has been attached to a window 13507 */ 13508 protected int getWindowAttachCount() { 13509 return mWindowAttachCount; 13510 } 13511 13512 /** 13513 * Retrieve a unique token identifying the window this view is attached to. 13514 * @return Return the window's token for use in 13515 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 13516 */ 13517 public IBinder getWindowToken() { 13518 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 13519 } 13520 13521 /** 13522 * Retrieve the {@link WindowId} for the window this view is 13523 * currently attached to. 13524 */ 13525 public WindowId getWindowId() { 13526 if (mAttachInfo == null) { 13527 return null; 13528 } 13529 if (mAttachInfo.mWindowId == null) { 13530 try { 13531 mAttachInfo.mIWindowId = mAttachInfo.mSession.getWindowId( 13532 mAttachInfo.mWindowToken); 13533 mAttachInfo.mWindowId = new WindowId( 13534 mAttachInfo.mIWindowId); 13535 } catch (RemoteException e) { 13536 } 13537 } 13538 return mAttachInfo.mWindowId; 13539 } 13540 13541 /** 13542 * Retrieve a unique token identifying the top-level "real" window of 13543 * the window that this view is attached to. That is, this is like 13544 * {@link #getWindowToken}, except if the window this view in is a panel 13545 * window (attached to another containing window), then the token of 13546 * the containing window is returned instead. 13547 * 13548 * @return Returns the associated window token, either 13549 * {@link #getWindowToken()} or the containing window's token. 13550 */ 13551 public IBinder getApplicationWindowToken() { 13552 AttachInfo ai = mAttachInfo; 13553 if (ai != null) { 13554 IBinder appWindowToken = ai.mPanelParentWindowToken; 13555 if (appWindowToken == null) { 13556 appWindowToken = ai.mWindowToken; 13557 } 13558 return appWindowToken; 13559 } 13560 return null; 13561 } 13562 13563 /** 13564 * Gets the logical display to which the view's window has been attached. 13565 * 13566 * @return The logical display, or null if the view is not currently attached to a window. 13567 */ 13568 public Display getDisplay() { 13569 return mAttachInfo != null ? mAttachInfo.mDisplay : null; 13570 } 13571 13572 /** 13573 * Retrieve private session object this view hierarchy is using to 13574 * communicate with the window manager. 13575 * @return the session object to communicate with the window manager 13576 */ 13577 /*package*/ IWindowSession getWindowSession() { 13578 return mAttachInfo != null ? mAttachInfo.mSession : null; 13579 } 13580 13581 /** 13582 * @param info the {@link android.view.View.AttachInfo} to associated with 13583 * this view 13584 */ 13585 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 13586 //System.out.println("Attached! " + this); 13587 mAttachInfo = info; 13588 if (mOverlay != null) { 13589 mOverlay.getOverlayView().dispatchAttachedToWindow(info, visibility); 13590 } 13591 mWindowAttachCount++; 13592 // We will need to evaluate the drawable state at least once. 13593 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 13594 if (mFloatingTreeObserver != null) { 13595 info.mTreeObserver.merge(mFloatingTreeObserver); 13596 mFloatingTreeObserver = null; 13597 } 13598 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER) != 0) { 13599 mAttachInfo.mScrollContainers.add(this); 13600 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 13601 } 13602 performCollectViewAttributes(mAttachInfo, visibility); 13603 onAttachedToWindow(); 13604 13605 ListenerInfo li = mListenerInfo; 13606 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13607 li != null ? li.mOnAttachStateChangeListeners : null; 13608 if (listeners != null && listeners.size() > 0) { 13609 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13610 // perform the dispatching. The iterator is a safe guard against listeners that 13611 // could mutate the list by calling the various add/remove methods. This prevents 13612 // the array from being modified while we iterate it. 13613 for (OnAttachStateChangeListener listener : listeners) { 13614 listener.onViewAttachedToWindow(this); 13615 } 13616 } 13617 13618 int vis = info.mWindowVisibility; 13619 if (vis != GONE) { 13620 onWindowVisibilityChanged(vis); 13621 } 13622 if ((mPrivateFlags&PFLAG_DRAWABLE_STATE_DIRTY) != 0) { 13623 // If nobody has evaluated the drawable state yet, then do it now. 13624 refreshDrawableState(); 13625 } 13626 needGlobalAttributesUpdate(false); 13627 } 13628 13629 void dispatchDetachedFromWindow() { 13630 AttachInfo info = mAttachInfo; 13631 if (info != null) { 13632 int vis = info.mWindowVisibility; 13633 if (vis != GONE) { 13634 onWindowVisibilityChanged(GONE); 13635 } 13636 } 13637 13638 onDetachedFromWindow(); 13639 onDetachedFromWindowInternal(); 13640 13641 ListenerInfo li = mListenerInfo; 13642 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13643 li != null ? li.mOnAttachStateChangeListeners : null; 13644 if (listeners != null && listeners.size() > 0) { 13645 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13646 // perform the dispatching. The iterator is a safe guard against listeners that 13647 // could mutate the list by calling the various add/remove methods. This prevents 13648 // the array from being modified while we iterate it. 13649 for (OnAttachStateChangeListener listener : listeners) { 13650 listener.onViewDetachedFromWindow(this); 13651 } 13652 } 13653 13654 if ((mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 13655 mAttachInfo.mScrollContainers.remove(this); 13656 mPrivateFlags &= ~PFLAG_SCROLL_CONTAINER_ADDED; 13657 } 13658 13659 mAttachInfo = null; 13660 if (mOverlay != null) { 13661 mOverlay.getOverlayView().dispatchDetachedFromWindow(); 13662 } 13663 } 13664 13665 /** 13666 * Cancel any deferred high-level input events that were previously posted to the event queue. 13667 * 13668 * <p>Many views post high-level events such as click handlers to the event queue 13669 * to run deferred in order to preserve a desired user experience - clearing visible 13670 * pressed states before executing, etc. This method will abort any events of this nature 13671 * that are currently in flight.</p> 13672 * 13673 * <p>Custom views that generate their own high-level deferred input events should override 13674 * {@link #onCancelPendingInputEvents()} and remove those pending events from the queue.</p> 13675 * 13676 * <p>This will also cancel pending input events for any child views.</p> 13677 * 13678 * <p>Note that this may not be sufficient as a debouncing strategy for clicks in all cases. 13679 * This will not impact newer events posted after this call that may occur as a result of 13680 * lower-level input events still waiting in the queue. If you are trying to prevent 13681 * double-submitted events for the duration of some sort of asynchronous transaction 13682 * you should also take other steps to protect against unexpected double inputs e.g. calling 13683 * {@link #setEnabled(boolean) setEnabled(false)} and re-enabling the view when 13684 * the transaction completes, tracking already submitted transaction IDs, etc.</p> 13685 */ 13686 public final void cancelPendingInputEvents() { 13687 dispatchCancelPendingInputEvents(); 13688 } 13689 13690 /** 13691 * Called by {@link #cancelPendingInputEvents()} to cancel input events in flight. 13692 * Overridden by ViewGroup to dispatch. Package scoped to prevent app-side meddling. 13693 */ 13694 void dispatchCancelPendingInputEvents() { 13695 mPrivateFlags3 &= ~PFLAG3_CALLED_SUPER; 13696 onCancelPendingInputEvents(); 13697 if ((mPrivateFlags3 & PFLAG3_CALLED_SUPER) != PFLAG3_CALLED_SUPER) { 13698 throw new SuperNotCalledException("View " + getClass().getSimpleName() + 13699 " did not call through to super.onCancelPendingInputEvents()"); 13700 } 13701 } 13702 13703 /** 13704 * Called as the result of a call to {@link #cancelPendingInputEvents()} on this view or 13705 * a parent view. 13706 * 13707 * <p>This method is responsible for removing any pending high-level input events that were 13708 * posted to the event queue to run later. Custom view classes that post their own deferred 13709 * high-level events via {@link #post(Runnable)}, {@link #postDelayed(Runnable, long)} or 13710 * {@link android.os.Handler} should override this method, call 13711 * <code>super.onCancelPendingInputEvents()</code> and remove those callbacks as appropriate. 13712 * </p> 13713 */ 13714 public void onCancelPendingInputEvents() { 13715 removePerformClickCallback(); 13716 cancelLongPress(); 13717 mPrivateFlags3 |= PFLAG3_CALLED_SUPER; 13718 } 13719 13720 /** 13721 * Store this view hierarchy's frozen state into the given container. 13722 * 13723 * @param container The SparseArray in which to save the view's state. 13724 * 13725 * @see #restoreHierarchyState(android.util.SparseArray) 13726 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13727 * @see #onSaveInstanceState() 13728 */ 13729 public void saveHierarchyState(SparseArray<Parcelable> container) { 13730 dispatchSaveInstanceState(container); 13731 } 13732 13733 /** 13734 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 13735 * this view and its children. May be overridden to modify how freezing happens to a 13736 * view's children; for example, some views may want to not store state for their children. 13737 * 13738 * @param container The SparseArray in which to save the view's state. 13739 * 13740 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13741 * @see #saveHierarchyState(android.util.SparseArray) 13742 * @see #onSaveInstanceState() 13743 */ 13744 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 13745 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 13746 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13747 Parcelable state = onSaveInstanceState(); 13748 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13749 throw new IllegalStateException( 13750 "Derived class did not call super.onSaveInstanceState()"); 13751 } 13752 if (state != null) { 13753 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 13754 // + ": " + state); 13755 container.put(mID, state); 13756 } 13757 } 13758 } 13759 13760 /** 13761 * Hook allowing a view to generate a representation of its internal state 13762 * that can later be used to create a new instance with that same state. 13763 * This state should only contain information that is not persistent or can 13764 * not be reconstructed later. For example, you will never store your 13765 * current position on screen because that will be computed again when a 13766 * new instance of the view is placed in its view hierarchy. 13767 * <p> 13768 * Some examples of things you may store here: the current cursor position 13769 * in a text view (but usually not the text itself since that is stored in a 13770 * content provider or other persistent storage), the currently selected 13771 * item in a list view. 13772 * 13773 * @return Returns a Parcelable object containing the view's current dynamic 13774 * state, or null if there is nothing interesting to save. The 13775 * default implementation returns null. 13776 * @see #onRestoreInstanceState(android.os.Parcelable) 13777 * @see #saveHierarchyState(android.util.SparseArray) 13778 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13779 * @see #setSaveEnabled(boolean) 13780 */ 13781 protected Parcelable onSaveInstanceState() { 13782 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13783 return BaseSavedState.EMPTY_STATE; 13784 } 13785 13786 /** 13787 * Restore this view hierarchy's frozen state from the given container. 13788 * 13789 * @param container The SparseArray which holds previously frozen states. 13790 * 13791 * @see #saveHierarchyState(android.util.SparseArray) 13792 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13793 * @see #onRestoreInstanceState(android.os.Parcelable) 13794 */ 13795 public void restoreHierarchyState(SparseArray<Parcelable> container) { 13796 dispatchRestoreInstanceState(container); 13797 } 13798 13799 /** 13800 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 13801 * state for this view and its children. May be overridden to modify how restoring 13802 * happens to a view's children; for example, some views may want to not store state 13803 * for their children. 13804 * 13805 * @param container The SparseArray which holds previously saved state. 13806 * 13807 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13808 * @see #restoreHierarchyState(android.util.SparseArray) 13809 * @see #onRestoreInstanceState(android.os.Parcelable) 13810 */ 13811 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 13812 if (mID != NO_ID) { 13813 Parcelable state = container.get(mID); 13814 if (state != null) { 13815 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 13816 // + ": " + state); 13817 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13818 onRestoreInstanceState(state); 13819 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13820 throw new IllegalStateException( 13821 "Derived class did not call super.onRestoreInstanceState()"); 13822 } 13823 } 13824 } 13825 } 13826 13827 /** 13828 * Hook allowing a view to re-apply a representation of its internal state that had previously 13829 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 13830 * null state. 13831 * 13832 * @param state The frozen state that had previously been returned by 13833 * {@link #onSaveInstanceState}. 13834 * 13835 * @see #onSaveInstanceState() 13836 * @see #restoreHierarchyState(android.util.SparseArray) 13837 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13838 */ 13839 protected void onRestoreInstanceState(Parcelable state) { 13840 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13841 if (state != BaseSavedState.EMPTY_STATE && state != null) { 13842 throw new IllegalArgumentException("Wrong state class, expecting View State but " 13843 + "received " + state.getClass().toString() + " instead. This usually happens " 13844 + "when two views of different type have the same id in the same hierarchy. " 13845 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 13846 + "other views do not use the same id."); 13847 } 13848 } 13849 13850 /** 13851 * <p>Return the time at which the drawing of the view hierarchy started.</p> 13852 * 13853 * @return the drawing start time in milliseconds 13854 */ 13855 public long getDrawingTime() { 13856 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 13857 } 13858 13859 /** 13860 * <p>Enables or disables the duplication of the parent's state into this view. When 13861 * duplication is enabled, this view gets its drawable state from its parent rather 13862 * than from its own internal properties.</p> 13863 * 13864 * <p>Note: in the current implementation, setting this property to true after the 13865 * view was added to a ViewGroup might have no effect at all. This property should 13866 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 13867 * 13868 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 13869 * property is enabled, an exception will be thrown.</p> 13870 * 13871 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 13872 * parent, these states should not be affected by this method.</p> 13873 * 13874 * @param enabled True to enable duplication of the parent's drawable state, false 13875 * to disable it. 13876 * 13877 * @see #getDrawableState() 13878 * @see #isDuplicateParentStateEnabled() 13879 */ 13880 public void setDuplicateParentStateEnabled(boolean enabled) { 13881 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 13882 } 13883 13884 /** 13885 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 13886 * 13887 * @return True if this view's drawable state is duplicated from the parent, 13888 * false otherwise 13889 * 13890 * @see #getDrawableState() 13891 * @see #setDuplicateParentStateEnabled(boolean) 13892 */ 13893 public boolean isDuplicateParentStateEnabled() { 13894 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 13895 } 13896 13897 /** 13898 * <p>Specifies the type of layer backing this view. The layer can be 13899 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13900 * {@link #LAYER_TYPE_HARDWARE}.</p> 13901 * 13902 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13903 * instance that controls how the layer is composed on screen. The following 13904 * properties of the paint are taken into account when composing the layer:</p> 13905 * <ul> 13906 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13907 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13908 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13909 * </ul> 13910 * 13911 * <p>If this view has an alpha value set to < 1.0 by calling 13912 * {@link #setAlpha(float)}, the alpha value of the layer's paint is superceded 13913 * by this view's alpha value.</p> 13914 * 13915 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE}, 13916 * {@link #LAYER_TYPE_SOFTWARE} and {@link #LAYER_TYPE_HARDWARE} 13917 * for more information on when and how to use layers.</p> 13918 * 13919 * @param layerType The type of layer to use with this view, must be one of 13920 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13921 * {@link #LAYER_TYPE_HARDWARE} 13922 * @param paint The paint used to compose the layer. This argument is optional 13923 * and can be null. It is ignored when the layer type is 13924 * {@link #LAYER_TYPE_NONE} 13925 * 13926 * @see #getLayerType() 13927 * @see #LAYER_TYPE_NONE 13928 * @see #LAYER_TYPE_SOFTWARE 13929 * @see #LAYER_TYPE_HARDWARE 13930 * @see #setAlpha(float) 13931 * 13932 * @attr ref android.R.styleable#View_layerType 13933 */ 13934 public void setLayerType(int layerType, Paint paint) { 13935 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 13936 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 13937 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 13938 } 13939 13940 boolean typeChanged = mRenderNode.setLayerType(layerType); 13941 13942 if (!typeChanged) { 13943 setLayerPaint(paint); 13944 return; 13945 } 13946 13947 // Destroy any previous software drawing cache if needed 13948 if (mLayerType == LAYER_TYPE_SOFTWARE) { 13949 destroyDrawingCache(); 13950 } 13951 13952 mLayerType = layerType; 13953 final boolean layerDisabled = (mLayerType == LAYER_TYPE_NONE); 13954 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 13955 mRenderNode.setLayerPaint(mLayerPaint); 13956 13957 // draw() behaves differently if we are on a layer, so we need to 13958 // invalidate() here 13959 invalidateParentCaches(); 13960 invalidate(true); 13961 } 13962 13963 /** 13964 * Updates the {@link Paint} object used with the current layer (used only if the current 13965 * layer type is not set to {@link #LAYER_TYPE_NONE}). Changed properties of the Paint 13966 * provided to {@link #setLayerType(int, android.graphics.Paint)} will be used the next time 13967 * the View is redrawn, but {@link #setLayerPaint(android.graphics.Paint)} must be called to 13968 * ensure that the view gets redrawn immediately. 13969 * 13970 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13971 * instance that controls how the layer is composed on screen. The following 13972 * properties of the paint are taken into account when composing the layer:</p> 13973 * <ul> 13974 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13975 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13976 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13977 * </ul> 13978 * 13979 * <p>If this view has an alpha value set to < 1.0 by calling {@link #setAlpha(float)}, the 13980 * alpha value of the layer's paint is superceded by this view's alpha value.</p> 13981 * 13982 * @param paint The paint used to compose the layer. This argument is optional 13983 * and can be null. It is ignored when the layer type is 13984 * {@link #LAYER_TYPE_NONE} 13985 * 13986 * @see #setLayerType(int, android.graphics.Paint) 13987 */ 13988 public void setLayerPaint(Paint paint) { 13989 int layerType = getLayerType(); 13990 if (layerType != LAYER_TYPE_NONE) { 13991 mLayerPaint = paint == null ? new Paint() : paint; 13992 if (layerType == LAYER_TYPE_HARDWARE) { 13993 if (mRenderNode.setLayerPaint(mLayerPaint)) { 13994 invalidateViewProperty(false, false); 13995 } 13996 } else { 13997 invalidate(); 13998 } 13999 } 14000 } 14001 14002 /** 14003 * Indicates whether this view has a static layer. A view with layer type 14004 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 14005 * dynamic. 14006 */ 14007 boolean hasStaticLayer() { 14008 return true; 14009 } 14010 14011 /** 14012 * Indicates what type of layer is currently associated with this view. By default 14013 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 14014 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 14015 * for more information on the different types of layers. 14016 * 14017 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 14018 * {@link #LAYER_TYPE_HARDWARE} 14019 * 14020 * @see #setLayerType(int, android.graphics.Paint) 14021 * @see #buildLayer() 14022 * @see #LAYER_TYPE_NONE 14023 * @see #LAYER_TYPE_SOFTWARE 14024 * @see #LAYER_TYPE_HARDWARE 14025 */ 14026 public int getLayerType() { 14027 return mLayerType; 14028 } 14029 14030 /** 14031 * Forces this view's layer to be created and this view to be rendered 14032 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 14033 * invoking this method will have no effect. 14034 * 14035 * This method can for instance be used to render a view into its layer before 14036 * starting an animation. If this view is complex, rendering into the layer 14037 * before starting the animation will avoid skipping frames. 14038 * 14039 * @throws IllegalStateException If this view is not attached to a window 14040 * 14041 * @see #setLayerType(int, android.graphics.Paint) 14042 */ 14043 public void buildLayer() { 14044 if (mLayerType == LAYER_TYPE_NONE) return; 14045 14046 final AttachInfo attachInfo = mAttachInfo; 14047 if (attachInfo == null) { 14048 throw new IllegalStateException("This view must be attached to a window first"); 14049 } 14050 14051 if (getWidth() == 0 || getHeight() == 0) { 14052 return; 14053 } 14054 14055 switch (mLayerType) { 14056 case LAYER_TYPE_HARDWARE: 14057 updateDisplayListIfDirty(); 14058 if (attachInfo.mHardwareRenderer != null && mRenderNode.isValid()) { 14059 attachInfo.mHardwareRenderer.buildLayer(mRenderNode); 14060 } 14061 break; 14062 case LAYER_TYPE_SOFTWARE: 14063 buildDrawingCache(true); 14064 break; 14065 } 14066 } 14067 14068 /** 14069 * If this View draws with a HardwareLayer, returns it. 14070 * Otherwise returns null 14071 * 14072 * TODO: Only TextureView uses this, can we eliminate it? 14073 */ 14074 HardwareLayer getHardwareLayer() { 14075 return null; 14076 } 14077 14078 /** 14079 * Destroys all hardware rendering resources. This method is invoked 14080 * when the system needs to reclaim resources. Upon execution of this 14081 * method, you should free any OpenGL resources created by the view. 14082 * 14083 * Note: you <strong>must</strong> call 14084 * <code>super.destroyHardwareResources()</code> when overriding 14085 * this method. 14086 * 14087 * @hide 14088 */ 14089 protected void destroyHardwareResources() { 14090 // Although the Layer will be destroyed by RenderNode, we want to release 14091 // the staging display list, which is also a signal to RenderNode that it's 14092 // safe to free its copy of the display list as it knows that we will 14093 // push an updated DisplayList if we try to draw again 14094 resetDisplayList(); 14095 } 14096 14097 /** 14098 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 14099 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 14100 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 14101 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 14102 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 14103 * null.</p> 14104 * 14105 * <p>Enabling the drawing cache is similar to 14106 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 14107 * acceleration is turned off. When hardware acceleration is turned on, enabling the 14108 * drawing cache has no effect on rendering because the system uses a different mechanism 14109 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 14110 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 14111 * for information on how to enable software and hardware layers.</p> 14112 * 14113 * <p>This API can be used to manually generate 14114 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 14115 * {@link #getDrawingCache()}.</p> 14116 * 14117 * @param enabled true to enable the drawing cache, false otherwise 14118 * 14119 * @see #isDrawingCacheEnabled() 14120 * @see #getDrawingCache() 14121 * @see #buildDrawingCache() 14122 * @see #setLayerType(int, android.graphics.Paint) 14123 */ 14124 public void setDrawingCacheEnabled(boolean enabled) { 14125 mCachingFailed = false; 14126 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 14127 } 14128 14129 /** 14130 * <p>Indicates whether the drawing cache is enabled for this view.</p> 14131 * 14132 * @return true if the drawing cache is enabled 14133 * 14134 * @see #setDrawingCacheEnabled(boolean) 14135 * @see #getDrawingCache() 14136 */ 14137 @ViewDebug.ExportedProperty(category = "drawing") 14138 public boolean isDrawingCacheEnabled() { 14139 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 14140 } 14141 14142 /** 14143 * Debugging utility which recursively outputs the dirty state of a view and its 14144 * descendants. 14145 * 14146 * @hide 14147 */ 14148 @SuppressWarnings({"UnusedDeclaration"}) 14149 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 14150 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.PFLAG_DIRTY_MASK) + 14151 ") DRAWN(" + (mPrivateFlags & PFLAG_DRAWN) + ")" + " CACHE_VALID(" + 14152 (mPrivateFlags & View.PFLAG_DRAWING_CACHE_VALID) + 14153 ") INVALIDATED(" + (mPrivateFlags & PFLAG_INVALIDATED) + ")"); 14154 if (clear) { 14155 mPrivateFlags &= clearMask; 14156 } 14157 if (this instanceof ViewGroup) { 14158 ViewGroup parent = (ViewGroup) this; 14159 final int count = parent.getChildCount(); 14160 for (int i = 0; i < count; i++) { 14161 final View child = parent.getChildAt(i); 14162 child.outputDirtyFlags(indent + " ", clear, clearMask); 14163 } 14164 } 14165 } 14166 14167 /** 14168 * This method is used by ViewGroup to cause its children to restore or recreate their 14169 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 14170 * to recreate its own display list, which would happen if it went through the normal 14171 * draw/dispatchDraw mechanisms. 14172 * 14173 * @hide 14174 */ 14175 protected void dispatchGetDisplayList() {} 14176 14177 /** 14178 * A view that is not attached or hardware accelerated cannot create a display list. 14179 * This method checks these conditions and returns the appropriate result. 14180 * 14181 * @return true if view has the ability to create a display list, false otherwise. 14182 * 14183 * @hide 14184 */ 14185 public boolean canHaveDisplayList() { 14186 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 14187 } 14188 14189 private void updateDisplayListIfDirty() { 14190 final RenderNode renderNode = mRenderNode; 14191 if (!canHaveDisplayList()) { 14192 // can't populate RenderNode, don't try 14193 return; 14194 } 14195 14196 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 14197 || !renderNode.isValid() 14198 || (mRecreateDisplayList)) { 14199 // Don't need to recreate the display list, just need to tell our 14200 // children to restore/recreate theirs 14201 if (renderNode.isValid() 14202 && !mRecreateDisplayList) { 14203 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14204 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14205 dispatchGetDisplayList(); 14206 14207 return; // no work needed 14208 } 14209 14210 // If we got here, we're recreating it. Mark it as such to ensure that 14211 // we copy in child display lists into ours in drawChild() 14212 mRecreateDisplayList = true; 14213 14214 int width = mRight - mLeft; 14215 int height = mBottom - mTop; 14216 int layerType = getLayerType(); 14217 14218 final HardwareCanvas canvas = renderNode.start(width, height); 14219 canvas.setHighContrastText(mAttachInfo.mHighContrastText); 14220 14221 try { 14222 final HardwareLayer layer = getHardwareLayer(); 14223 if (layer != null && layer.isValid()) { 14224 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint); 14225 } else if (layerType == LAYER_TYPE_SOFTWARE) { 14226 buildDrawingCache(true); 14227 Bitmap cache = getDrawingCache(true); 14228 if (cache != null) { 14229 canvas.drawBitmap(cache, 0, 0, mLayerPaint); 14230 } 14231 } else { 14232 computeScroll(); 14233 14234 canvas.translate(-mScrollX, -mScrollY); 14235 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14236 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14237 14238 // Fast path for layouts with no backgrounds 14239 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14240 dispatchDraw(canvas); 14241 if (mOverlay != null && !mOverlay.isEmpty()) { 14242 mOverlay.getOverlayView().draw(canvas); 14243 } 14244 } else { 14245 draw(canvas); 14246 } 14247 } 14248 } finally { 14249 renderNode.end(canvas); 14250 setDisplayListProperties(renderNode); 14251 } 14252 } else { 14253 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14254 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14255 } 14256 } 14257 14258 /** 14259 * Returns a RenderNode with View draw content recorded, which can be 14260 * used to draw this view again without executing its draw method. 14261 * 14262 * @return A RenderNode ready to replay, or null if caching is not enabled. 14263 * 14264 * @hide 14265 */ 14266 public RenderNode getDisplayList() { 14267 updateDisplayListIfDirty(); 14268 return mRenderNode; 14269 } 14270 14271 private void resetDisplayList() { 14272 if (mRenderNode.isValid()) { 14273 mRenderNode.destroyDisplayListData(); 14274 } 14275 14276 if (mBackgroundRenderNode != null && mBackgroundRenderNode.isValid()) { 14277 mBackgroundRenderNode.destroyDisplayListData(); 14278 } 14279 } 14280 14281 /** 14282 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 14283 * 14284 * @return A non-scaled bitmap representing this view or null if cache is disabled. 14285 * 14286 * @see #getDrawingCache(boolean) 14287 */ 14288 public Bitmap getDrawingCache() { 14289 return getDrawingCache(false); 14290 } 14291 14292 /** 14293 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 14294 * is null when caching is disabled. If caching is enabled and the cache is not ready, 14295 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 14296 * draw from the cache when the cache is enabled. To benefit from the cache, you must 14297 * request the drawing cache by calling this method and draw it on screen if the 14298 * returned bitmap is not null.</p> 14299 * 14300 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14301 * this method will create a bitmap of the same size as this view. Because this bitmap 14302 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14303 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14304 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14305 * size than the view. This implies that your application must be able to handle this 14306 * size.</p> 14307 * 14308 * @param autoScale Indicates whether the generated bitmap should be scaled based on 14309 * the current density of the screen when the application is in compatibility 14310 * mode. 14311 * 14312 * @return A bitmap representing this view or null if cache is disabled. 14313 * 14314 * @see #setDrawingCacheEnabled(boolean) 14315 * @see #isDrawingCacheEnabled() 14316 * @see #buildDrawingCache(boolean) 14317 * @see #destroyDrawingCache() 14318 */ 14319 public Bitmap getDrawingCache(boolean autoScale) { 14320 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 14321 return null; 14322 } 14323 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 14324 buildDrawingCache(autoScale); 14325 } 14326 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 14327 } 14328 14329 /** 14330 * <p>Frees the resources used by the drawing cache. If you call 14331 * {@link #buildDrawingCache()} manually without calling 14332 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14333 * should cleanup the cache with this method afterwards.</p> 14334 * 14335 * @see #setDrawingCacheEnabled(boolean) 14336 * @see #buildDrawingCache() 14337 * @see #getDrawingCache() 14338 */ 14339 public void destroyDrawingCache() { 14340 if (mDrawingCache != null) { 14341 mDrawingCache.recycle(); 14342 mDrawingCache = null; 14343 } 14344 if (mUnscaledDrawingCache != null) { 14345 mUnscaledDrawingCache.recycle(); 14346 mUnscaledDrawingCache = null; 14347 } 14348 } 14349 14350 /** 14351 * Setting a solid background color for the drawing cache's bitmaps will improve 14352 * performance and memory usage. Note, though that this should only be used if this 14353 * view will always be drawn on top of a solid color. 14354 * 14355 * @param color The background color to use for the drawing cache's bitmap 14356 * 14357 * @see #setDrawingCacheEnabled(boolean) 14358 * @see #buildDrawingCache() 14359 * @see #getDrawingCache() 14360 */ 14361 public void setDrawingCacheBackgroundColor(int color) { 14362 if (color != mDrawingCacheBackgroundColor) { 14363 mDrawingCacheBackgroundColor = color; 14364 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 14365 } 14366 } 14367 14368 /** 14369 * @see #setDrawingCacheBackgroundColor(int) 14370 * 14371 * @return The background color to used for the drawing cache's bitmap 14372 */ 14373 public int getDrawingCacheBackgroundColor() { 14374 return mDrawingCacheBackgroundColor; 14375 } 14376 14377 /** 14378 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 14379 * 14380 * @see #buildDrawingCache(boolean) 14381 */ 14382 public void buildDrawingCache() { 14383 buildDrawingCache(false); 14384 } 14385 14386 /** 14387 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 14388 * 14389 * <p>If you call {@link #buildDrawingCache()} manually without calling 14390 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14391 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 14392 * 14393 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14394 * this method will create a bitmap of the same size as this view. Because this bitmap 14395 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14396 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14397 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14398 * size than the view. This implies that your application must be able to handle this 14399 * size.</p> 14400 * 14401 * <p>You should avoid calling this method when hardware acceleration is enabled. If 14402 * you do not need the drawing cache bitmap, calling this method will increase memory 14403 * usage and cause the view to be rendered in software once, thus negatively impacting 14404 * performance.</p> 14405 * 14406 * @see #getDrawingCache() 14407 * @see #destroyDrawingCache() 14408 */ 14409 public void buildDrawingCache(boolean autoScale) { 14410 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || (autoScale ? 14411 mDrawingCache == null : mUnscaledDrawingCache == null)) { 14412 if (Trace.isTagEnabled(Trace.TRACE_TAG_VIEW)) { 14413 Trace.traceBegin(Trace.TRACE_TAG_VIEW, 14414 "buildDrawingCache/SW Layer for " + getClass().getSimpleName()); 14415 } 14416 try { 14417 buildDrawingCacheImpl(autoScale); 14418 } finally { 14419 Trace.traceEnd(Trace.TRACE_TAG_VIEW); 14420 } 14421 } 14422 } 14423 14424 /** 14425 * private, internal implementation of buildDrawingCache, used to enable tracing 14426 */ 14427 private void buildDrawingCacheImpl(boolean autoScale) { 14428 mCachingFailed = false; 14429 14430 int width = mRight - mLeft; 14431 int height = mBottom - mTop; 14432 14433 final AttachInfo attachInfo = mAttachInfo; 14434 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 14435 14436 if (autoScale && scalingRequired) { 14437 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 14438 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 14439 } 14440 14441 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 14442 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 14443 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 14444 14445 final long projectedBitmapSize = width * height * (opaque && !use32BitCache ? 2 : 4); 14446 final long drawingCacheSize = 14447 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize(); 14448 if (width <= 0 || height <= 0 || projectedBitmapSize > drawingCacheSize) { 14449 if (width > 0 && height > 0) { 14450 Log.w(VIEW_LOG_TAG, "View too large to fit into drawing cache, needs " 14451 + projectedBitmapSize + " bytes, only " 14452 + drawingCacheSize + " available"); 14453 } 14454 destroyDrawingCache(); 14455 mCachingFailed = true; 14456 return; 14457 } 14458 14459 boolean clear = true; 14460 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 14461 14462 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 14463 Bitmap.Config quality; 14464 if (!opaque) { 14465 // Never pick ARGB_4444 because it looks awful 14466 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 14467 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 14468 case DRAWING_CACHE_QUALITY_AUTO: 14469 case DRAWING_CACHE_QUALITY_LOW: 14470 case DRAWING_CACHE_QUALITY_HIGH: 14471 default: 14472 quality = Bitmap.Config.ARGB_8888; 14473 break; 14474 } 14475 } else { 14476 // Optimization for translucent windows 14477 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 14478 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 14479 } 14480 14481 // Try to cleanup memory 14482 if (bitmap != null) bitmap.recycle(); 14483 14484 try { 14485 bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14486 width, height, quality); 14487 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 14488 if (autoScale) { 14489 mDrawingCache = bitmap; 14490 } else { 14491 mUnscaledDrawingCache = bitmap; 14492 } 14493 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 14494 } catch (OutOfMemoryError e) { 14495 // If there is not enough memory to create the bitmap cache, just 14496 // ignore the issue as bitmap caches are not required to draw the 14497 // view hierarchy 14498 if (autoScale) { 14499 mDrawingCache = null; 14500 } else { 14501 mUnscaledDrawingCache = null; 14502 } 14503 mCachingFailed = true; 14504 return; 14505 } 14506 14507 clear = drawingCacheBackgroundColor != 0; 14508 } 14509 14510 Canvas canvas; 14511 if (attachInfo != null) { 14512 canvas = attachInfo.mCanvas; 14513 if (canvas == null) { 14514 canvas = new Canvas(); 14515 } 14516 canvas.setBitmap(bitmap); 14517 // Temporarily clobber the cached Canvas in case one of our children 14518 // is also using a drawing cache. Without this, the children would 14519 // steal the canvas by attaching their own bitmap to it and bad, bad 14520 // thing would happen (invisible views, corrupted drawings, etc.) 14521 attachInfo.mCanvas = null; 14522 } else { 14523 // This case should hopefully never or seldom happen 14524 canvas = new Canvas(bitmap); 14525 } 14526 14527 if (clear) { 14528 bitmap.eraseColor(drawingCacheBackgroundColor); 14529 } 14530 14531 computeScroll(); 14532 final int restoreCount = canvas.save(); 14533 14534 if (autoScale && scalingRequired) { 14535 final float scale = attachInfo.mApplicationScale; 14536 canvas.scale(scale, scale); 14537 } 14538 14539 canvas.translate(-mScrollX, -mScrollY); 14540 14541 mPrivateFlags |= PFLAG_DRAWN; 14542 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 14543 mLayerType != LAYER_TYPE_NONE) { 14544 mPrivateFlags |= PFLAG_DRAWING_CACHE_VALID; 14545 } 14546 14547 // Fast path for layouts with no backgrounds 14548 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14549 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14550 dispatchDraw(canvas); 14551 if (mOverlay != null && !mOverlay.isEmpty()) { 14552 mOverlay.getOverlayView().draw(canvas); 14553 } 14554 } else { 14555 draw(canvas); 14556 } 14557 14558 canvas.restoreToCount(restoreCount); 14559 canvas.setBitmap(null); 14560 14561 if (attachInfo != null) { 14562 // Restore the cached Canvas for our siblings 14563 attachInfo.mCanvas = canvas; 14564 } 14565 } 14566 14567 /** 14568 * Create a snapshot of the view into a bitmap. We should probably make 14569 * some form of this public, but should think about the API. 14570 */ 14571 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 14572 int width = mRight - mLeft; 14573 int height = mBottom - mTop; 14574 14575 final AttachInfo attachInfo = mAttachInfo; 14576 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 14577 width = (int) ((width * scale) + 0.5f); 14578 height = (int) ((height * scale) + 0.5f); 14579 14580 Bitmap bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14581 width > 0 ? width : 1, height > 0 ? height : 1, quality); 14582 if (bitmap == null) { 14583 throw new OutOfMemoryError(); 14584 } 14585 14586 Resources resources = getResources(); 14587 if (resources != null) { 14588 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 14589 } 14590 14591 Canvas canvas; 14592 if (attachInfo != null) { 14593 canvas = attachInfo.mCanvas; 14594 if (canvas == null) { 14595 canvas = new Canvas(); 14596 } 14597 canvas.setBitmap(bitmap); 14598 // Temporarily clobber the cached Canvas in case one of our children 14599 // is also using a drawing cache. Without this, the children would 14600 // steal the canvas by attaching their own bitmap to it and bad, bad 14601 // things would happen (invisible views, corrupted drawings, etc.) 14602 attachInfo.mCanvas = null; 14603 } else { 14604 // This case should hopefully never or seldom happen 14605 canvas = new Canvas(bitmap); 14606 } 14607 14608 if ((backgroundColor & 0xff000000) != 0) { 14609 bitmap.eraseColor(backgroundColor); 14610 } 14611 14612 computeScroll(); 14613 final int restoreCount = canvas.save(); 14614 canvas.scale(scale, scale); 14615 canvas.translate(-mScrollX, -mScrollY); 14616 14617 // Temporarily remove the dirty mask 14618 int flags = mPrivateFlags; 14619 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14620 14621 // Fast path for layouts with no backgrounds 14622 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14623 dispatchDraw(canvas); 14624 if (mOverlay != null && !mOverlay.isEmpty()) { 14625 mOverlay.getOverlayView().draw(canvas); 14626 } 14627 } else { 14628 draw(canvas); 14629 } 14630 14631 mPrivateFlags = flags; 14632 14633 canvas.restoreToCount(restoreCount); 14634 canvas.setBitmap(null); 14635 14636 if (attachInfo != null) { 14637 // Restore the cached Canvas for our siblings 14638 attachInfo.mCanvas = canvas; 14639 } 14640 14641 return bitmap; 14642 } 14643 14644 /** 14645 * Indicates whether this View is currently in edit mode. A View is usually 14646 * in edit mode when displayed within a developer tool. For instance, if 14647 * this View is being drawn by a visual user interface builder, this method 14648 * should return true. 14649 * 14650 * Subclasses should check the return value of this method to provide 14651 * different behaviors if their normal behavior might interfere with the 14652 * host environment. For instance: the class spawns a thread in its 14653 * constructor, the drawing code relies on device-specific features, etc. 14654 * 14655 * This method is usually checked in the drawing code of custom widgets. 14656 * 14657 * @return True if this View is in edit mode, false otherwise. 14658 */ 14659 public boolean isInEditMode() { 14660 return false; 14661 } 14662 14663 /** 14664 * If the View draws content inside its padding and enables fading edges, 14665 * it needs to support padding offsets. Padding offsets are added to the 14666 * fading edges to extend the length of the fade so that it covers pixels 14667 * drawn inside the padding. 14668 * 14669 * Subclasses of this class should override this method if they need 14670 * to draw content inside the padding. 14671 * 14672 * @return True if padding offset must be applied, false otherwise. 14673 * 14674 * @see #getLeftPaddingOffset() 14675 * @see #getRightPaddingOffset() 14676 * @see #getTopPaddingOffset() 14677 * @see #getBottomPaddingOffset() 14678 * 14679 * @since CURRENT 14680 */ 14681 protected boolean isPaddingOffsetRequired() { 14682 return false; 14683 } 14684 14685 /** 14686 * Amount by which to extend the left fading region. Called only when 14687 * {@link #isPaddingOffsetRequired()} returns true. 14688 * 14689 * @return The left padding offset in pixels. 14690 * 14691 * @see #isPaddingOffsetRequired() 14692 * 14693 * @since CURRENT 14694 */ 14695 protected int getLeftPaddingOffset() { 14696 return 0; 14697 } 14698 14699 /** 14700 * Amount by which to extend the right fading region. Called only when 14701 * {@link #isPaddingOffsetRequired()} returns true. 14702 * 14703 * @return The right padding offset in pixels. 14704 * 14705 * @see #isPaddingOffsetRequired() 14706 * 14707 * @since CURRENT 14708 */ 14709 protected int getRightPaddingOffset() { 14710 return 0; 14711 } 14712 14713 /** 14714 * Amount by which to extend the top fading region. Called only when 14715 * {@link #isPaddingOffsetRequired()} returns true. 14716 * 14717 * @return The top padding offset in pixels. 14718 * 14719 * @see #isPaddingOffsetRequired() 14720 * 14721 * @since CURRENT 14722 */ 14723 protected int getTopPaddingOffset() { 14724 return 0; 14725 } 14726 14727 /** 14728 * Amount by which to extend the bottom fading region. Called only when 14729 * {@link #isPaddingOffsetRequired()} returns true. 14730 * 14731 * @return The bottom padding offset in pixels. 14732 * 14733 * @see #isPaddingOffsetRequired() 14734 * 14735 * @since CURRENT 14736 */ 14737 protected int getBottomPaddingOffset() { 14738 return 0; 14739 } 14740 14741 /** 14742 * @hide 14743 * @param offsetRequired 14744 */ 14745 protected int getFadeTop(boolean offsetRequired) { 14746 int top = mPaddingTop; 14747 if (offsetRequired) top += getTopPaddingOffset(); 14748 return top; 14749 } 14750 14751 /** 14752 * @hide 14753 * @param offsetRequired 14754 */ 14755 protected int getFadeHeight(boolean offsetRequired) { 14756 int padding = mPaddingTop; 14757 if (offsetRequired) padding += getTopPaddingOffset(); 14758 return mBottom - mTop - mPaddingBottom - padding; 14759 } 14760 14761 /** 14762 * <p>Indicates whether this view is attached to a hardware accelerated 14763 * window or not.</p> 14764 * 14765 * <p>Even if this method returns true, it does not mean that every call 14766 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 14767 * accelerated {@link android.graphics.Canvas}. For instance, if this view 14768 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its 14769 * window is hardware accelerated, 14770 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 14771 * return false, and this method will return true.</p> 14772 * 14773 * @return True if the view is attached to a window and the window is 14774 * hardware accelerated; false in any other case. 14775 */ 14776 @ViewDebug.ExportedProperty(category = "drawing") 14777 public boolean isHardwareAccelerated() { 14778 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14779 } 14780 14781 /** 14782 * Sets a rectangular area on this view to which the view will be clipped 14783 * when it is drawn. Setting the value to null will remove the clip bounds 14784 * and the view will draw normally, using its full bounds. 14785 * 14786 * @param clipBounds The rectangular area, in the local coordinates of 14787 * this view, to which future drawing operations will be clipped. 14788 */ 14789 public void setClipBounds(Rect clipBounds) { 14790 if (clipBounds == mClipBounds 14791 || (clipBounds != null && clipBounds.equals(mClipBounds))) { 14792 return; 14793 } 14794 if (clipBounds != null) { 14795 if (mClipBounds == null) { 14796 mClipBounds = new Rect(clipBounds); 14797 } else { 14798 mClipBounds.set(clipBounds); 14799 } 14800 } else { 14801 mClipBounds = null; 14802 } 14803 mRenderNode.setClipBounds(mClipBounds); 14804 invalidateViewProperty(false, false); 14805 } 14806 14807 /** 14808 * Returns a copy of the current {@link #setClipBounds(Rect) clipBounds}. 14809 * 14810 * @return A copy of the current clip bounds if clip bounds are set, 14811 * otherwise null. 14812 */ 14813 public Rect getClipBounds() { 14814 return (mClipBounds != null) ? new Rect(mClipBounds) : null; 14815 } 14816 14817 /** 14818 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common 14819 * case of an active Animation being run on the view. 14820 */ 14821 private boolean drawAnimation(ViewGroup parent, long drawingTime, 14822 Animation a, boolean scalingRequired) { 14823 Transformation invalidationTransform; 14824 final int flags = parent.mGroupFlags; 14825 final boolean initialized = a.isInitialized(); 14826 if (!initialized) { 14827 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight()); 14828 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop); 14829 if (mAttachInfo != null) a.setListenerHandler(mAttachInfo.mHandler); 14830 onAnimationStart(); 14831 } 14832 14833 final Transformation t = parent.getChildTransformation(); 14834 boolean more = a.getTransformation(drawingTime, t, 1f); 14835 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) { 14836 if (parent.mInvalidationTransformation == null) { 14837 parent.mInvalidationTransformation = new Transformation(); 14838 } 14839 invalidationTransform = parent.mInvalidationTransformation; 14840 a.getTransformation(drawingTime, invalidationTransform, 1f); 14841 } else { 14842 invalidationTransform = t; 14843 } 14844 14845 if (more) { 14846 if (!a.willChangeBounds()) { 14847 if ((flags & (ViewGroup.FLAG_OPTIMIZE_INVALIDATE | ViewGroup.FLAG_ANIMATION_DONE)) == 14848 ViewGroup.FLAG_OPTIMIZE_INVALIDATE) { 14849 parent.mGroupFlags |= ViewGroup.FLAG_INVALIDATE_REQUIRED; 14850 } else if ((flags & ViewGroup.FLAG_INVALIDATE_REQUIRED) == 0) { 14851 // The child need to draw an animation, potentially offscreen, so 14852 // make sure we do not cancel invalidate requests 14853 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14854 parent.invalidate(mLeft, mTop, mRight, mBottom); 14855 } 14856 } else { 14857 if (parent.mInvalidateRegion == null) { 14858 parent.mInvalidateRegion = new RectF(); 14859 } 14860 final RectF region = parent.mInvalidateRegion; 14861 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region, 14862 invalidationTransform); 14863 14864 // The child need to draw an animation, potentially offscreen, so 14865 // make sure we do not cancel invalidate requests 14866 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14867 14868 final int left = mLeft + (int) region.left; 14869 final int top = mTop + (int) region.top; 14870 parent.invalidate(left, top, left + (int) (region.width() + .5f), 14871 top + (int) (region.height() + .5f)); 14872 } 14873 } 14874 return more; 14875 } 14876 14877 /** 14878 * This method is called by getDisplayList() when a display list is recorded for a View. 14879 * It pushes any properties to the RenderNode that aren't managed by the RenderNode. 14880 */ 14881 void setDisplayListProperties(RenderNode renderNode) { 14882 if (renderNode != null) { 14883 renderNode.setHasOverlappingRendering(hasOverlappingRendering()); 14884 if (mParent instanceof ViewGroup) { 14885 renderNode.setClipToBounds( 14886 (((ViewGroup) mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0); 14887 } 14888 float alpha = 1; 14889 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags & 14890 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14891 ViewGroup parentVG = (ViewGroup) mParent; 14892 final Transformation t = parentVG.getChildTransformation(); 14893 if (parentVG.getChildStaticTransformation(this, t)) { 14894 final int transformType = t.getTransformationType(); 14895 if (transformType != Transformation.TYPE_IDENTITY) { 14896 if ((transformType & Transformation.TYPE_ALPHA) != 0) { 14897 alpha = t.getAlpha(); 14898 } 14899 if ((transformType & Transformation.TYPE_MATRIX) != 0) { 14900 renderNode.setStaticMatrix(t.getMatrix()); 14901 } 14902 } 14903 } 14904 } 14905 if (mTransformationInfo != null) { 14906 alpha *= getFinalAlpha(); 14907 if (alpha < 1) { 14908 final int multipliedAlpha = (int) (255 * alpha); 14909 if (onSetAlpha(multipliedAlpha)) { 14910 alpha = 1; 14911 } 14912 } 14913 renderNode.setAlpha(alpha); 14914 } else if (alpha < 1) { 14915 renderNode.setAlpha(alpha); 14916 } 14917 } 14918 } 14919 14920 /** 14921 * This method is called by ViewGroup.drawChild() to have each child view draw itself. 14922 * This draw() method is an implementation detail and is not intended to be overridden or 14923 * to be called from anywhere else other than ViewGroup.drawChild(). 14924 */ 14925 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) { 14926 boolean usingRenderNodeProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14927 boolean more = false; 14928 final boolean childHasIdentityMatrix = hasIdentityMatrix(); 14929 final int flags = parent.mGroupFlags; 14930 14931 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) { 14932 parent.getChildTransformation().clear(); 14933 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION; 14934 } 14935 14936 Transformation transformToApply = null; 14937 boolean concatMatrix = false; 14938 14939 boolean scalingRequired = false; 14940 boolean caching; 14941 int layerType = getLayerType(); 14942 14943 final boolean hardwareAccelerated = canvas.isHardwareAccelerated(); 14944 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 || 14945 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) { 14946 caching = true; 14947 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList 14948 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired; 14949 } else { 14950 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated; 14951 } 14952 14953 final Animation a = getAnimation(); 14954 if (a != null) { 14955 more = drawAnimation(parent, drawingTime, a, scalingRequired); 14956 concatMatrix = a.willChangeTransformationMatrix(); 14957 if (concatMatrix) { 14958 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14959 } 14960 transformToApply = parent.getChildTransformation(); 14961 } else { 14962 if ((mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_TRANSFORM) != 0) { 14963 // No longer animating: clear out old animation matrix 14964 mRenderNode.setAnimationMatrix(null); 14965 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14966 } 14967 if (!usingRenderNodeProperties && 14968 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14969 final Transformation t = parent.getChildTransformation(); 14970 final boolean hasTransform = parent.getChildStaticTransformation(this, t); 14971 if (hasTransform) { 14972 final int transformType = t.getTransformationType(); 14973 transformToApply = transformType != Transformation.TYPE_IDENTITY ? t : null; 14974 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0; 14975 } 14976 } 14977 } 14978 14979 concatMatrix |= !childHasIdentityMatrix; 14980 14981 // Sets the flag as early as possible to allow draw() implementations 14982 // to call invalidate() successfully when doing animations 14983 mPrivateFlags |= PFLAG_DRAWN; 14984 14985 if (!concatMatrix && 14986 (flags & (ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS | 14987 ViewGroup.FLAG_CLIP_CHILDREN)) == ViewGroup.FLAG_CLIP_CHILDREN && 14988 canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) && 14989 (mPrivateFlags & PFLAG_DRAW_ANIMATION) == 0) { 14990 mPrivateFlags2 |= PFLAG2_VIEW_QUICK_REJECTED; 14991 return more; 14992 } 14993 mPrivateFlags2 &= ~PFLAG2_VIEW_QUICK_REJECTED; 14994 14995 if (hardwareAccelerated) { 14996 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but 14997 // retain the flag's value temporarily in the mRecreateDisplayList flag 14998 mRecreateDisplayList = (mPrivateFlags & PFLAG_INVALIDATED) == PFLAG_INVALIDATED; 14999 mPrivateFlags &= ~PFLAG_INVALIDATED; 15000 } 15001 15002 RenderNode renderNode = null; 15003 Bitmap cache = null; 15004 boolean hasDisplayList = false; 15005 if (caching) { 15006 if (!hardwareAccelerated) { 15007 if (layerType != LAYER_TYPE_NONE) { 15008 layerType = LAYER_TYPE_SOFTWARE; 15009 buildDrawingCache(true); 15010 } 15011 cache = getDrawingCache(true); 15012 } else { 15013 switch (layerType) { 15014 case LAYER_TYPE_SOFTWARE: 15015 if (usingRenderNodeProperties) { 15016 hasDisplayList = canHaveDisplayList(); 15017 } else { 15018 buildDrawingCache(true); 15019 cache = getDrawingCache(true); 15020 } 15021 break; 15022 case LAYER_TYPE_HARDWARE: 15023 if (usingRenderNodeProperties) { 15024 hasDisplayList = canHaveDisplayList(); 15025 } 15026 break; 15027 case LAYER_TYPE_NONE: 15028 // Delay getting the display list until animation-driven alpha values are 15029 // set up and possibly passed on to the view 15030 hasDisplayList = canHaveDisplayList(); 15031 break; 15032 } 15033 } 15034 } 15035 usingRenderNodeProperties &= hasDisplayList; 15036 if (usingRenderNodeProperties) { 15037 renderNode = getDisplayList(); 15038 if (!renderNode.isValid()) { 15039 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15040 // to getDisplayList(), the display list will be marked invalid and we should not 15041 // try to use it again. 15042 renderNode = null; 15043 hasDisplayList = false; 15044 usingRenderNodeProperties = false; 15045 } 15046 } 15047 15048 int sx = 0; 15049 int sy = 0; 15050 if (!hasDisplayList) { 15051 computeScroll(); 15052 sx = mScrollX; 15053 sy = mScrollY; 15054 } 15055 15056 final boolean hasNoCache = cache == null || hasDisplayList; 15057 final boolean offsetForScroll = cache == null && !hasDisplayList && 15058 layerType != LAYER_TYPE_HARDWARE; 15059 15060 int restoreTo = -1; 15061 if (!usingRenderNodeProperties || transformToApply != null) { 15062 restoreTo = canvas.save(); 15063 } 15064 if (offsetForScroll) { 15065 canvas.translate(mLeft - sx, mTop - sy); 15066 } else { 15067 if (!usingRenderNodeProperties) { 15068 canvas.translate(mLeft, mTop); 15069 } 15070 if (scalingRequired) { 15071 if (usingRenderNodeProperties) { 15072 // TODO: Might not need this if we put everything inside the DL 15073 restoreTo = canvas.save(); 15074 } 15075 // mAttachInfo cannot be null, otherwise scalingRequired == false 15076 final float scale = 1.0f / mAttachInfo.mApplicationScale; 15077 canvas.scale(scale, scale); 15078 } 15079 } 15080 15081 float alpha = usingRenderNodeProperties ? 1 : (getAlpha() * getTransitionAlpha()); 15082 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix() || 15083 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15084 if (transformToApply != null || !childHasIdentityMatrix) { 15085 int transX = 0; 15086 int transY = 0; 15087 15088 if (offsetForScroll) { 15089 transX = -sx; 15090 transY = -sy; 15091 } 15092 15093 if (transformToApply != null) { 15094 if (concatMatrix) { 15095 if (usingRenderNodeProperties) { 15096 renderNode.setAnimationMatrix(transformToApply.getMatrix()); 15097 } else { 15098 // Undo the scroll translation, apply the transformation matrix, 15099 // then redo the scroll translate to get the correct result. 15100 canvas.translate(-transX, -transY); 15101 canvas.concat(transformToApply.getMatrix()); 15102 canvas.translate(transX, transY); 15103 } 15104 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15105 } 15106 15107 float transformAlpha = transformToApply.getAlpha(); 15108 if (transformAlpha < 1) { 15109 alpha *= transformAlpha; 15110 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15111 } 15112 } 15113 15114 if (!childHasIdentityMatrix && !usingRenderNodeProperties) { 15115 canvas.translate(-transX, -transY); 15116 canvas.concat(getMatrix()); 15117 canvas.translate(transX, transY); 15118 } 15119 } 15120 15121 // Deal with alpha if it is or used to be <1 15122 if (alpha < 1 || 15123 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15124 if (alpha < 1) { 15125 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15126 } else { 15127 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15128 } 15129 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15130 if (hasNoCache) { 15131 final int multipliedAlpha = (int) (255 * alpha); 15132 if (!onSetAlpha(multipliedAlpha)) { 15133 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15134 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 || 15135 layerType != LAYER_TYPE_NONE) { 15136 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG; 15137 } 15138 if (usingRenderNodeProperties) { 15139 renderNode.setAlpha(alpha * getAlpha() * getTransitionAlpha()); 15140 } else if (layerType == LAYER_TYPE_NONE) { 15141 final int scrollX = hasDisplayList ? 0 : sx; 15142 final int scrollY = hasDisplayList ? 0 : sy; 15143 canvas.saveLayerAlpha(scrollX, scrollY, 15144 scrollX + (mRight - mLeft), scrollY + (mBottom - mTop), 15145 multipliedAlpha, layerFlags); 15146 } 15147 } else { 15148 // Alpha is handled by the child directly, clobber the layer's alpha 15149 mPrivateFlags |= PFLAG_ALPHA_SET; 15150 } 15151 } 15152 } 15153 } else if ((mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15154 onSetAlpha(255); 15155 mPrivateFlags &= ~PFLAG_ALPHA_SET; 15156 } 15157 15158 if (!usingRenderNodeProperties) { 15159 // apply clips directly, since RenderNode won't do it for this draw 15160 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN 15161 && cache == null) { 15162 if (offsetForScroll) { 15163 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop)); 15164 } else { 15165 if (!scalingRequired || cache == null) { 15166 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop); 15167 } else { 15168 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight()); 15169 } 15170 } 15171 } 15172 15173 if (mClipBounds != null) { 15174 // clip bounds ignore scroll 15175 canvas.clipRect(mClipBounds); 15176 } 15177 } 15178 15179 15180 15181 if (!usingRenderNodeProperties && hasDisplayList) { 15182 renderNode = getDisplayList(); 15183 if (!renderNode.isValid()) { 15184 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15185 // to getDisplayList(), the display list will be marked invalid and we should not 15186 // try to use it again. 15187 renderNode = null; 15188 hasDisplayList = false; 15189 } 15190 } 15191 15192 if (hasNoCache) { 15193 boolean layerRendered = false; 15194 if (layerType == LAYER_TYPE_HARDWARE && !usingRenderNodeProperties) { 15195 final HardwareLayer layer = getHardwareLayer(); 15196 if (layer != null && layer.isValid()) { 15197 int restoreAlpha = mLayerPaint.getAlpha(); 15198 mLayerPaint.setAlpha((int) (alpha * 255)); 15199 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint); 15200 mLayerPaint.setAlpha(restoreAlpha); 15201 layerRendered = true; 15202 } else { 15203 final int scrollX = hasDisplayList ? 0 : sx; 15204 final int scrollY = hasDisplayList ? 0 : sy; 15205 canvas.saveLayer(scrollX, scrollY, 15206 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint, 15207 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG); 15208 } 15209 } 15210 15211 if (!layerRendered) { 15212 if (!hasDisplayList) { 15213 // Fast path for layouts with no backgrounds 15214 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 15215 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15216 dispatchDraw(canvas); 15217 } else { 15218 draw(canvas); 15219 } 15220 } else { 15221 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15222 ((HardwareCanvas) canvas).drawRenderNode(renderNode, null, flags); 15223 } 15224 } 15225 } else if (cache != null) { 15226 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15227 Paint cachePaint; 15228 int restoreAlpha = 0; 15229 15230 if (layerType == LAYER_TYPE_NONE) { 15231 cachePaint = parent.mCachePaint; 15232 if (cachePaint == null) { 15233 cachePaint = new Paint(); 15234 cachePaint.setDither(false); 15235 parent.mCachePaint = cachePaint; 15236 } 15237 } else { 15238 cachePaint = mLayerPaint; 15239 restoreAlpha = mLayerPaint.getAlpha(); 15240 } 15241 cachePaint.setAlpha((int) (alpha * 255)); 15242 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint); 15243 cachePaint.setAlpha(restoreAlpha); 15244 } 15245 15246 if (restoreTo >= 0) { 15247 canvas.restoreToCount(restoreTo); 15248 } 15249 15250 if (a != null && !more) { 15251 if (!hardwareAccelerated && !a.getFillAfter()) { 15252 onSetAlpha(255); 15253 } 15254 parent.finishAnimatingView(this, a); 15255 } 15256 15257 if (more && hardwareAccelerated) { 15258 if (a.hasAlpha() && (mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15259 // alpha animations should cause the child to recreate its display list 15260 invalidate(true); 15261 } 15262 } 15263 15264 mRecreateDisplayList = false; 15265 15266 return more; 15267 } 15268 15269 /** 15270 * Manually render this view (and all of its children) to the given Canvas. 15271 * The view must have already done a full layout before this function is 15272 * called. When implementing a view, implement 15273 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 15274 * If you do need to override this method, call the superclass version. 15275 * 15276 * @param canvas The Canvas to which the View is rendered. 15277 */ 15278 public void draw(Canvas canvas) { 15279 final int privateFlags = mPrivateFlags; 15280 final boolean dirtyOpaque = (privateFlags & PFLAG_DIRTY_MASK) == PFLAG_DIRTY_OPAQUE && 15281 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 15282 mPrivateFlags = (privateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN; 15283 15284 /* 15285 * Draw traversal performs several drawing steps which must be executed 15286 * in the appropriate order: 15287 * 15288 * 1. Draw the background 15289 * 2. If necessary, save the canvas' layers to prepare for fading 15290 * 3. Draw view's content 15291 * 4. Draw children 15292 * 5. If necessary, draw the fading edges and restore layers 15293 * 6. Draw decorations (scrollbars for instance) 15294 */ 15295 15296 // Step 1, draw the background, if needed 15297 int saveCount; 15298 15299 if (!dirtyOpaque) { 15300 drawBackground(canvas); 15301 } 15302 15303 // skip step 2 & 5 if possible (common case) 15304 final int viewFlags = mViewFlags; 15305 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 15306 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 15307 if (!verticalEdges && !horizontalEdges) { 15308 // Step 3, draw the content 15309 if (!dirtyOpaque) onDraw(canvas); 15310 15311 // Step 4, draw the children 15312 dispatchDraw(canvas); 15313 15314 // Step 6, draw decorations (scrollbars) 15315 onDrawScrollBars(canvas); 15316 15317 if (mOverlay != null && !mOverlay.isEmpty()) { 15318 mOverlay.getOverlayView().dispatchDraw(canvas); 15319 } 15320 15321 // we're done... 15322 return; 15323 } 15324 15325 /* 15326 * Here we do the full fledged routine... 15327 * (this is an uncommon case where speed matters less, 15328 * this is why we repeat some of the tests that have been 15329 * done above) 15330 */ 15331 15332 boolean drawTop = false; 15333 boolean drawBottom = false; 15334 boolean drawLeft = false; 15335 boolean drawRight = false; 15336 15337 float topFadeStrength = 0.0f; 15338 float bottomFadeStrength = 0.0f; 15339 float leftFadeStrength = 0.0f; 15340 float rightFadeStrength = 0.0f; 15341 15342 // Step 2, save the canvas' layers 15343 int paddingLeft = mPaddingLeft; 15344 15345 final boolean offsetRequired = isPaddingOffsetRequired(); 15346 if (offsetRequired) { 15347 paddingLeft += getLeftPaddingOffset(); 15348 } 15349 15350 int left = mScrollX + paddingLeft; 15351 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 15352 int top = mScrollY + getFadeTop(offsetRequired); 15353 int bottom = top + getFadeHeight(offsetRequired); 15354 15355 if (offsetRequired) { 15356 right += getRightPaddingOffset(); 15357 bottom += getBottomPaddingOffset(); 15358 } 15359 15360 final ScrollabilityCache scrollabilityCache = mScrollCache; 15361 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 15362 int length = (int) fadeHeight; 15363 15364 // clip the fade length if top and bottom fades overlap 15365 // overlapping fades produce odd-looking artifacts 15366 if (verticalEdges && (top + length > bottom - length)) { 15367 length = (bottom - top) / 2; 15368 } 15369 15370 // also clip horizontal fades if necessary 15371 if (horizontalEdges && (left + length > right - length)) { 15372 length = (right - left) / 2; 15373 } 15374 15375 if (verticalEdges) { 15376 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 15377 drawTop = topFadeStrength * fadeHeight > 1.0f; 15378 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 15379 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 15380 } 15381 15382 if (horizontalEdges) { 15383 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 15384 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 15385 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 15386 drawRight = rightFadeStrength * fadeHeight > 1.0f; 15387 } 15388 15389 saveCount = canvas.getSaveCount(); 15390 15391 int solidColor = getSolidColor(); 15392 if (solidColor == 0) { 15393 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15394 15395 if (drawTop) { 15396 canvas.saveLayer(left, top, right, top + length, null, flags); 15397 } 15398 15399 if (drawBottom) { 15400 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 15401 } 15402 15403 if (drawLeft) { 15404 canvas.saveLayer(left, top, left + length, bottom, null, flags); 15405 } 15406 15407 if (drawRight) { 15408 canvas.saveLayer(right - length, top, right, bottom, null, flags); 15409 } 15410 } else { 15411 scrollabilityCache.setFadeColor(solidColor); 15412 } 15413 15414 // Step 3, draw the content 15415 if (!dirtyOpaque) onDraw(canvas); 15416 15417 // Step 4, draw the children 15418 dispatchDraw(canvas); 15419 15420 // Step 5, draw the fade effect and restore layers 15421 final Paint p = scrollabilityCache.paint; 15422 final Matrix matrix = scrollabilityCache.matrix; 15423 final Shader fade = scrollabilityCache.shader; 15424 15425 if (drawTop) { 15426 matrix.setScale(1, fadeHeight * topFadeStrength); 15427 matrix.postTranslate(left, top); 15428 fade.setLocalMatrix(matrix); 15429 p.setShader(fade); 15430 canvas.drawRect(left, top, right, top + length, p); 15431 } 15432 15433 if (drawBottom) { 15434 matrix.setScale(1, fadeHeight * bottomFadeStrength); 15435 matrix.postRotate(180); 15436 matrix.postTranslate(left, bottom); 15437 fade.setLocalMatrix(matrix); 15438 p.setShader(fade); 15439 canvas.drawRect(left, bottom - length, right, bottom, p); 15440 } 15441 15442 if (drawLeft) { 15443 matrix.setScale(1, fadeHeight * leftFadeStrength); 15444 matrix.postRotate(-90); 15445 matrix.postTranslate(left, top); 15446 fade.setLocalMatrix(matrix); 15447 p.setShader(fade); 15448 canvas.drawRect(left, top, left + length, bottom, p); 15449 } 15450 15451 if (drawRight) { 15452 matrix.setScale(1, fadeHeight * rightFadeStrength); 15453 matrix.postRotate(90); 15454 matrix.postTranslate(right, top); 15455 fade.setLocalMatrix(matrix); 15456 p.setShader(fade); 15457 canvas.drawRect(right - length, top, right, bottom, p); 15458 } 15459 15460 canvas.restoreToCount(saveCount); 15461 15462 // Step 6, draw decorations (scrollbars) 15463 onDrawScrollBars(canvas); 15464 15465 if (mOverlay != null && !mOverlay.isEmpty()) { 15466 mOverlay.getOverlayView().dispatchDraw(canvas); 15467 } 15468 } 15469 15470 /** 15471 * Draws the background onto the specified canvas. 15472 * 15473 * @param canvas Canvas on which to draw the background 15474 */ 15475 private void drawBackground(Canvas canvas) { 15476 final Drawable background = mBackground; 15477 if (background == null) { 15478 return; 15479 } 15480 15481 if (mBackgroundSizeChanged) { 15482 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 15483 mBackgroundSizeChanged = false; 15484 rebuildOutline(); 15485 } 15486 15487 // Attempt to use a display list if requested. 15488 if (canvas.isHardwareAccelerated() && mAttachInfo != null 15489 && mAttachInfo.mHardwareRenderer != null) { 15490 mBackgroundRenderNode = getDrawableRenderNode(background, mBackgroundRenderNode); 15491 15492 final RenderNode renderNode = mBackgroundRenderNode; 15493 if (renderNode != null && renderNode.isValid()) { 15494 setBackgroundRenderNodeProperties(renderNode); 15495 ((HardwareCanvas) canvas).drawRenderNode(renderNode); 15496 return; 15497 } 15498 } 15499 15500 final int scrollX = mScrollX; 15501 final int scrollY = mScrollY; 15502 if ((scrollX | scrollY) == 0) { 15503 background.draw(canvas); 15504 } else { 15505 canvas.translate(scrollX, scrollY); 15506 background.draw(canvas); 15507 canvas.translate(-scrollX, -scrollY); 15508 } 15509 } 15510 15511 private void setBackgroundRenderNodeProperties(RenderNode renderNode) { 15512 renderNode.setTranslationX(mScrollX); 15513 renderNode.setTranslationY(mScrollY); 15514 } 15515 15516 /** 15517 * Creates a new display list or updates the existing display list for the 15518 * specified Drawable. 15519 * 15520 * @param drawable Drawable for which to create a display list 15521 * @param renderNode Existing RenderNode, or {@code null} 15522 * @return A valid display list for the specified drawable 15523 */ 15524 private RenderNode getDrawableRenderNode(Drawable drawable, RenderNode renderNode) { 15525 if (renderNode == null) { 15526 renderNode = RenderNode.create(drawable.getClass().getName(), this); 15527 } 15528 15529 final Rect bounds = drawable.getBounds(); 15530 final int width = bounds.width(); 15531 final int height = bounds.height(); 15532 final HardwareCanvas canvas = renderNode.start(width, height); 15533 try { 15534 drawable.draw(canvas); 15535 } finally { 15536 renderNode.end(canvas); 15537 } 15538 15539 // Set up drawable properties that are view-independent. 15540 renderNode.setLeftTopRightBottom(bounds.left, bounds.top, bounds.right, bounds.bottom); 15541 renderNode.setProjectBackwards(drawable.isProjected()); 15542 renderNode.setProjectionReceiver(true); 15543 renderNode.setClipToBounds(false); 15544 return renderNode; 15545 } 15546 15547 /** 15548 * Returns the overlay for this view, creating it if it does not yet exist. 15549 * Adding drawables to the overlay will cause them to be displayed whenever 15550 * the view itself is redrawn. Objects in the overlay should be actively 15551 * managed: remove them when they should not be displayed anymore. The 15552 * overlay will always have the same size as its host view. 15553 * 15554 * <p>Note: Overlays do not currently work correctly with {@link 15555 * SurfaceView} or {@link TextureView}; contents in overlays for these 15556 * types of views may not display correctly.</p> 15557 * 15558 * @return The ViewOverlay object for this view. 15559 * @see ViewOverlay 15560 */ 15561 public ViewOverlay getOverlay() { 15562 if (mOverlay == null) { 15563 mOverlay = new ViewOverlay(mContext, this); 15564 } 15565 return mOverlay; 15566 } 15567 15568 /** 15569 * Override this if your view is known to always be drawn on top of a solid color background, 15570 * and needs to draw fading edges. Returning a non-zero color enables the view system to 15571 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 15572 * should be set to 0xFF. 15573 * 15574 * @see #setVerticalFadingEdgeEnabled(boolean) 15575 * @see #setHorizontalFadingEdgeEnabled(boolean) 15576 * 15577 * @return The known solid color background for this view, or 0 if the color may vary 15578 */ 15579 @ViewDebug.ExportedProperty(category = "drawing") 15580 public int getSolidColor() { 15581 return 0; 15582 } 15583 15584 /** 15585 * Build a human readable string representation of the specified view flags. 15586 * 15587 * @param flags the view flags to convert to a string 15588 * @return a String representing the supplied flags 15589 */ 15590 private static String printFlags(int flags) { 15591 String output = ""; 15592 int numFlags = 0; 15593 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 15594 output += "TAKES_FOCUS"; 15595 numFlags++; 15596 } 15597 15598 switch (flags & VISIBILITY_MASK) { 15599 case INVISIBLE: 15600 if (numFlags > 0) { 15601 output += " "; 15602 } 15603 output += "INVISIBLE"; 15604 // USELESS HERE numFlags++; 15605 break; 15606 case GONE: 15607 if (numFlags > 0) { 15608 output += " "; 15609 } 15610 output += "GONE"; 15611 // USELESS HERE numFlags++; 15612 break; 15613 default: 15614 break; 15615 } 15616 return output; 15617 } 15618 15619 /** 15620 * Build a human readable string representation of the specified private 15621 * view flags. 15622 * 15623 * @param privateFlags the private view flags to convert to a string 15624 * @return a String representing the supplied flags 15625 */ 15626 private static String printPrivateFlags(int privateFlags) { 15627 String output = ""; 15628 int numFlags = 0; 15629 15630 if ((privateFlags & PFLAG_WANTS_FOCUS) == PFLAG_WANTS_FOCUS) { 15631 output += "WANTS_FOCUS"; 15632 numFlags++; 15633 } 15634 15635 if ((privateFlags & PFLAG_FOCUSED) == PFLAG_FOCUSED) { 15636 if (numFlags > 0) { 15637 output += " "; 15638 } 15639 output += "FOCUSED"; 15640 numFlags++; 15641 } 15642 15643 if ((privateFlags & PFLAG_SELECTED) == PFLAG_SELECTED) { 15644 if (numFlags > 0) { 15645 output += " "; 15646 } 15647 output += "SELECTED"; 15648 numFlags++; 15649 } 15650 15651 if ((privateFlags & PFLAG_IS_ROOT_NAMESPACE) == PFLAG_IS_ROOT_NAMESPACE) { 15652 if (numFlags > 0) { 15653 output += " "; 15654 } 15655 output += "IS_ROOT_NAMESPACE"; 15656 numFlags++; 15657 } 15658 15659 if ((privateFlags & PFLAG_HAS_BOUNDS) == PFLAG_HAS_BOUNDS) { 15660 if (numFlags > 0) { 15661 output += " "; 15662 } 15663 output += "HAS_BOUNDS"; 15664 numFlags++; 15665 } 15666 15667 if ((privateFlags & PFLAG_DRAWN) == PFLAG_DRAWN) { 15668 if (numFlags > 0) { 15669 output += " "; 15670 } 15671 output += "DRAWN"; 15672 // USELESS HERE numFlags++; 15673 } 15674 return output; 15675 } 15676 15677 /** 15678 * <p>Indicates whether or not this view's layout will be requested during 15679 * the next hierarchy layout pass.</p> 15680 * 15681 * @return true if the layout will be forced during next layout pass 15682 */ 15683 public boolean isLayoutRequested() { 15684 return (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 15685 } 15686 15687 /** 15688 * Return true if o is a ViewGroup that is laying out using optical bounds. 15689 * @hide 15690 */ 15691 public static boolean isLayoutModeOptical(Object o) { 15692 return o instanceof ViewGroup && ((ViewGroup) o).isLayoutModeOptical(); 15693 } 15694 15695 private boolean setOpticalFrame(int left, int top, int right, int bottom) { 15696 Insets parentInsets = mParent instanceof View ? 15697 ((View) mParent).getOpticalInsets() : Insets.NONE; 15698 Insets childInsets = getOpticalInsets(); 15699 return setFrame( 15700 left + parentInsets.left - childInsets.left, 15701 top + parentInsets.top - childInsets.top, 15702 right + parentInsets.left + childInsets.right, 15703 bottom + parentInsets.top + childInsets.bottom); 15704 } 15705 15706 /** 15707 * Assign a size and position to a view and all of its 15708 * descendants 15709 * 15710 * <p>This is the second phase of the layout mechanism. 15711 * (The first is measuring). In this phase, each parent calls 15712 * layout on all of its children to position them. 15713 * This is typically done using the child measurements 15714 * that were stored in the measure pass().</p> 15715 * 15716 * <p>Derived classes should not override this method. 15717 * Derived classes with children should override 15718 * onLayout. In that method, they should 15719 * call layout on each of their children.</p> 15720 * 15721 * @param l Left position, relative to parent 15722 * @param t Top position, relative to parent 15723 * @param r Right position, relative to parent 15724 * @param b Bottom position, relative to parent 15725 */ 15726 @SuppressWarnings({"unchecked"}) 15727 public void layout(int l, int t, int r, int b) { 15728 if ((mPrivateFlags3 & PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT) != 0) { 15729 onMeasure(mOldWidthMeasureSpec, mOldHeightMeasureSpec); 15730 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 15731 } 15732 15733 int oldL = mLeft; 15734 int oldT = mTop; 15735 int oldB = mBottom; 15736 int oldR = mRight; 15737 15738 boolean changed = isLayoutModeOptical(mParent) ? 15739 setOpticalFrame(l, t, r, b) : setFrame(l, t, r, b); 15740 15741 if (changed || (mPrivateFlags & PFLAG_LAYOUT_REQUIRED) == PFLAG_LAYOUT_REQUIRED) { 15742 onLayout(changed, l, t, r, b); 15743 mPrivateFlags &= ~PFLAG_LAYOUT_REQUIRED; 15744 15745 ListenerInfo li = mListenerInfo; 15746 if (li != null && li.mOnLayoutChangeListeners != null) { 15747 ArrayList<OnLayoutChangeListener> listenersCopy = 15748 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 15749 int numListeners = listenersCopy.size(); 15750 for (int i = 0; i < numListeners; ++i) { 15751 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 15752 } 15753 } 15754 } 15755 15756 mPrivateFlags &= ~PFLAG_FORCE_LAYOUT; 15757 mPrivateFlags3 |= PFLAG3_IS_LAID_OUT; 15758 } 15759 15760 /** 15761 * Called from layout when this view should 15762 * assign a size and position to each of its children. 15763 * 15764 * Derived classes with children should override 15765 * this method and call layout on each of 15766 * their children. 15767 * @param changed This is a new size or position for this view 15768 * @param left Left position, relative to parent 15769 * @param top Top position, relative to parent 15770 * @param right Right position, relative to parent 15771 * @param bottom Bottom position, relative to parent 15772 */ 15773 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 15774 } 15775 15776 /** 15777 * Assign a size and position to this view. 15778 * 15779 * This is called from layout. 15780 * 15781 * @param left Left position, relative to parent 15782 * @param top Top position, relative to parent 15783 * @param right Right position, relative to parent 15784 * @param bottom Bottom position, relative to parent 15785 * @return true if the new size and position are different than the 15786 * previous ones 15787 * {@hide} 15788 */ 15789 protected boolean setFrame(int left, int top, int right, int bottom) { 15790 boolean changed = false; 15791 15792 if (DBG) { 15793 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 15794 + right + "," + bottom + ")"); 15795 } 15796 15797 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 15798 changed = true; 15799 15800 // Remember our drawn bit 15801 int drawn = mPrivateFlags & PFLAG_DRAWN; 15802 15803 int oldWidth = mRight - mLeft; 15804 int oldHeight = mBottom - mTop; 15805 int newWidth = right - left; 15806 int newHeight = bottom - top; 15807 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 15808 15809 // Invalidate our old position 15810 invalidate(sizeChanged); 15811 15812 mLeft = left; 15813 mTop = top; 15814 mRight = right; 15815 mBottom = bottom; 15816 mRenderNode.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 15817 15818 mPrivateFlags |= PFLAG_HAS_BOUNDS; 15819 15820 15821 if (sizeChanged) { 15822 sizeChange(newWidth, newHeight, oldWidth, oldHeight); 15823 } 15824 15825 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE || mGhostView != null) { 15826 // If we are visible, force the DRAWN bit to on so that 15827 // this invalidate will go through (at least to our parent). 15828 // This is because someone may have invalidated this view 15829 // before this call to setFrame came in, thereby clearing 15830 // the DRAWN bit. 15831 mPrivateFlags |= PFLAG_DRAWN; 15832 invalidate(sizeChanged); 15833 // parent display list may need to be recreated based on a change in the bounds 15834 // of any child 15835 invalidateParentCaches(); 15836 } 15837 15838 // Reset drawn bit to original value (invalidate turns it off) 15839 mPrivateFlags |= drawn; 15840 15841 mBackgroundSizeChanged = true; 15842 15843 notifySubtreeAccessibilityStateChangedIfNeeded(); 15844 } 15845 return changed; 15846 } 15847 15848 /** 15849 * Same as setFrame, but public and hidden. For use in {@link android.transition.ChangeBounds}. 15850 * @hide 15851 */ 15852 public void setLeftTopRightBottom(int left, int top, int right, int bottom) { 15853 setFrame(left, top, right, bottom); 15854 } 15855 15856 private void sizeChange(int newWidth, int newHeight, int oldWidth, int oldHeight) { 15857 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 15858 if (mOverlay != null) { 15859 mOverlay.getOverlayView().setRight(newWidth); 15860 mOverlay.getOverlayView().setBottom(newHeight); 15861 } 15862 rebuildOutline(); 15863 } 15864 15865 /** 15866 * Finalize inflating a view from XML. This is called as the last phase 15867 * of inflation, after all child views have been added. 15868 * 15869 * <p>Even if the subclass overrides onFinishInflate, they should always be 15870 * sure to call the super method, so that we get called. 15871 */ 15872 protected void onFinishInflate() { 15873 } 15874 15875 /** 15876 * Returns the resources associated with this view. 15877 * 15878 * @return Resources object. 15879 */ 15880 public Resources getResources() { 15881 return mResources; 15882 } 15883 15884 /** 15885 * Invalidates the specified Drawable. 15886 * 15887 * @param drawable the drawable to invalidate 15888 */ 15889 @Override 15890 public void invalidateDrawable(@NonNull Drawable drawable) { 15891 if (verifyDrawable(drawable)) { 15892 final Rect dirty = drawable.getDirtyBounds(); 15893 final int scrollX = mScrollX; 15894 final int scrollY = mScrollY; 15895 15896 invalidate(dirty.left + scrollX, dirty.top + scrollY, 15897 dirty.right + scrollX, dirty.bottom + scrollY); 15898 rebuildOutline(); 15899 } 15900 } 15901 15902 /** 15903 * Schedules an action on a drawable to occur at a specified time. 15904 * 15905 * @param who the recipient of the action 15906 * @param what the action to run on the drawable 15907 * @param when the time at which the action must occur. Uses the 15908 * {@link SystemClock#uptimeMillis} timebase. 15909 */ 15910 @Override 15911 public void scheduleDrawable(Drawable who, Runnable what, long when) { 15912 if (verifyDrawable(who) && what != null) { 15913 final long delay = when - SystemClock.uptimeMillis(); 15914 if (mAttachInfo != null) { 15915 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 15916 Choreographer.CALLBACK_ANIMATION, what, who, 15917 Choreographer.subtractFrameDelay(delay)); 15918 } else { 15919 ViewRootImpl.getRunQueue().postDelayed(what, delay); 15920 } 15921 } 15922 } 15923 15924 /** 15925 * Cancels a scheduled action on a drawable. 15926 * 15927 * @param who the recipient of the action 15928 * @param what the action to cancel 15929 */ 15930 @Override 15931 public void unscheduleDrawable(Drawable who, Runnable what) { 15932 if (verifyDrawable(who) && what != null) { 15933 if (mAttachInfo != null) { 15934 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15935 Choreographer.CALLBACK_ANIMATION, what, who); 15936 } 15937 ViewRootImpl.getRunQueue().removeCallbacks(what); 15938 } 15939 } 15940 15941 /** 15942 * Unschedule any events associated with the given Drawable. This can be 15943 * used when selecting a new Drawable into a view, so that the previous 15944 * one is completely unscheduled. 15945 * 15946 * @param who The Drawable to unschedule. 15947 * 15948 * @see #drawableStateChanged 15949 */ 15950 public void unscheduleDrawable(Drawable who) { 15951 if (mAttachInfo != null && who != null) { 15952 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15953 Choreographer.CALLBACK_ANIMATION, null, who); 15954 } 15955 } 15956 15957 /** 15958 * Resolve the Drawables depending on the layout direction. This is implicitly supposing 15959 * that the View directionality can and will be resolved before its Drawables. 15960 * 15961 * Will call {@link View#onResolveDrawables} when resolution is done. 15962 * 15963 * @hide 15964 */ 15965 protected void resolveDrawables() { 15966 // Drawables resolution may need to happen before resolving the layout direction (which is 15967 // done only during the measure() call). 15968 // If the layout direction is not resolved yet, we cannot resolve the Drawables except in 15969 // one case: when the raw layout direction has not been defined as LAYOUT_DIRECTION_INHERIT. 15970 // So, if the raw layout direction is LAYOUT_DIRECTION_LTR or LAYOUT_DIRECTION_RTL or 15971 // LAYOUT_DIRECTION_LOCALE, we can "cheat" and we don't need to wait for the layout 15972 // direction to be resolved as its resolved value will be the same as its raw value. 15973 if (!isLayoutDirectionResolved() && 15974 getRawLayoutDirection() == View.LAYOUT_DIRECTION_INHERIT) { 15975 return; 15976 } 15977 15978 final int layoutDirection = isLayoutDirectionResolved() ? 15979 getLayoutDirection() : getRawLayoutDirection(); 15980 15981 if (mBackground != null) { 15982 mBackground.setLayoutDirection(layoutDirection); 15983 } 15984 mPrivateFlags2 |= PFLAG2_DRAWABLE_RESOLVED; 15985 onResolveDrawables(layoutDirection); 15986 } 15987 15988 boolean areDrawablesResolved() { 15989 return (mPrivateFlags2 & PFLAG2_DRAWABLE_RESOLVED) == PFLAG2_DRAWABLE_RESOLVED; 15990 } 15991 15992 /** 15993 * Called when layout direction has been resolved. 15994 * 15995 * The default implementation does nothing. 15996 * 15997 * @param layoutDirection The resolved layout direction. 15998 * 15999 * @see #LAYOUT_DIRECTION_LTR 16000 * @see #LAYOUT_DIRECTION_RTL 16001 * 16002 * @hide 16003 */ 16004 public void onResolveDrawables(@ResolvedLayoutDir int layoutDirection) { 16005 } 16006 16007 /** 16008 * @hide 16009 */ 16010 protected void resetResolvedDrawables() { 16011 resetResolvedDrawablesInternal(); 16012 } 16013 16014 void resetResolvedDrawablesInternal() { 16015 mPrivateFlags2 &= ~PFLAG2_DRAWABLE_RESOLVED; 16016 } 16017 16018 /** 16019 * If your view subclass is displaying its own Drawable objects, it should 16020 * override this function and return true for any Drawable it is 16021 * displaying. This allows animations for those drawables to be 16022 * scheduled. 16023 * 16024 * <p>Be sure to call through to the super class when overriding this 16025 * function. 16026 * 16027 * @param who The Drawable to verify. Return true if it is one you are 16028 * displaying, else return the result of calling through to the 16029 * super class. 16030 * 16031 * @return boolean If true than the Drawable is being displayed in the 16032 * view; else false and it is not allowed to animate. 16033 * 16034 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 16035 * @see #drawableStateChanged() 16036 */ 16037 protected boolean verifyDrawable(Drawable who) { 16038 return who == mBackground; 16039 } 16040 16041 /** 16042 * This function is called whenever the state of the view changes in such 16043 * a way that it impacts the state of drawables being shown. 16044 * <p> 16045 * If the View has a StateListAnimator, it will also be called to run necessary state 16046 * change animations. 16047 * <p> 16048 * Be sure to call through to the superclass when overriding this function. 16049 * 16050 * @see Drawable#setState(int[]) 16051 */ 16052 protected void drawableStateChanged() { 16053 final Drawable d = mBackground; 16054 if (d != null && d.isStateful()) { 16055 d.setState(getDrawableState()); 16056 } 16057 16058 if (mStateListAnimator != null) { 16059 mStateListAnimator.setState(getDrawableState()); 16060 } 16061 } 16062 16063 /** 16064 * This function is called whenever the view hotspot changes and needs to 16065 * be propagated to drawables managed by the view. 16066 * <p> 16067 * Be sure to call through to the superclass when overriding this function. 16068 * 16069 * @param x hotspot x coordinate 16070 * @param y hotspot y coordinate 16071 */ 16072 public void drawableHotspotChanged(float x, float y) { 16073 if (mBackground != null) { 16074 mBackground.setHotspot(x, y); 16075 } 16076 } 16077 16078 /** 16079 * Call this to force a view to update its drawable state. This will cause 16080 * drawableStateChanged to be called on this view. Views that are interested 16081 * in the new state should call getDrawableState. 16082 * 16083 * @see #drawableStateChanged 16084 * @see #getDrawableState 16085 */ 16086 public void refreshDrawableState() { 16087 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 16088 drawableStateChanged(); 16089 16090 ViewParent parent = mParent; 16091 if (parent != null) { 16092 parent.childDrawableStateChanged(this); 16093 } 16094 } 16095 16096 /** 16097 * Return an array of resource IDs of the drawable states representing the 16098 * current state of the view. 16099 * 16100 * @return The current drawable state 16101 * 16102 * @see Drawable#setState(int[]) 16103 * @see #drawableStateChanged() 16104 * @see #onCreateDrawableState(int) 16105 */ 16106 public final int[] getDrawableState() { 16107 if ((mDrawableState != null) && ((mPrivateFlags & PFLAG_DRAWABLE_STATE_DIRTY) == 0)) { 16108 return mDrawableState; 16109 } else { 16110 mDrawableState = onCreateDrawableState(0); 16111 mPrivateFlags &= ~PFLAG_DRAWABLE_STATE_DIRTY; 16112 return mDrawableState; 16113 } 16114 } 16115 16116 /** 16117 * Generate the new {@link android.graphics.drawable.Drawable} state for 16118 * this view. This is called by the view 16119 * system when the cached Drawable state is determined to be invalid. To 16120 * retrieve the current state, you should use {@link #getDrawableState}. 16121 * 16122 * @param extraSpace if non-zero, this is the number of extra entries you 16123 * would like in the returned array in which you can place your own 16124 * states. 16125 * 16126 * @return Returns an array holding the current {@link Drawable} state of 16127 * the view. 16128 * 16129 * @see #mergeDrawableStates(int[], int[]) 16130 */ 16131 protected int[] onCreateDrawableState(int extraSpace) { 16132 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 16133 mParent instanceof View) { 16134 return ((View) mParent).onCreateDrawableState(extraSpace); 16135 } 16136 16137 int[] drawableState; 16138 16139 int privateFlags = mPrivateFlags; 16140 16141 int viewStateIndex = 0; 16142 if ((privateFlags & PFLAG_PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 16143 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 16144 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 16145 if ((privateFlags & PFLAG_SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 16146 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 16147 if ((privateFlags & PFLAG_ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 16148 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 16149 HardwareRenderer.isAvailable()) { 16150 // This is set if HW acceleration is requested, even if the current 16151 // process doesn't allow it. This is just to allow app preview 16152 // windows to better match their app. 16153 viewStateIndex |= VIEW_STATE_ACCELERATED; 16154 } 16155 if ((privateFlags & PFLAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 16156 16157 final int privateFlags2 = mPrivateFlags2; 16158 if ((privateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 16159 if ((privateFlags2 & PFLAG2_DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 16160 16161 drawableState = VIEW_STATE_SETS[viewStateIndex]; 16162 16163 //noinspection ConstantIfStatement 16164 if (false) { 16165 Log.i("View", "drawableStateIndex=" + viewStateIndex); 16166 Log.i("View", toString() 16167 + " pressed=" + ((privateFlags & PFLAG_PRESSED) != 0) 16168 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 16169 + " fo=" + hasFocus() 16170 + " sl=" + ((privateFlags & PFLAG_SELECTED) != 0) 16171 + " wf=" + hasWindowFocus() 16172 + ": " + Arrays.toString(drawableState)); 16173 } 16174 16175 if (extraSpace == 0) { 16176 return drawableState; 16177 } 16178 16179 final int[] fullState; 16180 if (drawableState != null) { 16181 fullState = new int[drawableState.length + extraSpace]; 16182 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 16183 } else { 16184 fullState = new int[extraSpace]; 16185 } 16186 16187 return fullState; 16188 } 16189 16190 /** 16191 * Merge your own state values in <var>additionalState</var> into the base 16192 * state values <var>baseState</var> that were returned by 16193 * {@link #onCreateDrawableState(int)}. 16194 * 16195 * @param baseState The base state values returned by 16196 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 16197 * own additional state values. 16198 * 16199 * @param additionalState The additional state values you would like 16200 * added to <var>baseState</var>; this array is not modified. 16201 * 16202 * @return As a convenience, the <var>baseState</var> array you originally 16203 * passed into the function is returned. 16204 * 16205 * @see #onCreateDrawableState(int) 16206 */ 16207 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 16208 final int N = baseState.length; 16209 int i = N - 1; 16210 while (i >= 0 && baseState[i] == 0) { 16211 i--; 16212 } 16213 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 16214 return baseState; 16215 } 16216 16217 /** 16218 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 16219 * on all Drawable objects associated with this view. 16220 * <p> 16221 * Also calls {@link StateListAnimator#jumpToCurrentState()} if there is a StateListAnimator 16222 * attached to this view. 16223 */ 16224 public void jumpDrawablesToCurrentState() { 16225 if (mBackground != null) { 16226 mBackground.jumpToCurrentState(); 16227 } 16228 if (mStateListAnimator != null) { 16229 mStateListAnimator.jumpToCurrentState(); 16230 } 16231 } 16232 16233 /** 16234 * Sets the background color for this view. 16235 * @param color the color of the background 16236 */ 16237 @RemotableViewMethod 16238 public void setBackgroundColor(int color) { 16239 if (mBackground instanceof ColorDrawable) { 16240 ((ColorDrawable) mBackground.mutate()).setColor(color); 16241 computeOpaqueFlags(); 16242 mBackgroundResource = 0; 16243 } else { 16244 setBackground(new ColorDrawable(color)); 16245 } 16246 } 16247 16248 /** 16249 * Set the background to a given resource. The resource should refer to 16250 * a Drawable object or 0 to remove the background. 16251 * @param resid The identifier of the resource. 16252 * 16253 * @attr ref android.R.styleable#View_background 16254 */ 16255 @RemotableViewMethod 16256 public void setBackgroundResource(int resid) { 16257 if (resid != 0 && resid == mBackgroundResource) { 16258 return; 16259 } 16260 16261 Drawable d = null; 16262 if (resid != 0) { 16263 d = mContext.getDrawable(resid); 16264 } 16265 setBackground(d); 16266 16267 mBackgroundResource = resid; 16268 } 16269 16270 /** 16271 * Set the background to a given Drawable, or remove the background. If the 16272 * background has padding, this View's padding is set to the background's 16273 * padding. However, when a background is removed, this View's padding isn't 16274 * touched. If setting the padding is desired, please use 16275 * {@link #setPadding(int, int, int, int)}. 16276 * 16277 * @param background The Drawable to use as the background, or null to remove the 16278 * background 16279 */ 16280 public void setBackground(Drawable background) { 16281 //noinspection deprecation 16282 setBackgroundDrawable(background); 16283 } 16284 16285 /** 16286 * @deprecated use {@link #setBackground(Drawable)} instead 16287 */ 16288 @Deprecated 16289 public void setBackgroundDrawable(Drawable background) { 16290 computeOpaqueFlags(); 16291 16292 if (background == mBackground) { 16293 return; 16294 } 16295 16296 boolean requestLayout = false; 16297 16298 mBackgroundResource = 0; 16299 16300 /* 16301 * Regardless of whether we're setting a new background or not, we want 16302 * to clear the previous drawable. 16303 */ 16304 if (mBackground != null) { 16305 mBackground.setCallback(null); 16306 unscheduleDrawable(mBackground); 16307 } 16308 16309 if (background != null) { 16310 Rect padding = sThreadLocal.get(); 16311 if (padding == null) { 16312 padding = new Rect(); 16313 sThreadLocal.set(padding); 16314 } 16315 resetResolvedDrawablesInternal(); 16316 background.setLayoutDirection(getLayoutDirection()); 16317 if (background.getPadding(padding)) { 16318 resetResolvedPaddingInternal(); 16319 switch (background.getLayoutDirection()) { 16320 case LAYOUT_DIRECTION_RTL: 16321 mUserPaddingLeftInitial = padding.right; 16322 mUserPaddingRightInitial = padding.left; 16323 internalSetPadding(padding.right, padding.top, padding.left, padding.bottom); 16324 break; 16325 case LAYOUT_DIRECTION_LTR: 16326 default: 16327 mUserPaddingLeftInitial = padding.left; 16328 mUserPaddingRightInitial = padding.right; 16329 internalSetPadding(padding.left, padding.top, padding.right, padding.bottom); 16330 } 16331 mLeftPaddingDefined = false; 16332 mRightPaddingDefined = false; 16333 } 16334 16335 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 16336 // if it has a different minimum size, we should layout again 16337 if (mBackground == null 16338 || mBackground.getMinimumHeight() != background.getMinimumHeight() 16339 || mBackground.getMinimumWidth() != background.getMinimumWidth()) { 16340 requestLayout = true; 16341 } 16342 16343 background.setCallback(this); 16344 if (background.isStateful()) { 16345 background.setState(getDrawableState()); 16346 } 16347 background.setVisible(getVisibility() == VISIBLE, false); 16348 mBackground = background; 16349 16350 applyBackgroundTint(); 16351 16352 if ((mPrivateFlags & PFLAG_SKIP_DRAW) != 0) { 16353 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 16354 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 16355 requestLayout = true; 16356 } 16357 } else { 16358 /* Remove the background */ 16359 mBackground = null; 16360 16361 if ((mPrivateFlags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0) { 16362 /* 16363 * This view ONLY drew the background before and we're removing 16364 * the background, so now it won't draw anything 16365 * (hence we SKIP_DRAW) 16366 */ 16367 mPrivateFlags &= ~PFLAG_ONLY_DRAWS_BACKGROUND; 16368 mPrivateFlags |= PFLAG_SKIP_DRAW; 16369 } 16370 16371 /* 16372 * When the background is set, we try to apply its padding to this 16373 * View. When the background is removed, we don't touch this View's 16374 * padding. This is noted in the Javadocs. Hence, we don't need to 16375 * requestLayout(), the invalidate() below is sufficient. 16376 */ 16377 16378 // The old background's minimum size could have affected this 16379 // View's layout, so let's requestLayout 16380 requestLayout = true; 16381 } 16382 16383 computeOpaqueFlags(); 16384 16385 if (requestLayout) { 16386 requestLayout(); 16387 } 16388 16389 mBackgroundSizeChanged = true; 16390 invalidate(true); 16391 } 16392 16393 /** 16394 * Gets the background drawable 16395 * 16396 * @return The drawable used as the background for this view, if any. 16397 * 16398 * @see #setBackground(Drawable) 16399 * 16400 * @attr ref android.R.styleable#View_background 16401 */ 16402 public Drawable getBackground() { 16403 return mBackground; 16404 } 16405 16406 /** 16407 * Applies a tint to the background drawable. Does not modify the current tint 16408 * mode, which is {@link PorterDuff.Mode#SRC_IN} by default. 16409 * <p> 16410 * Subsequent calls to {@link #setBackground(Drawable)} will automatically 16411 * mutate the drawable and apply the specified tint and tint mode using 16412 * {@link Drawable#setTintList(ColorStateList)}. 16413 * 16414 * @param tint the tint to apply, may be {@code null} to clear tint 16415 * 16416 * @attr ref android.R.styleable#View_backgroundTint 16417 * @see #getBackgroundTintList() 16418 * @see Drawable#setTintList(ColorStateList) 16419 */ 16420 public void setBackgroundTintList(@Nullable ColorStateList tint) { 16421 if (mBackgroundTint == null) { 16422 mBackgroundTint = new TintInfo(); 16423 } 16424 mBackgroundTint.mTintList = tint; 16425 mBackgroundTint.mHasTintList = true; 16426 16427 applyBackgroundTint(); 16428 } 16429 16430 /** 16431 * Return the tint applied to the background drawable, if specified. 16432 * 16433 * @return the tint applied to the background drawable 16434 * @attr ref android.R.styleable#View_backgroundTint 16435 * @see #setBackgroundTintList(ColorStateList) 16436 */ 16437 @Nullable 16438 public ColorStateList getBackgroundTintList() { 16439 return mBackgroundTint != null ? mBackgroundTint.mTintList : null; 16440 } 16441 16442 /** 16443 * Specifies the blending mode used to apply the tint specified by 16444 * {@link #setBackgroundTintList(ColorStateList)}} to the background 16445 * drawable. The default mode is {@link PorterDuff.Mode#SRC_IN}. 16446 * 16447 * @param tintMode the blending mode used to apply the tint, may be 16448 * {@code null} to clear tint 16449 * @attr ref android.R.styleable#View_backgroundTintMode 16450 * @see #getBackgroundTintMode() 16451 * @see Drawable#setTintMode(PorterDuff.Mode) 16452 */ 16453 public void setBackgroundTintMode(@Nullable PorterDuff.Mode tintMode) { 16454 if (mBackgroundTint == null) { 16455 mBackgroundTint = new TintInfo(); 16456 } 16457 mBackgroundTint.mTintMode = tintMode; 16458 mBackgroundTint.mHasTintMode = true; 16459 16460 applyBackgroundTint(); 16461 } 16462 16463 /** 16464 * Return the blending mode used to apply the tint to the background 16465 * drawable, if specified. 16466 * 16467 * @return the blending mode used to apply the tint to the background 16468 * drawable 16469 * @attr ref android.R.styleable#View_backgroundTintMode 16470 * @see #setBackgroundTintMode(PorterDuff.Mode) 16471 */ 16472 @Nullable 16473 public PorterDuff.Mode getBackgroundTintMode() { 16474 return mBackgroundTint != null ? mBackgroundTint.mTintMode : null; 16475 } 16476 16477 private void applyBackgroundTint() { 16478 if (mBackground != null && mBackgroundTint != null) { 16479 final TintInfo tintInfo = mBackgroundTint; 16480 if (tintInfo.mHasTintList || tintInfo.mHasTintMode) { 16481 mBackground = mBackground.mutate(); 16482 16483 if (tintInfo.mHasTintList) { 16484 mBackground.setTintList(tintInfo.mTintList); 16485 } 16486 16487 if (tintInfo.mHasTintMode) { 16488 mBackground.setTintMode(tintInfo.mTintMode); 16489 } 16490 16491 // The drawable (or one of its children) may not have been 16492 // stateful before applying the tint, so let's try again. 16493 if (mBackground.isStateful()) { 16494 mBackground.setState(getDrawableState()); 16495 } 16496 } 16497 } 16498 } 16499 16500 /** 16501 * Sets the padding. The view may add on the space required to display 16502 * the scrollbars, depending on the style and visibility of the scrollbars. 16503 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 16504 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 16505 * from the values set in this call. 16506 * 16507 * @attr ref android.R.styleable#View_padding 16508 * @attr ref android.R.styleable#View_paddingBottom 16509 * @attr ref android.R.styleable#View_paddingLeft 16510 * @attr ref android.R.styleable#View_paddingRight 16511 * @attr ref android.R.styleable#View_paddingTop 16512 * @param left the left padding in pixels 16513 * @param top the top padding in pixels 16514 * @param right the right padding in pixels 16515 * @param bottom the bottom padding in pixels 16516 */ 16517 public void setPadding(int left, int top, int right, int bottom) { 16518 resetResolvedPaddingInternal(); 16519 16520 mUserPaddingStart = UNDEFINED_PADDING; 16521 mUserPaddingEnd = UNDEFINED_PADDING; 16522 16523 mUserPaddingLeftInitial = left; 16524 mUserPaddingRightInitial = right; 16525 16526 mLeftPaddingDefined = true; 16527 mRightPaddingDefined = true; 16528 16529 internalSetPadding(left, top, right, bottom); 16530 } 16531 16532 /** 16533 * @hide 16534 */ 16535 protected void internalSetPadding(int left, int top, int right, int bottom) { 16536 mUserPaddingLeft = left; 16537 mUserPaddingRight = right; 16538 mUserPaddingBottom = bottom; 16539 16540 final int viewFlags = mViewFlags; 16541 boolean changed = false; 16542 16543 // Common case is there are no scroll bars. 16544 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 16545 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 16546 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 16547 ? 0 : getVerticalScrollbarWidth(); 16548 switch (mVerticalScrollbarPosition) { 16549 case SCROLLBAR_POSITION_DEFAULT: 16550 if (isLayoutRtl()) { 16551 left += offset; 16552 } else { 16553 right += offset; 16554 } 16555 break; 16556 case SCROLLBAR_POSITION_RIGHT: 16557 right += offset; 16558 break; 16559 case SCROLLBAR_POSITION_LEFT: 16560 left += offset; 16561 break; 16562 } 16563 } 16564 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 16565 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 16566 ? 0 : getHorizontalScrollbarHeight(); 16567 } 16568 } 16569 16570 if (mPaddingLeft != left) { 16571 changed = true; 16572 mPaddingLeft = left; 16573 } 16574 if (mPaddingTop != top) { 16575 changed = true; 16576 mPaddingTop = top; 16577 } 16578 if (mPaddingRight != right) { 16579 changed = true; 16580 mPaddingRight = right; 16581 } 16582 if (mPaddingBottom != bottom) { 16583 changed = true; 16584 mPaddingBottom = bottom; 16585 } 16586 16587 if (changed) { 16588 requestLayout(); 16589 } 16590 } 16591 16592 /** 16593 * Sets the relative padding. The view may add on the space required to display 16594 * the scrollbars, depending on the style and visibility of the scrollbars. 16595 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 16596 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 16597 * from the values set in this call. 16598 * 16599 * @attr ref android.R.styleable#View_padding 16600 * @attr ref android.R.styleable#View_paddingBottom 16601 * @attr ref android.R.styleable#View_paddingStart 16602 * @attr ref android.R.styleable#View_paddingEnd 16603 * @attr ref android.R.styleable#View_paddingTop 16604 * @param start the start padding in pixels 16605 * @param top the top padding in pixels 16606 * @param end the end padding in pixels 16607 * @param bottom the bottom padding in pixels 16608 */ 16609 public void setPaddingRelative(int start, int top, int end, int bottom) { 16610 resetResolvedPaddingInternal(); 16611 16612 mUserPaddingStart = start; 16613 mUserPaddingEnd = end; 16614 mLeftPaddingDefined = true; 16615 mRightPaddingDefined = true; 16616 16617 switch(getLayoutDirection()) { 16618 case LAYOUT_DIRECTION_RTL: 16619 mUserPaddingLeftInitial = end; 16620 mUserPaddingRightInitial = start; 16621 internalSetPadding(end, top, start, bottom); 16622 break; 16623 case LAYOUT_DIRECTION_LTR: 16624 default: 16625 mUserPaddingLeftInitial = start; 16626 mUserPaddingRightInitial = end; 16627 internalSetPadding(start, top, end, bottom); 16628 } 16629 } 16630 16631 /** 16632 * Returns the top padding of this view. 16633 * 16634 * @return the top padding in pixels 16635 */ 16636 public int getPaddingTop() { 16637 return mPaddingTop; 16638 } 16639 16640 /** 16641 * Returns the bottom padding of this view. If there are inset and enabled 16642 * scrollbars, this value may include the space required to display the 16643 * scrollbars as well. 16644 * 16645 * @return the bottom padding in pixels 16646 */ 16647 public int getPaddingBottom() { 16648 return mPaddingBottom; 16649 } 16650 16651 /** 16652 * Returns the left padding of this view. If there are inset and enabled 16653 * scrollbars, this value may include the space required to display the 16654 * scrollbars as well. 16655 * 16656 * @return the left padding in pixels 16657 */ 16658 public int getPaddingLeft() { 16659 if (!isPaddingResolved()) { 16660 resolvePadding(); 16661 } 16662 return mPaddingLeft; 16663 } 16664 16665 /** 16666 * Returns the start padding of this view depending on its resolved layout direction. 16667 * If there are inset and enabled scrollbars, this value may include the space 16668 * required to display the scrollbars as well. 16669 * 16670 * @return the start padding in pixels 16671 */ 16672 public int getPaddingStart() { 16673 if (!isPaddingResolved()) { 16674 resolvePadding(); 16675 } 16676 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16677 mPaddingRight : mPaddingLeft; 16678 } 16679 16680 /** 16681 * Returns the right padding of this view. If there are inset and enabled 16682 * scrollbars, this value may include the space required to display the 16683 * scrollbars as well. 16684 * 16685 * @return the right padding in pixels 16686 */ 16687 public int getPaddingRight() { 16688 if (!isPaddingResolved()) { 16689 resolvePadding(); 16690 } 16691 return mPaddingRight; 16692 } 16693 16694 /** 16695 * Returns the end padding of this view depending on its resolved layout direction. 16696 * If there are inset and enabled scrollbars, this value may include the space 16697 * required to display the scrollbars as well. 16698 * 16699 * @return the end padding in pixels 16700 */ 16701 public int getPaddingEnd() { 16702 if (!isPaddingResolved()) { 16703 resolvePadding(); 16704 } 16705 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16706 mPaddingLeft : mPaddingRight; 16707 } 16708 16709 /** 16710 * Return if the padding as been set thru relative values 16711 * {@link #setPaddingRelative(int, int, int, int)} or thru 16712 * @attr ref android.R.styleable#View_paddingStart or 16713 * @attr ref android.R.styleable#View_paddingEnd 16714 * 16715 * @return true if the padding is relative or false if it is not. 16716 */ 16717 public boolean isPaddingRelative() { 16718 return (mUserPaddingStart != UNDEFINED_PADDING || mUserPaddingEnd != UNDEFINED_PADDING); 16719 } 16720 16721 Insets computeOpticalInsets() { 16722 return (mBackground == null) ? Insets.NONE : mBackground.getOpticalInsets(); 16723 } 16724 16725 /** 16726 * @hide 16727 */ 16728 public void resetPaddingToInitialValues() { 16729 if (isRtlCompatibilityMode()) { 16730 mPaddingLeft = mUserPaddingLeftInitial; 16731 mPaddingRight = mUserPaddingRightInitial; 16732 return; 16733 } 16734 if (isLayoutRtl()) { 16735 mPaddingLeft = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingLeftInitial; 16736 mPaddingRight = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingRightInitial; 16737 } else { 16738 mPaddingLeft = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingLeftInitial; 16739 mPaddingRight = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingRightInitial; 16740 } 16741 } 16742 16743 /** 16744 * @hide 16745 */ 16746 public Insets getOpticalInsets() { 16747 if (mLayoutInsets == null) { 16748 mLayoutInsets = computeOpticalInsets(); 16749 } 16750 return mLayoutInsets; 16751 } 16752 16753 /** 16754 * Set this view's optical insets. 16755 * 16756 * <p>This method should be treated similarly to setMeasuredDimension and not as a general 16757 * property. Views that compute their own optical insets should call it as part of measurement. 16758 * This method does not request layout. If you are setting optical insets outside of 16759 * measure/layout itself you will want to call requestLayout() yourself. 16760 * </p> 16761 * @hide 16762 */ 16763 public void setOpticalInsets(Insets insets) { 16764 mLayoutInsets = insets; 16765 } 16766 16767 /** 16768 * Changes the selection state of this view. A view can be selected or not. 16769 * Note that selection is not the same as focus. Views are typically 16770 * selected in the context of an AdapterView like ListView or GridView; 16771 * the selected view is the view that is highlighted. 16772 * 16773 * @param selected true if the view must be selected, false otherwise 16774 */ 16775 public void setSelected(boolean selected) { 16776 //noinspection DoubleNegation 16777 if (((mPrivateFlags & PFLAG_SELECTED) != 0) != selected) { 16778 mPrivateFlags = (mPrivateFlags & ~PFLAG_SELECTED) | (selected ? PFLAG_SELECTED : 0); 16779 if (!selected) resetPressedState(); 16780 invalidate(true); 16781 refreshDrawableState(); 16782 dispatchSetSelected(selected); 16783 if (selected) { 16784 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SELECTED); 16785 } else { 16786 notifyViewAccessibilityStateChangedIfNeeded( 16787 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 16788 } 16789 } 16790 } 16791 16792 /** 16793 * Dispatch setSelected to all of this View's children. 16794 * 16795 * @see #setSelected(boolean) 16796 * 16797 * @param selected The new selected state 16798 */ 16799 protected void dispatchSetSelected(boolean selected) { 16800 } 16801 16802 /** 16803 * Indicates the selection state of this view. 16804 * 16805 * @return true if the view is selected, false otherwise 16806 */ 16807 @ViewDebug.ExportedProperty 16808 public boolean isSelected() { 16809 return (mPrivateFlags & PFLAG_SELECTED) != 0; 16810 } 16811 16812 /** 16813 * Changes the activated state of this view. A view can be activated or not. 16814 * Note that activation is not the same as selection. Selection is 16815 * a transient property, representing the view (hierarchy) the user is 16816 * currently interacting with. Activation is a longer-term state that the 16817 * user can move views in and out of. For example, in a list view with 16818 * single or multiple selection enabled, the views in the current selection 16819 * set are activated. (Um, yeah, we are deeply sorry about the terminology 16820 * here.) The activated state is propagated down to children of the view it 16821 * is set on. 16822 * 16823 * @param activated true if the view must be activated, false otherwise 16824 */ 16825 public void setActivated(boolean activated) { 16826 //noinspection DoubleNegation 16827 if (((mPrivateFlags & PFLAG_ACTIVATED) != 0) != activated) { 16828 mPrivateFlags = (mPrivateFlags & ~PFLAG_ACTIVATED) | (activated ? PFLAG_ACTIVATED : 0); 16829 invalidate(true); 16830 refreshDrawableState(); 16831 dispatchSetActivated(activated); 16832 } 16833 } 16834 16835 /** 16836 * Dispatch setActivated to all of this View's children. 16837 * 16838 * @see #setActivated(boolean) 16839 * 16840 * @param activated The new activated state 16841 */ 16842 protected void dispatchSetActivated(boolean activated) { 16843 } 16844 16845 /** 16846 * Indicates the activation state of this view. 16847 * 16848 * @return true if the view is activated, false otherwise 16849 */ 16850 @ViewDebug.ExportedProperty 16851 public boolean isActivated() { 16852 return (mPrivateFlags & PFLAG_ACTIVATED) != 0; 16853 } 16854 16855 /** 16856 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 16857 * observer can be used to get notifications when global events, like 16858 * layout, happen. 16859 * 16860 * The returned ViewTreeObserver observer is not guaranteed to remain 16861 * valid for the lifetime of this View. If the caller of this method keeps 16862 * a long-lived reference to ViewTreeObserver, it should always check for 16863 * the return value of {@link ViewTreeObserver#isAlive()}. 16864 * 16865 * @return The ViewTreeObserver for this view's hierarchy. 16866 */ 16867 public ViewTreeObserver getViewTreeObserver() { 16868 if (mAttachInfo != null) { 16869 return mAttachInfo.mTreeObserver; 16870 } 16871 if (mFloatingTreeObserver == null) { 16872 mFloatingTreeObserver = new ViewTreeObserver(); 16873 } 16874 return mFloatingTreeObserver; 16875 } 16876 16877 /** 16878 * <p>Finds the topmost view in the current view hierarchy.</p> 16879 * 16880 * @return the topmost view containing this view 16881 */ 16882 public View getRootView() { 16883 if (mAttachInfo != null) { 16884 final View v = mAttachInfo.mRootView; 16885 if (v != null) { 16886 return v; 16887 } 16888 } 16889 16890 View parent = this; 16891 16892 while (parent.mParent != null && parent.mParent instanceof View) { 16893 parent = (View) parent.mParent; 16894 } 16895 16896 return parent; 16897 } 16898 16899 /** 16900 * Transforms a motion event from view-local coordinates to on-screen 16901 * coordinates. 16902 * 16903 * @param ev the view-local motion event 16904 * @return false if the transformation could not be applied 16905 * @hide 16906 */ 16907 public boolean toGlobalMotionEvent(MotionEvent ev) { 16908 final AttachInfo info = mAttachInfo; 16909 if (info == null) { 16910 return false; 16911 } 16912 16913 final Matrix m = info.mTmpMatrix; 16914 m.set(Matrix.IDENTITY_MATRIX); 16915 transformMatrixToGlobal(m); 16916 ev.transform(m); 16917 return true; 16918 } 16919 16920 /** 16921 * Transforms a motion event from on-screen coordinates to view-local 16922 * coordinates. 16923 * 16924 * @param ev the on-screen motion event 16925 * @return false if the transformation could not be applied 16926 * @hide 16927 */ 16928 public boolean toLocalMotionEvent(MotionEvent ev) { 16929 final AttachInfo info = mAttachInfo; 16930 if (info == null) { 16931 return false; 16932 } 16933 16934 final Matrix m = info.mTmpMatrix; 16935 m.set(Matrix.IDENTITY_MATRIX); 16936 transformMatrixToLocal(m); 16937 ev.transform(m); 16938 return true; 16939 } 16940 16941 /** 16942 * Modifies the input matrix such that it maps view-local coordinates to 16943 * on-screen coordinates. 16944 * 16945 * @param m input matrix to modify 16946 * @hide 16947 */ 16948 public void transformMatrixToGlobal(Matrix m) { 16949 final ViewParent parent = mParent; 16950 if (parent instanceof View) { 16951 final View vp = (View) parent; 16952 vp.transformMatrixToGlobal(m); 16953 m.preTranslate(-vp.mScrollX, -vp.mScrollY); 16954 } else if (parent instanceof ViewRootImpl) { 16955 final ViewRootImpl vr = (ViewRootImpl) parent; 16956 vr.transformMatrixToGlobal(m); 16957 m.preTranslate(0, -vr.mCurScrollY); 16958 } 16959 16960 m.preTranslate(mLeft, mTop); 16961 16962 if (!hasIdentityMatrix()) { 16963 m.preConcat(getMatrix()); 16964 } 16965 } 16966 16967 /** 16968 * Modifies the input matrix such that it maps on-screen coordinates to 16969 * view-local coordinates. 16970 * 16971 * @param m input matrix to modify 16972 * @hide 16973 */ 16974 public void transformMatrixToLocal(Matrix m) { 16975 final ViewParent parent = mParent; 16976 if (parent instanceof View) { 16977 final View vp = (View) parent; 16978 vp.transformMatrixToLocal(m); 16979 m.postTranslate(vp.mScrollX, vp.mScrollY); 16980 } else if (parent instanceof ViewRootImpl) { 16981 final ViewRootImpl vr = (ViewRootImpl) parent; 16982 vr.transformMatrixToLocal(m); 16983 m.postTranslate(0, vr.mCurScrollY); 16984 } 16985 16986 m.postTranslate(-mLeft, -mTop); 16987 16988 if (!hasIdentityMatrix()) { 16989 m.postConcat(getInverseMatrix()); 16990 } 16991 } 16992 16993 /** 16994 * @hide 16995 */ 16996 @ViewDebug.ExportedProperty(category = "layout", indexMapping = { 16997 @ViewDebug.IntToString(from = 0, to = "x"), 16998 @ViewDebug.IntToString(from = 1, to = "y") 16999 }) 17000 public int[] getLocationOnScreen() { 17001 int[] location = new int[2]; 17002 getLocationOnScreen(location); 17003 return location; 17004 } 17005 17006 /** 17007 * <p>Computes the coordinates of this view on the screen. The argument 17008 * must be an array of two integers. After the method returns, the array 17009 * contains the x and y location in that order.</p> 17010 * 17011 * @param location an array of two integers in which to hold the coordinates 17012 */ 17013 public void getLocationOnScreen(int[] location) { 17014 getLocationInWindow(location); 17015 17016 final AttachInfo info = mAttachInfo; 17017 if (info != null) { 17018 location[0] += info.mWindowLeft; 17019 location[1] += info.mWindowTop; 17020 } 17021 } 17022 17023 /** 17024 * <p>Computes the coordinates of this view in its window. The argument 17025 * must be an array of two integers. After the method returns, the array 17026 * contains the x and y location in that order.</p> 17027 * 17028 * @param location an array of two integers in which to hold the coordinates 17029 */ 17030 public void getLocationInWindow(int[] location) { 17031 if (location == null || location.length < 2) { 17032 throw new IllegalArgumentException("location must be an array of two integers"); 17033 } 17034 17035 if (mAttachInfo == null) { 17036 // When the view is not attached to a window, this method does not make sense 17037 location[0] = location[1] = 0; 17038 return; 17039 } 17040 17041 float[] position = mAttachInfo.mTmpTransformLocation; 17042 position[0] = position[1] = 0.0f; 17043 17044 if (!hasIdentityMatrix()) { 17045 getMatrix().mapPoints(position); 17046 } 17047 17048 position[0] += mLeft; 17049 position[1] += mTop; 17050 17051 ViewParent viewParent = mParent; 17052 while (viewParent instanceof View) { 17053 final View view = (View) viewParent; 17054 17055 position[0] -= view.mScrollX; 17056 position[1] -= view.mScrollY; 17057 17058 if (!view.hasIdentityMatrix()) { 17059 view.getMatrix().mapPoints(position); 17060 } 17061 17062 position[0] += view.mLeft; 17063 position[1] += view.mTop; 17064 17065 viewParent = view.mParent; 17066 } 17067 17068 if (viewParent instanceof ViewRootImpl) { 17069 // *cough* 17070 final ViewRootImpl vr = (ViewRootImpl) viewParent; 17071 position[1] -= vr.mCurScrollY; 17072 } 17073 17074 location[0] = (int) (position[0] + 0.5f); 17075 location[1] = (int) (position[1] + 0.5f); 17076 } 17077 17078 /** 17079 * {@hide} 17080 * @param id the id of the view to be found 17081 * @return the view of the specified id, null if cannot be found 17082 */ 17083 protected View findViewTraversal(int id) { 17084 if (id == mID) { 17085 return this; 17086 } 17087 return null; 17088 } 17089 17090 /** 17091 * {@hide} 17092 * @param tag the tag of the view to be found 17093 * @return the view of specified tag, null if cannot be found 17094 */ 17095 protected View findViewWithTagTraversal(Object tag) { 17096 if (tag != null && tag.equals(mTag)) { 17097 return this; 17098 } 17099 return null; 17100 } 17101 17102 /** 17103 * {@hide} 17104 * @param predicate The predicate to evaluate. 17105 * @param childToSkip If not null, ignores this child during the recursive traversal. 17106 * @return The first view that matches the predicate or null. 17107 */ 17108 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 17109 if (predicate.apply(this)) { 17110 return this; 17111 } 17112 return null; 17113 } 17114 17115 /** 17116 * Look for a child view with the given id. If this view has the given 17117 * id, return this view. 17118 * 17119 * @param id The id to search for. 17120 * @return The view that has the given id in the hierarchy or null 17121 */ 17122 public final View findViewById(int id) { 17123 if (id < 0) { 17124 return null; 17125 } 17126 return findViewTraversal(id); 17127 } 17128 17129 /** 17130 * Finds a view by its unuque and stable accessibility id. 17131 * 17132 * @param accessibilityId The searched accessibility id. 17133 * @return The found view. 17134 */ 17135 final View findViewByAccessibilityId(int accessibilityId) { 17136 if (accessibilityId < 0) { 17137 return null; 17138 } 17139 return findViewByAccessibilityIdTraversal(accessibilityId); 17140 } 17141 17142 /** 17143 * Performs the traversal to find a view by its unuque and stable accessibility id. 17144 * 17145 * <strong>Note:</strong>This method does not stop at the root namespace 17146 * boundary since the user can touch the screen at an arbitrary location 17147 * potentially crossing the root namespace bounday which will send an 17148 * accessibility event to accessibility services and they should be able 17149 * to obtain the event source. Also accessibility ids are guaranteed to be 17150 * unique in the window. 17151 * 17152 * @param accessibilityId The accessibility id. 17153 * @return The found view. 17154 * 17155 * @hide 17156 */ 17157 public View findViewByAccessibilityIdTraversal(int accessibilityId) { 17158 if (getAccessibilityViewId() == accessibilityId) { 17159 return this; 17160 } 17161 return null; 17162 } 17163 17164 /** 17165 * Look for a child view with the given tag. If this view has the given 17166 * tag, return this view. 17167 * 17168 * @param tag The tag to search for, using "tag.equals(getTag())". 17169 * @return The View that has the given tag in the hierarchy or null 17170 */ 17171 public final View findViewWithTag(Object tag) { 17172 if (tag == null) { 17173 return null; 17174 } 17175 return findViewWithTagTraversal(tag); 17176 } 17177 17178 /** 17179 * {@hide} 17180 * Look for a child view that matches the specified predicate. 17181 * If this view matches the predicate, return this view. 17182 * 17183 * @param predicate The predicate to evaluate. 17184 * @return The first view that matches the predicate or null. 17185 */ 17186 public final View findViewByPredicate(Predicate<View> predicate) { 17187 return findViewByPredicateTraversal(predicate, null); 17188 } 17189 17190 /** 17191 * {@hide} 17192 * Look for a child view that matches the specified predicate, 17193 * starting with the specified view and its descendents and then 17194 * recusively searching the ancestors and siblings of that view 17195 * until this view is reached. 17196 * 17197 * This method is useful in cases where the predicate does not match 17198 * a single unique view (perhaps multiple views use the same id) 17199 * and we are trying to find the view that is "closest" in scope to the 17200 * starting view. 17201 * 17202 * @param start The view to start from. 17203 * @param predicate The predicate to evaluate. 17204 * @return The first view that matches the predicate or null. 17205 */ 17206 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 17207 View childToSkip = null; 17208 for (;;) { 17209 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 17210 if (view != null || start == this) { 17211 return view; 17212 } 17213 17214 ViewParent parent = start.getParent(); 17215 if (parent == null || !(parent instanceof View)) { 17216 return null; 17217 } 17218 17219 childToSkip = start; 17220 start = (View) parent; 17221 } 17222 } 17223 17224 /** 17225 * Sets the identifier for this view. The identifier does not have to be 17226 * unique in this view's hierarchy. The identifier should be a positive 17227 * number. 17228 * 17229 * @see #NO_ID 17230 * @see #getId() 17231 * @see #findViewById(int) 17232 * 17233 * @param id a number used to identify the view 17234 * 17235 * @attr ref android.R.styleable#View_id 17236 */ 17237 public void setId(int id) { 17238 mID = id; 17239 if (mID == View.NO_ID && mLabelForId != View.NO_ID) { 17240 mID = generateViewId(); 17241 } 17242 } 17243 17244 /** 17245 * {@hide} 17246 * 17247 * @param isRoot true if the view belongs to the root namespace, false 17248 * otherwise 17249 */ 17250 public void setIsRootNamespace(boolean isRoot) { 17251 if (isRoot) { 17252 mPrivateFlags |= PFLAG_IS_ROOT_NAMESPACE; 17253 } else { 17254 mPrivateFlags &= ~PFLAG_IS_ROOT_NAMESPACE; 17255 } 17256 } 17257 17258 /** 17259 * {@hide} 17260 * 17261 * @return true if the view belongs to the root namespace, false otherwise 17262 */ 17263 public boolean isRootNamespace() { 17264 return (mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0; 17265 } 17266 17267 /** 17268 * Returns this view's identifier. 17269 * 17270 * @return a positive integer used to identify the view or {@link #NO_ID} 17271 * if the view has no ID 17272 * 17273 * @see #setId(int) 17274 * @see #findViewById(int) 17275 * @attr ref android.R.styleable#View_id 17276 */ 17277 @ViewDebug.CapturedViewProperty 17278 public int getId() { 17279 return mID; 17280 } 17281 17282 /** 17283 * Returns this view's tag. 17284 * 17285 * @return the Object stored in this view as a tag, or {@code null} if not 17286 * set 17287 * 17288 * @see #setTag(Object) 17289 * @see #getTag(int) 17290 */ 17291 @ViewDebug.ExportedProperty 17292 public Object getTag() { 17293 return mTag; 17294 } 17295 17296 /** 17297 * Sets the tag associated with this view. A tag can be used to mark 17298 * a view in its hierarchy and does not have to be unique within the 17299 * hierarchy. Tags can also be used to store data within a view without 17300 * resorting to another data structure. 17301 * 17302 * @param tag an Object to tag the view with 17303 * 17304 * @see #getTag() 17305 * @see #setTag(int, Object) 17306 */ 17307 public void setTag(final Object tag) { 17308 mTag = tag; 17309 } 17310 17311 /** 17312 * Returns the tag associated with this view and the specified key. 17313 * 17314 * @param key The key identifying the tag 17315 * 17316 * @return the Object stored in this view as a tag, or {@code null} if not 17317 * set 17318 * 17319 * @see #setTag(int, Object) 17320 * @see #getTag() 17321 */ 17322 public Object getTag(int key) { 17323 if (mKeyedTags != null) return mKeyedTags.get(key); 17324 return null; 17325 } 17326 17327 /** 17328 * Sets a tag associated with this view and a key. A tag can be used 17329 * to mark a view in its hierarchy and does not have to be unique within 17330 * the hierarchy. Tags can also be used to store data within a view 17331 * without resorting to another data structure. 17332 * 17333 * The specified key should be an id declared in the resources of the 17334 * application to ensure it is unique (see the <a 17335 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 17336 * Keys identified as belonging to 17337 * the Android framework or not associated with any package will cause 17338 * an {@link IllegalArgumentException} to be thrown. 17339 * 17340 * @param key The key identifying the tag 17341 * @param tag An Object to tag the view with 17342 * 17343 * @throws IllegalArgumentException If they specified key is not valid 17344 * 17345 * @see #setTag(Object) 17346 * @see #getTag(int) 17347 */ 17348 public void setTag(int key, final Object tag) { 17349 // If the package id is 0x00 or 0x01, it's either an undefined package 17350 // or a framework id 17351 if ((key >>> 24) < 2) { 17352 throw new IllegalArgumentException("The key must be an application-specific " 17353 + "resource id."); 17354 } 17355 17356 setKeyedTag(key, tag); 17357 } 17358 17359 /** 17360 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 17361 * framework id. 17362 * 17363 * @hide 17364 */ 17365 public void setTagInternal(int key, Object tag) { 17366 if ((key >>> 24) != 0x1) { 17367 throw new IllegalArgumentException("The key must be a framework-specific " 17368 + "resource id."); 17369 } 17370 17371 setKeyedTag(key, tag); 17372 } 17373 17374 private void setKeyedTag(int key, Object tag) { 17375 if (mKeyedTags == null) { 17376 mKeyedTags = new SparseArray<Object>(2); 17377 } 17378 17379 mKeyedTags.put(key, tag); 17380 } 17381 17382 /** 17383 * Prints information about this view in the log output, with the tag 17384 * {@link #VIEW_LOG_TAG}. 17385 * 17386 * @hide 17387 */ 17388 public void debug() { 17389 debug(0); 17390 } 17391 17392 /** 17393 * Prints information about this view in the log output, with the tag 17394 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 17395 * indentation defined by the <code>depth</code>. 17396 * 17397 * @param depth the indentation level 17398 * 17399 * @hide 17400 */ 17401 protected void debug(int depth) { 17402 String output = debugIndent(depth - 1); 17403 17404 output += "+ " + this; 17405 int id = getId(); 17406 if (id != -1) { 17407 output += " (id=" + id + ")"; 17408 } 17409 Object tag = getTag(); 17410 if (tag != null) { 17411 output += " (tag=" + tag + ")"; 17412 } 17413 Log.d(VIEW_LOG_TAG, output); 17414 17415 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 17416 output = debugIndent(depth) + " FOCUSED"; 17417 Log.d(VIEW_LOG_TAG, output); 17418 } 17419 17420 output = debugIndent(depth); 17421 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 17422 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 17423 + "} "; 17424 Log.d(VIEW_LOG_TAG, output); 17425 17426 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 17427 || mPaddingBottom != 0) { 17428 output = debugIndent(depth); 17429 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 17430 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 17431 Log.d(VIEW_LOG_TAG, output); 17432 } 17433 17434 output = debugIndent(depth); 17435 output += "mMeasureWidth=" + mMeasuredWidth + 17436 " mMeasureHeight=" + mMeasuredHeight; 17437 Log.d(VIEW_LOG_TAG, output); 17438 17439 output = debugIndent(depth); 17440 if (mLayoutParams == null) { 17441 output += "BAD! no layout params"; 17442 } else { 17443 output = mLayoutParams.debug(output); 17444 } 17445 Log.d(VIEW_LOG_TAG, output); 17446 17447 output = debugIndent(depth); 17448 output += "flags={"; 17449 output += View.printFlags(mViewFlags); 17450 output += "}"; 17451 Log.d(VIEW_LOG_TAG, output); 17452 17453 output = debugIndent(depth); 17454 output += "privateFlags={"; 17455 output += View.printPrivateFlags(mPrivateFlags); 17456 output += "}"; 17457 Log.d(VIEW_LOG_TAG, output); 17458 } 17459 17460 /** 17461 * Creates a string of whitespaces used for indentation. 17462 * 17463 * @param depth the indentation level 17464 * @return a String containing (depth * 2 + 3) * 2 white spaces 17465 * 17466 * @hide 17467 */ 17468 protected static String debugIndent(int depth) { 17469 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 17470 for (int i = 0; i < (depth * 2) + 3; i++) { 17471 spaces.append(' ').append(' '); 17472 } 17473 return spaces.toString(); 17474 } 17475 17476 /** 17477 * <p>Return the offset of the widget's text baseline from the widget's top 17478 * boundary. If this widget does not support baseline alignment, this 17479 * method returns -1. </p> 17480 * 17481 * @return the offset of the baseline within the widget's bounds or -1 17482 * if baseline alignment is not supported 17483 */ 17484 @ViewDebug.ExportedProperty(category = "layout") 17485 public int getBaseline() { 17486 return -1; 17487 } 17488 17489 /** 17490 * Returns whether the view hierarchy is currently undergoing a layout pass. This 17491 * information is useful to avoid situations such as calling {@link #requestLayout()} during 17492 * a layout pass. 17493 * 17494 * @return whether the view hierarchy is currently undergoing a layout pass 17495 */ 17496 public boolean isInLayout() { 17497 ViewRootImpl viewRoot = getViewRootImpl(); 17498 return (viewRoot != null && viewRoot.isInLayout()); 17499 } 17500 17501 /** 17502 * Call this when something has changed which has invalidated the 17503 * layout of this view. This will schedule a layout pass of the view 17504 * tree. This should not be called while the view hierarchy is currently in a layout 17505 * pass ({@link #isInLayout()}. If layout is happening, the request may be honored at the 17506 * end of the current layout pass (and then layout will run again) or after the current 17507 * frame is drawn and the next layout occurs. 17508 * 17509 * <p>Subclasses which override this method should call the superclass method to 17510 * handle possible request-during-layout errors correctly.</p> 17511 */ 17512 public void requestLayout() { 17513 if (mMeasureCache != null) mMeasureCache.clear(); 17514 17515 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == null) { 17516 // Only trigger request-during-layout logic if this is the view requesting it, 17517 // not the views in its parent hierarchy 17518 ViewRootImpl viewRoot = getViewRootImpl(); 17519 if (viewRoot != null && viewRoot.isInLayout()) { 17520 if (!viewRoot.requestLayoutDuringLayout(this)) { 17521 return; 17522 } 17523 } 17524 mAttachInfo.mViewRequestingLayout = this; 17525 } 17526 17527 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17528 mPrivateFlags |= PFLAG_INVALIDATED; 17529 17530 if (mParent != null && !mParent.isLayoutRequested()) { 17531 mParent.requestLayout(); 17532 } 17533 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == this) { 17534 mAttachInfo.mViewRequestingLayout = null; 17535 } 17536 } 17537 17538 /** 17539 * Forces this view to be laid out during the next layout pass. 17540 * This method does not call requestLayout() or forceLayout() 17541 * on the parent. 17542 */ 17543 public void forceLayout() { 17544 if (mMeasureCache != null) mMeasureCache.clear(); 17545 17546 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17547 mPrivateFlags |= PFLAG_INVALIDATED; 17548 } 17549 17550 /** 17551 * <p> 17552 * This is called to find out how big a view should be. The parent 17553 * supplies constraint information in the width and height parameters. 17554 * </p> 17555 * 17556 * <p> 17557 * The actual measurement work of a view is performed in 17558 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 17559 * {@link #onMeasure(int, int)} can and must be overridden by subclasses. 17560 * </p> 17561 * 17562 * 17563 * @param widthMeasureSpec Horizontal space requirements as imposed by the 17564 * parent 17565 * @param heightMeasureSpec Vertical space requirements as imposed by the 17566 * parent 17567 * 17568 * @see #onMeasure(int, int) 17569 */ 17570 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 17571 boolean optical = isLayoutModeOptical(this); 17572 if (optical != isLayoutModeOptical(mParent)) { 17573 Insets insets = getOpticalInsets(); 17574 int oWidth = insets.left + insets.right; 17575 int oHeight = insets.top + insets.bottom; 17576 widthMeasureSpec = MeasureSpec.adjust(widthMeasureSpec, optical ? -oWidth : oWidth); 17577 heightMeasureSpec = MeasureSpec.adjust(heightMeasureSpec, optical ? -oHeight : oHeight); 17578 } 17579 17580 // Suppress sign extension for the low bytes 17581 long key = (long) widthMeasureSpec << 32 | (long) heightMeasureSpec & 0xffffffffL; 17582 if (mMeasureCache == null) mMeasureCache = new LongSparseLongArray(2); 17583 17584 final boolean forceLayout = (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 17585 final boolean isExactly = MeasureSpec.getMode(widthMeasureSpec) == MeasureSpec.EXACTLY && 17586 MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.EXACTLY; 17587 final boolean matchingSize = isExactly && 17588 getMeasuredWidth() == MeasureSpec.getSize(widthMeasureSpec) && 17589 getMeasuredHeight() == MeasureSpec.getSize(heightMeasureSpec); 17590 if (forceLayout || !matchingSize && 17591 (widthMeasureSpec != mOldWidthMeasureSpec || 17592 heightMeasureSpec != mOldHeightMeasureSpec)) { 17593 17594 // first clears the measured dimension flag 17595 mPrivateFlags &= ~PFLAG_MEASURED_DIMENSION_SET; 17596 17597 resolveRtlPropertiesIfNeeded(); 17598 17599 int cacheIndex = forceLayout ? -1 : mMeasureCache.indexOfKey(key); 17600 if (cacheIndex < 0 || sIgnoreMeasureCache) { 17601 // measure ourselves, this should set the measured dimension flag back 17602 onMeasure(widthMeasureSpec, heightMeasureSpec); 17603 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17604 } else { 17605 long value = mMeasureCache.valueAt(cacheIndex); 17606 // Casting a long to int drops the high 32 bits, no mask needed 17607 setMeasuredDimensionRaw((int) (value >> 32), (int) value); 17608 mPrivateFlags3 |= PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17609 } 17610 17611 // flag not set, setMeasuredDimension() was not invoked, we raise 17612 // an exception to warn the developer 17613 if ((mPrivateFlags & PFLAG_MEASURED_DIMENSION_SET) != PFLAG_MEASURED_DIMENSION_SET) { 17614 throw new IllegalStateException("onMeasure() did not set the" 17615 + " measured dimension by calling" 17616 + " setMeasuredDimension()"); 17617 } 17618 17619 mPrivateFlags |= PFLAG_LAYOUT_REQUIRED; 17620 } 17621 17622 mOldWidthMeasureSpec = widthMeasureSpec; 17623 mOldHeightMeasureSpec = heightMeasureSpec; 17624 17625 mMeasureCache.put(key, ((long) mMeasuredWidth) << 32 | 17626 (long) mMeasuredHeight & 0xffffffffL); // suppress sign extension 17627 } 17628 17629 /** 17630 * <p> 17631 * Measure the view and its content to determine the measured width and the 17632 * measured height. This method is invoked by {@link #measure(int, int)} and 17633 * should be overriden by subclasses to provide accurate and efficient 17634 * measurement of their contents. 17635 * </p> 17636 * 17637 * <p> 17638 * <strong>CONTRACT:</strong> When overriding this method, you 17639 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 17640 * measured width and height of this view. Failure to do so will trigger an 17641 * <code>IllegalStateException</code>, thrown by 17642 * {@link #measure(int, int)}. Calling the superclass' 17643 * {@link #onMeasure(int, int)} is a valid use. 17644 * </p> 17645 * 17646 * <p> 17647 * The base class implementation of measure defaults to the background size, 17648 * unless a larger size is allowed by the MeasureSpec. Subclasses should 17649 * override {@link #onMeasure(int, int)} to provide better measurements of 17650 * their content. 17651 * </p> 17652 * 17653 * <p> 17654 * If this method is overridden, it is the subclass's responsibility to make 17655 * sure the measured height and width are at least the view's minimum height 17656 * and width ({@link #getSuggestedMinimumHeight()} and 17657 * {@link #getSuggestedMinimumWidth()}). 17658 * </p> 17659 * 17660 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 17661 * The requirements are encoded with 17662 * {@link android.view.View.MeasureSpec}. 17663 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 17664 * The requirements are encoded with 17665 * {@link android.view.View.MeasureSpec}. 17666 * 17667 * @see #getMeasuredWidth() 17668 * @see #getMeasuredHeight() 17669 * @see #setMeasuredDimension(int, int) 17670 * @see #getSuggestedMinimumHeight() 17671 * @see #getSuggestedMinimumWidth() 17672 * @see android.view.View.MeasureSpec#getMode(int) 17673 * @see android.view.View.MeasureSpec#getSize(int) 17674 */ 17675 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 17676 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 17677 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 17678 } 17679 17680 /** 17681 * <p>This method must be called by {@link #onMeasure(int, int)} to store the 17682 * measured width and measured height. Failing to do so will trigger an 17683 * exception at measurement time.</p> 17684 * 17685 * @param measuredWidth The measured width of this view. May be a complex 17686 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17687 * {@link #MEASURED_STATE_TOO_SMALL}. 17688 * @param measuredHeight The measured height of this view. May be a complex 17689 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17690 * {@link #MEASURED_STATE_TOO_SMALL}. 17691 */ 17692 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 17693 boolean optical = isLayoutModeOptical(this); 17694 if (optical != isLayoutModeOptical(mParent)) { 17695 Insets insets = getOpticalInsets(); 17696 int opticalWidth = insets.left + insets.right; 17697 int opticalHeight = insets.top + insets.bottom; 17698 17699 measuredWidth += optical ? opticalWidth : -opticalWidth; 17700 measuredHeight += optical ? opticalHeight : -opticalHeight; 17701 } 17702 setMeasuredDimensionRaw(measuredWidth, measuredHeight); 17703 } 17704 17705 /** 17706 * Sets the measured dimension without extra processing for things like optical bounds. 17707 * Useful for reapplying consistent values that have already been cooked with adjustments 17708 * for optical bounds, etc. such as those from the measurement cache. 17709 * 17710 * @param measuredWidth The measured width of this view. May be a complex 17711 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17712 * {@link #MEASURED_STATE_TOO_SMALL}. 17713 * @param measuredHeight The measured height of this view. May be a complex 17714 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17715 * {@link #MEASURED_STATE_TOO_SMALL}. 17716 */ 17717 private void setMeasuredDimensionRaw(int measuredWidth, int measuredHeight) { 17718 mMeasuredWidth = measuredWidth; 17719 mMeasuredHeight = measuredHeight; 17720 17721 mPrivateFlags |= PFLAG_MEASURED_DIMENSION_SET; 17722 } 17723 17724 /** 17725 * Merge two states as returned by {@link #getMeasuredState()}. 17726 * @param curState The current state as returned from a view or the result 17727 * of combining multiple views. 17728 * @param newState The new view state to combine. 17729 * @return Returns a new integer reflecting the combination of the two 17730 * states. 17731 */ 17732 public static int combineMeasuredStates(int curState, int newState) { 17733 return curState | newState; 17734 } 17735 17736 /** 17737 * Version of {@link #resolveSizeAndState(int, int, int)} 17738 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 17739 */ 17740 public static int resolveSize(int size, int measureSpec) { 17741 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 17742 } 17743 17744 /** 17745 * Utility to reconcile a desired size and state, with constraints imposed 17746 * by a MeasureSpec. Will take the desired size, unless a different size 17747 * is imposed by the constraints. The returned value is a compound integer, 17748 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 17749 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 17750 * size is smaller than the size the view wants to be. 17751 * 17752 * @param size How big the view wants to be 17753 * @param measureSpec Constraints imposed by the parent 17754 * @return Size information bit mask as defined by 17755 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 17756 */ 17757 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 17758 int result = size; 17759 int specMode = MeasureSpec.getMode(measureSpec); 17760 int specSize = MeasureSpec.getSize(measureSpec); 17761 switch (specMode) { 17762 case MeasureSpec.UNSPECIFIED: 17763 result = size; 17764 break; 17765 case MeasureSpec.AT_MOST: 17766 if (specSize < size) { 17767 result = specSize | MEASURED_STATE_TOO_SMALL; 17768 } else { 17769 result = size; 17770 } 17771 break; 17772 case MeasureSpec.EXACTLY: 17773 result = specSize; 17774 break; 17775 } 17776 return result | (childMeasuredState&MEASURED_STATE_MASK); 17777 } 17778 17779 /** 17780 * Utility to return a default size. Uses the supplied size if the 17781 * MeasureSpec imposed no constraints. Will get larger if allowed 17782 * by the MeasureSpec. 17783 * 17784 * @param size Default size for this view 17785 * @param measureSpec Constraints imposed by the parent 17786 * @return The size this view should be. 17787 */ 17788 public static int getDefaultSize(int size, int measureSpec) { 17789 int result = size; 17790 int specMode = MeasureSpec.getMode(measureSpec); 17791 int specSize = MeasureSpec.getSize(measureSpec); 17792 17793 switch (specMode) { 17794 case MeasureSpec.UNSPECIFIED: 17795 result = size; 17796 break; 17797 case MeasureSpec.AT_MOST: 17798 case MeasureSpec.EXACTLY: 17799 result = specSize; 17800 break; 17801 } 17802 return result; 17803 } 17804 17805 /** 17806 * Returns the suggested minimum height that the view should use. This 17807 * returns the maximum of the view's minimum height 17808 * and the background's minimum height 17809 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 17810 * <p> 17811 * When being used in {@link #onMeasure(int, int)}, the caller should still 17812 * ensure the returned height is within the requirements of the parent. 17813 * 17814 * @return The suggested minimum height of the view. 17815 */ 17816 protected int getSuggestedMinimumHeight() { 17817 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight()); 17818 17819 } 17820 17821 /** 17822 * Returns the suggested minimum width that the view should use. This 17823 * returns the maximum of the view's minimum width) 17824 * and the background's minimum width 17825 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 17826 * <p> 17827 * When being used in {@link #onMeasure(int, int)}, the caller should still 17828 * ensure the returned width is within the requirements of the parent. 17829 * 17830 * @return The suggested minimum width of the view. 17831 */ 17832 protected int getSuggestedMinimumWidth() { 17833 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth()); 17834 } 17835 17836 /** 17837 * Returns the minimum height of the view. 17838 * 17839 * @return the minimum height the view will try to be. 17840 * 17841 * @see #setMinimumHeight(int) 17842 * 17843 * @attr ref android.R.styleable#View_minHeight 17844 */ 17845 public int getMinimumHeight() { 17846 return mMinHeight; 17847 } 17848 17849 /** 17850 * Sets the minimum height of the view. It is not guaranteed the view will 17851 * be able to achieve this minimum height (for example, if its parent layout 17852 * constrains it with less available height). 17853 * 17854 * @param minHeight The minimum height the view will try to be. 17855 * 17856 * @see #getMinimumHeight() 17857 * 17858 * @attr ref android.R.styleable#View_minHeight 17859 */ 17860 public void setMinimumHeight(int minHeight) { 17861 mMinHeight = minHeight; 17862 requestLayout(); 17863 } 17864 17865 /** 17866 * Returns the minimum width of the view. 17867 * 17868 * @return the minimum width the view will try to be. 17869 * 17870 * @see #setMinimumWidth(int) 17871 * 17872 * @attr ref android.R.styleable#View_minWidth 17873 */ 17874 public int getMinimumWidth() { 17875 return mMinWidth; 17876 } 17877 17878 /** 17879 * Sets the minimum width of the view. It is not guaranteed the view will 17880 * be able to achieve this minimum width (for example, if its parent layout 17881 * constrains it with less available width). 17882 * 17883 * @param minWidth The minimum width the view will try to be. 17884 * 17885 * @see #getMinimumWidth() 17886 * 17887 * @attr ref android.R.styleable#View_minWidth 17888 */ 17889 public void setMinimumWidth(int minWidth) { 17890 mMinWidth = minWidth; 17891 requestLayout(); 17892 17893 } 17894 17895 /** 17896 * Get the animation currently associated with this view. 17897 * 17898 * @return The animation that is currently playing or 17899 * scheduled to play for this view. 17900 */ 17901 public Animation getAnimation() { 17902 return mCurrentAnimation; 17903 } 17904 17905 /** 17906 * Start the specified animation now. 17907 * 17908 * @param animation the animation to start now 17909 */ 17910 public void startAnimation(Animation animation) { 17911 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 17912 setAnimation(animation); 17913 invalidateParentCaches(); 17914 invalidate(true); 17915 } 17916 17917 /** 17918 * Cancels any animations for this view. 17919 */ 17920 public void clearAnimation() { 17921 if (mCurrentAnimation != null) { 17922 mCurrentAnimation.detach(); 17923 } 17924 mCurrentAnimation = null; 17925 invalidateParentIfNeeded(); 17926 } 17927 17928 /** 17929 * Sets the next animation to play for this view. 17930 * If you want the animation to play immediately, use 17931 * {@link #startAnimation(android.view.animation.Animation)} instead. 17932 * This method provides allows fine-grained 17933 * control over the start time and invalidation, but you 17934 * must make sure that 1) the animation has a start time set, and 17935 * 2) the view's parent (which controls animations on its children) 17936 * will be invalidated when the animation is supposed to 17937 * start. 17938 * 17939 * @param animation The next animation, or null. 17940 */ 17941 public void setAnimation(Animation animation) { 17942 mCurrentAnimation = animation; 17943 17944 if (animation != null) { 17945 // If the screen is off assume the animation start time is now instead of 17946 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time 17947 // would cause the animation to start when the screen turns back on 17948 if (mAttachInfo != null && mAttachInfo.mDisplayState == Display.STATE_OFF 17949 && animation.getStartTime() == Animation.START_ON_FIRST_FRAME) { 17950 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis()); 17951 } 17952 animation.reset(); 17953 } 17954 } 17955 17956 /** 17957 * Invoked by a parent ViewGroup to notify the start of the animation 17958 * currently associated with this view. If you override this method, 17959 * always call super.onAnimationStart(); 17960 * 17961 * @see #setAnimation(android.view.animation.Animation) 17962 * @see #getAnimation() 17963 */ 17964 protected void onAnimationStart() { 17965 mPrivateFlags |= PFLAG_ANIMATION_STARTED; 17966 } 17967 17968 /** 17969 * Invoked by a parent ViewGroup to notify the end of the animation 17970 * currently associated with this view. If you override this method, 17971 * always call super.onAnimationEnd(); 17972 * 17973 * @see #setAnimation(android.view.animation.Animation) 17974 * @see #getAnimation() 17975 */ 17976 protected void onAnimationEnd() { 17977 mPrivateFlags &= ~PFLAG_ANIMATION_STARTED; 17978 } 17979 17980 /** 17981 * Invoked if there is a Transform that involves alpha. Subclass that can 17982 * draw themselves with the specified alpha should return true, and then 17983 * respect that alpha when their onDraw() is called. If this returns false 17984 * then the view may be redirected to draw into an offscreen buffer to 17985 * fulfill the request, which will look fine, but may be slower than if the 17986 * subclass handles it internally. The default implementation returns false. 17987 * 17988 * @param alpha The alpha (0..255) to apply to the view's drawing 17989 * @return true if the view can draw with the specified alpha. 17990 */ 17991 protected boolean onSetAlpha(int alpha) { 17992 return false; 17993 } 17994 17995 /** 17996 * This is used by the RootView to perform an optimization when 17997 * the view hierarchy contains one or several SurfaceView. 17998 * SurfaceView is always considered transparent, but its children are not, 17999 * therefore all View objects remove themselves from the global transparent 18000 * region (passed as a parameter to this function). 18001 * 18002 * @param region The transparent region for this ViewAncestor (window). 18003 * 18004 * @return Returns true if the effective visibility of the view at this 18005 * point is opaque, regardless of the transparent region; returns false 18006 * if it is possible for underlying windows to be seen behind the view. 18007 * 18008 * {@hide} 18009 */ 18010 public boolean gatherTransparentRegion(Region region) { 18011 final AttachInfo attachInfo = mAttachInfo; 18012 if (region != null && attachInfo != null) { 18013 final int pflags = mPrivateFlags; 18014 if ((pflags & PFLAG_SKIP_DRAW) == 0) { 18015 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 18016 // remove it from the transparent region. 18017 final int[] location = attachInfo.mTransparentLocation; 18018 getLocationInWindow(location); 18019 region.op(location[0], location[1], location[0] + mRight - mLeft, 18020 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 18021 } else if ((pflags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null && 18022 mBackground.getOpacity() != PixelFormat.TRANSPARENT) { 18023 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 18024 // exists, so we remove the background drawable's non-transparent 18025 // parts from this transparent region. 18026 applyDrawableToTransparentRegion(mBackground, region); 18027 } 18028 } 18029 return true; 18030 } 18031 18032 /** 18033 * Play a sound effect for this view. 18034 * 18035 * <p>The framework will play sound effects for some built in actions, such as 18036 * clicking, but you may wish to play these effects in your widget, 18037 * for instance, for internal navigation. 18038 * 18039 * <p>The sound effect will only be played if sound effects are enabled by the user, and 18040 * {@link #isSoundEffectsEnabled()} is true. 18041 * 18042 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 18043 */ 18044 public void playSoundEffect(int soundConstant) { 18045 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 18046 return; 18047 } 18048 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 18049 } 18050 18051 /** 18052 * BZZZTT!!1! 18053 * 18054 * <p>Provide haptic feedback to the user for this view. 18055 * 18056 * <p>The framework will provide haptic feedback for some built in actions, 18057 * such as long presses, but you may wish to provide feedback for your 18058 * own widget. 18059 * 18060 * <p>The feedback will only be performed if 18061 * {@link #isHapticFeedbackEnabled()} is true. 18062 * 18063 * @param feedbackConstant One of the constants defined in 18064 * {@link HapticFeedbackConstants} 18065 */ 18066 public boolean performHapticFeedback(int feedbackConstant) { 18067 return performHapticFeedback(feedbackConstant, 0); 18068 } 18069 18070 /** 18071 * BZZZTT!!1! 18072 * 18073 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 18074 * 18075 * @param feedbackConstant One of the constants defined in 18076 * {@link HapticFeedbackConstants} 18077 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 18078 */ 18079 public boolean performHapticFeedback(int feedbackConstant, int flags) { 18080 if (mAttachInfo == null) { 18081 return false; 18082 } 18083 //noinspection SimplifiableIfStatement 18084 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 18085 && !isHapticFeedbackEnabled()) { 18086 return false; 18087 } 18088 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 18089 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 18090 } 18091 18092 /** 18093 * Request that the visibility of the status bar or other screen/window 18094 * decorations be changed. 18095 * 18096 * <p>This method is used to put the over device UI into temporary modes 18097 * where the user's attention is focused more on the application content, 18098 * by dimming or hiding surrounding system affordances. This is typically 18099 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY 18100 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content 18101 * to be placed behind the action bar (and with these flags other system 18102 * affordances) so that smooth transitions between hiding and showing them 18103 * can be done. 18104 * 18105 * <p>Two representative examples of the use of system UI visibility is 18106 * implementing a content browsing application (like a magazine reader) 18107 * and a video playing application. 18108 * 18109 * <p>The first code shows a typical implementation of a View in a content 18110 * browsing application. In this implementation, the application goes 18111 * into a content-oriented mode by hiding the status bar and action bar, 18112 * and putting the navigation elements into lights out mode. The user can 18113 * then interact with content while in this mode. Such an application should 18114 * provide an easy way for the user to toggle out of the mode (such as to 18115 * check information in the status bar or access notifications). In the 18116 * implementation here, this is done simply by tapping on the content. 18117 * 18118 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java 18119 * content} 18120 * 18121 * <p>This second code sample shows a typical implementation of a View 18122 * in a video playing application. In this situation, while the video is 18123 * playing the application would like to go into a complete full-screen mode, 18124 * to use as much of the display as possible for the video. When in this state 18125 * the user can not interact with the application; the system intercepts 18126 * touching on the screen to pop the UI out of full screen mode. See 18127 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code. 18128 * 18129 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java 18130 * content} 18131 * 18132 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18133 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18134 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18135 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18136 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18137 */ 18138 public void setSystemUiVisibility(int visibility) { 18139 if (visibility != mSystemUiVisibility) { 18140 mSystemUiVisibility = visibility; 18141 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18142 mParent.recomputeViewAttributes(this); 18143 } 18144 } 18145 } 18146 18147 /** 18148 * Returns the last {@link #setSystemUiVisibility(int)} that this view has requested. 18149 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18150 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18151 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18152 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18153 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18154 */ 18155 public int getSystemUiVisibility() { 18156 return mSystemUiVisibility; 18157 } 18158 18159 /** 18160 * Returns the current system UI visibility that is currently set for 18161 * the entire window. This is the combination of the 18162 * {@link #setSystemUiVisibility(int)} values supplied by all of the 18163 * views in the window. 18164 */ 18165 public int getWindowSystemUiVisibility() { 18166 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0; 18167 } 18168 18169 /** 18170 * Override to find out when the window's requested system UI visibility 18171 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}. 18172 * This is different from the callbacks received through 18173 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)} 18174 * in that this is only telling you about the local request of the window, 18175 * not the actual values applied by the system. 18176 */ 18177 public void onWindowSystemUiVisibilityChanged(int visible) { 18178 } 18179 18180 /** 18181 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down 18182 * the view hierarchy. 18183 */ 18184 public void dispatchWindowSystemUiVisiblityChanged(int visible) { 18185 onWindowSystemUiVisibilityChanged(visible); 18186 } 18187 18188 /** 18189 * Set a listener to receive callbacks when the visibility of the system bar changes. 18190 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 18191 */ 18192 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 18193 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 18194 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18195 mParent.recomputeViewAttributes(this); 18196 } 18197 } 18198 18199 /** 18200 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 18201 * the view hierarchy. 18202 */ 18203 public void dispatchSystemUiVisibilityChanged(int visibility) { 18204 ListenerInfo li = mListenerInfo; 18205 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 18206 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 18207 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 18208 } 18209 } 18210 18211 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) { 18212 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 18213 if (val != mSystemUiVisibility) { 18214 setSystemUiVisibility(val); 18215 return true; 18216 } 18217 return false; 18218 } 18219 18220 /** @hide */ 18221 public void setDisabledSystemUiVisibility(int flags) { 18222 if (mAttachInfo != null) { 18223 if (mAttachInfo.mDisabledSystemUiVisibility != flags) { 18224 mAttachInfo.mDisabledSystemUiVisibility = flags; 18225 if (mParent != null) { 18226 mParent.recomputeViewAttributes(this); 18227 } 18228 } 18229 } 18230 } 18231 18232 /** 18233 * Creates an image that the system displays during the drag and drop 18234 * operation. This is called a "drag shadow". The default implementation 18235 * for a DragShadowBuilder based on a View returns an image that has exactly the same 18236 * appearance as the given View. The default also positions the center of the drag shadow 18237 * directly under the touch point. If no View is provided (the constructor with no parameters 18238 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 18239 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 18240 * default is an invisible drag shadow. 18241 * <p> 18242 * You are not required to use the View you provide to the constructor as the basis of the 18243 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 18244 * anything you want as the drag shadow. 18245 * </p> 18246 * <p> 18247 * You pass a DragShadowBuilder object to the system when you start the drag. The system 18248 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 18249 * size and position of the drag shadow. It uses this data to construct a 18250 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 18251 * so that your application can draw the shadow image in the Canvas. 18252 * </p> 18253 * 18254 * <div class="special reference"> 18255 * <h3>Developer Guides</h3> 18256 * <p>For a guide to implementing drag and drop features, read the 18257 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 18258 * </div> 18259 */ 18260 public static class DragShadowBuilder { 18261 private final WeakReference<View> mView; 18262 18263 /** 18264 * Constructs a shadow image builder based on a View. By default, the resulting drag 18265 * shadow will have the same appearance and dimensions as the View, with the touch point 18266 * over the center of the View. 18267 * @param view A View. Any View in scope can be used. 18268 */ 18269 public DragShadowBuilder(View view) { 18270 mView = new WeakReference<View>(view); 18271 } 18272 18273 /** 18274 * Construct a shadow builder object with no associated View. This 18275 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 18276 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 18277 * to supply the drag shadow's dimensions and appearance without 18278 * reference to any View object. If they are not overridden, then the result is an 18279 * invisible drag shadow. 18280 */ 18281 public DragShadowBuilder() { 18282 mView = new WeakReference<View>(null); 18283 } 18284 18285 /** 18286 * Returns the View object that had been passed to the 18287 * {@link #View.DragShadowBuilder(View)} 18288 * constructor. If that View parameter was {@code null} or if the 18289 * {@link #View.DragShadowBuilder()} 18290 * constructor was used to instantiate the builder object, this method will return 18291 * null. 18292 * 18293 * @return The View object associate with this builder object. 18294 */ 18295 @SuppressWarnings({"JavadocReference"}) 18296 final public View getView() { 18297 return mView.get(); 18298 } 18299 18300 /** 18301 * Provides the metrics for the shadow image. These include the dimensions of 18302 * the shadow image, and the point within that shadow that should 18303 * be centered under the touch location while dragging. 18304 * <p> 18305 * The default implementation sets the dimensions of the shadow to be the 18306 * same as the dimensions of the View itself and centers the shadow under 18307 * the touch point. 18308 * </p> 18309 * 18310 * @param shadowSize A {@link android.graphics.Point} containing the width and height 18311 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 18312 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 18313 * image. 18314 * 18315 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 18316 * shadow image that should be underneath the touch point during the drag and drop 18317 * operation. Your application must set {@link android.graphics.Point#x} to the 18318 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 18319 */ 18320 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 18321 final View view = mView.get(); 18322 if (view != null) { 18323 shadowSize.set(view.getWidth(), view.getHeight()); 18324 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 18325 } else { 18326 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 18327 } 18328 } 18329 18330 /** 18331 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 18332 * based on the dimensions it received from the 18333 * {@link #onProvideShadowMetrics(Point, Point)} callback. 18334 * 18335 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 18336 */ 18337 public void onDrawShadow(Canvas canvas) { 18338 final View view = mView.get(); 18339 if (view != null) { 18340 view.draw(canvas); 18341 } else { 18342 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 18343 } 18344 } 18345 } 18346 18347 /** 18348 * Starts a drag and drop operation. When your application calls this method, it passes a 18349 * {@link android.view.View.DragShadowBuilder} object to the system. The 18350 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 18351 * to get metrics for the drag shadow, and then calls the object's 18352 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 18353 * <p> 18354 * Once the system has the drag shadow, it begins the drag and drop operation by sending 18355 * drag events to all the View objects in your application that are currently visible. It does 18356 * this either by calling the View object's drag listener (an implementation of 18357 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 18358 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 18359 * Both are passed a {@link android.view.DragEvent} object that has a 18360 * {@link android.view.DragEvent#getAction()} value of 18361 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 18362 * </p> 18363 * <p> 18364 * Your application can invoke startDrag() on any attached View object. The View object does not 18365 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 18366 * be related to the View the user selected for dragging. 18367 * </p> 18368 * @param data A {@link android.content.ClipData} object pointing to the data to be 18369 * transferred by the drag and drop operation. 18370 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 18371 * drag shadow. 18372 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 18373 * drop operation. This Object is put into every DragEvent object sent by the system during the 18374 * current drag. 18375 * <p> 18376 * myLocalState is a lightweight mechanism for the sending information from the dragged View 18377 * to the target Views. For example, it can contain flags that differentiate between a 18378 * a copy operation and a move operation. 18379 * </p> 18380 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 18381 * so the parameter should be set to 0. 18382 * @return {@code true} if the method completes successfully, or 18383 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 18384 * do a drag, and so no drag operation is in progress. 18385 */ 18386 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 18387 Object myLocalState, int flags) { 18388 if (ViewDebug.DEBUG_DRAG) { 18389 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 18390 } 18391 boolean okay = false; 18392 18393 Point shadowSize = new Point(); 18394 Point shadowTouchPoint = new Point(); 18395 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 18396 18397 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 18398 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 18399 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 18400 } 18401 18402 if (ViewDebug.DEBUG_DRAG) { 18403 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 18404 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 18405 } 18406 Surface surface = new Surface(); 18407 try { 18408 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 18409 flags, shadowSize.x, shadowSize.y, surface); 18410 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 18411 + " surface=" + surface); 18412 if (token != null) { 18413 Canvas canvas = surface.lockCanvas(null); 18414 try { 18415 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 18416 shadowBuilder.onDrawShadow(canvas); 18417 } finally { 18418 surface.unlockCanvasAndPost(canvas); 18419 } 18420 18421 final ViewRootImpl root = getViewRootImpl(); 18422 18423 // Cache the local state object for delivery with DragEvents 18424 root.setLocalDragState(myLocalState); 18425 18426 // repurpose 'shadowSize' for the last touch point 18427 root.getLastTouchPoint(shadowSize); 18428 18429 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 18430 shadowSize.x, shadowSize.y, 18431 shadowTouchPoint.x, shadowTouchPoint.y, data); 18432 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 18433 18434 // Off and running! Release our local surface instance; the drag 18435 // shadow surface is now managed by the system process. 18436 surface.release(); 18437 } 18438 } catch (Exception e) { 18439 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 18440 surface.destroy(); 18441 } 18442 18443 return okay; 18444 } 18445 18446 /** 18447 * Handles drag events sent by the system following a call to 18448 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 18449 *<p> 18450 * When the system calls this method, it passes a 18451 * {@link android.view.DragEvent} object. A call to 18452 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 18453 * in DragEvent. The method uses these to determine what is happening in the drag and drop 18454 * operation. 18455 * @param event The {@link android.view.DragEvent} sent by the system. 18456 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 18457 * in DragEvent, indicating the type of drag event represented by this object. 18458 * @return {@code true} if the method was successful, otherwise {@code false}. 18459 * <p> 18460 * The method should return {@code true} in response to an action type of 18461 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 18462 * operation. 18463 * </p> 18464 * <p> 18465 * The method should also return {@code true} in response to an action type of 18466 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 18467 * {@code false} if it didn't. 18468 * </p> 18469 */ 18470 public boolean onDragEvent(DragEvent event) { 18471 return false; 18472 } 18473 18474 /** 18475 * Detects if this View is enabled and has a drag event listener. 18476 * If both are true, then it calls the drag event listener with the 18477 * {@link android.view.DragEvent} it received. If the drag event listener returns 18478 * {@code true}, then dispatchDragEvent() returns {@code true}. 18479 * <p> 18480 * For all other cases, the method calls the 18481 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 18482 * method and returns its result. 18483 * </p> 18484 * <p> 18485 * This ensures that a drag event is always consumed, even if the View does not have a drag 18486 * event listener. However, if the View has a listener and the listener returns true, then 18487 * onDragEvent() is not called. 18488 * </p> 18489 */ 18490 public boolean dispatchDragEvent(DragEvent event) { 18491 ListenerInfo li = mListenerInfo; 18492 //noinspection SimplifiableIfStatement 18493 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 18494 && li.mOnDragListener.onDrag(this, event)) { 18495 return true; 18496 } 18497 return onDragEvent(event); 18498 } 18499 18500 boolean canAcceptDrag() { 18501 return (mPrivateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0; 18502 } 18503 18504 /** 18505 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 18506 * it is ever exposed at all. 18507 * @hide 18508 */ 18509 public void onCloseSystemDialogs(String reason) { 18510 } 18511 18512 /** 18513 * Given a Drawable whose bounds have been set to draw into this view, 18514 * update a Region being computed for 18515 * {@link #gatherTransparentRegion(android.graphics.Region)} so 18516 * that any non-transparent parts of the Drawable are removed from the 18517 * given transparent region. 18518 * 18519 * @param dr The Drawable whose transparency is to be applied to the region. 18520 * @param region A Region holding the current transparency information, 18521 * where any parts of the region that are set are considered to be 18522 * transparent. On return, this region will be modified to have the 18523 * transparency information reduced by the corresponding parts of the 18524 * Drawable that are not transparent. 18525 * {@hide} 18526 */ 18527 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 18528 if (DBG) { 18529 Log.i("View", "Getting transparent region for: " + this); 18530 } 18531 final Region r = dr.getTransparentRegion(); 18532 final Rect db = dr.getBounds(); 18533 final AttachInfo attachInfo = mAttachInfo; 18534 if (r != null && attachInfo != null) { 18535 final int w = getRight()-getLeft(); 18536 final int h = getBottom()-getTop(); 18537 if (db.left > 0) { 18538 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 18539 r.op(0, 0, db.left, h, Region.Op.UNION); 18540 } 18541 if (db.right < w) { 18542 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 18543 r.op(db.right, 0, w, h, Region.Op.UNION); 18544 } 18545 if (db.top > 0) { 18546 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 18547 r.op(0, 0, w, db.top, Region.Op.UNION); 18548 } 18549 if (db.bottom < h) { 18550 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 18551 r.op(0, db.bottom, w, h, Region.Op.UNION); 18552 } 18553 final int[] location = attachInfo.mTransparentLocation; 18554 getLocationInWindow(location); 18555 r.translate(location[0], location[1]); 18556 region.op(r, Region.Op.INTERSECT); 18557 } else { 18558 region.op(db, Region.Op.DIFFERENCE); 18559 } 18560 } 18561 18562 private void checkForLongClick(int delayOffset) { 18563 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 18564 mHasPerformedLongPress = false; 18565 18566 if (mPendingCheckForLongPress == null) { 18567 mPendingCheckForLongPress = new CheckForLongPress(); 18568 } 18569 mPendingCheckForLongPress.rememberWindowAttachCount(); 18570 postDelayed(mPendingCheckForLongPress, 18571 ViewConfiguration.getLongPressTimeout() - delayOffset); 18572 } 18573 } 18574 18575 /** 18576 * Inflate a view from an XML resource. This convenience method wraps the {@link 18577 * LayoutInflater} class, which provides a full range of options for view inflation. 18578 * 18579 * @param context The Context object for your activity or application. 18580 * @param resource The resource ID to inflate 18581 * @param root A view group that will be the parent. Used to properly inflate the 18582 * layout_* parameters. 18583 * @see LayoutInflater 18584 */ 18585 public static View inflate(Context context, int resource, ViewGroup root) { 18586 LayoutInflater factory = LayoutInflater.from(context); 18587 return factory.inflate(resource, root); 18588 } 18589 18590 /** 18591 * Scroll the view with standard behavior for scrolling beyond the normal 18592 * content boundaries. Views that call this method should override 18593 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 18594 * results of an over-scroll operation. 18595 * 18596 * Views can use this method to handle any touch or fling-based scrolling. 18597 * 18598 * @param deltaX Change in X in pixels 18599 * @param deltaY Change in Y in pixels 18600 * @param scrollX Current X scroll value in pixels before applying deltaX 18601 * @param scrollY Current Y scroll value in pixels before applying deltaY 18602 * @param scrollRangeX Maximum content scroll range along the X axis 18603 * @param scrollRangeY Maximum content scroll range along the Y axis 18604 * @param maxOverScrollX Number of pixels to overscroll by in either direction 18605 * along the X axis. 18606 * @param maxOverScrollY Number of pixels to overscroll by in either direction 18607 * along the Y axis. 18608 * @param isTouchEvent true if this scroll operation is the result of a touch event. 18609 * @return true if scrolling was clamped to an over-scroll boundary along either 18610 * axis, false otherwise. 18611 */ 18612 @SuppressWarnings({"UnusedParameters"}) 18613 protected boolean overScrollBy(int deltaX, int deltaY, 18614 int scrollX, int scrollY, 18615 int scrollRangeX, int scrollRangeY, 18616 int maxOverScrollX, int maxOverScrollY, 18617 boolean isTouchEvent) { 18618 final int overScrollMode = mOverScrollMode; 18619 final boolean canScrollHorizontal = 18620 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 18621 final boolean canScrollVertical = 18622 computeVerticalScrollRange() > computeVerticalScrollExtent(); 18623 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 18624 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 18625 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 18626 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 18627 18628 int newScrollX = scrollX + deltaX; 18629 if (!overScrollHorizontal) { 18630 maxOverScrollX = 0; 18631 } 18632 18633 int newScrollY = scrollY + deltaY; 18634 if (!overScrollVertical) { 18635 maxOverScrollY = 0; 18636 } 18637 18638 // Clamp values if at the limits and record 18639 final int left = -maxOverScrollX; 18640 final int right = maxOverScrollX + scrollRangeX; 18641 final int top = -maxOverScrollY; 18642 final int bottom = maxOverScrollY + scrollRangeY; 18643 18644 boolean clampedX = false; 18645 if (newScrollX > right) { 18646 newScrollX = right; 18647 clampedX = true; 18648 } else if (newScrollX < left) { 18649 newScrollX = left; 18650 clampedX = true; 18651 } 18652 18653 boolean clampedY = false; 18654 if (newScrollY > bottom) { 18655 newScrollY = bottom; 18656 clampedY = true; 18657 } else if (newScrollY < top) { 18658 newScrollY = top; 18659 clampedY = true; 18660 } 18661 18662 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 18663 18664 return clampedX || clampedY; 18665 } 18666 18667 /** 18668 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 18669 * respond to the results of an over-scroll operation. 18670 * 18671 * @param scrollX New X scroll value in pixels 18672 * @param scrollY New Y scroll value in pixels 18673 * @param clampedX True if scrollX was clamped to an over-scroll boundary 18674 * @param clampedY True if scrollY was clamped to an over-scroll boundary 18675 */ 18676 protected void onOverScrolled(int scrollX, int scrollY, 18677 boolean clampedX, boolean clampedY) { 18678 // Intentionally empty. 18679 } 18680 18681 /** 18682 * Returns the over-scroll mode for this view. The result will be 18683 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18684 * (allow over-scrolling only if the view content is larger than the container), 18685 * or {@link #OVER_SCROLL_NEVER}. 18686 * 18687 * @return This view's over-scroll mode. 18688 */ 18689 public int getOverScrollMode() { 18690 return mOverScrollMode; 18691 } 18692 18693 /** 18694 * Set the over-scroll mode for this view. Valid over-scroll modes are 18695 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18696 * (allow over-scrolling only if the view content is larger than the container), 18697 * or {@link #OVER_SCROLL_NEVER}. 18698 * 18699 * Setting the over-scroll mode of a view will have an effect only if the 18700 * view is capable of scrolling. 18701 * 18702 * @param overScrollMode The new over-scroll mode for this view. 18703 */ 18704 public void setOverScrollMode(int overScrollMode) { 18705 if (overScrollMode != OVER_SCROLL_ALWAYS && 18706 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 18707 overScrollMode != OVER_SCROLL_NEVER) { 18708 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 18709 } 18710 mOverScrollMode = overScrollMode; 18711 } 18712 18713 /** 18714 * Enable or disable nested scrolling for this view. 18715 * 18716 * <p>If this property is set to true the view will be permitted to initiate nested 18717 * scrolling operations with a compatible parent view in the current hierarchy. If this 18718 * view does not implement nested scrolling this will have no effect. Disabling nested scrolling 18719 * while a nested scroll is in progress has the effect of {@link #stopNestedScroll() stopping} 18720 * the nested scroll.</p> 18721 * 18722 * @param enabled true to enable nested scrolling, false to disable 18723 * 18724 * @see #isNestedScrollingEnabled() 18725 */ 18726 public void setNestedScrollingEnabled(boolean enabled) { 18727 if (enabled) { 18728 mPrivateFlags3 |= PFLAG3_NESTED_SCROLLING_ENABLED; 18729 } else { 18730 stopNestedScroll(); 18731 mPrivateFlags3 &= ~PFLAG3_NESTED_SCROLLING_ENABLED; 18732 } 18733 } 18734 18735 /** 18736 * Returns true if nested scrolling is enabled for this view. 18737 * 18738 * <p>If nested scrolling is enabled and this View class implementation supports it, 18739 * this view will act as a nested scrolling child view when applicable, forwarding data 18740 * about the scroll operation in progress to a compatible and cooperating nested scrolling 18741 * parent.</p> 18742 * 18743 * @return true if nested scrolling is enabled 18744 * 18745 * @see #setNestedScrollingEnabled(boolean) 18746 */ 18747 public boolean isNestedScrollingEnabled() { 18748 return (mPrivateFlags3 & PFLAG3_NESTED_SCROLLING_ENABLED) == 18749 PFLAG3_NESTED_SCROLLING_ENABLED; 18750 } 18751 18752 /** 18753 * Begin a nestable scroll operation along the given axes. 18754 * 18755 * <p>A view starting a nested scroll promises to abide by the following contract:</p> 18756 * 18757 * <p>The view will call startNestedScroll upon initiating a scroll operation. In the case 18758 * of a touch scroll this corresponds to the initial {@link MotionEvent#ACTION_DOWN}. 18759 * In the case of touch scrolling the nested scroll will be terminated automatically in 18760 * the same manner as {@link ViewParent#requestDisallowInterceptTouchEvent(boolean)}. 18761 * In the event of programmatic scrolling the caller must explicitly call 18762 * {@link #stopNestedScroll()} to indicate the end of the nested scroll.</p> 18763 * 18764 * <p>If <code>startNestedScroll</code> returns true, a cooperative parent was found. 18765 * If it returns false the caller may ignore the rest of this contract until the next scroll. 18766 * Calling startNestedScroll while a nested scroll is already in progress will return true.</p> 18767 * 18768 * <p>At each incremental step of the scroll the caller should invoke 18769 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} 18770 * once it has calculated the requested scrolling delta. If it returns true the nested scrolling 18771 * parent at least partially consumed the scroll and the caller should adjust the amount it 18772 * scrolls by.</p> 18773 * 18774 * <p>After applying the remainder of the scroll delta the caller should invoke 18775 * {@link #dispatchNestedScroll(int, int, int, int, int[]) dispatchNestedScroll}, passing 18776 * both the delta consumed and the delta unconsumed. A nested scrolling parent may treat 18777 * these values differently. See {@link ViewParent#onNestedScroll(View, int, int, int, int)}. 18778 * </p> 18779 * 18780 * @param axes Flags consisting of a combination of {@link #SCROLL_AXIS_HORIZONTAL} and/or 18781 * {@link #SCROLL_AXIS_VERTICAL}. 18782 * @return true if a cooperative parent was found and nested scrolling has been enabled for 18783 * the current gesture. 18784 * 18785 * @see #stopNestedScroll() 18786 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18787 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18788 */ 18789 public boolean startNestedScroll(int axes) { 18790 if (hasNestedScrollingParent()) { 18791 // Already in progress 18792 return true; 18793 } 18794 if (isNestedScrollingEnabled()) { 18795 ViewParent p = getParent(); 18796 View child = this; 18797 while (p != null) { 18798 try { 18799 if (p.onStartNestedScroll(child, this, axes)) { 18800 mNestedScrollingParent = p; 18801 p.onNestedScrollAccepted(child, this, axes); 18802 return true; 18803 } 18804 } catch (AbstractMethodError e) { 18805 Log.e(VIEW_LOG_TAG, "ViewParent " + p + " does not implement interface " + 18806 "method onStartNestedScroll", e); 18807 // Allow the search upward to continue 18808 } 18809 if (p instanceof View) { 18810 child = (View) p; 18811 } 18812 p = p.getParent(); 18813 } 18814 } 18815 return false; 18816 } 18817 18818 /** 18819 * Stop a nested scroll in progress. 18820 * 18821 * <p>Calling this method when a nested scroll is not currently in progress is harmless.</p> 18822 * 18823 * @see #startNestedScroll(int) 18824 */ 18825 public void stopNestedScroll() { 18826 if (mNestedScrollingParent != null) { 18827 mNestedScrollingParent.onStopNestedScroll(this); 18828 mNestedScrollingParent = null; 18829 } 18830 } 18831 18832 /** 18833 * Returns true if this view has a nested scrolling parent. 18834 * 18835 * <p>The presence of a nested scrolling parent indicates that this view has initiated 18836 * a nested scroll and it was accepted by an ancestor view further up the view hierarchy.</p> 18837 * 18838 * @return whether this view has a nested scrolling parent 18839 */ 18840 public boolean hasNestedScrollingParent() { 18841 return mNestedScrollingParent != null; 18842 } 18843 18844 /** 18845 * Dispatch one step of a nested scroll in progress. 18846 * 18847 * <p>Implementations of views that support nested scrolling should call this to report 18848 * info about a scroll in progress to the current nested scrolling parent. If a nested scroll 18849 * is not currently in progress or nested scrolling is not 18850 * {@link #isNestedScrollingEnabled() enabled} for this view this method does nothing.</p> 18851 * 18852 * <p>Compatible View implementations should also call 18853 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} before 18854 * consuming a component of the scroll event themselves.</p> 18855 * 18856 * @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step 18857 * @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step 18858 * @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view 18859 * @param dyUnconsumed Horizontal scroll distance in pixels not consumed by this view 18860 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18861 * in local view coordinates of this view from before this operation 18862 * to after it completes. View implementations may use this to adjust 18863 * expected input coordinate tracking. 18864 * @return true if the event was dispatched, false if it could not be dispatched. 18865 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18866 */ 18867 public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed, 18868 int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) { 18869 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18870 if (dxConsumed != 0 || dyConsumed != 0 || dxUnconsumed != 0 || dyUnconsumed != 0) { 18871 int startX = 0; 18872 int startY = 0; 18873 if (offsetInWindow != null) { 18874 getLocationInWindow(offsetInWindow); 18875 startX = offsetInWindow[0]; 18876 startY = offsetInWindow[1]; 18877 } 18878 18879 mNestedScrollingParent.onNestedScroll(this, dxConsumed, dyConsumed, 18880 dxUnconsumed, dyUnconsumed); 18881 18882 if (offsetInWindow != null) { 18883 getLocationInWindow(offsetInWindow); 18884 offsetInWindow[0] -= startX; 18885 offsetInWindow[1] -= startY; 18886 } 18887 return true; 18888 } else if (offsetInWindow != null) { 18889 // No motion, no dispatch. Keep offsetInWindow up to date. 18890 offsetInWindow[0] = 0; 18891 offsetInWindow[1] = 0; 18892 } 18893 } 18894 return false; 18895 } 18896 18897 /** 18898 * Dispatch one step of a nested scroll in progress before this view consumes any portion of it. 18899 * 18900 * <p>Nested pre-scroll events are to nested scroll events what touch intercept is to touch. 18901 * <code>dispatchNestedPreScroll</code> offers an opportunity for the parent view in a nested 18902 * scrolling operation to consume some or all of the scroll operation before the child view 18903 * consumes it.</p> 18904 * 18905 * @param dx Horizontal scroll distance in pixels 18906 * @param dy Vertical scroll distance in pixels 18907 * @param consumed Output. If not null, consumed[0] will contain the consumed component of dx 18908 * and consumed[1] the consumed dy. 18909 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18910 * in local view coordinates of this view from before this operation 18911 * to after it completes. View implementations may use this to adjust 18912 * expected input coordinate tracking. 18913 * @return true if the parent consumed some or all of the scroll delta 18914 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18915 */ 18916 public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) { 18917 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18918 if (dx != 0 || dy != 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 if (consumed == null) { 18928 if (mTempNestedScrollConsumed == null) { 18929 mTempNestedScrollConsumed = new int[2]; 18930 } 18931 consumed = mTempNestedScrollConsumed; 18932 } 18933 consumed[0] = 0; 18934 consumed[1] = 0; 18935 mNestedScrollingParent.onNestedPreScroll(this, dx, dy, consumed); 18936 18937 if (offsetInWindow != null) { 18938 getLocationInWindow(offsetInWindow); 18939 offsetInWindow[0] -= startX; 18940 offsetInWindow[1] -= startY; 18941 } 18942 return consumed[0] != 0 || consumed[1] != 0; 18943 } else if (offsetInWindow != null) { 18944 offsetInWindow[0] = 0; 18945 offsetInWindow[1] = 0; 18946 } 18947 } 18948 return false; 18949 } 18950 18951 /** 18952 * Dispatch a fling to a nested scrolling parent. 18953 * 18954 * <p>This method should be used to indicate that a nested scrolling child has detected 18955 * suitable conditions for a fling. Generally this means that a touch scroll has ended with a 18956 * {@link VelocityTracker velocity} in the direction of scrolling that meets or exceeds 18957 * the {@link ViewConfiguration#getScaledMinimumFlingVelocity() minimum fling velocity} 18958 * along a scrollable axis.</p> 18959 * 18960 * <p>If a nested scrolling child view would normally fling but it is at the edge of 18961 * its own content, it can use this method to delegate the fling to its nested scrolling 18962 * parent instead. The parent may optionally consume the fling or observe a child fling.</p> 18963 * 18964 * @param velocityX Horizontal fling velocity in pixels per second 18965 * @param velocityY Vertical fling velocity in pixels per second 18966 * @param consumed true if the child consumed the fling, false otherwise 18967 * @return true if the nested scrolling parent consumed or otherwise reacted to the fling 18968 */ 18969 public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) { 18970 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18971 return mNestedScrollingParent.onNestedFling(this, velocityX, velocityY, consumed); 18972 } 18973 return false; 18974 } 18975 18976 /** 18977 * Dispatch a fling to a nested scrolling parent before it is processed by this view. 18978 * 18979 * <p>Nested pre-fling events are to nested fling events what touch intercept is to touch 18980 * and what nested pre-scroll is to nested scroll. <code>dispatchNestedPreFling</code> 18981 * offsets an opportunity for the parent view in a nested fling to fully consume the fling 18982 * before the child view consumes it. If this method returns <code>true</code>, a nested 18983 * parent view consumed the fling and this view should not scroll as a result.</p> 18984 * 18985 * <p>For a better user experience, only one view in a nested scrolling chain should consume 18986 * the fling at a time. If a parent view consumed the fling this method will return false. 18987 * Custom view implementations should account for this in two ways:</p> 18988 * 18989 * <ul> 18990 * <li>If a custom view is paged and needs to settle to a fixed page-point, do not 18991 * call <code>dispatchNestedPreFling</code>; consume the fling and settle to a valid 18992 * position regardless.</li> 18993 * <li>If a nested parent does consume the fling, this view should not scroll at all, 18994 * even to settle back to a valid idle position.</li> 18995 * </ul> 18996 * 18997 * <p>Views should also not offer fling velocities to nested parent views along an axis 18998 * where scrolling is not currently supported; a {@link android.widget.ScrollView ScrollView} 18999 * should not offer a horizontal fling velocity to its parents since scrolling along that 19000 * axis is not permitted and carrying velocity along that motion does not make sense.</p> 19001 * 19002 * @param velocityX Horizontal fling velocity in pixels per second 19003 * @param velocityY Vertical fling velocity in pixels per second 19004 * @return true if a nested scrolling parent consumed the fling 19005 */ 19006 public boolean dispatchNestedPreFling(float velocityX, float velocityY) { 19007 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 19008 return mNestedScrollingParent.onNestedPreFling(this, velocityX, velocityY); 19009 } 19010 return false; 19011 } 19012 19013 /** 19014 * Gets a scale factor that determines the distance the view should scroll 19015 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 19016 * @return The vertical scroll scale factor. 19017 * @hide 19018 */ 19019 protected float getVerticalScrollFactor() { 19020 if (mVerticalScrollFactor == 0) { 19021 TypedValue outValue = new TypedValue(); 19022 if (!mContext.getTheme().resolveAttribute( 19023 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 19024 throw new IllegalStateException( 19025 "Expected theme to define listPreferredItemHeight."); 19026 } 19027 mVerticalScrollFactor = outValue.getDimension( 19028 mContext.getResources().getDisplayMetrics()); 19029 } 19030 return mVerticalScrollFactor; 19031 } 19032 19033 /** 19034 * Gets a scale factor that determines the distance the view should scroll 19035 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 19036 * @return The horizontal scroll scale factor. 19037 * @hide 19038 */ 19039 protected float getHorizontalScrollFactor() { 19040 // TODO: Should use something else. 19041 return getVerticalScrollFactor(); 19042 } 19043 19044 /** 19045 * Return the value specifying the text direction or policy that was set with 19046 * {@link #setTextDirection(int)}. 19047 * 19048 * @return the defined text direction. It can be one of: 19049 * 19050 * {@link #TEXT_DIRECTION_INHERIT}, 19051 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19052 * {@link #TEXT_DIRECTION_ANY_RTL}, 19053 * {@link #TEXT_DIRECTION_LTR}, 19054 * {@link #TEXT_DIRECTION_RTL}, 19055 * {@link #TEXT_DIRECTION_LOCALE} 19056 * 19057 * @attr ref android.R.styleable#View_textDirection 19058 * 19059 * @hide 19060 */ 19061 @ViewDebug.ExportedProperty(category = "text", mapping = { 19062 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19063 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19064 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19065 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19066 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19067 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19068 }) 19069 public int getRawTextDirection() { 19070 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_MASK) >> PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 19071 } 19072 19073 /** 19074 * Set the text direction. 19075 * 19076 * @param textDirection the direction to set. Should be one of: 19077 * 19078 * {@link #TEXT_DIRECTION_INHERIT}, 19079 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19080 * {@link #TEXT_DIRECTION_ANY_RTL}, 19081 * {@link #TEXT_DIRECTION_LTR}, 19082 * {@link #TEXT_DIRECTION_RTL}, 19083 * {@link #TEXT_DIRECTION_LOCALE} 19084 * 19085 * Resolution will be done if the value is set to TEXT_DIRECTION_INHERIT. The resolution 19086 * proceeds up the parent chain of the view to get the value. If there is no parent, then it will 19087 * return the default {@link #TEXT_DIRECTION_FIRST_STRONG}. 19088 * 19089 * @attr ref android.R.styleable#View_textDirection 19090 */ 19091 public void setTextDirection(int textDirection) { 19092 if (getRawTextDirection() != textDirection) { 19093 // Reset the current text direction and the resolved one 19094 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 19095 resetResolvedTextDirection(); 19096 // Set the new text direction 19097 mPrivateFlags2 |= ((textDirection << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) & PFLAG2_TEXT_DIRECTION_MASK); 19098 // Do resolution 19099 resolveTextDirection(); 19100 // Notify change 19101 onRtlPropertiesChanged(getLayoutDirection()); 19102 // Refresh 19103 requestLayout(); 19104 invalidate(true); 19105 } 19106 } 19107 19108 /** 19109 * Return the resolved text direction. 19110 * 19111 * @return the resolved text direction. Returns one of: 19112 * 19113 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19114 * {@link #TEXT_DIRECTION_ANY_RTL}, 19115 * {@link #TEXT_DIRECTION_LTR}, 19116 * {@link #TEXT_DIRECTION_RTL}, 19117 * {@link #TEXT_DIRECTION_LOCALE} 19118 * 19119 * @attr ref android.R.styleable#View_textDirection 19120 */ 19121 @ViewDebug.ExportedProperty(category = "text", mapping = { 19122 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19123 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19124 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19125 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19126 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19127 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19128 }) 19129 public int getTextDirection() { 19130 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED_MASK) >> PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 19131 } 19132 19133 /** 19134 * Resolve the text direction. 19135 * 19136 * @return true if resolution has been done, false otherwise. 19137 * 19138 * @hide 19139 */ 19140 public boolean resolveTextDirection() { 19141 // Reset any previous text direction resolution 19142 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19143 19144 if (hasRtlSupport()) { 19145 // Set resolved text direction flag depending on text direction flag 19146 final int textDirection = getRawTextDirection(); 19147 switch(textDirection) { 19148 case TEXT_DIRECTION_INHERIT: 19149 if (!canResolveTextDirection()) { 19150 // We cannot do the resolution if there is no parent, so use the default one 19151 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19152 // Resolution will need to happen again later 19153 return false; 19154 } 19155 19156 // Parent has not yet resolved, so we still return the default 19157 try { 19158 if (!mParent.isTextDirectionResolved()) { 19159 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19160 // Resolution will need to happen again later 19161 return false; 19162 } 19163 } catch (AbstractMethodError e) { 19164 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19165 " does not fully implement ViewParent", e); 19166 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED | 19167 PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19168 return true; 19169 } 19170 19171 // Set current resolved direction to the same value as the parent's one 19172 int parentResolvedDirection; 19173 try { 19174 parentResolvedDirection = mParent.getTextDirection(); 19175 } catch (AbstractMethodError e) { 19176 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19177 " does not fully implement ViewParent", e); 19178 parentResolvedDirection = TEXT_DIRECTION_LTR; 19179 } 19180 switch (parentResolvedDirection) { 19181 case TEXT_DIRECTION_FIRST_STRONG: 19182 case TEXT_DIRECTION_ANY_RTL: 19183 case TEXT_DIRECTION_LTR: 19184 case TEXT_DIRECTION_RTL: 19185 case TEXT_DIRECTION_LOCALE: 19186 mPrivateFlags2 |= 19187 (parentResolvedDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19188 break; 19189 default: 19190 // Default resolved direction is "first strong" heuristic 19191 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19192 } 19193 break; 19194 case TEXT_DIRECTION_FIRST_STRONG: 19195 case TEXT_DIRECTION_ANY_RTL: 19196 case TEXT_DIRECTION_LTR: 19197 case TEXT_DIRECTION_RTL: 19198 case TEXT_DIRECTION_LOCALE: 19199 // Resolved direction is the same as text direction 19200 mPrivateFlags2 |= (textDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19201 break; 19202 default: 19203 // Default resolved direction is "first strong" heuristic 19204 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19205 } 19206 } else { 19207 // Default resolved direction is "first strong" heuristic 19208 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19209 } 19210 19211 // Set to resolved 19212 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED; 19213 return true; 19214 } 19215 19216 /** 19217 * Check if text direction resolution can be done. 19218 * 19219 * @return true if text direction resolution can be done otherwise return false. 19220 */ 19221 public boolean canResolveTextDirection() { 19222 switch (getRawTextDirection()) { 19223 case TEXT_DIRECTION_INHERIT: 19224 if (mParent != null) { 19225 try { 19226 return mParent.canResolveTextDirection(); 19227 } catch (AbstractMethodError e) { 19228 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19229 " does not fully implement ViewParent", e); 19230 } 19231 } 19232 return false; 19233 19234 default: 19235 return true; 19236 } 19237 } 19238 19239 /** 19240 * Reset resolved text direction. Text direction will be resolved during a call to 19241 * {@link #onMeasure(int, int)}. 19242 * 19243 * @hide 19244 */ 19245 public void resetResolvedTextDirection() { 19246 // Reset any previous text direction resolution 19247 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19248 // Set to default value 19249 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19250 } 19251 19252 /** 19253 * @return true if text direction is inherited. 19254 * 19255 * @hide 19256 */ 19257 public boolean isTextDirectionInherited() { 19258 return (getRawTextDirection() == TEXT_DIRECTION_INHERIT); 19259 } 19260 19261 /** 19262 * @return true if text direction is resolved. 19263 */ 19264 public boolean isTextDirectionResolved() { 19265 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED) == PFLAG2_TEXT_DIRECTION_RESOLVED; 19266 } 19267 19268 /** 19269 * Return the value specifying the text alignment or policy that was set with 19270 * {@link #setTextAlignment(int)}. 19271 * 19272 * @return the defined text alignment. It can be one of: 19273 * 19274 * {@link #TEXT_ALIGNMENT_INHERIT}, 19275 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19276 * {@link #TEXT_ALIGNMENT_CENTER}, 19277 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19278 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19279 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19280 * {@link #TEXT_ALIGNMENT_VIEW_END} 19281 * 19282 * @attr ref android.R.styleable#View_textAlignment 19283 * 19284 * @hide 19285 */ 19286 @ViewDebug.ExportedProperty(category = "text", mapping = { 19287 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19288 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19289 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19290 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19291 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19292 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19293 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19294 }) 19295 @TextAlignment 19296 public int getRawTextAlignment() { 19297 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_MASK) >> PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 19298 } 19299 19300 /** 19301 * Set the text alignment. 19302 * 19303 * @param textAlignment The text alignment to set. Should be one of 19304 * 19305 * {@link #TEXT_ALIGNMENT_INHERIT}, 19306 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19307 * {@link #TEXT_ALIGNMENT_CENTER}, 19308 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19309 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19310 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19311 * {@link #TEXT_ALIGNMENT_VIEW_END} 19312 * 19313 * Resolution will be done if the value is set to TEXT_ALIGNMENT_INHERIT. The resolution 19314 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 19315 * will return the default {@link #TEXT_ALIGNMENT_GRAVITY}. 19316 * 19317 * @attr ref android.R.styleable#View_textAlignment 19318 */ 19319 public void setTextAlignment(@TextAlignment int textAlignment) { 19320 if (textAlignment != getRawTextAlignment()) { 19321 // Reset the current and resolved text alignment 19322 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 19323 resetResolvedTextAlignment(); 19324 // Set the new text alignment 19325 mPrivateFlags2 |= 19326 ((textAlignment << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) & PFLAG2_TEXT_ALIGNMENT_MASK); 19327 // Do resolution 19328 resolveTextAlignment(); 19329 // Notify change 19330 onRtlPropertiesChanged(getLayoutDirection()); 19331 // Refresh 19332 requestLayout(); 19333 invalidate(true); 19334 } 19335 } 19336 19337 /** 19338 * Return the resolved text alignment. 19339 * 19340 * @return the resolved text alignment. Returns one of: 19341 * 19342 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19343 * {@link #TEXT_ALIGNMENT_CENTER}, 19344 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19345 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19346 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19347 * {@link #TEXT_ALIGNMENT_VIEW_END} 19348 * 19349 * @attr ref android.R.styleable#View_textAlignment 19350 */ 19351 @ViewDebug.ExportedProperty(category = "text", mapping = { 19352 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19353 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19354 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19355 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19356 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19357 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19358 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19359 }) 19360 @TextAlignment 19361 public int getTextAlignment() { 19362 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK) >> 19363 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 19364 } 19365 19366 /** 19367 * Resolve the text alignment. 19368 * 19369 * @return true if resolution has been done, false otherwise. 19370 * 19371 * @hide 19372 */ 19373 public boolean resolveTextAlignment() { 19374 // Reset any previous text alignment resolution 19375 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19376 19377 if (hasRtlSupport()) { 19378 // Set resolved text alignment flag depending on text alignment flag 19379 final int textAlignment = getRawTextAlignment(); 19380 switch (textAlignment) { 19381 case TEXT_ALIGNMENT_INHERIT: 19382 // Check if we can resolve the text alignment 19383 if (!canResolveTextAlignment()) { 19384 // We cannot do the resolution if there is no parent so use the default 19385 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19386 // Resolution will need to happen again later 19387 return false; 19388 } 19389 19390 // Parent has not yet resolved, so we still return the default 19391 try { 19392 if (!mParent.isTextAlignmentResolved()) { 19393 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19394 // Resolution will need to happen again later 19395 return false; 19396 } 19397 } catch (AbstractMethodError e) { 19398 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19399 " does not fully implement ViewParent", e); 19400 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED | 19401 PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19402 return true; 19403 } 19404 19405 int parentResolvedTextAlignment; 19406 try { 19407 parentResolvedTextAlignment = mParent.getTextAlignment(); 19408 } catch (AbstractMethodError e) { 19409 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19410 " does not fully implement ViewParent", e); 19411 parentResolvedTextAlignment = TEXT_ALIGNMENT_GRAVITY; 19412 } 19413 switch (parentResolvedTextAlignment) { 19414 case TEXT_ALIGNMENT_GRAVITY: 19415 case TEXT_ALIGNMENT_TEXT_START: 19416 case TEXT_ALIGNMENT_TEXT_END: 19417 case TEXT_ALIGNMENT_CENTER: 19418 case TEXT_ALIGNMENT_VIEW_START: 19419 case TEXT_ALIGNMENT_VIEW_END: 19420 // Resolved text alignment is the same as the parent resolved 19421 // text alignment 19422 mPrivateFlags2 |= 19423 (parentResolvedTextAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19424 break; 19425 default: 19426 // Use default resolved text alignment 19427 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19428 } 19429 break; 19430 case TEXT_ALIGNMENT_GRAVITY: 19431 case TEXT_ALIGNMENT_TEXT_START: 19432 case TEXT_ALIGNMENT_TEXT_END: 19433 case TEXT_ALIGNMENT_CENTER: 19434 case TEXT_ALIGNMENT_VIEW_START: 19435 case TEXT_ALIGNMENT_VIEW_END: 19436 // Resolved text alignment is the same as text alignment 19437 mPrivateFlags2 |= (textAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19438 break; 19439 default: 19440 // Use default resolved text alignment 19441 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19442 } 19443 } else { 19444 // Use default resolved text alignment 19445 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19446 } 19447 19448 // Set the resolved 19449 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19450 return true; 19451 } 19452 19453 /** 19454 * Check if text alignment resolution can be done. 19455 * 19456 * @return true if text alignment resolution can be done otherwise return false. 19457 */ 19458 public boolean canResolveTextAlignment() { 19459 switch (getRawTextAlignment()) { 19460 case TEXT_DIRECTION_INHERIT: 19461 if (mParent != null) { 19462 try { 19463 return mParent.canResolveTextAlignment(); 19464 } catch (AbstractMethodError e) { 19465 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19466 " does not fully implement ViewParent", e); 19467 } 19468 } 19469 return false; 19470 19471 default: 19472 return true; 19473 } 19474 } 19475 19476 /** 19477 * Reset resolved text alignment. Text alignment will be resolved during a call to 19478 * {@link #onMeasure(int, int)}. 19479 * 19480 * @hide 19481 */ 19482 public void resetResolvedTextAlignment() { 19483 // Reset any previous text alignment resolution 19484 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19485 // Set to default 19486 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19487 } 19488 19489 /** 19490 * @return true if text alignment is inherited. 19491 * 19492 * @hide 19493 */ 19494 public boolean isTextAlignmentInherited() { 19495 return (getRawTextAlignment() == TEXT_ALIGNMENT_INHERIT); 19496 } 19497 19498 /** 19499 * @return true if text alignment is resolved. 19500 */ 19501 public boolean isTextAlignmentResolved() { 19502 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED) == PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19503 } 19504 19505 /** 19506 * Generate a value suitable for use in {@link #setId(int)}. 19507 * This value will not collide with ID values generated at build time by aapt for R.id. 19508 * 19509 * @return a generated ID value 19510 */ 19511 public static int generateViewId() { 19512 for (;;) { 19513 final int result = sNextGeneratedId.get(); 19514 // aapt-generated IDs have the high byte nonzero; clamp to the range under that. 19515 int newValue = result + 1; 19516 if (newValue > 0x00FFFFFF) newValue = 1; // Roll over to 1, not 0. 19517 if (sNextGeneratedId.compareAndSet(result, newValue)) { 19518 return result; 19519 } 19520 } 19521 } 19522 19523 /** 19524 * Gets the Views in the hierarchy affected by entering and exiting Activity Scene transitions. 19525 * @param transitioningViews This View will be added to transitioningViews if it is VISIBLE and 19526 * a normal View or a ViewGroup with 19527 * {@link android.view.ViewGroup#isTransitionGroup()} true. 19528 * @hide 19529 */ 19530 public void captureTransitioningViews(List<View> transitioningViews) { 19531 if (getVisibility() == View.VISIBLE) { 19532 transitioningViews.add(this); 19533 } 19534 } 19535 19536 /** 19537 * Adds all Views that have {@link #getTransitionName()} non-null to namedElements. 19538 * @param namedElements Will contain all Views in the hierarchy having a transitionName. 19539 * @hide 19540 */ 19541 public void findNamedViews(Map<String, View> namedElements) { 19542 if (getVisibility() == VISIBLE || mGhostView != null) { 19543 String transitionName = getTransitionName(); 19544 if (transitionName != null) { 19545 namedElements.put(transitionName, this); 19546 } 19547 } 19548 } 19549 19550 // 19551 // Properties 19552 // 19553 /** 19554 * A Property wrapper around the <code>alpha</code> functionality handled by the 19555 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 19556 */ 19557 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 19558 @Override 19559 public void setValue(View object, float value) { 19560 object.setAlpha(value); 19561 } 19562 19563 @Override 19564 public Float get(View object) { 19565 return object.getAlpha(); 19566 } 19567 }; 19568 19569 /** 19570 * A Property wrapper around the <code>translationX</code> functionality handled by the 19571 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 19572 */ 19573 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 19574 @Override 19575 public void setValue(View object, float value) { 19576 object.setTranslationX(value); 19577 } 19578 19579 @Override 19580 public Float get(View object) { 19581 return object.getTranslationX(); 19582 } 19583 }; 19584 19585 /** 19586 * A Property wrapper around the <code>translationY</code> functionality handled by the 19587 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 19588 */ 19589 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 19590 @Override 19591 public void setValue(View object, float value) { 19592 object.setTranslationY(value); 19593 } 19594 19595 @Override 19596 public Float get(View object) { 19597 return object.getTranslationY(); 19598 } 19599 }; 19600 19601 /** 19602 * A Property wrapper around the <code>translationZ</code> functionality handled by the 19603 * {@link View#setTranslationZ(float)} and {@link View#getTranslationZ()} methods. 19604 */ 19605 public static final Property<View, Float> TRANSLATION_Z = new FloatProperty<View>("translationZ") { 19606 @Override 19607 public void setValue(View object, float value) { 19608 object.setTranslationZ(value); 19609 } 19610 19611 @Override 19612 public Float get(View object) { 19613 return object.getTranslationZ(); 19614 } 19615 }; 19616 19617 /** 19618 * A Property wrapper around the <code>x</code> functionality handled by the 19619 * {@link View#setX(float)} and {@link View#getX()} methods. 19620 */ 19621 public static final Property<View, Float> X = new FloatProperty<View>("x") { 19622 @Override 19623 public void setValue(View object, float value) { 19624 object.setX(value); 19625 } 19626 19627 @Override 19628 public Float get(View object) { 19629 return object.getX(); 19630 } 19631 }; 19632 19633 /** 19634 * A Property wrapper around the <code>y</code> functionality handled by the 19635 * {@link View#setY(float)} and {@link View#getY()} methods. 19636 */ 19637 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 19638 @Override 19639 public void setValue(View object, float value) { 19640 object.setY(value); 19641 } 19642 19643 @Override 19644 public Float get(View object) { 19645 return object.getY(); 19646 } 19647 }; 19648 19649 /** 19650 * A Property wrapper around the <code>z</code> functionality handled by the 19651 * {@link View#setZ(float)} and {@link View#getZ()} methods. 19652 */ 19653 public static final Property<View, Float> Z = new FloatProperty<View>("z") { 19654 @Override 19655 public void setValue(View object, float value) { 19656 object.setZ(value); 19657 } 19658 19659 @Override 19660 public Float get(View object) { 19661 return object.getZ(); 19662 } 19663 }; 19664 19665 /** 19666 * A Property wrapper around the <code>rotation</code> functionality handled by the 19667 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 19668 */ 19669 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 19670 @Override 19671 public void setValue(View object, float value) { 19672 object.setRotation(value); 19673 } 19674 19675 @Override 19676 public Float get(View object) { 19677 return object.getRotation(); 19678 } 19679 }; 19680 19681 /** 19682 * A Property wrapper around the <code>rotationX</code> functionality handled by the 19683 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 19684 */ 19685 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 19686 @Override 19687 public void setValue(View object, float value) { 19688 object.setRotationX(value); 19689 } 19690 19691 @Override 19692 public Float get(View object) { 19693 return object.getRotationX(); 19694 } 19695 }; 19696 19697 /** 19698 * A Property wrapper around the <code>rotationY</code> functionality handled by the 19699 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 19700 */ 19701 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 19702 @Override 19703 public void setValue(View object, float value) { 19704 object.setRotationY(value); 19705 } 19706 19707 @Override 19708 public Float get(View object) { 19709 return object.getRotationY(); 19710 } 19711 }; 19712 19713 /** 19714 * A Property wrapper around the <code>scaleX</code> functionality handled by the 19715 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 19716 */ 19717 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 19718 @Override 19719 public void setValue(View object, float value) { 19720 object.setScaleX(value); 19721 } 19722 19723 @Override 19724 public Float get(View object) { 19725 return object.getScaleX(); 19726 } 19727 }; 19728 19729 /** 19730 * A Property wrapper around the <code>scaleY</code> functionality handled by the 19731 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 19732 */ 19733 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 19734 @Override 19735 public void setValue(View object, float value) { 19736 object.setScaleY(value); 19737 } 19738 19739 @Override 19740 public Float get(View object) { 19741 return object.getScaleY(); 19742 } 19743 }; 19744 19745 /** 19746 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 19747 * Each MeasureSpec represents a requirement for either the width or the height. 19748 * A MeasureSpec is comprised of a size and a mode. There are three possible 19749 * modes: 19750 * <dl> 19751 * <dt>UNSPECIFIED</dt> 19752 * <dd> 19753 * The parent has not imposed any constraint on the child. It can be whatever size 19754 * it wants. 19755 * </dd> 19756 * 19757 * <dt>EXACTLY</dt> 19758 * <dd> 19759 * The parent has determined an exact size for the child. The child is going to be 19760 * given those bounds regardless of how big it wants to be. 19761 * </dd> 19762 * 19763 * <dt>AT_MOST</dt> 19764 * <dd> 19765 * The child can be as large as it wants up to the specified size. 19766 * </dd> 19767 * </dl> 19768 * 19769 * MeasureSpecs are implemented as ints to reduce object allocation. This class 19770 * is provided to pack and unpack the <size, mode> tuple into the int. 19771 */ 19772 public static class MeasureSpec { 19773 private static final int MODE_SHIFT = 30; 19774 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 19775 19776 /** 19777 * Measure specification mode: The parent has not imposed any constraint 19778 * on the child. It can be whatever size it wants. 19779 */ 19780 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 19781 19782 /** 19783 * Measure specification mode: The parent has determined an exact size 19784 * for the child. The child is going to be given those bounds regardless 19785 * of how big it wants to be. 19786 */ 19787 public static final int EXACTLY = 1 << MODE_SHIFT; 19788 19789 /** 19790 * Measure specification mode: The child can be as large as it wants up 19791 * to the specified size. 19792 */ 19793 public static final int AT_MOST = 2 << MODE_SHIFT; 19794 19795 /** 19796 * Creates a measure specification based on the supplied size and mode. 19797 * 19798 * The mode must always be one of the following: 19799 * <ul> 19800 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 19801 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 19802 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 19803 * </ul> 19804 * 19805 * <p><strong>Note:</strong> On API level 17 and lower, makeMeasureSpec's 19806 * implementation was such that the order of arguments did not matter 19807 * and overflow in either value could impact the resulting MeasureSpec. 19808 * {@link android.widget.RelativeLayout} was affected by this bug. 19809 * Apps targeting API levels greater than 17 will get the fixed, more strict 19810 * behavior.</p> 19811 * 19812 * @param size the size of the measure specification 19813 * @param mode the mode of the measure specification 19814 * @return the measure specification based on size and mode 19815 */ 19816 public static int makeMeasureSpec(int size, int mode) { 19817 if (sUseBrokenMakeMeasureSpec) { 19818 return size + mode; 19819 } else { 19820 return (size & ~MODE_MASK) | (mode & MODE_MASK); 19821 } 19822 } 19823 19824 /** 19825 * Extracts the mode from the supplied measure specification. 19826 * 19827 * @param measureSpec the measure specification to extract the mode from 19828 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 19829 * {@link android.view.View.MeasureSpec#AT_MOST} or 19830 * {@link android.view.View.MeasureSpec#EXACTLY} 19831 */ 19832 public static int getMode(int measureSpec) { 19833 return (measureSpec & MODE_MASK); 19834 } 19835 19836 /** 19837 * Extracts the size from the supplied measure specification. 19838 * 19839 * @param measureSpec the measure specification to extract the size from 19840 * @return the size in pixels defined in the supplied measure specification 19841 */ 19842 public static int getSize(int measureSpec) { 19843 return (measureSpec & ~MODE_MASK); 19844 } 19845 19846 static int adjust(int measureSpec, int delta) { 19847 final int mode = getMode(measureSpec); 19848 if (mode == UNSPECIFIED) { 19849 // No need to adjust size for UNSPECIFIED mode. 19850 return makeMeasureSpec(0, UNSPECIFIED); 19851 } 19852 int size = getSize(measureSpec) + delta; 19853 if (size < 0) { 19854 Log.e(VIEW_LOG_TAG, "MeasureSpec.adjust: new size would be negative! (" + size + 19855 ") spec: " + toString(measureSpec) + " delta: " + delta); 19856 size = 0; 19857 } 19858 return makeMeasureSpec(size, mode); 19859 } 19860 19861 /** 19862 * Returns a String representation of the specified measure 19863 * specification. 19864 * 19865 * @param measureSpec the measure specification to convert to a String 19866 * @return a String with the following format: "MeasureSpec: MODE SIZE" 19867 */ 19868 public static String toString(int measureSpec) { 19869 int mode = getMode(measureSpec); 19870 int size = getSize(measureSpec); 19871 19872 StringBuilder sb = new StringBuilder("MeasureSpec: "); 19873 19874 if (mode == UNSPECIFIED) 19875 sb.append("UNSPECIFIED "); 19876 else if (mode == EXACTLY) 19877 sb.append("EXACTLY "); 19878 else if (mode == AT_MOST) 19879 sb.append("AT_MOST "); 19880 else 19881 sb.append(mode).append(" "); 19882 19883 sb.append(size); 19884 return sb.toString(); 19885 } 19886 } 19887 19888 private final class CheckForLongPress implements Runnable { 19889 private int mOriginalWindowAttachCount; 19890 19891 @Override 19892 public void run() { 19893 if (isPressed() && (mParent != null) 19894 && mOriginalWindowAttachCount == mWindowAttachCount) { 19895 if (performLongClick()) { 19896 mHasPerformedLongPress = true; 19897 } 19898 } 19899 } 19900 19901 public void rememberWindowAttachCount() { 19902 mOriginalWindowAttachCount = mWindowAttachCount; 19903 } 19904 } 19905 19906 private final class CheckForTap implements Runnable { 19907 public float x; 19908 public float y; 19909 19910 @Override 19911 public void run() { 19912 mPrivateFlags &= ~PFLAG_PREPRESSED; 19913 setPressed(true, x, y); 19914 checkForLongClick(ViewConfiguration.getTapTimeout()); 19915 } 19916 } 19917 19918 private final class PerformClick implements Runnable { 19919 @Override 19920 public void run() { 19921 performClick(); 19922 } 19923 } 19924 19925 /** @hide */ 19926 public void hackTurnOffWindowResizeAnim(boolean off) { 19927 mAttachInfo.mTurnOffWindowResizeAnim = off; 19928 } 19929 19930 /** 19931 * This method returns a ViewPropertyAnimator object, which can be used to animate 19932 * specific properties on this View. 19933 * 19934 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 19935 */ 19936 public ViewPropertyAnimator animate() { 19937 if (mAnimator == null) { 19938 mAnimator = new ViewPropertyAnimator(this); 19939 } 19940 return mAnimator; 19941 } 19942 19943 /** 19944 * Sets the name of the View to be used to identify Views in Transitions. 19945 * Names should be unique in the View hierarchy. 19946 * 19947 * @param transitionName The name of the View to uniquely identify it for Transitions. 19948 */ 19949 public final void setTransitionName(String transitionName) { 19950 mTransitionName = transitionName; 19951 } 19952 19953 /** 19954 * Returns the name of the View to be used to identify Views in Transitions. 19955 * Names should be unique in the View hierarchy. 19956 * 19957 * <p>This returns null if the View has not been given a name.</p> 19958 * 19959 * @return The name used of the View to be used to identify Views in Transitions or null 19960 * if no name has been given. 19961 */ 19962 @ViewDebug.ExportedProperty 19963 public String getTransitionName() { 19964 return mTransitionName; 19965 } 19966 19967 /** 19968 * Interface definition for a callback to be invoked when a hardware key event is 19969 * dispatched to this view. The callback will be invoked before the key event is 19970 * given to the view. This is only useful for hardware keyboards; a software input 19971 * method has no obligation to trigger this listener. 19972 */ 19973 public interface OnKeyListener { 19974 /** 19975 * Called when a hardware key is dispatched to a view. This allows listeners to 19976 * get a chance to respond before the target view. 19977 * <p>Key presses in software keyboards will generally NOT trigger this method, 19978 * although some may elect to do so in some situations. Do not assume a 19979 * software input method has to be key-based; even if it is, it may use key presses 19980 * in a different way than you expect, so there is no way to reliably catch soft 19981 * input key presses. 19982 * 19983 * @param v The view the key has been dispatched to. 19984 * @param keyCode The code for the physical key that was pressed 19985 * @param event The KeyEvent object containing full information about 19986 * the event. 19987 * @return True if the listener has consumed the event, false otherwise. 19988 */ 19989 boolean onKey(View v, int keyCode, KeyEvent event); 19990 } 19991 19992 /** 19993 * Interface definition for a callback to be invoked when a touch event is 19994 * dispatched to this view. The callback will be invoked before the touch 19995 * event is given to the view. 19996 */ 19997 public interface OnTouchListener { 19998 /** 19999 * Called when a touch event is dispatched to a view. This allows listeners to 20000 * get a chance to respond before the target view. 20001 * 20002 * @param v The view the touch event has been dispatched to. 20003 * @param event The MotionEvent object containing full information about 20004 * the event. 20005 * @return True if the listener has consumed the event, false otherwise. 20006 */ 20007 boolean onTouch(View v, MotionEvent event); 20008 } 20009 20010 /** 20011 * Interface definition for a callback to be invoked when a hover event is 20012 * dispatched to this view. The callback will be invoked before the hover 20013 * event is given to the view. 20014 */ 20015 public interface OnHoverListener { 20016 /** 20017 * Called when a hover event is dispatched to a view. This allows listeners to 20018 * get a chance to respond before the target view. 20019 * 20020 * @param v The view the hover event has been dispatched to. 20021 * @param event The MotionEvent object containing full information about 20022 * the event. 20023 * @return True if the listener has consumed the event, false otherwise. 20024 */ 20025 boolean onHover(View v, MotionEvent event); 20026 } 20027 20028 /** 20029 * Interface definition for a callback to be invoked when a generic motion event is 20030 * dispatched to this view. The callback will be invoked before the generic motion 20031 * event is given to the view. 20032 */ 20033 public interface OnGenericMotionListener { 20034 /** 20035 * Called when a generic motion event is dispatched to a view. This allows listeners to 20036 * get a chance to respond before the target view. 20037 * 20038 * @param v The view the generic motion event has been dispatched to. 20039 * @param event The MotionEvent object containing full information about 20040 * the event. 20041 * @return True if the listener has consumed the event, false otherwise. 20042 */ 20043 boolean onGenericMotion(View v, MotionEvent event); 20044 } 20045 20046 /** 20047 * Interface definition for a callback to be invoked when a view has been clicked and held. 20048 */ 20049 public interface OnLongClickListener { 20050 /** 20051 * Called when a view has been clicked and held. 20052 * 20053 * @param v The view that was clicked and held. 20054 * 20055 * @return true if the callback consumed the long click, false otherwise. 20056 */ 20057 boolean onLongClick(View v); 20058 } 20059 20060 /** 20061 * Interface definition for a callback to be invoked when a drag is being dispatched 20062 * to this view. The callback will be invoked before the hosting view's own 20063 * onDrag(event) method. If the listener wants to fall back to the hosting view's 20064 * onDrag(event) behavior, it should return 'false' from this callback. 20065 * 20066 * <div class="special reference"> 20067 * <h3>Developer Guides</h3> 20068 * <p>For a guide to implementing drag and drop features, read the 20069 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 20070 * </div> 20071 */ 20072 public interface OnDragListener { 20073 /** 20074 * Called when a drag event is dispatched to a view. This allows listeners 20075 * to get a chance to override base View behavior. 20076 * 20077 * @param v The View that received the drag event. 20078 * @param event The {@link android.view.DragEvent} object for the drag event. 20079 * @return {@code true} if the drag event was handled successfully, or {@code false} 20080 * if the drag event was not handled. Note that {@code false} will trigger the View 20081 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 20082 */ 20083 boolean onDrag(View v, DragEvent event); 20084 } 20085 20086 /** 20087 * Interface definition for a callback to be invoked when the focus state of 20088 * a view changed. 20089 */ 20090 public interface OnFocusChangeListener { 20091 /** 20092 * Called when the focus state of a view has changed. 20093 * 20094 * @param v The view whose state has changed. 20095 * @param hasFocus The new focus state of v. 20096 */ 20097 void onFocusChange(View v, boolean hasFocus); 20098 } 20099 20100 /** 20101 * Interface definition for a callback to be invoked when a view is clicked. 20102 */ 20103 public interface OnClickListener { 20104 /** 20105 * Called when a view has been clicked. 20106 * 20107 * @param v The view that was clicked. 20108 */ 20109 void onClick(View v); 20110 } 20111 20112 /** 20113 * Interface definition for a callback to be invoked when the context menu 20114 * for this view is being built. 20115 */ 20116 public interface OnCreateContextMenuListener { 20117 /** 20118 * Called when the context menu for this view is being built. It is not 20119 * safe to hold onto the menu after this method returns. 20120 * 20121 * @param menu The context menu that is being built 20122 * @param v The view for which the context menu is being built 20123 * @param menuInfo Extra information about the item for which the 20124 * context menu should be shown. This information will vary 20125 * depending on the class of v. 20126 */ 20127 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 20128 } 20129 20130 /** 20131 * Interface definition for a callback to be invoked when the status bar changes 20132 * visibility. This reports <strong>global</strong> changes to the system UI 20133 * state, not what the application is requesting. 20134 * 20135 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 20136 */ 20137 public interface OnSystemUiVisibilityChangeListener { 20138 /** 20139 * Called when the status bar changes visibility because of a call to 20140 * {@link View#setSystemUiVisibility(int)}. 20141 * 20142 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 20143 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}. 20144 * This tells you the <strong>global</strong> state of these UI visibility 20145 * flags, not what your app is currently applying. 20146 */ 20147 public void onSystemUiVisibilityChange(int visibility); 20148 } 20149 20150 /** 20151 * Interface definition for a callback to be invoked when this view is attached 20152 * or detached from its window. 20153 */ 20154 public interface OnAttachStateChangeListener { 20155 /** 20156 * Called when the view is attached to a window. 20157 * @param v The view that was attached 20158 */ 20159 public void onViewAttachedToWindow(View v); 20160 /** 20161 * Called when the view is detached from a window. 20162 * @param v The view that was detached 20163 */ 20164 public void onViewDetachedFromWindow(View v); 20165 } 20166 20167 /** 20168 * Listener for applying window insets on a view in a custom way. 20169 * 20170 * <p>Apps may choose to implement this interface if they want to apply custom policy 20171 * to the way that window insets are treated for a view. If an OnApplyWindowInsetsListener 20172 * is set, its 20173 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 20174 * method will be called instead of the View's own 20175 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. The listener 20176 * may optionally call the parameter View's <code>onApplyWindowInsets</code> method to apply 20177 * the View's normal behavior as part of its own.</p> 20178 */ 20179 public interface OnApplyWindowInsetsListener { 20180 /** 20181 * When {@link View#setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) set} 20182 * on a View, this listener method will be called instead of the view's own 20183 * {@link View#onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 20184 * 20185 * @param v The view applying window insets 20186 * @param insets The insets to apply 20187 * @return The insets supplied, minus any insets that were consumed 20188 */ 20189 public WindowInsets onApplyWindowInsets(View v, WindowInsets insets); 20190 } 20191 20192 private final class UnsetPressedState implements Runnable { 20193 @Override 20194 public void run() { 20195 setPressed(false); 20196 } 20197 } 20198 20199 /** 20200 * Base class for derived classes that want to save and restore their own 20201 * state in {@link android.view.View#onSaveInstanceState()}. 20202 */ 20203 public static class BaseSavedState extends AbsSavedState { 20204 /** 20205 * Constructor used when reading from a parcel. Reads the state of the superclass. 20206 * 20207 * @param source 20208 */ 20209 public BaseSavedState(Parcel source) { 20210 super(source); 20211 } 20212 20213 /** 20214 * Constructor called by derived classes when creating their SavedState objects 20215 * 20216 * @param superState The state of the superclass of this view 20217 */ 20218 public BaseSavedState(Parcelable superState) { 20219 super(superState); 20220 } 20221 20222 public static final Parcelable.Creator<BaseSavedState> CREATOR = 20223 new Parcelable.Creator<BaseSavedState>() { 20224 public BaseSavedState createFromParcel(Parcel in) { 20225 return new BaseSavedState(in); 20226 } 20227 20228 public BaseSavedState[] newArray(int size) { 20229 return new BaseSavedState[size]; 20230 } 20231 }; 20232 } 20233 20234 /** 20235 * A set of information given to a view when it is attached to its parent 20236 * window. 20237 */ 20238 final static class AttachInfo { 20239 interface Callbacks { 20240 void playSoundEffect(int effectId); 20241 boolean performHapticFeedback(int effectId, boolean always); 20242 } 20243 20244 /** 20245 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 20246 * to a Handler. This class contains the target (View) to invalidate and 20247 * the coordinates of the dirty rectangle. 20248 * 20249 * For performance purposes, this class also implements a pool of up to 20250 * POOL_LIMIT objects that get reused. This reduces memory allocations 20251 * whenever possible. 20252 */ 20253 static class InvalidateInfo { 20254 private static final int POOL_LIMIT = 10; 20255 20256 private static final SynchronizedPool<InvalidateInfo> sPool = 20257 new SynchronizedPool<InvalidateInfo>(POOL_LIMIT); 20258 20259 View target; 20260 20261 int left; 20262 int top; 20263 int right; 20264 int bottom; 20265 20266 public static InvalidateInfo obtain() { 20267 InvalidateInfo instance = sPool.acquire(); 20268 return (instance != null) ? instance : new InvalidateInfo(); 20269 } 20270 20271 public void recycle() { 20272 target = null; 20273 sPool.release(this); 20274 } 20275 } 20276 20277 final IWindowSession mSession; 20278 20279 final IWindow mWindow; 20280 20281 final IBinder mWindowToken; 20282 20283 final Display mDisplay; 20284 20285 final Callbacks mRootCallbacks; 20286 20287 IWindowId mIWindowId; 20288 WindowId mWindowId; 20289 20290 /** 20291 * The top view of the hierarchy. 20292 */ 20293 View mRootView; 20294 20295 IBinder mPanelParentWindowToken; 20296 20297 boolean mHardwareAccelerated; 20298 boolean mHardwareAccelerationRequested; 20299 HardwareRenderer mHardwareRenderer; 20300 List<RenderNode> mPendingAnimatingRenderNodes; 20301 20302 /** 20303 * The state of the display to which the window is attached, as reported 20304 * by {@link Display#getState()}. Note that the display state constants 20305 * declared by {@link Display} do not exactly line up with the screen state 20306 * constants declared by {@link View} (there are more display states than 20307 * screen states). 20308 */ 20309 int mDisplayState = Display.STATE_UNKNOWN; 20310 20311 /** 20312 * Scale factor used by the compatibility mode 20313 */ 20314 float mApplicationScale; 20315 20316 /** 20317 * Indicates whether the application is in compatibility mode 20318 */ 20319 boolean mScalingRequired; 20320 20321 /** 20322 * If set, ViewRootImpl doesn't use its lame animation for when the window resizes. 20323 */ 20324 boolean mTurnOffWindowResizeAnim; 20325 20326 /** 20327 * Left position of this view's window 20328 */ 20329 int mWindowLeft; 20330 20331 /** 20332 * Top position of this view's window 20333 */ 20334 int mWindowTop; 20335 20336 /** 20337 * Indicates whether views need to use 32-bit drawing caches 20338 */ 20339 boolean mUse32BitDrawingCache; 20340 20341 /** 20342 * For windows that are full-screen but using insets to layout inside 20343 * of the screen areas, these are the current insets to appear inside 20344 * the overscan area of the display. 20345 */ 20346 final Rect mOverscanInsets = new Rect(); 20347 20348 /** 20349 * For windows that are full-screen but using insets to layout inside 20350 * of the screen decorations, these are the current insets for the 20351 * content of the window. 20352 */ 20353 final Rect mContentInsets = new Rect(); 20354 20355 /** 20356 * For windows that are full-screen but using insets to layout inside 20357 * of the screen decorations, these are the current insets for the 20358 * actual visible parts of the window. 20359 */ 20360 final Rect mVisibleInsets = new Rect(); 20361 20362 /** 20363 * For windows that are full-screen but using insets to layout inside 20364 * of the screen decorations, these are the current insets for the 20365 * stable system windows. 20366 */ 20367 final Rect mStableInsets = new Rect(); 20368 20369 /** 20370 * The internal insets given by this window. This value is 20371 * supplied by the client (through 20372 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 20373 * be given to the window manager when changed to be used in laying 20374 * out windows behind it. 20375 */ 20376 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 20377 = new ViewTreeObserver.InternalInsetsInfo(); 20378 20379 /** 20380 * Set to true when mGivenInternalInsets is non-empty. 20381 */ 20382 boolean mHasNonEmptyGivenInternalInsets; 20383 20384 /** 20385 * All views in the window's hierarchy that serve as scroll containers, 20386 * used to determine if the window can be resized or must be panned 20387 * to adjust for a soft input area. 20388 */ 20389 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 20390 20391 final KeyEvent.DispatcherState mKeyDispatchState 20392 = new KeyEvent.DispatcherState(); 20393 20394 /** 20395 * Indicates whether the view's window currently has the focus. 20396 */ 20397 boolean mHasWindowFocus; 20398 20399 /** 20400 * The current visibility of the window. 20401 */ 20402 int mWindowVisibility; 20403 20404 /** 20405 * Indicates the time at which drawing started to occur. 20406 */ 20407 long mDrawingTime; 20408 20409 /** 20410 * Indicates whether or not ignoring the DIRTY_MASK flags. 20411 */ 20412 boolean mIgnoreDirtyState; 20413 20414 /** 20415 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 20416 * to avoid clearing that flag prematurely. 20417 */ 20418 boolean mSetIgnoreDirtyState = false; 20419 20420 /** 20421 * Indicates whether the view's window is currently in touch mode. 20422 */ 20423 boolean mInTouchMode; 20424 20425 /** 20426 * Indicates whether the view has requested unbuffered input dispatching for the current 20427 * event stream. 20428 */ 20429 boolean mUnbufferedDispatchRequested; 20430 20431 /** 20432 * Indicates that ViewAncestor should trigger a global layout change 20433 * the next time it performs a traversal 20434 */ 20435 boolean mRecomputeGlobalAttributes; 20436 20437 /** 20438 * Always report new attributes at next traversal. 20439 */ 20440 boolean mForceReportNewAttributes; 20441 20442 /** 20443 * Set during a traveral if any views want to keep the screen on. 20444 */ 20445 boolean mKeepScreenOn; 20446 20447 /** 20448 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 20449 */ 20450 int mSystemUiVisibility; 20451 20452 /** 20453 * Hack to force certain system UI visibility flags to be cleared. 20454 */ 20455 int mDisabledSystemUiVisibility; 20456 20457 /** 20458 * Last global system UI visibility reported by the window manager. 20459 */ 20460 int mGlobalSystemUiVisibility; 20461 20462 /** 20463 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 20464 * attached. 20465 */ 20466 boolean mHasSystemUiListeners; 20467 20468 /** 20469 * Set if the window has requested to extend into the overscan region 20470 * via WindowManager.LayoutParams.FLAG_LAYOUT_IN_OVERSCAN. 20471 */ 20472 boolean mOverscanRequested; 20473 20474 /** 20475 * Set if the visibility of any views has changed. 20476 */ 20477 boolean mViewVisibilityChanged; 20478 20479 /** 20480 * Set to true if a view has been scrolled. 20481 */ 20482 boolean mViewScrollChanged; 20483 20484 /** 20485 * Set to true if high contrast mode enabled 20486 */ 20487 boolean mHighContrastText; 20488 20489 /** 20490 * Global to the view hierarchy used as a temporary for dealing with 20491 * x/y points in the transparent region computations. 20492 */ 20493 final int[] mTransparentLocation = new int[2]; 20494 20495 /** 20496 * Global to the view hierarchy used as a temporary for dealing with 20497 * x/y points in the ViewGroup.invalidateChild implementation. 20498 */ 20499 final int[] mInvalidateChildLocation = new int[2]; 20500 20501 /** 20502 * Global to the view hierarchy used as a temporary for dealng with 20503 * computing absolute on-screen location. 20504 */ 20505 final int[] mTmpLocation = new int[2]; 20506 20507 /** 20508 * Global to the view hierarchy used as a temporary for dealing with 20509 * x/y location when view is transformed. 20510 */ 20511 final float[] mTmpTransformLocation = new float[2]; 20512 20513 /** 20514 * The view tree observer used to dispatch global events like 20515 * layout, pre-draw, touch mode change, etc. 20516 */ 20517 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 20518 20519 /** 20520 * A Canvas used by the view hierarchy to perform bitmap caching. 20521 */ 20522 Canvas mCanvas; 20523 20524 /** 20525 * The view root impl. 20526 */ 20527 final ViewRootImpl mViewRootImpl; 20528 20529 /** 20530 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 20531 * handler can be used to pump events in the UI events queue. 20532 */ 20533 final Handler mHandler; 20534 20535 /** 20536 * Temporary for use in computing invalidate rectangles while 20537 * calling up the hierarchy. 20538 */ 20539 final Rect mTmpInvalRect = new Rect(); 20540 20541 /** 20542 * Temporary for use in computing hit areas with transformed views 20543 */ 20544 final RectF mTmpTransformRect = new RectF(); 20545 20546 /** 20547 * Temporary for use in computing hit areas with transformed views 20548 */ 20549 final RectF mTmpTransformRect1 = new RectF(); 20550 20551 /** 20552 * Temporary list of rectanges. 20553 */ 20554 final List<RectF> mTmpRectList = new ArrayList<>(); 20555 20556 /** 20557 * Temporary for use in transforming invalidation rect 20558 */ 20559 final Matrix mTmpMatrix = new Matrix(); 20560 20561 /** 20562 * Temporary for use in transforming invalidation rect 20563 */ 20564 final Transformation mTmpTransformation = new Transformation(); 20565 20566 /** 20567 * Temporary for use in querying outlines from OutlineProviders 20568 */ 20569 final Outline mTmpOutline = new Outline(); 20570 20571 /** 20572 * Temporary list for use in collecting focusable descendents of a view. 20573 */ 20574 final ArrayList<View> mTempArrayList = new ArrayList<View>(24); 20575 20576 /** 20577 * The id of the window for accessibility purposes. 20578 */ 20579 int mAccessibilityWindowId = AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 20580 20581 /** 20582 * Flags related to accessibility processing. 20583 * 20584 * @see AccessibilityNodeInfo#FLAG_INCLUDE_NOT_IMPORTANT_VIEWS 20585 * @see AccessibilityNodeInfo#FLAG_REPORT_VIEW_IDS 20586 */ 20587 int mAccessibilityFetchFlags; 20588 20589 /** 20590 * The drawable for highlighting accessibility focus. 20591 */ 20592 Drawable mAccessibilityFocusDrawable; 20593 20594 /** 20595 * Show where the margins, bounds and layout bounds are for each view. 20596 */ 20597 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false); 20598 20599 /** 20600 * Point used to compute visible regions. 20601 */ 20602 final Point mPoint = new Point(); 20603 20604 /** 20605 * Used to track which View originated a requestLayout() call, used when 20606 * requestLayout() is called during layout. 20607 */ 20608 View mViewRequestingLayout; 20609 20610 /** 20611 * Creates a new set of attachment information with the specified 20612 * events handler and thread. 20613 * 20614 * @param handler the events handler the view must use 20615 */ 20616 AttachInfo(IWindowSession session, IWindow window, Display display, 20617 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) { 20618 mSession = session; 20619 mWindow = window; 20620 mWindowToken = window.asBinder(); 20621 mDisplay = display; 20622 mViewRootImpl = viewRootImpl; 20623 mHandler = handler; 20624 mRootCallbacks = effectPlayer; 20625 } 20626 } 20627 20628 /** 20629 * <p>ScrollabilityCache holds various fields used by a View when scrolling 20630 * is supported. This avoids keeping too many unused fields in most 20631 * instances of View.</p> 20632 */ 20633 private static class ScrollabilityCache implements Runnable { 20634 20635 /** 20636 * Scrollbars are not visible 20637 */ 20638 public static final int OFF = 0; 20639 20640 /** 20641 * Scrollbars are visible 20642 */ 20643 public static final int ON = 1; 20644 20645 /** 20646 * Scrollbars are fading away 20647 */ 20648 public static final int FADING = 2; 20649 20650 public boolean fadeScrollBars; 20651 20652 public int fadingEdgeLength; 20653 public int scrollBarDefaultDelayBeforeFade; 20654 public int scrollBarFadeDuration; 20655 20656 public int scrollBarSize; 20657 public ScrollBarDrawable scrollBar; 20658 public float[] interpolatorValues; 20659 public View host; 20660 20661 public final Paint paint; 20662 public final Matrix matrix; 20663 public Shader shader; 20664 20665 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 20666 20667 private static final float[] OPAQUE = { 255 }; 20668 private static final float[] TRANSPARENT = { 0.0f }; 20669 20670 /** 20671 * When fading should start. This time moves into the future every time 20672 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 20673 */ 20674 public long fadeStartTime; 20675 20676 20677 /** 20678 * The current state of the scrollbars: ON, OFF, or FADING 20679 */ 20680 public int state = OFF; 20681 20682 private int mLastColor; 20683 20684 public ScrollabilityCache(ViewConfiguration configuration, View host) { 20685 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 20686 scrollBarSize = configuration.getScaledScrollBarSize(); 20687 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 20688 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 20689 20690 paint = new Paint(); 20691 matrix = new Matrix(); 20692 // use use a height of 1, and then wack the matrix each time we 20693 // actually use it. 20694 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20695 paint.setShader(shader); 20696 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20697 20698 this.host = host; 20699 } 20700 20701 public void setFadeColor(int color) { 20702 if (color != mLastColor) { 20703 mLastColor = color; 20704 20705 if (color != 0) { 20706 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 20707 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 20708 paint.setShader(shader); 20709 // Restore the default transfer mode (src_over) 20710 paint.setXfermode(null); 20711 } else { 20712 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20713 paint.setShader(shader); 20714 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20715 } 20716 } 20717 } 20718 20719 public void run() { 20720 long now = AnimationUtils.currentAnimationTimeMillis(); 20721 if (now >= fadeStartTime) { 20722 20723 // the animation fades the scrollbars out by changing 20724 // the opacity (alpha) from fully opaque to fully 20725 // transparent 20726 int nextFrame = (int) now; 20727 int framesCount = 0; 20728 20729 Interpolator interpolator = scrollBarInterpolator; 20730 20731 // Start opaque 20732 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 20733 20734 // End transparent 20735 nextFrame += scrollBarFadeDuration; 20736 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 20737 20738 state = FADING; 20739 20740 // Kick off the fade animation 20741 host.invalidate(true); 20742 } 20743 } 20744 } 20745 20746 /** 20747 * Resuable callback for sending 20748 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 20749 */ 20750 private class SendViewScrolledAccessibilityEvent implements Runnable { 20751 public volatile boolean mIsPending; 20752 20753 public void run() { 20754 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 20755 mIsPending = false; 20756 } 20757 } 20758 20759 /** 20760 * <p> 20761 * This class represents a delegate that can be registered in a {@link View} 20762 * to enhance accessibility support via composition rather via inheritance. 20763 * It is specifically targeted to widget developers that extend basic View 20764 * classes i.e. classes in package android.view, that would like their 20765 * applications to be backwards compatible. 20766 * </p> 20767 * <div class="special reference"> 20768 * <h3>Developer Guides</h3> 20769 * <p>For more information about making applications accessible, read the 20770 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a> 20771 * developer guide.</p> 20772 * </div> 20773 * <p> 20774 * A scenario in which a developer would like to use an accessibility delegate 20775 * is overriding a method introduced in a later API version then the minimal API 20776 * version supported by the application. For example, the method 20777 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 20778 * in API version 4 when the accessibility APIs were first introduced. If a 20779 * developer would like his application to run on API version 4 devices (assuming 20780 * all other APIs used by the application are version 4 or lower) and take advantage 20781 * of this method, instead of overriding the method which would break the application's 20782 * backwards compatibility, he can override the corresponding method in this 20783 * delegate and register the delegate in the target View if the API version of 20784 * the system is high enough i.e. the API version is same or higher to the API 20785 * version that introduced 20786 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 20787 * </p> 20788 * <p> 20789 * Here is an example implementation: 20790 * </p> 20791 * <code><pre><p> 20792 * if (Build.VERSION.SDK_INT >= 14) { 20793 * // If the API version is equal of higher than the version in 20794 * // which onInitializeAccessibilityNodeInfo was introduced we 20795 * // register a delegate with a customized implementation. 20796 * View view = findViewById(R.id.view_id); 20797 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 20798 * public void onInitializeAccessibilityNodeInfo(View host, 20799 * AccessibilityNodeInfo info) { 20800 * // Let the default implementation populate the info. 20801 * super.onInitializeAccessibilityNodeInfo(host, info); 20802 * // Set some other information. 20803 * info.setEnabled(host.isEnabled()); 20804 * } 20805 * }); 20806 * } 20807 * </code></pre></p> 20808 * <p> 20809 * This delegate contains methods that correspond to the accessibility methods 20810 * in View. If a delegate has been specified the implementation in View hands 20811 * off handling to the corresponding method in this delegate. The default 20812 * implementation the delegate methods behaves exactly as the corresponding 20813 * method in View for the case of no accessibility delegate been set. Hence, 20814 * to customize the behavior of a View method, clients can override only the 20815 * corresponding delegate method without altering the behavior of the rest 20816 * accessibility related methods of the host view. 20817 * </p> 20818 */ 20819 public static class AccessibilityDelegate { 20820 20821 /** 20822 * Sends an accessibility event of the given type. If accessibility is not 20823 * enabled this method has no effect. 20824 * <p> 20825 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 20826 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 20827 * been set. 20828 * </p> 20829 * 20830 * @param host The View hosting the delegate. 20831 * @param eventType The type of the event to send. 20832 * 20833 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 20834 */ 20835 public void sendAccessibilityEvent(View host, int eventType) { 20836 host.sendAccessibilityEventInternal(eventType); 20837 } 20838 20839 /** 20840 * Performs the specified accessibility action on the view. For 20841 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 20842 * <p> 20843 * The default implementation behaves as 20844 * {@link View#performAccessibilityAction(int, Bundle) 20845 * View#performAccessibilityAction(int, Bundle)} for the case of 20846 * no accessibility delegate been set. 20847 * </p> 20848 * 20849 * @param action The action to perform. 20850 * @return Whether the action was performed. 20851 * 20852 * @see View#performAccessibilityAction(int, Bundle) 20853 * View#performAccessibilityAction(int, Bundle) 20854 */ 20855 public boolean performAccessibilityAction(View host, int action, Bundle args) { 20856 return host.performAccessibilityActionInternal(action, args); 20857 } 20858 20859 /** 20860 * Sends an accessibility event. This method behaves exactly as 20861 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 20862 * empty {@link AccessibilityEvent} and does not perform a check whether 20863 * accessibility is enabled. 20864 * <p> 20865 * The default implementation behaves as 20866 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20867 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 20868 * the case of no accessibility delegate been set. 20869 * </p> 20870 * 20871 * @param host The View hosting the delegate. 20872 * @param event The event to send. 20873 * 20874 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20875 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20876 */ 20877 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 20878 host.sendAccessibilityEventUncheckedInternal(event); 20879 } 20880 20881 /** 20882 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 20883 * to its children for adding their text content to the event. 20884 * <p> 20885 * The default implementation behaves as 20886 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20887 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 20888 * the case of no accessibility delegate been set. 20889 * </p> 20890 * 20891 * @param host The View hosting the delegate. 20892 * @param event The event. 20893 * @return True if the event population was completed. 20894 * 20895 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20896 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20897 */ 20898 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20899 return host.dispatchPopulateAccessibilityEventInternal(event); 20900 } 20901 20902 /** 20903 * Gives a chance to the host View to populate the accessibility event with its 20904 * text content. 20905 * <p> 20906 * The default implementation behaves as 20907 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 20908 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 20909 * the case of no accessibility delegate been set. 20910 * </p> 20911 * 20912 * @param host The View hosting the delegate. 20913 * @param event The accessibility event which to populate. 20914 * 20915 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 20916 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 20917 */ 20918 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20919 host.onPopulateAccessibilityEventInternal(event); 20920 } 20921 20922 /** 20923 * Initializes an {@link AccessibilityEvent} with information about the 20924 * the host View which is the event source. 20925 * <p> 20926 * The default implementation behaves as 20927 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 20928 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 20929 * the case of no accessibility delegate been set. 20930 * </p> 20931 * 20932 * @param host The View hosting the delegate. 20933 * @param event The event to initialize. 20934 * 20935 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 20936 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 20937 */ 20938 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 20939 host.onInitializeAccessibilityEventInternal(event); 20940 } 20941 20942 /** 20943 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 20944 * <p> 20945 * The default implementation behaves as 20946 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20947 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 20948 * the case of no accessibility delegate been set. 20949 * </p> 20950 * 20951 * @param host The View hosting the delegate. 20952 * @param info The instance to initialize. 20953 * 20954 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20955 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20956 */ 20957 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 20958 host.onInitializeAccessibilityNodeInfoInternal(info); 20959 } 20960 20961 /** 20962 * Called when a child of the host View has requested sending an 20963 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 20964 * to augment the event. 20965 * <p> 20966 * The default implementation behaves as 20967 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20968 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 20969 * the case of no accessibility delegate been set. 20970 * </p> 20971 * 20972 * @param host The View hosting the delegate. 20973 * @param child The child which requests sending the event. 20974 * @param event The event to be sent. 20975 * @return True if the event should be sent 20976 * 20977 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20978 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20979 */ 20980 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 20981 AccessibilityEvent event) { 20982 return host.onRequestSendAccessibilityEventInternal(child, event); 20983 } 20984 20985 /** 20986 * Gets the provider for managing a virtual view hierarchy rooted at this View 20987 * and reported to {@link android.accessibilityservice.AccessibilityService}s 20988 * that explore the window content. 20989 * <p> 20990 * The default implementation behaves as 20991 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 20992 * the case of no accessibility delegate been set. 20993 * </p> 20994 * 20995 * @return The provider. 20996 * 20997 * @see AccessibilityNodeProvider 20998 */ 20999 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 21000 return null; 21001 } 21002 21003 /** 21004 * Returns an {@link AccessibilityNodeInfo} representing the host view from the 21005 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 21006 * This method is responsible for obtaining an accessibility node info from a 21007 * pool of reusable instances and calling 21008 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on the host 21009 * view to initialize the former. 21010 * <p> 21011 * <strong>Note:</strong> The client is responsible for recycling the obtained 21012 * instance by calling {@link AccessibilityNodeInfo#recycle()} to minimize object 21013 * creation. 21014 * </p> 21015 * <p> 21016 * The default implementation behaves as 21017 * {@link View#createAccessibilityNodeInfo() View#createAccessibilityNodeInfo()} for 21018 * the case of no accessibility delegate been set. 21019 * </p> 21020 * @return A populated {@link AccessibilityNodeInfo}. 21021 * 21022 * @see AccessibilityNodeInfo 21023 * 21024 * @hide 21025 */ 21026 public AccessibilityNodeInfo createAccessibilityNodeInfo(View host) { 21027 return host.createAccessibilityNodeInfoInternal(); 21028 } 21029 } 21030 21031 private class MatchIdPredicate implements Predicate<View> { 21032 public int mId; 21033 21034 @Override 21035 public boolean apply(View view) { 21036 return (view.mID == mId); 21037 } 21038 } 21039 21040 private class MatchLabelForPredicate implements Predicate<View> { 21041 private int mLabeledId; 21042 21043 @Override 21044 public boolean apply(View view) { 21045 return (view.mLabelForId == mLabeledId); 21046 } 21047 } 21048 21049 private class SendViewStateChangedAccessibilityEvent implements Runnable { 21050 private int mChangeTypes = 0; 21051 private boolean mPosted; 21052 private boolean mPostedWithDelay; 21053 private long mLastEventTimeMillis; 21054 21055 @Override 21056 public void run() { 21057 mPosted = false; 21058 mPostedWithDelay = false; 21059 mLastEventTimeMillis = SystemClock.uptimeMillis(); 21060 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 21061 final AccessibilityEvent event = AccessibilityEvent.obtain(); 21062 event.setEventType(AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED); 21063 event.setContentChangeTypes(mChangeTypes); 21064 sendAccessibilityEventUnchecked(event); 21065 } 21066 mChangeTypes = 0; 21067 } 21068 21069 public void runOrPost(int changeType) { 21070 mChangeTypes |= changeType; 21071 21072 // If this is a live region or the child of a live region, collect 21073 // all events from this frame and send them on the next frame. 21074 if (inLiveRegion()) { 21075 // If we're already posted with a delay, remove that. 21076 if (mPostedWithDelay) { 21077 removeCallbacks(this); 21078 mPostedWithDelay = false; 21079 } 21080 // Only post if we're not already posted. 21081 if (!mPosted) { 21082 post(this); 21083 mPosted = true; 21084 } 21085 return; 21086 } 21087 21088 if (mPosted) { 21089 return; 21090 } 21091 21092 final long timeSinceLastMillis = SystemClock.uptimeMillis() - mLastEventTimeMillis; 21093 final long minEventIntevalMillis = 21094 ViewConfiguration.getSendRecurringAccessibilityEventsInterval(); 21095 if (timeSinceLastMillis >= minEventIntevalMillis) { 21096 removeCallbacks(this); 21097 run(); 21098 } else { 21099 postDelayed(this, minEventIntevalMillis - timeSinceLastMillis); 21100 mPostedWithDelay = true; 21101 } 21102 } 21103 } 21104 21105 private boolean inLiveRegion() { 21106 if (getAccessibilityLiveRegion() != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21107 return true; 21108 } 21109 21110 ViewParent parent = getParent(); 21111 while (parent instanceof View) { 21112 if (((View) parent).getAccessibilityLiveRegion() 21113 != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21114 return true; 21115 } 21116 parent = parent.getParent(); 21117 } 21118 21119 return false; 21120 } 21121 21122 /** 21123 * Dump all private flags in readable format, useful for documentation and 21124 * sanity checking. 21125 */ 21126 private static void dumpFlags() { 21127 final HashMap<String, String> found = Maps.newHashMap(); 21128 try { 21129 for (Field field : View.class.getDeclaredFields()) { 21130 final int modifiers = field.getModifiers(); 21131 if (Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers)) { 21132 if (field.getType().equals(int.class)) { 21133 final int value = field.getInt(null); 21134 dumpFlag(found, field.getName(), value); 21135 } else if (field.getType().equals(int[].class)) { 21136 final int[] values = (int[]) field.get(null); 21137 for (int i = 0; i < values.length; i++) { 21138 dumpFlag(found, field.getName() + "[" + i + "]", values[i]); 21139 } 21140 } 21141 } 21142 } 21143 } catch (IllegalAccessException e) { 21144 throw new RuntimeException(e); 21145 } 21146 21147 final ArrayList<String> keys = Lists.newArrayList(); 21148 keys.addAll(found.keySet()); 21149 Collections.sort(keys); 21150 for (String key : keys) { 21151 Log.d(VIEW_LOG_TAG, found.get(key)); 21152 } 21153 } 21154 21155 private static void dumpFlag(HashMap<String, String> found, String name, int value) { 21156 // Sort flags by prefix, then by bits, always keeping unique keys 21157 final String bits = String.format("%32s", Integer.toBinaryString(value)).replace('0', ' '); 21158 final int prefix = name.indexOf('_'); 21159 final String key = (prefix > 0 ? name.substring(0, prefix) : name) + bits + name; 21160 final String output = bits + " " + name; 21161 found.put(key, output); 21162 } 21163} 21164