View.java revision b15703c9b4bd77383344a06c0043f5f7448b24ae
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 RectF bounds = new RectF(); 5947 bounds.set(0, 0, getWidth(), getHeight()); 5948 outRects.add(bounds); 5949 } 5950 } 5951 5952 static void offsetRects(List<RectF> rects, float offsetX, float offsetY) { 5953 final int rectCount = rects.size(); 5954 for (int i = 0; i < rectCount; i++) { 5955 RectF intersection = rects.get(i); 5956 intersection.offset(offsetX, offsetY); 5957 } 5958 } 5959 5960 /** 5961 * Returns the delegate for implementing accessibility support via 5962 * composition. For more details see {@link AccessibilityDelegate}. 5963 * 5964 * @return The delegate, or null if none set. 5965 * 5966 * @hide 5967 */ 5968 public AccessibilityDelegate getAccessibilityDelegate() { 5969 return mAccessibilityDelegate; 5970 } 5971 5972 /** 5973 * Sets a delegate for implementing accessibility support via composition as 5974 * opposed to inheritance. The delegate's primary use is for implementing 5975 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 5976 * 5977 * @param delegate The delegate instance. 5978 * 5979 * @see AccessibilityDelegate 5980 */ 5981 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 5982 mAccessibilityDelegate = delegate; 5983 } 5984 5985 /** 5986 * Gets the provider for managing a virtual view hierarchy rooted at this View 5987 * and reported to {@link android.accessibilityservice.AccessibilityService}s 5988 * that explore the window content. 5989 * <p> 5990 * If this method returns an instance, this instance is responsible for managing 5991 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 5992 * View including the one representing the View itself. Similarly the returned 5993 * instance is responsible for performing accessibility actions on any virtual 5994 * view or the root view itself. 5995 * </p> 5996 * <p> 5997 * If an {@link AccessibilityDelegate} has been specified via calling 5998 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5999 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 6000 * is responsible for handling this call. 6001 * </p> 6002 * 6003 * @return The provider. 6004 * 6005 * @see AccessibilityNodeProvider 6006 */ 6007 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 6008 if (mAccessibilityDelegate != null) { 6009 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 6010 } else { 6011 return null; 6012 } 6013 } 6014 6015 /** 6016 * Gets the unique identifier of this view on the screen for accessibility purposes. 6017 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 6018 * 6019 * @return The view accessibility id. 6020 * 6021 * @hide 6022 */ 6023 public int getAccessibilityViewId() { 6024 if (mAccessibilityViewId == NO_ID) { 6025 mAccessibilityViewId = sNextAccessibilityViewId++; 6026 } 6027 return mAccessibilityViewId; 6028 } 6029 6030 /** 6031 * Gets the unique identifier of the window in which this View reseides. 6032 * 6033 * @return The window accessibility id. 6034 * 6035 * @hide 6036 */ 6037 public int getAccessibilityWindowId() { 6038 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId 6039 : AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 6040 } 6041 6042 /** 6043 * Gets the {@link View} description. It briefly describes the view and is 6044 * primarily used for accessibility support. Set this property to enable 6045 * better accessibility support for your application. This is especially 6046 * true for views that do not have textual representation (For example, 6047 * ImageButton). 6048 * 6049 * @return The content description. 6050 * 6051 * @attr ref android.R.styleable#View_contentDescription 6052 */ 6053 @ViewDebug.ExportedProperty(category = "accessibility") 6054 public CharSequence getContentDescription() { 6055 return mContentDescription; 6056 } 6057 6058 /** 6059 * Sets the {@link View} description. It briefly describes the view and is 6060 * primarily used for accessibility support. Set this property to enable 6061 * better accessibility support for your application. This is especially 6062 * true for views that do not have textual representation (For example, 6063 * ImageButton). 6064 * 6065 * @param contentDescription The content description. 6066 * 6067 * @attr ref android.R.styleable#View_contentDescription 6068 */ 6069 @RemotableViewMethod 6070 public void setContentDescription(CharSequence contentDescription) { 6071 if (mContentDescription == null) { 6072 if (contentDescription == null) { 6073 return; 6074 } 6075 } else if (mContentDescription.equals(contentDescription)) { 6076 return; 6077 } 6078 mContentDescription = contentDescription; 6079 final boolean nonEmptyDesc = contentDescription != null && contentDescription.length() > 0; 6080 if (nonEmptyDesc && getImportantForAccessibility() == IMPORTANT_FOR_ACCESSIBILITY_AUTO) { 6081 setImportantForAccessibility(IMPORTANT_FOR_ACCESSIBILITY_YES); 6082 notifySubtreeAccessibilityStateChangedIfNeeded(); 6083 } else { 6084 notifyViewAccessibilityStateChangedIfNeeded( 6085 AccessibilityEvent.CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION); 6086 } 6087 } 6088 6089 /** 6090 * Sets the id of a view before which this one is visited in accessibility traversal. 6091 * A screen-reader must visit the content of this view before the content of the one 6092 * it precedes. For example, if view B is set to be before view A, then a screen-reader 6093 * will traverse the entire content of B before traversing the entire content of A, 6094 * regardles of what traversal strategy it is using. 6095 * <p> 6096 * Views that do not have specified before/after relationships are traversed in order 6097 * determined by the screen-reader. 6098 * </p> 6099 * <p> 6100 * Setting that this view is before a view that is not important for accessibility 6101 * or if this view is not important for accessibility will have no effect as the 6102 * screen-reader is not aware of unimportant views. 6103 * </p> 6104 * 6105 * @param beforeId The id of a view this one precedes in accessibility traversal. 6106 * 6107 * @attr ref android.R.styleable#View_accessibilityTraversalBefore 6108 * 6109 * @see #setImportantForAccessibility(int) 6110 */ 6111 @RemotableViewMethod 6112 public void setAccessibilityTraversalBefore(int beforeId) { 6113 if (mAccessibilityTraversalBeforeId == beforeId) { 6114 return; 6115 } 6116 mAccessibilityTraversalBeforeId = beforeId; 6117 notifyViewAccessibilityStateChangedIfNeeded( 6118 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6119 } 6120 6121 /** 6122 * Gets the id of a view before which this one is visited in accessibility traversal. 6123 * 6124 * @return The id of a view this one precedes in accessibility traversal if 6125 * specified, otherwise {@link #NO_ID}. 6126 * 6127 * @see #setAccessibilityTraversalBefore(int) 6128 */ 6129 public int getAccessibilityTraversalBefore() { 6130 return mAccessibilityTraversalBeforeId; 6131 } 6132 6133 /** 6134 * Sets the id of a view after which this one is visited in accessibility traversal. 6135 * A screen-reader must visit the content of the other view before the content of this 6136 * one. For example, if view B is set to be after view A, then a screen-reader 6137 * will traverse the entire content of A before traversing the entire content of B, 6138 * regardles of what traversal strategy it is using. 6139 * <p> 6140 * Views that do not have specified before/after relationships are traversed in order 6141 * determined by the screen-reader. 6142 * </p> 6143 * <p> 6144 * Setting that this view is after a view that is not important for accessibility 6145 * or if this view is not important for accessibility will have no effect as the 6146 * screen-reader is not aware of unimportant views. 6147 * </p> 6148 * 6149 * @param afterId The id of a view this one succedees in accessibility traversal. 6150 * 6151 * @attr ref android.R.styleable#View_accessibilityTraversalAfter 6152 * 6153 * @see #setImportantForAccessibility(int) 6154 */ 6155 @RemotableViewMethod 6156 public void setAccessibilityTraversalAfter(int afterId) { 6157 if (mAccessibilityTraversalAfterId == afterId) { 6158 return; 6159 } 6160 mAccessibilityTraversalAfterId = afterId; 6161 notifyViewAccessibilityStateChangedIfNeeded( 6162 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6163 } 6164 6165 /** 6166 * Gets the id of a view after which this one is visited in accessibility traversal. 6167 * 6168 * @return The id of a view this one succeedes in accessibility traversal if 6169 * specified, otherwise {@link #NO_ID}. 6170 * 6171 * @see #setAccessibilityTraversalAfter(int) 6172 */ 6173 public int getAccessibilityTraversalAfter() { 6174 return mAccessibilityTraversalAfterId; 6175 } 6176 6177 /** 6178 * Gets the id of a view for which this view serves as a label for 6179 * accessibility purposes. 6180 * 6181 * @return The labeled view id. 6182 */ 6183 @ViewDebug.ExportedProperty(category = "accessibility") 6184 public int getLabelFor() { 6185 return mLabelForId; 6186 } 6187 6188 /** 6189 * Sets the id of a view for which this view serves as a label for 6190 * accessibility purposes. 6191 * 6192 * @param id The labeled view id. 6193 */ 6194 @RemotableViewMethod 6195 public void setLabelFor(int id) { 6196 if (mLabelForId == id) { 6197 return; 6198 } 6199 mLabelForId = id; 6200 if (mLabelForId != View.NO_ID 6201 && mID == View.NO_ID) { 6202 mID = generateViewId(); 6203 } 6204 notifyViewAccessibilityStateChangedIfNeeded( 6205 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6206 } 6207 6208 /** 6209 * Invoked whenever this view loses focus, either by losing window focus or by losing 6210 * focus within its window. This method can be used to clear any state tied to the 6211 * focus. For instance, if a button is held pressed with the trackball and the window 6212 * loses focus, this method can be used to cancel the press. 6213 * 6214 * Subclasses of View overriding this method should always call super.onFocusLost(). 6215 * 6216 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 6217 * @see #onWindowFocusChanged(boolean) 6218 * 6219 * @hide pending API council approval 6220 */ 6221 protected void onFocusLost() { 6222 resetPressedState(); 6223 } 6224 6225 private void resetPressedState() { 6226 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 6227 return; 6228 } 6229 6230 if (isPressed()) { 6231 setPressed(false); 6232 6233 if (!mHasPerformedLongPress) { 6234 removeLongPressCallback(); 6235 } 6236 } 6237 } 6238 6239 /** 6240 * Returns true if this view has focus 6241 * 6242 * @return True if this view has focus, false otherwise. 6243 */ 6244 @ViewDebug.ExportedProperty(category = "focus") 6245 public boolean isFocused() { 6246 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 6247 } 6248 6249 /** 6250 * Find the view in the hierarchy rooted at this view that currently has 6251 * focus. 6252 * 6253 * @return The view that currently has focus, or null if no focused view can 6254 * be found. 6255 */ 6256 public View findFocus() { 6257 return (mPrivateFlags & PFLAG_FOCUSED) != 0 ? this : null; 6258 } 6259 6260 /** 6261 * Indicates whether this view is one of the set of scrollable containers in 6262 * its window. 6263 * 6264 * @return whether this view is one of the set of scrollable containers in 6265 * its window 6266 * 6267 * @attr ref android.R.styleable#View_isScrollContainer 6268 */ 6269 public boolean isScrollContainer() { 6270 return (mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0; 6271 } 6272 6273 /** 6274 * Change whether this view is one of the set of scrollable containers in 6275 * its window. This will be used to determine whether the window can 6276 * resize or must pan when a soft input area is open -- scrollable 6277 * containers allow the window to use resize mode since the container 6278 * will appropriately shrink. 6279 * 6280 * @attr ref android.R.styleable#View_isScrollContainer 6281 */ 6282 public void setScrollContainer(boolean isScrollContainer) { 6283 if (isScrollContainer) { 6284 if (mAttachInfo != null && (mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) == 0) { 6285 mAttachInfo.mScrollContainers.add(this); 6286 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 6287 } 6288 mPrivateFlags |= PFLAG_SCROLL_CONTAINER; 6289 } else { 6290 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 6291 mAttachInfo.mScrollContainers.remove(this); 6292 } 6293 mPrivateFlags &= ~(PFLAG_SCROLL_CONTAINER|PFLAG_SCROLL_CONTAINER_ADDED); 6294 } 6295 } 6296 6297 /** 6298 * Returns the quality of the drawing cache. 6299 * 6300 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6301 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6302 * 6303 * @see #setDrawingCacheQuality(int) 6304 * @see #setDrawingCacheEnabled(boolean) 6305 * @see #isDrawingCacheEnabled() 6306 * 6307 * @attr ref android.R.styleable#View_drawingCacheQuality 6308 */ 6309 @DrawingCacheQuality 6310 public int getDrawingCacheQuality() { 6311 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 6312 } 6313 6314 /** 6315 * Set the drawing cache quality of this view. This value is used only when the 6316 * drawing cache is enabled 6317 * 6318 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6319 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6320 * 6321 * @see #getDrawingCacheQuality() 6322 * @see #setDrawingCacheEnabled(boolean) 6323 * @see #isDrawingCacheEnabled() 6324 * 6325 * @attr ref android.R.styleable#View_drawingCacheQuality 6326 */ 6327 public void setDrawingCacheQuality(@DrawingCacheQuality int quality) { 6328 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 6329 } 6330 6331 /** 6332 * Returns whether the screen should remain on, corresponding to the current 6333 * value of {@link #KEEP_SCREEN_ON}. 6334 * 6335 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 6336 * 6337 * @see #setKeepScreenOn(boolean) 6338 * 6339 * @attr ref android.R.styleable#View_keepScreenOn 6340 */ 6341 public boolean getKeepScreenOn() { 6342 return (mViewFlags & KEEP_SCREEN_ON) != 0; 6343 } 6344 6345 /** 6346 * Controls whether the screen should remain on, modifying the 6347 * value of {@link #KEEP_SCREEN_ON}. 6348 * 6349 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 6350 * 6351 * @see #getKeepScreenOn() 6352 * 6353 * @attr ref android.R.styleable#View_keepScreenOn 6354 */ 6355 public void setKeepScreenOn(boolean keepScreenOn) { 6356 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 6357 } 6358 6359 /** 6360 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6361 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6362 * 6363 * @attr ref android.R.styleable#View_nextFocusLeft 6364 */ 6365 public int getNextFocusLeftId() { 6366 return mNextFocusLeftId; 6367 } 6368 6369 /** 6370 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6371 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 6372 * decide automatically. 6373 * 6374 * @attr ref android.R.styleable#View_nextFocusLeft 6375 */ 6376 public void setNextFocusLeftId(int nextFocusLeftId) { 6377 mNextFocusLeftId = nextFocusLeftId; 6378 } 6379 6380 /** 6381 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6382 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6383 * 6384 * @attr ref android.R.styleable#View_nextFocusRight 6385 */ 6386 public int getNextFocusRightId() { 6387 return mNextFocusRightId; 6388 } 6389 6390 /** 6391 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6392 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 6393 * decide automatically. 6394 * 6395 * @attr ref android.R.styleable#View_nextFocusRight 6396 */ 6397 public void setNextFocusRightId(int nextFocusRightId) { 6398 mNextFocusRightId = nextFocusRightId; 6399 } 6400 6401 /** 6402 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6403 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6404 * 6405 * @attr ref android.R.styleable#View_nextFocusUp 6406 */ 6407 public int getNextFocusUpId() { 6408 return mNextFocusUpId; 6409 } 6410 6411 /** 6412 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6413 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 6414 * decide automatically. 6415 * 6416 * @attr ref android.R.styleable#View_nextFocusUp 6417 */ 6418 public void setNextFocusUpId(int nextFocusUpId) { 6419 mNextFocusUpId = nextFocusUpId; 6420 } 6421 6422 /** 6423 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6424 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6425 * 6426 * @attr ref android.R.styleable#View_nextFocusDown 6427 */ 6428 public int getNextFocusDownId() { 6429 return mNextFocusDownId; 6430 } 6431 6432 /** 6433 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6434 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 6435 * decide automatically. 6436 * 6437 * @attr ref android.R.styleable#View_nextFocusDown 6438 */ 6439 public void setNextFocusDownId(int nextFocusDownId) { 6440 mNextFocusDownId = nextFocusDownId; 6441 } 6442 6443 /** 6444 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6445 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6446 * 6447 * @attr ref android.R.styleable#View_nextFocusForward 6448 */ 6449 public int getNextFocusForwardId() { 6450 return mNextFocusForwardId; 6451 } 6452 6453 /** 6454 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6455 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 6456 * decide automatically. 6457 * 6458 * @attr ref android.R.styleable#View_nextFocusForward 6459 */ 6460 public void setNextFocusForwardId(int nextFocusForwardId) { 6461 mNextFocusForwardId = nextFocusForwardId; 6462 } 6463 6464 /** 6465 * Returns the visibility of this view and all of its ancestors 6466 * 6467 * @return True if this view and all of its ancestors are {@link #VISIBLE} 6468 */ 6469 public boolean isShown() { 6470 View current = this; 6471 //noinspection ConstantConditions 6472 do { 6473 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6474 return false; 6475 } 6476 ViewParent parent = current.mParent; 6477 if (parent == null) { 6478 return false; // We are not attached to the view root 6479 } 6480 if (!(parent instanceof View)) { 6481 return true; 6482 } 6483 current = (View) parent; 6484 } while (current != null); 6485 6486 return false; 6487 } 6488 6489 /** 6490 * Called by the view hierarchy when the content insets for a window have 6491 * changed, to allow it to adjust its content to fit within those windows. 6492 * The content insets tell you the space that the status bar, input method, 6493 * and other system windows infringe on the application's window. 6494 * 6495 * <p>You do not normally need to deal with this function, since the default 6496 * window decoration given to applications takes care of applying it to the 6497 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 6498 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case, 6499 * and your content can be placed under those system elements. You can then 6500 * use this method within your view hierarchy if you have parts of your UI 6501 * which you would like to ensure are not being covered. 6502 * 6503 * <p>The default implementation of this method simply applies the content 6504 * insets to the view's padding, consuming that content (modifying the 6505 * insets to be 0), and returning true. This behavior is off by default, but can 6506 * be enabled through {@link #setFitsSystemWindows(boolean)}. 6507 * 6508 * <p>This function's traversal down the hierarchy is depth-first. The same content 6509 * insets object is propagated down the hierarchy, so any changes made to it will 6510 * be seen by all following views (including potentially ones above in 6511 * the hierarchy since this is a depth-first traversal). The first view 6512 * that returns true will abort the entire traversal. 6513 * 6514 * <p>The default implementation works well for a situation where it is 6515 * used with a container that covers the entire window, allowing it to 6516 * apply the appropriate insets to its content on all edges. If you need 6517 * a more complicated layout (such as two different views fitting system 6518 * windows, one on the top of the window, and one on the bottom), 6519 * you can override the method and handle the insets however you would like. 6520 * Note that the insets provided by the framework are always relative to the 6521 * far edges of the window, not accounting for the location of the called view 6522 * within that window. (In fact when this method is called you do not yet know 6523 * where the layout will place the view, as it is done before layout happens.) 6524 * 6525 * <p>Note: unlike many View methods, there is no dispatch phase to this 6526 * call. If you are overriding it in a ViewGroup and want to allow the 6527 * call to continue to your children, you must be sure to call the super 6528 * implementation. 6529 * 6530 * <p>Here is a sample layout that makes use of fitting system windows 6531 * to have controls for a video view placed inside of the window decorations 6532 * that it hides and shows. This can be used with code like the second 6533 * sample (video player) shown in {@link #setSystemUiVisibility(int)}. 6534 * 6535 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete} 6536 * 6537 * @param insets Current content insets of the window. Prior to 6538 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify 6539 * the insets or else you and Android will be unhappy. 6540 * 6541 * @return {@code true} if this view applied the insets and it should not 6542 * continue propagating further down the hierarchy, {@code false} otherwise. 6543 * @see #getFitsSystemWindows() 6544 * @see #setFitsSystemWindows(boolean) 6545 * @see #setSystemUiVisibility(int) 6546 * 6547 * @deprecated As of API 20 use {@link #dispatchApplyWindowInsets(WindowInsets)} to apply 6548 * insets to views. Views should override {@link #onApplyWindowInsets(WindowInsets)} or use 6549 * {@link #setOnApplyWindowInsetsListener(android.view.View.OnApplyWindowInsetsListener)} 6550 * to implement handling their own insets. 6551 */ 6552 protected boolean fitSystemWindows(Rect insets) { 6553 if ((mPrivateFlags3 & PFLAG3_APPLYING_INSETS) == 0) { 6554 if (insets == null) { 6555 // Null insets by definition have already been consumed. 6556 // This call cannot apply insets since there are none to apply, 6557 // so return false. 6558 return false; 6559 } 6560 // If we're not in the process of dispatching the newer apply insets call, 6561 // that means we're not in the compatibility path. Dispatch into the newer 6562 // apply insets path and take things from there. 6563 try { 6564 mPrivateFlags3 |= PFLAG3_FITTING_SYSTEM_WINDOWS; 6565 return dispatchApplyWindowInsets(new WindowInsets(insets)).isConsumed(); 6566 } finally { 6567 mPrivateFlags3 &= ~PFLAG3_FITTING_SYSTEM_WINDOWS; 6568 } 6569 } else { 6570 // We're being called from the newer apply insets path. 6571 // Perform the standard fallback behavior. 6572 return fitSystemWindowsInt(insets); 6573 } 6574 } 6575 6576 private boolean fitSystemWindowsInt(Rect insets) { 6577 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 6578 mUserPaddingStart = UNDEFINED_PADDING; 6579 mUserPaddingEnd = UNDEFINED_PADDING; 6580 Rect localInsets = sThreadLocal.get(); 6581 if (localInsets == null) { 6582 localInsets = new Rect(); 6583 sThreadLocal.set(localInsets); 6584 } 6585 boolean res = computeFitSystemWindows(insets, localInsets); 6586 mUserPaddingLeftInitial = localInsets.left; 6587 mUserPaddingRightInitial = localInsets.right; 6588 internalSetPadding(localInsets.left, localInsets.top, 6589 localInsets.right, localInsets.bottom); 6590 return res; 6591 } 6592 return false; 6593 } 6594 6595 /** 6596 * Called when the view should apply {@link WindowInsets} according to its internal policy. 6597 * 6598 * <p>This method should be overridden by views that wish to apply a policy different from or 6599 * in addition to the default behavior. Clients that wish to force a view subtree 6600 * to apply insets should call {@link #dispatchApplyWindowInsets(WindowInsets)}.</p> 6601 * 6602 * <p>Clients may supply an {@link OnApplyWindowInsetsListener} to a view. If one is set 6603 * it will be called during dispatch instead of this method. The listener may optionally 6604 * call this method from its own implementation if it wishes to apply the view's default 6605 * insets policy in addition to its own.</p> 6606 * 6607 * <p>Implementations of this method should either return the insets parameter unchanged 6608 * or a new {@link WindowInsets} cloned from the supplied insets with any insets consumed 6609 * that this view applied itself. This allows new inset types added in future platform 6610 * versions to pass through existing implementations unchanged without being erroneously 6611 * consumed.</p> 6612 * 6613 * <p>By default if a view's {@link #setFitsSystemWindows(boolean) fitsSystemWindows} 6614 * property is set then the view will consume the system window insets and apply them 6615 * as padding for the view.</p> 6616 * 6617 * @param insets Insets to apply 6618 * @return The supplied insets with any applied insets consumed 6619 */ 6620 public WindowInsets onApplyWindowInsets(WindowInsets insets) { 6621 if ((mPrivateFlags3 & PFLAG3_FITTING_SYSTEM_WINDOWS) == 0) { 6622 // We weren't called from within a direct call to fitSystemWindows, 6623 // call into it as a fallback in case we're in a class that overrides it 6624 // and has logic to perform. 6625 if (fitSystemWindows(insets.getSystemWindowInsets())) { 6626 return insets.consumeSystemWindowInsets(); 6627 } 6628 } else { 6629 // We were called from within a direct call to fitSystemWindows. 6630 if (fitSystemWindowsInt(insets.getSystemWindowInsets())) { 6631 return insets.consumeSystemWindowInsets(); 6632 } 6633 } 6634 return insets; 6635 } 6636 6637 /** 6638 * Set an {@link OnApplyWindowInsetsListener} to take over the policy for applying 6639 * window insets to this view. The listener's 6640 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 6641 * method will be called instead of the view's 6642 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 6643 * 6644 * @param listener Listener to set 6645 * 6646 * @see #onApplyWindowInsets(WindowInsets) 6647 */ 6648 public void setOnApplyWindowInsetsListener(OnApplyWindowInsetsListener listener) { 6649 getListenerInfo().mOnApplyWindowInsetsListener = listener; 6650 } 6651 6652 /** 6653 * Request to apply the given window insets to this view or another view in its subtree. 6654 * 6655 * <p>This method should be called by clients wishing to apply insets corresponding to areas 6656 * obscured by window decorations or overlays. This can include the status and navigation bars, 6657 * action bars, input methods and more. New inset categories may be added in the future. 6658 * The method returns the insets provided minus any that were applied by this view or its 6659 * children.</p> 6660 * 6661 * <p>Clients wishing to provide custom behavior should override the 6662 * {@link #onApplyWindowInsets(WindowInsets)} method or alternatively provide a 6663 * {@link OnApplyWindowInsetsListener} via the 6664 * {@link #setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) setOnApplyWindowInsetsListener} 6665 * method.</p> 6666 * 6667 * <p>This method replaces the older {@link #fitSystemWindows(Rect) fitSystemWindows} method. 6668 * </p> 6669 * 6670 * @param insets Insets to apply 6671 * @return The provided insets minus the insets that were consumed 6672 */ 6673 public WindowInsets dispatchApplyWindowInsets(WindowInsets insets) { 6674 try { 6675 mPrivateFlags3 |= PFLAG3_APPLYING_INSETS; 6676 if (mListenerInfo != null && mListenerInfo.mOnApplyWindowInsetsListener != null) { 6677 return mListenerInfo.mOnApplyWindowInsetsListener.onApplyWindowInsets(this, insets); 6678 } else { 6679 return onApplyWindowInsets(insets); 6680 } 6681 } finally { 6682 mPrivateFlags3 &= ~PFLAG3_APPLYING_INSETS; 6683 } 6684 } 6685 6686 /** 6687 * @hide Compute the insets that should be consumed by this view and the ones 6688 * that should propagate to those under it. 6689 */ 6690 protected boolean computeFitSystemWindows(Rect inoutInsets, Rect outLocalInsets) { 6691 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6692 || mAttachInfo == null 6693 || ((mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0 6694 && !mAttachInfo.mOverscanRequested)) { 6695 outLocalInsets.set(inoutInsets); 6696 inoutInsets.set(0, 0, 0, 0); 6697 return true; 6698 } else { 6699 // The application wants to take care of fitting system window for 6700 // the content... however we still need to take care of any overscan here. 6701 final Rect overscan = mAttachInfo.mOverscanInsets; 6702 outLocalInsets.set(overscan); 6703 inoutInsets.left -= overscan.left; 6704 inoutInsets.top -= overscan.top; 6705 inoutInsets.right -= overscan.right; 6706 inoutInsets.bottom -= overscan.bottom; 6707 return false; 6708 } 6709 } 6710 6711 /** 6712 * Compute insets that should be consumed by this view and the ones that should propagate 6713 * to those under it. 6714 * 6715 * @param in Insets currently being processed by this View, likely received as a parameter 6716 * to {@link #onApplyWindowInsets(WindowInsets)}. 6717 * @param outLocalInsets A Rect that will receive the insets that should be consumed 6718 * by this view 6719 * @return Insets that should be passed along to views under this one 6720 */ 6721 public WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) { 6722 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6723 || mAttachInfo == null 6724 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) { 6725 outLocalInsets.set(in.getSystemWindowInsets()); 6726 return in.consumeSystemWindowInsets(); 6727 } else { 6728 outLocalInsets.set(0, 0, 0, 0); 6729 return in; 6730 } 6731 } 6732 6733 /** 6734 * Sets whether or not this view should account for system screen decorations 6735 * such as the status bar and inset its content; that is, controlling whether 6736 * the default implementation of {@link #fitSystemWindows(Rect)} will be 6737 * executed. See that method for more details. 6738 * 6739 * <p>Note that if you are providing your own implementation of 6740 * {@link #fitSystemWindows(Rect)}, then there is no need to set this 6741 * flag to true -- your implementation will be overriding the default 6742 * implementation that checks this flag. 6743 * 6744 * @param fitSystemWindows If true, then the default implementation of 6745 * {@link #fitSystemWindows(Rect)} will be executed. 6746 * 6747 * @attr ref android.R.styleable#View_fitsSystemWindows 6748 * @see #getFitsSystemWindows() 6749 * @see #fitSystemWindows(Rect) 6750 * @see #setSystemUiVisibility(int) 6751 */ 6752 public void setFitsSystemWindows(boolean fitSystemWindows) { 6753 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 6754 } 6755 6756 /** 6757 * Check for state of {@link #setFitsSystemWindows(boolean)}. If this method 6758 * returns {@code true}, the default implementation of {@link #fitSystemWindows(Rect)} 6759 * will be executed. 6760 * 6761 * @return {@code true} if the default implementation of 6762 * {@link #fitSystemWindows(Rect)} will be executed. 6763 * 6764 * @attr ref android.R.styleable#View_fitsSystemWindows 6765 * @see #setFitsSystemWindows(boolean) 6766 * @see #fitSystemWindows(Rect) 6767 * @see #setSystemUiVisibility(int) 6768 */ 6769 @ViewDebug.ExportedProperty 6770 public boolean getFitsSystemWindows() { 6771 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 6772 } 6773 6774 /** @hide */ 6775 public boolean fitsSystemWindows() { 6776 return getFitsSystemWindows(); 6777 } 6778 6779 /** 6780 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed. 6781 * @deprecated Use {@link #requestApplyInsets()} for newer platform versions. 6782 */ 6783 public void requestFitSystemWindows() { 6784 if (mParent != null) { 6785 mParent.requestFitSystemWindows(); 6786 } 6787 } 6788 6789 /** 6790 * Ask that a new dispatch of {@link #onApplyWindowInsets(WindowInsets)} be performed. 6791 */ 6792 public void requestApplyInsets() { 6793 requestFitSystemWindows(); 6794 } 6795 6796 /** 6797 * For use by PhoneWindow to make its own system window fitting optional. 6798 * @hide 6799 */ 6800 public void makeOptionalFitsSystemWindows() { 6801 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS); 6802 } 6803 6804 /** 6805 * Returns the visibility status for this view. 6806 * 6807 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6808 * @attr ref android.R.styleable#View_visibility 6809 */ 6810 @ViewDebug.ExportedProperty(mapping = { 6811 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 6812 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 6813 @ViewDebug.IntToString(from = GONE, to = "GONE") 6814 }) 6815 @Visibility 6816 public int getVisibility() { 6817 return mViewFlags & VISIBILITY_MASK; 6818 } 6819 6820 /** 6821 * Set the enabled state of this view. 6822 * 6823 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6824 * @attr ref android.R.styleable#View_visibility 6825 */ 6826 @RemotableViewMethod 6827 public void setVisibility(@Visibility int visibility) { 6828 setFlags(visibility, VISIBILITY_MASK); 6829 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false); 6830 } 6831 6832 /** 6833 * Returns the enabled status for this view. The interpretation of the 6834 * enabled state varies by subclass. 6835 * 6836 * @return True if this view is enabled, false otherwise. 6837 */ 6838 @ViewDebug.ExportedProperty 6839 public boolean isEnabled() { 6840 return (mViewFlags & ENABLED_MASK) == ENABLED; 6841 } 6842 6843 /** 6844 * Set the enabled state of this view. The interpretation of the enabled 6845 * state varies by subclass. 6846 * 6847 * @param enabled True if this view is enabled, false otherwise. 6848 */ 6849 @RemotableViewMethod 6850 public void setEnabled(boolean enabled) { 6851 if (enabled == isEnabled()) return; 6852 6853 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 6854 6855 /* 6856 * The View most likely has to change its appearance, so refresh 6857 * the drawable state. 6858 */ 6859 refreshDrawableState(); 6860 6861 // Invalidate too, since the default behavior for views is to be 6862 // be drawn at 50% alpha rather than to change the drawable. 6863 invalidate(true); 6864 6865 if (!enabled) { 6866 cancelPendingInputEvents(); 6867 } 6868 } 6869 6870 /** 6871 * Set whether this view can receive the focus. 6872 * 6873 * Setting this to false will also ensure that this view is not focusable 6874 * in touch mode. 6875 * 6876 * @param focusable If true, this view can receive the focus. 6877 * 6878 * @see #setFocusableInTouchMode(boolean) 6879 * @attr ref android.R.styleable#View_focusable 6880 */ 6881 public void setFocusable(boolean focusable) { 6882 if (!focusable) { 6883 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 6884 } 6885 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 6886 } 6887 6888 /** 6889 * Set whether this view can receive focus while in touch mode. 6890 * 6891 * Setting this to true will also ensure that this view is focusable. 6892 * 6893 * @param focusableInTouchMode If true, this view can receive the focus while 6894 * in touch mode. 6895 * 6896 * @see #setFocusable(boolean) 6897 * @attr ref android.R.styleable#View_focusableInTouchMode 6898 */ 6899 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 6900 // Focusable in touch mode should always be set before the focusable flag 6901 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 6902 // which, in touch mode, will not successfully request focus on this view 6903 // because the focusable in touch mode flag is not set 6904 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 6905 if (focusableInTouchMode) { 6906 setFlags(FOCUSABLE, FOCUSABLE_MASK); 6907 } 6908 } 6909 6910 /** 6911 * Set whether this view should have sound effects enabled for events such as 6912 * clicking and touching. 6913 * 6914 * <p>You may wish to disable sound effects for a view if you already play sounds, 6915 * for instance, a dial key that plays dtmf tones. 6916 * 6917 * @param soundEffectsEnabled whether sound effects are enabled for this view. 6918 * @see #isSoundEffectsEnabled() 6919 * @see #playSoundEffect(int) 6920 * @attr ref android.R.styleable#View_soundEffectsEnabled 6921 */ 6922 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 6923 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 6924 } 6925 6926 /** 6927 * @return whether this view should have sound effects enabled for events such as 6928 * clicking and touching. 6929 * 6930 * @see #setSoundEffectsEnabled(boolean) 6931 * @see #playSoundEffect(int) 6932 * @attr ref android.R.styleable#View_soundEffectsEnabled 6933 */ 6934 @ViewDebug.ExportedProperty 6935 public boolean isSoundEffectsEnabled() { 6936 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 6937 } 6938 6939 /** 6940 * Set whether this view should have haptic feedback for events such as 6941 * long presses. 6942 * 6943 * <p>You may wish to disable haptic feedback if your view already controls 6944 * its own haptic feedback. 6945 * 6946 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 6947 * @see #isHapticFeedbackEnabled() 6948 * @see #performHapticFeedback(int) 6949 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6950 */ 6951 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 6952 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 6953 } 6954 6955 /** 6956 * @return whether this view should have haptic feedback enabled for events 6957 * long presses. 6958 * 6959 * @see #setHapticFeedbackEnabled(boolean) 6960 * @see #performHapticFeedback(int) 6961 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6962 */ 6963 @ViewDebug.ExportedProperty 6964 public boolean isHapticFeedbackEnabled() { 6965 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 6966 } 6967 6968 /** 6969 * Returns the layout direction for this view. 6970 * 6971 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 6972 * {@link #LAYOUT_DIRECTION_RTL}, 6973 * {@link #LAYOUT_DIRECTION_INHERIT} or 6974 * {@link #LAYOUT_DIRECTION_LOCALE}. 6975 * 6976 * @attr ref android.R.styleable#View_layoutDirection 6977 * 6978 * @hide 6979 */ 6980 @ViewDebug.ExportedProperty(category = "layout", mapping = { 6981 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 6982 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 6983 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 6984 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 6985 }) 6986 @LayoutDir 6987 public int getRawLayoutDirection() { 6988 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 6989 } 6990 6991 /** 6992 * Set the layout direction for this view. This will propagate a reset of layout direction 6993 * resolution to the view's children and resolve layout direction for this view. 6994 * 6995 * @param layoutDirection the layout direction to set. Should be one of: 6996 * 6997 * {@link #LAYOUT_DIRECTION_LTR}, 6998 * {@link #LAYOUT_DIRECTION_RTL}, 6999 * {@link #LAYOUT_DIRECTION_INHERIT}, 7000 * {@link #LAYOUT_DIRECTION_LOCALE}. 7001 * 7002 * Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution 7003 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 7004 * will return the default {@link #LAYOUT_DIRECTION_LTR}. 7005 * 7006 * @attr ref android.R.styleable#View_layoutDirection 7007 */ 7008 @RemotableViewMethod 7009 public void setLayoutDirection(@LayoutDir int layoutDirection) { 7010 if (getRawLayoutDirection() != layoutDirection) { 7011 // Reset the current layout direction and the resolved one 7012 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_MASK; 7013 resetRtlProperties(); 7014 // Set the new layout direction (filtered) 7015 mPrivateFlags2 |= 7016 ((layoutDirection << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) & PFLAG2_LAYOUT_DIRECTION_MASK); 7017 // We need to resolve all RTL properties as they all depend on layout direction 7018 resolveRtlPropertiesIfNeeded(); 7019 requestLayout(); 7020 invalidate(true); 7021 } 7022 } 7023 7024 /** 7025 * Returns the resolved layout direction for this view. 7026 * 7027 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 7028 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. 7029 * 7030 * For compatibility, this will return {@link #LAYOUT_DIRECTION_LTR} if API version 7031 * is lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}. 7032 * 7033 * @attr ref android.R.styleable#View_layoutDirection 7034 */ 7035 @ViewDebug.ExportedProperty(category = "layout", mapping = { 7036 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 7037 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 7038 }) 7039 @ResolvedLayoutDir 7040 public int getLayoutDirection() { 7041 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 7042 if (targetSdkVersion < JELLY_BEAN_MR1) { 7043 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 7044 return LAYOUT_DIRECTION_RESOLVED_DEFAULT; 7045 } 7046 return ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) == 7047 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) ? LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 7048 } 7049 7050 /** 7051 * Indicates whether or not this view's layout is right-to-left. This is resolved from 7052 * layout attribute and/or the inherited value from the parent 7053 * 7054 * @return true if the layout is right-to-left. 7055 * 7056 * @hide 7057 */ 7058 @ViewDebug.ExportedProperty(category = "layout") 7059 public boolean isLayoutRtl() { 7060 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL); 7061 } 7062 7063 /** 7064 * Indicates whether the view is currently tracking transient state that the 7065 * app should not need to concern itself with saving and restoring, but that 7066 * the framework should take special note to preserve when possible. 7067 * 7068 * <p>A view with transient state cannot be trivially rebound from an external 7069 * data source, such as an adapter binding item views in a list. This may be 7070 * because the view is performing an animation, tracking user selection 7071 * of content, or similar.</p> 7072 * 7073 * @return true if the view has transient state 7074 */ 7075 @ViewDebug.ExportedProperty(category = "layout") 7076 public boolean hasTransientState() { 7077 return (mPrivateFlags2 & PFLAG2_HAS_TRANSIENT_STATE) == PFLAG2_HAS_TRANSIENT_STATE; 7078 } 7079 7080 /** 7081 * Set whether this view is currently tracking transient state that the 7082 * framework should attempt to preserve when possible. This flag is reference counted, 7083 * so every call to setHasTransientState(true) should be paired with a later call 7084 * to setHasTransientState(false). 7085 * 7086 * <p>A view with transient state cannot be trivially rebound from an external 7087 * data source, such as an adapter binding item views in a list. This may be 7088 * because the view is performing an animation, tracking user selection 7089 * of content, or similar.</p> 7090 * 7091 * @param hasTransientState true if this view has transient state 7092 */ 7093 public void setHasTransientState(boolean hasTransientState) { 7094 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 : 7095 mTransientStateCount - 1; 7096 if (mTransientStateCount < 0) { 7097 mTransientStateCount = 0; 7098 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " + 7099 "unmatched pair of setHasTransientState calls"); 7100 } else if ((hasTransientState && mTransientStateCount == 1) || 7101 (!hasTransientState && mTransientStateCount == 0)) { 7102 // update flag if we've just incremented up from 0 or decremented down to 0 7103 mPrivateFlags2 = (mPrivateFlags2 & ~PFLAG2_HAS_TRANSIENT_STATE) | 7104 (hasTransientState ? PFLAG2_HAS_TRANSIENT_STATE : 0); 7105 if (mParent != null) { 7106 try { 7107 mParent.childHasTransientStateChanged(this, hasTransientState); 7108 } catch (AbstractMethodError e) { 7109 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 7110 " does not fully implement ViewParent", e); 7111 } 7112 } 7113 } 7114 } 7115 7116 /** 7117 * Returns true if this view is currently attached to a window. 7118 */ 7119 public boolean isAttachedToWindow() { 7120 return mAttachInfo != null; 7121 } 7122 7123 /** 7124 * Returns true if this view has been through at least one layout since it 7125 * was last attached to or detached from a window. 7126 */ 7127 public boolean isLaidOut() { 7128 return (mPrivateFlags3 & PFLAG3_IS_LAID_OUT) == PFLAG3_IS_LAID_OUT; 7129 } 7130 7131 /** 7132 * If this view doesn't do any drawing on its own, set this flag to 7133 * allow further optimizations. By default, this flag is not set on 7134 * View, but could be set on some View subclasses such as ViewGroup. 7135 * 7136 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 7137 * you should clear this flag. 7138 * 7139 * @param willNotDraw whether or not this View draw on its own 7140 */ 7141 public void setWillNotDraw(boolean willNotDraw) { 7142 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 7143 } 7144 7145 /** 7146 * Returns whether or not this View draws on its own. 7147 * 7148 * @return true if this view has nothing to draw, false otherwise 7149 */ 7150 @ViewDebug.ExportedProperty(category = "drawing") 7151 public boolean willNotDraw() { 7152 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 7153 } 7154 7155 /** 7156 * When a View's drawing cache is enabled, drawing is redirected to an 7157 * offscreen bitmap. Some views, like an ImageView, must be able to 7158 * bypass this mechanism if they already draw a single bitmap, to avoid 7159 * unnecessary usage of the memory. 7160 * 7161 * @param willNotCacheDrawing true if this view does not cache its 7162 * drawing, false otherwise 7163 */ 7164 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 7165 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 7166 } 7167 7168 /** 7169 * Returns whether or not this View can cache its drawing or not. 7170 * 7171 * @return true if this view does not cache its drawing, false otherwise 7172 */ 7173 @ViewDebug.ExportedProperty(category = "drawing") 7174 public boolean willNotCacheDrawing() { 7175 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 7176 } 7177 7178 /** 7179 * Indicates whether this view reacts to click events or not. 7180 * 7181 * @return true if the view is clickable, false otherwise 7182 * 7183 * @see #setClickable(boolean) 7184 * @attr ref android.R.styleable#View_clickable 7185 */ 7186 @ViewDebug.ExportedProperty 7187 public boolean isClickable() { 7188 return (mViewFlags & CLICKABLE) == CLICKABLE; 7189 } 7190 7191 /** 7192 * Enables or disables click events for this view. When a view 7193 * is clickable it will change its state to "pressed" on every click. 7194 * Subclasses should set the view clickable to visually react to 7195 * user's clicks. 7196 * 7197 * @param clickable true to make the view clickable, false otherwise 7198 * 7199 * @see #isClickable() 7200 * @attr ref android.R.styleable#View_clickable 7201 */ 7202 public void setClickable(boolean clickable) { 7203 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 7204 } 7205 7206 /** 7207 * Indicates whether this view reacts to long click events or not. 7208 * 7209 * @return true if the view is long clickable, false otherwise 7210 * 7211 * @see #setLongClickable(boolean) 7212 * @attr ref android.R.styleable#View_longClickable 7213 */ 7214 public boolean isLongClickable() { 7215 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 7216 } 7217 7218 /** 7219 * Enables or disables long click events for this view. When a view is long 7220 * clickable it reacts to the user holding down the button for a longer 7221 * duration than a tap. This event can either launch the listener or a 7222 * context menu. 7223 * 7224 * @param longClickable true to make the view long clickable, false otherwise 7225 * @see #isLongClickable() 7226 * @attr ref android.R.styleable#View_longClickable 7227 */ 7228 public void setLongClickable(boolean longClickable) { 7229 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 7230 } 7231 7232 /** 7233 * Sets the pressed state for this view and provides a touch coordinate for 7234 * animation hinting. 7235 * 7236 * @param pressed Pass true to set the View's internal state to "pressed", 7237 * or false to reverts the View's internal state from a 7238 * previously set "pressed" state. 7239 * @param x The x coordinate of the touch that caused the press 7240 * @param y The y coordinate of the touch that caused the press 7241 */ 7242 private void setPressed(boolean pressed, float x, float y) { 7243 if (pressed) { 7244 drawableHotspotChanged(x, y); 7245 } 7246 7247 setPressed(pressed); 7248 } 7249 7250 /** 7251 * Sets the pressed state for this view. 7252 * 7253 * @see #isClickable() 7254 * @see #setClickable(boolean) 7255 * 7256 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 7257 * the View's internal state from a previously set "pressed" state. 7258 */ 7259 public void setPressed(boolean pressed) { 7260 final boolean needsRefresh = pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED); 7261 7262 if (pressed) { 7263 mPrivateFlags |= PFLAG_PRESSED; 7264 } else { 7265 mPrivateFlags &= ~PFLAG_PRESSED; 7266 } 7267 7268 if (needsRefresh) { 7269 refreshDrawableState(); 7270 } 7271 dispatchSetPressed(pressed); 7272 } 7273 7274 /** 7275 * Dispatch setPressed to all of this View's children. 7276 * 7277 * @see #setPressed(boolean) 7278 * 7279 * @param pressed The new pressed state 7280 */ 7281 protected void dispatchSetPressed(boolean pressed) { 7282 } 7283 7284 /** 7285 * Indicates whether the view is currently in pressed state. Unless 7286 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 7287 * the pressed state. 7288 * 7289 * @see #setPressed(boolean) 7290 * @see #isClickable() 7291 * @see #setClickable(boolean) 7292 * 7293 * @return true if the view is currently pressed, false otherwise 7294 */ 7295 @ViewDebug.ExportedProperty 7296 public boolean isPressed() { 7297 return (mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED; 7298 } 7299 7300 /** 7301 * Indicates whether this view will save its state (that is, 7302 * whether its {@link #onSaveInstanceState} method will be called). 7303 * 7304 * @return Returns true if the view state saving is enabled, else false. 7305 * 7306 * @see #setSaveEnabled(boolean) 7307 * @attr ref android.R.styleable#View_saveEnabled 7308 */ 7309 public boolean isSaveEnabled() { 7310 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 7311 } 7312 7313 /** 7314 * Controls whether the saving of this view's state is 7315 * enabled (that is, whether its {@link #onSaveInstanceState} method 7316 * will be called). Note that even if freezing is enabled, the 7317 * view still must have an id assigned to it (via {@link #setId(int)}) 7318 * for its state to be saved. This flag can only disable the 7319 * saving of this view; any child views may still have their state saved. 7320 * 7321 * @param enabled Set to false to <em>disable</em> state saving, or true 7322 * (the default) to allow it. 7323 * 7324 * @see #isSaveEnabled() 7325 * @see #setId(int) 7326 * @see #onSaveInstanceState() 7327 * @attr ref android.R.styleable#View_saveEnabled 7328 */ 7329 public void setSaveEnabled(boolean enabled) { 7330 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 7331 } 7332 7333 /** 7334 * Gets whether the framework should discard touches when the view's 7335 * window is obscured by another visible window. 7336 * Refer to the {@link View} security documentation for more details. 7337 * 7338 * @return True if touch filtering is enabled. 7339 * 7340 * @see #setFilterTouchesWhenObscured(boolean) 7341 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7342 */ 7343 @ViewDebug.ExportedProperty 7344 public boolean getFilterTouchesWhenObscured() { 7345 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 7346 } 7347 7348 /** 7349 * Sets whether the framework should discard touches when the view's 7350 * window is obscured by another visible window. 7351 * Refer to the {@link View} security documentation for more details. 7352 * 7353 * @param enabled True if touch filtering should be enabled. 7354 * 7355 * @see #getFilterTouchesWhenObscured 7356 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7357 */ 7358 public void setFilterTouchesWhenObscured(boolean enabled) { 7359 setFlags(enabled ? FILTER_TOUCHES_WHEN_OBSCURED : 0, 7360 FILTER_TOUCHES_WHEN_OBSCURED); 7361 } 7362 7363 /** 7364 * Indicates whether the entire hierarchy under this view will save its 7365 * state when a state saving traversal occurs from its parent. The default 7366 * is true; if false, these views will not be saved unless 7367 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7368 * 7369 * @return Returns true if the view state saving from parent is enabled, else false. 7370 * 7371 * @see #setSaveFromParentEnabled(boolean) 7372 */ 7373 public boolean isSaveFromParentEnabled() { 7374 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 7375 } 7376 7377 /** 7378 * Controls whether the entire hierarchy under this view will save its 7379 * state when a state saving traversal occurs from its parent. The default 7380 * is true; if false, these views will not be saved unless 7381 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7382 * 7383 * @param enabled Set to false to <em>disable</em> state saving, or true 7384 * (the default) to allow it. 7385 * 7386 * @see #isSaveFromParentEnabled() 7387 * @see #setId(int) 7388 * @see #onSaveInstanceState() 7389 */ 7390 public void setSaveFromParentEnabled(boolean enabled) { 7391 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 7392 } 7393 7394 7395 /** 7396 * Returns whether this View is able to take focus. 7397 * 7398 * @return True if this view can take focus, or false otherwise. 7399 * @attr ref android.R.styleable#View_focusable 7400 */ 7401 @ViewDebug.ExportedProperty(category = "focus") 7402 public final boolean isFocusable() { 7403 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 7404 } 7405 7406 /** 7407 * When a view is focusable, it may not want to take focus when in touch mode. 7408 * For example, a button would like focus when the user is navigating via a D-pad 7409 * so that the user can click on it, but once the user starts touching the screen, 7410 * the button shouldn't take focus 7411 * @return Whether the view is focusable in touch mode. 7412 * @attr ref android.R.styleable#View_focusableInTouchMode 7413 */ 7414 @ViewDebug.ExportedProperty 7415 public final boolean isFocusableInTouchMode() { 7416 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 7417 } 7418 7419 /** 7420 * Find the nearest view in the specified direction that can take focus. 7421 * This does not actually give focus to that view. 7422 * 7423 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7424 * 7425 * @return The nearest focusable in the specified direction, or null if none 7426 * can be found. 7427 */ 7428 public View focusSearch(@FocusRealDirection int direction) { 7429 if (mParent != null) { 7430 return mParent.focusSearch(this, direction); 7431 } else { 7432 return null; 7433 } 7434 } 7435 7436 /** 7437 * This method is the last chance for the focused view and its ancestors to 7438 * respond to an arrow key. This is called when the focused view did not 7439 * consume the key internally, nor could the view system find a new view in 7440 * the requested direction to give focus to. 7441 * 7442 * @param focused The currently focused view. 7443 * @param direction The direction focus wants to move. One of FOCUS_UP, 7444 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 7445 * @return True if the this view consumed this unhandled move. 7446 */ 7447 public boolean dispatchUnhandledMove(View focused, @FocusRealDirection int direction) { 7448 return false; 7449 } 7450 7451 /** 7452 * If a user manually specified the next view id for a particular direction, 7453 * use the root to look up the view. 7454 * @param root The root view of the hierarchy containing this view. 7455 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 7456 * or FOCUS_BACKWARD. 7457 * @return The user specified next view, or null if there is none. 7458 */ 7459 View findUserSetNextFocus(View root, @FocusDirection int direction) { 7460 switch (direction) { 7461 case FOCUS_LEFT: 7462 if (mNextFocusLeftId == View.NO_ID) return null; 7463 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 7464 case FOCUS_RIGHT: 7465 if (mNextFocusRightId == View.NO_ID) return null; 7466 return findViewInsideOutShouldExist(root, mNextFocusRightId); 7467 case FOCUS_UP: 7468 if (mNextFocusUpId == View.NO_ID) return null; 7469 return findViewInsideOutShouldExist(root, mNextFocusUpId); 7470 case FOCUS_DOWN: 7471 if (mNextFocusDownId == View.NO_ID) return null; 7472 return findViewInsideOutShouldExist(root, mNextFocusDownId); 7473 case FOCUS_FORWARD: 7474 if (mNextFocusForwardId == View.NO_ID) return null; 7475 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 7476 case FOCUS_BACKWARD: { 7477 if (mID == View.NO_ID) return null; 7478 final int id = mID; 7479 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 7480 @Override 7481 public boolean apply(View t) { 7482 return t.mNextFocusForwardId == id; 7483 } 7484 }); 7485 } 7486 } 7487 return null; 7488 } 7489 7490 private View findViewInsideOutShouldExist(View root, int id) { 7491 if (mMatchIdPredicate == null) { 7492 mMatchIdPredicate = new MatchIdPredicate(); 7493 } 7494 mMatchIdPredicate.mId = id; 7495 View result = root.findViewByPredicateInsideOut(this, mMatchIdPredicate); 7496 if (result == null) { 7497 Log.w(VIEW_LOG_TAG, "couldn't find view with id " + id); 7498 } 7499 return result; 7500 } 7501 7502 /** 7503 * Find and return all focusable views that are descendants of this view, 7504 * possibly including this view if it is focusable itself. 7505 * 7506 * @param direction The direction of the focus 7507 * @return A list of focusable views 7508 */ 7509 public ArrayList<View> getFocusables(@FocusDirection int direction) { 7510 ArrayList<View> result = new ArrayList<View>(24); 7511 addFocusables(result, direction); 7512 return result; 7513 } 7514 7515 /** 7516 * Add any focusable views that are descendants of this view (possibly 7517 * including this view if it is focusable itself) to views. If we are in touch mode, 7518 * only add views that are also focusable in touch mode. 7519 * 7520 * @param views Focusable views found so far 7521 * @param direction The direction of the focus 7522 */ 7523 public void addFocusables(ArrayList<View> views, @FocusDirection int direction) { 7524 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 7525 } 7526 7527 /** 7528 * Adds any focusable views that are descendants of this view (possibly 7529 * including this view if it is focusable itself) to views. This method 7530 * adds all focusable views regardless if we are in touch mode or 7531 * only views focusable in touch mode if we are in touch mode or 7532 * only views that can take accessibility focus if accessibility is enabeld 7533 * depending on the focusable mode paramater. 7534 * 7535 * @param views Focusable views found so far or null if all we are interested is 7536 * the number of focusables. 7537 * @param direction The direction of the focus. 7538 * @param focusableMode The type of focusables to be added. 7539 * 7540 * @see #FOCUSABLES_ALL 7541 * @see #FOCUSABLES_TOUCH_MODE 7542 */ 7543 public void addFocusables(ArrayList<View> views, @FocusDirection int direction, 7544 @FocusableMode int focusableMode) { 7545 if (views == null) { 7546 return; 7547 } 7548 if (!isFocusable()) { 7549 return; 7550 } 7551 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE 7552 && isInTouchMode() && !isFocusableInTouchMode()) { 7553 return; 7554 } 7555 views.add(this); 7556 } 7557 7558 /** 7559 * Finds the Views that contain given text. The containment is case insensitive. 7560 * The search is performed by either the text that the View renders or the content 7561 * description that describes the view for accessibility purposes and the view does 7562 * not render or both. Clients can specify how the search is to be performed via 7563 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 7564 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 7565 * 7566 * @param outViews The output list of matching Views. 7567 * @param searched The text to match against. 7568 * 7569 * @see #FIND_VIEWS_WITH_TEXT 7570 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 7571 * @see #setContentDescription(CharSequence) 7572 */ 7573 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, 7574 @FindViewFlags int flags) { 7575 if (getAccessibilityNodeProvider() != null) { 7576 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 7577 outViews.add(this); 7578 } 7579 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 7580 && (searched != null && searched.length() > 0) 7581 && (mContentDescription != null && mContentDescription.length() > 0)) { 7582 String searchedLowerCase = searched.toString().toLowerCase(); 7583 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 7584 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 7585 outViews.add(this); 7586 } 7587 } 7588 } 7589 7590 /** 7591 * Find and return all touchable views that are descendants of this view, 7592 * possibly including this view if it is touchable itself. 7593 * 7594 * @return A list of touchable views 7595 */ 7596 public ArrayList<View> getTouchables() { 7597 ArrayList<View> result = new ArrayList<View>(); 7598 addTouchables(result); 7599 return result; 7600 } 7601 7602 /** 7603 * Add any touchable views that are descendants of this view (possibly 7604 * including this view if it is touchable itself) to views. 7605 * 7606 * @param views Touchable views found so far 7607 */ 7608 public void addTouchables(ArrayList<View> views) { 7609 final int viewFlags = mViewFlags; 7610 7611 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 7612 && (viewFlags & ENABLED_MASK) == ENABLED) { 7613 views.add(this); 7614 } 7615 } 7616 7617 /** 7618 * Returns whether this View is accessibility focused. 7619 * 7620 * @return True if this View is accessibility focused. 7621 */ 7622 public boolean isAccessibilityFocused() { 7623 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0; 7624 } 7625 7626 /** 7627 * Call this to try to give accessibility focus to this view. 7628 * 7629 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()} 7630 * returns false or the view is no visible or the view already has accessibility 7631 * focus. 7632 * 7633 * See also {@link #focusSearch(int)}, which is what you call to say that you 7634 * have focus, and you want your parent to look for the next one. 7635 * 7636 * @return Whether this view actually took accessibility focus. 7637 * 7638 * @hide 7639 */ 7640 public boolean requestAccessibilityFocus() { 7641 AccessibilityManager manager = AccessibilityManager.getInstance(mContext); 7642 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) { 7643 return false; 7644 } 7645 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7646 return false; 7647 } 7648 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) == 0) { 7649 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_FOCUSED; 7650 ViewRootImpl viewRootImpl = getViewRootImpl(); 7651 if (viewRootImpl != null) { 7652 viewRootImpl.setAccessibilityFocus(this, null); 7653 } 7654 invalidate(); 7655 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED); 7656 return true; 7657 } 7658 return false; 7659 } 7660 7661 /** 7662 * Call this to try to clear accessibility focus of this view. 7663 * 7664 * See also {@link #focusSearch(int)}, which is what you call to say that you 7665 * have focus, and you want your parent to look for the next one. 7666 * 7667 * @hide 7668 */ 7669 public void clearAccessibilityFocus() { 7670 clearAccessibilityFocusNoCallbacks(); 7671 // Clear the global reference of accessibility focus if this 7672 // view or any of its descendants had accessibility focus. 7673 ViewRootImpl viewRootImpl = getViewRootImpl(); 7674 if (viewRootImpl != null) { 7675 View focusHost = viewRootImpl.getAccessibilityFocusedHost(); 7676 if (focusHost != null && ViewRootImpl.isViewDescendantOf(focusHost, this)) { 7677 viewRootImpl.setAccessibilityFocus(null, null); 7678 } 7679 } 7680 } 7681 7682 private void sendAccessibilityHoverEvent(int eventType) { 7683 // Since we are not delivering to a client accessibility events from not 7684 // important views (unless the clinet request that) we need to fire the 7685 // event from the deepest view exposed to the client. As a consequence if 7686 // the user crosses a not exposed view the client will see enter and exit 7687 // of the exposed predecessor followed by and enter and exit of that same 7688 // predecessor when entering and exiting the not exposed descendant. This 7689 // is fine since the client has a clear idea which view is hovered at the 7690 // price of a couple more events being sent. This is a simple and 7691 // working solution. 7692 View source = this; 7693 while (true) { 7694 if (source.includeForAccessibility()) { 7695 source.sendAccessibilityEvent(eventType); 7696 return; 7697 } 7698 ViewParent parent = source.getParent(); 7699 if (parent instanceof View) { 7700 source = (View) parent; 7701 } else { 7702 return; 7703 } 7704 } 7705 } 7706 7707 /** 7708 * Clears accessibility focus without calling any callback methods 7709 * normally invoked in {@link #clearAccessibilityFocus()}. This method 7710 * is used for clearing accessibility focus when giving this focus to 7711 * another view. 7712 */ 7713 void clearAccessibilityFocusNoCallbacks() { 7714 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) { 7715 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED; 7716 invalidate(); 7717 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED); 7718 } 7719 } 7720 7721 /** 7722 * Call this to try to give focus to a specific view or to one of its 7723 * descendants. 7724 * 7725 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7726 * false), or if it is focusable and it is not focusable in touch mode 7727 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7728 * 7729 * See also {@link #focusSearch(int)}, which is what you call to say that you 7730 * have focus, and you want your parent to look for the next one. 7731 * 7732 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 7733 * {@link #FOCUS_DOWN} and <code>null</code>. 7734 * 7735 * @return Whether this view or one of its descendants actually took focus. 7736 */ 7737 public final boolean requestFocus() { 7738 return requestFocus(View.FOCUS_DOWN); 7739 } 7740 7741 /** 7742 * Call this to try to give focus to a specific view or to one of its 7743 * descendants and give it a hint about what direction focus is heading. 7744 * 7745 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7746 * false), or if it is focusable and it is not focusable in touch mode 7747 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7748 * 7749 * See also {@link #focusSearch(int)}, which is what you call to say that you 7750 * have focus, and you want your parent to look for the next one. 7751 * 7752 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 7753 * <code>null</code> set for the previously focused rectangle. 7754 * 7755 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7756 * @return Whether this view or one of its descendants actually took focus. 7757 */ 7758 public final boolean requestFocus(int direction) { 7759 return requestFocus(direction, null); 7760 } 7761 7762 /** 7763 * Call this to try to give focus to a specific view or to one of its descendants 7764 * and give it hints about the direction and a specific rectangle that the focus 7765 * is coming from. The rectangle can help give larger views a finer grained hint 7766 * about where focus is coming from, and therefore, where to show selection, or 7767 * forward focus change internally. 7768 * 7769 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7770 * false), or if it is focusable and it is not focusable in touch mode 7771 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7772 * 7773 * A View will not take focus if it is not visible. 7774 * 7775 * A View will not take focus if one of its parents has 7776 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 7777 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 7778 * 7779 * See also {@link #focusSearch(int)}, which is what you call to say that you 7780 * have focus, and you want your parent to look for the next one. 7781 * 7782 * You may wish to override this method if your custom {@link View} has an internal 7783 * {@link View} that it wishes to forward the request to. 7784 * 7785 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7786 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 7787 * to give a finer grained hint about where focus is coming from. May be null 7788 * if there is no hint. 7789 * @return Whether this view or one of its descendants actually took focus. 7790 */ 7791 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 7792 return requestFocusNoSearch(direction, previouslyFocusedRect); 7793 } 7794 7795 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) { 7796 // need to be focusable 7797 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 7798 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7799 return false; 7800 } 7801 7802 // need to be focusable in touch mode if in touch mode 7803 if (isInTouchMode() && 7804 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 7805 return false; 7806 } 7807 7808 // need to not have any parents blocking us 7809 if (hasAncestorThatBlocksDescendantFocus()) { 7810 return false; 7811 } 7812 7813 handleFocusGainInternal(direction, previouslyFocusedRect); 7814 return true; 7815 } 7816 7817 /** 7818 * Call this to try to give focus to a specific view or to one of its descendants. This is a 7819 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 7820 * touch mode to request focus when they are touched. 7821 * 7822 * @return Whether this view or one of its descendants actually took focus. 7823 * 7824 * @see #isInTouchMode() 7825 * 7826 */ 7827 public final boolean requestFocusFromTouch() { 7828 // Leave touch mode if we need to 7829 if (isInTouchMode()) { 7830 ViewRootImpl viewRoot = getViewRootImpl(); 7831 if (viewRoot != null) { 7832 viewRoot.ensureTouchMode(false); 7833 } 7834 } 7835 return requestFocus(View.FOCUS_DOWN); 7836 } 7837 7838 /** 7839 * @return Whether any ancestor of this view blocks descendant focus. 7840 */ 7841 private boolean hasAncestorThatBlocksDescendantFocus() { 7842 final boolean focusableInTouchMode = isFocusableInTouchMode(); 7843 ViewParent ancestor = mParent; 7844 while (ancestor instanceof ViewGroup) { 7845 final ViewGroup vgAncestor = (ViewGroup) ancestor; 7846 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS 7847 || (!focusableInTouchMode && vgAncestor.shouldBlockFocusForTouchscreen())) { 7848 return true; 7849 } else { 7850 ancestor = vgAncestor.getParent(); 7851 } 7852 } 7853 return false; 7854 } 7855 7856 /** 7857 * Gets the mode for determining whether this View is important for accessibility 7858 * which is if it fires accessibility events and if it is reported to 7859 * accessibility services that query the screen. 7860 * 7861 * @return The mode for determining whether a View is important for accessibility. 7862 * 7863 * @attr ref android.R.styleable#View_importantForAccessibility 7864 * 7865 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7866 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7867 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7868 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7869 */ 7870 @ViewDebug.ExportedProperty(category = "accessibility", mapping = { 7871 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, to = "auto"), 7872 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, to = "yes"), 7873 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, to = "no"), 7874 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, 7875 to = "noHideDescendants") 7876 }) 7877 public int getImportantForAccessibility() { 7878 return (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 7879 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 7880 } 7881 7882 /** 7883 * Sets the live region mode for this view. This indicates to accessibility 7884 * services whether they should automatically notify the user about changes 7885 * to the view's content description or text, or to the content descriptions 7886 * or text of the view's children (where applicable). 7887 * <p> 7888 * For example, in a login screen with a TextView that displays an "incorrect 7889 * password" notification, that view should be marked as a live region with 7890 * mode {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7891 * <p> 7892 * To disable change notifications for this view, use 7893 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. This is the default live region 7894 * mode for most views. 7895 * <p> 7896 * To indicate that the user should be notified of changes, use 7897 * {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7898 * <p> 7899 * If the view's changes should interrupt ongoing speech and notify the user 7900 * immediately, use {@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE}. 7901 * 7902 * @param mode The live region mode for this view, one of: 7903 * <ul> 7904 * <li>{@link #ACCESSIBILITY_LIVE_REGION_NONE} 7905 * <li>{@link #ACCESSIBILITY_LIVE_REGION_POLITE} 7906 * <li>{@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE} 7907 * </ul> 7908 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7909 */ 7910 public void setAccessibilityLiveRegion(int mode) { 7911 if (mode != getAccessibilityLiveRegion()) { 7912 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7913 mPrivateFlags2 |= (mode << PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT) 7914 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7915 notifyViewAccessibilityStateChangedIfNeeded( 7916 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7917 } 7918 } 7919 7920 /** 7921 * Gets the live region mode for this View. 7922 * 7923 * @return The live region mode for the view. 7924 * 7925 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7926 * 7927 * @see #setAccessibilityLiveRegion(int) 7928 */ 7929 public int getAccessibilityLiveRegion() { 7930 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK) 7931 >> PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT; 7932 } 7933 7934 /** 7935 * Sets how to determine whether this view is important for accessibility 7936 * which is if it fires accessibility events and if it is reported to 7937 * accessibility services that query the screen. 7938 * 7939 * @param mode How to determine whether this view is important for accessibility. 7940 * 7941 * @attr ref android.R.styleable#View_importantForAccessibility 7942 * 7943 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7944 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7945 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7946 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7947 */ 7948 public void setImportantForAccessibility(int mode) { 7949 final int oldMode = getImportantForAccessibility(); 7950 if (mode != oldMode) { 7951 // If we're moving between AUTO and another state, we might not need 7952 // to send a subtree changed notification. We'll store the computed 7953 // importance, since we'll need to check it later to make sure. 7954 final boolean maySkipNotify = oldMode == IMPORTANT_FOR_ACCESSIBILITY_AUTO 7955 || mode == IMPORTANT_FOR_ACCESSIBILITY_AUTO; 7956 final boolean oldIncludeForAccessibility = maySkipNotify && includeForAccessibility(); 7957 mPrivateFlags2 &= ~PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7958 mPrivateFlags2 |= (mode << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT) 7959 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7960 if (!maySkipNotify || oldIncludeForAccessibility != includeForAccessibility()) { 7961 notifySubtreeAccessibilityStateChangedIfNeeded(); 7962 } else { 7963 notifyViewAccessibilityStateChangedIfNeeded( 7964 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7965 } 7966 } 7967 } 7968 7969 /** 7970 * Computes whether this view should be exposed for accessibility. In 7971 * general, views that are interactive or provide information are exposed 7972 * while views that serve only as containers are hidden. 7973 * <p> 7974 * If an ancestor of this view has importance 7975 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, this method 7976 * returns <code>false</code>. 7977 * <p> 7978 * Otherwise, the value is computed according to the view's 7979 * {@link #getImportantForAccessibility()} value: 7980 * <ol> 7981 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_NO} or 7982 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, return <code>false 7983 * </code> 7984 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_YES}, return <code>true</code> 7985 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_AUTO}, return <code>true</code> if 7986 * view satisfies any of the following: 7987 * <ul> 7988 * <li>Is actionable, e.g. {@link #isClickable()}, 7989 * {@link #isLongClickable()}, or {@link #isFocusable()} 7990 * <li>Has an {@link AccessibilityDelegate} 7991 * <li>Has an interaction listener, e.g. {@link OnTouchListener}, 7992 * {@link OnKeyListener}, etc. 7993 * <li>Is an accessibility live region, e.g. 7994 * {@link #getAccessibilityLiveRegion()} is not 7995 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. 7996 * </ul> 7997 * </ol> 7998 * 7999 * @return Whether the view is exposed for accessibility. 8000 * @see #setImportantForAccessibility(int) 8001 * @see #getImportantForAccessibility() 8002 */ 8003 public boolean isImportantForAccessibility() { 8004 final int mode = (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 8005 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 8006 if (mode == IMPORTANT_FOR_ACCESSIBILITY_NO 8007 || mode == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 8008 return false; 8009 } 8010 8011 // Check parent mode to ensure we're not hidden. 8012 ViewParent parent = mParent; 8013 while (parent instanceof View) { 8014 if (((View) parent).getImportantForAccessibility() 8015 == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 8016 return false; 8017 } 8018 parent = parent.getParent(); 8019 } 8020 8021 return mode == IMPORTANT_FOR_ACCESSIBILITY_YES || isActionableForAccessibility() 8022 || hasListenersForAccessibility() || getAccessibilityNodeProvider() != null 8023 || getAccessibilityLiveRegion() != ACCESSIBILITY_LIVE_REGION_NONE; 8024 } 8025 8026 /** 8027 * Gets the parent for accessibility purposes. Note that the parent for 8028 * accessibility is not necessary the immediate parent. It is the first 8029 * predecessor that is important for accessibility. 8030 * 8031 * @return The parent for accessibility purposes. 8032 */ 8033 public ViewParent getParentForAccessibility() { 8034 if (mParent instanceof View) { 8035 View parentView = (View) mParent; 8036 if (parentView.includeForAccessibility()) { 8037 return mParent; 8038 } else { 8039 return mParent.getParentForAccessibility(); 8040 } 8041 } 8042 return null; 8043 } 8044 8045 /** 8046 * Adds the children of a given View for accessibility. Since some Views are 8047 * not important for accessibility the children for accessibility are not 8048 * necessarily direct children of the view, rather they are the first level of 8049 * descendants important for accessibility. 8050 * 8051 * @param children The list of children for accessibility. 8052 */ 8053 public void addChildrenForAccessibility(ArrayList<View> children) { 8054 8055 } 8056 8057 /** 8058 * Whether to regard this view for accessibility. A view is regarded for 8059 * accessibility if it is important for accessibility or the querying 8060 * accessibility service has explicitly requested that view not 8061 * important for accessibility are regarded. 8062 * 8063 * @return Whether to regard the view for accessibility. 8064 * 8065 * @hide 8066 */ 8067 public boolean includeForAccessibility() { 8068 if (mAttachInfo != null) { 8069 return (mAttachInfo.mAccessibilityFetchFlags 8070 & AccessibilityNodeInfo.FLAG_INCLUDE_NOT_IMPORTANT_VIEWS) != 0 8071 || isImportantForAccessibility(); 8072 } 8073 return false; 8074 } 8075 8076 /** 8077 * Returns whether the View is considered actionable from 8078 * accessibility perspective. Such view are important for 8079 * accessibility. 8080 * 8081 * @return True if the view is actionable for accessibility. 8082 * 8083 * @hide 8084 */ 8085 public boolean isActionableForAccessibility() { 8086 return (isClickable() || isLongClickable() || isFocusable()); 8087 } 8088 8089 /** 8090 * Returns whether the View has registered callbacks which makes it 8091 * important for accessibility. 8092 * 8093 * @return True if the view is actionable for accessibility. 8094 */ 8095 private boolean hasListenersForAccessibility() { 8096 ListenerInfo info = getListenerInfo(); 8097 return mTouchDelegate != null || info.mOnKeyListener != null 8098 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null 8099 || info.mOnHoverListener != null || info.mOnDragListener != null; 8100 } 8101 8102 /** 8103 * Notifies that the accessibility state of this view changed. The change 8104 * is local to this view and does not represent structural changes such 8105 * as children and parent. For example, the view became focusable. The 8106 * notification is at at most once every 8107 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 8108 * to avoid unnecessary load to the system. Also once a view has a pending 8109 * notification this method is a NOP until the notification has been sent. 8110 * 8111 * @hide 8112 */ 8113 public void notifyViewAccessibilityStateChangedIfNeeded(int changeType) { 8114 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8115 return; 8116 } 8117 if (mSendViewStateChangedAccessibilityEvent == null) { 8118 mSendViewStateChangedAccessibilityEvent = 8119 new SendViewStateChangedAccessibilityEvent(); 8120 } 8121 mSendViewStateChangedAccessibilityEvent.runOrPost(changeType); 8122 } 8123 8124 /** 8125 * Notifies that the accessibility state of this view changed. The change 8126 * is *not* local to this view and does represent structural changes such 8127 * as children and parent. For example, the view size changed. The 8128 * notification is at at most once every 8129 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 8130 * to avoid unnecessary load to the system. Also once a view has a pending 8131 * notification this method is a NOP until the notification has been sent. 8132 * 8133 * @hide 8134 */ 8135 public void notifySubtreeAccessibilityStateChangedIfNeeded() { 8136 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8137 return; 8138 } 8139 if ((mPrivateFlags2 & PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED) == 0) { 8140 mPrivateFlags2 |= PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8141 if (mParent != null) { 8142 try { 8143 mParent.notifySubtreeAccessibilityStateChanged( 8144 this, this, AccessibilityEvent.CONTENT_CHANGE_TYPE_SUBTREE); 8145 } catch (AbstractMethodError e) { 8146 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 8147 " does not fully implement ViewParent", e); 8148 } 8149 } 8150 } 8151 } 8152 8153 /** 8154 * Reset the flag indicating the accessibility state of the subtree rooted 8155 * at this view changed. 8156 */ 8157 void resetSubtreeAccessibilityStateChanged() { 8158 mPrivateFlags2 &= ~PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8159 } 8160 8161 /** 8162 * Performs the specified accessibility action on the view. For 8163 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 8164 * <p> 8165 * If an {@link AccessibilityDelegate} has been specified via calling 8166 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 8167 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)} 8168 * is responsible for handling this call. 8169 * </p> 8170 * 8171 * @param action The action to perform. 8172 * @param arguments Optional action arguments. 8173 * @return Whether the action was performed. 8174 */ 8175 public boolean performAccessibilityAction(int action, Bundle arguments) { 8176 if (mAccessibilityDelegate != null) { 8177 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments); 8178 } else { 8179 return performAccessibilityActionInternal(action, arguments); 8180 } 8181 } 8182 8183 /** 8184 * @see #performAccessibilityAction(int, Bundle) 8185 * 8186 * Note: Called from the default {@link AccessibilityDelegate}. 8187 * 8188 * @hide Until we've refactored all accessibility delegation methods. 8189 */ 8190 public boolean performAccessibilityActionInternal(int action, Bundle arguments) { 8191 switch (action) { 8192 case AccessibilityNodeInfo.ACTION_CLICK: { 8193 if (isClickable()) { 8194 performClick(); 8195 return true; 8196 } 8197 } break; 8198 case AccessibilityNodeInfo.ACTION_LONG_CLICK: { 8199 if (isLongClickable()) { 8200 performLongClick(); 8201 return true; 8202 } 8203 } break; 8204 case AccessibilityNodeInfo.ACTION_FOCUS: { 8205 if (!hasFocus()) { 8206 // Get out of touch mode since accessibility 8207 // wants to move focus around. 8208 getViewRootImpl().ensureTouchMode(false); 8209 return requestFocus(); 8210 } 8211 } break; 8212 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: { 8213 if (hasFocus()) { 8214 clearFocus(); 8215 return !isFocused(); 8216 } 8217 } break; 8218 case AccessibilityNodeInfo.ACTION_SELECT: { 8219 if (!isSelected()) { 8220 setSelected(true); 8221 return isSelected(); 8222 } 8223 } break; 8224 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: { 8225 if (isSelected()) { 8226 setSelected(false); 8227 return !isSelected(); 8228 } 8229 } break; 8230 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: { 8231 if (!isAccessibilityFocused()) { 8232 return requestAccessibilityFocus(); 8233 } 8234 } break; 8235 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: { 8236 if (isAccessibilityFocused()) { 8237 clearAccessibilityFocus(); 8238 return true; 8239 } 8240 } break; 8241 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: { 8242 if (arguments != null) { 8243 final int granularity = arguments.getInt( 8244 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8245 final boolean extendSelection = arguments.getBoolean( 8246 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8247 return traverseAtGranularity(granularity, true, extendSelection); 8248 } 8249 } break; 8250 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: { 8251 if (arguments != null) { 8252 final int granularity = arguments.getInt( 8253 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8254 final boolean extendSelection = arguments.getBoolean( 8255 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8256 return traverseAtGranularity(granularity, false, extendSelection); 8257 } 8258 } break; 8259 case AccessibilityNodeInfo.ACTION_SET_SELECTION: { 8260 CharSequence text = getIterableTextForAccessibility(); 8261 if (text == null) { 8262 return false; 8263 } 8264 final int start = (arguments != null) ? arguments.getInt( 8265 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT, -1) : -1; 8266 final int end = (arguments != null) ? arguments.getInt( 8267 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT, -1) : -1; 8268 // Only cursor position can be specified (selection length == 0) 8269 if ((getAccessibilitySelectionStart() != start 8270 || getAccessibilitySelectionEnd() != end) 8271 && (start == end)) { 8272 setAccessibilitySelection(start, end); 8273 notifyViewAccessibilityStateChangedIfNeeded( 8274 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 8275 return true; 8276 } 8277 } break; 8278 } 8279 return false; 8280 } 8281 8282 private boolean traverseAtGranularity(int granularity, boolean forward, 8283 boolean extendSelection) { 8284 CharSequence text = getIterableTextForAccessibility(); 8285 if (text == null || text.length() == 0) { 8286 return false; 8287 } 8288 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 8289 if (iterator == null) { 8290 return false; 8291 } 8292 int current = getAccessibilitySelectionEnd(); 8293 if (current == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8294 current = forward ? 0 : text.length(); 8295 } 8296 final int[] range = forward ? iterator.following(current) : iterator.preceding(current); 8297 if (range == null) { 8298 return false; 8299 } 8300 final int segmentStart = range[0]; 8301 final int segmentEnd = range[1]; 8302 int selectionStart; 8303 int selectionEnd; 8304 if (extendSelection && isAccessibilitySelectionExtendable()) { 8305 selectionStart = getAccessibilitySelectionStart(); 8306 if (selectionStart == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8307 selectionStart = forward ? segmentStart : segmentEnd; 8308 } 8309 selectionEnd = forward ? segmentEnd : segmentStart; 8310 } else { 8311 selectionStart = selectionEnd= forward ? segmentEnd : segmentStart; 8312 } 8313 setAccessibilitySelection(selectionStart, selectionEnd); 8314 final int action = forward ? AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY 8315 : AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY; 8316 sendViewTextTraversedAtGranularityEvent(action, granularity, segmentStart, segmentEnd); 8317 return true; 8318 } 8319 8320 /** 8321 * Gets the text reported for accessibility purposes. 8322 * 8323 * @return The accessibility text. 8324 * 8325 * @hide 8326 */ 8327 public CharSequence getIterableTextForAccessibility() { 8328 return getContentDescription(); 8329 } 8330 8331 /** 8332 * Gets whether accessibility selection can be extended. 8333 * 8334 * @return If selection is extensible. 8335 * 8336 * @hide 8337 */ 8338 public boolean isAccessibilitySelectionExtendable() { 8339 return false; 8340 } 8341 8342 /** 8343 * @hide 8344 */ 8345 public int getAccessibilitySelectionStart() { 8346 return mAccessibilityCursorPosition; 8347 } 8348 8349 /** 8350 * @hide 8351 */ 8352 public int getAccessibilitySelectionEnd() { 8353 return getAccessibilitySelectionStart(); 8354 } 8355 8356 /** 8357 * @hide 8358 */ 8359 public void setAccessibilitySelection(int start, int end) { 8360 if (start == end && end == mAccessibilityCursorPosition) { 8361 return; 8362 } 8363 if (start >= 0 && start == end && end <= getIterableTextForAccessibility().length()) { 8364 mAccessibilityCursorPosition = start; 8365 } else { 8366 mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED; 8367 } 8368 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED); 8369 } 8370 8371 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity, 8372 int fromIndex, int toIndex) { 8373 if (mParent == null) { 8374 return; 8375 } 8376 AccessibilityEvent event = AccessibilityEvent.obtain( 8377 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY); 8378 onInitializeAccessibilityEvent(event); 8379 onPopulateAccessibilityEvent(event); 8380 event.setFromIndex(fromIndex); 8381 event.setToIndex(toIndex); 8382 event.setAction(action); 8383 event.setMovementGranularity(granularity); 8384 mParent.requestSendAccessibilityEvent(this, event); 8385 } 8386 8387 /** 8388 * @hide 8389 */ 8390 public TextSegmentIterator getIteratorForGranularity(int granularity) { 8391 switch (granularity) { 8392 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: { 8393 CharSequence text = getIterableTextForAccessibility(); 8394 if (text != null && text.length() > 0) { 8395 CharacterTextSegmentIterator iterator = 8396 CharacterTextSegmentIterator.getInstance( 8397 mContext.getResources().getConfiguration().locale); 8398 iterator.initialize(text.toString()); 8399 return iterator; 8400 } 8401 } break; 8402 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: { 8403 CharSequence text = getIterableTextForAccessibility(); 8404 if (text != null && text.length() > 0) { 8405 WordTextSegmentIterator iterator = 8406 WordTextSegmentIterator.getInstance( 8407 mContext.getResources().getConfiguration().locale); 8408 iterator.initialize(text.toString()); 8409 return iterator; 8410 } 8411 } break; 8412 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: { 8413 CharSequence text = getIterableTextForAccessibility(); 8414 if (text != null && text.length() > 0) { 8415 ParagraphTextSegmentIterator iterator = 8416 ParagraphTextSegmentIterator.getInstance(); 8417 iterator.initialize(text.toString()); 8418 return iterator; 8419 } 8420 } break; 8421 } 8422 return null; 8423 } 8424 8425 /** 8426 * @hide 8427 */ 8428 public void dispatchStartTemporaryDetach() { 8429 onStartTemporaryDetach(); 8430 } 8431 8432 /** 8433 * This is called when a container is going to temporarily detach a child, with 8434 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 8435 * It will either be followed by {@link #onFinishTemporaryDetach()} or 8436 * {@link #onDetachedFromWindow()} when the container is done. 8437 */ 8438 public void onStartTemporaryDetach() { 8439 removeUnsetPressCallback(); 8440 mPrivateFlags |= PFLAG_CANCEL_NEXT_UP_EVENT; 8441 } 8442 8443 /** 8444 * @hide 8445 */ 8446 public void dispatchFinishTemporaryDetach() { 8447 onFinishTemporaryDetach(); 8448 } 8449 8450 /** 8451 * Called after {@link #onStartTemporaryDetach} when the container is done 8452 * changing the view. 8453 */ 8454 public void onFinishTemporaryDetach() { 8455 } 8456 8457 /** 8458 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 8459 * for this view's window. Returns null if the view is not currently attached 8460 * to the window. Normally you will not need to use this directly, but 8461 * just use the standard high-level event callbacks like 8462 * {@link #onKeyDown(int, KeyEvent)}. 8463 */ 8464 public KeyEvent.DispatcherState getKeyDispatcherState() { 8465 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 8466 } 8467 8468 /** 8469 * Dispatch a key event before it is processed by any input method 8470 * associated with the view hierarchy. This can be used to intercept 8471 * key events in special situations before the IME consumes them; a 8472 * typical example would be handling the BACK key to update the application's 8473 * UI instead of allowing the IME to see it and close itself. 8474 * 8475 * @param event The key event to be dispatched. 8476 * @return True if the event was handled, false otherwise. 8477 */ 8478 public boolean dispatchKeyEventPreIme(KeyEvent event) { 8479 return onKeyPreIme(event.getKeyCode(), event); 8480 } 8481 8482 /** 8483 * Dispatch a key event to the next view on the focus path. This path runs 8484 * from the top of the view tree down to the currently focused view. If this 8485 * view has focus, it will dispatch to itself. Otherwise it will dispatch 8486 * the next node down the focus path. This method also fires any key 8487 * listeners. 8488 * 8489 * @param event The key event to be dispatched. 8490 * @return True if the event was handled, false otherwise. 8491 */ 8492 public boolean dispatchKeyEvent(KeyEvent event) { 8493 if (mInputEventConsistencyVerifier != null) { 8494 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 8495 } 8496 8497 // Give any attached key listener a first crack at the event. 8498 //noinspection SimplifiableIfStatement 8499 ListenerInfo li = mListenerInfo; 8500 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 8501 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 8502 return true; 8503 } 8504 8505 if (event.dispatch(this, mAttachInfo != null 8506 ? mAttachInfo.mKeyDispatchState : null, this)) { 8507 return true; 8508 } 8509 8510 if (mInputEventConsistencyVerifier != null) { 8511 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8512 } 8513 return false; 8514 } 8515 8516 /** 8517 * Dispatches a key shortcut event. 8518 * 8519 * @param event The key event to be dispatched. 8520 * @return True if the event was handled by the view, false otherwise. 8521 */ 8522 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 8523 return onKeyShortcut(event.getKeyCode(), event); 8524 } 8525 8526 /** 8527 * Pass the touch screen motion event down to the target view, or this 8528 * view if it is the target. 8529 * 8530 * @param event The motion event to be dispatched. 8531 * @return True if the event was handled by the view, false otherwise. 8532 */ 8533 public boolean dispatchTouchEvent(MotionEvent event) { 8534 boolean result = false; 8535 8536 if (mInputEventConsistencyVerifier != null) { 8537 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 8538 } 8539 8540 final int actionMasked = event.getActionMasked(); 8541 if (actionMasked == MotionEvent.ACTION_DOWN) { 8542 // Defensive cleanup for new gesture 8543 stopNestedScroll(); 8544 } 8545 8546 if (onFilterTouchEventForSecurity(event)) { 8547 //noinspection SimplifiableIfStatement 8548 ListenerInfo li = mListenerInfo; 8549 if (li != null && li.mOnTouchListener != null 8550 && (mViewFlags & ENABLED_MASK) == ENABLED 8551 && li.mOnTouchListener.onTouch(this, event)) { 8552 result = true; 8553 } 8554 8555 if (!result && onTouchEvent(event)) { 8556 result = true; 8557 } 8558 } 8559 8560 if (!result && mInputEventConsistencyVerifier != null) { 8561 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8562 } 8563 8564 // Clean up after nested scrolls if this is the end of a gesture; 8565 // also cancel it if we tried an ACTION_DOWN but we didn't want the rest 8566 // of the gesture. 8567 if (actionMasked == MotionEvent.ACTION_UP || 8568 actionMasked == MotionEvent.ACTION_CANCEL || 8569 (actionMasked == MotionEvent.ACTION_DOWN && !result)) { 8570 stopNestedScroll(); 8571 } 8572 8573 return result; 8574 } 8575 8576 /** 8577 * Filter the touch event to apply security policies. 8578 * 8579 * @param event The motion event to be filtered. 8580 * @return True if the event should be dispatched, false if the event should be dropped. 8581 * 8582 * @see #getFilterTouchesWhenObscured 8583 */ 8584 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 8585 //noinspection RedundantIfStatement 8586 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 8587 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 8588 // Window is obscured, drop this touch. 8589 return false; 8590 } 8591 return true; 8592 } 8593 8594 /** 8595 * Pass a trackball motion event down to the focused view. 8596 * 8597 * @param event The motion event to be dispatched. 8598 * @return True if the event was handled by the view, false otherwise. 8599 */ 8600 public boolean dispatchTrackballEvent(MotionEvent event) { 8601 if (mInputEventConsistencyVerifier != null) { 8602 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 8603 } 8604 8605 return onTrackballEvent(event); 8606 } 8607 8608 /** 8609 * Dispatch a generic motion event. 8610 * <p> 8611 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 8612 * are delivered to the view under the pointer. All other generic motion events are 8613 * delivered to the focused view. Hover events are handled specially and are delivered 8614 * to {@link #onHoverEvent(MotionEvent)}. 8615 * </p> 8616 * 8617 * @param event The motion event to be dispatched. 8618 * @return True if the event was handled by the view, false otherwise. 8619 */ 8620 public boolean dispatchGenericMotionEvent(MotionEvent event) { 8621 if (mInputEventConsistencyVerifier != null) { 8622 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 8623 } 8624 8625 final int source = event.getSource(); 8626 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 8627 final int action = event.getAction(); 8628 if (action == MotionEvent.ACTION_HOVER_ENTER 8629 || action == MotionEvent.ACTION_HOVER_MOVE 8630 || action == MotionEvent.ACTION_HOVER_EXIT) { 8631 if (dispatchHoverEvent(event)) { 8632 return true; 8633 } 8634 } else if (dispatchGenericPointerEvent(event)) { 8635 return true; 8636 } 8637 } else if (dispatchGenericFocusedEvent(event)) { 8638 return true; 8639 } 8640 8641 if (dispatchGenericMotionEventInternal(event)) { 8642 return true; 8643 } 8644 8645 if (mInputEventConsistencyVerifier != null) { 8646 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8647 } 8648 return false; 8649 } 8650 8651 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 8652 //noinspection SimplifiableIfStatement 8653 ListenerInfo li = mListenerInfo; 8654 if (li != null && li.mOnGenericMotionListener != null 8655 && (mViewFlags & ENABLED_MASK) == ENABLED 8656 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 8657 return true; 8658 } 8659 8660 if (onGenericMotionEvent(event)) { 8661 return true; 8662 } 8663 8664 if (mInputEventConsistencyVerifier != null) { 8665 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8666 } 8667 return false; 8668 } 8669 8670 /** 8671 * Dispatch a hover event. 8672 * <p> 8673 * Do not call this method directly. 8674 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8675 * </p> 8676 * 8677 * @param event The motion event to be dispatched. 8678 * @return True if the event was handled by the view, false otherwise. 8679 */ 8680 protected boolean dispatchHoverEvent(MotionEvent event) { 8681 ListenerInfo li = mListenerInfo; 8682 //noinspection SimplifiableIfStatement 8683 if (li != null && li.mOnHoverListener != null 8684 && (mViewFlags & ENABLED_MASK) == ENABLED 8685 && li.mOnHoverListener.onHover(this, event)) { 8686 return true; 8687 } 8688 8689 return onHoverEvent(event); 8690 } 8691 8692 /** 8693 * Returns true if the view has a child to which it has recently sent 8694 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 8695 * it does not have a hovered child, then it must be the innermost hovered view. 8696 * @hide 8697 */ 8698 protected boolean hasHoveredChild() { 8699 return false; 8700 } 8701 8702 /** 8703 * Dispatch a generic motion event to the view under the first pointer. 8704 * <p> 8705 * Do not call this method directly. 8706 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8707 * </p> 8708 * 8709 * @param event The motion event to be dispatched. 8710 * @return True if the event was handled by the view, false otherwise. 8711 */ 8712 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 8713 return false; 8714 } 8715 8716 /** 8717 * Dispatch a generic motion event to the currently focused view. 8718 * <p> 8719 * Do not call this method directly. 8720 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8721 * </p> 8722 * 8723 * @param event The motion event to be dispatched. 8724 * @return True if the event was handled by the view, false otherwise. 8725 */ 8726 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 8727 return false; 8728 } 8729 8730 /** 8731 * Dispatch a pointer event. 8732 * <p> 8733 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 8734 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 8735 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 8736 * and should not be expected to handle other pointing device features. 8737 * </p> 8738 * 8739 * @param event The motion event to be dispatched. 8740 * @return True if the event was handled by the view, false otherwise. 8741 * @hide 8742 */ 8743 public final boolean dispatchPointerEvent(MotionEvent event) { 8744 if (event.isTouchEvent()) { 8745 return dispatchTouchEvent(event); 8746 } else { 8747 return dispatchGenericMotionEvent(event); 8748 } 8749 } 8750 8751 /** 8752 * Called when the window containing this view gains or loses window focus. 8753 * ViewGroups should override to route to their children. 8754 * 8755 * @param hasFocus True if the window containing this view now has focus, 8756 * false otherwise. 8757 */ 8758 public void dispatchWindowFocusChanged(boolean hasFocus) { 8759 onWindowFocusChanged(hasFocus); 8760 } 8761 8762 /** 8763 * Called when the window containing this view gains or loses focus. Note 8764 * that this is separate from view focus: to receive key events, both 8765 * your view and its window must have focus. If a window is displayed 8766 * on top of yours that takes input focus, then your own window will lose 8767 * focus but the view focus will remain unchanged. 8768 * 8769 * @param hasWindowFocus True if the window containing this view now has 8770 * focus, false otherwise. 8771 */ 8772 public void onWindowFocusChanged(boolean hasWindowFocus) { 8773 InputMethodManager imm = InputMethodManager.peekInstance(); 8774 if (!hasWindowFocus) { 8775 if (isPressed()) { 8776 setPressed(false); 8777 } 8778 if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8779 imm.focusOut(this); 8780 } 8781 removeLongPressCallback(); 8782 removeTapCallback(); 8783 onFocusLost(); 8784 } else if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8785 imm.focusIn(this); 8786 } 8787 refreshDrawableState(); 8788 } 8789 8790 /** 8791 * Returns true if this view is in a window that currently has window focus. 8792 * Note that this is not the same as the view itself having focus. 8793 * 8794 * @return True if this view is in a window that currently has window focus. 8795 */ 8796 public boolean hasWindowFocus() { 8797 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 8798 } 8799 8800 /** 8801 * Dispatch a view visibility change down the view hierarchy. 8802 * ViewGroups should override to route to their children. 8803 * @param changedView The view whose visibility changed. Could be 'this' or 8804 * an ancestor view. 8805 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8806 * {@link #INVISIBLE} or {@link #GONE}. 8807 */ 8808 protected void dispatchVisibilityChanged(@NonNull View changedView, 8809 @Visibility int visibility) { 8810 onVisibilityChanged(changedView, visibility); 8811 } 8812 8813 /** 8814 * Called when the visibility of the view or an ancestor of the view is changed. 8815 * @param changedView The view whose visibility changed. Could be 'this' or 8816 * an ancestor view. 8817 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8818 * {@link #INVISIBLE} or {@link #GONE}. 8819 */ 8820 protected void onVisibilityChanged(@NonNull View changedView, @Visibility int visibility) { 8821 if (visibility == VISIBLE) { 8822 if (mAttachInfo != null) { 8823 initialAwakenScrollBars(); 8824 } else { 8825 mPrivateFlags |= PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 8826 } 8827 } 8828 } 8829 8830 /** 8831 * Dispatch a hint about whether this view is displayed. For instance, when 8832 * a View moves out of the screen, it might receives a display hint indicating 8833 * the view is not displayed. Applications should not <em>rely</em> on this hint 8834 * as there is no guarantee that they will receive one. 8835 * 8836 * @param hint A hint about whether or not this view is displayed: 8837 * {@link #VISIBLE} or {@link #INVISIBLE}. 8838 */ 8839 public void dispatchDisplayHint(@Visibility int hint) { 8840 onDisplayHint(hint); 8841 } 8842 8843 /** 8844 * Gives this view a hint about whether is displayed or not. For instance, when 8845 * a View moves out of the screen, it might receives a display hint indicating 8846 * the view is not displayed. Applications should not <em>rely</em> on this hint 8847 * as there is no guarantee that they will receive one. 8848 * 8849 * @param hint A hint about whether or not this view is displayed: 8850 * {@link #VISIBLE} or {@link #INVISIBLE}. 8851 */ 8852 protected void onDisplayHint(@Visibility int hint) { 8853 } 8854 8855 /** 8856 * Dispatch a window visibility change down the view hierarchy. 8857 * ViewGroups should override to route to their children. 8858 * 8859 * @param visibility The new visibility of the window. 8860 * 8861 * @see #onWindowVisibilityChanged(int) 8862 */ 8863 public void dispatchWindowVisibilityChanged(@Visibility int visibility) { 8864 onWindowVisibilityChanged(visibility); 8865 } 8866 8867 /** 8868 * Called when the window containing has change its visibility 8869 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 8870 * that this tells you whether or not your window is being made visible 8871 * to the window manager; this does <em>not</em> tell you whether or not 8872 * your window is obscured by other windows on the screen, even if it 8873 * is itself visible. 8874 * 8875 * @param visibility The new visibility of the window. 8876 */ 8877 protected void onWindowVisibilityChanged(@Visibility int visibility) { 8878 if (visibility == VISIBLE) { 8879 initialAwakenScrollBars(); 8880 } 8881 } 8882 8883 /** 8884 * Returns the current visibility of the window this view is attached to 8885 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 8886 * 8887 * @return Returns the current visibility of the view's window. 8888 */ 8889 @Visibility 8890 public int getWindowVisibility() { 8891 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 8892 } 8893 8894 /** 8895 * Retrieve the overall visible display size in which the window this view is 8896 * attached to has been positioned in. This takes into account screen 8897 * decorations above the window, for both cases where the window itself 8898 * is being position inside of them or the window is being placed under 8899 * then and covered insets are used for the window to position its content 8900 * inside. In effect, this tells you the available area where content can 8901 * be placed and remain visible to users. 8902 * 8903 * <p>This function requires an IPC back to the window manager to retrieve 8904 * the requested information, so should not be used in performance critical 8905 * code like drawing. 8906 * 8907 * @param outRect Filled in with the visible display frame. If the view 8908 * is not attached to a window, this is simply the raw display size. 8909 */ 8910 public void getWindowVisibleDisplayFrame(Rect outRect) { 8911 if (mAttachInfo != null) { 8912 try { 8913 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 8914 } catch (RemoteException e) { 8915 return; 8916 } 8917 // XXX This is really broken, and probably all needs to be done 8918 // in the window manager, and we need to know more about whether 8919 // we want the area behind or in front of the IME. 8920 final Rect insets = mAttachInfo.mVisibleInsets; 8921 outRect.left += insets.left; 8922 outRect.top += insets.top; 8923 outRect.right -= insets.right; 8924 outRect.bottom -= insets.bottom; 8925 return; 8926 } 8927 // The view is not attached to a display so we don't have a context. 8928 // Make a best guess about the display size. 8929 Display d = DisplayManagerGlobal.getInstance().getRealDisplay(Display.DEFAULT_DISPLAY); 8930 d.getRectSize(outRect); 8931 } 8932 8933 /** 8934 * Dispatch a notification about a resource configuration change down 8935 * the view hierarchy. 8936 * ViewGroups should override to route to their children. 8937 * 8938 * @param newConfig The new resource configuration. 8939 * 8940 * @see #onConfigurationChanged(android.content.res.Configuration) 8941 */ 8942 public void dispatchConfigurationChanged(Configuration newConfig) { 8943 onConfigurationChanged(newConfig); 8944 } 8945 8946 /** 8947 * Called when the current configuration of the resources being used 8948 * by the application have changed. You can use this to decide when 8949 * to reload resources that can changed based on orientation and other 8950 * configuration characterstics. You only need to use this if you are 8951 * not relying on the normal {@link android.app.Activity} mechanism of 8952 * recreating the activity instance upon a configuration change. 8953 * 8954 * @param newConfig The new resource configuration. 8955 */ 8956 protected void onConfigurationChanged(Configuration newConfig) { 8957 } 8958 8959 /** 8960 * Private function to aggregate all per-view attributes in to the view 8961 * root. 8962 */ 8963 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8964 performCollectViewAttributes(attachInfo, visibility); 8965 } 8966 8967 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8968 if ((visibility & VISIBILITY_MASK) == VISIBLE) { 8969 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 8970 attachInfo.mKeepScreenOn = true; 8971 } 8972 attachInfo.mSystemUiVisibility |= mSystemUiVisibility; 8973 ListenerInfo li = mListenerInfo; 8974 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 8975 attachInfo.mHasSystemUiListeners = true; 8976 } 8977 } 8978 } 8979 8980 void needGlobalAttributesUpdate(boolean force) { 8981 final AttachInfo ai = mAttachInfo; 8982 if (ai != null && !ai.mRecomputeGlobalAttributes) { 8983 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 8984 || ai.mHasSystemUiListeners) { 8985 ai.mRecomputeGlobalAttributes = true; 8986 } 8987 } 8988 } 8989 8990 /** 8991 * Returns whether the device is currently in touch mode. Touch mode is entered 8992 * once the user begins interacting with the device by touch, and affects various 8993 * things like whether focus is always visible to the user. 8994 * 8995 * @return Whether the device is in touch mode. 8996 */ 8997 @ViewDebug.ExportedProperty 8998 public boolean isInTouchMode() { 8999 if (mAttachInfo != null) { 9000 return mAttachInfo.mInTouchMode; 9001 } else { 9002 return ViewRootImpl.isInTouchMode(); 9003 } 9004 } 9005 9006 /** 9007 * Returns the context the view is running in, through which it can 9008 * access the current theme, resources, etc. 9009 * 9010 * @return The view's Context. 9011 */ 9012 @ViewDebug.CapturedViewProperty 9013 public final Context getContext() { 9014 return mContext; 9015 } 9016 9017 /** 9018 * Handle a key event before it is processed by any input method 9019 * associated with the view hierarchy. This can be used to intercept 9020 * key events in special situations before the IME consumes them; a 9021 * typical example would be handling the BACK key to update the application's 9022 * UI instead of allowing the IME to see it and close itself. 9023 * 9024 * @param keyCode The value in event.getKeyCode(). 9025 * @param event Description of the key event. 9026 * @return If you handled the event, return true. If you want to allow the 9027 * event to be handled by the next receiver, return false. 9028 */ 9029 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 9030 return false; 9031 } 9032 9033 /** 9034 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 9035 * KeyEvent.Callback.onKeyDown()}: perform press of the view 9036 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 9037 * is released, if the view is enabled and clickable. 9038 * 9039 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9040 * although some may elect to do so in some situations. Do not rely on this to 9041 * catch software key presses. 9042 * 9043 * @param keyCode A key code that represents the button pressed, from 9044 * {@link android.view.KeyEvent}. 9045 * @param event The KeyEvent object that defines the button action. 9046 */ 9047 public boolean onKeyDown(int keyCode, KeyEvent event) { 9048 boolean result = false; 9049 9050 if (KeyEvent.isConfirmKey(keyCode)) { 9051 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9052 return true; 9053 } 9054 // Long clickable items don't necessarily have to be clickable 9055 if (((mViewFlags & CLICKABLE) == CLICKABLE || 9056 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 9057 (event.getRepeatCount() == 0)) { 9058 setPressed(true); 9059 checkForLongClick(0); 9060 return true; 9061 } 9062 } 9063 return result; 9064 } 9065 9066 /** 9067 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 9068 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 9069 * the event). 9070 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9071 * although some may elect to do so in some situations. Do not rely on this to 9072 * catch software key presses. 9073 */ 9074 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 9075 return false; 9076 } 9077 9078 /** 9079 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 9080 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 9081 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 9082 * {@link KeyEvent#KEYCODE_ENTER} is released. 9083 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9084 * although some may elect to do so in some situations. Do not rely on this to 9085 * catch software key presses. 9086 * 9087 * @param keyCode A key code that represents the button pressed, from 9088 * {@link android.view.KeyEvent}. 9089 * @param event The KeyEvent object that defines the button action. 9090 */ 9091 public boolean onKeyUp(int keyCode, KeyEvent event) { 9092 if (KeyEvent.isConfirmKey(keyCode)) { 9093 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9094 return true; 9095 } 9096 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 9097 setPressed(false); 9098 9099 if (!mHasPerformedLongPress) { 9100 // This is a tap, so remove the longpress check 9101 removeLongPressCallback(); 9102 return performClick(); 9103 } 9104 } 9105 } 9106 return false; 9107 } 9108 9109 /** 9110 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 9111 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 9112 * the event). 9113 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9114 * although some may elect to do so in some situations. Do not rely on this to 9115 * catch software key presses. 9116 * 9117 * @param keyCode A key code that represents the button pressed, from 9118 * {@link android.view.KeyEvent}. 9119 * @param repeatCount The number of times the action was made. 9120 * @param event The KeyEvent object that defines the button action. 9121 */ 9122 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 9123 return false; 9124 } 9125 9126 /** 9127 * Called on the focused view when a key shortcut event is not handled. 9128 * Override this method to implement local key shortcuts for the View. 9129 * Key shortcuts can also be implemented by setting the 9130 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 9131 * 9132 * @param keyCode The value in event.getKeyCode(). 9133 * @param event Description of the key event. 9134 * @return If you handled the event, return true. If you want to allow the 9135 * event to be handled by the next receiver, return false. 9136 */ 9137 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 9138 return false; 9139 } 9140 9141 /** 9142 * Check whether the called view is a text editor, in which case it 9143 * would make sense to automatically display a soft input window for 9144 * it. Subclasses should override this if they implement 9145 * {@link #onCreateInputConnection(EditorInfo)} to return true if 9146 * a call on that method would return a non-null InputConnection, and 9147 * they are really a first-class editor that the user would normally 9148 * start typing on when the go into a window containing your view. 9149 * 9150 * <p>The default implementation always returns false. This does 9151 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 9152 * will not be called or the user can not otherwise perform edits on your 9153 * view; it is just a hint to the system that this is not the primary 9154 * purpose of this view. 9155 * 9156 * @return Returns true if this view is a text editor, else false. 9157 */ 9158 public boolean onCheckIsTextEditor() { 9159 return false; 9160 } 9161 9162 /** 9163 * Create a new InputConnection for an InputMethod to interact 9164 * with the view. The default implementation returns null, since it doesn't 9165 * support input methods. You can override this to implement such support. 9166 * This is only needed for views that take focus and text input. 9167 * 9168 * <p>When implementing this, you probably also want to implement 9169 * {@link #onCheckIsTextEditor()} to indicate you will return a 9170 * non-null InputConnection.</p> 9171 * 9172 * <p>Also, take good care to fill in the {@link android.view.inputmethod.EditorInfo} 9173 * object correctly and in its entirety, so that the connected IME can rely 9174 * on its values. For example, {@link android.view.inputmethod.EditorInfo#initialSelStart} 9175 * and {@link android.view.inputmethod.EditorInfo#initialSelEnd} members 9176 * must be filled in with the correct cursor position for IMEs to work correctly 9177 * with your application.</p> 9178 * 9179 * @param outAttrs Fill in with attribute information about the connection. 9180 */ 9181 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 9182 return null; 9183 } 9184 9185 /** 9186 * Called by the {@link android.view.inputmethod.InputMethodManager} 9187 * when a view who is not the current 9188 * input connection target is trying to make a call on the manager. The 9189 * default implementation returns false; you can override this to return 9190 * true for certain views if you are performing InputConnection proxying 9191 * to them. 9192 * @param view The View that is making the InputMethodManager call. 9193 * @return Return true to allow the call, false to reject. 9194 */ 9195 public boolean checkInputConnectionProxy(View view) { 9196 return false; 9197 } 9198 9199 /** 9200 * Show the context menu for this view. It is not safe to hold on to the 9201 * menu after returning from this method. 9202 * 9203 * You should normally not overload this method. Overload 9204 * {@link #onCreateContextMenu(ContextMenu)} or define an 9205 * {@link OnCreateContextMenuListener} to add items to the context menu. 9206 * 9207 * @param menu The context menu to populate 9208 */ 9209 public void createContextMenu(ContextMenu menu) { 9210 ContextMenuInfo menuInfo = getContextMenuInfo(); 9211 9212 // Sets the current menu info so all items added to menu will have 9213 // my extra info set. 9214 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 9215 9216 onCreateContextMenu(menu); 9217 ListenerInfo li = mListenerInfo; 9218 if (li != null && li.mOnCreateContextMenuListener != null) { 9219 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 9220 } 9221 9222 // Clear the extra information so subsequent items that aren't mine don't 9223 // have my extra info. 9224 ((MenuBuilder)menu).setCurrentMenuInfo(null); 9225 9226 if (mParent != null) { 9227 mParent.createContextMenu(menu); 9228 } 9229 } 9230 9231 /** 9232 * Views should implement this if they have extra information to associate 9233 * with the context menu. The return result is supplied as a parameter to 9234 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 9235 * callback. 9236 * 9237 * @return Extra information about the item for which the context menu 9238 * should be shown. This information will vary across different 9239 * subclasses of View. 9240 */ 9241 protected ContextMenuInfo getContextMenuInfo() { 9242 return null; 9243 } 9244 9245 /** 9246 * Views should implement this if the view itself is going to add items to 9247 * the context menu. 9248 * 9249 * @param menu the context menu to populate 9250 */ 9251 protected void onCreateContextMenu(ContextMenu menu) { 9252 } 9253 9254 /** 9255 * Implement this method to handle trackball motion events. The 9256 * <em>relative</em> movement of the trackball since the last event 9257 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 9258 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 9259 * that a movement of 1 corresponds to the user pressing one DPAD key (so 9260 * they will often be fractional values, representing the more fine-grained 9261 * movement information available from a trackball). 9262 * 9263 * @param event The motion event. 9264 * @return True if the event was handled, false otherwise. 9265 */ 9266 public boolean onTrackballEvent(MotionEvent event) { 9267 return false; 9268 } 9269 9270 /** 9271 * Implement this method to handle generic motion events. 9272 * <p> 9273 * Generic motion events describe joystick movements, mouse hovers, track pad 9274 * touches, scroll wheel movements and other input events. The 9275 * {@link MotionEvent#getSource() source} of the motion event specifies 9276 * the class of input that was received. Implementations of this method 9277 * must examine the bits in the source before processing the event. 9278 * The following code example shows how this is done. 9279 * </p><p> 9280 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 9281 * are delivered to the view under the pointer. All other generic motion events are 9282 * delivered to the focused view. 9283 * </p> 9284 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 9285 * if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) { 9286 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 9287 * // process the joystick movement... 9288 * return true; 9289 * } 9290 * } 9291 * if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) { 9292 * switch (event.getAction()) { 9293 * case MotionEvent.ACTION_HOVER_MOVE: 9294 * // process the mouse hover movement... 9295 * return true; 9296 * case MotionEvent.ACTION_SCROLL: 9297 * // process the scroll wheel movement... 9298 * return true; 9299 * } 9300 * } 9301 * return super.onGenericMotionEvent(event); 9302 * }</pre> 9303 * 9304 * @param event The generic motion event being processed. 9305 * @return True if the event was handled, false otherwise. 9306 */ 9307 public boolean onGenericMotionEvent(MotionEvent event) { 9308 return false; 9309 } 9310 9311 /** 9312 * Implement this method to handle hover events. 9313 * <p> 9314 * This method is called whenever a pointer is hovering into, over, or out of the 9315 * bounds of a view and the view is not currently being touched. 9316 * Hover events are represented as pointer events with action 9317 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 9318 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 9319 * </p> 9320 * <ul> 9321 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 9322 * when the pointer enters the bounds of the view.</li> 9323 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 9324 * when the pointer has already entered the bounds of the view and has moved.</li> 9325 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 9326 * when the pointer has exited the bounds of the view or when the pointer is 9327 * about to go down due to a button click, tap, or similar user action that 9328 * causes the view to be touched.</li> 9329 * </ul> 9330 * <p> 9331 * The view should implement this method to return true to indicate that it is 9332 * handling the hover event, such as by changing its drawable state. 9333 * </p><p> 9334 * The default implementation calls {@link #setHovered} to update the hovered state 9335 * of the view when a hover enter or hover exit event is received, if the view 9336 * is enabled and is clickable. The default implementation also sends hover 9337 * accessibility events. 9338 * </p> 9339 * 9340 * @param event The motion event that describes the hover. 9341 * @return True if the view handled the hover event. 9342 * 9343 * @see #isHovered 9344 * @see #setHovered 9345 * @see #onHoverChanged 9346 */ 9347 public boolean onHoverEvent(MotionEvent event) { 9348 // The root view may receive hover (or touch) events that are outside the bounds of 9349 // the window. This code ensures that we only send accessibility events for 9350 // hovers that are actually within the bounds of the root view. 9351 final int action = event.getActionMasked(); 9352 if (!mSendingHoverAccessibilityEvents) { 9353 if ((action == MotionEvent.ACTION_HOVER_ENTER 9354 || action == MotionEvent.ACTION_HOVER_MOVE) 9355 && !hasHoveredChild() 9356 && pointInView(event.getX(), event.getY())) { 9357 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 9358 mSendingHoverAccessibilityEvents = true; 9359 } 9360 } else { 9361 if (action == MotionEvent.ACTION_HOVER_EXIT 9362 || (action == MotionEvent.ACTION_MOVE 9363 && !pointInView(event.getX(), event.getY()))) { 9364 mSendingHoverAccessibilityEvents = false; 9365 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 9366 } 9367 } 9368 9369 if (isHoverable()) { 9370 switch (action) { 9371 case MotionEvent.ACTION_HOVER_ENTER: 9372 setHovered(true); 9373 break; 9374 case MotionEvent.ACTION_HOVER_EXIT: 9375 setHovered(false); 9376 break; 9377 } 9378 9379 // Dispatch the event to onGenericMotionEvent before returning true. 9380 // This is to provide compatibility with existing applications that 9381 // handled HOVER_MOVE events in onGenericMotionEvent and that would 9382 // break because of the new default handling for hoverable views 9383 // in onHoverEvent. 9384 // Note that onGenericMotionEvent will be called by default when 9385 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 9386 dispatchGenericMotionEventInternal(event); 9387 // The event was already handled by calling setHovered(), so always 9388 // return true. 9389 return true; 9390 } 9391 9392 return false; 9393 } 9394 9395 /** 9396 * Returns true if the view should handle {@link #onHoverEvent} 9397 * by calling {@link #setHovered} to change its hovered state. 9398 * 9399 * @return True if the view is hoverable. 9400 */ 9401 private boolean isHoverable() { 9402 final int viewFlags = mViewFlags; 9403 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9404 return false; 9405 } 9406 9407 return (viewFlags & CLICKABLE) == CLICKABLE 9408 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 9409 } 9410 9411 /** 9412 * Returns true if the view is currently hovered. 9413 * 9414 * @return True if the view is currently hovered. 9415 * 9416 * @see #setHovered 9417 * @see #onHoverChanged 9418 */ 9419 @ViewDebug.ExportedProperty 9420 public boolean isHovered() { 9421 return (mPrivateFlags & PFLAG_HOVERED) != 0; 9422 } 9423 9424 /** 9425 * Sets whether the view is currently hovered. 9426 * <p> 9427 * Calling this method also changes the drawable state of the view. This 9428 * enables the view to react to hover by using different drawable resources 9429 * to change its appearance. 9430 * </p><p> 9431 * The {@link #onHoverChanged} method is called when the hovered state changes. 9432 * </p> 9433 * 9434 * @param hovered True if the view is hovered. 9435 * 9436 * @see #isHovered 9437 * @see #onHoverChanged 9438 */ 9439 public void setHovered(boolean hovered) { 9440 if (hovered) { 9441 if ((mPrivateFlags & PFLAG_HOVERED) == 0) { 9442 mPrivateFlags |= PFLAG_HOVERED; 9443 refreshDrawableState(); 9444 onHoverChanged(true); 9445 } 9446 } else { 9447 if ((mPrivateFlags & PFLAG_HOVERED) != 0) { 9448 mPrivateFlags &= ~PFLAG_HOVERED; 9449 refreshDrawableState(); 9450 onHoverChanged(false); 9451 } 9452 } 9453 } 9454 9455 /** 9456 * Implement this method to handle hover state changes. 9457 * <p> 9458 * This method is called whenever the hover state changes as a result of a 9459 * call to {@link #setHovered}. 9460 * </p> 9461 * 9462 * @param hovered The current hover state, as returned by {@link #isHovered}. 9463 * 9464 * @see #isHovered 9465 * @see #setHovered 9466 */ 9467 public void onHoverChanged(boolean hovered) { 9468 } 9469 9470 /** 9471 * Implement this method to handle touch screen motion events. 9472 * <p> 9473 * If this method is used to detect click actions, it is recommended that 9474 * the actions be performed by implementing and calling 9475 * {@link #performClick()}. This will ensure consistent system behavior, 9476 * including: 9477 * <ul> 9478 * <li>obeying click sound preferences 9479 * <li>dispatching OnClickListener calls 9480 * <li>handling {@link AccessibilityNodeInfo#ACTION_CLICK ACTION_CLICK} when 9481 * accessibility features are enabled 9482 * </ul> 9483 * 9484 * @param event The motion event. 9485 * @return True if the event was handled, false otherwise. 9486 */ 9487 public boolean onTouchEvent(MotionEvent event) { 9488 final float x = event.getX(); 9489 final float y = event.getY(); 9490 final int viewFlags = mViewFlags; 9491 9492 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9493 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) { 9494 setPressed(false); 9495 } 9496 // A disabled view that is clickable still consumes the touch 9497 // events, it just doesn't respond to them. 9498 return (((viewFlags & CLICKABLE) == CLICKABLE || 9499 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 9500 } 9501 9502 if (mTouchDelegate != null) { 9503 if (mTouchDelegate.onTouchEvent(event)) { 9504 return true; 9505 } 9506 } 9507 9508 if (((viewFlags & CLICKABLE) == CLICKABLE || 9509 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 9510 switch (event.getAction()) { 9511 case MotionEvent.ACTION_UP: 9512 boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0; 9513 if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) { 9514 // take focus if we don't have it already and we should in 9515 // touch mode. 9516 boolean focusTaken = false; 9517 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 9518 focusTaken = requestFocus(); 9519 } 9520 9521 if (prepressed) { 9522 // The button is being released before we actually 9523 // showed it as pressed. Make it show the pressed 9524 // state now (before scheduling the click) to ensure 9525 // the user sees it. 9526 setPressed(true, x, y); 9527 } 9528 9529 if (!mHasPerformedLongPress) { 9530 // This is a tap, so remove the longpress check 9531 removeLongPressCallback(); 9532 9533 // Only perform take click actions if we were in the pressed state 9534 if (!focusTaken) { 9535 // Use a Runnable and post this rather than calling 9536 // performClick directly. This lets other visual state 9537 // of the view update before click actions start. 9538 if (mPerformClick == null) { 9539 mPerformClick = new PerformClick(); 9540 } 9541 if (!post(mPerformClick)) { 9542 performClick(); 9543 } 9544 } 9545 } 9546 9547 if (mUnsetPressedState == null) { 9548 mUnsetPressedState = new UnsetPressedState(); 9549 } 9550 9551 if (prepressed) { 9552 postDelayed(mUnsetPressedState, 9553 ViewConfiguration.getPressedStateDuration()); 9554 } else if (!post(mUnsetPressedState)) { 9555 // If the post failed, unpress right now 9556 mUnsetPressedState.run(); 9557 } 9558 9559 removeTapCallback(); 9560 } 9561 break; 9562 9563 case MotionEvent.ACTION_DOWN: 9564 mHasPerformedLongPress = false; 9565 9566 if (performButtonActionOnTouchDown(event)) { 9567 break; 9568 } 9569 9570 // Walk up the hierarchy to determine if we're inside a scrolling container. 9571 boolean isInScrollingContainer = isInScrollingContainer(); 9572 9573 // For views inside a scrolling container, delay the pressed feedback for 9574 // a short period in case this is a scroll. 9575 if (isInScrollingContainer) { 9576 mPrivateFlags |= PFLAG_PREPRESSED; 9577 if (mPendingCheckForTap == null) { 9578 mPendingCheckForTap = new CheckForTap(); 9579 } 9580 mPendingCheckForTap.x = event.getX(); 9581 mPendingCheckForTap.y = event.getY(); 9582 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 9583 } else { 9584 // Not inside a scrolling container, so show the feedback right away 9585 setPressed(true, x, y); 9586 checkForLongClick(0); 9587 } 9588 break; 9589 9590 case MotionEvent.ACTION_CANCEL: 9591 setPressed(false); 9592 removeTapCallback(); 9593 removeLongPressCallback(); 9594 break; 9595 9596 case MotionEvent.ACTION_MOVE: 9597 drawableHotspotChanged(x, y); 9598 9599 // Be lenient about moving outside of buttons 9600 if (!pointInView(x, y, mTouchSlop)) { 9601 // Outside button 9602 removeTapCallback(); 9603 if ((mPrivateFlags & PFLAG_PRESSED) != 0) { 9604 // Remove any future long press/tap checks 9605 removeLongPressCallback(); 9606 9607 setPressed(false); 9608 } 9609 } 9610 break; 9611 } 9612 9613 return true; 9614 } 9615 9616 return false; 9617 } 9618 9619 /** 9620 * @hide 9621 */ 9622 public boolean isInScrollingContainer() { 9623 ViewParent p = getParent(); 9624 while (p != null && p instanceof ViewGroup) { 9625 if (((ViewGroup) p).shouldDelayChildPressedState()) { 9626 return true; 9627 } 9628 p = p.getParent(); 9629 } 9630 return false; 9631 } 9632 9633 /** 9634 * Remove the longpress detection timer. 9635 */ 9636 private void removeLongPressCallback() { 9637 if (mPendingCheckForLongPress != null) { 9638 removeCallbacks(mPendingCheckForLongPress); 9639 } 9640 } 9641 9642 /** 9643 * Remove the pending click action 9644 */ 9645 private void removePerformClickCallback() { 9646 if (mPerformClick != null) { 9647 removeCallbacks(mPerformClick); 9648 } 9649 } 9650 9651 /** 9652 * Remove the prepress detection timer. 9653 */ 9654 private void removeUnsetPressCallback() { 9655 if ((mPrivateFlags & PFLAG_PRESSED) != 0 && mUnsetPressedState != null) { 9656 setPressed(false); 9657 removeCallbacks(mUnsetPressedState); 9658 } 9659 } 9660 9661 /** 9662 * Remove the tap detection timer. 9663 */ 9664 private void removeTapCallback() { 9665 if (mPendingCheckForTap != null) { 9666 mPrivateFlags &= ~PFLAG_PREPRESSED; 9667 removeCallbacks(mPendingCheckForTap); 9668 } 9669 } 9670 9671 /** 9672 * Cancels a pending long press. Your subclass can use this if you 9673 * want the context menu to come up if the user presses and holds 9674 * at the same place, but you don't want it to come up if they press 9675 * and then move around enough to cause scrolling. 9676 */ 9677 public void cancelLongPress() { 9678 removeLongPressCallback(); 9679 9680 /* 9681 * The prepressed state handled by the tap callback is a display 9682 * construct, but the tap callback will post a long press callback 9683 * less its own timeout. Remove it here. 9684 */ 9685 removeTapCallback(); 9686 } 9687 9688 /** 9689 * Remove the pending callback for sending a 9690 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 9691 */ 9692 private void removeSendViewScrolledAccessibilityEventCallback() { 9693 if (mSendViewScrolledAccessibilityEvent != null) { 9694 removeCallbacks(mSendViewScrolledAccessibilityEvent); 9695 mSendViewScrolledAccessibilityEvent.mIsPending = false; 9696 } 9697 } 9698 9699 /** 9700 * Sets the TouchDelegate for this View. 9701 */ 9702 public void setTouchDelegate(TouchDelegate delegate) { 9703 mTouchDelegate = delegate; 9704 } 9705 9706 /** 9707 * Gets the TouchDelegate for this View. 9708 */ 9709 public TouchDelegate getTouchDelegate() { 9710 return mTouchDelegate; 9711 } 9712 9713 /** 9714 * Request unbuffered dispatch of the given stream of MotionEvents to this View. 9715 * 9716 * Until this View receives a corresponding {@link MotionEvent#ACTION_UP}, ask that the input 9717 * system not batch {@link MotionEvent}s but instead deliver them as soon as they're 9718 * available. This method should only be called for touch events. 9719 * 9720 * <p class="note">This api is not intended for most applications. Buffered dispatch 9721 * provides many of benefits, and just requesting unbuffered dispatch on most MotionEvent 9722 * streams will not improve your input latency. Side effects include: increased latency, 9723 * jittery scrolls and inability to take advantage of system resampling. Talk to your input 9724 * professional to see if {@link #requestUnbufferedDispatch(MotionEvent)} is right for 9725 * you.</p> 9726 */ 9727 public final void requestUnbufferedDispatch(MotionEvent event) { 9728 final int action = event.getAction(); 9729 if (mAttachInfo == null 9730 || action != MotionEvent.ACTION_DOWN && action != MotionEvent.ACTION_MOVE 9731 || !event.isTouchEvent()) { 9732 return; 9733 } 9734 mAttachInfo.mUnbufferedDispatchRequested = true; 9735 } 9736 9737 /** 9738 * Set flags controlling behavior of this view. 9739 * 9740 * @param flags Constant indicating the value which should be set 9741 * @param mask Constant indicating the bit range that should be changed 9742 */ 9743 void setFlags(int flags, int mask) { 9744 final boolean accessibilityEnabled = 9745 AccessibilityManager.getInstance(mContext).isEnabled(); 9746 final boolean oldIncludeForAccessibility = accessibilityEnabled && includeForAccessibility(); 9747 9748 int old = mViewFlags; 9749 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 9750 9751 int changed = mViewFlags ^ old; 9752 if (changed == 0) { 9753 return; 9754 } 9755 int privateFlags = mPrivateFlags; 9756 9757 /* Check if the FOCUSABLE bit has changed */ 9758 if (((changed & FOCUSABLE_MASK) != 0) && 9759 ((privateFlags & PFLAG_HAS_BOUNDS) !=0)) { 9760 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 9761 && ((privateFlags & PFLAG_FOCUSED) != 0)) { 9762 /* Give up focus if we are no longer focusable */ 9763 clearFocus(); 9764 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 9765 && ((privateFlags & PFLAG_FOCUSED) == 0)) { 9766 /* 9767 * Tell the view system that we are now available to take focus 9768 * if no one else already has it. 9769 */ 9770 if (mParent != null) mParent.focusableViewAvailable(this); 9771 } 9772 } 9773 9774 final int newVisibility = flags & VISIBILITY_MASK; 9775 if (newVisibility == VISIBLE) { 9776 if ((changed & VISIBILITY_MASK) != 0) { 9777 /* 9778 * If this view is becoming visible, invalidate it in case it changed while 9779 * it was not visible. Marking it drawn ensures that the invalidation will 9780 * go through. 9781 */ 9782 mPrivateFlags |= PFLAG_DRAWN; 9783 invalidate(true); 9784 9785 needGlobalAttributesUpdate(true); 9786 9787 // a view becoming visible is worth notifying the parent 9788 // about in case nothing has focus. even if this specific view 9789 // isn't focusable, it may contain something that is, so let 9790 // the root view try to give this focus if nothing else does. 9791 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 9792 mParent.focusableViewAvailable(this); 9793 } 9794 } 9795 } 9796 9797 /* Check if the GONE bit has changed */ 9798 if ((changed & GONE) != 0) { 9799 needGlobalAttributesUpdate(false); 9800 requestLayout(); 9801 9802 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 9803 if (hasFocus()) clearFocus(); 9804 clearAccessibilityFocus(); 9805 destroyDrawingCache(); 9806 if (mParent instanceof View) { 9807 // GONE views noop invalidation, so invalidate the parent 9808 ((View) mParent).invalidate(true); 9809 } 9810 // Mark the view drawn to ensure that it gets invalidated properly the next 9811 // time it is visible and gets invalidated 9812 mPrivateFlags |= PFLAG_DRAWN; 9813 } 9814 if (mAttachInfo != null) { 9815 mAttachInfo.mViewVisibilityChanged = true; 9816 } 9817 } 9818 9819 /* Check if the VISIBLE bit has changed */ 9820 if ((changed & INVISIBLE) != 0) { 9821 needGlobalAttributesUpdate(false); 9822 /* 9823 * If this view is becoming invisible, set the DRAWN flag so that 9824 * the next invalidate() will not be skipped. 9825 */ 9826 mPrivateFlags |= PFLAG_DRAWN; 9827 9828 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE)) { 9829 // root view becoming invisible shouldn't clear focus and accessibility focus 9830 if (getRootView() != this) { 9831 if (hasFocus()) clearFocus(); 9832 clearAccessibilityFocus(); 9833 } 9834 } 9835 if (mAttachInfo != null) { 9836 mAttachInfo.mViewVisibilityChanged = true; 9837 } 9838 } 9839 9840 if ((changed & VISIBILITY_MASK) != 0) { 9841 // If the view is invisible, cleanup its display list to free up resources 9842 if (newVisibility != VISIBLE && mAttachInfo != null) { 9843 cleanupDraw(); 9844 } 9845 9846 if (mParent instanceof ViewGroup) { 9847 ((ViewGroup) mParent).onChildVisibilityChanged(this, 9848 (changed & VISIBILITY_MASK), newVisibility); 9849 ((View) mParent).invalidate(true); 9850 } else if (mParent != null) { 9851 mParent.invalidateChild(this, null); 9852 } 9853 dispatchVisibilityChanged(this, newVisibility); 9854 9855 notifySubtreeAccessibilityStateChangedIfNeeded(); 9856 } 9857 9858 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 9859 destroyDrawingCache(); 9860 } 9861 9862 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 9863 destroyDrawingCache(); 9864 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9865 invalidateParentCaches(); 9866 } 9867 9868 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 9869 destroyDrawingCache(); 9870 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9871 } 9872 9873 if ((changed & DRAW_MASK) != 0) { 9874 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 9875 if (mBackground != null) { 9876 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9877 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 9878 } else { 9879 mPrivateFlags |= PFLAG_SKIP_DRAW; 9880 } 9881 } else { 9882 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9883 } 9884 requestLayout(); 9885 invalidate(true); 9886 } 9887 9888 if ((changed & KEEP_SCREEN_ON) != 0) { 9889 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 9890 mParent.recomputeViewAttributes(this); 9891 } 9892 } 9893 9894 if (accessibilityEnabled) { 9895 if ((changed & FOCUSABLE_MASK) != 0 || (changed & VISIBILITY_MASK) != 0 9896 || (changed & CLICKABLE) != 0 || (changed & LONG_CLICKABLE) != 0) { 9897 if (oldIncludeForAccessibility != includeForAccessibility()) { 9898 notifySubtreeAccessibilityStateChangedIfNeeded(); 9899 } else { 9900 notifyViewAccessibilityStateChangedIfNeeded( 9901 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9902 } 9903 } else if ((changed & ENABLED_MASK) != 0) { 9904 notifyViewAccessibilityStateChangedIfNeeded( 9905 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9906 } 9907 } 9908 } 9909 9910 /** 9911 * Change the view's z order in the tree, so it's on top of other sibling 9912 * views. This ordering change may affect layout, if the parent container 9913 * uses an order-dependent layout scheme (e.g., LinearLayout). Prior 9914 * to {@link android.os.Build.VERSION_CODES#KITKAT} this 9915 * method should be followed by calls to {@link #requestLayout()} and 9916 * {@link View#invalidate()} on the view's parent to force the parent to redraw 9917 * with the new child ordering. 9918 * 9919 * @see ViewGroup#bringChildToFront(View) 9920 */ 9921 public void bringToFront() { 9922 if (mParent != null) { 9923 mParent.bringChildToFront(this); 9924 } 9925 } 9926 9927 /** 9928 * This is called in response to an internal scroll in this view (i.e., the 9929 * view scrolled its own contents). This is typically as a result of 9930 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 9931 * called. 9932 * 9933 * @param l Current horizontal scroll origin. 9934 * @param t Current vertical scroll origin. 9935 * @param oldl Previous horizontal scroll origin. 9936 * @param oldt Previous vertical scroll origin. 9937 */ 9938 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 9939 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 9940 postSendViewScrolledAccessibilityEventCallback(); 9941 } 9942 9943 mBackgroundSizeChanged = true; 9944 9945 final AttachInfo ai = mAttachInfo; 9946 if (ai != null) { 9947 ai.mViewScrollChanged = true; 9948 } 9949 9950 if (mListenerInfo != null && mListenerInfo.mOnScrollChangeListener != null) { 9951 mListenerInfo.mOnScrollChangeListener.onScrollChange(this, l, t, oldl, oldt); 9952 } 9953 } 9954 9955 /** 9956 * Interface definition for a callback to be invoked when the scroll 9957 * position of a view changes. 9958 * 9959 * @hide Only used internally. 9960 */ 9961 public interface OnScrollChangeListener { 9962 /** 9963 * Called when the scroll position of a view changes. 9964 * 9965 * @param v The view whose scroll position has changed. 9966 * @param scrollX Current horizontal scroll origin. 9967 * @param scrollY Current vertical scroll origin. 9968 * @param oldScrollX Previous horizontal scroll origin. 9969 * @param oldScrollY Previous vertical scroll origin. 9970 */ 9971 void onScrollChange(View v, int scrollX, int scrollY, int oldScrollX, int oldScrollY); 9972 } 9973 9974 /** 9975 * Interface definition for a callback to be invoked when the layout bounds of a view 9976 * changes due to layout processing. 9977 */ 9978 public interface OnLayoutChangeListener { 9979 /** 9980 * Called when the layout bounds of a view changes due to layout processing. 9981 * 9982 * @param v The view whose bounds have changed. 9983 * @param left The new value of the view's left property. 9984 * @param top The new value of the view's top property. 9985 * @param right The new value of the view's right property. 9986 * @param bottom The new value of the view's bottom property. 9987 * @param oldLeft The previous value of the view's left property. 9988 * @param oldTop The previous value of the view's top property. 9989 * @param oldRight The previous value of the view's right property. 9990 * @param oldBottom The previous value of the view's bottom property. 9991 */ 9992 void onLayoutChange(View v, int left, int top, int right, int bottom, 9993 int oldLeft, int oldTop, int oldRight, int oldBottom); 9994 } 9995 9996 /** 9997 * This is called during layout when the size of this view has changed. If 9998 * you were just added to the view hierarchy, you're called with the old 9999 * values of 0. 10000 * 10001 * @param w Current width of this view. 10002 * @param h Current height of this view. 10003 * @param oldw Old width of this view. 10004 * @param oldh Old height of this view. 10005 */ 10006 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 10007 } 10008 10009 /** 10010 * Called by draw to draw the child views. This may be overridden 10011 * by derived classes to gain control just before its children are drawn 10012 * (but after its own view has been drawn). 10013 * @param canvas the canvas on which to draw the view 10014 */ 10015 protected void dispatchDraw(Canvas canvas) { 10016 10017 } 10018 10019 /** 10020 * Gets the parent of this view. Note that the parent is a 10021 * ViewParent and not necessarily a View. 10022 * 10023 * @return Parent of this view. 10024 */ 10025 public final ViewParent getParent() { 10026 return mParent; 10027 } 10028 10029 /** 10030 * Set the horizontal scrolled position of your view. This will cause a call to 10031 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10032 * invalidated. 10033 * @param value the x position to scroll to 10034 */ 10035 public void setScrollX(int value) { 10036 scrollTo(value, mScrollY); 10037 } 10038 10039 /** 10040 * Set the vertical scrolled position of your view. This will cause a call to 10041 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10042 * invalidated. 10043 * @param value the y position to scroll to 10044 */ 10045 public void setScrollY(int value) { 10046 scrollTo(mScrollX, value); 10047 } 10048 10049 /** 10050 * Return the scrolled left position of this view. This is the left edge of 10051 * the displayed part of your view. You do not need to draw any pixels 10052 * farther left, since those are outside of the frame of your view on 10053 * screen. 10054 * 10055 * @return The left edge of the displayed part of your view, in pixels. 10056 */ 10057 public final int getScrollX() { 10058 return mScrollX; 10059 } 10060 10061 /** 10062 * Return the scrolled top position of this view. This is the top edge of 10063 * the displayed part of your view. You do not need to draw any pixels above 10064 * it, since those are outside of the frame of your view on screen. 10065 * 10066 * @return The top edge of the displayed part of your view, in pixels. 10067 */ 10068 public final int getScrollY() { 10069 return mScrollY; 10070 } 10071 10072 /** 10073 * Return the width of the your view. 10074 * 10075 * @return The width of your view, in pixels. 10076 */ 10077 @ViewDebug.ExportedProperty(category = "layout") 10078 public final int getWidth() { 10079 return mRight - mLeft; 10080 } 10081 10082 /** 10083 * Return the height of your view. 10084 * 10085 * @return The height of your view, in pixels. 10086 */ 10087 @ViewDebug.ExportedProperty(category = "layout") 10088 public final int getHeight() { 10089 return mBottom - mTop; 10090 } 10091 10092 /** 10093 * Return the visible drawing bounds of your view. Fills in the output 10094 * rectangle with the values from getScrollX(), getScrollY(), 10095 * getWidth(), and getHeight(). These bounds do not account for any 10096 * transformation properties currently set on the view, such as 10097 * {@link #setScaleX(float)} or {@link #setRotation(float)}. 10098 * 10099 * @param outRect The (scrolled) drawing bounds of the view. 10100 */ 10101 public void getDrawingRect(Rect outRect) { 10102 outRect.left = mScrollX; 10103 outRect.top = mScrollY; 10104 outRect.right = mScrollX + (mRight - mLeft); 10105 outRect.bottom = mScrollY + (mBottom - mTop); 10106 } 10107 10108 /** 10109 * Like {@link #getMeasuredWidthAndState()}, but only returns the 10110 * raw width component (that is the result is masked by 10111 * {@link #MEASURED_SIZE_MASK}). 10112 * 10113 * @return The raw measured width of this view. 10114 */ 10115 public final int getMeasuredWidth() { 10116 return mMeasuredWidth & MEASURED_SIZE_MASK; 10117 } 10118 10119 /** 10120 * Return the full width measurement information for this view as computed 10121 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10122 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10123 * This should be used during measurement and layout calculations only. Use 10124 * {@link #getWidth()} to see how wide a view is after layout. 10125 * 10126 * @return The measured width of this view as a bit mask. 10127 */ 10128 public final int getMeasuredWidthAndState() { 10129 return mMeasuredWidth; 10130 } 10131 10132 /** 10133 * Like {@link #getMeasuredHeightAndState()}, but only returns the 10134 * raw width component (that is the result is masked by 10135 * {@link #MEASURED_SIZE_MASK}). 10136 * 10137 * @return The raw measured height of this view. 10138 */ 10139 public final int getMeasuredHeight() { 10140 return mMeasuredHeight & MEASURED_SIZE_MASK; 10141 } 10142 10143 /** 10144 * Return the full height measurement information for this view as computed 10145 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10146 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10147 * This should be used during measurement and layout calculations only. Use 10148 * {@link #getHeight()} to see how wide a view is after layout. 10149 * 10150 * @return The measured width of this view as a bit mask. 10151 */ 10152 public final int getMeasuredHeightAndState() { 10153 return mMeasuredHeight; 10154 } 10155 10156 /** 10157 * Return only the state bits of {@link #getMeasuredWidthAndState()} 10158 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 10159 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 10160 * and the height component is at the shifted bits 10161 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 10162 */ 10163 public final int getMeasuredState() { 10164 return (mMeasuredWidth&MEASURED_STATE_MASK) 10165 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 10166 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 10167 } 10168 10169 /** 10170 * The transform matrix of this view, which is calculated based on the current 10171 * rotation, scale, and pivot properties. 10172 * 10173 * @see #getRotation() 10174 * @see #getScaleX() 10175 * @see #getScaleY() 10176 * @see #getPivotX() 10177 * @see #getPivotY() 10178 * @return The current transform matrix for the view 10179 */ 10180 public Matrix getMatrix() { 10181 ensureTransformationInfo(); 10182 final Matrix matrix = mTransformationInfo.mMatrix; 10183 mRenderNode.getMatrix(matrix); 10184 return matrix; 10185 } 10186 10187 /** 10188 * Returns true if the transform matrix is the identity matrix. 10189 * Recomputes the matrix if necessary. 10190 * 10191 * @return True if the transform matrix is the identity matrix, false otherwise. 10192 */ 10193 final boolean hasIdentityMatrix() { 10194 return mRenderNode.hasIdentityMatrix(); 10195 } 10196 10197 void ensureTransformationInfo() { 10198 if (mTransformationInfo == null) { 10199 mTransformationInfo = new TransformationInfo(); 10200 } 10201 } 10202 10203 /** 10204 * Utility method to retrieve the inverse of the current mMatrix property. 10205 * We cache the matrix to avoid recalculating it when transform properties 10206 * have not changed. 10207 * 10208 * @return The inverse of the current matrix of this view. 10209 * @hide 10210 */ 10211 public final Matrix getInverseMatrix() { 10212 ensureTransformationInfo(); 10213 if (mTransformationInfo.mInverseMatrix == null) { 10214 mTransformationInfo.mInverseMatrix = new Matrix(); 10215 } 10216 final Matrix matrix = mTransformationInfo.mInverseMatrix; 10217 mRenderNode.getInverseMatrix(matrix); 10218 return matrix; 10219 } 10220 10221 /** 10222 * Gets the distance along the Z axis from the camera to this view. 10223 * 10224 * @see #setCameraDistance(float) 10225 * 10226 * @return The distance along the Z axis. 10227 */ 10228 public float getCameraDistance() { 10229 final float dpi = mResources.getDisplayMetrics().densityDpi; 10230 return -(mRenderNode.getCameraDistance() * dpi); 10231 } 10232 10233 /** 10234 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 10235 * views are drawn) from the camera to this view. The camera's distance 10236 * affects 3D transformations, for instance rotations around the X and Y 10237 * axis. If the rotationX or rotationY properties are changed and this view is 10238 * large (more than half the size of the screen), it is recommended to always 10239 * use a camera distance that's greater than the height (X axis rotation) or 10240 * the width (Y axis rotation) of this view.</p> 10241 * 10242 * <p>The distance of the camera from the view plane can have an affect on the 10243 * perspective distortion of the view when it is rotated around the x or y axis. 10244 * For example, a large distance will result in a large viewing angle, and there 10245 * will not be much perspective distortion of the view as it rotates. A short 10246 * distance may cause much more perspective distortion upon rotation, and can 10247 * also result in some drawing artifacts if the rotated view ends up partially 10248 * behind the camera (which is why the recommendation is to use a distance at 10249 * least as far as the size of the view, if the view is to be rotated.)</p> 10250 * 10251 * <p>The distance is expressed in "depth pixels." The default distance depends 10252 * on the screen density. For instance, on a medium density display, the 10253 * default distance is 1280. On a high density display, the default distance 10254 * is 1920.</p> 10255 * 10256 * <p>If you want to specify a distance that leads to visually consistent 10257 * results across various densities, use the following formula:</p> 10258 * <pre> 10259 * float scale = context.getResources().getDisplayMetrics().density; 10260 * view.setCameraDistance(distance * scale); 10261 * </pre> 10262 * 10263 * <p>The density scale factor of a high density display is 1.5, 10264 * and 1920 = 1280 * 1.5.</p> 10265 * 10266 * @param distance The distance in "depth pixels", if negative the opposite 10267 * value is used 10268 * 10269 * @see #setRotationX(float) 10270 * @see #setRotationY(float) 10271 */ 10272 public void setCameraDistance(float distance) { 10273 final float dpi = mResources.getDisplayMetrics().densityDpi; 10274 10275 invalidateViewProperty(true, false); 10276 mRenderNode.setCameraDistance(-Math.abs(distance) / dpi); 10277 invalidateViewProperty(false, false); 10278 10279 invalidateParentIfNeededAndWasQuickRejected(); 10280 } 10281 10282 /** 10283 * The degrees that the view is rotated around the pivot point. 10284 * 10285 * @see #setRotation(float) 10286 * @see #getPivotX() 10287 * @see #getPivotY() 10288 * 10289 * @return The degrees of rotation. 10290 */ 10291 @ViewDebug.ExportedProperty(category = "drawing") 10292 public float getRotation() { 10293 return mRenderNode.getRotation(); 10294 } 10295 10296 /** 10297 * Sets the degrees that the view is rotated around the pivot point. Increasing values 10298 * result in clockwise rotation. 10299 * 10300 * @param rotation The degrees of rotation. 10301 * 10302 * @see #getRotation() 10303 * @see #getPivotX() 10304 * @see #getPivotY() 10305 * @see #setRotationX(float) 10306 * @see #setRotationY(float) 10307 * 10308 * @attr ref android.R.styleable#View_rotation 10309 */ 10310 public void setRotation(float rotation) { 10311 if (rotation != getRotation()) { 10312 // Double-invalidation is necessary to capture view's old and new areas 10313 invalidateViewProperty(true, false); 10314 mRenderNode.setRotation(rotation); 10315 invalidateViewProperty(false, true); 10316 10317 invalidateParentIfNeededAndWasQuickRejected(); 10318 notifySubtreeAccessibilityStateChangedIfNeeded(); 10319 } 10320 } 10321 10322 /** 10323 * The degrees that the view is rotated around the vertical axis through the pivot point. 10324 * 10325 * @see #getPivotX() 10326 * @see #getPivotY() 10327 * @see #setRotationY(float) 10328 * 10329 * @return The degrees of Y rotation. 10330 */ 10331 @ViewDebug.ExportedProperty(category = "drawing") 10332 public float getRotationY() { 10333 return mRenderNode.getRotationY(); 10334 } 10335 10336 /** 10337 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 10338 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 10339 * down the y axis. 10340 * 10341 * When rotating large views, it is recommended to adjust the camera distance 10342 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10343 * 10344 * @param rotationY The degrees of Y rotation. 10345 * 10346 * @see #getRotationY() 10347 * @see #getPivotX() 10348 * @see #getPivotY() 10349 * @see #setRotation(float) 10350 * @see #setRotationX(float) 10351 * @see #setCameraDistance(float) 10352 * 10353 * @attr ref android.R.styleable#View_rotationY 10354 */ 10355 public void setRotationY(float rotationY) { 10356 if (rotationY != getRotationY()) { 10357 invalidateViewProperty(true, false); 10358 mRenderNode.setRotationY(rotationY); 10359 invalidateViewProperty(false, true); 10360 10361 invalidateParentIfNeededAndWasQuickRejected(); 10362 notifySubtreeAccessibilityStateChangedIfNeeded(); 10363 } 10364 } 10365 10366 /** 10367 * The degrees that the view is rotated around the horizontal axis through the pivot point. 10368 * 10369 * @see #getPivotX() 10370 * @see #getPivotY() 10371 * @see #setRotationX(float) 10372 * 10373 * @return The degrees of X rotation. 10374 */ 10375 @ViewDebug.ExportedProperty(category = "drawing") 10376 public float getRotationX() { 10377 return mRenderNode.getRotationX(); 10378 } 10379 10380 /** 10381 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 10382 * Increasing values result in clockwise rotation from the viewpoint of looking down the 10383 * x axis. 10384 * 10385 * When rotating large views, it is recommended to adjust the camera distance 10386 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10387 * 10388 * @param rotationX The degrees of X rotation. 10389 * 10390 * @see #getRotationX() 10391 * @see #getPivotX() 10392 * @see #getPivotY() 10393 * @see #setRotation(float) 10394 * @see #setRotationY(float) 10395 * @see #setCameraDistance(float) 10396 * 10397 * @attr ref android.R.styleable#View_rotationX 10398 */ 10399 public void setRotationX(float rotationX) { 10400 if (rotationX != getRotationX()) { 10401 invalidateViewProperty(true, false); 10402 mRenderNode.setRotationX(rotationX); 10403 invalidateViewProperty(false, true); 10404 10405 invalidateParentIfNeededAndWasQuickRejected(); 10406 notifySubtreeAccessibilityStateChangedIfNeeded(); 10407 } 10408 } 10409 10410 /** 10411 * The amount that the view is scaled in x around the pivot point, as a proportion of 10412 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 10413 * 10414 * <p>By default, this is 1.0f. 10415 * 10416 * @see #getPivotX() 10417 * @see #getPivotY() 10418 * @return The scaling factor. 10419 */ 10420 @ViewDebug.ExportedProperty(category = "drawing") 10421 public float getScaleX() { 10422 return mRenderNode.getScaleX(); 10423 } 10424 10425 /** 10426 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 10427 * the view's unscaled width. A value of 1 means that no scaling is applied. 10428 * 10429 * @param scaleX The scaling factor. 10430 * @see #getPivotX() 10431 * @see #getPivotY() 10432 * 10433 * @attr ref android.R.styleable#View_scaleX 10434 */ 10435 public void setScaleX(float scaleX) { 10436 if (scaleX != getScaleX()) { 10437 invalidateViewProperty(true, false); 10438 mRenderNode.setScaleX(scaleX); 10439 invalidateViewProperty(false, true); 10440 10441 invalidateParentIfNeededAndWasQuickRejected(); 10442 notifySubtreeAccessibilityStateChangedIfNeeded(); 10443 } 10444 } 10445 10446 /** 10447 * The amount that the view is scaled in y around the pivot point, as a proportion of 10448 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 10449 * 10450 * <p>By default, this is 1.0f. 10451 * 10452 * @see #getPivotX() 10453 * @see #getPivotY() 10454 * @return The scaling factor. 10455 */ 10456 @ViewDebug.ExportedProperty(category = "drawing") 10457 public float getScaleY() { 10458 return mRenderNode.getScaleY(); 10459 } 10460 10461 /** 10462 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 10463 * the view's unscaled width. A value of 1 means that no scaling is applied. 10464 * 10465 * @param scaleY The scaling factor. 10466 * @see #getPivotX() 10467 * @see #getPivotY() 10468 * 10469 * @attr ref android.R.styleable#View_scaleY 10470 */ 10471 public void setScaleY(float scaleY) { 10472 if (scaleY != getScaleY()) { 10473 invalidateViewProperty(true, false); 10474 mRenderNode.setScaleY(scaleY); 10475 invalidateViewProperty(false, true); 10476 10477 invalidateParentIfNeededAndWasQuickRejected(); 10478 notifySubtreeAccessibilityStateChangedIfNeeded(); 10479 } 10480 } 10481 10482 /** 10483 * The x location of the point around which the view is {@link #setRotation(float) rotated} 10484 * and {@link #setScaleX(float) scaled}. 10485 * 10486 * @see #getRotation() 10487 * @see #getScaleX() 10488 * @see #getScaleY() 10489 * @see #getPivotY() 10490 * @return The x location of the pivot point. 10491 * 10492 * @attr ref android.R.styleable#View_transformPivotX 10493 */ 10494 @ViewDebug.ExportedProperty(category = "drawing") 10495 public float getPivotX() { 10496 return mRenderNode.getPivotX(); 10497 } 10498 10499 /** 10500 * Sets the x location of the point around which the view is 10501 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 10502 * By default, the pivot point is centered on the object. 10503 * Setting this property disables this behavior and causes the view to use only the 10504 * explicitly set pivotX and pivotY values. 10505 * 10506 * @param pivotX The x location of the pivot point. 10507 * @see #getRotation() 10508 * @see #getScaleX() 10509 * @see #getScaleY() 10510 * @see #getPivotY() 10511 * 10512 * @attr ref android.R.styleable#View_transformPivotX 10513 */ 10514 public void setPivotX(float pivotX) { 10515 if (!mRenderNode.isPivotExplicitlySet() || pivotX != getPivotX()) { 10516 invalidateViewProperty(true, false); 10517 mRenderNode.setPivotX(pivotX); 10518 invalidateViewProperty(false, true); 10519 10520 invalidateParentIfNeededAndWasQuickRejected(); 10521 } 10522 } 10523 10524 /** 10525 * The y location of the point around which the view is {@link #setRotation(float) rotated} 10526 * and {@link #setScaleY(float) scaled}. 10527 * 10528 * @see #getRotation() 10529 * @see #getScaleX() 10530 * @see #getScaleY() 10531 * @see #getPivotY() 10532 * @return The y location of the pivot point. 10533 * 10534 * @attr ref android.R.styleable#View_transformPivotY 10535 */ 10536 @ViewDebug.ExportedProperty(category = "drawing") 10537 public float getPivotY() { 10538 return mRenderNode.getPivotY(); 10539 } 10540 10541 /** 10542 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 10543 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 10544 * Setting this property disables this behavior and causes the view to use only the 10545 * explicitly set pivotX and pivotY values. 10546 * 10547 * @param pivotY The y location of the pivot point. 10548 * @see #getRotation() 10549 * @see #getScaleX() 10550 * @see #getScaleY() 10551 * @see #getPivotY() 10552 * 10553 * @attr ref android.R.styleable#View_transformPivotY 10554 */ 10555 public void setPivotY(float pivotY) { 10556 if (!mRenderNode.isPivotExplicitlySet() || pivotY != getPivotY()) { 10557 invalidateViewProperty(true, false); 10558 mRenderNode.setPivotY(pivotY); 10559 invalidateViewProperty(false, true); 10560 10561 invalidateParentIfNeededAndWasQuickRejected(); 10562 } 10563 } 10564 10565 /** 10566 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 10567 * completely transparent and 1 means the view is completely opaque. 10568 * 10569 * <p>By default this is 1.0f. 10570 * @return The opacity of the view. 10571 */ 10572 @ViewDebug.ExportedProperty(category = "drawing") 10573 public float getAlpha() { 10574 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 10575 } 10576 10577 /** 10578 * Returns whether this View has content which overlaps. 10579 * 10580 * <p>This function, intended to be overridden by specific View types, is an optimization when 10581 * alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to 10582 * an offscreen buffer and then composited into place, which can be expensive. If the view has 10583 * no overlapping rendering, the view can draw each primitive with the appropriate alpha value 10584 * directly. An example of overlapping rendering is a TextView with a background image, such as 10585 * a Button. An example of non-overlapping rendering is a TextView with no background, or an 10586 * ImageView with only the foreground image. The default implementation returns true; subclasses 10587 * should override if they have cases which can be optimized.</p> 10588 * 10589 * <p>The current implementation of the saveLayer and saveLayerAlpha methods in {@link Canvas} 10590 * necessitates that a View return true if it uses the methods internally without passing the 10591 * {@link Canvas#CLIP_TO_LAYER_SAVE_FLAG}.</p> 10592 * 10593 * @return true if the content in this view might overlap, false otherwise. 10594 */ 10595 @ViewDebug.ExportedProperty(category = "drawing") 10596 public boolean hasOverlappingRendering() { 10597 return true; 10598 } 10599 10600 /** 10601 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 10602 * completely transparent and 1 means the view is completely opaque.</p> 10603 * 10604 * <p> Note that setting alpha to a translucent value (0 < alpha < 1) can have significant 10605 * performance implications, especially for large views. It is best to use the alpha property 10606 * sparingly and transiently, as in the case of fading animations.</p> 10607 * 10608 * <p>For a view with a frequently changing alpha, such as during a fading animation, it is 10609 * strongly recommended for performance reasons to either override 10610 * {@link #hasOverlappingRendering()} to return false if appropriate, or setting a 10611 * {@link #setLayerType(int, android.graphics.Paint) layer type} on the view.</p> 10612 * 10613 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 10614 * responsible for applying the opacity itself.</p> 10615 * 10616 * <p>Note that if the view is backed by a 10617 * {@link #setLayerType(int, android.graphics.Paint) layer} and is associated with a 10618 * {@link #setLayerPaint(android.graphics.Paint) layer paint}, setting an alpha value less than 10619 * 1.0 will supercede the alpha of the layer paint.</p> 10620 * 10621 * @param alpha The opacity of the view. 10622 * 10623 * @see #hasOverlappingRendering() 10624 * @see #setLayerType(int, android.graphics.Paint) 10625 * 10626 * @attr ref android.R.styleable#View_alpha 10627 */ 10628 public void setAlpha(float alpha) { 10629 ensureTransformationInfo(); 10630 if (mTransformationInfo.mAlpha != alpha) { 10631 mTransformationInfo.mAlpha = alpha; 10632 if (onSetAlpha((int) (alpha * 255))) { 10633 mPrivateFlags |= PFLAG_ALPHA_SET; 10634 // subclass is handling alpha - don't optimize rendering cache invalidation 10635 invalidateParentCaches(); 10636 invalidate(true); 10637 } else { 10638 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10639 invalidateViewProperty(true, false); 10640 mRenderNode.setAlpha(getFinalAlpha()); 10641 notifyViewAccessibilityStateChangedIfNeeded( 10642 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 10643 } 10644 } 10645 } 10646 10647 /** 10648 * Faster version of setAlpha() which performs the same steps except there are 10649 * no calls to invalidate(). The caller of this function should perform proper invalidation 10650 * on the parent and this object. The return value indicates whether the subclass handles 10651 * alpha (the return value for onSetAlpha()). 10652 * 10653 * @param alpha The new value for the alpha property 10654 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 10655 * the new value for the alpha property is different from the old value 10656 */ 10657 boolean setAlphaNoInvalidation(float alpha) { 10658 ensureTransformationInfo(); 10659 if (mTransformationInfo.mAlpha != alpha) { 10660 mTransformationInfo.mAlpha = alpha; 10661 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 10662 if (subclassHandlesAlpha) { 10663 mPrivateFlags |= PFLAG_ALPHA_SET; 10664 return true; 10665 } else { 10666 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10667 mRenderNode.setAlpha(getFinalAlpha()); 10668 } 10669 } 10670 return false; 10671 } 10672 10673 /** 10674 * This property is hidden and intended only for use by the Fade transition, which 10675 * animates it to produce a visual translucency that does not side-effect (or get 10676 * affected by) the real alpha property. This value is composited with the other 10677 * alpha value (and the AlphaAnimation value, when that is present) to produce 10678 * a final visual translucency result, which is what is passed into the DisplayList. 10679 * 10680 * @hide 10681 */ 10682 public void setTransitionAlpha(float alpha) { 10683 ensureTransformationInfo(); 10684 if (mTransformationInfo.mTransitionAlpha != alpha) { 10685 mTransformationInfo.mTransitionAlpha = alpha; 10686 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10687 invalidateViewProperty(true, false); 10688 mRenderNode.setAlpha(getFinalAlpha()); 10689 } 10690 } 10691 10692 /** 10693 * Calculates the visual alpha of this view, which is a combination of the actual 10694 * alpha value and the transitionAlpha value (if set). 10695 */ 10696 private float getFinalAlpha() { 10697 if (mTransformationInfo != null) { 10698 return mTransformationInfo.mAlpha * mTransformationInfo.mTransitionAlpha; 10699 } 10700 return 1; 10701 } 10702 10703 /** 10704 * This property is hidden and intended only for use by the Fade transition, which 10705 * animates it to produce a visual translucency that does not side-effect (or get 10706 * affected by) the real alpha property. This value is composited with the other 10707 * alpha value (and the AlphaAnimation value, when that is present) to produce 10708 * a final visual translucency result, which is what is passed into the DisplayList. 10709 * 10710 * @hide 10711 */ 10712 @ViewDebug.ExportedProperty(category = "drawing") 10713 public float getTransitionAlpha() { 10714 return mTransformationInfo != null ? mTransformationInfo.mTransitionAlpha : 1; 10715 } 10716 10717 /** 10718 * Top position of this view relative to its parent. 10719 * 10720 * @return The top of this view, in pixels. 10721 */ 10722 @ViewDebug.CapturedViewProperty 10723 public final int getTop() { 10724 return mTop; 10725 } 10726 10727 /** 10728 * Sets the top position of this view relative to its parent. This method is meant to be called 10729 * by the layout system and should not generally be called otherwise, because the property 10730 * may be changed at any time by the layout. 10731 * 10732 * @param top The top of this view, in pixels. 10733 */ 10734 public final void setTop(int top) { 10735 if (top != mTop) { 10736 final boolean matrixIsIdentity = hasIdentityMatrix(); 10737 if (matrixIsIdentity) { 10738 if (mAttachInfo != null) { 10739 int minTop; 10740 int yLoc; 10741 if (top < mTop) { 10742 minTop = top; 10743 yLoc = top - mTop; 10744 } else { 10745 minTop = mTop; 10746 yLoc = 0; 10747 } 10748 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 10749 } 10750 } else { 10751 // Double-invalidation is necessary to capture view's old and new areas 10752 invalidate(true); 10753 } 10754 10755 int width = mRight - mLeft; 10756 int oldHeight = mBottom - mTop; 10757 10758 mTop = top; 10759 mRenderNode.setTop(mTop); 10760 10761 sizeChange(width, mBottom - mTop, width, oldHeight); 10762 10763 if (!matrixIsIdentity) { 10764 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10765 invalidate(true); 10766 } 10767 mBackgroundSizeChanged = true; 10768 invalidateParentIfNeeded(); 10769 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10770 // View was rejected last time it was drawn by its parent; this may have changed 10771 invalidateParentIfNeeded(); 10772 } 10773 } 10774 } 10775 10776 /** 10777 * Bottom position of this view relative to its parent. 10778 * 10779 * @return The bottom of this view, in pixels. 10780 */ 10781 @ViewDebug.CapturedViewProperty 10782 public final int getBottom() { 10783 return mBottom; 10784 } 10785 10786 /** 10787 * True if this view has changed since the last time being drawn. 10788 * 10789 * @return The dirty state of this view. 10790 */ 10791 public boolean isDirty() { 10792 return (mPrivateFlags & PFLAG_DIRTY_MASK) != 0; 10793 } 10794 10795 /** 10796 * Sets the bottom position of this view relative to its parent. This method is meant to be 10797 * called by the layout system and should not generally be called otherwise, because the 10798 * property may be changed at any time by the layout. 10799 * 10800 * @param bottom The bottom of this view, in pixels. 10801 */ 10802 public final void setBottom(int bottom) { 10803 if (bottom != mBottom) { 10804 final boolean matrixIsIdentity = hasIdentityMatrix(); 10805 if (matrixIsIdentity) { 10806 if (mAttachInfo != null) { 10807 int maxBottom; 10808 if (bottom < mBottom) { 10809 maxBottom = mBottom; 10810 } else { 10811 maxBottom = bottom; 10812 } 10813 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 10814 } 10815 } else { 10816 // Double-invalidation is necessary to capture view's old and new areas 10817 invalidate(true); 10818 } 10819 10820 int width = mRight - mLeft; 10821 int oldHeight = mBottom - mTop; 10822 10823 mBottom = bottom; 10824 mRenderNode.setBottom(mBottom); 10825 10826 sizeChange(width, mBottom - mTop, width, oldHeight); 10827 10828 if (!matrixIsIdentity) { 10829 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10830 invalidate(true); 10831 } 10832 mBackgroundSizeChanged = true; 10833 invalidateParentIfNeeded(); 10834 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10835 // View was rejected last time it was drawn by its parent; this may have changed 10836 invalidateParentIfNeeded(); 10837 } 10838 } 10839 } 10840 10841 /** 10842 * Left position of this view relative to its parent. 10843 * 10844 * @return The left edge of this view, in pixels. 10845 */ 10846 @ViewDebug.CapturedViewProperty 10847 public final int getLeft() { 10848 return mLeft; 10849 } 10850 10851 /** 10852 * Sets the left position of this view relative to its parent. This method is meant to be called 10853 * by the layout system and should not generally be called otherwise, because the property 10854 * may be changed at any time by the layout. 10855 * 10856 * @param left The left of this view, in pixels. 10857 */ 10858 public final void setLeft(int left) { 10859 if (left != mLeft) { 10860 final boolean matrixIsIdentity = hasIdentityMatrix(); 10861 if (matrixIsIdentity) { 10862 if (mAttachInfo != null) { 10863 int minLeft; 10864 int xLoc; 10865 if (left < mLeft) { 10866 minLeft = left; 10867 xLoc = left - mLeft; 10868 } else { 10869 minLeft = mLeft; 10870 xLoc = 0; 10871 } 10872 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 10873 } 10874 } else { 10875 // Double-invalidation is necessary to capture view's old and new areas 10876 invalidate(true); 10877 } 10878 10879 int oldWidth = mRight - mLeft; 10880 int height = mBottom - mTop; 10881 10882 mLeft = left; 10883 mRenderNode.setLeft(left); 10884 10885 sizeChange(mRight - mLeft, height, oldWidth, height); 10886 10887 if (!matrixIsIdentity) { 10888 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10889 invalidate(true); 10890 } 10891 mBackgroundSizeChanged = true; 10892 invalidateParentIfNeeded(); 10893 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10894 // View was rejected last time it was drawn by its parent; this may have changed 10895 invalidateParentIfNeeded(); 10896 } 10897 } 10898 } 10899 10900 /** 10901 * Right position of this view relative to its parent. 10902 * 10903 * @return The right edge of this view, in pixels. 10904 */ 10905 @ViewDebug.CapturedViewProperty 10906 public final int getRight() { 10907 return mRight; 10908 } 10909 10910 /** 10911 * Sets the right position of this view relative to its parent. This method is meant to be called 10912 * by the layout system and should not generally be called otherwise, because the property 10913 * may be changed at any time by the layout. 10914 * 10915 * @param right The right of this view, in pixels. 10916 */ 10917 public final void setRight(int right) { 10918 if (right != mRight) { 10919 final boolean matrixIsIdentity = hasIdentityMatrix(); 10920 if (matrixIsIdentity) { 10921 if (mAttachInfo != null) { 10922 int maxRight; 10923 if (right < mRight) { 10924 maxRight = mRight; 10925 } else { 10926 maxRight = right; 10927 } 10928 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 10929 } 10930 } else { 10931 // Double-invalidation is necessary to capture view's old and new areas 10932 invalidate(true); 10933 } 10934 10935 int oldWidth = mRight - mLeft; 10936 int height = mBottom - mTop; 10937 10938 mRight = right; 10939 mRenderNode.setRight(mRight); 10940 10941 sizeChange(mRight - mLeft, height, oldWidth, height); 10942 10943 if (!matrixIsIdentity) { 10944 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10945 invalidate(true); 10946 } 10947 mBackgroundSizeChanged = true; 10948 invalidateParentIfNeeded(); 10949 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10950 // View was rejected last time it was drawn by its parent; this may have changed 10951 invalidateParentIfNeeded(); 10952 } 10953 } 10954 } 10955 10956 /** 10957 * The visual x position of this view, in pixels. This is equivalent to the 10958 * {@link #setTranslationX(float) translationX} property plus the current 10959 * {@link #getLeft() left} property. 10960 * 10961 * @return The visual x position of this view, in pixels. 10962 */ 10963 @ViewDebug.ExportedProperty(category = "drawing") 10964 public float getX() { 10965 return mLeft + getTranslationX(); 10966 } 10967 10968 /** 10969 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 10970 * {@link #setTranslationX(float) translationX} property to be the difference between 10971 * the x value passed in and the current {@link #getLeft() left} property. 10972 * 10973 * @param x The visual x position of this view, in pixels. 10974 */ 10975 public void setX(float x) { 10976 setTranslationX(x - mLeft); 10977 } 10978 10979 /** 10980 * The visual y position of this view, in pixels. This is equivalent to the 10981 * {@link #setTranslationY(float) translationY} property plus the current 10982 * {@link #getTop() top} property. 10983 * 10984 * @return The visual y position of this view, in pixels. 10985 */ 10986 @ViewDebug.ExportedProperty(category = "drawing") 10987 public float getY() { 10988 return mTop + getTranslationY(); 10989 } 10990 10991 /** 10992 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 10993 * {@link #setTranslationY(float) translationY} property to be the difference between 10994 * the y value passed in and the current {@link #getTop() top} property. 10995 * 10996 * @param y The visual y position of this view, in pixels. 10997 */ 10998 public void setY(float y) { 10999 setTranslationY(y - mTop); 11000 } 11001 11002 /** 11003 * The visual z position of this view, in pixels. This is equivalent to the 11004 * {@link #setTranslationZ(float) translationZ} property plus the current 11005 * {@link #getElevation() elevation} property. 11006 * 11007 * @return The visual z position of this view, in pixels. 11008 */ 11009 @ViewDebug.ExportedProperty(category = "drawing") 11010 public float getZ() { 11011 return getElevation() + getTranslationZ(); 11012 } 11013 11014 /** 11015 * Sets the visual z position of this view, in pixels. This is equivalent to setting the 11016 * {@link #setTranslationZ(float) translationZ} property to be the difference between 11017 * the x value passed in and the current {@link #getElevation() elevation} property. 11018 * 11019 * @param z The visual z position of this view, in pixels. 11020 */ 11021 public void setZ(float z) { 11022 setTranslationZ(z - getElevation()); 11023 } 11024 11025 /** 11026 * The base elevation of this view relative to its parent, in pixels. 11027 * 11028 * @return The base depth position of the view, in pixels. 11029 */ 11030 @ViewDebug.ExportedProperty(category = "drawing") 11031 public float getElevation() { 11032 return mRenderNode.getElevation(); 11033 } 11034 11035 /** 11036 * Sets the base elevation of this view, in pixels. 11037 * 11038 * @attr ref android.R.styleable#View_elevation 11039 */ 11040 public void setElevation(float elevation) { 11041 if (elevation != getElevation()) { 11042 invalidateViewProperty(true, false); 11043 mRenderNode.setElevation(elevation); 11044 invalidateViewProperty(false, true); 11045 11046 invalidateParentIfNeededAndWasQuickRejected(); 11047 } 11048 } 11049 11050 /** 11051 * The horizontal location of this view relative to its {@link #getLeft() left} position. 11052 * This position is post-layout, in addition to wherever the object's 11053 * layout placed it. 11054 * 11055 * @return The horizontal position of this view relative to its left position, in pixels. 11056 */ 11057 @ViewDebug.ExportedProperty(category = "drawing") 11058 public float getTranslationX() { 11059 return mRenderNode.getTranslationX(); 11060 } 11061 11062 /** 11063 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 11064 * This effectively positions the object post-layout, in addition to wherever the object's 11065 * layout placed it. 11066 * 11067 * @param translationX The horizontal position of this view relative to its left position, 11068 * in pixels. 11069 * 11070 * @attr ref android.R.styleable#View_translationX 11071 */ 11072 public void setTranslationX(float translationX) { 11073 if (translationX != getTranslationX()) { 11074 invalidateViewProperty(true, false); 11075 mRenderNode.setTranslationX(translationX); 11076 invalidateViewProperty(false, true); 11077 11078 invalidateParentIfNeededAndWasQuickRejected(); 11079 notifySubtreeAccessibilityStateChangedIfNeeded(); 11080 } 11081 } 11082 11083 /** 11084 * The vertical location of this view relative to its {@link #getTop() top} position. 11085 * This position is post-layout, in addition to wherever the object's 11086 * layout placed it. 11087 * 11088 * @return The vertical position of this view relative to its top position, 11089 * in pixels. 11090 */ 11091 @ViewDebug.ExportedProperty(category = "drawing") 11092 public float getTranslationY() { 11093 return mRenderNode.getTranslationY(); 11094 } 11095 11096 /** 11097 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 11098 * This effectively positions the object post-layout, in addition to wherever the object's 11099 * layout placed it. 11100 * 11101 * @param translationY The vertical position of this view relative to its top position, 11102 * in pixels. 11103 * 11104 * @attr ref android.R.styleable#View_translationY 11105 */ 11106 public void setTranslationY(float translationY) { 11107 if (translationY != getTranslationY()) { 11108 invalidateViewProperty(true, false); 11109 mRenderNode.setTranslationY(translationY); 11110 invalidateViewProperty(false, true); 11111 11112 invalidateParentIfNeededAndWasQuickRejected(); 11113 } 11114 } 11115 11116 /** 11117 * The depth location of this view relative to its {@link #getElevation() elevation}. 11118 * 11119 * @return The depth of this view relative to its elevation. 11120 */ 11121 @ViewDebug.ExportedProperty(category = "drawing") 11122 public float getTranslationZ() { 11123 return mRenderNode.getTranslationZ(); 11124 } 11125 11126 /** 11127 * Sets the depth location of this view relative to its {@link #getElevation() elevation}. 11128 * 11129 * @attr ref android.R.styleable#View_translationZ 11130 */ 11131 public void setTranslationZ(float translationZ) { 11132 if (translationZ != getTranslationZ()) { 11133 invalidateViewProperty(true, false); 11134 mRenderNode.setTranslationZ(translationZ); 11135 invalidateViewProperty(false, true); 11136 11137 invalidateParentIfNeededAndWasQuickRejected(); 11138 } 11139 } 11140 11141 /** @hide */ 11142 public void setAnimationMatrix(Matrix matrix) { 11143 invalidateViewProperty(true, false); 11144 mRenderNode.setAnimationMatrix(matrix); 11145 invalidateViewProperty(false, true); 11146 11147 invalidateParentIfNeededAndWasQuickRejected(); 11148 } 11149 11150 /** 11151 * Returns the current StateListAnimator if exists. 11152 * 11153 * @return StateListAnimator or null if it does not exists 11154 * @see #setStateListAnimator(android.animation.StateListAnimator) 11155 */ 11156 public StateListAnimator getStateListAnimator() { 11157 return mStateListAnimator; 11158 } 11159 11160 /** 11161 * Attaches the provided StateListAnimator to this View. 11162 * <p> 11163 * Any previously attached StateListAnimator will be detached. 11164 * 11165 * @param stateListAnimator The StateListAnimator to update the view 11166 * @see {@link android.animation.StateListAnimator} 11167 */ 11168 public void setStateListAnimator(StateListAnimator stateListAnimator) { 11169 if (mStateListAnimator == stateListAnimator) { 11170 return; 11171 } 11172 if (mStateListAnimator != null) { 11173 mStateListAnimator.setTarget(null); 11174 } 11175 mStateListAnimator = stateListAnimator; 11176 if (stateListAnimator != null) { 11177 stateListAnimator.setTarget(this); 11178 if (isAttachedToWindow()) { 11179 stateListAnimator.setState(getDrawableState()); 11180 } 11181 } 11182 } 11183 11184 /** 11185 * Returns whether the Outline should be used to clip the contents of the View. 11186 * <p> 11187 * Note that this flag will only be respected if the View's Outline returns true from 11188 * {@link Outline#canClip()}. 11189 * 11190 * @see #setOutlineProvider(ViewOutlineProvider) 11191 * @see #setClipToOutline(boolean) 11192 */ 11193 public final boolean getClipToOutline() { 11194 return mRenderNode.getClipToOutline(); 11195 } 11196 11197 /** 11198 * Sets whether the View's Outline should be used to clip the contents of the View. 11199 * <p> 11200 * Only a single non-rectangular clip can be applied on a View at any time. 11201 * Circular clips from a {@link ViewAnimationUtils#createCircularReveal(View, int, int, float, float) 11202 * circular reveal} animation take priority over Outline clipping, and 11203 * child Outline clipping takes priority over Outline clipping done by a 11204 * parent. 11205 * <p> 11206 * Note that this flag will only be respected if the View's Outline returns true from 11207 * {@link Outline#canClip()}. 11208 * 11209 * @see #setOutlineProvider(ViewOutlineProvider) 11210 * @see #getClipToOutline() 11211 */ 11212 public void setClipToOutline(boolean clipToOutline) { 11213 damageInParent(); 11214 if (getClipToOutline() != clipToOutline) { 11215 mRenderNode.setClipToOutline(clipToOutline); 11216 } 11217 } 11218 11219 // correspond to the enum values of View_outlineProvider 11220 private static final int PROVIDER_BACKGROUND = 0; 11221 private static final int PROVIDER_NONE = 1; 11222 private static final int PROVIDER_BOUNDS = 2; 11223 private static final int PROVIDER_PADDED_BOUNDS = 3; 11224 private void setOutlineProviderFromAttribute(int providerInt) { 11225 switch (providerInt) { 11226 case PROVIDER_BACKGROUND: 11227 setOutlineProvider(ViewOutlineProvider.BACKGROUND); 11228 break; 11229 case PROVIDER_NONE: 11230 setOutlineProvider(null); 11231 break; 11232 case PROVIDER_BOUNDS: 11233 setOutlineProvider(ViewOutlineProvider.BOUNDS); 11234 break; 11235 case PROVIDER_PADDED_BOUNDS: 11236 setOutlineProvider(ViewOutlineProvider.PADDED_BOUNDS); 11237 break; 11238 } 11239 } 11240 11241 /** 11242 * Sets the {@link ViewOutlineProvider} of the view, which generates the Outline that defines 11243 * the shape of the shadow it casts, and enables outline clipping. 11244 * <p> 11245 * The default ViewOutlineProvider, {@link ViewOutlineProvider#BACKGROUND}, queries the Outline 11246 * from the View's background drawable, via {@link Drawable#getOutline(Outline)}. Changing the 11247 * outline provider with this method allows this behavior to be overridden. 11248 * <p> 11249 * If the ViewOutlineProvider is null, if querying it for an outline returns false, 11250 * or if the produced Outline is {@link Outline#isEmpty()}, shadows will not be cast. 11251 * <p> 11252 * Only outlines that return true from {@link Outline#canClip()} may be used for clipping. 11253 * 11254 * @see #setClipToOutline(boolean) 11255 * @see #getClipToOutline() 11256 * @see #getOutlineProvider() 11257 */ 11258 public void setOutlineProvider(ViewOutlineProvider provider) { 11259 mOutlineProvider = provider; 11260 invalidateOutline(); 11261 } 11262 11263 /** 11264 * Returns the current {@link ViewOutlineProvider} of the view, which generates the Outline 11265 * that defines the shape of the shadow it casts, and enables outline clipping. 11266 * 11267 * @see #setOutlineProvider(ViewOutlineProvider) 11268 */ 11269 public ViewOutlineProvider getOutlineProvider() { 11270 return mOutlineProvider; 11271 } 11272 11273 /** 11274 * Called to rebuild this View's Outline from its {@link ViewOutlineProvider outline provider} 11275 * 11276 * @see #setOutlineProvider(ViewOutlineProvider) 11277 */ 11278 public void invalidateOutline() { 11279 rebuildOutline(); 11280 11281 notifySubtreeAccessibilityStateChangedIfNeeded(); 11282 invalidateViewProperty(false, false); 11283 } 11284 11285 /** 11286 * Internal version of {@link #invalidateOutline()} which invalidates the 11287 * outline without invalidating the view itself. This is intended to be called from 11288 * within methods in the View class itself which are the result of the view being 11289 * invalidated already. For example, when we are drawing the background of a View, 11290 * we invalidate the outline in case it changed in the meantime, but we do not 11291 * need to invalidate the view because we're already drawing the background as part 11292 * of drawing the view in response to an earlier invalidation of the view. 11293 */ 11294 private void rebuildOutline() { 11295 // Unattached views ignore this signal, and outline is recomputed in onAttachedToWindow() 11296 if (mAttachInfo == null) return; 11297 11298 if (mOutlineProvider == null) { 11299 // no provider, remove outline 11300 mRenderNode.setOutline(null); 11301 } else { 11302 final Outline outline = mAttachInfo.mTmpOutline; 11303 outline.setEmpty(); 11304 outline.setAlpha(1.0f); 11305 11306 mOutlineProvider.getOutline(this, outline); 11307 mRenderNode.setOutline(outline); 11308 } 11309 } 11310 11311 /** 11312 * HierarchyViewer only 11313 * 11314 * @hide 11315 */ 11316 @ViewDebug.ExportedProperty(category = "drawing") 11317 public boolean hasShadow() { 11318 return mRenderNode.hasShadow(); 11319 } 11320 11321 11322 /** @hide */ 11323 public void setRevealClip(boolean shouldClip, float x, float y, float radius) { 11324 mRenderNode.setRevealClip(shouldClip, x, y, radius); 11325 invalidateViewProperty(false, false); 11326 } 11327 11328 /** 11329 * Hit rectangle in parent's coordinates 11330 * 11331 * @param outRect The hit rectangle of the view. 11332 */ 11333 public void getHitRect(Rect outRect) { 11334 if (hasIdentityMatrix() || mAttachInfo == null) { 11335 outRect.set(mLeft, mTop, mRight, mBottom); 11336 } else { 11337 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 11338 tmpRect.set(0, 0, getWidth(), getHeight()); 11339 getMatrix().mapRect(tmpRect); // TODO: mRenderNode.mapRect(tmpRect) 11340 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 11341 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 11342 } 11343 } 11344 11345 /** 11346 * Determines whether the given point, in local coordinates is inside the view. 11347 */ 11348 /*package*/ final boolean pointInView(float localX, float localY) { 11349 return localX >= 0 && localX < (mRight - mLeft) 11350 && localY >= 0 && localY < (mBottom - mTop); 11351 } 11352 11353 /** 11354 * Utility method to determine whether the given point, in local coordinates, 11355 * is inside the view, where the area of the view is expanded by the slop factor. 11356 * This method is called while processing touch-move events to determine if the event 11357 * is still within the view. 11358 * 11359 * @hide 11360 */ 11361 public boolean pointInView(float localX, float localY, float slop) { 11362 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 11363 localY < ((mBottom - mTop) + slop); 11364 } 11365 11366 /** 11367 * When a view has focus and the user navigates away from it, the next view is searched for 11368 * starting from the rectangle filled in by this method. 11369 * 11370 * By default, the rectangle is the {@link #getDrawingRect(android.graphics.Rect)}) 11371 * of the view. However, if your view maintains some idea of internal selection, 11372 * such as a cursor, or a selected row or column, you should override this method and 11373 * fill in a more specific rectangle. 11374 * 11375 * @param r The rectangle to fill in, in this view's coordinates. 11376 */ 11377 public void getFocusedRect(Rect r) { 11378 getDrawingRect(r); 11379 } 11380 11381 /** 11382 * If some part of this view is not clipped by any of its parents, then 11383 * return that area in r in global (root) coordinates. To convert r to local 11384 * coordinates (without taking possible View rotations into account), offset 11385 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 11386 * If the view is completely clipped or translated out, return false. 11387 * 11388 * @param r If true is returned, r holds the global coordinates of the 11389 * visible portion of this view. 11390 * @param globalOffset If true is returned, globalOffset holds the dx,dy 11391 * between this view and its root. globalOffet may be null. 11392 * @return true if r is non-empty (i.e. part of the view is visible at the 11393 * root level. 11394 */ 11395 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 11396 int width = mRight - mLeft; 11397 int height = mBottom - mTop; 11398 if (width > 0 && height > 0) { 11399 r.set(0, 0, width, height); 11400 if (globalOffset != null) { 11401 globalOffset.set(-mScrollX, -mScrollY); 11402 } 11403 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 11404 } 11405 return false; 11406 } 11407 11408 public final boolean getGlobalVisibleRect(Rect r) { 11409 return getGlobalVisibleRect(r, null); 11410 } 11411 11412 public final boolean getLocalVisibleRect(Rect r) { 11413 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point(); 11414 if (getGlobalVisibleRect(r, offset)) { 11415 r.offset(-offset.x, -offset.y); // make r local 11416 return true; 11417 } 11418 return false; 11419 } 11420 11421 /** 11422 * Offset this view's vertical location by the specified number of pixels. 11423 * 11424 * @param offset the number of pixels to offset the view by 11425 */ 11426 public void offsetTopAndBottom(int offset) { 11427 if (offset != 0) { 11428 final boolean matrixIsIdentity = hasIdentityMatrix(); 11429 if (matrixIsIdentity) { 11430 if (isHardwareAccelerated()) { 11431 invalidateViewProperty(false, false); 11432 } else { 11433 final ViewParent p = mParent; 11434 if (p != null && mAttachInfo != null) { 11435 final Rect r = mAttachInfo.mTmpInvalRect; 11436 int minTop; 11437 int maxBottom; 11438 int yLoc; 11439 if (offset < 0) { 11440 minTop = mTop + offset; 11441 maxBottom = mBottom; 11442 yLoc = offset; 11443 } else { 11444 minTop = mTop; 11445 maxBottom = mBottom + offset; 11446 yLoc = 0; 11447 } 11448 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 11449 p.invalidateChild(this, r); 11450 } 11451 } 11452 } else { 11453 invalidateViewProperty(false, false); 11454 } 11455 11456 mTop += offset; 11457 mBottom += offset; 11458 mRenderNode.offsetTopAndBottom(offset); 11459 if (isHardwareAccelerated()) { 11460 invalidateViewProperty(false, false); 11461 } else { 11462 if (!matrixIsIdentity) { 11463 invalidateViewProperty(false, true); 11464 } 11465 invalidateParentIfNeeded(); 11466 } 11467 notifySubtreeAccessibilityStateChangedIfNeeded(); 11468 } 11469 } 11470 11471 /** 11472 * Offset this view's horizontal location by the specified amount of pixels. 11473 * 11474 * @param offset the number of pixels to offset the view by 11475 */ 11476 public void offsetLeftAndRight(int offset) { 11477 if (offset != 0) { 11478 final boolean matrixIsIdentity = hasIdentityMatrix(); 11479 if (matrixIsIdentity) { 11480 if (isHardwareAccelerated()) { 11481 invalidateViewProperty(false, false); 11482 } else { 11483 final ViewParent p = mParent; 11484 if (p != null && mAttachInfo != null) { 11485 final Rect r = mAttachInfo.mTmpInvalRect; 11486 int minLeft; 11487 int maxRight; 11488 if (offset < 0) { 11489 minLeft = mLeft + offset; 11490 maxRight = mRight; 11491 } else { 11492 minLeft = mLeft; 11493 maxRight = mRight + offset; 11494 } 11495 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 11496 p.invalidateChild(this, r); 11497 } 11498 } 11499 } else { 11500 invalidateViewProperty(false, false); 11501 } 11502 11503 mLeft += offset; 11504 mRight += offset; 11505 mRenderNode.offsetLeftAndRight(offset); 11506 if (isHardwareAccelerated()) { 11507 invalidateViewProperty(false, false); 11508 } else { 11509 if (!matrixIsIdentity) { 11510 invalidateViewProperty(false, true); 11511 } 11512 invalidateParentIfNeeded(); 11513 } 11514 notifySubtreeAccessibilityStateChangedIfNeeded(); 11515 } 11516 } 11517 11518 /** 11519 * Get the LayoutParams associated with this view. All views should have 11520 * layout parameters. These supply parameters to the <i>parent</i> of this 11521 * view specifying how it should be arranged. There are many subclasses of 11522 * ViewGroup.LayoutParams, and these correspond to the different subclasses 11523 * of ViewGroup that are responsible for arranging their children. 11524 * 11525 * This method may return null if this View is not attached to a parent 11526 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 11527 * was not invoked successfully. When a View is attached to a parent 11528 * ViewGroup, this method must not return null. 11529 * 11530 * @return The LayoutParams associated with this view, or null if no 11531 * parameters have been set yet 11532 */ 11533 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 11534 public ViewGroup.LayoutParams getLayoutParams() { 11535 return mLayoutParams; 11536 } 11537 11538 /** 11539 * Set the layout parameters associated with this view. These supply 11540 * parameters to the <i>parent</i> of this view specifying how it should be 11541 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 11542 * correspond to the different subclasses of ViewGroup that are responsible 11543 * for arranging their children. 11544 * 11545 * @param params The layout parameters for this view, cannot be null 11546 */ 11547 public void setLayoutParams(ViewGroup.LayoutParams params) { 11548 if (params == null) { 11549 throw new NullPointerException("Layout parameters cannot be null"); 11550 } 11551 mLayoutParams = params; 11552 resolveLayoutParams(); 11553 if (mParent instanceof ViewGroup) { 11554 ((ViewGroup) mParent).onSetLayoutParams(this, params); 11555 } 11556 requestLayout(); 11557 } 11558 11559 /** 11560 * Resolve the layout parameters depending on the resolved layout direction 11561 * 11562 * @hide 11563 */ 11564 public void resolveLayoutParams() { 11565 if (mLayoutParams != null) { 11566 mLayoutParams.resolveLayoutDirection(getLayoutDirection()); 11567 } 11568 } 11569 11570 /** 11571 * Set the scrolled position of your view. This will cause a call to 11572 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11573 * invalidated. 11574 * @param x the x position to scroll to 11575 * @param y the y position to scroll to 11576 */ 11577 public void scrollTo(int x, int y) { 11578 if (mScrollX != x || mScrollY != y) { 11579 int oldX = mScrollX; 11580 int oldY = mScrollY; 11581 mScrollX = x; 11582 mScrollY = y; 11583 invalidateParentCaches(); 11584 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 11585 if (!awakenScrollBars()) { 11586 postInvalidateOnAnimation(); 11587 } 11588 } 11589 } 11590 11591 /** 11592 * Move the scrolled position of your view. This will cause a call to 11593 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11594 * invalidated. 11595 * @param x the amount of pixels to scroll by horizontally 11596 * @param y the amount of pixels to scroll by vertically 11597 */ 11598 public void scrollBy(int x, int y) { 11599 scrollTo(mScrollX + x, mScrollY + y); 11600 } 11601 11602 /** 11603 * <p>Trigger the scrollbars to draw. When invoked this method starts an 11604 * animation to fade the scrollbars out after a default delay. If a subclass 11605 * provides animated scrolling, the start delay should equal the duration 11606 * of the scrolling animation.</p> 11607 * 11608 * <p>The animation starts only if at least one of the scrollbars is 11609 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 11610 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11611 * this method returns true, and false otherwise. If the animation is 11612 * started, this method calls {@link #invalidate()}; in that case the 11613 * caller should not call {@link #invalidate()}.</p> 11614 * 11615 * <p>This method should be invoked every time a subclass directly updates 11616 * the scroll parameters.</p> 11617 * 11618 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 11619 * and {@link #scrollTo(int, int)}.</p> 11620 * 11621 * @return true if the animation is played, false otherwise 11622 * 11623 * @see #awakenScrollBars(int) 11624 * @see #scrollBy(int, int) 11625 * @see #scrollTo(int, int) 11626 * @see #isHorizontalScrollBarEnabled() 11627 * @see #isVerticalScrollBarEnabled() 11628 * @see #setHorizontalScrollBarEnabled(boolean) 11629 * @see #setVerticalScrollBarEnabled(boolean) 11630 */ 11631 protected boolean awakenScrollBars() { 11632 return mScrollCache != null && 11633 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 11634 } 11635 11636 /** 11637 * Trigger the scrollbars to draw. 11638 * This method differs from awakenScrollBars() only in its default duration. 11639 * initialAwakenScrollBars() will show the scroll bars for longer than 11640 * usual to give the user more of a chance to notice them. 11641 * 11642 * @return true if the animation is played, false otherwise. 11643 */ 11644 private boolean initialAwakenScrollBars() { 11645 return mScrollCache != null && 11646 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 11647 } 11648 11649 /** 11650 * <p> 11651 * Trigger the scrollbars to draw. When invoked this method starts an 11652 * animation to fade the scrollbars out after a fixed delay. If a subclass 11653 * provides animated scrolling, the start delay should equal the duration of 11654 * the scrolling animation. 11655 * </p> 11656 * 11657 * <p> 11658 * The animation starts only if at least one of the scrollbars is enabled, 11659 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11660 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11661 * this method returns true, and false otherwise. If the animation is 11662 * started, this method calls {@link #invalidate()}; in that case the caller 11663 * should not call {@link #invalidate()}. 11664 * </p> 11665 * 11666 * <p> 11667 * This method should be invoked everytime a subclass directly updates the 11668 * scroll parameters. 11669 * </p> 11670 * 11671 * @param startDelay the delay, in milliseconds, after which the animation 11672 * should start; when the delay is 0, the animation starts 11673 * immediately 11674 * @return true if the animation is played, false otherwise 11675 * 11676 * @see #scrollBy(int, int) 11677 * @see #scrollTo(int, int) 11678 * @see #isHorizontalScrollBarEnabled() 11679 * @see #isVerticalScrollBarEnabled() 11680 * @see #setHorizontalScrollBarEnabled(boolean) 11681 * @see #setVerticalScrollBarEnabled(boolean) 11682 */ 11683 protected boolean awakenScrollBars(int startDelay) { 11684 return awakenScrollBars(startDelay, true); 11685 } 11686 11687 /** 11688 * <p> 11689 * Trigger the scrollbars to draw. When invoked this method starts an 11690 * animation to fade the scrollbars out after a fixed delay. If a subclass 11691 * provides animated scrolling, the start delay should equal the duration of 11692 * the scrolling animation. 11693 * </p> 11694 * 11695 * <p> 11696 * The animation starts only if at least one of the scrollbars is enabled, 11697 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11698 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11699 * this method returns true, and false otherwise. If the animation is 11700 * started, this method calls {@link #invalidate()} if the invalidate parameter 11701 * is set to true; in that case the caller 11702 * should not call {@link #invalidate()}. 11703 * </p> 11704 * 11705 * <p> 11706 * This method should be invoked everytime a subclass directly updates the 11707 * scroll parameters. 11708 * </p> 11709 * 11710 * @param startDelay the delay, in milliseconds, after which the animation 11711 * should start; when the delay is 0, the animation starts 11712 * immediately 11713 * 11714 * @param invalidate Wheter this method should call invalidate 11715 * 11716 * @return true if the animation is played, false otherwise 11717 * 11718 * @see #scrollBy(int, int) 11719 * @see #scrollTo(int, int) 11720 * @see #isHorizontalScrollBarEnabled() 11721 * @see #isVerticalScrollBarEnabled() 11722 * @see #setHorizontalScrollBarEnabled(boolean) 11723 * @see #setVerticalScrollBarEnabled(boolean) 11724 */ 11725 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 11726 final ScrollabilityCache scrollCache = mScrollCache; 11727 11728 if (scrollCache == null || !scrollCache.fadeScrollBars) { 11729 return false; 11730 } 11731 11732 if (scrollCache.scrollBar == null) { 11733 scrollCache.scrollBar = new ScrollBarDrawable(); 11734 } 11735 11736 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 11737 11738 if (invalidate) { 11739 // Invalidate to show the scrollbars 11740 postInvalidateOnAnimation(); 11741 } 11742 11743 if (scrollCache.state == ScrollabilityCache.OFF) { 11744 // FIXME: this is copied from WindowManagerService. 11745 // We should get this value from the system when it 11746 // is possible to do so. 11747 final int KEY_REPEAT_FIRST_DELAY = 750; 11748 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 11749 } 11750 11751 // Tell mScrollCache when we should start fading. This may 11752 // extend the fade start time if one was already scheduled 11753 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 11754 scrollCache.fadeStartTime = fadeStartTime; 11755 scrollCache.state = ScrollabilityCache.ON; 11756 11757 // Schedule our fader to run, unscheduling any old ones first 11758 if (mAttachInfo != null) { 11759 mAttachInfo.mHandler.removeCallbacks(scrollCache); 11760 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 11761 } 11762 11763 return true; 11764 } 11765 11766 return false; 11767 } 11768 11769 /** 11770 * Do not invalidate views which are not visible and which are not running an animation. They 11771 * will not get drawn and they should not set dirty flags as if they will be drawn 11772 */ 11773 private boolean skipInvalidate() { 11774 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 11775 (!(mParent instanceof ViewGroup) || 11776 !((ViewGroup) mParent).isViewTransitioning(this)); 11777 } 11778 11779 /** 11780 * Mark the area defined by dirty as needing to be drawn. If the view is 11781 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11782 * point in the future. 11783 * <p> 11784 * This must be called from a UI thread. To call from a non-UI thread, call 11785 * {@link #postInvalidate()}. 11786 * <p> 11787 * <b>WARNING:</b> In API 19 and below, this method may be destructive to 11788 * {@code dirty}. 11789 * 11790 * @param dirty the rectangle representing the bounds of the dirty region 11791 */ 11792 public void invalidate(Rect dirty) { 11793 final int scrollX = mScrollX; 11794 final int scrollY = mScrollY; 11795 invalidateInternal(dirty.left - scrollX, dirty.top - scrollY, 11796 dirty.right - scrollX, dirty.bottom - scrollY, true, false); 11797 } 11798 11799 /** 11800 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. The 11801 * coordinates of the dirty rect are relative to the view. If the view is 11802 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11803 * point in the future. 11804 * <p> 11805 * This must be called from a UI thread. To call from a non-UI thread, call 11806 * {@link #postInvalidate()}. 11807 * 11808 * @param l the left position of the dirty region 11809 * @param t the top position of the dirty region 11810 * @param r the right position of the dirty region 11811 * @param b the bottom position of the dirty region 11812 */ 11813 public void invalidate(int l, int t, int r, int b) { 11814 final int scrollX = mScrollX; 11815 final int scrollY = mScrollY; 11816 invalidateInternal(l - scrollX, t - scrollY, r - scrollX, b - scrollY, true, false); 11817 } 11818 11819 /** 11820 * Invalidate the whole view. If the view is visible, 11821 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 11822 * the future. 11823 * <p> 11824 * This must be called from a UI thread. To call from a non-UI thread, call 11825 * {@link #postInvalidate()}. 11826 */ 11827 public void invalidate() { 11828 invalidate(true); 11829 } 11830 11831 /** 11832 * This is where the invalidate() work actually happens. A full invalidate() 11833 * causes the drawing cache to be invalidated, but this function can be 11834 * called with invalidateCache set to false to skip that invalidation step 11835 * for cases that do not need it (for example, a component that remains at 11836 * the same dimensions with the same content). 11837 * 11838 * @param invalidateCache Whether the drawing cache for this view should be 11839 * invalidated as well. This is usually true for a full 11840 * invalidate, but may be set to false if the View's contents or 11841 * dimensions have not changed. 11842 */ 11843 void invalidate(boolean invalidateCache) { 11844 invalidateInternal(0, 0, mRight - mLeft, mBottom - mTop, invalidateCache, true); 11845 } 11846 11847 void invalidateInternal(int l, int t, int r, int b, boolean invalidateCache, 11848 boolean fullInvalidate) { 11849 if (mGhostView != null) { 11850 mGhostView.invalidate(true); 11851 return; 11852 } 11853 11854 if (skipInvalidate()) { 11855 return; 11856 } 11857 11858 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) 11859 || (invalidateCache && (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) 11860 || (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED 11861 || (fullInvalidate && isOpaque() != mLastIsOpaque)) { 11862 if (fullInvalidate) { 11863 mLastIsOpaque = isOpaque(); 11864 mPrivateFlags &= ~PFLAG_DRAWN; 11865 } 11866 11867 mPrivateFlags |= PFLAG_DIRTY; 11868 11869 if (invalidateCache) { 11870 mPrivateFlags |= PFLAG_INVALIDATED; 11871 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 11872 } 11873 11874 // Propagate the damage rectangle to the parent view. 11875 final AttachInfo ai = mAttachInfo; 11876 final ViewParent p = mParent; 11877 if (p != null && ai != null && l < r && t < b) { 11878 final Rect damage = ai.mTmpInvalRect; 11879 damage.set(l, t, r, b); 11880 p.invalidateChild(this, damage); 11881 } 11882 11883 // Damage the entire projection receiver, if necessary. 11884 if (mBackground != null && mBackground.isProjected()) { 11885 final View receiver = getProjectionReceiver(); 11886 if (receiver != null) { 11887 receiver.damageInParent(); 11888 } 11889 } 11890 11891 // Damage the entire IsolatedZVolume receiving this view's shadow. 11892 if (isHardwareAccelerated() && getZ() != 0) { 11893 damageShadowReceiver(); 11894 } 11895 } 11896 } 11897 11898 /** 11899 * @return this view's projection receiver, or {@code null} if none exists 11900 */ 11901 private View getProjectionReceiver() { 11902 ViewParent p = getParent(); 11903 while (p != null && p instanceof View) { 11904 final View v = (View) p; 11905 if (v.isProjectionReceiver()) { 11906 return v; 11907 } 11908 p = p.getParent(); 11909 } 11910 11911 return null; 11912 } 11913 11914 /** 11915 * @return whether the view is a projection receiver 11916 */ 11917 private boolean isProjectionReceiver() { 11918 return mBackground != null; 11919 } 11920 11921 /** 11922 * Damage area of the screen that can be covered by this View's shadow. 11923 * 11924 * This method will guarantee that any changes to shadows cast by a View 11925 * are damaged on the screen for future redraw. 11926 */ 11927 private void damageShadowReceiver() { 11928 final AttachInfo ai = mAttachInfo; 11929 if (ai != null) { 11930 ViewParent p = getParent(); 11931 if (p != null && p instanceof ViewGroup) { 11932 final ViewGroup vg = (ViewGroup) p; 11933 vg.damageInParent(); 11934 } 11935 } 11936 } 11937 11938 /** 11939 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to 11940 * set any flags or handle all of the cases handled by the default invalidation methods. 11941 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate 11942 * dirty rect. This method calls into fast invalidation methods in ViewGroup that 11943 * walk up the hierarchy, transforming the dirty rect as necessary. 11944 * 11945 * The method also handles normal invalidation logic if display list properties are not 11946 * being used in this view. The invalidateParent and forceRedraw flags are used by that 11947 * backup approach, to handle these cases used in the various property-setting methods. 11948 * 11949 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties 11950 * are not being used in this view 11951 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display 11952 * list properties are not being used in this view 11953 */ 11954 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) { 11955 if (!isHardwareAccelerated() 11956 || !mRenderNode.isValid() 11957 || (mPrivateFlags & PFLAG_DRAW_ANIMATION) != 0) { 11958 if (invalidateParent) { 11959 invalidateParentCaches(); 11960 } 11961 if (forceRedraw) { 11962 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 11963 } 11964 invalidate(false); 11965 } else { 11966 damageInParent(); 11967 } 11968 if (isHardwareAccelerated() && invalidateParent && getZ() != 0) { 11969 damageShadowReceiver(); 11970 } 11971 } 11972 11973 /** 11974 * Tells the parent view to damage this view's bounds. 11975 * 11976 * @hide 11977 */ 11978 protected void damageInParent() { 11979 final AttachInfo ai = mAttachInfo; 11980 final ViewParent p = mParent; 11981 if (p != null && ai != null) { 11982 final Rect r = ai.mTmpInvalRect; 11983 r.set(0, 0, mRight - mLeft, mBottom - mTop); 11984 if (mParent instanceof ViewGroup) { 11985 ((ViewGroup) mParent).damageChild(this, r); 11986 } else { 11987 mParent.invalidateChild(this, r); 11988 } 11989 } 11990 } 11991 11992 /** 11993 * Utility method to transform a given Rect by the current matrix of this view. 11994 */ 11995 void transformRect(final Rect rect) { 11996 if (!getMatrix().isIdentity()) { 11997 RectF boundingRect = mAttachInfo.mTmpTransformRect; 11998 boundingRect.set(rect); 11999 getMatrix().mapRect(boundingRect); 12000 rect.set((int) Math.floor(boundingRect.left), 12001 (int) Math.floor(boundingRect.top), 12002 (int) Math.ceil(boundingRect.right), 12003 (int) Math.ceil(boundingRect.bottom)); 12004 } 12005 } 12006 12007 /** 12008 * Used to indicate that the parent of this view should clear its caches. This functionality 12009 * is used to force the parent to rebuild its display list (when hardware-accelerated), 12010 * which is necessary when various parent-managed properties of the view change, such as 12011 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 12012 * clears the parent caches and does not causes an invalidate event. 12013 * 12014 * @hide 12015 */ 12016 protected void invalidateParentCaches() { 12017 if (mParent instanceof View) { 12018 ((View) mParent).mPrivateFlags |= PFLAG_INVALIDATED; 12019 } 12020 } 12021 12022 /** 12023 * Used to indicate that the parent of this view should be invalidated. This functionality 12024 * is used to force the parent to rebuild its display list (when hardware-accelerated), 12025 * which is necessary when various parent-managed properties of the view change, such as 12026 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 12027 * an invalidation event to the parent. 12028 * 12029 * @hide 12030 */ 12031 protected void invalidateParentIfNeeded() { 12032 if (isHardwareAccelerated() && mParent instanceof View) { 12033 ((View) mParent).invalidate(true); 12034 } 12035 } 12036 12037 /** 12038 * @hide 12039 */ 12040 protected void invalidateParentIfNeededAndWasQuickRejected() { 12041 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) != 0) { 12042 // View was rejected last time it was drawn by its parent; this may have changed 12043 invalidateParentIfNeeded(); 12044 } 12045 } 12046 12047 /** 12048 * Indicates whether this View is opaque. An opaque View guarantees that it will 12049 * draw all the pixels overlapping its bounds using a fully opaque color. 12050 * 12051 * Subclasses of View should override this method whenever possible to indicate 12052 * whether an instance is opaque. Opaque Views are treated in a special way by 12053 * the View hierarchy, possibly allowing it to perform optimizations during 12054 * invalidate/draw passes. 12055 * 12056 * @return True if this View is guaranteed to be fully opaque, false otherwise. 12057 */ 12058 @ViewDebug.ExportedProperty(category = "drawing") 12059 public boolean isOpaque() { 12060 return (mPrivateFlags & PFLAG_OPAQUE_MASK) == PFLAG_OPAQUE_MASK && 12061 getFinalAlpha() >= 1.0f; 12062 } 12063 12064 /** 12065 * @hide 12066 */ 12067 protected void computeOpaqueFlags() { 12068 // Opaque if: 12069 // - Has a background 12070 // - Background is opaque 12071 // - Doesn't have scrollbars or scrollbars overlay 12072 12073 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) { 12074 mPrivateFlags |= PFLAG_OPAQUE_BACKGROUND; 12075 } else { 12076 mPrivateFlags &= ~PFLAG_OPAQUE_BACKGROUND; 12077 } 12078 12079 final int flags = mViewFlags; 12080 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 12081 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY || 12082 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_OUTSIDE_OVERLAY) { 12083 mPrivateFlags |= PFLAG_OPAQUE_SCROLLBARS; 12084 } else { 12085 mPrivateFlags &= ~PFLAG_OPAQUE_SCROLLBARS; 12086 } 12087 } 12088 12089 /** 12090 * @hide 12091 */ 12092 protected boolean hasOpaqueScrollbars() { 12093 return (mPrivateFlags & PFLAG_OPAQUE_SCROLLBARS) == PFLAG_OPAQUE_SCROLLBARS; 12094 } 12095 12096 /** 12097 * @return A handler associated with the thread running the View. This 12098 * handler can be used to pump events in the UI events queue. 12099 */ 12100 public Handler getHandler() { 12101 final AttachInfo attachInfo = mAttachInfo; 12102 if (attachInfo != null) { 12103 return attachInfo.mHandler; 12104 } 12105 return null; 12106 } 12107 12108 /** 12109 * Gets the view root associated with the View. 12110 * @return The view root, or null if none. 12111 * @hide 12112 */ 12113 public ViewRootImpl getViewRootImpl() { 12114 if (mAttachInfo != null) { 12115 return mAttachInfo.mViewRootImpl; 12116 } 12117 return null; 12118 } 12119 12120 /** 12121 * @hide 12122 */ 12123 public HardwareRenderer getHardwareRenderer() { 12124 return mAttachInfo != null ? mAttachInfo.mHardwareRenderer : null; 12125 } 12126 12127 /** 12128 * <p>Causes the Runnable to be added to the message queue. 12129 * The runnable will be run on the user interface thread.</p> 12130 * 12131 * @param action The Runnable that will be executed. 12132 * 12133 * @return Returns true if the Runnable was successfully placed in to the 12134 * message queue. Returns false on failure, usually because the 12135 * looper processing the message queue is exiting. 12136 * 12137 * @see #postDelayed 12138 * @see #removeCallbacks 12139 */ 12140 public boolean post(Runnable action) { 12141 final AttachInfo attachInfo = mAttachInfo; 12142 if (attachInfo != null) { 12143 return attachInfo.mHandler.post(action); 12144 } 12145 // Assume that post will succeed later 12146 ViewRootImpl.getRunQueue().post(action); 12147 return true; 12148 } 12149 12150 /** 12151 * <p>Causes the Runnable to be added to the message queue, to be run 12152 * after the specified amount of time elapses. 12153 * The runnable will be run on the user interface thread.</p> 12154 * 12155 * @param action The Runnable that will be executed. 12156 * @param delayMillis The delay (in milliseconds) until the Runnable 12157 * will be executed. 12158 * 12159 * @return true if the Runnable was successfully placed in to the 12160 * message queue. Returns false on failure, usually because the 12161 * looper processing the message queue is exiting. Note that a 12162 * result of true does not mean the Runnable will be processed -- 12163 * if the looper is quit before the delivery time of the message 12164 * occurs then the message will be dropped. 12165 * 12166 * @see #post 12167 * @see #removeCallbacks 12168 */ 12169 public boolean postDelayed(Runnable action, long delayMillis) { 12170 final AttachInfo attachInfo = mAttachInfo; 12171 if (attachInfo != null) { 12172 return attachInfo.mHandler.postDelayed(action, delayMillis); 12173 } 12174 // Assume that post will succeed later 12175 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12176 return true; 12177 } 12178 12179 /** 12180 * <p>Causes the Runnable to execute on the next animation time step. 12181 * The runnable will be run on the user interface thread.</p> 12182 * 12183 * @param action The Runnable that will be executed. 12184 * 12185 * @see #postOnAnimationDelayed 12186 * @see #removeCallbacks 12187 */ 12188 public void postOnAnimation(Runnable action) { 12189 final AttachInfo attachInfo = mAttachInfo; 12190 if (attachInfo != null) { 12191 attachInfo.mViewRootImpl.mChoreographer.postCallback( 12192 Choreographer.CALLBACK_ANIMATION, action, null); 12193 } else { 12194 // Assume that post will succeed later 12195 ViewRootImpl.getRunQueue().post(action); 12196 } 12197 } 12198 12199 /** 12200 * <p>Causes the Runnable to execute on the next animation time step, 12201 * after the specified amount of time elapses. 12202 * The runnable will be run on the user interface thread.</p> 12203 * 12204 * @param action The Runnable that will be executed. 12205 * @param delayMillis The delay (in milliseconds) until the Runnable 12206 * will be executed. 12207 * 12208 * @see #postOnAnimation 12209 * @see #removeCallbacks 12210 */ 12211 public void postOnAnimationDelayed(Runnable action, long delayMillis) { 12212 final AttachInfo attachInfo = mAttachInfo; 12213 if (attachInfo != null) { 12214 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 12215 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis); 12216 } else { 12217 // Assume that post will succeed later 12218 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12219 } 12220 } 12221 12222 /** 12223 * <p>Removes the specified Runnable from the message queue.</p> 12224 * 12225 * @param action The Runnable to remove from the message handling queue 12226 * 12227 * @return true if this view could ask the Handler to remove the Runnable, 12228 * false otherwise. When the returned value is true, the Runnable 12229 * may or may not have been actually removed from the message queue 12230 * (for instance, if the Runnable was not in the queue already.) 12231 * 12232 * @see #post 12233 * @see #postDelayed 12234 * @see #postOnAnimation 12235 * @see #postOnAnimationDelayed 12236 */ 12237 public boolean removeCallbacks(Runnable action) { 12238 if (action != null) { 12239 final AttachInfo attachInfo = mAttachInfo; 12240 if (attachInfo != null) { 12241 attachInfo.mHandler.removeCallbacks(action); 12242 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 12243 Choreographer.CALLBACK_ANIMATION, action, null); 12244 } 12245 // Assume that post will succeed later 12246 ViewRootImpl.getRunQueue().removeCallbacks(action); 12247 } 12248 return true; 12249 } 12250 12251 /** 12252 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 12253 * Use this to invalidate the View from a non-UI thread.</p> 12254 * 12255 * <p>This method can be invoked from outside of the UI thread 12256 * only when this View is attached to a window.</p> 12257 * 12258 * @see #invalidate() 12259 * @see #postInvalidateDelayed(long) 12260 */ 12261 public void postInvalidate() { 12262 postInvalidateDelayed(0); 12263 } 12264 12265 /** 12266 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12267 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 12268 * 12269 * <p>This method can be invoked from outside of the UI thread 12270 * only when this View is attached to a window.</p> 12271 * 12272 * @param left The left coordinate of the rectangle to invalidate. 12273 * @param top The top coordinate of the rectangle to invalidate. 12274 * @param right The right coordinate of the rectangle to invalidate. 12275 * @param bottom The bottom coordinate of the rectangle to invalidate. 12276 * 12277 * @see #invalidate(int, int, int, int) 12278 * @see #invalidate(Rect) 12279 * @see #postInvalidateDelayed(long, int, int, int, int) 12280 */ 12281 public void postInvalidate(int left, int top, int right, int bottom) { 12282 postInvalidateDelayed(0, left, top, right, bottom); 12283 } 12284 12285 /** 12286 * <p>Cause an invalidate to happen on a subsequent cycle through the event 12287 * loop. Waits for the specified amount of time.</p> 12288 * 12289 * <p>This method can be invoked from outside of the UI thread 12290 * only when this View is attached to a window.</p> 12291 * 12292 * @param delayMilliseconds the duration in milliseconds to delay the 12293 * invalidation by 12294 * 12295 * @see #invalidate() 12296 * @see #postInvalidate() 12297 */ 12298 public void postInvalidateDelayed(long delayMilliseconds) { 12299 // We try only with the AttachInfo because there's no point in invalidating 12300 // if we are not attached to our window 12301 final AttachInfo attachInfo = mAttachInfo; 12302 if (attachInfo != null) { 12303 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds); 12304 } 12305 } 12306 12307 /** 12308 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12309 * through the event loop. Waits for the specified amount of time.</p> 12310 * 12311 * <p>This method can be invoked from outside of the UI thread 12312 * only when this View is attached to a window.</p> 12313 * 12314 * @param delayMilliseconds the duration in milliseconds to delay the 12315 * invalidation by 12316 * @param left The left coordinate of the rectangle to invalidate. 12317 * @param top The top coordinate of the rectangle to invalidate. 12318 * @param right The right coordinate of the rectangle to invalidate. 12319 * @param bottom The bottom coordinate of the rectangle to invalidate. 12320 * 12321 * @see #invalidate(int, int, int, int) 12322 * @see #invalidate(Rect) 12323 * @see #postInvalidate(int, int, int, int) 12324 */ 12325 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 12326 int right, int bottom) { 12327 12328 // We try only with the AttachInfo because there's no point in invalidating 12329 // if we are not attached to our window 12330 final AttachInfo attachInfo = mAttachInfo; 12331 if (attachInfo != null) { 12332 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12333 info.target = this; 12334 info.left = left; 12335 info.top = top; 12336 info.right = right; 12337 info.bottom = bottom; 12338 12339 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds); 12340 } 12341 } 12342 12343 /** 12344 * <p>Cause an invalidate to happen on the next animation time step, typically the 12345 * next display frame.</p> 12346 * 12347 * <p>This method can be invoked from outside of the UI thread 12348 * only when this View is attached to a window.</p> 12349 * 12350 * @see #invalidate() 12351 */ 12352 public void postInvalidateOnAnimation() { 12353 // We try only with the AttachInfo because there's no point in invalidating 12354 // if we are not attached to our window 12355 final AttachInfo attachInfo = mAttachInfo; 12356 if (attachInfo != null) { 12357 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this); 12358 } 12359 } 12360 12361 /** 12362 * <p>Cause an invalidate of the specified area to happen on the next animation 12363 * time step, typically the next display frame.</p> 12364 * 12365 * <p>This method can be invoked from outside of the UI thread 12366 * only when this View is attached to a window.</p> 12367 * 12368 * @param left The left coordinate of the rectangle to invalidate. 12369 * @param top The top coordinate of the rectangle to invalidate. 12370 * @param right The right coordinate of the rectangle to invalidate. 12371 * @param bottom The bottom coordinate of the rectangle to invalidate. 12372 * 12373 * @see #invalidate(int, int, int, int) 12374 * @see #invalidate(Rect) 12375 */ 12376 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) { 12377 // We try only with the AttachInfo because there's no point in invalidating 12378 // if we are not attached to our window 12379 final AttachInfo attachInfo = mAttachInfo; 12380 if (attachInfo != null) { 12381 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12382 info.target = this; 12383 info.left = left; 12384 info.top = top; 12385 info.right = right; 12386 info.bottom = bottom; 12387 12388 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info); 12389 } 12390 } 12391 12392 /** 12393 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 12394 * This event is sent at most once every 12395 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 12396 */ 12397 private void postSendViewScrolledAccessibilityEventCallback() { 12398 if (mSendViewScrolledAccessibilityEvent == null) { 12399 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 12400 } 12401 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 12402 mSendViewScrolledAccessibilityEvent.mIsPending = true; 12403 postDelayed(mSendViewScrolledAccessibilityEvent, 12404 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 12405 } 12406 } 12407 12408 /** 12409 * Called by a parent to request that a child update its values for mScrollX 12410 * and mScrollY if necessary. This will typically be done if the child is 12411 * animating a scroll using a {@link android.widget.Scroller Scroller} 12412 * object. 12413 */ 12414 public void computeScroll() { 12415 } 12416 12417 /** 12418 * <p>Indicate whether the horizontal edges are faded when the view is 12419 * scrolled horizontally.</p> 12420 * 12421 * @return true if the horizontal edges should are faded on scroll, false 12422 * otherwise 12423 * 12424 * @see #setHorizontalFadingEdgeEnabled(boolean) 12425 * 12426 * @attr ref android.R.styleable#View_requiresFadingEdge 12427 */ 12428 public boolean isHorizontalFadingEdgeEnabled() { 12429 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 12430 } 12431 12432 /** 12433 * <p>Define whether the horizontal edges should be faded when this view 12434 * is scrolled horizontally.</p> 12435 * 12436 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 12437 * be faded when the view is scrolled 12438 * horizontally 12439 * 12440 * @see #isHorizontalFadingEdgeEnabled() 12441 * 12442 * @attr ref android.R.styleable#View_requiresFadingEdge 12443 */ 12444 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 12445 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 12446 if (horizontalFadingEdgeEnabled) { 12447 initScrollCache(); 12448 } 12449 12450 mViewFlags ^= FADING_EDGE_HORIZONTAL; 12451 } 12452 } 12453 12454 /** 12455 * <p>Indicate whether the vertical edges are faded when the view is 12456 * scrolled horizontally.</p> 12457 * 12458 * @return true if the vertical edges should are faded on scroll, false 12459 * otherwise 12460 * 12461 * @see #setVerticalFadingEdgeEnabled(boolean) 12462 * 12463 * @attr ref android.R.styleable#View_requiresFadingEdge 12464 */ 12465 public boolean isVerticalFadingEdgeEnabled() { 12466 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 12467 } 12468 12469 /** 12470 * <p>Define whether the vertical edges should be faded when this view 12471 * is scrolled vertically.</p> 12472 * 12473 * @param verticalFadingEdgeEnabled true if the vertical edges should 12474 * be faded when the view is scrolled 12475 * vertically 12476 * 12477 * @see #isVerticalFadingEdgeEnabled() 12478 * 12479 * @attr ref android.R.styleable#View_requiresFadingEdge 12480 */ 12481 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 12482 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 12483 if (verticalFadingEdgeEnabled) { 12484 initScrollCache(); 12485 } 12486 12487 mViewFlags ^= FADING_EDGE_VERTICAL; 12488 } 12489 } 12490 12491 /** 12492 * Returns the strength, or intensity, of the top faded edge. The strength is 12493 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12494 * returns 0.0 or 1.0 but no value in between. 12495 * 12496 * Subclasses should override this method to provide a smoother fade transition 12497 * when scrolling occurs. 12498 * 12499 * @return the intensity of the top fade as a float between 0.0f and 1.0f 12500 */ 12501 protected float getTopFadingEdgeStrength() { 12502 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 12503 } 12504 12505 /** 12506 * Returns the strength, or intensity, of the bottom faded edge. The strength is 12507 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12508 * returns 0.0 or 1.0 but no value in between. 12509 * 12510 * Subclasses should override this method to provide a smoother fade transition 12511 * when scrolling occurs. 12512 * 12513 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 12514 */ 12515 protected float getBottomFadingEdgeStrength() { 12516 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 12517 computeVerticalScrollRange() ? 1.0f : 0.0f; 12518 } 12519 12520 /** 12521 * Returns the strength, or intensity, of the left faded edge. The strength is 12522 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12523 * returns 0.0 or 1.0 but no value in between. 12524 * 12525 * Subclasses should override this method to provide a smoother fade transition 12526 * when scrolling occurs. 12527 * 12528 * @return the intensity of the left fade as a float between 0.0f and 1.0f 12529 */ 12530 protected float getLeftFadingEdgeStrength() { 12531 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 12532 } 12533 12534 /** 12535 * Returns the strength, or intensity, of the right faded edge. The strength is 12536 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12537 * returns 0.0 or 1.0 but no value in between. 12538 * 12539 * Subclasses should override this method to provide a smoother fade transition 12540 * when scrolling occurs. 12541 * 12542 * @return the intensity of the right fade as a float between 0.0f and 1.0f 12543 */ 12544 protected float getRightFadingEdgeStrength() { 12545 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 12546 computeHorizontalScrollRange() ? 1.0f : 0.0f; 12547 } 12548 12549 /** 12550 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 12551 * scrollbar is not drawn by default.</p> 12552 * 12553 * @return true if the horizontal scrollbar should be painted, false 12554 * otherwise 12555 * 12556 * @see #setHorizontalScrollBarEnabled(boolean) 12557 */ 12558 public boolean isHorizontalScrollBarEnabled() { 12559 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12560 } 12561 12562 /** 12563 * <p>Define whether the horizontal scrollbar should be drawn or not. The 12564 * scrollbar is not drawn by default.</p> 12565 * 12566 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 12567 * be painted 12568 * 12569 * @see #isHorizontalScrollBarEnabled() 12570 */ 12571 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 12572 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 12573 mViewFlags ^= SCROLLBARS_HORIZONTAL; 12574 computeOpaqueFlags(); 12575 resolvePadding(); 12576 } 12577 } 12578 12579 /** 12580 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 12581 * scrollbar is not drawn by default.</p> 12582 * 12583 * @return true if the vertical scrollbar should be painted, false 12584 * otherwise 12585 * 12586 * @see #setVerticalScrollBarEnabled(boolean) 12587 */ 12588 public boolean isVerticalScrollBarEnabled() { 12589 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 12590 } 12591 12592 /** 12593 * <p>Define whether the vertical scrollbar should be drawn or not. The 12594 * scrollbar is not drawn by default.</p> 12595 * 12596 * @param verticalScrollBarEnabled true if the vertical scrollbar should 12597 * be painted 12598 * 12599 * @see #isVerticalScrollBarEnabled() 12600 */ 12601 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 12602 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 12603 mViewFlags ^= SCROLLBARS_VERTICAL; 12604 computeOpaqueFlags(); 12605 resolvePadding(); 12606 } 12607 } 12608 12609 /** 12610 * @hide 12611 */ 12612 protected void recomputePadding() { 12613 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 12614 } 12615 12616 /** 12617 * Define whether scrollbars will fade when the view is not scrolling. 12618 * 12619 * @param fadeScrollbars wheter to enable fading 12620 * 12621 * @attr ref android.R.styleable#View_fadeScrollbars 12622 */ 12623 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 12624 initScrollCache(); 12625 final ScrollabilityCache scrollabilityCache = mScrollCache; 12626 scrollabilityCache.fadeScrollBars = fadeScrollbars; 12627 if (fadeScrollbars) { 12628 scrollabilityCache.state = ScrollabilityCache.OFF; 12629 } else { 12630 scrollabilityCache.state = ScrollabilityCache.ON; 12631 } 12632 } 12633 12634 /** 12635 * 12636 * Returns true if scrollbars will fade when this view is not scrolling 12637 * 12638 * @return true if scrollbar fading is enabled 12639 * 12640 * @attr ref android.R.styleable#View_fadeScrollbars 12641 */ 12642 public boolean isScrollbarFadingEnabled() { 12643 return mScrollCache != null && mScrollCache.fadeScrollBars; 12644 } 12645 12646 /** 12647 * 12648 * Returns the delay before scrollbars fade. 12649 * 12650 * @return the delay before scrollbars fade 12651 * 12652 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12653 */ 12654 public int getScrollBarDefaultDelayBeforeFade() { 12655 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() : 12656 mScrollCache.scrollBarDefaultDelayBeforeFade; 12657 } 12658 12659 /** 12660 * Define the delay before scrollbars fade. 12661 * 12662 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade 12663 * 12664 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12665 */ 12666 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) { 12667 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade; 12668 } 12669 12670 /** 12671 * 12672 * Returns the scrollbar fade duration. 12673 * 12674 * @return the scrollbar fade duration 12675 * 12676 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12677 */ 12678 public int getScrollBarFadeDuration() { 12679 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() : 12680 mScrollCache.scrollBarFadeDuration; 12681 } 12682 12683 /** 12684 * Define the scrollbar fade duration. 12685 * 12686 * @param scrollBarFadeDuration - the scrollbar fade duration 12687 * 12688 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12689 */ 12690 public void setScrollBarFadeDuration(int scrollBarFadeDuration) { 12691 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration; 12692 } 12693 12694 /** 12695 * 12696 * Returns the scrollbar size. 12697 * 12698 * @return the scrollbar size 12699 * 12700 * @attr ref android.R.styleable#View_scrollbarSize 12701 */ 12702 public int getScrollBarSize() { 12703 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() : 12704 mScrollCache.scrollBarSize; 12705 } 12706 12707 /** 12708 * Define the scrollbar size. 12709 * 12710 * @param scrollBarSize - the scrollbar size 12711 * 12712 * @attr ref android.R.styleable#View_scrollbarSize 12713 */ 12714 public void setScrollBarSize(int scrollBarSize) { 12715 getScrollCache().scrollBarSize = scrollBarSize; 12716 } 12717 12718 /** 12719 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 12720 * inset. When inset, they add to the padding of the view. And the scrollbars 12721 * can be drawn inside the padding area or on the edge of the view. For example, 12722 * if a view has a background drawable and you want to draw the scrollbars 12723 * inside the padding specified by the drawable, you can use 12724 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 12725 * appear at the edge of the view, ignoring the padding, then you can use 12726 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 12727 * @param style the style of the scrollbars. Should be one of 12728 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 12729 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 12730 * @see #SCROLLBARS_INSIDE_OVERLAY 12731 * @see #SCROLLBARS_INSIDE_INSET 12732 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12733 * @see #SCROLLBARS_OUTSIDE_INSET 12734 * 12735 * @attr ref android.R.styleable#View_scrollbarStyle 12736 */ 12737 public void setScrollBarStyle(@ScrollBarStyle int style) { 12738 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 12739 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 12740 computeOpaqueFlags(); 12741 resolvePadding(); 12742 } 12743 } 12744 12745 /** 12746 * <p>Returns the current scrollbar style.</p> 12747 * @return the current scrollbar style 12748 * @see #SCROLLBARS_INSIDE_OVERLAY 12749 * @see #SCROLLBARS_INSIDE_INSET 12750 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12751 * @see #SCROLLBARS_OUTSIDE_INSET 12752 * 12753 * @attr ref android.R.styleable#View_scrollbarStyle 12754 */ 12755 @ViewDebug.ExportedProperty(mapping = { 12756 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 12757 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 12758 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 12759 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 12760 }) 12761 @ScrollBarStyle 12762 public int getScrollBarStyle() { 12763 return mViewFlags & SCROLLBARS_STYLE_MASK; 12764 } 12765 12766 /** 12767 * <p>Compute the horizontal range that the horizontal scrollbar 12768 * represents.</p> 12769 * 12770 * <p>The range is expressed in arbitrary units that must be the same as the 12771 * units used by {@link #computeHorizontalScrollExtent()} and 12772 * {@link #computeHorizontalScrollOffset()}.</p> 12773 * 12774 * <p>The default range is the drawing width of this view.</p> 12775 * 12776 * @return the total horizontal range represented by the horizontal 12777 * scrollbar 12778 * 12779 * @see #computeHorizontalScrollExtent() 12780 * @see #computeHorizontalScrollOffset() 12781 * @see android.widget.ScrollBarDrawable 12782 */ 12783 protected int computeHorizontalScrollRange() { 12784 return getWidth(); 12785 } 12786 12787 /** 12788 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 12789 * within the horizontal range. This value is used to compute the position 12790 * of the thumb within the scrollbar's track.</p> 12791 * 12792 * <p>The range is expressed in arbitrary units that must be the same as the 12793 * units used by {@link #computeHorizontalScrollRange()} and 12794 * {@link #computeHorizontalScrollExtent()}.</p> 12795 * 12796 * <p>The default offset is the scroll offset of this view.</p> 12797 * 12798 * @return the horizontal offset of the scrollbar's thumb 12799 * 12800 * @see #computeHorizontalScrollRange() 12801 * @see #computeHorizontalScrollExtent() 12802 * @see android.widget.ScrollBarDrawable 12803 */ 12804 protected int computeHorizontalScrollOffset() { 12805 return mScrollX; 12806 } 12807 12808 /** 12809 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 12810 * within the horizontal range. This value is used to compute the length 12811 * of the thumb within the scrollbar's track.</p> 12812 * 12813 * <p>The range is expressed in arbitrary units that must be the same as the 12814 * units used by {@link #computeHorizontalScrollRange()} and 12815 * {@link #computeHorizontalScrollOffset()}.</p> 12816 * 12817 * <p>The default extent is the drawing width of this view.</p> 12818 * 12819 * @return the horizontal extent of the scrollbar's thumb 12820 * 12821 * @see #computeHorizontalScrollRange() 12822 * @see #computeHorizontalScrollOffset() 12823 * @see android.widget.ScrollBarDrawable 12824 */ 12825 protected int computeHorizontalScrollExtent() { 12826 return getWidth(); 12827 } 12828 12829 /** 12830 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 12831 * 12832 * <p>The range is expressed in arbitrary units that must be the same as the 12833 * units used by {@link #computeVerticalScrollExtent()} and 12834 * {@link #computeVerticalScrollOffset()}.</p> 12835 * 12836 * @return the total vertical range represented by the vertical scrollbar 12837 * 12838 * <p>The default range is the drawing height of this view.</p> 12839 * 12840 * @see #computeVerticalScrollExtent() 12841 * @see #computeVerticalScrollOffset() 12842 * @see android.widget.ScrollBarDrawable 12843 */ 12844 protected int computeVerticalScrollRange() { 12845 return getHeight(); 12846 } 12847 12848 /** 12849 * <p>Compute the vertical offset of the vertical scrollbar's thumb 12850 * within the horizontal range. This value is used to compute the position 12851 * of the thumb within the scrollbar's track.</p> 12852 * 12853 * <p>The range is expressed in arbitrary units that must be the same as the 12854 * units used by {@link #computeVerticalScrollRange()} and 12855 * {@link #computeVerticalScrollExtent()}.</p> 12856 * 12857 * <p>The default offset is the scroll offset of this view.</p> 12858 * 12859 * @return the vertical offset of the scrollbar's thumb 12860 * 12861 * @see #computeVerticalScrollRange() 12862 * @see #computeVerticalScrollExtent() 12863 * @see android.widget.ScrollBarDrawable 12864 */ 12865 protected int computeVerticalScrollOffset() { 12866 return mScrollY; 12867 } 12868 12869 /** 12870 * <p>Compute the vertical extent of the vertical scrollbar's thumb 12871 * within the vertical range. This value is used to compute the length 12872 * of the thumb within the scrollbar's track.</p> 12873 * 12874 * <p>The range is expressed in arbitrary units that must be the same as the 12875 * units used by {@link #computeVerticalScrollRange()} and 12876 * {@link #computeVerticalScrollOffset()}.</p> 12877 * 12878 * <p>The default extent is the drawing height of this view.</p> 12879 * 12880 * @return the vertical extent of the scrollbar's thumb 12881 * 12882 * @see #computeVerticalScrollRange() 12883 * @see #computeVerticalScrollOffset() 12884 * @see android.widget.ScrollBarDrawable 12885 */ 12886 protected int computeVerticalScrollExtent() { 12887 return getHeight(); 12888 } 12889 12890 /** 12891 * Check if this view can be scrolled horizontally in a certain direction. 12892 * 12893 * @param direction Negative to check scrolling left, positive to check scrolling right. 12894 * @return true if this view can be scrolled in the specified direction, false otherwise. 12895 */ 12896 public boolean canScrollHorizontally(int direction) { 12897 final int offset = computeHorizontalScrollOffset(); 12898 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 12899 if (range == 0) return false; 12900 if (direction < 0) { 12901 return offset > 0; 12902 } else { 12903 return offset < range - 1; 12904 } 12905 } 12906 12907 /** 12908 * Check if this view can be scrolled vertically in a certain direction. 12909 * 12910 * @param direction Negative to check scrolling up, positive to check scrolling down. 12911 * @return true if this view can be scrolled in the specified direction, false otherwise. 12912 */ 12913 public boolean canScrollVertically(int direction) { 12914 final int offset = computeVerticalScrollOffset(); 12915 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 12916 if (range == 0) return false; 12917 if (direction < 0) { 12918 return offset > 0; 12919 } else { 12920 return offset < range - 1; 12921 } 12922 } 12923 12924 /** 12925 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 12926 * scrollbars are painted only if they have been awakened first.</p> 12927 * 12928 * @param canvas the canvas on which to draw the scrollbars 12929 * 12930 * @see #awakenScrollBars(int) 12931 */ 12932 protected final void onDrawScrollBars(Canvas canvas) { 12933 // scrollbars are drawn only when the animation is running 12934 final ScrollabilityCache cache = mScrollCache; 12935 if (cache != null) { 12936 12937 int state = cache.state; 12938 12939 if (state == ScrollabilityCache.OFF) { 12940 return; 12941 } 12942 12943 boolean invalidate = false; 12944 12945 if (state == ScrollabilityCache.FADING) { 12946 // We're fading -- get our fade interpolation 12947 if (cache.interpolatorValues == null) { 12948 cache.interpolatorValues = new float[1]; 12949 } 12950 12951 float[] values = cache.interpolatorValues; 12952 12953 // Stops the animation if we're done 12954 if (cache.scrollBarInterpolator.timeToValues(values) == 12955 Interpolator.Result.FREEZE_END) { 12956 cache.state = ScrollabilityCache.OFF; 12957 } else { 12958 cache.scrollBar.setAlpha(Math.round(values[0])); 12959 } 12960 12961 // This will make the scroll bars inval themselves after 12962 // drawing. We only want this when we're fading so that 12963 // we prevent excessive redraws 12964 invalidate = true; 12965 } else { 12966 // We're just on -- but we may have been fading before so 12967 // reset alpha 12968 cache.scrollBar.setAlpha(255); 12969 } 12970 12971 12972 final int viewFlags = mViewFlags; 12973 12974 final boolean drawHorizontalScrollBar = 12975 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12976 final boolean drawVerticalScrollBar = 12977 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 12978 && !isVerticalScrollBarHidden(); 12979 12980 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 12981 final int width = mRight - mLeft; 12982 final int height = mBottom - mTop; 12983 12984 final ScrollBarDrawable scrollBar = cache.scrollBar; 12985 12986 final int scrollX = mScrollX; 12987 final int scrollY = mScrollY; 12988 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 12989 12990 int left; 12991 int top; 12992 int right; 12993 int bottom; 12994 12995 if (drawHorizontalScrollBar) { 12996 int size = scrollBar.getSize(false); 12997 if (size <= 0) { 12998 size = cache.scrollBarSize; 12999 } 13000 13001 scrollBar.setParameters(computeHorizontalScrollRange(), 13002 computeHorizontalScrollOffset(), 13003 computeHorizontalScrollExtent(), false); 13004 final int verticalScrollBarGap = drawVerticalScrollBar ? 13005 getVerticalScrollbarWidth() : 0; 13006 top = scrollY + height - size - (mUserPaddingBottom & inside); 13007 left = scrollX + (mPaddingLeft & inside); 13008 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 13009 bottom = top + size; 13010 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 13011 if (invalidate) { 13012 invalidate(left, top, right, bottom); 13013 } 13014 } 13015 13016 if (drawVerticalScrollBar) { 13017 int size = scrollBar.getSize(true); 13018 if (size <= 0) { 13019 size = cache.scrollBarSize; 13020 } 13021 13022 scrollBar.setParameters(computeVerticalScrollRange(), 13023 computeVerticalScrollOffset(), 13024 computeVerticalScrollExtent(), true); 13025 int verticalScrollbarPosition = mVerticalScrollbarPosition; 13026 if (verticalScrollbarPosition == SCROLLBAR_POSITION_DEFAULT) { 13027 verticalScrollbarPosition = isLayoutRtl() ? 13028 SCROLLBAR_POSITION_LEFT : SCROLLBAR_POSITION_RIGHT; 13029 } 13030 switch (verticalScrollbarPosition) { 13031 default: 13032 case SCROLLBAR_POSITION_RIGHT: 13033 left = scrollX + width - size - (mUserPaddingRight & inside); 13034 break; 13035 case SCROLLBAR_POSITION_LEFT: 13036 left = scrollX + (mUserPaddingLeft & inside); 13037 break; 13038 } 13039 top = scrollY + (mPaddingTop & inside); 13040 right = left + size; 13041 bottom = scrollY + height - (mUserPaddingBottom & inside); 13042 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 13043 if (invalidate) { 13044 invalidate(left, top, right, bottom); 13045 } 13046 } 13047 } 13048 } 13049 } 13050 13051 /** 13052 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 13053 * FastScroller is visible. 13054 * @return whether to temporarily hide the vertical scrollbar 13055 * @hide 13056 */ 13057 protected boolean isVerticalScrollBarHidden() { 13058 return false; 13059 } 13060 13061 /** 13062 * <p>Draw the horizontal scrollbar if 13063 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 13064 * 13065 * @param canvas the canvas on which to draw the scrollbar 13066 * @param scrollBar the scrollbar's drawable 13067 * 13068 * @see #isHorizontalScrollBarEnabled() 13069 * @see #computeHorizontalScrollRange() 13070 * @see #computeHorizontalScrollExtent() 13071 * @see #computeHorizontalScrollOffset() 13072 * @see android.widget.ScrollBarDrawable 13073 * @hide 13074 */ 13075 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 13076 int l, int t, int r, int b) { 13077 scrollBar.setBounds(l, t, r, b); 13078 scrollBar.draw(canvas); 13079 } 13080 13081 /** 13082 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 13083 * returns true.</p> 13084 * 13085 * @param canvas the canvas on which to draw the scrollbar 13086 * @param scrollBar the scrollbar's drawable 13087 * 13088 * @see #isVerticalScrollBarEnabled() 13089 * @see #computeVerticalScrollRange() 13090 * @see #computeVerticalScrollExtent() 13091 * @see #computeVerticalScrollOffset() 13092 * @see android.widget.ScrollBarDrawable 13093 * @hide 13094 */ 13095 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 13096 int l, int t, int r, int b) { 13097 scrollBar.setBounds(l, t, r, b); 13098 scrollBar.draw(canvas); 13099 } 13100 13101 /** 13102 * Implement this to do your drawing. 13103 * 13104 * @param canvas the canvas on which the background will be drawn 13105 */ 13106 protected void onDraw(Canvas canvas) { 13107 } 13108 13109 /* 13110 * Caller is responsible for calling requestLayout if necessary. 13111 * (This allows addViewInLayout to not request a new layout.) 13112 */ 13113 void assignParent(ViewParent parent) { 13114 if (mParent == null) { 13115 mParent = parent; 13116 } else if (parent == null) { 13117 mParent = null; 13118 } else { 13119 throw new RuntimeException("view " + this + " being added, but" 13120 + " it already has a parent"); 13121 } 13122 } 13123 13124 /** 13125 * This is called when the view is attached to a window. At this point it 13126 * has a Surface and will start drawing. Note that this function is 13127 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 13128 * however it may be called any time before the first onDraw -- including 13129 * before or after {@link #onMeasure(int, int)}. 13130 * 13131 * @see #onDetachedFromWindow() 13132 */ 13133 protected void onAttachedToWindow() { 13134 if ((mPrivateFlags & PFLAG_REQUEST_TRANSPARENT_REGIONS) != 0) { 13135 mParent.requestTransparentRegion(this); 13136 } 13137 13138 if ((mPrivateFlags & PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 13139 initialAwakenScrollBars(); 13140 mPrivateFlags &= ~PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 13141 } 13142 13143 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13144 13145 jumpDrawablesToCurrentState(); 13146 13147 resetSubtreeAccessibilityStateChanged(); 13148 13149 // rebuild, since Outline not maintained while View is detached 13150 rebuildOutline(); 13151 13152 if (isFocused()) { 13153 InputMethodManager imm = InputMethodManager.peekInstance(); 13154 imm.focusIn(this); 13155 } 13156 } 13157 13158 /** 13159 * Resolve all RTL related properties. 13160 * 13161 * @return true if resolution of RTL properties has been done 13162 * 13163 * @hide 13164 */ 13165 public boolean resolveRtlPropertiesIfNeeded() { 13166 if (!needRtlPropertiesResolution()) return false; 13167 13168 // Order is important here: LayoutDirection MUST be resolved first 13169 if (!isLayoutDirectionResolved()) { 13170 resolveLayoutDirection(); 13171 resolveLayoutParams(); 13172 } 13173 // ... then we can resolve the others properties depending on the resolved LayoutDirection. 13174 if (!isTextDirectionResolved()) { 13175 resolveTextDirection(); 13176 } 13177 if (!isTextAlignmentResolved()) { 13178 resolveTextAlignment(); 13179 } 13180 // Should resolve Drawables before Padding because we need the layout direction of the 13181 // Drawable to correctly resolve Padding. 13182 if (!areDrawablesResolved()) { 13183 resolveDrawables(); 13184 } 13185 if (!isPaddingResolved()) { 13186 resolvePadding(); 13187 } 13188 onRtlPropertiesChanged(getLayoutDirection()); 13189 return true; 13190 } 13191 13192 /** 13193 * Reset resolution of all RTL related properties. 13194 * 13195 * @hide 13196 */ 13197 public void resetRtlProperties() { 13198 resetResolvedLayoutDirection(); 13199 resetResolvedTextDirection(); 13200 resetResolvedTextAlignment(); 13201 resetResolvedPadding(); 13202 resetResolvedDrawables(); 13203 } 13204 13205 /** 13206 * @see #onScreenStateChanged(int) 13207 */ 13208 void dispatchScreenStateChanged(int screenState) { 13209 onScreenStateChanged(screenState); 13210 } 13211 13212 /** 13213 * This method is called whenever the state of the screen this view is 13214 * attached to changes. A state change will usually occurs when the screen 13215 * turns on or off (whether it happens automatically or the user does it 13216 * manually.) 13217 * 13218 * @param screenState The new state of the screen. Can be either 13219 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF} 13220 */ 13221 public void onScreenStateChanged(int screenState) { 13222 } 13223 13224 /** 13225 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true 13226 */ 13227 private boolean hasRtlSupport() { 13228 return mContext.getApplicationInfo().hasRtlSupport(); 13229 } 13230 13231 /** 13232 * Return true if we are in RTL compatibility mode (either before Jelly Bean MR1 or 13233 * RTL not supported) 13234 */ 13235 private boolean isRtlCompatibilityMode() { 13236 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 13237 return targetSdkVersion < JELLY_BEAN_MR1 || !hasRtlSupport(); 13238 } 13239 13240 /** 13241 * @return true if RTL properties need resolution. 13242 * 13243 */ 13244 private boolean needRtlPropertiesResolution() { 13245 return (mPrivateFlags2 & ALL_RTL_PROPERTIES_RESOLVED) != ALL_RTL_PROPERTIES_RESOLVED; 13246 } 13247 13248 /** 13249 * Called when any RTL property (layout direction or text direction or text alignment) has 13250 * been changed. 13251 * 13252 * Subclasses need to override this method to take care of cached information that depends on the 13253 * resolved layout direction, or to inform child views that inherit their layout direction. 13254 * 13255 * The default implementation does nothing. 13256 * 13257 * @param layoutDirection the direction of the layout 13258 * 13259 * @see #LAYOUT_DIRECTION_LTR 13260 * @see #LAYOUT_DIRECTION_RTL 13261 */ 13262 public void onRtlPropertiesChanged(@ResolvedLayoutDir int layoutDirection) { 13263 } 13264 13265 /** 13266 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 13267 * that the parent directionality can and will be resolved before its children. 13268 * 13269 * @return true if resolution has been done, false otherwise. 13270 * 13271 * @hide 13272 */ 13273 public boolean resolveLayoutDirection() { 13274 // Clear any previous layout direction resolution 13275 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13276 13277 if (hasRtlSupport()) { 13278 // Set resolved depending on layout direction 13279 switch ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> 13280 PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) { 13281 case LAYOUT_DIRECTION_INHERIT: 13282 // We cannot resolve yet. LTR is by default and let the resolution happen again 13283 // later to get the correct resolved value 13284 if (!canResolveLayoutDirection()) return false; 13285 13286 // Parent has not yet resolved, LTR is still the default 13287 try { 13288 if (!mParent.isLayoutDirectionResolved()) return false; 13289 13290 if (mParent.getLayoutDirection() == LAYOUT_DIRECTION_RTL) { 13291 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13292 } 13293 } catch (AbstractMethodError e) { 13294 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13295 " does not fully implement ViewParent", e); 13296 } 13297 break; 13298 case LAYOUT_DIRECTION_RTL: 13299 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13300 break; 13301 case LAYOUT_DIRECTION_LOCALE: 13302 if((LAYOUT_DIRECTION_RTL == 13303 TextUtils.getLayoutDirectionFromLocale(Locale.getDefault()))) { 13304 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13305 } 13306 break; 13307 default: 13308 // Nothing to do, LTR by default 13309 } 13310 } 13311 13312 // Set to resolved 13313 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13314 return true; 13315 } 13316 13317 /** 13318 * Check if layout direction resolution can be done. 13319 * 13320 * @return true if layout direction resolution can be done otherwise return false. 13321 */ 13322 public boolean canResolveLayoutDirection() { 13323 switch (getRawLayoutDirection()) { 13324 case LAYOUT_DIRECTION_INHERIT: 13325 if (mParent != null) { 13326 try { 13327 return mParent.canResolveLayoutDirection(); 13328 } catch (AbstractMethodError e) { 13329 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13330 " does not fully implement ViewParent", e); 13331 } 13332 } 13333 return false; 13334 13335 default: 13336 return true; 13337 } 13338 } 13339 13340 /** 13341 * Reset the resolved layout direction. Layout direction will be resolved during a call to 13342 * {@link #onMeasure(int, int)}. 13343 * 13344 * @hide 13345 */ 13346 public void resetResolvedLayoutDirection() { 13347 // Reset the current resolved bits 13348 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13349 } 13350 13351 /** 13352 * @return true if the layout direction is inherited. 13353 * 13354 * @hide 13355 */ 13356 public boolean isLayoutDirectionInherited() { 13357 return (getRawLayoutDirection() == LAYOUT_DIRECTION_INHERIT); 13358 } 13359 13360 /** 13361 * @return true if layout direction has been resolved. 13362 */ 13363 public boolean isLayoutDirectionResolved() { 13364 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED) == PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13365 } 13366 13367 /** 13368 * Return if padding has been resolved 13369 * 13370 * @hide 13371 */ 13372 boolean isPaddingResolved() { 13373 return (mPrivateFlags2 & PFLAG2_PADDING_RESOLVED) == PFLAG2_PADDING_RESOLVED; 13374 } 13375 13376 /** 13377 * Resolves padding depending on layout direction, if applicable, and 13378 * recomputes internal padding values to adjust for scroll bars. 13379 * 13380 * @hide 13381 */ 13382 public void resolvePadding() { 13383 final int resolvedLayoutDirection = getLayoutDirection(); 13384 13385 if (!isRtlCompatibilityMode()) { 13386 // Post Jelly Bean MR1 case: we need to take the resolved layout direction into account. 13387 // If start / end padding are defined, they will be resolved (hence overriding) to 13388 // left / right or right / left depending on the resolved layout direction. 13389 // If start / end padding are not defined, use the left / right ones. 13390 if (mBackground != null && (!mLeftPaddingDefined || !mRightPaddingDefined)) { 13391 Rect padding = sThreadLocal.get(); 13392 if (padding == null) { 13393 padding = new Rect(); 13394 sThreadLocal.set(padding); 13395 } 13396 mBackground.getPadding(padding); 13397 if (!mLeftPaddingDefined) { 13398 mUserPaddingLeftInitial = padding.left; 13399 } 13400 if (!mRightPaddingDefined) { 13401 mUserPaddingRightInitial = padding.right; 13402 } 13403 } 13404 switch (resolvedLayoutDirection) { 13405 case LAYOUT_DIRECTION_RTL: 13406 if (mUserPaddingStart != UNDEFINED_PADDING) { 13407 mUserPaddingRight = mUserPaddingStart; 13408 } else { 13409 mUserPaddingRight = mUserPaddingRightInitial; 13410 } 13411 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13412 mUserPaddingLeft = mUserPaddingEnd; 13413 } else { 13414 mUserPaddingLeft = mUserPaddingLeftInitial; 13415 } 13416 break; 13417 case LAYOUT_DIRECTION_LTR: 13418 default: 13419 if (mUserPaddingStart != UNDEFINED_PADDING) { 13420 mUserPaddingLeft = mUserPaddingStart; 13421 } else { 13422 mUserPaddingLeft = mUserPaddingLeftInitial; 13423 } 13424 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13425 mUserPaddingRight = mUserPaddingEnd; 13426 } else { 13427 mUserPaddingRight = mUserPaddingRightInitial; 13428 } 13429 } 13430 13431 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 13432 } 13433 13434 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 13435 onRtlPropertiesChanged(resolvedLayoutDirection); 13436 13437 mPrivateFlags2 |= PFLAG2_PADDING_RESOLVED; 13438 } 13439 13440 /** 13441 * Reset the resolved layout direction. 13442 * 13443 * @hide 13444 */ 13445 public void resetResolvedPadding() { 13446 resetResolvedPaddingInternal(); 13447 } 13448 13449 /** 13450 * Used when we only want to reset *this* view's padding and not trigger overrides 13451 * in ViewGroup that reset children too. 13452 */ 13453 void resetResolvedPaddingInternal() { 13454 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED; 13455 } 13456 13457 /** 13458 * This is called when the view is detached from a window. At this point it 13459 * no longer has a surface for drawing. 13460 * 13461 * @see #onAttachedToWindow() 13462 */ 13463 protected void onDetachedFromWindow() { 13464 } 13465 13466 /** 13467 * This is a framework-internal mirror of onDetachedFromWindow() that's called 13468 * after onDetachedFromWindow(). 13469 * 13470 * If you override this you *MUST* call super.onDetachedFromWindowInternal()! 13471 * The super method should be called at the end of the overriden method to ensure 13472 * subclasses are destroyed first 13473 * 13474 * @hide 13475 */ 13476 protected void onDetachedFromWindowInternal() { 13477 mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT; 13478 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13479 13480 removeUnsetPressCallback(); 13481 removeLongPressCallback(); 13482 removePerformClickCallback(); 13483 removeSendViewScrolledAccessibilityEventCallback(); 13484 stopNestedScroll(); 13485 13486 // Anything that started animating right before detach should already 13487 // be in its final state when re-attached. 13488 jumpDrawablesToCurrentState(); 13489 13490 destroyDrawingCache(); 13491 13492 cleanupDraw(); 13493 mCurrentAnimation = null; 13494 } 13495 13496 private void cleanupDraw() { 13497 resetDisplayList(); 13498 if (mAttachInfo != null) { 13499 mAttachInfo.mViewRootImpl.cancelInvalidate(this); 13500 } 13501 } 13502 13503 void invalidateInheritedLayoutMode(int layoutModeOfRoot) { 13504 } 13505 13506 /** 13507 * @return The number of times this view has been attached to a window 13508 */ 13509 protected int getWindowAttachCount() { 13510 return mWindowAttachCount; 13511 } 13512 13513 /** 13514 * Retrieve a unique token identifying the window this view is attached to. 13515 * @return Return the window's token for use in 13516 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 13517 */ 13518 public IBinder getWindowToken() { 13519 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 13520 } 13521 13522 /** 13523 * Retrieve the {@link WindowId} for the window this view is 13524 * currently attached to. 13525 */ 13526 public WindowId getWindowId() { 13527 if (mAttachInfo == null) { 13528 return null; 13529 } 13530 if (mAttachInfo.mWindowId == null) { 13531 try { 13532 mAttachInfo.mIWindowId = mAttachInfo.mSession.getWindowId( 13533 mAttachInfo.mWindowToken); 13534 mAttachInfo.mWindowId = new WindowId( 13535 mAttachInfo.mIWindowId); 13536 } catch (RemoteException e) { 13537 } 13538 } 13539 return mAttachInfo.mWindowId; 13540 } 13541 13542 /** 13543 * Retrieve a unique token identifying the top-level "real" window of 13544 * the window that this view is attached to. That is, this is like 13545 * {@link #getWindowToken}, except if the window this view in is a panel 13546 * window (attached to another containing window), then the token of 13547 * the containing window is returned instead. 13548 * 13549 * @return Returns the associated window token, either 13550 * {@link #getWindowToken()} or the containing window's token. 13551 */ 13552 public IBinder getApplicationWindowToken() { 13553 AttachInfo ai = mAttachInfo; 13554 if (ai != null) { 13555 IBinder appWindowToken = ai.mPanelParentWindowToken; 13556 if (appWindowToken == null) { 13557 appWindowToken = ai.mWindowToken; 13558 } 13559 return appWindowToken; 13560 } 13561 return null; 13562 } 13563 13564 /** 13565 * Gets the logical display to which the view's window has been attached. 13566 * 13567 * @return The logical display, or null if the view is not currently attached to a window. 13568 */ 13569 public Display getDisplay() { 13570 return mAttachInfo != null ? mAttachInfo.mDisplay : null; 13571 } 13572 13573 /** 13574 * Retrieve private session object this view hierarchy is using to 13575 * communicate with the window manager. 13576 * @return the session object to communicate with the window manager 13577 */ 13578 /*package*/ IWindowSession getWindowSession() { 13579 return mAttachInfo != null ? mAttachInfo.mSession : null; 13580 } 13581 13582 /** 13583 * @param info the {@link android.view.View.AttachInfo} to associated with 13584 * this view 13585 */ 13586 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 13587 //System.out.println("Attached! " + this); 13588 mAttachInfo = info; 13589 if (mOverlay != null) { 13590 mOverlay.getOverlayView().dispatchAttachedToWindow(info, visibility); 13591 } 13592 mWindowAttachCount++; 13593 // We will need to evaluate the drawable state at least once. 13594 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 13595 if (mFloatingTreeObserver != null) { 13596 info.mTreeObserver.merge(mFloatingTreeObserver); 13597 mFloatingTreeObserver = null; 13598 } 13599 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER) != 0) { 13600 mAttachInfo.mScrollContainers.add(this); 13601 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 13602 } 13603 performCollectViewAttributes(mAttachInfo, visibility); 13604 onAttachedToWindow(); 13605 13606 ListenerInfo li = mListenerInfo; 13607 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13608 li != null ? li.mOnAttachStateChangeListeners : null; 13609 if (listeners != null && listeners.size() > 0) { 13610 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13611 // perform the dispatching. The iterator is a safe guard against listeners that 13612 // could mutate the list by calling the various add/remove methods. This prevents 13613 // the array from being modified while we iterate it. 13614 for (OnAttachStateChangeListener listener : listeners) { 13615 listener.onViewAttachedToWindow(this); 13616 } 13617 } 13618 13619 int vis = info.mWindowVisibility; 13620 if (vis != GONE) { 13621 onWindowVisibilityChanged(vis); 13622 } 13623 if ((mPrivateFlags&PFLAG_DRAWABLE_STATE_DIRTY) != 0) { 13624 // If nobody has evaluated the drawable state yet, then do it now. 13625 refreshDrawableState(); 13626 } 13627 needGlobalAttributesUpdate(false); 13628 } 13629 13630 void dispatchDetachedFromWindow() { 13631 AttachInfo info = mAttachInfo; 13632 if (info != null) { 13633 int vis = info.mWindowVisibility; 13634 if (vis != GONE) { 13635 onWindowVisibilityChanged(GONE); 13636 } 13637 } 13638 13639 onDetachedFromWindow(); 13640 onDetachedFromWindowInternal(); 13641 13642 ListenerInfo li = mListenerInfo; 13643 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13644 li != null ? li.mOnAttachStateChangeListeners : null; 13645 if (listeners != null && listeners.size() > 0) { 13646 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13647 // perform the dispatching. The iterator is a safe guard against listeners that 13648 // could mutate the list by calling the various add/remove methods. This prevents 13649 // the array from being modified while we iterate it. 13650 for (OnAttachStateChangeListener listener : listeners) { 13651 listener.onViewDetachedFromWindow(this); 13652 } 13653 } 13654 13655 if ((mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 13656 mAttachInfo.mScrollContainers.remove(this); 13657 mPrivateFlags &= ~PFLAG_SCROLL_CONTAINER_ADDED; 13658 } 13659 13660 mAttachInfo = null; 13661 if (mOverlay != null) { 13662 mOverlay.getOverlayView().dispatchDetachedFromWindow(); 13663 } 13664 } 13665 13666 /** 13667 * Cancel any deferred high-level input events that were previously posted to the event queue. 13668 * 13669 * <p>Many views post high-level events such as click handlers to the event queue 13670 * to run deferred in order to preserve a desired user experience - clearing visible 13671 * pressed states before executing, etc. This method will abort any events of this nature 13672 * that are currently in flight.</p> 13673 * 13674 * <p>Custom views that generate their own high-level deferred input events should override 13675 * {@link #onCancelPendingInputEvents()} and remove those pending events from the queue.</p> 13676 * 13677 * <p>This will also cancel pending input events for any child views.</p> 13678 * 13679 * <p>Note that this may not be sufficient as a debouncing strategy for clicks in all cases. 13680 * This will not impact newer events posted after this call that may occur as a result of 13681 * lower-level input events still waiting in the queue. If you are trying to prevent 13682 * double-submitted events for the duration of some sort of asynchronous transaction 13683 * you should also take other steps to protect against unexpected double inputs e.g. calling 13684 * {@link #setEnabled(boolean) setEnabled(false)} and re-enabling the view when 13685 * the transaction completes, tracking already submitted transaction IDs, etc.</p> 13686 */ 13687 public final void cancelPendingInputEvents() { 13688 dispatchCancelPendingInputEvents(); 13689 } 13690 13691 /** 13692 * Called by {@link #cancelPendingInputEvents()} to cancel input events in flight. 13693 * Overridden by ViewGroup to dispatch. Package scoped to prevent app-side meddling. 13694 */ 13695 void dispatchCancelPendingInputEvents() { 13696 mPrivateFlags3 &= ~PFLAG3_CALLED_SUPER; 13697 onCancelPendingInputEvents(); 13698 if ((mPrivateFlags3 & PFLAG3_CALLED_SUPER) != PFLAG3_CALLED_SUPER) { 13699 throw new SuperNotCalledException("View " + getClass().getSimpleName() + 13700 " did not call through to super.onCancelPendingInputEvents()"); 13701 } 13702 } 13703 13704 /** 13705 * Called as the result of a call to {@link #cancelPendingInputEvents()} on this view or 13706 * a parent view. 13707 * 13708 * <p>This method is responsible for removing any pending high-level input events that were 13709 * posted to the event queue to run later. Custom view classes that post their own deferred 13710 * high-level events via {@link #post(Runnable)}, {@link #postDelayed(Runnable, long)} or 13711 * {@link android.os.Handler} should override this method, call 13712 * <code>super.onCancelPendingInputEvents()</code> and remove those callbacks as appropriate. 13713 * </p> 13714 */ 13715 public void onCancelPendingInputEvents() { 13716 removePerformClickCallback(); 13717 cancelLongPress(); 13718 mPrivateFlags3 |= PFLAG3_CALLED_SUPER; 13719 } 13720 13721 /** 13722 * Store this view hierarchy's frozen state into the given container. 13723 * 13724 * @param container The SparseArray in which to save the view's state. 13725 * 13726 * @see #restoreHierarchyState(android.util.SparseArray) 13727 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13728 * @see #onSaveInstanceState() 13729 */ 13730 public void saveHierarchyState(SparseArray<Parcelable> container) { 13731 dispatchSaveInstanceState(container); 13732 } 13733 13734 /** 13735 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 13736 * this view and its children. May be overridden to modify how freezing happens to a 13737 * view's children; for example, some views may want to not store state for their children. 13738 * 13739 * @param container The SparseArray in which to save the view's state. 13740 * 13741 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13742 * @see #saveHierarchyState(android.util.SparseArray) 13743 * @see #onSaveInstanceState() 13744 */ 13745 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 13746 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 13747 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13748 Parcelable state = onSaveInstanceState(); 13749 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13750 throw new IllegalStateException( 13751 "Derived class did not call super.onSaveInstanceState()"); 13752 } 13753 if (state != null) { 13754 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 13755 // + ": " + state); 13756 container.put(mID, state); 13757 } 13758 } 13759 } 13760 13761 /** 13762 * Hook allowing a view to generate a representation of its internal state 13763 * that can later be used to create a new instance with that same state. 13764 * This state should only contain information that is not persistent or can 13765 * not be reconstructed later. For example, you will never store your 13766 * current position on screen because that will be computed again when a 13767 * new instance of the view is placed in its view hierarchy. 13768 * <p> 13769 * Some examples of things you may store here: the current cursor position 13770 * in a text view (but usually not the text itself since that is stored in a 13771 * content provider or other persistent storage), the currently selected 13772 * item in a list view. 13773 * 13774 * @return Returns a Parcelable object containing the view's current dynamic 13775 * state, or null if there is nothing interesting to save. The 13776 * default implementation returns null. 13777 * @see #onRestoreInstanceState(android.os.Parcelable) 13778 * @see #saveHierarchyState(android.util.SparseArray) 13779 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13780 * @see #setSaveEnabled(boolean) 13781 */ 13782 protected Parcelable onSaveInstanceState() { 13783 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13784 return BaseSavedState.EMPTY_STATE; 13785 } 13786 13787 /** 13788 * Restore this view hierarchy's frozen state from the given container. 13789 * 13790 * @param container The SparseArray which holds previously frozen states. 13791 * 13792 * @see #saveHierarchyState(android.util.SparseArray) 13793 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13794 * @see #onRestoreInstanceState(android.os.Parcelable) 13795 */ 13796 public void restoreHierarchyState(SparseArray<Parcelable> container) { 13797 dispatchRestoreInstanceState(container); 13798 } 13799 13800 /** 13801 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 13802 * state for this view and its children. May be overridden to modify how restoring 13803 * happens to a view's children; for example, some views may want to not store state 13804 * for their children. 13805 * 13806 * @param container The SparseArray which holds previously saved state. 13807 * 13808 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13809 * @see #restoreHierarchyState(android.util.SparseArray) 13810 * @see #onRestoreInstanceState(android.os.Parcelable) 13811 */ 13812 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 13813 if (mID != NO_ID) { 13814 Parcelable state = container.get(mID); 13815 if (state != null) { 13816 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 13817 // + ": " + state); 13818 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13819 onRestoreInstanceState(state); 13820 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13821 throw new IllegalStateException( 13822 "Derived class did not call super.onRestoreInstanceState()"); 13823 } 13824 } 13825 } 13826 } 13827 13828 /** 13829 * Hook allowing a view to re-apply a representation of its internal state that had previously 13830 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 13831 * null state. 13832 * 13833 * @param state The frozen state that had previously been returned by 13834 * {@link #onSaveInstanceState}. 13835 * 13836 * @see #onSaveInstanceState() 13837 * @see #restoreHierarchyState(android.util.SparseArray) 13838 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13839 */ 13840 protected void onRestoreInstanceState(Parcelable state) { 13841 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13842 if (state != BaseSavedState.EMPTY_STATE && state != null) { 13843 throw new IllegalArgumentException("Wrong state class, expecting View State but " 13844 + "received " + state.getClass().toString() + " instead. This usually happens " 13845 + "when two views of different type have the same id in the same hierarchy. " 13846 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 13847 + "other views do not use the same id."); 13848 } 13849 } 13850 13851 /** 13852 * <p>Return the time at which the drawing of the view hierarchy started.</p> 13853 * 13854 * @return the drawing start time in milliseconds 13855 */ 13856 public long getDrawingTime() { 13857 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 13858 } 13859 13860 /** 13861 * <p>Enables or disables the duplication of the parent's state into this view. When 13862 * duplication is enabled, this view gets its drawable state from its parent rather 13863 * than from its own internal properties.</p> 13864 * 13865 * <p>Note: in the current implementation, setting this property to true after the 13866 * view was added to a ViewGroup might have no effect at all. This property should 13867 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 13868 * 13869 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 13870 * property is enabled, an exception will be thrown.</p> 13871 * 13872 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 13873 * parent, these states should not be affected by this method.</p> 13874 * 13875 * @param enabled True to enable duplication of the parent's drawable state, false 13876 * to disable it. 13877 * 13878 * @see #getDrawableState() 13879 * @see #isDuplicateParentStateEnabled() 13880 */ 13881 public void setDuplicateParentStateEnabled(boolean enabled) { 13882 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 13883 } 13884 13885 /** 13886 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 13887 * 13888 * @return True if this view's drawable state is duplicated from the parent, 13889 * false otherwise 13890 * 13891 * @see #getDrawableState() 13892 * @see #setDuplicateParentStateEnabled(boolean) 13893 */ 13894 public boolean isDuplicateParentStateEnabled() { 13895 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 13896 } 13897 13898 /** 13899 * <p>Specifies the type of layer backing this view. The layer can be 13900 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13901 * {@link #LAYER_TYPE_HARDWARE}.</p> 13902 * 13903 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13904 * instance that controls how the layer is composed on screen. The following 13905 * properties of the paint are taken into account when composing the layer:</p> 13906 * <ul> 13907 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13908 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13909 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13910 * </ul> 13911 * 13912 * <p>If this view has an alpha value set to < 1.0 by calling 13913 * {@link #setAlpha(float)}, the alpha value of the layer's paint is superceded 13914 * by this view's alpha value.</p> 13915 * 13916 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE}, 13917 * {@link #LAYER_TYPE_SOFTWARE} and {@link #LAYER_TYPE_HARDWARE} 13918 * for more information on when and how to use layers.</p> 13919 * 13920 * @param layerType The type of layer to use with this view, must be one of 13921 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13922 * {@link #LAYER_TYPE_HARDWARE} 13923 * @param paint The paint used to compose the layer. This argument is optional 13924 * and can be null. It is ignored when the layer type is 13925 * {@link #LAYER_TYPE_NONE} 13926 * 13927 * @see #getLayerType() 13928 * @see #LAYER_TYPE_NONE 13929 * @see #LAYER_TYPE_SOFTWARE 13930 * @see #LAYER_TYPE_HARDWARE 13931 * @see #setAlpha(float) 13932 * 13933 * @attr ref android.R.styleable#View_layerType 13934 */ 13935 public void setLayerType(int layerType, Paint paint) { 13936 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 13937 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 13938 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 13939 } 13940 13941 boolean typeChanged = mRenderNode.setLayerType(layerType); 13942 13943 if (!typeChanged) { 13944 setLayerPaint(paint); 13945 return; 13946 } 13947 13948 // Destroy any previous software drawing cache if needed 13949 if (mLayerType == LAYER_TYPE_SOFTWARE) { 13950 destroyDrawingCache(); 13951 } 13952 13953 mLayerType = layerType; 13954 final boolean layerDisabled = (mLayerType == LAYER_TYPE_NONE); 13955 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 13956 mRenderNode.setLayerPaint(mLayerPaint); 13957 13958 // draw() behaves differently if we are on a layer, so we need to 13959 // invalidate() here 13960 invalidateParentCaches(); 13961 invalidate(true); 13962 } 13963 13964 /** 13965 * Updates the {@link Paint} object used with the current layer (used only if the current 13966 * layer type is not set to {@link #LAYER_TYPE_NONE}). Changed properties of the Paint 13967 * provided to {@link #setLayerType(int, android.graphics.Paint)} will be used the next time 13968 * the View is redrawn, but {@link #setLayerPaint(android.graphics.Paint)} must be called to 13969 * ensure that the view gets redrawn immediately. 13970 * 13971 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13972 * instance that controls how the layer is composed on screen. The following 13973 * properties of the paint are taken into account when composing the layer:</p> 13974 * <ul> 13975 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13976 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13977 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13978 * </ul> 13979 * 13980 * <p>If this view has an alpha value set to < 1.0 by calling {@link #setAlpha(float)}, the 13981 * alpha value of the layer's paint is superceded by this view's alpha value.</p> 13982 * 13983 * @param paint The paint used to compose the layer. This argument is optional 13984 * and can be null. It is ignored when the layer type is 13985 * {@link #LAYER_TYPE_NONE} 13986 * 13987 * @see #setLayerType(int, android.graphics.Paint) 13988 */ 13989 public void setLayerPaint(Paint paint) { 13990 int layerType = getLayerType(); 13991 if (layerType != LAYER_TYPE_NONE) { 13992 mLayerPaint = paint == null ? new Paint() : paint; 13993 if (layerType == LAYER_TYPE_HARDWARE) { 13994 if (mRenderNode.setLayerPaint(mLayerPaint)) { 13995 invalidateViewProperty(false, false); 13996 } 13997 } else { 13998 invalidate(); 13999 } 14000 } 14001 } 14002 14003 /** 14004 * Indicates whether this view has a static layer. A view with layer type 14005 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 14006 * dynamic. 14007 */ 14008 boolean hasStaticLayer() { 14009 return true; 14010 } 14011 14012 /** 14013 * Indicates what type of layer is currently associated with this view. By default 14014 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 14015 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 14016 * for more information on the different types of layers. 14017 * 14018 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 14019 * {@link #LAYER_TYPE_HARDWARE} 14020 * 14021 * @see #setLayerType(int, android.graphics.Paint) 14022 * @see #buildLayer() 14023 * @see #LAYER_TYPE_NONE 14024 * @see #LAYER_TYPE_SOFTWARE 14025 * @see #LAYER_TYPE_HARDWARE 14026 */ 14027 public int getLayerType() { 14028 return mLayerType; 14029 } 14030 14031 /** 14032 * Forces this view's layer to be created and this view to be rendered 14033 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 14034 * invoking this method will have no effect. 14035 * 14036 * This method can for instance be used to render a view into its layer before 14037 * starting an animation. If this view is complex, rendering into the layer 14038 * before starting the animation will avoid skipping frames. 14039 * 14040 * @throws IllegalStateException If this view is not attached to a window 14041 * 14042 * @see #setLayerType(int, android.graphics.Paint) 14043 */ 14044 public void buildLayer() { 14045 if (mLayerType == LAYER_TYPE_NONE) return; 14046 14047 final AttachInfo attachInfo = mAttachInfo; 14048 if (attachInfo == null) { 14049 throw new IllegalStateException("This view must be attached to a window first"); 14050 } 14051 14052 if (getWidth() == 0 || getHeight() == 0) { 14053 return; 14054 } 14055 14056 switch (mLayerType) { 14057 case LAYER_TYPE_HARDWARE: 14058 updateDisplayListIfDirty(); 14059 if (attachInfo.mHardwareRenderer != null && mRenderNode.isValid()) { 14060 attachInfo.mHardwareRenderer.buildLayer(mRenderNode); 14061 } 14062 break; 14063 case LAYER_TYPE_SOFTWARE: 14064 buildDrawingCache(true); 14065 break; 14066 } 14067 } 14068 14069 /** 14070 * If this View draws with a HardwareLayer, returns it. 14071 * Otherwise returns null 14072 * 14073 * TODO: Only TextureView uses this, can we eliminate it? 14074 */ 14075 HardwareLayer getHardwareLayer() { 14076 return null; 14077 } 14078 14079 /** 14080 * Destroys all hardware rendering resources. This method is invoked 14081 * when the system needs to reclaim resources. Upon execution of this 14082 * method, you should free any OpenGL resources created by the view. 14083 * 14084 * Note: you <strong>must</strong> call 14085 * <code>super.destroyHardwareResources()</code> when overriding 14086 * this method. 14087 * 14088 * @hide 14089 */ 14090 protected void destroyHardwareResources() { 14091 // Although the Layer will be destroyed by RenderNode, we want to release 14092 // the staging display list, which is also a signal to RenderNode that it's 14093 // safe to free its copy of the display list as it knows that we will 14094 // push an updated DisplayList if we try to draw again 14095 resetDisplayList(); 14096 } 14097 14098 /** 14099 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 14100 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 14101 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 14102 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 14103 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 14104 * null.</p> 14105 * 14106 * <p>Enabling the drawing cache is similar to 14107 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 14108 * acceleration is turned off. When hardware acceleration is turned on, enabling the 14109 * drawing cache has no effect on rendering because the system uses a different mechanism 14110 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 14111 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 14112 * for information on how to enable software and hardware layers.</p> 14113 * 14114 * <p>This API can be used to manually generate 14115 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 14116 * {@link #getDrawingCache()}.</p> 14117 * 14118 * @param enabled true to enable the drawing cache, false otherwise 14119 * 14120 * @see #isDrawingCacheEnabled() 14121 * @see #getDrawingCache() 14122 * @see #buildDrawingCache() 14123 * @see #setLayerType(int, android.graphics.Paint) 14124 */ 14125 public void setDrawingCacheEnabled(boolean enabled) { 14126 mCachingFailed = false; 14127 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 14128 } 14129 14130 /** 14131 * <p>Indicates whether the drawing cache is enabled for this view.</p> 14132 * 14133 * @return true if the drawing cache is enabled 14134 * 14135 * @see #setDrawingCacheEnabled(boolean) 14136 * @see #getDrawingCache() 14137 */ 14138 @ViewDebug.ExportedProperty(category = "drawing") 14139 public boolean isDrawingCacheEnabled() { 14140 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 14141 } 14142 14143 /** 14144 * Debugging utility which recursively outputs the dirty state of a view and its 14145 * descendants. 14146 * 14147 * @hide 14148 */ 14149 @SuppressWarnings({"UnusedDeclaration"}) 14150 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 14151 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.PFLAG_DIRTY_MASK) + 14152 ") DRAWN(" + (mPrivateFlags & PFLAG_DRAWN) + ")" + " CACHE_VALID(" + 14153 (mPrivateFlags & View.PFLAG_DRAWING_CACHE_VALID) + 14154 ") INVALIDATED(" + (mPrivateFlags & PFLAG_INVALIDATED) + ")"); 14155 if (clear) { 14156 mPrivateFlags &= clearMask; 14157 } 14158 if (this instanceof ViewGroup) { 14159 ViewGroup parent = (ViewGroup) this; 14160 final int count = parent.getChildCount(); 14161 for (int i = 0; i < count; i++) { 14162 final View child = parent.getChildAt(i); 14163 child.outputDirtyFlags(indent + " ", clear, clearMask); 14164 } 14165 } 14166 } 14167 14168 /** 14169 * This method is used by ViewGroup to cause its children to restore or recreate their 14170 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 14171 * to recreate its own display list, which would happen if it went through the normal 14172 * draw/dispatchDraw mechanisms. 14173 * 14174 * @hide 14175 */ 14176 protected void dispatchGetDisplayList() {} 14177 14178 /** 14179 * A view that is not attached or hardware accelerated cannot create a display list. 14180 * This method checks these conditions and returns the appropriate result. 14181 * 14182 * @return true if view has the ability to create a display list, false otherwise. 14183 * 14184 * @hide 14185 */ 14186 public boolean canHaveDisplayList() { 14187 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 14188 } 14189 14190 private void updateDisplayListIfDirty() { 14191 final RenderNode renderNode = mRenderNode; 14192 if (!canHaveDisplayList()) { 14193 // can't populate RenderNode, don't try 14194 return; 14195 } 14196 14197 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 14198 || !renderNode.isValid() 14199 || (mRecreateDisplayList)) { 14200 // Don't need to recreate the display list, just need to tell our 14201 // children to restore/recreate theirs 14202 if (renderNode.isValid() 14203 && !mRecreateDisplayList) { 14204 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14205 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14206 dispatchGetDisplayList(); 14207 14208 return; // no work needed 14209 } 14210 14211 // If we got here, we're recreating it. Mark it as such to ensure that 14212 // we copy in child display lists into ours in drawChild() 14213 mRecreateDisplayList = true; 14214 14215 int width = mRight - mLeft; 14216 int height = mBottom - mTop; 14217 int layerType = getLayerType(); 14218 14219 final HardwareCanvas canvas = renderNode.start(width, height); 14220 canvas.setHighContrastText(mAttachInfo.mHighContrastText); 14221 14222 try { 14223 final HardwareLayer layer = getHardwareLayer(); 14224 if (layer != null && layer.isValid()) { 14225 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint); 14226 } else if (layerType == LAYER_TYPE_SOFTWARE) { 14227 buildDrawingCache(true); 14228 Bitmap cache = getDrawingCache(true); 14229 if (cache != null) { 14230 canvas.drawBitmap(cache, 0, 0, mLayerPaint); 14231 } 14232 } else { 14233 computeScroll(); 14234 14235 canvas.translate(-mScrollX, -mScrollY); 14236 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14237 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14238 14239 // Fast path for layouts with no backgrounds 14240 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14241 dispatchDraw(canvas); 14242 if (mOverlay != null && !mOverlay.isEmpty()) { 14243 mOverlay.getOverlayView().draw(canvas); 14244 } 14245 } else { 14246 draw(canvas); 14247 } 14248 } 14249 } finally { 14250 renderNode.end(canvas); 14251 setDisplayListProperties(renderNode); 14252 } 14253 } else { 14254 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14255 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14256 } 14257 } 14258 14259 /** 14260 * Returns a RenderNode with View draw content recorded, which can be 14261 * used to draw this view again without executing its draw method. 14262 * 14263 * @return A RenderNode ready to replay, or null if caching is not enabled. 14264 * 14265 * @hide 14266 */ 14267 public RenderNode getDisplayList() { 14268 updateDisplayListIfDirty(); 14269 return mRenderNode; 14270 } 14271 14272 private void resetDisplayList() { 14273 if (mRenderNode.isValid()) { 14274 mRenderNode.destroyDisplayListData(); 14275 } 14276 14277 if (mBackgroundRenderNode != null && mBackgroundRenderNode.isValid()) { 14278 mBackgroundRenderNode.destroyDisplayListData(); 14279 } 14280 } 14281 14282 /** 14283 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 14284 * 14285 * @return A non-scaled bitmap representing this view or null if cache is disabled. 14286 * 14287 * @see #getDrawingCache(boolean) 14288 */ 14289 public Bitmap getDrawingCache() { 14290 return getDrawingCache(false); 14291 } 14292 14293 /** 14294 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 14295 * is null when caching is disabled. If caching is enabled and the cache is not ready, 14296 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 14297 * draw from the cache when the cache is enabled. To benefit from the cache, you must 14298 * request the drawing cache by calling this method and draw it on screen if the 14299 * returned bitmap is not null.</p> 14300 * 14301 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14302 * this method will create a bitmap of the same size as this view. Because this bitmap 14303 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14304 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14305 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14306 * size than the view. This implies that your application must be able to handle this 14307 * size.</p> 14308 * 14309 * @param autoScale Indicates whether the generated bitmap should be scaled based on 14310 * the current density of the screen when the application is in compatibility 14311 * mode. 14312 * 14313 * @return A bitmap representing this view or null if cache is disabled. 14314 * 14315 * @see #setDrawingCacheEnabled(boolean) 14316 * @see #isDrawingCacheEnabled() 14317 * @see #buildDrawingCache(boolean) 14318 * @see #destroyDrawingCache() 14319 */ 14320 public Bitmap getDrawingCache(boolean autoScale) { 14321 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 14322 return null; 14323 } 14324 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 14325 buildDrawingCache(autoScale); 14326 } 14327 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 14328 } 14329 14330 /** 14331 * <p>Frees the resources used by the drawing cache. If you call 14332 * {@link #buildDrawingCache()} manually without calling 14333 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14334 * should cleanup the cache with this method afterwards.</p> 14335 * 14336 * @see #setDrawingCacheEnabled(boolean) 14337 * @see #buildDrawingCache() 14338 * @see #getDrawingCache() 14339 */ 14340 public void destroyDrawingCache() { 14341 if (mDrawingCache != null) { 14342 mDrawingCache.recycle(); 14343 mDrawingCache = null; 14344 } 14345 if (mUnscaledDrawingCache != null) { 14346 mUnscaledDrawingCache.recycle(); 14347 mUnscaledDrawingCache = null; 14348 } 14349 } 14350 14351 /** 14352 * Setting a solid background color for the drawing cache's bitmaps will improve 14353 * performance and memory usage. Note, though that this should only be used if this 14354 * view will always be drawn on top of a solid color. 14355 * 14356 * @param color The background color to use for the drawing cache's bitmap 14357 * 14358 * @see #setDrawingCacheEnabled(boolean) 14359 * @see #buildDrawingCache() 14360 * @see #getDrawingCache() 14361 */ 14362 public void setDrawingCacheBackgroundColor(int color) { 14363 if (color != mDrawingCacheBackgroundColor) { 14364 mDrawingCacheBackgroundColor = color; 14365 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 14366 } 14367 } 14368 14369 /** 14370 * @see #setDrawingCacheBackgroundColor(int) 14371 * 14372 * @return The background color to used for the drawing cache's bitmap 14373 */ 14374 public int getDrawingCacheBackgroundColor() { 14375 return mDrawingCacheBackgroundColor; 14376 } 14377 14378 /** 14379 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 14380 * 14381 * @see #buildDrawingCache(boolean) 14382 */ 14383 public void buildDrawingCache() { 14384 buildDrawingCache(false); 14385 } 14386 14387 /** 14388 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 14389 * 14390 * <p>If you call {@link #buildDrawingCache()} manually without calling 14391 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14392 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 14393 * 14394 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14395 * this method will create a bitmap of the same size as this view. Because this bitmap 14396 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14397 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14398 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14399 * size than the view. This implies that your application must be able to handle this 14400 * size.</p> 14401 * 14402 * <p>You should avoid calling this method when hardware acceleration is enabled. If 14403 * you do not need the drawing cache bitmap, calling this method will increase memory 14404 * usage and cause the view to be rendered in software once, thus negatively impacting 14405 * performance.</p> 14406 * 14407 * @see #getDrawingCache() 14408 * @see #destroyDrawingCache() 14409 */ 14410 public void buildDrawingCache(boolean autoScale) { 14411 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || (autoScale ? 14412 mDrawingCache == null : mUnscaledDrawingCache == null)) { 14413 if (Trace.isTagEnabled(Trace.TRACE_TAG_VIEW)) { 14414 Trace.traceBegin(Trace.TRACE_TAG_VIEW, 14415 "buildDrawingCache/SW Layer for " + getClass().getSimpleName()); 14416 } 14417 try { 14418 buildDrawingCacheImpl(autoScale); 14419 } finally { 14420 Trace.traceEnd(Trace.TRACE_TAG_VIEW); 14421 } 14422 } 14423 } 14424 14425 /** 14426 * private, internal implementation of buildDrawingCache, used to enable tracing 14427 */ 14428 private void buildDrawingCacheImpl(boolean autoScale) { 14429 mCachingFailed = false; 14430 14431 int width = mRight - mLeft; 14432 int height = mBottom - mTop; 14433 14434 final AttachInfo attachInfo = mAttachInfo; 14435 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 14436 14437 if (autoScale && scalingRequired) { 14438 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 14439 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 14440 } 14441 14442 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 14443 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 14444 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 14445 14446 final long projectedBitmapSize = width * height * (opaque && !use32BitCache ? 2 : 4); 14447 final long drawingCacheSize = 14448 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize(); 14449 if (width <= 0 || height <= 0 || projectedBitmapSize > drawingCacheSize) { 14450 if (width > 0 && height > 0) { 14451 Log.w(VIEW_LOG_TAG, "View too large to fit into drawing cache, needs " 14452 + projectedBitmapSize + " bytes, only " 14453 + drawingCacheSize + " available"); 14454 } 14455 destroyDrawingCache(); 14456 mCachingFailed = true; 14457 return; 14458 } 14459 14460 boolean clear = true; 14461 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 14462 14463 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 14464 Bitmap.Config quality; 14465 if (!opaque) { 14466 // Never pick ARGB_4444 because it looks awful 14467 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 14468 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 14469 case DRAWING_CACHE_QUALITY_AUTO: 14470 case DRAWING_CACHE_QUALITY_LOW: 14471 case DRAWING_CACHE_QUALITY_HIGH: 14472 default: 14473 quality = Bitmap.Config.ARGB_8888; 14474 break; 14475 } 14476 } else { 14477 // Optimization for translucent windows 14478 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 14479 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 14480 } 14481 14482 // Try to cleanup memory 14483 if (bitmap != null) bitmap.recycle(); 14484 14485 try { 14486 bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14487 width, height, quality); 14488 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 14489 if (autoScale) { 14490 mDrawingCache = bitmap; 14491 } else { 14492 mUnscaledDrawingCache = bitmap; 14493 } 14494 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 14495 } catch (OutOfMemoryError e) { 14496 // If there is not enough memory to create the bitmap cache, just 14497 // ignore the issue as bitmap caches are not required to draw the 14498 // view hierarchy 14499 if (autoScale) { 14500 mDrawingCache = null; 14501 } else { 14502 mUnscaledDrawingCache = null; 14503 } 14504 mCachingFailed = true; 14505 return; 14506 } 14507 14508 clear = drawingCacheBackgroundColor != 0; 14509 } 14510 14511 Canvas canvas; 14512 if (attachInfo != null) { 14513 canvas = attachInfo.mCanvas; 14514 if (canvas == null) { 14515 canvas = new Canvas(); 14516 } 14517 canvas.setBitmap(bitmap); 14518 // Temporarily clobber the cached Canvas in case one of our children 14519 // is also using a drawing cache. Without this, the children would 14520 // steal the canvas by attaching their own bitmap to it and bad, bad 14521 // thing would happen (invisible views, corrupted drawings, etc.) 14522 attachInfo.mCanvas = null; 14523 } else { 14524 // This case should hopefully never or seldom happen 14525 canvas = new Canvas(bitmap); 14526 } 14527 14528 if (clear) { 14529 bitmap.eraseColor(drawingCacheBackgroundColor); 14530 } 14531 14532 computeScroll(); 14533 final int restoreCount = canvas.save(); 14534 14535 if (autoScale && scalingRequired) { 14536 final float scale = attachInfo.mApplicationScale; 14537 canvas.scale(scale, scale); 14538 } 14539 14540 canvas.translate(-mScrollX, -mScrollY); 14541 14542 mPrivateFlags |= PFLAG_DRAWN; 14543 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 14544 mLayerType != LAYER_TYPE_NONE) { 14545 mPrivateFlags |= PFLAG_DRAWING_CACHE_VALID; 14546 } 14547 14548 // Fast path for layouts with no backgrounds 14549 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14550 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14551 dispatchDraw(canvas); 14552 if (mOverlay != null && !mOverlay.isEmpty()) { 14553 mOverlay.getOverlayView().draw(canvas); 14554 } 14555 } else { 14556 draw(canvas); 14557 } 14558 14559 canvas.restoreToCount(restoreCount); 14560 canvas.setBitmap(null); 14561 14562 if (attachInfo != null) { 14563 // Restore the cached Canvas for our siblings 14564 attachInfo.mCanvas = canvas; 14565 } 14566 } 14567 14568 /** 14569 * Create a snapshot of the view into a bitmap. We should probably make 14570 * some form of this public, but should think about the API. 14571 */ 14572 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 14573 int width = mRight - mLeft; 14574 int height = mBottom - mTop; 14575 14576 final AttachInfo attachInfo = mAttachInfo; 14577 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 14578 width = (int) ((width * scale) + 0.5f); 14579 height = (int) ((height * scale) + 0.5f); 14580 14581 Bitmap bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14582 width > 0 ? width : 1, height > 0 ? height : 1, quality); 14583 if (bitmap == null) { 14584 throw new OutOfMemoryError(); 14585 } 14586 14587 Resources resources = getResources(); 14588 if (resources != null) { 14589 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 14590 } 14591 14592 Canvas canvas; 14593 if (attachInfo != null) { 14594 canvas = attachInfo.mCanvas; 14595 if (canvas == null) { 14596 canvas = new Canvas(); 14597 } 14598 canvas.setBitmap(bitmap); 14599 // Temporarily clobber the cached Canvas in case one of our children 14600 // is also using a drawing cache. Without this, the children would 14601 // steal the canvas by attaching their own bitmap to it and bad, bad 14602 // things would happen (invisible views, corrupted drawings, etc.) 14603 attachInfo.mCanvas = null; 14604 } else { 14605 // This case should hopefully never or seldom happen 14606 canvas = new Canvas(bitmap); 14607 } 14608 14609 if ((backgroundColor & 0xff000000) != 0) { 14610 bitmap.eraseColor(backgroundColor); 14611 } 14612 14613 computeScroll(); 14614 final int restoreCount = canvas.save(); 14615 canvas.scale(scale, scale); 14616 canvas.translate(-mScrollX, -mScrollY); 14617 14618 // Temporarily remove the dirty mask 14619 int flags = mPrivateFlags; 14620 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14621 14622 // Fast path for layouts with no backgrounds 14623 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14624 dispatchDraw(canvas); 14625 if (mOverlay != null && !mOverlay.isEmpty()) { 14626 mOverlay.getOverlayView().draw(canvas); 14627 } 14628 } else { 14629 draw(canvas); 14630 } 14631 14632 mPrivateFlags = flags; 14633 14634 canvas.restoreToCount(restoreCount); 14635 canvas.setBitmap(null); 14636 14637 if (attachInfo != null) { 14638 // Restore the cached Canvas for our siblings 14639 attachInfo.mCanvas = canvas; 14640 } 14641 14642 return bitmap; 14643 } 14644 14645 /** 14646 * Indicates whether this View is currently in edit mode. A View is usually 14647 * in edit mode when displayed within a developer tool. For instance, if 14648 * this View is being drawn by a visual user interface builder, this method 14649 * should return true. 14650 * 14651 * Subclasses should check the return value of this method to provide 14652 * different behaviors if their normal behavior might interfere with the 14653 * host environment. For instance: the class spawns a thread in its 14654 * constructor, the drawing code relies on device-specific features, etc. 14655 * 14656 * This method is usually checked in the drawing code of custom widgets. 14657 * 14658 * @return True if this View is in edit mode, false otherwise. 14659 */ 14660 public boolean isInEditMode() { 14661 return false; 14662 } 14663 14664 /** 14665 * If the View draws content inside its padding and enables fading edges, 14666 * it needs to support padding offsets. Padding offsets are added to the 14667 * fading edges to extend the length of the fade so that it covers pixels 14668 * drawn inside the padding. 14669 * 14670 * Subclasses of this class should override this method if they need 14671 * to draw content inside the padding. 14672 * 14673 * @return True if padding offset must be applied, false otherwise. 14674 * 14675 * @see #getLeftPaddingOffset() 14676 * @see #getRightPaddingOffset() 14677 * @see #getTopPaddingOffset() 14678 * @see #getBottomPaddingOffset() 14679 * 14680 * @since CURRENT 14681 */ 14682 protected boolean isPaddingOffsetRequired() { 14683 return false; 14684 } 14685 14686 /** 14687 * Amount by which to extend the left fading region. Called only when 14688 * {@link #isPaddingOffsetRequired()} returns true. 14689 * 14690 * @return The left padding offset in pixels. 14691 * 14692 * @see #isPaddingOffsetRequired() 14693 * 14694 * @since CURRENT 14695 */ 14696 protected int getLeftPaddingOffset() { 14697 return 0; 14698 } 14699 14700 /** 14701 * Amount by which to extend the right fading region. Called only when 14702 * {@link #isPaddingOffsetRequired()} returns true. 14703 * 14704 * @return The right padding offset in pixels. 14705 * 14706 * @see #isPaddingOffsetRequired() 14707 * 14708 * @since CURRENT 14709 */ 14710 protected int getRightPaddingOffset() { 14711 return 0; 14712 } 14713 14714 /** 14715 * Amount by which to extend the top fading region. Called only when 14716 * {@link #isPaddingOffsetRequired()} returns true. 14717 * 14718 * @return The top padding offset in pixels. 14719 * 14720 * @see #isPaddingOffsetRequired() 14721 * 14722 * @since CURRENT 14723 */ 14724 protected int getTopPaddingOffset() { 14725 return 0; 14726 } 14727 14728 /** 14729 * Amount by which to extend the bottom fading region. Called only when 14730 * {@link #isPaddingOffsetRequired()} returns true. 14731 * 14732 * @return The bottom padding offset in pixels. 14733 * 14734 * @see #isPaddingOffsetRequired() 14735 * 14736 * @since CURRENT 14737 */ 14738 protected int getBottomPaddingOffset() { 14739 return 0; 14740 } 14741 14742 /** 14743 * @hide 14744 * @param offsetRequired 14745 */ 14746 protected int getFadeTop(boolean offsetRequired) { 14747 int top = mPaddingTop; 14748 if (offsetRequired) top += getTopPaddingOffset(); 14749 return top; 14750 } 14751 14752 /** 14753 * @hide 14754 * @param offsetRequired 14755 */ 14756 protected int getFadeHeight(boolean offsetRequired) { 14757 int padding = mPaddingTop; 14758 if (offsetRequired) padding += getTopPaddingOffset(); 14759 return mBottom - mTop - mPaddingBottom - padding; 14760 } 14761 14762 /** 14763 * <p>Indicates whether this view is attached to a hardware accelerated 14764 * window or not.</p> 14765 * 14766 * <p>Even if this method returns true, it does not mean that every call 14767 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 14768 * accelerated {@link android.graphics.Canvas}. For instance, if this view 14769 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its 14770 * window is hardware accelerated, 14771 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 14772 * return false, and this method will return true.</p> 14773 * 14774 * @return True if the view is attached to a window and the window is 14775 * hardware accelerated; false in any other case. 14776 */ 14777 @ViewDebug.ExportedProperty(category = "drawing") 14778 public boolean isHardwareAccelerated() { 14779 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14780 } 14781 14782 /** 14783 * Sets a rectangular area on this view to which the view will be clipped 14784 * when it is drawn. Setting the value to null will remove the clip bounds 14785 * and the view will draw normally, using its full bounds. 14786 * 14787 * @param clipBounds The rectangular area, in the local coordinates of 14788 * this view, to which future drawing operations will be clipped. 14789 */ 14790 public void setClipBounds(Rect clipBounds) { 14791 if (clipBounds == mClipBounds 14792 || (clipBounds != null && clipBounds.equals(mClipBounds))) { 14793 return; 14794 } 14795 if (clipBounds != null) { 14796 if (mClipBounds == null) { 14797 mClipBounds = new Rect(clipBounds); 14798 } else { 14799 mClipBounds.set(clipBounds); 14800 } 14801 } else { 14802 mClipBounds = null; 14803 } 14804 mRenderNode.setClipBounds(mClipBounds); 14805 invalidateViewProperty(false, false); 14806 } 14807 14808 /** 14809 * Returns a copy of the current {@link #setClipBounds(Rect) clipBounds}. 14810 * 14811 * @return A copy of the current clip bounds if clip bounds are set, 14812 * otherwise null. 14813 */ 14814 public Rect getClipBounds() { 14815 return (mClipBounds != null) ? new Rect(mClipBounds) : null; 14816 } 14817 14818 /** 14819 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common 14820 * case of an active Animation being run on the view. 14821 */ 14822 private boolean drawAnimation(ViewGroup parent, long drawingTime, 14823 Animation a, boolean scalingRequired) { 14824 Transformation invalidationTransform; 14825 final int flags = parent.mGroupFlags; 14826 final boolean initialized = a.isInitialized(); 14827 if (!initialized) { 14828 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight()); 14829 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop); 14830 if (mAttachInfo != null) a.setListenerHandler(mAttachInfo.mHandler); 14831 onAnimationStart(); 14832 } 14833 14834 final Transformation t = parent.getChildTransformation(); 14835 boolean more = a.getTransformation(drawingTime, t, 1f); 14836 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) { 14837 if (parent.mInvalidationTransformation == null) { 14838 parent.mInvalidationTransformation = new Transformation(); 14839 } 14840 invalidationTransform = parent.mInvalidationTransformation; 14841 a.getTransformation(drawingTime, invalidationTransform, 1f); 14842 } else { 14843 invalidationTransform = t; 14844 } 14845 14846 if (more) { 14847 if (!a.willChangeBounds()) { 14848 if ((flags & (ViewGroup.FLAG_OPTIMIZE_INVALIDATE | ViewGroup.FLAG_ANIMATION_DONE)) == 14849 ViewGroup.FLAG_OPTIMIZE_INVALIDATE) { 14850 parent.mGroupFlags |= ViewGroup.FLAG_INVALIDATE_REQUIRED; 14851 } else if ((flags & ViewGroup.FLAG_INVALIDATE_REQUIRED) == 0) { 14852 // The child need to draw an animation, potentially offscreen, so 14853 // make sure we do not cancel invalidate requests 14854 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14855 parent.invalidate(mLeft, mTop, mRight, mBottom); 14856 } 14857 } else { 14858 if (parent.mInvalidateRegion == null) { 14859 parent.mInvalidateRegion = new RectF(); 14860 } 14861 final RectF region = parent.mInvalidateRegion; 14862 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region, 14863 invalidationTransform); 14864 14865 // The child need to draw an animation, potentially offscreen, so 14866 // make sure we do not cancel invalidate requests 14867 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14868 14869 final int left = mLeft + (int) region.left; 14870 final int top = mTop + (int) region.top; 14871 parent.invalidate(left, top, left + (int) (region.width() + .5f), 14872 top + (int) (region.height() + .5f)); 14873 } 14874 } 14875 return more; 14876 } 14877 14878 /** 14879 * This method is called by getDisplayList() when a display list is recorded for a View. 14880 * It pushes any properties to the RenderNode that aren't managed by the RenderNode. 14881 */ 14882 void setDisplayListProperties(RenderNode renderNode) { 14883 if (renderNode != null) { 14884 renderNode.setHasOverlappingRendering(hasOverlappingRendering()); 14885 if (mParent instanceof ViewGroup) { 14886 renderNode.setClipToBounds( 14887 (((ViewGroup) mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0); 14888 } 14889 float alpha = 1; 14890 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags & 14891 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14892 ViewGroup parentVG = (ViewGroup) mParent; 14893 final Transformation t = parentVG.getChildTransformation(); 14894 if (parentVG.getChildStaticTransformation(this, t)) { 14895 final int transformType = t.getTransformationType(); 14896 if (transformType != Transformation.TYPE_IDENTITY) { 14897 if ((transformType & Transformation.TYPE_ALPHA) != 0) { 14898 alpha = t.getAlpha(); 14899 } 14900 if ((transformType & Transformation.TYPE_MATRIX) != 0) { 14901 renderNode.setStaticMatrix(t.getMatrix()); 14902 } 14903 } 14904 } 14905 } 14906 if (mTransformationInfo != null) { 14907 alpha *= getFinalAlpha(); 14908 if (alpha < 1) { 14909 final int multipliedAlpha = (int) (255 * alpha); 14910 if (onSetAlpha(multipliedAlpha)) { 14911 alpha = 1; 14912 } 14913 } 14914 renderNode.setAlpha(alpha); 14915 } else if (alpha < 1) { 14916 renderNode.setAlpha(alpha); 14917 } 14918 } 14919 } 14920 14921 /** 14922 * This method is called by ViewGroup.drawChild() to have each child view draw itself. 14923 * This draw() method is an implementation detail and is not intended to be overridden or 14924 * to be called from anywhere else other than ViewGroup.drawChild(). 14925 */ 14926 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) { 14927 boolean usingRenderNodeProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14928 boolean more = false; 14929 final boolean childHasIdentityMatrix = hasIdentityMatrix(); 14930 final int flags = parent.mGroupFlags; 14931 14932 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) { 14933 parent.getChildTransformation().clear(); 14934 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION; 14935 } 14936 14937 Transformation transformToApply = null; 14938 boolean concatMatrix = false; 14939 14940 boolean scalingRequired = false; 14941 boolean caching; 14942 int layerType = getLayerType(); 14943 14944 final boolean hardwareAccelerated = canvas.isHardwareAccelerated(); 14945 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 || 14946 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) { 14947 caching = true; 14948 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList 14949 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired; 14950 } else { 14951 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated; 14952 } 14953 14954 final Animation a = getAnimation(); 14955 if (a != null) { 14956 more = drawAnimation(parent, drawingTime, a, scalingRequired); 14957 concatMatrix = a.willChangeTransformationMatrix(); 14958 if (concatMatrix) { 14959 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14960 } 14961 transformToApply = parent.getChildTransformation(); 14962 } else { 14963 if ((mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_TRANSFORM) != 0) { 14964 // No longer animating: clear out old animation matrix 14965 mRenderNode.setAnimationMatrix(null); 14966 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14967 } 14968 if (!usingRenderNodeProperties && 14969 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14970 final Transformation t = parent.getChildTransformation(); 14971 final boolean hasTransform = parent.getChildStaticTransformation(this, t); 14972 if (hasTransform) { 14973 final int transformType = t.getTransformationType(); 14974 transformToApply = transformType != Transformation.TYPE_IDENTITY ? t : null; 14975 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0; 14976 } 14977 } 14978 } 14979 14980 concatMatrix |= !childHasIdentityMatrix; 14981 14982 // Sets the flag as early as possible to allow draw() implementations 14983 // to call invalidate() successfully when doing animations 14984 mPrivateFlags |= PFLAG_DRAWN; 14985 14986 if (!concatMatrix && 14987 (flags & (ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS | 14988 ViewGroup.FLAG_CLIP_CHILDREN)) == ViewGroup.FLAG_CLIP_CHILDREN && 14989 canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) && 14990 (mPrivateFlags & PFLAG_DRAW_ANIMATION) == 0) { 14991 mPrivateFlags2 |= PFLAG2_VIEW_QUICK_REJECTED; 14992 return more; 14993 } 14994 mPrivateFlags2 &= ~PFLAG2_VIEW_QUICK_REJECTED; 14995 14996 if (hardwareAccelerated) { 14997 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but 14998 // retain the flag's value temporarily in the mRecreateDisplayList flag 14999 mRecreateDisplayList = (mPrivateFlags & PFLAG_INVALIDATED) == PFLAG_INVALIDATED; 15000 mPrivateFlags &= ~PFLAG_INVALIDATED; 15001 } 15002 15003 RenderNode renderNode = null; 15004 Bitmap cache = null; 15005 boolean hasDisplayList = false; 15006 if (caching) { 15007 if (!hardwareAccelerated) { 15008 if (layerType != LAYER_TYPE_NONE) { 15009 layerType = LAYER_TYPE_SOFTWARE; 15010 buildDrawingCache(true); 15011 } 15012 cache = getDrawingCache(true); 15013 } else { 15014 switch (layerType) { 15015 case LAYER_TYPE_SOFTWARE: 15016 if (usingRenderNodeProperties) { 15017 hasDisplayList = canHaveDisplayList(); 15018 } else { 15019 buildDrawingCache(true); 15020 cache = getDrawingCache(true); 15021 } 15022 break; 15023 case LAYER_TYPE_HARDWARE: 15024 if (usingRenderNodeProperties) { 15025 hasDisplayList = canHaveDisplayList(); 15026 } 15027 break; 15028 case LAYER_TYPE_NONE: 15029 // Delay getting the display list until animation-driven alpha values are 15030 // set up and possibly passed on to the view 15031 hasDisplayList = canHaveDisplayList(); 15032 break; 15033 } 15034 } 15035 } 15036 usingRenderNodeProperties &= hasDisplayList; 15037 if (usingRenderNodeProperties) { 15038 renderNode = getDisplayList(); 15039 if (!renderNode.isValid()) { 15040 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15041 // to getDisplayList(), the display list will be marked invalid and we should not 15042 // try to use it again. 15043 renderNode = null; 15044 hasDisplayList = false; 15045 usingRenderNodeProperties = false; 15046 } 15047 } 15048 15049 int sx = 0; 15050 int sy = 0; 15051 if (!hasDisplayList) { 15052 computeScroll(); 15053 sx = mScrollX; 15054 sy = mScrollY; 15055 } 15056 15057 final boolean hasNoCache = cache == null || hasDisplayList; 15058 final boolean offsetForScroll = cache == null && !hasDisplayList && 15059 layerType != LAYER_TYPE_HARDWARE; 15060 15061 int restoreTo = -1; 15062 if (!usingRenderNodeProperties || transformToApply != null) { 15063 restoreTo = canvas.save(); 15064 } 15065 if (offsetForScroll) { 15066 canvas.translate(mLeft - sx, mTop - sy); 15067 } else { 15068 if (!usingRenderNodeProperties) { 15069 canvas.translate(mLeft, mTop); 15070 } 15071 if (scalingRequired) { 15072 if (usingRenderNodeProperties) { 15073 // TODO: Might not need this if we put everything inside the DL 15074 restoreTo = canvas.save(); 15075 } 15076 // mAttachInfo cannot be null, otherwise scalingRequired == false 15077 final float scale = 1.0f / mAttachInfo.mApplicationScale; 15078 canvas.scale(scale, scale); 15079 } 15080 } 15081 15082 float alpha = usingRenderNodeProperties ? 1 : (getAlpha() * getTransitionAlpha()); 15083 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix() || 15084 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15085 if (transformToApply != null || !childHasIdentityMatrix) { 15086 int transX = 0; 15087 int transY = 0; 15088 15089 if (offsetForScroll) { 15090 transX = -sx; 15091 transY = -sy; 15092 } 15093 15094 if (transformToApply != null) { 15095 if (concatMatrix) { 15096 if (usingRenderNodeProperties) { 15097 renderNode.setAnimationMatrix(transformToApply.getMatrix()); 15098 } else { 15099 // Undo the scroll translation, apply the transformation matrix, 15100 // then redo the scroll translate to get the correct result. 15101 canvas.translate(-transX, -transY); 15102 canvas.concat(transformToApply.getMatrix()); 15103 canvas.translate(transX, transY); 15104 } 15105 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15106 } 15107 15108 float transformAlpha = transformToApply.getAlpha(); 15109 if (transformAlpha < 1) { 15110 alpha *= transformAlpha; 15111 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15112 } 15113 } 15114 15115 if (!childHasIdentityMatrix && !usingRenderNodeProperties) { 15116 canvas.translate(-transX, -transY); 15117 canvas.concat(getMatrix()); 15118 canvas.translate(transX, transY); 15119 } 15120 } 15121 15122 // Deal with alpha if it is or used to be <1 15123 if (alpha < 1 || 15124 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15125 if (alpha < 1) { 15126 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15127 } else { 15128 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15129 } 15130 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15131 if (hasNoCache) { 15132 final int multipliedAlpha = (int) (255 * alpha); 15133 if (!onSetAlpha(multipliedAlpha)) { 15134 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15135 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 || 15136 layerType != LAYER_TYPE_NONE) { 15137 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG; 15138 } 15139 if (usingRenderNodeProperties) { 15140 renderNode.setAlpha(alpha * getAlpha() * getTransitionAlpha()); 15141 } else if (layerType == LAYER_TYPE_NONE) { 15142 final int scrollX = hasDisplayList ? 0 : sx; 15143 final int scrollY = hasDisplayList ? 0 : sy; 15144 canvas.saveLayerAlpha(scrollX, scrollY, 15145 scrollX + (mRight - mLeft), scrollY + (mBottom - mTop), 15146 multipliedAlpha, layerFlags); 15147 } 15148 } else { 15149 // Alpha is handled by the child directly, clobber the layer's alpha 15150 mPrivateFlags |= PFLAG_ALPHA_SET; 15151 } 15152 } 15153 } 15154 } else if ((mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15155 onSetAlpha(255); 15156 mPrivateFlags &= ~PFLAG_ALPHA_SET; 15157 } 15158 15159 if (!usingRenderNodeProperties) { 15160 // apply clips directly, since RenderNode won't do it for this draw 15161 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN 15162 && cache == null) { 15163 if (offsetForScroll) { 15164 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop)); 15165 } else { 15166 if (!scalingRequired || cache == null) { 15167 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop); 15168 } else { 15169 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight()); 15170 } 15171 } 15172 } 15173 15174 if (mClipBounds != null) { 15175 // clip bounds ignore scroll 15176 canvas.clipRect(mClipBounds); 15177 } 15178 } 15179 15180 15181 15182 if (!usingRenderNodeProperties && hasDisplayList) { 15183 renderNode = getDisplayList(); 15184 if (!renderNode.isValid()) { 15185 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15186 // to getDisplayList(), the display list will be marked invalid and we should not 15187 // try to use it again. 15188 renderNode = null; 15189 hasDisplayList = false; 15190 } 15191 } 15192 15193 if (hasNoCache) { 15194 boolean layerRendered = false; 15195 if (layerType == LAYER_TYPE_HARDWARE && !usingRenderNodeProperties) { 15196 final HardwareLayer layer = getHardwareLayer(); 15197 if (layer != null && layer.isValid()) { 15198 int restoreAlpha = mLayerPaint.getAlpha(); 15199 mLayerPaint.setAlpha((int) (alpha * 255)); 15200 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint); 15201 mLayerPaint.setAlpha(restoreAlpha); 15202 layerRendered = true; 15203 } else { 15204 final int scrollX = hasDisplayList ? 0 : sx; 15205 final int scrollY = hasDisplayList ? 0 : sy; 15206 canvas.saveLayer(scrollX, scrollY, 15207 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint, 15208 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG); 15209 } 15210 } 15211 15212 if (!layerRendered) { 15213 if (!hasDisplayList) { 15214 // Fast path for layouts with no backgrounds 15215 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 15216 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15217 dispatchDraw(canvas); 15218 } else { 15219 draw(canvas); 15220 } 15221 } else { 15222 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15223 ((HardwareCanvas) canvas).drawRenderNode(renderNode, null, flags); 15224 } 15225 } 15226 } else if (cache != null) { 15227 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15228 Paint cachePaint; 15229 int restoreAlpha = 0; 15230 15231 if (layerType == LAYER_TYPE_NONE) { 15232 cachePaint = parent.mCachePaint; 15233 if (cachePaint == null) { 15234 cachePaint = new Paint(); 15235 cachePaint.setDither(false); 15236 parent.mCachePaint = cachePaint; 15237 } 15238 } else { 15239 cachePaint = mLayerPaint; 15240 restoreAlpha = mLayerPaint.getAlpha(); 15241 } 15242 cachePaint.setAlpha((int) (alpha * 255)); 15243 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint); 15244 cachePaint.setAlpha(restoreAlpha); 15245 } 15246 15247 if (restoreTo >= 0) { 15248 canvas.restoreToCount(restoreTo); 15249 } 15250 15251 if (a != null && !more) { 15252 if (!hardwareAccelerated && !a.getFillAfter()) { 15253 onSetAlpha(255); 15254 } 15255 parent.finishAnimatingView(this, a); 15256 } 15257 15258 if (more && hardwareAccelerated) { 15259 if (a.hasAlpha() && (mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15260 // alpha animations should cause the child to recreate its display list 15261 invalidate(true); 15262 } 15263 } 15264 15265 mRecreateDisplayList = false; 15266 15267 return more; 15268 } 15269 15270 /** 15271 * Manually render this view (and all of its children) to the given Canvas. 15272 * The view must have already done a full layout before this function is 15273 * called. When implementing a view, implement 15274 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 15275 * If you do need to override this method, call the superclass version. 15276 * 15277 * @param canvas The Canvas to which the View is rendered. 15278 */ 15279 public void draw(Canvas canvas) { 15280 final int privateFlags = mPrivateFlags; 15281 final boolean dirtyOpaque = (privateFlags & PFLAG_DIRTY_MASK) == PFLAG_DIRTY_OPAQUE && 15282 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 15283 mPrivateFlags = (privateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN; 15284 15285 /* 15286 * Draw traversal performs several drawing steps which must be executed 15287 * in the appropriate order: 15288 * 15289 * 1. Draw the background 15290 * 2. If necessary, save the canvas' layers to prepare for fading 15291 * 3. Draw view's content 15292 * 4. Draw children 15293 * 5. If necessary, draw the fading edges and restore layers 15294 * 6. Draw decorations (scrollbars for instance) 15295 */ 15296 15297 // Step 1, draw the background, if needed 15298 int saveCount; 15299 15300 if (!dirtyOpaque) { 15301 drawBackground(canvas); 15302 } 15303 15304 // skip step 2 & 5 if possible (common case) 15305 final int viewFlags = mViewFlags; 15306 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 15307 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 15308 if (!verticalEdges && !horizontalEdges) { 15309 // Step 3, draw the content 15310 if (!dirtyOpaque) onDraw(canvas); 15311 15312 // Step 4, draw the children 15313 dispatchDraw(canvas); 15314 15315 // Step 6, draw decorations (scrollbars) 15316 onDrawScrollBars(canvas); 15317 15318 if (mOverlay != null && !mOverlay.isEmpty()) { 15319 mOverlay.getOverlayView().dispatchDraw(canvas); 15320 } 15321 15322 // we're done... 15323 return; 15324 } 15325 15326 /* 15327 * Here we do the full fledged routine... 15328 * (this is an uncommon case where speed matters less, 15329 * this is why we repeat some of the tests that have been 15330 * done above) 15331 */ 15332 15333 boolean drawTop = false; 15334 boolean drawBottom = false; 15335 boolean drawLeft = false; 15336 boolean drawRight = false; 15337 15338 float topFadeStrength = 0.0f; 15339 float bottomFadeStrength = 0.0f; 15340 float leftFadeStrength = 0.0f; 15341 float rightFadeStrength = 0.0f; 15342 15343 // Step 2, save the canvas' layers 15344 int paddingLeft = mPaddingLeft; 15345 15346 final boolean offsetRequired = isPaddingOffsetRequired(); 15347 if (offsetRequired) { 15348 paddingLeft += getLeftPaddingOffset(); 15349 } 15350 15351 int left = mScrollX + paddingLeft; 15352 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 15353 int top = mScrollY + getFadeTop(offsetRequired); 15354 int bottom = top + getFadeHeight(offsetRequired); 15355 15356 if (offsetRequired) { 15357 right += getRightPaddingOffset(); 15358 bottom += getBottomPaddingOffset(); 15359 } 15360 15361 final ScrollabilityCache scrollabilityCache = mScrollCache; 15362 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 15363 int length = (int) fadeHeight; 15364 15365 // clip the fade length if top and bottom fades overlap 15366 // overlapping fades produce odd-looking artifacts 15367 if (verticalEdges && (top + length > bottom - length)) { 15368 length = (bottom - top) / 2; 15369 } 15370 15371 // also clip horizontal fades if necessary 15372 if (horizontalEdges && (left + length > right - length)) { 15373 length = (right - left) / 2; 15374 } 15375 15376 if (verticalEdges) { 15377 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 15378 drawTop = topFadeStrength * fadeHeight > 1.0f; 15379 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 15380 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 15381 } 15382 15383 if (horizontalEdges) { 15384 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 15385 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 15386 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 15387 drawRight = rightFadeStrength * fadeHeight > 1.0f; 15388 } 15389 15390 saveCount = canvas.getSaveCount(); 15391 15392 int solidColor = getSolidColor(); 15393 if (solidColor == 0) { 15394 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15395 15396 if (drawTop) { 15397 canvas.saveLayer(left, top, right, top + length, null, flags); 15398 } 15399 15400 if (drawBottom) { 15401 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 15402 } 15403 15404 if (drawLeft) { 15405 canvas.saveLayer(left, top, left + length, bottom, null, flags); 15406 } 15407 15408 if (drawRight) { 15409 canvas.saveLayer(right - length, top, right, bottom, null, flags); 15410 } 15411 } else { 15412 scrollabilityCache.setFadeColor(solidColor); 15413 } 15414 15415 // Step 3, draw the content 15416 if (!dirtyOpaque) onDraw(canvas); 15417 15418 // Step 4, draw the children 15419 dispatchDraw(canvas); 15420 15421 // Step 5, draw the fade effect and restore layers 15422 final Paint p = scrollabilityCache.paint; 15423 final Matrix matrix = scrollabilityCache.matrix; 15424 final Shader fade = scrollabilityCache.shader; 15425 15426 if (drawTop) { 15427 matrix.setScale(1, fadeHeight * topFadeStrength); 15428 matrix.postTranslate(left, top); 15429 fade.setLocalMatrix(matrix); 15430 p.setShader(fade); 15431 canvas.drawRect(left, top, right, top + length, p); 15432 } 15433 15434 if (drawBottom) { 15435 matrix.setScale(1, fadeHeight * bottomFadeStrength); 15436 matrix.postRotate(180); 15437 matrix.postTranslate(left, bottom); 15438 fade.setLocalMatrix(matrix); 15439 p.setShader(fade); 15440 canvas.drawRect(left, bottom - length, right, bottom, p); 15441 } 15442 15443 if (drawLeft) { 15444 matrix.setScale(1, fadeHeight * leftFadeStrength); 15445 matrix.postRotate(-90); 15446 matrix.postTranslate(left, top); 15447 fade.setLocalMatrix(matrix); 15448 p.setShader(fade); 15449 canvas.drawRect(left, top, left + length, bottom, p); 15450 } 15451 15452 if (drawRight) { 15453 matrix.setScale(1, fadeHeight * rightFadeStrength); 15454 matrix.postRotate(90); 15455 matrix.postTranslate(right, top); 15456 fade.setLocalMatrix(matrix); 15457 p.setShader(fade); 15458 canvas.drawRect(right - length, top, right, bottom, p); 15459 } 15460 15461 canvas.restoreToCount(saveCount); 15462 15463 // Step 6, draw decorations (scrollbars) 15464 onDrawScrollBars(canvas); 15465 15466 if (mOverlay != null && !mOverlay.isEmpty()) { 15467 mOverlay.getOverlayView().dispatchDraw(canvas); 15468 } 15469 } 15470 15471 /** 15472 * Draws the background onto the specified canvas. 15473 * 15474 * @param canvas Canvas on which to draw the background 15475 */ 15476 private void drawBackground(Canvas canvas) { 15477 final Drawable background = mBackground; 15478 if (background == null) { 15479 return; 15480 } 15481 15482 if (mBackgroundSizeChanged) { 15483 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 15484 mBackgroundSizeChanged = false; 15485 rebuildOutline(); 15486 } 15487 15488 // Attempt to use a display list if requested. 15489 if (canvas.isHardwareAccelerated() && mAttachInfo != null 15490 && mAttachInfo.mHardwareRenderer != null) { 15491 mBackgroundRenderNode = getDrawableRenderNode(background, mBackgroundRenderNode); 15492 15493 final RenderNode renderNode = mBackgroundRenderNode; 15494 if (renderNode != null && renderNode.isValid()) { 15495 setBackgroundRenderNodeProperties(renderNode); 15496 ((HardwareCanvas) canvas).drawRenderNode(renderNode); 15497 return; 15498 } 15499 } 15500 15501 final int scrollX = mScrollX; 15502 final int scrollY = mScrollY; 15503 if ((scrollX | scrollY) == 0) { 15504 background.draw(canvas); 15505 } else { 15506 canvas.translate(scrollX, scrollY); 15507 background.draw(canvas); 15508 canvas.translate(-scrollX, -scrollY); 15509 } 15510 } 15511 15512 private void setBackgroundRenderNodeProperties(RenderNode renderNode) { 15513 renderNode.setTranslationX(mScrollX); 15514 renderNode.setTranslationY(mScrollY); 15515 } 15516 15517 /** 15518 * Creates a new display list or updates the existing display list for the 15519 * specified Drawable. 15520 * 15521 * @param drawable Drawable for which to create a display list 15522 * @param renderNode Existing RenderNode, or {@code null} 15523 * @return A valid display list for the specified drawable 15524 */ 15525 private RenderNode getDrawableRenderNode(Drawable drawable, RenderNode renderNode) { 15526 if (renderNode == null) { 15527 renderNode = RenderNode.create(drawable.getClass().getName(), this); 15528 } 15529 15530 final Rect bounds = drawable.getBounds(); 15531 final int width = bounds.width(); 15532 final int height = bounds.height(); 15533 final HardwareCanvas canvas = renderNode.start(width, height); 15534 15535 // Reverse left/top translation done by drawable canvas, which will 15536 // instead be applied by rendernode's LTRB bounds below. This way, the 15537 // drawable's bounds match with its rendernode bounds and its content 15538 // will lie within those bounds in the rendernode tree. 15539 canvas.translate(-bounds.left, -bounds.top); 15540 15541 try { 15542 drawable.draw(canvas); 15543 } finally { 15544 renderNode.end(canvas); 15545 } 15546 15547 // Set up drawable properties that are view-independent. 15548 renderNode.setLeftTopRightBottom(bounds.left, bounds.top, bounds.right, bounds.bottom); 15549 renderNode.setProjectBackwards(drawable.isProjected()); 15550 renderNode.setProjectionReceiver(true); 15551 renderNode.setClipToBounds(false); 15552 return renderNode; 15553 } 15554 15555 /** 15556 * Returns the overlay for this view, creating it if it does not yet exist. 15557 * Adding drawables to the overlay will cause them to be displayed whenever 15558 * the view itself is redrawn. Objects in the overlay should be actively 15559 * managed: remove them when they should not be displayed anymore. The 15560 * overlay will always have the same size as its host view. 15561 * 15562 * <p>Note: Overlays do not currently work correctly with {@link 15563 * SurfaceView} or {@link TextureView}; contents in overlays for these 15564 * types of views may not display correctly.</p> 15565 * 15566 * @return The ViewOverlay object for this view. 15567 * @see ViewOverlay 15568 */ 15569 public ViewOverlay getOverlay() { 15570 if (mOverlay == null) { 15571 mOverlay = new ViewOverlay(mContext, this); 15572 } 15573 return mOverlay; 15574 } 15575 15576 /** 15577 * Override this if your view is known to always be drawn on top of a solid color background, 15578 * and needs to draw fading edges. Returning a non-zero color enables the view system to 15579 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 15580 * should be set to 0xFF. 15581 * 15582 * @see #setVerticalFadingEdgeEnabled(boolean) 15583 * @see #setHorizontalFadingEdgeEnabled(boolean) 15584 * 15585 * @return The known solid color background for this view, or 0 if the color may vary 15586 */ 15587 @ViewDebug.ExportedProperty(category = "drawing") 15588 public int getSolidColor() { 15589 return 0; 15590 } 15591 15592 /** 15593 * Build a human readable string representation of the specified view flags. 15594 * 15595 * @param flags the view flags to convert to a string 15596 * @return a String representing the supplied flags 15597 */ 15598 private static String printFlags(int flags) { 15599 String output = ""; 15600 int numFlags = 0; 15601 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 15602 output += "TAKES_FOCUS"; 15603 numFlags++; 15604 } 15605 15606 switch (flags & VISIBILITY_MASK) { 15607 case INVISIBLE: 15608 if (numFlags > 0) { 15609 output += " "; 15610 } 15611 output += "INVISIBLE"; 15612 // USELESS HERE numFlags++; 15613 break; 15614 case GONE: 15615 if (numFlags > 0) { 15616 output += " "; 15617 } 15618 output += "GONE"; 15619 // USELESS HERE numFlags++; 15620 break; 15621 default: 15622 break; 15623 } 15624 return output; 15625 } 15626 15627 /** 15628 * Build a human readable string representation of the specified private 15629 * view flags. 15630 * 15631 * @param privateFlags the private view flags to convert to a string 15632 * @return a String representing the supplied flags 15633 */ 15634 private static String printPrivateFlags(int privateFlags) { 15635 String output = ""; 15636 int numFlags = 0; 15637 15638 if ((privateFlags & PFLAG_WANTS_FOCUS) == PFLAG_WANTS_FOCUS) { 15639 output += "WANTS_FOCUS"; 15640 numFlags++; 15641 } 15642 15643 if ((privateFlags & PFLAG_FOCUSED) == PFLAG_FOCUSED) { 15644 if (numFlags > 0) { 15645 output += " "; 15646 } 15647 output += "FOCUSED"; 15648 numFlags++; 15649 } 15650 15651 if ((privateFlags & PFLAG_SELECTED) == PFLAG_SELECTED) { 15652 if (numFlags > 0) { 15653 output += " "; 15654 } 15655 output += "SELECTED"; 15656 numFlags++; 15657 } 15658 15659 if ((privateFlags & PFLAG_IS_ROOT_NAMESPACE) == PFLAG_IS_ROOT_NAMESPACE) { 15660 if (numFlags > 0) { 15661 output += " "; 15662 } 15663 output += "IS_ROOT_NAMESPACE"; 15664 numFlags++; 15665 } 15666 15667 if ((privateFlags & PFLAG_HAS_BOUNDS) == PFLAG_HAS_BOUNDS) { 15668 if (numFlags > 0) { 15669 output += " "; 15670 } 15671 output += "HAS_BOUNDS"; 15672 numFlags++; 15673 } 15674 15675 if ((privateFlags & PFLAG_DRAWN) == PFLAG_DRAWN) { 15676 if (numFlags > 0) { 15677 output += " "; 15678 } 15679 output += "DRAWN"; 15680 // USELESS HERE numFlags++; 15681 } 15682 return output; 15683 } 15684 15685 /** 15686 * <p>Indicates whether or not this view's layout will be requested during 15687 * the next hierarchy layout pass.</p> 15688 * 15689 * @return true if the layout will be forced during next layout pass 15690 */ 15691 public boolean isLayoutRequested() { 15692 return (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 15693 } 15694 15695 /** 15696 * Return true if o is a ViewGroup that is laying out using optical bounds. 15697 * @hide 15698 */ 15699 public static boolean isLayoutModeOptical(Object o) { 15700 return o instanceof ViewGroup && ((ViewGroup) o).isLayoutModeOptical(); 15701 } 15702 15703 private boolean setOpticalFrame(int left, int top, int right, int bottom) { 15704 Insets parentInsets = mParent instanceof View ? 15705 ((View) mParent).getOpticalInsets() : Insets.NONE; 15706 Insets childInsets = getOpticalInsets(); 15707 return setFrame( 15708 left + parentInsets.left - childInsets.left, 15709 top + parentInsets.top - childInsets.top, 15710 right + parentInsets.left + childInsets.right, 15711 bottom + parentInsets.top + childInsets.bottom); 15712 } 15713 15714 /** 15715 * Assign a size and position to a view and all of its 15716 * descendants 15717 * 15718 * <p>This is the second phase of the layout mechanism. 15719 * (The first is measuring). In this phase, each parent calls 15720 * layout on all of its children to position them. 15721 * This is typically done using the child measurements 15722 * that were stored in the measure pass().</p> 15723 * 15724 * <p>Derived classes should not override this method. 15725 * Derived classes with children should override 15726 * onLayout. In that method, they should 15727 * call layout on each of their children.</p> 15728 * 15729 * @param l Left position, relative to parent 15730 * @param t Top position, relative to parent 15731 * @param r Right position, relative to parent 15732 * @param b Bottom position, relative to parent 15733 */ 15734 @SuppressWarnings({"unchecked"}) 15735 public void layout(int l, int t, int r, int b) { 15736 if ((mPrivateFlags3 & PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT) != 0) { 15737 onMeasure(mOldWidthMeasureSpec, mOldHeightMeasureSpec); 15738 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 15739 } 15740 15741 int oldL = mLeft; 15742 int oldT = mTop; 15743 int oldB = mBottom; 15744 int oldR = mRight; 15745 15746 boolean changed = isLayoutModeOptical(mParent) ? 15747 setOpticalFrame(l, t, r, b) : setFrame(l, t, r, b); 15748 15749 if (changed || (mPrivateFlags & PFLAG_LAYOUT_REQUIRED) == PFLAG_LAYOUT_REQUIRED) { 15750 onLayout(changed, l, t, r, b); 15751 mPrivateFlags &= ~PFLAG_LAYOUT_REQUIRED; 15752 15753 ListenerInfo li = mListenerInfo; 15754 if (li != null && li.mOnLayoutChangeListeners != null) { 15755 ArrayList<OnLayoutChangeListener> listenersCopy = 15756 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 15757 int numListeners = listenersCopy.size(); 15758 for (int i = 0; i < numListeners; ++i) { 15759 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 15760 } 15761 } 15762 } 15763 15764 mPrivateFlags &= ~PFLAG_FORCE_LAYOUT; 15765 mPrivateFlags3 |= PFLAG3_IS_LAID_OUT; 15766 } 15767 15768 /** 15769 * Called from layout when this view should 15770 * assign a size and position to each of its children. 15771 * 15772 * Derived classes with children should override 15773 * this method and call layout on each of 15774 * their children. 15775 * @param changed This is a new size or position for this view 15776 * @param left Left position, relative to parent 15777 * @param top Top position, relative to parent 15778 * @param right Right position, relative to parent 15779 * @param bottom Bottom position, relative to parent 15780 */ 15781 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 15782 } 15783 15784 /** 15785 * Assign a size and position to this view. 15786 * 15787 * This is called from layout. 15788 * 15789 * @param left Left position, relative to parent 15790 * @param top Top position, relative to parent 15791 * @param right Right position, relative to parent 15792 * @param bottom Bottom position, relative to parent 15793 * @return true if the new size and position are different than the 15794 * previous ones 15795 * {@hide} 15796 */ 15797 protected boolean setFrame(int left, int top, int right, int bottom) { 15798 boolean changed = false; 15799 15800 if (DBG) { 15801 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 15802 + right + "," + bottom + ")"); 15803 } 15804 15805 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 15806 changed = true; 15807 15808 // Remember our drawn bit 15809 int drawn = mPrivateFlags & PFLAG_DRAWN; 15810 15811 int oldWidth = mRight - mLeft; 15812 int oldHeight = mBottom - mTop; 15813 int newWidth = right - left; 15814 int newHeight = bottom - top; 15815 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 15816 15817 // Invalidate our old position 15818 invalidate(sizeChanged); 15819 15820 mLeft = left; 15821 mTop = top; 15822 mRight = right; 15823 mBottom = bottom; 15824 mRenderNode.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 15825 15826 mPrivateFlags |= PFLAG_HAS_BOUNDS; 15827 15828 15829 if (sizeChanged) { 15830 sizeChange(newWidth, newHeight, oldWidth, oldHeight); 15831 } 15832 15833 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE || mGhostView != null) { 15834 // If we are visible, force the DRAWN bit to on so that 15835 // this invalidate will go through (at least to our parent). 15836 // This is because someone may have invalidated this view 15837 // before this call to setFrame came in, thereby clearing 15838 // the DRAWN bit. 15839 mPrivateFlags |= PFLAG_DRAWN; 15840 invalidate(sizeChanged); 15841 // parent display list may need to be recreated based on a change in the bounds 15842 // of any child 15843 invalidateParentCaches(); 15844 } 15845 15846 // Reset drawn bit to original value (invalidate turns it off) 15847 mPrivateFlags |= drawn; 15848 15849 mBackgroundSizeChanged = true; 15850 15851 notifySubtreeAccessibilityStateChangedIfNeeded(); 15852 } 15853 return changed; 15854 } 15855 15856 /** 15857 * Same as setFrame, but public and hidden. For use in {@link android.transition.ChangeBounds}. 15858 * @hide 15859 */ 15860 public void setLeftTopRightBottom(int left, int top, int right, int bottom) { 15861 setFrame(left, top, right, bottom); 15862 } 15863 15864 private void sizeChange(int newWidth, int newHeight, int oldWidth, int oldHeight) { 15865 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 15866 if (mOverlay != null) { 15867 mOverlay.getOverlayView().setRight(newWidth); 15868 mOverlay.getOverlayView().setBottom(newHeight); 15869 } 15870 rebuildOutline(); 15871 } 15872 15873 /** 15874 * Finalize inflating a view from XML. This is called as the last phase 15875 * of inflation, after all child views have been added. 15876 * 15877 * <p>Even if the subclass overrides onFinishInflate, they should always be 15878 * sure to call the super method, so that we get called. 15879 */ 15880 protected void onFinishInflate() { 15881 } 15882 15883 /** 15884 * Returns the resources associated with this view. 15885 * 15886 * @return Resources object. 15887 */ 15888 public Resources getResources() { 15889 return mResources; 15890 } 15891 15892 /** 15893 * Invalidates the specified Drawable. 15894 * 15895 * @param drawable the drawable to invalidate 15896 */ 15897 @Override 15898 public void invalidateDrawable(@NonNull Drawable drawable) { 15899 if (verifyDrawable(drawable)) { 15900 final Rect dirty = drawable.getDirtyBounds(); 15901 final int scrollX = mScrollX; 15902 final int scrollY = mScrollY; 15903 15904 invalidate(dirty.left + scrollX, dirty.top + scrollY, 15905 dirty.right + scrollX, dirty.bottom + scrollY); 15906 rebuildOutline(); 15907 } 15908 } 15909 15910 /** 15911 * Schedules an action on a drawable to occur at a specified time. 15912 * 15913 * @param who the recipient of the action 15914 * @param what the action to run on the drawable 15915 * @param when the time at which the action must occur. Uses the 15916 * {@link SystemClock#uptimeMillis} timebase. 15917 */ 15918 @Override 15919 public void scheduleDrawable(Drawable who, Runnable what, long when) { 15920 if (verifyDrawable(who) && what != null) { 15921 final long delay = when - SystemClock.uptimeMillis(); 15922 if (mAttachInfo != null) { 15923 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 15924 Choreographer.CALLBACK_ANIMATION, what, who, 15925 Choreographer.subtractFrameDelay(delay)); 15926 } else { 15927 ViewRootImpl.getRunQueue().postDelayed(what, delay); 15928 } 15929 } 15930 } 15931 15932 /** 15933 * Cancels a scheduled action on a drawable. 15934 * 15935 * @param who the recipient of the action 15936 * @param what the action to cancel 15937 */ 15938 @Override 15939 public void unscheduleDrawable(Drawable who, Runnable what) { 15940 if (verifyDrawable(who) && what != null) { 15941 if (mAttachInfo != null) { 15942 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15943 Choreographer.CALLBACK_ANIMATION, what, who); 15944 } 15945 ViewRootImpl.getRunQueue().removeCallbacks(what); 15946 } 15947 } 15948 15949 /** 15950 * Unschedule any events associated with the given Drawable. This can be 15951 * used when selecting a new Drawable into a view, so that the previous 15952 * one is completely unscheduled. 15953 * 15954 * @param who The Drawable to unschedule. 15955 * 15956 * @see #drawableStateChanged 15957 */ 15958 public void unscheduleDrawable(Drawable who) { 15959 if (mAttachInfo != null && who != null) { 15960 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15961 Choreographer.CALLBACK_ANIMATION, null, who); 15962 } 15963 } 15964 15965 /** 15966 * Resolve the Drawables depending on the layout direction. This is implicitly supposing 15967 * that the View directionality can and will be resolved before its Drawables. 15968 * 15969 * Will call {@link View#onResolveDrawables} when resolution is done. 15970 * 15971 * @hide 15972 */ 15973 protected void resolveDrawables() { 15974 // Drawables resolution may need to happen before resolving the layout direction (which is 15975 // done only during the measure() call). 15976 // If the layout direction is not resolved yet, we cannot resolve the Drawables except in 15977 // one case: when the raw layout direction has not been defined as LAYOUT_DIRECTION_INHERIT. 15978 // So, if the raw layout direction is LAYOUT_DIRECTION_LTR or LAYOUT_DIRECTION_RTL or 15979 // LAYOUT_DIRECTION_LOCALE, we can "cheat" and we don't need to wait for the layout 15980 // direction to be resolved as its resolved value will be the same as its raw value. 15981 if (!isLayoutDirectionResolved() && 15982 getRawLayoutDirection() == View.LAYOUT_DIRECTION_INHERIT) { 15983 return; 15984 } 15985 15986 final int layoutDirection = isLayoutDirectionResolved() ? 15987 getLayoutDirection() : getRawLayoutDirection(); 15988 15989 if (mBackground != null) { 15990 mBackground.setLayoutDirection(layoutDirection); 15991 } 15992 mPrivateFlags2 |= PFLAG2_DRAWABLE_RESOLVED; 15993 onResolveDrawables(layoutDirection); 15994 } 15995 15996 boolean areDrawablesResolved() { 15997 return (mPrivateFlags2 & PFLAG2_DRAWABLE_RESOLVED) == PFLAG2_DRAWABLE_RESOLVED; 15998 } 15999 16000 /** 16001 * Called when layout direction has been resolved. 16002 * 16003 * The default implementation does nothing. 16004 * 16005 * @param layoutDirection The resolved layout direction. 16006 * 16007 * @see #LAYOUT_DIRECTION_LTR 16008 * @see #LAYOUT_DIRECTION_RTL 16009 * 16010 * @hide 16011 */ 16012 public void onResolveDrawables(@ResolvedLayoutDir int layoutDirection) { 16013 } 16014 16015 /** 16016 * @hide 16017 */ 16018 protected void resetResolvedDrawables() { 16019 resetResolvedDrawablesInternal(); 16020 } 16021 16022 void resetResolvedDrawablesInternal() { 16023 mPrivateFlags2 &= ~PFLAG2_DRAWABLE_RESOLVED; 16024 } 16025 16026 /** 16027 * If your view subclass is displaying its own Drawable objects, it should 16028 * override this function and return true for any Drawable it is 16029 * displaying. This allows animations for those drawables to be 16030 * scheduled. 16031 * 16032 * <p>Be sure to call through to the super class when overriding this 16033 * function. 16034 * 16035 * @param who The Drawable to verify. Return true if it is one you are 16036 * displaying, else return the result of calling through to the 16037 * super class. 16038 * 16039 * @return boolean If true than the Drawable is being displayed in the 16040 * view; else false and it is not allowed to animate. 16041 * 16042 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 16043 * @see #drawableStateChanged() 16044 */ 16045 protected boolean verifyDrawable(Drawable who) { 16046 return who == mBackground; 16047 } 16048 16049 /** 16050 * This function is called whenever the state of the view changes in such 16051 * a way that it impacts the state of drawables being shown. 16052 * <p> 16053 * If the View has a StateListAnimator, it will also be called to run necessary state 16054 * change animations. 16055 * <p> 16056 * Be sure to call through to the superclass when overriding this function. 16057 * 16058 * @see Drawable#setState(int[]) 16059 */ 16060 protected void drawableStateChanged() { 16061 final Drawable d = mBackground; 16062 if (d != null && d.isStateful()) { 16063 d.setState(getDrawableState()); 16064 } 16065 16066 if (mStateListAnimator != null) { 16067 mStateListAnimator.setState(getDrawableState()); 16068 } 16069 } 16070 16071 /** 16072 * This function is called whenever the view hotspot changes and needs to 16073 * be propagated to drawables or child views managed by the view. 16074 * <p> 16075 * Dispatching to child views is handled by 16076 * {@link #dispatchDrawableHotspotChanged(float, float)}. 16077 * <p> 16078 * Be sure to call through to the superclass when overriding this function. 16079 * 16080 * @param x hotspot x coordinate 16081 * @param y hotspot y coordinate 16082 */ 16083 public void drawableHotspotChanged(float x, float y) { 16084 if (mBackground != null) { 16085 mBackground.setHotspot(x, y); 16086 } 16087 16088 dispatchDrawableHotspotChanged(x, y); 16089 } 16090 16091 /** 16092 * Dispatches drawableHotspotChanged to all of this View's children. 16093 * 16094 * @param x hotspot x coordinate 16095 * @param y hotspot y coordinate 16096 * @see #drawableHotspotChanged(float, float) 16097 */ 16098 public void dispatchDrawableHotspotChanged(float x, float y) { 16099 } 16100 16101 /** 16102 * Call this to force a view to update its drawable state. This will cause 16103 * drawableStateChanged to be called on this view. Views that are interested 16104 * in the new state should call getDrawableState. 16105 * 16106 * @see #drawableStateChanged 16107 * @see #getDrawableState 16108 */ 16109 public void refreshDrawableState() { 16110 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 16111 drawableStateChanged(); 16112 16113 ViewParent parent = mParent; 16114 if (parent != null) { 16115 parent.childDrawableStateChanged(this); 16116 } 16117 } 16118 16119 /** 16120 * Return an array of resource IDs of the drawable states representing the 16121 * current state of the view. 16122 * 16123 * @return The current drawable state 16124 * 16125 * @see Drawable#setState(int[]) 16126 * @see #drawableStateChanged() 16127 * @see #onCreateDrawableState(int) 16128 */ 16129 public final int[] getDrawableState() { 16130 if ((mDrawableState != null) && ((mPrivateFlags & PFLAG_DRAWABLE_STATE_DIRTY) == 0)) { 16131 return mDrawableState; 16132 } else { 16133 mDrawableState = onCreateDrawableState(0); 16134 mPrivateFlags &= ~PFLAG_DRAWABLE_STATE_DIRTY; 16135 return mDrawableState; 16136 } 16137 } 16138 16139 /** 16140 * Generate the new {@link android.graphics.drawable.Drawable} state for 16141 * this view. This is called by the view 16142 * system when the cached Drawable state is determined to be invalid. To 16143 * retrieve the current state, you should use {@link #getDrawableState}. 16144 * 16145 * @param extraSpace if non-zero, this is the number of extra entries you 16146 * would like in the returned array in which you can place your own 16147 * states. 16148 * 16149 * @return Returns an array holding the current {@link Drawable} state of 16150 * the view. 16151 * 16152 * @see #mergeDrawableStates(int[], int[]) 16153 */ 16154 protected int[] onCreateDrawableState(int extraSpace) { 16155 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 16156 mParent instanceof View) { 16157 return ((View) mParent).onCreateDrawableState(extraSpace); 16158 } 16159 16160 int[] drawableState; 16161 16162 int privateFlags = mPrivateFlags; 16163 16164 int viewStateIndex = 0; 16165 if ((privateFlags & PFLAG_PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 16166 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 16167 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 16168 if ((privateFlags & PFLAG_SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 16169 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 16170 if ((privateFlags & PFLAG_ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 16171 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 16172 HardwareRenderer.isAvailable()) { 16173 // This is set if HW acceleration is requested, even if the current 16174 // process doesn't allow it. This is just to allow app preview 16175 // windows to better match their app. 16176 viewStateIndex |= VIEW_STATE_ACCELERATED; 16177 } 16178 if ((privateFlags & PFLAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 16179 16180 final int privateFlags2 = mPrivateFlags2; 16181 if ((privateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 16182 if ((privateFlags2 & PFLAG2_DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 16183 16184 drawableState = VIEW_STATE_SETS[viewStateIndex]; 16185 16186 //noinspection ConstantIfStatement 16187 if (false) { 16188 Log.i("View", "drawableStateIndex=" + viewStateIndex); 16189 Log.i("View", toString() 16190 + " pressed=" + ((privateFlags & PFLAG_PRESSED) != 0) 16191 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 16192 + " fo=" + hasFocus() 16193 + " sl=" + ((privateFlags & PFLAG_SELECTED) != 0) 16194 + " wf=" + hasWindowFocus() 16195 + ": " + Arrays.toString(drawableState)); 16196 } 16197 16198 if (extraSpace == 0) { 16199 return drawableState; 16200 } 16201 16202 final int[] fullState; 16203 if (drawableState != null) { 16204 fullState = new int[drawableState.length + extraSpace]; 16205 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 16206 } else { 16207 fullState = new int[extraSpace]; 16208 } 16209 16210 return fullState; 16211 } 16212 16213 /** 16214 * Merge your own state values in <var>additionalState</var> into the base 16215 * state values <var>baseState</var> that were returned by 16216 * {@link #onCreateDrawableState(int)}. 16217 * 16218 * @param baseState The base state values returned by 16219 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 16220 * own additional state values. 16221 * 16222 * @param additionalState The additional state values you would like 16223 * added to <var>baseState</var>; this array is not modified. 16224 * 16225 * @return As a convenience, the <var>baseState</var> array you originally 16226 * passed into the function is returned. 16227 * 16228 * @see #onCreateDrawableState(int) 16229 */ 16230 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 16231 final int N = baseState.length; 16232 int i = N - 1; 16233 while (i >= 0 && baseState[i] == 0) { 16234 i--; 16235 } 16236 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 16237 return baseState; 16238 } 16239 16240 /** 16241 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 16242 * on all Drawable objects associated with this view. 16243 * <p> 16244 * Also calls {@link StateListAnimator#jumpToCurrentState()} if there is a StateListAnimator 16245 * attached to this view. 16246 */ 16247 public void jumpDrawablesToCurrentState() { 16248 if (mBackground != null) { 16249 mBackground.jumpToCurrentState(); 16250 } 16251 if (mStateListAnimator != null) { 16252 mStateListAnimator.jumpToCurrentState(); 16253 } 16254 } 16255 16256 /** 16257 * Sets the background color for this view. 16258 * @param color the color of the background 16259 */ 16260 @RemotableViewMethod 16261 public void setBackgroundColor(int color) { 16262 if (mBackground instanceof ColorDrawable) { 16263 ((ColorDrawable) mBackground.mutate()).setColor(color); 16264 computeOpaqueFlags(); 16265 mBackgroundResource = 0; 16266 } else { 16267 setBackground(new ColorDrawable(color)); 16268 } 16269 } 16270 16271 /** 16272 * Set the background to a given resource. The resource should refer to 16273 * a Drawable object or 0 to remove the background. 16274 * @param resid The identifier of the resource. 16275 * 16276 * @attr ref android.R.styleable#View_background 16277 */ 16278 @RemotableViewMethod 16279 public void setBackgroundResource(int resid) { 16280 if (resid != 0 && resid == mBackgroundResource) { 16281 return; 16282 } 16283 16284 Drawable d = null; 16285 if (resid != 0) { 16286 d = mContext.getDrawable(resid); 16287 } 16288 setBackground(d); 16289 16290 mBackgroundResource = resid; 16291 } 16292 16293 /** 16294 * Set the background to a given Drawable, or remove the background. If the 16295 * background has padding, this View's padding is set to the background's 16296 * padding. However, when a background is removed, this View's padding isn't 16297 * touched. If setting the padding is desired, please use 16298 * {@link #setPadding(int, int, int, int)}. 16299 * 16300 * @param background The Drawable to use as the background, or null to remove the 16301 * background 16302 */ 16303 public void setBackground(Drawable background) { 16304 //noinspection deprecation 16305 setBackgroundDrawable(background); 16306 } 16307 16308 /** 16309 * @deprecated use {@link #setBackground(Drawable)} instead 16310 */ 16311 @Deprecated 16312 public void setBackgroundDrawable(Drawable background) { 16313 computeOpaqueFlags(); 16314 16315 if (background == mBackground) { 16316 return; 16317 } 16318 16319 boolean requestLayout = false; 16320 16321 mBackgroundResource = 0; 16322 16323 /* 16324 * Regardless of whether we're setting a new background or not, we want 16325 * to clear the previous drawable. 16326 */ 16327 if (mBackground != null) { 16328 mBackground.setCallback(null); 16329 unscheduleDrawable(mBackground); 16330 } 16331 16332 if (background != null) { 16333 Rect padding = sThreadLocal.get(); 16334 if (padding == null) { 16335 padding = new Rect(); 16336 sThreadLocal.set(padding); 16337 } 16338 resetResolvedDrawablesInternal(); 16339 background.setLayoutDirection(getLayoutDirection()); 16340 if (background.getPadding(padding)) { 16341 resetResolvedPaddingInternal(); 16342 switch (background.getLayoutDirection()) { 16343 case LAYOUT_DIRECTION_RTL: 16344 mUserPaddingLeftInitial = padding.right; 16345 mUserPaddingRightInitial = padding.left; 16346 internalSetPadding(padding.right, padding.top, padding.left, padding.bottom); 16347 break; 16348 case LAYOUT_DIRECTION_LTR: 16349 default: 16350 mUserPaddingLeftInitial = padding.left; 16351 mUserPaddingRightInitial = padding.right; 16352 internalSetPadding(padding.left, padding.top, padding.right, padding.bottom); 16353 } 16354 mLeftPaddingDefined = false; 16355 mRightPaddingDefined = false; 16356 } 16357 16358 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 16359 // if it has a different minimum size, we should layout again 16360 if (mBackground == null 16361 || mBackground.getMinimumHeight() != background.getMinimumHeight() 16362 || mBackground.getMinimumWidth() != background.getMinimumWidth()) { 16363 requestLayout = true; 16364 } 16365 16366 background.setCallback(this); 16367 if (background.isStateful()) { 16368 background.setState(getDrawableState()); 16369 } 16370 background.setVisible(getVisibility() == VISIBLE, false); 16371 mBackground = background; 16372 16373 applyBackgroundTint(); 16374 16375 if ((mPrivateFlags & PFLAG_SKIP_DRAW) != 0) { 16376 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 16377 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 16378 requestLayout = true; 16379 } 16380 } else { 16381 /* Remove the background */ 16382 mBackground = null; 16383 16384 if ((mPrivateFlags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0) { 16385 /* 16386 * This view ONLY drew the background before and we're removing 16387 * the background, so now it won't draw anything 16388 * (hence we SKIP_DRAW) 16389 */ 16390 mPrivateFlags &= ~PFLAG_ONLY_DRAWS_BACKGROUND; 16391 mPrivateFlags |= PFLAG_SKIP_DRAW; 16392 } 16393 16394 /* 16395 * When the background is set, we try to apply its padding to this 16396 * View. When the background is removed, we don't touch this View's 16397 * padding. This is noted in the Javadocs. Hence, we don't need to 16398 * requestLayout(), the invalidate() below is sufficient. 16399 */ 16400 16401 // The old background's minimum size could have affected this 16402 // View's layout, so let's requestLayout 16403 requestLayout = true; 16404 } 16405 16406 computeOpaqueFlags(); 16407 16408 if (requestLayout) { 16409 requestLayout(); 16410 } 16411 16412 mBackgroundSizeChanged = true; 16413 invalidate(true); 16414 } 16415 16416 /** 16417 * Gets the background drawable 16418 * 16419 * @return The drawable used as the background for this view, if any. 16420 * 16421 * @see #setBackground(Drawable) 16422 * 16423 * @attr ref android.R.styleable#View_background 16424 */ 16425 public Drawable getBackground() { 16426 return mBackground; 16427 } 16428 16429 /** 16430 * Applies a tint to the background drawable. Does not modify the current tint 16431 * mode, which is {@link PorterDuff.Mode#SRC_IN} by default. 16432 * <p> 16433 * Subsequent calls to {@link #setBackground(Drawable)} will automatically 16434 * mutate the drawable and apply the specified tint and tint mode using 16435 * {@link Drawable#setTintList(ColorStateList)}. 16436 * 16437 * @param tint the tint to apply, may be {@code null} to clear tint 16438 * 16439 * @attr ref android.R.styleable#View_backgroundTint 16440 * @see #getBackgroundTintList() 16441 * @see Drawable#setTintList(ColorStateList) 16442 */ 16443 public void setBackgroundTintList(@Nullable ColorStateList tint) { 16444 if (mBackgroundTint == null) { 16445 mBackgroundTint = new TintInfo(); 16446 } 16447 mBackgroundTint.mTintList = tint; 16448 mBackgroundTint.mHasTintList = true; 16449 16450 applyBackgroundTint(); 16451 } 16452 16453 /** 16454 * Return the tint applied to the background drawable, if specified. 16455 * 16456 * @return the tint applied to the background drawable 16457 * @attr ref android.R.styleable#View_backgroundTint 16458 * @see #setBackgroundTintList(ColorStateList) 16459 */ 16460 @Nullable 16461 public ColorStateList getBackgroundTintList() { 16462 return mBackgroundTint != null ? mBackgroundTint.mTintList : null; 16463 } 16464 16465 /** 16466 * Specifies the blending mode used to apply the tint specified by 16467 * {@link #setBackgroundTintList(ColorStateList)}} to the background 16468 * drawable. The default mode is {@link PorterDuff.Mode#SRC_IN}. 16469 * 16470 * @param tintMode the blending mode used to apply the tint, may be 16471 * {@code null} to clear tint 16472 * @attr ref android.R.styleable#View_backgroundTintMode 16473 * @see #getBackgroundTintMode() 16474 * @see Drawable#setTintMode(PorterDuff.Mode) 16475 */ 16476 public void setBackgroundTintMode(@Nullable PorterDuff.Mode tintMode) { 16477 if (mBackgroundTint == null) { 16478 mBackgroundTint = new TintInfo(); 16479 } 16480 mBackgroundTint.mTintMode = tintMode; 16481 mBackgroundTint.mHasTintMode = true; 16482 16483 applyBackgroundTint(); 16484 } 16485 16486 /** 16487 * Return the blending mode used to apply the tint to the background 16488 * drawable, if specified. 16489 * 16490 * @return the blending mode used to apply the tint to the background 16491 * drawable 16492 * @attr ref android.R.styleable#View_backgroundTintMode 16493 * @see #setBackgroundTintMode(PorterDuff.Mode) 16494 */ 16495 @Nullable 16496 public PorterDuff.Mode getBackgroundTintMode() { 16497 return mBackgroundTint != null ? mBackgroundTint.mTintMode : null; 16498 } 16499 16500 private void applyBackgroundTint() { 16501 if (mBackground != null && mBackgroundTint != null) { 16502 final TintInfo tintInfo = mBackgroundTint; 16503 if (tintInfo.mHasTintList || tintInfo.mHasTintMode) { 16504 mBackground = mBackground.mutate(); 16505 16506 if (tintInfo.mHasTintList) { 16507 mBackground.setTintList(tintInfo.mTintList); 16508 } 16509 16510 if (tintInfo.mHasTintMode) { 16511 mBackground.setTintMode(tintInfo.mTintMode); 16512 } 16513 16514 // The drawable (or one of its children) may not have been 16515 // stateful before applying the tint, so let's try again. 16516 if (mBackground.isStateful()) { 16517 mBackground.setState(getDrawableState()); 16518 } 16519 } 16520 } 16521 } 16522 16523 /** 16524 * Sets the padding. The view may add on the space required to display 16525 * the scrollbars, depending on the style and visibility of the scrollbars. 16526 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 16527 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 16528 * from the values set in this call. 16529 * 16530 * @attr ref android.R.styleable#View_padding 16531 * @attr ref android.R.styleable#View_paddingBottom 16532 * @attr ref android.R.styleable#View_paddingLeft 16533 * @attr ref android.R.styleable#View_paddingRight 16534 * @attr ref android.R.styleable#View_paddingTop 16535 * @param left the left padding in pixels 16536 * @param top the top padding in pixels 16537 * @param right the right padding in pixels 16538 * @param bottom the bottom padding in pixels 16539 */ 16540 public void setPadding(int left, int top, int right, int bottom) { 16541 resetResolvedPaddingInternal(); 16542 16543 mUserPaddingStart = UNDEFINED_PADDING; 16544 mUserPaddingEnd = UNDEFINED_PADDING; 16545 16546 mUserPaddingLeftInitial = left; 16547 mUserPaddingRightInitial = right; 16548 16549 mLeftPaddingDefined = true; 16550 mRightPaddingDefined = true; 16551 16552 internalSetPadding(left, top, right, bottom); 16553 } 16554 16555 /** 16556 * @hide 16557 */ 16558 protected void internalSetPadding(int left, int top, int right, int bottom) { 16559 mUserPaddingLeft = left; 16560 mUserPaddingRight = right; 16561 mUserPaddingBottom = bottom; 16562 16563 final int viewFlags = mViewFlags; 16564 boolean changed = false; 16565 16566 // Common case is there are no scroll bars. 16567 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 16568 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 16569 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 16570 ? 0 : getVerticalScrollbarWidth(); 16571 switch (mVerticalScrollbarPosition) { 16572 case SCROLLBAR_POSITION_DEFAULT: 16573 if (isLayoutRtl()) { 16574 left += offset; 16575 } else { 16576 right += offset; 16577 } 16578 break; 16579 case SCROLLBAR_POSITION_RIGHT: 16580 right += offset; 16581 break; 16582 case SCROLLBAR_POSITION_LEFT: 16583 left += offset; 16584 break; 16585 } 16586 } 16587 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 16588 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 16589 ? 0 : getHorizontalScrollbarHeight(); 16590 } 16591 } 16592 16593 if (mPaddingLeft != left) { 16594 changed = true; 16595 mPaddingLeft = left; 16596 } 16597 if (mPaddingTop != top) { 16598 changed = true; 16599 mPaddingTop = top; 16600 } 16601 if (mPaddingRight != right) { 16602 changed = true; 16603 mPaddingRight = right; 16604 } 16605 if (mPaddingBottom != bottom) { 16606 changed = true; 16607 mPaddingBottom = bottom; 16608 } 16609 16610 if (changed) { 16611 requestLayout(); 16612 } 16613 } 16614 16615 /** 16616 * Sets the relative padding. The view may add on the space required to display 16617 * the scrollbars, depending on the style and visibility of the scrollbars. 16618 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 16619 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 16620 * from the values set in this call. 16621 * 16622 * @attr ref android.R.styleable#View_padding 16623 * @attr ref android.R.styleable#View_paddingBottom 16624 * @attr ref android.R.styleable#View_paddingStart 16625 * @attr ref android.R.styleable#View_paddingEnd 16626 * @attr ref android.R.styleable#View_paddingTop 16627 * @param start the start padding in pixels 16628 * @param top the top padding in pixels 16629 * @param end the end padding in pixels 16630 * @param bottom the bottom padding in pixels 16631 */ 16632 public void setPaddingRelative(int start, int top, int end, int bottom) { 16633 resetResolvedPaddingInternal(); 16634 16635 mUserPaddingStart = start; 16636 mUserPaddingEnd = end; 16637 mLeftPaddingDefined = true; 16638 mRightPaddingDefined = true; 16639 16640 switch(getLayoutDirection()) { 16641 case LAYOUT_DIRECTION_RTL: 16642 mUserPaddingLeftInitial = end; 16643 mUserPaddingRightInitial = start; 16644 internalSetPadding(end, top, start, bottom); 16645 break; 16646 case LAYOUT_DIRECTION_LTR: 16647 default: 16648 mUserPaddingLeftInitial = start; 16649 mUserPaddingRightInitial = end; 16650 internalSetPadding(start, top, end, bottom); 16651 } 16652 } 16653 16654 /** 16655 * Returns the top padding of this view. 16656 * 16657 * @return the top padding in pixels 16658 */ 16659 public int getPaddingTop() { 16660 return mPaddingTop; 16661 } 16662 16663 /** 16664 * Returns the bottom padding of this view. If there are inset and enabled 16665 * scrollbars, this value may include the space required to display the 16666 * scrollbars as well. 16667 * 16668 * @return the bottom padding in pixels 16669 */ 16670 public int getPaddingBottom() { 16671 return mPaddingBottom; 16672 } 16673 16674 /** 16675 * Returns the left padding of this view. If there are inset and enabled 16676 * scrollbars, this value may include the space required to display the 16677 * scrollbars as well. 16678 * 16679 * @return the left padding in pixels 16680 */ 16681 public int getPaddingLeft() { 16682 if (!isPaddingResolved()) { 16683 resolvePadding(); 16684 } 16685 return mPaddingLeft; 16686 } 16687 16688 /** 16689 * Returns the start padding of this view depending on its resolved layout direction. 16690 * If there are inset and enabled scrollbars, this value may include the space 16691 * required to display the scrollbars as well. 16692 * 16693 * @return the start padding in pixels 16694 */ 16695 public int getPaddingStart() { 16696 if (!isPaddingResolved()) { 16697 resolvePadding(); 16698 } 16699 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16700 mPaddingRight : mPaddingLeft; 16701 } 16702 16703 /** 16704 * Returns the right padding of this view. If there are inset and enabled 16705 * scrollbars, this value may include the space required to display the 16706 * scrollbars as well. 16707 * 16708 * @return the right padding in pixels 16709 */ 16710 public int getPaddingRight() { 16711 if (!isPaddingResolved()) { 16712 resolvePadding(); 16713 } 16714 return mPaddingRight; 16715 } 16716 16717 /** 16718 * Returns the end padding of this view depending on its resolved layout direction. 16719 * If there are inset and enabled scrollbars, this value may include the space 16720 * required to display the scrollbars as well. 16721 * 16722 * @return the end padding in pixels 16723 */ 16724 public int getPaddingEnd() { 16725 if (!isPaddingResolved()) { 16726 resolvePadding(); 16727 } 16728 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16729 mPaddingLeft : mPaddingRight; 16730 } 16731 16732 /** 16733 * Return if the padding as been set thru relative values 16734 * {@link #setPaddingRelative(int, int, int, int)} or thru 16735 * @attr ref android.R.styleable#View_paddingStart or 16736 * @attr ref android.R.styleable#View_paddingEnd 16737 * 16738 * @return true if the padding is relative or false if it is not. 16739 */ 16740 public boolean isPaddingRelative() { 16741 return (mUserPaddingStart != UNDEFINED_PADDING || mUserPaddingEnd != UNDEFINED_PADDING); 16742 } 16743 16744 Insets computeOpticalInsets() { 16745 return (mBackground == null) ? Insets.NONE : mBackground.getOpticalInsets(); 16746 } 16747 16748 /** 16749 * @hide 16750 */ 16751 public void resetPaddingToInitialValues() { 16752 if (isRtlCompatibilityMode()) { 16753 mPaddingLeft = mUserPaddingLeftInitial; 16754 mPaddingRight = mUserPaddingRightInitial; 16755 return; 16756 } 16757 if (isLayoutRtl()) { 16758 mPaddingLeft = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingLeftInitial; 16759 mPaddingRight = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingRightInitial; 16760 } else { 16761 mPaddingLeft = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingLeftInitial; 16762 mPaddingRight = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingRightInitial; 16763 } 16764 } 16765 16766 /** 16767 * @hide 16768 */ 16769 public Insets getOpticalInsets() { 16770 if (mLayoutInsets == null) { 16771 mLayoutInsets = computeOpticalInsets(); 16772 } 16773 return mLayoutInsets; 16774 } 16775 16776 /** 16777 * Set this view's optical insets. 16778 * 16779 * <p>This method should be treated similarly to setMeasuredDimension and not as a general 16780 * property. Views that compute their own optical insets should call it as part of measurement. 16781 * This method does not request layout. If you are setting optical insets outside of 16782 * measure/layout itself you will want to call requestLayout() yourself. 16783 * </p> 16784 * @hide 16785 */ 16786 public void setOpticalInsets(Insets insets) { 16787 mLayoutInsets = insets; 16788 } 16789 16790 /** 16791 * Changes the selection state of this view. A view can be selected or not. 16792 * Note that selection is not the same as focus. Views are typically 16793 * selected in the context of an AdapterView like ListView or GridView; 16794 * the selected view is the view that is highlighted. 16795 * 16796 * @param selected true if the view must be selected, false otherwise 16797 */ 16798 public void setSelected(boolean selected) { 16799 //noinspection DoubleNegation 16800 if (((mPrivateFlags & PFLAG_SELECTED) != 0) != selected) { 16801 mPrivateFlags = (mPrivateFlags & ~PFLAG_SELECTED) | (selected ? PFLAG_SELECTED : 0); 16802 if (!selected) resetPressedState(); 16803 invalidate(true); 16804 refreshDrawableState(); 16805 dispatchSetSelected(selected); 16806 if (selected) { 16807 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SELECTED); 16808 } else { 16809 notifyViewAccessibilityStateChangedIfNeeded( 16810 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 16811 } 16812 } 16813 } 16814 16815 /** 16816 * Dispatch setSelected to all of this View's children. 16817 * 16818 * @see #setSelected(boolean) 16819 * 16820 * @param selected The new selected state 16821 */ 16822 protected void dispatchSetSelected(boolean selected) { 16823 } 16824 16825 /** 16826 * Indicates the selection state of this view. 16827 * 16828 * @return true if the view is selected, false otherwise 16829 */ 16830 @ViewDebug.ExportedProperty 16831 public boolean isSelected() { 16832 return (mPrivateFlags & PFLAG_SELECTED) != 0; 16833 } 16834 16835 /** 16836 * Changes the activated state of this view. A view can be activated or not. 16837 * Note that activation is not the same as selection. Selection is 16838 * a transient property, representing the view (hierarchy) the user is 16839 * currently interacting with. Activation is a longer-term state that the 16840 * user can move views in and out of. For example, in a list view with 16841 * single or multiple selection enabled, the views in the current selection 16842 * set are activated. (Um, yeah, we are deeply sorry about the terminology 16843 * here.) The activated state is propagated down to children of the view it 16844 * is set on. 16845 * 16846 * @param activated true if the view must be activated, false otherwise 16847 */ 16848 public void setActivated(boolean activated) { 16849 //noinspection DoubleNegation 16850 if (((mPrivateFlags & PFLAG_ACTIVATED) != 0) != activated) { 16851 mPrivateFlags = (mPrivateFlags & ~PFLAG_ACTIVATED) | (activated ? PFLAG_ACTIVATED : 0); 16852 invalidate(true); 16853 refreshDrawableState(); 16854 dispatchSetActivated(activated); 16855 } 16856 } 16857 16858 /** 16859 * Dispatch setActivated to all of this View's children. 16860 * 16861 * @see #setActivated(boolean) 16862 * 16863 * @param activated The new activated state 16864 */ 16865 protected void dispatchSetActivated(boolean activated) { 16866 } 16867 16868 /** 16869 * Indicates the activation state of this view. 16870 * 16871 * @return true if the view is activated, false otherwise 16872 */ 16873 @ViewDebug.ExportedProperty 16874 public boolean isActivated() { 16875 return (mPrivateFlags & PFLAG_ACTIVATED) != 0; 16876 } 16877 16878 /** 16879 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 16880 * observer can be used to get notifications when global events, like 16881 * layout, happen. 16882 * 16883 * The returned ViewTreeObserver observer is not guaranteed to remain 16884 * valid for the lifetime of this View. If the caller of this method keeps 16885 * a long-lived reference to ViewTreeObserver, it should always check for 16886 * the return value of {@link ViewTreeObserver#isAlive()}. 16887 * 16888 * @return The ViewTreeObserver for this view's hierarchy. 16889 */ 16890 public ViewTreeObserver getViewTreeObserver() { 16891 if (mAttachInfo != null) { 16892 return mAttachInfo.mTreeObserver; 16893 } 16894 if (mFloatingTreeObserver == null) { 16895 mFloatingTreeObserver = new ViewTreeObserver(); 16896 } 16897 return mFloatingTreeObserver; 16898 } 16899 16900 /** 16901 * <p>Finds the topmost view in the current view hierarchy.</p> 16902 * 16903 * @return the topmost view containing this view 16904 */ 16905 public View getRootView() { 16906 if (mAttachInfo != null) { 16907 final View v = mAttachInfo.mRootView; 16908 if (v != null) { 16909 return v; 16910 } 16911 } 16912 16913 View parent = this; 16914 16915 while (parent.mParent != null && parent.mParent instanceof View) { 16916 parent = (View) parent.mParent; 16917 } 16918 16919 return parent; 16920 } 16921 16922 /** 16923 * Transforms a motion event from view-local coordinates to on-screen 16924 * coordinates. 16925 * 16926 * @param ev the view-local motion event 16927 * @return false if the transformation could not be applied 16928 * @hide 16929 */ 16930 public boolean toGlobalMotionEvent(MotionEvent ev) { 16931 final AttachInfo info = mAttachInfo; 16932 if (info == null) { 16933 return false; 16934 } 16935 16936 final Matrix m = info.mTmpMatrix; 16937 m.set(Matrix.IDENTITY_MATRIX); 16938 transformMatrixToGlobal(m); 16939 ev.transform(m); 16940 return true; 16941 } 16942 16943 /** 16944 * Transforms a motion event from on-screen coordinates to view-local 16945 * coordinates. 16946 * 16947 * @param ev the on-screen motion event 16948 * @return false if the transformation could not be applied 16949 * @hide 16950 */ 16951 public boolean toLocalMotionEvent(MotionEvent ev) { 16952 final AttachInfo info = mAttachInfo; 16953 if (info == null) { 16954 return false; 16955 } 16956 16957 final Matrix m = info.mTmpMatrix; 16958 m.set(Matrix.IDENTITY_MATRIX); 16959 transformMatrixToLocal(m); 16960 ev.transform(m); 16961 return true; 16962 } 16963 16964 /** 16965 * Modifies the input matrix such that it maps view-local coordinates to 16966 * on-screen coordinates. 16967 * 16968 * @param m input matrix to modify 16969 * @hide 16970 */ 16971 public void transformMatrixToGlobal(Matrix m) { 16972 final ViewParent parent = mParent; 16973 if (parent instanceof View) { 16974 final View vp = (View) parent; 16975 vp.transformMatrixToGlobal(m); 16976 m.preTranslate(-vp.mScrollX, -vp.mScrollY); 16977 } else if (parent instanceof ViewRootImpl) { 16978 final ViewRootImpl vr = (ViewRootImpl) parent; 16979 vr.transformMatrixToGlobal(m); 16980 m.preTranslate(0, -vr.mCurScrollY); 16981 } 16982 16983 m.preTranslate(mLeft, mTop); 16984 16985 if (!hasIdentityMatrix()) { 16986 m.preConcat(getMatrix()); 16987 } 16988 } 16989 16990 /** 16991 * Modifies the input matrix such that it maps on-screen coordinates to 16992 * view-local coordinates. 16993 * 16994 * @param m input matrix to modify 16995 * @hide 16996 */ 16997 public void transformMatrixToLocal(Matrix m) { 16998 final ViewParent parent = mParent; 16999 if (parent instanceof View) { 17000 final View vp = (View) parent; 17001 vp.transformMatrixToLocal(m); 17002 m.postTranslate(vp.mScrollX, vp.mScrollY); 17003 } else if (parent instanceof ViewRootImpl) { 17004 final ViewRootImpl vr = (ViewRootImpl) parent; 17005 vr.transformMatrixToLocal(m); 17006 m.postTranslate(0, vr.mCurScrollY); 17007 } 17008 17009 m.postTranslate(-mLeft, -mTop); 17010 17011 if (!hasIdentityMatrix()) { 17012 m.postConcat(getInverseMatrix()); 17013 } 17014 } 17015 17016 /** 17017 * @hide 17018 */ 17019 @ViewDebug.ExportedProperty(category = "layout", indexMapping = { 17020 @ViewDebug.IntToString(from = 0, to = "x"), 17021 @ViewDebug.IntToString(from = 1, to = "y") 17022 }) 17023 public int[] getLocationOnScreen() { 17024 int[] location = new int[2]; 17025 getLocationOnScreen(location); 17026 return location; 17027 } 17028 17029 /** 17030 * <p>Computes the coordinates of this view on the screen. The argument 17031 * must be an array of two integers. After the method returns, the array 17032 * contains the x and y location in that order.</p> 17033 * 17034 * @param location an array of two integers in which to hold the coordinates 17035 */ 17036 public void getLocationOnScreen(int[] location) { 17037 getLocationInWindow(location); 17038 17039 final AttachInfo info = mAttachInfo; 17040 if (info != null) { 17041 location[0] += info.mWindowLeft; 17042 location[1] += info.mWindowTop; 17043 } 17044 } 17045 17046 /** 17047 * <p>Computes the coordinates of this view in its window. The argument 17048 * must be an array of two integers. After the method returns, the array 17049 * contains the x and y location in that order.</p> 17050 * 17051 * @param location an array of two integers in which to hold the coordinates 17052 */ 17053 public void getLocationInWindow(int[] location) { 17054 if (location == null || location.length < 2) { 17055 throw new IllegalArgumentException("location must be an array of two integers"); 17056 } 17057 17058 if (mAttachInfo == null) { 17059 // When the view is not attached to a window, this method does not make sense 17060 location[0] = location[1] = 0; 17061 return; 17062 } 17063 17064 float[] position = mAttachInfo.mTmpTransformLocation; 17065 position[0] = position[1] = 0.0f; 17066 17067 if (!hasIdentityMatrix()) { 17068 getMatrix().mapPoints(position); 17069 } 17070 17071 position[0] += mLeft; 17072 position[1] += mTop; 17073 17074 ViewParent viewParent = mParent; 17075 while (viewParent instanceof View) { 17076 final View view = (View) viewParent; 17077 17078 position[0] -= view.mScrollX; 17079 position[1] -= view.mScrollY; 17080 17081 if (!view.hasIdentityMatrix()) { 17082 view.getMatrix().mapPoints(position); 17083 } 17084 17085 position[0] += view.mLeft; 17086 position[1] += view.mTop; 17087 17088 viewParent = view.mParent; 17089 } 17090 17091 if (viewParent instanceof ViewRootImpl) { 17092 // *cough* 17093 final ViewRootImpl vr = (ViewRootImpl) viewParent; 17094 position[1] -= vr.mCurScrollY; 17095 } 17096 17097 location[0] = (int) (position[0] + 0.5f); 17098 location[1] = (int) (position[1] + 0.5f); 17099 } 17100 17101 /** 17102 * {@hide} 17103 * @param id the id of the view to be found 17104 * @return the view of the specified id, null if cannot be found 17105 */ 17106 protected View findViewTraversal(int id) { 17107 if (id == mID) { 17108 return this; 17109 } 17110 return null; 17111 } 17112 17113 /** 17114 * {@hide} 17115 * @param tag the tag of the view to be found 17116 * @return the view of specified tag, null if cannot be found 17117 */ 17118 protected View findViewWithTagTraversal(Object tag) { 17119 if (tag != null && tag.equals(mTag)) { 17120 return this; 17121 } 17122 return null; 17123 } 17124 17125 /** 17126 * {@hide} 17127 * @param predicate The predicate to evaluate. 17128 * @param childToSkip If not null, ignores this child during the recursive traversal. 17129 * @return The first view that matches the predicate or null. 17130 */ 17131 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 17132 if (predicate.apply(this)) { 17133 return this; 17134 } 17135 return null; 17136 } 17137 17138 /** 17139 * Look for a child view with the given id. If this view has the given 17140 * id, return this view. 17141 * 17142 * @param id The id to search for. 17143 * @return The view that has the given id in the hierarchy or null 17144 */ 17145 public final View findViewById(int id) { 17146 if (id < 0) { 17147 return null; 17148 } 17149 return findViewTraversal(id); 17150 } 17151 17152 /** 17153 * Finds a view by its unuque and stable accessibility id. 17154 * 17155 * @param accessibilityId The searched accessibility id. 17156 * @return The found view. 17157 */ 17158 final View findViewByAccessibilityId(int accessibilityId) { 17159 if (accessibilityId < 0) { 17160 return null; 17161 } 17162 return findViewByAccessibilityIdTraversal(accessibilityId); 17163 } 17164 17165 /** 17166 * Performs the traversal to find a view by its unuque and stable accessibility id. 17167 * 17168 * <strong>Note:</strong>This method does not stop at the root namespace 17169 * boundary since the user can touch the screen at an arbitrary location 17170 * potentially crossing the root namespace bounday which will send an 17171 * accessibility event to accessibility services and they should be able 17172 * to obtain the event source. Also accessibility ids are guaranteed to be 17173 * unique in the window. 17174 * 17175 * @param accessibilityId The accessibility id. 17176 * @return The found view. 17177 * 17178 * @hide 17179 */ 17180 public View findViewByAccessibilityIdTraversal(int accessibilityId) { 17181 if (getAccessibilityViewId() == accessibilityId) { 17182 return this; 17183 } 17184 return null; 17185 } 17186 17187 /** 17188 * Look for a child view with the given tag. If this view has the given 17189 * tag, return this view. 17190 * 17191 * @param tag The tag to search for, using "tag.equals(getTag())". 17192 * @return The View that has the given tag in the hierarchy or null 17193 */ 17194 public final View findViewWithTag(Object tag) { 17195 if (tag == null) { 17196 return null; 17197 } 17198 return findViewWithTagTraversal(tag); 17199 } 17200 17201 /** 17202 * {@hide} 17203 * Look for a child view that matches the specified predicate. 17204 * If this view matches the predicate, return this view. 17205 * 17206 * @param predicate The predicate to evaluate. 17207 * @return The first view that matches the predicate or null. 17208 */ 17209 public final View findViewByPredicate(Predicate<View> predicate) { 17210 return findViewByPredicateTraversal(predicate, null); 17211 } 17212 17213 /** 17214 * {@hide} 17215 * Look for a child view that matches the specified predicate, 17216 * starting with the specified view and its descendents and then 17217 * recusively searching the ancestors and siblings of that view 17218 * until this view is reached. 17219 * 17220 * This method is useful in cases where the predicate does not match 17221 * a single unique view (perhaps multiple views use the same id) 17222 * and we are trying to find the view that is "closest" in scope to the 17223 * starting view. 17224 * 17225 * @param start The view to start from. 17226 * @param predicate The predicate to evaluate. 17227 * @return The first view that matches the predicate or null. 17228 */ 17229 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 17230 View childToSkip = null; 17231 for (;;) { 17232 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 17233 if (view != null || start == this) { 17234 return view; 17235 } 17236 17237 ViewParent parent = start.getParent(); 17238 if (parent == null || !(parent instanceof View)) { 17239 return null; 17240 } 17241 17242 childToSkip = start; 17243 start = (View) parent; 17244 } 17245 } 17246 17247 /** 17248 * Sets the identifier for this view. The identifier does not have to be 17249 * unique in this view's hierarchy. The identifier should be a positive 17250 * number. 17251 * 17252 * @see #NO_ID 17253 * @see #getId() 17254 * @see #findViewById(int) 17255 * 17256 * @param id a number used to identify the view 17257 * 17258 * @attr ref android.R.styleable#View_id 17259 */ 17260 public void setId(int id) { 17261 mID = id; 17262 if (mID == View.NO_ID && mLabelForId != View.NO_ID) { 17263 mID = generateViewId(); 17264 } 17265 } 17266 17267 /** 17268 * {@hide} 17269 * 17270 * @param isRoot true if the view belongs to the root namespace, false 17271 * otherwise 17272 */ 17273 public void setIsRootNamespace(boolean isRoot) { 17274 if (isRoot) { 17275 mPrivateFlags |= PFLAG_IS_ROOT_NAMESPACE; 17276 } else { 17277 mPrivateFlags &= ~PFLAG_IS_ROOT_NAMESPACE; 17278 } 17279 } 17280 17281 /** 17282 * {@hide} 17283 * 17284 * @return true if the view belongs to the root namespace, false otherwise 17285 */ 17286 public boolean isRootNamespace() { 17287 return (mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0; 17288 } 17289 17290 /** 17291 * Returns this view's identifier. 17292 * 17293 * @return a positive integer used to identify the view or {@link #NO_ID} 17294 * if the view has no ID 17295 * 17296 * @see #setId(int) 17297 * @see #findViewById(int) 17298 * @attr ref android.R.styleable#View_id 17299 */ 17300 @ViewDebug.CapturedViewProperty 17301 public int getId() { 17302 return mID; 17303 } 17304 17305 /** 17306 * Returns this view's tag. 17307 * 17308 * @return the Object stored in this view as a tag, or {@code null} if not 17309 * set 17310 * 17311 * @see #setTag(Object) 17312 * @see #getTag(int) 17313 */ 17314 @ViewDebug.ExportedProperty 17315 public Object getTag() { 17316 return mTag; 17317 } 17318 17319 /** 17320 * Sets the tag associated with this view. A tag can be used to mark 17321 * a view in its hierarchy and does not have to be unique within the 17322 * hierarchy. Tags can also be used to store data within a view without 17323 * resorting to another data structure. 17324 * 17325 * @param tag an Object to tag the view with 17326 * 17327 * @see #getTag() 17328 * @see #setTag(int, Object) 17329 */ 17330 public void setTag(final Object tag) { 17331 mTag = tag; 17332 } 17333 17334 /** 17335 * Returns the tag associated with this view and the specified key. 17336 * 17337 * @param key The key identifying the tag 17338 * 17339 * @return the Object stored in this view as a tag, or {@code null} if not 17340 * set 17341 * 17342 * @see #setTag(int, Object) 17343 * @see #getTag() 17344 */ 17345 public Object getTag(int key) { 17346 if (mKeyedTags != null) return mKeyedTags.get(key); 17347 return null; 17348 } 17349 17350 /** 17351 * Sets a tag associated with this view and a key. A tag can be used 17352 * to mark a view in its hierarchy and does not have to be unique within 17353 * the hierarchy. Tags can also be used to store data within a view 17354 * without resorting to another data structure. 17355 * 17356 * The specified key should be an id declared in the resources of the 17357 * application to ensure it is unique (see the <a 17358 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 17359 * Keys identified as belonging to 17360 * the Android framework or not associated with any package will cause 17361 * an {@link IllegalArgumentException} to be thrown. 17362 * 17363 * @param key The key identifying the tag 17364 * @param tag An Object to tag the view with 17365 * 17366 * @throws IllegalArgumentException If they specified key is not valid 17367 * 17368 * @see #setTag(Object) 17369 * @see #getTag(int) 17370 */ 17371 public void setTag(int key, final Object tag) { 17372 // If the package id is 0x00 or 0x01, it's either an undefined package 17373 // or a framework id 17374 if ((key >>> 24) < 2) { 17375 throw new IllegalArgumentException("The key must be an application-specific " 17376 + "resource id."); 17377 } 17378 17379 setKeyedTag(key, tag); 17380 } 17381 17382 /** 17383 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 17384 * framework id. 17385 * 17386 * @hide 17387 */ 17388 public void setTagInternal(int key, Object tag) { 17389 if ((key >>> 24) != 0x1) { 17390 throw new IllegalArgumentException("The key must be a framework-specific " 17391 + "resource id."); 17392 } 17393 17394 setKeyedTag(key, tag); 17395 } 17396 17397 private void setKeyedTag(int key, Object tag) { 17398 if (mKeyedTags == null) { 17399 mKeyedTags = new SparseArray<Object>(2); 17400 } 17401 17402 mKeyedTags.put(key, tag); 17403 } 17404 17405 /** 17406 * Prints information about this view in the log output, with the tag 17407 * {@link #VIEW_LOG_TAG}. 17408 * 17409 * @hide 17410 */ 17411 public void debug() { 17412 debug(0); 17413 } 17414 17415 /** 17416 * Prints information about this view in the log output, with the tag 17417 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 17418 * indentation defined by the <code>depth</code>. 17419 * 17420 * @param depth the indentation level 17421 * 17422 * @hide 17423 */ 17424 protected void debug(int depth) { 17425 String output = debugIndent(depth - 1); 17426 17427 output += "+ " + this; 17428 int id = getId(); 17429 if (id != -1) { 17430 output += " (id=" + id + ")"; 17431 } 17432 Object tag = getTag(); 17433 if (tag != null) { 17434 output += " (tag=" + tag + ")"; 17435 } 17436 Log.d(VIEW_LOG_TAG, output); 17437 17438 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 17439 output = debugIndent(depth) + " FOCUSED"; 17440 Log.d(VIEW_LOG_TAG, output); 17441 } 17442 17443 output = debugIndent(depth); 17444 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 17445 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 17446 + "} "; 17447 Log.d(VIEW_LOG_TAG, output); 17448 17449 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 17450 || mPaddingBottom != 0) { 17451 output = debugIndent(depth); 17452 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 17453 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 17454 Log.d(VIEW_LOG_TAG, output); 17455 } 17456 17457 output = debugIndent(depth); 17458 output += "mMeasureWidth=" + mMeasuredWidth + 17459 " mMeasureHeight=" + mMeasuredHeight; 17460 Log.d(VIEW_LOG_TAG, output); 17461 17462 output = debugIndent(depth); 17463 if (mLayoutParams == null) { 17464 output += "BAD! no layout params"; 17465 } else { 17466 output = mLayoutParams.debug(output); 17467 } 17468 Log.d(VIEW_LOG_TAG, output); 17469 17470 output = debugIndent(depth); 17471 output += "flags={"; 17472 output += View.printFlags(mViewFlags); 17473 output += "}"; 17474 Log.d(VIEW_LOG_TAG, output); 17475 17476 output = debugIndent(depth); 17477 output += "privateFlags={"; 17478 output += View.printPrivateFlags(mPrivateFlags); 17479 output += "}"; 17480 Log.d(VIEW_LOG_TAG, output); 17481 } 17482 17483 /** 17484 * Creates a string of whitespaces used for indentation. 17485 * 17486 * @param depth the indentation level 17487 * @return a String containing (depth * 2 + 3) * 2 white spaces 17488 * 17489 * @hide 17490 */ 17491 protected static String debugIndent(int depth) { 17492 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 17493 for (int i = 0; i < (depth * 2) + 3; i++) { 17494 spaces.append(' ').append(' '); 17495 } 17496 return spaces.toString(); 17497 } 17498 17499 /** 17500 * <p>Return the offset of the widget's text baseline from the widget's top 17501 * boundary. If this widget does not support baseline alignment, this 17502 * method returns -1. </p> 17503 * 17504 * @return the offset of the baseline within the widget's bounds or -1 17505 * if baseline alignment is not supported 17506 */ 17507 @ViewDebug.ExportedProperty(category = "layout") 17508 public int getBaseline() { 17509 return -1; 17510 } 17511 17512 /** 17513 * Returns whether the view hierarchy is currently undergoing a layout pass. This 17514 * information is useful to avoid situations such as calling {@link #requestLayout()} during 17515 * a layout pass. 17516 * 17517 * @return whether the view hierarchy is currently undergoing a layout pass 17518 */ 17519 public boolean isInLayout() { 17520 ViewRootImpl viewRoot = getViewRootImpl(); 17521 return (viewRoot != null && viewRoot.isInLayout()); 17522 } 17523 17524 /** 17525 * Call this when something has changed which has invalidated the 17526 * layout of this view. This will schedule a layout pass of the view 17527 * tree. This should not be called while the view hierarchy is currently in a layout 17528 * pass ({@link #isInLayout()}. If layout is happening, the request may be honored at the 17529 * end of the current layout pass (and then layout will run again) or after the current 17530 * frame is drawn and the next layout occurs. 17531 * 17532 * <p>Subclasses which override this method should call the superclass method to 17533 * handle possible request-during-layout errors correctly.</p> 17534 */ 17535 public void requestLayout() { 17536 if (mMeasureCache != null) mMeasureCache.clear(); 17537 17538 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == null) { 17539 // Only trigger request-during-layout logic if this is the view requesting it, 17540 // not the views in its parent hierarchy 17541 ViewRootImpl viewRoot = getViewRootImpl(); 17542 if (viewRoot != null && viewRoot.isInLayout()) { 17543 if (!viewRoot.requestLayoutDuringLayout(this)) { 17544 return; 17545 } 17546 } 17547 mAttachInfo.mViewRequestingLayout = this; 17548 } 17549 17550 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17551 mPrivateFlags |= PFLAG_INVALIDATED; 17552 17553 if (mParent != null && !mParent.isLayoutRequested()) { 17554 mParent.requestLayout(); 17555 } 17556 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == this) { 17557 mAttachInfo.mViewRequestingLayout = null; 17558 } 17559 } 17560 17561 /** 17562 * Forces this view to be laid out during the next layout pass. 17563 * This method does not call requestLayout() or forceLayout() 17564 * on the parent. 17565 */ 17566 public void forceLayout() { 17567 if (mMeasureCache != null) mMeasureCache.clear(); 17568 17569 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17570 mPrivateFlags |= PFLAG_INVALIDATED; 17571 } 17572 17573 /** 17574 * <p> 17575 * This is called to find out how big a view should be. The parent 17576 * supplies constraint information in the width and height parameters. 17577 * </p> 17578 * 17579 * <p> 17580 * The actual measurement work of a view is performed in 17581 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 17582 * {@link #onMeasure(int, int)} can and must be overridden by subclasses. 17583 * </p> 17584 * 17585 * 17586 * @param widthMeasureSpec Horizontal space requirements as imposed by the 17587 * parent 17588 * @param heightMeasureSpec Vertical space requirements as imposed by the 17589 * parent 17590 * 17591 * @see #onMeasure(int, int) 17592 */ 17593 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 17594 boolean optical = isLayoutModeOptical(this); 17595 if (optical != isLayoutModeOptical(mParent)) { 17596 Insets insets = getOpticalInsets(); 17597 int oWidth = insets.left + insets.right; 17598 int oHeight = insets.top + insets.bottom; 17599 widthMeasureSpec = MeasureSpec.adjust(widthMeasureSpec, optical ? -oWidth : oWidth); 17600 heightMeasureSpec = MeasureSpec.adjust(heightMeasureSpec, optical ? -oHeight : oHeight); 17601 } 17602 17603 // Suppress sign extension for the low bytes 17604 long key = (long) widthMeasureSpec << 32 | (long) heightMeasureSpec & 0xffffffffL; 17605 if (mMeasureCache == null) mMeasureCache = new LongSparseLongArray(2); 17606 17607 final boolean forceLayout = (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 17608 final boolean isExactly = MeasureSpec.getMode(widthMeasureSpec) == MeasureSpec.EXACTLY && 17609 MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.EXACTLY; 17610 final boolean matchingSize = isExactly && 17611 getMeasuredWidth() == MeasureSpec.getSize(widthMeasureSpec) && 17612 getMeasuredHeight() == MeasureSpec.getSize(heightMeasureSpec); 17613 if (forceLayout || !matchingSize && 17614 (widthMeasureSpec != mOldWidthMeasureSpec || 17615 heightMeasureSpec != mOldHeightMeasureSpec)) { 17616 17617 // first clears the measured dimension flag 17618 mPrivateFlags &= ~PFLAG_MEASURED_DIMENSION_SET; 17619 17620 resolveRtlPropertiesIfNeeded(); 17621 17622 int cacheIndex = forceLayout ? -1 : mMeasureCache.indexOfKey(key); 17623 if (cacheIndex < 0 || sIgnoreMeasureCache) { 17624 // measure ourselves, this should set the measured dimension flag back 17625 onMeasure(widthMeasureSpec, heightMeasureSpec); 17626 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17627 } else { 17628 long value = mMeasureCache.valueAt(cacheIndex); 17629 // Casting a long to int drops the high 32 bits, no mask needed 17630 setMeasuredDimensionRaw((int) (value >> 32), (int) value); 17631 mPrivateFlags3 |= PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17632 } 17633 17634 // flag not set, setMeasuredDimension() was not invoked, we raise 17635 // an exception to warn the developer 17636 if ((mPrivateFlags & PFLAG_MEASURED_DIMENSION_SET) != PFLAG_MEASURED_DIMENSION_SET) { 17637 throw new IllegalStateException("onMeasure() did not set the" 17638 + " measured dimension by calling" 17639 + " setMeasuredDimension()"); 17640 } 17641 17642 mPrivateFlags |= PFLAG_LAYOUT_REQUIRED; 17643 } 17644 17645 mOldWidthMeasureSpec = widthMeasureSpec; 17646 mOldHeightMeasureSpec = heightMeasureSpec; 17647 17648 mMeasureCache.put(key, ((long) mMeasuredWidth) << 32 | 17649 (long) mMeasuredHeight & 0xffffffffL); // suppress sign extension 17650 } 17651 17652 /** 17653 * <p> 17654 * Measure the view and its content to determine the measured width and the 17655 * measured height. This method is invoked by {@link #measure(int, int)} and 17656 * should be overriden by subclasses to provide accurate and efficient 17657 * measurement of their contents. 17658 * </p> 17659 * 17660 * <p> 17661 * <strong>CONTRACT:</strong> When overriding this method, you 17662 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 17663 * measured width and height of this view. Failure to do so will trigger an 17664 * <code>IllegalStateException</code>, thrown by 17665 * {@link #measure(int, int)}. Calling the superclass' 17666 * {@link #onMeasure(int, int)} is a valid use. 17667 * </p> 17668 * 17669 * <p> 17670 * The base class implementation of measure defaults to the background size, 17671 * unless a larger size is allowed by the MeasureSpec. Subclasses should 17672 * override {@link #onMeasure(int, int)} to provide better measurements of 17673 * their content. 17674 * </p> 17675 * 17676 * <p> 17677 * If this method is overridden, it is the subclass's responsibility to make 17678 * sure the measured height and width are at least the view's minimum height 17679 * and width ({@link #getSuggestedMinimumHeight()} and 17680 * {@link #getSuggestedMinimumWidth()}). 17681 * </p> 17682 * 17683 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 17684 * The requirements are encoded with 17685 * {@link android.view.View.MeasureSpec}. 17686 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 17687 * The requirements are encoded with 17688 * {@link android.view.View.MeasureSpec}. 17689 * 17690 * @see #getMeasuredWidth() 17691 * @see #getMeasuredHeight() 17692 * @see #setMeasuredDimension(int, int) 17693 * @see #getSuggestedMinimumHeight() 17694 * @see #getSuggestedMinimumWidth() 17695 * @see android.view.View.MeasureSpec#getMode(int) 17696 * @see android.view.View.MeasureSpec#getSize(int) 17697 */ 17698 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 17699 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 17700 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 17701 } 17702 17703 /** 17704 * <p>This method must be called by {@link #onMeasure(int, int)} to store the 17705 * measured width and measured height. Failing to do so will trigger an 17706 * exception at measurement time.</p> 17707 * 17708 * @param measuredWidth The measured width of this view. May be a complex 17709 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17710 * {@link #MEASURED_STATE_TOO_SMALL}. 17711 * @param measuredHeight The measured height of this view. May be a complex 17712 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17713 * {@link #MEASURED_STATE_TOO_SMALL}. 17714 */ 17715 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 17716 boolean optical = isLayoutModeOptical(this); 17717 if (optical != isLayoutModeOptical(mParent)) { 17718 Insets insets = getOpticalInsets(); 17719 int opticalWidth = insets.left + insets.right; 17720 int opticalHeight = insets.top + insets.bottom; 17721 17722 measuredWidth += optical ? opticalWidth : -opticalWidth; 17723 measuredHeight += optical ? opticalHeight : -opticalHeight; 17724 } 17725 setMeasuredDimensionRaw(measuredWidth, measuredHeight); 17726 } 17727 17728 /** 17729 * Sets the measured dimension without extra processing for things like optical bounds. 17730 * Useful for reapplying consistent values that have already been cooked with adjustments 17731 * for optical bounds, etc. such as those from the measurement cache. 17732 * 17733 * @param measuredWidth The measured width of this view. May be a complex 17734 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17735 * {@link #MEASURED_STATE_TOO_SMALL}. 17736 * @param measuredHeight The measured height of this view. May be a complex 17737 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17738 * {@link #MEASURED_STATE_TOO_SMALL}. 17739 */ 17740 private void setMeasuredDimensionRaw(int measuredWidth, int measuredHeight) { 17741 mMeasuredWidth = measuredWidth; 17742 mMeasuredHeight = measuredHeight; 17743 17744 mPrivateFlags |= PFLAG_MEASURED_DIMENSION_SET; 17745 } 17746 17747 /** 17748 * Merge two states as returned by {@link #getMeasuredState()}. 17749 * @param curState The current state as returned from a view or the result 17750 * of combining multiple views. 17751 * @param newState The new view state to combine. 17752 * @return Returns a new integer reflecting the combination of the two 17753 * states. 17754 */ 17755 public static int combineMeasuredStates(int curState, int newState) { 17756 return curState | newState; 17757 } 17758 17759 /** 17760 * Version of {@link #resolveSizeAndState(int, int, int)} 17761 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 17762 */ 17763 public static int resolveSize(int size, int measureSpec) { 17764 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 17765 } 17766 17767 /** 17768 * Utility to reconcile a desired size and state, with constraints imposed 17769 * by a MeasureSpec. Will take the desired size, unless a different size 17770 * is imposed by the constraints. The returned value is a compound integer, 17771 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 17772 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 17773 * size is smaller than the size the view wants to be. 17774 * 17775 * @param size How big the view wants to be 17776 * @param measureSpec Constraints imposed by the parent 17777 * @return Size information bit mask as defined by 17778 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 17779 */ 17780 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 17781 int result = size; 17782 int specMode = MeasureSpec.getMode(measureSpec); 17783 int specSize = MeasureSpec.getSize(measureSpec); 17784 switch (specMode) { 17785 case MeasureSpec.UNSPECIFIED: 17786 result = size; 17787 break; 17788 case MeasureSpec.AT_MOST: 17789 if (specSize < size) { 17790 result = specSize | MEASURED_STATE_TOO_SMALL; 17791 } else { 17792 result = size; 17793 } 17794 break; 17795 case MeasureSpec.EXACTLY: 17796 result = specSize; 17797 break; 17798 } 17799 return result | (childMeasuredState&MEASURED_STATE_MASK); 17800 } 17801 17802 /** 17803 * Utility to return a default size. Uses the supplied size if the 17804 * MeasureSpec imposed no constraints. Will get larger if allowed 17805 * by the MeasureSpec. 17806 * 17807 * @param size Default size for this view 17808 * @param measureSpec Constraints imposed by the parent 17809 * @return The size this view should be. 17810 */ 17811 public static int getDefaultSize(int size, int measureSpec) { 17812 int result = size; 17813 int specMode = MeasureSpec.getMode(measureSpec); 17814 int specSize = MeasureSpec.getSize(measureSpec); 17815 17816 switch (specMode) { 17817 case MeasureSpec.UNSPECIFIED: 17818 result = size; 17819 break; 17820 case MeasureSpec.AT_MOST: 17821 case MeasureSpec.EXACTLY: 17822 result = specSize; 17823 break; 17824 } 17825 return result; 17826 } 17827 17828 /** 17829 * Returns the suggested minimum height that the view should use. This 17830 * returns the maximum of the view's minimum height 17831 * and the background's minimum height 17832 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 17833 * <p> 17834 * When being used in {@link #onMeasure(int, int)}, the caller should still 17835 * ensure the returned height is within the requirements of the parent. 17836 * 17837 * @return The suggested minimum height of the view. 17838 */ 17839 protected int getSuggestedMinimumHeight() { 17840 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight()); 17841 17842 } 17843 17844 /** 17845 * Returns the suggested minimum width that the view should use. This 17846 * returns the maximum of the view's minimum width) 17847 * and the background's minimum width 17848 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 17849 * <p> 17850 * When being used in {@link #onMeasure(int, int)}, the caller should still 17851 * ensure the returned width is within the requirements of the parent. 17852 * 17853 * @return The suggested minimum width of the view. 17854 */ 17855 protected int getSuggestedMinimumWidth() { 17856 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth()); 17857 } 17858 17859 /** 17860 * Returns the minimum height of the view. 17861 * 17862 * @return the minimum height the view will try to be. 17863 * 17864 * @see #setMinimumHeight(int) 17865 * 17866 * @attr ref android.R.styleable#View_minHeight 17867 */ 17868 public int getMinimumHeight() { 17869 return mMinHeight; 17870 } 17871 17872 /** 17873 * Sets the minimum height of the view. It is not guaranteed the view will 17874 * be able to achieve this minimum height (for example, if its parent layout 17875 * constrains it with less available height). 17876 * 17877 * @param minHeight The minimum height the view will try to be. 17878 * 17879 * @see #getMinimumHeight() 17880 * 17881 * @attr ref android.R.styleable#View_minHeight 17882 */ 17883 public void setMinimumHeight(int minHeight) { 17884 mMinHeight = minHeight; 17885 requestLayout(); 17886 } 17887 17888 /** 17889 * Returns the minimum width of the view. 17890 * 17891 * @return the minimum width the view will try to be. 17892 * 17893 * @see #setMinimumWidth(int) 17894 * 17895 * @attr ref android.R.styleable#View_minWidth 17896 */ 17897 public int getMinimumWidth() { 17898 return mMinWidth; 17899 } 17900 17901 /** 17902 * Sets the minimum width of the view. It is not guaranteed the view will 17903 * be able to achieve this minimum width (for example, if its parent layout 17904 * constrains it with less available width). 17905 * 17906 * @param minWidth The minimum width the view will try to be. 17907 * 17908 * @see #getMinimumWidth() 17909 * 17910 * @attr ref android.R.styleable#View_minWidth 17911 */ 17912 public void setMinimumWidth(int minWidth) { 17913 mMinWidth = minWidth; 17914 requestLayout(); 17915 17916 } 17917 17918 /** 17919 * Get the animation currently associated with this view. 17920 * 17921 * @return The animation that is currently playing or 17922 * scheduled to play for this view. 17923 */ 17924 public Animation getAnimation() { 17925 return mCurrentAnimation; 17926 } 17927 17928 /** 17929 * Start the specified animation now. 17930 * 17931 * @param animation the animation to start now 17932 */ 17933 public void startAnimation(Animation animation) { 17934 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 17935 setAnimation(animation); 17936 invalidateParentCaches(); 17937 invalidate(true); 17938 } 17939 17940 /** 17941 * Cancels any animations for this view. 17942 */ 17943 public void clearAnimation() { 17944 if (mCurrentAnimation != null) { 17945 mCurrentAnimation.detach(); 17946 } 17947 mCurrentAnimation = null; 17948 invalidateParentIfNeeded(); 17949 } 17950 17951 /** 17952 * Sets the next animation to play for this view. 17953 * If you want the animation to play immediately, use 17954 * {@link #startAnimation(android.view.animation.Animation)} instead. 17955 * This method provides allows fine-grained 17956 * control over the start time and invalidation, but you 17957 * must make sure that 1) the animation has a start time set, and 17958 * 2) the view's parent (which controls animations on its children) 17959 * will be invalidated when the animation is supposed to 17960 * start. 17961 * 17962 * @param animation The next animation, or null. 17963 */ 17964 public void setAnimation(Animation animation) { 17965 mCurrentAnimation = animation; 17966 17967 if (animation != null) { 17968 // If the screen is off assume the animation start time is now instead of 17969 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time 17970 // would cause the animation to start when the screen turns back on 17971 if (mAttachInfo != null && mAttachInfo.mDisplayState == Display.STATE_OFF 17972 && animation.getStartTime() == Animation.START_ON_FIRST_FRAME) { 17973 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis()); 17974 } 17975 animation.reset(); 17976 } 17977 } 17978 17979 /** 17980 * Invoked by a parent ViewGroup to notify the start of the animation 17981 * currently associated with this view. If you override this method, 17982 * always call super.onAnimationStart(); 17983 * 17984 * @see #setAnimation(android.view.animation.Animation) 17985 * @see #getAnimation() 17986 */ 17987 protected void onAnimationStart() { 17988 mPrivateFlags |= PFLAG_ANIMATION_STARTED; 17989 } 17990 17991 /** 17992 * Invoked by a parent ViewGroup to notify the end of the animation 17993 * currently associated with this view. If you override this method, 17994 * always call super.onAnimationEnd(); 17995 * 17996 * @see #setAnimation(android.view.animation.Animation) 17997 * @see #getAnimation() 17998 */ 17999 protected void onAnimationEnd() { 18000 mPrivateFlags &= ~PFLAG_ANIMATION_STARTED; 18001 } 18002 18003 /** 18004 * Invoked if there is a Transform that involves alpha. Subclass that can 18005 * draw themselves with the specified alpha should return true, and then 18006 * respect that alpha when their onDraw() is called. If this returns false 18007 * then the view may be redirected to draw into an offscreen buffer to 18008 * fulfill the request, which will look fine, but may be slower than if the 18009 * subclass handles it internally. The default implementation returns false. 18010 * 18011 * @param alpha The alpha (0..255) to apply to the view's drawing 18012 * @return true if the view can draw with the specified alpha. 18013 */ 18014 protected boolean onSetAlpha(int alpha) { 18015 return false; 18016 } 18017 18018 /** 18019 * This is used by the RootView to perform an optimization when 18020 * the view hierarchy contains one or several SurfaceView. 18021 * SurfaceView is always considered transparent, but its children are not, 18022 * therefore all View objects remove themselves from the global transparent 18023 * region (passed as a parameter to this function). 18024 * 18025 * @param region The transparent region for this ViewAncestor (window). 18026 * 18027 * @return Returns true if the effective visibility of the view at this 18028 * point is opaque, regardless of the transparent region; returns false 18029 * if it is possible for underlying windows to be seen behind the view. 18030 * 18031 * {@hide} 18032 */ 18033 public boolean gatherTransparentRegion(Region region) { 18034 final AttachInfo attachInfo = mAttachInfo; 18035 if (region != null && attachInfo != null) { 18036 final int pflags = mPrivateFlags; 18037 if ((pflags & PFLAG_SKIP_DRAW) == 0) { 18038 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 18039 // remove it from the transparent region. 18040 final int[] location = attachInfo.mTransparentLocation; 18041 getLocationInWindow(location); 18042 region.op(location[0], location[1], location[0] + mRight - mLeft, 18043 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 18044 } else if ((pflags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null && 18045 mBackground.getOpacity() != PixelFormat.TRANSPARENT) { 18046 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 18047 // exists, so we remove the background drawable's non-transparent 18048 // parts from this transparent region. 18049 applyDrawableToTransparentRegion(mBackground, region); 18050 } 18051 } 18052 return true; 18053 } 18054 18055 /** 18056 * Play a sound effect for this view. 18057 * 18058 * <p>The framework will play sound effects for some built in actions, such as 18059 * clicking, but you may wish to play these effects in your widget, 18060 * for instance, for internal navigation. 18061 * 18062 * <p>The sound effect will only be played if sound effects are enabled by the user, and 18063 * {@link #isSoundEffectsEnabled()} is true. 18064 * 18065 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 18066 */ 18067 public void playSoundEffect(int soundConstant) { 18068 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 18069 return; 18070 } 18071 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 18072 } 18073 18074 /** 18075 * BZZZTT!!1! 18076 * 18077 * <p>Provide haptic feedback to the user for this view. 18078 * 18079 * <p>The framework will provide haptic feedback for some built in actions, 18080 * such as long presses, but you may wish to provide feedback for your 18081 * own widget. 18082 * 18083 * <p>The feedback will only be performed if 18084 * {@link #isHapticFeedbackEnabled()} is true. 18085 * 18086 * @param feedbackConstant One of the constants defined in 18087 * {@link HapticFeedbackConstants} 18088 */ 18089 public boolean performHapticFeedback(int feedbackConstant) { 18090 return performHapticFeedback(feedbackConstant, 0); 18091 } 18092 18093 /** 18094 * BZZZTT!!1! 18095 * 18096 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 18097 * 18098 * @param feedbackConstant One of the constants defined in 18099 * {@link HapticFeedbackConstants} 18100 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 18101 */ 18102 public boolean performHapticFeedback(int feedbackConstant, int flags) { 18103 if (mAttachInfo == null) { 18104 return false; 18105 } 18106 //noinspection SimplifiableIfStatement 18107 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 18108 && !isHapticFeedbackEnabled()) { 18109 return false; 18110 } 18111 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 18112 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 18113 } 18114 18115 /** 18116 * Request that the visibility of the status bar or other screen/window 18117 * decorations be changed. 18118 * 18119 * <p>This method is used to put the over device UI into temporary modes 18120 * where the user's attention is focused more on the application content, 18121 * by dimming or hiding surrounding system affordances. This is typically 18122 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY 18123 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content 18124 * to be placed behind the action bar (and with these flags other system 18125 * affordances) so that smooth transitions between hiding and showing them 18126 * can be done. 18127 * 18128 * <p>Two representative examples of the use of system UI visibility is 18129 * implementing a content browsing application (like a magazine reader) 18130 * and a video playing application. 18131 * 18132 * <p>The first code shows a typical implementation of a View in a content 18133 * browsing application. In this implementation, the application goes 18134 * into a content-oriented mode by hiding the status bar and action bar, 18135 * and putting the navigation elements into lights out mode. The user can 18136 * then interact with content while in this mode. Such an application should 18137 * provide an easy way for the user to toggle out of the mode (such as to 18138 * check information in the status bar or access notifications). In the 18139 * implementation here, this is done simply by tapping on the content. 18140 * 18141 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java 18142 * content} 18143 * 18144 * <p>This second code sample shows a typical implementation of a View 18145 * in a video playing application. In this situation, while the video is 18146 * playing the application would like to go into a complete full-screen mode, 18147 * to use as much of the display as possible for the video. When in this state 18148 * the user can not interact with the application; the system intercepts 18149 * touching on the screen to pop the UI out of full screen mode. See 18150 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code. 18151 * 18152 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java 18153 * content} 18154 * 18155 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18156 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18157 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18158 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18159 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18160 */ 18161 public void setSystemUiVisibility(int visibility) { 18162 if (visibility != mSystemUiVisibility) { 18163 mSystemUiVisibility = visibility; 18164 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18165 mParent.recomputeViewAttributes(this); 18166 } 18167 } 18168 } 18169 18170 /** 18171 * Returns the last {@link #setSystemUiVisibility(int)} that this view has requested. 18172 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18173 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18174 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18175 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18176 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18177 */ 18178 public int getSystemUiVisibility() { 18179 return mSystemUiVisibility; 18180 } 18181 18182 /** 18183 * Returns the current system UI visibility that is currently set for 18184 * the entire window. This is the combination of the 18185 * {@link #setSystemUiVisibility(int)} values supplied by all of the 18186 * views in the window. 18187 */ 18188 public int getWindowSystemUiVisibility() { 18189 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0; 18190 } 18191 18192 /** 18193 * Override to find out when the window's requested system UI visibility 18194 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}. 18195 * This is different from the callbacks received through 18196 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)} 18197 * in that this is only telling you about the local request of the window, 18198 * not the actual values applied by the system. 18199 */ 18200 public void onWindowSystemUiVisibilityChanged(int visible) { 18201 } 18202 18203 /** 18204 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down 18205 * the view hierarchy. 18206 */ 18207 public void dispatchWindowSystemUiVisiblityChanged(int visible) { 18208 onWindowSystemUiVisibilityChanged(visible); 18209 } 18210 18211 /** 18212 * Set a listener to receive callbacks when the visibility of the system bar changes. 18213 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 18214 */ 18215 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 18216 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 18217 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18218 mParent.recomputeViewAttributes(this); 18219 } 18220 } 18221 18222 /** 18223 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 18224 * the view hierarchy. 18225 */ 18226 public void dispatchSystemUiVisibilityChanged(int visibility) { 18227 ListenerInfo li = mListenerInfo; 18228 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 18229 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 18230 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 18231 } 18232 } 18233 18234 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) { 18235 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 18236 if (val != mSystemUiVisibility) { 18237 setSystemUiVisibility(val); 18238 return true; 18239 } 18240 return false; 18241 } 18242 18243 /** @hide */ 18244 public void setDisabledSystemUiVisibility(int flags) { 18245 if (mAttachInfo != null) { 18246 if (mAttachInfo.mDisabledSystemUiVisibility != flags) { 18247 mAttachInfo.mDisabledSystemUiVisibility = flags; 18248 if (mParent != null) { 18249 mParent.recomputeViewAttributes(this); 18250 } 18251 } 18252 } 18253 } 18254 18255 /** 18256 * Creates an image that the system displays during the drag and drop 18257 * operation. This is called a "drag shadow". The default implementation 18258 * for a DragShadowBuilder based on a View returns an image that has exactly the same 18259 * appearance as the given View. The default also positions the center of the drag shadow 18260 * directly under the touch point. If no View is provided (the constructor with no parameters 18261 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 18262 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 18263 * default is an invisible drag shadow. 18264 * <p> 18265 * You are not required to use the View you provide to the constructor as the basis of the 18266 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 18267 * anything you want as the drag shadow. 18268 * </p> 18269 * <p> 18270 * You pass a DragShadowBuilder object to the system when you start the drag. The system 18271 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 18272 * size and position of the drag shadow. It uses this data to construct a 18273 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 18274 * so that your application can draw the shadow image in the Canvas. 18275 * </p> 18276 * 18277 * <div class="special reference"> 18278 * <h3>Developer Guides</h3> 18279 * <p>For a guide to implementing drag and drop features, read the 18280 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 18281 * </div> 18282 */ 18283 public static class DragShadowBuilder { 18284 private final WeakReference<View> mView; 18285 18286 /** 18287 * Constructs a shadow image builder based on a View. By default, the resulting drag 18288 * shadow will have the same appearance and dimensions as the View, with the touch point 18289 * over the center of the View. 18290 * @param view A View. Any View in scope can be used. 18291 */ 18292 public DragShadowBuilder(View view) { 18293 mView = new WeakReference<View>(view); 18294 } 18295 18296 /** 18297 * Construct a shadow builder object with no associated View. This 18298 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 18299 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 18300 * to supply the drag shadow's dimensions and appearance without 18301 * reference to any View object. If they are not overridden, then the result is an 18302 * invisible drag shadow. 18303 */ 18304 public DragShadowBuilder() { 18305 mView = new WeakReference<View>(null); 18306 } 18307 18308 /** 18309 * Returns the View object that had been passed to the 18310 * {@link #View.DragShadowBuilder(View)} 18311 * constructor. If that View parameter was {@code null} or if the 18312 * {@link #View.DragShadowBuilder()} 18313 * constructor was used to instantiate the builder object, this method will return 18314 * null. 18315 * 18316 * @return The View object associate with this builder object. 18317 */ 18318 @SuppressWarnings({"JavadocReference"}) 18319 final public View getView() { 18320 return mView.get(); 18321 } 18322 18323 /** 18324 * Provides the metrics for the shadow image. These include the dimensions of 18325 * the shadow image, and the point within that shadow that should 18326 * be centered under the touch location while dragging. 18327 * <p> 18328 * The default implementation sets the dimensions of the shadow to be the 18329 * same as the dimensions of the View itself and centers the shadow under 18330 * the touch point. 18331 * </p> 18332 * 18333 * @param shadowSize A {@link android.graphics.Point} containing the width and height 18334 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 18335 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 18336 * image. 18337 * 18338 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 18339 * shadow image that should be underneath the touch point during the drag and drop 18340 * operation. Your application must set {@link android.graphics.Point#x} to the 18341 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 18342 */ 18343 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 18344 final View view = mView.get(); 18345 if (view != null) { 18346 shadowSize.set(view.getWidth(), view.getHeight()); 18347 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 18348 } else { 18349 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 18350 } 18351 } 18352 18353 /** 18354 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 18355 * based on the dimensions it received from the 18356 * {@link #onProvideShadowMetrics(Point, Point)} callback. 18357 * 18358 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 18359 */ 18360 public void onDrawShadow(Canvas canvas) { 18361 final View view = mView.get(); 18362 if (view != null) { 18363 view.draw(canvas); 18364 } else { 18365 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 18366 } 18367 } 18368 } 18369 18370 /** 18371 * Starts a drag and drop operation. When your application calls this method, it passes a 18372 * {@link android.view.View.DragShadowBuilder} object to the system. The 18373 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 18374 * to get metrics for the drag shadow, and then calls the object's 18375 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 18376 * <p> 18377 * Once the system has the drag shadow, it begins the drag and drop operation by sending 18378 * drag events to all the View objects in your application that are currently visible. It does 18379 * this either by calling the View object's drag listener (an implementation of 18380 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 18381 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 18382 * Both are passed a {@link android.view.DragEvent} object that has a 18383 * {@link android.view.DragEvent#getAction()} value of 18384 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 18385 * </p> 18386 * <p> 18387 * Your application can invoke startDrag() on any attached View object. The View object does not 18388 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 18389 * be related to the View the user selected for dragging. 18390 * </p> 18391 * @param data A {@link android.content.ClipData} object pointing to the data to be 18392 * transferred by the drag and drop operation. 18393 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 18394 * drag shadow. 18395 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 18396 * drop operation. This Object is put into every DragEvent object sent by the system during the 18397 * current drag. 18398 * <p> 18399 * myLocalState is a lightweight mechanism for the sending information from the dragged View 18400 * to the target Views. For example, it can contain flags that differentiate between a 18401 * a copy operation and a move operation. 18402 * </p> 18403 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 18404 * so the parameter should be set to 0. 18405 * @return {@code true} if the method completes successfully, or 18406 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 18407 * do a drag, and so no drag operation is in progress. 18408 */ 18409 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 18410 Object myLocalState, int flags) { 18411 if (ViewDebug.DEBUG_DRAG) { 18412 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 18413 } 18414 boolean okay = false; 18415 18416 Point shadowSize = new Point(); 18417 Point shadowTouchPoint = new Point(); 18418 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 18419 18420 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 18421 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 18422 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 18423 } 18424 18425 if (ViewDebug.DEBUG_DRAG) { 18426 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 18427 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 18428 } 18429 Surface surface = new Surface(); 18430 try { 18431 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 18432 flags, shadowSize.x, shadowSize.y, surface); 18433 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 18434 + " surface=" + surface); 18435 if (token != null) { 18436 Canvas canvas = surface.lockCanvas(null); 18437 try { 18438 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 18439 shadowBuilder.onDrawShadow(canvas); 18440 } finally { 18441 surface.unlockCanvasAndPost(canvas); 18442 } 18443 18444 final ViewRootImpl root = getViewRootImpl(); 18445 18446 // Cache the local state object for delivery with DragEvents 18447 root.setLocalDragState(myLocalState); 18448 18449 // repurpose 'shadowSize' for the last touch point 18450 root.getLastTouchPoint(shadowSize); 18451 18452 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 18453 shadowSize.x, shadowSize.y, 18454 shadowTouchPoint.x, shadowTouchPoint.y, data); 18455 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 18456 18457 // Off and running! Release our local surface instance; the drag 18458 // shadow surface is now managed by the system process. 18459 surface.release(); 18460 } 18461 } catch (Exception e) { 18462 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 18463 surface.destroy(); 18464 } 18465 18466 return okay; 18467 } 18468 18469 /** 18470 * Handles drag events sent by the system following a call to 18471 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 18472 *<p> 18473 * When the system calls this method, it passes a 18474 * {@link android.view.DragEvent} object. A call to 18475 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 18476 * in DragEvent. The method uses these to determine what is happening in the drag and drop 18477 * operation. 18478 * @param event The {@link android.view.DragEvent} sent by the system. 18479 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 18480 * in DragEvent, indicating the type of drag event represented by this object. 18481 * @return {@code true} if the method was successful, otherwise {@code false}. 18482 * <p> 18483 * The method should return {@code true} in response to an action type of 18484 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 18485 * operation. 18486 * </p> 18487 * <p> 18488 * The method should also return {@code true} in response to an action type of 18489 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 18490 * {@code false} if it didn't. 18491 * </p> 18492 */ 18493 public boolean onDragEvent(DragEvent event) { 18494 return false; 18495 } 18496 18497 /** 18498 * Detects if this View is enabled and has a drag event listener. 18499 * If both are true, then it calls the drag event listener with the 18500 * {@link android.view.DragEvent} it received. If the drag event listener returns 18501 * {@code true}, then dispatchDragEvent() returns {@code true}. 18502 * <p> 18503 * For all other cases, the method calls the 18504 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 18505 * method and returns its result. 18506 * </p> 18507 * <p> 18508 * This ensures that a drag event is always consumed, even if the View does not have a drag 18509 * event listener. However, if the View has a listener and the listener returns true, then 18510 * onDragEvent() is not called. 18511 * </p> 18512 */ 18513 public boolean dispatchDragEvent(DragEvent event) { 18514 ListenerInfo li = mListenerInfo; 18515 //noinspection SimplifiableIfStatement 18516 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 18517 && li.mOnDragListener.onDrag(this, event)) { 18518 return true; 18519 } 18520 return onDragEvent(event); 18521 } 18522 18523 boolean canAcceptDrag() { 18524 return (mPrivateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0; 18525 } 18526 18527 /** 18528 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 18529 * it is ever exposed at all. 18530 * @hide 18531 */ 18532 public void onCloseSystemDialogs(String reason) { 18533 } 18534 18535 /** 18536 * Given a Drawable whose bounds have been set to draw into this view, 18537 * update a Region being computed for 18538 * {@link #gatherTransparentRegion(android.graphics.Region)} so 18539 * that any non-transparent parts of the Drawable are removed from the 18540 * given transparent region. 18541 * 18542 * @param dr The Drawable whose transparency is to be applied to the region. 18543 * @param region A Region holding the current transparency information, 18544 * where any parts of the region that are set are considered to be 18545 * transparent. On return, this region will be modified to have the 18546 * transparency information reduced by the corresponding parts of the 18547 * Drawable that are not transparent. 18548 * {@hide} 18549 */ 18550 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 18551 if (DBG) { 18552 Log.i("View", "Getting transparent region for: " + this); 18553 } 18554 final Region r = dr.getTransparentRegion(); 18555 final Rect db = dr.getBounds(); 18556 final AttachInfo attachInfo = mAttachInfo; 18557 if (r != null && attachInfo != null) { 18558 final int w = getRight()-getLeft(); 18559 final int h = getBottom()-getTop(); 18560 if (db.left > 0) { 18561 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 18562 r.op(0, 0, db.left, h, Region.Op.UNION); 18563 } 18564 if (db.right < w) { 18565 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 18566 r.op(db.right, 0, w, h, Region.Op.UNION); 18567 } 18568 if (db.top > 0) { 18569 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 18570 r.op(0, 0, w, db.top, Region.Op.UNION); 18571 } 18572 if (db.bottom < h) { 18573 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 18574 r.op(0, db.bottom, w, h, Region.Op.UNION); 18575 } 18576 final int[] location = attachInfo.mTransparentLocation; 18577 getLocationInWindow(location); 18578 r.translate(location[0], location[1]); 18579 region.op(r, Region.Op.INTERSECT); 18580 } else { 18581 region.op(db, Region.Op.DIFFERENCE); 18582 } 18583 } 18584 18585 private void checkForLongClick(int delayOffset) { 18586 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 18587 mHasPerformedLongPress = false; 18588 18589 if (mPendingCheckForLongPress == null) { 18590 mPendingCheckForLongPress = new CheckForLongPress(); 18591 } 18592 mPendingCheckForLongPress.rememberWindowAttachCount(); 18593 postDelayed(mPendingCheckForLongPress, 18594 ViewConfiguration.getLongPressTimeout() - delayOffset); 18595 } 18596 } 18597 18598 /** 18599 * Inflate a view from an XML resource. This convenience method wraps the {@link 18600 * LayoutInflater} class, which provides a full range of options for view inflation. 18601 * 18602 * @param context The Context object for your activity or application. 18603 * @param resource The resource ID to inflate 18604 * @param root A view group that will be the parent. Used to properly inflate the 18605 * layout_* parameters. 18606 * @see LayoutInflater 18607 */ 18608 public static View inflate(Context context, int resource, ViewGroup root) { 18609 LayoutInflater factory = LayoutInflater.from(context); 18610 return factory.inflate(resource, root); 18611 } 18612 18613 /** 18614 * Scroll the view with standard behavior for scrolling beyond the normal 18615 * content boundaries. Views that call this method should override 18616 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 18617 * results of an over-scroll operation. 18618 * 18619 * Views can use this method to handle any touch or fling-based scrolling. 18620 * 18621 * @param deltaX Change in X in pixels 18622 * @param deltaY Change in Y in pixels 18623 * @param scrollX Current X scroll value in pixels before applying deltaX 18624 * @param scrollY Current Y scroll value in pixels before applying deltaY 18625 * @param scrollRangeX Maximum content scroll range along the X axis 18626 * @param scrollRangeY Maximum content scroll range along the Y axis 18627 * @param maxOverScrollX Number of pixels to overscroll by in either direction 18628 * along the X axis. 18629 * @param maxOverScrollY Number of pixels to overscroll by in either direction 18630 * along the Y axis. 18631 * @param isTouchEvent true if this scroll operation is the result of a touch event. 18632 * @return true if scrolling was clamped to an over-scroll boundary along either 18633 * axis, false otherwise. 18634 */ 18635 @SuppressWarnings({"UnusedParameters"}) 18636 protected boolean overScrollBy(int deltaX, int deltaY, 18637 int scrollX, int scrollY, 18638 int scrollRangeX, int scrollRangeY, 18639 int maxOverScrollX, int maxOverScrollY, 18640 boolean isTouchEvent) { 18641 final int overScrollMode = mOverScrollMode; 18642 final boolean canScrollHorizontal = 18643 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 18644 final boolean canScrollVertical = 18645 computeVerticalScrollRange() > computeVerticalScrollExtent(); 18646 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 18647 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 18648 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 18649 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 18650 18651 int newScrollX = scrollX + deltaX; 18652 if (!overScrollHorizontal) { 18653 maxOverScrollX = 0; 18654 } 18655 18656 int newScrollY = scrollY + deltaY; 18657 if (!overScrollVertical) { 18658 maxOverScrollY = 0; 18659 } 18660 18661 // Clamp values if at the limits and record 18662 final int left = -maxOverScrollX; 18663 final int right = maxOverScrollX + scrollRangeX; 18664 final int top = -maxOverScrollY; 18665 final int bottom = maxOverScrollY + scrollRangeY; 18666 18667 boolean clampedX = false; 18668 if (newScrollX > right) { 18669 newScrollX = right; 18670 clampedX = true; 18671 } else if (newScrollX < left) { 18672 newScrollX = left; 18673 clampedX = true; 18674 } 18675 18676 boolean clampedY = false; 18677 if (newScrollY > bottom) { 18678 newScrollY = bottom; 18679 clampedY = true; 18680 } else if (newScrollY < top) { 18681 newScrollY = top; 18682 clampedY = true; 18683 } 18684 18685 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 18686 18687 return clampedX || clampedY; 18688 } 18689 18690 /** 18691 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 18692 * respond to the results of an over-scroll operation. 18693 * 18694 * @param scrollX New X scroll value in pixels 18695 * @param scrollY New Y scroll value in pixels 18696 * @param clampedX True if scrollX was clamped to an over-scroll boundary 18697 * @param clampedY True if scrollY was clamped to an over-scroll boundary 18698 */ 18699 protected void onOverScrolled(int scrollX, int scrollY, 18700 boolean clampedX, boolean clampedY) { 18701 // Intentionally empty. 18702 } 18703 18704 /** 18705 * Returns the over-scroll mode for this view. The result will be 18706 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18707 * (allow over-scrolling only if the view content is larger than the container), 18708 * or {@link #OVER_SCROLL_NEVER}. 18709 * 18710 * @return This view's over-scroll mode. 18711 */ 18712 public int getOverScrollMode() { 18713 return mOverScrollMode; 18714 } 18715 18716 /** 18717 * Set the over-scroll mode for this view. Valid over-scroll modes are 18718 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18719 * (allow over-scrolling only if the view content is larger than the container), 18720 * or {@link #OVER_SCROLL_NEVER}. 18721 * 18722 * Setting the over-scroll mode of a view will have an effect only if the 18723 * view is capable of scrolling. 18724 * 18725 * @param overScrollMode The new over-scroll mode for this view. 18726 */ 18727 public void setOverScrollMode(int overScrollMode) { 18728 if (overScrollMode != OVER_SCROLL_ALWAYS && 18729 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 18730 overScrollMode != OVER_SCROLL_NEVER) { 18731 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 18732 } 18733 mOverScrollMode = overScrollMode; 18734 } 18735 18736 /** 18737 * Enable or disable nested scrolling for this view. 18738 * 18739 * <p>If this property is set to true the view will be permitted to initiate nested 18740 * scrolling operations with a compatible parent view in the current hierarchy. If this 18741 * view does not implement nested scrolling this will have no effect. Disabling nested scrolling 18742 * while a nested scroll is in progress has the effect of {@link #stopNestedScroll() stopping} 18743 * the nested scroll.</p> 18744 * 18745 * @param enabled true to enable nested scrolling, false to disable 18746 * 18747 * @see #isNestedScrollingEnabled() 18748 */ 18749 public void setNestedScrollingEnabled(boolean enabled) { 18750 if (enabled) { 18751 mPrivateFlags3 |= PFLAG3_NESTED_SCROLLING_ENABLED; 18752 } else { 18753 stopNestedScroll(); 18754 mPrivateFlags3 &= ~PFLAG3_NESTED_SCROLLING_ENABLED; 18755 } 18756 } 18757 18758 /** 18759 * Returns true if nested scrolling is enabled for this view. 18760 * 18761 * <p>If nested scrolling is enabled and this View class implementation supports it, 18762 * this view will act as a nested scrolling child view when applicable, forwarding data 18763 * about the scroll operation in progress to a compatible and cooperating nested scrolling 18764 * parent.</p> 18765 * 18766 * @return true if nested scrolling is enabled 18767 * 18768 * @see #setNestedScrollingEnabled(boolean) 18769 */ 18770 public boolean isNestedScrollingEnabled() { 18771 return (mPrivateFlags3 & PFLAG3_NESTED_SCROLLING_ENABLED) == 18772 PFLAG3_NESTED_SCROLLING_ENABLED; 18773 } 18774 18775 /** 18776 * Begin a nestable scroll operation along the given axes. 18777 * 18778 * <p>A view starting a nested scroll promises to abide by the following contract:</p> 18779 * 18780 * <p>The view will call startNestedScroll upon initiating a scroll operation. In the case 18781 * of a touch scroll this corresponds to the initial {@link MotionEvent#ACTION_DOWN}. 18782 * In the case of touch scrolling the nested scroll will be terminated automatically in 18783 * the same manner as {@link ViewParent#requestDisallowInterceptTouchEvent(boolean)}. 18784 * In the event of programmatic scrolling the caller must explicitly call 18785 * {@link #stopNestedScroll()} to indicate the end of the nested scroll.</p> 18786 * 18787 * <p>If <code>startNestedScroll</code> returns true, a cooperative parent was found. 18788 * If it returns false the caller may ignore the rest of this contract until the next scroll. 18789 * Calling startNestedScroll while a nested scroll is already in progress will return true.</p> 18790 * 18791 * <p>At each incremental step of the scroll the caller should invoke 18792 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} 18793 * once it has calculated the requested scrolling delta. If it returns true the nested scrolling 18794 * parent at least partially consumed the scroll and the caller should adjust the amount it 18795 * scrolls by.</p> 18796 * 18797 * <p>After applying the remainder of the scroll delta the caller should invoke 18798 * {@link #dispatchNestedScroll(int, int, int, int, int[]) dispatchNestedScroll}, passing 18799 * both the delta consumed and the delta unconsumed. A nested scrolling parent may treat 18800 * these values differently. See {@link ViewParent#onNestedScroll(View, int, int, int, int)}. 18801 * </p> 18802 * 18803 * @param axes Flags consisting of a combination of {@link #SCROLL_AXIS_HORIZONTAL} and/or 18804 * {@link #SCROLL_AXIS_VERTICAL}. 18805 * @return true if a cooperative parent was found and nested scrolling has been enabled for 18806 * the current gesture. 18807 * 18808 * @see #stopNestedScroll() 18809 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18810 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18811 */ 18812 public boolean startNestedScroll(int axes) { 18813 if (hasNestedScrollingParent()) { 18814 // Already in progress 18815 return true; 18816 } 18817 if (isNestedScrollingEnabled()) { 18818 ViewParent p = getParent(); 18819 View child = this; 18820 while (p != null) { 18821 try { 18822 if (p.onStartNestedScroll(child, this, axes)) { 18823 mNestedScrollingParent = p; 18824 p.onNestedScrollAccepted(child, this, axes); 18825 return true; 18826 } 18827 } catch (AbstractMethodError e) { 18828 Log.e(VIEW_LOG_TAG, "ViewParent " + p + " does not implement interface " + 18829 "method onStartNestedScroll", e); 18830 // Allow the search upward to continue 18831 } 18832 if (p instanceof View) { 18833 child = (View) p; 18834 } 18835 p = p.getParent(); 18836 } 18837 } 18838 return false; 18839 } 18840 18841 /** 18842 * Stop a nested scroll in progress. 18843 * 18844 * <p>Calling this method when a nested scroll is not currently in progress is harmless.</p> 18845 * 18846 * @see #startNestedScroll(int) 18847 */ 18848 public void stopNestedScroll() { 18849 if (mNestedScrollingParent != null) { 18850 mNestedScrollingParent.onStopNestedScroll(this); 18851 mNestedScrollingParent = null; 18852 } 18853 } 18854 18855 /** 18856 * Returns true if this view has a nested scrolling parent. 18857 * 18858 * <p>The presence of a nested scrolling parent indicates that this view has initiated 18859 * a nested scroll and it was accepted by an ancestor view further up the view hierarchy.</p> 18860 * 18861 * @return whether this view has a nested scrolling parent 18862 */ 18863 public boolean hasNestedScrollingParent() { 18864 return mNestedScrollingParent != null; 18865 } 18866 18867 /** 18868 * Dispatch one step of a nested scroll in progress. 18869 * 18870 * <p>Implementations of views that support nested scrolling should call this to report 18871 * info about a scroll in progress to the current nested scrolling parent. If a nested scroll 18872 * is not currently in progress or nested scrolling is not 18873 * {@link #isNestedScrollingEnabled() enabled} for this view this method does nothing.</p> 18874 * 18875 * <p>Compatible View implementations should also call 18876 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} before 18877 * consuming a component of the scroll event themselves.</p> 18878 * 18879 * @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step 18880 * @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step 18881 * @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view 18882 * @param dyUnconsumed Horizontal scroll distance in pixels not consumed by this view 18883 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18884 * in local view coordinates of this view from before this operation 18885 * to after it completes. View implementations may use this to adjust 18886 * expected input coordinate tracking. 18887 * @return true if the event was dispatched, false if it could not be dispatched. 18888 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18889 */ 18890 public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed, 18891 int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) { 18892 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18893 if (dxConsumed != 0 || dyConsumed != 0 || dxUnconsumed != 0 || dyUnconsumed != 0) { 18894 int startX = 0; 18895 int startY = 0; 18896 if (offsetInWindow != null) { 18897 getLocationInWindow(offsetInWindow); 18898 startX = offsetInWindow[0]; 18899 startY = offsetInWindow[1]; 18900 } 18901 18902 mNestedScrollingParent.onNestedScroll(this, dxConsumed, dyConsumed, 18903 dxUnconsumed, dyUnconsumed); 18904 18905 if (offsetInWindow != null) { 18906 getLocationInWindow(offsetInWindow); 18907 offsetInWindow[0] -= startX; 18908 offsetInWindow[1] -= startY; 18909 } 18910 return true; 18911 } else if (offsetInWindow != null) { 18912 // No motion, no dispatch. Keep offsetInWindow up to date. 18913 offsetInWindow[0] = 0; 18914 offsetInWindow[1] = 0; 18915 } 18916 } 18917 return false; 18918 } 18919 18920 /** 18921 * Dispatch one step of a nested scroll in progress before this view consumes any portion of it. 18922 * 18923 * <p>Nested pre-scroll events are to nested scroll events what touch intercept is to touch. 18924 * <code>dispatchNestedPreScroll</code> offers an opportunity for the parent view in a nested 18925 * scrolling operation to consume some or all of the scroll operation before the child view 18926 * consumes it.</p> 18927 * 18928 * @param dx Horizontal scroll distance in pixels 18929 * @param dy Vertical scroll distance in pixels 18930 * @param consumed Output. If not null, consumed[0] will contain the consumed component of dx 18931 * and consumed[1] the consumed dy. 18932 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18933 * in local view coordinates of this view from before this operation 18934 * to after it completes. View implementations may use this to adjust 18935 * expected input coordinate tracking. 18936 * @return true if the parent consumed some or all of the scroll delta 18937 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18938 */ 18939 public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) { 18940 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18941 if (dx != 0 || dy != 0) { 18942 int startX = 0; 18943 int startY = 0; 18944 if (offsetInWindow != null) { 18945 getLocationInWindow(offsetInWindow); 18946 startX = offsetInWindow[0]; 18947 startY = offsetInWindow[1]; 18948 } 18949 18950 if (consumed == null) { 18951 if (mTempNestedScrollConsumed == null) { 18952 mTempNestedScrollConsumed = new int[2]; 18953 } 18954 consumed = mTempNestedScrollConsumed; 18955 } 18956 consumed[0] = 0; 18957 consumed[1] = 0; 18958 mNestedScrollingParent.onNestedPreScroll(this, dx, dy, consumed); 18959 18960 if (offsetInWindow != null) { 18961 getLocationInWindow(offsetInWindow); 18962 offsetInWindow[0] -= startX; 18963 offsetInWindow[1] -= startY; 18964 } 18965 return consumed[0] != 0 || consumed[1] != 0; 18966 } else if (offsetInWindow != null) { 18967 offsetInWindow[0] = 0; 18968 offsetInWindow[1] = 0; 18969 } 18970 } 18971 return false; 18972 } 18973 18974 /** 18975 * Dispatch a fling to a nested scrolling parent. 18976 * 18977 * <p>This method should be used to indicate that a nested scrolling child has detected 18978 * suitable conditions for a fling. Generally this means that a touch scroll has ended with a 18979 * {@link VelocityTracker velocity} in the direction of scrolling that meets or exceeds 18980 * the {@link ViewConfiguration#getScaledMinimumFlingVelocity() minimum fling velocity} 18981 * along a scrollable axis.</p> 18982 * 18983 * <p>If a nested scrolling child view would normally fling but it is at the edge of 18984 * its own content, it can use this method to delegate the fling to its nested scrolling 18985 * parent instead. The parent may optionally consume the fling or observe a child fling.</p> 18986 * 18987 * @param velocityX Horizontal fling velocity in pixels per second 18988 * @param velocityY Vertical fling velocity in pixels per second 18989 * @param consumed true if the child consumed the fling, false otherwise 18990 * @return true if the nested scrolling parent consumed or otherwise reacted to the fling 18991 */ 18992 public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) { 18993 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18994 return mNestedScrollingParent.onNestedFling(this, velocityX, velocityY, consumed); 18995 } 18996 return false; 18997 } 18998 18999 /** 19000 * Dispatch a fling to a nested scrolling parent before it is processed by this view. 19001 * 19002 * <p>Nested pre-fling events are to nested fling events what touch intercept is to touch 19003 * and what nested pre-scroll is to nested scroll. <code>dispatchNestedPreFling</code> 19004 * offsets an opportunity for the parent view in a nested fling to fully consume the fling 19005 * before the child view consumes it. If this method returns <code>true</code>, a nested 19006 * parent view consumed the fling and this view should not scroll as a result.</p> 19007 * 19008 * <p>For a better user experience, only one view in a nested scrolling chain should consume 19009 * the fling at a time. If a parent view consumed the fling this method will return false. 19010 * Custom view implementations should account for this in two ways:</p> 19011 * 19012 * <ul> 19013 * <li>If a custom view is paged and needs to settle to a fixed page-point, do not 19014 * call <code>dispatchNestedPreFling</code>; consume the fling and settle to a valid 19015 * position regardless.</li> 19016 * <li>If a nested parent does consume the fling, this view should not scroll at all, 19017 * even to settle back to a valid idle position.</li> 19018 * </ul> 19019 * 19020 * <p>Views should also not offer fling velocities to nested parent views along an axis 19021 * where scrolling is not currently supported; a {@link android.widget.ScrollView ScrollView} 19022 * should not offer a horizontal fling velocity to its parents since scrolling along that 19023 * axis is not permitted and carrying velocity along that motion does not make sense.</p> 19024 * 19025 * @param velocityX Horizontal fling velocity in pixels per second 19026 * @param velocityY Vertical fling velocity in pixels per second 19027 * @return true if a nested scrolling parent consumed the fling 19028 */ 19029 public boolean dispatchNestedPreFling(float velocityX, float velocityY) { 19030 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 19031 return mNestedScrollingParent.onNestedPreFling(this, velocityX, velocityY); 19032 } 19033 return false; 19034 } 19035 19036 /** 19037 * Gets a scale factor that determines the distance the view should scroll 19038 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 19039 * @return The vertical scroll scale factor. 19040 * @hide 19041 */ 19042 protected float getVerticalScrollFactor() { 19043 if (mVerticalScrollFactor == 0) { 19044 TypedValue outValue = new TypedValue(); 19045 if (!mContext.getTheme().resolveAttribute( 19046 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 19047 throw new IllegalStateException( 19048 "Expected theme to define listPreferredItemHeight."); 19049 } 19050 mVerticalScrollFactor = outValue.getDimension( 19051 mContext.getResources().getDisplayMetrics()); 19052 } 19053 return mVerticalScrollFactor; 19054 } 19055 19056 /** 19057 * Gets a scale factor that determines the distance the view should scroll 19058 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 19059 * @return The horizontal scroll scale factor. 19060 * @hide 19061 */ 19062 protected float getHorizontalScrollFactor() { 19063 // TODO: Should use something else. 19064 return getVerticalScrollFactor(); 19065 } 19066 19067 /** 19068 * Return the value specifying the text direction or policy that was set with 19069 * {@link #setTextDirection(int)}. 19070 * 19071 * @return the defined text direction. It can be one of: 19072 * 19073 * {@link #TEXT_DIRECTION_INHERIT}, 19074 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19075 * {@link #TEXT_DIRECTION_ANY_RTL}, 19076 * {@link #TEXT_DIRECTION_LTR}, 19077 * {@link #TEXT_DIRECTION_RTL}, 19078 * {@link #TEXT_DIRECTION_LOCALE} 19079 * 19080 * @attr ref android.R.styleable#View_textDirection 19081 * 19082 * @hide 19083 */ 19084 @ViewDebug.ExportedProperty(category = "text", mapping = { 19085 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19086 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19087 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19088 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19089 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19090 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19091 }) 19092 public int getRawTextDirection() { 19093 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_MASK) >> PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 19094 } 19095 19096 /** 19097 * Set the text direction. 19098 * 19099 * @param textDirection the direction to set. Should be one of: 19100 * 19101 * {@link #TEXT_DIRECTION_INHERIT}, 19102 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19103 * {@link #TEXT_DIRECTION_ANY_RTL}, 19104 * {@link #TEXT_DIRECTION_LTR}, 19105 * {@link #TEXT_DIRECTION_RTL}, 19106 * {@link #TEXT_DIRECTION_LOCALE} 19107 * 19108 * Resolution will be done if the value is set to TEXT_DIRECTION_INHERIT. The resolution 19109 * proceeds up the parent chain of the view to get the value. If there is no parent, then it will 19110 * return the default {@link #TEXT_DIRECTION_FIRST_STRONG}. 19111 * 19112 * @attr ref android.R.styleable#View_textDirection 19113 */ 19114 public void setTextDirection(int textDirection) { 19115 if (getRawTextDirection() != textDirection) { 19116 // Reset the current text direction and the resolved one 19117 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 19118 resetResolvedTextDirection(); 19119 // Set the new text direction 19120 mPrivateFlags2 |= ((textDirection << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) & PFLAG2_TEXT_DIRECTION_MASK); 19121 // Do resolution 19122 resolveTextDirection(); 19123 // Notify change 19124 onRtlPropertiesChanged(getLayoutDirection()); 19125 // Refresh 19126 requestLayout(); 19127 invalidate(true); 19128 } 19129 } 19130 19131 /** 19132 * Return the resolved text direction. 19133 * 19134 * @return the resolved text direction. Returns one of: 19135 * 19136 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19137 * {@link #TEXT_DIRECTION_ANY_RTL}, 19138 * {@link #TEXT_DIRECTION_LTR}, 19139 * {@link #TEXT_DIRECTION_RTL}, 19140 * {@link #TEXT_DIRECTION_LOCALE} 19141 * 19142 * @attr ref android.R.styleable#View_textDirection 19143 */ 19144 @ViewDebug.ExportedProperty(category = "text", mapping = { 19145 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19146 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19147 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19148 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19149 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19150 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19151 }) 19152 public int getTextDirection() { 19153 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED_MASK) >> PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 19154 } 19155 19156 /** 19157 * Resolve the text direction. 19158 * 19159 * @return true if resolution has been done, false otherwise. 19160 * 19161 * @hide 19162 */ 19163 public boolean resolveTextDirection() { 19164 // Reset any previous text direction resolution 19165 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19166 19167 if (hasRtlSupport()) { 19168 // Set resolved text direction flag depending on text direction flag 19169 final int textDirection = getRawTextDirection(); 19170 switch(textDirection) { 19171 case TEXT_DIRECTION_INHERIT: 19172 if (!canResolveTextDirection()) { 19173 // We cannot do the resolution if there is no parent, so use the default one 19174 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19175 // Resolution will need to happen again later 19176 return false; 19177 } 19178 19179 // Parent has not yet resolved, so we still return the default 19180 try { 19181 if (!mParent.isTextDirectionResolved()) { 19182 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19183 // Resolution will need to happen again later 19184 return false; 19185 } 19186 } catch (AbstractMethodError e) { 19187 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19188 " does not fully implement ViewParent", e); 19189 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED | 19190 PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19191 return true; 19192 } 19193 19194 // Set current resolved direction to the same value as the parent's one 19195 int parentResolvedDirection; 19196 try { 19197 parentResolvedDirection = mParent.getTextDirection(); 19198 } catch (AbstractMethodError e) { 19199 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19200 " does not fully implement ViewParent", e); 19201 parentResolvedDirection = TEXT_DIRECTION_LTR; 19202 } 19203 switch (parentResolvedDirection) { 19204 case TEXT_DIRECTION_FIRST_STRONG: 19205 case TEXT_DIRECTION_ANY_RTL: 19206 case TEXT_DIRECTION_LTR: 19207 case TEXT_DIRECTION_RTL: 19208 case TEXT_DIRECTION_LOCALE: 19209 mPrivateFlags2 |= 19210 (parentResolvedDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19211 break; 19212 default: 19213 // Default resolved direction is "first strong" heuristic 19214 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19215 } 19216 break; 19217 case TEXT_DIRECTION_FIRST_STRONG: 19218 case TEXT_DIRECTION_ANY_RTL: 19219 case TEXT_DIRECTION_LTR: 19220 case TEXT_DIRECTION_RTL: 19221 case TEXT_DIRECTION_LOCALE: 19222 // Resolved direction is the same as text direction 19223 mPrivateFlags2 |= (textDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19224 break; 19225 default: 19226 // Default resolved direction is "first strong" heuristic 19227 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19228 } 19229 } else { 19230 // Default resolved direction is "first strong" heuristic 19231 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19232 } 19233 19234 // Set to resolved 19235 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED; 19236 return true; 19237 } 19238 19239 /** 19240 * Check if text direction resolution can be done. 19241 * 19242 * @return true if text direction resolution can be done otherwise return false. 19243 */ 19244 public boolean canResolveTextDirection() { 19245 switch (getRawTextDirection()) { 19246 case TEXT_DIRECTION_INHERIT: 19247 if (mParent != null) { 19248 try { 19249 return mParent.canResolveTextDirection(); 19250 } catch (AbstractMethodError e) { 19251 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19252 " does not fully implement ViewParent", e); 19253 } 19254 } 19255 return false; 19256 19257 default: 19258 return true; 19259 } 19260 } 19261 19262 /** 19263 * Reset resolved text direction. Text direction will be resolved during a call to 19264 * {@link #onMeasure(int, int)}. 19265 * 19266 * @hide 19267 */ 19268 public void resetResolvedTextDirection() { 19269 // Reset any previous text direction resolution 19270 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19271 // Set to default value 19272 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19273 } 19274 19275 /** 19276 * @return true if text direction is inherited. 19277 * 19278 * @hide 19279 */ 19280 public boolean isTextDirectionInherited() { 19281 return (getRawTextDirection() == TEXT_DIRECTION_INHERIT); 19282 } 19283 19284 /** 19285 * @return true if text direction is resolved. 19286 */ 19287 public boolean isTextDirectionResolved() { 19288 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED) == PFLAG2_TEXT_DIRECTION_RESOLVED; 19289 } 19290 19291 /** 19292 * Return the value specifying the text alignment or policy that was set with 19293 * {@link #setTextAlignment(int)}. 19294 * 19295 * @return the defined text alignment. It can be one of: 19296 * 19297 * {@link #TEXT_ALIGNMENT_INHERIT}, 19298 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19299 * {@link #TEXT_ALIGNMENT_CENTER}, 19300 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19301 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19302 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19303 * {@link #TEXT_ALIGNMENT_VIEW_END} 19304 * 19305 * @attr ref android.R.styleable#View_textAlignment 19306 * 19307 * @hide 19308 */ 19309 @ViewDebug.ExportedProperty(category = "text", mapping = { 19310 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19311 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19312 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19313 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19314 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19315 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19316 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19317 }) 19318 @TextAlignment 19319 public int getRawTextAlignment() { 19320 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_MASK) >> PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 19321 } 19322 19323 /** 19324 * Set the text alignment. 19325 * 19326 * @param textAlignment The text alignment to set. Should be one of 19327 * 19328 * {@link #TEXT_ALIGNMENT_INHERIT}, 19329 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19330 * {@link #TEXT_ALIGNMENT_CENTER}, 19331 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19332 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19333 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19334 * {@link #TEXT_ALIGNMENT_VIEW_END} 19335 * 19336 * Resolution will be done if the value is set to TEXT_ALIGNMENT_INHERIT. The resolution 19337 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 19338 * will return the default {@link #TEXT_ALIGNMENT_GRAVITY}. 19339 * 19340 * @attr ref android.R.styleable#View_textAlignment 19341 */ 19342 public void setTextAlignment(@TextAlignment int textAlignment) { 19343 if (textAlignment != getRawTextAlignment()) { 19344 // Reset the current and resolved text alignment 19345 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 19346 resetResolvedTextAlignment(); 19347 // Set the new text alignment 19348 mPrivateFlags2 |= 19349 ((textAlignment << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) & PFLAG2_TEXT_ALIGNMENT_MASK); 19350 // Do resolution 19351 resolveTextAlignment(); 19352 // Notify change 19353 onRtlPropertiesChanged(getLayoutDirection()); 19354 // Refresh 19355 requestLayout(); 19356 invalidate(true); 19357 } 19358 } 19359 19360 /** 19361 * Return the resolved text alignment. 19362 * 19363 * @return the resolved text alignment. Returns one of: 19364 * 19365 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19366 * {@link #TEXT_ALIGNMENT_CENTER}, 19367 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19368 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19369 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19370 * {@link #TEXT_ALIGNMENT_VIEW_END} 19371 * 19372 * @attr ref android.R.styleable#View_textAlignment 19373 */ 19374 @ViewDebug.ExportedProperty(category = "text", mapping = { 19375 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19376 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19377 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19378 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19379 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19380 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19381 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19382 }) 19383 @TextAlignment 19384 public int getTextAlignment() { 19385 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK) >> 19386 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 19387 } 19388 19389 /** 19390 * Resolve the text alignment. 19391 * 19392 * @return true if resolution has been done, false otherwise. 19393 * 19394 * @hide 19395 */ 19396 public boolean resolveTextAlignment() { 19397 // Reset any previous text alignment resolution 19398 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19399 19400 if (hasRtlSupport()) { 19401 // Set resolved text alignment flag depending on text alignment flag 19402 final int textAlignment = getRawTextAlignment(); 19403 switch (textAlignment) { 19404 case TEXT_ALIGNMENT_INHERIT: 19405 // Check if we can resolve the text alignment 19406 if (!canResolveTextAlignment()) { 19407 // We cannot do the resolution if there is no parent so use the default 19408 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19409 // Resolution will need to happen again later 19410 return false; 19411 } 19412 19413 // Parent has not yet resolved, so we still return the default 19414 try { 19415 if (!mParent.isTextAlignmentResolved()) { 19416 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19417 // Resolution will need to happen again later 19418 return false; 19419 } 19420 } catch (AbstractMethodError e) { 19421 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19422 " does not fully implement ViewParent", e); 19423 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED | 19424 PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19425 return true; 19426 } 19427 19428 int parentResolvedTextAlignment; 19429 try { 19430 parentResolvedTextAlignment = mParent.getTextAlignment(); 19431 } catch (AbstractMethodError e) { 19432 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19433 " does not fully implement ViewParent", e); 19434 parentResolvedTextAlignment = TEXT_ALIGNMENT_GRAVITY; 19435 } 19436 switch (parentResolvedTextAlignment) { 19437 case TEXT_ALIGNMENT_GRAVITY: 19438 case TEXT_ALIGNMENT_TEXT_START: 19439 case TEXT_ALIGNMENT_TEXT_END: 19440 case TEXT_ALIGNMENT_CENTER: 19441 case TEXT_ALIGNMENT_VIEW_START: 19442 case TEXT_ALIGNMENT_VIEW_END: 19443 // Resolved text alignment is the same as the parent resolved 19444 // text alignment 19445 mPrivateFlags2 |= 19446 (parentResolvedTextAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19447 break; 19448 default: 19449 // Use default resolved text alignment 19450 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19451 } 19452 break; 19453 case TEXT_ALIGNMENT_GRAVITY: 19454 case TEXT_ALIGNMENT_TEXT_START: 19455 case TEXT_ALIGNMENT_TEXT_END: 19456 case TEXT_ALIGNMENT_CENTER: 19457 case TEXT_ALIGNMENT_VIEW_START: 19458 case TEXT_ALIGNMENT_VIEW_END: 19459 // Resolved text alignment is the same as text alignment 19460 mPrivateFlags2 |= (textAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19461 break; 19462 default: 19463 // Use default resolved text alignment 19464 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19465 } 19466 } else { 19467 // Use default resolved text alignment 19468 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19469 } 19470 19471 // Set the resolved 19472 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19473 return true; 19474 } 19475 19476 /** 19477 * Check if text alignment resolution can be done. 19478 * 19479 * @return true if text alignment resolution can be done otherwise return false. 19480 */ 19481 public boolean canResolveTextAlignment() { 19482 switch (getRawTextAlignment()) { 19483 case TEXT_DIRECTION_INHERIT: 19484 if (mParent != null) { 19485 try { 19486 return mParent.canResolveTextAlignment(); 19487 } catch (AbstractMethodError e) { 19488 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19489 " does not fully implement ViewParent", e); 19490 } 19491 } 19492 return false; 19493 19494 default: 19495 return true; 19496 } 19497 } 19498 19499 /** 19500 * Reset resolved text alignment. Text alignment will be resolved during a call to 19501 * {@link #onMeasure(int, int)}. 19502 * 19503 * @hide 19504 */ 19505 public void resetResolvedTextAlignment() { 19506 // Reset any previous text alignment resolution 19507 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19508 // Set to default 19509 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19510 } 19511 19512 /** 19513 * @return true if text alignment is inherited. 19514 * 19515 * @hide 19516 */ 19517 public boolean isTextAlignmentInherited() { 19518 return (getRawTextAlignment() == TEXT_ALIGNMENT_INHERIT); 19519 } 19520 19521 /** 19522 * @return true if text alignment is resolved. 19523 */ 19524 public boolean isTextAlignmentResolved() { 19525 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED) == PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19526 } 19527 19528 /** 19529 * Generate a value suitable for use in {@link #setId(int)}. 19530 * This value will not collide with ID values generated at build time by aapt for R.id. 19531 * 19532 * @return a generated ID value 19533 */ 19534 public static int generateViewId() { 19535 for (;;) { 19536 final int result = sNextGeneratedId.get(); 19537 // aapt-generated IDs have the high byte nonzero; clamp to the range under that. 19538 int newValue = result + 1; 19539 if (newValue > 0x00FFFFFF) newValue = 1; // Roll over to 1, not 0. 19540 if (sNextGeneratedId.compareAndSet(result, newValue)) { 19541 return result; 19542 } 19543 } 19544 } 19545 19546 /** 19547 * Gets the Views in the hierarchy affected by entering and exiting Activity Scene transitions. 19548 * @param transitioningViews This View will be added to transitioningViews if it is VISIBLE and 19549 * a normal View or a ViewGroup with 19550 * {@link android.view.ViewGroup#isTransitionGroup()} true. 19551 * @hide 19552 */ 19553 public void captureTransitioningViews(List<View> transitioningViews) { 19554 if (getVisibility() == View.VISIBLE) { 19555 transitioningViews.add(this); 19556 } 19557 } 19558 19559 /** 19560 * Adds all Views that have {@link #getTransitionName()} non-null to namedElements. 19561 * @param namedElements Will contain all Views in the hierarchy having a transitionName. 19562 * @hide 19563 */ 19564 public void findNamedViews(Map<String, View> namedElements) { 19565 if (getVisibility() == VISIBLE || mGhostView != null) { 19566 String transitionName = getTransitionName(); 19567 if (transitionName != null) { 19568 namedElements.put(transitionName, this); 19569 } 19570 } 19571 } 19572 19573 // 19574 // Properties 19575 // 19576 /** 19577 * A Property wrapper around the <code>alpha</code> functionality handled by the 19578 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 19579 */ 19580 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 19581 @Override 19582 public void setValue(View object, float value) { 19583 object.setAlpha(value); 19584 } 19585 19586 @Override 19587 public Float get(View object) { 19588 return object.getAlpha(); 19589 } 19590 }; 19591 19592 /** 19593 * A Property wrapper around the <code>translationX</code> functionality handled by the 19594 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 19595 */ 19596 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 19597 @Override 19598 public void setValue(View object, float value) { 19599 object.setTranslationX(value); 19600 } 19601 19602 @Override 19603 public Float get(View object) { 19604 return object.getTranslationX(); 19605 } 19606 }; 19607 19608 /** 19609 * A Property wrapper around the <code>translationY</code> functionality handled by the 19610 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 19611 */ 19612 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 19613 @Override 19614 public void setValue(View object, float value) { 19615 object.setTranslationY(value); 19616 } 19617 19618 @Override 19619 public Float get(View object) { 19620 return object.getTranslationY(); 19621 } 19622 }; 19623 19624 /** 19625 * A Property wrapper around the <code>translationZ</code> functionality handled by the 19626 * {@link View#setTranslationZ(float)} and {@link View#getTranslationZ()} methods. 19627 */ 19628 public static final Property<View, Float> TRANSLATION_Z = new FloatProperty<View>("translationZ") { 19629 @Override 19630 public void setValue(View object, float value) { 19631 object.setTranslationZ(value); 19632 } 19633 19634 @Override 19635 public Float get(View object) { 19636 return object.getTranslationZ(); 19637 } 19638 }; 19639 19640 /** 19641 * A Property wrapper around the <code>x</code> functionality handled by the 19642 * {@link View#setX(float)} and {@link View#getX()} methods. 19643 */ 19644 public static final Property<View, Float> X = new FloatProperty<View>("x") { 19645 @Override 19646 public void setValue(View object, float value) { 19647 object.setX(value); 19648 } 19649 19650 @Override 19651 public Float get(View object) { 19652 return object.getX(); 19653 } 19654 }; 19655 19656 /** 19657 * A Property wrapper around the <code>y</code> functionality handled by the 19658 * {@link View#setY(float)} and {@link View#getY()} methods. 19659 */ 19660 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 19661 @Override 19662 public void setValue(View object, float value) { 19663 object.setY(value); 19664 } 19665 19666 @Override 19667 public Float get(View object) { 19668 return object.getY(); 19669 } 19670 }; 19671 19672 /** 19673 * A Property wrapper around the <code>z</code> functionality handled by the 19674 * {@link View#setZ(float)} and {@link View#getZ()} methods. 19675 */ 19676 public static final Property<View, Float> Z = new FloatProperty<View>("z") { 19677 @Override 19678 public void setValue(View object, float value) { 19679 object.setZ(value); 19680 } 19681 19682 @Override 19683 public Float get(View object) { 19684 return object.getZ(); 19685 } 19686 }; 19687 19688 /** 19689 * A Property wrapper around the <code>rotation</code> functionality handled by the 19690 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 19691 */ 19692 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 19693 @Override 19694 public void setValue(View object, float value) { 19695 object.setRotation(value); 19696 } 19697 19698 @Override 19699 public Float get(View object) { 19700 return object.getRotation(); 19701 } 19702 }; 19703 19704 /** 19705 * A Property wrapper around the <code>rotationX</code> functionality handled by the 19706 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 19707 */ 19708 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 19709 @Override 19710 public void setValue(View object, float value) { 19711 object.setRotationX(value); 19712 } 19713 19714 @Override 19715 public Float get(View object) { 19716 return object.getRotationX(); 19717 } 19718 }; 19719 19720 /** 19721 * A Property wrapper around the <code>rotationY</code> functionality handled by the 19722 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 19723 */ 19724 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 19725 @Override 19726 public void setValue(View object, float value) { 19727 object.setRotationY(value); 19728 } 19729 19730 @Override 19731 public Float get(View object) { 19732 return object.getRotationY(); 19733 } 19734 }; 19735 19736 /** 19737 * A Property wrapper around the <code>scaleX</code> functionality handled by the 19738 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 19739 */ 19740 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 19741 @Override 19742 public void setValue(View object, float value) { 19743 object.setScaleX(value); 19744 } 19745 19746 @Override 19747 public Float get(View object) { 19748 return object.getScaleX(); 19749 } 19750 }; 19751 19752 /** 19753 * A Property wrapper around the <code>scaleY</code> functionality handled by the 19754 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 19755 */ 19756 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 19757 @Override 19758 public void setValue(View object, float value) { 19759 object.setScaleY(value); 19760 } 19761 19762 @Override 19763 public Float get(View object) { 19764 return object.getScaleY(); 19765 } 19766 }; 19767 19768 /** 19769 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 19770 * Each MeasureSpec represents a requirement for either the width or the height. 19771 * A MeasureSpec is comprised of a size and a mode. There are three possible 19772 * modes: 19773 * <dl> 19774 * <dt>UNSPECIFIED</dt> 19775 * <dd> 19776 * The parent has not imposed any constraint on the child. It can be whatever size 19777 * it wants. 19778 * </dd> 19779 * 19780 * <dt>EXACTLY</dt> 19781 * <dd> 19782 * The parent has determined an exact size for the child. The child is going to be 19783 * given those bounds regardless of how big it wants to be. 19784 * </dd> 19785 * 19786 * <dt>AT_MOST</dt> 19787 * <dd> 19788 * The child can be as large as it wants up to the specified size. 19789 * </dd> 19790 * </dl> 19791 * 19792 * MeasureSpecs are implemented as ints to reduce object allocation. This class 19793 * is provided to pack and unpack the <size, mode> tuple into the int. 19794 */ 19795 public static class MeasureSpec { 19796 private static final int MODE_SHIFT = 30; 19797 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 19798 19799 /** 19800 * Measure specification mode: The parent has not imposed any constraint 19801 * on the child. It can be whatever size it wants. 19802 */ 19803 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 19804 19805 /** 19806 * Measure specification mode: The parent has determined an exact size 19807 * for the child. The child is going to be given those bounds regardless 19808 * of how big it wants to be. 19809 */ 19810 public static final int EXACTLY = 1 << MODE_SHIFT; 19811 19812 /** 19813 * Measure specification mode: The child can be as large as it wants up 19814 * to the specified size. 19815 */ 19816 public static final int AT_MOST = 2 << MODE_SHIFT; 19817 19818 /** 19819 * Creates a measure specification based on the supplied size and mode. 19820 * 19821 * The mode must always be one of the following: 19822 * <ul> 19823 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 19824 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 19825 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 19826 * </ul> 19827 * 19828 * <p><strong>Note:</strong> On API level 17 and lower, makeMeasureSpec's 19829 * implementation was such that the order of arguments did not matter 19830 * and overflow in either value could impact the resulting MeasureSpec. 19831 * {@link android.widget.RelativeLayout} was affected by this bug. 19832 * Apps targeting API levels greater than 17 will get the fixed, more strict 19833 * behavior.</p> 19834 * 19835 * @param size the size of the measure specification 19836 * @param mode the mode of the measure specification 19837 * @return the measure specification based on size and mode 19838 */ 19839 public static int makeMeasureSpec(int size, int mode) { 19840 if (sUseBrokenMakeMeasureSpec) { 19841 return size + mode; 19842 } else { 19843 return (size & ~MODE_MASK) | (mode & MODE_MASK); 19844 } 19845 } 19846 19847 /** 19848 * Extracts the mode from the supplied measure specification. 19849 * 19850 * @param measureSpec the measure specification to extract the mode from 19851 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 19852 * {@link android.view.View.MeasureSpec#AT_MOST} or 19853 * {@link android.view.View.MeasureSpec#EXACTLY} 19854 */ 19855 public static int getMode(int measureSpec) { 19856 return (measureSpec & MODE_MASK); 19857 } 19858 19859 /** 19860 * Extracts the size from the supplied measure specification. 19861 * 19862 * @param measureSpec the measure specification to extract the size from 19863 * @return the size in pixels defined in the supplied measure specification 19864 */ 19865 public static int getSize(int measureSpec) { 19866 return (measureSpec & ~MODE_MASK); 19867 } 19868 19869 static int adjust(int measureSpec, int delta) { 19870 final int mode = getMode(measureSpec); 19871 if (mode == UNSPECIFIED) { 19872 // No need to adjust size for UNSPECIFIED mode. 19873 return makeMeasureSpec(0, UNSPECIFIED); 19874 } 19875 int size = getSize(measureSpec) + delta; 19876 if (size < 0) { 19877 Log.e(VIEW_LOG_TAG, "MeasureSpec.adjust: new size would be negative! (" + size + 19878 ") spec: " + toString(measureSpec) + " delta: " + delta); 19879 size = 0; 19880 } 19881 return makeMeasureSpec(size, mode); 19882 } 19883 19884 /** 19885 * Returns a String representation of the specified measure 19886 * specification. 19887 * 19888 * @param measureSpec the measure specification to convert to a String 19889 * @return a String with the following format: "MeasureSpec: MODE SIZE" 19890 */ 19891 public static String toString(int measureSpec) { 19892 int mode = getMode(measureSpec); 19893 int size = getSize(measureSpec); 19894 19895 StringBuilder sb = new StringBuilder("MeasureSpec: "); 19896 19897 if (mode == UNSPECIFIED) 19898 sb.append("UNSPECIFIED "); 19899 else if (mode == EXACTLY) 19900 sb.append("EXACTLY "); 19901 else if (mode == AT_MOST) 19902 sb.append("AT_MOST "); 19903 else 19904 sb.append(mode).append(" "); 19905 19906 sb.append(size); 19907 return sb.toString(); 19908 } 19909 } 19910 19911 private final class CheckForLongPress implements Runnable { 19912 private int mOriginalWindowAttachCount; 19913 19914 @Override 19915 public void run() { 19916 if (isPressed() && (mParent != null) 19917 && mOriginalWindowAttachCount == mWindowAttachCount) { 19918 if (performLongClick()) { 19919 mHasPerformedLongPress = true; 19920 } 19921 } 19922 } 19923 19924 public void rememberWindowAttachCount() { 19925 mOriginalWindowAttachCount = mWindowAttachCount; 19926 } 19927 } 19928 19929 private final class CheckForTap implements Runnable { 19930 public float x; 19931 public float y; 19932 19933 @Override 19934 public void run() { 19935 mPrivateFlags &= ~PFLAG_PREPRESSED; 19936 setPressed(true, x, y); 19937 checkForLongClick(ViewConfiguration.getTapTimeout()); 19938 } 19939 } 19940 19941 private final class PerformClick implements Runnable { 19942 @Override 19943 public void run() { 19944 performClick(); 19945 } 19946 } 19947 19948 /** @hide */ 19949 public void hackTurnOffWindowResizeAnim(boolean off) { 19950 mAttachInfo.mTurnOffWindowResizeAnim = off; 19951 } 19952 19953 /** 19954 * This method returns a ViewPropertyAnimator object, which can be used to animate 19955 * specific properties on this View. 19956 * 19957 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 19958 */ 19959 public ViewPropertyAnimator animate() { 19960 if (mAnimator == null) { 19961 mAnimator = new ViewPropertyAnimator(this); 19962 } 19963 return mAnimator; 19964 } 19965 19966 /** 19967 * Sets the name of the View to be used to identify Views in Transitions. 19968 * Names should be unique in the View hierarchy. 19969 * 19970 * @param transitionName The name of the View to uniquely identify it for Transitions. 19971 */ 19972 public final void setTransitionName(String transitionName) { 19973 mTransitionName = transitionName; 19974 } 19975 19976 /** 19977 * Returns the name of the View to be used to identify Views in Transitions. 19978 * Names should be unique in the View hierarchy. 19979 * 19980 * <p>This returns null if the View has not been given a name.</p> 19981 * 19982 * @return The name used of the View to be used to identify Views in Transitions or null 19983 * if no name has been given. 19984 */ 19985 @ViewDebug.ExportedProperty 19986 public String getTransitionName() { 19987 return mTransitionName; 19988 } 19989 19990 /** 19991 * Interface definition for a callback to be invoked when a hardware key event is 19992 * dispatched to this view. The callback will be invoked before the key event is 19993 * given to the view. This is only useful for hardware keyboards; a software input 19994 * method has no obligation to trigger this listener. 19995 */ 19996 public interface OnKeyListener { 19997 /** 19998 * Called when a hardware key is dispatched to a view. This allows listeners to 19999 * get a chance to respond before the target view. 20000 * <p>Key presses in software keyboards will generally NOT trigger this method, 20001 * although some may elect to do so in some situations. Do not assume a 20002 * software input method has to be key-based; even if it is, it may use key presses 20003 * in a different way than you expect, so there is no way to reliably catch soft 20004 * input key presses. 20005 * 20006 * @param v The view the key has been dispatched to. 20007 * @param keyCode The code for the physical key that was pressed 20008 * @param event The KeyEvent object containing full information about 20009 * the event. 20010 * @return True if the listener has consumed the event, false otherwise. 20011 */ 20012 boolean onKey(View v, int keyCode, KeyEvent event); 20013 } 20014 20015 /** 20016 * Interface definition for a callback to be invoked when a touch event is 20017 * dispatched to this view. The callback will be invoked before the touch 20018 * event is given to the view. 20019 */ 20020 public interface OnTouchListener { 20021 /** 20022 * Called when a touch event is dispatched to a view. This allows listeners to 20023 * get a chance to respond before the target view. 20024 * 20025 * @param v The view the touch event has been dispatched to. 20026 * @param event The MotionEvent object containing full information about 20027 * the event. 20028 * @return True if the listener has consumed the event, false otherwise. 20029 */ 20030 boolean onTouch(View v, MotionEvent event); 20031 } 20032 20033 /** 20034 * Interface definition for a callback to be invoked when a hover event is 20035 * dispatched to this view. The callback will be invoked before the hover 20036 * event is given to the view. 20037 */ 20038 public interface OnHoverListener { 20039 /** 20040 * Called when a hover event is dispatched to a view. This allows listeners to 20041 * get a chance to respond before the target view. 20042 * 20043 * @param v The view the hover event has been dispatched to. 20044 * @param event The MotionEvent object containing full information about 20045 * the event. 20046 * @return True if the listener has consumed the event, false otherwise. 20047 */ 20048 boolean onHover(View v, MotionEvent event); 20049 } 20050 20051 /** 20052 * Interface definition for a callback to be invoked when a generic motion event is 20053 * dispatched to this view. The callback will be invoked before the generic motion 20054 * event is given to the view. 20055 */ 20056 public interface OnGenericMotionListener { 20057 /** 20058 * Called when a generic motion event is dispatched to a view. This allows listeners to 20059 * get a chance to respond before the target view. 20060 * 20061 * @param v The view the generic motion event has been dispatched to. 20062 * @param event The MotionEvent object containing full information about 20063 * the event. 20064 * @return True if the listener has consumed the event, false otherwise. 20065 */ 20066 boolean onGenericMotion(View v, MotionEvent event); 20067 } 20068 20069 /** 20070 * Interface definition for a callback to be invoked when a view has been clicked and held. 20071 */ 20072 public interface OnLongClickListener { 20073 /** 20074 * Called when a view has been clicked and held. 20075 * 20076 * @param v The view that was clicked and held. 20077 * 20078 * @return true if the callback consumed the long click, false otherwise. 20079 */ 20080 boolean onLongClick(View v); 20081 } 20082 20083 /** 20084 * Interface definition for a callback to be invoked when a drag is being dispatched 20085 * to this view. The callback will be invoked before the hosting view's own 20086 * onDrag(event) method. If the listener wants to fall back to the hosting view's 20087 * onDrag(event) behavior, it should return 'false' from this callback. 20088 * 20089 * <div class="special reference"> 20090 * <h3>Developer Guides</h3> 20091 * <p>For a guide to implementing drag and drop features, read the 20092 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 20093 * </div> 20094 */ 20095 public interface OnDragListener { 20096 /** 20097 * Called when a drag event is dispatched to a view. This allows listeners 20098 * to get a chance to override base View behavior. 20099 * 20100 * @param v The View that received the drag event. 20101 * @param event The {@link android.view.DragEvent} object for the drag event. 20102 * @return {@code true} if the drag event was handled successfully, or {@code false} 20103 * if the drag event was not handled. Note that {@code false} will trigger the View 20104 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 20105 */ 20106 boolean onDrag(View v, DragEvent event); 20107 } 20108 20109 /** 20110 * Interface definition for a callback to be invoked when the focus state of 20111 * a view changed. 20112 */ 20113 public interface OnFocusChangeListener { 20114 /** 20115 * Called when the focus state of a view has changed. 20116 * 20117 * @param v The view whose state has changed. 20118 * @param hasFocus The new focus state of v. 20119 */ 20120 void onFocusChange(View v, boolean hasFocus); 20121 } 20122 20123 /** 20124 * Interface definition for a callback to be invoked when a view is clicked. 20125 */ 20126 public interface OnClickListener { 20127 /** 20128 * Called when a view has been clicked. 20129 * 20130 * @param v The view that was clicked. 20131 */ 20132 void onClick(View v); 20133 } 20134 20135 /** 20136 * Interface definition for a callback to be invoked when the context menu 20137 * for this view is being built. 20138 */ 20139 public interface OnCreateContextMenuListener { 20140 /** 20141 * Called when the context menu for this view is being built. It is not 20142 * safe to hold onto the menu after this method returns. 20143 * 20144 * @param menu The context menu that is being built 20145 * @param v The view for which the context menu is being built 20146 * @param menuInfo Extra information about the item for which the 20147 * context menu should be shown. This information will vary 20148 * depending on the class of v. 20149 */ 20150 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 20151 } 20152 20153 /** 20154 * Interface definition for a callback to be invoked when the status bar changes 20155 * visibility. This reports <strong>global</strong> changes to the system UI 20156 * state, not what the application is requesting. 20157 * 20158 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 20159 */ 20160 public interface OnSystemUiVisibilityChangeListener { 20161 /** 20162 * Called when the status bar changes visibility because of a call to 20163 * {@link View#setSystemUiVisibility(int)}. 20164 * 20165 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 20166 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}. 20167 * This tells you the <strong>global</strong> state of these UI visibility 20168 * flags, not what your app is currently applying. 20169 */ 20170 public void onSystemUiVisibilityChange(int visibility); 20171 } 20172 20173 /** 20174 * Interface definition for a callback to be invoked when this view is attached 20175 * or detached from its window. 20176 */ 20177 public interface OnAttachStateChangeListener { 20178 /** 20179 * Called when the view is attached to a window. 20180 * @param v The view that was attached 20181 */ 20182 public void onViewAttachedToWindow(View v); 20183 /** 20184 * Called when the view is detached from a window. 20185 * @param v The view that was detached 20186 */ 20187 public void onViewDetachedFromWindow(View v); 20188 } 20189 20190 /** 20191 * Listener for applying window insets on a view in a custom way. 20192 * 20193 * <p>Apps may choose to implement this interface if they want to apply custom policy 20194 * to the way that window insets are treated for a view. If an OnApplyWindowInsetsListener 20195 * is set, its 20196 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 20197 * method will be called instead of the View's own 20198 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. The listener 20199 * may optionally call the parameter View's <code>onApplyWindowInsets</code> method to apply 20200 * the View's normal behavior as part of its own.</p> 20201 */ 20202 public interface OnApplyWindowInsetsListener { 20203 /** 20204 * When {@link View#setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) set} 20205 * on a View, this listener method will be called instead of the view's own 20206 * {@link View#onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 20207 * 20208 * @param v The view applying window insets 20209 * @param insets The insets to apply 20210 * @return The insets supplied, minus any insets that were consumed 20211 */ 20212 public WindowInsets onApplyWindowInsets(View v, WindowInsets insets); 20213 } 20214 20215 private final class UnsetPressedState implements Runnable { 20216 @Override 20217 public void run() { 20218 setPressed(false); 20219 } 20220 } 20221 20222 /** 20223 * Base class for derived classes that want to save and restore their own 20224 * state in {@link android.view.View#onSaveInstanceState()}. 20225 */ 20226 public static class BaseSavedState extends AbsSavedState { 20227 /** 20228 * Constructor used when reading from a parcel. Reads the state of the superclass. 20229 * 20230 * @param source 20231 */ 20232 public BaseSavedState(Parcel source) { 20233 super(source); 20234 } 20235 20236 /** 20237 * Constructor called by derived classes when creating their SavedState objects 20238 * 20239 * @param superState The state of the superclass of this view 20240 */ 20241 public BaseSavedState(Parcelable superState) { 20242 super(superState); 20243 } 20244 20245 public static final Parcelable.Creator<BaseSavedState> CREATOR = 20246 new Parcelable.Creator<BaseSavedState>() { 20247 public BaseSavedState createFromParcel(Parcel in) { 20248 return new BaseSavedState(in); 20249 } 20250 20251 public BaseSavedState[] newArray(int size) { 20252 return new BaseSavedState[size]; 20253 } 20254 }; 20255 } 20256 20257 /** 20258 * A set of information given to a view when it is attached to its parent 20259 * window. 20260 */ 20261 final static class AttachInfo { 20262 interface Callbacks { 20263 void playSoundEffect(int effectId); 20264 boolean performHapticFeedback(int effectId, boolean always); 20265 } 20266 20267 /** 20268 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 20269 * to a Handler. This class contains the target (View) to invalidate and 20270 * the coordinates of the dirty rectangle. 20271 * 20272 * For performance purposes, this class also implements a pool of up to 20273 * POOL_LIMIT objects that get reused. This reduces memory allocations 20274 * whenever possible. 20275 */ 20276 static class InvalidateInfo { 20277 private static final int POOL_LIMIT = 10; 20278 20279 private static final SynchronizedPool<InvalidateInfo> sPool = 20280 new SynchronizedPool<InvalidateInfo>(POOL_LIMIT); 20281 20282 View target; 20283 20284 int left; 20285 int top; 20286 int right; 20287 int bottom; 20288 20289 public static InvalidateInfo obtain() { 20290 InvalidateInfo instance = sPool.acquire(); 20291 return (instance != null) ? instance : new InvalidateInfo(); 20292 } 20293 20294 public void recycle() { 20295 target = null; 20296 sPool.release(this); 20297 } 20298 } 20299 20300 final IWindowSession mSession; 20301 20302 final IWindow mWindow; 20303 20304 final IBinder mWindowToken; 20305 20306 final Display mDisplay; 20307 20308 final Callbacks mRootCallbacks; 20309 20310 IWindowId mIWindowId; 20311 WindowId mWindowId; 20312 20313 /** 20314 * The top view of the hierarchy. 20315 */ 20316 View mRootView; 20317 20318 IBinder mPanelParentWindowToken; 20319 20320 boolean mHardwareAccelerated; 20321 boolean mHardwareAccelerationRequested; 20322 HardwareRenderer mHardwareRenderer; 20323 List<RenderNode> mPendingAnimatingRenderNodes; 20324 20325 /** 20326 * The state of the display to which the window is attached, as reported 20327 * by {@link Display#getState()}. Note that the display state constants 20328 * declared by {@link Display} do not exactly line up with the screen state 20329 * constants declared by {@link View} (there are more display states than 20330 * screen states). 20331 */ 20332 int mDisplayState = Display.STATE_UNKNOWN; 20333 20334 /** 20335 * Scale factor used by the compatibility mode 20336 */ 20337 float mApplicationScale; 20338 20339 /** 20340 * Indicates whether the application is in compatibility mode 20341 */ 20342 boolean mScalingRequired; 20343 20344 /** 20345 * If set, ViewRootImpl doesn't use its lame animation for when the window resizes. 20346 */ 20347 boolean mTurnOffWindowResizeAnim; 20348 20349 /** 20350 * Left position of this view's window 20351 */ 20352 int mWindowLeft; 20353 20354 /** 20355 * Top position of this view's window 20356 */ 20357 int mWindowTop; 20358 20359 /** 20360 * Indicates whether views need to use 32-bit drawing caches 20361 */ 20362 boolean mUse32BitDrawingCache; 20363 20364 /** 20365 * For windows that are full-screen but using insets to layout inside 20366 * of the screen areas, these are the current insets to appear inside 20367 * the overscan area of the display. 20368 */ 20369 final Rect mOverscanInsets = new Rect(); 20370 20371 /** 20372 * For windows that are full-screen but using insets to layout inside 20373 * of the screen decorations, these are the current insets for the 20374 * content of the window. 20375 */ 20376 final Rect mContentInsets = new Rect(); 20377 20378 /** 20379 * For windows that are full-screen but using insets to layout inside 20380 * of the screen decorations, these are the current insets for the 20381 * actual visible parts of the window. 20382 */ 20383 final Rect mVisibleInsets = new Rect(); 20384 20385 /** 20386 * For windows that are full-screen but using insets to layout inside 20387 * of the screen decorations, these are the current insets for the 20388 * stable system windows. 20389 */ 20390 final Rect mStableInsets = new Rect(); 20391 20392 /** 20393 * The internal insets given by this window. This value is 20394 * supplied by the client (through 20395 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 20396 * be given to the window manager when changed to be used in laying 20397 * out windows behind it. 20398 */ 20399 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 20400 = new ViewTreeObserver.InternalInsetsInfo(); 20401 20402 /** 20403 * Set to true when mGivenInternalInsets is non-empty. 20404 */ 20405 boolean mHasNonEmptyGivenInternalInsets; 20406 20407 /** 20408 * All views in the window's hierarchy that serve as scroll containers, 20409 * used to determine if the window can be resized or must be panned 20410 * to adjust for a soft input area. 20411 */ 20412 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 20413 20414 final KeyEvent.DispatcherState mKeyDispatchState 20415 = new KeyEvent.DispatcherState(); 20416 20417 /** 20418 * Indicates whether the view's window currently has the focus. 20419 */ 20420 boolean mHasWindowFocus; 20421 20422 /** 20423 * The current visibility of the window. 20424 */ 20425 int mWindowVisibility; 20426 20427 /** 20428 * Indicates the time at which drawing started to occur. 20429 */ 20430 long mDrawingTime; 20431 20432 /** 20433 * Indicates whether or not ignoring the DIRTY_MASK flags. 20434 */ 20435 boolean mIgnoreDirtyState; 20436 20437 /** 20438 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 20439 * to avoid clearing that flag prematurely. 20440 */ 20441 boolean mSetIgnoreDirtyState = false; 20442 20443 /** 20444 * Indicates whether the view's window is currently in touch mode. 20445 */ 20446 boolean mInTouchMode; 20447 20448 /** 20449 * Indicates whether the view has requested unbuffered input dispatching for the current 20450 * event stream. 20451 */ 20452 boolean mUnbufferedDispatchRequested; 20453 20454 /** 20455 * Indicates that ViewAncestor should trigger a global layout change 20456 * the next time it performs a traversal 20457 */ 20458 boolean mRecomputeGlobalAttributes; 20459 20460 /** 20461 * Always report new attributes at next traversal. 20462 */ 20463 boolean mForceReportNewAttributes; 20464 20465 /** 20466 * Set during a traveral if any views want to keep the screen on. 20467 */ 20468 boolean mKeepScreenOn; 20469 20470 /** 20471 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 20472 */ 20473 int mSystemUiVisibility; 20474 20475 /** 20476 * Hack to force certain system UI visibility flags to be cleared. 20477 */ 20478 int mDisabledSystemUiVisibility; 20479 20480 /** 20481 * Last global system UI visibility reported by the window manager. 20482 */ 20483 int mGlobalSystemUiVisibility; 20484 20485 /** 20486 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 20487 * attached. 20488 */ 20489 boolean mHasSystemUiListeners; 20490 20491 /** 20492 * Set if the window has requested to extend into the overscan region 20493 * via WindowManager.LayoutParams.FLAG_LAYOUT_IN_OVERSCAN. 20494 */ 20495 boolean mOverscanRequested; 20496 20497 /** 20498 * Set if the visibility of any views has changed. 20499 */ 20500 boolean mViewVisibilityChanged; 20501 20502 /** 20503 * Set to true if a view has been scrolled. 20504 */ 20505 boolean mViewScrollChanged; 20506 20507 /** 20508 * Set to true if high contrast mode enabled 20509 */ 20510 boolean mHighContrastText; 20511 20512 /** 20513 * Global to the view hierarchy used as a temporary for dealing with 20514 * x/y points in the transparent region computations. 20515 */ 20516 final int[] mTransparentLocation = new int[2]; 20517 20518 /** 20519 * Global to the view hierarchy used as a temporary for dealing with 20520 * x/y points in the ViewGroup.invalidateChild implementation. 20521 */ 20522 final int[] mInvalidateChildLocation = new int[2]; 20523 20524 /** 20525 * Global to the view hierarchy used as a temporary for dealng with 20526 * computing absolute on-screen location. 20527 */ 20528 final int[] mTmpLocation = new int[2]; 20529 20530 /** 20531 * Global to the view hierarchy used as a temporary for dealing with 20532 * x/y location when view is transformed. 20533 */ 20534 final float[] mTmpTransformLocation = new float[2]; 20535 20536 /** 20537 * The view tree observer used to dispatch global events like 20538 * layout, pre-draw, touch mode change, etc. 20539 */ 20540 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 20541 20542 /** 20543 * A Canvas used by the view hierarchy to perform bitmap caching. 20544 */ 20545 Canvas mCanvas; 20546 20547 /** 20548 * The view root impl. 20549 */ 20550 final ViewRootImpl mViewRootImpl; 20551 20552 /** 20553 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 20554 * handler can be used to pump events in the UI events queue. 20555 */ 20556 final Handler mHandler; 20557 20558 /** 20559 * Temporary for use in computing invalidate rectangles while 20560 * calling up the hierarchy. 20561 */ 20562 final Rect mTmpInvalRect = new Rect(); 20563 20564 /** 20565 * Temporary for use in computing hit areas with transformed views 20566 */ 20567 final RectF mTmpTransformRect = new RectF(); 20568 20569 /** 20570 * Temporary for use in computing hit areas with transformed views 20571 */ 20572 final RectF mTmpTransformRect1 = new RectF(); 20573 20574 /** 20575 * Temporary list of rectanges. 20576 */ 20577 final List<RectF> mTmpRectList = new ArrayList<>(); 20578 20579 /** 20580 * Temporary for use in transforming invalidation rect 20581 */ 20582 final Matrix mTmpMatrix = new Matrix(); 20583 20584 /** 20585 * Temporary for use in transforming invalidation rect 20586 */ 20587 final Transformation mTmpTransformation = new Transformation(); 20588 20589 /** 20590 * Temporary for use in querying outlines from OutlineProviders 20591 */ 20592 final Outline mTmpOutline = new Outline(); 20593 20594 /** 20595 * Temporary list for use in collecting focusable descendents of a view. 20596 */ 20597 final ArrayList<View> mTempArrayList = new ArrayList<View>(24); 20598 20599 /** 20600 * The id of the window for accessibility purposes. 20601 */ 20602 int mAccessibilityWindowId = AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 20603 20604 /** 20605 * Flags related to accessibility processing. 20606 * 20607 * @see AccessibilityNodeInfo#FLAG_INCLUDE_NOT_IMPORTANT_VIEWS 20608 * @see AccessibilityNodeInfo#FLAG_REPORT_VIEW_IDS 20609 */ 20610 int mAccessibilityFetchFlags; 20611 20612 /** 20613 * The drawable for highlighting accessibility focus. 20614 */ 20615 Drawable mAccessibilityFocusDrawable; 20616 20617 /** 20618 * Show where the margins, bounds and layout bounds are for each view. 20619 */ 20620 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false); 20621 20622 /** 20623 * Point used to compute visible regions. 20624 */ 20625 final Point mPoint = new Point(); 20626 20627 /** 20628 * Used to track which View originated a requestLayout() call, used when 20629 * requestLayout() is called during layout. 20630 */ 20631 View mViewRequestingLayout; 20632 20633 /** 20634 * Creates a new set of attachment information with the specified 20635 * events handler and thread. 20636 * 20637 * @param handler the events handler the view must use 20638 */ 20639 AttachInfo(IWindowSession session, IWindow window, Display display, 20640 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) { 20641 mSession = session; 20642 mWindow = window; 20643 mWindowToken = window.asBinder(); 20644 mDisplay = display; 20645 mViewRootImpl = viewRootImpl; 20646 mHandler = handler; 20647 mRootCallbacks = effectPlayer; 20648 } 20649 } 20650 20651 /** 20652 * <p>ScrollabilityCache holds various fields used by a View when scrolling 20653 * is supported. This avoids keeping too many unused fields in most 20654 * instances of View.</p> 20655 */ 20656 private static class ScrollabilityCache implements Runnable { 20657 20658 /** 20659 * Scrollbars are not visible 20660 */ 20661 public static final int OFF = 0; 20662 20663 /** 20664 * Scrollbars are visible 20665 */ 20666 public static final int ON = 1; 20667 20668 /** 20669 * Scrollbars are fading away 20670 */ 20671 public static final int FADING = 2; 20672 20673 public boolean fadeScrollBars; 20674 20675 public int fadingEdgeLength; 20676 public int scrollBarDefaultDelayBeforeFade; 20677 public int scrollBarFadeDuration; 20678 20679 public int scrollBarSize; 20680 public ScrollBarDrawable scrollBar; 20681 public float[] interpolatorValues; 20682 public View host; 20683 20684 public final Paint paint; 20685 public final Matrix matrix; 20686 public Shader shader; 20687 20688 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 20689 20690 private static final float[] OPAQUE = { 255 }; 20691 private static final float[] TRANSPARENT = { 0.0f }; 20692 20693 /** 20694 * When fading should start. This time moves into the future every time 20695 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 20696 */ 20697 public long fadeStartTime; 20698 20699 20700 /** 20701 * The current state of the scrollbars: ON, OFF, or FADING 20702 */ 20703 public int state = OFF; 20704 20705 private int mLastColor; 20706 20707 public ScrollabilityCache(ViewConfiguration configuration, View host) { 20708 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 20709 scrollBarSize = configuration.getScaledScrollBarSize(); 20710 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 20711 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 20712 20713 paint = new Paint(); 20714 matrix = new Matrix(); 20715 // use use a height of 1, and then wack the matrix each time we 20716 // actually use it. 20717 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20718 paint.setShader(shader); 20719 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20720 20721 this.host = host; 20722 } 20723 20724 public void setFadeColor(int color) { 20725 if (color != mLastColor) { 20726 mLastColor = color; 20727 20728 if (color != 0) { 20729 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 20730 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 20731 paint.setShader(shader); 20732 // Restore the default transfer mode (src_over) 20733 paint.setXfermode(null); 20734 } else { 20735 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20736 paint.setShader(shader); 20737 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20738 } 20739 } 20740 } 20741 20742 public void run() { 20743 long now = AnimationUtils.currentAnimationTimeMillis(); 20744 if (now >= fadeStartTime) { 20745 20746 // the animation fades the scrollbars out by changing 20747 // the opacity (alpha) from fully opaque to fully 20748 // transparent 20749 int nextFrame = (int) now; 20750 int framesCount = 0; 20751 20752 Interpolator interpolator = scrollBarInterpolator; 20753 20754 // Start opaque 20755 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 20756 20757 // End transparent 20758 nextFrame += scrollBarFadeDuration; 20759 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 20760 20761 state = FADING; 20762 20763 // Kick off the fade animation 20764 host.invalidate(true); 20765 } 20766 } 20767 } 20768 20769 /** 20770 * Resuable callback for sending 20771 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 20772 */ 20773 private class SendViewScrolledAccessibilityEvent implements Runnable { 20774 public volatile boolean mIsPending; 20775 20776 public void run() { 20777 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 20778 mIsPending = false; 20779 } 20780 } 20781 20782 /** 20783 * <p> 20784 * This class represents a delegate that can be registered in a {@link View} 20785 * to enhance accessibility support via composition rather via inheritance. 20786 * It is specifically targeted to widget developers that extend basic View 20787 * classes i.e. classes in package android.view, that would like their 20788 * applications to be backwards compatible. 20789 * </p> 20790 * <div class="special reference"> 20791 * <h3>Developer Guides</h3> 20792 * <p>For more information about making applications accessible, read the 20793 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a> 20794 * developer guide.</p> 20795 * </div> 20796 * <p> 20797 * A scenario in which a developer would like to use an accessibility delegate 20798 * is overriding a method introduced in a later API version then the minimal API 20799 * version supported by the application. For example, the method 20800 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 20801 * in API version 4 when the accessibility APIs were first introduced. If a 20802 * developer would like his application to run on API version 4 devices (assuming 20803 * all other APIs used by the application are version 4 or lower) and take advantage 20804 * of this method, instead of overriding the method which would break the application's 20805 * backwards compatibility, he can override the corresponding method in this 20806 * delegate and register the delegate in the target View if the API version of 20807 * the system is high enough i.e. the API version is same or higher to the API 20808 * version that introduced 20809 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 20810 * </p> 20811 * <p> 20812 * Here is an example implementation: 20813 * </p> 20814 * <code><pre><p> 20815 * if (Build.VERSION.SDK_INT >= 14) { 20816 * // If the API version is equal of higher than the version in 20817 * // which onInitializeAccessibilityNodeInfo was introduced we 20818 * // register a delegate with a customized implementation. 20819 * View view = findViewById(R.id.view_id); 20820 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 20821 * public void onInitializeAccessibilityNodeInfo(View host, 20822 * AccessibilityNodeInfo info) { 20823 * // Let the default implementation populate the info. 20824 * super.onInitializeAccessibilityNodeInfo(host, info); 20825 * // Set some other information. 20826 * info.setEnabled(host.isEnabled()); 20827 * } 20828 * }); 20829 * } 20830 * </code></pre></p> 20831 * <p> 20832 * This delegate contains methods that correspond to the accessibility methods 20833 * in View. If a delegate has been specified the implementation in View hands 20834 * off handling to the corresponding method in this delegate. The default 20835 * implementation the delegate methods behaves exactly as the corresponding 20836 * method in View for the case of no accessibility delegate been set. Hence, 20837 * to customize the behavior of a View method, clients can override only the 20838 * corresponding delegate method without altering the behavior of the rest 20839 * accessibility related methods of the host view. 20840 * </p> 20841 */ 20842 public static class AccessibilityDelegate { 20843 20844 /** 20845 * Sends an accessibility event of the given type. If accessibility is not 20846 * enabled this method has no effect. 20847 * <p> 20848 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 20849 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 20850 * been set. 20851 * </p> 20852 * 20853 * @param host The View hosting the delegate. 20854 * @param eventType The type of the event to send. 20855 * 20856 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 20857 */ 20858 public void sendAccessibilityEvent(View host, int eventType) { 20859 host.sendAccessibilityEventInternal(eventType); 20860 } 20861 20862 /** 20863 * Performs the specified accessibility action on the view. For 20864 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 20865 * <p> 20866 * The default implementation behaves as 20867 * {@link View#performAccessibilityAction(int, Bundle) 20868 * View#performAccessibilityAction(int, Bundle)} for the case of 20869 * no accessibility delegate been set. 20870 * </p> 20871 * 20872 * @param action The action to perform. 20873 * @return Whether the action was performed. 20874 * 20875 * @see View#performAccessibilityAction(int, Bundle) 20876 * View#performAccessibilityAction(int, Bundle) 20877 */ 20878 public boolean performAccessibilityAction(View host, int action, Bundle args) { 20879 return host.performAccessibilityActionInternal(action, args); 20880 } 20881 20882 /** 20883 * Sends an accessibility event. This method behaves exactly as 20884 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 20885 * empty {@link AccessibilityEvent} and does not perform a check whether 20886 * accessibility is enabled. 20887 * <p> 20888 * The default implementation behaves as 20889 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20890 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 20891 * the case of no accessibility delegate been set. 20892 * </p> 20893 * 20894 * @param host The View hosting the delegate. 20895 * @param event The event to send. 20896 * 20897 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20898 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20899 */ 20900 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 20901 host.sendAccessibilityEventUncheckedInternal(event); 20902 } 20903 20904 /** 20905 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 20906 * to its children for adding their text content to the event. 20907 * <p> 20908 * The default implementation behaves as 20909 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20910 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 20911 * the case of no accessibility delegate been set. 20912 * </p> 20913 * 20914 * @param host The View hosting the delegate. 20915 * @param event The event. 20916 * @return True if the event population was completed. 20917 * 20918 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20919 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20920 */ 20921 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20922 return host.dispatchPopulateAccessibilityEventInternal(event); 20923 } 20924 20925 /** 20926 * Gives a chance to the host View to populate the accessibility event with its 20927 * text content. 20928 * <p> 20929 * The default implementation behaves as 20930 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 20931 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 20932 * the case of no accessibility delegate been set. 20933 * </p> 20934 * 20935 * @param host The View hosting the delegate. 20936 * @param event The accessibility event which to populate. 20937 * 20938 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 20939 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 20940 */ 20941 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20942 host.onPopulateAccessibilityEventInternal(event); 20943 } 20944 20945 /** 20946 * Initializes an {@link AccessibilityEvent} with information about the 20947 * the host View which is the event source. 20948 * <p> 20949 * The default implementation behaves as 20950 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 20951 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 20952 * the case of no accessibility delegate been set. 20953 * </p> 20954 * 20955 * @param host The View hosting the delegate. 20956 * @param event The event to initialize. 20957 * 20958 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 20959 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 20960 */ 20961 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 20962 host.onInitializeAccessibilityEventInternal(event); 20963 } 20964 20965 /** 20966 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 20967 * <p> 20968 * The default implementation behaves as 20969 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20970 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 20971 * the case of no accessibility delegate been set. 20972 * </p> 20973 * 20974 * @param host The View hosting the delegate. 20975 * @param info The instance to initialize. 20976 * 20977 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20978 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20979 */ 20980 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 20981 host.onInitializeAccessibilityNodeInfoInternal(info); 20982 } 20983 20984 /** 20985 * Called when a child of the host View has requested sending an 20986 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 20987 * to augment the event. 20988 * <p> 20989 * The default implementation behaves as 20990 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20991 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 20992 * the case of no accessibility delegate been set. 20993 * </p> 20994 * 20995 * @param host The View hosting the delegate. 20996 * @param child The child which requests sending the event. 20997 * @param event The event to be sent. 20998 * @return True if the event should be sent 20999 * 21000 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 21001 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 21002 */ 21003 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 21004 AccessibilityEvent event) { 21005 return host.onRequestSendAccessibilityEventInternal(child, event); 21006 } 21007 21008 /** 21009 * Gets the provider for managing a virtual view hierarchy rooted at this View 21010 * and reported to {@link android.accessibilityservice.AccessibilityService}s 21011 * that explore the window content. 21012 * <p> 21013 * The default implementation behaves as 21014 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 21015 * the case of no accessibility delegate been set. 21016 * </p> 21017 * 21018 * @return The provider. 21019 * 21020 * @see AccessibilityNodeProvider 21021 */ 21022 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 21023 return null; 21024 } 21025 21026 /** 21027 * Returns an {@link AccessibilityNodeInfo} representing the host view from the 21028 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 21029 * This method is responsible for obtaining an accessibility node info from a 21030 * pool of reusable instances and calling 21031 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on the host 21032 * view to initialize the former. 21033 * <p> 21034 * <strong>Note:</strong> The client is responsible for recycling the obtained 21035 * instance by calling {@link AccessibilityNodeInfo#recycle()} to minimize object 21036 * creation. 21037 * </p> 21038 * <p> 21039 * The default implementation behaves as 21040 * {@link View#createAccessibilityNodeInfo() View#createAccessibilityNodeInfo()} for 21041 * the case of no accessibility delegate been set. 21042 * </p> 21043 * @return A populated {@link AccessibilityNodeInfo}. 21044 * 21045 * @see AccessibilityNodeInfo 21046 * 21047 * @hide 21048 */ 21049 public AccessibilityNodeInfo createAccessibilityNodeInfo(View host) { 21050 return host.createAccessibilityNodeInfoInternal(); 21051 } 21052 } 21053 21054 private class MatchIdPredicate implements Predicate<View> { 21055 public int mId; 21056 21057 @Override 21058 public boolean apply(View view) { 21059 return (view.mID == mId); 21060 } 21061 } 21062 21063 private class MatchLabelForPredicate implements Predicate<View> { 21064 private int mLabeledId; 21065 21066 @Override 21067 public boolean apply(View view) { 21068 return (view.mLabelForId == mLabeledId); 21069 } 21070 } 21071 21072 private class SendViewStateChangedAccessibilityEvent implements Runnable { 21073 private int mChangeTypes = 0; 21074 private boolean mPosted; 21075 private boolean mPostedWithDelay; 21076 private long mLastEventTimeMillis; 21077 21078 @Override 21079 public void run() { 21080 mPosted = false; 21081 mPostedWithDelay = false; 21082 mLastEventTimeMillis = SystemClock.uptimeMillis(); 21083 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 21084 final AccessibilityEvent event = AccessibilityEvent.obtain(); 21085 event.setEventType(AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED); 21086 event.setContentChangeTypes(mChangeTypes); 21087 sendAccessibilityEventUnchecked(event); 21088 } 21089 mChangeTypes = 0; 21090 } 21091 21092 public void runOrPost(int changeType) { 21093 mChangeTypes |= changeType; 21094 21095 // If this is a live region or the child of a live region, collect 21096 // all events from this frame and send them on the next frame. 21097 if (inLiveRegion()) { 21098 // If we're already posted with a delay, remove that. 21099 if (mPostedWithDelay) { 21100 removeCallbacks(this); 21101 mPostedWithDelay = false; 21102 } 21103 // Only post if we're not already posted. 21104 if (!mPosted) { 21105 post(this); 21106 mPosted = true; 21107 } 21108 return; 21109 } 21110 21111 if (mPosted) { 21112 return; 21113 } 21114 21115 final long timeSinceLastMillis = SystemClock.uptimeMillis() - mLastEventTimeMillis; 21116 final long minEventIntevalMillis = 21117 ViewConfiguration.getSendRecurringAccessibilityEventsInterval(); 21118 if (timeSinceLastMillis >= minEventIntevalMillis) { 21119 removeCallbacks(this); 21120 run(); 21121 } else { 21122 postDelayed(this, minEventIntevalMillis - timeSinceLastMillis); 21123 mPostedWithDelay = true; 21124 } 21125 } 21126 } 21127 21128 private boolean inLiveRegion() { 21129 if (getAccessibilityLiveRegion() != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21130 return true; 21131 } 21132 21133 ViewParent parent = getParent(); 21134 while (parent instanceof View) { 21135 if (((View) parent).getAccessibilityLiveRegion() 21136 != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21137 return true; 21138 } 21139 parent = parent.getParent(); 21140 } 21141 21142 return false; 21143 } 21144 21145 /** 21146 * Dump all private flags in readable format, useful for documentation and 21147 * sanity checking. 21148 */ 21149 private static void dumpFlags() { 21150 final HashMap<String, String> found = Maps.newHashMap(); 21151 try { 21152 for (Field field : View.class.getDeclaredFields()) { 21153 final int modifiers = field.getModifiers(); 21154 if (Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers)) { 21155 if (field.getType().equals(int.class)) { 21156 final int value = field.getInt(null); 21157 dumpFlag(found, field.getName(), value); 21158 } else if (field.getType().equals(int[].class)) { 21159 final int[] values = (int[]) field.get(null); 21160 for (int i = 0; i < values.length; i++) { 21161 dumpFlag(found, field.getName() + "[" + i + "]", values[i]); 21162 } 21163 } 21164 } 21165 } 21166 } catch (IllegalAccessException e) { 21167 throw new RuntimeException(e); 21168 } 21169 21170 final ArrayList<String> keys = Lists.newArrayList(); 21171 keys.addAll(found.keySet()); 21172 Collections.sort(keys); 21173 for (String key : keys) { 21174 Log.d(VIEW_LOG_TAG, found.get(key)); 21175 } 21176 } 21177 21178 private static void dumpFlag(HashMap<String, String> found, String name, int value) { 21179 // Sort flags by prefix, then by bits, always keeping unique keys 21180 final String bits = String.format("%32s", Integer.toBinaryString(value)).replace('0', ' '); 21181 final int prefix = name.indexOf('_'); 21182 final String key = (prefix > 0 ? name.substring(0, prefix) : name) + bits + name; 21183 final String output = bits + " " + name; 21184 found.put(key, output); 21185 } 21186} 21187