View.java revision f8512ce08174426dfbba96e8108e5a64332f1e71
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 coordinates. 5557 * 5558 * @param outRect The output location 5559 * @hide 5560 */ 5561 public void getBoundsOnScreen(Rect outRect) { 5562 getBoundsOnScreen(outRect, false); 5563 } 5564 5565 /** 5566 * Gets the location of this view in screen coordinates. 5567 * 5568 * @param outRect The output location 5569 * @param clipToParent Whether to clip child bounds to the parent ones. 5570 * @hide 5571 */ 5572 public void getBoundsOnScreen(Rect outRect, boolean clipToParent) { 5573 if (mAttachInfo == null) { 5574 return; 5575 } 5576 5577 RectF position = mAttachInfo.mTmpTransformRect; 5578 position.set(0, 0, mRight - mLeft, mBottom - mTop); 5579 5580 if (!hasIdentityMatrix()) { 5581 getMatrix().mapRect(position); 5582 } 5583 5584 position.offset(mLeft, mTop); 5585 5586 ViewParent parent = mParent; 5587 while (parent instanceof View) { 5588 View parentView = (View) parent; 5589 5590 position.offset(-parentView.mScrollX, -parentView.mScrollY); 5591 5592 if (clipToParent) { 5593 position.left = Math.max(position.left, 0); 5594 position.top = Math.max(position.top, 0); 5595 position.right = Math.min(position.right, parentView.getWidth()); 5596 position.bottom = Math.min(position.bottom, parentView.getHeight()); 5597 } 5598 5599 if (!parentView.hasIdentityMatrix()) { 5600 parentView.getMatrix().mapRect(position); 5601 } 5602 5603 position.offset(parentView.mLeft, parentView.mTop); 5604 5605 parent = parentView.mParent; 5606 } 5607 5608 if (parent instanceof ViewRootImpl) { 5609 ViewRootImpl viewRootImpl = (ViewRootImpl) parent; 5610 position.offset(0, -viewRootImpl.mCurScrollY); 5611 } 5612 5613 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop); 5614 5615 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f), 5616 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f)); 5617 } 5618 5619 /** 5620 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 5621 * 5622 * Note: Called from the default {@link AccessibilityDelegate}. 5623 */ 5624 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) { 5625 Rect bounds = mAttachInfo.mTmpInvalRect; 5626 5627 getDrawingRect(bounds); 5628 info.setBoundsInParent(bounds); 5629 5630 getBoundsOnScreen(bounds, true); 5631 info.setBoundsInScreen(bounds); 5632 5633 ViewParent parent = getParentForAccessibility(); 5634 if (parent instanceof View) { 5635 info.setParent((View) parent); 5636 } 5637 5638 if (mID != View.NO_ID) { 5639 View rootView = getRootView(); 5640 if (rootView == null) { 5641 rootView = this; 5642 } 5643 5644 View label = rootView.findLabelForView(this, mID); 5645 if (label != null) { 5646 info.setLabeledBy(label); 5647 } 5648 5649 if ((mAttachInfo.mAccessibilityFetchFlags 5650 & AccessibilityNodeInfo.FLAG_REPORT_VIEW_IDS) != 0 5651 && Resources.resourceHasPackage(mID)) { 5652 try { 5653 String viewId = getResources().getResourceName(mID); 5654 info.setViewIdResourceName(viewId); 5655 } catch (Resources.NotFoundException nfe) { 5656 /* ignore */ 5657 } 5658 } 5659 } 5660 5661 if (mLabelForId != View.NO_ID) { 5662 View rootView = getRootView(); 5663 if (rootView == null) { 5664 rootView = this; 5665 } 5666 View labeled = rootView.findViewInsideOutShouldExist(this, mLabelForId); 5667 if (labeled != null) { 5668 info.setLabelFor(labeled); 5669 } 5670 } 5671 5672 if (mAccessibilityTraversalBeforeId != View.NO_ID) { 5673 View rootView = getRootView(); 5674 if (rootView == null) { 5675 rootView = this; 5676 } 5677 View next = rootView.findViewInsideOutShouldExist(this, 5678 mAccessibilityTraversalBeforeId); 5679 if (next != null) { 5680 info.setTraversalBefore(next); 5681 } 5682 } 5683 5684 if (mAccessibilityTraversalAfterId != View.NO_ID) { 5685 View rootView = getRootView(); 5686 if (rootView == null) { 5687 rootView = this; 5688 } 5689 View next = rootView.findViewInsideOutShouldExist(this, 5690 mAccessibilityTraversalAfterId); 5691 if (next != null) { 5692 info.setTraversalAfter(next); 5693 } 5694 } 5695 5696 info.setVisibleToUser(isVisibleToUser()); 5697 5698 info.setPackageName(mContext.getPackageName()); 5699 info.setClassName(View.class.getName()); 5700 info.setContentDescription(getContentDescription()); 5701 5702 info.setEnabled(isEnabled()); 5703 info.setClickable(isClickable()); 5704 info.setFocusable(isFocusable()); 5705 info.setFocused(isFocused()); 5706 info.setAccessibilityFocused(isAccessibilityFocused()); 5707 info.setSelected(isSelected()); 5708 info.setLongClickable(isLongClickable()); 5709 info.setLiveRegion(getAccessibilityLiveRegion()); 5710 5711 // TODO: These make sense only if we are in an AdapterView but all 5712 // views can be selected. Maybe from accessibility perspective 5713 // we should report as selectable view in an AdapterView. 5714 info.addAction(AccessibilityNodeInfo.ACTION_SELECT); 5715 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION); 5716 5717 if (isFocusable()) { 5718 if (isFocused()) { 5719 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS); 5720 } else { 5721 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS); 5722 } 5723 } 5724 5725 if (!isAccessibilityFocused()) { 5726 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS); 5727 } else { 5728 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS); 5729 } 5730 5731 if (isClickable() && isEnabled()) { 5732 info.addAction(AccessibilityNodeInfo.ACTION_CLICK); 5733 } 5734 5735 if (isLongClickable() && isEnabled()) { 5736 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK); 5737 } 5738 5739 CharSequence text = getIterableTextForAccessibility(); 5740 if (text != null && text.length() > 0) { 5741 info.setTextSelection(getAccessibilitySelectionStart(), getAccessibilitySelectionEnd()); 5742 5743 info.addAction(AccessibilityNodeInfo.ACTION_SET_SELECTION); 5744 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY); 5745 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY); 5746 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER 5747 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD 5748 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH); 5749 } 5750 } 5751 5752 private View findLabelForView(View view, int labeledId) { 5753 if (mMatchLabelForPredicate == null) { 5754 mMatchLabelForPredicate = new MatchLabelForPredicate(); 5755 } 5756 mMatchLabelForPredicate.mLabeledId = labeledId; 5757 return findViewByPredicateInsideOut(view, mMatchLabelForPredicate); 5758 } 5759 5760 /** 5761 * Computes whether this view is visible to the user. Such a view is 5762 * attached, visible, all its predecessors are visible, it is not clipped 5763 * entirely by its predecessors, and has an alpha greater than zero. 5764 * 5765 * @return Whether the view is visible on the screen. 5766 * 5767 * @hide 5768 */ 5769 protected boolean isVisibleToUser() { 5770 return isVisibleToUser(null); 5771 } 5772 5773 /** 5774 * Computes whether the given portion of this view is visible to the user. 5775 * Such a view is attached, visible, all its predecessors are visible, 5776 * has an alpha greater than zero, and the specified portion is not 5777 * clipped entirely by its predecessors. 5778 * 5779 * @param boundInView the portion of the view to test; coordinates should be relative; may be 5780 * <code>null</code>, and the entire view will be tested in this case. 5781 * When <code>true</code> is returned by the function, the actual visible 5782 * region will be stored in this parameter; that is, if boundInView is fully 5783 * contained within the view, no modification will be made, otherwise regions 5784 * outside of the visible area of the view will be clipped. 5785 * 5786 * @return Whether the specified portion of the view is visible on the screen. 5787 * 5788 * @hide 5789 */ 5790 protected boolean isVisibleToUser(Rect boundInView) { 5791 if (mAttachInfo != null) { 5792 // Attached to invisible window means this view is not visible. 5793 if (mAttachInfo.mWindowVisibility != View.VISIBLE) { 5794 return false; 5795 } 5796 // An invisible predecessor or one with alpha zero means 5797 // that this view is not visible to the user. 5798 Object current = this; 5799 while (current instanceof View) { 5800 View view = (View) current; 5801 // We have attach info so this view is attached and there is no 5802 // need to check whether we reach to ViewRootImpl on the way up. 5803 if (view.getAlpha() <= 0 || view.getTransitionAlpha() <= 0 || 5804 view.getVisibility() != VISIBLE) { 5805 return false; 5806 } 5807 current = view.mParent; 5808 } 5809 // Check if the view is entirely covered by its predecessors. 5810 Rect visibleRect = mAttachInfo.mTmpInvalRect; 5811 Point offset = mAttachInfo.mPoint; 5812 if (!getGlobalVisibleRect(visibleRect, offset)) { 5813 return false; 5814 } 5815 // Check if the visible portion intersects the rectangle of interest. 5816 if (boundInView != null) { 5817 visibleRect.offset(-offset.x, -offset.y); 5818 return boundInView.intersect(visibleRect); 5819 } 5820 return true; 5821 } 5822 return false; 5823 } 5824 5825 /** 5826 * Returns the delegate for implementing accessibility support via 5827 * composition. For more details see {@link AccessibilityDelegate}. 5828 * 5829 * @return The delegate, or null if none set. 5830 * 5831 * @hide 5832 */ 5833 public AccessibilityDelegate getAccessibilityDelegate() { 5834 return mAccessibilityDelegate; 5835 } 5836 5837 /** 5838 * Sets a delegate for implementing accessibility support via composition as 5839 * opposed to inheritance. The delegate's primary use is for implementing 5840 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 5841 * 5842 * @param delegate The delegate instance. 5843 * 5844 * @see AccessibilityDelegate 5845 */ 5846 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 5847 mAccessibilityDelegate = delegate; 5848 } 5849 5850 /** 5851 * Gets the provider for managing a virtual view hierarchy rooted at this View 5852 * and reported to {@link android.accessibilityservice.AccessibilityService}s 5853 * that explore the window content. 5854 * <p> 5855 * If this method returns an instance, this instance is responsible for managing 5856 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 5857 * View including the one representing the View itself. Similarly the returned 5858 * instance is responsible for performing accessibility actions on any virtual 5859 * view or the root view itself. 5860 * </p> 5861 * <p> 5862 * If an {@link AccessibilityDelegate} has been specified via calling 5863 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5864 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 5865 * is responsible for handling this call. 5866 * </p> 5867 * 5868 * @return The provider. 5869 * 5870 * @see AccessibilityNodeProvider 5871 */ 5872 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 5873 if (mAccessibilityDelegate != null) { 5874 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 5875 } else { 5876 return null; 5877 } 5878 } 5879 5880 /** 5881 * Gets the unique identifier of this view on the screen for accessibility purposes. 5882 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 5883 * 5884 * @return The view accessibility id. 5885 * 5886 * @hide 5887 */ 5888 public int getAccessibilityViewId() { 5889 if (mAccessibilityViewId == NO_ID) { 5890 mAccessibilityViewId = sNextAccessibilityViewId++; 5891 } 5892 return mAccessibilityViewId; 5893 } 5894 5895 /** 5896 * Gets the unique identifier of the window in which this View reseides. 5897 * 5898 * @return The window accessibility id. 5899 * 5900 * @hide 5901 */ 5902 public int getAccessibilityWindowId() { 5903 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId 5904 : AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 5905 } 5906 5907 /** 5908 * Gets the {@link View} description. It briefly describes the view and is 5909 * primarily used for accessibility support. Set this property to enable 5910 * better accessibility support for your application. This is especially 5911 * true for views that do not have textual representation (For example, 5912 * ImageButton). 5913 * 5914 * @return The content description. 5915 * 5916 * @attr ref android.R.styleable#View_contentDescription 5917 */ 5918 @ViewDebug.ExportedProperty(category = "accessibility") 5919 public CharSequence getContentDescription() { 5920 return mContentDescription; 5921 } 5922 5923 /** 5924 * Sets the {@link View} description. It briefly describes the view and is 5925 * primarily used for accessibility support. Set this property to enable 5926 * better accessibility support for your application. This is especially 5927 * true for views that do not have textual representation (For example, 5928 * ImageButton). 5929 * 5930 * @param contentDescription The content description. 5931 * 5932 * @attr ref android.R.styleable#View_contentDescription 5933 */ 5934 @RemotableViewMethod 5935 public void setContentDescription(CharSequence contentDescription) { 5936 if (mContentDescription == null) { 5937 if (contentDescription == null) { 5938 return; 5939 } 5940 } else if (mContentDescription.equals(contentDescription)) { 5941 return; 5942 } 5943 mContentDescription = contentDescription; 5944 final boolean nonEmptyDesc = contentDescription != null && contentDescription.length() > 0; 5945 if (nonEmptyDesc && getImportantForAccessibility() == IMPORTANT_FOR_ACCESSIBILITY_AUTO) { 5946 setImportantForAccessibility(IMPORTANT_FOR_ACCESSIBILITY_YES); 5947 notifySubtreeAccessibilityStateChangedIfNeeded(); 5948 } else { 5949 notifyViewAccessibilityStateChangedIfNeeded( 5950 AccessibilityEvent.CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION); 5951 } 5952 } 5953 5954 /** 5955 * Sets the id of a view before which this one is visited in accessibility traversal. 5956 * A screen-reader must visit the content of this view before the content of the one 5957 * it precedes. For example, if view B is set to be before view A, then a screen-reader 5958 * will traverse the entire content of B before traversing the entire content of A, 5959 * regardles of what traversal strategy it is using. 5960 * <p> 5961 * Views that do not have specified before/after relationships are traversed in order 5962 * determined by the screen-reader. 5963 * </p> 5964 * <p> 5965 * Setting that this view is before a view that is not important for accessibility 5966 * or if this view is not important for accessibility will have no effect as the 5967 * screen-reader is not aware of unimportant views. 5968 * </p> 5969 * 5970 * @param beforeId The id of a view this one precedes in accessibility traversal. 5971 * 5972 * @attr ref android.R.styleable#View_accessibilityTraversalBefore 5973 * 5974 * @see #setImportantForAccessibility(int) 5975 */ 5976 @RemotableViewMethod 5977 public void setAccessibilityTraversalBefore(int beforeId) { 5978 if (mAccessibilityTraversalBeforeId == beforeId) { 5979 return; 5980 } 5981 mAccessibilityTraversalBeforeId = beforeId; 5982 notifyViewAccessibilityStateChangedIfNeeded( 5983 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 5984 } 5985 5986 /** 5987 * Gets the id of a view before which this one is visited in accessibility traversal. 5988 * 5989 * @return The id of a view this one precedes in accessibility traversal if 5990 * specified, otherwise {@link #NO_ID}. 5991 * 5992 * @see #setAccessibilityTraversalBefore(int) 5993 */ 5994 public int getAccessibilityTraversalBefore() { 5995 return mAccessibilityTraversalBeforeId; 5996 } 5997 5998 /** 5999 * Sets the id of a view after which this one is visited in accessibility traversal. 6000 * A screen-reader must visit the content of the other view before the content of this 6001 * one. For example, if view B is set to be after view A, then a screen-reader 6002 * will traverse the entire content of A before traversing the entire content of B, 6003 * regardles of what traversal strategy it is using. 6004 * <p> 6005 * Views that do not have specified before/after relationships are traversed in order 6006 * determined by the screen-reader. 6007 * </p> 6008 * <p> 6009 * Setting that this view is after a view that is not important for accessibility 6010 * or if this view is not important for accessibility will have no effect as the 6011 * screen-reader is not aware of unimportant views. 6012 * </p> 6013 * 6014 * @param afterId The id of a view this one succedees in accessibility traversal. 6015 * 6016 * @attr ref android.R.styleable#View_accessibilityTraversalAfter 6017 * 6018 * @see #setImportantForAccessibility(int) 6019 */ 6020 @RemotableViewMethod 6021 public void setAccessibilityTraversalAfter(int afterId) { 6022 if (mAccessibilityTraversalAfterId == afterId) { 6023 return; 6024 } 6025 mAccessibilityTraversalAfterId = afterId; 6026 notifyViewAccessibilityStateChangedIfNeeded( 6027 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6028 } 6029 6030 /** 6031 * Gets the id of a view after which this one is visited in accessibility traversal. 6032 * 6033 * @return The id of a view this one succeedes in accessibility traversal if 6034 * specified, otherwise {@link #NO_ID}. 6035 * 6036 * @see #setAccessibilityTraversalAfter(int) 6037 */ 6038 public int getAccessibilityTraversalAfter() { 6039 return mAccessibilityTraversalAfterId; 6040 } 6041 6042 /** 6043 * Gets the id of a view for which this view serves as a label for 6044 * accessibility purposes. 6045 * 6046 * @return The labeled view id. 6047 */ 6048 @ViewDebug.ExportedProperty(category = "accessibility") 6049 public int getLabelFor() { 6050 return mLabelForId; 6051 } 6052 6053 /** 6054 * Sets the id of a view for which this view serves as a label for 6055 * accessibility purposes. 6056 * 6057 * @param id The labeled view id. 6058 */ 6059 @RemotableViewMethod 6060 public void setLabelFor(int id) { 6061 if (mLabelForId == id) { 6062 return; 6063 } 6064 mLabelForId = id; 6065 if (mLabelForId != View.NO_ID 6066 && mID == View.NO_ID) { 6067 mID = generateViewId(); 6068 } 6069 notifyViewAccessibilityStateChangedIfNeeded( 6070 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 6071 } 6072 6073 /** 6074 * Invoked whenever this view loses focus, either by losing window focus or by losing 6075 * focus within its window. This method can be used to clear any state tied to the 6076 * focus. For instance, if a button is held pressed with the trackball and the window 6077 * loses focus, this method can be used to cancel the press. 6078 * 6079 * Subclasses of View overriding this method should always call super.onFocusLost(). 6080 * 6081 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 6082 * @see #onWindowFocusChanged(boolean) 6083 * 6084 * @hide pending API council approval 6085 */ 6086 protected void onFocusLost() { 6087 resetPressedState(); 6088 } 6089 6090 private void resetPressedState() { 6091 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 6092 return; 6093 } 6094 6095 if (isPressed()) { 6096 setPressed(false); 6097 6098 if (!mHasPerformedLongPress) { 6099 removeLongPressCallback(); 6100 } 6101 } 6102 } 6103 6104 /** 6105 * Returns true if this view has focus 6106 * 6107 * @return True if this view has focus, false otherwise. 6108 */ 6109 @ViewDebug.ExportedProperty(category = "focus") 6110 public boolean isFocused() { 6111 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 6112 } 6113 6114 /** 6115 * Find the view in the hierarchy rooted at this view that currently has 6116 * focus. 6117 * 6118 * @return The view that currently has focus, or null if no focused view can 6119 * be found. 6120 */ 6121 public View findFocus() { 6122 return (mPrivateFlags & PFLAG_FOCUSED) != 0 ? this : null; 6123 } 6124 6125 /** 6126 * Indicates whether this view is one of the set of scrollable containers in 6127 * its window. 6128 * 6129 * @return whether this view is one of the set of scrollable containers in 6130 * its window 6131 * 6132 * @attr ref android.R.styleable#View_isScrollContainer 6133 */ 6134 public boolean isScrollContainer() { 6135 return (mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0; 6136 } 6137 6138 /** 6139 * Change whether this view is one of the set of scrollable containers in 6140 * its window. This will be used to determine whether the window can 6141 * resize or must pan when a soft input area is open -- scrollable 6142 * containers allow the window to use resize mode since the container 6143 * will appropriately shrink. 6144 * 6145 * @attr ref android.R.styleable#View_isScrollContainer 6146 */ 6147 public void setScrollContainer(boolean isScrollContainer) { 6148 if (isScrollContainer) { 6149 if (mAttachInfo != null && (mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) == 0) { 6150 mAttachInfo.mScrollContainers.add(this); 6151 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 6152 } 6153 mPrivateFlags |= PFLAG_SCROLL_CONTAINER; 6154 } else { 6155 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 6156 mAttachInfo.mScrollContainers.remove(this); 6157 } 6158 mPrivateFlags &= ~(PFLAG_SCROLL_CONTAINER|PFLAG_SCROLL_CONTAINER_ADDED); 6159 } 6160 } 6161 6162 /** 6163 * Returns the quality of the drawing cache. 6164 * 6165 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6166 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6167 * 6168 * @see #setDrawingCacheQuality(int) 6169 * @see #setDrawingCacheEnabled(boolean) 6170 * @see #isDrawingCacheEnabled() 6171 * 6172 * @attr ref android.R.styleable#View_drawingCacheQuality 6173 */ 6174 @DrawingCacheQuality 6175 public int getDrawingCacheQuality() { 6176 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 6177 } 6178 6179 /** 6180 * Set the drawing cache quality of this view. This value is used only when the 6181 * drawing cache is enabled 6182 * 6183 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 6184 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 6185 * 6186 * @see #getDrawingCacheQuality() 6187 * @see #setDrawingCacheEnabled(boolean) 6188 * @see #isDrawingCacheEnabled() 6189 * 6190 * @attr ref android.R.styleable#View_drawingCacheQuality 6191 */ 6192 public void setDrawingCacheQuality(@DrawingCacheQuality int quality) { 6193 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 6194 } 6195 6196 /** 6197 * Returns whether the screen should remain on, corresponding to the current 6198 * value of {@link #KEEP_SCREEN_ON}. 6199 * 6200 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 6201 * 6202 * @see #setKeepScreenOn(boolean) 6203 * 6204 * @attr ref android.R.styleable#View_keepScreenOn 6205 */ 6206 public boolean getKeepScreenOn() { 6207 return (mViewFlags & KEEP_SCREEN_ON) != 0; 6208 } 6209 6210 /** 6211 * Controls whether the screen should remain on, modifying the 6212 * value of {@link #KEEP_SCREEN_ON}. 6213 * 6214 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 6215 * 6216 * @see #getKeepScreenOn() 6217 * 6218 * @attr ref android.R.styleable#View_keepScreenOn 6219 */ 6220 public void setKeepScreenOn(boolean keepScreenOn) { 6221 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 6222 } 6223 6224 /** 6225 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6226 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6227 * 6228 * @attr ref android.R.styleable#View_nextFocusLeft 6229 */ 6230 public int getNextFocusLeftId() { 6231 return mNextFocusLeftId; 6232 } 6233 6234 /** 6235 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 6236 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 6237 * decide automatically. 6238 * 6239 * @attr ref android.R.styleable#View_nextFocusLeft 6240 */ 6241 public void setNextFocusLeftId(int nextFocusLeftId) { 6242 mNextFocusLeftId = nextFocusLeftId; 6243 } 6244 6245 /** 6246 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6247 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6248 * 6249 * @attr ref android.R.styleable#View_nextFocusRight 6250 */ 6251 public int getNextFocusRightId() { 6252 return mNextFocusRightId; 6253 } 6254 6255 /** 6256 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 6257 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 6258 * decide automatically. 6259 * 6260 * @attr ref android.R.styleable#View_nextFocusRight 6261 */ 6262 public void setNextFocusRightId(int nextFocusRightId) { 6263 mNextFocusRightId = nextFocusRightId; 6264 } 6265 6266 /** 6267 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6268 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6269 * 6270 * @attr ref android.R.styleable#View_nextFocusUp 6271 */ 6272 public int getNextFocusUpId() { 6273 return mNextFocusUpId; 6274 } 6275 6276 /** 6277 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 6278 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 6279 * decide automatically. 6280 * 6281 * @attr ref android.R.styleable#View_nextFocusUp 6282 */ 6283 public void setNextFocusUpId(int nextFocusUpId) { 6284 mNextFocusUpId = nextFocusUpId; 6285 } 6286 6287 /** 6288 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6289 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6290 * 6291 * @attr ref android.R.styleable#View_nextFocusDown 6292 */ 6293 public int getNextFocusDownId() { 6294 return mNextFocusDownId; 6295 } 6296 6297 /** 6298 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 6299 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 6300 * decide automatically. 6301 * 6302 * @attr ref android.R.styleable#View_nextFocusDown 6303 */ 6304 public void setNextFocusDownId(int nextFocusDownId) { 6305 mNextFocusDownId = nextFocusDownId; 6306 } 6307 6308 /** 6309 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6310 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 6311 * 6312 * @attr ref android.R.styleable#View_nextFocusForward 6313 */ 6314 public int getNextFocusForwardId() { 6315 return mNextFocusForwardId; 6316 } 6317 6318 /** 6319 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 6320 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 6321 * decide automatically. 6322 * 6323 * @attr ref android.R.styleable#View_nextFocusForward 6324 */ 6325 public void setNextFocusForwardId(int nextFocusForwardId) { 6326 mNextFocusForwardId = nextFocusForwardId; 6327 } 6328 6329 /** 6330 * Returns the visibility of this view and all of its ancestors 6331 * 6332 * @return True if this view and all of its ancestors are {@link #VISIBLE} 6333 */ 6334 public boolean isShown() { 6335 View current = this; 6336 //noinspection ConstantConditions 6337 do { 6338 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6339 return false; 6340 } 6341 ViewParent parent = current.mParent; 6342 if (parent == null) { 6343 return false; // We are not attached to the view root 6344 } 6345 if (!(parent instanceof View)) { 6346 return true; 6347 } 6348 current = (View) parent; 6349 } while (current != null); 6350 6351 return false; 6352 } 6353 6354 /** 6355 * Called by the view hierarchy when the content insets for a window have 6356 * changed, to allow it to adjust its content to fit within those windows. 6357 * The content insets tell you the space that the status bar, input method, 6358 * and other system windows infringe on the application's window. 6359 * 6360 * <p>You do not normally need to deal with this function, since the default 6361 * window decoration given to applications takes care of applying it to the 6362 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 6363 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case, 6364 * and your content can be placed under those system elements. You can then 6365 * use this method within your view hierarchy if you have parts of your UI 6366 * which you would like to ensure are not being covered. 6367 * 6368 * <p>The default implementation of this method simply applies the content 6369 * insets to the view's padding, consuming that content (modifying the 6370 * insets to be 0), and returning true. This behavior is off by default, but can 6371 * be enabled through {@link #setFitsSystemWindows(boolean)}. 6372 * 6373 * <p>This function's traversal down the hierarchy is depth-first. The same content 6374 * insets object is propagated down the hierarchy, so any changes made to it will 6375 * be seen by all following views (including potentially ones above in 6376 * the hierarchy since this is a depth-first traversal). The first view 6377 * that returns true will abort the entire traversal. 6378 * 6379 * <p>The default implementation works well for a situation where it is 6380 * used with a container that covers the entire window, allowing it to 6381 * apply the appropriate insets to its content on all edges. If you need 6382 * a more complicated layout (such as two different views fitting system 6383 * windows, one on the top of the window, and one on the bottom), 6384 * you can override the method and handle the insets however you would like. 6385 * Note that the insets provided by the framework are always relative to the 6386 * far edges of the window, not accounting for the location of the called view 6387 * within that window. (In fact when this method is called you do not yet know 6388 * where the layout will place the view, as it is done before layout happens.) 6389 * 6390 * <p>Note: unlike many View methods, there is no dispatch phase to this 6391 * call. If you are overriding it in a ViewGroup and want to allow the 6392 * call to continue to your children, you must be sure to call the super 6393 * implementation. 6394 * 6395 * <p>Here is a sample layout that makes use of fitting system windows 6396 * to have controls for a video view placed inside of the window decorations 6397 * that it hides and shows. This can be used with code like the second 6398 * sample (video player) shown in {@link #setSystemUiVisibility(int)}. 6399 * 6400 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete} 6401 * 6402 * @param insets Current content insets of the window. Prior to 6403 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify 6404 * the insets or else you and Android will be unhappy. 6405 * 6406 * @return {@code true} if this view applied the insets and it should not 6407 * continue propagating further down the hierarchy, {@code false} otherwise. 6408 * @see #getFitsSystemWindows() 6409 * @see #setFitsSystemWindows(boolean) 6410 * @see #setSystemUiVisibility(int) 6411 * 6412 * @deprecated As of API 20 use {@link #dispatchApplyWindowInsets(WindowInsets)} to apply 6413 * insets to views. Views should override {@link #onApplyWindowInsets(WindowInsets)} or use 6414 * {@link #setOnApplyWindowInsetsListener(android.view.View.OnApplyWindowInsetsListener)} 6415 * to implement handling their own insets. 6416 */ 6417 protected boolean fitSystemWindows(Rect insets) { 6418 if ((mPrivateFlags3 & PFLAG3_APPLYING_INSETS) == 0) { 6419 if (insets == null) { 6420 // Null insets by definition have already been consumed. 6421 // This call cannot apply insets since there are none to apply, 6422 // so return false. 6423 return false; 6424 } 6425 // If we're not in the process of dispatching the newer apply insets call, 6426 // that means we're not in the compatibility path. Dispatch into the newer 6427 // apply insets path and take things from there. 6428 try { 6429 mPrivateFlags3 |= PFLAG3_FITTING_SYSTEM_WINDOWS; 6430 return dispatchApplyWindowInsets(new WindowInsets(insets)).isConsumed(); 6431 } finally { 6432 mPrivateFlags3 &= ~PFLAG3_FITTING_SYSTEM_WINDOWS; 6433 } 6434 } else { 6435 // We're being called from the newer apply insets path. 6436 // Perform the standard fallback behavior. 6437 return fitSystemWindowsInt(insets); 6438 } 6439 } 6440 6441 private boolean fitSystemWindowsInt(Rect insets) { 6442 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 6443 mUserPaddingStart = UNDEFINED_PADDING; 6444 mUserPaddingEnd = UNDEFINED_PADDING; 6445 Rect localInsets = sThreadLocal.get(); 6446 if (localInsets == null) { 6447 localInsets = new Rect(); 6448 sThreadLocal.set(localInsets); 6449 } 6450 boolean res = computeFitSystemWindows(insets, localInsets); 6451 mUserPaddingLeftInitial = localInsets.left; 6452 mUserPaddingRightInitial = localInsets.right; 6453 internalSetPadding(localInsets.left, localInsets.top, 6454 localInsets.right, localInsets.bottom); 6455 return res; 6456 } 6457 return false; 6458 } 6459 6460 /** 6461 * Called when the view should apply {@link WindowInsets} according to its internal policy. 6462 * 6463 * <p>This method should be overridden by views that wish to apply a policy different from or 6464 * in addition to the default behavior. Clients that wish to force a view subtree 6465 * to apply insets should call {@link #dispatchApplyWindowInsets(WindowInsets)}.</p> 6466 * 6467 * <p>Clients may supply an {@link OnApplyWindowInsetsListener} to a view. If one is set 6468 * it will be called during dispatch instead of this method. The listener may optionally 6469 * call this method from its own implementation if it wishes to apply the view's default 6470 * insets policy in addition to its own.</p> 6471 * 6472 * <p>Implementations of this method should either return the insets parameter unchanged 6473 * or a new {@link WindowInsets} cloned from the supplied insets with any insets consumed 6474 * that this view applied itself. This allows new inset types added in future platform 6475 * versions to pass through existing implementations unchanged without being erroneously 6476 * consumed.</p> 6477 * 6478 * <p>By default if a view's {@link #setFitsSystemWindows(boolean) fitsSystemWindows} 6479 * property is set then the view will consume the system window insets and apply them 6480 * as padding for the view.</p> 6481 * 6482 * @param insets Insets to apply 6483 * @return The supplied insets with any applied insets consumed 6484 */ 6485 public WindowInsets onApplyWindowInsets(WindowInsets insets) { 6486 if ((mPrivateFlags3 & PFLAG3_FITTING_SYSTEM_WINDOWS) == 0) { 6487 // We weren't called from within a direct call to fitSystemWindows, 6488 // call into it as a fallback in case we're in a class that overrides it 6489 // and has logic to perform. 6490 if (fitSystemWindows(insets.getSystemWindowInsets())) { 6491 return insets.consumeSystemWindowInsets(); 6492 } 6493 } else { 6494 // We were called from within a direct call to fitSystemWindows. 6495 if (fitSystemWindowsInt(insets.getSystemWindowInsets())) { 6496 return insets.consumeSystemWindowInsets(); 6497 } 6498 } 6499 return insets; 6500 } 6501 6502 /** 6503 * Set an {@link OnApplyWindowInsetsListener} to take over the policy for applying 6504 * window insets to this view. The listener's 6505 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 6506 * method will be called instead of the view's 6507 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 6508 * 6509 * @param listener Listener to set 6510 * 6511 * @see #onApplyWindowInsets(WindowInsets) 6512 */ 6513 public void setOnApplyWindowInsetsListener(OnApplyWindowInsetsListener listener) { 6514 getListenerInfo().mOnApplyWindowInsetsListener = listener; 6515 } 6516 6517 /** 6518 * Request to apply the given window insets to this view or another view in its subtree. 6519 * 6520 * <p>This method should be called by clients wishing to apply insets corresponding to areas 6521 * obscured by window decorations or overlays. This can include the status and navigation bars, 6522 * action bars, input methods and more. New inset categories may be added in the future. 6523 * The method returns the insets provided minus any that were applied by this view or its 6524 * children.</p> 6525 * 6526 * <p>Clients wishing to provide custom behavior should override the 6527 * {@link #onApplyWindowInsets(WindowInsets)} method or alternatively provide a 6528 * {@link OnApplyWindowInsetsListener} via the 6529 * {@link #setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) setOnApplyWindowInsetsListener} 6530 * method.</p> 6531 * 6532 * <p>This method replaces the older {@link #fitSystemWindows(Rect) fitSystemWindows} method. 6533 * </p> 6534 * 6535 * @param insets Insets to apply 6536 * @return The provided insets minus the insets that were consumed 6537 */ 6538 public WindowInsets dispatchApplyWindowInsets(WindowInsets insets) { 6539 try { 6540 mPrivateFlags3 |= PFLAG3_APPLYING_INSETS; 6541 if (mListenerInfo != null && mListenerInfo.mOnApplyWindowInsetsListener != null) { 6542 return mListenerInfo.mOnApplyWindowInsetsListener.onApplyWindowInsets(this, insets); 6543 } else { 6544 return onApplyWindowInsets(insets); 6545 } 6546 } finally { 6547 mPrivateFlags3 &= ~PFLAG3_APPLYING_INSETS; 6548 } 6549 } 6550 6551 /** 6552 * @hide Compute the insets that should be consumed by this view and the ones 6553 * that should propagate to those under it. 6554 */ 6555 protected boolean computeFitSystemWindows(Rect inoutInsets, Rect outLocalInsets) { 6556 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6557 || mAttachInfo == null 6558 || ((mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0 6559 && !mAttachInfo.mOverscanRequested)) { 6560 outLocalInsets.set(inoutInsets); 6561 inoutInsets.set(0, 0, 0, 0); 6562 return true; 6563 } else { 6564 // The application wants to take care of fitting system window for 6565 // the content... however we still need to take care of any overscan here. 6566 final Rect overscan = mAttachInfo.mOverscanInsets; 6567 outLocalInsets.set(overscan); 6568 inoutInsets.left -= overscan.left; 6569 inoutInsets.top -= overscan.top; 6570 inoutInsets.right -= overscan.right; 6571 inoutInsets.bottom -= overscan.bottom; 6572 return false; 6573 } 6574 } 6575 6576 /** 6577 * Compute insets that should be consumed by this view and the ones that should propagate 6578 * to those under it. 6579 * 6580 * @param in Insets currently being processed by this View, likely received as a parameter 6581 * to {@link #onApplyWindowInsets(WindowInsets)}. 6582 * @param outLocalInsets A Rect that will receive the insets that should be consumed 6583 * by this view 6584 * @return Insets that should be passed along to views under this one 6585 */ 6586 public WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) { 6587 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 6588 || mAttachInfo == null 6589 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) { 6590 outLocalInsets.set(in.getSystemWindowInsets()); 6591 return in.consumeSystemWindowInsets(); 6592 } else { 6593 outLocalInsets.set(0, 0, 0, 0); 6594 return in; 6595 } 6596 } 6597 6598 /** 6599 * Sets whether or not this view should account for system screen decorations 6600 * such as the status bar and inset its content; that is, controlling whether 6601 * the default implementation of {@link #fitSystemWindows(Rect)} will be 6602 * executed. See that method for more details. 6603 * 6604 * <p>Note that if you are providing your own implementation of 6605 * {@link #fitSystemWindows(Rect)}, then there is no need to set this 6606 * flag to true -- your implementation will be overriding the default 6607 * implementation that checks this flag. 6608 * 6609 * @param fitSystemWindows If true, then the default implementation of 6610 * {@link #fitSystemWindows(Rect)} will be executed. 6611 * 6612 * @attr ref android.R.styleable#View_fitsSystemWindows 6613 * @see #getFitsSystemWindows() 6614 * @see #fitSystemWindows(Rect) 6615 * @see #setSystemUiVisibility(int) 6616 */ 6617 public void setFitsSystemWindows(boolean fitSystemWindows) { 6618 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 6619 } 6620 6621 /** 6622 * Check for state of {@link #setFitsSystemWindows(boolean)}. If this method 6623 * returns {@code true}, the default implementation of {@link #fitSystemWindows(Rect)} 6624 * will be executed. 6625 * 6626 * @return {@code true} if the default implementation of 6627 * {@link #fitSystemWindows(Rect)} will be executed. 6628 * 6629 * @attr ref android.R.styleable#View_fitsSystemWindows 6630 * @see #setFitsSystemWindows(boolean) 6631 * @see #fitSystemWindows(Rect) 6632 * @see #setSystemUiVisibility(int) 6633 */ 6634 @ViewDebug.ExportedProperty 6635 public boolean getFitsSystemWindows() { 6636 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 6637 } 6638 6639 /** @hide */ 6640 public boolean fitsSystemWindows() { 6641 return getFitsSystemWindows(); 6642 } 6643 6644 /** 6645 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed. 6646 * @deprecated Use {@link #requestApplyInsets()} for newer platform versions. 6647 */ 6648 public void requestFitSystemWindows() { 6649 if (mParent != null) { 6650 mParent.requestFitSystemWindows(); 6651 } 6652 } 6653 6654 /** 6655 * Ask that a new dispatch of {@link #onApplyWindowInsets(WindowInsets)} be performed. 6656 */ 6657 public void requestApplyInsets() { 6658 requestFitSystemWindows(); 6659 } 6660 6661 /** 6662 * For use by PhoneWindow to make its own system window fitting optional. 6663 * @hide 6664 */ 6665 public void makeOptionalFitsSystemWindows() { 6666 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS); 6667 } 6668 6669 /** 6670 * Returns the visibility status for this view. 6671 * 6672 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6673 * @attr ref android.R.styleable#View_visibility 6674 */ 6675 @ViewDebug.ExportedProperty(mapping = { 6676 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 6677 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 6678 @ViewDebug.IntToString(from = GONE, to = "GONE") 6679 }) 6680 @Visibility 6681 public int getVisibility() { 6682 return mViewFlags & VISIBILITY_MASK; 6683 } 6684 6685 /** 6686 * Set the enabled state of this view. 6687 * 6688 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 6689 * @attr ref android.R.styleable#View_visibility 6690 */ 6691 @RemotableViewMethod 6692 public void setVisibility(@Visibility int visibility) { 6693 setFlags(visibility, VISIBILITY_MASK); 6694 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false); 6695 } 6696 6697 /** 6698 * Returns the enabled status for this view. The interpretation of the 6699 * enabled state varies by subclass. 6700 * 6701 * @return True if this view is enabled, false otherwise. 6702 */ 6703 @ViewDebug.ExportedProperty 6704 public boolean isEnabled() { 6705 return (mViewFlags & ENABLED_MASK) == ENABLED; 6706 } 6707 6708 /** 6709 * Set the enabled state of this view. The interpretation of the enabled 6710 * state varies by subclass. 6711 * 6712 * @param enabled True if this view is enabled, false otherwise. 6713 */ 6714 @RemotableViewMethod 6715 public void setEnabled(boolean enabled) { 6716 if (enabled == isEnabled()) return; 6717 6718 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 6719 6720 /* 6721 * The View most likely has to change its appearance, so refresh 6722 * the drawable state. 6723 */ 6724 refreshDrawableState(); 6725 6726 // Invalidate too, since the default behavior for views is to be 6727 // be drawn at 50% alpha rather than to change the drawable. 6728 invalidate(true); 6729 6730 if (!enabled) { 6731 cancelPendingInputEvents(); 6732 } 6733 } 6734 6735 /** 6736 * Set whether this view can receive the focus. 6737 * 6738 * Setting this to false will also ensure that this view is not focusable 6739 * in touch mode. 6740 * 6741 * @param focusable If true, this view can receive the focus. 6742 * 6743 * @see #setFocusableInTouchMode(boolean) 6744 * @attr ref android.R.styleable#View_focusable 6745 */ 6746 public void setFocusable(boolean focusable) { 6747 if (!focusable) { 6748 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 6749 } 6750 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 6751 } 6752 6753 /** 6754 * Set whether this view can receive focus while in touch mode. 6755 * 6756 * Setting this to true will also ensure that this view is focusable. 6757 * 6758 * @param focusableInTouchMode If true, this view can receive the focus while 6759 * in touch mode. 6760 * 6761 * @see #setFocusable(boolean) 6762 * @attr ref android.R.styleable#View_focusableInTouchMode 6763 */ 6764 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 6765 // Focusable in touch mode should always be set before the focusable flag 6766 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 6767 // which, in touch mode, will not successfully request focus on this view 6768 // because the focusable in touch mode flag is not set 6769 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 6770 if (focusableInTouchMode) { 6771 setFlags(FOCUSABLE, FOCUSABLE_MASK); 6772 } 6773 } 6774 6775 /** 6776 * Set whether this view should have sound effects enabled for events such as 6777 * clicking and touching. 6778 * 6779 * <p>You may wish to disable sound effects for a view if you already play sounds, 6780 * for instance, a dial key that plays dtmf tones. 6781 * 6782 * @param soundEffectsEnabled whether sound effects are enabled for this view. 6783 * @see #isSoundEffectsEnabled() 6784 * @see #playSoundEffect(int) 6785 * @attr ref android.R.styleable#View_soundEffectsEnabled 6786 */ 6787 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 6788 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 6789 } 6790 6791 /** 6792 * @return whether this view should have sound effects enabled for events such as 6793 * clicking and touching. 6794 * 6795 * @see #setSoundEffectsEnabled(boolean) 6796 * @see #playSoundEffect(int) 6797 * @attr ref android.R.styleable#View_soundEffectsEnabled 6798 */ 6799 @ViewDebug.ExportedProperty 6800 public boolean isSoundEffectsEnabled() { 6801 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 6802 } 6803 6804 /** 6805 * Set whether this view should have haptic feedback for events such as 6806 * long presses. 6807 * 6808 * <p>You may wish to disable haptic feedback if your view already controls 6809 * its own haptic feedback. 6810 * 6811 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 6812 * @see #isHapticFeedbackEnabled() 6813 * @see #performHapticFeedback(int) 6814 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6815 */ 6816 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 6817 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 6818 } 6819 6820 /** 6821 * @return whether this view should have haptic feedback enabled for events 6822 * long presses. 6823 * 6824 * @see #setHapticFeedbackEnabled(boolean) 6825 * @see #performHapticFeedback(int) 6826 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 6827 */ 6828 @ViewDebug.ExportedProperty 6829 public boolean isHapticFeedbackEnabled() { 6830 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 6831 } 6832 6833 /** 6834 * Returns the layout direction for this view. 6835 * 6836 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 6837 * {@link #LAYOUT_DIRECTION_RTL}, 6838 * {@link #LAYOUT_DIRECTION_INHERIT} or 6839 * {@link #LAYOUT_DIRECTION_LOCALE}. 6840 * 6841 * @attr ref android.R.styleable#View_layoutDirection 6842 * 6843 * @hide 6844 */ 6845 @ViewDebug.ExportedProperty(category = "layout", mapping = { 6846 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 6847 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 6848 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 6849 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 6850 }) 6851 @LayoutDir 6852 public int getRawLayoutDirection() { 6853 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 6854 } 6855 6856 /** 6857 * Set the layout direction for this view. This will propagate a reset of layout direction 6858 * resolution to the view's children and resolve layout direction for this view. 6859 * 6860 * @param layoutDirection the layout direction to set. Should be one of: 6861 * 6862 * {@link #LAYOUT_DIRECTION_LTR}, 6863 * {@link #LAYOUT_DIRECTION_RTL}, 6864 * {@link #LAYOUT_DIRECTION_INHERIT}, 6865 * {@link #LAYOUT_DIRECTION_LOCALE}. 6866 * 6867 * Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution 6868 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 6869 * will return the default {@link #LAYOUT_DIRECTION_LTR}. 6870 * 6871 * @attr ref android.R.styleable#View_layoutDirection 6872 */ 6873 @RemotableViewMethod 6874 public void setLayoutDirection(@LayoutDir int layoutDirection) { 6875 if (getRawLayoutDirection() != layoutDirection) { 6876 // Reset the current layout direction and the resolved one 6877 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_MASK; 6878 resetRtlProperties(); 6879 // Set the new layout direction (filtered) 6880 mPrivateFlags2 |= 6881 ((layoutDirection << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) & PFLAG2_LAYOUT_DIRECTION_MASK); 6882 // We need to resolve all RTL properties as they all depend on layout direction 6883 resolveRtlPropertiesIfNeeded(); 6884 requestLayout(); 6885 invalidate(true); 6886 } 6887 } 6888 6889 /** 6890 * Returns the resolved layout direction for this view. 6891 * 6892 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 6893 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. 6894 * 6895 * For compatibility, this will return {@link #LAYOUT_DIRECTION_LTR} if API version 6896 * is lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}. 6897 * 6898 * @attr ref android.R.styleable#View_layoutDirection 6899 */ 6900 @ViewDebug.ExportedProperty(category = "layout", mapping = { 6901 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 6902 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 6903 }) 6904 @ResolvedLayoutDir 6905 public int getLayoutDirection() { 6906 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 6907 if (targetSdkVersion < JELLY_BEAN_MR1) { 6908 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 6909 return LAYOUT_DIRECTION_RESOLVED_DEFAULT; 6910 } 6911 return ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) == 6912 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) ? LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 6913 } 6914 6915 /** 6916 * Indicates whether or not this view's layout is right-to-left. This is resolved from 6917 * layout attribute and/or the inherited value from the parent 6918 * 6919 * @return true if the layout is right-to-left. 6920 * 6921 * @hide 6922 */ 6923 @ViewDebug.ExportedProperty(category = "layout") 6924 public boolean isLayoutRtl() { 6925 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL); 6926 } 6927 6928 /** 6929 * Indicates whether the view is currently tracking transient state that the 6930 * app should not need to concern itself with saving and restoring, but that 6931 * the framework should take special note to preserve when possible. 6932 * 6933 * <p>A view with transient state cannot be trivially rebound from an external 6934 * data source, such as an adapter binding item views in a list. This may be 6935 * because the view is performing an animation, tracking user selection 6936 * of content, or similar.</p> 6937 * 6938 * @return true if the view has transient state 6939 */ 6940 @ViewDebug.ExportedProperty(category = "layout") 6941 public boolean hasTransientState() { 6942 return (mPrivateFlags2 & PFLAG2_HAS_TRANSIENT_STATE) == PFLAG2_HAS_TRANSIENT_STATE; 6943 } 6944 6945 /** 6946 * Set whether this view is currently tracking transient state that the 6947 * framework should attempt to preserve when possible. This flag is reference counted, 6948 * so every call to setHasTransientState(true) should be paired with a later call 6949 * to setHasTransientState(false). 6950 * 6951 * <p>A view with transient state cannot be trivially rebound from an external 6952 * data source, such as an adapter binding item views in a list. This may be 6953 * because the view is performing an animation, tracking user selection 6954 * of content, or similar.</p> 6955 * 6956 * @param hasTransientState true if this view has transient state 6957 */ 6958 public void setHasTransientState(boolean hasTransientState) { 6959 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 : 6960 mTransientStateCount - 1; 6961 if (mTransientStateCount < 0) { 6962 mTransientStateCount = 0; 6963 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " + 6964 "unmatched pair of setHasTransientState calls"); 6965 } else if ((hasTransientState && mTransientStateCount == 1) || 6966 (!hasTransientState && mTransientStateCount == 0)) { 6967 // update flag if we've just incremented up from 0 or decremented down to 0 6968 mPrivateFlags2 = (mPrivateFlags2 & ~PFLAG2_HAS_TRANSIENT_STATE) | 6969 (hasTransientState ? PFLAG2_HAS_TRANSIENT_STATE : 0); 6970 if (mParent != null) { 6971 try { 6972 mParent.childHasTransientStateChanged(this, hasTransientState); 6973 } catch (AbstractMethodError e) { 6974 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 6975 " does not fully implement ViewParent", e); 6976 } 6977 } 6978 } 6979 } 6980 6981 /** 6982 * Returns true if this view is currently attached to a window. 6983 */ 6984 public boolean isAttachedToWindow() { 6985 return mAttachInfo != null; 6986 } 6987 6988 /** 6989 * Returns true if this view has been through at least one layout since it 6990 * was last attached to or detached from a window. 6991 */ 6992 public boolean isLaidOut() { 6993 return (mPrivateFlags3 & PFLAG3_IS_LAID_OUT) == PFLAG3_IS_LAID_OUT; 6994 } 6995 6996 /** 6997 * If this view doesn't do any drawing on its own, set this flag to 6998 * allow further optimizations. By default, this flag is not set on 6999 * View, but could be set on some View subclasses such as ViewGroup. 7000 * 7001 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 7002 * you should clear this flag. 7003 * 7004 * @param willNotDraw whether or not this View draw on its own 7005 */ 7006 public void setWillNotDraw(boolean willNotDraw) { 7007 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 7008 } 7009 7010 /** 7011 * Returns whether or not this View draws on its own. 7012 * 7013 * @return true if this view has nothing to draw, false otherwise 7014 */ 7015 @ViewDebug.ExportedProperty(category = "drawing") 7016 public boolean willNotDraw() { 7017 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 7018 } 7019 7020 /** 7021 * When a View's drawing cache is enabled, drawing is redirected to an 7022 * offscreen bitmap. Some views, like an ImageView, must be able to 7023 * bypass this mechanism if they already draw a single bitmap, to avoid 7024 * unnecessary usage of the memory. 7025 * 7026 * @param willNotCacheDrawing true if this view does not cache its 7027 * drawing, false otherwise 7028 */ 7029 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 7030 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 7031 } 7032 7033 /** 7034 * Returns whether or not this View can cache its drawing or not. 7035 * 7036 * @return true if this view does not cache its drawing, false otherwise 7037 */ 7038 @ViewDebug.ExportedProperty(category = "drawing") 7039 public boolean willNotCacheDrawing() { 7040 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 7041 } 7042 7043 /** 7044 * Indicates whether this view reacts to click events or not. 7045 * 7046 * @return true if the view is clickable, false otherwise 7047 * 7048 * @see #setClickable(boolean) 7049 * @attr ref android.R.styleable#View_clickable 7050 */ 7051 @ViewDebug.ExportedProperty 7052 public boolean isClickable() { 7053 return (mViewFlags & CLICKABLE) == CLICKABLE; 7054 } 7055 7056 /** 7057 * Enables or disables click events for this view. When a view 7058 * is clickable it will change its state to "pressed" on every click. 7059 * Subclasses should set the view clickable to visually react to 7060 * user's clicks. 7061 * 7062 * @param clickable true to make the view clickable, false otherwise 7063 * 7064 * @see #isClickable() 7065 * @attr ref android.R.styleable#View_clickable 7066 */ 7067 public void setClickable(boolean clickable) { 7068 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 7069 } 7070 7071 /** 7072 * Indicates whether this view reacts to long click events or not. 7073 * 7074 * @return true if the view is long clickable, false otherwise 7075 * 7076 * @see #setLongClickable(boolean) 7077 * @attr ref android.R.styleable#View_longClickable 7078 */ 7079 public boolean isLongClickable() { 7080 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 7081 } 7082 7083 /** 7084 * Enables or disables long click events for this view. When a view is long 7085 * clickable it reacts to the user holding down the button for a longer 7086 * duration than a tap. This event can either launch the listener or a 7087 * context menu. 7088 * 7089 * @param longClickable true to make the view long clickable, false otherwise 7090 * @see #isLongClickable() 7091 * @attr ref android.R.styleable#View_longClickable 7092 */ 7093 public void setLongClickable(boolean longClickable) { 7094 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 7095 } 7096 7097 /** 7098 * Sets the pressed state for this view and provides a touch coordinate for 7099 * animation hinting. 7100 * 7101 * @param pressed Pass true to set the View's internal state to "pressed", 7102 * or false to reverts the View's internal state from a 7103 * previously set "pressed" state. 7104 * @param x The x coordinate of the touch that caused the press 7105 * @param y The y coordinate of the touch that caused the press 7106 */ 7107 private void setPressed(boolean pressed, float x, float y) { 7108 if (pressed) { 7109 drawableHotspotChanged(x, y); 7110 } 7111 7112 setPressed(pressed); 7113 } 7114 7115 /** 7116 * Sets the pressed state for this view. 7117 * 7118 * @see #isClickable() 7119 * @see #setClickable(boolean) 7120 * 7121 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 7122 * the View's internal state from a previously set "pressed" state. 7123 */ 7124 public void setPressed(boolean pressed) { 7125 final boolean needsRefresh = pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED); 7126 7127 if (pressed) { 7128 mPrivateFlags |= PFLAG_PRESSED; 7129 } else { 7130 mPrivateFlags &= ~PFLAG_PRESSED; 7131 } 7132 7133 if (needsRefresh) { 7134 refreshDrawableState(); 7135 } 7136 dispatchSetPressed(pressed); 7137 } 7138 7139 /** 7140 * Dispatch setPressed to all of this View's children. 7141 * 7142 * @see #setPressed(boolean) 7143 * 7144 * @param pressed The new pressed state 7145 */ 7146 protected void dispatchSetPressed(boolean pressed) { 7147 } 7148 7149 /** 7150 * Indicates whether the view is currently in pressed state. Unless 7151 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 7152 * the pressed state. 7153 * 7154 * @see #setPressed(boolean) 7155 * @see #isClickable() 7156 * @see #setClickable(boolean) 7157 * 7158 * @return true if the view is currently pressed, false otherwise 7159 */ 7160 @ViewDebug.ExportedProperty 7161 public boolean isPressed() { 7162 return (mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED; 7163 } 7164 7165 /** 7166 * Indicates whether this view will save its state (that is, 7167 * whether its {@link #onSaveInstanceState} method will be called). 7168 * 7169 * @return Returns true if the view state saving is enabled, else false. 7170 * 7171 * @see #setSaveEnabled(boolean) 7172 * @attr ref android.R.styleable#View_saveEnabled 7173 */ 7174 public boolean isSaveEnabled() { 7175 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 7176 } 7177 7178 /** 7179 * Controls whether the saving of this view's state is 7180 * enabled (that is, whether its {@link #onSaveInstanceState} method 7181 * will be called). Note that even if freezing is enabled, the 7182 * view still must have an id assigned to it (via {@link #setId(int)}) 7183 * for its state to be saved. This flag can only disable the 7184 * saving of this view; any child views may still have their state saved. 7185 * 7186 * @param enabled Set to false to <em>disable</em> state saving, or true 7187 * (the default) to allow it. 7188 * 7189 * @see #isSaveEnabled() 7190 * @see #setId(int) 7191 * @see #onSaveInstanceState() 7192 * @attr ref android.R.styleable#View_saveEnabled 7193 */ 7194 public void setSaveEnabled(boolean enabled) { 7195 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 7196 } 7197 7198 /** 7199 * Gets whether the framework should discard touches when the view's 7200 * window is obscured by another visible window. 7201 * Refer to the {@link View} security documentation for more details. 7202 * 7203 * @return True if touch filtering is enabled. 7204 * 7205 * @see #setFilterTouchesWhenObscured(boolean) 7206 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7207 */ 7208 @ViewDebug.ExportedProperty 7209 public boolean getFilterTouchesWhenObscured() { 7210 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 7211 } 7212 7213 /** 7214 * Sets whether the framework should discard touches when the view's 7215 * window is obscured by another visible window. 7216 * Refer to the {@link View} security documentation for more details. 7217 * 7218 * @param enabled True if touch filtering should be enabled. 7219 * 7220 * @see #getFilterTouchesWhenObscured 7221 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 7222 */ 7223 public void setFilterTouchesWhenObscured(boolean enabled) { 7224 setFlags(enabled ? FILTER_TOUCHES_WHEN_OBSCURED : 0, 7225 FILTER_TOUCHES_WHEN_OBSCURED); 7226 } 7227 7228 /** 7229 * Indicates whether the entire hierarchy under this view will save its 7230 * state when a state saving traversal occurs from its parent. The default 7231 * is true; if false, these views will not be saved unless 7232 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7233 * 7234 * @return Returns true if the view state saving from parent is enabled, else false. 7235 * 7236 * @see #setSaveFromParentEnabled(boolean) 7237 */ 7238 public boolean isSaveFromParentEnabled() { 7239 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 7240 } 7241 7242 /** 7243 * Controls whether the entire hierarchy under this view will save its 7244 * state when a state saving traversal occurs from its parent. The default 7245 * is true; if false, these views will not be saved unless 7246 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 7247 * 7248 * @param enabled Set to false to <em>disable</em> state saving, or true 7249 * (the default) to allow it. 7250 * 7251 * @see #isSaveFromParentEnabled() 7252 * @see #setId(int) 7253 * @see #onSaveInstanceState() 7254 */ 7255 public void setSaveFromParentEnabled(boolean enabled) { 7256 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 7257 } 7258 7259 7260 /** 7261 * Returns whether this View is able to take focus. 7262 * 7263 * @return True if this view can take focus, or false otherwise. 7264 * @attr ref android.R.styleable#View_focusable 7265 */ 7266 @ViewDebug.ExportedProperty(category = "focus") 7267 public final boolean isFocusable() { 7268 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 7269 } 7270 7271 /** 7272 * When a view is focusable, it may not want to take focus when in touch mode. 7273 * For example, a button would like focus when the user is navigating via a D-pad 7274 * so that the user can click on it, but once the user starts touching the screen, 7275 * the button shouldn't take focus 7276 * @return Whether the view is focusable in touch mode. 7277 * @attr ref android.R.styleable#View_focusableInTouchMode 7278 */ 7279 @ViewDebug.ExportedProperty 7280 public final boolean isFocusableInTouchMode() { 7281 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 7282 } 7283 7284 /** 7285 * Find the nearest view in the specified direction that can take focus. 7286 * This does not actually give focus to that view. 7287 * 7288 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7289 * 7290 * @return The nearest focusable in the specified direction, or null if none 7291 * can be found. 7292 */ 7293 public View focusSearch(@FocusRealDirection int direction) { 7294 if (mParent != null) { 7295 return mParent.focusSearch(this, direction); 7296 } else { 7297 return null; 7298 } 7299 } 7300 7301 /** 7302 * This method is the last chance for the focused view and its ancestors to 7303 * respond to an arrow key. This is called when the focused view did not 7304 * consume the key internally, nor could the view system find a new view in 7305 * the requested direction to give focus to. 7306 * 7307 * @param focused The currently focused view. 7308 * @param direction The direction focus wants to move. One of FOCUS_UP, 7309 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 7310 * @return True if the this view consumed this unhandled move. 7311 */ 7312 public boolean dispatchUnhandledMove(View focused, @FocusRealDirection int direction) { 7313 return false; 7314 } 7315 7316 /** 7317 * If a user manually specified the next view id for a particular direction, 7318 * use the root to look up the view. 7319 * @param root The root view of the hierarchy containing this view. 7320 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 7321 * or FOCUS_BACKWARD. 7322 * @return The user specified next view, or null if there is none. 7323 */ 7324 View findUserSetNextFocus(View root, @FocusDirection int direction) { 7325 switch (direction) { 7326 case FOCUS_LEFT: 7327 if (mNextFocusLeftId == View.NO_ID) return null; 7328 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 7329 case FOCUS_RIGHT: 7330 if (mNextFocusRightId == View.NO_ID) return null; 7331 return findViewInsideOutShouldExist(root, mNextFocusRightId); 7332 case FOCUS_UP: 7333 if (mNextFocusUpId == View.NO_ID) return null; 7334 return findViewInsideOutShouldExist(root, mNextFocusUpId); 7335 case FOCUS_DOWN: 7336 if (mNextFocusDownId == View.NO_ID) return null; 7337 return findViewInsideOutShouldExist(root, mNextFocusDownId); 7338 case FOCUS_FORWARD: 7339 if (mNextFocusForwardId == View.NO_ID) return null; 7340 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 7341 case FOCUS_BACKWARD: { 7342 if (mID == View.NO_ID) return null; 7343 final int id = mID; 7344 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 7345 @Override 7346 public boolean apply(View t) { 7347 return t.mNextFocusForwardId == id; 7348 } 7349 }); 7350 } 7351 } 7352 return null; 7353 } 7354 7355 private View findViewInsideOutShouldExist(View root, int id) { 7356 if (mMatchIdPredicate == null) { 7357 mMatchIdPredicate = new MatchIdPredicate(); 7358 } 7359 mMatchIdPredicate.mId = id; 7360 View result = root.findViewByPredicateInsideOut(this, mMatchIdPredicate); 7361 if (result == null) { 7362 Log.w(VIEW_LOG_TAG, "couldn't find view with id " + id); 7363 } 7364 return result; 7365 } 7366 7367 /** 7368 * Find and return all focusable views that are descendants of this view, 7369 * possibly including this view if it is focusable itself. 7370 * 7371 * @param direction The direction of the focus 7372 * @return A list of focusable views 7373 */ 7374 public ArrayList<View> getFocusables(@FocusDirection int direction) { 7375 ArrayList<View> result = new ArrayList<View>(24); 7376 addFocusables(result, direction); 7377 return result; 7378 } 7379 7380 /** 7381 * Add any focusable views that are descendants of this view (possibly 7382 * including this view if it is focusable itself) to views. If we are in touch mode, 7383 * only add views that are also focusable in touch mode. 7384 * 7385 * @param views Focusable views found so far 7386 * @param direction The direction of the focus 7387 */ 7388 public void addFocusables(ArrayList<View> views, @FocusDirection int direction) { 7389 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 7390 } 7391 7392 /** 7393 * Adds any focusable views that are descendants of this view (possibly 7394 * including this view if it is focusable itself) to views. This method 7395 * adds all focusable views regardless if we are in touch mode or 7396 * only views focusable in touch mode if we are in touch mode or 7397 * only views that can take accessibility focus if accessibility is enabeld 7398 * depending on the focusable mode paramater. 7399 * 7400 * @param views Focusable views found so far or null if all we are interested is 7401 * the number of focusables. 7402 * @param direction The direction of the focus. 7403 * @param focusableMode The type of focusables to be added. 7404 * 7405 * @see #FOCUSABLES_ALL 7406 * @see #FOCUSABLES_TOUCH_MODE 7407 */ 7408 public void addFocusables(ArrayList<View> views, @FocusDirection int direction, 7409 @FocusableMode int focusableMode) { 7410 if (views == null) { 7411 return; 7412 } 7413 if (!isFocusable()) { 7414 return; 7415 } 7416 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE 7417 && isInTouchMode() && !isFocusableInTouchMode()) { 7418 return; 7419 } 7420 views.add(this); 7421 } 7422 7423 /** 7424 * Finds the Views that contain given text. The containment is case insensitive. 7425 * The search is performed by either the text that the View renders or the content 7426 * description that describes the view for accessibility purposes and the view does 7427 * not render or both. Clients can specify how the search is to be performed via 7428 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 7429 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 7430 * 7431 * @param outViews The output list of matching Views. 7432 * @param searched The text to match against. 7433 * 7434 * @see #FIND_VIEWS_WITH_TEXT 7435 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 7436 * @see #setContentDescription(CharSequence) 7437 */ 7438 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, 7439 @FindViewFlags int flags) { 7440 if (getAccessibilityNodeProvider() != null) { 7441 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 7442 outViews.add(this); 7443 } 7444 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 7445 && (searched != null && searched.length() > 0) 7446 && (mContentDescription != null && mContentDescription.length() > 0)) { 7447 String searchedLowerCase = searched.toString().toLowerCase(); 7448 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 7449 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 7450 outViews.add(this); 7451 } 7452 } 7453 } 7454 7455 /** 7456 * Find and return all touchable views that are descendants of this view, 7457 * possibly including this view if it is touchable itself. 7458 * 7459 * @return A list of touchable views 7460 */ 7461 public ArrayList<View> getTouchables() { 7462 ArrayList<View> result = new ArrayList<View>(); 7463 addTouchables(result); 7464 return result; 7465 } 7466 7467 /** 7468 * Add any touchable views that are descendants of this view (possibly 7469 * including this view if it is touchable itself) to views. 7470 * 7471 * @param views Touchable views found so far 7472 */ 7473 public void addTouchables(ArrayList<View> views) { 7474 final int viewFlags = mViewFlags; 7475 7476 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 7477 && (viewFlags & ENABLED_MASK) == ENABLED) { 7478 views.add(this); 7479 } 7480 } 7481 7482 /** 7483 * Returns whether this View is accessibility focused. 7484 * 7485 * @return True if this View is accessibility focused. 7486 */ 7487 public boolean isAccessibilityFocused() { 7488 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0; 7489 } 7490 7491 /** 7492 * Call this to try to give accessibility focus to this view. 7493 * 7494 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()} 7495 * returns false or the view is no visible or the view already has accessibility 7496 * focus. 7497 * 7498 * See also {@link #focusSearch(int)}, which is what you call to say that you 7499 * have focus, and you want your parent to look for the next one. 7500 * 7501 * @return Whether this view actually took accessibility focus. 7502 * 7503 * @hide 7504 */ 7505 public boolean requestAccessibilityFocus() { 7506 AccessibilityManager manager = AccessibilityManager.getInstance(mContext); 7507 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) { 7508 return false; 7509 } 7510 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7511 return false; 7512 } 7513 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) == 0) { 7514 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_FOCUSED; 7515 ViewRootImpl viewRootImpl = getViewRootImpl(); 7516 if (viewRootImpl != null) { 7517 viewRootImpl.setAccessibilityFocus(this, null); 7518 } 7519 invalidate(); 7520 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED); 7521 return true; 7522 } 7523 return false; 7524 } 7525 7526 /** 7527 * Call this to try to clear accessibility focus of this view. 7528 * 7529 * See also {@link #focusSearch(int)}, which is what you call to say that you 7530 * have focus, and you want your parent to look for the next one. 7531 * 7532 * @hide 7533 */ 7534 public void clearAccessibilityFocus() { 7535 clearAccessibilityFocusNoCallbacks(); 7536 // Clear the global reference of accessibility focus if this 7537 // view or any of its descendants had accessibility focus. 7538 ViewRootImpl viewRootImpl = getViewRootImpl(); 7539 if (viewRootImpl != null) { 7540 View focusHost = viewRootImpl.getAccessibilityFocusedHost(); 7541 if (focusHost != null && ViewRootImpl.isViewDescendantOf(focusHost, this)) { 7542 viewRootImpl.setAccessibilityFocus(null, null); 7543 } 7544 } 7545 } 7546 7547 private void sendAccessibilityHoverEvent(int eventType) { 7548 // Since we are not delivering to a client accessibility events from not 7549 // important views (unless the clinet request that) we need to fire the 7550 // event from the deepest view exposed to the client. As a consequence if 7551 // the user crosses a not exposed view the client will see enter and exit 7552 // of the exposed predecessor followed by and enter and exit of that same 7553 // predecessor when entering and exiting the not exposed descendant. This 7554 // is fine since the client has a clear idea which view is hovered at the 7555 // price of a couple more events being sent. This is a simple and 7556 // working solution. 7557 View source = this; 7558 while (true) { 7559 if (source.includeForAccessibility()) { 7560 source.sendAccessibilityEvent(eventType); 7561 return; 7562 } 7563 ViewParent parent = source.getParent(); 7564 if (parent instanceof View) { 7565 source = (View) parent; 7566 } else { 7567 return; 7568 } 7569 } 7570 } 7571 7572 /** 7573 * Clears accessibility focus without calling any callback methods 7574 * normally invoked in {@link #clearAccessibilityFocus()}. This method 7575 * is used for clearing accessibility focus when giving this focus to 7576 * another view. 7577 */ 7578 void clearAccessibilityFocusNoCallbacks() { 7579 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) { 7580 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED; 7581 invalidate(); 7582 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED); 7583 } 7584 } 7585 7586 /** 7587 * Call this to try to give focus to a specific view or to one of its 7588 * descendants. 7589 * 7590 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7591 * false), or if it is focusable and it is not focusable in touch mode 7592 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7593 * 7594 * See also {@link #focusSearch(int)}, which is what you call to say that you 7595 * have focus, and you want your parent to look for the next one. 7596 * 7597 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 7598 * {@link #FOCUS_DOWN} and <code>null</code>. 7599 * 7600 * @return Whether this view or one of its descendants actually took focus. 7601 */ 7602 public final boolean requestFocus() { 7603 return requestFocus(View.FOCUS_DOWN); 7604 } 7605 7606 /** 7607 * Call this to try to give focus to a specific view or to one of its 7608 * descendants and give it a hint about what direction focus is heading. 7609 * 7610 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7611 * false), or if it is focusable and it is not focusable in touch mode 7612 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7613 * 7614 * See also {@link #focusSearch(int)}, which is what you call to say that you 7615 * have focus, and you want your parent to look for the next one. 7616 * 7617 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 7618 * <code>null</code> set for the previously focused rectangle. 7619 * 7620 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7621 * @return Whether this view or one of its descendants actually took focus. 7622 */ 7623 public final boolean requestFocus(int direction) { 7624 return requestFocus(direction, null); 7625 } 7626 7627 /** 7628 * Call this to try to give focus to a specific view or to one of its descendants 7629 * and give it hints about the direction and a specific rectangle that the focus 7630 * is coming from. The rectangle can help give larger views a finer grained hint 7631 * about where focus is coming from, and therefore, where to show selection, or 7632 * forward focus change internally. 7633 * 7634 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 7635 * false), or if it is focusable and it is not focusable in touch mode 7636 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 7637 * 7638 * A View will not take focus if it is not visible. 7639 * 7640 * A View will not take focus if one of its parents has 7641 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 7642 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 7643 * 7644 * See also {@link #focusSearch(int)}, which is what you call to say that you 7645 * have focus, and you want your parent to look for the next one. 7646 * 7647 * You may wish to override this method if your custom {@link View} has an internal 7648 * {@link View} that it wishes to forward the request to. 7649 * 7650 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 7651 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 7652 * to give a finer grained hint about where focus is coming from. May be null 7653 * if there is no hint. 7654 * @return Whether this view or one of its descendants actually took focus. 7655 */ 7656 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 7657 return requestFocusNoSearch(direction, previouslyFocusedRect); 7658 } 7659 7660 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) { 7661 // need to be focusable 7662 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 7663 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 7664 return false; 7665 } 7666 7667 // need to be focusable in touch mode if in touch mode 7668 if (isInTouchMode() && 7669 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 7670 return false; 7671 } 7672 7673 // need to not have any parents blocking us 7674 if (hasAncestorThatBlocksDescendantFocus()) { 7675 return false; 7676 } 7677 7678 handleFocusGainInternal(direction, previouslyFocusedRect); 7679 return true; 7680 } 7681 7682 /** 7683 * Call this to try to give focus to a specific view or to one of its descendants. This is a 7684 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 7685 * touch mode to request focus when they are touched. 7686 * 7687 * @return Whether this view or one of its descendants actually took focus. 7688 * 7689 * @see #isInTouchMode() 7690 * 7691 */ 7692 public final boolean requestFocusFromTouch() { 7693 // Leave touch mode if we need to 7694 if (isInTouchMode()) { 7695 ViewRootImpl viewRoot = getViewRootImpl(); 7696 if (viewRoot != null) { 7697 viewRoot.ensureTouchMode(false); 7698 } 7699 } 7700 return requestFocus(View.FOCUS_DOWN); 7701 } 7702 7703 /** 7704 * @return Whether any ancestor of this view blocks descendant focus. 7705 */ 7706 private boolean hasAncestorThatBlocksDescendantFocus() { 7707 final boolean focusableInTouchMode = isFocusableInTouchMode(); 7708 ViewParent ancestor = mParent; 7709 while (ancestor instanceof ViewGroup) { 7710 final ViewGroup vgAncestor = (ViewGroup) ancestor; 7711 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS 7712 || (!focusableInTouchMode && vgAncestor.shouldBlockFocusForTouchscreen())) { 7713 return true; 7714 } else { 7715 ancestor = vgAncestor.getParent(); 7716 } 7717 } 7718 return false; 7719 } 7720 7721 /** 7722 * Gets the mode for determining whether this View is important for accessibility 7723 * which is if it fires accessibility events and if it is reported to 7724 * accessibility services that query the screen. 7725 * 7726 * @return The mode for determining whether a View is important for accessibility. 7727 * 7728 * @attr ref android.R.styleable#View_importantForAccessibility 7729 * 7730 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7731 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7732 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7733 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7734 */ 7735 @ViewDebug.ExportedProperty(category = "accessibility", mapping = { 7736 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, to = "auto"), 7737 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, to = "yes"), 7738 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, to = "no"), 7739 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, 7740 to = "noHideDescendants") 7741 }) 7742 public int getImportantForAccessibility() { 7743 return (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 7744 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 7745 } 7746 7747 /** 7748 * Sets the live region mode for this view. This indicates to accessibility 7749 * services whether they should automatically notify the user about changes 7750 * to the view's content description or text, or to the content descriptions 7751 * or text of the view's children (where applicable). 7752 * <p> 7753 * For example, in a login screen with a TextView that displays an "incorrect 7754 * password" notification, that view should be marked as a live region with 7755 * mode {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7756 * <p> 7757 * To disable change notifications for this view, use 7758 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. This is the default live region 7759 * mode for most views. 7760 * <p> 7761 * To indicate that the user should be notified of changes, use 7762 * {@link #ACCESSIBILITY_LIVE_REGION_POLITE}. 7763 * <p> 7764 * If the view's changes should interrupt ongoing speech and notify the user 7765 * immediately, use {@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE}. 7766 * 7767 * @param mode The live region mode for this view, one of: 7768 * <ul> 7769 * <li>{@link #ACCESSIBILITY_LIVE_REGION_NONE} 7770 * <li>{@link #ACCESSIBILITY_LIVE_REGION_POLITE} 7771 * <li>{@link #ACCESSIBILITY_LIVE_REGION_ASSERTIVE} 7772 * </ul> 7773 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7774 */ 7775 public void setAccessibilityLiveRegion(int mode) { 7776 if (mode != getAccessibilityLiveRegion()) { 7777 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7778 mPrivateFlags2 |= (mode << PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT) 7779 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK; 7780 notifyViewAccessibilityStateChangedIfNeeded( 7781 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7782 } 7783 } 7784 7785 /** 7786 * Gets the live region mode for this View. 7787 * 7788 * @return The live region mode for the view. 7789 * 7790 * @attr ref android.R.styleable#View_accessibilityLiveRegion 7791 * 7792 * @see #setAccessibilityLiveRegion(int) 7793 */ 7794 public int getAccessibilityLiveRegion() { 7795 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_LIVE_REGION_MASK) 7796 >> PFLAG2_ACCESSIBILITY_LIVE_REGION_SHIFT; 7797 } 7798 7799 /** 7800 * Sets how to determine whether this view is important for accessibility 7801 * which is if it fires accessibility events and if it is reported to 7802 * accessibility services that query the screen. 7803 * 7804 * @param mode How to determine whether this view is important for accessibility. 7805 * 7806 * @attr ref android.R.styleable#View_importantForAccessibility 7807 * 7808 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 7809 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 7810 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS 7811 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 7812 */ 7813 public void setImportantForAccessibility(int mode) { 7814 final int oldMode = getImportantForAccessibility(); 7815 if (mode != oldMode) { 7816 // If we're moving between AUTO and another state, we might not need 7817 // to send a subtree changed notification. We'll store the computed 7818 // importance, since we'll need to check it later to make sure. 7819 final boolean maySkipNotify = oldMode == IMPORTANT_FOR_ACCESSIBILITY_AUTO 7820 || mode == IMPORTANT_FOR_ACCESSIBILITY_AUTO; 7821 final boolean oldIncludeForAccessibility = maySkipNotify && includeForAccessibility(); 7822 mPrivateFlags2 &= ~PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7823 mPrivateFlags2 |= (mode << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT) 7824 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 7825 if (!maySkipNotify || oldIncludeForAccessibility != includeForAccessibility()) { 7826 notifySubtreeAccessibilityStateChangedIfNeeded(); 7827 } else { 7828 notifyViewAccessibilityStateChangedIfNeeded( 7829 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 7830 } 7831 } 7832 } 7833 7834 /** 7835 * Computes whether this view should be exposed for accessibility. In 7836 * general, views that are interactive or provide information are exposed 7837 * while views that serve only as containers are hidden. 7838 * <p> 7839 * If an ancestor of this view has importance 7840 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, this method 7841 * returns <code>false</code>. 7842 * <p> 7843 * Otherwise, the value is computed according to the view's 7844 * {@link #getImportantForAccessibility()} value: 7845 * <ol> 7846 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_NO} or 7847 * {@link #IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS}, return <code>false 7848 * </code> 7849 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_YES}, return <code>true</code> 7850 * <li>{@link #IMPORTANT_FOR_ACCESSIBILITY_AUTO}, return <code>true</code> if 7851 * view satisfies any of the following: 7852 * <ul> 7853 * <li>Is actionable, e.g. {@link #isClickable()}, 7854 * {@link #isLongClickable()}, or {@link #isFocusable()} 7855 * <li>Has an {@link AccessibilityDelegate} 7856 * <li>Has an interaction listener, e.g. {@link OnTouchListener}, 7857 * {@link OnKeyListener}, etc. 7858 * <li>Is an accessibility live region, e.g. 7859 * {@link #getAccessibilityLiveRegion()} is not 7860 * {@link #ACCESSIBILITY_LIVE_REGION_NONE}. 7861 * </ul> 7862 * </ol> 7863 * 7864 * @return Whether the view is exposed for accessibility. 7865 * @see #setImportantForAccessibility(int) 7866 * @see #getImportantForAccessibility() 7867 */ 7868 public boolean isImportantForAccessibility() { 7869 final int mode = (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 7870 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 7871 if (mode == IMPORTANT_FOR_ACCESSIBILITY_NO 7872 || mode == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 7873 return false; 7874 } 7875 7876 // Check parent mode to ensure we're not hidden. 7877 ViewParent parent = mParent; 7878 while (parent instanceof View) { 7879 if (((View) parent).getImportantForAccessibility() 7880 == IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS) { 7881 return false; 7882 } 7883 parent = parent.getParent(); 7884 } 7885 7886 return mode == IMPORTANT_FOR_ACCESSIBILITY_YES || isActionableForAccessibility() 7887 || hasListenersForAccessibility() || getAccessibilityNodeProvider() != null 7888 || getAccessibilityLiveRegion() != ACCESSIBILITY_LIVE_REGION_NONE; 7889 } 7890 7891 /** 7892 * Gets the parent for accessibility purposes. Note that the parent for 7893 * accessibility is not necessary the immediate parent. It is the first 7894 * predecessor that is important for accessibility. 7895 * 7896 * @return The parent for accessibility purposes. 7897 */ 7898 public ViewParent getParentForAccessibility() { 7899 if (mParent instanceof View) { 7900 View parentView = (View) mParent; 7901 if (parentView.includeForAccessibility()) { 7902 return mParent; 7903 } else { 7904 return mParent.getParentForAccessibility(); 7905 } 7906 } 7907 return null; 7908 } 7909 7910 /** 7911 * Adds the children of a given View for accessibility. Since some Views are 7912 * not important for accessibility the children for accessibility are not 7913 * necessarily direct children of the view, rather they are the first level of 7914 * descendants important for accessibility. 7915 * 7916 * @param children The list of children for accessibility. 7917 */ 7918 public void addChildrenForAccessibility(ArrayList<View> children) { 7919 7920 } 7921 7922 /** 7923 * Whether to regard this view for accessibility. A view is regarded for 7924 * accessibility if it is important for accessibility or the querying 7925 * accessibility service has explicitly requested that view not 7926 * important for accessibility are regarded. 7927 * 7928 * @return Whether to regard the view for accessibility. 7929 * 7930 * @hide 7931 */ 7932 public boolean includeForAccessibility() { 7933 if (mAttachInfo != null) { 7934 return (mAttachInfo.mAccessibilityFetchFlags 7935 & AccessibilityNodeInfo.FLAG_INCLUDE_NOT_IMPORTANT_VIEWS) != 0 7936 || isImportantForAccessibility(); 7937 } 7938 return false; 7939 } 7940 7941 /** 7942 * Returns whether the View is considered actionable from 7943 * accessibility perspective. Such view are important for 7944 * accessibility. 7945 * 7946 * @return True if the view is actionable for accessibility. 7947 * 7948 * @hide 7949 */ 7950 public boolean isActionableForAccessibility() { 7951 return (isClickable() || isLongClickable() || isFocusable()); 7952 } 7953 7954 /** 7955 * Returns whether the View has registered callbacks which makes it 7956 * important for accessibility. 7957 * 7958 * @return True if the view is actionable for accessibility. 7959 */ 7960 private boolean hasListenersForAccessibility() { 7961 ListenerInfo info = getListenerInfo(); 7962 return mTouchDelegate != null || info.mOnKeyListener != null 7963 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null 7964 || info.mOnHoverListener != null || info.mOnDragListener != null; 7965 } 7966 7967 /** 7968 * Notifies that the accessibility state of this view changed. The change 7969 * is local to this view and does not represent structural changes such 7970 * as children and parent. For example, the view became focusable. The 7971 * notification is at at most once every 7972 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 7973 * to avoid unnecessary load to the system. Also once a view has a pending 7974 * notification this method is a NOP until the notification has been sent. 7975 * 7976 * @hide 7977 */ 7978 public void notifyViewAccessibilityStateChangedIfNeeded(int changeType) { 7979 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 7980 return; 7981 } 7982 if (mSendViewStateChangedAccessibilityEvent == null) { 7983 mSendViewStateChangedAccessibilityEvent = 7984 new SendViewStateChangedAccessibilityEvent(); 7985 } 7986 mSendViewStateChangedAccessibilityEvent.runOrPost(changeType); 7987 } 7988 7989 /** 7990 * Notifies that the accessibility state of this view changed. The change 7991 * is *not* local to this view and does represent structural changes such 7992 * as children and parent. For example, the view size changed. The 7993 * notification is at at most once every 7994 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 7995 * to avoid unnecessary load to the system. Also once a view has a pending 7996 * notification this method is a NOP until the notification has been sent. 7997 * 7998 * @hide 7999 */ 8000 public void notifySubtreeAccessibilityStateChangedIfNeeded() { 8001 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 8002 return; 8003 } 8004 if ((mPrivateFlags2 & PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED) == 0) { 8005 mPrivateFlags2 |= PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8006 if (mParent != null) { 8007 try { 8008 mParent.notifySubtreeAccessibilityStateChanged( 8009 this, this, AccessibilityEvent.CONTENT_CHANGE_TYPE_SUBTREE); 8010 } catch (AbstractMethodError e) { 8011 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 8012 " does not fully implement ViewParent", e); 8013 } 8014 } 8015 } 8016 } 8017 8018 /** 8019 * Reset the flag indicating the accessibility state of the subtree rooted 8020 * at this view changed. 8021 */ 8022 void resetSubtreeAccessibilityStateChanged() { 8023 mPrivateFlags2 &= ~PFLAG2_SUBTREE_ACCESSIBILITY_STATE_CHANGED; 8024 } 8025 8026 /** 8027 * Report an accessibility action to this view's parents for delegated processing. 8028 * 8029 * <p>Implementations of {@link #performAccessibilityAction(int, Bundle)} may internally 8030 * call this method to delegate an accessibility action to a supporting parent. If the parent 8031 * returns true from its 8032 * {@link ViewParent#onNestedPrePerformAccessibilityAction(View, int, android.os.Bundle)} 8033 * method this method will return true to signify that the action was consumed.</p> 8034 * 8035 * <p>This method is useful for implementing nested scrolling child views. If 8036 * {@link #isNestedScrollingEnabled()} returns true and the action is a scrolling action 8037 * a custom view implementation may invoke this method to allow a parent to consume the 8038 * scroll first. If this method returns true the custom view should skip its own scrolling 8039 * behavior.</p> 8040 * 8041 * @param action Accessibility action to delegate 8042 * @param arguments Optional action arguments 8043 * @return true if the action was consumed by a parent 8044 */ 8045 public boolean dispatchNestedPrePerformAccessibilityAction(int action, Bundle arguments) { 8046 for (ViewParent p = getParent(); p != null; p = p.getParent()) { 8047 if (p.onNestedPrePerformAccessibilityAction(this, action, arguments)) { 8048 return true; 8049 } 8050 } 8051 return false; 8052 } 8053 8054 /** 8055 * Performs the specified accessibility action on the view. For 8056 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 8057 * <p> 8058 * If an {@link AccessibilityDelegate} has been specified via calling 8059 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 8060 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)} 8061 * is responsible for handling this call. 8062 * </p> 8063 * 8064 * <p>The default implementation will delegate 8065 * {@link AccessibilityNodeInfo#ACTION_SCROLL_BACKWARD} and 8066 * {@link AccessibilityNodeInfo#ACTION_SCROLL_FORWARD} to nested scrolling parents if 8067 * {@link #isNestedScrollingEnabled() nested scrolling is enabled} on this view.</p> 8068 * 8069 * @param action The action to perform. 8070 * @param arguments Optional action arguments. 8071 * @return Whether the action was performed. 8072 */ 8073 public boolean performAccessibilityAction(int action, Bundle arguments) { 8074 if (mAccessibilityDelegate != null) { 8075 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments); 8076 } else { 8077 return performAccessibilityActionInternal(action, arguments); 8078 } 8079 } 8080 8081 /** 8082 * @see #performAccessibilityAction(int, Bundle) 8083 * 8084 * Note: Called from the default {@link AccessibilityDelegate}. 8085 * 8086 * @hide Until we've refactored all accessibility delegation methods. 8087 */ 8088 public boolean performAccessibilityActionInternal(int action, Bundle arguments) { 8089 if (isNestedScrollingEnabled() 8090 && (action == AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD 8091 || action == AccessibilityNodeInfo.ACTION_SCROLL_FORWARD)) { 8092 if (dispatchNestedPrePerformAccessibilityAction(action, arguments)) { 8093 return true; 8094 } 8095 } 8096 8097 switch (action) { 8098 case AccessibilityNodeInfo.ACTION_CLICK: { 8099 if (isClickable()) { 8100 performClick(); 8101 return true; 8102 } 8103 } break; 8104 case AccessibilityNodeInfo.ACTION_LONG_CLICK: { 8105 if (isLongClickable()) { 8106 performLongClick(); 8107 return true; 8108 } 8109 } break; 8110 case AccessibilityNodeInfo.ACTION_FOCUS: { 8111 if (!hasFocus()) { 8112 // Get out of touch mode since accessibility 8113 // wants to move focus around. 8114 getViewRootImpl().ensureTouchMode(false); 8115 return requestFocus(); 8116 } 8117 } break; 8118 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: { 8119 if (hasFocus()) { 8120 clearFocus(); 8121 return !isFocused(); 8122 } 8123 } break; 8124 case AccessibilityNodeInfo.ACTION_SELECT: { 8125 if (!isSelected()) { 8126 setSelected(true); 8127 return isSelected(); 8128 } 8129 } break; 8130 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: { 8131 if (isSelected()) { 8132 setSelected(false); 8133 return !isSelected(); 8134 } 8135 } break; 8136 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: { 8137 if (!isAccessibilityFocused()) { 8138 return requestAccessibilityFocus(); 8139 } 8140 } break; 8141 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: { 8142 if (isAccessibilityFocused()) { 8143 clearAccessibilityFocus(); 8144 return true; 8145 } 8146 } break; 8147 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: { 8148 if (arguments != null) { 8149 final int granularity = arguments.getInt( 8150 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8151 final boolean extendSelection = arguments.getBoolean( 8152 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8153 return traverseAtGranularity(granularity, true, extendSelection); 8154 } 8155 } break; 8156 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: { 8157 if (arguments != null) { 8158 final int granularity = arguments.getInt( 8159 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 8160 final boolean extendSelection = arguments.getBoolean( 8161 AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN); 8162 return traverseAtGranularity(granularity, false, extendSelection); 8163 } 8164 } break; 8165 case AccessibilityNodeInfo.ACTION_SET_SELECTION: { 8166 CharSequence text = getIterableTextForAccessibility(); 8167 if (text == null) { 8168 return false; 8169 } 8170 final int start = (arguments != null) ? arguments.getInt( 8171 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_START_INT, -1) : -1; 8172 final int end = (arguments != null) ? arguments.getInt( 8173 AccessibilityNodeInfo.ACTION_ARGUMENT_SELECTION_END_INT, -1) : -1; 8174 // Only cursor position can be specified (selection length == 0) 8175 if ((getAccessibilitySelectionStart() != start 8176 || getAccessibilitySelectionEnd() != end) 8177 && (start == end)) { 8178 setAccessibilitySelection(start, end); 8179 notifyViewAccessibilityStateChangedIfNeeded( 8180 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 8181 return true; 8182 } 8183 } break; 8184 } 8185 return false; 8186 } 8187 8188 private boolean traverseAtGranularity(int granularity, boolean forward, 8189 boolean extendSelection) { 8190 CharSequence text = getIterableTextForAccessibility(); 8191 if (text == null || text.length() == 0) { 8192 return false; 8193 } 8194 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 8195 if (iterator == null) { 8196 return false; 8197 } 8198 int current = getAccessibilitySelectionEnd(); 8199 if (current == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8200 current = forward ? 0 : text.length(); 8201 } 8202 final int[] range = forward ? iterator.following(current) : iterator.preceding(current); 8203 if (range == null) { 8204 return false; 8205 } 8206 final int segmentStart = range[0]; 8207 final int segmentEnd = range[1]; 8208 int selectionStart; 8209 int selectionEnd; 8210 if (extendSelection && isAccessibilitySelectionExtendable()) { 8211 selectionStart = getAccessibilitySelectionStart(); 8212 if (selectionStart == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 8213 selectionStart = forward ? segmentStart : segmentEnd; 8214 } 8215 selectionEnd = forward ? segmentEnd : segmentStart; 8216 } else { 8217 selectionStart = selectionEnd= forward ? segmentEnd : segmentStart; 8218 } 8219 setAccessibilitySelection(selectionStart, selectionEnd); 8220 final int action = forward ? AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY 8221 : AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY; 8222 sendViewTextTraversedAtGranularityEvent(action, granularity, segmentStart, segmentEnd); 8223 return true; 8224 } 8225 8226 /** 8227 * Gets the text reported for accessibility purposes. 8228 * 8229 * @return The accessibility text. 8230 * 8231 * @hide 8232 */ 8233 public CharSequence getIterableTextForAccessibility() { 8234 return getContentDescription(); 8235 } 8236 8237 /** 8238 * Gets whether accessibility selection can be extended. 8239 * 8240 * @return If selection is extensible. 8241 * 8242 * @hide 8243 */ 8244 public boolean isAccessibilitySelectionExtendable() { 8245 return false; 8246 } 8247 8248 /** 8249 * @hide 8250 */ 8251 public int getAccessibilitySelectionStart() { 8252 return mAccessibilityCursorPosition; 8253 } 8254 8255 /** 8256 * @hide 8257 */ 8258 public int getAccessibilitySelectionEnd() { 8259 return getAccessibilitySelectionStart(); 8260 } 8261 8262 /** 8263 * @hide 8264 */ 8265 public void setAccessibilitySelection(int start, int end) { 8266 if (start == end && end == mAccessibilityCursorPosition) { 8267 return; 8268 } 8269 if (start >= 0 && start == end && end <= getIterableTextForAccessibility().length()) { 8270 mAccessibilityCursorPosition = start; 8271 } else { 8272 mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED; 8273 } 8274 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED); 8275 } 8276 8277 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity, 8278 int fromIndex, int toIndex) { 8279 if (mParent == null) { 8280 return; 8281 } 8282 AccessibilityEvent event = AccessibilityEvent.obtain( 8283 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY); 8284 onInitializeAccessibilityEvent(event); 8285 onPopulateAccessibilityEvent(event); 8286 event.setFromIndex(fromIndex); 8287 event.setToIndex(toIndex); 8288 event.setAction(action); 8289 event.setMovementGranularity(granularity); 8290 mParent.requestSendAccessibilityEvent(this, event); 8291 } 8292 8293 /** 8294 * @hide 8295 */ 8296 public TextSegmentIterator getIteratorForGranularity(int granularity) { 8297 switch (granularity) { 8298 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: { 8299 CharSequence text = getIterableTextForAccessibility(); 8300 if (text != null && text.length() > 0) { 8301 CharacterTextSegmentIterator iterator = 8302 CharacterTextSegmentIterator.getInstance( 8303 mContext.getResources().getConfiguration().locale); 8304 iterator.initialize(text.toString()); 8305 return iterator; 8306 } 8307 } break; 8308 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: { 8309 CharSequence text = getIterableTextForAccessibility(); 8310 if (text != null && text.length() > 0) { 8311 WordTextSegmentIterator iterator = 8312 WordTextSegmentIterator.getInstance( 8313 mContext.getResources().getConfiguration().locale); 8314 iterator.initialize(text.toString()); 8315 return iterator; 8316 } 8317 } break; 8318 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: { 8319 CharSequence text = getIterableTextForAccessibility(); 8320 if (text != null && text.length() > 0) { 8321 ParagraphTextSegmentIterator iterator = 8322 ParagraphTextSegmentIterator.getInstance(); 8323 iterator.initialize(text.toString()); 8324 return iterator; 8325 } 8326 } break; 8327 } 8328 return null; 8329 } 8330 8331 /** 8332 * @hide 8333 */ 8334 public void dispatchStartTemporaryDetach() { 8335 onStartTemporaryDetach(); 8336 } 8337 8338 /** 8339 * This is called when a container is going to temporarily detach a child, with 8340 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 8341 * It will either be followed by {@link #onFinishTemporaryDetach()} or 8342 * {@link #onDetachedFromWindow()} when the container is done. 8343 */ 8344 public void onStartTemporaryDetach() { 8345 removeUnsetPressCallback(); 8346 mPrivateFlags |= PFLAG_CANCEL_NEXT_UP_EVENT; 8347 } 8348 8349 /** 8350 * @hide 8351 */ 8352 public void dispatchFinishTemporaryDetach() { 8353 onFinishTemporaryDetach(); 8354 } 8355 8356 /** 8357 * Called after {@link #onStartTemporaryDetach} when the container is done 8358 * changing the view. 8359 */ 8360 public void onFinishTemporaryDetach() { 8361 } 8362 8363 /** 8364 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 8365 * for this view's window. Returns null if the view is not currently attached 8366 * to the window. Normally you will not need to use this directly, but 8367 * just use the standard high-level event callbacks like 8368 * {@link #onKeyDown(int, KeyEvent)}. 8369 */ 8370 public KeyEvent.DispatcherState getKeyDispatcherState() { 8371 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 8372 } 8373 8374 /** 8375 * Dispatch a key event before it is processed by any input method 8376 * associated with the view hierarchy. This can be used to intercept 8377 * key events in special situations before the IME consumes them; a 8378 * typical example would be handling the BACK key to update the application's 8379 * UI instead of allowing the IME to see it and close itself. 8380 * 8381 * @param event The key event to be dispatched. 8382 * @return True if the event was handled, false otherwise. 8383 */ 8384 public boolean dispatchKeyEventPreIme(KeyEvent event) { 8385 return onKeyPreIme(event.getKeyCode(), event); 8386 } 8387 8388 /** 8389 * Dispatch a key event to the next view on the focus path. This path runs 8390 * from the top of the view tree down to the currently focused view. If this 8391 * view has focus, it will dispatch to itself. Otherwise it will dispatch 8392 * the next node down the focus path. This method also fires any key 8393 * listeners. 8394 * 8395 * @param event The key event to be dispatched. 8396 * @return True if the event was handled, false otherwise. 8397 */ 8398 public boolean dispatchKeyEvent(KeyEvent event) { 8399 if (mInputEventConsistencyVerifier != null) { 8400 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 8401 } 8402 8403 // Give any attached key listener a first crack at the event. 8404 //noinspection SimplifiableIfStatement 8405 ListenerInfo li = mListenerInfo; 8406 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 8407 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 8408 return true; 8409 } 8410 8411 if (event.dispatch(this, mAttachInfo != null 8412 ? mAttachInfo.mKeyDispatchState : null, this)) { 8413 return true; 8414 } 8415 8416 if (mInputEventConsistencyVerifier != null) { 8417 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8418 } 8419 return false; 8420 } 8421 8422 /** 8423 * Dispatches a key shortcut event. 8424 * 8425 * @param event The key event to be dispatched. 8426 * @return True if the event was handled by the view, false otherwise. 8427 */ 8428 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 8429 return onKeyShortcut(event.getKeyCode(), event); 8430 } 8431 8432 /** 8433 * Pass the touch screen motion event down to the target view, or this 8434 * view if it is the target. 8435 * 8436 * @param event The motion event to be dispatched. 8437 * @return True if the event was handled by the view, false otherwise. 8438 */ 8439 public boolean dispatchTouchEvent(MotionEvent event) { 8440 // If the event should be handled by accessibility focus first. 8441 if (event.isTargetAccessibilityFocus()) { 8442 // We don't have focus or no virtual descendant has it, do not handle the event. 8443 if (!isAccessibilityFocused() && !(getViewRootImpl() != null && getViewRootImpl() 8444 .getAccessibilityFocusedHost() == this)) { 8445 return false; 8446 } 8447 // We have focus and got the event, then use normal event dispatch. 8448 event.setTargetAccessibilityFocus(false); 8449 } 8450 8451 boolean result = false; 8452 8453 if (mInputEventConsistencyVerifier != null) { 8454 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 8455 } 8456 8457 final int actionMasked = event.getActionMasked(); 8458 if (actionMasked == MotionEvent.ACTION_DOWN) { 8459 // Defensive cleanup for new gesture 8460 stopNestedScroll(); 8461 } 8462 8463 if (onFilterTouchEventForSecurity(event)) { 8464 //noinspection SimplifiableIfStatement 8465 ListenerInfo li = mListenerInfo; 8466 if (li != null && li.mOnTouchListener != null 8467 && (mViewFlags & ENABLED_MASK) == ENABLED 8468 && li.mOnTouchListener.onTouch(this, event)) { 8469 result = true; 8470 } 8471 8472 if (!result && onTouchEvent(event)) { 8473 result = true; 8474 } 8475 } 8476 8477 if (!result && mInputEventConsistencyVerifier != null) { 8478 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8479 } 8480 8481 // Clean up after nested scrolls if this is the end of a gesture; 8482 // also cancel it if we tried an ACTION_DOWN but we didn't want the rest 8483 // of the gesture. 8484 if (actionMasked == MotionEvent.ACTION_UP || 8485 actionMasked == MotionEvent.ACTION_CANCEL || 8486 (actionMasked == MotionEvent.ACTION_DOWN && !result)) { 8487 stopNestedScroll(); 8488 } 8489 8490 return result; 8491 } 8492 8493 /** 8494 * Filter the touch event to apply security policies. 8495 * 8496 * @param event The motion event to be filtered. 8497 * @return True if the event should be dispatched, false if the event should be dropped. 8498 * 8499 * @see #getFilterTouchesWhenObscured 8500 */ 8501 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 8502 //noinspection RedundantIfStatement 8503 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 8504 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 8505 // Window is obscured, drop this touch. 8506 return false; 8507 } 8508 return true; 8509 } 8510 8511 /** 8512 * Pass a trackball motion event down to the focused view. 8513 * 8514 * @param event The motion event to be dispatched. 8515 * @return True if the event was handled by the view, false otherwise. 8516 */ 8517 public boolean dispatchTrackballEvent(MotionEvent event) { 8518 if (mInputEventConsistencyVerifier != null) { 8519 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 8520 } 8521 8522 return onTrackballEvent(event); 8523 } 8524 8525 /** 8526 * Dispatch a generic motion event. 8527 * <p> 8528 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 8529 * are delivered to the view under the pointer. All other generic motion events are 8530 * delivered to the focused view. Hover events are handled specially and are delivered 8531 * to {@link #onHoverEvent(MotionEvent)}. 8532 * </p> 8533 * 8534 * @param event The motion event to be dispatched. 8535 * @return True if the event was handled by the view, false otherwise. 8536 */ 8537 public boolean dispatchGenericMotionEvent(MotionEvent event) { 8538 if (mInputEventConsistencyVerifier != null) { 8539 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 8540 } 8541 8542 final int source = event.getSource(); 8543 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 8544 final int action = event.getAction(); 8545 if (action == MotionEvent.ACTION_HOVER_ENTER 8546 || action == MotionEvent.ACTION_HOVER_MOVE 8547 || action == MotionEvent.ACTION_HOVER_EXIT) { 8548 if (dispatchHoverEvent(event)) { 8549 return true; 8550 } 8551 } else if (dispatchGenericPointerEvent(event)) { 8552 return true; 8553 } 8554 } else if (dispatchGenericFocusedEvent(event)) { 8555 return true; 8556 } 8557 8558 if (dispatchGenericMotionEventInternal(event)) { 8559 return true; 8560 } 8561 8562 if (mInputEventConsistencyVerifier != null) { 8563 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8564 } 8565 return false; 8566 } 8567 8568 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 8569 //noinspection SimplifiableIfStatement 8570 ListenerInfo li = mListenerInfo; 8571 if (li != null && li.mOnGenericMotionListener != null 8572 && (mViewFlags & ENABLED_MASK) == ENABLED 8573 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 8574 return true; 8575 } 8576 8577 if (onGenericMotionEvent(event)) { 8578 return true; 8579 } 8580 8581 if (mInputEventConsistencyVerifier != null) { 8582 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 8583 } 8584 return false; 8585 } 8586 8587 /** 8588 * Dispatch a hover event. 8589 * <p> 8590 * Do not call this method directly. 8591 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8592 * </p> 8593 * 8594 * @param event The motion event to be dispatched. 8595 * @return True if the event was handled by the view, false otherwise. 8596 */ 8597 protected boolean dispatchHoverEvent(MotionEvent event) { 8598 ListenerInfo li = mListenerInfo; 8599 //noinspection SimplifiableIfStatement 8600 if (li != null && li.mOnHoverListener != null 8601 && (mViewFlags & ENABLED_MASK) == ENABLED 8602 && li.mOnHoverListener.onHover(this, event)) { 8603 return true; 8604 } 8605 8606 return onHoverEvent(event); 8607 } 8608 8609 /** 8610 * Returns true if the view has a child to which it has recently sent 8611 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 8612 * it does not have a hovered child, then it must be the innermost hovered view. 8613 * @hide 8614 */ 8615 protected boolean hasHoveredChild() { 8616 return false; 8617 } 8618 8619 /** 8620 * Dispatch a generic motion event to the view under the first pointer. 8621 * <p> 8622 * Do not call this method directly. 8623 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8624 * </p> 8625 * 8626 * @param event The motion event to be dispatched. 8627 * @return True if the event was handled by the view, false otherwise. 8628 */ 8629 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 8630 return false; 8631 } 8632 8633 /** 8634 * Dispatch a generic motion event to the currently focused view. 8635 * <p> 8636 * Do not call this method directly. 8637 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 8638 * </p> 8639 * 8640 * @param event The motion event to be dispatched. 8641 * @return True if the event was handled by the view, false otherwise. 8642 */ 8643 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 8644 return false; 8645 } 8646 8647 /** 8648 * Dispatch a pointer event. 8649 * <p> 8650 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 8651 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 8652 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 8653 * and should not be expected to handle other pointing device features. 8654 * </p> 8655 * 8656 * @param event The motion event to be dispatched. 8657 * @return True if the event was handled by the view, false otherwise. 8658 * @hide 8659 */ 8660 public final boolean dispatchPointerEvent(MotionEvent event) { 8661 if (event.isTouchEvent()) { 8662 return dispatchTouchEvent(event); 8663 } else { 8664 return dispatchGenericMotionEvent(event); 8665 } 8666 } 8667 8668 /** 8669 * Called when the window containing this view gains or loses window focus. 8670 * ViewGroups should override to route to their children. 8671 * 8672 * @param hasFocus True if the window containing this view now has focus, 8673 * false otherwise. 8674 */ 8675 public void dispatchWindowFocusChanged(boolean hasFocus) { 8676 onWindowFocusChanged(hasFocus); 8677 } 8678 8679 /** 8680 * Called when the window containing this view gains or loses focus. Note 8681 * that this is separate from view focus: to receive key events, both 8682 * your view and its window must have focus. If a window is displayed 8683 * on top of yours that takes input focus, then your own window will lose 8684 * focus but the view focus will remain unchanged. 8685 * 8686 * @param hasWindowFocus True if the window containing this view now has 8687 * focus, false otherwise. 8688 */ 8689 public void onWindowFocusChanged(boolean hasWindowFocus) { 8690 InputMethodManager imm = InputMethodManager.peekInstance(); 8691 if (!hasWindowFocus) { 8692 if (isPressed()) { 8693 setPressed(false); 8694 } 8695 if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8696 imm.focusOut(this); 8697 } 8698 removeLongPressCallback(); 8699 removeTapCallback(); 8700 onFocusLost(); 8701 } else if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 8702 imm.focusIn(this); 8703 } 8704 refreshDrawableState(); 8705 } 8706 8707 /** 8708 * Returns true if this view is in a window that currently has window focus. 8709 * Note that this is not the same as the view itself having focus. 8710 * 8711 * @return True if this view is in a window that currently has window focus. 8712 */ 8713 public boolean hasWindowFocus() { 8714 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 8715 } 8716 8717 /** 8718 * Dispatch a view visibility change down the view hierarchy. 8719 * ViewGroups should override to route to their children. 8720 * @param changedView The view whose visibility changed. Could be 'this' or 8721 * an ancestor view. 8722 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8723 * {@link #INVISIBLE} or {@link #GONE}. 8724 */ 8725 protected void dispatchVisibilityChanged(@NonNull View changedView, 8726 @Visibility int visibility) { 8727 onVisibilityChanged(changedView, visibility); 8728 } 8729 8730 /** 8731 * Called when the visibility of the view or an ancestor of the view is changed. 8732 * @param changedView The view whose visibility changed. Could be 'this' or 8733 * an ancestor view. 8734 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 8735 * {@link #INVISIBLE} or {@link #GONE}. 8736 */ 8737 protected void onVisibilityChanged(@NonNull View changedView, @Visibility int visibility) { 8738 if (visibility == VISIBLE) { 8739 if (mAttachInfo != null) { 8740 initialAwakenScrollBars(); 8741 } else { 8742 mPrivateFlags |= PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 8743 } 8744 } 8745 } 8746 8747 /** 8748 * Dispatch a hint about whether this view is displayed. For instance, when 8749 * a View moves out of the screen, it might receives a display hint indicating 8750 * the view is not displayed. Applications should not <em>rely</em> on this hint 8751 * as there is no guarantee that they will receive one. 8752 * 8753 * @param hint A hint about whether or not this view is displayed: 8754 * {@link #VISIBLE} or {@link #INVISIBLE}. 8755 */ 8756 public void dispatchDisplayHint(@Visibility int hint) { 8757 onDisplayHint(hint); 8758 } 8759 8760 /** 8761 * Gives this view a hint about whether is displayed or not. For instance, when 8762 * a View moves out of the screen, it might receives a display hint indicating 8763 * the view is not displayed. Applications should not <em>rely</em> on this hint 8764 * as there is no guarantee that they will receive one. 8765 * 8766 * @param hint A hint about whether or not this view is displayed: 8767 * {@link #VISIBLE} or {@link #INVISIBLE}. 8768 */ 8769 protected void onDisplayHint(@Visibility int hint) { 8770 } 8771 8772 /** 8773 * Dispatch a window visibility change down the view hierarchy. 8774 * ViewGroups should override to route to their children. 8775 * 8776 * @param visibility The new visibility of the window. 8777 * 8778 * @see #onWindowVisibilityChanged(int) 8779 */ 8780 public void dispatchWindowVisibilityChanged(@Visibility int visibility) { 8781 onWindowVisibilityChanged(visibility); 8782 } 8783 8784 /** 8785 * Called when the window containing has change its visibility 8786 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 8787 * that this tells you whether or not your window is being made visible 8788 * to the window manager; this does <em>not</em> tell you whether or not 8789 * your window is obscured by other windows on the screen, even if it 8790 * is itself visible. 8791 * 8792 * @param visibility The new visibility of the window. 8793 */ 8794 protected void onWindowVisibilityChanged(@Visibility int visibility) { 8795 if (visibility == VISIBLE) { 8796 initialAwakenScrollBars(); 8797 } 8798 } 8799 8800 /** 8801 * Returns the current visibility of the window this view is attached to 8802 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 8803 * 8804 * @return Returns the current visibility of the view's window. 8805 */ 8806 @Visibility 8807 public int getWindowVisibility() { 8808 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 8809 } 8810 8811 /** 8812 * Retrieve the overall visible display size in which the window this view is 8813 * attached to has been positioned in. This takes into account screen 8814 * decorations above the window, for both cases where the window itself 8815 * is being position inside of them or the window is being placed under 8816 * then and covered insets are used for the window to position its content 8817 * inside. In effect, this tells you the available area where content can 8818 * be placed and remain visible to users. 8819 * 8820 * <p>This function requires an IPC back to the window manager to retrieve 8821 * the requested information, so should not be used in performance critical 8822 * code like drawing. 8823 * 8824 * @param outRect Filled in with the visible display frame. If the view 8825 * is not attached to a window, this is simply the raw display size. 8826 */ 8827 public void getWindowVisibleDisplayFrame(Rect outRect) { 8828 if (mAttachInfo != null) { 8829 try { 8830 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 8831 } catch (RemoteException e) { 8832 return; 8833 } 8834 // XXX This is really broken, and probably all needs to be done 8835 // in the window manager, and we need to know more about whether 8836 // we want the area behind or in front of the IME. 8837 final Rect insets = mAttachInfo.mVisibleInsets; 8838 outRect.left += insets.left; 8839 outRect.top += insets.top; 8840 outRect.right -= insets.right; 8841 outRect.bottom -= insets.bottom; 8842 return; 8843 } 8844 // The view is not attached to a display so we don't have a context. 8845 // Make a best guess about the display size. 8846 Display d = DisplayManagerGlobal.getInstance().getRealDisplay(Display.DEFAULT_DISPLAY); 8847 d.getRectSize(outRect); 8848 } 8849 8850 /** 8851 * Dispatch a notification about a resource configuration change down 8852 * the view hierarchy. 8853 * ViewGroups should override to route to their children. 8854 * 8855 * @param newConfig The new resource configuration. 8856 * 8857 * @see #onConfigurationChanged(android.content.res.Configuration) 8858 */ 8859 public void dispatchConfigurationChanged(Configuration newConfig) { 8860 onConfigurationChanged(newConfig); 8861 } 8862 8863 /** 8864 * Called when the current configuration of the resources being used 8865 * by the application have changed. You can use this to decide when 8866 * to reload resources that can changed based on orientation and other 8867 * configuration characterstics. You only need to use this if you are 8868 * not relying on the normal {@link android.app.Activity} mechanism of 8869 * recreating the activity instance upon a configuration change. 8870 * 8871 * @param newConfig The new resource configuration. 8872 */ 8873 protected void onConfigurationChanged(Configuration newConfig) { 8874 } 8875 8876 /** 8877 * Private function to aggregate all per-view attributes in to the view 8878 * root. 8879 */ 8880 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8881 performCollectViewAttributes(attachInfo, visibility); 8882 } 8883 8884 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) { 8885 if ((visibility & VISIBILITY_MASK) == VISIBLE) { 8886 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 8887 attachInfo.mKeepScreenOn = true; 8888 } 8889 attachInfo.mSystemUiVisibility |= mSystemUiVisibility; 8890 ListenerInfo li = mListenerInfo; 8891 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 8892 attachInfo.mHasSystemUiListeners = true; 8893 } 8894 } 8895 } 8896 8897 void needGlobalAttributesUpdate(boolean force) { 8898 final AttachInfo ai = mAttachInfo; 8899 if (ai != null && !ai.mRecomputeGlobalAttributes) { 8900 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 8901 || ai.mHasSystemUiListeners) { 8902 ai.mRecomputeGlobalAttributes = true; 8903 } 8904 } 8905 } 8906 8907 /** 8908 * Returns whether the device is currently in touch mode. Touch mode is entered 8909 * once the user begins interacting with the device by touch, and affects various 8910 * things like whether focus is always visible to the user. 8911 * 8912 * @return Whether the device is in touch mode. 8913 */ 8914 @ViewDebug.ExportedProperty 8915 public boolean isInTouchMode() { 8916 if (mAttachInfo != null) { 8917 return mAttachInfo.mInTouchMode; 8918 } else { 8919 return ViewRootImpl.isInTouchMode(); 8920 } 8921 } 8922 8923 /** 8924 * Returns the context the view is running in, through which it can 8925 * access the current theme, resources, etc. 8926 * 8927 * @return The view's Context. 8928 */ 8929 @ViewDebug.CapturedViewProperty 8930 public final Context getContext() { 8931 return mContext; 8932 } 8933 8934 /** 8935 * Handle a key event before it is processed by any input method 8936 * associated with the view hierarchy. This can be used to intercept 8937 * key events in special situations before the IME consumes them; a 8938 * typical example would be handling the BACK key to update the application's 8939 * UI instead of allowing the IME to see it and close itself. 8940 * 8941 * @param keyCode The value in event.getKeyCode(). 8942 * @param event Description of the key event. 8943 * @return If you handled the event, return true. If you want to allow the 8944 * event to be handled by the next receiver, return false. 8945 */ 8946 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 8947 return false; 8948 } 8949 8950 /** 8951 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 8952 * KeyEvent.Callback.onKeyDown()}: perform press of the view 8953 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 8954 * is released, if the view is enabled and clickable. 8955 * 8956 * <p>Key presses in software keyboards will generally NOT trigger this listener, 8957 * although some may elect to do so in some situations. Do not rely on this to 8958 * catch software key presses. 8959 * 8960 * @param keyCode A key code that represents the button pressed, from 8961 * {@link android.view.KeyEvent}. 8962 * @param event The KeyEvent object that defines the button action. 8963 */ 8964 public boolean onKeyDown(int keyCode, KeyEvent event) { 8965 boolean result = false; 8966 8967 if (KeyEvent.isConfirmKey(keyCode)) { 8968 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 8969 return true; 8970 } 8971 // Long clickable items don't necessarily have to be clickable 8972 if (((mViewFlags & CLICKABLE) == CLICKABLE || 8973 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 8974 (event.getRepeatCount() == 0)) { 8975 setPressed(true); 8976 checkForLongClick(0); 8977 return true; 8978 } 8979 } 8980 return result; 8981 } 8982 8983 /** 8984 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 8985 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 8986 * the event). 8987 * <p>Key presses in software keyboards will generally NOT trigger this listener, 8988 * although some may elect to do so in some situations. Do not rely on this to 8989 * catch software key presses. 8990 */ 8991 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 8992 return false; 8993 } 8994 8995 /** 8996 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 8997 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 8998 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 8999 * {@link KeyEvent#KEYCODE_ENTER} is released. 9000 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9001 * although some may elect to do so in some situations. Do not rely on this to 9002 * catch software key presses. 9003 * 9004 * @param keyCode A key code that represents the button pressed, from 9005 * {@link android.view.KeyEvent}. 9006 * @param event The KeyEvent object that defines the button action. 9007 */ 9008 public boolean onKeyUp(int keyCode, KeyEvent event) { 9009 if (KeyEvent.isConfirmKey(keyCode)) { 9010 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 9011 return true; 9012 } 9013 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 9014 setPressed(false); 9015 9016 if (!mHasPerformedLongPress) { 9017 // This is a tap, so remove the longpress check 9018 removeLongPressCallback(); 9019 return performClick(); 9020 } 9021 } 9022 } 9023 return false; 9024 } 9025 9026 /** 9027 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 9028 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 9029 * the event). 9030 * <p>Key presses in software keyboards will generally NOT trigger this listener, 9031 * although some may elect to do so in some situations. Do not rely on this to 9032 * catch software key presses. 9033 * 9034 * @param keyCode A key code that represents the button pressed, from 9035 * {@link android.view.KeyEvent}. 9036 * @param repeatCount The number of times the action was made. 9037 * @param event The KeyEvent object that defines the button action. 9038 */ 9039 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 9040 return false; 9041 } 9042 9043 /** 9044 * Called on the focused view when a key shortcut event is not handled. 9045 * Override this method to implement local key shortcuts for the View. 9046 * Key shortcuts can also be implemented by setting the 9047 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 9048 * 9049 * @param keyCode The value in event.getKeyCode(). 9050 * @param event Description of the key event. 9051 * @return If you handled the event, return true. If you want to allow the 9052 * event to be handled by the next receiver, return false. 9053 */ 9054 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 9055 return false; 9056 } 9057 9058 /** 9059 * Check whether the called view is a text editor, in which case it 9060 * would make sense to automatically display a soft input window for 9061 * it. Subclasses should override this if they implement 9062 * {@link #onCreateInputConnection(EditorInfo)} to return true if 9063 * a call on that method would return a non-null InputConnection, and 9064 * they are really a first-class editor that the user would normally 9065 * start typing on when the go into a window containing your view. 9066 * 9067 * <p>The default implementation always returns false. This does 9068 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 9069 * will not be called or the user can not otherwise perform edits on your 9070 * view; it is just a hint to the system that this is not the primary 9071 * purpose of this view. 9072 * 9073 * @return Returns true if this view is a text editor, else false. 9074 */ 9075 public boolean onCheckIsTextEditor() { 9076 return false; 9077 } 9078 9079 /** 9080 * Create a new InputConnection for an InputMethod to interact 9081 * with the view. The default implementation returns null, since it doesn't 9082 * support input methods. You can override this to implement such support. 9083 * This is only needed for views that take focus and text input. 9084 * 9085 * <p>When implementing this, you probably also want to implement 9086 * {@link #onCheckIsTextEditor()} to indicate you will return a 9087 * non-null InputConnection.</p> 9088 * 9089 * <p>Also, take good care to fill in the {@link android.view.inputmethod.EditorInfo} 9090 * object correctly and in its entirety, so that the connected IME can rely 9091 * on its values. For example, {@link android.view.inputmethod.EditorInfo#initialSelStart} 9092 * and {@link android.view.inputmethod.EditorInfo#initialSelEnd} members 9093 * must be filled in with the correct cursor position for IMEs to work correctly 9094 * with your application.</p> 9095 * 9096 * @param outAttrs Fill in with attribute information about the connection. 9097 */ 9098 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 9099 return null; 9100 } 9101 9102 /** 9103 * Called by the {@link android.view.inputmethod.InputMethodManager} 9104 * when a view who is not the current 9105 * input connection target is trying to make a call on the manager. The 9106 * default implementation returns false; you can override this to return 9107 * true for certain views if you are performing InputConnection proxying 9108 * to them. 9109 * @param view The View that is making the InputMethodManager call. 9110 * @return Return true to allow the call, false to reject. 9111 */ 9112 public boolean checkInputConnectionProxy(View view) { 9113 return false; 9114 } 9115 9116 /** 9117 * Show the context menu for this view. It is not safe to hold on to the 9118 * menu after returning from this method. 9119 * 9120 * You should normally not overload this method. Overload 9121 * {@link #onCreateContextMenu(ContextMenu)} or define an 9122 * {@link OnCreateContextMenuListener} to add items to the context menu. 9123 * 9124 * @param menu The context menu to populate 9125 */ 9126 public void createContextMenu(ContextMenu menu) { 9127 ContextMenuInfo menuInfo = getContextMenuInfo(); 9128 9129 // Sets the current menu info so all items added to menu will have 9130 // my extra info set. 9131 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 9132 9133 onCreateContextMenu(menu); 9134 ListenerInfo li = mListenerInfo; 9135 if (li != null && li.mOnCreateContextMenuListener != null) { 9136 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 9137 } 9138 9139 // Clear the extra information so subsequent items that aren't mine don't 9140 // have my extra info. 9141 ((MenuBuilder)menu).setCurrentMenuInfo(null); 9142 9143 if (mParent != null) { 9144 mParent.createContextMenu(menu); 9145 } 9146 } 9147 9148 /** 9149 * Views should implement this if they have extra information to associate 9150 * with the context menu. The return result is supplied as a parameter to 9151 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 9152 * callback. 9153 * 9154 * @return Extra information about the item for which the context menu 9155 * should be shown. This information will vary across different 9156 * subclasses of View. 9157 */ 9158 protected ContextMenuInfo getContextMenuInfo() { 9159 return null; 9160 } 9161 9162 /** 9163 * Views should implement this if the view itself is going to add items to 9164 * the context menu. 9165 * 9166 * @param menu the context menu to populate 9167 */ 9168 protected void onCreateContextMenu(ContextMenu menu) { 9169 } 9170 9171 /** 9172 * Implement this method to handle trackball motion events. The 9173 * <em>relative</em> movement of the trackball since the last event 9174 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 9175 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 9176 * that a movement of 1 corresponds to the user pressing one DPAD key (so 9177 * they will often be fractional values, representing the more fine-grained 9178 * movement information available from a trackball). 9179 * 9180 * @param event The motion event. 9181 * @return True if the event was handled, false otherwise. 9182 */ 9183 public boolean onTrackballEvent(MotionEvent event) { 9184 return false; 9185 } 9186 9187 /** 9188 * Implement this method to handle generic motion events. 9189 * <p> 9190 * Generic motion events describe joystick movements, mouse hovers, track pad 9191 * touches, scroll wheel movements and other input events. The 9192 * {@link MotionEvent#getSource() source} of the motion event specifies 9193 * the class of input that was received. Implementations of this method 9194 * must examine the bits in the source before processing the event. 9195 * The following code example shows how this is done. 9196 * </p><p> 9197 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 9198 * are delivered to the view under the pointer. All other generic motion events are 9199 * delivered to the focused view. 9200 * </p> 9201 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 9202 * if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) { 9203 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 9204 * // process the joystick movement... 9205 * return true; 9206 * } 9207 * } 9208 * if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) { 9209 * switch (event.getAction()) { 9210 * case MotionEvent.ACTION_HOVER_MOVE: 9211 * // process the mouse hover movement... 9212 * return true; 9213 * case MotionEvent.ACTION_SCROLL: 9214 * // process the scroll wheel movement... 9215 * return true; 9216 * } 9217 * } 9218 * return super.onGenericMotionEvent(event); 9219 * }</pre> 9220 * 9221 * @param event The generic motion event being processed. 9222 * @return True if the event was handled, false otherwise. 9223 */ 9224 public boolean onGenericMotionEvent(MotionEvent event) { 9225 return false; 9226 } 9227 9228 /** 9229 * Implement this method to handle hover events. 9230 * <p> 9231 * This method is called whenever a pointer is hovering into, over, or out of the 9232 * bounds of a view and the view is not currently being touched. 9233 * Hover events are represented as pointer events with action 9234 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 9235 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 9236 * </p> 9237 * <ul> 9238 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 9239 * when the pointer enters the bounds of the view.</li> 9240 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 9241 * when the pointer has already entered the bounds of the view and has moved.</li> 9242 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 9243 * when the pointer has exited the bounds of the view or when the pointer is 9244 * about to go down due to a button click, tap, or similar user action that 9245 * causes the view to be touched.</li> 9246 * </ul> 9247 * <p> 9248 * The view should implement this method to return true to indicate that it is 9249 * handling the hover event, such as by changing its drawable state. 9250 * </p><p> 9251 * The default implementation calls {@link #setHovered} to update the hovered state 9252 * of the view when a hover enter or hover exit event is received, if the view 9253 * is enabled and is clickable. The default implementation also sends hover 9254 * accessibility events. 9255 * </p> 9256 * 9257 * @param event The motion event that describes the hover. 9258 * @return True if the view handled the hover event. 9259 * 9260 * @see #isHovered 9261 * @see #setHovered 9262 * @see #onHoverChanged 9263 */ 9264 public boolean onHoverEvent(MotionEvent event) { 9265 // The root view may receive hover (or touch) events that are outside the bounds of 9266 // the window. This code ensures that we only send accessibility events for 9267 // hovers that are actually within the bounds of the root view. 9268 final int action = event.getActionMasked(); 9269 if (!mSendingHoverAccessibilityEvents) { 9270 if ((action == MotionEvent.ACTION_HOVER_ENTER 9271 || action == MotionEvent.ACTION_HOVER_MOVE) 9272 && !hasHoveredChild() 9273 && pointInView(event.getX(), event.getY())) { 9274 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 9275 mSendingHoverAccessibilityEvents = true; 9276 } 9277 } else { 9278 if (action == MotionEvent.ACTION_HOVER_EXIT 9279 || (action == MotionEvent.ACTION_MOVE 9280 && !pointInView(event.getX(), event.getY()))) { 9281 mSendingHoverAccessibilityEvents = false; 9282 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 9283 } 9284 } 9285 9286 if (isHoverable()) { 9287 switch (action) { 9288 case MotionEvent.ACTION_HOVER_ENTER: 9289 setHovered(true); 9290 break; 9291 case MotionEvent.ACTION_HOVER_EXIT: 9292 setHovered(false); 9293 break; 9294 } 9295 9296 // Dispatch the event to onGenericMotionEvent before returning true. 9297 // This is to provide compatibility with existing applications that 9298 // handled HOVER_MOVE events in onGenericMotionEvent and that would 9299 // break because of the new default handling for hoverable views 9300 // in onHoverEvent. 9301 // Note that onGenericMotionEvent will be called by default when 9302 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 9303 dispatchGenericMotionEventInternal(event); 9304 // The event was already handled by calling setHovered(), so always 9305 // return true. 9306 return true; 9307 } 9308 9309 return false; 9310 } 9311 9312 /** 9313 * Returns true if the view should handle {@link #onHoverEvent} 9314 * by calling {@link #setHovered} to change its hovered state. 9315 * 9316 * @return True if the view is hoverable. 9317 */ 9318 private boolean isHoverable() { 9319 final int viewFlags = mViewFlags; 9320 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9321 return false; 9322 } 9323 9324 return (viewFlags & CLICKABLE) == CLICKABLE 9325 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 9326 } 9327 9328 /** 9329 * Returns true if the view is currently hovered. 9330 * 9331 * @return True if the view is currently hovered. 9332 * 9333 * @see #setHovered 9334 * @see #onHoverChanged 9335 */ 9336 @ViewDebug.ExportedProperty 9337 public boolean isHovered() { 9338 return (mPrivateFlags & PFLAG_HOVERED) != 0; 9339 } 9340 9341 /** 9342 * Sets whether the view is currently hovered. 9343 * <p> 9344 * Calling this method also changes the drawable state of the view. This 9345 * enables the view to react to hover by using different drawable resources 9346 * to change its appearance. 9347 * </p><p> 9348 * The {@link #onHoverChanged} method is called when the hovered state changes. 9349 * </p> 9350 * 9351 * @param hovered True if the view is hovered. 9352 * 9353 * @see #isHovered 9354 * @see #onHoverChanged 9355 */ 9356 public void setHovered(boolean hovered) { 9357 if (hovered) { 9358 if ((mPrivateFlags & PFLAG_HOVERED) == 0) { 9359 mPrivateFlags |= PFLAG_HOVERED; 9360 refreshDrawableState(); 9361 onHoverChanged(true); 9362 } 9363 } else { 9364 if ((mPrivateFlags & PFLAG_HOVERED) != 0) { 9365 mPrivateFlags &= ~PFLAG_HOVERED; 9366 refreshDrawableState(); 9367 onHoverChanged(false); 9368 } 9369 } 9370 } 9371 9372 /** 9373 * Implement this method to handle hover state changes. 9374 * <p> 9375 * This method is called whenever the hover state changes as a result of a 9376 * call to {@link #setHovered}. 9377 * </p> 9378 * 9379 * @param hovered The current hover state, as returned by {@link #isHovered}. 9380 * 9381 * @see #isHovered 9382 * @see #setHovered 9383 */ 9384 public void onHoverChanged(boolean hovered) { 9385 } 9386 9387 /** 9388 * Implement this method to handle touch screen motion events. 9389 * <p> 9390 * If this method is used to detect click actions, it is recommended that 9391 * the actions be performed by implementing and calling 9392 * {@link #performClick()}. This will ensure consistent system behavior, 9393 * including: 9394 * <ul> 9395 * <li>obeying click sound preferences 9396 * <li>dispatching OnClickListener calls 9397 * <li>handling {@link AccessibilityNodeInfo#ACTION_CLICK ACTION_CLICK} when 9398 * accessibility features are enabled 9399 * </ul> 9400 * 9401 * @param event The motion event. 9402 * @return True if the event was handled, false otherwise. 9403 */ 9404 public boolean onTouchEvent(MotionEvent event) { 9405 final float x = event.getX(); 9406 final float y = event.getY(); 9407 final int viewFlags = mViewFlags; 9408 9409 if ((viewFlags & ENABLED_MASK) == DISABLED) { 9410 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) { 9411 setPressed(false); 9412 } 9413 // A disabled view that is clickable still consumes the touch 9414 // events, it just doesn't respond to them. 9415 return (((viewFlags & CLICKABLE) == CLICKABLE || 9416 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 9417 } 9418 9419 if (mTouchDelegate != null) { 9420 if (mTouchDelegate.onTouchEvent(event)) { 9421 return true; 9422 } 9423 } 9424 9425 if (((viewFlags & CLICKABLE) == CLICKABLE || 9426 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 9427 switch (event.getAction()) { 9428 case MotionEvent.ACTION_UP: 9429 boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0; 9430 if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) { 9431 // take focus if we don't have it already and we should in 9432 // touch mode. 9433 boolean focusTaken = false; 9434 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 9435 focusTaken = requestFocus(); 9436 } 9437 9438 if (prepressed) { 9439 // The button is being released before we actually 9440 // showed it as pressed. Make it show the pressed 9441 // state now (before scheduling the click) to ensure 9442 // the user sees it. 9443 setPressed(true, x, y); 9444 } 9445 9446 if (!mHasPerformedLongPress) { 9447 // This is a tap, so remove the longpress check 9448 removeLongPressCallback(); 9449 9450 // Only perform take click actions if we were in the pressed state 9451 if (!focusTaken) { 9452 // Use a Runnable and post this rather than calling 9453 // performClick directly. This lets other visual state 9454 // of the view update before click actions start. 9455 if (mPerformClick == null) { 9456 mPerformClick = new PerformClick(); 9457 } 9458 if (!post(mPerformClick)) { 9459 performClick(); 9460 } 9461 } 9462 } 9463 9464 if (mUnsetPressedState == null) { 9465 mUnsetPressedState = new UnsetPressedState(); 9466 } 9467 9468 if (prepressed) { 9469 postDelayed(mUnsetPressedState, 9470 ViewConfiguration.getPressedStateDuration()); 9471 } else if (!post(mUnsetPressedState)) { 9472 // If the post failed, unpress right now 9473 mUnsetPressedState.run(); 9474 } 9475 9476 removeTapCallback(); 9477 } 9478 break; 9479 9480 case MotionEvent.ACTION_DOWN: 9481 mHasPerformedLongPress = false; 9482 9483 if (performButtonActionOnTouchDown(event)) { 9484 break; 9485 } 9486 9487 // Walk up the hierarchy to determine if we're inside a scrolling container. 9488 boolean isInScrollingContainer = isInScrollingContainer(); 9489 9490 // For views inside a scrolling container, delay the pressed feedback for 9491 // a short period in case this is a scroll. 9492 if (isInScrollingContainer) { 9493 mPrivateFlags |= PFLAG_PREPRESSED; 9494 if (mPendingCheckForTap == null) { 9495 mPendingCheckForTap = new CheckForTap(); 9496 } 9497 mPendingCheckForTap.x = event.getX(); 9498 mPendingCheckForTap.y = event.getY(); 9499 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 9500 } else { 9501 // Not inside a scrolling container, so show the feedback right away 9502 setPressed(true, x, y); 9503 checkForLongClick(0); 9504 } 9505 break; 9506 9507 case MotionEvent.ACTION_CANCEL: 9508 setPressed(false); 9509 removeTapCallback(); 9510 removeLongPressCallback(); 9511 break; 9512 9513 case MotionEvent.ACTION_MOVE: 9514 drawableHotspotChanged(x, y); 9515 9516 // Be lenient about moving outside of buttons 9517 if (!pointInView(x, y, mTouchSlop)) { 9518 // Outside button 9519 removeTapCallback(); 9520 if ((mPrivateFlags & PFLAG_PRESSED) != 0) { 9521 // Remove any future long press/tap checks 9522 removeLongPressCallback(); 9523 9524 setPressed(false); 9525 } 9526 } 9527 break; 9528 } 9529 9530 return true; 9531 } 9532 9533 return false; 9534 } 9535 9536 /** 9537 * @hide 9538 */ 9539 public boolean isInScrollingContainer() { 9540 ViewParent p = getParent(); 9541 while (p != null && p instanceof ViewGroup) { 9542 if (((ViewGroup) p).shouldDelayChildPressedState()) { 9543 return true; 9544 } 9545 p = p.getParent(); 9546 } 9547 return false; 9548 } 9549 9550 /** 9551 * Remove the longpress detection timer. 9552 */ 9553 private void removeLongPressCallback() { 9554 if (mPendingCheckForLongPress != null) { 9555 removeCallbacks(mPendingCheckForLongPress); 9556 } 9557 } 9558 9559 /** 9560 * Remove the pending click action 9561 */ 9562 private void removePerformClickCallback() { 9563 if (mPerformClick != null) { 9564 removeCallbacks(mPerformClick); 9565 } 9566 } 9567 9568 /** 9569 * Remove the prepress detection timer. 9570 */ 9571 private void removeUnsetPressCallback() { 9572 if ((mPrivateFlags & PFLAG_PRESSED) != 0 && mUnsetPressedState != null) { 9573 setPressed(false); 9574 removeCallbacks(mUnsetPressedState); 9575 } 9576 } 9577 9578 /** 9579 * Remove the tap detection timer. 9580 */ 9581 private void removeTapCallback() { 9582 if (mPendingCheckForTap != null) { 9583 mPrivateFlags &= ~PFLAG_PREPRESSED; 9584 removeCallbacks(mPendingCheckForTap); 9585 } 9586 } 9587 9588 /** 9589 * Cancels a pending long press. Your subclass can use this if you 9590 * want the context menu to come up if the user presses and holds 9591 * at the same place, but you don't want it to come up if they press 9592 * and then move around enough to cause scrolling. 9593 */ 9594 public void cancelLongPress() { 9595 removeLongPressCallback(); 9596 9597 /* 9598 * The prepressed state handled by the tap callback is a display 9599 * construct, but the tap callback will post a long press callback 9600 * less its own timeout. Remove it here. 9601 */ 9602 removeTapCallback(); 9603 } 9604 9605 /** 9606 * Remove the pending callback for sending a 9607 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 9608 */ 9609 private void removeSendViewScrolledAccessibilityEventCallback() { 9610 if (mSendViewScrolledAccessibilityEvent != null) { 9611 removeCallbacks(mSendViewScrolledAccessibilityEvent); 9612 mSendViewScrolledAccessibilityEvent.mIsPending = false; 9613 } 9614 } 9615 9616 /** 9617 * Sets the TouchDelegate for this View. 9618 */ 9619 public void setTouchDelegate(TouchDelegate delegate) { 9620 mTouchDelegate = delegate; 9621 } 9622 9623 /** 9624 * Gets the TouchDelegate for this View. 9625 */ 9626 public TouchDelegate getTouchDelegate() { 9627 return mTouchDelegate; 9628 } 9629 9630 /** 9631 * Request unbuffered dispatch of the given stream of MotionEvents to this View. 9632 * 9633 * Until this View receives a corresponding {@link MotionEvent#ACTION_UP}, ask that the input 9634 * system not batch {@link MotionEvent}s but instead deliver them as soon as they're 9635 * available. This method should only be called for touch events. 9636 * 9637 * <p class="note">This api is not intended for most applications. Buffered dispatch 9638 * provides many of benefits, and just requesting unbuffered dispatch on most MotionEvent 9639 * streams will not improve your input latency. Side effects include: increased latency, 9640 * jittery scrolls and inability to take advantage of system resampling. Talk to your input 9641 * professional to see if {@link #requestUnbufferedDispatch(MotionEvent)} is right for 9642 * you.</p> 9643 */ 9644 public final void requestUnbufferedDispatch(MotionEvent event) { 9645 final int action = event.getAction(); 9646 if (mAttachInfo == null 9647 || action != MotionEvent.ACTION_DOWN && action != MotionEvent.ACTION_MOVE 9648 || !event.isTouchEvent()) { 9649 return; 9650 } 9651 mAttachInfo.mUnbufferedDispatchRequested = true; 9652 } 9653 9654 /** 9655 * Set flags controlling behavior of this view. 9656 * 9657 * @param flags Constant indicating the value which should be set 9658 * @param mask Constant indicating the bit range that should be changed 9659 */ 9660 void setFlags(int flags, int mask) { 9661 final boolean accessibilityEnabled = 9662 AccessibilityManager.getInstance(mContext).isEnabled(); 9663 final boolean oldIncludeForAccessibility = accessibilityEnabled && includeForAccessibility(); 9664 9665 int old = mViewFlags; 9666 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 9667 9668 int changed = mViewFlags ^ old; 9669 if (changed == 0) { 9670 return; 9671 } 9672 int privateFlags = mPrivateFlags; 9673 9674 /* Check if the FOCUSABLE bit has changed */ 9675 if (((changed & FOCUSABLE_MASK) != 0) && 9676 ((privateFlags & PFLAG_HAS_BOUNDS) !=0)) { 9677 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 9678 && ((privateFlags & PFLAG_FOCUSED) != 0)) { 9679 /* Give up focus if we are no longer focusable */ 9680 clearFocus(); 9681 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 9682 && ((privateFlags & PFLAG_FOCUSED) == 0)) { 9683 /* 9684 * Tell the view system that we are now available to take focus 9685 * if no one else already has it. 9686 */ 9687 if (mParent != null) mParent.focusableViewAvailable(this); 9688 } 9689 } 9690 9691 final int newVisibility = flags & VISIBILITY_MASK; 9692 if (newVisibility == VISIBLE) { 9693 if ((changed & VISIBILITY_MASK) != 0) { 9694 /* 9695 * If this view is becoming visible, invalidate it in case it changed while 9696 * it was not visible. Marking it drawn ensures that the invalidation will 9697 * go through. 9698 */ 9699 mPrivateFlags |= PFLAG_DRAWN; 9700 invalidate(true); 9701 9702 needGlobalAttributesUpdate(true); 9703 9704 // a view becoming visible is worth notifying the parent 9705 // about in case nothing has focus. even if this specific view 9706 // isn't focusable, it may contain something that is, so let 9707 // the root view try to give this focus if nothing else does. 9708 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 9709 mParent.focusableViewAvailable(this); 9710 } 9711 } 9712 } 9713 9714 /* Check if the GONE bit has changed */ 9715 if ((changed & GONE) != 0) { 9716 needGlobalAttributesUpdate(false); 9717 requestLayout(); 9718 9719 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 9720 if (hasFocus()) clearFocus(); 9721 clearAccessibilityFocus(); 9722 destroyDrawingCache(); 9723 if (mParent instanceof View) { 9724 // GONE views noop invalidation, so invalidate the parent 9725 ((View) mParent).invalidate(true); 9726 } 9727 // Mark the view drawn to ensure that it gets invalidated properly the next 9728 // time it is visible and gets invalidated 9729 mPrivateFlags |= PFLAG_DRAWN; 9730 } 9731 if (mAttachInfo != null) { 9732 mAttachInfo.mViewVisibilityChanged = true; 9733 } 9734 } 9735 9736 /* Check if the VISIBLE bit has changed */ 9737 if ((changed & INVISIBLE) != 0) { 9738 needGlobalAttributesUpdate(false); 9739 /* 9740 * If this view is becoming invisible, set the DRAWN flag so that 9741 * the next invalidate() will not be skipped. 9742 */ 9743 mPrivateFlags |= PFLAG_DRAWN; 9744 9745 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE)) { 9746 // root view becoming invisible shouldn't clear focus and accessibility focus 9747 if (getRootView() != this) { 9748 if (hasFocus()) clearFocus(); 9749 clearAccessibilityFocus(); 9750 } 9751 } 9752 if (mAttachInfo != null) { 9753 mAttachInfo.mViewVisibilityChanged = true; 9754 } 9755 } 9756 9757 if ((changed & VISIBILITY_MASK) != 0) { 9758 // If the view is invisible, cleanup its display list to free up resources 9759 if (newVisibility != VISIBLE && mAttachInfo != null) { 9760 cleanupDraw(); 9761 } 9762 9763 if (mParent instanceof ViewGroup) { 9764 ((ViewGroup) mParent).onChildVisibilityChanged(this, 9765 (changed & VISIBILITY_MASK), newVisibility); 9766 ((View) mParent).invalidate(true); 9767 } else if (mParent != null) { 9768 mParent.invalidateChild(this, null); 9769 } 9770 dispatchVisibilityChanged(this, newVisibility); 9771 9772 notifySubtreeAccessibilityStateChangedIfNeeded(); 9773 } 9774 9775 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 9776 destroyDrawingCache(); 9777 } 9778 9779 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 9780 destroyDrawingCache(); 9781 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9782 invalidateParentCaches(); 9783 } 9784 9785 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 9786 destroyDrawingCache(); 9787 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 9788 } 9789 9790 if ((changed & DRAW_MASK) != 0) { 9791 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 9792 if (mBackground != null) { 9793 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9794 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 9795 } else { 9796 mPrivateFlags |= PFLAG_SKIP_DRAW; 9797 } 9798 } else { 9799 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 9800 } 9801 requestLayout(); 9802 invalidate(true); 9803 } 9804 9805 if ((changed & KEEP_SCREEN_ON) != 0) { 9806 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 9807 mParent.recomputeViewAttributes(this); 9808 } 9809 } 9810 9811 if (accessibilityEnabled) { 9812 if ((changed & FOCUSABLE_MASK) != 0 || (changed & VISIBILITY_MASK) != 0 9813 || (changed & CLICKABLE) != 0 || (changed & LONG_CLICKABLE) != 0) { 9814 if (oldIncludeForAccessibility != includeForAccessibility()) { 9815 notifySubtreeAccessibilityStateChangedIfNeeded(); 9816 } else { 9817 notifyViewAccessibilityStateChangedIfNeeded( 9818 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9819 } 9820 } else if ((changed & ENABLED_MASK) != 0) { 9821 notifyViewAccessibilityStateChangedIfNeeded( 9822 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 9823 } 9824 } 9825 } 9826 9827 /** 9828 * Change the view's z order in the tree, so it's on top of other sibling 9829 * views. This ordering change may affect layout, if the parent container 9830 * uses an order-dependent layout scheme (e.g., LinearLayout). Prior 9831 * to {@link android.os.Build.VERSION_CODES#KITKAT} this 9832 * method should be followed by calls to {@link #requestLayout()} and 9833 * {@link View#invalidate()} on the view's parent to force the parent to redraw 9834 * with the new child ordering. 9835 * 9836 * @see ViewGroup#bringChildToFront(View) 9837 */ 9838 public void bringToFront() { 9839 if (mParent != null) { 9840 mParent.bringChildToFront(this); 9841 } 9842 } 9843 9844 /** 9845 * This is called in response to an internal scroll in this view (i.e., the 9846 * view scrolled its own contents). This is typically as a result of 9847 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 9848 * called. 9849 * 9850 * @param l Current horizontal scroll origin. 9851 * @param t Current vertical scroll origin. 9852 * @param oldl Previous horizontal scroll origin. 9853 * @param oldt Previous vertical scroll origin. 9854 */ 9855 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 9856 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 9857 postSendViewScrolledAccessibilityEventCallback(); 9858 } 9859 9860 mBackgroundSizeChanged = true; 9861 9862 final AttachInfo ai = mAttachInfo; 9863 if (ai != null) { 9864 ai.mViewScrollChanged = true; 9865 } 9866 9867 if (mListenerInfo != null && mListenerInfo.mOnScrollChangeListener != null) { 9868 mListenerInfo.mOnScrollChangeListener.onScrollChange(this, l, t, oldl, oldt); 9869 } 9870 } 9871 9872 /** 9873 * Interface definition for a callback to be invoked when the scroll 9874 * position of a view changes. 9875 * 9876 * @hide Only used internally. 9877 */ 9878 public interface OnScrollChangeListener { 9879 /** 9880 * Called when the scroll position of a view changes. 9881 * 9882 * @param v The view whose scroll position has changed. 9883 * @param scrollX Current horizontal scroll origin. 9884 * @param scrollY Current vertical scroll origin. 9885 * @param oldScrollX Previous horizontal scroll origin. 9886 * @param oldScrollY Previous vertical scroll origin. 9887 */ 9888 void onScrollChange(View v, int scrollX, int scrollY, int oldScrollX, int oldScrollY); 9889 } 9890 9891 /** 9892 * Interface definition for a callback to be invoked when the layout bounds of a view 9893 * changes due to layout processing. 9894 */ 9895 public interface OnLayoutChangeListener { 9896 /** 9897 * Called when the layout bounds of a view changes due to layout processing. 9898 * 9899 * @param v The view whose bounds have changed. 9900 * @param left The new value of the view's left property. 9901 * @param top The new value of the view's top property. 9902 * @param right The new value of the view's right property. 9903 * @param bottom The new value of the view's bottom property. 9904 * @param oldLeft The previous value of the view's left property. 9905 * @param oldTop The previous value of the view's top property. 9906 * @param oldRight The previous value of the view's right property. 9907 * @param oldBottom The previous value of the view's bottom property. 9908 */ 9909 void onLayoutChange(View v, int left, int top, int right, int bottom, 9910 int oldLeft, int oldTop, int oldRight, int oldBottom); 9911 } 9912 9913 /** 9914 * This is called during layout when the size of this view has changed. If 9915 * you were just added to the view hierarchy, you're called with the old 9916 * values of 0. 9917 * 9918 * @param w Current width of this view. 9919 * @param h Current height of this view. 9920 * @param oldw Old width of this view. 9921 * @param oldh Old height of this view. 9922 */ 9923 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 9924 } 9925 9926 /** 9927 * Called by draw to draw the child views. This may be overridden 9928 * by derived classes to gain control just before its children are drawn 9929 * (but after its own view has been drawn). 9930 * @param canvas the canvas on which to draw the view 9931 */ 9932 protected void dispatchDraw(Canvas canvas) { 9933 9934 } 9935 9936 /** 9937 * Gets the parent of this view. Note that the parent is a 9938 * ViewParent and not necessarily a View. 9939 * 9940 * @return Parent of this view. 9941 */ 9942 public final ViewParent getParent() { 9943 return mParent; 9944 } 9945 9946 /** 9947 * Set the horizontal scrolled position of your view. This will cause a call to 9948 * {@link #onScrollChanged(int, int, int, int)} and the view will be 9949 * invalidated. 9950 * @param value the x position to scroll to 9951 */ 9952 public void setScrollX(int value) { 9953 scrollTo(value, mScrollY); 9954 } 9955 9956 /** 9957 * Set the vertical scrolled position of your view. This will cause a call to 9958 * {@link #onScrollChanged(int, int, int, int)} and the view will be 9959 * invalidated. 9960 * @param value the y position to scroll to 9961 */ 9962 public void setScrollY(int value) { 9963 scrollTo(mScrollX, value); 9964 } 9965 9966 /** 9967 * Return the scrolled left position of this view. This is the left edge of 9968 * the displayed part of your view. You do not need to draw any pixels 9969 * farther left, since those are outside of the frame of your view on 9970 * screen. 9971 * 9972 * @return The left edge of the displayed part of your view, in pixels. 9973 */ 9974 public final int getScrollX() { 9975 return mScrollX; 9976 } 9977 9978 /** 9979 * Return the scrolled top position of this view. This is the top edge of 9980 * the displayed part of your view. You do not need to draw any pixels above 9981 * it, since those are outside of the frame of your view on screen. 9982 * 9983 * @return The top edge of the displayed part of your view, in pixels. 9984 */ 9985 public final int getScrollY() { 9986 return mScrollY; 9987 } 9988 9989 /** 9990 * Return the width of the your view. 9991 * 9992 * @return The width of your view, in pixels. 9993 */ 9994 @ViewDebug.ExportedProperty(category = "layout") 9995 public final int getWidth() { 9996 return mRight - mLeft; 9997 } 9998 9999 /** 10000 * Return the height of your view. 10001 * 10002 * @return The height of your view, in pixels. 10003 */ 10004 @ViewDebug.ExportedProperty(category = "layout") 10005 public final int getHeight() { 10006 return mBottom - mTop; 10007 } 10008 10009 /** 10010 * Return the visible drawing bounds of your view. Fills in the output 10011 * rectangle with the values from getScrollX(), getScrollY(), 10012 * getWidth(), and getHeight(). These bounds do not account for any 10013 * transformation properties currently set on the view, such as 10014 * {@link #setScaleX(float)} or {@link #setRotation(float)}. 10015 * 10016 * @param outRect The (scrolled) drawing bounds of the view. 10017 */ 10018 public void getDrawingRect(Rect outRect) { 10019 outRect.left = mScrollX; 10020 outRect.top = mScrollY; 10021 outRect.right = mScrollX + (mRight - mLeft); 10022 outRect.bottom = mScrollY + (mBottom - mTop); 10023 } 10024 10025 /** 10026 * Like {@link #getMeasuredWidthAndState()}, but only returns the 10027 * raw width component (that is the result is masked by 10028 * {@link #MEASURED_SIZE_MASK}). 10029 * 10030 * @return The raw measured width of this view. 10031 */ 10032 public final int getMeasuredWidth() { 10033 return mMeasuredWidth & MEASURED_SIZE_MASK; 10034 } 10035 10036 /** 10037 * Return the full width measurement information for this view as computed 10038 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10039 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10040 * This should be used during measurement and layout calculations only. Use 10041 * {@link #getWidth()} to see how wide a view is after layout. 10042 * 10043 * @return The measured width of this view as a bit mask. 10044 */ 10045 public final int getMeasuredWidthAndState() { 10046 return mMeasuredWidth; 10047 } 10048 10049 /** 10050 * Like {@link #getMeasuredHeightAndState()}, but only returns the 10051 * raw width component (that is the result is masked by 10052 * {@link #MEASURED_SIZE_MASK}). 10053 * 10054 * @return The raw measured height of this view. 10055 */ 10056 public final int getMeasuredHeight() { 10057 return mMeasuredHeight & MEASURED_SIZE_MASK; 10058 } 10059 10060 /** 10061 * Return the full height measurement information for this view as computed 10062 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 10063 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10064 * This should be used during measurement and layout calculations only. Use 10065 * {@link #getHeight()} to see how wide a view is after layout. 10066 * 10067 * @return The measured width of this view as a bit mask. 10068 */ 10069 public final int getMeasuredHeightAndState() { 10070 return mMeasuredHeight; 10071 } 10072 10073 /** 10074 * Return only the state bits of {@link #getMeasuredWidthAndState()} 10075 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 10076 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 10077 * and the height component is at the shifted bits 10078 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 10079 */ 10080 public final int getMeasuredState() { 10081 return (mMeasuredWidth&MEASURED_STATE_MASK) 10082 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 10083 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 10084 } 10085 10086 /** 10087 * The transform matrix of this view, which is calculated based on the current 10088 * rotation, scale, and pivot properties. 10089 * 10090 * @see #getRotation() 10091 * @see #getScaleX() 10092 * @see #getScaleY() 10093 * @see #getPivotX() 10094 * @see #getPivotY() 10095 * @return The current transform matrix for the view 10096 */ 10097 public Matrix getMatrix() { 10098 ensureTransformationInfo(); 10099 final Matrix matrix = mTransformationInfo.mMatrix; 10100 mRenderNode.getMatrix(matrix); 10101 return matrix; 10102 } 10103 10104 /** 10105 * Returns true if the transform matrix is the identity matrix. 10106 * Recomputes the matrix if necessary. 10107 * 10108 * @return True if the transform matrix is the identity matrix, false otherwise. 10109 */ 10110 final boolean hasIdentityMatrix() { 10111 return mRenderNode.hasIdentityMatrix(); 10112 } 10113 10114 void ensureTransformationInfo() { 10115 if (mTransformationInfo == null) { 10116 mTransformationInfo = new TransformationInfo(); 10117 } 10118 } 10119 10120 /** 10121 * Utility method to retrieve the inverse of the current mMatrix property. 10122 * We cache the matrix to avoid recalculating it when transform properties 10123 * have not changed. 10124 * 10125 * @return The inverse of the current matrix of this view. 10126 * @hide 10127 */ 10128 public final Matrix getInverseMatrix() { 10129 ensureTransformationInfo(); 10130 if (mTransformationInfo.mInverseMatrix == null) { 10131 mTransformationInfo.mInverseMatrix = new Matrix(); 10132 } 10133 final Matrix matrix = mTransformationInfo.mInverseMatrix; 10134 mRenderNode.getInverseMatrix(matrix); 10135 return matrix; 10136 } 10137 10138 /** 10139 * Gets the distance along the Z axis from the camera to this view. 10140 * 10141 * @see #setCameraDistance(float) 10142 * 10143 * @return The distance along the Z axis. 10144 */ 10145 public float getCameraDistance() { 10146 final float dpi = mResources.getDisplayMetrics().densityDpi; 10147 return -(mRenderNode.getCameraDistance() * dpi); 10148 } 10149 10150 /** 10151 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 10152 * views are drawn) from the camera to this view. The camera's distance 10153 * affects 3D transformations, for instance rotations around the X and Y 10154 * axis. If the rotationX or rotationY properties are changed and this view is 10155 * large (more than half the size of the screen), it is recommended to always 10156 * use a camera distance that's greater than the height (X axis rotation) or 10157 * the width (Y axis rotation) of this view.</p> 10158 * 10159 * <p>The distance of the camera from the view plane can have an affect on the 10160 * perspective distortion of the view when it is rotated around the x or y axis. 10161 * For example, a large distance will result in a large viewing angle, and there 10162 * will not be much perspective distortion of the view as it rotates. A short 10163 * distance may cause much more perspective distortion upon rotation, and can 10164 * also result in some drawing artifacts if the rotated view ends up partially 10165 * behind the camera (which is why the recommendation is to use a distance at 10166 * least as far as the size of the view, if the view is to be rotated.)</p> 10167 * 10168 * <p>The distance is expressed in "depth pixels." The default distance depends 10169 * on the screen density. For instance, on a medium density display, the 10170 * default distance is 1280. On a high density display, the default distance 10171 * is 1920.</p> 10172 * 10173 * <p>If you want to specify a distance that leads to visually consistent 10174 * results across various densities, use the following formula:</p> 10175 * <pre> 10176 * float scale = context.getResources().getDisplayMetrics().density; 10177 * view.setCameraDistance(distance * scale); 10178 * </pre> 10179 * 10180 * <p>The density scale factor of a high density display is 1.5, 10181 * and 1920 = 1280 * 1.5.</p> 10182 * 10183 * @param distance The distance in "depth pixels", if negative the opposite 10184 * value is used 10185 * 10186 * @see #setRotationX(float) 10187 * @see #setRotationY(float) 10188 */ 10189 public void setCameraDistance(float distance) { 10190 final float dpi = mResources.getDisplayMetrics().densityDpi; 10191 10192 invalidateViewProperty(true, false); 10193 mRenderNode.setCameraDistance(-Math.abs(distance) / dpi); 10194 invalidateViewProperty(false, false); 10195 10196 invalidateParentIfNeededAndWasQuickRejected(); 10197 } 10198 10199 /** 10200 * The degrees that the view is rotated around the pivot point. 10201 * 10202 * @see #setRotation(float) 10203 * @see #getPivotX() 10204 * @see #getPivotY() 10205 * 10206 * @return The degrees of rotation. 10207 */ 10208 @ViewDebug.ExportedProperty(category = "drawing") 10209 public float getRotation() { 10210 return mRenderNode.getRotation(); 10211 } 10212 10213 /** 10214 * Sets the degrees that the view is rotated around the pivot point. Increasing values 10215 * result in clockwise rotation. 10216 * 10217 * @param rotation The degrees of rotation. 10218 * 10219 * @see #getRotation() 10220 * @see #getPivotX() 10221 * @see #getPivotY() 10222 * @see #setRotationX(float) 10223 * @see #setRotationY(float) 10224 * 10225 * @attr ref android.R.styleable#View_rotation 10226 */ 10227 public void setRotation(float rotation) { 10228 if (rotation != getRotation()) { 10229 // Double-invalidation is necessary to capture view's old and new areas 10230 invalidateViewProperty(true, false); 10231 mRenderNode.setRotation(rotation); 10232 invalidateViewProperty(false, true); 10233 10234 invalidateParentIfNeededAndWasQuickRejected(); 10235 notifySubtreeAccessibilityStateChangedIfNeeded(); 10236 } 10237 } 10238 10239 /** 10240 * The degrees that the view is rotated around the vertical axis through the pivot point. 10241 * 10242 * @see #getPivotX() 10243 * @see #getPivotY() 10244 * @see #setRotationY(float) 10245 * 10246 * @return The degrees of Y rotation. 10247 */ 10248 @ViewDebug.ExportedProperty(category = "drawing") 10249 public float getRotationY() { 10250 return mRenderNode.getRotationY(); 10251 } 10252 10253 /** 10254 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 10255 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 10256 * down the y axis. 10257 * 10258 * When rotating large views, it is recommended to adjust the camera distance 10259 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10260 * 10261 * @param rotationY The degrees of Y rotation. 10262 * 10263 * @see #getRotationY() 10264 * @see #getPivotX() 10265 * @see #getPivotY() 10266 * @see #setRotation(float) 10267 * @see #setRotationX(float) 10268 * @see #setCameraDistance(float) 10269 * 10270 * @attr ref android.R.styleable#View_rotationY 10271 */ 10272 public void setRotationY(float rotationY) { 10273 if (rotationY != getRotationY()) { 10274 invalidateViewProperty(true, false); 10275 mRenderNode.setRotationY(rotationY); 10276 invalidateViewProperty(false, true); 10277 10278 invalidateParentIfNeededAndWasQuickRejected(); 10279 notifySubtreeAccessibilityStateChangedIfNeeded(); 10280 } 10281 } 10282 10283 /** 10284 * The degrees that the view is rotated around the horizontal axis through the pivot point. 10285 * 10286 * @see #getPivotX() 10287 * @see #getPivotY() 10288 * @see #setRotationX(float) 10289 * 10290 * @return The degrees of X rotation. 10291 */ 10292 @ViewDebug.ExportedProperty(category = "drawing") 10293 public float getRotationX() { 10294 return mRenderNode.getRotationX(); 10295 } 10296 10297 /** 10298 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 10299 * Increasing values result in clockwise rotation from the viewpoint of looking down the 10300 * x axis. 10301 * 10302 * When rotating large views, it is recommended to adjust the camera distance 10303 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 10304 * 10305 * @param rotationX The degrees of X rotation. 10306 * 10307 * @see #getRotationX() 10308 * @see #getPivotX() 10309 * @see #getPivotY() 10310 * @see #setRotation(float) 10311 * @see #setRotationY(float) 10312 * @see #setCameraDistance(float) 10313 * 10314 * @attr ref android.R.styleable#View_rotationX 10315 */ 10316 public void setRotationX(float rotationX) { 10317 if (rotationX != getRotationX()) { 10318 invalidateViewProperty(true, false); 10319 mRenderNode.setRotationX(rotationX); 10320 invalidateViewProperty(false, true); 10321 10322 invalidateParentIfNeededAndWasQuickRejected(); 10323 notifySubtreeAccessibilityStateChangedIfNeeded(); 10324 } 10325 } 10326 10327 /** 10328 * The amount that the view is scaled in x around the pivot point, as a proportion of 10329 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 10330 * 10331 * <p>By default, this is 1.0f. 10332 * 10333 * @see #getPivotX() 10334 * @see #getPivotY() 10335 * @return The scaling factor. 10336 */ 10337 @ViewDebug.ExportedProperty(category = "drawing") 10338 public float getScaleX() { 10339 return mRenderNode.getScaleX(); 10340 } 10341 10342 /** 10343 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 10344 * the view's unscaled width. A value of 1 means that no scaling is applied. 10345 * 10346 * @param scaleX The scaling factor. 10347 * @see #getPivotX() 10348 * @see #getPivotY() 10349 * 10350 * @attr ref android.R.styleable#View_scaleX 10351 */ 10352 public void setScaleX(float scaleX) { 10353 if (scaleX != getScaleX()) { 10354 invalidateViewProperty(true, false); 10355 mRenderNode.setScaleX(scaleX); 10356 invalidateViewProperty(false, true); 10357 10358 invalidateParentIfNeededAndWasQuickRejected(); 10359 notifySubtreeAccessibilityStateChangedIfNeeded(); 10360 } 10361 } 10362 10363 /** 10364 * The amount that the view is scaled in y around the pivot point, as a proportion of 10365 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 10366 * 10367 * <p>By default, this is 1.0f. 10368 * 10369 * @see #getPivotX() 10370 * @see #getPivotY() 10371 * @return The scaling factor. 10372 */ 10373 @ViewDebug.ExportedProperty(category = "drawing") 10374 public float getScaleY() { 10375 return mRenderNode.getScaleY(); 10376 } 10377 10378 /** 10379 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 10380 * the view's unscaled width. A value of 1 means that no scaling is applied. 10381 * 10382 * @param scaleY The scaling factor. 10383 * @see #getPivotX() 10384 * @see #getPivotY() 10385 * 10386 * @attr ref android.R.styleable#View_scaleY 10387 */ 10388 public void setScaleY(float scaleY) { 10389 if (scaleY != getScaleY()) { 10390 invalidateViewProperty(true, false); 10391 mRenderNode.setScaleY(scaleY); 10392 invalidateViewProperty(false, true); 10393 10394 invalidateParentIfNeededAndWasQuickRejected(); 10395 notifySubtreeAccessibilityStateChangedIfNeeded(); 10396 } 10397 } 10398 10399 /** 10400 * The x location of the point around which the view is {@link #setRotation(float) rotated} 10401 * and {@link #setScaleX(float) scaled}. 10402 * 10403 * @see #getRotation() 10404 * @see #getScaleX() 10405 * @see #getScaleY() 10406 * @see #getPivotY() 10407 * @return The x location of the pivot point. 10408 * 10409 * @attr ref android.R.styleable#View_transformPivotX 10410 */ 10411 @ViewDebug.ExportedProperty(category = "drawing") 10412 public float getPivotX() { 10413 return mRenderNode.getPivotX(); 10414 } 10415 10416 /** 10417 * Sets the x location of the point around which the view is 10418 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 10419 * By default, the pivot point is centered on the object. 10420 * Setting this property disables this behavior and causes the view to use only the 10421 * explicitly set pivotX and pivotY values. 10422 * 10423 * @param pivotX The x location of the pivot point. 10424 * @see #getRotation() 10425 * @see #getScaleX() 10426 * @see #getScaleY() 10427 * @see #getPivotY() 10428 * 10429 * @attr ref android.R.styleable#View_transformPivotX 10430 */ 10431 public void setPivotX(float pivotX) { 10432 if (!mRenderNode.isPivotExplicitlySet() || pivotX != getPivotX()) { 10433 invalidateViewProperty(true, false); 10434 mRenderNode.setPivotX(pivotX); 10435 invalidateViewProperty(false, true); 10436 10437 invalidateParentIfNeededAndWasQuickRejected(); 10438 } 10439 } 10440 10441 /** 10442 * The y location of the point around which the view is {@link #setRotation(float) rotated} 10443 * and {@link #setScaleY(float) scaled}. 10444 * 10445 * @see #getRotation() 10446 * @see #getScaleX() 10447 * @see #getScaleY() 10448 * @see #getPivotY() 10449 * @return The y location of the pivot point. 10450 * 10451 * @attr ref android.R.styleable#View_transformPivotY 10452 */ 10453 @ViewDebug.ExportedProperty(category = "drawing") 10454 public float getPivotY() { 10455 return mRenderNode.getPivotY(); 10456 } 10457 10458 /** 10459 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 10460 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 10461 * Setting this property disables this behavior and causes the view to use only the 10462 * explicitly set pivotX and pivotY values. 10463 * 10464 * @param pivotY The y location of the pivot point. 10465 * @see #getRotation() 10466 * @see #getScaleX() 10467 * @see #getScaleY() 10468 * @see #getPivotY() 10469 * 10470 * @attr ref android.R.styleable#View_transformPivotY 10471 */ 10472 public void setPivotY(float pivotY) { 10473 if (!mRenderNode.isPivotExplicitlySet() || pivotY != getPivotY()) { 10474 invalidateViewProperty(true, false); 10475 mRenderNode.setPivotY(pivotY); 10476 invalidateViewProperty(false, true); 10477 10478 invalidateParentIfNeededAndWasQuickRejected(); 10479 } 10480 } 10481 10482 /** 10483 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 10484 * completely transparent and 1 means the view is completely opaque. 10485 * 10486 * <p>By default this is 1.0f. 10487 * @return The opacity of the view. 10488 */ 10489 @ViewDebug.ExportedProperty(category = "drawing") 10490 public float getAlpha() { 10491 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 10492 } 10493 10494 /** 10495 * Returns whether this View has content which overlaps. 10496 * 10497 * <p>This function, intended to be overridden by specific View types, is an optimization when 10498 * alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to 10499 * an offscreen buffer and then composited into place, which can be expensive. If the view has 10500 * no overlapping rendering, the view can draw each primitive with the appropriate alpha value 10501 * directly. An example of overlapping rendering is a TextView with a background image, such as 10502 * a Button. An example of non-overlapping rendering is a TextView with no background, or an 10503 * ImageView with only the foreground image. The default implementation returns true; subclasses 10504 * should override if they have cases which can be optimized.</p> 10505 * 10506 * <p>The current implementation of the saveLayer and saveLayerAlpha methods in {@link Canvas} 10507 * necessitates that a View return true if it uses the methods internally without passing the 10508 * {@link Canvas#CLIP_TO_LAYER_SAVE_FLAG}.</p> 10509 * 10510 * @return true if the content in this view might overlap, false otherwise. 10511 */ 10512 @ViewDebug.ExportedProperty(category = "drawing") 10513 public boolean hasOverlappingRendering() { 10514 return true; 10515 } 10516 10517 /** 10518 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 10519 * completely transparent and 1 means the view is completely opaque.</p> 10520 * 10521 * <p> Note that setting alpha to a translucent value (0 < alpha < 1) can have significant 10522 * performance implications, especially for large views. It is best to use the alpha property 10523 * sparingly and transiently, as in the case of fading animations.</p> 10524 * 10525 * <p>For a view with a frequently changing alpha, such as during a fading animation, it is 10526 * strongly recommended for performance reasons to either override 10527 * {@link #hasOverlappingRendering()} to return false if appropriate, or setting a 10528 * {@link #setLayerType(int, android.graphics.Paint) layer type} on the view.</p> 10529 * 10530 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 10531 * responsible for applying the opacity itself.</p> 10532 * 10533 * <p>Note that if the view is backed by a 10534 * {@link #setLayerType(int, android.graphics.Paint) layer} and is associated with a 10535 * {@link #setLayerPaint(android.graphics.Paint) layer paint}, setting an alpha value less than 10536 * 1.0 will supercede the alpha of the layer paint.</p> 10537 * 10538 * @param alpha The opacity of the view. 10539 * 10540 * @see #hasOverlappingRendering() 10541 * @see #setLayerType(int, android.graphics.Paint) 10542 * 10543 * @attr ref android.R.styleable#View_alpha 10544 */ 10545 public void setAlpha(float alpha) { 10546 ensureTransformationInfo(); 10547 if (mTransformationInfo.mAlpha != alpha) { 10548 mTransformationInfo.mAlpha = alpha; 10549 if (onSetAlpha((int) (alpha * 255))) { 10550 mPrivateFlags |= PFLAG_ALPHA_SET; 10551 // subclass is handling alpha - don't optimize rendering cache invalidation 10552 invalidateParentCaches(); 10553 invalidate(true); 10554 } else { 10555 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10556 invalidateViewProperty(true, false); 10557 mRenderNode.setAlpha(getFinalAlpha()); 10558 notifyViewAccessibilityStateChangedIfNeeded( 10559 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 10560 } 10561 } 10562 } 10563 10564 /** 10565 * Faster version of setAlpha() which performs the same steps except there are 10566 * no calls to invalidate(). The caller of this function should perform proper invalidation 10567 * on the parent and this object. The return value indicates whether the subclass handles 10568 * alpha (the return value for onSetAlpha()). 10569 * 10570 * @param alpha The new value for the alpha property 10571 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 10572 * the new value for the alpha property is different from the old value 10573 */ 10574 boolean setAlphaNoInvalidation(float alpha) { 10575 ensureTransformationInfo(); 10576 if (mTransformationInfo.mAlpha != alpha) { 10577 mTransformationInfo.mAlpha = alpha; 10578 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 10579 if (subclassHandlesAlpha) { 10580 mPrivateFlags |= PFLAG_ALPHA_SET; 10581 return true; 10582 } else { 10583 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10584 mRenderNode.setAlpha(getFinalAlpha()); 10585 } 10586 } 10587 return false; 10588 } 10589 10590 /** 10591 * This property is hidden and intended only for use by the Fade transition, which 10592 * animates it to produce a visual translucency that does not side-effect (or get 10593 * affected by) the real alpha property. This value is composited with the other 10594 * alpha value (and the AlphaAnimation value, when that is present) to produce 10595 * a final visual translucency result, which is what is passed into the DisplayList. 10596 * 10597 * @hide 10598 */ 10599 public void setTransitionAlpha(float alpha) { 10600 ensureTransformationInfo(); 10601 if (mTransformationInfo.mTransitionAlpha != alpha) { 10602 mTransformationInfo.mTransitionAlpha = alpha; 10603 mPrivateFlags &= ~PFLAG_ALPHA_SET; 10604 invalidateViewProperty(true, false); 10605 mRenderNode.setAlpha(getFinalAlpha()); 10606 } 10607 } 10608 10609 /** 10610 * Calculates the visual alpha of this view, which is a combination of the actual 10611 * alpha value and the transitionAlpha value (if set). 10612 */ 10613 private float getFinalAlpha() { 10614 if (mTransformationInfo != null) { 10615 return mTransformationInfo.mAlpha * mTransformationInfo.mTransitionAlpha; 10616 } 10617 return 1; 10618 } 10619 10620 /** 10621 * This property is hidden and intended only for use by the Fade transition, which 10622 * animates it to produce a visual translucency that does not side-effect (or get 10623 * affected by) the real alpha property. This value is composited with the other 10624 * alpha value (and the AlphaAnimation value, when that is present) to produce 10625 * a final visual translucency result, which is what is passed into the DisplayList. 10626 * 10627 * @hide 10628 */ 10629 @ViewDebug.ExportedProperty(category = "drawing") 10630 public float getTransitionAlpha() { 10631 return mTransformationInfo != null ? mTransformationInfo.mTransitionAlpha : 1; 10632 } 10633 10634 /** 10635 * Top position of this view relative to its parent. 10636 * 10637 * @return The top of this view, in pixels. 10638 */ 10639 @ViewDebug.CapturedViewProperty 10640 public final int getTop() { 10641 return mTop; 10642 } 10643 10644 /** 10645 * Sets the top position of this view relative to its parent. This method is meant to be called 10646 * by the layout system and should not generally be called otherwise, because the property 10647 * may be changed at any time by the layout. 10648 * 10649 * @param top The top of this view, in pixels. 10650 */ 10651 public final void setTop(int top) { 10652 if (top != mTop) { 10653 final boolean matrixIsIdentity = hasIdentityMatrix(); 10654 if (matrixIsIdentity) { 10655 if (mAttachInfo != null) { 10656 int minTop; 10657 int yLoc; 10658 if (top < mTop) { 10659 minTop = top; 10660 yLoc = top - mTop; 10661 } else { 10662 minTop = mTop; 10663 yLoc = 0; 10664 } 10665 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 10666 } 10667 } else { 10668 // Double-invalidation is necessary to capture view's old and new areas 10669 invalidate(true); 10670 } 10671 10672 int width = mRight - mLeft; 10673 int oldHeight = mBottom - mTop; 10674 10675 mTop = top; 10676 mRenderNode.setTop(mTop); 10677 10678 sizeChange(width, mBottom - mTop, width, oldHeight); 10679 10680 if (!matrixIsIdentity) { 10681 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10682 invalidate(true); 10683 } 10684 mBackgroundSizeChanged = true; 10685 invalidateParentIfNeeded(); 10686 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10687 // View was rejected last time it was drawn by its parent; this may have changed 10688 invalidateParentIfNeeded(); 10689 } 10690 } 10691 } 10692 10693 /** 10694 * Bottom position of this view relative to its parent. 10695 * 10696 * @return The bottom of this view, in pixels. 10697 */ 10698 @ViewDebug.CapturedViewProperty 10699 public final int getBottom() { 10700 return mBottom; 10701 } 10702 10703 /** 10704 * True if this view has changed since the last time being drawn. 10705 * 10706 * @return The dirty state of this view. 10707 */ 10708 public boolean isDirty() { 10709 return (mPrivateFlags & PFLAG_DIRTY_MASK) != 0; 10710 } 10711 10712 /** 10713 * Sets the bottom position of this view relative to its parent. This method is meant to be 10714 * called by the layout system and should not generally be called otherwise, because the 10715 * property may be changed at any time by the layout. 10716 * 10717 * @param bottom The bottom of this view, in pixels. 10718 */ 10719 public final void setBottom(int bottom) { 10720 if (bottom != mBottom) { 10721 final boolean matrixIsIdentity = hasIdentityMatrix(); 10722 if (matrixIsIdentity) { 10723 if (mAttachInfo != null) { 10724 int maxBottom; 10725 if (bottom < mBottom) { 10726 maxBottom = mBottom; 10727 } else { 10728 maxBottom = bottom; 10729 } 10730 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 10731 } 10732 } else { 10733 // Double-invalidation is necessary to capture view's old and new areas 10734 invalidate(true); 10735 } 10736 10737 int width = mRight - mLeft; 10738 int oldHeight = mBottom - mTop; 10739 10740 mBottom = bottom; 10741 mRenderNode.setBottom(mBottom); 10742 10743 sizeChange(width, mBottom - mTop, width, oldHeight); 10744 10745 if (!matrixIsIdentity) { 10746 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10747 invalidate(true); 10748 } 10749 mBackgroundSizeChanged = true; 10750 invalidateParentIfNeeded(); 10751 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10752 // View was rejected last time it was drawn by its parent; this may have changed 10753 invalidateParentIfNeeded(); 10754 } 10755 } 10756 } 10757 10758 /** 10759 * Left position of this view relative to its parent. 10760 * 10761 * @return The left edge of this view, in pixels. 10762 */ 10763 @ViewDebug.CapturedViewProperty 10764 public final int getLeft() { 10765 return mLeft; 10766 } 10767 10768 /** 10769 * Sets the left position of this view relative to its parent. This method is meant to be called 10770 * by the layout system and should not generally be called otherwise, because the property 10771 * may be changed at any time by the layout. 10772 * 10773 * @param left The left of this view, in pixels. 10774 */ 10775 public final void setLeft(int left) { 10776 if (left != mLeft) { 10777 final boolean matrixIsIdentity = hasIdentityMatrix(); 10778 if (matrixIsIdentity) { 10779 if (mAttachInfo != null) { 10780 int minLeft; 10781 int xLoc; 10782 if (left < mLeft) { 10783 minLeft = left; 10784 xLoc = left - mLeft; 10785 } else { 10786 minLeft = mLeft; 10787 xLoc = 0; 10788 } 10789 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 10790 } 10791 } else { 10792 // Double-invalidation is necessary to capture view's old and new areas 10793 invalidate(true); 10794 } 10795 10796 int oldWidth = mRight - mLeft; 10797 int height = mBottom - mTop; 10798 10799 mLeft = left; 10800 mRenderNode.setLeft(left); 10801 10802 sizeChange(mRight - mLeft, height, oldWidth, height); 10803 10804 if (!matrixIsIdentity) { 10805 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10806 invalidate(true); 10807 } 10808 mBackgroundSizeChanged = true; 10809 invalidateParentIfNeeded(); 10810 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10811 // View was rejected last time it was drawn by its parent; this may have changed 10812 invalidateParentIfNeeded(); 10813 } 10814 } 10815 } 10816 10817 /** 10818 * Right position of this view relative to its parent. 10819 * 10820 * @return The right edge of this view, in pixels. 10821 */ 10822 @ViewDebug.CapturedViewProperty 10823 public final int getRight() { 10824 return mRight; 10825 } 10826 10827 /** 10828 * Sets the right position of this view relative to its parent. This method is meant to be called 10829 * by the layout system and should not generally be called otherwise, because the property 10830 * may be changed at any time by the layout. 10831 * 10832 * @param right The right of this view, in pixels. 10833 */ 10834 public final void setRight(int right) { 10835 if (right != mRight) { 10836 final boolean matrixIsIdentity = hasIdentityMatrix(); 10837 if (matrixIsIdentity) { 10838 if (mAttachInfo != null) { 10839 int maxRight; 10840 if (right < mRight) { 10841 maxRight = mRight; 10842 } else { 10843 maxRight = right; 10844 } 10845 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 10846 } 10847 } else { 10848 // Double-invalidation is necessary to capture view's old and new areas 10849 invalidate(true); 10850 } 10851 10852 int oldWidth = mRight - mLeft; 10853 int height = mBottom - mTop; 10854 10855 mRight = right; 10856 mRenderNode.setRight(mRight); 10857 10858 sizeChange(mRight - mLeft, height, oldWidth, height); 10859 10860 if (!matrixIsIdentity) { 10861 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10862 invalidate(true); 10863 } 10864 mBackgroundSizeChanged = true; 10865 invalidateParentIfNeeded(); 10866 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 10867 // View was rejected last time it was drawn by its parent; this may have changed 10868 invalidateParentIfNeeded(); 10869 } 10870 } 10871 } 10872 10873 /** 10874 * The visual x position of this view, in pixels. This is equivalent to the 10875 * {@link #setTranslationX(float) translationX} property plus the current 10876 * {@link #getLeft() left} property. 10877 * 10878 * @return The visual x position of this view, in pixels. 10879 */ 10880 @ViewDebug.ExportedProperty(category = "drawing") 10881 public float getX() { 10882 return mLeft + getTranslationX(); 10883 } 10884 10885 /** 10886 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 10887 * {@link #setTranslationX(float) translationX} property to be the difference between 10888 * the x value passed in and the current {@link #getLeft() left} property. 10889 * 10890 * @param x The visual x position of this view, in pixels. 10891 */ 10892 public void setX(float x) { 10893 setTranslationX(x - mLeft); 10894 } 10895 10896 /** 10897 * The visual y position of this view, in pixels. This is equivalent to the 10898 * {@link #setTranslationY(float) translationY} property plus the current 10899 * {@link #getTop() top} property. 10900 * 10901 * @return The visual y position of this view, in pixels. 10902 */ 10903 @ViewDebug.ExportedProperty(category = "drawing") 10904 public float getY() { 10905 return mTop + getTranslationY(); 10906 } 10907 10908 /** 10909 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 10910 * {@link #setTranslationY(float) translationY} property to be the difference between 10911 * the y value passed in and the current {@link #getTop() top} property. 10912 * 10913 * @param y The visual y position of this view, in pixels. 10914 */ 10915 public void setY(float y) { 10916 setTranslationY(y - mTop); 10917 } 10918 10919 /** 10920 * The visual z position of this view, in pixels. This is equivalent to the 10921 * {@link #setTranslationZ(float) translationZ} property plus the current 10922 * {@link #getElevation() elevation} property. 10923 * 10924 * @return The visual z position of this view, in pixels. 10925 */ 10926 @ViewDebug.ExportedProperty(category = "drawing") 10927 public float getZ() { 10928 return getElevation() + getTranslationZ(); 10929 } 10930 10931 /** 10932 * Sets the visual z position of this view, in pixels. This is equivalent to setting the 10933 * {@link #setTranslationZ(float) translationZ} property to be the difference between 10934 * the x value passed in and the current {@link #getElevation() elevation} property. 10935 * 10936 * @param z The visual z position of this view, in pixels. 10937 */ 10938 public void setZ(float z) { 10939 setTranslationZ(z - getElevation()); 10940 } 10941 10942 /** 10943 * The base elevation of this view relative to its parent, in pixels. 10944 * 10945 * @return The base depth position of the view, in pixels. 10946 */ 10947 @ViewDebug.ExportedProperty(category = "drawing") 10948 public float getElevation() { 10949 return mRenderNode.getElevation(); 10950 } 10951 10952 /** 10953 * Sets the base elevation of this view, in pixels. 10954 * 10955 * @attr ref android.R.styleable#View_elevation 10956 */ 10957 public void setElevation(float elevation) { 10958 if (elevation != getElevation()) { 10959 invalidateViewProperty(true, false); 10960 mRenderNode.setElevation(elevation); 10961 invalidateViewProperty(false, true); 10962 10963 invalidateParentIfNeededAndWasQuickRejected(); 10964 } 10965 } 10966 10967 /** 10968 * The horizontal location of this view relative to its {@link #getLeft() left} position. 10969 * This position is post-layout, in addition to wherever the object's 10970 * layout placed it. 10971 * 10972 * @return The horizontal position of this view relative to its left position, in pixels. 10973 */ 10974 @ViewDebug.ExportedProperty(category = "drawing") 10975 public float getTranslationX() { 10976 return mRenderNode.getTranslationX(); 10977 } 10978 10979 /** 10980 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 10981 * This effectively positions the object post-layout, in addition to wherever the object's 10982 * layout placed it. 10983 * 10984 * @param translationX The horizontal position of this view relative to its left position, 10985 * in pixels. 10986 * 10987 * @attr ref android.R.styleable#View_translationX 10988 */ 10989 public void setTranslationX(float translationX) { 10990 if (translationX != getTranslationX()) { 10991 invalidateViewProperty(true, false); 10992 mRenderNode.setTranslationX(translationX); 10993 invalidateViewProperty(false, true); 10994 10995 invalidateParentIfNeededAndWasQuickRejected(); 10996 notifySubtreeAccessibilityStateChangedIfNeeded(); 10997 } 10998 } 10999 11000 /** 11001 * The vertical location of this view relative to its {@link #getTop() top} position. 11002 * This position is post-layout, in addition to wherever the object's 11003 * layout placed it. 11004 * 11005 * @return The vertical position of this view relative to its top position, 11006 * in pixels. 11007 */ 11008 @ViewDebug.ExportedProperty(category = "drawing") 11009 public float getTranslationY() { 11010 return mRenderNode.getTranslationY(); 11011 } 11012 11013 /** 11014 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 11015 * This effectively positions the object post-layout, in addition to wherever the object's 11016 * layout placed it. 11017 * 11018 * @param translationY The vertical position of this view relative to its top position, 11019 * in pixels. 11020 * 11021 * @attr ref android.R.styleable#View_translationY 11022 */ 11023 public void setTranslationY(float translationY) { 11024 if (translationY != getTranslationY()) { 11025 invalidateViewProperty(true, false); 11026 mRenderNode.setTranslationY(translationY); 11027 invalidateViewProperty(false, true); 11028 11029 invalidateParentIfNeededAndWasQuickRejected(); 11030 } 11031 } 11032 11033 /** 11034 * The depth location of this view relative to its {@link #getElevation() elevation}. 11035 * 11036 * @return The depth of this view relative to its elevation. 11037 */ 11038 @ViewDebug.ExportedProperty(category = "drawing") 11039 public float getTranslationZ() { 11040 return mRenderNode.getTranslationZ(); 11041 } 11042 11043 /** 11044 * Sets the depth location of this view relative to its {@link #getElevation() elevation}. 11045 * 11046 * @attr ref android.R.styleable#View_translationZ 11047 */ 11048 public void setTranslationZ(float translationZ) { 11049 if (translationZ != getTranslationZ()) { 11050 invalidateViewProperty(true, false); 11051 mRenderNode.setTranslationZ(translationZ); 11052 invalidateViewProperty(false, true); 11053 11054 invalidateParentIfNeededAndWasQuickRejected(); 11055 } 11056 } 11057 11058 /** @hide */ 11059 public void setAnimationMatrix(Matrix matrix) { 11060 invalidateViewProperty(true, false); 11061 mRenderNode.setAnimationMatrix(matrix); 11062 invalidateViewProperty(false, true); 11063 11064 invalidateParentIfNeededAndWasQuickRejected(); 11065 } 11066 11067 /** 11068 * Returns the current StateListAnimator if exists. 11069 * 11070 * @return StateListAnimator or null if it does not exists 11071 * @see #setStateListAnimator(android.animation.StateListAnimator) 11072 */ 11073 public StateListAnimator getStateListAnimator() { 11074 return mStateListAnimator; 11075 } 11076 11077 /** 11078 * Attaches the provided StateListAnimator to this View. 11079 * <p> 11080 * Any previously attached StateListAnimator will be detached. 11081 * 11082 * @param stateListAnimator The StateListAnimator to update the view 11083 * @see {@link android.animation.StateListAnimator} 11084 */ 11085 public void setStateListAnimator(StateListAnimator stateListAnimator) { 11086 if (mStateListAnimator == stateListAnimator) { 11087 return; 11088 } 11089 if (mStateListAnimator != null) { 11090 mStateListAnimator.setTarget(null); 11091 } 11092 mStateListAnimator = stateListAnimator; 11093 if (stateListAnimator != null) { 11094 stateListAnimator.setTarget(this); 11095 if (isAttachedToWindow()) { 11096 stateListAnimator.setState(getDrawableState()); 11097 } 11098 } 11099 } 11100 11101 /** 11102 * Returns whether the Outline should be used to clip the contents of the View. 11103 * <p> 11104 * Note that this flag will only be respected if the View's Outline returns true from 11105 * {@link Outline#canClip()}. 11106 * 11107 * @see #setOutlineProvider(ViewOutlineProvider) 11108 * @see #setClipToOutline(boolean) 11109 */ 11110 public final boolean getClipToOutline() { 11111 return mRenderNode.getClipToOutline(); 11112 } 11113 11114 /** 11115 * Sets whether the View's Outline should be used to clip the contents of the View. 11116 * <p> 11117 * Only a single non-rectangular clip can be applied on a View at any time. 11118 * Circular clips from a {@link ViewAnimationUtils#createCircularReveal(View, int, int, float, float) 11119 * circular reveal} animation take priority over Outline clipping, and 11120 * child Outline clipping takes priority over Outline clipping done by a 11121 * parent. 11122 * <p> 11123 * Note that this flag will only be respected if the View's Outline returns true from 11124 * {@link Outline#canClip()}. 11125 * 11126 * @see #setOutlineProvider(ViewOutlineProvider) 11127 * @see #getClipToOutline() 11128 */ 11129 public void setClipToOutline(boolean clipToOutline) { 11130 damageInParent(); 11131 if (getClipToOutline() != clipToOutline) { 11132 mRenderNode.setClipToOutline(clipToOutline); 11133 } 11134 } 11135 11136 // correspond to the enum values of View_outlineProvider 11137 private static final int PROVIDER_BACKGROUND = 0; 11138 private static final int PROVIDER_NONE = 1; 11139 private static final int PROVIDER_BOUNDS = 2; 11140 private static final int PROVIDER_PADDED_BOUNDS = 3; 11141 private void setOutlineProviderFromAttribute(int providerInt) { 11142 switch (providerInt) { 11143 case PROVIDER_BACKGROUND: 11144 setOutlineProvider(ViewOutlineProvider.BACKGROUND); 11145 break; 11146 case PROVIDER_NONE: 11147 setOutlineProvider(null); 11148 break; 11149 case PROVIDER_BOUNDS: 11150 setOutlineProvider(ViewOutlineProvider.BOUNDS); 11151 break; 11152 case PROVIDER_PADDED_BOUNDS: 11153 setOutlineProvider(ViewOutlineProvider.PADDED_BOUNDS); 11154 break; 11155 } 11156 } 11157 11158 /** 11159 * Sets the {@link ViewOutlineProvider} of the view, which generates the Outline that defines 11160 * the shape of the shadow it casts, and enables outline clipping. 11161 * <p> 11162 * The default ViewOutlineProvider, {@link ViewOutlineProvider#BACKGROUND}, queries the Outline 11163 * from the View's background drawable, via {@link Drawable#getOutline(Outline)}. Changing the 11164 * outline provider with this method allows this behavior to be overridden. 11165 * <p> 11166 * If the ViewOutlineProvider is null, if querying it for an outline returns false, 11167 * or if the produced Outline is {@link Outline#isEmpty()}, shadows will not be cast. 11168 * <p> 11169 * Only outlines that return true from {@link Outline#canClip()} may be used for clipping. 11170 * 11171 * @see #setClipToOutline(boolean) 11172 * @see #getClipToOutline() 11173 * @see #getOutlineProvider() 11174 */ 11175 public void setOutlineProvider(ViewOutlineProvider provider) { 11176 mOutlineProvider = provider; 11177 invalidateOutline(); 11178 } 11179 11180 /** 11181 * Returns the current {@link ViewOutlineProvider} of the view, which generates the Outline 11182 * that defines the shape of the shadow it casts, and enables outline clipping. 11183 * 11184 * @see #setOutlineProvider(ViewOutlineProvider) 11185 */ 11186 public ViewOutlineProvider getOutlineProvider() { 11187 return mOutlineProvider; 11188 } 11189 11190 /** 11191 * Called to rebuild this View's Outline from its {@link ViewOutlineProvider outline provider} 11192 * 11193 * @see #setOutlineProvider(ViewOutlineProvider) 11194 */ 11195 public void invalidateOutline() { 11196 rebuildOutline(); 11197 11198 notifySubtreeAccessibilityStateChangedIfNeeded(); 11199 invalidateViewProperty(false, false); 11200 } 11201 11202 /** 11203 * Internal version of {@link #invalidateOutline()} which invalidates the 11204 * outline without invalidating the view itself. This is intended to be called from 11205 * within methods in the View class itself which are the result of the view being 11206 * invalidated already. For example, when we are drawing the background of a View, 11207 * we invalidate the outline in case it changed in the meantime, but we do not 11208 * need to invalidate the view because we're already drawing the background as part 11209 * of drawing the view in response to an earlier invalidation of the view. 11210 */ 11211 private void rebuildOutline() { 11212 // Unattached views ignore this signal, and outline is recomputed in onAttachedToWindow() 11213 if (mAttachInfo == null) return; 11214 11215 if (mOutlineProvider == null) { 11216 // no provider, remove outline 11217 mRenderNode.setOutline(null); 11218 } else { 11219 final Outline outline = mAttachInfo.mTmpOutline; 11220 outline.setEmpty(); 11221 outline.setAlpha(1.0f); 11222 11223 mOutlineProvider.getOutline(this, outline); 11224 mRenderNode.setOutline(outline); 11225 } 11226 } 11227 11228 /** 11229 * HierarchyViewer only 11230 * 11231 * @hide 11232 */ 11233 @ViewDebug.ExportedProperty(category = "drawing") 11234 public boolean hasShadow() { 11235 return mRenderNode.hasShadow(); 11236 } 11237 11238 11239 /** @hide */ 11240 public void setRevealClip(boolean shouldClip, float x, float y, float radius) { 11241 mRenderNode.setRevealClip(shouldClip, x, y, radius); 11242 invalidateViewProperty(false, false); 11243 } 11244 11245 /** 11246 * Hit rectangle in parent's coordinates 11247 * 11248 * @param outRect The hit rectangle of the view. 11249 */ 11250 public void getHitRect(Rect outRect) { 11251 if (hasIdentityMatrix() || mAttachInfo == null) { 11252 outRect.set(mLeft, mTop, mRight, mBottom); 11253 } else { 11254 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 11255 tmpRect.set(0, 0, getWidth(), getHeight()); 11256 getMatrix().mapRect(tmpRect); // TODO: mRenderNode.mapRect(tmpRect) 11257 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 11258 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 11259 } 11260 } 11261 11262 /** 11263 * Determines whether the given point, in local coordinates is inside the view. 11264 */ 11265 /*package*/ final boolean pointInView(float localX, float localY) { 11266 return localX >= 0 && localX < (mRight - mLeft) 11267 && localY >= 0 && localY < (mBottom - mTop); 11268 } 11269 11270 /** 11271 * Utility method to determine whether the given point, in local coordinates, 11272 * is inside the view, where the area of the view is expanded by the slop factor. 11273 * This method is called while processing touch-move events to determine if the event 11274 * is still within the view. 11275 * 11276 * @hide 11277 */ 11278 public boolean pointInView(float localX, float localY, float slop) { 11279 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 11280 localY < ((mBottom - mTop) + slop); 11281 } 11282 11283 /** 11284 * When a view has focus and the user navigates away from it, the next view is searched for 11285 * starting from the rectangle filled in by this method. 11286 * 11287 * By default, the rectangle is the {@link #getDrawingRect(android.graphics.Rect)}) 11288 * of the view. However, if your view maintains some idea of internal selection, 11289 * such as a cursor, or a selected row or column, you should override this method and 11290 * fill in a more specific rectangle. 11291 * 11292 * @param r The rectangle to fill in, in this view's coordinates. 11293 */ 11294 public void getFocusedRect(Rect r) { 11295 getDrawingRect(r); 11296 } 11297 11298 /** 11299 * If some part of this view is not clipped by any of its parents, then 11300 * return that area in r in global (root) coordinates. To convert r to local 11301 * coordinates (without taking possible View rotations into account), offset 11302 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 11303 * If the view is completely clipped or translated out, return false. 11304 * 11305 * @param r If true is returned, r holds the global coordinates of the 11306 * visible portion of this view. 11307 * @param globalOffset If true is returned, globalOffset holds the dx,dy 11308 * between this view and its root. globalOffet may be null. 11309 * @return true if r is non-empty (i.e. part of the view is visible at the 11310 * root level. 11311 */ 11312 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 11313 int width = mRight - mLeft; 11314 int height = mBottom - mTop; 11315 if (width > 0 && height > 0) { 11316 r.set(0, 0, width, height); 11317 if (globalOffset != null) { 11318 globalOffset.set(-mScrollX, -mScrollY); 11319 } 11320 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 11321 } 11322 return false; 11323 } 11324 11325 public final boolean getGlobalVisibleRect(Rect r) { 11326 return getGlobalVisibleRect(r, null); 11327 } 11328 11329 public final boolean getLocalVisibleRect(Rect r) { 11330 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point(); 11331 if (getGlobalVisibleRect(r, offset)) { 11332 r.offset(-offset.x, -offset.y); // make r local 11333 return true; 11334 } 11335 return false; 11336 } 11337 11338 /** 11339 * Offset this view's vertical location by the specified number of pixels. 11340 * 11341 * @param offset the number of pixels to offset the view by 11342 */ 11343 public void offsetTopAndBottom(int offset) { 11344 if (offset != 0) { 11345 final boolean matrixIsIdentity = hasIdentityMatrix(); 11346 if (matrixIsIdentity) { 11347 if (isHardwareAccelerated()) { 11348 invalidateViewProperty(false, false); 11349 } else { 11350 final ViewParent p = mParent; 11351 if (p != null && mAttachInfo != null) { 11352 final Rect r = mAttachInfo.mTmpInvalRect; 11353 int minTop; 11354 int maxBottom; 11355 int yLoc; 11356 if (offset < 0) { 11357 minTop = mTop + offset; 11358 maxBottom = mBottom; 11359 yLoc = offset; 11360 } else { 11361 minTop = mTop; 11362 maxBottom = mBottom + offset; 11363 yLoc = 0; 11364 } 11365 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 11366 p.invalidateChild(this, r); 11367 } 11368 } 11369 } else { 11370 invalidateViewProperty(false, false); 11371 } 11372 11373 mTop += offset; 11374 mBottom += offset; 11375 mRenderNode.offsetTopAndBottom(offset); 11376 if (isHardwareAccelerated()) { 11377 invalidateViewProperty(false, false); 11378 } else { 11379 if (!matrixIsIdentity) { 11380 invalidateViewProperty(false, true); 11381 } 11382 invalidateParentIfNeeded(); 11383 } 11384 notifySubtreeAccessibilityStateChangedIfNeeded(); 11385 } 11386 } 11387 11388 /** 11389 * Offset this view's horizontal location by the specified amount of pixels. 11390 * 11391 * @param offset the number of pixels to offset the view by 11392 */ 11393 public void offsetLeftAndRight(int offset) { 11394 if (offset != 0) { 11395 final boolean matrixIsIdentity = hasIdentityMatrix(); 11396 if (matrixIsIdentity) { 11397 if (isHardwareAccelerated()) { 11398 invalidateViewProperty(false, false); 11399 } else { 11400 final ViewParent p = mParent; 11401 if (p != null && mAttachInfo != null) { 11402 final Rect r = mAttachInfo.mTmpInvalRect; 11403 int minLeft; 11404 int maxRight; 11405 if (offset < 0) { 11406 minLeft = mLeft + offset; 11407 maxRight = mRight; 11408 } else { 11409 minLeft = mLeft; 11410 maxRight = mRight + offset; 11411 } 11412 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 11413 p.invalidateChild(this, r); 11414 } 11415 } 11416 } else { 11417 invalidateViewProperty(false, false); 11418 } 11419 11420 mLeft += offset; 11421 mRight += offset; 11422 mRenderNode.offsetLeftAndRight(offset); 11423 if (isHardwareAccelerated()) { 11424 invalidateViewProperty(false, false); 11425 } else { 11426 if (!matrixIsIdentity) { 11427 invalidateViewProperty(false, true); 11428 } 11429 invalidateParentIfNeeded(); 11430 } 11431 notifySubtreeAccessibilityStateChangedIfNeeded(); 11432 } 11433 } 11434 11435 /** 11436 * Get the LayoutParams associated with this view. All views should have 11437 * layout parameters. These supply parameters to the <i>parent</i> of this 11438 * view specifying how it should be arranged. There are many subclasses of 11439 * ViewGroup.LayoutParams, and these correspond to the different subclasses 11440 * of ViewGroup that are responsible for arranging their children. 11441 * 11442 * This method may return null if this View is not attached to a parent 11443 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 11444 * was not invoked successfully. When a View is attached to a parent 11445 * ViewGroup, this method must not return null. 11446 * 11447 * @return The LayoutParams associated with this view, or null if no 11448 * parameters have been set yet 11449 */ 11450 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 11451 public ViewGroup.LayoutParams getLayoutParams() { 11452 return mLayoutParams; 11453 } 11454 11455 /** 11456 * Set the layout parameters associated with this view. These supply 11457 * parameters to the <i>parent</i> of this view specifying how it should be 11458 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 11459 * correspond to the different subclasses of ViewGroup that are responsible 11460 * for arranging their children. 11461 * 11462 * @param params The layout parameters for this view, cannot be null 11463 */ 11464 public void setLayoutParams(ViewGroup.LayoutParams params) { 11465 if (params == null) { 11466 throw new NullPointerException("Layout parameters cannot be null"); 11467 } 11468 mLayoutParams = params; 11469 resolveLayoutParams(); 11470 if (mParent instanceof ViewGroup) { 11471 ((ViewGroup) mParent).onSetLayoutParams(this, params); 11472 } 11473 requestLayout(); 11474 } 11475 11476 /** 11477 * Resolve the layout parameters depending on the resolved layout direction 11478 * 11479 * @hide 11480 */ 11481 public void resolveLayoutParams() { 11482 if (mLayoutParams != null) { 11483 mLayoutParams.resolveLayoutDirection(getLayoutDirection()); 11484 } 11485 } 11486 11487 /** 11488 * Set the scrolled position of your view. This will cause a call to 11489 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11490 * invalidated. 11491 * @param x the x position to scroll to 11492 * @param y the y position to scroll to 11493 */ 11494 public void scrollTo(int x, int y) { 11495 if (mScrollX != x || mScrollY != y) { 11496 int oldX = mScrollX; 11497 int oldY = mScrollY; 11498 mScrollX = x; 11499 mScrollY = y; 11500 invalidateParentCaches(); 11501 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 11502 if (!awakenScrollBars()) { 11503 postInvalidateOnAnimation(); 11504 } 11505 } 11506 } 11507 11508 /** 11509 * Move the scrolled position of your view. This will cause a call to 11510 * {@link #onScrollChanged(int, int, int, int)} and the view will be 11511 * invalidated. 11512 * @param x the amount of pixels to scroll by horizontally 11513 * @param y the amount of pixels to scroll by vertically 11514 */ 11515 public void scrollBy(int x, int y) { 11516 scrollTo(mScrollX + x, mScrollY + y); 11517 } 11518 11519 /** 11520 * <p>Trigger the scrollbars to draw. When invoked this method starts an 11521 * animation to fade the scrollbars out after a default delay. If a subclass 11522 * provides animated scrolling, the start delay should equal the duration 11523 * of the scrolling animation.</p> 11524 * 11525 * <p>The animation starts only if at least one of the scrollbars is 11526 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 11527 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11528 * this method returns true, and false otherwise. If the animation is 11529 * started, this method calls {@link #invalidate()}; in that case the 11530 * caller should not call {@link #invalidate()}.</p> 11531 * 11532 * <p>This method should be invoked every time a subclass directly updates 11533 * the scroll parameters.</p> 11534 * 11535 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 11536 * and {@link #scrollTo(int, int)}.</p> 11537 * 11538 * @return true if the animation is played, false otherwise 11539 * 11540 * @see #awakenScrollBars(int) 11541 * @see #scrollBy(int, int) 11542 * @see #scrollTo(int, int) 11543 * @see #isHorizontalScrollBarEnabled() 11544 * @see #isVerticalScrollBarEnabled() 11545 * @see #setHorizontalScrollBarEnabled(boolean) 11546 * @see #setVerticalScrollBarEnabled(boolean) 11547 */ 11548 protected boolean awakenScrollBars() { 11549 return mScrollCache != null && 11550 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 11551 } 11552 11553 /** 11554 * Trigger the scrollbars to draw. 11555 * This method differs from awakenScrollBars() only in its default duration. 11556 * initialAwakenScrollBars() will show the scroll bars for longer than 11557 * usual to give the user more of a chance to notice them. 11558 * 11559 * @return true if the animation is played, false otherwise. 11560 */ 11561 private boolean initialAwakenScrollBars() { 11562 return mScrollCache != null && 11563 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 11564 } 11565 11566 /** 11567 * <p> 11568 * Trigger the scrollbars to draw. When invoked this method starts an 11569 * animation to fade the scrollbars out after a fixed delay. If a subclass 11570 * provides animated scrolling, the start delay should equal the duration of 11571 * the scrolling animation. 11572 * </p> 11573 * 11574 * <p> 11575 * The animation starts only if at least one of the scrollbars is enabled, 11576 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11577 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11578 * this method returns true, and false otherwise. If the animation is 11579 * started, this method calls {@link #invalidate()}; in that case the caller 11580 * should not call {@link #invalidate()}. 11581 * </p> 11582 * 11583 * <p> 11584 * This method should be invoked everytime a subclass directly updates the 11585 * scroll parameters. 11586 * </p> 11587 * 11588 * @param startDelay the delay, in milliseconds, after which the animation 11589 * should start; when the delay is 0, the animation starts 11590 * immediately 11591 * @return true if the animation is played, false otherwise 11592 * 11593 * @see #scrollBy(int, int) 11594 * @see #scrollTo(int, int) 11595 * @see #isHorizontalScrollBarEnabled() 11596 * @see #isVerticalScrollBarEnabled() 11597 * @see #setHorizontalScrollBarEnabled(boolean) 11598 * @see #setVerticalScrollBarEnabled(boolean) 11599 */ 11600 protected boolean awakenScrollBars(int startDelay) { 11601 return awakenScrollBars(startDelay, true); 11602 } 11603 11604 /** 11605 * <p> 11606 * Trigger the scrollbars to draw. When invoked this method starts an 11607 * animation to fade the scrollbars out after a fixed delay. If a subclass 11608 * provides animated scrolling, the start delay should equal the duration of 11609 * the scrolling animation. 11610 * </p> 11611 * 11612 * <p> 11613 * The animation starts only if at least one of the scrollbars is enabled, 11614 * as specified by {@link #isHorizontalScrollBarEnabled()} and 11615 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 11616 * this method returns true, and false otherwise. If the animation is 11617 * started, this method calls {@link #invalidate()} if the invalidate parameter 11618 * is set to true; in that case the caller 11619 * should not call {@link #invalidate()}. 11620 * </p> 11621 * 11622 * <p> 11623 * This method should be invoked everytime a subclass directly updates the 11624 * scroll parameters. 11625 * </p> 11626 * 11627 * @param startDelay the delay, in milliseconds, after which the animation 11628 * should start; when the delay is 0, the animation starts 11629 * immediately 11630 * 11631 * @param invalidate Wheter this method should call invalidate 11632 * 11633 * @return true if the animation is played, false otherwise 11634 * 11635 * @see #scrollBy(int, int) 11636 * @see #scrollTo(int, int) 11637 * @see #isHorizontalScrollBarEnabled() 11638 * @see #isVerticalScrollBarEnabled() 11639 * @see #setHorizontalScrollBarEnabled(boolean) 11640 * @see #setVerticalScrollBarEnabled(boolean) 11641 */ 11642 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 11643 final ScrollabilityCache scrollCache = mScrollCache; 11644 11645 if (scrollCache == null || !scrollCache.fadeScrollBars) { 11646 return false; 11647 } 11648 11649 if (scrollCache.scrollBar == null) { 11650 scrollCache.scrollBar = new ScrollBarDrawable(); 11651 } 11652 11653 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 11654 11655 if (invalidate) { 11656 // Invalidate to show the scrollbars 11657 postInvalidateOnAnimation(); 11658 } 11659 11660 if (scrollCache.state == ScrollabilityCache.OFF) { 11661 // FIXME: this is copied from WindowManagerService. 11662 // We should get this value from the system when it 11663 // is possible to do so. 11664 final int KEY_REPEAT_FIRST_DELAY = 750; 11665 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 11666 } 11667 11668 // Tell mScrollCache when we should start fading. This may 11669 // extend the fade start time if one was already scheduled 11670 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 11671 scrollCache.fadeStartTime = fadeStartTime; 11672 scrollCache.state = ScrollabilityCache.ON; 11673 11674 // Schedule our fader to run, unscheduling any old ones first 11675 if (mAttachInfo != null) { 11676 mAttachInfo.mHandler.removeCallbacks(scrollCache); 11677 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 11678 } 11679 11680 return true; 11681 } 11682 11683 return false; 11684 } 11685 11686 /** 11687 * Do not invalidate views which are not visible and which are not running an animation. They 11688 * will not get drawn and they should not set dirty flags as if they will be drawn 11689 */ 11690 private boolean skipInvalidate() { 11691 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 11692 (!(mParent instanceof ViewGroup) || 11693 !((ViewGroup) mParent).isViewTransitioning(this)); 11694 } 11695 11696 /** 11697 * Mark the area defined by dirty as needing to be drawn. If the view is 11698 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11699 * point in the future. 11700 * <p> 11701 * This must be called from a UI thread. To call from a non-UI thread, call 11702 * {@link #postInvalidate()}. 11703 * <p> 11704 * <b>WARNING:</b> In API 19 and below, this method may be destructive to 11705 * {@code dirty}. 11706 * 11707 * @param dirty the rectangle representing the bounds of the dirty region 11708 */ 11709 public void invalidate(Rect dirty) { 11710 final int scrollX = mScrollX; 11711 final int scrollY = mScrollY; 11712 invalidateInternal(dirty.left - scrollX, dirty.top - scrollY, 11713 dirty.right - scrollX, dirty.bottom - scrollY, true, false); 11714 } 11715 11716 /** 11717 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. The 11718 * coordinates of the dirty rect are relative to the view. If the view is 11719 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some 11720 * point in the future. 11721 * <p> 11722 * This must be called from a UI thread. To call from a non-UI thread, call 11723 * {@link #postInvalidate()}. 11724 * 11725 * @param l the left position of the dirty region 11726 * @param t the top position of the dirty region 11727 * @param r the right position of the dirty region 11728 * @param b the bottom position of the dirty region 11729 */ 11730 public void invalidate(int l, int t, int r, int b) { 11731 final int scrollX = mScrollX; 11732 final int scrollY = mScrollY; 11733 invalidateInternal(l - scrollX, t - scrollY, r - scrollX, b - scrollY, true, false); 11734 } 11735 11736 /** 11737 * Invalidate the whole view. If the view is visible, 11738 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 11739 * the future. 11740 * <p> 11741 * This must be called from a UI thread. To call from a non-UI thread, call 11742 * {@link #postInvalidate()}. 11743 */ 11744 public void invalidate() { 11745 invalidate(true); 11746 } 11747 11748 /** 11749 * This is where the invalidate() work actually happens. A full invalidate() 11750 * causes the drawing cache to be invalidated, but this function can be 11751 * called with invalidateCache set to false to skip that invalidation step 11752 * for cases that do not need it (for example, a component that remains at 11753 * the same dimensions with the same content). 11754 * 11755 * @param invalidateCache Whether the drawing cache for this view should be 11756 * invalidated as well. This is usually true for a full 11757 * invalidate, but may be set to false if the View's contents or 11758 * dimensions have not changed. 11759 */ 11760 void invalidate(boolean invalidateCache) { 11761 invalidateInternal(0, 0, mRight - mLeft, mBottom - mTop, invalidateCache, true); 11762 } 11763 11764 void invalidateInternal(int l, int t, int r, int b, boolean invalidateCache, 11765 boolean fullInvalidate) { 11766 if (mGhostView != null) { 11767 mGhostView.invalidate(true); 11768 return; 11769 } 11770 11771 if (skipInvalidate()) { 11772 return; 11773 } 11774 11775 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) 11776 || (invalidateCache && (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) 11777 || (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED 11778 || (fullInvalidate && isOpaque() != mLastIsOpaque)) { 11779 if (fullInvalidate) { 11780 mLastIsOpaque = isOpaque(); 11781 mPrivateFlags &= ~PFLAG_DRAWN; 11782 } 11783 11784 mPrivateFlags |= PFLAG_DIRTY; 11785 11786 if (invalidateCache) { 11787 mPrivateFlags |= PFLAG_INVALIDATED; 11788 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 11789 } 11790 11791 // Propagate the damage rectangle to the parent view. 11792 final AttachInfo ai = mAttachInfo; 11793 final ViewParent p = mParent; 11794 if (p != null && ai != null && l < r && t < b) { 11795 final Rect damage = ai.mTmpInvalRect; 11796 damage.set(l, t, r, b); 11797 p.invalidateChild(this, damage); 11798 } 11799 11800 // Damage the entire projection receiver, if necessary. 11801 if (mBackground != null && mBackground.isProjected()) { 11802 final View receiver = getProjectionReceiver(); 11803 if (receiver != null) { 11804 receiver.damageInParent(); 11805 } 11806 } 11807 11808 // Damage the entire IsolatedZVolume receiving this view's shadow. 11809 if (isHardwareAccelerated() && getZ() != 0) { 11810 damageShadowReceiver(); 11811 } 11812 } 11813 } 11814 11815 /** 11816 * @return this view's projection receiver, or {@code null} if none exists 11817 */ 11818 private View getProjectionReceiver() { 11819 ViewParent p = getParent(); 11820 while (p != null && p instanceof View) { 11821 final View v = (View) p; 11822 if (v.isProjectionReceiver()) { 11823 return v; 11824 } 11825 p = p.getParent(); 11826 } 11827 11828 return null; 11829 } 11830 11831 /** 11832 * @return whether the view is a projection receiver 11833 */ 11834 private boolean isProjectionReceiver() { 11835 return mBackground != null; 11836 } 11837 11838 /** 11839 * Damage area of the screen that can be covered by this View's shadow. 11840 * 11841 * This method will guarantee that any changes to shadows cast by a View 11842 * are damaged on the screen for future redraw. 11843 */ 11844 private void damageShadowReceiver() { 11845 final AttachInfo ai = mAttachInfo; 11846 if (ai != null) { 11847 ViewParent p = getParent(); 11848 if (p != null && p instanceof ViewGroup) { 11849 final ViewGroup vg = (ViewGroup) p; 11850 vg.damageInParent(); 11851 } 11852 } 11853 } 11854 11855 /** 11856 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to 11857 * set any flags or handle all of the cases handled by the default invalidation methods. 11858 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate 11859 * dirty rect. This method calls into fast invalidation methods in ViewGroup that 11860 * walk up the hierarchy, transforming the dirty rect as necessary. 11861 * 11862 * The method also handles normal invalidation logic if display list properties are not 11863 * being used in this view. The invalidateParent and forceRedraw flags are used by that 11864 * backup approach, to handle these cases used in the various property-setting methods. 11865 * 11866 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties 11867 * are not being used in this view 11868 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display 11869 * list properties are not being used in this view 11870 */ 11871 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) { 11872 if (!isHardwareAccelerated() 11873 || !mRenderNode.isValid() 11874 || (mPrivateFlags & PFLAG_DRAW_ANIMATION) != 0) { 11875 if (invalidateParent) { 11876 invalidateParentCaches(); 11877 } 11878 if (forceRedraw) { 11879 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 11880 } 11881 invalidate(false); 11882 } else { 11883 damageInParent(); 11884 } 11885 if (isHardwareAccelerated() && invalidateParent && getZ() != 0) { 11886 damageShadowReceiver(); 11887 } 11888 } 11889 11890 /** 11891 * Tells the parent view to damage this view's bounds. 11892 * 11893 * @hide 11894 */ 11895 protected void damageInParent() { 11896 final AttachInfo ai = mAttachInfo; 11897 final ViewParent p = mParent; 11898 if (p != null && ai != null) { 11899 final Rect r = ai.mTmpInvalRect; 11900 r.set(0, 0, mRight - mLeft, mBottom - mTop); 11901 if (mParent instanceof ViewGroup) { 11902 ((ViewGroup) mParent).damageChild(this, r); 11903 } else { 11904 mParent.invalidateChild(this, r); 11905 } 11906 } 11907 } 11908 11909 /** 11910 * Utility method to transform a given Rect by the current matrix of this view. 11911 */ 11912 void transformRect(final Rect rect) { 11913 if (!getMatrix().isIdentity()) { 11914 RectF boundingRect = mAttachInfo.mTmpTransformRect; 11915 boundingRect.set(rect); 11916 getMatrix().mapRect(boundingRect); 11917 rect.set((int) Math.floor(boundingRect.left), 11918 (int) Math.floor(boundingRect.top), 11919 (int) Math.ceil(boundingRect.right), 11920 (int) Math.ceil(boundingRect.bottom)); 11921 } 11922 } 11923 11924 /** 11925 * Used to indicate that the parent of this view should clear its caches. This functionality 11926 * is used to force the parent to rebuild its display list (when hardware-accelerated), 11927 * which is necessary when various parent-managed properties of the view change, such as 11928 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 11929 * clears the parent caches and does not causes an invalidate event. 11930 * 11931 * @hide 11932 */ 11933 protected void invalidateParentCaches() { 11934 if (mParent instanceof View) { 11935 ((View) mParent).mPrivateFlags |= PFLAG_INVALIDATED; 11936 } 11937 } 11938 11939 /** 11940 * Used to indicate that the parent of this view should be invalidated. This functionality 11941 * is used to force the parent to rebuild its display list (when hardware-accelerated), 11942 * which is necessary when various parent-managed properties of the view change, such as 11943 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 11944 * an invalidation event to the parent. 11945 * 11946 * @hide 11947 */ 11948 protected void invalidateParentIfNeeded() { 11949 if (isHardwareAccelerated() && mParent instanceof View) { 11950 ((View) mParent).invalidate(true); 11951 } 11952 } 11953 11954 /** 11955 * @hide 11956 */ 11957 protected void invalidateParentIfNeededAndWasQuickRejected() { 11958 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) != 0) { 11959 // View was rejected last time it was drawn by its parent; this may have changed 11960 invalidateParentIfNeeded(); 11961 } 11962 } 11963 11964 /** 11965 * Indicates whether this View is opaque. An opaque View guarantees that it will 11966 * draw all the pixels overlapping its bounds using a fully opaque color. 11967 * 11968 * Subclasses of View should override this method whenever possible to indicate 11969 * whether an instance is opaque. Opaque Views are treated in a special way by 11970 * the View hierarchy, possibly allowing it to perform optimizations during 11971 * invalidate/draw passes. 11972 * 11973 * @return True if this View is guaranteed to be fully opaque, false otherwise. 11974 */ 11975 @ViewDebug.ExportedProperty(category = "drawing") 11976 public boolean isOpaque() { 11977 return (mPrivateFlags & PFLAG_OPAQUE_MASK) == PFLAG_OPAQUE_MASK && 11978 getFinalAlpha() >= 1.0f; 11979 } 11980 11981 /** 11982 * @hide 11983 */ 11984 protected void computeOpaqueFlags() { 11985 // Opaque if: 11986 // - Has a background 11987 // - Background is opaque 11988 // - Doesn't have scrollbars or scrollbars overlay 11989 11990 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) { 11991 mPrivateFlags |= PFLAG_OPAQUE_BACKGROUND; 11992 } else { 11993 mPrivateFlags &= ~PFLAG_OPAQUE_BACKGROUND; 11994 } 11995 11996 final int flags = mViewFlags; 11997 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 11998 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY || 11999 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_OUTSIDE_OVERLAY) { 12000 mPrivateFlags |= PFLAG_OPAQUE_SCROLLBARS; 12001 } else { 12002 mPrivateFlags &= ~PFLAG_OPAQUE_SCROLLBARS; 12003 } 12004 } 12005 12006 /** 12007 * @hide 12008 */ 12009 protected boolean hasOpaqueScrollbars() { 12010 return (mPrivateFlags & PFLAG_OPAQUE_SCROLLBARS) == PFLAG_OPAQUE_SCROLLBARS; 12011 } 12012 12013 /** 12014 * @return A handler associated with the thread running the View. This 12015 * handler can be used to pump events in the UI events queue. 12016 */ 12017 public Handler getHandler() { 12018 final AttachInfo attachInfo = mAttachInfo; 12019 if (attachInfo != null) { 12020 return attachInfo.mHandler; 12021 } 12022 return null; 12023 } 12024 12025 /** 12026 * Gets the view root associated with the View. 12027 * @return The view root, or null if none. 12028 * @hide 12029 */ 12030 public ViewRootImpl getViewRootImpl() { 12031 if (mAttachInfo != null) { 12032 return mAttachInfo.mViewRootImpl; 12033 } 12034 return null; 12035 } 12036 12037 /** 12038 * @hide 12039 */ 12040 public HardwareRenderer getHardwareRenderer() { 12041 return mAttachInfo != null ? mAttachInfo.mHardwareRenderer : null; 12042 } 12043 12044 /** 12045 * <p>Causes the Runnable to be added to the message queue. 12046 * The runnable will be run on the user interface thread.</p> 12047 * 12048 * @param action The Runnable that will be executed. 12049 * 12050 * @return Returns true if the Runnable was successfully placed in to the 12051 * message queue. Returns false on failure, usually because the 12052 * looper processing the message queue is exiting. 12053 * 12054 * @see #postDelayed 12055 * @see #removeCallbacks 12056 */ 12057 public boolean post(Runnable action) { 12058 final AttachInfo attachInfo = mAttachInfo; 12059 if (attachInfo != null) { 12060 return attachInfo.mHandler.post(action); 12061 } 12062 // Assume that post will succeed later 12063 ViewRootImpl.getRunQueue().post(action); 12064 return true; 12065 } 12066 12067 /** 12068 * <p>Causes the Runnable to be added to the message queue, to be run 12069 * after the specified amount of time elapses. 12070 * The runnable will be run on the user interface thread.</p> 12071 * 12072 * @param action The Runnable that will be executed. 12073 * @param delayMillis The delay (in milliseconds) until the Runnable 12074 * will be executed. 12075 * 12076 * @return true if the Runnable was successfully placed in to the 12077 * message queue. Returns false on failure, usually because the 12078 * looper processing the message queue is exiting. Note that a 12079 * result of true does not mean the Runnable will be processed -- 12080 * if the looper is quit before the delivery time of the message 12081 * occurs then the message will be dropped. 12082 * 12083 * @see #post 12084 * @see #removeCallbacks 12085 */ 12086 public boolean postDelayed(Runnable action, long delayMillis) { 12087 final AttachInfo attachInfo = mAttachInfo; 12088 if (attachInfo != null) { 12089 return attachInfo.mHandler.postDelayed(action, delayMillis); 12090 } 12091 // Assume that post will succeed later 12092 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12093 return true; 12094 } 12095 12096 /** 12097 * <p>Causes the Runnable to execute on the next animation time step. 12098 * The runnable will be run on the user interface thread.</p> 12099 * 12100 * @param action The Runnable that will be executed. 12101 * 12102 * @see #postOnAnimationDelayed 12103 * @see #removeCallbacks 12104 */ 12105 public void postOnAnimation(Runnable action) { 12106 final AttachInfo attachInfo = mAttachInfo; 12107 if (attachInfo != null) { 12108 attachInfo.mViewRootImpl.mChoreographer.postCallback( 12109 Choreographer.CALLBACK_ANIMATION, action, null); 12110 } else { 12111 // Assume that post will succeed later 12112 ViewRootImpl.getRunQueue().post(action); 12113 } 12114 } 12115 12116 /** 12117 * <p>Causes the Runnable to execute on the next animation time step, 12118 * after the specified amount of time elapses. 12119 * The runnable will be run on the user interface thread.</p> 12120 * 12121 * @param action The Runnable that will be executed. 12122 * @param delayMillis The delay (in milliseconds) until the Runnable 12123 * will be executed. 12124 * 12125 * @see #postOnAnimation 12126 * @see #removeCallbacks 12127 */ 12128 public void postOnAnimationDelayed(Runnable action, long delayMillis) { 12129 final AttachInfo attachInfo = mAttachInfo; 12130 if (attachInfo != null) { 12131 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 12132 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis); 12133 } else { 12134 // Assume that post will succeed later 12135 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 12136 } 12137 } 12138 12139 /** 12140 * <p>Removes the specified Runnable from the message queue.</p> 12141 * 12142 * @param action The Runnable to remove from the message handling queue 12143 * 12144 * @return true if this view could ask the Handler to remove the Runnable, 12145 * false otherwise. When the returned value is true, the Runnable 12146 * may or may not have been actually removed from the message queue 12147 * (for instance, if the Runnable was not in the queue already.) 12148 * 12149 * @see #post 12150 * @see #postDelayed 12151 * @see #postOnAnimation 12152 * @see #postOnAnimationDelayed 12153 */ 12154 public boolean removeCallbacks(Runnable action) { 12155 if (action != null) { 12156 final AttachInfo attachInfo = mAttachInfo; 12157 if (attachInfo != null) { 12158 attachInfo.mHandler.removeCallbacks(action); 12159 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 12160 Choreographer.CALLBACK_ANIMATION, action, null); 12161 } 12162 // Assume that post will succeed later 12163 ViewRootImpl.getRunQueue().removeCallbacks(action); 12164 } 12165 return true; 12166 } 12167 12168 /** 12169 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 12170 * Use this to invalidate the View from a non-UI thread.</p> 12171 * 12172 * <p>This method can be invoked from outside of the UI thread 12173 * only when this View is attached to a window.</p> 12174 * 12175 * @see #invalidate() 12176 * @see #postInvalidateDelayed(long) 12177 */ 12178 public void postInvalidate() { 12179 postInvalidateDelayed(0); 12180 } 12181 12182 /** 12183 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12184 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 12185 * 12186 * <p>This method can be invoked from outside of the UI thread 12187 * only when this View is attached to a window.</p> 12188 * 12189 * @param left The left coordinate of the rectangle to invalidate. 12190 * @param top The top coordinate of the rectangle to invalidate. 12191 * @param right The right coordinate of the rectangle to invalidate. 12192 * @param bottom The bottom coordinate of the rectangle to invalidate. 12193 * 12194 * @see #invalidate(int, int, int, int) 12195 * @see #invalidate(Rect) 12196 * @see #postInvalidateDelayed(long, int, int, int, int) 12197 */ 12198 public void postInvalidate(int left, int top, int right, int bottom) { 12199 postInvalidateDelayed(0, left, top, right, bottom); 12200 } 12201 12202 /** 12203 * <p>Cause an invalidate to happen on a subsequent cycle through the event 12204 * loop. Waits for the specified amount of time.</p> 12205 * 12206 * <p>This method can be invoked from outside of the UI thread 12207 * only when this View is attached to a window.</p> 12208 * 12209 * @param delayMilliseconds the duration in milliseconds to delay the 12210 * invalidation by 12211 * 12212 * @see #invalidate() 12213 * @see #postInvalidate() 12214 */ 12215 public void postInvalidateDelayed(long delayMilliseconds) { 12216 // We try only with the AttachInfo because there's no point in invalidating 12217 // if we are not attached to our window 12218 final AttachInfo attachInfo = mAttachInfo; 12219 if (attachInfo != null) { 12220 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds); 12221 } 12222 } 12223 12224 /** 12225 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 12226 * through the event loop. Waits for the specified amount of time.</p> 12227 * 12228 * <p>This method can be invoked from outside of the UI thread 12229 * only when this View is attached to a window.</p> 12230 * 12231 * @param delayMilliseconds the duration in milliseconds to delay the 12232 * invalidation by 12233 * @param left The left coordinate of the rectangle to invalidate. 12234 * @param top The top coordinate of the rectangle to invalidate. 12235 * @param right The right coordinate of the rectangle to invalidate. 12236 * @param bottom The bottom coordinate of the rectangle to invalidate. 12237 * 12238 * @see #invalidate(int, int, int, int) 12239 * @see #invalidate(Rect) 12240 * @see #postInvalidate(int, int, int, int) 12241 */ 12242 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 12243 int right, int bottom) { 12244 12245 // We try only with the AttachInfo because there's no point in invalidating 12246 // if we are not attached to our window 12247 final AttachInfo attachInfo = mAttachInfo; 12248 if (attachInfo != null) { 12249 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12250 info.target = this; 12251 info.left = left; 12252 info.top = top; 12253 info.right = right; 12254 info.bottom = bottom; 12255 12256 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds); 12257 } 12258 } 12259 12260 /** 12261 * <p>Cause an invalidate to happen on the next animation time step, typically the 12262 * next display frame.</p> 12263 * 12264 * <p>This method can be invoked from outside of the UI thread 12265 * only when this View is attached to a window.</p> 12266 * 12267 * @see #invalidate() 12268 */ 12269 public void postInvalidateOnAnimation() { 12270 // We try only with the AttachInfo because there's no point in invalidating 12271 // if we are not attached to our window 12272 final AttachInfo attachInfo = mAttachInfo; 12273 if (attachInfo != null) { 12274 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this); 12275 } 12276 } 12277 12278 /** 12279 * <p>Cause an invalidate of the specified area to happen on the next animation 12280 * time step, typically the next display frame.</p> 12281 * 12282 * <p>This method can be invoked from outside of the UI thread 12283 * only when this View is attached to a window.</p> 12284 * 12285 * @param left The left coordinate of the rectangle to invalidate. 12286 * @param top The top coordinate of the rectangle to invalidate. 12287 * @param right The right coordinate of the rectangle to invalidate. 12288 * @param bottom The bottom coordinate of the rectangle to invalidate. 12289 * 12290 * @see #invalidate(int, int, int, int) 12291 * @see #invalidate(Rect) 12292 */ 12293 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) { 12294 // We try only with the AttachInfo because there's no point in invalidating 12295 // if we are not attached to our window 12296 final AttachInfo attachInfo = mAttachInfo; 12297 if (attachInfo != null) { 12298 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.obtain(); 12299 info.target = this; 12300 info.left = left; 12301 info.top = top; 12302 info.right = right; 12303 info.bottom = bottom; 12304 12305 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info); 12306 } 12307 } 12308 12309 /** 12310 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 12311 * This event is sent at most once every 12312 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 12313 */ 12314 private void postSendViewScrolledAccessibilityEventCallback() { 12315 if (mSendViewScrolledAccessibilityEvent == null) { 12316 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 12317 } 12318 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 12319 mSendViewScrolledAccessibilityEvent.mIsPending = true; 12320 postDelayed(mSendViewScrolledAccessibilityEvent, 12321 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 12322 } 12323 } 12324 12325 /** 12326 * Called by a parent to request that a child update its values for mScrollX 12327 * and mScrollY if necessary. This will typically be done if the child is 12328 * animating a scroll using a {@link android.widget.Scroller Scroller} 12329 * object. 12330 */ 12331 public void computeScroll() { 12332 } 12333 12334 /** 12335 * <p>Indicate whether the horizontal edges are faded when the view is 12336 * scrolled horizontally.</p> 12337 * 12338 * @return true if the horizontal edges should are faded on scroll, false 12339 * otherwise 12340 * 12341 * @see #setHorizontalFadingEdgeEnabled(boolean) 12342 * 12343 * @attr ref android.R.styleable#View_requiresFadingEdge 12344 */ 12345 public boolean isHorizontalFadingEdgeEnabled() { 12346 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 12347 } 12348 12349 /** 12350 * <p>Define whether the horizontal edges should be faded when this view 12351 * is scrolled horizontally.</p> 12352 * 12353 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 12354 * be faded when the view is scrolled 12355 * horizontally 12356 * 12357 * @see #isHorizontalFadingEdgeEnabled() 12358 * 12359 * @attr ref android.R.styleable#View_requiresFadingEdge 12360 */ 12361 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 12362 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 12363 if (horizontalFadingEdgeEnabled) { 12364 initScrollCache(); 12365 } 12366 12367 mViewFlags ^= FADING_EDGE_HORIZONTAL; 12368 } 12369 } 12370 12371 /** 12372 * <p>Indicate whether the vertical edges are faded when the view is 12373 * scrolled horizontally.</p> 12374 * 12375 * @return true if the vertical edges should are faded on scroll, false 12376 * otherwise 12377 * 12378 * @see #setVerticalFadingEdgeEnabled(boolean) 12379 * 12380 * @attr ref android.R.styleable#View_requiresFadingEdge 12381 */ 12382 public boolean isVerticalFadingEdgeEnabled() { 12383 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 12384 } 12385 12386 /** 12387 * <p>Define whether the vertical edges should be faded when this view 12388 * is scrolled vertically.</p> 12389 * 12390 * @param verticalFadingEdgeEnabled true if the vertical edges should 12391 * be faded when the view is scrolled 12392 * vertically 12393 * 12394 * @see #isVerticalFadingEdgeEnabled() 12395 * 12396 * @attr ref android.R.styleable#View_requiresFadingEdge 12397 */ 12398 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 12399 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 12400 if (verticalFadingEdgeEnabled) { 12401 initScrollCache(); 12402 } 12403 12404 mViewFlags ^= FADING_EDGE_VERTICAL; 12405 } 12406 } 12407 12408 /** 12409 * Returns the strength, or intensity, of the top faded edge. The strength is 12410 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12411 * returns 0.0 or 1.0 but no value in between. 12412 * 12413 * Subclasses should override this method to provide a smoother fade transition 12414 * when scrolling occurs. 12415 * 12416 * @return the intensity of the top fade as a float between 0.0f and 1.0f 12417 */ 12418 protected float getTopFadingEdgeStrength() { 12419 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 12420 } 12421 12422 /** 12423 * Returns the strength, or intensity, of the bottom faded edge. The strength is 12424 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12425 * returns 0.0 or 1.0 but no value in between. 12426 * 12427 * Subclasses should override this method to provide a smoother fade transition 12428 * when scrolling occurs. 12429 * 12430 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 12431 */ 12432 protected float getBottomFadingEdgeStrength() { 12433 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 12434 computeVerticalScrollRange() ? 1.0f : 0.0f; 12435 } 12436 12437 /** 12438 * Returns the strength, or intensity, of the left faded edge. The strength is 12439 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12440 * returns 0.0 or 1.0 but no value in between. 12441 * 12442 * Subclasses should override this method to provide a smoother fade transition 12443 * when scrolling occurs. 12444 * 12445 * @return the intensity of the left fade as a float between 0.0f and 1.0f 12446 */ 12447 protected float getLeftFadingEdgeStrength() { 12448 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 12449 } 12450 12451 /** 12452 * Returns the strength, or intensity, of the right faded edge. The strength is 12453 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 12454 * returns 0.0 or 1.0 but no value in between. 12455 * 12456 * Subclasses should override this method to provide a smoother fade transition 12457 * when scrolling occurs. 12458 * 12459 * @return the intensity of the right fade as a float between 0.0f and 1.0f 12460 */ 12461 protected float getRightFadingEdgeStrength() { 12462 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 12463 computeHorizontalScrollRange() ? 1.0f : 0.0f; 12464 } 12465 12466 /** 12467 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 12468 * scrollbar is not drawn by default.</p> 12469 * 12470 * @return true if the horizontal scrollbar should be painted, false 12471 * otherwise 12472 * 12473 * @see #setHorizontalScrollBarEnabled(boolean) 12474 */ 12475 public boolean isHorizontalScrollBarEnabled() { 12476 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12477 } 12478 12479 /** 12480 * <p>Define whether the horizontal scrollbar should be drawn or not. The 12481 * scrollbar is not drawn by default.</p> 12482 * 12483 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 12484 * be painted 12485 * 12486 * @see #isHorizontalScrollBarEnabled() 12487 */ 12488 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 12489 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 12490 mViewFlags ^= SCROLLBARS_HORIZONTAL; 12491 computeOpaqueFlags(); 12492 resolvePadding(); 12493 } 12494 } 12495 12496 /** 12497 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 12498 * scrollbar is not drawn by default.</p> 12499 * 12500 * @return true if the vertical scrollbar should be painted, false 12501 * otherwise 12502 * 12503 * @see #setVerticalScrollBarEnabled(boolean) 12504 */ 12505 public boolean isVerticalScrollBarEnabled() { 12506 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 12507 } 12508 12509 /** 12510 * <p>Define whether the vertical scrollbar should be drawn or not. The 12511 * scrollbar is not drawn by default.</p> 12512 * 12513 * @param verticalScrollBarEnabled true if the vertical scrollbar should 12514 * be painted 12515 * 12516 * @see #isVerticalScrollBarEnabled() 12517 */ 12518 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 12519 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 12520 mViewFlags ^= SCROLLBARS_VERTICAL; 12521 computeOpaqueFlags(); 12522 resolvePadding(); 12523 } 12524 } 12525 12526 /** 12527 * @hide 12528 */ 12529 protected void recomputePadding() { 12530 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 12531 } 12532 12533 /** 12534 * Define whether scrollbars will fade when the view is not scrolling. 12535 * 12536 * @param fadeScrollbars wheter to enable fading 12537 * 12538 * @attr ref android.R.styleable#View_fadeScrollbars 12539 */ 12540 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 12541 initScrollCache(); 12542 final ScrollabilityCache scrollabilityCache = mScrollCache; 12543 scrollabilityCache.fadeScrollBars = fadeScrollbars; 12544 if (fadeScrollbars) { 12545 scrollabilityCache.state = ScrollabilityCache.OFF; 12546 } else { 12547 scrollabilityCache.state = ScrollabilityCache.ON; 12548 } 12549 } 12550 12551 /** 12552 * 12553 * Returns true if scrollbars will fade when this view is not scrolling 12554 * 12555 * @return true if scrollbar fading is enabled 12556 * 12557 * @attr ref android.R.styleable#View_fadeScrollbars 12558 */ 12559 public boolean isScrollbarFadingEnabled() { 12560 return mScrollCache != null && mScrollCache.fadeScrollBars; 12561 } 12562 12563 /** 12564 * 12565 * Returns the delay before scrollbars fade. 12566 * 12567 * @return the delay before scrollbars fade 12568 * 12569 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12570 */ 12571 public int getScrollBarDefaultDelayBeforeFade() { 12572 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() : 12573 mScrollCache.scrollBarDefaultDelayBeforeFade; 12574 } 12575 12576 /** 12577 * Define the delay before scrollbars fade. 12578 * 12579 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade 12580 * 12581 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 12582 */ 12583 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) { 12584 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade; 12585 } 12586 12587 /** 12588 * 12589 * Returns the scrollbar fade duration. 12590 * 12591 * @return the scrollbar fade duration 12592 * 12593 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12594 */ 12595 public int getScrollBarFadeDuration() { 12596 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() : 12597 mScrollCache.scrollBarFadeDuration; 12598 } 12599 12600 /** 12601 * Define the scrollbar fade duration. 12602 * 12603 * @param scrollBarFadeDuration - the scrollbar fade duration 12604 * 12605 * @attr ref android.R.styleable#View_scrollbarFadeDuration 12606 */ 12607 public void setScrollBarFadeDuration(int scrollBarFadeDuration) { 12608 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration; 12609 } 12610 12611 /** 12612 * 12613 * Returns the scrollbar size. 12614 * 12615 * @return the scrollbar size 12616 * 12617 * @attr ref android.R.styleable#View_scrollbarSize 12618 */ 12619 public int getScrollBarSize() { 12620 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() : 12621 mScrollCache.scrollBarSize; 12622 } 12623 12624 /** 12625 * Define the scrollbar size. 12626 * 12627 * @param scrollBarSize - the scrollbar size 12628 * 12629 * @attr ref android.R.styleable#View_scrollbarSize 12630 */ 12631 public void setScrollBarSize(int scrollBarSize) { 12632 getScrollCache().scrollBarSize = scrollBarSize; 12633 } 12634 12635 /** 12636 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 12637 * inset. When inset, they add to the padding of the view. And the scrollbars 12638 * can be drawn inside the padding area or on the edge of the view. For example, 12639 * if a view has a background drawable and you want to draw the scrollbars 12640 * inside the padding specified by the drawable, you can use 12641 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 12642 * appear at the edge of the view, ignoring the padding, then you can use 12643 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 12644 * @param style the style of the scrollbars. Should be one of 12645 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 12646 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 12647 * @see #SCROLLBARS_INSIDE_OVERLAY 12648 * @see #SCROLLBARS_INSIDE_INSET 12649 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12650 * @see #SCROLLBARS_OUTSIDE_INSET 12651 * 12652 * @attr ref android.R.styleable#View_scrollbarStyle 12653 */ 12654 public void setScrollBarStyle(@ScrollBarStyle int style) { 12655 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 12656 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 12657 computeOpaqueFlags(); 12658 resolvePadding(); 12659 } 12660 } 12661 12662 /** 12663 * <p>Returns the current scrollbar style.</p> 12664 * @return the current scrollbar style 12665 * @see #SCROLLBARS_INSIDE_OVERLAY 12666 * @see #SCROLLBARS_INSIDE_INSET 12667 * @see #SCROLLBARS_OUTSIDE_OVERLAY 12668 * @see #SCROLLBARS_OUTSIDE_INSET 12669 * 12670 * @attr ref android.R.styleable#View_scrollbarStyle 12671 */ 12672 @ViewDebug.ExportedProperty(mapping = { 12673 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 12674 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 12675 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 12676 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 12677 }) 12678 @ScrollBarStyle 12679 public int getScrollBarStyle() { 12680 return mViewFlags & SCROLLBARS_STYLE_MASK; 12681 } 12682 12683 /** 12684 * <p>Compute the horizontal range that the horizontal scrollbar 12685 * represents.</p> 12686 * 12687 * <p>The range is expressed in arbitrary units that must be the same as the 12688 * units used by {@link #computeHorizontalScrollExtent()} and 12689 * {@link #computeHorizontalScrollOffset()}.</p> 12690 * 12691 * <p>The default range is the drawing width of this view.</p> 12692 * 12693 * @return the total horizontal range represented by the horizontal 12694 * scrollbar 12695 * 12696 * @see #computeHorizontalScrollExtent() 12697 * @see #computeHorizontalScrollOffset() 12698 * @see android.widget.ScrollBarDrawable 12699 */ 12700 protected int computeHorizontalScrollRange() { 12701 return getWidth(); 12702 } 12703 12704 /** 12705 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 12706 * within the horizontal range. This value is used to compute the position 12707 * of the thumb within the scrollbar's track.</p> 12708 * 12709 * <p>The range is expressed in arbitrary units that must be the same as the 12710 * units used by {@link #computeHorizontalScrollRange()} and 12711 * {@link #computeHorizontalScrollExtent()}.</p> 12712 * 12713 * <p>The default offset is the scroll offset of this view.</p> 12714 * 12715 * @return the horizontal offset of the scrollbar's thumb 12716 * 12717 * @see #computeHorizontalScrollRange() 12718 * @see #computeHorizontalScrollExtent() 12719 * @see android.widget.ScrollBarDrawable 12720 */ 12721 protected int computeHorizontalScrollOffset() { 12722 return mScrollX; 12723 } 12724 12725 /** 12726 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 12727 * within the horizontal range. This value is used to compute the length 12728 * of the thumb within the scrollbar's track.</p> 12729 * 12730 * <p>The range is expressed in arbitrary units that must be the same as the 12731 * units used by {@link #computeHorizontalScrollRange()} and 12732 * {@link #computeHorizontalScrollOffset()}.</p> 12733 * 12734 * <p>The default extent is the drawing width of this view.</p> 12735 * 12736 * @return the horizontal extent of the scrollbar's thumb 12737 * 12738 * @see #computeHorizontalScrollRange() 12739 * @see #computeHorizontalScrollOffset() 12740 * @see android.widget.ScrollBarDrawable 12741 */ 12742 protected int computeHorizontalScrollExtent() { 12743 return getWidth(); 12744 } 12745 12746 /** 12747 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 12748 * 12749 * <p>The range is expressed in arbitrary units that must be the same as the 12750 * units used by {@link #computeVerticalScrollExtent()} and 12751 * {@link #computeVerticalScrollOffset()}.</p> 12752 * 12753 * @return the total vertical range represented by the vertical scrollbar 12754 * 12755 * <p>The default range is the drawing height of this view.</p> 12756 * 12757 * @see #computeVerticalScrollExtent() 12758 * @see #computeVerticalScrollOffset() 12759 * @see android.widget.ScrollBarDrawable 12760 */ 12761 protected int computeVerticalScrollRange() { 12762 return getHeight(); 12763 } 12764 12765 /** 12766 * <p>Compute the vertical offset of the vertical scrollbar's thumb 12767 * within the horizontal range. This value is used to compute the position 12768 * of the thumb within the scrollbar's track.</p> 12769 * 12770 * <p>The range is expressed in arbitrary units that must be the same as the 12771 * units used by {@link #computeVerticalScrollRange()} and 12772 * {@link #computeVerticalScrollExtent()}.</p> 12773 * 12774 * <p>The default offset is the scroll offset of this view.</p> 12775 * 12776 * @return the vertical offset of the scrollbar's thumb 12777 * 12778 * @see #computeVerticalScrollRange() 12779 * @see #computeVerticalScrollExtent() 12780 * @see android.widget.ScrollBarDrawable 12781 */ 12782 protected int computeVerticalScrollOffset() { 12783 return mScrollY; 12784 } 12785 12786 /** 12787 * <p>Compute the vertical extent of the vertical scrollbar's thumb 12788 * within the vertical range. This value is used to compute the length 12789 * of the thumb within the scrollbar's track.</p> 12790 * 12791 * <p>The range is expressed in arbitrary units that must be the same as the 12792 * units used by {@link #computeVerticalScrollRange()} and 12793 * {@link #computeVerticalScrollOffset()}.</p> 12794 * 12795 * <p>The default extent is the drawing height of this view.</p> 12796 * 12797 * @return the vertical extent of the scrollbar's thumb 12798 * 12799 * @see #computeVerticalScrollRange() 12800 * @see #computeVerticalScrollOffset() 12801 * @see android.widget.ScrollBarDrawable 12802 */ 12803 protected int computeVerticalScrollExtent() { 12804 return getHeight(); 12805 } 12806 12807 /** 12808 * Check if this view can be scrolled horizontally in a certain direction. 12809 * 12810 * @param direction Negative to check scrolling left, positive to check scrolling right. 12811 * @return true if this view can be scrolled in the specified direction, false otherwise. 12812 */ 12813 public boolean canScrollHorizontally(int direction) { 12814 final int offset = computeHorizontalScrollOffset(); 12815 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 12816 if (range == 0) return false; 12817 if (direction < 0) { 12818 return offset > 0; 12819 } else { 12820 return offset < range - 1; 12821 } 12822 } 12823 12824 /** 12825 * Check if this view can be scrolled vertically in a certain direction. 12826 * 12827 * @param direction Negative to check scrolling up, positive to check scrolling down. 12828 * @return true if this view can be scrolled in the specified direction, false otherwise. 12829 */ 12830 public boolean canScrollVertically(int direction) { 12831 final int offset = computeVerticalScrollOffset(); 12832 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 12833 if (range == 0) return false; 12834 if (direction < 0) { 12835 return offset > 0; 12836 } else { 12837 return offset < range - 1; 12838 } 12839 } 12840 12841 /** 12842 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 12843 * scrollbars are painted only if they have been awakened first.</p> 12844 * 12845 * @param canvas the canvas on which to draw the scrollbars 12846 * 12847 * @see #awakenScrollBars(int) 12848 */ 12849 protected final void onDrawScrollBars(Canvas canvas) { 12850 // scrollbars are drawn only when the animation is running 12851 final ScrollabilityCache cache = mScrollCache; 12852 if (cache != null) { 12853 12854 int state = cache.state; 12855 12856 if (state == ScrollabilityCache.OFF) { 12857 return; 12858 } 12859 12860 boolean invalidate = false; 12861 12862 if (state == ScrollabilityCache.FADING) { 12863 // We're fading -- get our fade interpolation 12864 if (cache.interpolatorValues == null) { 12865 cache.interpolatorValues = new float[1]; 12866 } 12867 12868 float[] values = cache.interpolatorValues; 12869 12870 // Stops the animation if we're done 12871 if (cache.scrollBarInterpolator.timeToValues(values) == 12872 Interpolator.Result.FREEZE_END) { 12873 cache.state = ScrollabilityCache.OFF; 12874 } else { 12875 cache.scrollBar.mutate().setAlpha(Math.round(values[0])); 12876 } 12877 12878 // This will make the scroll bars inval themselves after 12879 // drawing. We only want this when we're fading so that 12880 // we prevent excessive redraws 12881 invalidate = true; 12882 } else { 12883 // We're just on -- but we may have been fading before so 12884 // reset alpha 12885 cache.scrollBar.mutate().setAlpha(255); 12886 } 12887 12888 12889 final int viewFlags = mViewFlags; 12890 12891 final boolean drawHorizontalScrollBar = 12892 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 12893 final boolean drawVerticalScrollBar = 12894 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 12895 && !isVerticalScrollBarHidden(); 12896 12897 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 12898 final int width = mRight - mLeft; 12899 final int height = mBottom - mTop; 12900 12901 final ScrollBarDrawable scrollBar = cache.scrollBar; 12902 12903 final int scrollX = mScrollX; 12904 final int scrollY = mScrollY; 12905 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 12906 12907 int left; 12908 int top; 12909 int right; 12910 int bottom; 12911 12912 if (drawHorizontalScrollBar) { 12913 int size = scrollBar.getSize(false); 12914 if (size <= 0) { 12915 size = cache.scrollBarSize; 12916 } 12917 12918 scrollBar.setParameters(computeHorizontalScrollRange(), 12919 computeHorizontalScrollOffset(), 12920 computeHorizontalScrollExtent(), false); 12921 final int verticalScrollBarGap = drawVerticalScrollBar ? 12922 getVerticalScrollbarWidth() : 0; 12923 top = scrollY + height - size - (mUserPaddingBottom & inside); 12924 left = scrollX + (mPaddingLeft & inside); 12925 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 12926 bottom = top + size; 12927 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 12928 if (invalidate) { 12929 invalidate(left, top, right, bottom); 12930 } 12931 } 12932 12933 if (drawVerticalScrollBar) { 12934 int size = scrollBar.getSize(true); 12935 if (size <= 0) { 12936 size = cache.scrollBarSize; 12937 } 12938 12939 scrollBar.setParameters(computeVerticalScrollRange(), 12940 computeVerticalScrollOffset(), 12941 computeVerticalScrollExtent(), true); 12942 int verticalScrollbarPosition = mVerticalScrollbarPosition; 12943 if (verticalScrollbarPosition == SCROLLBAR_POSITION_DEFAULT) { 12944 verticalScrollbarPosition = isLayoutRtl() ? 12945 SCROLLBAR_POSITION_LEFT : SCROLLBAR_POSITION_RIGHT; 12946 } 12947 switch (verticalScrollbarPosition) { 12948 default: 12949 case SCROLLBAR_POSITION_RIGHT: 12950 left = scrollX + width - size - (mUserPaddingRight & inside); 12951 break; 12952 case SCROLLBAR_POSITION_LEFT: 12953 left = scrollX + (mUserPaddingLeft & inside); 12954 break; 12955 } 12956 top = scrollY + (mPaddingTop & inside); 12957 right = left + size; 12958 bottom = scrollY + height - (mUserPaddingBottom & inside); 12959 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 12960 if (invalidate) { 12961 invalidate(left, top, right, bottom); 12962 } 12963 } 12964 } 12965 } 12966 } 12967 12968 /** 12969 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 12970 * FastScroller is visible. 12971 * @return whether to temporarily hide the vertical scrollbar 12972 * @hide 12973 */ 12974 protected boolean isVerticalScrollBarHidden() { 12975 return false; 12976 } 12977 12978 /** 12979 * <p>Draw the horizontal scrollbar if 12980 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 12981 * 12982 * @param canvas the canvas on which to draw the scrollbar 12983 * @param scrollBar the scrollbar's drawable 12984 * 12985 * @see #isHorizontalScrollBarEnabled() 12986 * @see #computeHorizontalScrollRange() 12987 * @see #computeHorizontalScrollExtent() 12988 * @see #computeHorizontalScrollOffset() 12989 * @see android.widget.ScrollBarDrawable 12990 * @hide 12991 */ 12992 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 12993 int l, int t, int r, int b) { 12994 scrollBar.setBounds(l, t, r, b); 12995 scrollBar.draw(canvas); 12996 } 12997 12998 /** 12999 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 13000 * returns true.</p> 13001 * 13002 * @param canvas the canvas on which to draw the scrollbar 13003 * @param scrollBar the scrollbar's drawable 13004 * 13005 * @see #isVerticalScrollBarEnabled() 13006 * @see #computeVerticalScrollRange() 13007 * @see #computeVerticalScrollExtent() 13008 * @see #computeVerticalScrollOffset() 13009 * @see android.widget.ScrollBarDrawable 13010 * @hide 13011 */ 13012 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 13013 int l, int t, int r, int b) { 13014 scrollBar.setBounds(l, t, r, b); 13015 scrollBar.draw(canvas); 13016 } 13017 13018 /** 13019 * Implement this to do your drawing. 13020 * 13021 * @param canvas the canvas on which the background will be drawn 13022 */ 13023 protected void onDraw(Canvas canvas) { 13024 } 13025 13026 /* 13027 * Caller is responsible for calling requestLayout if necessary. 13028 * (This allows addViewInLayout to not request a new layout.) 13029 */ 13030 void assignParent(ViewParent parent) { 13031 if (mParent == null) { 13032 mParent = parent; 13033 } else if (parent == null) { 13034 mParent = null; 13035 } else { 13036 throw new RuntimeException("view " + this + " being added, but" 13037 + " it already has a parent"); 13038 } 13039 } 13040 13041 /** 13042 * This is called when the view is attached to a window. At this point it 13043 * has a Surface and will start drawing. Note that this function is 13044 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 13045 * however it may be called any time before the first onDraw -- including 13046 * before or after {@link #onMeasure(int, int)}. 13047 * 13048 * @see #onDetachedFromWindow() 13049 */ 13050 protected void onAttachedToWindow() { 13051 if ((mPrivateFlags & PFLAG_REQUEST_TRANSPARENT_REGIONS) != 0) { 13052 mParent.requestTransparentRegion(this); 13053 } 13054 13055 if ((mPrivateFlags & PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 13056 initialAwakenScrollBars(); 13057 mPrivateFlags &= ~PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 13058 } 13059 13060 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13061 13062 jumpDrawablesToCurrentState(); 13063 13064 resetSubtreeAccessibilityStateChanged(); 13065 13066 // rebuild, since Outline not maintained while View is detached 13067 rebuildOutline(); 13068 13069 if (isFocused()) { 13070 InputMethodManager imm = InputMethodManager.peekInstance(); 13071 imm.focusIn(this); 13072 } 13073 } 13074 13075 /** 13076 * Resolve all RTL related properties. 13077 * 13078 * @return true if resolution of RTL properties has been done 13079 * 13080 * @hide 13081 */ 13082 public boolean resolveRtlPropertiesIfNeeded() { 13083 if (!needRtlPropertiesResolution()) return false; 13084 13085 // Order is important here: LayoutDirection MUST be resolved first 13086 if (!isLayoutDirectionResolved()) { 13087 resolveLayoutDirection(); 13088 resolveLayoutParams(); 13089 } 13090 // ... then we can resolve the others properties depending on the resolved LayoutDirection. 13091 if (!isTextDirectionResolved()) { 13092 resolveTextDirection(); 13093 } 13094 if (!isTextAlignmentResolved()) { 13095 resolveTextAlignment(); 13096 } 13097 // Should resolve Drawables before Padding because we need the layout direction of the 13098 // Drawable to correctly resolve Padding. 13099 if (!areDrawablesResolved()) { 13100 resolveDrawables(); 13101 } 13102 if (!isPaddingResolved()) { 13103 resolvePadding(); 13104 } 13105 onRtlPropertiesChanged(getLayoutDirection()); 13106 return true; 13107 } 13108 13109 /** 13110 * Reset resolution of all RTL related properties. 13111 * 13112 * @hide 13113 */ 13114 public void resetRtlProperties() { 13115 resetResolvedLayoutDirection(); 13116 resetResolvedTextDirection(); 13117 resetResolvedTextAlignment(); 13118 resetResolvedPadding(); 13119 resetResolvedDrawables(); 13120 } 13121 13122 /** 13123 * @see #onScreenStateChanged(int) 13124 */ 13125 void dispatchScreenStateChanged(int screenState) { 13126 onScreenStateChanged(screenState); 13127 } 13128 13129 /** 13130 * This method is called whenever the state of the screen this view is 13131 * attached to changes. A state change will usually occurs when the screen 13132 * turns on or off (whether it happens automatically or the user does it 13133 * manually.) 13134 * 13135 * @param screenState The new state of the screen. Can be either 13136 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF} 13137 */ 13138 public void onScreenStateChanged(int screenState) { 13139 } 13140 13141 /** 13142 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true 13143 */ 13144 private boolean hasRtlSupport() { 13145 return mContext.getApplicationInfo().hasRtlSupport(); 13146 } 13147 13148 /** 13149 * Return true if we are in RTL compatibility mode (either before Jelly Bean MR1 or 13150 * RTL not supported) 13151 */ 13152 private boolean isRtlCompatibilityMode() { 13153 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 13154 return targetSdkVersion < JELLY_BEAN_MR1 || !hasRtlSupport(); 13155 } 13156 13157 /** 13158 * @return true if RTL properties need resolution. 13159 * 13160 */ 13161 private boolean needRtlPropertiesResolution() { 13162 return (mPrivateFlags2 & ALL_RTL_PROPERTIES_RESOLVED) != ALL_RTL_PROPERTIES_RESOLVED; 13163 } 13164 13165 /** 13166 * Called when any RTL property (layout direction or text direction or text alignment) has 13167 * been changed. 13168 * 13169 * Subclasses need to override this method to take care of cached information that depends on the 13170 * resolved layout direction, or to inform child views that inherit their layout direction. 13171 * 13172 * The default implementation does nothing. 13173 * 13174 * @param layoutDirection the direction of the layout 13175 * 13176 * @see #LAYOUT_DIRECTION_LTR 13177 * @see #LAYOUT_DIRECTION_RTL 13178 */ 13179 public void onRtlPropertiesChanged(@ResolvedLayoutDir int layoutDirection) { 13180 } 13181 13182 /** 13183 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 13184 * that the parent directionality can and will be resolved before its children. 13185 * 13186 * @return true if resolution has been done, false otherwise. 13187 * 13188 * @hide 13189 */ 13190 public boolean resolveLayoutDirection() { 13191 // Clear any previous layout direction resolution 13192 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13193 13194 if (hasRtlSupport()) { 13195 // Set resolved depending on layout direction 13196 switch ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> 13197 PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) { 13198 case LAYOUT_DIRECTION_INHERIT: 13199 // We cannot resolve yet. LTR is by default and let the resolution happen again 13200 // later to get the correct resolved value 13201 if (!canResolveLayoutDirection()) return false; 13202 13203 // Parent has not yet resolved, LTR is still the default 13204 try { 13205 if (!mParent.isLayoutDirectionResolved()) return false; 13206 13207 if (mParent.getLayoutDirection() == LAYOUT_DIRECTION_RTL) { 13208 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13209 } 13210 } catch (AbstractMethodError e) { 13211 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13212 " does not fully implement ViewParent", e); 13213 } 13214 break; 13215 case LAYOUT_DIRECTION_RTL: 13216 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13217 break; 13218 case LAYOUT_DIRECTION_LOCALE: 13219 if((LAYOUT_DIRECTION_RTL == 13220 TextUtils.getLayoutDirectionFromLocale(Locale.getDefault()))) { 13221 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 13222 } 13223 break; 13224 default: 13225 // Nothing to do, LTR by default 13226 } 13227 } 13228 13229 // Set to resolved 13230 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13231 return true; 13232 } 13233 13234 /** 13235 * Check if layout direction resolution can be done. 13236 * 13237 * @return true if layout direction resolution can be done otherwise return false. 13238 */ 13239 public boolean canResolveLayoutDirection() { 13240 switch (getRawLayoutDirection()) { 13241 case LAYOUT_DIRECTION_INHERIT: 13242 if (mParent != null) { 13243 try { 13244 return mParent.canResolveLayoutDirection(); 13245 } catch (AbstractMethodError e) { 13246 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 13247 " does not fully implement ViewParent", e); 13248 } 13249 } 13250 return false; 13251 13252 default: 13253 return true; 13254 } 13255 } 13256 13257 /** 13258 * Reset the resolved layout direction. Layout direction will be resolved during a call to 13259 * {@link #onMeasure(int, int)}. 13260 * 13261 * @hide 13262 */ 13263 public void resetResolvedLayoutDirection() { 13264 // Reset the current resolved bits 13265 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 13266 } 13267 13268 /** 13269 * @return true if the layout direction is inherited. 13270 * 13271 * @hide 13272 */ 13273 public boolean isLayoutDirectionInherited() { 13274 return (getRawLayoutDirection() == LAYOUT_DIRECTION_INHERIT); 13275 } 13276 13277 /** 13278 * @return true if layout direction has been resolved. 13279 */ 13280 public boolean isLayoutDirectionResolved() { 13281 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED) == PFLAG2_LAYOUT_DIRECTION_RESOLVED; 13282 } 13283 13284 /** 13285 * Return if padding has been resolved 13286 * 13287 * @hide 13288 */ 13289 boolean isPaddingResolved() { 13290 return (mPrivateFlags2 & PFLAG2_PADDING_RESOLVED) == PFLAG2_PADDING_RESOLVED; 13291 } 13292 13293 /** 13294 * Resolves padding depending on layout direction, if applicable, and 13295 * recomputes internal padding values to adjust for scroll bars. 13296 * 13297 * @hide 13298 */ 13299 public void resolvePadding() { 13300 final int resolvedLayoutDirection = getLayoutDirection(); 13301 13302 if (!isRtlCompatibilityMode()) { 13303 // Post Jelly Bean MR1 case: we need to take the resolved layout direction into account. 13304 // If start / end padding are defined, they will be resolved (hence overriding) to 13305 // left / right or right / left depending on the resolved layout direction. 13306 // If start / end padding are not defined, use the left / right ones. 13307 if (mBackground != null && (!mLeftPaddingDefined || !mRightPaddingDefined)) { 13308 Rect padding = sThreadLocal.get(); 13309 if (padding == null) { 13310 padding = new Rect(); 13311 sThreadLocal.set(padding); 13312 } 13313 mBackground.getPadding(padding); 13314 if (!mLeftPaddingDefined) { 13315 mUserPaddingLeftInitial = padding.left; 13316 } 13317 if (!mRightPaddingDefined) { 13318 mUserPaddingRightInitial = padding.right; 13319 } 13320 } 13321 switch (resolvedLayoutDirection) { 13322 case LAYOUT_DIRECTION_RTL: 13323 if (mUserPaddingStart != UNDEFINED_PADDING) { 13324 mUserPaddingRight = mUserPaddingStart; 13325 } else { 13326 mUserPaddingRight = mUserPaddingRightInitial; 13327 } 13328 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13329 mUserPaddingLeft = mUserPaddingEnd; 13330 } else { 13331 mUserPaddingLeft = mUserPaddingLeftInitial; 13332 } 13333 break; 13334 case LAYOUT_DIRECTION_LTR: 13335 default: 13336 if (mUserPaddingStart != UNDEFINED_PADDING) { 13337 mUserPaddingLeft = mUserPaddingStart; 13338 } else { 13339 mUserPaddingLeft = mUserPaddingLeftInitial; 13340 } 13341 if (mUserPaddingEnd != UNDEFINED_PADDING) { 13342 mUserPaddingRight = mUserPaddingEnd; 13343 } else { 13344 mUserPaddingRight = mUserPaddingRightInitial; 13345 } 13346 } 13347 13348 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 13349 } 13350 13351 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 13352 onRtlPropertiesChanged(resolvedLayoutDirection); 13353 13354 mPrivateFlags2 |= PFLAG2_PADDING_RESOLVED; 13355 } 13356 13357 /** 13358 * Reset the resolved layout direction. 13359 * 13360 * @hide 13361 */ 13362 public void resetResolvedPadding() { 13363 resetResolvedPaddingInternal(); 13364 } 13365 13366 /** 13367 * Used when we only want to reset *this* view's padding and not trigger overrides 13368 * in ViewGroup that reset children too. 13369 */ 13370 void resetResolvedPaddingInternal() { 13371 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED; 13372 } 13373 13374 /** 13375 * This is called when the view is detached from a window. At this point it 13376 * no longer has a surface for drawing. 13377 * 13378 * @see #onAttachedToWindow() 13379 */ 13380 protected void onDetachedFromWindow() { 13381 } 13382 13383 /** 13384 * This is a framework-internal mirror of onDetachedFromWindow() that's called 13385 * after onDetachedFromWindow(). 13386 * 13387 * If you override this you *MUST* call super.onDetachedFromWindowInternal()! 13388 * The super method should be called at the end of the overriden method to ensure 13389 * subclasses are destroyed first 13390 * 13391 * @hide 13392 */ 13393 protected void onDetachedFromWindowInternal() { 13394 mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT; 13395 mPrivateFlags3 &= ~PFLAG3_IS_LAID_OUT; 13396 13397 removeUnsetPressCallback(); 13398 removeLongPressCallback(); 13399 removePerformClickCallback(); 13400 removeSendViewScrolledAccessibilityEventCallback(); 13401 stopNestedScroll(); 13402 13403 // Anything that started animating right before detach should already 13404 // be in its final state when re-attached. 13405 jumpDrawablesToCurrentState(); 13406 13407 destroyDrawingCache(); 13408 13409 cleanupDraw(); 13410 mCurrentAnimation = null; 13411 } 13412 13413 private void cleanupDraw() { 13414 resetDisplayList(); 13415 if (mAttachInfo != null) { 13416 mAttachInfo.mViewRootImpl.cancelInvalidate(this); 13417 } 13418 } 13419 13420 void invalidateInheritedLayoutMode(int layoutModeOfRoot) { 13421 } 13422 13423 /** 13424 * @return The number of times this view has been attached to a window 13425 */ 13426 protected int getWindowAttachCount() { 13427 return mWindowAttachCount; 13428 } 13429 13430 /** 13431 * Retrieve a unique token identifying the window this view is attached to. 13432 * @return Return the window's token for use in 13433 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 13434 */ 13435 public IBinder getWindowToken() { 13436 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 13437 } 13438 13439 /** 13440 * Retrieve the {@link WindowId} for the window this view is 13441 * currently attached to. 13442 */ 13443 public WindowId getWindowId() { 13444 if (mAttachInfo == null) { 13445 return null; 13446 } 13447 if (mAttachInfo.mWindowId == null) { 13448 try { 13449 mAttachInfo.mIWindowId = mAttachInfo.mSession.getWindowId( 13450 mAttachInfo.mWindowToken); 13451 mAttachInfo.mWindowId = new WindowId( 13452 mAttachInfo.mIWindowId); 13453 } catch (RemoteException e) { 13454 } 13455 } 13456 return mAttachInfo.mWindowId; 13457 } 13458 13459 /** 13460 * Retrieve a unique token identifying the top-level "real" window of 13461 * the window that this view is attached to. That is, this is like 13462 * {@link #getWindowToken}, except if the window this view in is a panel 13463 * window (attached to another containing window), then the token of 13464 * the containing window is returned instead. 13465 * 13466 * @return Returns the associated window token, either 13467 * {@link #getWindowToken()} or the containing window's token. 13468 */ 13469 public IBinder getApplicationWindowToken() { 13470 AttachInfo ai = mAttachInfo; 13471 if (ai != null) { 13472 IBinder appWindowToken = ai.mPanelParentWindowToken; 13473 if (appWindowToken == null) { 13474 appWindowToken = ai.mWindowToken; 13475 } 13476 return appWindowToken; 13477 } 13478 return null; 13479 } 13480 13481 /** 13482 * Gets the logical display to which the view's window has been attached. 13483 * 13484 * @return The logical display, or null if the view is not currently attached to a window. 13485 */ 13486 public Display getDisplay() { 13487 return mAttachInfo != null ? mAttachInfo.mDisplay : null; 13488 } 13489 13490 /** 13491 * Retrieve private session object this view hierarchy is using to 13492 * communicate with the window manager. 13493 * @return the session object to communicate with the window manager 13494 */ 13495 /*package*/ IWindowSession getWindowSession() { 13496 return mAttachInfo != null ? mAttachInfo.mSession : null; 13497 } 13498 13499 /** 13500 * @param info the {@link android.view.View.AttachInfo} to associated with 13501 * this view 13502 */ 13503 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 13504 //System.out.println("Attached! " + this); 13505 mAttachInfo = info; 13506 if (mOverlay != null) { 13507 mOverlay.getOverlayView().dispatchAttachedToWindow(info, visibility); 13508 } 13509 mWindowAttachCount++; 13510 // We will need to evaluate the drawable state at least once. 13511 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 13512 if (mFloatingTreeObserver != null) { 13513 info.mTreeObserver.merge(mFloatingTreeObserver); 13514 mFloatingTreeObserver = null; 13515 } 13516 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER) != 0) { 13517 mAttachInfo.mScrollContainers.add(this); 13518 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 13519 } 13520 performCollectViewAttributes(mAttachInfo, visibility); 13521 onAttachedToWindow(); 13522 13523 ListenerInfo li = mListenerInfo; 13524 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13525 li != null ? li.mOnAttachStateChangeListeners : null; 13526 if (listeners != null && listeners.size() > 0) { 13527 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13528 // perform the dispatching. The iterator is a safe guard against listeners that 13529 // could mutate the list by calling the various add/remove methods. This prevents 13530 // the array from being modified while we iterate it. 13531 for (OnAttachStateChangeListener listener : listeners) { 13532 listener.onViewAttachedToWindow(this); 13533 } 13534 } 13535 13536 int vis = info.mWindowVisibility; 13537 if (vis != GONE) { 13538 onWindowVisibilityChanged(vis); 13539 } 13540 if ((mPrivateFlags&PFLAG_DRAWABLE_STATE_DIRTY) != 0) { 13541 // If nobody has evaluated the drawable state yet, then do it now. 13542 refreshDrawableState(); 13543 } 13544 needGlobalAttributesUpdate(false); 13545 } 13546 13547 void dispatchDetachedFromWindow() { 13548 AttachInfo info = mAttachInfo; 13549 if (info != null) { 13550 int vis = info.mWindowVisibility; 13551 if (vis != GONE) { 13552 onWindowVisibilityChanged(GONE); 13553 } 13554 } 13555 13556 onDetachedFromWindow(); 13557 onDetachedFromWindowInternal(); 13558 13559 ListenerInfo li = mListenerInfo; 13560 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 13561 li != null ? li.mOnAttachStateChangeListeners : null; 13562 if (listeners != null && listeners.size() > 0) { 13563 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 13564 // perform the dispatching. The iterator is a safe guard against listeners that 13565 // could mutate the list by calling the various add/remove methods. This prevents 13566 // the array from being modified while we iterate it. 13567 for (OnAttachStateChangeListener listener : listeners) { 13568 listener.onViewDetachedFromWindow(this); 13569 } 13570 } 13571 13572 if ((mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 13573 mAttachInfo.mScrollContainers.remove(this); 13574 mPrivateFlags &= ~PFLAG_SCROLL_CONTAINER_ADDED; 13575 } 13576 13577 mAttachInfo = null; 13578 if (mOverlay != null) { 13579 mOverlay.getOverlayView().dispatchDetachedFromWindow(); 13580 } 13581 } 13582 13583 /** 13584 * Cancel any deferred high-level input events that were previously posted to the event queue. 13585 * 13586 * <p>Many views post high-level events such as click handlers to the event queue 13587 * to run deferred in order to preserve a desired user experience - clearing visible 13588 * pressed states before executing, etc. This method will abort any events of this nature 13589 * that are currently in flight.</p> 13590 * 13591 * <p>Custom views that generate their own high-level deferred input events should override 13592 * {@link #onCancelPendingInputEvents()} and remove those pending events from the queue.</p> 13593 * 13594 * <p>This will also cancel pending input events for any child views.</p> 13595 * 13596 * <p>Note that this may not be sufficient as a debouncing strategy for clicks in all cases. 13597 * This will not impact newer events posted after this call that may occur as a result of 13598 * lower-level input events still waiting in the queue. If you are trying to prevent 13599 * double-submitted events for the duration of some sort of asynchronous transaction 13600 * you should also take other steps to protect against unexpected double inputs e.g. calling 13601 * {@link #setEnabled(boolean) setEnabled(false)} and re-enabling the view when 13602 * the transaction completes, tracking already submitted transaction IDs, etc.</p> 13603 */ 13604 public final void cancelPendingInputEvents() { 13605 dispatchCancelPendingInputEvents(); 13606 } 13607 13608 /** 13609 * Called by {@link #cancelPendingInputEvents()} to cancel input events in flight. 13610 * Overridden by ViewGroup to dispatch. Package scoped to prevent app-side meddling. 13611 */ 13612 void dispatchCancelPendingInputEvents() { 13613 mPrivateFlags3 &= ~PFLAG3_CALLED_SUPER; 13614 onCancelPendingInputEvents(); 13615 if ((mPrivateFlags3 & PFLAG3_CALLED_SUPER) != PFLAG3_CALLED_SUPER) { 13616 throw new SuperNotCalledException("View " + getClass().getSimpleName() + 13617 " did not call through to super.onCancelPendingInputEvents()"); 13618 } 13619 } 13620 13621 /** 13622 * Called as the result of a call to {@link #cancelPendingInputEvents()} on this view or 13623 * a parent view. 13624 * 13625 * <p>This method is responsible for removing any pending high-level input events that were 13626 * posted to the event queue to run later. Custom view classes that post their own deferred 13627 * high-level events via {@link #post(Runnable)}, {@link #postDelayed(Runnable, long)} or 13628 * {@link android.os.Handler} should override this method, call 13629 * <code>super.onCancelPendingInputEvents()</code> and remove those callbacks as appropriate. 13630 * </p> 13631 */ 13632 public void onCancelPendingInputEvents() { 13633 removePerformClickCallback(); 13634 cancelLongPress(); 13635 mPrivateFlags3 |= PFLAG3_CALLED_SUPER; 13636 } 13637 13638 /** 13639 * Store this view hierarchy's frozen state into the given container. 13640 * 13641 * @param container The SparseArray in which to save the view's state. 13642 * 13643 * @see #restoreHierarchyState(android.util.SparseArray) 13644 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13645 * @see #onSaveInstanceState() 13646 */ 13647 public void saveHierarchyState(SparseArray<Parcelable> container) { 13648 dispatchSaveInstanceState(container); 13649 } 13650 13651 /** 13652 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 13653 * this view and its children. May be overridden to modify how freezing happens to a 13654 * view's children; for example, some views may want to not store state for their children. 13655 * 13656 * @param container The SparseArray in which to save the view's state. 13657 * 13658 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13659 * @see #saveHierarchyState(android.util.SparseArray) 13660 * @see #onSaveInstanceState() 13661 */ 13662 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 13663 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 13664 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13665 Parcelable state = onSaveInstanceState(); 13666 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13667 throw new IllegalStateException( 13668 "Derived class did not call super.onSaveInstanceState()"); 13669 } 13670 if (state != null) { 13671 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 13672 // + ": " + state); 13673 container.put(mID, state); 13674 } 13675 } 13676 } 13677 13678 /** 13679 * Hook allowing a view to generate a representation of its internal state 13680 * that can later be used to create a new instance with that same state. 13681 * This state should only contain information that is not persistent or can 13682 * not be reconstructed later. For example, you will never store your 13683 * current position on screen because that will be computed again when a 13684 * new instance of the view is placed in its view hierarchy. 13685 * <p> 13686 * Some examples of things you may store here: the current cursor position 13687 * in a text view (but usually not the text itself since that is stored in a 13688 * content provider or other persistent storage), the currently selected 13689 * item in a list view. 13690 * 13691 * @return Returns a Parcelable object containing the view's current dynamic 13692 * state, or null if there is nothing interesting to save. The 13693 * default implementation returns null. 13694 * @see #onRestoreInstanceState(android.os.Parcelable) 13695 * @see #saveHierarchyState(android.util.SparseArray) 13696 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13697 * @see #setSaveEnabled(boolean) 13698 */ 13699 protected Parcelable onSaveInstanceState() { 13700 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13701 return BaseSavedState.EMPTY_STATE; 13702 } 13703 13704 /** 13705 * Restore this view hierarchy's frozen state from the given container. 13706 * 13707 * @param container The SparseArray which holds previously frozen states. 13708 * 13709 * @see #saveHierarchyState(android.util.SparseArray) 13710 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13711 * @see #onRestoreInstanceState(android.os.Parcelable) 13712 */ 13713 public void restoreHierarchyState(SparseArray<Parcelable> container) { 13714 dispatchRestoreInstanceState(container); 13715 } 13716 13717 /** 13718 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 13719 * state for this view and its children. May be overridden to modify how restoring 13720 * happens to a view's children; for example, some views may want to not store state 13721 * for their children. 13722 * 13723 * @param container The SparseArray which holds previously saved state. 13724 * 13725 * @see #dispatchSaveInstanceState(android.util.SparseArray) 13726 * @see #restoreHierarchyState(android.util.SparseArray) 13727 * @see #onRestoreInstanceState(android.os.Parcelable) 13728 */ 13729 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 13730 if (mID != NO_ID) { 13731 Parcelable state = container.get(mID); 13732 if (state != null) { 13733 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 13734 // + ": " + state); 13735 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 13736 onRestoreInstanceState(state); 13737 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 13738 throw new IllegalStateException( 13739 "Derived class did not call super.onRestoreInstanceState()"); 13740 } 13741 } 13742 } 13743 } 13744 13745 /** 13746 * Hook allowing a view to re-apply a representation of its internal state that had previously 13747 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 13748 * null state. 13749 * 13750 * @param state The frozen state that had previously been returned by 13751 * {@link #onSaveInstanceState}. 13752 * 13753 * @see #onSaveInstanceState() 13754 * @see #restoreHierarchyState(android.util.SparseArray) 13755 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 13756 */ 13757 protected void onRestoreInstanceState(Parcelable state) { 13758 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 13759 if (state != BaseSavedState.EMPTY_STATE && state != null) { 13760 throw new IllegalArgumentException("Wrong state class, expecting View State but " 13761 + "received " + state.getClass().toString() + " instead. This usually happens " 13762 + "when two views of different type have the same id in the same hierarchy. " 13763 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 13764 + "other views do not use the same id."); 13765 } 13766 } 13767 13768 /** 13769 * <p>Return the time at which the drawing of the view hierarchy started.</p> 13770 * 13771 * @return the drawing start time in milliseconds 13772 */ 13773 public long getDrawingTime() { 13774 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 13775 } 13776 13777 /** 13778 * <p>Enables or disables the duplication of the parent's state into this view. When 13779 * duplication is enabled, this view gets its drawable state from its parent rather 13780 * than from its own internal properties.</p> 13781 * 13782 * <p>Note: in the current implementation, setting this property to true after the 13783 * view was added to a ViewGroup might have no effect at all. This property should 13784 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 13785 * 13786 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 13787 * property is enabled, an exception will be thrown.</p> 13788 * 13789 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 13790 * parent, these states should not be affected by this method.</p> 13791 * 13792 * @param enabled True to enable duplication of the parent's drawable state, false 13793 * to disable it. 13794 * 13795 * @see #getDrawableState() 13796 * @see #isDuplicateParentStateEnabled() 13797 */ 13798 public void setDuplicateParentStateEnabled(boolean enabled) { 13799 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 13800 } 13801 13802 /** 13803 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 13804 * 13805 * @return True if this view's drawable state is duplicated from the parent, 13806 * false otherwise 13807 * 13808 * @see #getDrawableState() 13809 * @see #setDuplicateParentStateEnabled(boolean) 13810 */ 13811 public boolean isDuplicateParentStateEnabled() { 13812 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 13813 } 13814 13815 /** 13816 * <p>Specifies the type of layer backing this view. The layer can be 13817 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13818 * {@link #LAYER_TYPE_HARDWARE}.</p> 13819 * 13820 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13821 * instance that controls how the layer is composed on screen. The following 13822 * properties of the paint are taken into account when composing the layer:</p> 13823 * <ul> 13824 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13825 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13826 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13827 * </ul> 13828 * 13829 * <p>If this view has an alpha value set to < 1.0 by calling 13830 * {@link #setAlpha(float)}, the alpha value of the layer's paint is superceded 13831 * by this view's alpha value.</p> 13832 * 13833 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE}, 13834 * {@link #LAYER_TYPE_SOFTWARE} and {@link #LAYER_TYPE_HARDWARE} 13835 * for more information on when and how to use layers.</p> 13836 * 13837 * @param layerType The type of layer to use with this view, must be one of 13838 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13839 * {@link #LAYER_TYPE_HARDWARE} 13840 * @param paint The paint used to compose the layer. This argument is optional 13841 * and can be null. It is ignored when the layer type is 13842 * {@link #LAYER_TYPE_NONE} 13843 * 13844 * @see #getLayerType() 13845 * @see #LAYER_TYPE_NONE 13846 * @see #LAYER_TYPE_SOFTWARE 13847 * @see #LAYER_TYPE_HARDWARE 13848 * @see #setAlpha(float) 13849 * 13850 * @attr ref android.R.styleable#View_layerType 13851 */ 13852 public void setLayerType(int layerType, Paint paint) { 13853 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 13854 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 13855 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 13856 } 13857 13858 boolean typeChanged = mRenderNode.setLayerType(layerType); 13859 13860 if (!typeChanged) { 13861 setLayerPaint(paint); 13862 return; 13863 } 13864 13865 // Destroy any previous software drawing cache if needed 13866 if (mLayerType == LAYER_TYPE_SOFTWARE) { 13867 destroyDrawingCache(); 13868 } 13869 13870 mLayerType = layerType; 13871 final boolean layerDisabled = (mLayerType == LAYER_TYPE_NONE); 13872 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 13873 mRenderNode.setLayerPaint(mLayerPaint); 13874 13875 // draw() behaves differently if we are on a layer, so we need to 13876 // invalidate() here 13877 invalidateParentCaches(); 13878 invalidate(true); 13879 } 13880 13881 /** 13882 * Updates the {@link Paint} object used with the current layer (used only if the current 13883 * layer type is not set to {@link #LAYER_TYPE_NONE}). Changed properties of the Paint 13884 * provided to {@link #setLayerType(int, android.graphics.Paint)} will be used the next time 13885 * the View is redrawn, but {@link #setLayerPaint(android.graphics.Paint)} must be called to 13886 * ensure that the view gets redrawn immediately. 13887 * 13888 * <p>A layer is associated with an optional {@link android.graphics.Paint} 13889 * instance that controls how the layer is composed on screen. The following 13890 * properties of the paint are taken into account when composing the layer:</p> 13891 * <ul> 13892 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 13893 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 13894 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 13895 * </ul> 13896 * 13897 * <p>If this view has an alpha value set to < 1.0 by calling {@link #setAlpha(float)}, the 13898 * alpha value of the layer's paint is superceded by this view's alpha value.</p> 13899 * 13900 * @param paint The paint used to compose the layer. This argument is optional 13901 * and can be null. It is ignored when the layer type is 13902 * {@link #LAYER_TYPE_NONE} 13903 * 13904 * @see #setLayerType(int, android.graphics.Paint) 13905 */ 13906 public void setLayerPaint(Paint paint) { 13907 int layerType = getLayerType(); 13908 if (layerType != LAYER_TYPE_NONE) { 13909 mLayerPaint = paint == null ? new Paint() : paint; 13910 if (layerType == LAYER_TYPE_HARDWARE) { 13911 if (mRenderNode.setLayerPaint(mLayerPaint)) { 13912 invalidateViewProperty(false, false); 13913 } 13914 } else { 13915 invalidate(); 13916 } 13917 } 13918 } 13919 13920 /** 13921 * Indicates whether this view has a static layer. A view with layer type 13922 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 13923 * dynamic. 13924 */ 13925 boolean hasStaticLayer() { 13926 return true; 13927 } 13928 13929 /** 13930 * Indicates what type of layer is currently associated with this view. By default 13931 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 13932 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 13933 * for more information on the different types of layers. 13934 * 13935 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 13936 * {@link #LAYER_TYPE_HARDWARE} 13937 * 13938 * @see #setLayerType(int, android.graphics.Paint) 13939 * @see #buildLayer() 13940 * @see #LAYER_TYPE_NONE 13941 * @see #LAYER_TYPE_SOFTWARE 13942 * @see #LAYER_TYPE_HARDWARE 13943 */ 13944 public int getLayerType() { 13945 return mLayerType; 13946 } 13947 13948 /** 13949 * Forces this view's layer to be created and this view to be rendered 13950 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 13951 * invoking this method will have no effect. 13952 * 13953 * This method can for instance be used to render a view into its layer before 13954 * starting an animation. If this view is complex, rendering into the layer 13955 * before starting the animation will avoid skipping frames. 13956 * 13957 * @throws IllegalStateException If this view is not attached to a window 13958 * 13959 * @see #setLayerType(int, android.graphics.Paint) 13960 */ 13961 public void buildLayer() { 13962 if (mLayerType == LAYER_TYPE_NONE) return; 13963 13964 final AttachInfo attachInfo = mAttachInfo; 13965 if (attachInfo == null) { 13966 throw new IllegalStateException("This view must be attached to a window first"); 13967 } 13968 13969 if (getWidth() == 0 || getHeight() == 0) { 13970 return; 13971 } 13972 13973 switch (mLayerType) { 13974 case LAYER_TYPE_HARDWARE: 13975 updateDisplayListIfDirty(); 13976 if (attachInfo.mHardwareRenderer != null && mRenderNode.isValid()) { 13977 attachInfo.mHardwareRenderer.buildLayer(mRenderNode); 13978 } 13979 break; 13980 case LAYER_TYPE_SOFTWARE: 13981 buildDrawingCache(true); 13982 break; 13983 } 13984 } 13985 13986 /** 13987 * If this View draws with a HardwareLayer, returns it. 13988 * Otherwise returns null 13989 * 13990 * TODO: Only TextureView uses this, can we eliminate it? 13991 */ 13992 HardwareLayer getHardwareLayer() { 13993 return null; 13994 } 13995 13996 /** 13997 * Destroys all hardware rendering resources. This method is invoked 13998 * when the system needs to reclaim resources. Upon execution of this 13999 * method, you should free any OpenGL resources created by the view. 14000 * 14001 * Note: you <strong>must</strong> call 14002 * <code>super.destroyHardwareResources()</code> when overriding 14003 * this method. 14004 * 14005 * @hide 14006 */ 14007 protected void destroyHardwareResources() { 14008 // Although the Layer will be destroyed by RenderNode, we want to release 14009 // the staging display list, which is also a signal to RenderNode that it's 14010 // safe to free its copy of the display list as it knows that we will 14011 // push an updated DisplayList if we try to draw again 14012 resetDisplayList(); 14013 } 14014 14015 /** 14016 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 14017 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 14018 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 14019 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 14020 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 14021 * null.</p> 14022 * 14023 * <p>Enabling the drawing cache is similar to 14024 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 14025 * acceleration is turned off. When hardware acceleration is turned on, enabling the 14026 * drawing cache has no effect on rendering because the system uses a different mechanism 14027 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 14028 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 14029 * for information on how to enable software and hardware layers.</p> 14030 * 14031 * <p>This API can be used to manually generate 14032 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 14033 * {@link #getDrawingCache()}.</p> 14034 * 14035 * @param enabled true to enable the drawing cache, false otherwise 14036 * 14037 * @see #isDrawingCacheEnabled() 14038 * @see #getDrawingCache() 14039 * @see #buildDrawingCache() 14040 * @see #setLayerType(int, android.graphics.Paint) 14041 */ 14042 public void setDrawingCacheEnabled(boolean enabled) { 14043 mCachingFailed = false; 14044 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 14045 } 14046 14047 /** 14048 * <p>Indicates whether the drawing cache is enabled for this view.</p> 14049 * 14050 * @return true if the drawing cache is enabled 14051 * 14052 * @see #setDrawingCacheEnabled(boolean) 14053 * @see #getDrawingCache() 14054 */ 14055 @ViewDebug.ExportedProperty(category = "drawing") 14056 public boolean isDrawingCacheEnabled() { 14057 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 14058 } 14059 14060 /** 14061 * Debugging utility which recursively outputs the dirty state of a view and its 14062 * descendants. 14063 * 14064 * @hide 14065 */ 14066 @SuppressWarnings({"UnusedDeclaration"}) 14067 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 14068 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.PFLAG_DIRTY_MASK) + 14069 ") DRAWN(" + (mPrivateFlags & PFLAG_DRAWN) + ")" + " CACHE_VALID(" + 14070 (mPrivateFlags & View.PFLAG_DRAWING_CACHE_VALID) + 14071 ") INVALIDATED(" + (mPrivateFlags & PFLAG_INVALIDATED) + ")"); 14072 if (clear) { 14073 mPrivateFlags &= clearMask; 14074 } 14075 if (this instanceof ViewGroup) { 14076 ViewGroup parent = (ViewGroup) this; 14077 final int count = parent.getChildCount(); 14078 for (int i = 0; i < count; i++) { 14079 final View child = parent.getChildAt(i); 14080 child.outputDirtyFlags(indent + " ", clear, clearMask); 14081 } 14082 } 14083 } 14084 14085 /** 14086 * This method is used by ViewGroup to cause its children to restore or recreate their 14087 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 14088 * to recreate its own display list, which would happen if it went through the normal 14089 * draw/dispatchDraw mechanisms. 14090 * 14091 * @hide 14092 */ 14093 protected void dispatchGetDisplayList() {} 14094 14095 /** 14096 * A view that is not attached or hardware accelerated cannot create a display list. 14097 * This method checks these conditions and returns the appropriate result. 14098 * 14099 * @return true if view has the ability to create a display list, false otherwise. 14100 * 14101 * @hide 14102 */ 14103 public boolean canHaveDisplayList() { 14104 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 14105 } 14106 14107 private void updateDisplayListIfDirty() { 14108 final RenderNode renderNode = mRenderNode; 14109 if (!canHaveDisplayList()) { 14110 // can't populate RenderNode, don't try 14111 return; 14112 } 14113 14114 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 14115 || !renderNode.isValid() 14116 || (mRecreateDisplayList)) { 14117 // Don't need to recreate the display list, just need to tell our 14118 // children to restore/recreate theirs 14119 if (renderNode.isValid() 14120 && !mRecreateDisplayList) { 14121 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14122 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14123 dispatchGetDisplayList(); 14124 14125 return; // no work needed 14126 } 14127 14128 // If we got here, we're recreating it. Mark it as such to ensure that 14129 // we copy in child display lists into ours in drawChild() 14130 mRecreateDisplayList = true; 14131 14132 int width = mRight - mLeft; 14133 int height = mBottom - mTop; 14134 int layerType = getLayerType(); 14135 14136 final HardwareCanvas canvas = renderNode.start(width, height); 14137 canvas.setHighContrastText(mAttachInfo.mHighContrastText); 14138 14139 try { 14140 final HardwareLayer layer = getHardwareLayer(); 14141 if (layer != null && layer.isValid()) { 14142 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint); 14143 } else if (layerType == LAYER_TYPE_SOFTWARE) { 14144 buildDrawingCache(true); 14145 Bitmap cache = getDrawingCache(true); 14146 if (cache != null) { 14147 canvas.drawBitmap(cache, 0, 0, mLayerPaint); 14148 } 14149 } else { 14150 computeScroll(); 14151 14152 canvas.translate(-mScrollX, -mScrollY); 14153 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14154 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14155 14156 // Fast path for layouts with no backgrounds 14157 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14158 dispatchDraw(canvas); 14159 if (mOverlay != null && !mOverlay.isEmpty()) { 14160 mOverlay.getOverlayView().draw(canvas); 14161 } 14162 } else { 14163 draw(canvas); 14164 } 14165 } 14166 } finally { 14167 renderNode.end(canvas); 14168 setDisplayListProperties(renderNode); 14169 } 14170 } else { 14171 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 14172 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14173 } 14174 } 14175 14176 /** 14177 * Returns a RenderNode with View draw content recorded, which can be 14178 * used to draw this view again without executing its draw method. 14179 * 14180 * @return A RenderNode ready to replay, or null if caching is not enabled. 14181 * 14182 * @hide 14183 */ 14184 public RenderNode getDisplayList() { 14185 updateDisplayListIfDirty(); 14186 return mRenderNode; 14187 } 14188 14189 private void resetDisplayList() { 14190 if (mRenderNode.isValid()) { 14191 mRenderNode.destroyDisplayListData(); 14192 } 14193 14194 if (mBackgroundRenderNode != null && mBackgroundRenderNode.isValid()) { 14195 mBackgroundRenderNode.destroyDisplayListData(); 14196 } 14197 } 14198 14199 /** 14200 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 14201 * 14202 * @return A non-scaled bitmap representing this view or null if cache is disabled. 14203 * 14204 * @see #getDrawingCache(boolean) 14205 */ 14206 public Bitmap getDrawingCache() { 14207 return getDrawingCache(false); 14208 } 14209 14210 /** 14211 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 14212 * is null when caching is disabled. If caching is enabled and the cache is not ready, 14213 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 14214 * draw from the cache when the cache is enabled. To benefit from the cache, you must 14215 * request the drawing cache by calling this method and draw it on screen if the 14216 * returned bitmap is not null.</p> 14217 * 14218 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14219 * this method will create a bitmap of the same size as this view. Because this bitmap 14220 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14221 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14222 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14223 * size than the view. This implies that your application must be able to handle this 14224 * size.</p> 14225 * 14226 * @param autoScale Indicates whether the generated bitmap should be scaled based on 14227 * the current density of the screen when the application is in compatibility 14228 * mode. 14229 * 14230 * @return A bitmap representing this view or null if cache is disabled. 14231 * 14232 * @see #setDrawingCacheEnabled(boolean) 14233 * @see #isDrawingCacheEnabled() 14234 * @see #buildDrawingCache(boolean) 14235 * @see #destroyDrawingCache() 14236 */ 14237 public Bitmap getDrawingCache(boolean autoScale) { 14238 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 14239 return null; 14240 } 14241 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 14242 buildDrawingCache(autoScale); 14243 } 14244 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 14245 } 14246 14247 /** 14248 * <p>Frees the resources used by the drawing cache. If you call 14249 * {@link #buildDrawingCache()} manually without calling 14250 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14251 * should cleanup the cache with this method afterwards.</p> 14252 * 14253 * @see #setDrawingCacheEnabled(boolean) 14254 * @see #buildDrawingCache() 14255 * @see #getDrawingCache() 14256 */ 14257 public void destroyDrawingCache() { 14258 if (mDrawingCache != null) { 14259 mDrawingCache.recycle(); 14260 mDrawingCache = null; 14261 } 14262 if (mUnscaledDrawingCache != null) { 14263 mUnscaledDrawingCache.recycle(); 14264 mUnscaledDrawingCache = null; 14265 } 14266 } 14267 14268 /** 14269 * Setting a solid background color for the drawing cache's bitmaps will improve 14270 * performance and memory usage. Note, though that this should only be used if this 14271 * view will always be drawn on top of a solid color. 14272 * 14273 * @param color The background color to use for the drawing cache's bitmap 14274 * 14275 * @see #setDrawingCacheEnabled(boolean) 14276 * @see #buildDrawingCache() 14277 * @see #getDrawingCache() 14278 */ 14279 public void setDrawingCacheBackgroundColor(int color) { 14280 if (color != mDrawingCacheBackgroundColor) { 14281 mDrawingCacheBackgroundColor = color; 14282 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 14283 } 14284 } 14285 14286 /** 14287 * @see #setDrawingCacheBackgroundColor(int) 14288 * 14289 * @return The background color to used for the drawing cache's bitmap 14290 */ 14291 public int getDrawingCacheBackgroundColor() { 14292 return mDrawingCacheBackgroundColor; 14293 } 14294 14295 /** 14296 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 14297 * 14298 * @see #buildDrawingCache(boolean) 14299 */ 14300 public void buildDrawingCache() { 14301 buildDrawingCache(false); 14302 } 14303 14304 /** 14305 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 14306 * 14307 * <p>If you call {@link #buildDrawingCache()} manually without calling 14308 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 14309 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 14310 * 14311 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 14312 * this method will create a bitmap of the same size as this view. Because this bitmap 14313 * will be drawn scaled by the parent ViewGroup, the result on screen might show 14314 * scaling artifacts. To avoid such artifacts, you should call this method by setting 14315 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 14316 * size than the view. This implies that your application must be able to handle this 14317 * size.</p> 14318 * 14319 * <p>You should avoid calling this method when hardware acceleration is enabled. If 14320 * you do not need the drawing cache bitmap, calling this method will increase memory 14321 * usage and cause the view to be rendered in software once, thus negatively impacting 14322 * performance.</p> 14323 * 14324 * @see #getDrawingCache() 14325 * @see #destroyDrawingCache() 14326 */ 14327 public void buildDrawingCache(boolean autoScale) { 14328 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || (autoScale ? 14329 mDrawingCache == null : mUnscaledDrawingCache == null)) { 14330 if (Trace.isTagEnabled(Trace.TRACE_TAG_VIEW)) { 14331 Trace.traceBegin(Trace.TRACE_TAG_VIEW, 14332 "buildDrawingCache/SW Layer for " + getClass().getSimpleName()); 14333 } 14334 try { 14335 buildDrawingCacheImpl(autoScale); 14336 } finally { 14337 Trace.traceEnd(Trace.TRACE_TAG_VIEW); 14338 } 14339 } 14340 } 14341 14342 /** 14343 * private, internal implementation of buildDrawingCache, used to enable tracing 14344 */ 14345 private void buildDrawingCacheImpl(boolean autoScale) { 14346 mCachingFailed = false; 14347 14348 int width = mRight - mLeft; 14349 int height = mBottom - mTop; 14350 14351 final AttachInfo attachInfo = mAttachInfo; 14352 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 14353 14354 if (autoScale && scalingRequired) { 14355 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 14356 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 14357 } 14358 14359 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 14360 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 14361 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 14362 14363 final long projectedBitmapSize = width * height * (opaque && !use32BitCache ? 2 : 4); 14364 final long drawingCacheSize = 14365 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize(); 14366 if (width <= 0 || height <= 0 || projectedBitmapSize > drawingCacheSize) { 14367 if (width > 0 && height > 0) { 14368 Log.w(VIEW_LOG_TAG, "View too large to fit into drawing cache, needs " 14369 + projectedBitmapSize + " bytes, only " 14370 + drawingCacheSize + " available"); 14371 } 14372 destroyDrawingCache(); 14373 mCachingFailed = true; 14374 return; 14375 } 14376 14377 boolean clear = true; 14378 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 14379 14380 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 14381 Bitmap.Config quality; 14382 if (!opaque) { 14383 // Never pick ARGB_4444 because it looks awful 14384 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 14385 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 14386 case DRAWING_CACHE_QUALITY_AUTO: 14387 case DRAWING_CACHE_QUALITY_LOW: 14388 case DRAWING_CACHE_QUALITY_HIGH: 14389 default: 14390 quality = Bitmap.Config.ARGB_8888; 14391 break; 14392 } 14393 } else { 14394 // Optimization for translucent windows 14395 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 14396 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 14397 } 14398 14399 // Try to cleanup memory 14400 if (bitmap != null) bitmap.recycle(); 14401 14402 try { 14403 bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14404 width, height, quality); 14405 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 14406 if (autoScale) { 14407 mDrawingCache = bitmap; 14408 } else { 14409 mUnscaledDrawingCache = bitmap; 14410 } 14411 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 14412 } catch (OutOfMemoryError e) { 14413 // If there is not enough memory to create the bitmap cache, just 14414 // ignore the issue as bitmap caches are not required to draw the 14415 // view hierarchy 14416 if (autoScale) { 14417 mDrawingCache = null; 14418 } else { 14419 mUnscaledDrawingCache = null; 14420 } 14421 mCachingFailed = true; 14422 return; 14423 } 14424 14425 clear = drawingCacheBackgroundColor != 0; 14426 } 14427 14428 Canvas canvas; 14429 if (attachInfo != null) { 14430 canvas = attachInfo.mCanvas; 14431 if (canvas == null) { 14432 canvas = new Canvas(); 14433 } 14434 canvas.setBitmap(bitmap); 14435 // Temporarily clobber the cached Canvas in case one of our children 14436 // is also using a drawing cache. Without this, the children would 14437 // steal the canvas by attaching their own bitmap to it and bad, bad 14438 // thing would happen (invisible views, corrupted drawings, etc.) 14439 attachInfo.mCanvas = null; 14440 } else { 14441 // This case should hopefully never or seldom happen 14442 canvas = new Canvas(bitmap); 14443 } 14444 14445 if (clear) { 14446 bitmap.eraseColor(drawingCacheBackgroundColor); 14447 } 14448 14449 computeScroll(); 14450 final int restoreCount = canvas.save(); 14451 14452 if (autoScale && scalingRequired) { 14453 final float scale = attachInfo.mApplicationScale; 14454 canvas.scale(scale, scale); 14455 } 14456 14457 canvas.translate(-mScrollX, -mScrollY); 14458 14459 mPrivateFlags |= PFLAG_DRAWN; 14460 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 14461 mLayerType != LAYER_TYPE_NONE) { 14462 mPrivateFlags |= PFLAG_DRAWING_CACHE_VALID; 14463 } 14464 14465 // Fast path for layouts with no backgrounds 14466 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14467 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14468 dispatchDraw(canvas); 14469 if (mOverlay != null && !mOverlay.isEmpty()) { 14470 mOverlay.getOverlayView().draw(canvas); 14471 } 14472 } else { 14473 draw(canvas); 14474 } 14475 14476 canvas.restoreToCount(restoreCount); 14477 canvas.setBitmap(null); 14478 14479 if (attachInfo != null) { 14480 // Restore the cached Canvas for our siblings 14481 attachInfo.mCanvas = canvas; 14482 } 14483 } 14484 14485 /** 14486 * Create a snapshot of the view into a bitmap. We should probably make 14487 * some form of this public, but should think about the API. 14488 */ 14489 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 14490 int width = mRight - mLeft; 14491 int height = mBottom - mTop; 14492 14493 final AttachInfo attachInfo = mAttachInfo; 14494 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 14495 width = (int) ((width * scale) + 0.5f); 14496 height = (int) ((height * scale) + 0.5f); 14497 14498 Bitmap bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 14499 width > 0 ? width : 1, height > 0 ? height : 1, quality); 14500 if (bitmap == null) { 14501 throw new OutOfMemoryError(); 14502 } 14503 14504 Resources resources = getResources(); 14505 if (resources != null) { 14506 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 14507 } 14508 14509 Canvas canvas; 14510 if (attachInfo != null) { 14511 canvas = attachInfo.mCanvas; 14512 if (canvas == null) { 14513 canvas = new Canvas(); 14514 } 14515 canvas.setBitmap(bitmap); 14516 // Temporarily clobber the cached Canvas in case one of our children 14517 // is also using a drawing cache. Without this, the children would 14518 // steal the canvas by attaching their own bitmap to it and bad, bad 14519 // things would happen (invisible views, corrupted drawings, etc.) 14520 attachInfo.mCanvas = null; 14521 } else { 14522 // This case should hopefully never or seldom happen 14523 canvas = new Canvas(bitmap); 14524 } 14525 14526 if ((backgroundColor & 0xff000000) != 0) { 14527 bitmap.eraseColor(backgroundColor); 14528 } 14529 14530 computeScroll(); 14531 final int restoreCount = canvas.save(); 14532 canvas.scale(scale, scale); 14533 canvas.translate(-mScrollX, -mScrollY); 14534 14535 // Temporarily remove the dirty mask 14536 int flags = mPrivateFlags; 14537 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 14538 14539 // Fast path for layouts with no backgrounds 14540 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 14541 dispatchDraw(canvas); 14542 if (mOverlay != null && !mOverlay.isEmpty()) { 14543 mOverlay.getOverlayView().draw(canvas); 14544 } 14545 } else { 14546 draw(canvas); 14547 } 14548 14549 mPrivateFlags = flags; 14550 14551 canvas.restoreToCount(restoreCount); 14552 canvas.setBitmap(null); 14553 14554 if (attachInfo != null) { 14555 // Restore the cached Canvas for our siblings 14556 attachInfo.mCanvas = canvas; 14557 } 14558 14559 return bitmap; 14560 } 14561 14562 /** 14563 * Indicates whether this View is currently in edit mode. A View is usually 14564 * in edit mode when displayed within a developer tool. For instance, if 14565 * this View is being drawn by a visual user interface builder, this method 14566 * should return true. 14567 * 14568 * Subclasses should check the return value of this method to provide 14569 * different behaviors if their normal behavior might interfere with the 14570 * host environment. For instance: the class spawns a thread in its 14571 * constructor, the drawing code relies on device-specific features, etc. 14572 * 14573 * This method is usually checked in the drawing code of custom widgets. 14574 * 14575 * @return True if this View is in edit mode, false otherwise. 14576 */ 14577 public boolean isInEditMode() { 14578 return false; 14579 } 14580 14581 /** 14582 * If the View draws content inside its padding and enables fading edges, 14583 * it needs to support padding offsets. Padding offsets are added to the 14584 * fading edges to extend the length of the fade so that it covers pixels 14585 * drawn inside the padding. 14586 * 14587 * Subclasses of this class should override this method if they need 14588 * to draw content inside the padding. 14589 * 14590 * @return True if padding offset must be applied, false otherwise. 14591 * 14592 * @see #getLeftPaddingOffset() 14593 * @see #getRightPaddingOffset() 14594 * @see #getTopPaddingOffset() 14595 * @see #getBottomPaddingOffset() 14596 * 14597 * @since CURRENT 14598 */ 14599 protected boolean isPaddingOffsetRequired() { 14600 return false; 14601 } 14602 14603 /** 14604 * Amount by which to extend the left fading region. Called only when 14605 * {@link #isPaddingOffsetRequired()} returns true. 14606 * 14607 * @return The left padding offset in pixels. 14608 * 14609 * @see #isPaddingOffsetRequired() 14610 * 14611 * @since CURRENT 14612 */ 14613 protected int getLeftPaddingOffset() { 14614 return 0; 14615 } 14616 14617 /** 14618 * Amount by which to extend the right fading region. Called only when 14619 * {@link #isPaddingOffsetRequired()} returns true. 14620 * 14621 * @return The right padding offset in pixels. 14622 * 14623 * @see #isPaddingOffsetRequired() 14624 * 14625 * @since CURRENT 14626 */ 14627 protected int getRightPaddingOffset() { 14628 return 0; 14629 } 14630 14631 /** 14632 * Amount by which to extend the top fading region. Called only when 14633 * {@link #isPaddingOffsetRequired()} returns true. 14634 * 14635 * @return The top padding offset in pixels. 14636 * 14637 * @see #isPaddingOffsetRequired() 14638 * 14639 * @since CURRENT 14640 */ 14641 protected int getTopPaddingOffset() { 14642 return 0; 14643 } 14644 14645 /** 14646 * Amount by which to extend the bottom fading region. Called only when 14647 * {@link #isPaddingOffsetRequired()} returns true. 14648 * 14649 * @return The bottom padding offset in pixels. 14650 * 14651 * @see #isPaddingOffsetRequired() 14652 * 14653 * @since CURRENT 14654 */ 14655 protected int getBottomPaddingOffset() { 14656 return 0; 14657 } 14658 14659 /** 14660 * @hide 14661 * @param offsetRequired 14662 */ 14663 protected int getFadeTop(boolean offsetRequired) { 14664 int top = mPaddingTop; 14665 if (offsetRequired) top += getTopPaddingOffset(); 14666 return top; 14667 } 14668 14669 /** 14670 * @hide 14671 * @param offsetRequired 14672 */ 14673 protected int getFadeHeight(boolean offsetRequired) { 14674 int padding = mPaddingTop; 14675 if (offsetRequired) padding += getTopPaddingOffset(); 14676 return mBottom - mTop - mPaddingBottom - padding; 14677 } 14678 14679 /** 14680 * <p>Indicates whether this view is attached to a hardware accelerated 14681 * window or not.</p> 14682 * 14683 * <p>Even if this method returns true, it does not mean that every call 14684 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 14685 * accelerated {@link android.graphics.Canvas}. For instance, if this view 14686 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its 14687 * window is hardware accelerated, 14688 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 14689 * return false, and this method will return true.</p> 14690 * 14691 * @return True if the view is attached to a window and the window is 14692 * hardware accelerated; false in any other case. 14693 */ 14694 @ViewDebug.ExportedProperty(category = "drawing") 14695 public boolean isHardwareAccelerated() { 14696 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14697 } 14698 14699 /** 14700 * Sets a rectangular area on this view to which the view will be clipped 14701 * when it is drawn. Setting the value to null will remove the clip bounds 14702 * and the view will draw normally, using its full bounds. 14703 * 14704 * @param clipBounds The rectangular area, in the local coordinates of 14705 * this view, to which future drawing operations will be clipped. 14706 */ 14707 public void setClipBounds(Rect clipBounds) { 14708 if (clipBounds == mClipBounds 14709 || (clipBounds != null && clipBounds.equals(mClipBounds))) { 14710 return; 14711 } 14712 if (clipBounds != null) { 14713 if (mClipBounds == null) { 14714 mClipBounds = new Rect(clipBounds); 14715 } else { 14716 mClipBounds.set(clipBounds); 14717 } 14718 } else { 14719 mClipBounds = null; 14720 } 14721 mRenderNode.setClipBounds(mClipBounds); 14722 invalidateViewProperty(false, false); 14723 } 14724 14725 /** 14726 * Returns a copy of the current {@link #setClipBounds(Rect) clipBounds}. 14727 * 14728 * @return A copy of the current clip bounds if clip bounds are set, 14729 * otherwise null. 14730 */ 14731 public Rect getClipBounds() { 14732 return (mClipBounds != null) ? new Rect(mClipBounds) : null; 14733 } 14734 14735 /** 14736 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common 14737 * case of an active Animation being run on the view. 14738 */ 14739 private boolean drawAnimation(ViewGroup parent, long drawingTime, 14740 Animation a, boolean scalingRequired) { 14741 Transformation invalidationTransform; 14742 final int flags = parent.mGroupFlags; 14743 final boolean initialized = a.isInitialized(); 14744 if (!initialized) { 14745 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight()); 14746 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop); 14747 if (mAttachInfo != null) a.setListenerHandler(mAttachInfo.mHandler); 14748 onAnimationStart(); 14749 } 14750 14751 final Transformation t = parent.getChildTransformation(); 14752 boolean more = a.getTransformation(drawingTime, t, 1f); 14753 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) { 14754 if (parent.mInvalidationTransformation == null) { 14755 parent.mInvalidationTransformation = new Transformation(); 14756 } 14757 invalidationTransform = parent.mInvalidationTransformation; 14758 a.getTransformation(drawingTime, invalidationTransform, 1f); 14759 } else { 14760 invalidationTransform = t; 14761 } 14762 14763 if (more) { 14764 if (!a.willChangeBounds()) { 14765 if ((flags & (ViewGroup.FLAG_OPTIMIZE_INVALIDATE | ViewGroup.FLAG_ANIMATION_DONE)) == 14766 ViewGroup.FLAG_OPTIMIZE_INVALIDATE) { 14767 parent.mGroupFlags |= ViewGroup.FLAG_INVALIDATE_REQUIRED; 14768 } else if ((flags & ViewGroup.FLAG_INVALIDATE_REQUIRED) == 0) { 14769 // The child need to draw an animation, potentially offscreen, so 14770 // make sure we do not cancel invalidate requests 14771 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14772 parent.invalidate(mLeft, mTop, mRight, mBottom); 14773 } 14774 } else { 14775 if (parent.mInvalidateRegion == null) { 14776 parent.mInvalidateRegion = new RectF(); 14777 } 14778 final RectF region = parent.mInvalidateRegion; 14779 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region, 14780 invalidationTransform); 14781 14782 // The child need to draw an animation, potentially offscreen, so 14783 // make sure we do not cancel invalidate requests 14784 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 14785 14786 final int left = mLeft + (int) region.left; 14787 final int top = mTop + (int) region.top; 14788 parent.invalidate(left, top, left + (int) (region.width() + .5f), 14789 top + (int) (region.height() + .5f)); 14790 } 14791 } 14792 return more; 14793 } 14794 14795 /** 14796 * This method is called by getDisplayList() when a display list is recorded for a View. 14797 * It pushes any properties to the RenderNode that aren't managed by the RenderNode. 14798 */ 14799 void setDisplayListProperties(RenderNode renderNode) { 14800 if (renderNode != null) { 14801 renderNode.setHasOverlappingRendering(hasOverlappingRendering()); 14802 if (mParent instanceof ViewGroup) { 14803 renderNode.setClipToBounds( 14804 (((ViewGroup) mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0); 14805 } 14806 float alpha = 1; 14807 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags & 14808 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14809 ViewGroup parentVG = (ViewGroup) mParent; 14810 final Transformation t = parentVG.getChildTransformation(); 14811 if (parentVG.getChildStaticTransformation(this, t)) { 14812 final int transformType = t.getTransformationType(); 14813 if (transformType != Transformation.TYPE_IDENTITY) { 14814 if ((transformType & Transformation.TYPE_ALPHA) != 0) { 14815 alpha = t.getAlpha(); 14816 } 14817 if ((transformType & Transformation.TYPE_MATRIX) != 0) { 14818 renderNode.setStaticMatrix(t.getMatrix()); 14819 } 14820 } 14821 } 14822 } 14823 if (mTransformationInfo != null) { 14824 alpha *= getFinalAlpha(); 14825 if (alpha < 1) { 14826 final int multipliedAlpha = (int) (255 * alpha); 14827 if (onSetAlpha(multipliedAlpha)) { 14828 alpha = 1; 14829 } 14830 } 14831 renderNode.setAlpha(alpha); 14832 } else if (alpha < 1) { 14833 renderNode.setAlpha(alpha); 14834 } 14835 } 14836 } 14837 14838 /** 14839 * This method is called by ViewGroup.drawChild() to have each child view draw itself. 14840 * This draw() method is an implementation detail and is not intended to be overridden or 14841 * to be called from anywhere else other than ViewGroup.drawChild(). 14842 */ 14843 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) { 14844 boolean usingRenderNodeProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 14845 boolean more = false; 14846 final boolean childHasIdentityMatrix = hasIdentityMatrix(); 14847 final int flags = parent.mGroupFlags; 14848 14849 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) { 14850 parent.getChildTransformation().clear(); 14851 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION; 14852 } 14853 14854 Transformation transformToApply = null; 14855 boolean concatMatrix = false; 14856 14857 boolean scalingRequired = false; 14858 boolean caching; 14859 int layerType = getLayerType(); 14860 14861 final boolean hardwareAccelerated = canvas.isHardwareAccelerated(); 14862 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 || 14863 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) { 14864 caching = true; 14865 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList 14866 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired; 14867 } else { 14868 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated; 14869 } 14870 14871 final Animation a = getAnimation(); 14872 if (a != null) { 14873 more = drawAnimation(parent, drawingTime, a, scalingRequired); 14874 concatMatrix = a.willChangeTransformationMatrix(); 14875 if (concatMatrix) { 14876 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14877 } 14878 transformToApply = parent.getChildTransformation(); 14879 } else { 14880 if ((mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_TRANSFORM) != 0) { 14881 // No longer animating: clear out old animation matrix 14882 mRenderNode.setAnimationMatrix(null); 14883 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 14884 } 14885 if (!usingRenderNodeProperties && 14886 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 14887 final Transformation t = parent.getChildTransformation(); 14888 final boolean hasTransform = parent.getChildStaticTransformation(this, t); 14889 if (hasTransform) { 14890 final int transformType = t.getTransformationType(); 14891 transformToApply = transformType != Transformation.TYPE_IDENTITY ? t : null; 14892 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0; 14893 } 14894 } 14895 } 14896 14897 concatMatrix |= !childHasIdentityMatrix; 14898 14899 // Sets the flag as early as possible to allow draw() implementations 14900 // to call invalidate() successfully when doing animations 14901 mPrivateFlags |= PFLAG_DRAWN; 14902 14903 if (!concatMatrix && 14904 (flags & (ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS | 14905 ViewGroup.FLAG_CLIP_CHILDREN)) == ViewGroup.FLAG_CLIP_CHILDREN && 14906 canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) && 14907 (mPrivateFlags & PFLAG_DRAW_ANIMATION) == 0) { 14908 mPrivateFlags2 |= PFLAG2_VIEW_QUICK_REJECTED; 14909 return more; 14910 } 14911 mPrivateFlags2 &= ~PFLAG2_VIEW_QUICK_REJECTED; 14912 14913 if (hardwareAccelerated) { 14914 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but 14915 // retain the flag's value temporarily in the mRecreateDisplayList flag 14916 mRecreateDisplayList = (mPrivateFlags & PFLAG_INVALIDATED) == PFLAG_INVALIDATED; 14917 mPrivateFlags &= ~PFLAG_INVALIDATED; 14918 } 14919 14920 RenderNode renderNode = null; 14921 Bitmap cache = null; 14922 boolean hasDisplayList = false; 14923 if (caching) { 14924 if (!hardwareAccelerated) { 14925 if (layerType != LAYER_TYPE_NONE) { 14926 layerType = LAYER_TYPE_SOFTWARE; 14927 buildDrawingCache(true); 14928 } 14929 cache = getDrawingCache(true); 14930 } else { 14931 switch (layerType) { 14932 case LAYER_TYPE_SOFTWARE: 14933 if (usingRenderNodeProperties) { 14934 hasDisplayList = canHaveDisplayList(); 14935 } else { 14936 buildDrawingCache(true); 14937 cache = getDrawingCache(true); 14938 } 14939 break; 14940 case LAYER_TYPE_HARDWARE: 14941 if (usingRenderNodeProperties) { 14942 hasDisplayList = canHaveDisplayList(); 14943 } 14944 break; 14945 case LAYER_TYPE_NONE: 14946 // Delay getting the display list until animation-driven alpha values are 14947 // set up and possibly passed on to the view 14948 hasDisplayList = canHaveDisplayList(); 14949 break; 14950 } 14951 } 14952 } 14953 usingRenderNodeProperties &= hasDisplayList; 14954 if (usingRenderNodeProperties) { 14955 renderNode = getDisplayList(); 14956 if (!renderNode.isValid()) { 14957 // Uncommon, but possible. If a view is removed from the hierarchy during the call 14958 // to getDisplayList(), the display list will be marked invalid and we should not 14959 // try to use it again. 14960 renderNode = null; 14961 hasDisplayList = false; 14962 usingRenderNodeProperties = false; 14963 } 14964 } 14965 14966 int sx = 0; 14967 int sy = 0; 14968 if (!hasDisplayList) { 14969 computeScroll(); 14970 sx = mScrollX; 14971 sy = mScrollY; 14972 } 14973 14974 final boolean hasNoCache = cache == null || hasDisplayList; 14975 final boolean offsetForScroll = cache == null && !hasDisplayList && 14976 layerType != LAYER_TYPE_HARDWARE; 14977 14978 int restoreTo = -1; 14979 if (!usingRenderNodeProperties || transformToApply != null) { 14980 restoreTo = canvas.save(); 14981 } 14982 if (offsetForScroll) { 14983 canvas.translate(mLeft - sx, mTop - sy); 14984 } else { 14985 if (!usingRenderNodeProperties) { 14986 canvas.translate(mLeft, mTop); 14987 } 14988 if (scalingRequired) { 14989 if (usingRenderNodeProperties) { 14990 // TODO: Might not need this if we put everything inside the DL 14991 restoreTo = canvas.save(); 14992 } 14993 // mAttachInfo cannot be null, otherwise scalingRequired == false 14994 final float scale = 1.0f / mAttachInfo.mApplicationScale; 14995 canvas.scale(scale, scale); 14996 } 14997 } 14998 14999 float alpha = usingRenderNodeProperties ? 1 : (getAlpha() * getTransitionAlpha()); 15000 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix() || 15001 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15002 if (transformToApply != null || !childHasIdentityMatrix) { 15003 int transX = 0; 15004 int transY = 0; 15005 15006 if (offsetForScroll) { 15007 transX = -sx; 15008 transY = -sy; 15009 } 15010 15011 if (transformToApply != null) { 15012 if (concatMatrix) { 15013 if (usingRenderNodeProperties) { 15014 renderNode.setAnimationMatrix(transformToApply.getMatrix()); 15015 } else { 15016 // Undo the scroll translation, apply the transformation matrix, 15017 // then redo the scroll translate to get the correct result. 15018 canvas.translate(-transX, -transY); 15019 canvas.concat(transformToApply.getMatrix()); 15020 canvas.translate(transX, transY); 15021 } 15022 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15023 } 15024 15025 float transformAlpha = transformToApply.getAlpha(); 15026 if (transformAlpha < 1) { 15027 alpha *= transformAlpha; 15028 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15029 } 15030 } 15031 15032 if (!childHasIdentityMatrix && !usingRenderNodeProperties) { 15033 canvas.translate(-transX, -transY); 15034 canvas.concat(getMatrix()); 15035 canvas.translate(transX, transY); 15036 } 15037 } 15038 15039 // Deal with alpha if it is or used to be <1 15040 if (alpha < 1 || 15041 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 15042 if (alpha < 1) { 15043 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15044 } else { 15045 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_ALPHA; 15046 } 15047 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 15048 if (hasNoCache) { 15049 final int multipliedAlpha = (int) (255 * alpha); 15050 if (!onSetAlpha(multipliedAlpha)) { 15051 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15052 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 || 15053 layerType != LAYER_TYPE_NONE) { 15054 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG; 15055 } 15056 if (usingRenderNodeProperties) { 15057 renderNode.setAlpha(alpha * getAlpha() * getTransitionAlpha()); 15058 } else if (layerType == LAYER_TYPE_NONE) { 15059 final int scrollX = hasDisplayList ? 0 : sx; 15060 final int scrollY = hasDisplayList ? 0 : sy; 15061 canvas.saveLayerAlpha(scrollX, scrollY, 15062 scrollX + (mRight - mLeft), scrollY + (mBottom - mTop), 15063 multipliedAlpha, layerFlags); 15064 } 15065 } else { 15066 // Alpha is handled by the child directly, clobber the layer's alpha 15067 mPrivateFlags |= PFLAG_ALPHA_SET; 15068 } 15069 } 15070 } 15071 } else if ((mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15072 onSetAlpha(255); 15073 mPrivateFlags &= ~PFLAG_ALPHA_SET; 15074 } 15075 15076 if (!usingRenderNodeProperties) { 15077 // apply clips directly, since RenderNode won't do it for this draw 15078 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN 15079 && cache == null) { 15080 if (offsetForScroll) { 15081 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop)); 15082 } else { 15083 if (!scalingRequired || cache == null) { 15084 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop); 15085 } else { 15086 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight()); 15087 } 15088 } 15089 } 15090 15091 if (mClipBounds != null) { 15092 // clip bounds ignore scroll 15093 canvas.clipRect(mClipBounds); 15094 } 15095 } 15096 15097 15098 15099 if (!usingRenderNodeProperties && hasDisplayList) { 15100 renderNode = getDisplayList(); 15101 if (!renderNode.isValid()) { 15102 // Uncommon, but possible. If a view is removed from the hierarchy during the call 15103 // to getDisplayList(), the display list will be marked invalid and we should not 15104 // try to use it again. 15105 renderNode = null; 15106 hasDisplayList = false; 15107 } 15108 } 15109 15110 if (hasNoCache) { 15111 boolean layerRendered = false; 15112 if (layerType == LAYER_TYPE_HARDWARE && !usingRenderNodeProperties) { 15113 final HardwareLayer layer = getHardwareLayer(); 15114 if (layer != null && layer.isValid()) { 15115 int restoreAlpha = mLayerPaint.getAlpha(); 15116 mLayerPaint.setAlpha((int) (alpha * 255)); 15117 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint); 15118 mLayerPaint.setAlpha(restoreAlpha); 15119 layerRendered = true; 15120 } else { 15121 final int scrollX = hasDisplayList ? 0 : sx; 15122 final int scrollY = hasDisplayList ? 0 : sy; 15123 canvas.saveLayer(scrollX, scrollY, 15124 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint, 15125 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG); 15126 } 15127 } 15128 15129 if (!layerRendered) { 15130 if (!hasDisplayList) { 15131 // Fast path for layouts with no backgrounds 15132 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 15133 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15134 dispatchDraw(canvas); 15135 } else { 15136 draw(canvas); 15137 } 15138 } else { 15139 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15140 ((HardwareCanvas) canvas).drawRenderNode(renderNode, null, flags); 15141 } 15142 } 15143 } else if (cache != null) { 15144 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 15145 Paint cachePaint; 15146 int restoreAlpha = 0; 15147 15148 if (layerType == LAYER_TYPE_NONE) { 15149 cachePaint = parent.mCachePaint; 15150 if (cachePaint == null) { 15151 cachePaint = new Paint(); 15152 cachePaint.setDither(false); 15153 parent.mCachePaint = cachePaint; 15154 } 15155 } else { 15156 cachePaint = mLayerPaint; 15157 restoreAlpha = mLayerPaint.getAlpha(); 15158 } 15159 cachePaint.setAlpha((int) (alpha * 255)); 15160 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint); 15161 cachePaint.setAlpha(restoreAlpha); 15162 } 15163 15164 if (restoreTo >= 0) { 15165 canvas.restoreToCount(restoreTo); 15166 } 15167 15168 if (a != null && !more) { 15169 if (!hardwareAccelerated && !a.getFillAfter()) { 15170 onSetAlpha(255); 15171 } 15172 parent.finishAnimatingView(this, a); 15173 } 15174 15175 if (more && hardwareAccelerated) { 15176 if (a.hasAlpha() && (mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 15177 // alpha animations should cause the child to recreate its display list 15178 invalidate(true); 15179 } 15180 } 15181 15182 mRecreateDisplayList = false; 15183 15184 return more; 15185 } 15186 15187 /** 15188 * Manually render this view (and all of its children) to the given Canvas. 15189 * The view must have already done a full layout before this function is 15190 * called. When implementing a view, implement 15191 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 15192 * If you do need to override this method, call the superclass version. 15193 * 15194 * @param canvas The Canvas to which the View is rendered. 15195 */ 15196 public void draw(Canvas canvas) { 15197 final int privateFlags = mPrivateFlags; 15198 final boolean dirtyOpaque = (privateFlags & PFLAG_DIRTY_MASK) == PFLAG_DIRTY_OPAQUE && 15199 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 15200 mPrivateFlags = (privateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN; 15201 15202 /* 15203 * Draw traversal performs several drawing steps which must be executed 15204 * in the appropriate order: 15205 * 15206 * 1. Draw the background 15207 * 2. If necessary, save the canvas' layers to prepare for fading 15208 * 3. Draw view's content 15209 * 4. Draw children 15210 * 5. If necessary, draw the fading edges and restore layers 15211 * 6. Draw decorations (scrollbars for instance) 15212 */ 15213 15214 // Step 1, draw the background, if needed 15215 int saveCount; 15216 15217 if (!dirtyOpaque) { 15218 drawBackground(canvas); 15219 } 15220 15221 // skip step 2 & 5 if possible (common case) 15222 final int viewFlags = mViewFlags; 15223 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 15224 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 15225 if (!verticalEdges && !horizontalEdges) { 15226 // Step 3, draw the content 15227 if (!dirtyOpaque) onDraw(canvas); 15228 15229 // Step 4, draw the children 15230 dispatchDraw(canvas); 15231 15232 // Step 6, draw decorations (scrollbars) 15233 onDrawScrollBars(canvas); 15234 15235 if (mOverlay != null && !mOverlay.isEmpty()) { 15236 mOverlay.getOverlayView().dispatchDraw(canvas); 15237 } 15238 15239 // we're done... 15240 return; 15241 } 15242 15243 /* 15244 * Here we do the full fledged routine... 15245 * (this is an uncommon case where speed matters less, 15246 * this is why we repeat some of the tests that have been 15247 * done above) 15248 */ 15249 15250 boolean drawTop = false; 15251 boolean drawBottom = false; 15252 boolean drawLeft = false; 15253 boolean drawRight = false; 15254 15255 float topFadeStrength = 0.0f; 15256 float bottomFadeStrength = 0.0f; 15257 float leftFadeStrength = 0.0f; 15258 float rightFadeStrength = 0.0f; 15259 15260 // Step 2, save the canvas' layers 15261 int paddingLeft = mPaddingLeft; 15262 15263 final boolean offsetRequired = isPaddingOffsetRequired(); 15264 if (offsetRequired) { 15265 paddingLeft += getLeftPaddingOffset(); 15266 } 15267 15268 int left = mScrollX + paddingLeft; 15269 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 15270 int top = mScrollY + getFadeTop(offsetRequired); 15271 int bottom = top + getFadeHeight(offsetRequired); 15272 15273 if (offsetRequired) { 15274 right += getRightPaddingOffset(); 15275 bottom += getBottomPaddingOffset(); 15276 } 15277 15278 final ScrollabilityCache scrollabilityCache = mScrollCache; 15279 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 15280 int length = (int) fadeHeight; 15281 15282 // clip the fade length if top and bottom fades overlap 15283 // overlapping fades produce odd-looking artifacts 15284 if (verticalEdges && (top + length > bottom - length)) { 15285 length = (bottom - top) / 2; 15286 } 15287 15288 // also clip horizontal fades if necessary 15289 if (horizontalEdges && (left + length > right - length)) { 15290 length = (right - left) / 2; 15291 } 15292 15293 if (verticalEdges) { 15294 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 15295 drawTop = topFadeStrength * fadeHeight > 1.0f; 15296 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 15297 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 15298 } 15299 15300 if (horizontalEdges) { 15301 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 15302 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 15303 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 15304 drawRight = rightFadeStrength * fadeHeight > 1.0f; 15305 } 15306 15307 saveCount = canvas.getSaveCount(); 15308 15309 int solidColor = getSolidColor(); 15310 if (solidColor == 0) { 15311 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 15312 15313 if (drawTop) { 15314 canvas.saveLayer(left, top, right, top + length, null, flags); 15315 } 15316 15317 if (drawBottom) { 15318 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 15319 } 15320 15321 if (drawLeft) { 15322 canvas.saveLayer(left, top, left + length, bottom, null, flags); 15323 } 15324 15325 if (drawRight) { 15326 canvas.saveLayer(right - length, top, right, bottom, null, flags); 15327 } 15328 } else { 15329 scrollabilityCache.setFadeColor(solidColor); 15330 } 15331 15332 // Step 3, draw the content 15333 if (!dirtyOpaque) onDraw(canvas); 15334 15335 // Step 4, draw the children 15336 dispatchDraw(canvas); 15337 15338 // Step 5, draw the fade effect and restore layers 15339 final Paint p = scrollabilityCache.paint; 15340 final Matrix matrix = scrollabilityCache.matrix; 15341 final Shader fade = scrollabilityCache.shader; 15342 15343 if (drawTop) { 15344 matrix.setScale(1, fadeHeight * topFadeStrength); 15345 matrix.postTranslate(left, top); 15346 fade.setLocalMatrix(matrix); 15347 p.setShader(fade); 15348 canvas.drawRect(left, top, right, top + length, p); 15349 } 15350 15351 if (drawBottom) { 15352 matrix.setScale(1, fadeHeight * bottomFadeStrength); 15353 matrix.postRotate(180); 15354 matrix.postTranslate(left, bottom); 15355 fade.setLocalMatrix(matrix); 15356 p.setShader(fade); 15357 canvas.drawRect(left, bottom - length, right, bottom, p); 15358 } 15359 15360 if (drawLeft) { 15361 matrix.setScale(1, fadeHeight * leftFadeStrength); 15362 matrix.postRotate(-90); 15363 matrix.postTranslate(left, top); 15364 fade.setLocalMatrix(matrix); 15365 p.setShader(fade); 15366 canvas.drawRect(left, top, left + length, bottom, p); 15367 } 15368 15369 if (drawRight) { 15370 matrix.setScale(1, fadeHeight * rightFadeStrength); 15371 matrix.postRotate(90); 15372 matrix.postTranslate(right, top); 15373 fade.setLocalMatrix(matrix); 15374 p.setShader(fade); 15375 canvas.drawRect(right - length, top, right, bottom, p); 15376 } 15377 15378 canvas.restoreToCount(saveCount); 15379 15380 // Step 6, draw decorations (scrollbars) 15381 onDrawScrollBars(canvas); 15382 15383 if (mOverlay != null && !mOverlay.isEmpty()) { 15384 mOverlay.getOverlayView().dispatchDraw(canvas); 15385 } 15386 } 15387 15388 /** 15389 * Draws the background onto the specified canvas. 15390 * 15391 * @param canvas Canvas on which to draw the background 15392 */ 15393 private void drawBackground(Canvas canvas) { 15394 final Drawable background = mBackground; 15395 if (background == null) { 15396 return; 15397 } 15398 15399 if (mBackgroundSizeChanged) { 15400 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 15401 mBackgroundSizeChanged = false; 15402 rebuildOutline(); 15403 } 15404 15405 // Attempt to use a display list if requested. 15406 if (canvas.isHardwareAccelerated() && mAttachInfo != null 15407 && mAttachInfo.mHardwareRenderer != null) { 15408 mBackgroundRenderNode = getDrawableRenderNode(background, mBackgroundRenderNode); 15409 15410 final RenderNode renderNode = mBackgroundRenderNode; 15411 if (renderNode != null && renderNode.isValid()) { 15412 setBackgroundRenderNodeProperties(renderNode); 15413 ((HardwareCanvas) canvas).drawRenderNode(renderNode); 15414 return; 15415 } 15416 } 15417 15418 final int scrollX = mScrollX; 15419 final int scrollY = mScrollY; 15420 if ((scrollX | scrollY) == 0) { 15421 background.draw(canvas); 15422 } else { 15423 canvas.translate(scrollX, scrollY); 15424 background.draw(canvas); 15425 canvas.translate(-scrollX, -scrollY); 15426 } 15427 } 15428 15429 private void setBackgroundRenderNodeProperties(RenderNode renderNode) { 15430 renderNode.setTranslationX(mScrollX); 15431 renderNode.setTranslationY(mScrollY); 15432 } 15433 15434 /** 15435 * Creates a new display list or updates the existing display list for the 15436 * specified Drawable. 15437 * 15438 * @param drawable Drawable for which to create a display list 15439 * @param renderNode Existing RenderNode, or {@code null} 15440 * @return A valid display list for the specified drawable 15441 */ 15442 private RenderNode getDrawableRenderNode(Drawable drawable, RenderNode renderNode) { 15443 if (renderNode == null) { 15444 renderNode = RenderNode.create(drawable.getClass().getName(), this); 15445 } 15446 15447 final Rect bounds = drawable.getBounds(); 15448 final int width = bounds.width(); 15449 final int height = bounds.height(); 15450 final HardwareCanvas canvas = renderNode.start(width, height); 15451 15452 // Reverse left/top translation done by drawable canvas, which will 15453 // instead be applied by rendernode's LTRB bounds below. This way, the 15454 // drawable's bounds match with its rendernode bounds and its content 15455 // will lie within those bounds in the rendernode tree. 15456 canvas.translate(-bounds.left, -bounds.top); 15457 15458 try { 15459 drawable.draw(canvas); 15460 } finally { 15461 renderNode.end(canvas); 15462 } 15463 15464 // Set up drawable properties that are view-independent. 15465 renderNode.setLeftTopRightBottom(bounds.left, bounds.top, bounds.right, bounds.bottom); 15466 renderNode.setProjectBackwards(drawable.isProjected()); 15467 renderNode.setProjectionReceiver(true); 15468 renderNode.setClipToBounds(false); 15469 return renderNode; 15470 } 15471 15472 /** 15473 * Returns the overlay for this view, creating it if it does not yet exist. 15474 * Adding drawables to the overlay will cause them to be displayed whenever 15475 * the view itself is redrawn. Objects in the overlay should be actively 15476 * managed: remove them when they should not be displayed anymore. The 15477 * overlay will always have the same size as its host view. 15478 * 15479 * <p>Note: Overlays do not currently work correctly with {@link 15480 * SurfaceView} or {@link TextureView}; contents in overlays for these 15481 * types of views may not display correctly.</p> 15482 * 15483 * @return The ViewOverlay object for this view. 15484 * @see ViewOverlay 15485 */ 15486 public ViewOverlay getOverlay() { 15487 if (mOverlay == null) { 15488 mOverlay = new ViewOverlay(mContext, this); 15489 } 15490 return mOverlay; 15491 } 15492 15493 /** 15494 * Override this if your view is known to always be drawn on top of a solid color background, 15495 * and needs to draw fading edges. Returning a non-zero color enables the view system to 15496 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 15497 * should be set to 0xFF. 15498 * 15499 * @see #setVerticalFadingEdgeEnabled(boolean) 15500 * @see #setHorizontalFadingEdgeEnabled(boolean) 15501 * 15502 * @return The known solid color background for this view, or 0 if the color may vary 15503 */ 15504 @ViewDebug.ExportedProperty(category = "drawing") 15505 public int getSolidColor() { 15506 return 0; 15507 } 15508 15509 /** 15510 * Build a human readable string representation of the specified view flags. 15511 * 15512 * @param flags the view flags to convert to a string 15513 * @return a String representing the supplied flags 15514 */ 15515 private static String printFlags(int flags) { 15516 String output = ""; 15517 int numFlags = 0; 15518 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 15519 output += "TAKES_FOCUS"; 15520 numFlags++; 15521 } 15522 15523 switch (flags & VISIBILITY_MASK) { 15524 case INVISIBLE: 15525 if (numFlags > 0) { 15526 output += " "; 15527 } 15528 output += "INVISIBLE"; 15529 // USELESS HERE numFlags++; 15530 break; 15531 case GONE: 15532 if (numFlags > 0) { 15533 output += " "; 15534 } 15535 output += "GONE"; 15536 // USELESS HERE numFlags++; 15537 break; 15538 default: 15539 break; 15540 } 15541 return output; 15542 } 15543 15544 /** 15545 * Build a human readable string representation of the specified private 15546 * view flags. 15547 * 15548 * @param privateFlags the private view flags to convert to a string 15549 * @return a String representing the supplied flags 15550 */ 15551 private static String printPrivateFlags(int privateFlags) { 15552 String output = ""; 15553 int numFlags = 0; 15554 15555 if ((privateFlags & PFLAG_WANTS_FOCUS) == PFLAG_WANTS_FOCUS) { 15556 output += "WANTS_FOCUS"; 15557 numFlags++; 15558 } 15559 15560 if ((privateFlags & PFLAG_FOCUSED) == PFLAG_FOCUSED) { 15561 if (numFlags > 0) { 15562 output += " "; 15563 } 15564 output += "FOCUSED"; 15565 numFlags++; 15566 } 15567 15568 if ((privateFlags & PFLAG_SELECTED) == PFLAG_SELECTED) { 15569 if (numFlags > 0) { 15570 output += " "; 15571 } 15572 output += "SELECTED"; 15573 numFlags++; 15574 } 15575 15576 if ((privateFlags & PFLAG_IS_ROOT_NAMESPACE) == PFLAG_IS_ROOT_NAMESPACE) { 15577 if (numFlags > 0) { 15578 output += " "; 15579 } 15580 output += "IS_ROOT_NAMESPACE"; 15581 numFlags++; 15582 } 15583 15584 if ((privateFlags & PFLAG_HAS_BOUNDS) == PFLAG_HAS_BOUNDS) { 15585 if (numFlags > 0) { 15586 output += " "; 15587 } 15588 output += "HAS_BOUNDS"; 15589 numFlags++; 15590 } 15591 15592 if ((privateFlags & PFLAG_DRAWN) == PFLAG_DRAWN) { 15593 if (numFlags > 0) { 15594 output += " "; 15595 } 15596 output += "DRAWN"; 15597 // USELESS HERE numFlags++; 15598 } 15599 return output; 15600 } 15601 15602 /** 15603 * <p>Indicates whether or not this view's layout will be requested during 15604 * the next hierarchy layout pass.</p> 15605 * 15606 * @return true if the layout will be forced during next layout pass 15607 */ 15608 public boolean isLayoutRequested() { 15609 return (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 15610 } 15611 15612 /** 15613 * Return true if o is a ViewGroup that is laying out using optical bounds. 15614 * @hide 15615 */ 15616 public static boolean isLayoutModeOptical(Object o) { 15617 return o instanceof ViewGroup && ((ViewGroup) o).isLayoutModeOptical(); 15618 } 15619 15620 private boolean setOpticalFrame(int left, int top, int right, int bottom) { 15621 Insets parentInsets = mParent instanceof View ? 15622 ((View) mParent).getOpticalInsets() : Insets.NONE; 15623 Insets childInsets = getOpticalInsets(); 15624 return setFrame( 15625 left + parentInsets.left - childInsets.left, 15626 top + parentInsets.top - childInsets.top, 15627 right + parentInsets.left + childInsets.right, 15628 bottom + parentInsets.top + childInsets.bottom); 15629 } 15630 15631 /** 15632 * Assign a size and position to a view and all of its 15633 * descendants 15634 * 15635 * <p>This is the second phase of the layout mechanism. 15636 * (The first is measuring). In this phase, each parent calls 15637 * layout on all of its children to position them. 15638 * This is typically done using the child measurements 15639 * that were stored in the measure pass().</p> 15640 * 15641 * <p>Derived classes should not override this method. 15642 * Derived classes with children should override 15643 * onLayout. In that method, they should 15644 * call layout on each of their children.</p> 15645 * 15646 * @param l Left position, relative to parent 15647 * @param t Top position, relative to parent 15648 * @param r Right position, relative to parent 15649 * @param b Bottom position, relative to parent 15650 */ 15651 @SuppressWarnings({"unchecked"}) 15652 public void layout(int l, int t, int r, int b) { 15653 if ((mPrivateFlags3 & PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT) != 0) { 15654 onMeasure(mOldWidthMeasureSpec, mOldHeightMeasureSpec); 15655 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 15656 } 15657 15658 int oldL = mLeft; 15659 int oldT = mTop; 15660 int oldB = mBottom; 15661 int oldR = mRight; 15662 15663 boolean changed = isLayoutModeOptical(mParent) ? 15664 setOpticalFrame(l, t, r, b) : setFrame(l, t, r, b); 15665 15666 if (changed || (mPrivateFlags & PFLAG_LAYOUT_REQUIRED) == PFLAG_LAYOUT_REQUIRED) { 15667 onLayout(changed, l, t, r, b); 15668 mPrivateFlags &= ~PFLAG_LAYOUT_REQUIRED; 15669 15670 ListenerInfo li = mListenerInfo; 15671 if (li != null && li.mOnLayoutChangeListeners != null) { 15672 ArrayList<OnLayoutChangeListener> listenersCopy = 15673 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 15674 int numListeners = listenersCopy.size(); 15675 for (int i = 0; i < numListeners; ++i) { 15676 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 15677 } 15678 } 15679 } 15680 15681 mPrivateFlags &= ~PFLAG_FORCE_LAYOUT; 15682 mPrivateFlags3 |= PFLAG3_IS_LAID_OUT; 15683 } 15684 15685 /** 15686 * Called from layout when this view should 15687 * assign a size and position to each of its children. 15688 * 15689 * Derived classes with children should override 15690 * this method and call layout on each of 15691 * their children. 15692 * @param changed This is a new size or position for this view 15693 * @param left Left position, relative to parent 15694 * @param top Top position, relative to parent 15695 * @param right Right position, relative to parent 15696 * @param bottom Bottom position, relative to parent 15697 */ 15698 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 15699 } 15700 15701 /** 15702 * Assign a size and position to this view. 15703 * 15704 * This is called from layout. 15705 * 15706 * @param left Left position, relative to parent 15707 * @param top Top position, relative to parent 15708 * @param right Right position, relative to parent 15709 * @param bottom Bottom position, relative to parent 15710 * @return true if the new size and position are different than the 15711 * previous ones 15712 * {@hide} 15713 */ 15714 protected boolean setFrame(int left, int top, int right, int bottom) { 15715 boolean changed = false; 15716 15717 if (DBG) { 15718 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 15719 + right + "," + bottom + ")"); 15720 } 15721 15722 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 15723 changed = true; 15724 15725 // Remember our drawn bit 15726 int drawn = mPrivateFlags & PFLAG_DRAWN; 15727 15728 int oldWidth = mRight - mLeft; 15729 int oldHeight = mBottom - mTop; 15730 int newWidth = right - left; 15731 int newHeight = bottom - top; 15732 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 15733 15734 // Invalidate our old position 15735 invalidate(sizeChanged); 15736 15737 mLeft = left; 15738 mTop = top; 15739 mRight = right; 15740 mBottom = bottom; 15741 mRenderNode.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 15742 15743 mPrivateFlags |= PFLAG_HAS_BOUNDS; 15744 15745 15746 if (sizeChanged) { 15747 sizeChange(newWidth, newHeight, oldWidth, oldHeight); 15748 } 15749 15750 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE || mGhostView != null) { 15751 // If we are visible, force the DRAWN bit to on so that 15752 // this invalidate will go through (at least to our parent). 15753 // This is because someone may have invalidated this view 15754 // before this call to setFrame came in, thereby clearing 15755 // the DRAWN bit. 15756 mPrivateFlags |= PFLAG_DRAWN; 15757 invalidate(sizeChanged); 15758 // parent display list may need to be recreated based on a change in the bounds 15759 // of any child 15760 invalidateParentCaches(); 15761 } 15762 15763 // Reset drawn bit to original value (invalidate turns it off) 15764 mPrivateFlags |= drawn; 15765 15766 mBackgroundSizeChanged = true; 15767 15768 notifySubtreeAccessibilityStateChangedIfNeeded(); 15769 } 15770 return changed; 15771 } 15772 15773 /** 15774 * Same as setFrame, but public and hidden. For use in {@link android.transition.ChangeBounds}. 15775 * @hide 15776 */ 15777 public void setLeftTopRightBottom(int left, int top, int right, int bottom) { 15778 setFrame(left, top, right, bottom); 15779 } 15780 15781 private void sizeChange(int newWidth, int newHeight, int oldWidth, int oldHeight) { 15782 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 15783 if (mOverlay != null) { 15784 mOverlay.getOverlayView().setRight(newWidth); 15785 mOverlay.getOverlayView().setBottom(newHeight); 15786 } 15787 rebuildOutline(); 15788 } 15789 15790 /** 15791 * Finalize inflating a view from XML. This is called as the last phase 15792 * of inflation, after all child views have been added. 15793 * 15794 * <p>Even if the subclass overrides onFinishInflate, they should always be 15795 * sure to call the super method, so that we get called. 15796 */ 15797 protected void onFinishInflate() { 15798 } 15799 15800 /** 15801 * Returns the resources associated with this view. 15802 * 15803 * @return Resources object. 15804 */ 15805 public Resources getResources() { 15806 return mResources; 15807 } 15808 15809 /** 15810 * Invalidates the specified Drawable. 15811 * 15812 * @param drawable the drawable to invalidate 15813 */ 15814 @Override 15815 public void invalidateDrawable(@NonNull Drawable drawable) { 15816 if (verifyDrawable(drawable)) { 15817 final Rect dirty = drawable.getDirtyBounds(); 15818 final int scrollX = mScrollX; 15819 final int scrollY = mScrollY; 15820 15821 invalidate(dirty.left + scrollX, dirty.top + scrollY, 15822 dirty.right + scrollX, dirty.bottom + scrollY); 15823 rebuildOutline(); 15824 } 15825 } 15826 15827 /** 15828 * Schedules an action on a drawable to occur at a specified time. 15829 * 15830 * @param who the recipient of the action 15831 * @param what the action to run on the drawable 15832 * @param when the time at which the action must occur. Uses the 15833 * {@link SystemClock#uptimeMillis} timebase. 15834 */ 15835 @Override 15836 public void scheduleDrawable(Drawable who, Runnable what, long when) { 15837 if (verifyDrawable(who) && what != null) { 15838 final long delay = when - SystemClock.uptimeMillis(); 15839 if (mAttachInfo != null) { 15840 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 15841 Choreographer.CALLBACK_ANIMATION, what, who, 15842 Choreographer.subtractFrameDelay(delay)); 15843 } else { 15844 ViewRootImpl.getRunQueue().postDelayed(what, delay); 15845 } 15846 } 15847 } 15848 15849 /** 15850 * Cancels a scheduled action on a drawable. 15851 * 15852 * @param who the recipient of the action 15853 * @param what the action to cancel 15854 */ 15855 @Override 15856 public void unscheduleDrawable(Drawable who, Runnable what) { 15857 if (verifyDrawable(who) && what != null) { 15858 if (mAttachInfo != null) { 15859 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15860 Choreographer.CALLBACK_ANIMATION, what, who); 15861 } 15862 ViewRootImpl.getRunQueue().removeCallbacks(what); 15863 } 15864 } 15865 15866 /** 15867 * Unschedule any events associated with the given Drawable. This can be 15868 * used when selecting a new Drawable into a view, so that the previous 15869 * one is completely unscheduled. 15870 * 15871 * @param who The Drawable to unschedule. 15872 * 15873 * @see #drawableStateChanged 15874 */ 15875 public void unscheduleDrawable(Drawable who) { 15876 if (mAttachInfo != null && who != null) { 15877 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 15878 Choreographer.CALLBACK_ANIMATION, null, who); 15879 } 15880 } 15881 15882 /** 15883 * Resolve the Drawables depending on the layout direction. This is implicitly supposing 15884 * that the View directionality can and will be resolved before its Drawables. 15885 * 15886 * Will call {@link View#onResolveDrawables} when resolution is done. 15887 * 15888 * @hide 15889 */ 15890 protected void resolveDrawables() { 15891 // Drawables resolution may need to happen before resolving the layout direction (which is 15892 // done only during the measure() call). 15893 // If the layout direction is not resolved yet, we cannot resolve the Drawables except in 15894 // one case: when the raw layout direction has not been defined as LAYOUT_DIRECTION_INHERIT. 15895 // So, if the raw layout direction is LAYOUT_DIRECTION_LTR or LAYOUT_DIRECTION_RTL or 15896 // LAYOUT_DIRECTION_LOCALE, we can "cheat" and we don't need to wait for the layout 15897 // direction to be resolved as its resolved value will be the same as its raw value. 15898 if (!isLayoutDirectionResolved() && 15899 getRawLayoutDirection() == View.LAYOUT_DIRECTION_INHERIT) { 15900 return; 15901 } 15902 15903 final int layoutDirection = isLayoutDirectionResolved() ? 15904 getLayoutDirection() : getRawLayoutDirection(); 15905 15906 if (mBackground != null) { 15907 mBackground.setLayoutDirection(layoutDirection); 15908 } 15909 mPrivateFlags2 |= PFLAG2_DRAWABLE_RESOLVED; 15910 onResolveDrawables(layoutDirection); 15911 } 15912 15913 boolean areDrawablesResolved() { 15914 return (mPrivateFlags2 & PFLAG2_DRAWABLE_RESOLVED) == PFLAG2_DRAWABLE_RESOLVED; 15915 } 15916 15917 /** 15918 * Called when layout direction has been resolved. 15919 * 15920 * The default implementation does nothing. 15921 * 15922 * @param layoutDirection The resolved layout direction. 15923 * 15924 * @see #LAYOUT_DIRECTION_LTR 15925 * @see #LAYOUT_DIRECTION_RTL 15926 * 15927 * @hide 15928 */ 15929 public void onResolveDrawables(@ResolvedLayoutDir int layoutDirection) { 15930 } 15931 15932 /** 15933 * @hide 15934 */ 15935 protected void resetResolvedDrawables() { 15936 resetResolvedDrawablesInternal(); 15937 } 15938 15939 void resetResolvedDrawablesInternal() { 15940 mPrivateFlags2 &= ~PFLAG2_DRAWABLE_RESOLVED; 15941 } 15942 15943 /** 15944 * If your view subclass is displaying its own Drawable objects, it should 15945 * override this function and return true for any Drawable it is 15946 * displaying. This allows animations for those drawables to be 15947 * scheduled. 15948 * 15949 * <p>Be sure to call through to the super class when overriding this 15950 * function. 15951 * 15952 * @param who The Drawable to verify. Return true if it is one you are 15953 * displaying, else return the result of calling through to the 15954 * super class. 15955 * 15956 * @return boolean If true than the Drawable is being displayed in the 15957 * view; else false and it is not allowed to animate. 15958 * 15959 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 15960 * @see #drawableStateChanged() 15961 */ 15962 protected boolean verifyDrawable(Drawable who) { 15963 return who == mBackground; 15964 } 15965 15966 /** 15967 * This function is called whenever the state of the view changes in such 15968 * a way that it impacts the state of drawables being shown. 15969 * <p> 15970 * If the View has a StateListAnimator, it will also be called to run necessary state 15971 * change animations. 15972 * <p> 15973 * Be sure to call through to the superclass when overriding this function. 15974 * 15975 * @see Drawable#setState(int[]) 15976 */ 15977 protected void drawableStateChanged() { 15978 final Drawable d = mBackground; 15979 if (d != null && d.isStateful()) { 15980 d.setState(getDrawableState()); 15981 } 15982 15983 if (mStateListAnimator != null) { 15984 mStateListAnimator.setState(getDrawableState()); 15985 } 15986 } 15987 15988 /** 15989 * This function is called whenever the view hotspot changes and needs to 15990 * be propagated to drawables or child views managed by the view. 15991 * <p> 15992 * Dispatching to child views is handled by 15993 * {@link #dispatchDrawableHotspotChanged(float, float)}. 15994 * <p> 15995 * Be sure to call through to the superclass when overriding this function. 15996 * 15997 * @param x hotspot x coordinate 15998 * @param y hotspot y coordinate 15999 */ 16000 public void drawableHotspotChanged(float x, float y) { 16001 if (mBackground != null) { 16002 mBackground.setHotspot(x, y); 16003 } 16004 16005 dispatchDrawableHotspotChanged(x, y); 16006 } 16007 16008 /** 16009 * Dispatches drawableHotspotChanged to all of this View's children. 16010 * 16011 * @param x hotspot x coordinate 16012 * @param y hotspot y coordinate 16013 * @see #drawableHotspotChanged(float, float) 16014 */ 16015 public void dispatchDrawableHotspotChanged(float x, float y) { 16016 } 16017 16018 /** 16019 * Call this to force a view to update its drawable state. This will cause 16020 * drawableStateChanged to be called on this view. Views that are interested 16021 * in the new state should call getDrawableState. 16022 * 16023 * @see #drawableStateChanged 16024 * @see #getDrawableState 16025 */ 16026 public void refreshDrawableState() { 16027 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 16028 drawableStateChanged(); 16029 16030 ViewParent parent = mParent; 16031 if (parent != null) { 16032 parent.childDrawableStateChanged(this); 16033 } 16034 } 16035 16036 /** 16037 * Return an array of resource IDs of the drawable states representing the 16038 * current state of the view. 16039 * 16040 * @return The current drawable state 16041 * 16042 * @see Drawable#setState(int[]) 16043 * @see #drawableStateChanged() 16044 * @see #onCreateDrawableState(int) 16045 */ 16046 public final int[] getDrawableState() { 16047 if ((mDrawableState != null) && ((mPrivateFlags & PFLAG_DRAWABLE_STATE_DIRTY) == 0)) { 16048 return mDrawableState; 16049 } else { 16050 mDrawableState = onCreateDrawableState(0); 16051 mPrivateFlags &= ~PFLAG_DRAWABLE_STATE_DIRTY; 16052 return mDrawableState; 16053 } 16054 } 16055 16056 /** 16057 * Generate the new {@link android.graphics.drawable.Drawable} state for 16058 * this view. This is called by the view 16059 * system when the cached Drawable state is determined to be invalid. To 16060 * retrieve the current state, you should use {@link #getDrawableState}. 16061 * 16062 * @param extraSpace if non-zero, this is the number of extra entries you 16063 * would like in the returned array in which you can place your own 16064 * states. 16065 * 16066 * @return Returns an array holding the current {@link Drawable} state of 16067 * the view. 16068 * 16069 * @see #mergeDrawableStates(int[], int[]) 16070 */ 16071 protected int[] onCreateDrawableState(int extraSpace) { 16072 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 16073 mParent instanceof View) { 16074 return ((View) mParent).onCreateDrawableState(extraSpace); 16075 } 16076 16077 int[] drawableState; 16078 16079 int privateFlags = mPrivateFlags; 16080 16081 int viewStateIndex = 0; 16082 if ((privateFlags & PFLAG_PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 16083 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 16084 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 16085 if ((privateFlags & PFLAG_SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 16086 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 16087 if ((privateFlags & PFLAG_ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 16088 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 16089 HardwareRenderer.isAvailable()) { 16090 // This is set if HW acceleration is requested, even if the current 16091 // process doesn't allow it. This is just to allow app preview 16092 // windows to better match their app. 16093 viewStateIndex |= VIEW_STATE_ACCELERATED; 16094 } 16095 if ((privateFlags & PFLAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 16096 16097 final int privateFlags2 = mPrivateFlags2; 16098 if ((privateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 16099 if ((privateFlags2 & PFLAG2_DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 16100 16101 drawableState = VIEW_STATE_SETS[viewStateIndex]; 16102 16103 //noinspection ConstantIfStatement 16104 if (false) { 16105 Log.i("View", "drawableStateIndex=" + viewStateIndex); 16106 Log.i("View", toString() 16107 + " pressed=" + ((privateFlags & PFLAG_PRESSED) != 0) 16108 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 16109 + " fo=" + hasFocus() 16110 + " sl=" + ((privateFlags & PFLAG_SELECTED) != 0) 16111 + " wf=" + hasWindowFocus() 16112 + ": " + Arrays.toString(drawableState)); 16113 } 16114 16115 if (extraSpace == 0) { 16116 return drawableState; 16117 } 16118 16119 final int[] fullState; 16120 if (drawableState != null) { 16121 fullState = new int[drawableState.length + extraSpace]; 16122 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 16123 } else { 16124 fullState = new int[extraSpace]; 16125 } 16126 16127 return fullState; 16128 } 16129 16130 /** 16131 * Merge your own state values in <var>additionalState</var> into the base 16132 * state values <var>baseState</var> that were returned by 16133 * {@link #onCreateDrawableState(int)}. 16134 * 16135 * @param baseState The base state values returned by 16136 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 16137 * own additional state values. 16138 * 16139 * @param additionalState The additional state values you would like 16140 * added to <var>baseState</var>; this array is not modified. 16141 * 16142 * @return As a convenience, the <var>baseState</var> array you originally 16143 * passed into the function is returned. 16144 * 16145 * @see #onCreateDrawableState(int) 16146 */ 16147 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 16148 final int N = baseState.length; 16149 int i = N - 1; 16150 while (i >= 0 && baseState[i] == 0) { 16151 i--; 16152 } 16153 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 16154 return baseState; 16155 } 16156 16157 /** 16158 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 16159 * on all Drawable objects associated with this view. 16160 * <p> 16161 * Also calls {@link StateListAnimator#jumpToCurrentState()} if there is a StateListAnimator 16162 * attached to this view. 16163 */ 16164 public void jumpDrawablesToCurrentState() { 16165 if (mBackground != null) { 16166 mBackground.jumpToCurrentState(); 16167 } 16168 if (mStateListAnimator != null) { 16169 mStateListAnimator.jumpToCurrentState(); 16170 } 16171 } 16172 16173 /** 16174 * Sets the background color for this view. 16175 * @param color the color of the background 16176 */ 16177 @RemotableViewMethod 16178 public void setBackgroundColor(int color) { 16179 if (mBackground instanceof ColorDrawable) { 16180 ((ColorDrawable) mBackground.mutate()).setColor(color); 16181 computeOpaqueFlags(); 16182 mBackgroundResource = 0; 16183 } else { 16184 setBackground(new ColorDrawable(color)); 16185 } 16186 } 16187 16188 /** 16189 * Set the background to a given resource. The resource should refer to 16190 * a Drawable object or 0 to remove the background. 16191 * @param resid The identifier of the resource. 16192 * 16193 * @attr ref android.R.styleable#View_background 16194 */ 16195 @RemotableViewMethod 16196 public void setBackgroundResource(int resid) { 16197 if (resid != 0 && resid == mBackgroundResource) { 16198 return; 16199 } 16200 16201 Drawable d = null; 16202 if (resid != 0) { 16203 d = mContext.getDrawable(resid); 16204 } 16205 setBackground(d); 16206 16207 mBackgroundResource = resid; 16208 } 16209 16210 /** 16211 * Set the background to a given Drawable, or remove the background. If the 16212 * background has padding, this View's padding is set to the background's 16213 * padding. However, when a background is removed, this View's padding isn't 16214 * touched. If setting the padding is desired, please use 16215 * {@link #setPadding(int, int, int, int)}. 16216 * 16217 * @param background The Drawable to use as the background, or null to remove the 16218 * background 16219 */ 16220 public void setBackground(Drawable background) { 16221 //noinspection deprecation 16222 setBackgroundDrawable(background); 16223 } 16224 16225 /** 16226 * @deprecated use {@link #setBackground(Drawable)} instead 16227 */ 16228 @Deprecated 16229 public void setBackgroundDrawable(Drawable background) { 16230 computeOpaqueFlags(); 16231 16232 if (background == mBackground) { 16233 return; 16234 } 16235 16236 boolean requestLayout = false; 16237 16238 mBackgroundResource = 0; 16239 16240 /* 16241 * Regardless of whether we're setting a new background or not, we want 16242 * to clear the previous drawable. 16243 */ 16244 if (mBackground != null) { 16245 mBackground.setCallback(null); 16246 unscheduleDrawable(mBackground); 16247 } 16248 16249 if (background != null) { 16250 Rect padding = sThreadLocal.get(); 16251 if (padding == null) { 16252 padding = new Rect(); 16253 sThreadLocal.set(padding); 16254 } 16255 resetResolvedDrawablesInternal(); 16256 background.setLayoutDirection(getLayoutDirection()); 16257 if (background.getPadding(padding)) { 16258 resetResolvedPaddingInternal(); 16259 switch (background.getLayoutDirection()) { 16260 case LAYOUT_DIRECTION_RTL: 16261 mUserPaddingLeftInitial = padding.right; 16262 mUserPaddingRightInitial = padding.left; 16263 internalSetPadding(padding.right, padding.top, padding.left, padding.bottom); 16264 break; 16265 case LAYOUT_DIRECTION_LTR: 16266 default: 16267 mUserPaddingLeftInitial = padding.left; 16268 mUserPaddingRightInitial = padding.right; 16269 internalSetPadding(padding.left, padding.top, padding.right, padding.bottom); 16270 } 16271 mLeftPaddingDefined = false; 16272 mRightPaddingDefined = false; 16273 } 16274 16275 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 16276 // if it has a different minimum size, we should layout again 16277 if (mBackground == null 16278 || mBackground.getMinimumHeight() != background.getMinimumHeight() 16279 || mBackground.getMinimumWidth() != background.getMinimumWidth()) { 16280 requestLayout = true; 16281 } 16282 16283 background.setCallback(this); 16284 if (background.isStateful()) { 16285 background.setState(getDrawableState()); 16286 } 16287 background.setVisible(getVisibility() == VISIBLE, false); 16288 mBackground = background; 16289 16290 applyBackgroundTint(); 16291 16292 if ((mPrivateFlags & PFLAG_SKIP_DRAW) != 0) { 16293 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 16294 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 16295 requestLayout = true; 16296 } 16297 } else { 16298 /* Remove the background */ 16299 mBackground = null; 16300 16301 if ((mPrivateFlags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0) { 16302 /* 16303 * This view ONLY drew the background before and we're removing 16304 * the background, so now it won't draw anything 16305 * (hence we SKIP_DRAW) 16306 */ 16307 mPrivateFlags &= ~PFLAG_ONLY_DRAWS_BACKGROUND; 16308 mPrivateFlags |= PFLAG_SKIP_DRAW; 16309 } 16310 16311 /* 16312 * When the background is set, we try to apply its padding to this 16313 * View. When the background is removed, we don't touch this View's 16314 * padding. This is noted in the Javadocs. Hence, we don't need to 16315 * requestLayout(), the invalidate() below is sufficient. 16316 */ 16317 16318 // The old background's minimum size could have affected this 16319 // View's layout, so let's requestLayout 16320 requestLayout = true; 16321 } 16322 16323 computeOpaqueFlags(); 16324 16325 if (requestLayout) { 16326 requestLayout(); 16327 } 16328 16329 mBackgroundSizeChanged = true; 16330 invalidate(true); 16331 } 16332 16333 /** 16334 * Gets the background drawable 16335 * 16336 * @return The drawable used as the background for this view, if any. 16337 * 16338 * @see #setBackground(Drawable) 16339 * 16340 * @attr ref android.R.styleable#View_background 16341 */ 16342 public Drawable getBackground() { 16343 return mBackground; 16344 } 16345 16346 /** 16347 * Applies a tint to the background drawable. Does not modify the current tint 16348 * mode, which is {@link PorterDuff.Mode#SRC_IN} by default. 16349 * <p> 16350 * Subsequent calls to {@link #setBackground(Drawable)} will automatically 16351 * mutate the drawable and apply the specified tint and tint mode using 16352 * {@link Drawable#setTintList(ColorStateList)}. 16353 * 16354 * @param tint the tint to apply, may be {@code null} to clear tint 16355 * 16356 * @attr ref android.R.styleable#View_backgroundTint 16357 * @see #getBackgroundTintList() 16358 * @see Drawable#setTintList(ColorStateList) 16359 */ 16360 public void setBackgroundTintList(@Nullable ColorStateList tint) { 16361 if (mBackgroundTint == null) { 16362 mBackgroundTint = new TintInfo(); 16363 } 16364 mBackgroundTint.mTintList = tint; 16365 mBackgroundTint.mHasTintList = true; 16366 16367 applyBackgroundTint(); 16368 } 16369 16370 /** 16371 * Return the tint applied to the background drawable, if specified. 16372 * 16373 * @return the tint applied to the background drawable 16374 * @attr ref android.R.styleable#View_backgroundTint 16375 * @see #setBackgroundTintList(ColorStateList) 16376 */ 16377 @Nullable 16378 public ColorStateList getBackgroundTintList() { 16379 return mBackgroundTint != null ? mBackgroundTint.mTintList : null; 16380 } 16381 16382 /** 16383 * Specifies the blending mode used to apply the tint specified by 16384 * {@link #setBackgroundTintList(ColorStateList)}} to the background 16385 * drawable. The default mode is {@link PorterDuff.Mode#SRC_IN}. 16386 * 16387 * @param tintMode the blending mode used to apply the tint, may be 16388 * {@code null} to clear tint 16389 * @attr ref android.R.styleable#View_backgroundTintMode 16390 * @see #getBackgroundTintMode() 16391 * @see Drawable#setTintMode(PorterDuff.Mode) 16392 */ 16393 public void setBackgroundTintMode(@Nullable PorterDuff.Mode tintMode) { 16394 if (mBackgroundTint == null) { 16395 mBackgroundTint = new TintInfo(); 16396 } 16397 mBackgroundTint.mTintMode = tintMode; 16398 mBackgroundTint.mHasTintMode = true; 16399 16400 applyBackgroundTint(); 16401 } 16402 16403 /** 16404 * Return the blending mode used to apply the tint to the background 16405 * drawable, if specified. 16406 * 16407 * @return the blending mode used to apply the tint to the background 16408 * drawable 16409 * @attr ref android.R.styleable#View_backgroundTintMode 16410 * @see #setBackgroundTintMode(PorterDuff.Mode) 16411 */ 16412 @Nullable 16413 public PorterDuff.Mode getBackgroundTintMode() { 16414 return mBackgroundTint != null ? mBackgroundTint.mTintMode : null; 16415 } 16416 16417 private void applyBackgroundTint() { 16418 if (mBackground != null && mBackgroundTint != null) { 16419 final TintInfo tintInfo = mBackgroundTint; 16420 if (tintInfo.mHasTintList || tintInfo.mHasTintMode) { 16421 mBackground = mBackground.mutate(); 16422 16423 if (tintInfo.mHasTintList) { 16424 mBackground.setTintList(tintInfo.mTintList); 16425 } 16426 16427 if (tintInfo.mHasTintMode) { 16428 mBackground.setTintMode(tintInfo.mTintMode); 16429 } 16430 16431 // The drawable (or one of its children) may not have been 16432 // stateful before applying the tint, so let's try again. 16433 if (mBackground.isStateful()) { 16434 mBackground.setState(getDrawableState()); 16435 } 16436 } 16437 } 16438 } 16439 16440 /** 16441 * Sets the padding. The view may add on the space required to display 16442 * the scrollbars, depending on the style and visibility of the scrollbars. 16443 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 16444 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 16445 * from the values set in this call. 16446 * 16447 * @attr ref android.R.styleable#View_padding 16448 * @attr ref android.R.styleable#View_paddingBottom 16449 * @attr ref android.R.styleable#View_paddingLeft 16450 * @attr ref android.R.styleable#View_paddingRight 16451 * @attr ref android.R.styleable#View_paddingTop 16452 * @param left the left padding in pixels 16453 * @param top the top padding in pixels 16454 * @param right the right padding in pixels 16455 * @param bottom the bottom padding in pixels 16456 */ 16457 public void setPadding(int left, int top, int right, int bottom) { 16458 resetResolvedPaddingInternal(); 16459 16460 mUserPaddingStart = UNDEFINED_PADDING; 16461 mUserPaddingEnd = UNDEFINED_PADDING; 16462 16463 mUserPaddingLeftInitial = left; 16464 mUserPaddingRightInitial = right; 16465 16466 mLeftPaddingDefined = true; 16467 mRightPaddingDefined = true; 16468 16469 internalSetPadding(left, top, right, bottom); 16470 } 16471 16472 /** 16473 * @hide 16474 */ 16475 protected void internalSetPadding(int left, int top, int right, int bottom) { 16476 mUserPaddingLeft = left; 16477 mUserPaddingRight = right; 16478 mUserPaddingBottom = bottom; 16479 16480 final int viewFlags = mViewFlags; 16481 boolean changed = false; 16482 16483 // Common case is there are no scroll bars. 16484 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 16485 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 16486 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 16487 ? 0 : getVerticalScrollbarWidth(); 16488 switch (mVerticalScrollbarPosition) { 16489 case SCROLLBAR_POSITION_DEFAULT: 16490 if (isLayoutRtl()) { 16491 left += offset; 16492 } else { 16493 right += offset; 16494 } 16495 break; 16496 case SCROLLBAR_POSITION_RIGHT: 16497 right += offset; 16498 break; 16499 case SCROLLBAR_POSITION_LEFT: 16500 left += offset; 16501 break; 16502 } 16503 } 16504 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 16505 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 16506 ? 0 : getHorizontalScrollbarHeight(); 16507 } 16508 } 16509 16510 if (mPaddingLeft != left) { 16511 changed = true; 16512 mPaddingLeft = left; 16513 } 16514 if (mPaddingTop != top) { 16515 changed = true; 16516 mPaddingTop = top; 16517 } 16518 if (mPaddingRight != right) { 16519 changed = true; 16520 mPaddingRight = right; 16521 } 16522 if (mPaddingBottom != bottom) { 16523 changed = true; 16524 mPaddingBottom = bottom; 16525 } 16526 16527 if (changed) { 16528 requestLayout(); 16529 invalidateOutline(); 16530 } 16531 } 16532 16533 /** 16534 * Sets the relative padding. The view may add on the space required to display 16535 * the scrollbars, depending on the style and visibility of the scrollbars. 16536 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 16537 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 16538 * from the values set in this call. 16539 * 16540 * @attr ref android.R.styleable#View_padding 16541 * @attr ref android.R.styleable#View_paddingBottom 16542 * @attr ref android.R.styleable#View_paddingStart 16543 * @attr ref android.R.styleable#View_paddingEnd 16544 * @attr ref android.R.styleable#View_paddingTop 16545 * @param start the start padding in pixels 16546 * @param top the top padding in pixels 16547 * @param end the end padding in pixels 16548 * @param bottom the bottom padding in pixels 16549 */ 16550 public void setPaddingRelative(int start, int top, int end, int bottom) { 16551 resetResolvedPaddingInternal(); 16552 16553 mUserPaddingStart = start; 16554 mUserPaddingEnd = end; 16555 mLeftPaddingDefined = true; 16556 mRightPaddingDefined = true; 16557 16558 switch(getLayoutDirection()) { 16559 case LAYOUT_DIRECTION_RTL: 16560 mUserPaddingLeftInitial = end; 16561 mUserPaddingRightInitial = start; 16562 internalSetPadding(end, top, start, bottom); 16563 break; 16564 case LAYOUT_DIRECTION_LTR: 16565 default: 16566 mUserPaddingLeftInitial = start; 16567 mUserPaddingRightInitial = end; 16568 internalSetPadding(start, top, end, bottom); 16569 } 16570 } 16571 16572 /** 16573 * Returns the top padding of this view. 16574 * 16575 * @return the top padding in pixels 16576 */ 16577 public int getPaddingTop() { 16578 return mPaddingTop; 16579 } 16580 16581 /** 16582 * Returns the bottom padding of this view. If there are inset and enabled 16583 * scrollbars, this value may include the space required to display the 16584 * scrollbars as well. 16585 * 16586 * @return the bottom padding in pixels 16587 */ 16588 public int getPaddingBottom() { 16589 return mPaddingBottom; 16590 } 16591 16592 /** 16593 * Returns the left padding of this view. If there are inset and enabled 16594 * scrollbars, this value may include the space required to display the 16595 * scrollbars as well. 16596 * 16597 * @return the left padding in pixels 16598 */ 16599 public int getPaddingLeft() { 16600 if (!isPaddingResolved()) { 16601 resolvePadding(); 16602 } 16603 return mPaddingLeft; 16604 } 16605 16606 /** 16607 * Returns the start padding of this view depending on its resolved layout direction. 16608 * If there are inset and enabled scrollbars, this value may include the space 16609 * required to display the scrollbars as well. 16610 * 16611 * @return the start padding in pixels 16612 */ 16613 public int getPaddingStart() { 16614 if (!isPaddingResolved()) { 16615 resolvePadding(); 16616 } 16617 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16618 mPaddingRight : mPaddingLeft; 16619 } 16620 16621 /** 16622 * Returns the right padding of this view. If there are inset and enabled 16623 * scrollbars, this value may include the space required to display the 16624 * scrollbars as well. 16625 * 16626 * @return the right padding in pixels 16627 */ 16628 public int getPaddingRight() { 16629 if (!isPaddingResolved()) { 16630 resolvePadding(); 16631 } 16632 return mPaddingRight; 16633 } 16634 16635 /** 16636 * Returns the end padding of this view depending on its resolved layout direction. 16637 * If there are inset and enabled scrollbars, this value may include the space 16638 * required to display the scrollbars as well. 16639 * 16640 * @return the end padding in pixels 16641 */ 16642 public int getPaddingEnd() { 16643 if (!isPaddingResolved()) { 16644 resolvePadding(); 16645 } 16646 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 16647 mPaddingLeft : mPaddingRight; 16648 } 16649 16650 /** 16651 * Return if the padding as been set thru relative values 16652 * {@link #setPaddingRelative(int, int, int, int)} or thru 16653 * @attr ref android.R.styleable#View_paddingStart or 16654 * @attr ref android.R.styleable#View_paddingEnd 16655 * 16656 * @return true if the padding is relative or false if it is not. 16657 */ 16658 public boolean isPaddingRelative() { 16659 return (mUserPaddingStart != UNDEFINED_PADDING || mUserPaddingEnd != UNDEFINED_PADDING); 16660 } 16661 16662 Insets computeOpticalInsets() { 16663 return (mBackground == null) ? Insets.NONE : mBackground.getOpticalInsets(); 16664 } 16665 16666 /** 16667 * @hide 16668 */ 16669 public void resetPaddingToInitialValues() { 16670 if (isRtlCompatibilityMode()) { 16671 mPaddingLeft = mUserPaddingLeftInitial; 16672 mPaddingRight = mUserPaddingRightInitial; 16673 return; 16674 } 16675 if (isLayoutRtl()) { 16676 mPaddingLeft = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingLeftInitial; 16677 mPaddingRight = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingRightInitial; 16678 } else { 16679 mPaddingLeft = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingLeftInitial; 16680 mPaddingRight = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingRightInitial; 16681 } 16682 } 16683 16684 /** 16685 * @hide 16686 */ 16687 public Insets getOpticalInsets() { 16688 if (mLayoutInsets == null) { 16689 mLayoutInsets = computeOpticalInsets(); 16690 } 16691 return mLayoutInsets; 16692 } 16693 16694 /** 16695 * Set this view's optical insets. 16696 * 16697 * <p>This method should be treated similarly to setMeasuredDimension and not as a general 16698 * property. Views that compute their own optical insets should call it as part of measurement. 16699 * This method does not request layout. If you are setting optical insets outside of 16700 * measure/layout itself you will want to call requestLayout() yourself. 16701 * </p> 16702 * @hide 16703 */ 16704 public void setOpticalInsets(Insets insets) { 16705 mLayoutInsets = insets; 16706 } 16707 16708 /** 16709 * Changes the selection state of this view. A view can be selected or not. 16710 * Note that selection is not the same as focus. Views are typically 16711 * selected in the context of an AdapterView like ListView or GridView; 16712 * the selected view is the view that is highlighted. 16713 * 16714 * @param selected true if the view must be selected, false otherwise 16715 */ 16716 public void setSelected(boolean selected) { 16717 //noinspection DoubleNegation 16718 if (((mPrivateFlags & PFLAG_SELECTED) != 0) != selected) { 16719 mPrivateFlags = (mPrivateFlags & ~PFLAG_SELECTED) | (selected ? PFLAG_SELECTED : 0); 16720 if (!selected) resetPressedState(); 16721 invalidate(true); 16722 refreshDrawableState(); 16723 dispatchSetSelected(selected); 16724 if (selected) { 16725 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SELECTED); 16726 } else { 16727 notifyViewAccessibilityStateChangedIfNeeded( 16728 AccessibilityEvent.CONTENT_CHANGE_TYPE_UNDEFINED); 16729 } 16730 } 16731 } 16732 16733 /** 16734 * Dispatch setSelected to all of this View's children. 16735 * 16736 * @see #setSelected(boolean) 16737 * 16738 * @param selected The new selected state 16739 */ 16740 protected void dispatchSetSelected(boolean selected) { 16741 } 16742 16743 /** 16744 * Indicates the selection state of this view. 16745 * 16746 * @return true if the view is selected, false otherwise 16747 */ 16748 @ViewDebug.ExportedProperty 16749 public boolean isSelected() { 16750 return (mPrivateFlags & PFLAG_SELECTED) != 0; 16751 } 16752 16753 /** 16754 * Changes the activated state of this view. A view can be activated or not. 16755 * Note that activation is not the same as selection. Selection is 16756 * a transient property, representing the view (hierarchy) the user is 16757 * currently interacting with. Activation is a longer-term state that the 16758 * user can move views in and out of. For example, in a list view with 16759 * single or multiple selection enabled, the views in the current selection 16760 * set are activated. (Um, yeah, we are deeply sorry about the terminology 16761 * here.) The activated state is propagated down to children of the view it 16762 * is set on. 16763 * 16764 * @param activated true if the view must be activated, false otherwise 16765 */ 16766 public void setActivated(boolean activated) { 16767 //noinspection DoubleNegation 16768 if (((mPrivateFlags & PFLAG_ACTIVATED) != 0) != activated) { 16769 mPrivateFlags = (mPrivateFlags & ~PFLAG_ACTIVATED) | (activated ? PFLAG_ACTIVATED : 0); 16770 invalidate(true); 16771 refreshDrawableState(); 16772 dispatchSetActivated(activated); 16773 } 16774 } 16775 16776 /** 16777 * Dispatch setActivated to all of this View's children. 16778 * 16779 * @see #setActivated(boolean) 16780 * 16781 * @param activated The new activated state 16782 */ 16783 protected void dispatchSetActivated(boolean activated) { 16784 } 16785 16786 /** 16787 * Indicates the activation state of this view. 16788 * 16789 * @return true if the view is activated, false otherwise 16790 */ 16791 @ViewDebug.ExportedProperty 16792 public boolean isActivated() { 16793 return (mPrivateFlags & PFLAG_ACTIVATED) != 0; 16794 } 16795 16796 /** 16797 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 16798 * observer can be used to get notifications when global events, like 16799 * layout, happen. 16800 * 16801 * The returned ViewTreeObserver observer is not guaranteed to remain 16802 * valid for the lifetime of this View. If the caller of this method keeps 16803 * a long-lived reference to ViewTreeObserver, it should always check for 16804 * the return value of {@link ViewTreeObserver#isAlive()}. 16805 * 16806 * @return The ViewTreeObserver for this view's hierarchy. 16807 */ 16808 public ViewTreeObserver getViewTreeObserver() { 16809 if (mAttachInfo != null) { 16810 return mAttachInfo.mTreeObserver; 16811 } 16812 if (mFloatingTreeObserver == null) { 16813 mFloatingTreeObserver = new ViewTreeObserver(); 16814 } 16815 return mFloatingTreeObserver; 16816 } 16817 16818 /** 16819 * <p>Finds the topmost view in the current view hierarchy.</p> 16820 * 16821 * @return the topmost view containing this view 16822 */ 16823 public View getRootView() { 16824 if (mAttachInfo != null) { 16825 final View v = mAttachInfo.mRootView; 16826 if (v != null) { 16827 return v; 16828 } 16829 } 16830 16831 View parent = this; 16832 16833 while (parent.mParent != null && parent.mParent instanceof View) { 16834 parent = (View) parent.mParent; 16835 } 16836 16837 return parent; 16838 } 16839 16840 /** 16841 * Transforms a motion event from view-local coordinates to on-screen 16842 * coordinates. 16843 * 16844 * @param ev the view-local motion event 16845 * @return false if the transformation could not be applied 16846 * @hide 16847 */ 16848 public boolean toGlobalMotionEvent(MotionEvent ev) { 16849 final AttachInfo info = mAttachInfo; 16850 if (info == null) { 16851 return false; 16852 } 16853 16854 final Matrix m = info.mTmpMatrix; 16855 m.set(Matrix.IDENTITY_MATRIX); 16856 transformMatrixToGlobal(m); 16857 ev.transform(m); 16858 return true; 16859 } 16860 16861 /** 16862 * Transforms a motion event from on-screen coordinates to view-local 16863 * coordinates. 16864 * 16865 * @param ev the on-screen motion event 16866 * @return false if the transformation could not be applied 16867 * @hide 16868 */ 16869 public boolean toLocalMotionEvent(MotionEvent ev) { 16870 final AttachInfo info = mAttachInfo; 16871 if (info == null) { 16872 return false; 16873 } 16874 16875 final Matrix m = info.mTmpMatrix; 16876 m.set(Matrix.IDENTITY_MATRIX); 16877 transformMatrixToLocal(m); 16878 ev.transform(m); 16879 return true; 16880 } 16881 16882 /** 16883 * Modifies the input matrix such that it maps view-local coordinates to 16884 * on-screen coordinates. 16885 * 16886 * @param m input matrix to modify 16887 * @hide 16888 */ 16889 public void transformMatrixToGlobal(Matrix m) { 16890 final ViewParent parent = mParent; 16891 if (parent instanceof View) { 16892 final View vp = (View) parent; 16893 vp.transformMatrixToGlobal(m); 16894 m.preTranslate(-vp.mScrollX, -vp.mScrollY); 16895 } else if (parent instanceof ViewRootImpl) { 16896 final ViewRootImpl vr = (ViewRootImpl) parent; 16897 vr.transformMatrixToGlobal(m); 16898 m.preTranslate(0, -vr.mCurScrollY); 16899 } 16900 16901 m.preTranslate(mLeft, mTop); 16902 16903 if (!hasIdentityMatrix()) { 16904 m.preConcat(getMatrix()); 16905 } 16906 } 16907 16908 /** 16909 * Modifies the input matrix such that it maps on-screen coordinates to 16910 * view-local coordinates. 16911 * 16912 * @param m input matrix to modify 16913 * @hide 16914 */ 16915 public void transformMatrixToLocal(Matrix m) { 16916 final ViewParent parent = mParent; 16917 if (parent instanceof View) { 16918 final View vp = (View) parent; 16919 vp.transformMatrixToLocal(m); 16920 m.postTranslate(vp.mScrollX, vp.mScrollY); 16921 } else if (parent instanceof ViewRootImpl) { 16922 final ViewRootImpl vr = (ViewRootImpl) parent; 16923 vr.transformMatrixToLocal(m); 16924 m.postTranslate(0, vr.mCurScrollY); 16925 } 16926 16927 m.postTranslate(-mLeft, -mTop); 16928 16929 if (!hasIdentityMatrix()) { 16930 m.postConcat(getInverseMatrix()); 16931 } 16932 } 16933 16934 /** 16935 * @hide 16936 */ 16937 @ViewDebug.ExportedProperty(category = "layout", indexMapping = { 16938 @ViewDebug.IntToString(from = 0, to = "x"), 16939 @ViewDebug.IntToString(from = 1, to = "y") 16940 }) 16941 public int[] getLocationOnScreen() { 16942 int[] location = new int[2]; 16943 getLocationOnScreen(location); 16944 return location; 16945 } 16946 16947 /** 16948 * <p>Computes the coordinates of this view on the screen. The argument 16949 * must be an array of two integers. After the method returns, the array 16950 * contains the x and y location in that order.</p> 16951 * 16952 * @param location an array of two integers in which to hold the coordinates 16953 */ 16954 public void getLocationOnScreen(int[] location) { 16955 getLocationInWindow(location); 16956 16957 final AttachInfo info = mAttachInfo; 16958 if (info != null) { 16959 location[0] += info.mWindowLeft; 16960 location[1] += info.mWindowTop; 16961 } 16962 } 16963 16964 /** 16965 * <p>Computes the coordinates of this view in its window. The argument 16966 * must be an array of two integers. After the method returns, the array 16967 * contains the x and y location in that order.</p> 16968 * 16969 * @param location an array of two integers in which to hold the coordinates 16970 */ 16971 public void getLocationInWindow(int[] location) { 16972 if (location == null || location.length < 2) { 16973 throw new IllegalArgumentException("location must be an array of two integers"); 16974 } 16975 16976 if (mAttachInfo == null) { 16977 // When the view is not attached to a window, this method does not make sense 16978 location[0] = location[1] = 0; 16979 return; 16980 } 16981 16982 float[] position = mAttachInfo.mTmpTransformLocation; 16983 position[0] = position[1] = 0.0f; 16984 16985 if (!hasIdentityMatrix()) { 16986 getMatrix().mapPoints(position); 16987 } 16988 16989 position[0] += mLeft; 16990 position[1] += mTop; 16991 16992 ViewParent viewParent = mParent; 16993 while (viewParent instanceof View) { 16994 final View view = (View) viewParent; 16995 16996 position[0] -= view.mScrollX; 16997 position[1] -= view.mScrollY; 16998 16999 if (!view.hasIdentityMatrix()) { 17000 view.getMatrix().mapPoints(position); 17001 } 17002 17003 position[0] += view.mLeft; 17004 position[1] += view.mTop; 17005 17006 viewParent = view.mParent; 17007 } 17008 17009 if (viewParent instanceof ViewRootImpl) { 17010 // *cough* 17011 final ViewRootImpl vr = (ViewRootImpl) viewParent; 17012 position[1] -= vr.mCurScrollY; 17013 } 17014 17015 location[0] = (int) (position[0] + 0.5f); 17016 location[1] = (int) (position[1] + 0.5f); 17017 } 17018 17019 /** 17020 * {@hide} 17021 * @param id the id of the view to be found 17022 * @return the view of the specified id, null if cannot be found 17023 */ 17024 protected View findViewTraversal(int id) { 17025 if (id == mID) { 17026 return this; 17027 } 17028 return null; 17029 } 17030 17031 /** 17032 * {@hide} 17033 * @param tag the tag of the view to be found 17034 * @return the view of specified tag, null if cannot be found 17035 */ 17036 protected View findViewWithTagTraversal(Object tag) { 17037 if (tag != null && tag.equals(mTag)) { 17038 return this; 17039 } 17040 return null; 17041 } 17042 17043 /** 17044 * {@hide} 17045 * @param predicate The predicate to evaluate. 17046 * @param childToSkip If not null, ignores this child during the recursive traversal. 17047 * @return The first view that matches the predicate or null. 17048 */ 17049 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 17050 if (predicate.apply(this)) { 17051 return this; 17052 } 17053 return null; 17054 } 17055 17056 /** 17057 * Look for a child view with the given id. If this view has the given 17058 * id, return this view. 17059 * 17060 * @param id The id to search for. 17061 * @return The view that has the given id in the hierarchy or null 17062 */ 17063 public final View findViewById(int id) { 17064 if (id < 0) { 17065 return null; 17066 } 17067 return findViewTraversal(id); 17068 } 17069 17070 /** 17071 * Finds a view by its unuque and stable accessibility id. 17072 * 17073 * @param accessibilityId The searched accessibility id. 17074 * @return The found view. 17075 */ 17076 final View findViewByAccessibilityId(int accessibilityId) { 17077 if (accessibilityId < 0) { 17078 return null; 17079 } 17080 return findViewByAccessibilityIdTraversal(accessibilityId); 17081 } 17082 17083 /** 17084 * Performs the traversal to find a view by its unuque and stable accessibility id. 17085 * 17086 * <strong>Note:</strong>This method does not stop at the root namespace 17087 * boundary since the user can touch the screen at an arbitrary location 17088 * potentially crossing the root namespace bounday which will send an 17089 * accessibility event to accessibility services and they should be able 17090 * to obtain the event source. Also accessibility ids are guaranteed to be 17091 * unique in the window. 17092 * 17093 * @param accessibilityId The accessibility id. 17094 * @return The found view. 17095 * 17096 * @hide 17097 */ 17098 public View findViewByAccessibilityIdTraversal(int accessibilityId) { 17099 if (getAccessibilityViewId() == accessibilityId) { 17100 return this; 17101 } 17102 return null; 17103 } 17104 17105 /** 17106 * Look for a child view with the given tag. If this view has the given 17107 * tag, return this view. 17108 * 17109 * @param tag The tag to search for, using "tag.equals(getTag())". 17110 * @return The View that has the given tag in the hierarchy or null 17111 */ 17112 public final View findViewWithTag(Object tag) { 17113 if (tag == null) { 17114 return null; 17115 } 17116 return findViewWithTagTraversal(tag); 17117 } 17118 17119 /** 17120 * {@hide} 17121 * Look for a child view that matches the specified predicate. 17122 * If this view matches the predicate, return this view. 17123 * 17124 * @param predicate The predicate to evaluate. 17125 * @return The first view that matches the predicate or null. 17126 */ 17127 public final View findViewByPredicate(Predicate<View> predicate) { 17128 return findViewByPredicateTraversal(predicate, null); 17129 } 17130 17131 /** 17132 * {@hide} 17133 * Look for a child view that matches the specified predicate, 17134 * starting with the specified view and its descendents and then 17135 * recusively searching the ancestors and siblings of that view 17136 * until this view is reached. 17137 * 17138 * This method is useful in cases where the predicate does not match 17139 * a single unique view (perhaps multiple views use the same id) 17140 * and we are trying to find the view that is "closest" in scope to the 17141 * starting view. 17142 * 17143 * @param start The view to start from. 17144 * @param predicate The predicate to evaluate. 17145 * @return The first view that matches the predicate or null. 17146 */ 17147 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 17148 View childToSkip = null; 17149 for (;;) { 17150 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 17151 if (view != null || start == this) { 17152 return view; 17153 } 17154 17155 ViewParent parent = start.getParent(); 17156 if (parent == null || !(parent instanceof View)) { 17157 return null; 17158 } 17159 17160 childToSkip = start; 17161 start = (View) parent; 17162 } 17163 } 17164 17165 /** 17166 * Sets the identifier for this view. The identifier does not have to be 17167 * unique in this view's hierarchy. The identifier should be a positive 17168 * number. 17169 * 17170 * @see #NO_ID 17171 * @see #getId() 17172 * @see #findViewById(int) 17173 * 17174 * @param id a number used to identify the view 17175 * 17176 * @attr ref android.R.styleable#View_id 17177 */ 17178 public void setId(int id) { 17179 mID = id; 17180 if (mID == View.NO_ID && mLabelForId != View.NO_ID) { 17181 mID = generateViewId(); 17182 } 17183 } 17184 17185 /** 17186 * {@hide} 17187 * 17188 * @param isRoot true if the view belongs to the root namespace, false 17189 * otherwise 17190 */ 17191 public void setIsRootNamespace(boolean isRoot) { 17192 if (isRoot) { 17193 mPrivateFlags |= PFLAG_IS_ROOT_NAMESPACE; 17194 } else { 17195 mPrivateFlags &= ~PFLAG_IS_ROOT_NAMESPACE; 17196 } 17197 } 17198 17199 /** 17200 * {@hide} 17201 * 17202 * @return true if the view belongs to the root namespace, false otherwise 17203 */ 17204 public boolean isRootNamespace() { 17205 return (mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0; 17206 } 17207 17208 /** 17209 * Returns this view's identifier. 17210 * 17211 * @return a positive integer used to identify the view or {@link #NO_ID} 17212 * if the view has no ID 17213 * 17214 * @see #setId(int) 17215 * @see #findViewById(int) 17216 * @attr ref android.R.styleable#View_id 17217 */ 17218 @ViewDebug.CapturedViewProperty 17219 public int getId() { 17220 return mID; 17221 } 17222 17223 /** 17224 * Returns this view's tag. 17225 * 17226 * @return the Object stored in this view as a tag, or {@code null} if not 17227 * set 17228 * 17229 * @see #setTag(Object) 17230 * @see #getTag(int) 17231 */ 17232 @ViewDebug.ExportedProperty 17233 public Object getTag() { 17234 return mTag; 17235 } 17236 17237 /** 17238 * Sets the tag associated with this view. A tag can be used to mark 17239 * a view in its hierarchy and does not have to be unique within the 17240 * hierarchy. Tags can also be used to store data within a view without 17241 * resorting to another data structure. 17242 * 17243 * @param tag an Object to tag the view with 17244 * 17245 * @see #getTag() 17246 * @see #setTag(int, Object) 17247 */ 17248 public void setTag(final Object tag) { 17249 mTag = tag; 17250 } 17251 17252 /** 17253 * Returns the tag associated with this view and the specified key. 17254 * 17255 * @param key The key identifying the tag 17256 * 17257 * @return the Object stored in this view as a tag, or {@code null} if not 17258 * set 17259 * 17260 * @see #setTag(int, Object) 17261 * @see #getTag() 17262 */ 17263 public Object getTag(int key) { 17264 if (mKeyedTags != null) return mKeyedTags.get(key); 17265 return null; 17266 } 17267 17268 /** 17269 * Sets a tag associated with this view and a key. A tag can be used 17270 * to mark a view in its hierarchy and does not have to be unique within 17271 * the hierarchy. Tags can also be used to store data within a view 17272 * without resorting to another data structure. 17273 * 17274 * The specified key should be an id declared in the resources of the 17275 * application to ensure it is unique (see the <a 17276 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 17277 * Keys identified as belonging to 17278 * the Android framework or not associated with any package will cause 17279 * an {@link IllegalArgumentException} to be thrown. 17280 * 17281 * @param key The key identifying the tag 17282 * @param tag An Object to tag the view with 17283 * 17284 * @throws IllegalArgumentException If they specified key is not valid 17285 * 17286 * @see #setTag(Object) 17287 * @see #getTag(int) 17288 */ 17289 public void setTag(int key, final Object tag) { 17290 // If the package id is 0x00 or 0x01, it's either an undefined package 17291 // or a framework id 17292 if ((key >>> 24) < 2) { 17293 throw new IllegalArgumentException("The key must be an application-specific " 17294 + "resource id."); 17295 } 17296 17297 setKeyedTag(key, tag); 17298 } 17299 17300 /** 17301 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 17302 * framework id. 17303 * 17304 * @hide 17305 */ 17306 public void setTagInternal(int key, Object tag) { 17307 if ((key >>> 24) != 0x1) { 17308 throw new IllegalArgumentException("The key must be a framework-specific " 17309 + "resource id."); 17310 } 17311 17312 setKeyedTag(key, tag); 17313 } 17314 17315 private void setKeyedTag(int key, Object tag) { 17316 if (mKeyedTags == null) { 17317 mKeyedTags = new SparseArray<Object>(2); 17318 } 17319 17320 mKeyedTags.put(key, tag); 17321 } 17322 17323 /** 17324 * Prints information about this view in the log output, with the tag 17325 * {@link #VIEW_LOG_TAG}. 17326 * 17327 * @hide 17328 */ 17329 public void debug() { 17330 debug(0); 17331 } 17332 17333 /** 17334 * Prints information about this view in the log output, with the tag 17335 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 17336 * indentation defined by the <code>depth</code>. 17337 * 17338 * @param depth the indentation level 17339 * 17340 * @hide 17341 */ 17342 protected void debug(int depth) { 17343 String output = debugIndent(depth - 1); 17344 17345 output += "+ " + this; 17346 int id = getId(); 17347 if (id != -1) { 17348 output += " (id=" + id + ")"; 17349 } 17350 Object tag = getTag(); 17351 if (tag != null) { 17352 output += " (tag=" + tag + ")"; 17353 } 17354 Log.d(VIEW_LOG_TAG, output); 17355 17356 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 17357 output = debugIndent(depth) + " FOCUSED"; 17358 Log.d(VIEW_LOG_TAG, output); 17359 } 17360 17361 output = debugIndent(depth); 17362 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 17363 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 17364 + "} "; 17365 Log.d(VIEW_LOG_TAG, output); 17366 17367 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 17368 || mPaddingBottom != 0) { 17369 output = debugIndent(depth); 17370 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 17371 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 17372 Log.d(VIEW_LOG_TAG, output); 17373 } 17374 17375 output = debugIndent(depth); 17376 output += "mMeasureWidth=" + mMeasuredWidth + 17377 " mMeasureHeight=" + mMeasuredHeight; 17378 Log.d(VIEW_LOG_TAG, output); 17379 17380 output = debugIndent(depth); 17381 if (mLayoutParams == null) { 17382 output += "BAD! no layout params"; 17383 } else { 17384 output = mLayoutParams.debug(output); 17385 } 17386 Log.d(VIEW_LOG_TAG, output); 17387 17388 output = debugIndent(depth); 17389 output += "flags={"; 17390 output += View.printFlags(mViewFlags); 17391 output += "}"; 17392 Log.d(VIEW_LOG_TAG, output); 17393 17394 output = debugIndent(depth); 17395 output += "privateFlags={"; 17396 output += View.printPrivateFlags(mPrivateFlags); 17397 output += "}"; 17398 Log.d(VIEW_LOG_TAG, output); 17399 } 17400 17401 /** 17402 * Creates a string of whitespaces used for indentation. 17403 * 17404 * @param depth the indentation level 17405 * @return a String containing (depth * 2 + 3) * 2 white spaces 17406 * 17407 * @hide 17408 */ 17409 protected static String debugIndent(int depth) { 17410 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 17411 for (int i = 0; i < (depth * 2) + 3; i++) { 17412 spaces.append(' ').append(' '); 17413 } 17414 return spaces.toString(); 17415 } 17416 17417 /** 17418 * <p>Return the offset of the widget's text baseline from the widget's top 17419 * boundary. If this widget does not support baseline alignment, this 17420 * method returns -1. </p> 17421 * 17422 * @return the offset of the baseline within the widget's bounds or -1 17423 * if baseline alignment is not supported 17424 */ 17425 @ViewDebug.ExportedProperty(category = "layout") 17426 public int getBaseline() { 17427 return -1; 17428 } 17429 17430 /** 17431 * Returns whether the view hierarchy is currently undergoing a layout pass. This 17432 * information is useful to avoid situations such as calling {@link #requestLayout()} during 17433 * a layout pass. 17434 * 17435 * @return whether the view hierarchy is currently undergoing a layout pass 17436 */ 17437 public boolean isInLayout() { 17438 ViewRootImpl viewRoot = getViewRootImpl(); 17439 return (viewRoot != null && viewRoot.isInLayout()); 17440 } 17441 17442 /** 17443 * Call this when something has changed which has invalidated the 17444 * layout of this view. This will schedule a layout pass of the view 17445 * tree. This should not be called while the view hierarchy is currently in a layout 17446 * pass ({@link #isInLayout()}. If layout is happening, the request may be honored at the 17447 * end of the current layout pass (and then layout will run again) or after the current 17448 * frame is drawn and the next layout occurs. 17449 * 17450 * <p>Subclasses which override this method should call the superclass method to 17451 * handle possible request-during-layout errors correctly.</p> 17452 */ 17453 public void requestLayout() { 17454 if (mMeasureCache != null) mMeasureCache.clear(); 17455 17456 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == null) { 17457 // Only trigger request-during-layout logic if this is the view requesting it, 17458 // not the views in its parent hierarchy 17459 ViewRootImpl viewRoot = getViewRootImpl(); 17460 if (viewRoot != null && viewRoot.isInLayout()) { 17461 if (!viewRoot.requestLayoutDuringLayout(this)) { 17462 return; 17463 } 17464 } 17465 mAttachInfo.mViewRequestingLayout = this; 17466 } 17467 17468 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17469 mPrivateFlags |= PFLAG_INVALIDATED; 17470 17471 if (mParent != null && !mParent.isLayoutRequested()) { 17472 mParent.requestLayout(); 17473 } 17474 if (mAttachInfo != null && mAttachInfo.mViewRequestingLayout == this) { 17475 mAttachInfo.mViewRequestingLayout = null; 17476 } 17477 } 17478 17479 /** 17480 * Forces this view to be laid out during the next layout pass. 17481 * This method does not call requestLayout() or forceLayout() 17482 * on the parent. 17483 */ 17484 public void forceLayout() { 17485 if (mMeasureCache != null) mMeasureCache.clear(); 17486 17487 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 17488 mPrivateFlags |= PFLAG_INVALIDATED; 17489 } 17490 17491 /** 17492 * <p> 17493 * This is called to find out how big a view should be. The parent 17494 * supplies constraint information in the width and height parameters. 17495 * </p> 17496 * 17497 * <p> 17498 * The actual measurement work of a view is performed in 17499 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 17500 * {@link #onMeasure(int, int)} can and must be overridden by subclasses. 17501 * </p> 17502 * 17503 * 17504 * @param widthMeasureSpec Horizontal space requirements as imposed by the 17505 * parent 17506 * @param heightMeasureSpec Vertical space requirements as imposed by the 17507 * parent 17508 * 17509 * @see #onMeasure(int, int) 17510 */ 17511 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 17512 boolean optical = isLayoutModeOptical(this); 17513 if (optical != isLayoutModeOptical(mParent)) { 17514 Insets insets = getOpticalInsets(); 17515 int oWidth = insets.left + insets.right; 17516 int oHeight = insets.top + insets.bottom; 17517 widthMeasureSpec = MeasureSpec.adjust(widthMeasureSpec, optical ? -oWidth : oWidth); 17518 heightMeasureSpec = MeasureSpec.adjust(heightMeasureSpec, optical ? -oHeight : oHeight); 17519 } 17520 17521 // Suppress sign extension for the low bytes 17522 long key = (long) widthMeasureSpec << 32 | (long) heightMeasureSpec & 0xffffffffL; 17523 if (mMeasureCache == null) mMeasureCache = new LongSparseLongArray(2); 17524 17525 final boolean forceLayout = (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 17526 final boolean isExactly = MeasureSpec.getMode(widthMeasureSpec) == MeasureSpec.EXACTLY && 17527 MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.EXACTLY; 17528 final boolean matchingSize = isExactly && 17529 getMeasuredWidth() == MeasureSpec.getSize(widthMeasureSpec) && 17530 getMeasuredHeight() == MeasureSpec.getSize(heightMeasureSpec); 17531 if (forceLayout || !matchingSize && 17532 (widthMeasureSpec != mOldWidthMeasureSpec || 17533 heightMeasureSpec != mOldHeightMeasureSpec)) { 17534 17535 // first clears the measured dimension flag 17536 mPrivateFlags &= ~PFLAG_MEASURED_DIMENSION_SET; 17537 17538 resolveRtlPropertiesIfNeeded(); 17539 17540 int cacheIndex = forceLayout ? -1 : mMeasureCache.indexOfKey(key); 17541 if (cacheIndex < 0 || sIgnoreMeasureCache) { 17542 // measure ourselves, this should set the measured dimension flag back 17543 onMeasure(widthMeasureSpec, heightMeasureSpec); 17544 mPrivateFlags3 &= ~PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17545 } else { 17546 long value = mMeasureCache.valueAt(cacheIndex); 17547 // Casting a long to int drops the high 32 bits, no mask needed 17548 setMeasuredDimensionRaw((int) (value >> 32), (int) value); 17549 mPrivateFlags3 |= PFLAG3_MEASURE_NEEDED_BEFORE_LAYOUT; 17550 } 17551 17552 // flag not set, setMeasuredDimension() was not invoked, we raise 17553 // an exception to warn the developer 17554 if ((mPrivateFlags & PFLAG_MEASURED_DIMENSION_SET) != PFLAG_MEASURED_DIMENSION_SET) { 17555 throw new IllegalStateException("onMeasure() did not set the" 17556 + " measured dimension by calling" 17557 + " setMeasuredDimension()"); 17558 } 17559 17560 mPrivateFlags |= PFLAG_LAYOUT_REQUIRED; 17561 } 17562 17563 mOldWidthMeasureSpec = widthMeasureSpec; 17564 mOldHeightMeasureSpec = heightMeasureSpec; 17565 17566 mMeasureCache.put(key, ((long) mMeasuredWidth) << 32 | 17567 (long) mMeasuredHeight & 0xffffffffL); // suppress sign extension 17568 } 17569 17570 /** 17571 * <p> 17572 * Measure the view and its content to determine the measured width and the 17573 * measured height. This method is invoked by {@link #measure(int, int)} and 17574 * should be overriden by subclasses to provide accurate and efficient 17575 * measurement of their contents. 17576 * </p> 17577 * 17578 * <p> 17579 * <strong>CONTRACT:</strong> When overriding this method, you 17580 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 17581 * measured width and height of this view. Failure to do so will trigger an 17582 * <code>IllegalStateException</code>, thrown by 17583 * {@link #measure(int, int)}. Calling the superclass' 17584 * {@link #onMeasure(int, int)} is a valid use. 17585 * </p> 17586 * 17587 * <p> 17588 * The base class implementation of measure defaults to the background size, 17589 * unless a larger size is allowed by the MeasureSpec. Subclasses should 17590 * override {@link #onMeasure(int, int)} to provide better measurements of 17591 * their content. 17592 * </p> 17593 * 17594 * <p> 17595 * If this method is overridden, it is the subclass's responsibility to make 17596 * sure the measured height and width are at least the view's minimum height 17597 * and width ({@link #getSuggestedMinimumHeight()} and 17598 * {@link #getSuggestedMinimumWidth()}). 17599 * </p> 17600 * 17601 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 17602 * The requirements are encoded with 17603 * {@link android.view.View.MeasureSpec}. 17604 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 17605 * The requirements are encoded with 17606 * {@link android.view.View.MeasureSpec}. 17607 * 17608 * @see #getMeasuredWidth() 17609 * @see #getMeasuredHeight() 17610 * @see #setMeasuredDimension(int, int) 17611 * @see #getSuggestedMinimumHeight() 17612 * @see #getSuggestedMinimumWidth() 17613 * @see android.view.View.MeasureSpec#getMode(int) 17614 * @see android.view.View.MeasureSpec#getSize(int) 17615 */ 17616 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 17617 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 17618 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 17619 } 17620 17621 /** 17622 * <p>This method must be called by {@link #onMeasure(int, int)} to store the 17623 * measured width and measured height. Failing to do so will trigger an 17624 * exception at measurement time.</p> 17625 * 17626 * @param measuredWidth The measured width of this view. May be a complex 17627 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17628 * {@link #MEASURED_STATE_TOO_SMALL}. 17629 * @param measuredHeight The measured height of this view. May be a complex 17630 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17631 * {@link #MEASURED_STATE_TOO_SMALL}. 17632 */ 17633 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 17634 boolean optical = isLayoutModeOptical(this); 17635 if (optical != isLayoutModeOptical(mParent)) { 17636 Insets insets = getOpticalInsets(); 17637 int opticalWidth = insets.left + insets.right; 17638 int opticalHeight = insets.top + insets.bottom; 17639 17640 measuredWidth += optical ? opticalWidth : -opticalWidth; 17641 measuredHeight += optical ? opticalHeight : -opticalHeight; 17642 } 17643 setMeasuredDimensionRaw(measuredWidth, measuredHeight); 17644 } 17645 17646 /** 17647 * Sets the measured dimension without extra processing for things like optical bounds. 17648 * Useful for reapplying consistent values that have already been cooked with adjustments 17649 * for optical bounds, etc. such as those from the measurement cache. 17650 * 17651 * @param measuredWidth The measured width of this view. May be a complex 17652 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17653 * {@link #MEASURED_STATE_TOO_SMALL}. 17654 * @param measuredHeight The measured height of this view. May be a complex 17655 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 17656 * {@link #MEASURED_STATE_TOO_SMALL}. 17657 */ 17658 private void setMeasuredDimensionRaw(int measuredWidth, int measuredHeight) { 17659 mMeasuredWidth = measuredWidth; 17660 mMeasuredHeight = measuredHeight; 17661 17662 mPrivateFlags |= PFLAG_MEASURED_DIMENSION_SET; 17663 } 17664 17665 /** 17666 * Merge two states as returned by {@link #getMeasuredState()}. 17667 * @param curState The current state as returned from a view or the result 17668 * of combining multiple views. 17669 * @param newState The new view state to combine. 17670 * @return Returns a new integer reflecting the combination of the two 17671 * states. 17672 */ 17673 public static int combineMeasuredStates(int curState, int newState) { 17674 return curState | newState; 17675 } 17676 17677 /** 17678 * Version of {@link #resolveSizeAndState(int, int, int)} 17679 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 17680 */ 17681 public static int resolveSize(int size, int measureSpec) { 17682 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 17683 } 17684 17685 /** 17686 * Utility to reconcile a desired size and state, with constraints imposed 17687 * by a MeasureSpec. Will take the desired size, unless a different size 17688 * is imposed by the constraints. The returned value is a compound integer, 17689 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 17690 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 17691 * size is smaller than the size the view wants to be. 17692 * 17693 * @param size How big the view wants to be 17694 * @param measureSpec Constraints imposed by the parent 17695 * @return Size information bit mask as defined by 17696 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 17697 */ 17698 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 17699 int result = size; 17700 int specMode = MeasureSpec.getMode(measureSpec); 17701 int specSize = MeasureSpec.getSize(measureSpec); 17702 switch (specMode) { 17703 case MeasureSpec.UNSPECIFIED: 17704 result = size; 17705 break; 17706 case MeasureSpec.AT_MOST: 17707 if (specSize < size) { 17708 result = specSize | MEASURED_STATE_TOO_SMALL; 17709 } else { 17710 result = size; 17711 } 17712 break; 17713 case MeasureSpec.EXACTLY: 17714 result = specSize; 17715 break; 17716 } 17717 return result | (childMeasuredState&MEASURED_STATE_MASK); 17718 } 17719 17720 /** 17721 * Utility to return a default size. Uses the supplied size if the 17722 * MeasureSpec imposed no constraints. Will get larger if allowed 17723 * by the MeasureSpec. 17724 * 17725 * @param size Default size for this view 17726 * @param measureSpec Constraints imposed by the parent 17727 * @return The size this view should be. 17728 */ 17729 public static int getDefaultSize(int size, int measureSpec) { 17730 int result = size; 17731 int specMode = MeasureSpec.getMode(measureSpec); 17732 int specSize = MeasureSpec.getSize(measureSpec); 17733 17734 switch (specMode) { 17735 case MeasureSpec.UNSPECIFIED: 17736 result = size; 17737 break; 17738 case MeasureSpec.AT_MOST: 17739 case MeasureSpec.EXACTLY: 17740 result = specSize; 17741 break; 17742 } 17743 return result; 17744 } 17745 17746 /** 17747 * Returns the suggested minimum height that the view should use. This 17748 * returns the maximum of the view's minimum height 17749 * and the background's minimum height 17750 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 17751 * <p> 17752 * When being used in {@link #onMeasure(int, int)}, the caller should still 17753 * ensure the returned height is within the requirements of the parent. 17754 * 17755 * @return The suggested minimum height of the view. 17756 */ 17757 protected int getSuggestedMinimumHeight() { 17758 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight()); 17759 17760 } 17761 17762 /** 17763 * Returns the suggested minimum width that the view should use. This 17764 * returns the maximum of the view's minimum width) 17765 * and the background's minimum width 17766 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 17767 * <p> 17768 * When being used in {@link #onMeasure(int, int)}, the caller should still 17769 * ensure the returned width is within the requirements of the parent. 17770 * 17771 * @return The suggested minimum width of the view. 17772 */ 17773 protected int getSuggestedMinimumWidth() { 17774 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth()); 17775 } 17776 17777 /** 17778 * Returns the minimum height of the view. 17779 * 17780 * @return the minimum height the view will try to be. 17781 * 17782 * @see #setMinimumHeight(int) 17783 * 17784 * @attr ref android.R.styleable#View_minHeight 17785 */ 17786 public int getMinimumHeight() { 17787 return mMinHeight; 17788 } 17789 17790 /** 17791 * Sets the minimum height of the view. It is not guaranteed the view will 17792 * be able to achieve this minimum height (for example, if its parent layout 17793 * constrains it with less available height). 17794 * 17795 * @param minHeight The minimum height the view will try to be. 17796 * 17797 * @see #getMinimumHeight() 17798 * 17799 * @attr ref android.R.styleable#View_minHeight 17800 */ 17801 public void setMinimumHeight(int minHeight) { 17802 mMinHeight = minHeight; 17803 requestLayout(); 17804 } 17805 17806 /** 17807 * Returns the minimum width of the view. 17808 * 17809 * @return the minimum width the view will try to be. 17810 * 17811 * @see #setMinimumWidth(int) 17812 * 17813 * @attr ref android.R.styleable#View_minWidth 17814 */ 17815 public int getMinimumWidth() { 17816 return mMinWidth; 17817 } 17818 17819 /** 17820 * Sets the minimum width of the view. It is not guaranteed the view will 17821 * be able to achieve this minimum width (for example, if its parent layout 17822 * constrains it with less available width). 17823 * 17824 * @param minWidth The minimum width the view will try to be. 17825 * 17826 * @see #getMinimumWidth() 17827 * 17828 * @attr ref android.R.styleable#View_minWidth 17829 */ 17830 public void setMinimumWidth(int minWidth) { 17831 mMinWidth = minWidth; 17832 requestLayout(); 17833 17834 } 17835 17836 /** 17837 * Get the animation currently associated with this view. 17838 * 17839 * @return The animation that is currently playing or 17840 * scheduled to play for this view. 17841 */ 17842 public Animation getAnimation() { 17843 return mCurrentAnimation; 17844 } 17845 17846 /** 17847 * Start the specified animation now. 17848 * 17849 * @param animation the animation to start now 17850 */ 17851 public void startAnimation(Animation animation) { 17852 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 17853 setAnimation(animation); 17854 invalidateParentCaches(); 17855 invalidate(true); 17856 } 17857 17858 /** 17859 * Cancels any animations for this view. 17860 */ 17861 public void clearAnimation() { 17862 if (mCurrentAnimation != null) { 17863 mCurrentAnimation.detach(); 17864 } 17865 mCurrentAnimation = null; 17866 invalidateParentIfNeeded(); 17867 } 17868 17869 /** 17870 * Sets the next animation to play for this view. 17871 * If you want the animation to play immediately, use 17872 * {@link #startAnimation(android.view.animation.Animation)} instead. 17873 * This method provides allows fine-grained 17874 * control over the start time and invalidation, but you 17875 * must make sure that 1) the animation has a start time set, and 17876 * 2) the view's parent (which controls animations on its children) 17877 * will be invalidated when the animation is supposed to 17878 * start. 17879 * 17880 * @param animation The next animation, or null. 17881 */ 17882 public void setAnimation(Animation animation) { 17883 mCurrentAnimation = animation; 17884 17885 if (animation != null) { 17886 // If the screen is off assume the animation start time is now instead of 17887 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time 17888 // would cause the animation to start when the screen turns back on 17889 if (mAttachInfo != null && mAttachInfo.mDisplayState == Display.STATE_OFF 17890 && animation.getStartTime() == Animation.START_ON_FIRST_FRAME) { 17891 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis()); 17892 } 17893 animation.reset(); 17894 } 17895 } 17896 17897 /** 17898 * Invoked by a parent ViewGroup to notify the start of the animation 17899 * currently associated with this view. If you override this method, 17900 * always call super.onAnimationStart(); 17901 * 17902 * @see #setAnimation(android.view.animation.Animation) 17903 * @see #getAnimation() 17904 */ 17905 protected void onAnimationStart() { 17906 mPrivateFlags |= PFLAG_ANIMATION_STARTED; 17907 } 17908 17909 /** 17910 * Invoked by a parent ViewGroup to notify the end of the animation 17911 * currently associated with this view. If you override this method, 17912 * always call super.onAnimationEnd(); 17913 * 17914 * @see #setAnimation(android.view.animation.Animation) 17915 * @see #getAnimation() 17916 */ 17917 protected void onAnimationEnd() { 17918 mPrivateFlags &= ~PFLAG_ANIMATION_STARTED; 17919 } 17920 17921 /** 17922 * Invoked if there is a Transform that involves alpha. Subclass that can 17923 * draw themselves with the specified alpha should return true, and then 17924 * respect that alpha when their onDraw() is called. If this returns false 17925 * then the view may be redirected to draw into an offscreen buffer to 17926 * fulfill the request, which will look fine, but may be slower than if the 17927 * subclass handles it internally. The default implementation returns false. 17928 * 17929 * @param alpha The alpha (0..255) to apply to the view's drawing 17930 * @return true if the view can draw with the specified alpha. 17931 */ 17932 protected boolean onSetAlpha(int alpha) { 17933 return false; 17934 } 17935 17936 /** 17937 * This is used by the RootView to perform an optimization when 17938 * the view hierarchy contains one or several SurfaceView. 17939 * SurfaceView is always considered transparent, but its children are not, 17940 * therefore all View objects remove themselves from the global transparent 17941 * region (passed as a parameter to this function). 17942 * 17943 * @param region The transparent region for this ViewAncestor (window). 17944 * 17945 * @return Returns true if the effective visibility of the view at this 17946 * point is opaque, regardless of the transparent region; returns false 17947 * if it is possible for underlying windows to be seen behind the view. 17948 * 17949 * {@hide} 17950 */ 17951 public boolean gatherTransparentRegion(Region region) { 17952 final AttachInfo attachInfo = mAttachInfo; 17953 if (region != null && attachInfo != null) { 17954 final int pflags = mPrivateFlags; 17955 if ((pflags & PFLAG_SKIP_DRAW) == 0) { 17956 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 17957 // remove it from the transparent region. 17958 final int[] location = attachInfo.mTransparentLocation; 17959 getLocationInWindow(location); 17960 region.op(location[0], location[1], location[0] + mRight - mLeft, 17961 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 17962 } else if ((pflags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null && 17963 mBackground.getOpacity() != PixelFormat.TRANSPARENT) { 17964 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 17965 // exists, so we remove the background drawable's non-transparent 17966 // parts from this transparent region. 17967 applyDrawableToTransparentRegion(mBackground, region); 17968 } 17969 } 17970 return true; 17971 } 17972 17973 /** 17974 * Play a sound effect for this view. 17975 * 17976 * <p>The framework will play sound effects for some built in actions, such as 17977 * clicking, but you may wish to play these effects in your widget, 17978 * for instance, for internal navigation. 17979 * 17980 * <p>The sound effect will only be played if sound effects are enabled by the user, and 17981 * {@link #isSoundEffectsEnabled()} is true. 17982 * 17983 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 17984 */ 17985 public void playSoundEffect(int soundConstant) { 17986 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 17987 return; 17988 } 17989 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 17990 } 17991 17992 /** 17993 * BZZZTT!!1! 17994 * 17995 * <p>Provide haptic feedback to the user for this view. 17996 * 17997 * <p>The framework will provide haptic feedback for some built in actions, 17998 * such as long presses, but you may wish to provide feedback for your 17999 * own widget. 18000 * 18001 * <p>The feedback will only be performed if 18002 * {@link #isHapticFeedbackEnabled()} is true. 18003 * 18004 * @param feedbackConstant One of the constants defined in 18005 * {@link HapticFeedbackConstants} 18006 */ 18007 public boolean performHapticFeedback(int feedbackConstant) { 18008 return performHapticFeedback(feedbackConstant, 0); 18009 } 18010 18011 /** 18012 * BZZZTT!!1! 18013 * 18014 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 18015 * 18016 * @param feedbackConstant One of the constants defined in 18017 * {@link HapticFeedbackConstants} 18018 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 18019 */ 18020 public boolean performHapticFeedback(int feedbackConstant, int flags) { 18021 if (mAttachInfo == null) { 18022 return false; 18023 } 18024 //noinspection SimplifiableIfStatement 18025 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 18026 && !isHapticFeedbackEnabled()) { 18027 return false; 18028 } 18029 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 18030 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 18031 } 18032 18033 /** 18034 * Request that the visibility of the status bar or other screen/window 18035 * decorations be changed. 18036 * 18037 * <p>This method is used to put the over device UI into temporary modes 18038 * where the user's attention is focused more on the application content, 18039 * by dimming or hiding surrounding system affordances. This is typically 18040 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY 18041 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content 18042 * to be placed behind the action bar (and with these flags other system 18043 * affordances) so that smooth transitions between hiding and showing them 18044 * can be done. 18045 * 18046 * <p>Two representative examples of the use of system UI visibility is 18047 * implementing a content browsing application (like a magazine reader) 18048 * and a video playing application. 18049 * 18050 * <p>The first code shows a typical implementation of a View in a content 18051 * browsing application. In this implementation, the application goes 18052 * into a content-oriented mode by hiding the status bar and action bar, 18053 * and putting the navigation elements into lights out mode. The user can 18054 * then interact with content while in this mode. Such an application should 18055 * provide an easy way for the user to toggle out of the mode (such as to 18056 * check information in the status bar or access notifications). In the 18057 * implementation here, this is done simply by tapping on the content. 18058 * 18059 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java 18060 * content} 18061 * 18062 * <p>This second code sample shows a typical implementation of a View 18063 * in a video playing application. In this situation, while the video is 18064 * playing the application would like to go into a complete full-screen mode, 18065 * to use as much of the display as possible for the video. When in this state 18066 * the user can not interact with the application; the system intercepts 18067 * touching on the screen to pop the UI out of full screen mode. See 18068 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code. 18069 * 18070 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java 18071 * content} 18072 * 18073 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18074 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18075 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18076 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18077 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18078 */ 18079 public void setSystemUiVisibility(int visibility) { 18080 if (visibility != mSystemUiVisibility) { 18081 mSystemUiVisibility = visibility; 18082 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18083 mParent.recomputeViewAttributes(this); 18084 } 18085 } 18086 } 18087 18088 /** 18089 * Returns the last {@link #setSystemUiVisibility(int)} that this view has requested. 18090 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 18091 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 18092 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 18093 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}, {@link #SYSTEM_UI_FLAG_IMMERSIVE}, 18094 * and {@link #SYSTEM_UI_FLAG_IMMERSIVE_STICKY}. 18095 */ 18096 public int getSystemUiVisibility() { 18097 return mSystemUiVisibility; 18098 } 18099 18100 /** 18101 * Returns the current system UI visibility that is currently set for 18102 * the entire window. This is the combination of the 18103 * {@link #setSystemUiVisibility(int)} values supplied by all of the 18104 * views in the window. 18105 */ 18106 public int getWindowSystemUiVisibility() { 18107 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0; 18108 } 18109 18110 /** 18111 * Override to find out when the window's requested system UI visibility 18112 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}. 18113 * This is different from the callbacks received through 18114 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)} 18115 * in that this is only telling you about the local request of the window, 18116 * not the actual values applied by the system. 18117 */ 18118 public void onWindowSystemUiVisibilityChanged(int visible) { 18119 } 18120 18121 /** 18122 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down 18123 * the view hierarchy. 18124 */ 18125 public void dispatchWindowSystemUiVisiblityChanged(int visible) { 18126 onWindowSystemUiVisibilityChanged(visible); 18127 } 18128 18129 /** 18130 * Set a listener to receive callbacks when the visibility of the system bar changes. 18131 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 18132 */ 18133 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 18134 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 18135 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 18136 mParent.recomputeViewAttributes(this); 18137 } 18138 } 18139 18140 /** 18141 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 18142 * the view hierarchy. 18143 */ 18144 public void dispatchSystemUiVisibilityChanged(int visibility) { 18145 ListenerInfo li = mListenerInfo; 18146 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 18147 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 18148 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 18149 } 18150 } 18151 18152 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) { 18153 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 18154 if (val != mSystemUiVisibility) { 18155 setSystemUiVisibility(val); 18156 return true; 18157 } 18158 return false; 18159 } 18160 18161 /** @hide */ 18162 public void setDisabledSystemUiVisibility(int flags) { 18163 if (mAttachInfo != null) { 18164 if (mAttachInfo.mDisabledSystemUiVisibility != flags) { 18165 mAttachInfo.mDisabledSystemUiVisibility = flags; 18166 if (mParent != null) { 18167 mParent.recomputeViewAttributes(this); 18168 } 18169 } 18170 } 18171 } 18172 18173 /** 18174 * Creates an image that the system displays during the drag and drop 18175 * operation. This is called a "drag shadow". The default implementation 18176 * for a DragShadowBuilder based on a View returns an image that has exactly the same 18177 * appearance as the given View. The default also positions the center of the drag shadow 18178 * directly under the touch point. If no View is provided (the constructor with no parameters 18179 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 18180 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 18181 * default is an invisible drag shadow. 18182 * <p> 18183 * You are not required to use the View you provide to the constructor as the basis of the 18184 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 18185 * anything you want as the drag shadow. 18186 * </p> 18187 * <p> 18188 * You pass a DragShadowBuilder object to the system when you start the drag. The system 18189 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 18190 * size and position of the drag shadow. It uses this data to construct a 18191 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 18192 * so that your application can draw the shadow image in the Canvas. 18193 * </p> 18194 * 18195 * <div class="special reference"> 18196 * <h3>Developer Guides</h3> 18197 * <p>For a guide to implementing drag and drop features, read the 18198 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 18199 * </div> 18200 */ 18201 public static class DragShadowBuilder { 18202 private final WeakReference<View> mView; 18203 18204 /** 18205 * Constructs a shadow image builder based on a View. By default, the resulting drag 18206 * shadow will have the same appearance and dimensions as the View, with the touch point 18207 * over the center of the View. 18208 * @param view A View. Any View in scope can be used. 18209 */ 18210 public DragShadowBuilder(View view) { 18211 mView = new WeakReference<View>(view); 18212 } 18213 18214 /** 18215 * Construct a shadow builder object with no associated View. This 18216 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 18217 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 18218 * to supply the drag shadow's dimensions and appearance without 18219 * reference to any View object. If they are not overridden, then the result is an 18220 * invisible drag shadow. 18221 */ 18222 public DragShadowBuilder() { 18223 mView = new WeakReference<View>(null); 18224 } 18225 18226 /** 18227 * Returns the View object that had been passed to the 18228 * {@link #View.DragShadowBuilder(View)} 18229 * constructor. If that View parameter was {@code null} or if the 18230 * {@link #View.DragShadowBuilder()} 18231 * constructor was used to instantiate the builder object, this method will return 18232 * null. 18233 * 18234 * @return The View object associate with this builder object. 18235 */ 18236 @SuppressWarnings({"JavadocReference"}) 18237 final public View getView() { 18238 return mView.get(); 18239 } 18240 18241 /** 18242 * Provides the metrics for the shadow image. These include the dimensions of 18243 * the shadow image, and the point within that shadow that should 18244 * be centered under the touch location while dragging. 18245 * <p> 18246 * The default implementation sets the dimensions of the shadow to be the 18247 * same as the dimensions of the View itself and centers the shadow under 18248 * the touch point. 18249 * </p> 18250 * 18251 * @param shadowSize A {@link android.graphics.Point} containing the width and height 18252 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 18253 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 18254 * image. 18255 * 18256 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 18257 * shadow image that should be underneath the touch point during the drag and drop 18258 * operation. Your application must set {@link android.graphics.Point#x} to the 18259 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 18260 */ 18261 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 18262 final View view = mView.get(); 18263 if (view != null) { 18264 shadowSize.set(view.getWidth(), view.getHeight()); 18265 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 18266 } else { 18267 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 18268 } 18269 } 18270 18271 /** 18272 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 18273 * based on the dimensions it received from the 18274 * {@link #onProvideShadowMetrics(Point, Point)} callback. 18275 * 18276 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 18277 */ 18278 public void onDrawShadow(Canvas canvas) { 18279 final View view = mView.get(); 18280 if (view != null) { 18281 view.draw(canvas); 18282 } else { 18283 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 18284 } 18285 } 18286 } 18287 18288 /** 18289 * Starts a drag and drop operation. When your application calls this method, it passes a 18290 * {@link android.view.View.DragShadowBuilder} object to the system. The 18291 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 18292 * to get metrics for the drag shadow, and then calls the object's 18293 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 18294 * <p> 18295 * Once the system has the drag shadow, it begins the drag and drop operation by sending 18296 * drag events to all the View objects in your application that are currently visible. It does 18297 * this either by calling the View object's drag listener (an implementation of 18298 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 18299 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 18300 * Both are passed a {@link android.view.DragEvent} object that has a 18301 * {@link android.view.DragEvent#getAction()} value of 18302 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 18303 * </p> 18304 * <p> 18305 * Your application can invoke startDrag() on any attached View object. The View object does not 18306 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 18307 * be related to the View the user selected for dragging. 18308 * </p> 18309 * @param data A {@link android.content.ClipData} object pointing to the data to be 18310 * transferred by the drag and drop operation. 18311 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 18312 * drag shadow. 18313 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 18314 * drop operation. This Object is put into every DragEvent object sent by the system during the 18315 * current drag. 18316 * <p> 18317 * myLocalState is a lightweight mechanism for the sending information from the dragged View 18318 * to the target Views. For example, it can contain flags that differentiate between a 18319 * a copy operation and a move operation. 18320 * </p> 18321 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 18322 * so the parameter should be set to 0. 18323 * @return {@code true} if the method completes successfully, or 18324 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 18325 * do a drag, and so no drag operation is in progress. 18326 */ 18327 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 18328 Object myLocalState, int flags) { 18329 if (ViewDebug.DEBUG_DRAG) { 18330 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 18331 } 18332 boolean okay = false; 18333 18334 Point shadowSize = new Point(); 18335 Point shadowTouchPoint = new Point(); 18336 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 18337 18338 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 18339 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 18340 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 18341 } 18342 18343 if (ViewDebug.DEBUG_DRAG) { 18344 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 18345 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 18346 } 18347 Surface surface = new Surface(); 18348 try { 18349 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 18350 flags, shadowSize.x, shadowSize.y, surface); 18351 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 18352 + " surface=" + surface); 18353 if (token != null) { 18354 Canvas canvas = surface.lockCanvas(null); 18355 try { 18356 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 18357 shadowBuilder.onDrawShadow(canvas); 18358 } finally { 18359 surface.unlockCanvasAndPost(canvas); 18360 } 18361 18362 final ViewRootImpl root = getViewRootImpl(); 18363 18364 // Cache the local state object for delivery with DragEvents 18365 root.setLocalDragState(myLocalState); 18366 18367 // repurpose 'shadowSize' for the last touch point 18368 root.getLastTouchPoint(shadowSize); 18369 18370 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 18371 shadowSize.x, shadowSize.y, 18372 shadowTouchPoint.x, shadowTouchPoint.y, data); 18373 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 18374 18375 // Off and running! Release our local surface instance; the drag 18376 // shadow surface is now managed by the system process. 18377 surface.release(); 18378 } 18379 } catch (Exception e) { 18380 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 18381 surface.destroy(); 18382 } 18383 18384 return okay; 18385 } 18386 18387 /** 18388 * Handles drag events sent by the system following a call to 18389 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 18390 *<p> 18391 * When the system calls this method, it passes a 18392 * {@link android.view.DragEvent} object. A call to 18393 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 18394 * in DragEvent. The method uses these to determine what is happening in the drag and drop 18395 * operation. 18396 * @param event The {@link android.view.DragEvent} sent by the system. 18397 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 18398 * in DragEvent, indicating the type of drag event represented by this object. 18399 * @return {@code true} if the method was successful, otherwise {@code false}. 18400 * <p> 18401 * The method should return {@code true} in response to an action type of 18402 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 18403 * operation. 18404 * </p> 18405 * <p> 18406 * The method should also return {@code true} in response to an action type of 18407 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 18408 * {@code false} if it didn't. 18409 * </p> 18410 */ 18411 public boolean onDragEvent(DragEvent event) { 18412 return false; 18413 } 18414 18415 /** 18416 * Detects if this View is enabled and has a drag event listener. 18417 * If both are true, then it calls the drag event listener with the 18418 * {@link android.view.DragEvent} it received. If the drag event listener returns 18419 * {@code true}, then dispatchDragEvent() returns {@code true}. 18420 * <p> 18421 * For all other cases, the method calls the 18422 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 18423 * method and returns its result. 18424 * </p> 18425 * <p> 18426 * This ensures that a drag event is always consumed, even if the View does not have a drag 18427 * event listener. However, if the View has a listener and the listener returns true, then 18428 * onDragEvent() is not called. 18429 * </p> 18430 */ 18431 public boolean dispatchDragEvent(DragEvent event) { 18432 ListenerInfo li = mListenerInfo; 18433 //noinspection SimplifiableIfStatement 18434 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 18435 && li.mOnDragListener.onDrag(this, event)) { 18436 return true; 18437 } 18438 return onDragEvent(event); 18439 } 18440 18441 boolean canAcceptDrag() { 18442 return (mPrivateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0; 18443 } 18444 18445 /** 18446 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 18447 * it is ever exposed at all. 18448 * @hide 18449 */ 18450 public void onCloseSystemDialogs(String reason) { 18451 } 18452 18453 /** 18454 * Given a Drawable whose bounds have been set to draw into this view, 18455 * update a Region being computed for 18456 * {@link #gatherTransparentRegion(android.graphics.Region)} so 18457 * that any non-transparent parts of the Drawable are removed from the 18458 * given transparent region. 18459 * 18460 * @param dr The Drawable whose transparency is to be applied to the region. 18461 * @param region A Region holding the current transparency information, 18462 * where any parts of the region that are set are considered to be 18463 * transparent. On return, this region will be modified to have the 18464 * transparency information reduced by the corresponding parts of the 18465 * Drawable that are not transparent. 18466 * {@hide} 18467 */ 18468 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 18469 if (DBG) { 18470 Log.i("View", "Getting transparent region for: " + this); 18471 } 18472 final Region r = dr.getTransparentRegion(); 18473 final Rect db = dr.getBounds(); 18474 final AttachInfo attachInfo = mAttachInfo; 18475 if (r != null && attachInfo != null) { 18476 final int w = getRight()-getLeft(); 18477 final int h = getBottom()-getTop(); 18478 if (db.left > 0) { 18479 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 18480 r.op(0, 0, db.left, h, Region.Op.UNION); 18481 } 18482 if (db.right < w) { 18483 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 18484 r.op(db.right, 0, w, h, Region.Op.UNION); 18485 } 18486 if (db.top > 0) { 18487 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 18488 r.op(0, 0, w, db.top, Region.Op.UNION); 18489 } 18490 if (db.bottom < h) { 18491 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 18492 r.op(0, db.bottom, w, h, Region.Op.UNION); 18493 } 18494 final int[] location = attachInfo.mTransparentLocation; 18495 getLocationInWindow(location); 18496 r.translate(location[0], location[1]); 18497 region.op(r, Region.Op.INTERSECT); 18498 } else { 18499 region.op(db, Region.Op.DIFFERENCE); 18500 } 18501 } 18502 18503 private void checkForLongClick(int delayOffset) { 18504 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 18505 mHasPerformedLongPress = false; 18506 18507 if (mPendingCheckForLongPress == null) { 18508 mPendingCheckForLongPress = new CheckForLongPress(); 18509 } 18510 mPendingCheckForLongPress.rememberWindowAttachCount(); 18511 postDelayed(mPendingCheckForLongPress, 18512 ViewConfiguration.getLongPressTimeout() - delayOffset); 18513 } 18514 } 18515 18516 /** 18517 * Inflate a view from an XML resource. This convenience method wraps the {@link 18518 * LayoutInflater} class, which provides a full range of options for view inflation. 18519 * 18520 * @param context The Context object for your activity or application. 18521 * @param resource The resource ID to inflate 18522 * @param root A view group that will be the parent. Used to properly inflate the 18523 * layout_* parameters. 18524 * @see LayoutInflater 18525 */ 18526 public static View inflate(Context context, int resource, ViewGroup root) { 18527 LayoutInflater factory = LayoutInflater.from(context); 18528 return factory.inflate(resource, root); 18529 } 18530 18531 /** 18532 * Scroll the view with standard behavior for scrolling beyond the normal 18533 * content boundaries. Views that call this method should override 18534 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 18535 * results of an over-scroll operation. 18536 * 18537 * Views can use this method to handle any touch or fling-based scrolling. 18538 * 18539 * @param deltaX Change in X in pixels 18540 * @param deltaY Change in Y in pixels 18541 * @param scrollX Current X scroll value in pixels before applying deltaX 18542 * @param scrollY Current Y scroll value in pixels before applying deltaY 18543 * @param scrollRangeX Maximum content scroll range along the X axis 18544 * @param scrollRangeY Maximum content scroll range along the Y axis 18545 * @param maxOverScrollX Number of pixels to overscroll by in either direction 18546 * along the X axis. 18547 * @param maxOverScrollY Number of pixels to overscroll by in either direction 18548 * along the Y axis. 18549 * @param isTouchEvent true if this scroll operation is the result of a touch event. 18550 * @return true if scrolling was clamped to an over-scroll boundary along either 18551 * axis, false otherwise. 18552 */ 18553 @SuppressWarnings({"UnusedParameters"}) 18554 protected boolean overScrollBy(int deltaX, int deltaY, 18555 int scrollX, int scrollY, 18556 int scrollRangeX, int scrollRangeY, 18557 int maxOverScrollX, int maxOverScrollY, 18558 boolean isTouchEvent) { 18559 final int overScrollMode = mOverScrollMode; 18560 final boolean canScrollHorizontal = 18561 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 18562 final boolean canScrollVertical = 18563 computeVerticalScrollRange() > computeVerticalScrollExtent(); 18564 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 18565 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 18566 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 18567 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 18568 18569 int newScrollX = scrollX + deltaX; 18570 if (!overScrollHorizontal) { 18571 maxOverScrollX = 0; 18572 } 18573 18574 int newScrollY = scrollY + deltaY; 18575 if (!overScrollVertical) { 18576 maxOverScrollY = 0; 18577 } 18578 18579 // Clamp values if at the limits and record 18580 final int left = -maxOverScrollX; 18581 final int right = maxOverScrollX + scrollRangeX; 18582 final int top = -maxOverScrollY; 18583 final int bottom = maxOverScrollY + scrollRangeY; 18584 18585 boolean clampedX = false; 18586 if (newScrollX > right) { 18587 newScrollX = right; 18588 clampedX = true; 18589 } else if (newScrollX < left) { 18590 newScrollX = left; 18591 clampedX = true; 18592 } 18593 18594 boolean clampedY = false; 18595 if (newScrollY > bottom) { 18596 newScrollY = bottom; 18597 clampedY = true; 18598 } else if (newScrollY < top) { 18599 newScrollY = top; 18600 clampedY = true; 18601 } 18602 18603 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 18604 18605 return clampedX || clampedY; 18606 } 18607 18608 /** 18609 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 18610 * respond to the results of an over-scroll operation. 18611 * 18612 * @param scrollX New X scroll value in pixels 18613 * @param scrollY New Y scroll value in pixels 18614 * @param clampedX True if scrollX was clamped to an over-scroll boundary 18615 * @param clampedY True if scrollY was clamped to an over-scroll boundary 18616 */ 18617 protected void onOverScrolled(int scrollX, int scrollY, 18618 boolean clampedX, boolean clampedY) { 18619 // Intentionally empty. 18620 } 18621 18622 /** 18623 * Returns the over-scroll mode for this view. The result will be 18624 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18625 * (allow over-scrolling only if the view content is larger than the container), 18626 * or {@link #OVER_SCROLL_NEVER}. 18627 * 18628 * @return This view's over-scroll mode. 18629 */ 18630 public int getOverScrollMode() { 18631 return mOverScrollMode; 18632 } 18633 18634 /** 18635 * Set the over-scroll mode for this view. Valid over-scroll modes are 18636 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 18637 * (allow over-scrolling only if the view content is larger than the container), 18638 * or {@link #OVER_SCROLL_NEVER}. 18639 * 18640 * Setting the over-scroll mode of a view will have an effect only if the 18641 * view is capable of scrolling. 18642 * 18643 * @param overScrollMode The new over-scroll mode for this view. 18644 */ 18645 public void setOverScrollMode(int overScrollMode) { 18646 if (overScrollMode != OVER_SCROLL_ALWAYS && 18647 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 18648 overScrollMode != OVER_SCROLL_NEVER) { 18649 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 18650 } 18651 mOverScrollMode = overScrollMode; 18652 } 18653 18654 /** 18655 * Enable or disable nested scrolling for this view. 18656 * 18657 * <p>If this property is set to true the view will be permitted to initiate nested 18658 * scrolling operations with a compatible parent view in the current hierarchy. If this 18659 * view does not implement nested scrolling this will have no effect. Disabling nested scrolling 18660 * while a nested scroll is in progress has the effect of {@link #stopNestedScroll() stopping} 18661 * the nested scroll.</p> 18662 * 18663 * @param enabled true to enable nested scrolling, false to disable 18664 * 18665 * @see #isNestedScrollingEnabled() 18666 */ 18667 public void setNestedScrollingEnabled(boolean enabled) { 18668 if (enabled) { 18669 mPrivateFlags3 |= PFLAG3_NESTED_SCROLLING_ENABLED; 18670 } else { 18671 stopNestedScroll(); 18672 mPrivateFlags3 &= ~PFLAG3_NESTED_SCROLLING_ENABLED; 18673 } 18674 } 18675 18676 /** 18677 * Returns true if nested scrolling is enabled for this view. 18678 * 18679 * <p>If nested scrolling is enabled and this View class implementation supports it, 18680 * this view will act as a nested scrolling child view when applicable, forwarding data 18681 * about the scroll operation in progress to a compatible and cooperating nested scrolling 18682 * parent.</p> 18683 * 18684 * @return true if nested scrolling is enabled 18685 * 18686 * @see #setNestedScrollingEnabled(boolean) 18687 */ 18688 public boolean isNestedScrollingEnabled() { 18689 return (mPrivateFlags3 & PFLAG3_NESTED_SCROLLING_ENABLED) == 18690 PFLAG3_NESTED_SCROLLING_ENABLED; 18691 } 18692 18693 /** 18694 * Begin a nestable scroll operation along the given axes. 18695 * 18696 * <p>A view starting a nested scroll promises to abide by the following contract:</p> 18697 * 18698 * <p>The view will call startNestedScroll upon initiating a scroll operation. In the case 18699 * of a touch scroll this corresponds to the initial {@link MotionEvent#ACTION_DOWN}. 18700 * In the case of touch scrolling the nested scroll will be terminated automatically in 18701 * the same manner as {@link ViewParent#requestDisallowInterceptTouchEvent(boolean)}. 18702 * In the event of programmatic scrolling the caller must explicitly call 18703 * {@link #stopNestedScroll()} to indicate the end of the nested scroll.</p> 18704 * 18705 * <p>If <code>startNestedScroll</code> returns true, a cooperative parent was found. 18706 * If it returns false the caller may ignore the rest of this contract until the next scroll. 18707 * Calling startNestedScroll while a nested scroll is already in progress will return true.</p> 18708 * 18709 * <p>At each incremental step of the scroll the caller should invoke 18710 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} 18711 * once it has calculated the requested scrolling delta. If it returns true the nested scrolling 18712 * parent at least partially consumed the scroll and the caller should adjust the amount it 18713 * scrolls by.</p> 18714 * 18715 * <p>After applying the remainder of the scroll delta the caller should invoke 18716 * {@link #dispatchNestedScroll(int, int, int, int, int[]) dispatchNestedScroll}, passing 18717 * both the delta consumed and the delta unconsumed. A nested scrolling parent may treat 18718 * these values differently. See {@link ViewParent#onNestedScroll(View, int, int, int, int)}. 18719 * </p> 18720 * 18721 * @param axes Flags consisting of a combination of {@link #SCROLL_AXIS_HORIZONTAL} and/or 18722 * {@link #SCROLL_AXIS_VERTICAL}. 18723 * @return true if a cooperative parent was found and nested scrolling has been enabled for 18724 * the current gesture. 18725 * 18726 * @see #stopNestedScroll() 18727 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18728 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18729 */ 18730 public boolean startNestedScroll(int axes) { 18731 if (hasNestedScrollingParent()) { 18732 // Already in progress 18733 return true; 18734 } 18735 if (isNestedScrollingEnabled()) { 18736 ViewParent p = getParent(); 18737 View child = this; 18738 while (p != null) { 18739 try { 18740 if (p.onStartNestedScroll(child, this, axes)) { 18741 mNestedScrollingParent = p; 18742 p.onNestedScrollAccepted(child, this, axes); 18743 return true; 18744 } 18745 } catch (AbstractMethodError e) { 18746 Log.e(VIEW_LOG_TAG, "ViewParent " + p + " does not implement interface " + 18747 "method onStartNestedScroll", e); 18748 // Allow the search upward to continue 18749 } 18750 if (p instanceof View) { 18751 child = (View) p; 18752 } 18753 p = p.getParent(); 18754 } 18755 } 18756 return false; 18757 } 18758 18759 /** 18760 * Stop a nested scroll in progress. 18761 * 18762 * <p>Calling this method when a nested scroll is not currently in progress is harmless.</p> 18763 * 18764 * @see #startNestedScroll(int) 18765 */ 18766 public void stopNestedScroll() { 18767 if (mNestedScrollingParent != null) { 18768 mNestedScrollingParent.onStopNestedScroll(this); 18769 mNestedScrollingParent = null; 18770 } 18771 } 18772 18773 /** 18774 * Returns true if this view has a nested scrolling parent. 18775 * 18776 * <p>The presence of a nested scrolling parent indicates that this view has initiated 18777 * a nested scroll and it was accepted by an ancestor view further up the view hierarchy.</p> 18778 * 18779 * @return whether this view has a nested scrolling parent 18780 */ 18781 public boolean hasNestedScrollingParent() { 18782 return mNestedScrollingParent != null; 18783 } 18784 18785 /** 18786 * Dispatch one step of a nested scroll in progress. 18787 * 18788 * <p>Implementations of views that support nested scrolling should call this to report 18789 * info about a scroll in progress to the current nested scrolling parent. If a nested scroll 18790 * is not currently in progress or nested scrolling is not 18791 * {@link #isNestedScrollingEnabled() enabled} for this view this method does nothing.</p> 18792 * 18793 * <p>Compatible View implementations should also call 18794 * {@link #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll} before 18795 * consuming a component of the scroll event themselves.</p> 18796 * 18797 * @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step 18798 * @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step 18799 * @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view 18800 * @param dyUnconsumed Horizontal scroll distance in pixels not consumed by this view 18801 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18802 * in local view coordinates of this view from before this operation 18803 * to after it completes. View implementations may use this to adjust 18804 * expected input coordinate tracking. 18805 * @return true if the event was dispatched, false if it could not be dispatched. 18806 * @see #dispatchNestedPreScroll(int, int, int[], int[]) 18807 */ 18808 public boolean dispatchNestedScroll(int dxConsumed, int dyConsumed, 18809 int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) { 18810 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18811 if (dxConsumed != 0 || dyConsumed != 0 || dxUnconsumed != 0 || dyUnconsumed != 0) { 18812 int startX = 0; 18813 int startY = 0; 18814 if (offsetInWindow != null) { 18815 getLocationInWindow(offsetInWindow); 18816 startX = offsetInWindow[0]; 18817 startY = offsetInWindow[1]; 18818 } 18819 18820 mNestedScrollingParent.onNestedScroll(this, dxConsumed, dyConsumed, 18821 dxUnconsumed, dyUnconsumed); 18822 18823 if (offsetInWindow != null) { 18824 getLocationInWindow(offsetInWindow); 18825 offsetInWindow[0] -= startX; 18826 offsetInWindow[1] -= startY; 18827 } 18828 return true; 18829 } else if (offsetInWindow != null) { 18830 // No motion, no dispatch. Keep offsetInWindow up to date. 18831 offsetInWindow[0] = 0; 18832 offsetInWindow[1] = 0; 18833 } 18834 } 18835 return false; 18836 } 18837 18838 /** 18839 * Dispatch one step of a nested scroll in progress before this view consumes any portion of it. 18840 * 18841 * <p>Nested pre-scroll events are to nested scroll events what touch intercept is to touch. 18842 * <code>dispatchNestedPreScroll</code> offers an opportunity for the parent view in a nested 18843 * scrolling operation to consume some or all of the scroll operation before the child view 18844 * consumes it.</p> 18845 * 18846 * @param dx Horizontal scroll distance in pixels 18847 * @param dy Vertical scroll distance in pixels 18848 * @param consumed Output. If not null, consumed[0] will contain the consumed component of dx 18849 * and consumed[1] the consumed dy. 18850 * @param offsetInWindow Optional. If not null, on return this will contain the offset 18851 * in local view coordinates of this view from before this operation 18852 * to after it completes. View implementations may use this to adjust 18853 * expected input coordinate tracking. 18854 * @return true if the parent consumed some or all of the scroll delta 18855 * @see #dispatchNestedScroll(int, int, int, int, int[]) 18856 */ 18857 public boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) { 18858 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18859 if (dx != 0 || dy != 0) { 18860 int startX = 0; 18861 int startY = 0; 18862 if (offsetInWindow != null) { 18863 getLocationInWindow(offsetInWindow); 18864 startX = offsetInWindow[0]; 18865 startY = offsetInWindow[1]; 18866 } 18867 18868 if (consumed == null) { 18869 if (mTempNestedScrollConsumed == null) { 18870 mTempNestedScrollConsumed = new int[2]; 18871 } 18872 consumed = mTempNestedScrollConsumed; 18873 } 18874 consumed[0] = 0; 18875 consumed[1] = 0; 18876 mNestedScrollingParent.onNestedPreScroll(this, dx, dy, consumed); 18877 18878 if (offsetInWindow != null) { 18879 getLocationInWindow(offsetInWindow); 18880 offsetInWindow[0] -= startX; 18881 offsetInWindow[1] -= startY; 18882 } 18883 return consumed[0] != 0 || consumed[1] != 0; 18884 } else if (offsetInWindow != null) { 18885 offsetInWindow[0] = 0; 18886 offsetInWindow[1] = 0; 18887 } 18888 } 18889 return false; 18890 } 18891 18892 /** 18893 * Dispatch a fling to a nested scrolling parent. 18894 * 18895 * <p>This method should be used to indicate that a nested scrolling child has detected 18896 * suitable conditions for a fling. Generally this means that a touch scroll has ended with a 18897 * {@link VelocityTracker velocity} in the direction of scrolling that meets or exceeds 18898 * the {@link ViewConfiguration#getScaledMinimumFlingVelocity() minimum fling velocity} 18899 * along a scrollable axis.</p> 18900 * 18901 * <p>If a nested scrolling child view would normally fling but it is at the edge of 18902 * its own content, it can use this method to delegate the fling to its nested scrolling 18903 * parent instead. The parent may optionally consume the fling or observe a child fling.</p> 18904 * 18905 * @param velocityX Horizontal fling velocity in pixels per second 18906 * @param velocityY Vertical fling velocity in pixels per second 18907 * @param consumed true if the child consumed the fling, false otherwise 18908 * @return true if the nested scrolling parent consumed or otherwise reacted to the fling 18909 */ 18910 public boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) { 18911 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18912 return mNestedScrollingParent.onNestedFling(this, velocityX, velocityY, consumed); 18913 } 18914 return false; 18915 } 18916 18917 /** 18918 * Dispatch a fling to a nested scrolling parent before it is processed by this view. 18919 * 18920 * <p>Nested pre-fling events are to nested fling events what touch intercept is to touch 18921 * and what nested pre-scroll is to nested scroll. <code>dispatchNestedPreFling</code> 18922 * offsets an opportunity for the parent view in a nested fling to fully consume the fling 18923 * before the child view consumes it. If this method returns <code>true</code>, a nested 18924 * parent view consumed the fling and this view should not scroll as a result.</p> 18925 * 18926 * <p>For a better user experience, only one view in a nested scrolling chain should consume 18927 * the fling at a time. If a parent view consumed the fling this method will return false. 18928 * Custom view implementations should account for this in two ways:</p> 18929 * 18930 * <ul> 18931 * <li>If a custom view is paged and needs to settle to a fixed page-point, do not 18932 * call <code>dispatchNestedPreFling</code>; consume the fling and settle to a valid 18933 * position regardless.</li> 18934 * <li>If a nested parent does consume the fling, this view should not scroll at all, 18935 * even to settle back to a valid idle position.</li> 18936 * </ul> 18937 * 18938 * <p>Views should also not offer fling velocities to nested parent views along an axis 18939 * where scrolling is not currently supported; a {@link android.widget.ScrollView ScrollView} 18940 * should not offer a horizontal fling velocity to its parents since scrolling along that 18941 * axis is not permitted and carrying velocity along that motion does not make sense.</p> 18942 * 18943 * @param velocityX Horizontal fling velocity in pixels per second 18944 * @param velocityY Vertical fling velocity in pixels per second 18945 * @return true if a nested scrolling parent consumed the fling 18946 */ 18947 public boolean dispatchNestedPreFling(float velocityX, float velocityY) { 18948 if (isNestedScrollingEnabled() && mNestedScrollingParent != null) { 18949 return mNestedScrollingParent.onNestedPreFling(this, velocityX, velocityY); 18950 } 18951 return false; 18952 } 18953 18954 /** 18955 * Gets a scale factor that determines the distance the view should scroll 18956 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 18957 * @return The vertical scroll scale factor. 18958 * @hide 18959 */ 18960 protected float getVerticalScrollFactor() { 18961 if (mVerticalScrollFactor == 0) { 18962 TypedValue outValue = new TypedValue(); 18963 if (!mContext.getTheme().resolveAttribute( 18964 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 18965 throw new IllegalStateException( 18966 "Expected theme to define listPreferredItemHeight."); 18967 } 18968 mVerticalScrollFactor = outValue.getDimension( 18969 mContext.getResources().getDisplayMetrics()); 18970 } 18971 return mVerticalScrollFactor; 18972 } 18973 18974 /** 18975 * Gets a scale factor that determines the distance the view should scroll 18976 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 18977 * @return The horizontal scroll scale factor. 18978 * @hide 18979 */ 18980 protected float getHorizontalScrollFactor() { 18981 // TODO: Should use something else. 18982 return getVerticalScrollFactor(); 18983 } 18984 18985 /** 18986 * Return the value specifying the text direction or policy that was set with 18987 * {@link #setTextDirection(int)}. 18988 * 18989 * @return the defined text direction. It can be one of: 18990 * 18991 * {@link #TEXT_DIRECTION_INHERIT}, 18992 * {@link #TEXT_DIRECTION_FIRST_STRONG} 18993 * {@link #TEXT_DIRECTION_ANY_RTL}, 18994 * {@link #TEXT_DIRECTION_LTR}, 18995 * {@link #TEXT_DIRECTION_RTL}, 18996 * {@link #TEXT_DIRECTION_LOCALE} 18997 * 18998 * @attr ref android.R.styleable#View_textDirection 18999 * 19000 * @hide 19001 */ 19002 @ViewDebug.ExportedProperty(category = "text", mapping = { 19003 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19004 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19005 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19006 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19007 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19008 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19009 }) 19010 public int getRawTextDirection() { 19011 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_MASK) >> PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 19012 } 19013 19014 /** 19015 * Set the text direction. 19016 * 19017 * @param textDirection the direction to set. Should be one of: 19018 * 19019 * {@link #TEXT_DIRECTION_INHERIT}, 19020 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19021 * {@link #TEXT_DIRECTION_ANY_RTL}, 19022 * {@link #TEXT_DIRECTION_LTR}, 19023 * {@link #TEXT_DIRECTION_RTL}, 19024 * {@link #TEXT_DIRECTION_LOCALE} 19025 * 19026 * Resolution will be done if the value is set to TEXT_DIRECTION_INHERIT. The resolution 19027 * proceeds up the parent chain of the view to get the value. If there is no parent, then it will 19028 * return the default {@link #TEXT_DIRECTION_FIRST_STRONG}. 19029 * 19030 * @attr ref android.R.styleable#View_textDirection 19031 */ 19032 public void setTextDirection(int textDirection) { 19033 if (getRawTextDirection() != textDirection) { 19034 // Reset the current text direction and the resolved one 19035 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 19036 resetResolvedTextDirection(); 19037 // Set the new text direction 19038 mPrivateFlags2 |= ((textDirection << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) & PFLAG2_TEXT_DIRECTION_MASK); 19039 // Do resolution 19040 resolveTextDirection(); 19041 // Notify change 19042 onRtlPropertiesChanged(getLayoutDirection()); 19043 // Refresh 19044 requestLayout(); 19045 invalidate(true); 19046 } 19047 } 19048 19049 /** 19050 * Return the resolved text direction. 19051 * 19052 * @return the resolved text direction. Returns one of: 19053 * 19054 * {@link #TEXT_DIRECTION_FIRST_STRONG} 19055 * {@link #TEXT_DIRECTION_ANY_RTL}, 19056 * {@link #TEXT_DIRECTION_LTR}, 19057 * {@link #TEXT_DIRECTION_RTL}, 19058 * {@link #TEXT_DIRECTION_LOCALE} 19059 * 19060 * @attr ref android.R.styleable#View_textDirection 19061 */ 19062 @ViewDebug.ExportedProperty(category = "text", mapping = { 19063 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 19064 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 19065 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 19066 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 19067 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 19068 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 19069 }) 19070 public int getTextDirection() { 19071 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED_MASK) >> PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 19072 } 19073 19074 /** 19075 * Resolve the text direction. 19076 * 19077 * @return true if resolution has been done, false otherwise. 19078 * 19079 * @hide 19080 */ 19081 public boolean resolveTextDirection() { 19082 // Reset any previous text direction resolution 19083 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19084 19085 if (hasRtlSupport()) { 19086 // Set resolved text direction flag depending on text direction flag 19087 final int textDirection = getRawTextDirection(); 19088 switch(textDirection) { 19089 case TEXT_DIRECTION_INHERIT: 19090 if (!canResolveTextDirection()) { 19091 // We cannot do the resolution if there is no parent, so use the default one 19092 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19093 // Resolution will need to happen again later 19094 return false; 19095 } 19096 19097 // Parent has not yet resolved, so we still return the default 19098 try { 19099 if (!mParent.isTextDirectionResolved()) { 19100 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19101 // Resolution will need to happen again later 19102 return false; 19103 } 19104 } catch (AbstractMethodError e) { 19105 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19106 " does not fully implement ViewParent", e); 19107 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED | 19108 PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19109 return true; 19110 } 19111 19112 // Set current resolved direction to the same value as the parent's one 19113 int parentResolvedDirection; 19114 try { 19115 parentResolvedDirection = mParent.getTextDirection(); 19116 } catch (AbstractMethodError e) { 19117 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19118 " does not fully implement ViewParent", e); 19119 parentResolvedDirection = TEXT_DIRECTION_LTR; 19120 } 19121 switch (parentResolvedDirection) { 19122 case TEXT_DIRECTION_FIRST_STRONG: 19123 case TEXT_DIRECTION_ANY_RTL: 19124 case TEXT_DIRECTION_LTR: 19125 case TEXT_DIRECTION_RTL: 19126 case TEXT_DIRECTION_LOCALE: 19127 mPrivateFlags2 |= 19128 (parentResolvedDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19129 break; 19130 default: 19131 // Default resolved direction is "first strong" heuristic 19132 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19133 } 19134 break; 19135 case TEXT_DIRECTION_FIRST_STRONG: 19136 case TEXT_DIRECTION_ANY_RTL: 19137 case TEXT_DIRECTION_LTR: 19138 case TEXT_DIRECTION_RTL: 19139 case TEXT_DIRECTION_LOCALE: 19140 // Resolved direction is the same as text direction 19141 mPrivateFlags2 |= (textDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 19142 break; 19143 default: 19144 // Default resolved direction is "first strong" heuristic 19145 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19146 } 19147 } else { 19148 // Default resolved direction is "first strong" heuristic 19149 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19150 } 19151 19152 // Set to resolved 19153 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED; 19154 return true; 19155 } 19156 19157 /** 19158 * Check if text direction resolution can be done. 19159 * 19160 * @return true if text direction resolution can be done otherwise return false. 19161 */ 19162 public boolean canResolveTextDirection() { 19163 switch (getRawTextDirection()) { 19164 case TEXT_DIRECTION_INHERIT: 19165 if (mParent != null) { 19166 try { 19167 return mParent.canResolveTextDirection(); 19168 } catch (AbstractMethodError e) { 19169 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19170 " does not fully implement ViewParent", e); 19171 } 19172 } 19173 return false; 19174 19175 default: 19176 return true; 19177 } 19178 } 19179 19180 /** 19181 * Reset resolved text direction. Text direction will be resolved during a call to 19182 * {@link #onMeasure(int, int)}. 19183 * 19184 * @hide 19185 */ 19186 public void resetResolvedTextDirection() { 19187 // Reset any previous text direction resolution 19188 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 19189 // Set to default value 19190 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 19191 } 19192 19193 /** 19194 * @return true if text direction is inherited. 19195 * 19196 * @hide 19197 */ 19198 public boolean isTextDirectionInherited() { 19199 return (getRawTextDirection() == TEXT_DIRECTION_INHERIT); 19200 } 19201 19202 /** 19203 * @return true if text direction is resolved. 19204 */ 19205 public boolean isTextDirectionResolved() { 19206 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED) == PFLAG2_TEXT_DIRECTION_RESOLVED; 19207 } 19208 19209 /** 19210 * Return the value specifying the text alignment or policy that was set with 19211 * {@link #setTextAlignment(int)}. 19212 * 19213 * @return the defined text alignment. It can be one of: 19214 * 19215 * {@link #TEXT_ALIGNMENT_INHERIT}, 19216 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19217 * {@link #TEXT_ALIGNMENT_CENTER}, 19218 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19219 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19220 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19221 * {@link #TEXT_ALIGNMENT_VIEW_END} 19222 * 19223 * @attr ref android.R.styleable#View_textAlignment 19224 * 19225 * @hide 19226 */ 19227 @ViewDebug.ExportedProperty(category = "text", mapping = { 19228 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19229 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19230 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19231 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19232 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19233 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19234 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19235 }) 19236 @TextAlignment 19237 public int getRawTextAlignment() { 19238 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_MASK) >> PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 19239 } 19240 19241 /** 19242 * Set the text alignment. 19243 * 19244 * @param textAlignment The text alignment to set. Should be one of 19245 * 19246 * {@link #TEXT_ALIGNMENT_INHERIT}, 19247 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19248 * {@link #TEXT_ALIGNMENT_CENTER}, 19249 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19250 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19251 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19252 * {@link #TEXT_ALIGNMENT_VIEW_END} 19253 * 19254 * Resolution will be done if the value is set to TEXT_ALIGNMENT_INHERIT. The resolution 19255 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 19256 * will return the default {@link #TEXT_ALIGNMENT_GRAVITY}. 19257 * 19258 * @attr ref android.R.styleable#View_textAlignment 19259 */ 19260 public void setTextAlignment(@TextAlignment int textAlignment) { 19261 if (textAlignment != getRawTextAlignment()) { 19262 // Reset the current and resolved text alignment 19263 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 19264 resetResolvedTextAlignment(); 19265 // Set the new text alignment 19266 mPrivateFlags2 |= 19267 ((textAlignment << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) & PFLAG2_TEXT_ALIGNMENT_MASK); 19268 // Do resolution 19269 resolveTextAlignment(); 19270 // Notify change 19271 onRtlPropertiesChanged(getLayoutDirection()); 19272 // Refresh 19273 requestLayout(); 19274 invalidate(true); 19275 } 19276 } 19277 19278 /** 19279 * Return the resolved text alignment. 19280 * 19281 * @return the resolved text alignment. Returns one of: 19282 * 19283 * {@link #TEXT_ALIGNMENT_GRAVITY}, 19284 * {@link #TEXT_ALIGNMENT_CENTER}, 19285 * {@link #TEXT_ALIGNMENT_TEXT_START}, 19286 * {@link #TEXT_ALIGNMENT_TEXT_END}, 19287 * {@link #TEXT_ALIGNMENT_VIEW_START}, 19288 * {@link #TEXT_ALIGNMENT_VIEW_END} 19289 * 19290 * @attr ref android.R.styleable#View_textAlignment 19291 */ 19292 @ViewDebug.ExportedProperty(category = "text", mapping = { 19293 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 19294 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 19295 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 19296 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 19297 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 19298 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 19299 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 19300 }) 19301 @TextAlignment 19302 public int getTextAlignment() { 19303 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK) >> 19304 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 19305 } 19306 19307 /** 19308 * Resolve the text alignment. 19309 * 19310 * @return true if resolution has been done, false otherwise. 19311 * 19312 * @hide 19313 */ 19314 public boolean resolveTextAlignment() { 19315 // Reset any previous text alignment resolution 19316 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19317 19318 if (hasRtlSupport()) { 19319 // Set resolved text alignment flag depending on text alignment flag 19320 final int textAlignment = getRawTextAlignment(); 19321 switch (textAlignment) { 19322 case TEXT_ALIGNMENT_INHERIT: 19323 // Check if we can resolve the text alignment 19324 if (!canResolveTextAlignment()) { 19325 // We cannot do the resolution if there is no parent so use the default 19326 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19327 // Resolution will need to happen again later 19328 return false; 19329 } 19330 19331 // Parent has not yet resolved, so we still return the default 19332 try { 19333 if (!mParent.isTextAlignmentResolved()) { 19334 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19335 // Resolution will need to happen again later 19336 return false; 19337 } 19338 } catch (AbstractMethodError e) { 19339 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19340 " does not fully implement ViewParent", e); 19341 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED | 19342 PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19343 return true; 19344 } 19345 19346 int parentResolvedTextAlignment; 19347 try { 19348 parentResolvedTextAlignment = mParent.getTextAlignment(); 19349 } catch (AbstractMethodError e) { 19350 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19351 " does not fully implement ViewParent", e); 19352 parentResolvedTextAlignment = TEXT_ALIGNMENT_GRAVITY; 19353 } 19354 switch (parentResolvedTextAlignment) { 19355 case TEXT_ALIGNMENT_GRAVITY: 19356 case TEXT_ALIGNMENT_TEXT_START: 19357 case TEXT_ALIGNMENT_TEXT_END: 19358 case TEXT_ALIGNMENT_CENTER: 19359 case TEXT_ALIGNMENT_VIEW_START: 19360 case TEXT_ALIGNMENT_VIEW_END: 19361 // Resolved text alignment is the same as the parent resolved 19362 // text alignment 19363 mPrivateFlags2 |= 19364 (parentResolvedTextAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19365 break; 19366 default: 19367 // Use default resolved text alignment 19368 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19369 } 19370 break; 19371 case TEXT_ALIGNMENT_GRAVITY: 19372 case TEXT_ALIGNMENT_TEXT_START: 19373 case TEXT_ALIGNMENT_TEXT_END: 19374 case TEXT_ALIGNMENT_CENTER: 19375 case TEXT_ALIGNMENT_VIEW_START: 19376 case TEXT_ALIGNMENT_VIEW_END: 19377 // Resolved text alignment is the same as text alignment 19378 mPrivateFlags2 |= (textAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 19379 break; 19380 default: 19381 // Use default resolved text alignment 19382 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19383 } 19384 } else { 19385 // Use default resolved text alignment 19386 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19387 } 19388 19389 // Set the resolved 19390 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19391 return true; 19392 } 19393 19394 /** 19395 * Check if text alignment resolution can be done. 19396 * 19397 * @return true if text alignment resolution can be done otherwise return false. 19398 */ 19399 public boolean canResolveTextAlignment() { 19400 switch (getRawTextAlignment()) { 19401 case TEXT_DIRECTION_INHERIT: 19402 if (mParent != null) { 19403 try { 19404 return mParent.canResolveTextAlignment(); 19405 } catch (AbstractMethodError e) { 19406 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 19407 " does not fully implement ViewParent", e); 19408 } 19409 } 19410 return false; 19411 19412 default: 19413 return true; 19414 } 19415 } 19416 19417 /** 19418 * Reset resolved text alignment. Text alignment will be resolved during a call to 19419 * {@link #onMeasure(int, int)}. 19420 * 19421 * @hide 19422 */ 19423 public void resetResolvedTextAlignment() { 19424 // Reset any previous text alignment resolution 19425 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 19426 // Set to default 19427 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 19428 } 19429 19430 /** 19431 * @return true if text alignment is inherited. 19432 * 19433 * @hide 19434 */ 19435 public boolean isTextAlignmentInherited() { 19436 return (getRawTextAlignment() == TEXT_ALIGNMENT_INHERIT); 19437 } 19438 19439 /** 19440 * @return true if text alignment is resolved. 19441 */ 19442 public boolean isTextAlignmentResolved() { 19443 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED) == PFLAG2_TEXT_ALIGNMENT_RESOLVED; 19444 } 19445 19446 /** 19447 * Generate a value suitable for use in {@link #setId(int)}. 19448 * This value will not collide with ID values generated at build time by aapt for R.id. 19449 * 19450 * @return a generated ID value 19451 */ 19452 public static int generateViewId() { 19453 for (;;) { 19454 final int result = sNextGeneratedId.get(); 19455 // aapt-generated IDs have the high byte nonzero; clamp to the range under that. 19456 int newValue = result + 1; 19457 if (newValue > 0x00FFFFFF) newValue = 1; // Roll over to 1, not 0. 19458 if (sNextGeneratedId.compareAndSet(result, newValue)) { 19459 return result; 19460 } 19461 } 19462 } 19463 19464 /** 19465 * Gets the Views in the hierarchy affected by entering and exiting Activity Scene transitions. 19466 * @param transitioningViews This View will be added to transitioningViews if it is VISIBLE and 19467 * a normal View or a ViewGroup with 19468 * {@link android.view.ViewGroup#isTransitionGroup()} true. 19469 * @hide 19470 */ 19471 public void captureTransitioningViews(List<View> transitioningViews) { 19472 if (getVisibility() == View.VISIBLE) { 19473 transitioningViews.add(this); 19474 } 19475 } 19476 19477 /** 19478 * Adds all Views that have {@link #getTransitionName()} non-null to namedElements. 19479 * @param namedElements Will contain all Views in the hierarchy having a transitionName. 19480 * @hide 19481 */ 19482 public void findNamedViews(Map<String, View> namedElements) { 19483 if (getVisibility() == VISIBLE || mGhostView != null) { 19484 String transitionName = getTransitionName(); 19485 if (transitionName != null) { 19486 namedElements.put(transitionName, this); 19487 } 19488 } 19489 } 19490 19491 // 19492 // Properties 19493 // 19494 /** 19495 * A Property wrapper around the <code>alpha</code> functionality handled by the 19496 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 19497 */ 19498 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 19499 @Override 19500 public void setValue(View object, float value) { 19501 object.setAlpha(value); 19502 } 19503 19504 @Override 19505 public Float get(View object) { 19506 return object.getAlpha(); 19507 } 19508 }; 19509 19510 /** 19511 * A Property wrapper around the <code>translationX</code> functionality handled by the 19512 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 19513 */ 19514 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 19515 @Override 19516 public void setValue(View object, float value) { 19517 object.setTranslationX(value); 19518 } 19519 19520 @Override 19521 public Float get(View object) { 19522 return object.getTranslationX(); 19523 } 19524 }; 19525 19526 /** 19527 * A Property wrapper around the <code>translationY</code> functionality handled by the 19528 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 19529 */ 19530 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 19531 @Override 19532 public void setValue(View object, float value) { 19533 object.setTranslationY(value); 19534 } 19535 19536 @Override 19537 public Float get(View object) { 19538 return object.getTranslationY(); 19539 } 19540 }; 19541 19542 /** 19543 * A Property wrapper around the <code>translationZ</code> functionality handled by the 19544 * {@link View#setTranslationZ(float)} and {@link View#getTranslationZ()} methods. 19545 */ 19546 public static final Property<View, Float> TRANSLATION_Z = new FloatProperty<View>("translationZ") { 19547 @Override 19548 public void setValue(View object, float value) { 19549 object.setTranslationZ(value); 19550 } 19551 19552 @Override 19553 public Float get(View object) { 19554 return object.getTranslationZ(); 19555 } 19556 }; 19557 19558 /** 19559 * A Property wrapper around the <code>x</code> functionality handled by the 19560 * {@link View#setX(float)} and {@link View#getX()} methods. 19561 */ 19562 public static final Property<View, Float> X = new FloatProperty<View>("x") { 19563 @Override 19564 public void setValue(View object, float value) { 19565 object.setX(value); 19566 } 19567 19568 @Override 19569 public Float get(View object) { 19570 return object.getX(); 19571 } 19572 }; 19573 19574 /** 19575 * A Property wrapper around the <code>y</code> functionality handled by the 19576 * {@link View#setY(float)} and {@link View#getY()} methods. 19577 */ 19578 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 19579 @Override 19580 public void setValue(View object, float value) { 19581 object.setY(value); 19582 } 19583 19584 @Override 19585 public Float get(View object) { 19586 return object.getY(); 19587 } 19588 }; 19589 19590 /** 19591 * A Property wrapper around the <code>z</code> functionality handled by the 19592 * {@link View#setZ(float)} and {@link View#getZ()} methods. 19593 */ 19594 public static final Property<View, Float> Z = new FloatProperty<View>("z") { 19595 @Override 19596 public void setValue(View object, float value) { 19597 object.setZ(value); 19598 } 19599 19600 @Override 19601 public Float get(View object) { 19602 return object.getZ(); 19603 } 19604 }; 19605 19606 /** 19607 * A Property wrapper around the <code>rotation</code> functionality handled by the 19608 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 19609 */ 19610 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 19611 @Override 19612 public void setValue(View object, float value) { 19613 object.setRotation(value); 19614 } 19615 19616 @Override 19617 public Float get(View object) { 19618 return object.getRotation(); 19619 } 19620 }; 19621 19622 /** 19623 * A Property wrapper around the <code>rotationX</code> functionality handled by the 19624 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 19625 */ 19626 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 19627 @Override 19628 public void setValue(View object, float value) { 19629 object.setRotationX(value); 19630 } 19631 19632 @Override 19633 public Float get(View object) { 19634 return object.getRotationX(); 19635 } 19636 }; 19637 19638 /** 19639 * A Property wrapper around the <code>rotationY</code> functionality handled by the 19640 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 19641 */ 19642 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 19643 @Override 19644 public void setValue(View object, float value) { 19645 object.setRotationY(value); 19646 } 19647 19648 @Override 19649 public Float get(View object) { 19650 return object.getRotationY(); 19651 } 19652 }; 19653 19654 /** 19655 * A Property wrapper around the <code>scaleX</code> functionality handled by the 19656 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 19657 */ 19658 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 19659 @Override 19660 public void setValue(View object, float value) { 19661 object.setScaleX(value); 19662 } 19663 19664 @Override 19665 public Float get(View object) { 19666 return object.getScaleX(); 19667 } 19668 }; 19669 19670 /** 19671 * A Property wrapper around the <code>scaleY</code> functionality handled by the 19672 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 19673 */ 19674 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 19675 @Override 19676 public void setValue(View object, float value) { 19677 object.setScaleY(value); 19678 } 19679 19680 @Override 19681 public Float get(View object) { 19682 return object.getScaleY(); 19683 } 19684 }; 19685 19686 /** 19687 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 19688 * Each MeasureSpec represents a requirement for either the width or the height. 19689 * A MeasureSpec is comprised of a size and a mode. There are three possible 19690 * modes: 19691 * <dl> 19692 * <dt>UNSPECIFIED</dt> 19693 * <dd> 19694 * The parent has not imposed any constraint on the child. It can be whatever size 19695 * it wants. 19696 * </dd> 19697 * 19698 * <dt>EXACTLY</dt> 19699 * <dd> 19700 * The parent has determined an exact size for the child. The child is going to be 19701 * given those bounds regardless of how big it wants to be. 19702 * </dd> 19703 * 19704 * <dt>AT_MOST</dt> 19705 * <dd> 19706 * The child can be as large as it wants up to the specified size. 19707 * </dd> 19708 * </dl> 19709 * 19710 * MeasureSpecs are implemented as ints to reduce object allocation. This class 19711 * is provided to pack and unpack the <size, mode> tuple into the int. 19712 */ 19713 public static class MeasureSpec { 19714 private static final int MODE_SHIFT = 30; 19715 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 19716 19717 /** 19718 * Measure specification mode: The parent has not imposed any constraint 19719 * on the child. It can be whatever size it wants. 19720 */ 19721 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 19722 19723 /** 19724 * Measure specification mode: The parent has determined an exact size 19725 * for the child. The child is going to be given those bounds regardless 19726 * of how big it wants to be. 19727 */ 19728 public static final int EXACTLY = 1 << MODE_SHIFT; 19729 19730 /** 19731 * Measure specification mode: The child can be as large as it wants up 19732 * to the specified size. 19733 */ 19734 public static final int AT_MOST = 2 << MODE_SHIFT; 19735 19736 /** 19737 * Creates a measure specification based on the supplied size and mode. 19738 * 19739 * The mode must always be one of the following: 19740 * <ul> 19741 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 19742 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 19743 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 19744 * </ul> 19745 * 19746 * <p><strong>Note:</strong> On API level 17 and lower, makeMeasureSpec's 19747 * implementation was such that the order of arguments did not matter 19748 * and overflow in either value could impact the resulting MeasureSpec. 19749 * {@link android.widget.RelativeLayout} was affected by this bug. 19750 * Apps targeting API levels greater than 17 will get the fixed, more strict 19751 * behavior.</p> 19752 * 19753 * @param size the size of the measure specification 19754 * @param mode the mode of the measure specification 19755 * @return the measure specification based on size and mode 19756 */ 19757 public static int makeMeasureSpec(int size, int mode) { 19758 if (sUseBrokenMakeMeasureSpec) { 19759 return size + mode; 19760 } else { 19761 return (size & ~MODE_MASK) | (mode & MODE_MASK); 19762 } 19763 } 19764 19765 /** 19766 * Extracts the mode from the supplied measure specification. 19767 * 19768 * @param measureSpec the measure specification to extract the mode from 19769 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 19770 * {@link android.view.View.MeasureSpec#AT_MOST} or 19771 * {@link android.view.View.MeasureSpec#EXACTLY} 19772 */ 19773 public static int getMode(int measureSpec) { 19774 return (measureSpec & MODE_MASK); 19775 } 19776 19777 /** 19778 * Extracts the size from the supplied measure specification. 19779 * 19780 * @param measureSpec the measure specification to extract the size from 19781 * @return the size in pixels defined in the supplied measure specification 19782 */ 19783 public static int getSize(int measureSpec) { 19784 return (measureSpec & ~MODE_MASK); 19785 } 19786 19787 static int adjust(int measureSpec, int delta) { 19788 final int mode = getMode(measureSpec); 19789 if (mode == UNSPECIFIED) { 19790 // No need to adjust size for UNSPECIFIED mode. 19791 return makeMeasureSpec(0, UNSPECIFIED); 19792 } 19793 int size = getSize(measureSpec) + delta; 19794 if (size < 0) { 19795 Log.e(VIEW_LOG_TAG, "MeasureSpec.adjust: new size would be negative! (" + size + 19796 ") spec: " + toString(measureSpec) + " delta: " + delta); 19797 size = 0; 19798 } 19799 return makeMeasureSpec(size, mode); 19800 } 19801 19802 /** 19803 * Returns a String representation of the specified measure 19804 * specification. 19805 * 19806 * @param measureSpec the measure specification to convert to a String 19807 * @return a String with the following format: "MeasureSpec: MODE SIZE" 19808 */ 19809 public static String toString(int measureSpec) { 19810 int mode = getMode(measureSpec); 19811 int size = getSize(measureSpec); 19812 19813 StringBuilder sb = new StringBuilder("MeasureSpec: "); 19814 19815 if (mode == UNSPECIFIED) 19816 sb.append("UNSPECIFIED "); 19817 else if (mode == EXACTLY) 19818 sb.append("EXACTLY "); 19819 else if (mode == AT_MOST) 19820 sb.append("AT_MOST "); 19821 else 19822 sb.append(mode).append(" "); 19823 19824 sb.append(size); 19825 return sb.toString(); 19826 } 19827 } 19828 19829 private final class CheckForLongPress implements Runnable { 19830 private int mOriginalWindowAttachCount; 19831 19832 @Override 19833 public void run() { 19834 if (isPressed() && (mParent != null) 19835 && mOriginalWindowAttachCount == mWindowAttachCount) { 19836 if (performLongClick()) { 19837 mHasPerformedLongPress = true; 19838 } 19839 } 19840 } 19841 19842 public void rememberWindowAttachCount() { 19843 mOriginalWindowAttachCount = mWindowAttachCount; 19844 } 19845 } 19846 19847 private final class CheckForTap implements Runnable { 19848 public float x; 19849 public float y; 19850 19851 @Override 19852 public void run() { 19853 mPrivateFlags &= ~PFLAG_PREPRESSED; 19854 setPressed(true, x, y); 19855 checkForLongClick(ViewConfiguration.getTapTimeout()); 19856 } 19857 } 19858 19859 private final class PerformClick implements Runnable { 19860 @Override 19861 public void run() { 19862 performClick(); 19863 } 19864 } 19865 19866 /** @hide */ 19867 public void hackTurnOffWindowResizeAnim(boolean off) { 19868 mAttachInfo.mTurnOffWindowResizeAnim = off; 19869 } 19870 19871 /** 19872 * This method returns a ViewPropertyAnimator object, which can be used to animate 19873 * specific properties on this View. 19874 * 19875 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 19876 */ 19877 public ViewPropertyAnimator animate() { 19878 if (mAnimator == null) { 19879 mAnimator = new ViewPropertyAnimator(this); 19880 } 19881 return mAnimator; 19882 } 19883 19884 /** 19885 * Sets the name of the View to be used to identify Views in Transitions. 19886 * Names should be unique in the View hierarchy. 19887 * 19888 * @param transitionName The name of the View to uniquely identify it for Transitions. 19889 */ 19890 public final void setTransitionName(String transitionName) { 19891 mTransitionName = transitionName; 19892 } 19893 19894 /** 19895 * Returns the name of the View to be used to identify Views in Transitions. 19896 * Names should be unique in the View hierarchy. 19897 * 19898 * <p>This returns null if the View has not been given a name.</p> 19899 * 19900 * @return The name used of the View to be used to identify Views in Transitions or null 19901 * if no name has been given. 19902 */ 19903 @ViewDebug.ExportedProperty 19904 public String getTransitionName() { 19905 return mTransitionName; 19906 } 19907 19908 /** 19909 * Interface definition for a callback to be invoked when a hardware key event is 19910 * dispatched to this view. The callback will be invoked before the key event is 19911 * given to the view. This is only useful for hardware keyboards; a software input 19912 * method has no obligation to trigger this listener. 19913 */ 19914 public interface OnKeyListener { 19915 /** 19916 * Called when a hardware key is dispatched to a view. This allows listeners to 19917 * get a chance to respond before the target view. 19918 * <p>Key presses in software keyboards will generally NOT trigger this method, 19919 * although some may elect to do so in some situations. Do not assume a 19920 * software input method has to be key-based; even if it is, it may use key presses 19921 * in a different way than you expect, so there is no way to reliably catch soft 19922 * input key presses. 19923 * 19924 * @param v The view the key has been dispatched to. 19925 * @param keyCode The code for the physical key that was pressed 19926 * @param event The KeyEvent object containing full information about 19927 * the event. 19928 * @return True if the listener has consumed the event, false otherwise. 19929 */ 19930 boolean onKey(View v, int keyCode, KeyEvent event); 19931 } 19932 19933 /** 19934 * Interface definition for a callback to be invoked when a touch event is 19935 * dispatched to this view. The callback will be invoked before the touch 19936 * event is given to the view. 19937 */ 19938 public interface OnTouchListener { 19939 /** 19940 * Called when a touch event is dispatched to a view. This allows listeners to 19941 * get a chance to respond before the target view. 19942 * 19943 * @param v The view the touch event has been dispatched to. 19944 * @param event The MotionEvent object containing full information about 19945 * the event. 19946 * @return True if the listener has consumed the event, false otherwise. 19947 */ 19948 boolean onTouch(View v, MotionEvent event); 19949 } 19950 19951 /** 19952 * Interface definition for a callback to be invoked when a hover event is 19953 * dispatched to this view. The callback will be invoked before the hover 19954 * event is given to the view. 19955 */ 19956 public interface OnHoverListener { 19957 /** 19958 * Called when a hover event is dispatched to a view. This allows listeners to 19959 * get a chance to respond before the target view. 19960 * 19961 * @param v The view the hover event has been dispatched to. 19962 * @param event The MotionEvent object containing full information about 19963 * the event. 19964 * @return True if the listener has consumed the event, false otherwise. 19965 */ 19966 boolean onHover(View v, MotionEvent event); 19967 } 19968 19969 /** 19970 * Interface definition for a callback to be invoked when a generic motion event is 19971 * dispatched to this view. The callback will be invoked before the generic motion 19972 * event is given to the view. 19973 */ 19974 public interface OnGenericMotionListener { 19975 /** 19976 * Called when a generic motion event is dispatched to a view. This allows listeners to 19977 * get a chance to respond before the target view. 19978 * 19979 * @param v The view the generic motion event has been dispatched to. 19980 * @param event The MotionEvent object containing full information about 19981 * the event. 19982 * @return True if the listener has consumed the event, false otherwise. 19983 */ 19984 boolean onGenericMotion(View v, MotionEvent event); 19985 } 19986 19987 /** 19988 * Interface definition for a callback to be invoked when a view has been clicked and held. 19989 */ 19990 public interface OnLongClickListener { 19991 /** 19992 * Called when a view has been clicked and held. 19993 * 19994 * @param v The view that was clicked and held. 19995 * 19996 * @return true if the callback consumed the long click, false otherwise. 19997 */ 19998 boolean onLongClick(View v); 19999 } 20000 20001 /** 20002 * Interface definition for a callback to be invoked when a drag is being dispatched 20003 * to this view. The callback will be invoked before the hosting view's own 20004 * onDrag(event) method. If the listener wants to fall back to the hosting view's 20005 * onDrag(event) behavior, it should return 'false' from this callback. 20006 * 20007 * <div class="special reference"> 20008 * <h3>Developer Guides</h3> 20009 * <p>For a guide to implementing drag and drop features, read the 20010 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 20011 * </div> 20012 */ 20013 public interface OnDragListener { 20014 /** 20015 * Called when a drag event is dispatched to a view. This allows listeners 20016 * to get a chance to override base View behavior. 20017 * 20018 * @param v The View that received the drag event. 20019 * @param event The {@link android.view.DragEvent} object for the drag event. 20020 * @return {@code true} if the drag event was handled successfully, or {@code false} 20021 * if the drag event was not handled. Note that {@code false} will trigger the View 20022 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 20023 */ 20024 boolean onDrag(View v, DragEvent event); 20025 } 20026 20027 /** 20028 * Interface definition for a callback to be invoked when the focus state of 20029 * a view changed. 20030 */ 20031 public interface OnFocusChangeListener { 20032 /** 20033 * Called when the focus state of a view has changed. 20034 * 20035 * @param v The view whose state has changed. 20036 * @param hasFocus The new focus state of v. 20037 */ 20038 void onFocusChange(View v, boolean hasFocus); 20039 } 20040 20041 /** 20042 * Interface definition for a callback to be invoked when a view is clicked. 20043 */ 20044 public interface OnClickListener { 20045 /** 20046 * Called when a view has been clicked. 20047 * 20048 * @param v The view that was clicked. 20049 */ 20050 void onClick(View v); 20051 } 20052 20053 /** 20054 * Interface definition for a callback to be invoked when the context menu 20055 * for this view is being built. 20056 */ 20057 public interface OnCreateContextMenuListener { 20058 /** 20059 * Called when the context menu for this view is being built. It is not 20060 * safe to hold onto the menu after this method returns. 20061 * 20062 * @param menu The context menu that is being built 20063 * @param v The view for which the context menu is being built 20064 * @param menuInfo Extra information about the item for which the 20065 * context menu should be shown. This information will vary 20066 * depending on the class of v. 20067 */ 20068 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 20069 } 20070 20071 /** 20072 * Interface definition for a callback to be invoked when the status bar changes 20073 * visibility. This reports <strong>global</strong> changes to the system UI 20074 * state, not what the application is requesting. 20075 * 20076 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 20077 */ 20078 public interface OnSystemUiVisibilityChangeListener { 20079 /** 20080 * Called when the status bar changes visibility because of a call to 20081 * {@link View#setSystemUiVisibility(int)}. 20082 * 20083 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 20084 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}. 20085 * This tells you the <strong>global</strong> state of these UI visibility 20086 * flags, not what your app is currently applying. 20087 */ 20088 public void onSystemUiVisibilityChange(int visibility); 20089 } 20090 20091 /** 20092 * Interface definition for a callback to be invoked when this view is attached 20093 * or detached from its window. 20094 */ 20095 public interface OnAttachStateChangeListener { 20096 /** 20097 * Called when the view is attached to a window. 20098 * @param v The view that was attached 20099 */ 20100 public void onViewAttachedToWindow(View v); 20101 /** 20102 * Called when the view is detached from a window. 20103 * @param v The view that was detached 20104 */ 20105 public void onViewDetachedFromWindow(View v); 20106 } 20107 20108 /** 20109 * Listener for applying window insets on a view in a custom way. 20110 * 20111 * <p>Apps may choose to implement this interface if they want to apply custom policy 20112 * to the way that window insets are treated for a view. If an OnApplyWindowInsetsListener 20113 * is set, its 20114 * {@link OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) onApplyWindowInsets} 20115 * method will be called instead of the View's own 20116 * {@link #onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. The listener 20117 * may optionally call the parameter View's <code>onApplyWindowInsets</code> method to apply 20118 * the View's normal behavior as part of its own.</p> 20119 */ 20120 public interface OnApplyWindowInsetsListener { 20121 /** 20122 * When {@link View#setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener) set} 20123 * on a View, this listener method will be called instead of the view's own 20124 * {@link View#onApplyWindowInsets(WindowInsets) onApplyWindowInsets} method. 20125 * 20126 * @param v The view applying window insets 20127 * @param insets The insets to apply 20128 * @return The insets supplied, minus any insets that were consumed 20129 */ 20130 public WindowInsets onApplyWindowInsets(View v, WindowInsets insets); 20131 } 20132 20133 private final class UnsetPressedState implements Runnable { 20134 @Override 20135 public void run() { 20136 setPressed(false); 20137 } 20138 } 20139 20140 /** 20141 * Base class for derived classes that want to save and restore their own 20142 * state in {@link android.view.View#onSaveInstanceState()}. 20143 */ 20144 public static class BaseSavedState extends AbsSavedState { 20145 /** 20146 * Constructor used when reading from a parcel. Reads the state of the superclass. 20147 * 20148 * @param source 20149 */ 20150 public BaseSavedState(Parcel source) { 20151 super(source); 20152 } 20153 20154 /** 20155 * Constructor called by derived classes when creating their SavedState objects 20156 * 20157 * @param superState The state of the superclass of this view 20158 */ 20159 public BaseSavedState(Parcelable superState) { 20160 super(superState); 20161 } 20162 20163 public static final Parcelable.Creator<BaseSavedState> CREATOR = 20164 new Parcelable.Creator<BaseSavedState>() { 20165 public BaseSavedState createFromParcel(Parcel in) { 20166 return new BaseSavedState(in); 20167 } 20168 20169 public BaseSavedState[] newArray(int size) { 20170 return new BaseSavedState[size]; 20171 } 20172 }; 20173 } 20174 20175 /** 20176 * A set of information given to a view when it is attached to its parent 20177 * window. 20178 */ 20179 final static class AttachInfo { 20180 interface Callbacks { 20181 void playSoundEffect(int effectId); 20182 boolean performHapticFeedback(int effectId, boolean always); 20183 } 20184 20185 /** 20186 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 20187 * to a Handler. This class contains the target (View) to invalidate and 20188 * the coordinates of the dirty rectangle. 20189 * 20190 * For performance purposes, this class also implements a pool of up to 20191 * POOL_LIMIT objects that get reused. This reduces memory allocations 20192 * whenever possible. 20193 */ 20194 static class InvalidateInfo { 20195 private static final int POOL_LIMIT = 10; 20196 20197 private static final SynchronizedPool<InvalidateInfo> sPool = 20198 new SynchronizedPool<InvalidateInfo>(POOL_LIMIT); 20199 20200 View target; 20201 20202 int left; 20203 int top; 20204 int right; 20205 int bottom; 20206 20207 public static InvalidateInfo obtain() { 20208 InvalidateInfo instance = sPool.acquire(); 20209 return (instance != null) ? instance : new InvalidateInfo(); 20210 } 20211 20212 public void recycle() { 20213 target = null; 20214 sPool.release(this); 20215 } 20216 } 20217 20218 final IWindowSession mSession; 20219 20220 final IWindow mWindow; 20221 20222 final IBinder mWindowToken; 20223 20224 final Display mDisplay; 20225 20226 final Callbacks mRootCallbacks; 20227 20228 IWindowId mIWindowId; 20229 WindowId mWindowId; 20230 20231 /** 20232 * The top view of the hierarchy. 20233 */ 20234 View mRootView; 20235 20236 IBinder mPanelParentWindowToken; 20237 20238 boolean mHardwareAccelerated; 20239 boolean mHardwareAccelerationRequested; 20240 HardwareRenderer mHardwareRenderer; 20241 List<RenderNode> mPendingAnimatingRenderNodes; 20242 20243 /** 20244 * The state of the display to which the window is attached, as reported 20245 * by {@link Display#getState()}. Note that the display state constants 20246 * declared by {@link Display} do not exactly line up with the screen state 20247 * constants declared by {@link View} (there are more display states than 20248 * screen states). 20249 */ 20250 int mDisplayState = Display.STATE_UNKNOWN; 20251 20252 /** 20253 * Scale factor used by the compatibility mode 20254 */ 20255 float mApplicationScale; 20256 20257 /** 20258 * Indicates whether the application is in compatibility mode 20259 */ 20260 boolean mScalingRequired; 20261 20262 /** 20263 * If set, ViewRootImpl doesn't use its lame animation for when the window resizes. 20264 */ 20265 boolean mTurnOffWindowResizeAnim; 20266 20267 /** 20268 * Left position of this view's window 20269 */ 20270 int mWindowLeft; 20271 20272 /** 20273 * Top position of this view's window 20274 */ 20275 int mWindowTop; 20276 20277 /** 20278 * Indicates whether views need to use 32-bit drawing caches 20279 */ 20280 boolean mUse32BitDrawingCache; 20281 20282 /** 20283 * For windows that are full-screen but using insets to layout inside 20284 * of the screen areas, these are the current insets to appear inside 20285 * the overscan area of the display. 20286 */ 20287 final Rect mOverscanInsets = new Rect(); 20288 20289 /** 20290 * For windows that are full-screen but using insets to layout inside 20291 * of the screen decorations, these are the current insets for the 20292 * content of the window. 20293 */ 20294 final Rect mContentInsets = new Rect(); 20295 20296 /** 20297 * For windows that are full-screen but using insets to layout inside 20298 * of the screen decorations, these are the current insets for the 20299 * actual visible parts of the window. 20300 */ 20301 final Rect mVisibleInsets = new Rect(); 20302 20303 /** 20304 * For windows that are full-screen but using insets to layout inside 20305 * of the screen decorations, these are the current insets for the 20306 * stable system windows. 20307 */ 20308 final Rect mStableInsets = new Rect(); 20309 20310 /** 20311 * The internal insets given by this window. This value is 20312 * supplied by the client (through 20313 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 20314 * be given to the window manager when changed to be used in laying 20315 * out windows behind it. 20316 */ 20317 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 20318 = new ViewTreeObserver.InternalInsetsInfo(); 20319 20320 /** 20321 * Set to true when mGivenInternalInsets is non-empty. 20322 */ 20323 boolean mHasNonEmptyGivenInternalInsets; 20324 20325 /** 20326 * All views in the window's hierarchy that serve as scroll containers, 20327 * used to determine if the window can be resized or must be panned 20328 * to adjust for a soft input area. 20329 */ 20330 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 20331 20332 final KeyEvent.DispatcherState mKeyDispatchState 20333 = new KeyEvent.DispatcherState(); 20334 20335 /** 20336 * Indicates whether the view's window currently has the focus. 20337 */ 20338 boolean mHasWindowFocus; 20339 20340 /** 20341 * The current visibility of the window. 20342 */ 20343 int mWindowVisibility; 20344 20345 /** 20346 * Indicates the time at which drawing started to occur. 20347 */ 20348 long mDrawingTime; 20349 20350 /** 20351 * Indicates whether or not ignoring the DIRTY_MASK flags. 20352 */ 20353 boolean mIgnoreDirtyState; 20354 20355 /** 20356 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 20357 * to avoid clearing that flag prematurely. 20358 */ 20359 boolean mSetIgnoreDirtyState = false; 20360 20361 /** 20362 * Indicates whether the view's window is currently in touch mode. 20363 */ 20364 boolean mInTouchMode; 20365 20366 /** 20367 * Indicates whether the view has requested unbuffered input dispatching for the current 20368 * event stream. 20369 */ 20370 boolean mUnbufferedDispatchRequested; 20371 20372 /** 20373 * Indicates that ViewAncestor should trigger a global layout change 20374 * the next time it performs a traversal 20375 */ 20376 boolean mRecomputeGlobalAttributes; 20377 20378 /** 20379 * Always report new attributes at next traversal. 20380 */ 20381 boolean mForceReportNewAttributes; 20382 20383 /** 20384 * Set during a traveral if any views want to keep the screen on. 20385 */ 20386 boolean mKeepScreenOn; 20387 20388 /** 20389 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 20390 */ 20391 int mSystemUiVisibility; 20392 20393 /** 20394 * Hack to force certain system UI visibility flags to be cleared. 20395 */ 20396 int mDisabledSystemUiVisibility; 20397 20398 /** 20399 * Last global system UI visibility reported by the window manager. 20400 */ 20401 int mGlobalSystemUiVisibility; 20402 20403 /** 20404 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 20405 * attached. 20406 */ 20407 boolean mHasSystemUiListeners; 20408 20409 /** 20410 * Set if the window has requested to extend into the overscan region 20411 * via WindowManager.LayoutParams.FLAG_LAYOUT_IN_OVERSCAN. 20412 */ 20413 boolean mOverscanRequested; 20414 20415 /** 20416 * Set if the visibility of any views has changed. 20417 */ 20418 boolean mViewVisibilityChanged; 20419 20420 /** 20421 * Set to true if a view has been scrolled. 20422 */ 20423 boolean mViewScrollChanged; 20424 20425 /** 20426 * Set to true if high contrast mode enabled 20427 */ 20428 boolean mHighContrastText; 20429 20430 /** 20431 * Global to the view hierarchy used as a temporary for dealing with 20432 * x/y points in the transparent region computations. 20433 */ 20434 final int[] mTransparentLocation = new int[2]; 20435 20436 /** 20437 * Global to the view hierarchy used as a temporary for dealing with 20438 * x/y points in the ViewGroup.invalidateChild implementation. 20439 */ 20440 final int[] mInvalidateChildLocation = new int[2]; 20441 20442 /** 20443 * Global to the view hierarchy used as a temporary for dealng with 20444 * computing absolute on-screen location. 20445 */ 20446 final int[] mTmpLocation = new int[2]; 20447 20448 /** 20449 * Global to the view hierarchy used as a temporary for dealing with 20450 * x/y location when view is transformed. 20451 */ 20452 final float[] mTmpTransformLocation = new float[2]; 20453 20454 /** 20455 * The view tree observer used to dispatch global events like 20456 * layout, pre-draw, touch mode change, etc. 20457 */ 20458 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 20459 20460 /** 20461 * A Canvas used by the view hierarchy to perform bitmap caching. 20462 */ 20463 Canvas mCanvas; 20464 20465 /** 20466 * The view root impl. 20467 */ 20468 final ViewRootImpl mViewRootImpl; 20469 20470 /** 20471 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 20472 * handler can be used to pump events in the UI events queue. 20473 */ 20474 final Handler mHandler; 20475 20476 /** 20477 * Temporary for use in computing invalidate rectangles while 20478 * calling up the hierarchy. 20479 */ 20480 final Rect mTmpInvalRect = new Rect(); 20481 20482 /** 20483 * Temporary for use in computing hit areas with transformed views 20484 */ 20485 final RectF mTmpTransformRect = new RectF(); 20486 20487 /** 20488 * Temporary for use in computing hit areas with transformed views 20489 */ 20490 final RectF mTmpTransformRect1 = new RectF(); 20491 20492 /** 20493 * Temporary list of rectanges. 20494 */ 20495 final List<RectF> mTmpRectList = new ArrayList<>(); 20496 20497 /** 20498 * Temporary for use in transforming invalidation rect 20499 */ 20500 final Matrix mTmpMatrix = new Matrix(); 20501 20502 /** 20503 * Temporary for use in transforming invalidation rect 20504 */ 20505 final Transformation mTmpTransformation = new Transformation(); 20506 20507 /** 20508 * Temporary for use in querying outlines from OutlineProviders 20509 */ 20510 final Outline mTmpOutline = new Outline(); 20511 20512 /** 20513 * Temporary list for use in collecting focusable descendents of a view. 20514 */ 20515 final ArrayList<View> mTempArrayList = new ArrayList<View>(24); 20516 20517 /** 20518 * The id of the window for accessibility purposes. 20519 */ 20520 int mAccessibilityWindowId = AccessibilityNodeInfo.UNDEFINED_ITEM_ID; 20521 20522 /** 20523 * Flags related to accessibility processing. 20524 * 20525 * @see AccessibilityNodeInfo#FLAG_INCLUDE_NOT_IMPORTANT_VIEWS 20526 * @see AccessibilityNodeInfo#FLAG_REPORT_VIEW_IDS 20527 */ 20528 int mAccessibilityFetchFlags; 20529 20530 /** 20531 * The drawable for highlighting accessibility focus. 20532 */ 20533 Drawable mAccessibilityFocusDrawable; 20534 20535 /** 20536 * Show where the margins, bounds and layout bounds are for each view. 20537 */ 20538 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false); 20539 20540 /** 20541 * Point used to compute visible regions. 20542 */ 20543 final Point mPoint = new Point(); 20544 20545 /** 20546 * Used to track which View originated a requestLayout() call, used when 20547 * requestLayout() is called during layout. 20548 */ 20549 View mViewRequestingLayout; 20550 20551 /** 20552 * Creates a new set of attachment information with the specified 20553 * events handler and thread. 20554 * 20555 * @param handler the events handler the view must use 20556 */ 20557 AttachInfo(IWindowSession session, IWindow window, Display display, 20558 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) { 20559 mSession = session; 20560 mWindow = window; 20561 mWindowToken = window.asBinder(); 20562 mDisplay = display; 20563 mViewRootImpl = viewRootImpl; 20564 mHandler = handler; 20565 mRootCallbacks = effectPlayer; 20566 } 20567 } 20568 20569 /** 20570 * <p>ScrollabilityCache holds various fields used by a View when scrolling 20571 * is supported. This avoids keeping too many unused fields in most 20572 * instances of View.</p> 20573 */ 20574 private static class ScrollabilityCache implements Runnable { 20575 20576 /** 20577 * Scrollbars are not visible 20578 */ 20579 public static final int OFF = 0; 20580 20581 /** 20582 * Scrollbars are visible 20583 */ 20584 public static final int ON = 1; 20585 20586 /** 20587 * Scrollbars are fading away 20588 */ 20589 public static final int FADING = 2; 20590 20591 public boolean fadeScrollBars; 20592 20593 public int fadingEdgeLength; 20594 public int scrollBarDefaultDelayBeforeFade; 20595 public int scrollBarFadeDuration; 20596 20597 public int scrollBarSize; 20598 public ScrollBarDrawable scrollBar; 20599 public float[] interpolatorValues; 20600 public View host; 20601 20602 public final Paint paint; 20603 public final Matrix matrix; 20604 public Shader shader; 20605 20606 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 20607 20608 private static final float[] OPAQUE = { 255 }; 20609 private static final float[] TRANSPARENT = { 0.0f }; 20610 20611 /** 20612 * When fading should start. This time moves into the future every time 20613 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 20614 */ 20615 public long fadeStartTime; 20616 20617 20618 /** 20619 * The current state of the scrollbars: ON, OFF, or FADING 20620 */ 20621 public int state = OFF; 20622 20623 private int mLastColor; 20624 20625 public ScrollabilityCache(ViewConfiguration configuration, View host) { 20626 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 20627 scrollBarSize = configuration.getScaledScrollBarSize(); 20628 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 20629 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 20630 20631 paint = new Paint(); 20632 matrix = new Matrix(); 20633 // use use a height of 1, and then wack the matrix each time we 20634 // actually use it. 20635 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20636 paint.setShader(shader); 20637 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20638 20639 this.host = host; 20640 } 20641 20642 public void setFadeColor(int color) { 20643 if (color != mLastColor) { 20644 mLastColor = color; 20645 20646 if (color != 0) { 20647 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 20648 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 20649 paint.setShader(shader); 20650 // Restore the default transfer mode (src_over) 20651 paint.setXfermode(null); 20652 } else { 20653 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 20654 paint.setShader(shader); 20655 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 20656 } 20657 } 20658 } 20659 20660 public void run() { 20661 long now = AnimationUtils.currentAnimationTimeMillis(); 20662 if (now >= fadeStartTime) { 20663 20664 // the animation fades the scrollbars out by changing 20665 // the opacity (alpha) from fully opaque to fully 20666 // transparent 20667 int nextFrame = (int) now; 20668 int framesCount = 0; 20669 20670 Interpolator interpolator = scrollBarInterpolator; 20671 20672 // Start opaque 20673 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 20674 20675 // End transparent 20676 nextFrame += scrollBarFadeDuration; 20677 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 20678 20679 state = FADING; 20680 20681 // Kick off the fade animation 20682 host.invalidate(true); 20683 } 20684 } 20685 } 20686 20687 /** 20688 * Resuable callback for sending 20689 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 20690 */ 20691 private class SendViewScrolledAccessibilityEvent implements Runnable { 20692 public volatile boolean mIsPending; 20693 20694 public void run() { 20695 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 20696 mIsPending = false; 20697 } 20698 } 20699 20700 /** 20701 * <p> 20702 * This class represents a delegate that can be registered in a {@link View} 20703 * to enhance accessibility support via composition rather via inheritance. 20704 * It is specifically targeted to widget developers that extend basic View 20705 * classes i.e. classes in package android.view, that would like their 20706 * applications to be backwards compatible. 20707 * </p> 20708 * <div class="special reference"> 20709 * <h3>Developer Guides</h3> 20710 * <p>For more information about making applications accessible, read the 20711 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a> 20712 * developer guide.</p> 20713 * </div> 20714 * <p> 20715 * A scenario in which a developer would like to use an accessibility delegate 20716 * is overriding a method introduced in a later API version then the minimal API 20717 * version supported by the application. For example, the method 20718 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 20719 * in API version 4 when the accessibility APIs were first introduced. If a 20720 * developer would like his application to run on API version 4 devices (assuming 20721 * all other APIs used by the application are version 4 or lower) and take advantage 20722 * of this method, instead of overriding the method which would break the application's 20723 * backwards compatibility, he can override the corresponding method in this 20724 * delegate and register the delegate in the target View if the API version of 20725 * the system is high enough i.e. the API version is same or higher to the API 20726 * version that introduced 20727 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 20728 * </p> 20729 * <p> 20730 * Here is an example implementation: 20731 * </p> 20732 * <code><pre><p> 20733 * if (Build.VERSION.SDK_INT >= 14) { 20734 * // If the API version is equal of higher than the version in 20735 * // which onInitializeAccessibilityNodeInfo was introduced we 20736 * // register a delegate with a customized implementation. 20737 * View view = findViewById(R.id.view_id); 20738 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 20739 * public void onInitializeAccessibilityNodeInfo(View host, 20740 * AccessibilityNodeInfo info) { 20741 * // Let the default implementation populate the info. 20742 * super.onInitializeAccessibilityNodeInfo(host, info); 20743 * // Set some other information. 20744 * info.setEnabled(host.isEnabled()); 20745 * } 20746 * }); 20747 * } 20748 * </code></pre></p> 20749 * <p> 20750 * This delegate contains methods that correspond to the accessibility methods 20751 * in View. If a delegate has been specified the implementation in View hands 20752 * off handling to the corresponding method in this delegate. The default 20753 * implementation the delegate methods behaves exactly as the corresponding 20754 * method in View for the case of no accessibility delegate been set. Hence, 20755 * to customize the behavior of a View method, clients can override only the 20756 * corresponding delegate method without altering the behavior of the rest 20757 * accessibility related methods of the host view. 20758 * </p> 20759 */ 20760 public static class AccessibilityDelegate { 20761 20762 /** 20763 * Sends an accessibility event of the given type. If accessibility is not 20764 * enabled this method has no effect. 20765 * <p> 20766 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 20767 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 20768 * been set. 20769 * </p> 20770 * 20771 * @param host The View hosting the delegate. 20772 * @param eventType The type of the event to send. 20773 * 20774 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 20775 */ 20776 public void sendAccessibilityEvent(View host, int eventType) { 20777 host.sendAccessibilityEventInternal(eventType); 20778 } 20779 20780 /** 20781 * Performs the specified accessibility action on the view. For 20782 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 20783 * <p> 20784 * The default implementation behaves as 20785 * {@link View#performAccessibilityAction(int, Bundle) 20786 * View#performAccessibilityAction(int, Bundle)} for the case of 20787 * no accessibility delegate been set. 20788 * </p> 20789 * 20790 * @param action The action to perform. 20791 * @return Whether the action was performed. 20792 * 20793 * @see View#performAccessibilityAction(int, Bundle) 20794 * View#performAccessibilityAction(int, Bundle) 20795 */ 20796 public boolean performAccessibilityAction(View host, int action, Bundle args) { 20797 return host.performAccessibilityActionInternal(action, args); 20798 } 20799 20800 /** 20801 * Sends an accessibility event. This method behaves exactly as 20802 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 20803 * empty {@link AccessibilityEvent} and does not perform a check whether 20804 * accessibility is enabled. 20805 * <p> 20806 * The default implementation behaves as 20807 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20808 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 20809 * the case of no accessibility delegate been set. 20810 * </p> 20811 * 20812 * @param host The View hosting the delegate. 20813 * @param event The event to send. 20814 * 20815 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20816 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 20817 */ 20818 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 20819 host.sendAccessibilityEventUncheckedInternal(event); 20820 } 20821 20822 /** 20823 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 20824 * to its children for adding their text content to the event. 20825 * <p> 20826 * The default implementation behaves as 20827 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20828 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 20829 * the case of no accessibility delegate been set. 20830 * </p> 20831 * 20832 * @param host The View hosting the delegate. 20833 * @param event The event. 20834 * @return True if the event population was completed. 20835 * 20836 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20837 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 20838 */ 20839 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20840 return host.dispatchPopulateAccessibilityEventInternal(event); 20841 } 20842 20843 /** 20844 * Gives a chance to the host View to populate the accessibility event with its 20845 * text content. 20846 * <p> 20847 * The default implementation behaves as 20848 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 20849 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 20850 * the case of no accessibility delegate been set. 20851 * </p> 20852 * 20853 * @param host The View hosting the delegate. 20854 * @param event The accessibility event which to populate. 20855 * 20856 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 20857 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 20858 */ 20859 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 20860 host.onPopulateAccessibilityEventInternal(event); 20861 } 20862 20863 /** 20864 * Initializes an {@link AccessibilityEvent} with information about the 20865 * the host View which is the event source. 20866 * <p> 20867 * The default implementation behaves as 20868 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 20869 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 20870 * the case of no accessibility delegate been set. 20871 * </p> 20872 * 20873 * @param host The View hosting the delegate. 20874 * @param event The event to initialize. 20875 * 20876 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 20877 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 20878 */ 20879 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 20880 host.onInitializeAccessibilityEventInternal(event); 20881 } 20882 20883 /** 20884 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 20885 * <p> 20886 * The default implementation behaves as 20887 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20888 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 20889 * the case of no accessibility delegate been set. 20890 * </p> 20891 * 20892 * @param host The View hosting the delegate. 20893 * @param info The instance to initialize. 20894 * 20895 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20896 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 20897 */ 20898 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 20899 host.onInitializeAccessibilityNodeInfoInternal(info); 20900 } 20901 20902 /** 20903 * Called when a child of the host View has requested sending an 20904 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 20905 * to augment the event. 20906 * <p> 20907 * The default implementation behaves as 20908 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20909 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 20910 * the case of no accessibility delegate been set. 20911 * </p> 20912 * 20913 * @param host The View hosting the delegate. 20914 * @param child The child which requests sending the event. 20915 * @param event The event to be sent. 20916 * @return True if the event should be sent 20917 * 20918 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20919 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 20920 */ 20921 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 20922 AccessibilityEvent event) { 20923 return host.onRequestSendAccessibilityEventInternal(child, event); 20924 } 20925 20926 /** 20927 * Gets the provider for managing a virtual view hierarchy rooted at this View 20928 * and reported to {@link android.accessibilityservice.AccessibilityService}s 20929 * that explore the window content. 20930 * <p> 20931 * The default implementation behaves as 20932 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 20933 * the case of no accessibility delegate been set. 20934 * </p> 20935 * 20936 * @return The provider. 20937 * 20938 * @see AccessibilityNodeProvider 20939 */ 20940 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 20941 return null; 20942 } 20943 20944 /** 20945 * Returns an {@link AccessibilityNodeInfo} representing the host view from the 20946 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 20947 * This method is responsible for obtaining an accessibility node info from a 20948 * pool of reusable instances and calling 20949 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on the host 20950 * view to initialize the former. 20951 * <p> 20952 * <strong>Note:</strong> The client is responsible for recycling the obtained 20953 * instance by calling {@link AccessibilityNodeInfo#recycle()} to minimize object 20954 * creation. 20955 * </p> 20956 * <p> 20957 * The default implementation behaves as 20958 * {@link View#createAccessibilityNodeInfo() View#createAccessibilityNodeInfo()} for 20959 * the case of no accessibility delegate been set. 20960 * </p> 20961 * @return A populated {@link AccessibilityNodeInfo}. 20962 * 20963 * @see AccessibilityNodeInfo 20964 * 20965 * @hide 20966 */ 20967 public AccessibilityNodeInfo createAccessibilityNodeInfo(View host) { 20968 return host.createAccessibilityNodeInfoInternal(); 20969 } 20970 } 20971 20972 private class MatchIdPredicate implements Predicate<View> { 20973 public int mId; 20974 20975 @Override 20976 public boolean apply(View view) { 20977 return (view.mID == mId); 20978 } 20979 } 20980 20981 private class MatchLabelForPredicate implements Predicate<View> { 20982 private int mLabeledId; 20983 20984 @Override 20985 public boolean apply(View view) { 20986 return (view.mLabelForId == mLabeledId); 20987 } 20988 } 20989 20990 private class SendViewStateChangedAccessibilityEvent implements Runnable { 20991 private int mChangeTypes = 0; 20992 private boolean mPosted; 20993 private boolean mPostedWithDelay; 20994 private long mLastEventTimeMillis; 20995 20996 @Override 20997 public void run() { 20998 mPosted = false; 20999 mPostedWithDelay = false; 21000 mLastEventTimeMillis = SystemClock.uptimeMillis(); 21001 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 21002 final AccessibilityEvent event = AccessibilityEvent.obtain(); 21003 event.setEventType(AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED); 21004 event.setContentChangeTypes(mChangeTypes); 21005 sendAccessibilityEventUnchecked(event); 21006 } 21007 mChangeTypes = 0; 21008 } 21009 21010 public void runOrPost(int changeType) { 21011 mChangeTypes |= changeType; 21012 21013 // If this is a live region or the child of a live region, collect 21014 // all events from this frame and send them on the next frame. 21015 if (inLiveRegion()) { 21016 // If we're already posted with a delay, remove that. 21017 if (mPostedWithDelay) { 21018 removeCallbacks(this); 21019 mPostedWithDelay = false; 21020 } 21021 // Only post if we're not already posted. 21022 if (!mPosted) { 21023 post(this); 21024 mPosted = true; 21025 } 21026 return; 21027 } 21028 21029 if (mPosted) { 21030 return; 21031 } 21032 21033 final long timeSinceLastMillis = SystemClock.uptimeMillis() - mLastEventTimeMillis; 21034 final long minEventIntevalMillis = 21035 ViewConfiguration.getSendRecurringAccessibilityEventsInterval(); 21036 if (timeSinceLastMillis >= minEventIntevalMillis) { 21037 removeCallbacks(this); 21038 run(); 21039 } else { 21040 postDelayed(this, minEventIntevalMillis - timeSinceLastMillis); 21041 mPostedWithDelay = true; 21042 } 21043 } 21044 } 21045 21046 private boolean inLiveRegion() { 21047 if (getAccessibilityLiveRegion() != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21048 return true; 21049 } 21050 21051 ViewParent parent = getParent(); 21052 while (parent instanceof View) { 21053 if (((View) parent).getAccessibilityLiveRegion() 21054 != View.ACCESSIBILITY_LIVE_REGION_NONE) { 21055 return true; 21056 } 21057 parent = parent.getParent(); 21058 } 21059 21060 return false; 21061 } 21062 21063 /** 21064 * Dump all private flags in readable format, useful for documentation and 21065 * sanity checking. 21066 */ 21067 private static void dumpFlags() { 21068 final HashMap<String, String> found = Maps.newHashMap(); 21069 try { 21070 for (Field field : View.class.getDeclaredFields()) { 21071 final int modifiers = field.getModifiers(); 21072 if (Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers)) { 21073 if (field.getType().equals(int.class)) { 21074 final int value = field.getInt(null); 21075 dumpFlag(found, field.getName(), value); 21076 } else if (field.getType().equals(int[].class)) { 21077 final int[] values = (int[]) field.get(null); 21078 for (int i = 0; i < values.length; i++) { 21079 dumpFlag(found, field.getName() + "[" + i + "]", values[i]); 21080 } 21081 } 21082 } 21083 } 21084 } catch (IllegalAccessException e) { 21085 throw new RuntimeException(e); 21086 } 21087 21088 final ArrayList<String> keys = Lists.newArrayList(); 21089 keys.addAll(found.keySet()); 21090 Collections.sort(keys); 21091 for (String key : keys) { 21092 Log.d(VIEW_LOG_TAG, found.get(key)); 21093 } 21094 } 21095 21096 private static void dumpFlag(HashMap<String, String> found, String name, int value) { 21097 // Sort flags by prefix, then by bits, always keeping unique keys 21098 final String bits = String.format("%32s", Integer.toBinaryString(value)).replace('0', ' '); 21099 final int prefix = name.indexOf('_'); 21100 final String key = (prefix > 0 ? name.substring(0, prefix) : name) + bits + name; 21101 final String output = bits + " " + name; 21102 found.put(key, output); 21103 } 21104} 21105