View.java revision edc900528937cd03f0d3a94fdf73d019324a2054
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.content.ClipData; 20import android.content.Context; 21import android.content.res.Configuration; 22import android.content.res.Resources; 23import android.content.res.TypedArray; 24import android.graphics.Bitmap; 25import android.graphics.Camera; 26import android.graphics.Canvas; 27import android.graphics.Insets; 28import android.graphics.Interpolator; 29import android.graphics.LinearGradient; 30import android.graphics.Matrix; 31import android.graphics.Paint; 32import android.graphics.PixelFormat; 33import android.graphics.Point; 34import android.graphics.PorterDuff; 35import android.graphics.PorterDuffXfermode; 36import android.graphics.Rect; 37import android.graphics.RectF; 38import android.graphics.Region; 39import android.graphics.Shader; 40import android.graphics.drawable.ColorDrawable; 41import android.graphics.drawable.Drawable; 42import android.hardware.display.DisplayManagerGlobal; 43import android.os.Bundle; 44import android.os.Handler; 45import android.os.IBinder; 46import android.os.Parcel; 47import android.os.Parcelable; 48import android.os.RemoteException; 49import android.os.SystemClock; 50import android.os.SystemProperties; 51import android.text.TextUtils; 52import android.util.AttributeSet; 53import android.util.FloatProperty; 54import android.util.Log; 55import android.util.Pool; 56import android.util.Poolable; 57import android.util.PoolableManager; 58import android.util.Pools; 59import android.util.Property; 60import android.util.SparseArray; 61import android.util.TypedValue; 62import android.view.ContextMenu.ContextMenuInfo; 63import android.view.AccessibilityIterators.TextSegmentIterator; 64import android.view.AccessibilityIterators.CharacterTextSegmentIterator; 65import android.view.AccessibilityIterators.WordTextSegmentIterator; 66import android.view.AccessibilityIterators.ParagraphTextSegmentIterator; 67import android.view.accessibility.AccessibilityEvent; 68import android.view.accessibility.AccessibilityEventSource; 69import android.view.accessibility.AccessibilityManager; 70import android.view.accessibility.AccessibilityNodeInfo; 71import android.view.accessibility.AccessibilityNodeProvider; 72import android.view.animation.Animation; 73import android.view.animation.AnimationUtils; 74import android.view.animation.Transformation; 75import android.view.inputmethod.EditorInfo; 76import android.view.inputmethod.InputConnection; 77import android.view.inputmethod.InputMethodManager; 78import android.widget.ScrollBarDrawable; 79 80import static android.os.Build.VERSION_CODES.*; 81import static java.lang.Math.max; 82 83import com.android.internal.R; 84import com.android.internal.util.Predicate; 85import com.android.internal.view.menu.MenuBuilder; 86import com.google.android.collect.Lists; 87import com.google.android.collect.Maps; 88 89import java.lang.ref.WeakReference; 90import java.lang.reflect.Field; 91import java.lang.reflect.InvocationTargetException; 92import java.lang.reflect.Method; 93import java.lang.reflect.Modifier; 94import java.util.ArrayList; 95import java.util.Arrays; 96import java.util.Collections; 97import java.util.HashMap; 98import java.util.Locale; 99import java.util.concurrent.CopyOnWriteArrayList; 100import java.util.concurrent.atomic.AtomicInteger; 101 102/** 103 * <p> 104 * This class represents the basic building block for user interface components. A View 105 * occupies a rectangular area on the screen and is responsible for drawing and 106 * event handling. View is the base class for <em>widgets</em>, which are 107 * used to create interactive UI components (buttons, text fields, etc.). The 108 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which 109 * are invisible containers that hold other Views (or other ViewGroups) and define 110 * their layout properties. 111 * </p> 112 * 113 * <div class="special reference"> 114 * <h3>Developer Guides</h3> 115 * <p>For information about using this class to develop your application's user interface, 116 * read the <a href="{@docRoot}guide/topics/ui/index.html">User Interface</a> developer guide. 117 * </div> 118 * 119 * <a name="Using"></a> 120 * <h3>Using Views</h3> 121 * <p> 122 * All of the views in a window are arranged in a single tree. You can add views 123 * either from code or by specifying a tree of views in one or more XML layout 124 * files. There are many specialized subclasses of views that act as controls or 125 * are capable of displaying text, images, or other content. 126 * </p> 127 * <p> 128 * Once you have created a tree of views, there are typically a few types of 129 * common operations you may wish to perform: 130 * <ul> 131 * <li><strong>Set properties:</strong> for example setting the text of a 132 * {@link android.widget.TextView}. The available properties and the methods 133 * that set them will vary among the different subclasses of views. Note that 134 * properties that are known at build time can be set in the XML layout 135 * files.</li> 136 * <li><strong>Set focus:</strong> The framework will handled moving focus in 137 * response to user input. To force focus to a specific view, call 138 * {@link #requestFocus}.</li> 139 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners 140 * that will be notified when something interesting happens to the view. For 141 * example, all views will let you set a listener to be notified when the view 142 * gains or loses focus. You can register such a listener using 143 * {@link #setOnFocusChangeListener(android.view.View.OnFocusChangeListener)}. 144 * Other view subclasses offer more specialized listeners. For example, a Button 145 * exposes a listener to notify clients when the button is clicked.</li> 146 * <li><strong>Set visibility:</strong> You can hide or show views using 147 * {@link #setVisibility(int)}.</li> 148 * </ul> 149 * </p> 150 * <p><em> 151 * Note: The Android framework is responsible for measuring, laying out and 152 * drawing views. You should not call methods that perform these actions on 153 * views yourself unless you are actually implementing a 154 * {@link android.view.ViewGroup}. 155 * </em></p> 156 * 157 * <a name="Lifecycle"></a> 158 * <h3>Implementing a Custom View</h3> 159 * 160 * <p> 161 * To implement a custom view, you will usually begin by providing overrides for 162 * some of the standard methods that the framework calls on all views. You do 163 * not need to override all of these methods. In fact, you can start by just 164 * overriding {@link #onDraw(android.graphics.Canvas)}. 165 * <table border="2" width="85%" align="center" cellpadding="5"> 166 * <thead> 167 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr> 168 * </thead> 169 * 170 * <tbody> 171 * <tr> 172 * <td rowspan="2">Creation</td> 173 * <td>Constructors</td> 174 * <td>There is a form of the constructor that are called when the view 175 * is created from code and a form that is called when the view is 176 * inflated from a layout file. The second form should parse and apply 177 * any attributes defined in the layout file. 178 * </td> 179 * </tr> 180 * <tr> 181 * <td><code>{@link #onFinishInflate()}</code></td> 182 * <td>Called after a view and all of its children has been inflated 183 * from XML.</td> 184 * </tr> 185 * 186 * <tr> 187 * <td rowspan="3">Layout</td> 188 * <td><code>{@link #onMeasure(int, int)}</code></td> 189 * <td>Called to determine the size requirements for this view and all 190 * of its children. 191 * </td> 192 * </tr> 193 * <tr> 194 * <td><code>{@link #onLayout(boolean, int, int, int, int)}</code></td> 195 * <td>Called when this view should assign a size and position to all 196 * of its children. 197 * </td> 198 * </tr> 199 * <tr> 200 * <td><code>{@link #onSizeChanged(int, int, int, int)}</code></td> 201 * <td>Called when the size of this view has changed. 202 * </td> 203 * </tr> 204 * 205 * <tr> 206 * <td>Drawing</td> 207 * <td><code>{@link #onDraw(android.graphics.Canvas)}</code></td> 208 * <td>Called when the view should render its content. 209 * </td> 210 * </tr> 211 * 212 * <tr> 213 * <td rowspan="4">Event processing</td> 214 * <td><code>{@link #onKeyDown(int, KeyEvent)}</code></td> 215 * <td>Called when a new hardware key event occurs. 216 * </td> 217 * </tr> 218 * <tr> 219 * <td><code>{@link #onKeyUp(int, KeyEvent)}</code></td> 220 * <td>Called when a hardware key up event occurs. 221 * </td> 222 * </tr> 223 * <tr> 224 * <td><code>{@link #onTrackballEvent(MotionEvent)}</code></td> 225 * <td>Called when a trackball motion event occurs. 226 * </td> 227 * </tr> 228 * <tr> 229 * <td><code>{@link #onTouchEvent(MotionEvent)}</code></td> 230 * <td>Called when a touch screen motion event occurs. 231 * </td> 232 * </tr> 233 * 234 * <tr> 235 * <td rowspan="2">Focus</td> 236 * <td><code>{@link #onFocusChanged(boolean, int, android.graphics.Rect)}</code></td> 237 * <td>Called when the view gains or loses focus. 238 * </td> 239 * </tr> 240 * 241 * <tr> 242 * <td><code>{@link #onWindowFocusChanged(boolean)}</code></td> 243 * <td>Called when the window containing the view gains or loses focus. 244 * </td> 245 * </tr> 246 * 247 * <tr> 248 * <td rowspan="3">Attaching</td> 249 * <td><code>{@link #onAttachedToWindow()}</code></td> 250 * <td>Called when the view is attached to a window. 251 * </td> 252 * </tr> 253 * 254 * <tr> 255 * <td><code>{@link #onDetachedFromWindow}</code></td> 256 * <td>Called when the view is detached from its window. 257 * </td> 258 * </tr> 259 * 260 * <tr> 261 * <td><code>{@link #onWindowVisibilityChanged(int)}</code></td> 262 * <td>Called when the visibility of the window containing the view 263 * has changed. 264 * </td> 265 * </tr> 266 * </tbody> 267 * 268 * </table> 269 * </p> 270 * 271 * <a name="IDs"></a> 272 * <h3>IDs</h3> 273 * Views may have an integer id associated with them. These ids are typically 274 * assigned in the layout XML files, and are used to find specific views within 275 * the view tree. A common pattern is to: 276 * <ul> 277 * <li>Define a Button in the layout file and assign it a unique ID. 278 * <pre> 279 * <Button 280 * android:id="@+id/my_button" 281 * android:layout_width="wrap_content" 282 * android:layout_height="wrap_content" 283 * android:text="@string/my_button_text"/> 284 * </pre></li> 285 * <li>From the onCreate method of an Activity, find the Button 286 * <pre class="prettyprint"> 287 * Button myButton = (Button) findViewById(R.id.my_button); 288 * </pre></li> 289 * </ul> 290 * <p> 291 * View IDs need not be unique throughout the tree, but it is good practice to 292 * ensure that they are at least unique within the part of the tree you are 293 * searching. 294 * </p> 295 * 296 * <a name="Position"></a> 297 * <h3>Position</h3> 298 * <p> 299 * The geometry of a view is that of a rectangle. A view has a location, 300 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and 301 * two dimensions, expressed as a width and a height. The unit for location 302 * and dimensions is the pixel. 303 * </p> 304 * 305 * <p> 306 * It is possible to retrieve the location of a view by invoking the methods 307 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X, 308 * coordinate of the rectangle representing the view. The latter returns the 309 * top, or Y, coordinate of the rectangle representing the view. These methods 310 * both return the location of the view relative to its parent. For instance, 311 * when getLeft() returns 20, that means the view is located 20 pixels to the 312 * right of the left edge of its direct parent. 313 * </p> 314 * 315 * <p> 316 * In addition, several convenience methods are offered to avoid unnecessary 317 * computations, namely {@link #getRight()} and {@link #getBottom()}. 318 * These methods return the coordinates of the right and bottom edges of the 319 * rectangle representing the view. For instance, calling {@link #getRight()} 320 * is similar to the following computation: <code>getLeft() + getWidth()</code> 321 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.) 322 * </p> 323 * 324 * <a name="SizePaddingMargins"></a> 325 * <h3>Size, padding and margins</h3> 326 * <p> 327 * The size of a view is expressed with a width and a height. A view actually 328 * possess two pairs of width and height values. 329 * </p> 330 * 331 * <p> 332 * The first pair is known as <em>measured width</em> and 333 * <em>measured height</em>. These dimensions define how big a view wants to be 334 * within its parent (see <a href="#Layout">Layout</a> for more details.) The 335 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()} 336 * and {@link #getMeasuredHeight()}. 337 * </p> 338 * 339 * <p> 340 * The second pair is simply known as <em>width</em> and <em>height</em>, or 341 * sometimes <em>drawing width</em> and <em>drawing height</em>. These 342 * dimensions define the actual size of the view on screen, at drawing time and 343 * after layout. These values may, but do not have to, be different from the 344 * measured width and height. The width and height can be obtained by calling 345 * {@link #getWidth()} and {@link #getHeight()}. 346 * </p> 347 * 348 * <p> 349 * To measure its dimensions, a view takes into account its padding. The padding 350 * is expressed in pixels for the left, top, right and bottom parts of the view. 351 * Padding can be used to offset the content of the view by a specific amount of 352 * pixels. For instance, a left padding of 2 will push the view's content by 353 * 2 pixels to the right of the left edge. Padding can be set using the 354 * {@link #setPadding(int, int, int, int)} or {@link #setPaddingRelative(int, int, int, int)} 355 * method and queried by calling {@link #getPaddingLeft()}, {@link #getPaddingTop()}, 356 * {@link #getPaddingRight()}, {@link #getPaddingBottom()}, {@link #getPaddingStart()}, 357 * {@link #getPaddingEnd()}. 358 * </p> 359 * 360 * <p> 361 * Even though a view can define a padding, it does not provide any support for 362 * margins. However, view groups provide such a support. Refer to 363 * {@link android.view.ViewGroup} and 364 * {@link android.view.ViewGroup.MarginLayoutParams} for further information. 365 * </p> 366 * 367 * <a name="Layout"></a> 368 * <h3>Layout</h3> 369 * <p> 370 * Layout is a two pass process: a measure pass and a layout pass. The measuring 371 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal 372 * of the view tree. Each view pushes dimension specifications down the tree 373 * during the recursion. At the end of the measure pass, every view has stored 374 * its measurements. The second pass happens in 375 * {@link #layout(int,int,int,int)} and is also top-down. During 376 * this pass each parent is responsible for positioning all of its children 377 * using the sizes computed in the measure pass. 378 * </p> 379 * 380 * <p> 381 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and 382 * {@link #getMeasuredHeight()} values must be set, along with those for all of 383 * that view's descendants. A view's measured width and measured height values 384 * must respect the constraints imposed by the view's parents. This guarantees 385 * that at the end of the measure pass, all parents accept all of their 386 * children's measurements. A parent view may call measure() more than once on 387 * its children. For example, the parent may measure each child once with 388 * unspecified dimensions to find out how big they want to be, then call 389 * measure() on them again with actual numbers if the sum of all the children's 390 * unconstrained sizes is too big or too small. 391 * </p> 392 * 393 * <p> 394 * The measure pass uses two classes to communicate dimensions. The 395 * {@link MeasureSpec} class is used by views to tell their parents how they 396 * want to be measured and positioned. The base LayoutParams class just 397 * describes how big the view wants to be for both width and height. For each 398 * dimension, it can specify one of: 399 * <ul> 400 * <li> an exact number 401 * <li>MATCH_PARENT, which means the view wants to be as big as its parent 402 * (minus padding) 403 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to 404 * enclose its content (plus padding). 405 * </ul> 406 * There are subclasses of LayoutParams for different subclasses of ViewGroup. 407 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds 408 * an X and Y value. 409 * </p> 410 * 411 * <p> 412 * MeasureSpecs are used to push requirements down the tree from parent to 413 * child. A MeasureSpec can be in one of three modes: 414 * <ul> 415 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension 416 * of a child view. For example, a LinearLayout may call measure() on its child 417 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how 418 * tall the child view wants to be given a width of 240 pixels. 419 * <li>EXACTLY: This is used by the parent to impose an exact size on the 420 * child. The child must use this size, and guarantee that all of its 421 * descendants will fit within this size. 422 * <li>AT_MOST: This is used by the parent to impose a maximum size on the 423 * child. The child must gurantee that it and all of its descendants will fit 424 * within this size. 425 * </ul> 426 * </p> 427 * 428 * <p> 429 * To intiate a layout, call {@link #requestLayout}. This method is typically 430 * called by a view on itself when it believes that is can no longer fit within 431 * its current bounds. 432 * </p> 433 * 434 * <a name="Drawing"></a> 435 * <h3>Drawing</h3> 436 * <p> 437 * Drawing is handled by walking the tree and rendering each view that 438 * intersects the invalid region. Because the tree is traversed in-order, 439 * this means that parents will draw before (i.e., behind) their children, with 440 * siblings drawn in the order they appear in the tree. 441 * If you set a background drawable for a View, then the View will draw it for you 442 * before calling back to its <code>onDraw()</code> method. 443 * </p> 444 * 445 * <p> 446 * Note that the framework will not draw views that are not in the invalid region. 447 * </p> 448 * 449 * <p> 450 * To force a view to draw, call {@link #invalidate()}. 451 * </p> 452 * 453 * <a name="EventHandlingThreading"></a> 454 * <h3>Event Handling and Threading</h3> 455 * <p> 456 * The basic cycle of a view is as follows: 457 * <ol> 458 * <li>An event comes in and is dispatched to the appropriate view. The view 459 * handles the event and notifies any listeners.</li> 460 * <li>If in the course of processing the event, the view's bounds may need 461 * to be changed, the view will call {@link #requestLayout()}.</li> 462 * <li>Similarly, if in the course of processing the event the view's appearance 463 * may need to be changed, the view will call {@link #invalidate()}.</li> 464 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called, 465 * the framework will take care of measuring, laying out, and drawing the tree 466 * as appropriate.</li> 467 * </ol> 468 * </p> 469 * 470 * <p><em>Note: The entire view tree is single threaded. You must always be on 471 * the UI thread when calling any method on any view.</em> 472 * If you are doing work on other threads and want to update the state of a view 473 * from that thread, you should use a {@link Handler}. 474 * </p> 475 * 476 * <a name="FocusHandling"></a> 477 * <h3>Focus Handling</h3> 478 * <p> 479 * The framework will handle routine focus movement in response to user input. 480 * This includes changing the focus as views are removed or hidden, or as new 481 * views become available. Views indicate their willingness to take focus 482 * through the {@link #isFocusable} method. To change whether a view can take 483 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below) 484 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode} 485 * and can change this via {@link #setFocusableInTouchMode(boolean)}. 486 * </p> 487 * <p> 488 * Focus movement is based on an algorithm which finds the nearest neighbor in a 489 * given direction. In rare cases, the default algorithm may not match the 490 * intended behavior of the developer. In these situations, you can provide 491 * explicit overrides by using these XML attributes in the layout file: 492 * <pre> 493 * nextFocusDown 494 * nextFocusLeft 495 * nextFocusRight 496 * nextFocusUp 497 * </pre> 498 * </p> 499 * 500 * 501 * <p> 502 * To get a particular view to take focus, call {@link #requestFocus()}. 503 * </p> 504 * 505 * <a name="TouchMode"></a> 506 * <h3>Touch Mode</h3> 507 * <p> 508 * When a user is navigating a user interface via directional keys such as a D-pad, it is 509 * necessary to give focus to actionable items such as buttons so the user can see 510 * what will take input. If the device has touch capabilities, however, and the user 511 * begins interacting with the interface by touching it, it is no longer necessary to 512 * always highlight, or give focus to, a particular view. This motivates a mode 513 * for interaction named 'touch mode'. 514 * </p> 515 * <p> 516 * For a touch capable device, once the user touches the screen, the device 517 * will enter touch mode. From this point onward, only views for which 518 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets. 519 * Other views that are touchable, like buttons, will not take focus when touched; they will 520 * only fire the on click listeners. 521 * </p> 522 * <p> 523 * Any time a user hits a directional key, such as a D-pad direction, the view device will 524 * exit touch mode, and find a view to take focus, so that the user may resume interacting 525 * with the user interface without touching the screen again. 526 * </p> 527 * <p> 528 * The touch mode state is maintained across {@link android.app.Activity}s. Call 529 * {@link #isInTouchMode} to see whether the device is currently in touch mode. 530 * </p> 531 * 532 * <a name="Scrolling"></a> 533 * <h3>Scrolling</h3> 534 * <p> 535 * The framework provides basic support for views that wish to internally 536 * scroll their content. This includes keeping track of the X and Y scroll 537 * offset as well as mechanisms for drawing scrollbars. See 538 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and 539 * {@link #awakenScrollBars()} for more details. 540 * </p> 541 * 542 * <a name="Tags"></a> 543 * <h3>Tags</h3> 544 * <p> 545 * Unlike IDs, tags are not used to identify views. Tags are essentially an 546 * extra piece of information that can be associated with a view. They are most 547 * often used as a convenience to store data related to views in the views 548 * themselves rather than by putting them in a separate structure. 549 * </p> 550 * 551 * <a name="Properties"></a> 552 * <h3>Properties</h3> 553 * <p> 554 * The View class exposes an {@link #ALPHA} property, as well as several transform-related 555 * properties, such as {@link #TRANSLATION_X} and {@link #TRANSLATION_Y}. These properties are 556 * available both in the {@link Property} form as well as in similarly-named setter/getter 557 * methods (such as {@link #setAlpha(float)} for {@link #ALPHA}). These properties can 558 * be used to set persistent state associated with these rendering-related properties on the view. 559 * The properties and methods can also be used in conjunction with 560 * {@link android.animation.Animator Animator}-based animations, described more in the 561 * <a href="#Animation">Animation</a> section. 562 * </p> 563 * 564 * <a name="Animation"></a> 565 * <h3>Animation</h3> 566 * <p> 567 * Starting with Android 3.0, the preferred way of animating views is to use the 568 * {@link android.animation} package APIs. These {@link android.animation.Animator Animator}-based 569 * classes change actual properties of the View object, such as {@link #setAlpha(float) alpha} and 570 * {@link #setTranslationX(float) translationX}. This behavior is contrasted to that of the pre-3.0 571 * {@link android.view.animation.Animation Animation}-based classes, which instead animate only 572 * how the view is drawn on the display. In particular, the {@link ViewPropertyAnimator} class 573 * makes animating these View properties particularly easy and efficient. 574 * </p> 575 * <p> 576 * Alternatively, you can use the pre-3.0 animation classes to animate how Views are rendered. 577 * You can attach an {@link Animation} object to a view using 578 * {@link #setAnimation(Animation)} or 579 * {@link #startAnimation(Animation)}. The animation can alter the scale, 580 * rotation, translation and alpha of a view over time. If the animation is 581 * attached to a view that has children, the animation will affect the entire 582 * subtree rooted by that node. When an animation is started, the framework will 583 * take care of redrawing the appropriate views until the animation completes. 584 * </p> 585 * 586 * <a name="Security"></a> 587 * <h3>Security</h3> 588 * <p> 589 * Sometimes it is essential that an application be able to verify that an action 590 * is being performed with the full knowledge and consent of the user, such as 591 * granting a permission request, making a purchase or clicking on an advertisement. 592 * Unfortunately, a malicious application could try to spoof the user into 593 * performing these actions, unaware, by concealing the intended purpose of the view. 594 * As a remedy, the framework offers a touch filtering mechanism that can be used to 595 * improve the security of views that provide access to sensitive functionality. 596 * </p><p> 597 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the 598 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework 599 * will discard touches that are received whenever the view's window is obscured by 600 * another visible window. As a result, the view will not receive touches whenever a 601 * toast, dialog or other window appears above the view's window. 602 * </p><p> 603 * For more fine-grained control over security, consider overriding the 604 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own 605 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}. 606 * </p> 607 * 608 * @attr ref android.R.styleable#View_alpha 609 * @attr ref android.R.styleable#View_background 610 * @attr ref android.R.styleable#View_clickable 611 * @attr ref android.R.styleable#View_contentDescription 612 * @attr ref android.R.styleable#View_drawingCacheQuality 613 * @attr ref android.R.styleable#View_duplicateParentState 614 * @attr ref android.R.styleable#View_id 615 * @attr ref android.R.styleable#View_requiresFadingEdge 616 * @attr ref android.R.styleable#View_fadeScrollbars 617 * @attr ref android.R.styleable#View_fadingEdgeLength 618 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 619 * @attr ref android.R.styleable#View_fitsSystemWindows 620 * @attr ref android.R.styleable#View_isScrollContainer 621 * @attr ref android.R.styleable#View_focusable 622 * @attr ref android.R.styleable#View_focusableInTouchMode 623 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 624 * @attr ref android.R.styleable#View_keepScreenOn 625 * @attr ref android.R.styleable#View_layerType 626 * @attr ref android.R.styleable#View_longClickable 627 * @attr ref android.R.styleable#View_minHeight 628 * @attr ref android.R.styleable#View_minWidth 629 * @attr ref android.R.styleable#View_nextFocusDown 630 * @attr ref android.R.styleable#View_nextFocusLeft 631 * @attr ref android.R.styleable#View_nextFocusRight 632 * @attr ref android.R.styleable#View_nextFocusUp 633 * @attr ref android.R.styleable#View_onClick 634 * @attr ref android.R.styleable#View_padding 635 * @attr ref android.R.styleable#View_paddingBottom 636 * @attr ref android.R.styleable#View_paddingLeft 637 * @attr ref android.R.styleable#View_paddingRight 638 * @attr ref android.R.styleable#View_paddingTop 639 * @attr ref android.R.styleable#View_paddingStart 640 * @attr ref android.R.styleable#View_paddingEnd 641 * @attr ref android.R.styleable#View_saveEnabled 642 * @attr ref android.R.styleable#View_rotation 643 * @attr ref android.R.styleable#View_rotationX 644 * @attr ref android.R.styleable#View_rotationY 645 * @attr ref android.R.styleable#View_scaleX 646 * @attr ref android.R.styleable#View_scaleY 647 * @attr ref android.R.styleable#View_scrollX 648 * @attr ref android.R.styleable#View_scrollY 649 * @attr ref android.R.styleable#View_scrollbarSize 650 * @attr ref android.R.styleable#View_scrollbarStyle 651 * @attr ref android.R.styleable#View_scrollbars 652 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 653 * @attr ref android.R.styleable#View_scrollbarFadeDuration 654 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal 655 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal 656 * @attr ref android.R.styleable#View_scrollbarThumbVertical 657 * @attr ref android.R.styleable#View_scrollbarTrackVertical 658 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack 659 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack 660 * @attr ref android.R.styleable#View_soundEffectsEnabled 661 * @attr ref android.R.styleable#View_tag 662 * @attr ref android.R.styleable#View_textAlignment 663 * @attr ref android.R.styleable#View_transformPivotX 664 * @attr ref android.R.styleable#View_transformPivotY 665 * @attr ref android.R.styleable#View_translationX 666 * @attr ref android.R.styleable#View_translationY 667 * @attr ref android.R.styleable#View_visibility 668 * 669 * @see android.view.ViewGroup 670 */ 671public class View implements Drawable.Callback, KeyEvent.Callback, 672 AccessibilityEventSource { 673 private static final boolean DBG = false; 674 675 /** 676 * The logging tag used by this class with android.util.Log. 677 */ 678 protected static final String VIEW_LOG_TAG = "View"; 679 680 /** 681 * When set to true, apps will draw debugging information about their layouts. 682 * 683 * @hide 684 */ 685 public static final String DEBUG_LAYOUT_PROPERTY = "debug.layout"; 686 687 /** 688 * Used to mark a View that has no ID. 689 */ 690 public static final int NO_ID = -1; 691 692 /** 693 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when 694 * calling setFlags. 695 */ 696 private static final int NOT_FOCUSABLE = 0x00000000; 697 698 /** 699 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling 700 * setFlags. 701 */ 702 private static final int FOCUSABLE = 0x00000001; 703 704 /** 705 * Mask for use with setFlags indicating bits used for focus. 706 */ 707 private static final int FOCUSABLE_MASK = 0x00000001; 708 709 /** 710 * This view will adjust its padding to fit sytem windows (e.g. status bar) 711 */ 712 private static final int FITS_SYSTEM_WINDOWS = 0x00000002; 713 714 /** 715 * This view is visible. 716 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 717 * android:visibility}. 718 */ 719 public static final int VISIBLE = 0x00000000; 720 721 /** 722 * This view is invisible, but it still takes up space for layout purposes. 723 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 724 * android:visibility}. 725 */ 726 public static final int INVISIBLE = 0x00000004; 727 728 /** 729 * This view is invisible, and it doesn't take any space for layout 730 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 731 * android:visibility}. 732 */ 733 public static final int GONE = 0x00000008; 734 735 /** 736 * Mask for use with setFlags indicating bits used for visibility. 737 * {@hide} 738 */ 739 static final int VISIBILITY_MASK = 0x0000000C; 740 741 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE}; 742 743 /** 744 * This view is enabled. Interpretation varies by subclass. 745 * Use with ENABLED_MASK when calling setFlags. 746 * {@hide} 747 */ 748 static final int ENABLED = 0x00000000; 749 750 /** 751 * This view is disabled. Interpretation varies by subclass. 752 * Use with ENABLED_MASK when calling setFlags. 753 * {@hide} 754 */ 755 static final int DISABLED = 0x00000020; 756 757 /** 758 * Mask for use with setFlags indicating bits used for indicating whether 759 * this view is enabled 760 * {@hide} 761 */ 762 static final int ENABLED_MASK = 0x00000020; 763 764 /** 765 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be 766 * called and further optimizations will be performed. It is okay to have 767 * this flag set and a background. Use with DRAW_MASK when calling setFlags. 768 * {@hide} 769 */ 770 static final int WILL_NOT_DRAW = 0x00000080; 771 772 /** 773 * Mask for use with setFlags indicating bits used for indicating whether 774 * this view is will draw 775 * {@hide} 776 */ 777 static final int DRAW_MASK = 0x00000080; 778 779 /** 780 * <p>This view doesn't show scrollbars.</p> 781 * {@hide} 782 */ 783 static final int SCROLLBARS_NONE = 0x00000000; 784 785 /** 786 * <p>This view shows horizontal scrollbars.</p> 787 * {@hide} 788 */ 789 static final int SCROLLBARS_HORIZONTAL = 0x00000100; 790 791 /** 792 * <p>This view shows vertical scrollbars.</p> 793 * {@hide} 794 */ 795 static final int SCROLLBARS_VERTICAL = 0x00000200; 796 797 /** 798 * <p>Mask for use with setFlags indicating bits used for indicating which 799 * scrollbars are enabled.</p> 800 * {@hide} 801 */ 802 static final int SCROLLBARS_MASK = 0x00000300; 803 804 /** 805 * Indicates that the view should filter touches when its window is obscured. 806 * Refer to the class comments for more information about this security feature. 807 * {@hide} 808 */ 809 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400; 810 811 /** 812 * Set for framework elements that use FITS_SYSTEM_WINDOWS, to indicate 813 * that they are optional and should be skipped if the window has 814 * requested system UI flags that ignore those insets for layout. 815 */ 816 static final int OPTIONAL_FITS_SYSTEM_WINDOWS = 0x00000800; 817 818 /** 819 * <p>This view doesn't show fading edges.</p> 820 * {@hide} 821 */ 822 static final int FADING_EDGE_NONE = 0x00000000; 823 824 /** 825 * <p>This view shows horizontal fading edges.</p> 826 * {@hide} 827 */ 828 static final int FADING_EDGE_HORIZONTAL = 0x00001000; 829 830 /** 831 * <p>This view shows vertical fading edges.</p> 832 * {@hide} 833 */ 834 static final int FADING_EDGE_VERTICAL = 0x00002000; 835 836 /** 837 * <p>Mask for use with setFlags indicating bits used for indicating which 838 * fading edges are enabled.</p> 839 * {@hide} 840 */ 841 static final int FADING_EDGE_MASK = 0x00003000; 842 843 /** 844 * <p>Indicates this view can be clicked. When clickable, a View reacts 845 * to clicks by notifying the OnClickListener.<p> 846 * {@hide} 847 */ 848 static final int CLICKABLE = 0x00004000; 849 850 /** 851 * <p>Indicates this view is caching its drawing into a bitmap.</p> 852 * {@hide} 853 */ 854 static final int DRAWING_CACHE_ENABLED = 0x00008000; 855 856 /** 857 * <p>Indicates that no icicle should be saved for this view.<p> 858 * {@hide} 859 */ 860 static final int SAVE_DISABLED = 0x000010000; 861 862 /** 863 * <p>Mask for use with setFlags indicating bits used for the saveEnabled 864 * property.</p> 865 * {@hide} 866 */ 867 static final int SAVE_DISABLED_MASK = 0x000010000; 868 869 /** 870 * <p>Indicates that no drawing cache should ever be created for this view.<p> 871 * {@hide} 872 */ 873 static final int WILL_NOT_CACHE_DRAWING = 0x000020000; 874 875 /** 876 * <p>Indicates this view can take / keep focus when int touch mode.</p> 877 * {@hide} 878 */ 879 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000; 880 881 /** 882 * <p>Enables low quality mode for the drawing cache.</p> 883 */ 884 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000; 885 886 /** 887 * <p>Enables high quality mode for the drawing cache.</p> 888 */ 889 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000; 890 891 /** 892 * <p>Enables automatic quality mode for the drawing cache.</p> 893 */ 894 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000; 895 896 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = { 897 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH 898 }; 899 900 /** 901 * <p>Mask for use with setFlags indicating bits used for the cache 902 * quality property.</p> 903 * {@hide} 904 */ 905 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000; 906 907 /** 908 * <p> 909 * Indicates this view can be long clicked. When long clickable, a View 910 * reacts to long clicks by notifying the OnLongClickListener or showing a 911 * context menu. 912 * </p> 913 * {@hide} 914 */ 915 static final int LONG_CLICKABLE = 0x00200000; 916 917 /** 918 * <p>Indicates that this view gets its drawable states from its direct parent 919 * and ignores its original internal states.</p> 920 * 921 * @hide 922 */ 923 static final int DUPLICATE_PARENT_STATE = 0x00400000; 924 925 /** 926 * The scrollbar style to display the scrollbars inside the content area, 927 * without increasing the padding. The scrollbars will be overlaid with 928 * translucency on the view's content. 929 */ 930 public static final int SCROLLBARS_INSIDE_OVERLAY = 0; 931 932 /** 933 * The scrollbar style to display the scrollbars inside the padded area, 934 * increasing the padding of the view. The scrollbars will not overlap the 935 * content area of the view. 936 */ 937 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000; 938 939 /** 940 * The scrollbar style to display the scrollbars at the edge of the view, 941 * without increasing the padding. The scrollbars will be overlaid with 942 * translucency. 943 */ 944 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000; 945 946 /** 947 * The scrollbar style to display the scrollbars at the edge of the view, 948 * increasing the padding of the view. The scrollbars will only overlap the 949 * background, if any. 950 */ 951 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000; 952 953 /** 954 * Mask to check if the scrollbar style is overlay or inset. 955 * {@hide} 956 */ 957 static final int SCROLLBARS_INSET_MASK = 0x01000000; 958 959 /** 960 * Mask to check if the scrollbar style is inside or outside. 961 * {@hide} 962 */ 963 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000; 964 965 /** 966 * Mask for scrollbar style. 967 * {@hide} 968 */ 969 static final int SCROLLBARS_STYLE_MASK = 0x03000000; 970 971 /** 972 * View flag indicating that the screen should remain on while the 973 * window containing this view is visible to the user. This effectively 974 * takes care of automatically setting the WindowManager's 975 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}. 976 */ 977 public static final int KEEP_SCREEN_ON = 0x04000000; 978 979 /** 980 * View flag indicating whether this view should have sound effects enabled 981 * for events such as clicking and touching. 982 */ 983 public static final int SOUND_EFFECTS_ENABLED = 0x08000000; 984 985 /** 986 * View flag indicating whether this view should have haptic feedback 987 * enabled for events such as long presses. 988 */ 989 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000; 990 991 /** 992 * <p>Indicates that the view hierarchy should stop saving state when 993 * it reaches this view. If state saving is initiated immediately at 994 * the view, it will be allowed. 995 * {@hide} 996 */ 997 static final int PARENT_SAVE_DISABLED = 0x20000000; 998 999 /** 1000 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p> 1001 * {@hide} 1002 */ 1003 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000; 1004 1005 /** 1006 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1007 * should add all focusable Views regardless if they are focusable in touch mode. 1008 */ 1009 public static final int FOCUSABLES_ALL = 0x00000000; 1010 1011 /** 1012 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1013 * should add only Views focusable in touch mode. 1014 */ 1015 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001; 1016 1017 /** 1018 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable 1019 * item. 1020 */ 1021 public static final int FOCUS_BACKWARD = 0x00000001; 1022 1023 /** 1024 * Use with {@link #focusSearch(int)}. Move focus to the next selectable 1025 * item. 1026 */ 1027 public static final int FOCUS_FORWARD = 0x00000002; 1028 1029 /** 1030 * Use with {@link #focusSearch(int)}. Move focus to the left. 1031 */ 1032 public static final int FOCUS_LEFT = 0x00000011; 1033 1034 /** 1035 * Use with {@link #focusSearch(int)}. Move focus up. 1036 */ 1037 public static final int FOCUS_UP = 0x00000021; 1038 1039 /** 1040 * Use with {@link #focusSearch(int)}. Move focus to the right. 1041 */ 1042 public static final int FOCUS_RIGHT = 0x00000042; 1043 1044 /** 1045 * Use with {@link #focusSearch(int)}. Move focus down. 1046 */ 1047 public static final int FOCUS_DOWN = 0x00000082; 1048 1049 /** 1050 * Bits of {@link #getMeasuredWidthAndState()} and 1051 * {@link #getMeasuredWidthAndState()} that provide the actual measured size. 1052 */ 1053 public static final int MEASURED_SIZE_MASK = 0x00ffffff; 1054 1055 /** 1056 * Bits of {@link #getMeasuredWidthAndState()} and 1057 * {@link #getMeasuredWidthAndState()} that provide the additional state bits. 1058 */ 1059 public static final int MEASURED_STATE_MASK = 0xff000000; 1060 1061 /** 1062 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits 1063 * for functions that combine both width and height into a single int, 1064 * such as {@link #getMeasuredState()} and the childState argument of 1065 * {@link #resolveSizeAndState(int, int, int)}. 1066 */ 1067 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16; 1068 1069 /** 1070 * Bit of {@link #getMeasuredWidthAndState()} and 1071 * {@link #getMeasuredWidthAndState()} that indicates the measured size 1072 * is smaller that the space the view would like to have. 1073 */ 1074 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000; 1075 1076 /** 1077 * Base View state sets 1078 */ 1079 // Singles 1080 /** 1081 * Indicates the view has no states set. States are used with 1082 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1083 * view depending on its state. 1084 * 1085 * @see android.graphics.drawable.Drawable 1086 * @see #getDrawableState() 1087 */ 1088 protected static final int[] EMPTY_STATE_SET; 1089 /** 1090 * Indicates the view is enabled. States are used with 1091 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1092 * view depending on its state. 1093 * 1094 * @see android.graphics.drawable.Drawable 1095 * @see #getDrawableState() 1096 */ 1097 protected static final int[] ENABLED_STATE_SET; 1098 /** 1099 * Indicates the view is focused. States are used with 1100 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1101 * view depending on its state. 1102 * 1103 * @see android.graphics.drawable.Drawable 1104 * @see #getDrawableState() 1105 */ 1106 protected static final int[] FOCUSED_STATE_SET; 1107 /** 1108 * Indicates the view is selected. States are used with 1109 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1110 * view depending on its state. 1111 * 1112 * @see android.graphics.drawable.Drawable 1113 * @see #getDrawableState() 1114 */ 1115 protected static final int[] SELECTED_STATE_SET; 1116 /** 1117 * Indicates the view is pressed. States are used with 1118 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1119 * view depending on its state. 1120 * 1121 * @see android.graphics.drawable.Drawable 1122 * @see #getDrawableState() 1123 * @hide 1124 */ 1125 protected static final int[] PRESSED_STATE_SET; 1126 /** 1127 * Indicates the view's window has focus. States are used with 1128 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1129 * view depending on its state. 1130 * 1131 * @see android.graphics.drawable.Drawable 1132 * @see #getDrawableState() 1133 */ 1134 protected static final int[] WINDOW_FOCUSED_STATE_SET; 1135 // Doubles 1136 /** 1137 * Indicates the view is enabled and has the focus. 1138 * 1139 * @see #ENABLED_STATE_SET 1140 * @see #FOCUSED_STATE_SET 1141 */ 1142 protected static final int[] ENABLED_FOCUSED_STATE_SET; 1143 /** 1144 * Indicates the view is enabled and selected. 1145 * 1146 * @see #ENABLED_STATE_SET 1147 * @see #SELECTED_STATE_SET 1148 */ 1149 protected static final int[] ENABLED_SELECTED_STATE_SET; 1150 /** 1151 * Indicates the view is enabled and that its window has focus. 1152 * 1153 * @see #ENABLED_STATE_SET 1154 * @see #WINDOW_FOCUSED_STATE_SET 1155 */ 1156 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET; 1157 /** 1158 * Indicates the view is focused and selected. 1159 * 1160 * @see #FOCUSED_STATE_SET 1161 * @see #SELECTED_STATE_SET 1162 */ 1163 protected static final int[] FOCUSED_SELECTED_STATE_SET; 1164 /** 1165 * Indicates the view has the focus and that its window has the focus. 1166 * 1167 * @see #FOCUSED_STATE_SET 1168 * @see #WINDOW_FOCUSED_STATE_SET 1169 */ 1170 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET; 1171 /** 1172 * Indicates the view is selected and that its window has the focus. 1173 * 1174 * @see #SELECTED_STATE_SET 1175 * @see #WINDOW_FOCUSED_STATE_SET 1176 */ 1177 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET; 1178 // Triples 1179 /** 1180 * Indicates the view is enabled, focused and selected. 1181 * 1182 * @see #ENABLED_STATE_SET 1183 * @see #FOCUSED_STATE_SET 1184 * @see #SELECTED_STATE_SET 1185 */ 1186 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET; 1187 /** 1188 * Indicates the view is enabled, focused and its window has the focus. 1189 * 1190 * @see #ENABLED_STATE_SET 1191 * @see #FOCUSED_STATE_SET 1192 * @see #WINDOW_FOCUSED_STATE_SET 1193 */ 1194 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1195 /** 1196 * Indicates the view is enabled, selected and its window has the focus. 1197 * 1198 * @see #ENABLED_STATE_SET 1199 * @see #SELECTED_STATE_SET 1200 * @see #WINDOW_FOCUSED_STATE_SET 1201 */ 1202 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1203 /** 1204 * Indicates the view is focused, selected and its window has the focus. 1205 * 1206 * @see #FOCUSED_STATE_SET 1207 * @see #SELECTED_STATE_SET 1208 * @see #WINDOW_FOCUSED_STATE_SET 1209 */ 1210 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1211 /** 1212 * Indicates the view is enabled, focused, selected and its window 1213 * has the focus. 1214 * 1215 * @see #ENABLED_STATE_SET 1216 * @see #FOCUSED_STATE_SET 1217 * @see #SELECTED_STATE_SET 1218 * @see #WINDOW_FOCUSED_STATE_SET 1219 */ 1220 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1221 /** 1222 * Indicates the view is pressed and its window has the focus. 1223 * 1224 * @see #PRESSED_STATE_SET 1225 * @see #WINDOW_FOCUSED_STATE_SET 1226 */ 1227 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET; 1228 /** 1229 * Indicates the view is pressed and selected. 1230 * 1231 * @see #PRESSED_STATE_SET 1232 * @see #SELECTED_STATE_SET 1233 */ 1234 protected static final int[] PRESSED_SELECTED_STATE_SET; 1235 /** 1236 * Indicates the view is pressed, selected and its window has the focus. 1237 * 1238 * @see #PRESSED_STATE_SET 1239 * @see #SELECTED_STATE_SET 1240 * @see #WINDOW_FOCUSED_STATE_SET 1241 */ 1242 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1243 /** 1244 * Indicates the view is pressed and focused. 1245 * 1246 * @see #PRESSED_STATE_SET 1247 * @see #FOCUSED_STATE_SET 1248 */ 1249 protected static final int[] PRESSED_FOCUSED_STATE_SET; 1250 /** 1251 * Indicates the view is pressed, focused and its window has the focus. 1252 * 1253 * @see #PRESSED_STATE_SET 1254 * @see #FOCUSED_STATE_SET 1255 * @see #WINDOW_FOCUSED_STATE_SET 1256 */ 1257 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1258 /** 1259 * Indicates the view is pressed, focused and selected. 1260 * 1261 * @see #PRESSED_STATE_SET 1262 * @see #SELECTED_STATE_SET 1263 * @see #FOCUSED_STATE_SET 1264 */ 1265 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET; 1266 /** 1267 * Indicates the view is pressed, focused, selected and its window has the focus. 1268 * 1269 * @see #PRESSED_STATE_SET 1270 * @see #FOCUSED_STATE_SET 1271 * @see #SELECTED_STATE_SET 1272 * @see #WINDOW_FOCUSED_STATE_SET 1273 */ 1274 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1275 /** 1276 * Indicates the view is pressed and enabled. 1277 * 1278 * @see #PRESSED_STATE_SET 1279 * @see #ENABLED_STATE_SET 1280 */ 1281 protected static final int[] PRESSED_ENABLED_STATE_SET; 1282 /** 1283 * Indicates the view is pressed, enabled and its window has the focus. 1284 * 1285 * @see #PRESSED_STATE_SET 1286 * @see #ENABLED_STATE_SET 1287 * @see #WINDOW_FOCUSED_STATE_SET 1288 */ 1289 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET; 1290 /** 1291 * Indicates the view is pressed, enabled and selected. 1292 * 1293 * @see #PRESSED_STATE_SET 1294 * @see #ENABLED_STATE_SET 1295 * @see #SELECTED_STATE_SET 1296 */ 1297 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET; 1298 /** 1299 * Indicates the view is pressed, enabled, selected and its window has the 1300 * focus. 1301 * 1302 * @see #PRESSED_STATE_SET 1303 * @see #ENABLED_STATE_SET 1304 * @see #SELECTED_STATE_SET 1305 * @see #WINDOW_FOCUSED_STATE_SET 1306 */ 1307 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1308 /** 1309 * Indicates the view is pressed, enabled and focused. 1310 * 1311 * @see #PRESSED_STATE_SET 1312 * @see #ENABLED_STATE_SET 1313 * @see #FOCUSED_STATE_SET 1314 */ 1315 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET; 1316 /** 1317 * Indicates the view is pressed, enabled, focused and its window has the 1318 * focus. 1319 * 1320 * @see #PRESSED_STATE_SET 1321 * @see #ENABLED_STATE_SET 1322 * @see #FOCUSED_STATE_SET 1323 * @see #WINDOW_FOCUSED_STATE_SET 1324 */ 1325 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1326 /** 1327 * Indicates the view is pressed, enabled, focused and selected. 1328 * 1329 * @see #PRESSED_STATE_SET 1330 * @see #ENABLED_STATE_SET 1331 * @see #SELECTED_STATE_SET 1332 * @see #FOCUSED_STATE_SET 1333 */ 1334 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET; 1335 /** 1336 * Indicates the view is pressed, enabled, focused, selected and its window 1337 * has the focus. 1338 * 1339 * @see #PRESSED_STATE_SET 1340 * @see #ENABLED_STATE_SET 1341 * @see #SELECTED_STATE_SET 1342 * @see #FOCUSED_STATE_SET 1343 * @see #WINDOW_FOCUSED_STATE_SET 1344 */ 1345 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1346 1347 /** 1348 * The order here is very important to {@link #getDrawableState()} 1349 */ 1350 private static final int[][] VIEW_STATE_SETS; 1351 1352 static final int VIEW_STATE_WINDOW_FOCUSED = 1; 1353 static final int VIEW_STATE_SELECTED = 1 << 1; 1354 static final int VIEW_STATE_FOCUSED = 1 << 2; 1355 static final int VIEW_STATE_ENABLED = 1 << 3; 1356 static final int VIEW_STATE_PRESSED = 1 << 4; 1357 static final int VIEW_STATE_ACTIVATED = 1 << 5; 1358 static final int VIEW_STATE_ACCELERATED = 1 << 6; 1359 static final int VIEW_STATE_HOVERED = 1 << 7; 1360 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8; 1361 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9; 1362 1363 static final int[] VIEW_STATE_IDS = new int[] { 1364 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED, 1365 R.attr.state_selected, VIEW_STATE_SELECTED, 1366 R.attr.state_focused, VIEW_STATE_FOCUSED, 1367 R.attr.state_enabled, VIEW_STATE_ENABLED, 1368 R.attr.state_pressed, VIEW_STATE_PRESSED, 1369 R.attr.state_activated, VIEW_STATE_ACTIVATED, 1370 R.attr.state_accelerated, VIEW_STATE_ACCELERATED, 1371 R.attr.state_hovered, VIEW_STATE_HOVERED, 1372 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT, 1373 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED 1374 }; 1375 1376 static { 1377 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) { 1378 throw new IllegalStateException( 1379 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array"); 1380 } 1381 int[] orderedIds = new int[VIEW_STATE_IDS.length]; 1382 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) { 1383 int viewState = R.styleable.ViewDrawableStates[i]; 1384 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) { 1385 if (VIEW_STATE_IDS[j] == viewState) { 1386 orderedIds[i * 2] = viewState; 1387 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1]; 1388 } 1389 } 1390 } 1391 final int NUM_BITS = VIEW_STATE_IDS.length / 2; 1392 VIEW_STATE_SETS = new int[1 << NUM_BITS][]; 1393 for (int i = 0; i < VIEW_STATE_SETS.length; i++) { 1394 int numBits = Integer.bitCount(i); 1395 int[] set = new int[numBits]; 1396 int pos = 0; 1397 for (int j = 0; j < orderedIds.length; j += 2) { 1398 if ((i & orderedIds[j+1]) != 0) { 1399 set[pos++] = orderedIds[j]; 1400 } 1401 } 1402 VIEW_STATE_SETS[i] = set; 1403 } 1404 1405 EMPTY_STATE_SET = VIEW_STATE_SETS[0]; 1406 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED]; 1407 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED]; 1408 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1409 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED]; 1410 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED]; 1411 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1412 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED]; 1413 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1414 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED]; 1415 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1416 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1417 | VIEW_STATE_FOCUSED]; 1418 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED]; 1419 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1420 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED]; 1421 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1422 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED]; 1423 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1424 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1425 | VIEW_STATE_ENABLED]; 1426 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1427 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED]; 1428 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1429 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1430 | VIEW_STATE_ENABLED]; 1431 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1432 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1433 | VIEW_STATE_ENABLED]; 1434 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1435 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1436 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED]; 1437 1438 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED]; 1439 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1440 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED]; 1441 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1442 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED]; 1443 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1444 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1445 | VIEW_STATE_PRESSED]; 1446 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1447 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1448 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1449 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1450 | VIEW_STATE_PRESSED]; 1451 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1452 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1453 | VIEW_STATE_PRESSED]; 1454 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1455 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1456 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1457 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[ 1458 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1459 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1460 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED 1461 | VIEW_STATE_PRESSED]; 1462 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1463 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED 1464 | VIEW_STATE_PRESSED]; 1465 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1466 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1467 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1468 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1469 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED 1470 | VIEW_STATE_PRESSED]; 1471 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1472 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1473 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1474 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1475 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1476 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1477 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1478 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1479 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED 1480 | VIEW_STATE_PRESSED]; 1481 } 1482 1483 /** 1484 * Accessibility event types that are dispatched for text population. 1485 */ 1486 private static final int POPULATING_ACCESSIBILITY_EVENT_TYPES = 1487 AccessibilityEvent.TYPE_VIEW_CLICKED 1488 | AccessibilityEvent.TYPE_VIEW_LONG_CLICKED 1489 | AccessibilityEvent.TYPE_VIEW_SELECTED 1490 | AccessibilityEvent.TYPE_VIEW_FOCUSED 1491 | AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED 1492 | AccessibilityEvent.TYPE_VIEW_HOVER_ENTER 1493 | AccessibilityEvent.TYPE_VIEW_HOVER_EXIT 1494 | AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED 1495 | AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED 1496 | AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED 1497 | AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY; 1498 1499 /** 1500 * Temporary Rect currently for use in setBackground(). This will probably 1501 * be extended in the future to hold our own class with more than just 1502 * a Rect. :) 1503 */ 1504 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>(); 1505 1506 /** 1507 * Map used to store views' tags. 1508 */ 1509 private SparseArray<Object> mKeyedTags; 1510 1511 /** 1512 * The next available accessibility id. 1513 */ 1514 private static int sNextAccessibilityViewId; 1515 1516 /** 1517 * The animation currently associated with this view. 1518 * @hide 1519 */ 1520 protected Animation mCurrentAnimation = null; 1521 1522 /** 1523 * Width as measured during measure pass. 1524 * {@hide} 1525 */ 1526 @ViewDebug.ExportedProperty(category = "measurement") 1527 int mMeasuredWidth; 1528 1529 /** 1530 * Height as measured during measure pass. 1531 * {@hide} 1532 */ 1533 @ViewDebug.ExportedProperty(category = "measurement") 1534 int mMeasuredHeight; 1535 1536 /** 1537 * Flag to indicate that this view was marked INVALIDATED, or had its display list 1538 * invalidated, prior to the current drawing iteration. If true, the view must re-draw 1539 * its display list. This flag, used only when hw accelerated, allows us to clear the 1540 * flag while retaining this information until it's needed (at getDisplayList() time and 1541 * in drawChild(), when we decide to draw a view's children's display lists into our own). 1542 * 1543 * {@hide} 1544 */ 1545 boolean mRecreateDisplayList = false; 1546 1547 /** 1548 * The view's identifier. 1549 * {@hide} 1550 * 1551 * @see #setId(int) 1552 * @see #getId() 1553 */ 1554 @ViewDebug.ExportedProperty(resolveId = true) 1555 int mID = NO_ID; 1556 1557 /** 1558 * The stable ID of this view for accessibility purposes. 1559 */ 1560 int mAccessibilityViewId = NO_ID; 1561 1562 /** 1563 * @hide 1564 */ 1565 private int mAccessibilityCursorPosition = ACCESSIBILITY_CURSOR_POSITION_UNDEFINED; 1566 1567 /** 1568 * The view's tag. 1569 * {@hide} 1570 * 1571 * @see #setTag(Object) 1572 * @see #getTag() 1573 */ 1574 protected Object mTag; 1575 1576 // for mPrivateFlags: 1577 /** {@hide} */ 1578 static final int PFLAG_WANTS_FOCUS = 0x00000001; 1579 /** {@hide} */ 1580 static final int PFLAG_FOCUSED = 0x00000002; 1581 /** {@hide} */ 1582 static final int PFLAG_SELECTED = 0x00000004; 1583 /** {@hide} */ 1584 static final int PFLAG_IS_ROOT_NAMESPACE = 0x00000008; 1585 /** {@hide} */ 1586 static final int PFLAG_HAS_BOUNDS = 0x00000010; 1587 /** {@hide} */ 1588 static final int PFLAG_DRAWN = 0x00000020; 1589 /** 1590 * When this flag is set, this view is running an animation on behalf of its 1591 * children and should therefore not cancel invalidate requests, even if they 1592 * lie outside of this view's bounds. 1593 * 1594 * {@hide} 1595 */ 1596 static final int PFLAG_DRAW_ANIMATION = 0x00000040; 1597 /** {@hide} */ 1598 static final int PFLAG_SKIP_DRAW = 0x00000080; 1599 /** {@hide} */ 1600 static final int PFLAG_ONLY_DRAWS_BACKGROUND = 0x00000100; 1601 /** {@hide} */ 1602 static final int PFLAG_REQUEST_TRANSPARENT_REGIONS = 0x00000200; 1603 /** {@hide} */ 1604 static final int PFLAG_DRAWABLE_STATE_DIRTY = 0x00000400; 1605 /** {@hide} */ 1606 static final int PFLAG_MEASURED_DIMENSION_SET = 0x00000800; 1607 /** {@hide} */ 1608 static final int PFLAG_FORCE_LAYOUT = 0x00001000; 1609 /** {@hide} */ 1610 static final int PFLAG_LAYOUT_REQUIRED = 0x00002000; 1611 1612 private static final int PFLAG_PRESSED = 0x00004000; 1613 1614 /** {@hide} */ 1615 static final int PFLAG_DRAWING_CACHE_VALID = 0x00008000; 1616 /** 1617 * Flag used to indicate that this view should be drawn once more (and only once 1618 * more) after its animation has completed. 1619 * {@hide} 1620 */ 1621 static final int PFLAG_ANIMATION_STARTED = 0x00010000; 1622 1623 private static final int PFLAG_SAVE_STATE_CALLED = 0x00020000; 1624 1625 /** 1626 * Indicates that the View returned true when onSetAlpha() was called and that 1627 * the alpha must be restored. 1628 * {@hide} 1629 */ 1630 static final int PFLAG_ALPHA_SET = 0x00040000; 1631 1632 /** 1633 * Set by {@link #setScrollContainer(boolean)}. 1634 */ 1635 static final int PFLAG_SCROLL_CONTAINER = 0x00080000; 1636 1637 /** 1638 * Set by {@link #setScrollContainer(boolean)}. 1639 */ 1640 static final int PFLAG_SCROLL_CONTAINER_ADDED = 0x00100000; 1641 1642 /** 1643 * View flag indicating whether this view was invalidated (fully or partially.) 1644 * 1645 * @hide 1646 */ 1647 static final int PFLAG_DIRTY = 0x00200000; 1648 1649 /** 1650 * View flag indicating whether this view was invalidated by an opaque 1651 * invalidate request. 1652 * 1653 * @hide 1654 */ 1655 static final int PFLAG_DIRTY_OPAQUE = 0x00400000; 1656 1657 /** 1658 * Mask for {@link #PFLAG_DIRTY} and {@link #PFLAG_DIRTY_OPAQUE}. 1659 * 1660 * @hide 1661 */ 1662 static final int PFLAG_DIRTY_MASK = 0x00600000; 1663 1664 /** 1665 * Indicates whether the background is opaque. 1666 * 1667 * @hide 1668 */ 1669 static final int PFLAG_OPAQUE_BACKGROUND = 0x00800000; 1670 1671 /** 1672 * Indicates whether the scrollbars are opaque. 1673 * 1674 * @hide 1675 */ 1676 static final int PFLAG_OPAQUE_SCROLLBARS = 0x01000000; 1677 1678 /** 1679 * Indicates whether the view is opaque. 1680 * 1681 * @hide 1682 */ 1683 static final int PFLAG_OPAQUE_MASK = 0x01800000; 1684 1685 /** 1686 * Indicates a prepressed state; 1687 * the short time between ACTION_DOWN and recognizing 1688 * a 'real' press. Prepressed is used to recognize quick taps 1689 * even when they are shorter than ViewConfiguration.getTapTimeout(). 1690 * 1691 * @hide 1692 */ 1693 private static final int PFLAG_PREPRESSED = 0x02000000; 1694 1695 /** 1696 * Indicates whether the view is temporarily detached. 1697 * 1698 * @hide 1699 */ 1700 static final int PFLAG_CANCEL_NEXT_UP_EVENT = 0x04000000; 1701 1702 /** 1703 * Indicates that we should awaken scroll bars once attached 1704 * 1705 * @hide 1706 */ 1707 private static final int PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000; 1708 1709 /** 1710 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT. 1711 * @hide 1712 */ 1713 private static final int PFLAG_HOVERED = 0x10000000; 1714 1715 /** 1716 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center 1717 * for transform operations 1718 * 1719 * @hide 1720 */ 1721 private static final int PFLAG_PIVOT_EXPLICITLY_SET = 0x20000000; 1722 1723 /** {@hide} */ 1724 static final int PFLAG_ACTIVATED = 0x40000000; 1725 1726 /** 1727 * Indicates that this view was specifically invalidated, not just dirtied because some 1728 * child view was invalidated. The flag is used to determine when we need to recreate 1729 * a view's display list (as opposed to just returning a reference to its existing 1730 * display list). 1731 * 1732 * @hide 1733 */ 1734 static final int PFLAG_INVALIDATED = 0x80000000; 1735 1736 /** 1737 * Masks for mPrivateFlags2, as generated by dumpFlags(): 1738 * 1739 * -------|-------|-------|-------| 1740 * PFLAG2_TEXT_ALIGNMENT_FLAGS[0] 1741 * PFLAG2_TEXT_DIRECTION_FLAGS[0] 1742 * 1 PFLAG2_DRAG_CAN_ACCEPT 1743 * 1 PFLAG2_DRAG_HOVERED 1744 * 1 PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT 1745 * 11 PFLAG2_TEXT_DIRECTION_MASK_SHIFT 1746 * 1 1 PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT 1747 * 11 PFLAG2_LAYOUT_DIRECTION_MASK 1748 * 11 1 PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT 1749 * 1 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL 1750 * 1 1 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT 1751 * 1 1 PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT 1752 * 1 PFLAG2_LAYOUT_DIRECTION_RESOLVED 1753 * 11 PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK 1754 * 1 PFLAG2_TEXT_DIRECTION_FLAGS[1] 1755 * 1 PFLAG2_TEXT_DIRECTION_FLAGS[2] 1756 * 11 PFLAG2_TEXT_DIRECTION_FLAGS[3] 1757 * 1 PFLAG2_TEXT_DIRECTION_FLAGS[4] 1758 * 1 1 PFLAG2_TEXT_DIRECTION_FLAGS[5] 1759 * 111 PFLAG2_TEXT_DIRECTION_MASK 1760 * 1 PFLAG2_TEXT_DIRECTION_RESOLVED 1761 * 1 PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT 1762 * 111 PFLAG2_TEXT_DIRECTION_RESOLVED_MASK 1763 * 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[1] 1764 * 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[2] 1765 * 11 PFLAG2_TEXT_ALIGNMENT_FLAGS[3] 1766 * 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[4] 1767 * 1 1 PFLAG2_TEXT_ALIGNMENT_FLAGS[5] 1768 * 11 PFLAG2_TEXT_ALIGNMENT_FLAGS[6] 1769 * 111 PFLAG2_TEXT_ALIGNMENT_MASK 1770 * 1 PFLAG2_TEXT_ALIGNMENT_RESOLVED 1771 * 1 PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT 1772 * 111 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK 1773 * 11 PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK 1774 * 1 PFLAG2_HAS_TRANSIENT_STATE 1775 * 1 PFLAG2_ACCESSIBILITY_FOCUSED 1776 * 1 PFLAG2_ACCESSIBILITY_STATE_CHANGED 1777 * 1 PFLAG2_VIEW_QUICK_REJECTED 1778 * 1 PFLAG2_PADDING_RESOLVED 1779 * -------|-------|-------|-------| 1780 */ 1781 1782 /** 1783 * Indicates that this view has reported that it can accept the current drag's content. 1784 * Cleared when the drag operation concludes. 1785 * @hide 1786 */ 1787 static final int PFLAG2_DRAG_CAN_ACCEPT = 0x00000001; 1788 1789 /** 1790 * Indicates that this view is currently directly under the drag location in a 1791 * drag-and-drop operation involving content that it can accept. Cleared when 1792 * the drag exits the view, or when the drag operation concludes. 1793 * @hide 1794 */ 1795 static final int PFLAG2_DRAG_HOVERED = 0x00000002; 1796 1797 /** 1798 * Horizontal layout direction of this view is from Left to Right. 1799 * Use with {@link #setLayoutDirection}. 1800 */ 1801 public static final int LAYOUT_DIRECTION_LTR = 0; 1802 1803 /** 1804 * Horizontal layout direction of this view is from Right to Left. 1805 * Use with {@link #setLayoutDirection}. 1806 */ 1807 public static final int LAYOUT_DIRECTION_RTL = 1; 1808 1809 /** 1810 * Horizontal layout direction of this view is inherited from its parent. 1811 * Use with {@link #setLayoutDirection}. 1812 */ 1813 public static final int LAYOUT_DIRECTION_INHERIT = 2; 1814 1815 /** 1816 * Horizontal layout direction of this view is from deduced from the default language 1817 * script for the locale. Use with {@link #setLayoutDirection}. 1818 */ 1819 public static final int LAYOUT_DIRECTION_LOCALE = 3; 1820 1821 /** 1822 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 1823 * @hide 1824 */ 1825 static final int PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT = 2; 1826 1827 /** 1828 * Mask for use with private flags indicating bits used for horizontal layout direction. 1829 * @hide 1830 */ 1831 static final int PFLAG2_LAYOUT_DIRECTION_MASK = 0x00000003 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1832 1833 /** 1834 * Indicates whether the view horizontal layout direction has been resolved and drawn to the 1835 * right-to-left direction. 1836 * @hide 1837 */ 1838 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL = 4 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1839 1840 /** 1841 * Indicates whether the view horizontal layout direction has been resolved. 1842 * @hide 1843 */ 1844 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED = 8 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1845 1846 /** 1847 * Mask for use with private flags indicating bits used for resolved horizontal layout direction. 1848 * @hide 1849 */ 1850 static final int PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK = 0x0000000C 1851 << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 1852 1853 /* 1854 * Array of horizontal layout direction flags for mapping attribute "layoutDirection" to correct 1855 * flag value. 1856 * @hide 1857 */ 1858 private static final int[] LAYOUT_DIRECTION_FLAGS = { 1859 LAYOUT_DIRECTION_LTR, 1860 LAYOUT_DIRECTION_RTL, 1861 LAYOUT_DIRECTION_INHERIT, 1862 LAYOUT_DIRECTION_LOCALE 1863 }; 1864 1865 /** 1866 * Default horizontal layout direction. 1867 * @hide 1868 */ 1869 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT; 1870 1871 /** 1872 * Indicates that the view is tracking some sort of transient state 1873 * that the app should not need to be aware of, but that the framework 1874 * should take special care to preserve. 1875 * 1876 * @hide 1877 */ 1878 static final int PFLAG2_HAS_TRANSIENT_STATE = 0x1 << 22; 1879 1880 /** 1881 * Text direction is inherited thru {@link ViewGroup} 1882 */ 1883 public static final int TEXT_DIRECTION_INHERIT = 0; 1884 1885 /** 1886 * Text direction is using "first strong algorithm". The first strong directional character 1887 * determines the paragraph direction. If there is no strong directional character, the 1888 * paragraph direction is the view's resolved layout direction. 1889 */ 1890 public static final int TEXT_DIRECTION_FIRST_STRONG = 1; 1891 1892 /** 1893 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains 1894 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters. 1895 * If there are neither, the paragraph direction is the view's resolved layout direction. 1896 */ 1897 public static final int TEXT_DIRECTION_ANY_RTL = 2; 1898 1899 /** 1900 * Text direction is forced to LTR. 1901 */ 1902 public static final int TEXT_DIRECTION_LTR = 3; 1903 1904 /** 1905 * Text direction is forced to RTL. 1906 */ 1907 public static final int TEXT_DIRECTION_RTL = 4; 1908 1909 /** 1910 * Text direction is coming from the system Locale. 1911 */ 1912 public static final int TEXT_DIRECTION_LOCALE = 5; 1913 1914 /** 1915 * Default text direction is inherited 1916 */ 1917 public static int TEXT_DIRECTION_DEFAULT = TEXT_DIRECTION_INHERIT; 1918 1919 /** 1920 * Bit shift to get the horizontal layout direction. (bits after LAYOUT_DIRECTION_RESOLVED) 1921 * @hide 1922 */ 1923 static final int PFLAG2_TEXT_DIRECTION_MASK_SHIFT = 6; 1924 1925 /** 1926 * Mask for use with private flags indicating bits used for text direction. 1927 * @hide 1928 */ 1929 static final int PFLAG2_TEXT_DIRECTION_MASK = 0x00000007 1930 << PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 1931 1932 /** 1933 * Array of text direction flags for mapping attribute "textDirection" to correct 1934 * flag value. 1935 * @hide 1936 */ 1937 private static final int[] PFLAG2_TEXT_DIRECTION_FLAGS = { 1938 TEXT_DIRECTION_INHERIT << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 1939 TEXT_DIRECTION_FIRST_STRONG << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 1940 TEXT_DIRECTION_ANY_RTL << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 1941 TEXT_DIRECTION_LTR << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 1942 TEXT_DIRECTION_RTL << PFLAG2_TEXT_DIRECTION_MASK_SHIFT, 1943 TEXT_DIRECTION_LOCALE << PFLAG2_TEXT_DIRECTION_MASK_SHIFT 1944 }; 1945 1946 /** 1947 * Indicates whether the view text direction has been resolved. 1948 * @hide 1949 */ 1950 static final int PFLAG2_TEXT_DIRECTION_RESOLVED = 0x00000008 1951 << PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 1952 1953 /** 1954 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 1955 * @hide 1956 */ 1957 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT = 10; 1958 1959 /** 1960 * Mask for use with private flags indicating bits used for resolved text direction. 1961 * @hide 1962 */ 1963 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_MASK = 0x00000007 1964 << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 1965 1966 /** 1967 * Indicates whether the view text direction has been resolved to the "first strong" heuristic. 1968 * @hide 1969 */ 1970 static final int PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT = 1971 TEXT_DIRECTION_FIRST_STRONG << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 1972 1973 /* 1974 * Default text alignment. The text alignment of this View is inherited from its parent. 1975 * Use with {@link #setTextAlignment(int)} 1976 */ 1977 public static final int TEXT_ALIGNMENT_INHERIT = 0; 1978 1979 /** 1980 * Default for the root view. The gravity determines the text alignment, ALIGN_NORMAL, 1981 * ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph’s text direction. 1982 * 1983 * Use with {@link #setTextAlignment(int)} 1984 */ 1985 public static final int TEXT_ALIGNMENT_GRAVITY = 1; 1986 1987 /** 1988 * Align to the start of the paragraph, e.g. ALIGN_NORMAL. 1989 * 1990 * Use with {@link #setTextAlignment(int)} 1991 */ 1992 public static final int TEXT_ALIGNMENT_TEXT_START = 2; 1993 1994 /** 1995 * Align to the end of the paragraph, e.g. ALIGN_OPPOSITE. 1996 * 1997 * Use with {@link #setTextAlignment(int)} 1998 */ 1999 public static final int TEXT_ALIGNMENT_TEXT_END = 3; 2000 2001 /** 2002 * Center the paragraph, e.g. ALIGN_CENTER. 2003 * 2004 * Use with {@link #setTextAlignment(int)} 2005 */ 2006 public static final int TEXT_ALIGNMENT_CENTER = 4; 2007 2008 /** 2009 * Align to the start of the view, which is ALIGN_LEFT if the view’s resolved 2010 * layoutDirection is LTR, and ALIGN_RIGHT otherwise. 2011 * 2012 * Use with {@link #setTextAlignment(int)} 2013 */ 2014 public static final int TEXT_ALIGNMENT_VIEW_START = 5; 2015 2016 /** 2017 * Align to the end of the view, which is ALIGN_RIGHT if the view’s resolved 2018 * layoutDirection is LTR, and ALIGN_LEFT otherwise. 2019 * 2020 * Use with {@link #setTextAlignment(int)} 2021 */ 2022 public static final int TEXT_ALIGNMENT_VIEW_END = 6; 2023 2024 /** 2025 * Default text alignment is inherited 2026 */ 2027 public static int TEXT_ALIGNMENT_DEFAULT = TEXT_ALIGNMENT_GRAVITY; 2028 2029 /** 2030 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 2031 * @hide 2032 */ 2033 static final int PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT = 13; 2034 2035 /** 2036 * Mask for use with private flags indicating bits used for text alignment. 2037 * @hide 2038 */ 2039 static final int PFLAG2_TEXT_ALIGNMENT_MASK = 0x00000007 << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 2040 2041 /** 2042 * Array of text direction flags for mapping attribute "textAlignment" to correct 2043 * flag value. 2044 * @hide 2045 */ 2046 private static final int[] PFLAG2_TEXT_ALIGNMENT_FLAGS = { 2047 TEXT_ALIGNMENT_INHERIT << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2048 TEXT_ALIGNMENT_GRAVITY << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2049 TEXT_ALIGNMENT_TEXT_START << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2050 TEXT_ALIGNMENT_TEXT_END << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2051 TEXT_ALIGNMENT_CENTER << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2052 TEXT_ALIGNMENT_VIEW_START << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT, 2053 TEXT_ALIGNMENT_VIEW_END << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT 2054 }; 2055 2056 /** 2057 * Indicates whether the view text alignment has been resolved. 2058 * @hide 2059 */ 2060 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED = 0x00000008 << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 2061 2062 /** 2063 * Bit shift to get the resolved text alignment. 2064 * @hide 2065 */ 2066 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT = 17; 2067 2068 /** 2069 * Mask for use with private flags indicating bits used for text alignment. 2070 * @hide 2071 */ 2072 static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK = 0x00000007 2073 << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 2074 2075 /** 2076 * Indicates whether if the view text alignment has been resolved to gravity 2077 */ 2078 private static final int PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT = 2079 TEXT_ALIGNMENT_GRAVITY << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 2080 2081 // Accessiblity constants for mPrivateFlags2 2082 2083 /** 2084 * Shift for the bits in {@link #mPrivateFlags2} related to the 2085 * "importantForAccessibility" attribute. 2086 */ 2087 static final int PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT = 20; 2088 2089 /** 2090 * Automatically determine whether a view is important for accessibility. 2091 */ 2092 public static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0x00000000; 2093 2094 /** 2095 * The view is important for accessibility. 2096 */ 2097 public static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 0x00000001; 2098 2099 /** 2100 * The view is not important for accessibility. 2101 */ 2102 public static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 0x00000002; 2103 2104 /** 2105 * The default whether the view is important for accessibility. 2106 */ 2107 static final int IMPORTANT_FOR_ACCESSIBILITY_DEFAULT = IMPORTANT_FOR_ACCESSIBILITY_AUTO; 2108 2109 /** 2110 * Mask for obtainig the bits which specify how to determine 2111 * whether a view is important for accessibility. 2112 */ 2113 static final int PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK = (IMPORTANT_FOR_ACCESSIBILITY_AUTO 2114 | IMPORTANT_FOR_ACCESSIBILITY_YES | IMPORTANT_FOR_ACCESSIBILITY_NO) 2115 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2116 2117 /** 2118 * Flag indicating whether a view has accessibility focus. 2119 */ 2120 static final int PFLAG2_ACCESSIBILITY_FOCUSED = 0x00000040 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2121 2122 /** 2123 * Flag indicating whether a view state for accessibility has changed. 2124 */ 2125 static final int PFLAG2_ACCESSIBILITY_STATE_CHANGED = 0x00000080 2126 << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2127 2128 /** 2129 * Flag indicating whether a view failed the quickReject() check in draw(). This condition 2130 * is used to check whether later changes to the view's transform should invalidate the 2131 * view to force the quickReject test to run again. 2132 */ 2133 static final int PFLAG2_VIEW_QUICK_REJECTED = 0x10000000; 2134 2135 /** 2136 * Flag indicating that start/end padding has been resolved into left/right padding 2137 * for use in measurement, layout, drawing, etc. This is set by {@link #resolvePadding()} 2138 * and checked by {@link #measure(int, int)} to determine if padding needs to be resolved 2139 * during measurement. In some special cases this is required such as when an adapter-based 2140 * view measures prospective children without attaching them to a window. 2141 */ 2142 static final int PFLAG2_PADDING_RESOLVED = 0x20000000; 2143 2144 /** 2145 * Flag indicating that the start/end drawables has been resolved into left/right ones. 2146 */ 2147 static final int PFLAG2_DRAWABLE_RESOLVED = 0x40000000; 2148 2149 /** 2150 * Group of bits indicating that RTL properties resolution is done. 2151 */ 2152 static final int ALL_RTL_PROPERTIES_RESOLVED = PFLAG2_LAYOUT_DIRECTION_RESOLVED | 2153 PFLAG2_TEXT_DIRECTION_RESOLVED | 2154 PFLAG2_TEXT_ALIGNMENT_RESOLVED | 2155 PFLAG2_PADDING_RESOLVED | 2156 PFLAG2_DRAWABLE_RESOLVED; 2157 2158 // There are a couple of flags left in mPrivateFlags2 2159 2160 /* End of masks for mPrivateFlags2 */ 2161 2162 /* Masks for mPrivateFlags3 */ 2163 2164 /** 2165 * Flag indicating that view has a transform animation set on it. This is used to track whether 2166 * an animation is cleared between successive frames, in order to tell the associated 2167 * DisplayList to clear its animation matrix. 2168 */ 2169 static final int PFLAG3_VIEW_IS_ANIMATING_TRANSFORM = 0x1; 2170 2171 /** 2172 * Flag indicating that view has an alpha animation set on it. This is used to track whether an 2173 * animation is cleared between successive frames, in order to tell the associated 2174 * DisplayList to restore its alpha value. 2175 */ 2176 static final int PFLAG3_VIEW_IS_ANIMATING_ALPHA = 0x2; 2177 2178 2179 /* End of masks for mPrivateFlags3 */ 2180 2181 static final int DRAG_MASK = PFLAG2_DRAG_CAN_ACCEPT | PFLAG2_DRAG_HOVERED; 2182 2183 /** 2184 * Always allow a user to over-scroll this view, provided it is a 2185 * view that can scroll. 2186 * 2187 * @see #getOverScrollMode() 2188 * @see #setOverScrollMode(int) 2189 */ 2190 public static final int OVER_SCROLL_ALWAYS = 0; 2191 2192 /** 2193 * Allow a user to over-scroll this view only if the content is large 2194 * enough to meaningfully scroll, provided it is a view that can scroll. 2195 * 2196 * @see #getOverScrollMode() 2197 * @see #setOverScrollMode(int) 2198 */ 2199 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1; 2200 2201 /** 2202 * Never allow a user to over-scroll this view. 2203 * 2204 * @see #getOverScrollMode() 2205 * @see #setOverScrollMode(int) 2206 */ 2207 public static final int OVER_SCROLL_NEVER = 2; 2208 2209 /** 2210 * Special constant for {@link #setSystemUiVisibility(int)}: View has 2211 * requested the system UI (status bar) to be visible (the default). 2212 * 2213 * @see #setSystemUiVisibility(int) 2214 */ 2215 public static final int SYSTEM_UI_FLAG_VISIBLE = 0; 2216 2217 /** 2218 * Flag for {@link #setSystemUiVisibility(int)}: View has requested the 2219 * system UI to enter an unobtrusive "low profile" mode. 2220 * 2221 * <p>This is for use in games, book readers, video players, or any other 2222 * "immersive" application where the usual system chrome is deemed too distracting. 2223 * 2224 * <p>In low profile mode, the status bar and/or navigation icons may dim. 2225 * 2226 * @see #setSystemUiVisibility(int) 2227 */ 2228 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001; 2229 2230 /** 2231 * Flag for {@link #setSystemUiVisibility(int)}: View has requested that the 2232 * system navigation be temporarily hidden. 2233 * 2234 * <p>This is an even less obtrusive state than that called for by 2235 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls 2236 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause 2237 * those to disappear. This is useful (in conjunction with the 2238 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and 2239 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN} 2240 * window flags) for displaying content using every last pixel on the display. 2241 * 2242 * <p>There is a limitation: because navigation controls are so important, the least user 2243 * interaction will cause them to reappear immediately. When this happens, both 2244 * this flag and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be cleared automatically, 2245 * so that both elements reappear at the same time. 2246 * 2247 * @see #setSystemUiVisibility(int) 2248 */ 2249 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002; 2250 2251 /** 2252 * Flag for {@link #setSystemUiVisibility(int)}: View has requested to go 2253 * into the normal fullscreen mode so that its content can take over the screen 2254 * while still allowing the user to interact with the application. 2255 * 2256 * <p>This has the same visual effect as 2257 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN 2258 * WindowManager.LayoutParams.FLAG_FULLSCREEN}, 2259 * meaning that non-critical screen decorations (such as the status bar) will be 2260 * hidden while the user is in the View's window, focusing the experience on 2261 * that content. Unlike the window flag, if you are using ActionBar in 2262 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY 2263 * Window.FEATURE_ACTION_BAR_OVERLAY}, then enabling this flag will also 2264 * hide the action bar. 2265 * 2266 * <p>This approach to going fullscreen is best used over the window flag when 2267 * it is a transient state -- that is, the application does this at certain 2268 * points in its user interaction where it wants to allow the user to focus 2269 * on content, but not as a continuous state. For situations where the application 2270 * would like to simply stay full screen the entire time (such as a game that 2271 * wants to take over the screen), the 2272 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN window flag} 2273 * is usually a better approach. The state set here will be removed by the system 2274 * in various situations (such as the user moving to another application) like 2275 * the other system UI states. 2276 * 2277 * <p>When using this flag, the application should provide some easy facility 2278 * for the user to go out of it. A common example would be in an e-book 2279 * reader, where tapping on the screen brings back whatever screen and UI 2280 * decorations that had been hidden while the user was immersed in reading 2281 * the book. 2282 * 2283 * @see #setSystemUiVisibility(int) 2284 */ 2285 public static final int SYSTEM_UI_FLAG_FULLSCREEN = 0x00000004; 2286 2287 /** 2288 * Flag for {@link #setSystemUiVisibility(int)}: When using other layout 2289 * flags, we would like a stable view of the content insets given to 2290 * {@link #fitSystemWindows(Rect)}. This means that the insets seen there 2291 * will always represent the worst case that the application can expect 2292 * as a continuous state. In the stock Android UI this is the space for 2293 * the system bar, nav bar, and status bar, but not more transient elements 2294 * such as an input method. 2295 * 2296 * The stable layout your UI sees is based on the system UI modes you can 2297 * switch to. That is, if you specify {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 2298 * then you will get a stable layout for changes of the 2299 * {@link #SYSTEM_UI_FLAG_FULLSCREEN} mode; if you specify 2300 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} and 2301 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, then you can transition 2302 * to {@link #SYSTEM_UI_FLAG_FULLSCREEN} and {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION} 2303 * with a stable layout. (Note that you should avoid using 2304 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} by itself.) 2305 * 2306 * If you have set the window flag {@link WindowManager.LayoutParams#FLAG_FULLSCREEN} 2307 * to hide the status bar (instead of using {@link #SYSTEM_UI_FLAG_FULLSCREEN}), 2308 * then a hidden status bar will be considered a "stable" state for purposes 2309 * here. This allows your UI to continually hide the status bar, while still 2310 * using the system UI flags to hide the action bar while still retaining 2311 * a stable layout. Note that changing the window fullscreen flag will never 2312 * provide a stable layout for a clean transition. 2313 * 2314 * <p>If you are using ActionBar in 2315 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY 2316 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the 2317 * insets it adds to those given to the application. 2318 */ 2319 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100; 2320 2321 /** 2322 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window 2323 * to be layed out as if it has requested 2324 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This 2325 * allows it to avoid artifacts when switching in and out of that mode, at 2326 * the expense that some of its user interface may be covered by screen 2327 * decorations when they are shown. You can perform layout of your inner 2328 * UI elements to account for the navagation system UI through the 2329 * {@link #fitSystemWindows(Rect)} method. 2330 */ 2331 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200; 2332 2333 /** 2334 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window 2335 * to be layed out as if it has requested 2336 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This 2337 * allows it to avoid artifacts when switching in and out of that mode, at 2338 * the expense that some of its user interface may be covered by screen 2339 * decorations when they are shown. You can perform layout of your inner 2340 * UI elements to account for non-fullscreen system UI through the 2341 * {@link #fitSystemWindows(Rect)} method. 2342 */ 2343 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400; 2344 2345 /** 2346 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead. 2347 */ 2348 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE; 2349 2350 /** 2351 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead. 2352 */ 2353 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE; 2354 2355 /** 2356 * @hide 2357 * 2358 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2359 * out of the public fields to keep the undefined bits out of the developer's way. 2360 * 2361 * Flag to make the status bar not expandable. Unless you also 2362 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show. 2363 */ 2364 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000; 2365 2366 /** 2367 * @hide 2368 * 2369 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2370 * out of the public fields to keep the undefined bits out of the developer's way. 2371 * 2372 * Flag to hide notification icons and scrolling ticker text. 2373 */ 2374 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000; 2375 2376 /** 2377 * @hide 2378 * 2379 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2380 * out of the public fields to keep the undefined bits out of the developer's way. 2381 * 2382 * Flag to disable incoming notification alerts. This will not block 2383 * icons, but it will block sound, vibrating and other visual or aural notifications. 2384 */ 2385 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000; 2386 2387 /** 2388 * @hide 2389 * 2390 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2391 * out of the public fields to keep the undefined bits out of the developer's way. 2392 * 2393 * Flag to hide only the scrolling ticker. Note that 2394 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies 2395 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}. 2396 */ 2397 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000; 2398 2399 /** 2400 * @hide 2401 * 2402 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2403 * out of the public fields to keep the undefined bits out of the developer's way. 2404 * 2405 * Flag to hide the center system info area. 2406 */ 2407 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000; 2408 2409 /** 2410 * @hide 2411 * 2412 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2413 * out of the public fields to keep the undefined bits out of the developer's way. 2414 * 2415 * Flag to hide only the home button. Don't use this 2416 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2417 */ 2418 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000; 2419 2420 /** 2421 * @hide 2422 * 2423 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2424 * out of the public fields to keep the undefined bits out of the developer's way. 2425 * 2426 * Flag to hide only the back button. Don't use this 2427 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2428 */ 2429 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000; 2430 2431 /** 2432 * @hide 2433 * 2434 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2435 * out of the public fields to keep the undefined bits out of the developer's way. 2436 * 2437 * Flag to hide only the clock. You might use this if your activity has 2438 * its own clock making the status bar's clock redundant. 2439 */ 2440 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000; 2441 2442 /** 2443 * @hide 2444 * 2445 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2446 * out of the public fields to keep the undefined bits out of the developer's way. 2447 * 2448 * Flag to hide only the recent apps button. Don't use this 2449 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2450 */ 2451 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000; 2452 2453 /** 2454 * @hide 2455 */ 2456 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF; 2457 2458 /** 2459 * These are the system UI flags that can be cleared by events outside 2460 * of an application. Currently this is just the ability to tap on the 2461 * screen while hiding the navigation bar to have it return. 2462 * @hide 2463 */ 2464 public static final int SYSTEM_UI_CLEARABLE_FLAGS = 2465 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION 2466 | SYSTEM_UI_FLAG_FULLSCREEN; 2467 2468 /** 2469 * Flags that can impact the layout in relation to system UI. 2470 */ 2471 public static final int SYSTEM_UI_LAYOUT_FLAGS = 2472 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION 2473 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN; 2474 2475 /** 2476 * Find views that render the specified text. 2477 * 2478 * @see #findViewsWithText(ArrayList, CharSequence, int) 2479 */ 2480 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001; 2481 2482 /** 2483 * Find find views that contain the specified content description. 2484 * 2485 * @see #findViewsWithText(ArrayList, CharSequence, int) 2486 */ 2487 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002; 2488 2489 /** 2490 * Find views that contain {@link AccessibilityNodeProvider}. Such 2491 * a View is a root of virtual view hierarchy and may contain the searched 2492 * text. If this flag is set Views with providers are automatically 2493 * added and it is a responsibility of the client to call the APIs of 2494 * the provider to determine whether the virtual tree rooted at this View 2495 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s 2496 * represeting the virtual views with this text. 2497 * 2498 * @see #findViewsWithText(ArrayList, CharSequence, int) 2499 * 2500 * @hide 2501 */ 2502 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004; 2503 2504 /** 2505 * The undefined cursor position. 2506 */ 2507 private static final int ACCESSIBILITY_CURSOR_POSITION_UNDEFINED = -1; 2508 2509 /** 2510 * Indicates that the screen has changed state and is now off. 2511 * 2512 * @see #onScreenStateChanged(int) 2513 */ 2514 public static final int SCREEN_STATE_OFF = 0x0; 2515 2516 /** 2517 * Indicates that the screen has changed state and is now on. 2518 * 2519 * @see #onScreenStateChanged(int) 2520 */ 2521 public static final int SCREEN_STATE_ON = 0x1; 2522 2523 /** 2524 * Controls the over-scroll mode for this view. 2525 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)}, 2526 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}, 2527 * and {@link #OVER_SCROLL_NEVER}. 2528 */ 2529 private int mOverScrollMode; 2530 2531 /** 2532 * The parent this view is attached to. 2533 * {@hide} 2534 * 2535 * @see #getParent() 2536 */ 2537 protected ViewParent mParent; 2538 2539 /** 2540 * {@hide} 2541 */ 2542 AttachInfo mAttachInfo; 2543 2544 /** 2545 * {@hide} 2546 */ 2547 @ViewDebug.ExportedProperty(flagMapping = { 2548 @ViewDebug.FlagToString(mask = PFLAG_FORCE_LAYOUT, equals = PFLAG_FORCE_LAYOUT, 2549 name = "FORCE_LAYOUT"), 2550 @ViewDebug.FlagToString(mask = PFLAG_LAYOUT_REQUIRED, equals = PFLAG_LAYOUT_REQUIRED, 2551 name = "LAYOUT_REQUIRED"), 2552 @ViewDebug.FlagToString(mask = PFLAG_DRAWING_CACHE_VALID, equals = PFLAG_DRAWING_CACHE_VALID, 2553 name = "DRAWING_CACHE_INVALID", outputIf = false), 2554 @ViewDebug.FlagToString(mask = PFLAG_DRAWN, equals = PFLAG_DRAWN, name = "DRAWN", outputIf = true), 2555 @ViewDebug.FlagToString(mask = PFLAG_DRAWN, equals = PFLAG_DRAWN, name = "NOT_DRAWN", outputIf = false), 2556 @ViewDebug.FlagToString(mask = PFLAG_DIRTY_MASK, equals = PFLAG_DIRTY_OPAQUE, name = "DIRTY_OPAQUE"), 2557 @ViewDebug.FlagToString(mask = PFLAG_DIRTY_MASK, equals = PFLAG_DIRTY, name = "DIRTY") 2558 }) 2559 int mPrivateFlags; 2560 int mPrivateFlags2; 2561 int mPrivateFlags3; 2562 2563 /** 2564 * This view's request for the visibility of the status bar. 2565 * @hide 2566 */ 2567 @ViewDebug.ExportedProperty(flagMapping = { 2568 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE, 2569 equals = SYSTEM_UI_FLAG_LOW_PROFILE, 2570 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true), 2571 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2572 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2573 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true), 2574 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK, 2575 equals = SYSTEM_UI_FLAG_VISIBLE, 2576 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true) 2577 }) 2578 int mSystemUiVisibility; 2579 2580 /** 2581 * Reference count for transient state. 2582 * @see #setHasTransientState(boolean) 2583 */ 2584 int mTransientStateCount = 0; 2585 2586 /** 2587 * Count of how many windows this view has been attached to. 2588 */ 2589 int mWindowAttachCount; 2590 2591 /** 2592 * The layout parameters associated with this view and used by the parent 2593 * {@link android.view.ViewGroup} to determine how this view should be 2594 * laid out. 2595 * {@hide} 2596 */ 2597 protected ViewGroup.LayoutParams mLayoutParams; 2598 2599 /** 2600 * The view flags hold various views states. 2601 * {@hide} 2602 */ 2603 @ViewDebug.ExportedProperty 2604 int mViewFlags; 2605 2606 static class TransformationInfo { 2607 /** 2608 * The transform matrix for the View. This transform is calculated internally 2609 * based on the rotation, scaleX, and scaleY properties. The identity matrix 2610 * is used by default. Do *not* use this variable directly; instead call 2611 * getMatrix(), which will automatically recalculate the matrix if necessary 2612 * to get the correct matrix based on the latest rotation and scale properties. 2613 */ 2614 private final Matrix mMatrix = new Matrix(); 2615 2616 /** 2617 * The transform matrix for the View. This transform is calculated internally 2618 * based on the rotation, scaleX, and scaleY properties. The identity matrix 2619 * is used by default. Do *not* use this variable directly; instead call 2620 * getInverseMatrix(), which will automatically recalculate the matrix if necessary 2621 * to get the correct matrix based on the latest rotation and scale properties. 2622 */ 2623 private Matrix mInverseMatrix; 2624 2625 /** 2626 * An internal variable that tracks whether we need to recalculate the 2627 * transform matrix, based on whether the rotation or scaleX/Y properties 2628 * have changed since the matrix was last calculated. 2629 */ 2630 boolean mMatrixDirty = false; 2631 2632 /** 2633 * An internal variable that tracks whether we need to recalculate the 2634 * transform matrix, based on whether the rotation or scaleX/Y properties 2635 * have changed since the matrix was last calculated. 2636 */ 2637 private boolean mInverseMatrixDirty = true; 2638 2639 /** 2640 * A variable that tracks whether we need to recalculate the 2641 * transform matrix, based on whether the rotation or scaleX/Y properties 2642 * have changed since the matrix was last calculated. This variable 2643 * is only valid after a call to updateMatrix() or to a function that 2644 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix(). 2645 */ 2646 private boolean mMatrixIsIdentity = true; 2647 2648 /** 2649 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set. 2650 */ 2651 private Camera mCamera = null; 2652 2653 /** 2654 * This matrix is used when computing the matrix for 3D rotations. 2655 */ 2656 private Matrix matrix3D = null; 2657 2658 /** 2659 * These prev values are used to recalculate a centered pivot point when necessary. The 2660 * pivot point is only used in matrix operations (when rotation, scale, or translation are 2661 * set), so thes values are only used then as well. 2662 */ 2663 private int mPrevWidth = -1; 2664 private int mPrevHeight = -1; 2665 2666 /** 2667 * The degrees rotation around the vertical axis through the pivot point. 2668 */ 2669 @ViewDebug.ExportedProperty 2670 float mRotationY = 0f; 2671 2672 /** 2673 * The degrees rotation around the horizontal axis through the pivot point. 2674 */ 2675 @ViewDebug.ExportedProperty 2676 float mRotationX = 0f; 2677 2678 /** 2679 * The degrees rotation around the pivot point. 2680 */ 2681 @ViewDebug.ExportedProperty 2682 float mRotation = 0f; 2683 2684 /** 2685 * The amount of translation of the object away from its left property (post-layout). 2686 */ 2687 @ViewDebug.ExportedProperty 2688 float mTranslationX = 0f; 2689 2690 /** 2691 * The amount of translation of the object away from its top property (post-layout). 2692 */ 2693 @ViewDebug.ExportedProperty 2694 float mTranslationY = 0f; 2695 2696 /** 2697 * The amount of scale in the x direction around the pivot point. A 2698 * value of 1 means no scaling is applied. 2699 */ 2700 @ViewDebug.ExportedProperty 2701 float mScaleX = 1f; 2702 2703 /** 2704 * The amount of scale in the y direction around the pivot point. A 2705 * value of 1 means no scaling is applied. 2706 */ 2707 @ViewDebug.ExportedProperty 2708 float mScaleY = 1f; 2709 2710 /** 2711 * The x location of the point around which the view is rotated and scaled. 2712 */ 2713 @ViewDebug.ExportedProperty 2714 float mPivotX = 0f; 2715 2716 /** 2717 * The y location of the point around which the view is rotated and scaled. 2718 */ 2719 @ViewDebug.ExportedProperty 2720 float mPivotY = 0f; 2721 2722 /** 2723 * The opacity of the View. This is a value from 0 to 1, where 0 means 2724 * completely transparent and 1 means completely opaque. 2725 */ 2726 @ViewDebug.ExportedProperty 2727 float mAlpha = 1f; 2728 } 2729 2730 TransformationInfo mTransformationInfo; 2731 2732 private boolean mLastIsOpaque; 2733 2734 /** 2735 * Convenience value to check for float values that are close enough to zero to be considered 2736 * zero. 2737 */ 2738 private static final float NONZERO_EPSILON = .001f; 2739 2740 /** 2741 * The distance in pixels from the left edge of this view's parent 2742 * to the left edge of this view. 2743 * {@hide} 2744 */ 2745 @ViewDebug.ExportedProperty(category = "layout") 2746 protected int mLeft; 2747 /** 2748 * The distance in pixels from the left edge of this view's parent 2749 * to the right edge of this view. 2750 * {@hide} 2751 */ 2752 @ViewDebug.ExportedProperty(category = "layout") 2753 protected int mRight; 2754 /** 2755 * The distance in pixels from the top edge of this view's parent 2756 * to the top edge of this view. 2757 * {@hide} 2758 */ 2759 @ViewDebug.ExportedProperty(category = "layout") 2760 protected int mTop; 2761 /** 2762 * The distance in pixels from the top edge of this view's parent 2763 * to the bottom edge of this view. 2764 * {@hide} 2765 */ 2766 @ViewDebug.ExportedProperty(category = "layout") 2767 protected int mBottom; 2768 2769 /** 2770 * The offset, in pixels, by which the content of this view is scrolled 2771 * horizontally. 2772 * {@hide} 2773 */ 2774 @ViewDebug.ExportedProperty(category = "scrolling") 2775 protected int mScrollX; 2776 /** 2777 * The offset, in pixels, by which the content of this view is scrolled 2778 * vertically. 2779 * {@hide} 2780 */ 2781 @ViewDebug.ExportedProperty(category = "scrolling") 2782 protected int mScrollY; 2783 2784 /** 2785 * The left padding in pixels, that is the distance in pixels between the 2786 * left edge of this view and the left edge of its content. 2787 * {@hide} 2788 */ 2789 @ViewDebug.ExportedProperty(category = "padding") 2790 protected int mPaddingLeft = 0; 2791 /** 2792 * The right padding in pixels, that is the distance in pixels between the 2793 * right edge of this view and the right edge of its content. 2794 * {@hide} 2795 */ 2796 @ViewDebug.ExportedProperty(category = "padding") 2797 protected int mPaddingRight = 0; 2798 /** 2799 * The top padding in pixels, that is the distance in pixels between the 2800 * top edge of this view and the top edge of its content. 2801 * {@hide} 2802 */ 2803 @ViewDebug.ExportedProperty(category = "padding") 2804 protected int mPaddingTop; 2805 /** 2806 * The bottom padding in pixels, that is the distance in pixels between the 2807 * bottom edge of this view and the bottom edge of its content. 2808 * {@hide} 2809 */ 2810 @ViewDebug.ExportedProperty(category = "padding") 2811 protected int mPaddingBottom; 2812 2813 /** 2814 * The layout insets in pixels, that is the distance in pixels between the 2815 * visible edges of this view its bounds. 2816 */ 2817 private Insets mLayoutInsets; 2818 2819 /** 2820 * Briefly describes the view and is primarily used for accessibility support. 2821 */ 2822 private CharSequence mContentDescription; 2823 2824 /** 2825 * Specifies the id of a view for which this view serves as a label for 2826 * accessibility purposes. 2827 */ 2828 private int mLabelForId = View.NO_ID; 2829 2830 /** 2831 * Predicate for matching labeled view id with its label for 2832 * accessibility purposes. 2833 */ 2834 private MatchLabelForPredicate mMatchLabelForPredicate; 2835 2836 /** 2837 * Predicate for matching a view by its id. 2838 */ 2839 private MatchIdPredicate mMatchIdPredicate; 2840 2841 /** 2842 * Cache the paddingRight set by the user to append to the scrollbar's size. 2843 * 2844 * @hide 2845 */ 2846 @ViewDebug.ExportedProperty(category = "padding") 2847 protected int mUserPaddingRight; 2848 2849 /** 2850 * Cache the paddingBottom set by the user to append to the scrollbar's size. 2851 * 2852 * @hide 2853 */ 2854 @ViewDebug.ExportedProperty(category = "padding") 2855 protected int mUserPaddingBottom; 2856 2857 /** 2858 * Cache the paddingLeft set by the user to append to the scrollbar's size. 2859 * 2860 * @hide 2861 */ 2862 @ViewDebug.ExportedProperty(category = "padding") 2863 protected int mUserPaddingLeft; 2864 2865 /** 2866 * Cache the paddingStart set by the user to append to the scrollbar's size. 2867 * 2868 */ 2869 @ViewDebug.ExportedProperty(category = "padding") 2870 int mUserPaddingStart; 2871 2872 /** 2873 * Cache the paddingEnd set by the user to append to the scrollbar's size. 2874 * 2875 */ 2876 @ViewDebug.ExportedProperty(category = "padding") 2877 int mUserPaddingEnd; 2878 2879 /** 2880 * Cache initial left padding. 2881 * 2882 * @hide 2883 */ 2884 int mUserPaddingLeftInitial = 0; 2885 2886 /** 2887 * Cache initial right padding. 2888 * 2889 * @hide 2890 */ 2891 int mUserPaddingRightInitial = 0; 2892 2893 /** 2894 * Default undefined padding 2895 */ 2896 private static final int UNDEFINED_PADDING = Integer.MIN_VALUE; 2897 2898 /** 2899 * @hide 2900 */ 2901 int mOldWidthMeasureSpec = Integer.MIN_VALUE; 2902 /** 2903 * @hide 2904 */ 2905 int mOldHeightMeasureSpec = Integer.MIN_VALUE; 2906 2907 @ViewDebug.ExportedProperty(deepExport = true, prefix = "bg_") 2908 private Drawable mBackground; 2909 2910 private int mBackgroundResource; 2911 private boolean mBackgroundSizeChanged; 2912 2913 static class ListenerInfo { 2914 /** 2915 * Listener used to dispatch focus change events. 2916 * This field should be made private, so it is hidden from the SDK. 2917 * {@hide} 2918 */ 2919 protected OnFocusChangeListener mOnFocusChangeListener; 2920 2921 /** 2922 * Listeners for layout change events. 2923 */ 2924 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners; 2925 2926 /** 2927 * Listeners for attach events. 2928 */ 2929 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners; 2930 2931 /** 2932 * Listener used to dispatch click events. 2933 * This field should be made private, so it is hidden from the SDK. 2934 * {@hide} 2935 */ 2936 public OnClickListener mOnClickListener; 2937 2938 /** 2939 * Listener used to dispatch long click events. 2940 * This field should be made private, so it is hidden from the SDK. 2941 * {@hide} 2942 */ 2943 protected OnLongClickListener mOnLongClickListener; 2944 2945 /** 2946 * Listener used to build the context menu. 2947 * This field should be made private, so it is hidden from the SDK. 2948 * {@hide} 2949 */ 2950 protected OnCreateContextMenuListener mOnCreateContextMenuListener; 2951 2952 private OnKeyListener mOnKeyListener; 2953 2954 private OnTouchListener mOnTouchListener; 2955 2956 private OnHoverListener mOnHoverListener; 2957 2958 private OnGenericMotionListener mOnGenericMotionListener; 2959 2960 private OnDragListener mOnDragListener; 2961 2962 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener; 2963 } 2964 2965 ListenerInfo mListenerInfo; 2966 2967 /** 2968 * The application environment this view lives in. 2969 * This field should be made private, so it is hidden from the SDK. 2970 * {@hide} 2971 */ 2972 protected Context mContext; 2973 2974 private final Resources mResources; 2975 2976 private ScrollabilityCache mScrollCache; 2977 2978 private int[] mDrawableState = null; 2979 2980 /** 2981 * Set to true when drawing cache is enabled and cannot be created. 2982 * 2983 * @hide 2984 */ 2985 public boolean mCachingFailed; 2986 2987 private Bitmap mDrawingCache; 2988 private Bitmap mUnscaledDrawingCache; 2989 private HardwareLayer mHardwareLayer; 2990 DisplayList mDisplayList; 2991 2992 /** 2993 * When this view has focus and the next focus is {@link #FOCUS_LEFT}, 2994 * the user may specify which view to go to next. 2995 */ 2996 private int mNextFocusLeftId = View.NO_ID; 2997 2998 /** 2999 * When this view has focus and the next focus is {@link #FOCUS_RIGHT}, 3000 * the user may specify which view to go to next. 3001 */ 3002 private int mNextFocusRightId = View.NO_ID; 3003 3004 /** 3005 * When this view has focus and the next focus is {@link #FOCUS_UP}, 3006 * the user may specify which view to go to next. 3007 */ 3008 private int mNextFocusUpId = View.NO_ID; 3009 3010 /** 3011 * When this view has focus and the next focus is {@link #FOCUS_DOWN}, 3012 * the user may specify which view to go to next. 3013 */ 3014 private int mNextFocusDownId = View.NO_ID; 3015 3016 /** 3017 * When this view has focus and the next focus is {@link #FOCUS_FORWARD}, 3018 * the user may specify which view to go to next. 3019 */ 3020 int mNextFocusForwardId = View.NO_ID; 3021 3022 private CheckForLongPress mPendingCheckForLongPress; 3023 private CheckForTap mPendingCheckForTap = null; 3024 private PerformClick mPerformClick; 3025 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent; 3026 3027 private UnsetPressedState mUnsetPressedState; 3028 3029 /** 3030 * Whether the long press's action has been invoked. The tap's action is invoked on the 3031 * up event while a long press is invoked as soon as the long press duration is reached, so 3032 * a long press could be performed before the tap is checked, in which case the tap's action 3033 * should not be invoked. 3034 */ 3035 private boolean mHasPerformedLongPress; 3036 3037 /** 3038 * The minimum height of the view. We'll try our best to have the height 3039 * of this view to at least this amount. 3040 */ 3041 @ViewDebug.ExportedProperty(category = "measurement") 3042 private int mMinHeight; 3043 3044 /** 3045 * The minimum width of the view. We'll try our best to have the width 3046 * of this view to at least this amount. 3047 */ 3048 @ViewDebug.ExportedProperty(category = "measurement") 3049 private int mMinWidth; 3050 3051 /** 3052 * The delegate to handle touch events that are physically in this view 3053 * but should be handled by another view. 3054 */ 3055 private TouchDelegate mTouchDelegate = null; 3056 3057 /** 3058 * Solid color to use as a background when creating the drawing cache. Enables 3059 * the cache to use 16 bit bitmaps instead of 32 bit. 3060 */ 3061 private int mDrawingCacheBackgroundColor = 0; 3062 3063 /** 3064 * Special tree observer used when mAttachInfo is null. 3065 */ 3066 private ViewTreeObserver mFloatingTreeObserver; 3067 3068 /** 3069 * Cache the touch slop from the context that created the view. 3070 */ 3071 private int mTouchSlop; 3072 3073 /** 3074 * Object that handles automatic animation of view properties. 3075 */ 3076 private ViewPropertyAnimator mAnimator = null; 3077 3078 /** 3079 * Flag indicating that a drag can cross window boundaries. When 3080 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called 3081 * with this flag set, all visible applications will be able to participate 3082 * in the drag operation and receive the dragged content. 3083 * 3084 * @hide 3085 */ 3086 public static final int DRAG_FLAG_GLOBAL = 1; 3087 3088 /** 3089 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}. 3090 */ 3091 private float mVerticalScrollFactor; 3092 3093 /** 3094 * Position of the vertical scroll bar. 3095 */ 3096 private int mVerticalScrollbarPosition; 3097 3098 /** 3099 * Position the scroll bar at the default position as determined by the system. 3100 */ 3101 public static final int SCROLLBAR_POSITION_DEFAULT = 0; 3102 3103 /** 3104 * Position the scroll bar along the left edge. 3105 */ 3106 public static final int SCROLLBAR_POSITION_LEFT = 1; 3107 3108 /** 3109 * Position the scroll bar along the right edge. 3110 */ 3111 public static final int SCROLLBAR_POSITION_RIGHT = 2; 3112 3113 /** 3114 * Indicates that the view does not have a layer. 3115 * 3116 * @see #getLayerType() 3117 * @see #setLayerType(int, android.graphics.Paint) 3118 * @see #LAYER_TYPE_SOFTWARE 3119 * @see #LAYER_TYPE_HARDWARE 3120 */ 3121 public static final int LAYER_TYPE_NONE = 0; 3122 3123 /** 3124 * <p>Indicates that the view has a software layer. A software layer is backed 3125 * by a bitmap and causes the view to be rendered using Android's software 3126 * rendering pipeline, even if hardware acceleration is enabled.</p> 3127 * 3128 * <p>Software layers have various usages:</p> 3129 * <p>When the application is not using hardware acceleration, a software layer 3130 * is useful to apply a specific color filter and/or blending mode and/or 3131 * translucency to a view and all its children.</p> 3132 * <p>When the application is using hardware acceleration, a software layer 3133 * is useful to render drawing primitives not supported by the hardware 3134 * accelerated pipeline. It can also be used to cache a complex view tree 3135 * into a texture and reduce the complexity of drawing operations. For instance, 3136 * when animating a complex view tree with a translation, a software layer can 3137 * be used to render the view tree only once.</p> 3138 * <p>Software layers should be avoided when the affected view tree updates 3139 * often. Every update will require to re-render the software layer, which can 3140 * potentially be slow (particularly when hardware acceleration is turned on 3141 * since the layer will have to be uploaded into a hardware texture after every 3142 * update.)</p> 3143 * 3144 * @see #getLayerType() 3145 * @see #setLayerType(int, android.graphics.Paint) 3146 * @see #LAYER_TYPE_NONE 3147 * @see #LAYER_TYPE_HARDWARE 3148 */ 3149 public static final int LAYER_TYPE_SOFTWARE = 1; 3150 3151 /** 3152 * <p>Indicates that the view has a hardware layer. A hardware layer is backed 3153 * by a hardware specific texture (generally Frame Buffer Objects or FBO on 3154 * OpenGL hardware) and causes the view to be rendered using Android's hardware 3155 * rendering pipeline, but only if hardware acceleration is turned on for the 3156 * view hierarchy. When hardware acceleration is turned off, hardware layers 3157 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p> 3158 * 3159 * <p>A hardware layer is useful to apply a specific color filter and/or 3160 * blending mode and/or translucency to a view and all its children.</p> 3161 * <p>A hardware layer can be used to cache a complex view tree into a 3162 * texture and reduce the complexity of drawing operations. For instance, 3163 * when animating a complex view tree with a translation, a hardware layer can 3164 * be used to render the view tree only once.</p> 3165 * <p>A hardware layer can also be used to increase the rendering quality when 3166 * rotation transformations are applied on a view. It can also be used to 3167 * prevent potential clipping issues when applying 3D transforms on a view.</p> 3168 * 3169 * @see #getLayerType() 3170 * @see #setLayerType(int, android.graphics.Paint) 3171 * @see #LAYER_TYPE_NONE 3172 * @see #LAYER_TYPE_SOFTWARE 3173 */ 3174 public static final int LAYER_TYPE_HARDWARE = 2; 3175 3176 @ViewDebug.ExportedProperty(category = "drawing", mapping = { 3177 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"), 3178 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"), 3179 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE") 3180 }) 3181 int mLayerType = LAYER_TYPE_NONE; 3182 Paint mLayerPaint; 3183 Rect mLocalDirtyRect; 3184 3185 /** 3186 * Set to true when the view is sending hover accessibility events because it 3187 * is the innermost hovered view. 3188 */ 3189 private boolean mSendingHoverAccessibilityEvents; 3190 3191 /** 3192 * Delegate for injecting accessibility functionality. 3193 */ 3194 AccessibilityDelegate mAccessibilityDelegate; 3195 3196 /** 3197 * Consistency verifier for debugging purposes. 3198 * @hide 3199 */ 3200 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier = 3201 InputEventConsistencyVerifier.isInstrumentationEnabled() ? 3202 new InputEventConsistencyVerifier(this, 0) : null; 3203 3204 private static final AtomicInteger sNextGeneratedId = new AtomicInteger(1); 3205 3206 /** 3207 * Simple constructor to use when creating a view from code. 3208 * 3209 * @param context The Context the view is running in, through which it can 3210 * access the current theme, resources, etc. 3211 */ 3212 public View(Context context) { 3213 mContext = context; 3214 mResources = context != null ? context.getResources() : null; 3215 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED; 3216 // Set layout and text direction defaults 3217 mPrivateFlags2 = 3218 (LAYOUT_DIRECTION_DEFAULT << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) | 3219 (TEXT_DIRECTION_DEFAULT << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) | 3220 (PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT) | 3221 (TEXT_ALIGNMENT_DEFAULT << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) | 3222 (PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT) | 3223 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT); 3224 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop(); 3225 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS); 3226 mUserPaddingStart = UNDEFINED_PADDING; 3227 mUserPaddingEnd = UNDEFINED_PADDING; 3228 } 3229 3230 /** 3231 * Constructor that is called when inflating a view from XML. This is called 3232 * when a view is being constructed from an XML file, supplying attributes 3233 * that were specified in the XML file. This version uses a default style of 3234 * 0, so the only attribute values applied are those in the Context's Theme 3235 * and the given AttributeSet. 3236 * 3237 * <p> 3238 * The method onFinishInflate() will be called after all children have been 3239 * added. 3240 * 3241 * @param context The Context the view is running in, through which it can 3242 * access the current theme, resources, etc. 3243 * @param attrs The attributes of the XML tag that is inflating the view. 3244 * @see #View(Context, AttributeSet, int) 3245 */ 3246 public View(Context context, AttributeSet attrs) { 3247 this(context, attrs, 0); 3248 } 3249 3250 /** 3251 * Perform inflation from XML and apply a class-specific base style. This 3252 * constructor of View allows subclasses to use their own base style when 3253 * they are inflating. For example, a Button class's constructor would call 3254 * this version of the super class constructor and supply 3255 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows 3256 * the theme's button style to modify all of the base view attributes (in 3257 * particular its background) as well as the Button class's attributes. 3258 * 3259 * @param context The Context the view is running in, through which it can 3260 * access the current theme, resources, etc. 3261 * @param attrs The attributes of the XML tag that is inflating the view. 3262 * @param defStyle The default style to apply to this view. If 0, no style 3263 * will be applied (beyond what is included in the theme). This may 3264 * either be an attribute resource, whose value will be retrieved 3265 * from the current theme, or an explicit style resource. 3266 * @see #View(Context, AttributeSet) 3267 */ 3268 public View(Context context, AttributeSet attrs, int defStyle) { 3269 this(context); 3270 3271 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View, 3272 defStyle, 0); 3273 3274 Drawable background = null; 3275 3276 int leftPadding = -1; 3277 int topPadding = -1; 3278 int rightPadding = -1; 3279 int bottomPadding = -1; 3280 int startPadding = UNDEFINED_PADDING; 3281 int endPadding = UNDEFINED_PADDING; 3282 3283 int padding = -1; 3284 3285 int viewFlagValues = 0; 3286 int viewFlagMasks = 0; 3287 3288 boolean setScrollContainer = false; 3289 3290 int x = 0; 3291 int y = 0; 3292 3293 float tx = 0; 3294 float ty = 0; 3295 float rotation = 0; 3296 float rotationX = 0; 3297 float rotationY = 0; 3298 float sx = 1f; 3299 float sy = 1f; 3300 boolean transformSet = false; 3301 3302 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY; 3303 int overScrollMode = mOverScrollMode; 3304 boolean initializeScrollbars = false; 3305 3306 boolean leftPaddingDefined = false; 3307 boolean rightPaddingDefined = false; 3308 boolean startPaddingDefined = false; 3309 boolean endPaddingDefined = false; 3310 3311 final int targetSdkVersion = context.getApplicationInfo().targetSdkVersion; 3312 3313 final int N = a.getIndexCount(); 3314 for (int i = 0; i < N; i++) { 3315 int attr = a.getIndex(i); 3316 switch (attr) { 3317 case com.android.internal.R.styleable.View_background: 3318 background = a.getDrawable(attr); 3319 break; 3320 case com.android.internal.R.styleable.View_padding: 3321 padding = a.getDimensionPixelSize(attr, -1); 3322 mUserPaddingLeftInitial = padding; 3323 mUserPaddingRightInitial = padding; 3324 leftPaddingDefined = true; 3325 rightPaddingDefined = true; 3326 break; 3327 case com.android.internal.R.styleable.View_paddingLeft: 3328 leftPadding = a.getDimensionPixelSize(attr, -1); 3329 mUserPaddingLeftInitial = leftPadding; 3330 leftPaddingDefined = true; 3331 break; 3332 case com.android.internal.R.styleable.View_paddingTop: 3333 topPadding = a.getDimensionPixelSize(attr, -1); 3334 break; 3335 case com.android.internal.R.styleable.View_paddingRight: 3336 rightPadding = a.getDimensionPixelSize(attr, -1); 3337 mUserPaddingRightInitial = rightPadding; 3338 rightPaddingDefined = true; 3339 break; 3340 case com.android.internal.R.styleable.View_paddingBottom: 3341 bottomPadding = a.getDimensionPixelSize(attr, -1); 3342 break; 3343 case com.android.internal.R.styleable.View_paddingStart: 3344 startPadding = a.getDimensionPixelSize(attr, UNDEFINED_PADDING); 3345 startPaddingDefined = true; 3346 break; 3347 case com.android.internal.R.styleable.View_paddingEnd: 3348 endPadding = a.getDimensionPixelSize(attr, UNDEFINED_PADDING); 3349 endPaddingDefined = true; 3350 break; 3351 case com.android.internal.R.styleable.View_scrollX: 3352 x = a.getDimensionPixelOffset(attr, 0); 3353 break; 3354 case com.android.internal.R.styleable.View_scrollY: 3355 y = a.getDimensionPixelOffset(attr, 0); 3356 break; 3357 case com.android.internal.R.styleable.View_alpha: 3358 setAlpha(a.getFloat(attr, 1f)); 3359 break; 3360 case com.android.internal.R.styleable.View_transformPivotX: 3361 setPivotX(a.getDimensionPixelOffset(attr, 0)); 3362 break; 3363 case com.android.internal.R.styleable.View_transformPivotY: 3364 setPivotY(a.getDimensionPixelOffset(attr, 0)); 3365 break; 3366 case com.android.internal.R.styleable.View_translationX: 3367 tx = a.getDimensionPixelOffset(attr, 0); 3368 transformSet = true; 3369 break; 3370 case com.android.internal.R.styleable.View_translationY: 3371 ty = a.getDimensionPixelOffset(attr, 0); 3372 transformSet = true; 3373 break; 3374 case com.android.internal.R.styleable.View_rotation: 3375 rotation = a.getFloat(attr, 0); 3376 transformSet = true; 3377 break; 3378 case com.android.internal.R.styleable.View_rotationX: 3379 rotationX = a.getFloat(attr, 0); 3380 transformSet = true; 3381 break; 3382 case com.android.internal.R.styleable.View_rotationY: 3383 rotationY = a.getFloat(attr, 0); 3384 transformSet = true; 3385 break; 3386 case com.android.internal.R.styleable.View_scaleX: 3387 sx = a.getFloat(attr, 1f); 3388 transformSet = true; 3389 break; 3390 case com.android.internal.R.styleable.View_scaleY: 3391 sy = a.getFloat(attr, 1f); 3392 transformSet = true; 3393 break; 3394 case com.android.internal.R.styleable.View_id: 3395 mID = a.getResourceId(attr, NO_ID); 3396 break; 3397 case com.android.internal.R.styleable.View_tag: 3398 mTag = a.getText(attr); 3399 break; 3400 case com.android.internal.R.styleable.View_fitsSystemWindows: 3401 if (a.getBoolean(attr, false)) { 3402 viewFlagValues |= FITS_SYSTEM_WINDOWS; 3403 viewFlagMasks |= FITS_SYSTEM_WINDOWS; 3404 } 3405 break; 3406 case com.android.internal.R.styleable.View_focusable: 3407 if (a.getBoolean(attr, false)) { 3408 viewFlagValues |= FOCUSABLE; 3409 viewFlagMasks |= FOCUSABLE_MASK; 3410 } 3411 break; 3412 case com.android.internal.R.styleable.View_focusableInTouchMode: 3413 if (a.getBoolean(attr, false)) { 3414 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE; 3415 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK; 3416 } 3417 break; 3418 case com.android.internal.R.styleable.View_clickable: 3419 if (a.getBoolean(attr, false)) { 3420 viewFlagValues |= CLICKABLE; 3421 viewFlagMasks |= CLICKABLE; 3422 } 3423 break; 3424 case com.android.internal.R.styleable.View_longClickable: 3425 if (a.getBoolean(attr, false)) { 3426 viewFlagValues |= LONG_CLICKABLE; 3427 viewFlagMasks |= LONG_CLICKABLE; 3428 } 3429 break; 3430 case com.android.internal.R.styleable.View_saveEnabled: 3431 if (!a.getBoolean(attr, true)) { 3432 viewFlagValues |= SAVE_DISABLED; 3433 viewFlagMasks |= SAVE_DISABLED_MASK; 3434 } 3435 break; 3436 case com.android.internal.R.styleable.View_duplicateParentState: 3437 if (a.getBoolean(attr, false)) { 3438 viewFlagValues |= DUPLICATE_PARENT_STATE; 3439 viewFlagMasks |= DUPLICATE_PARENT_STATE; 3440 } 3441 break; 3442 case com.android.internal.R.styleable.View_visibility: 3443 final int visibility = a.getInt(attr, 0); 3444 if (visibility != 0) { 3445 viewFlagValues |= VISIBILITY_FLAGS[visibility]; 3446 viewFlagMasks |= VISIBILITY_MASK; 3447 } 3448 break; 3449 case com.android.internal.R.styleable.View_layoutDirection: 3450 // Clear any layout direction flags (included resolved bits) already set 3451 mPrivateFlags2 &= 3452 ~(PFLAG2_LAYOUT_DIRECTION_MASK | PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK); 3453 // Set the layout direction flags depending on the value of the attribute 3454 final int layoutDirection = a.getInt(attr, -1); 3455 final int value = (layoutDirection != -1) ? 3456 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT; 3457 mPrivateFlags2 |= (value << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT); 3458 break; 3459 case com.android.internal.R.styleable.View_drawingCacheQuality: 3460 final int cacheQuality = a.getInt(attr, 0); 3461 if (cacheQuality != 0) { 3462 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality]; 3463 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK; 3464 } 3465 break; 3466 case com.android.internal.R.styleable.View_contentDescription: 3467 setContentDescription(a.getString(attr)); 3468 break; 3469 case com.android.internal.R.styleable.View_labelFor: 3470 setLabelFor(a.getResourceId(attr, NO_ID)); 3471 break; 3472 case com.android.internal.R.styleable.View_soundEffectsEnabled: 3473 if (!a.getBoolean(attr, true)) { 3474 viewFlagValues &= ~SOUND_EFFECTS_ENABLED; 3475 viewFlagMasks |= SOUND_EFFECTS_ENABLED; 3476 } 3477 break; 3478 case com.android.internal.R.styleable.View_hapticFeedbackEnabled: 3479 if (!a.getBoolean(attr, true)) { 3480 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED; 3481 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED; 3482 } 3483 break; 3484 case R.styleable.View_scrollbars: 3485 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE); 3486 if (scrollbars != SCROLLBARS_NONE) { 3487 viewFlagValues |= scrollbars; 3488 viewFlagMasks |= SCROLLBARS_MASK; 3489 initializeScrollbars = true; 3490 } 3491 break; 3492 //noinspection deprecation 3493 case R.styleable.View_fadingEdge: 3494 if (targetSdkVersion >= ICE_CREAM_SANDWICH) { 3495 // Ignore the attribute starting with ICS 3496 break; 3497 } 3498 // With builds < ICS, fall through and apply fading edges 3499 case R.styleable.View_requiresFadingEdge: 3500 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE); 3501 if (fadingEdge != FADING_EDGE_NONE) { 3502 viewFlagValues |= fadingEdge; 3503 viewFlagMasks |= FADING_EDGE_MASK; 3504 initializeFadingEdge(a); 3505 } 3506 break; 3507 case R.styleable.View_scrollbarStyle: 3508 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY); 3509 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 3510 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK; 3511 viewFlagMasks |= SCROLLBARS_STYLE_MASK; 3512 } 3513 break; 3514 case R.styleable.View_isScrollContainer: 3515 setScrollContainer = true; 3516 if (a.getBoolean(attr, false)) { 3517 setScrollContainer(true); 3518 } 3519 break; 3520 case com.android.internal.R.styleable.View_keepScreenOn: 3521 if (a.getBoolean(attr, false)) { 3522 viewFlagValues |= KEEP_SCREEN_ON; 3523 viewFlagMasks |= KEEP_SCREEN_ON; 3524 } 3525 break; 3526 case R.styleable.View_filterTouchesWhenObscured: 3527 if (a.getBoolean(attr, false)) { 3528 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED; 3529 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED; 3530 } 3531 break; 3532 case R.styleable.View_nextFocusLeft: 3533 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID); 3534 break; 3535 case R.styleable.View_nextFocusRight: 3536 mNextFocusRightId = a.getResourceId(attr, View.NO_ID); 3537 break; 3538 case R.styleable.View_nextFocusUp: 3539 mNextFocusUpId = a.getResourceId(attr, View.NO_ID); 3540 break; 3541 case R.styleable.View_nextFocusDown: 3542 mNextFocusDownId = a.getResourceId(attr, View.NO_ID); 3543 break; 3544 case R.styleable.View_nextFocusForward: 3545 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID); 3546 break; 3547 case R.styleable.View_minWidth: 3548 mMinWidth = a.getDimensionPixelSize(attr, 0); 3549 break; 3550 case R.styleable.View_minHeight: 3551 mMinHeight = a.getDimensionPixelSize(attr, 0); 3552 break; 3553 case R.styleable.View_onClick: 3554 if (context.isRestricted()) { 3555 throw new IllegalStateException("The android:onClick attribute cannot " 3556 + "be used within a restricted context"); 3557 } 3558 3559 final String handlerName = a.getString(attr); 3560 if (handlerName != null) { 3561 setOnClickListener(new OnClickListener() { 3562 private Method mHandler; 3563 3564 public void onClick(View v) { 3565 if (mHandler == null) { 3566 try { 3567 mHandler = getContext().getClass().getMethod(handlerName, 3568 View.class); 3569 } catch (NoSuchMethodException e) { 3570 int id = getId(); 3571 String idText = id == NO_ID ? "" : " with id '" 3572 + getContext().getResources().getResourceEntryName( 3573 id) + "'"; 3574 throw new IllegalStateException("Could not find a method " + 3575 handlerName + "(View) in the activity " 3576 + getContext().getClass() + " for onClick handler" 3577 + " on view " + View.this.getClass() + idText, e); 3578 } 3579 } 3580 3581 try { 3582 mHandler.invoke(getContext(), View.this); 3583 } catch (IllegalAccessException e) { 3584 throw new IllegalStateException("Could not execute non " 3585 + "public method of the activity", e); 3586 } catch (InvocationTargetException e) { 3587 throw new IllegalStateException("Could not execute " 3588 + "method of the activity", e); 3589 } 3590 } 3591 }); 3592 } 3593 break; 3594 case R.styleable.View_overScrollMode: 3595 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS); 3596 break; 3597 case R.styleable.View_verticalScrollbarPosition: 3598 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT); 3599 break; 3600 case R.styleable.View_layerType: 3601 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null); 3602 break; 3603 case R.styleable.View_textDirection: 3604 // Clear any text direction flag already set 3605 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 3606 // Set the text direction flags depending on the value of the attribute 3607 final int textDirection = a.getInt(attr, -1); 3608 if (textDirection != -1) { 3609 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_FLAGS[textDirection]; 3610 } 3611 break; 3612 case R.styleable.View_textAlignment: 3613 // Clear any text alignment flag already set 3614 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 3615 // Set the text alignment flag depending on the value of the attribute 3616 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT); 3617 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_FLAGS[textAlignment]; 3618 break; 3619 case R.styleable.View_importantForAccessibility: 3620 setImportantForAccessibility(a.getInt(attr, 3621 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT)); 3622 break; 3623 } 3624 } 3625 3626 setOverScrollMode(overScrollMode); 3627 3628 // Cache start/end user padding as we cannot fully resolve padding here (we dont have yet 3629 // the resolved layout direction). Those cached values will be used later during padding 3630 // resolution. 3631 mUserPaddingStart = startPadding; 3632 mUserPaddingEnd = endPadding; 3633 3634 if (background != null) { 3635 setBackground(background); 3636 } 3637 3638 if (padding >= 0) { 3639 leftPadding = padding; 3640 topPadding = padding; 3641 rightPadding = padding; 3642 bottomPadding = padding; 3643 mUserPaddingLeftInitial = padding; 3644 mUserPaddingRightInitial = padding; 3645 } 3646 3647 if (isRtlCompatibilityMode()) { 3648 // RTL compatibility mode: pre Jelly Bean MR1 case OR no RTL support case. 3649 // left / right padding are used if defined (meaning here nothing to do). If they are not 3650 // defined and start / end padding are defined (e.g. in Frameworks resources), then we use 3651 // start / end and resolve them as left / right (layout direction is not taken into account). 3652 // Padding from the background drawable is stored at this point in mUserPaddingLeftInitial 3653 // and mUserPaddingRightInitial) so drawable padding will be used as ultimate default if 3654 // defined. 3655 if (!leftPaddingDefined && startPaddingDefined) { 3656 leftPadding = startPadding; 3657 } 3658 mUserPaddingLeftInitial = (leftPadding >= 0) ? leftPadding : mUserPaddingLeftInitial; 3659 if (!rightPaddingDefined && endPaddingDefined) { 3660 rightPadding = endPadding; 3661 } 3662 mUserPaddingRightInitial = (rightPadding >= 0) ? rightPadding : mUserPaddingRightInitial; 3663 } else { 3664 // Jelly Bean MR1 and after case: if start/end defined, they will override any left/right 3665 // values defined. Otherwise, left /right values are used. 3666 // Padding from the background drawable is stored at this point in mUserPaddingLeftInitial 3667 // and mUserPaddingRightInitial) so drawable padding will be used as ultimate default if 3668 // defined. 3669 if (leftPaddingDefined) { 3670 mUserPaddingLeftInitial = leftPadding; 3671 } 3672 if (rightPaddingDefined) { 3673 mUserPaddingRightInitial = rightPadding; 3674 } 3675 } 3676 3677 internalSetPadding( 3678 mUserPaddingLeftInitial, 3679 topPadding >= 0 ? topPadding : mPaddingTop, 3680 mUserPaddingRightInitial, 3681 bottomPadding >= 0 ? bottomPadding : mPaddingBottom); 3682 3683 if (viewFlagMasks != 0) { 3684 setFlags(viewFlagValues, viewFlagMasks); 3685 } 3686 3687 if (initializeScrollbars) { 3688 initializeScrollbars(a); 3689 } 3690 3691 a.recycle(); 3692 3693 // Needs to be called after mViewFlags is set 3694 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 3695 recomputePadding(); 3696 } 3697 3698 if (x != 0 || y != 0) { 3699 scrollTo(x, y); 3700 } 3701 3702 if (transformSet) { 3703 setTranslationX(tx); 3704 setTranslationY(ty); 3705 setRotation(rotation); 3706 setRotationX(rotationX); 3707 setRotationY(rotationY); 3708 setScaleX(sx); 3709 setScaleY(sy); 3710 } 3711 3712 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) { 3713 setScrollContainer(true); 3714 } 3715 3716 computeOpaqueFlags(); 3717 } 3718 3719 /** 3720 * Non-public constructor for use in testing 3721 */ 3722 View() { 3723 mResources = null; 3724 } 3725 3726 public String toString() { 3727 StringBuilder out = new StringBuilder(128); 3728 out.append(getClass().getName()); 3729 out.append('{'); 3730 out.append(Integer.toHexString(System.identityHashCode(this))); 3731 out.append(' '); 3732 switch (mViewFlags&VISIBILITY_MASK) { 3733 case VISIBLE: out.append('V'); break; 3734 case INVISIBLE: out.append('I'); break; 3735 case GONE: out.append('G'); break; 3736 default: out.append('.'); break; 3737 } 3738 out.append((mViewFlags&FOCUSABLE_MASK) == FOCUSABLE ? 'F' : '.'); 3739 out.append((mViewFlags&ENABLED_MASK) == ENABLED ? 'E' : '.'); 3740 out.append((mViewFlags&DRAW_MASK) == WILL_NOT_DRAW ? '.' : 'D'); 3741 out.append((mViewFlags&SCROLLBARS_HORIZONTAL) != 0 ? 'H' : '.'); 3742 out.append((mViewFlags&SCROLLBARS_VERTICAL) != 0 ? 'V' : '.'); 3743 out.append((mViewFlags&CLICKABLE) != 0 ? 'C' : '.'); 3744 out.append((mViewFlags&LONG_CLICKABLE) != 0 ? 'L' : '.'); 3745 out.append(' '); 3746 out.append((mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0 ? 'R' : '.'); 3747 out.append((mPrivateFlags&PFLAG_FOCUSED) != 0 ? 'F' : '.'); 3748 out.append((mPrivateFlags&PFLAG_SELECTED) != 0 ? 'S' : '.'); 3749 if ((mPrivateFlags&PFLAG_PREPRESSED) != 0) { 3750 out.append('p'); 3751 } else { 3752 out.append((mPrivateFlags&PFLAG_PRESSED) != 0 ? 'P' : '.'); 3753 } 3754 out.append((mPrivateFlags&PFLAG_HOVERED) != 0 ? 'H' : '.'); 3755 out.append((mPrivateFlags&PFLAG_ACTIVATED) != 0 ? 'A' : '.'); 3756 out.append((mPrivateFlags&PFLAG_INVALIDATED) != 0 ? 'I' : '.'); 3757 out.append((mPrivateFlags&PFLAG_DIRTY_MASK) != 0 ? 'D' : '.'); 3758 out.append(' '); 3759 out.append(mLeft); 3760 out.append(','); 3761 out.append(mTop); 3762 out.append('-'); 3763 out.append(mRight); 3764 out.append(','); 3765 out.append(mBottom); 3766 final int id = getId(); 3767 if (id != NO_ID) { 3768 out.append(" #"); 3769 out.append(Integer.toHexString(id)); 3770 final Resources r = mResources; 3771 if (id != 0 && r != null) { 3772 try { 3773 String pkgname; 3774 switch (id&0xff000000) { 3775 case 0x7f000000: 3776 pkgname="app"; 3777 break; 3778 case 0x01000000: 3779 pkgname="android"; 3780 break; 3781 default: 3782 pkgname = r.getResourcePackageName(id); 3783 break; 3784 } 3785 String typename = r.getResourceTypeName(id); 3786 String entryname = r.getResourceEntryName(id); 3787 out.append(" "); 3788 out.append(pkgname); 3789 out.append(":"); 3790 out.append(typename); 3791 out.append("/"); 3792 out.append(entryname); 3793 } catch (Resources.NotFoundException e) { 3794 } 3795 } 3796 } 3797 out.append("}"); 3798 return out.toString(); 3799 } 3800 3801 /** 3802 * <p> 3803 * Initializes the fading edges from a given set of styled attributes. This 3804 * method should be called by subclasses that need fading edges and when an 3805 * instance of these subclasses is created programmatically rather than 3806 * being inflated from XML. This method is automatically called when the XML 3807 * is inflated. 3808 * </p> 3809 * 3810 * @param a the styled attributes set to initialize the fading edges from 3811 */ 3812 protected void initializeFadingEdge(TypedArray a) { 3813 initScrollCache(); 3814 3815 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize( 3816 R.styleable.View_fadingEdgeLength, 3817 ViewConfiguration.get(mContext).getScaledFadingEdgeLength()); 3818 } 3819 3820 /** 3821 * Returns the size of the vertical faded edges used to indicate that more 3822 * content in this view is visible. 3823 * 3824 * @return The size in pixels of the vertical faded edge or 0 if vertical 3825 * faded edges are not enabled for this view. 3826 * @attr ref android.R.styleable#View_fadingEdgeLength 3827 */ 3828 public int getVerticalFadingEdgeLength() { 3829 if (isVerticalFadingEdgeEnabled()) { 3830 ScrollabilityCache cache = mScrollCache; 3831 if (cache != null) { 3832 return cache.fadingEdgeLength; 3833 } 3834 } 3835 return 0; 3836 } 3837 3838 /** 3839 * Set the size of the faded edge used to indicate that more content in this 3840 * view is available. Will not change whether the fading edge is enabled; use 3841 * {@link #setVerticalFadingEdgeEnabled(boolean)} or 3842 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge 3843 * for the vertical or horizontal fading edges. 3844 * 3845 * @param length The size in pixels of the faded edge used to indicate that more 3846 * content in this view is visible. 3847 */ 3848 public void setFadingEdgeLength(int length) { 3849 initScrollCache(); 3850 mScrollCache.fadingEdgeLength = length; 3851 } 3852 3853 /** 3854 * Returns the size of the horizontal faded edges used to indicate that more 3855 * content in this view is visible. 3856 * 3857 * @return The size in pixels of the horizontal faded edge or 0 if horizontal 3858 * faded edges are not enabled for this view. 3859 * @attr ref android.R.styleable#View_fadingEdgeLength 3860 */ 3861 public int getHorizontalFadingEdgeLength() { 3862 if (isHorizontalFadingEdgeEnabled()) { 3863 ScrollabilityCache cache = mScrollCache; 3864 if (cache != null) { 3865 return cache.fadingEdgeLength; 3866 } 3867 } 3868 return 0; 3869 } 3870 3871 /** 3872 * Returns the width of the vertical scrollbar. 3873 * 3874 * @return The width in pixels of the vertical scrollbar or 0 if there 3875 * is no vertical scrollbar. 3876 */ 3877 public int getVerticalScrollbarWidth() { 3878 ScrollabilityCache cache = mScrollCache; 3879 if (cache != null) { 3880 ScrollBarDrawable scrollBar = cache.scrollBar; 3881 if (scrollBar != null) { 3882 int size = scrollBar.getSize(true); 3883 if (size <= 0) { 3884 size = cache.scrollBarSize; 3885 } 3886 return size; 3887 } 3888 return 0; 3889 } 3890 return 0; 3891 } 3892 3893 /** 3894 * Returns the height of the horizontal scrollbar. 3895 * 3896 * @return The height in pixels of the horizontal scrollbar or 0 if 3897 * there is no horizontal scrollbar. 3898 */ 3899 protected int getHorizontalScrollbarHeight() { 3900 ScrollabilityCache cache = mScrollCache; 3901 if (cache != null) { 3902 ScrollBarDrawable scrollBar = cache.scrollBar; 3903 if (scrollBar != null) { 3904 int size = scrollBar.getSize(false); 3905 if (size <= 0) { 3906 size = cache.scrollBarSize; 3907 } 3908 return size; 3909 } 3910 return 0; 3911 } 3912 return 0; 3913 } 3914 3915 /** 3916 * <p> 3917 * Initializes the scrollbars from a given set of styled attributes. This 3918 * method should be called by subclasses that need scrollbars and when an 3919 * instance of these subclasses is created programmatically rather than 3920 * being inflated from XML. This method is automatically called when the XML 3921 * is inflated. 3922 * </p> 3923 * 3924 * @param a the styled attributes set to initialize the scrollbars from 3925 */ 3926 protected void initializeScrollbars(TypedArray a) { 3927 initScrollCache(); 3928 3929 final ScrollabilityCache scrollabilityCache = mScrollCache; 3930 3931 if (scrollabilityCache.scrollBar == null) { 3932 scrollabilityCache.scrollBar = new ScrollBarDrawable(); 3933 } 3934 3935 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true); 3936 3937 if (!fadeScrollbars) { 3938 scrollabilityCache.state = ScrollabilityCache.ON; 3939 } 3940 scrollabilityCache.fadeScrollBars = fadeScrollbars; 3941 3942 3943 scrollabilityCache.scrollBarFadeDuration = a.getInt( 3944 R.styleable.View_scrollbarFadeDuration, ViewConfiguration 3945 .getScrollBarFadeDuration()); 3946 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt( 3947 R.styleable.View_scrollbarDefaultDelayBeforeFade, 3948 ViewConfiguration.getScrollDefaultDelay()); 3949 3950 3951 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize( 3952 com.android.internal.R.styleable.View_scrollbarSize, 3953 ViewConfiguration.get(mContext).getScaledScrollBarSize()); 3954 3955 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal); 3956 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track); 3957 3958 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal); 3959 if (thumb != null) { 3960 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb); 3961 } 3962 3963 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack, 3964 false); 3965 if (alwaysDraw) { 3966 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true); 3967 } 3968 3969 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical); 3970 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track); 3971 3972 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical); 3973 if (thumb != null) { 3974 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb); 3975 } 3976 3977 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack, 3978 false); 3979 if (alwaysDraw) { 3980 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true); 3981 } 3982 3983 // Apply layout direction to the new Drawables if needed 3984 final int layoutDirection = getLayoutDirection(); 3985 if (track != null) { 3986 track.setLayoutDirection(layoutDirection); 3987 } 3988 if (thumb != null) { 3989 thumb.setLayoutDirection(layoutDirection); 3990 } 3991 3992 // Re-apply user/background padding so that scrollbar(s) get added 3993 resolvePadding(); 3994 } 3995 3996 /** 3997 * <p> 3998 * Initalizes the scrollability cache if necessary. 3999 * </p> 4000 */ 4001 private void initScrollCache() { 4002 if (mScrollCache == null) { 4003 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this); 4004 } 4005 } 4006 4007 private ScrollabilityCache getScrollCache() { 4008 initScrollCache(); 4009 return mScrollCache; 4010 } 4011 4012 /** 4013 * Set the position of the vertical scroll bar. Should be one of 4014 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or 4015 * {@link #SCROLLBAR_POSITION_RIGHT}. 4016 * 4017 * @param position Where the vertical scroll bar should be positioned. 4018 */ 4019 public void setVerticalScrollbarPosition(int position) { 4020 if (mVerticalScrollbarPosition != position) { 4021 mVerticalScrollbarPosition = position; 4022 computeOpaqueFlags(); 4023 resolvePadding(); 4024 } 4025 } 4026 4027 /** 4028 * @return The position where the vertical scroll bar will show, if applicable. 4029 * @see #setVerticalScrollbarPosition(int) 4030 */ 4031 public int getVerticalScrollbarPosition() { 4032 return mVerticalScrollbarPosition; 4033 } 4034 4035 ListenerInfo getListenerInfo() { 4036 if (mListenerInfo != null) { 4037 return mListenerInfo; 4038 } 4039 mListenerInfo = new ListenerInfo(); 4040 return mListenerInfo; 4041 } 4042 4043 /** 4044 * Register a callback to be invoked when focus of this view changed. 4045 * 4046 * @param l The callback that will run. 4047 */ 4048 public void setOnFocusChangeListener(OnFocusChangeListener l) { 4049 getListenerInfo().mOnFocusChangeListener = l; 4050 } 4051 4052 /** 4053 * Add a listener that will be called when the bounds of the view change due to 4054 * layout processing. 4055 * 4056 * @param listener The listener that will be called when layout bounds change. 4057 */ 4058 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) { 4059 ListenerInfo li = getListenerInfo(); 4060 if (li.mOnLayoutChangeListeners == null) { 4061 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>(); 4062 } 4063 if (!li.mOnLayoutChangeListeners.contains(listener)) { 4064 li.mOnLayoutChangeListeners.add(listener); 4065 } 4066 } 4067 4068 /** 4069 * Remove a listener for layout changes. 4070 * 4071 * @param listener The listener for layout bounds change. 4072 */ 4073 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) { 4074 ListenerInfo li = mListenerInfo; 4075 if (li == null || li.mOnLayoutChangeListeners == null) { 4076 return; 4077 } 4078 li.mOnLayoutChangeListeners.remove(listener); 4079 } 4080 4081 /** 4082 * Add a listener for attach state changes. 4083 * 4084 * This listener will be called whenever this view is attached or detached 4085 * from a window. Remove the listener using 4086 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}. 4087 * 4088 * @param listener Listener to attach 4089 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener) 4090 */ 4091 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 4092 ListenerInfo li = getListenerInfo(); 4093 if (li.mOnAttachStateChangeListeners == null) { 4094 li.mOnAttachStateChangeListeners 4095 = new CopyOnWriteArrayList<OnAttachStateChangeListener>(); 4096 } 4097 li.mOnAttachStateChangeListeners.add(listener); 4098 } 4099 4100 /** 4101 * Remove a listener for attach state changes. The listener will receive no further 4102 * notification of window attach/detach events. 4103 * 4104 * @param listener Listener to remove 4105 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener) 4106 */ 4107 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 4108 ListenerInfo li = mListenerInfo; 4109 if (li == null || li.mOnAttachStateChangeListeners == null) { 4110 return; 4111 } 4112 li.mOnAttachStateChangeListeners.remove(listener); 4113 } 4114 4115 /** 4116 * Returns the focus-change callback registered for this view. 4117 * 4118 * @return The callback, or null if one is not registered. 4119 */ 4120 public OnFocusChangeListener getOnFocusChangeListener() { 4121 ListenerInfo li = mListenerInfo; 4122 return li != null ? li.mOnFocusChangeListener : null; 4123 } 4124 4125 /** 4126 * Register a callback to be invoked when this view is clicked. If this view is not 4127 * clickable, it becomes clickable. 4128 * 4129 * @param l The callback that will run 4130 * 4131 * @see #setClickable(boolean) 4132 */ 4133 public void setOnClickListener(OnClickListener l) { 4134 if (!isClickable()) { 4135 setClickable(true); 4136 } 4137 getListenerInfo().mOnClickListener = l; 4138 } 4139 4140 /** 4141 * Return whether this view has an attached OnClickListener. Returns 4142 * true if there is a listener, false if there is none. 4143 */ 4144 public boolean hasOnClickListeners() { 4145 ListenerInfo li = mListenerInfo; 4146 return (li != null && li.mOnClickListener != null); 4147 } 4148 4149 /** 4150 * Register a callback to be invoked when this view is clicked and held. If this view is not 4151 * long clickable, it becomes long clickable. 4152 * 4153 * @param l The callback that will run 4154 * 4155 * @see #setLongClickable(boolean) 4156 */ 4157 public void setOnLongClickListener(OnLongClickListener l) { 4158 if (!isLongClickable()) { 4159 setLongClickable(true); 4160 } 4161 getListenerInfo().mOnLongClickListener = l; 4162 } 4163 4164 /** 4165 * Register a callback to be invoked when the context menu for this view is 4166 * being built. If this view is not long clickable, it becomes long clickable. 4167 * 4168 * @param l The callback that will run 4169 * 4170 */ 4171 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) { 4172 if (!isLongClickable()) { 4173 setLongClickable(true); 4174 } 4175 getListenerInfo().mOnCreateContextMenuListener = l; 4176 } 4177 4178 /** 4179 * Call this view's OnClickListener, if it is defined. Performs all normal 4180 * actions associated with clicking: reporting accessibility event, playing 4181 * a sound, etc. 4182 * 4183 * @return True there was an assigned OnClickListener that was called, false 4184 * otherwise is returned. 4185 */ 4186 public boolean performClick() { 4187 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED); 4188 4189 ListenerInfo li = mListenerInfo; 4190 if (li != null && li.mOnClickListener != null) { 4191 playSoundEffect(SoundEffectConstants.CLICK); 4192 li.mOnClickListener.onClick(this); 4193 return true; 4194 } 4195 4196 return false; 4197 } 4198 4199 /** 4200 * Directly call any attached OnClickListener. Unlike {@link #performClick()}, 4201 * this only calls the listener, and does not do any associated clicking 4202 * actions like reporting an accessibility event. 4203 * 4204 * @return True there was an assigned OnClickListener that was called, false 4205 * otherwise is returned. 4206 */ 4207 public boolean callOnClick() { 4208 ListenerInfo li = mListenerInfo; 4209 if (li != null && li.mOnClickListener != null) { 4210 li.mOnClickListener.onClick(this); 4211 return true; 4212 } 4213 return false; 4214 } 4215 4216 /** 4217 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the 4218 * OnLongClickListener did not consume the event. 4219 * 4220 * @return True if one of the above receivers consumed the event, false otherwise. 4221 */ 4222 public boolean performLongClick() { 4223 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED); 4224 4225 boolean handled = false; 4226 ListenerInfo li = mListenerInfo; 4227 if (li != null && li.mOnLongClickListener != null) { 4228 handled = li.mOnLongClickListener.onLongClick(View.this); 4229 } 4230 if (!handled) { 4231 handled = showContextMenu(); 4232 } 4233 if (handled) { 4234 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); 4235 } 4236 return handled; 4237 } 4238 4239 /** 4240 * Performs button-related actions during a touch down event. 4241 * 4242 * @param event The event. 4243 * @return True if the down was consumed. 4244 * 4245 * @hide 4246 */ 4247 protected boolean performButtonActionOnTouchDown(MotionEvent event) { 4248 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) { 4249 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) { 4250 return true; 4251 } 4252 } 4253 return false; 4254 } 4255 4256 /** 4257 * Bring up the context menu for this view. 4258 * 4259 * @return Whether a context menu was displayed. 4260 */ 4261 public boolean showContextMenu() { 4262 return getParent().showContextMenuForChild(this); 4263 } 4264 4265 /** 4266 * Bring up the context menu for this view, referring to the item under the specified point. 4267 * 4268 * @param x The referenced x coordinate. 4269 * @param y The referenced y coordinate. 4270 * @param metaState The keyboard modifiers that were pressed. 4271 * @return Whether a context menu was displayed. 4272 * 4273 * @hide 4274 */ 4275 public boolean showContextMenu(float x, float y, int metaState) { 4276 return showContextMenu(); 4277 } 4278 4279 /** 4280 * Start an action mode. 4281 * 4282 * @param callback Callback that will control the lifecycle of the action mode 4283 * @return The new action mode if it is started, null otherwise 4284 * 4285 * @see ActionMode 4286 */ 4287 public ActionMode startActionMode(ActionMode.Callback callback) { 4288 ViewParent parent = getParent(); 4289 if (parent == null) return null; 4290 return parent.startActionModeForChild(this, callback); 4291 } 4292 4293 /** 4294 * Register a callback to be invoked when a hardware key is pressed in this view. 4295 * Key presses in software input methods will generally not trigger the methods of 4296 * this listener. 4297 * @param l the key listener to attach to this view 4298 */ 4299 public void setOnKeyListener(OnKeyListener l) { 4300 getListenerInfo().mOnKeyListener = l; 4301 } 4302 4303 /** 4304 * Register a callback to be invoked when a touch event is sent to this view. 4305 * @param l the touch listener to attach to this view 4306 */ 4307 public void setOnTouchListener(OnTouchListener l) { 4308 getListenerInfo().mOnTouchListener = l; 4309 } 4310 4311 /** 4312 * Register a callback to be invoked when a generic motion event is sent to this view. 4313 * @param l the generic motion listener to attach to this view 4314 */ 4315 public void setOnGenericMotionListener(OnGenericMotionListener l) { 4316 getListenerInfo().mOnGenericMotionListener = l; 4317 } 4318 4319 /** 4320 * Register a callback to be invoked when a hover event is sent to this view. 4321 * @param l the hover listener to attach to this view 4322 */ 4323 public void setOnHoverListener(OnHoverListener l) { 4324 getListenerInfo().mOnHoverListener = l; 4325 } 4326 4327 /** 4328 * Register a drag event listener callback object for this View. The parameter is 4329 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a 4330 * View, the system calls the 4331 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method. 4332 * @param l An implementation of {@link android.view.View.OnDragListener}. 4333 */ 4334 public void setOnDragListener(OnDragListener l) { 4335 getListenerInfo().mOnDragListener = l; 4336 } 4337 4338 /** 4339 * Give this view focus. This will cause 4340 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called. 4341 * 4342 * Note: this does not check whether this {@link View} should get focus, it just 4343 * gives it focus no matter what. It should only be called internally by framework 4344 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}. 4345 * 4346 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN}, 4347 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which 4348 * focus moved when requestFocus() is called. It may not always 4349 * apply, in which case use the default View.FOCUS_DOWN. 4350 * @param previouslyFocusedRect The rectangle of the view that had focus 4351 * prior in this View's coordinate system. 4352 */ 4353 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) { 4354 if (DBG) { 4355 System.out.println(this + " requestFocus()"); 4356 } 4357 4358 if ((mPrivateFlags & PFLAG_FOCUSED) == 0) { 4359 mPrivateFlags |= PFLAG_FOCUSED; 4360 4361 if (mParent != null) { 4362 mParent.requestChildFocus(this, this); 4363 } 4364 4365 onFocusChanged(true, direction, previouslyFocusedRect); 4366 refreshDrawableState(); 4367 4368 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4369 notifyAccessibilityStateChanged(); 4370 } 4371 } 4372 } 4373 4374 /** 4375 * Request that a rectangle of this view be visible on the screen, 4376 * scrolling if necessary just enough. 4377 * 4378 * <p>A View should call this if it maintains some notion of which part 4379 * of its content is interesting. For example, a text editing view 4380 * should call this when its cursor moves. 4381 * 4382 * @param rectangle The rectangle. 4383 * @return Whether any parent scrolled. 4384 */ 4385 public boolean requestRectangleOnScreen(Rect rectangle) { 4386 return requestRectangleOnScreen(rectangle, false); 4387 } 4388 4389 /** 4390 * Request that a rectangle of this view be visible on the screen, 4391 * scrolling if necessary just enough. 4392 * 4393 * <p>A View should call this if it maintains some notion of which part 4394 * of its content is interesting. For example, a text editing view 4395 * should call this when its cursor moves. 4396 * 4397 * <p>When <code>immediate</code> is set to true, scrolling will not be 4398 * animated. 4399 * 4400 * @param rectangle The rectangle. 4401 * @param immediate True to forbid animated scrolling, false otherwise 4402 * @return Whether any parent scrolled. 4403 */ 4404 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) { 4405 if (mParent == null) { 4406 return false; 4407 } 4408 4409 View child = this; 4410 4411 RectF position = (mAttachInfo != null) ? mAttachInfo.mTmpTransformRect : new RectF(); 4412 position.set(rectangle); 4413 4414 ViewParent parent = mParent; 4415 boolean scrolled = false; 4416 while (parent != null) { 4417 rectangle.set((int) position.left, (int) position.top, 4418 (int) position.right, (int) position.bottom); 4419 4420 scrolled |= parent.requestChildRectangleOnScreen(child, 4421 rectangle, immediate); 4422 4423 if (!child.hasIdentityMatrix()) { 4424 child.getMatrix().mapRect(position); 4425 } 4426 4427 position.offset(child.mLeft, child.mTop); 4428 4429 if (!(parent instanceof View)) { 4430 break; 4431 } 4432 4433 View parentView = (View) parent; 4434 4435 position.offset(-parentView.getScrollX(), -parentView.getScrollY()); 4436 4437 child = parentView; 4438 parent = child.getParent(); 4439 } 4440 4441 return scrolled; 4442 } 4443 4444 /** 4445 * Called when this view wants to give up focus. If focus is cleared 4446 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called. 4447 * <p> 4448 * <strong>Note:</strong> When a View clears focus the framework is trying 4449 * to give focus to the first focusable View from the top. Hence, if this 4450 * View is the first from the top that can take focus, then all callbacks 4451 * related to clearing focus will be invoked after wich the framework will 4452 * give focus to this view. 4453 * </p> 4454 */ 4455 public void clearFocus() { 4456 if (DBG) { 4457 System.out.println(this + " clearFocus()"); 4458 } 4459 4460 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 4461 mPrivateFlags &= ~PFLAG_FOCUSED; 4462 4463 if (mParent != null) { 4464 mParent.clearChildFocus(this); 4465 } 4466 4467 onFocusChanged(false, 0, null); 4468 4469 refreshDrawableState(); 4470 4471 ensureInputFocusOnFirstFocusable(); 4472 4473 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4474 notifyAccessibilityStateChanged(); 4475 } 4476 } 4477 } 4478 4479 void ensureInputFocusOnFirstFocusable() { 4480 View root = getRootView(); 4481 if (root != null) { 4482 root.requestFocus(); 4483 } 4484 } 4485 4486 /** 4487 * Called internally by the view system when a new view is getting focus. 4488 * This is what clears the old focus. 4489 */ 4490 void unFocus() { 4491 if (DBG) { 4492 System.out.println(this + " unFocus()"); 4493 } 4494 4495 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 4496 mPrivateFlags &= ~PFLAG_FOCUSED; 4497 4498 onFocusChanged(false, 0, null); 4499 refreshDrawableState(); 4500 4501 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4502 notifyAccessibilityStateChanged(); 4503 } 4504 } 4505 } 4506 4507 /** 4508 * Returns true if this view has focus iteself, or is the ancestor of the 4509 * view that has focus. 4510 * 4511 * @return True if this view has or contains focus, false otherwise. 4512 */ 4513 @ViewDebug.ExportedProperty(category = "focus") 4514 public boolean hasFocus() { 4515 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 4516 } 4517 4518 /** 4519 * Returns true if this view is focusable or if it contains a reachable View 4520 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()" 4521 * is a View whose parents do not block descendants focus. 4522 * 4523 * Only {@link #VISIBLE} views are considered focusable. 4524 * 4525 * @return True if the view is focusable or if the view contains a focusable 4526 * View, false otherwise. 4527 * 4528 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS 4529 */ 4530 public boolean hasFocusable() { 4531 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable(); 4532 } 4533 4534 /** 4535 * Called by the view system when the focus state of this view changes. 4536 * When the focus change event is caused by directional navigation, direction 4537 * and previouslyFocusedRect provide insight into where the focus is coming from. 4538 * When overriding, be sure to call up through to the super class so that 4539 * the standard focus handling will occur. 4540 * 4541 * @param gainFocus True if the View has focus; false otherwise. 4542 * @param direction The direction focus has moved when requestFocus() 4543 * is called to give this view focus. Values are 4544 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT}, 4545 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}. 4546 * It may not always apply, in which case use the default. 4547 * @param previouslyFocusedRect The rectangle, in this view's coordinate 4548 * system, of the previously focused view. If applicable, this will be 4549 * passed in as finer grained information about where the focus is coming 4550 * from (in addition to direction). Will be <code>null</code> otherwise. 4551 */ 4552 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) { 4553 if (gainFocus) { 4554 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4555 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED); 4556 } 4557 } 4558 4559 InputMethodManager imm = InputMethodManager.peekInstance(); 4560 if (!gainFocus) { 4561 if (isPressed()) { 4562 setPressed(false); 4563 } 4564 if (imm != null && mAttachInfo != null 4565 && mAttachInfo.mHasWindowFocus) { 4566 imm.focusOut(this); 4567 } 4568 onFocusLost(); 4569 } else if (imm != null && mAttachInfo != null 4570 && mAttachInfo.mHasWindowFocus) { 4571 imm.focusIn(this); 4572 } 4573 4574 invalidate(true); 4575 ListenerInfo li = mListenerInfo; 4576 if (li != null && li.mOnFocusChangeListener != null) { 4577 li.mOnFocusChangeListener.onFocusChange(this, gainFocus); 4578 } 4579 4580 if (mAttachInfo != null) { 4581 mAttachInfo.mKeyDispatchState.reset(this); 4582 } 4583 } 4584 4585 /** 4586 * Sends an accessibility event of the given type. If accessibility is 4587 * not enabled this method has no effect. The default implementation calls 4588 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first 4589 * to populate information about the event source (this View), then calls 4590 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to 4591 * populate the text content of the event source including its descendants, 4592 * and last calls 4593 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)} 4594 * on its parent to resuest sending of the event to interested parties. 4595 * <p> 4596 * If an {@link AccessibilityDelegate} has been specified via calling 4597 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4598 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is 4599 * responsible for handling this call. 4600 * </p> 4601 * 4602 * @param eventType The type of the event to send, as defined by several types from 4603 * {@link android.view.accessibility.AccessibilityEvent}, such as 4604 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or 4605 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}. 4606 * 4607 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 4608 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4609 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent) 4610 * @see AccessibilityDelegate 4611 */ 4612 public void sendAccessibilityEvent(int eventType) { 4613 if (mAccessibilityDelegate != null) { 4614 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType); 4615 } else { 4616 sendAccessibilityEventInternal(eventType); 4617 } 4618 } 4619 4620 /** 4621 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT} 4622 * {@link AccessibilityEvent} to make an announcement which is related to some 4623 * sort of a context change for which none of the events representing UI transitions 4624 * is a good fit. For example, announcing a new page in a book. If accessibility 4625 * is not enabled this method does nothing. 4626 * 4627 * @param text The announcement text. 4628 */ 4629 public void announceForAccessibility(CharSequence text) { 4630 if (AccessibilityManager.getInstance(mContext).isEnabled() && mParent != null) { 4631 AccessibilityEvent event = AccessibilityEvent.obtain( 4632 AccessibilityEvent.TYPE_ANNOUNCEMENT); 4633 onInitializeAccessibilityEvent(event); 4634 event.getText().add(text); 4635 event.setContentDescription(null); 4636 mParent.requestSendAccessibilityEvent(this, event); 4637 } 4638 } 4639 4640 /** 4641 * @see #sendAccessibilityEvent(int) 4642 * 4643 * Note: Called from the default {@link AccessibilityDelegate}. 4644 */ 4645 void sendAccessibilityEventInternal(int eventType) { 4646 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4647 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType)); 4648 } 4649 } 4650 4651 /** 4652 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but 4653 * takes as an argument an empty {@link AccessibilityEvent} and does not 4654 * perform a check whether accessibility is enabled. 4655 * <p> 4656 * If an {@link AccessibilityDelegate} has been specified via calling 4657 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4658 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)} 4659 * is responsible for handling this call. 4660 * </p> 4661 * 4662 * @param event The event to send. 4663 * 4664 * @see #sendAccessibilityEvent(int) 4665 */ 4666 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) { 4667 if (mAccessibilityDelegate != null) { 4668 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event); 4669 } else { 4670 sendAccessibilityEventUncheckedInternal(event); 4671 } 4672 } 4673 4674 /** 4675 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent) 4676 * 4677 * Note: Called from the default {@link AccessibilityDelegate}. 4678 */ 4679 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) { 4680 if (!isShown()) { 4681 return; 4682 } 4683 onInitializeAccessibilityEvent(event); 4684 // Only a subset of accessibility events populates text content. 4685 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) { 4686 dispatchPopulateAccessibilityEvent(event); 4687 } 4688 // In the beginning we called #isShown(), so we know that getParent() is not null. 4689 getParent().requestSendAccessibilityEvent(this, event); 4690 } 4691 4692 /** 4693 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then 4694 * to its children for adding their text content to the event. Note that the 4695 * event text is populated in a separate dispatch path since we add to the 4696 * event not only the text of the source but also the text of all its descendants. 4697 * A typical implementation will call 4698 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view 4699 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 4700 * on each child. Override this method if custom population of the event text 4701 * content is required. 4702 * <p> 4703 * If an {@link AccessibilityDelegate} has been specified via calling 4704 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4705 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)} 4706 * is responsible for handling this call. 4707 * </p> 4708 * <p> 4709 * <em>Note:</em> Accessibility events of certain types are not dispatched for 4710 * populating the event text via this method. For details refer to {@link AccessibilityEvent}. 4711 * </p> 4712 * 4713 * @param event The event. 4714 * 4715 * @return True if the event population was completed. 4716 */ 4717 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 4718 if (mAccessibilityDelegate != null) { 4719 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event); 4720 } else { 4721 return dispatchPopulateAccessibilityEventInternal(event); 4722 } 4723 } 4724 4725 /** 4726 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4727 * 4728 * Note: Called from the default {@link AccessibilityDelegate}. 4729 */ 4730 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) { 4731 onPopulateAccessibilityEvent(event); 4732 return false; 4733 } 4734 4735 /** 4736 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 4737 * giving a chance to this View to populate the accessibility event with its 4738 * text content. While this method is free to modify event 4739 * attributes other than text content, doing so should normally be performed in 4740 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}. 4741 * <p> 4742 * Example: Adding formatted date string to an accessibility event in addition 4743 * to the text added by the super implementation: 4744 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 4745 * super.onPopulateAccessibilityEvent(event); 4746 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY; 4747 * String selectedDateUtterance = DateUtils.formatDateTime(mContext, 4748 * mCurrentDate.getTimeInMillis(), flags); 4749 * event.getText().add(selectedDateUtterance); 4750 * }</pre> 4751 * <p> 4752 * If an {@link AccessibilityDelegate} has been specified via calling 4753 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4754 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)} 4755 * is responsible for handling this call. 4756 * </p> 4757 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 4758 * information to the event, in case the default implementation has basic information to add. 4759 * </p> 4760 * 4761 * @param event The accessibility event which to populate. 4762 * 4763 * @see #sendAccessibilityEvent(int) 4764 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4765 */ 4766 public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 4767 if (mAccessibilityDelegate != null) { 4768 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event); 4769 } else { 4770 onPopulateAccessibilityEventInternal(event); 4771 } 4772 } 4773 4774 /** 4775 * @see #onPopulateAccessibilityEvent(AccessibilityEvent) 4776 * 4777 * Note: Called from the default {@link AccessibilityDelegate}. 4778 */ 4779 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) { 4780 4781 } 4782 4783 /** 4784 * Initializes an {@link AccessibilityEvent} with information about 4785 * this View which is the event source. In other words, the source of 4786 * an accessibility event is the view whose state change triggered firing 4787 * the event. 4788 * <p> 4789 * Example: Setting the password property of an event in addition 4790 * to properties set by the super implementation: 4791 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 4792 * super.onInitializeAccessibilityEvent(event); 4793 * event.setPassword(true); 4794 * }</pre> 4795 * <p> 4796 * If an {@link AccessibilityDelegate} has been specified via calling 4797 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4798 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)} 4799 * is responsible for handling this call. 4800 * </p> 4801 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 4802 * information to the event, in case the default implementation has basic information to add. 4803 * </p> 4804 * @param event The event to initialize. 4805 * 4806 * @see #sendAccessibilityEvent(int) 4807 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4808 */ 4809 public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 4810 if (mAccessibilityDelegate != null) { 4811 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event); 4812 } else { 4813 onInitializeAccessibilityEventInternal(event); 4814 } 4815 } 4816 4817 /** 4818 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 4819 * 4820 * Note: Called from the default {@link AccessibilityDelegate}. 4821 */ 4822 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) { 4823 event.setSource(this); 4824 event.setClassName(View.class.getName()); 4825 event.setPackageName(getContext().getPackageName()); 4826 event.setEnabled(isEnabled()); 4827 event.setContentDescription(mContentDescription); 4828 4829 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) { 4830 ArrayList<View> focusablesTempList = mAttachInfo.mTempArrayList; 4831 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, 4832 FOCUSABLES_ALL); 4833 event.setItemCount(focusablesTempList.size()); 4834 event.setCurrentItemIndex(focusablesTempList.indexOf(this)); 4835 focusablesTempList.clear(); 4836 } 4837 } 4838 4839 /** 4840 * Returns an {@link AccessibilityNodeInfo} representing this view from the 4841 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 4842 * This method is responsible for obtaining an accessibility node info from a 4843 * pool of reusable instances and calling 4844 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to 4845 * initialize the former. 4846 * <p> 4847 * Note: The client is responsible for recycling the obtained instance by calling 4848 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation. 4849 * </p> 4850 * 4851 * @return A populated {@link AccessibilityNodeInfo}. 4852 * 4853 * @see AccessibilityNodeInfo 4854 */ 4855 public AccessibilityNodeInfo createAccessibilityNodeInfo() { 4856 AccessibilityNodeProvider provider = getAccessibilityNodeProvider(); 4857 if (provider != null) { 4858 return provider.createAccessibilityNodeInfo(View.NO_ID); 4859 } else { 4860 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this); 4861 onInitializeAccessibilityNodeInfo(info); 4862 return info; 4863 } 4864 } 4865 4866 /** 4867 * Initializes an {@link AccessibilityNodeInfo} with information about this view. 4868 * The base implementation sets: 4869 * <ul> 4870 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li> 4871 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li> 4872 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li> 4873 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li> 4874 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li> 4875 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li> 4876 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li> 4877 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li> 4878 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li> 4879 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li> 4880 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li> 4881 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li> 4882 * </ul> 4883 * <p> 4884 * Subclasses should override this method, call the super implementation, 4885 * and set additional attributes. 4886 * </p> 4887 * <p> 4888 * If an {@link AccessibilityDelegate} has been specified via calling 4889 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4890 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)} 4891 * is responsible for handling this call. 4892 * </p> 4893 * 4894 * @param info The instance to initialize. 4895 */ 4896 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 4897 if (mAccessibilityDelegate != null) { 4898 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info); 4899 } else { 4900 onInitializeAccessibilityNodeInfoInternal(info); 4901 } 4902 } 4903 4904 /** 4905 * Gets the location of this view in screen coordintates. 4906 * 4907 * @param outRect The output location 4908 */ 4909 private void getBoundsOnScreen(Rect outRect) { 4910 if (mAttachInfo == null) { 4911 return; 4912 } 4913 4914 RectF position = mAttachInfo.mTmpTransformRect; 4915 position.set(0, 0, mRight - mLeft, mBottom - mTop); 4916 4917 if (!hasIdentityMatrix()) { 4918 getMatrix().mapRect(position); 4919 } 4920 4921 position.offset(mLeft, mTop); 4922 4923 ViewParent parent = mParent; 4924 while (parent instanceof View) { 4925 View parentView = (View) parent; 4926 4927 position.offset(-parentView.mScrollX, -parentView.mScrollY); 4928 4929 if (!parentView.hasIdentityMatrix()) { 4930 parentView.getMatrix().mapRect(position); 4931 } 4932 4933 position.offset(parentView.mLeft, parentView.mTop); 4934 4935 parent = parentView.mParent; 4936 } 4937 4938 if (parent instanceof ViewRootImpl) { 4939 ViewRootImpl viewRootImpl = (ViewRootImpl) parent; 4940 position.offset(0, -viewRootImpl.mCurScrollY); 4941 } 4942 4943 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop); 4944 4945 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f), 4946 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f)); 4947 } 4948 4949 /** 4950 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 4951 * 4952 * Note: Called from the default {@link AccessibilityDelegate}. 4953 */ 4954 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) { 4955 Rect bounds = mAttachInfo.mTmpInvalRect; 4956 4957 getDrawingRect(bounds); 4958 info.setBoundsInParent(bounds); 4959 4960 getBoundsOnScreen(bounds); 4961 info.setBoundsInScreen(bounds); 4962 4963 ViewParent parent = getParentForAccessibility(); 4964 if (parent instanceof View) { 4965 info.setParent((View) parent); 4966 } 4967 4968 if (mID != View.NO_ID) { 4969 View rootView = getRootView(); 4970 if (rootView == null) { 4971 rootView = this; 4972 } 4973 View label = rootView.findLabelForView(this, mID); 4974 if (label != null) { 4975 info.setLabeledBy(label); 4976 } 4977 } 4978 4979 if (mLabelForId != View.NO_ID) { 4980 View rootView = getRootView(); 4981 if (rootView == null) { 4982 rootView = this; 4983 } 4984 View labeled = rootView.findViewInsideOutShouldExist(this, mLabelForId); 4985 if (labeled != null) { 4986 info.setLabelFor(labeled); 4987 } 4988 } 4989 4990 info.setVisibleToUser(isVisibleToUser()); 4991 4992 info.setPackageName(mContext.getPackageName()); 4993 info.setClassName(View.class.getName()); 4994 info.setContentDescription(getContentDescription()); 4995 4996 info.setEnabled(isEnabled()); 4997 info.setClickable(isClickable()); 4998 info.setFocusable(isFocusable()); 4999 info.setFocused(isFocused()); 5000 info.setAccessibilityFocused(isAccessibilityFocused()); 5001 info.setSelected(isSelected()); 5002 info.setLongClickable(isLongClickable()); 5003 5004 // TODO: These make sense only if we are in an AdapterView but all 5005 // views can be selected. Maybe from accessibility perspective 5006 // we should report as selectable view in an AdapterView. 5007 info.addAction(AccessibilityNodeInfo.ACTION_SELECT); 5008 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION); 5009 5010 if (isFocusable()) { 5011 if (isFocused()) { 5012 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS); 5013 } else { 5014 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS); 5015 } 5016 } 5017 5018 if (!isAccessibilityFocused()) { 5019 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS); 5020 } else { 5021 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS); 5022 } 5023 5024 if (isClickable() && isEnabled()) { 5025 info.addAction(AccessibilityNodeInfo.ACTION_CLICK); 5026 } 5027 5028 if (isLongClickable() && isEnabled()) { 5029 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK); 5030 } 5031 5032 if (mContentDescription != null && mContentDescription.length() > 0) { 5033 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY); 5034 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY); 5035 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER 5036 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD 5037 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH); 5038 } 5039 } 5040 5041 private View findLabelForView(View view, int labeledId) { 5042 if (mMatchLabelForPredicate == null) { 5043 mMatchLabelForPredicate = new MatchLabelForPredicate(); 5044 } 5045 mMatchLabelForPredicate.mLabeledId = labeledId; 5046 return findViewByPredicateInsideOut(view, mMatchLabelForPredicate); 5047 } 5048 5049 /** 5050 * Computes whether this view is visible to the user. Such a view is 5051 * attached, visible, all its predecessors are visible, it is not clipped 5052 * entirely by its predecessors, and has an alpha greater than zero. 5053 * 5054 * @return Whether the view is visible on the screen. 5055 * 5056 * @hide 5057 */ 5058 protected boolean isVisibleToUser() { 5059 return isVisibleToUser(null); 5060 } 5061 5062 /** 5063 * Computes whether the given portion of this view is visible to the user. 5064 * Such a view is attached, visible, all its predecessors are visible, 5065 * has an alpha greater than zero, and the specified portion is not 5066 * clipped entirely by its predecessors. 5067 * 5068 * @param boundInView the portion of the view to test; coordinates should be relative; may be 5069 * <code>null</code>, and the entire view will be tested in this case. 5070 * When <code>true</code> is returned by the function, the actual visible 5071 * region will be stored in this parameter; that is, if boundInView is fully 5072 * contained within the view, no modification will be made, otherwise regions 5073 * outside of the visible area of the view will be clipped. 5074 * 5075 * @return Whether the specified portion of the view is visible on the screen. 5076 * 5077 * @hide 5078 */ 5079 protected boolean isVisibleToUser(Rect boundInView) { 5080 if (mAttachInfo != null) { 5081 Rect visibleRect = mAttachInfo.mTmpInvalRect; 5082 Point offset = mAttachInfo.mPoint; 5083 // The first two checks are made also made by isShown() which 5084 // however traverses the tree up to the parent to catch that. 5085 // Therefore, we do some fail fast check to minimize the up 5086 // tree traversal. 5087 boolean isVisible = mAttachInfo.mWindowVisibility == View.VISIBLE 5088 && getAlpha() > 0 5089 && isShown() 5090 && getGlobalVisibleRect(visibleRect, offset); 5091 if (isVisible && boundInView != null) { 5092 visibleRect.offset(-offset.x, -offset.y); 5093 // isVisible is always true here, use a simple assignment 5094 isVisible = boundInView.intersect(visibleRect); 5095 } 5096 return isVisible; 5097 } 5098 5099 return false; 5100 } 5101 5102 /** 5103 * Returns the delegate for implementing accessibility support via 5104 * composition. For more details see {@link AccessibilityDelegate}. 5105 * 5106 * @return The delegate, or null if none set. 5107 * 5108 * @hide 5109 */ 5110 public AccessibilityDelegate getAccessibilityDelegate() { 5111 return mAccessibilityDelegate; 5112 } 5113 5114 /** 5115 * Sets a delegate for implementing accessibility support via composition as 5116 * opposed to inheritance. The delegate's primary use is for implementing 5117 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 5118 * 5119 * @param delegate The delegate instance. 5120 * 5121 * @see AccessibilityDelegate 5122 */ 5123 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 5124 mAccessibilityDelegate = delegate; 5125 } 5126 5127 /** 5128 * Gets the provider for managing a virtual view hierarchy rooted at this View 5129 * and reported to {@link android.accessibilityservice.AccessibilityService}s 5130 * that explore the window content. 5131 * <p> 5132 * If this method returns an instance, this instance is responsible for managing 5133 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 5134 * View including the one representing the View itself. Similarly the returned 5135 * instance is responsible for performing accessibility actions on any virtual 5136 * view or the root view itself. 5137 * </p> 5138 * <p> 5139 * If an {@link AccessibilityDelegate} has been specified via calling 5140 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 5141 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 5142 * is responsible for handling this call. 5143 * </p> 5144 * 5145 * @return The provider. 5146 * 5147 * @see AccessibilityNodeProvider 5148 */ 5149 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 5150 if (mAccessibilityDelegate != null) { 5151 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 5152 } else { 5153 return null; 5154 } 5155 } 5156 5157 /** 5158 * Gets the unique identifier of this view on the screen for accessibility purposes. 5159 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 5160 * 5161 * @return The view accessibility id. 5162 * 5163 * @hide 5164 */ 5165 public int getAccessibilityViewId() { 5166 if (mAccessibilityViewId == NO_ID) { 5167 mAccessibilityViewId = sNextAccessibilityViewId++; 5168 } 5169 return mAccessibilityViewId; 5170 } 5171 5172 /** 5173 * Gets the unique identifier of the window in which this View reseides. 5174 * 5175 * @return The window accessibility id. 5176 * 5177 * @hide 5178 */ 5179 public int getAccessibilityWindowId() { 5180 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID; 5181 } 5182 5183 /** 5184 * Gets the {@link View} description. It briefly describes the view and is 5185 * primarily used for accessibility support. Set this property to enable 5186 * better accessibility support for your application. This is especially 5187 * true for views that do not have textual representation (For example, 5188 * ImageButton). 5189 * 5190 * @return The content description. 5191 * 5192 * @attr ref android.R.styleable#View_contentDescription 5193 */ 5194 @ViewDebug.ExportedProperty(category = "accessibility") 5195 public CharSequence getContentDescription() { 5196 return mContentDescription; 5197 } 5198 5199 /** 5200 * Sets the {@link View} description. It briefly describes the view and is 5201 * primarily used for accessibility support. Set this property to enable 5202 * better accessibility support for your application. This is especially 5203 * true for views that do not have textual representation (For example, 5204 * ImageButton). 5205 * 5206 * @param contentDescription The content description. 5207 * 5208 * @attr ref android.R.styleable#View_contentDescription 5209 */ 5210 @RemotableViewMethod 5211 public void setContentDescription(CharSequence contentDescription) { 5212 if (mContentDescription == null) { 5213 if (contentDescription == null) { 5214 return; 5215 } 5216 } else if (mContentDescription.equals(contentDescription)) { 5217 return; 5218 } 5219 mContentDescription = contentDescription; 5220 final boolean nonEmptyDesc = contentDescription != null && contentDescription.length() > 0; 5221 if (nonEmptyDesc && getImportantForAccessibility() == IMPORTANT_FOR_ACCESSIBILITY_AUTO) { 5222 setImportantForAccessibility(IMPORTANT_FOR_ACCESSIBILITY_YES); 5223 } 5224 notifyAccessibilityStateChanged(); 5225 } 5226 5227 /** 5228 * Gets the id of a view for which this view serves as a label for 5229 * accessibility purposes. 5230 * 5231 * @return The labeled view id. 5232 */ 5233 @ViewDebug.ExportedProperty(category = "accessibility") 5234 public int getLabelFor() { 5235 return mLabelForId; 5236 } 5237 5238 /** 5239 * Sets the id of a view for which this view serves as a label for 5240 * accessibility purposes. 5241 * 5242 * @param id The labeled view id. 5243 */ 5244 @RemotableViewMethod 5245 public void setLabelFor(int id) { 5246 mLabelForId = id; 5247 if (mLabelForId != View.NO_ID 5248 && mID == View.NO_ID) { 5249 mID = generateViewId(); 5250 } 5251 } 5252 5253 /** 5254 * Invoked whenever this view loses focus, either by losing window focus or by losing 5255 * focus within its window. This method can be used to clear any state tied to the 5256 * focus. For instance, if a button is held pressed with the trackball and the window 5257 * loses focus, this method can be used to cancel the press. 5258 * 5259 * Subclasses of View overriding this method should always call super.onFocusLost(). 5260 * 5261 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 5262 * @see #onWindowFocusChanged(boolean) 5263 * 5264 * @hide pending API council approval 5265 */ 5266 protected void onFocusLost() { 5267 resetPressedState(); 5268 } 5269 5270 private void resetPressedState() { 5271 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 5272 return; 5273 } 5274 5275 if (isPressed()) { 5276 setPressed(false); 5277 5278 if (!mHasPerformedLongPress) { 5279 removeLongPressCallback(); 5280 } 5281 } 5282 } 5283 5284 /** 5285 * Returns true if this view has focus 5286 * 5287 * @return True if this view has focus, false otherwise. 5288 */ 5289 @ViewDebug.ExportedProperty(category = "focus") 5290 public boolean isFocused() { 5291 return (mPrivateFlags & PFLAG_FOCUSED) != 0; 5292 } 5293 5294 /** 5295 * Find the view in the hierarchy rooted at this view that currently has 5296 * focus. 5297 * 5298 * @return The view that currently has focus, or null if no focused view can 5299 * be found. 5300 */ 5301 public View findFocus() { 5302 return (mPrivateFlags & PFLAG_FOCUSED) != 0 ? this : null; 5303 } 5304 5305 /** 5306 * Indicates whether this view is one of the set of scrollable containers in 5307 * its window. 5308 * 5309 * @return whether this view is one of the set of scrollable containers in 5310 * its window 5311 * 5312 * @attr ref android.R.styleable#View_isScrollContainer 5313 */ 5314 public boolean isScrollContainer() { 5315 return (mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0; 5316 } 5317 5318 /** 5319 * Change whether this view is one of the set of scrollable containers in 5320 * its window. This will be used to determine whether the window can 5321 * resize or must pan when a soft input area is open -- scrollable 5322 * containers allow the window to use resize mode since the container 5323 * will appropriately shrink. 5324 * 5325 * @attr ref android.R.styleable#View_isScrollContainer 5326 */ 5327 public void setScrollContainer(boolean isScrollContainer) { 5328 if (isScrollContainer) { 5329 if (mAttachInfo != null && (mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) == 0) { 5330 mAttachInfo.mScrollContainers.add(this); 5331 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 5332 } 5333 mPrivateFlags |= PFLAG_SCROLL_CONTAINER; 5334 } else { 5335 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 5336 mAttachInfo.mScrollContainers.remove(this); 5337 } 5338 mPrivateFlags &= ~(PFLAG_SCROLL_CONTAINER|PFLAG_SCROLL_CONTAINER_ADDED); 5339 } 5340 } 5341 5342 /** 5343 * Returns the quality of the drawing cache. 5344 * 5345 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 5346 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 5347 * 5348 * @see #setDrawingCacheQuality(int) 5349 * @see #setDrawingCacheEnabled(boolean) 5350 * @see #isDrawingCacheEnabled() 5351 * 5352 * @attr ref android.R.styleable#View_drawingCacheQuality 5353 */ 5354 public int getDrawingCacheQuality() { 5355 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 5356 } 5357 5358 /** 5359 * Set the drawing cache quality of this view. This value is used only when the 5360 * drawing cache is enabled 5361 * 5362 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 5363 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 5364 * 5365 * @see #getDrawingCacheQuality() 5366 * @see #setDrawingCacheEnabled(boolean) 5367 * @see #isDrawingCacheEnabled() 5368 * 5369 * @attr ref android.R.styleable#View_drawingCacheQuality 5370 */ 5371 public void setDrawingCacheQuality(int quality) { 5372 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 5373 } 5374 5375 /** 5376 * Returns whether the screen should remain on, corresponding to the current 5377 * value of {@link #KEEP_SCREEN_ON}. 5378 * 5379 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 5380 * 5381 * @see #setKeepScreenOn(boolean) 5382 * 5383 * @attr ref android.R.styleable#View_keepScreenOn 5384 */ 5385 public boolean getKeepScreenOn() { 5386 return (mViewFlags & KEEP_SCREEN_ON) != 0; 5387 } 5388 5389 /** 5390 * Controls whether the screen should remain on, modifying the 5391 * value of {@link #KEEP_SCREEN_ON}. 5392 * 5393 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 5394 * 5395 * @see #getKeepScreenOn() 5396 * 5397 * @attr ref android.R.styleable#View_keepScreenOn 5398 */ 5399 public void setKeepScreenOn(boolean keepScreenOn) { 5400 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 5401 } 5402 5403 /** 5404 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 5405 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5406 * 5407 * @attr ref android.R.styleable#View_nextFocusLeft 5408 */ 5409 public int getNextFocusLeftId() { 5410 return mNextFocusLeftId; 5411 } 5412 5413 /** 5414 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 5415 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 5416 * decide automatically. 5417 * 5418 * @attr ref android.R.styleable#View_nextFocusLeft 5419 */ 5420 public void setNextFocusLeftId(int nextFocusLeftId) { 5421 mNextFocusLeftId = nextFocusLeftId; 5422 } 5423 5424 /** 5425 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 5426 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5427 * 5428 * @attr ref android.R.styleable#View_nextFocusRight 5429 */ 5430 public int getNextFocusRightId() { 5431 return mNextFocusRightId; 5432 } 5433 5434 /** 5435 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 5436 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 5437 * decide automatically. 5438 * 5439 * @attr ref android.R.styleable#View_nextFocusRight 5440 */ 5441 public void setNextFocusRightId(int nextFocusRightId) { 5442 mNextFocusRightId = nextFocusRightId; 5443 } 5444 5445 /** 5446 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 5447 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5448 * 5449 * @attr ref android.R.styleable#View_nextFocusUp 5450 */ 5451 public int getNextFocusUpId() { 5452 return mNextFocusUpId; 5453 } 5454 5455 /** 5456 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 5457 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 5458 * decide automatically. 5459 * 5460 * @attr ref android.R.styleable#View_nextFocusUp 5461 */ 5462 public void setNextFocusUpId(int nextFocusUpId) { 5463 mNextFocusUpId = nextFocusUpId; 5464 } 5465 5466 /** 5467 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 5468 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5469 * 5470 * @attr ref android.R.styleable#View_nextFocusDown 5471 */ 5472 public int getNextFocusDownId() { 5473 return mNextFocusDownId; 5474 } 5475 5476 /** 5477 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 5478 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 5479 * decide automatically. 5480 * 5481 * @attr ref android.R.styleable#View_nextFocusDown 5482 */ 5483 public void setNextFocusDownId(int nextFocusDownId) { 5484 mNextFocusDownId = nextFocusDownId; 5485 } 5486 5487 /** 5488 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 5489 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5490 * 5491 * @attr ref android.R.styleable#View_nextFocusForward 5492 */ 5493 public int getNextFocusForwardId() { 5494 return mNextFocusForwardId; 5495 } 5496 5497 /** 5498 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 5499 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 5500 * decide automatically. 5501 * 5502 * @attr ref android.R.styleable#View_nextFocusForward 5503 */ 5504 public void setNextFocusForwardId(int nextFocusForwardId) { 5505 mNextFocusForwardId = nextFocusForwardId; 5506 } 5507 5508 /** 5509 * Returns the visibility of this view and all of its ancestors 5510 * 5511 * @return True if this view and all of its ancestors are {@link #VISIBLE} 5512 */ 5513 public boolean isShown() { 5514 View current = this; 5515 //noinspection ConstantConditions 5516 do { 5517 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 5518 return false; 5519 } 5520 ViewParent parent = current.mParent; 5521 if (parent == null) { 5522 return false; // We are not attached to the view root 5523 } 5524 if (!(parent instanceof View)) { 5525 return true; 5526 } 5527 current = (View) parent; 5528 } while (current != null); 5529 5530 return false; 5531 } 5532 5533 /** 5534 * Called by the view hierarchy when the content insets for a window have 5535 * changed, to allow it to adjust its content to fit within those windows. 5536 * The content insets tell you the space that the status bar, input method, 5537 * and other system windows infringe on the application's window. 5538 * 5539 * <p>You do not normally need to deal with this function, since the default 5540 * window decoration given to applications takes care of applying it to the 5541 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 5542 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case, 5543 * and your content can be placed under those system elements. You can then 5544 * use this method within your view hierarchy if you have parts of your UI 5545 * which you would like to ensure are not being covered. 5546 * 5547 * <p>The default implementation of this method simply applies the content 5548 * inset's to the view's padding, consuming that content (modifying the 5549 * insets to be 0), and returning true. This behavior is off by default, but can 5550 * be enabled through {@link #setFitsSystemWindows(boolean)}. 5551 * 5552 * <p>This function's traversal down the hierarchy is depth-first. The same content 5553 * insets object is propagated down the hierarchy, so any changes made to it will 5554 * be seen by all following views (including potentially ones above in 5555 * the hierarchy since this is a depth-first traversal). The first view 5556 * that returns true will abort the entire traversal. 5557 * 5558 * <p>The default implementation works well for a situation where it is 5559 * used with a container that covers the entire window, allowing it to 5560 * apply the appropriate insets to its content on all edges. If you need 5561 * a more complicated layout (such as two different views fitting system 5562 * windows, one on the top of the window, and one on the bottom), 5563 * you can override the method and handle the insets however you would like. 5564 * Note that the insets provided by the framework are always relative to the 5565 * far edges of the window, not accounting for the location of the called view 5566 * within that window. (In fact when this method is called you do not yet know 5567 * where the layout will place the view, as it is done before layout happens.) 5568 * 5569 * <p>Note: unlike many View methods, there is no dispatch phase to this 5570 * call. If you are overriding it in a ViewGroup and want to allow the 5571 * call to continue to your children, you must be sure to call the super 5572 * implementation. 5573 * 5574 * <p>Here is a sample layout that makes use of fitting system windows 5575 * to have controls for a video view placed inside of the window decorations 5576 * that it hides and shows. This can be used with code like the second 5577 * sample (video player) shown in {@link #setSystemUiVisibility(int)}. 5578 * 5579 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete} 5580 * 5581 * @param insets Current content insets of the window. Prior to 5582 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify 5583 * the insets or else you and Android will be unhappy. 5584 * 5585 * @return Return true if this view applied the insets and it should not 5586 * continue propagating further down the hierarchy, false otherwise. 5587 * @see #getFitsSystemWindows() 5588 * @see #setFitsSystemWindows(boolean) 5589 * @see #setSystemUiVisibility(int) 5590 */ 5591 protected boolean fitSystemWindows(Rect insets) { 5592 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 5593 mUserPaddingStart = UNDEFINED_PADDING; 5594 mUserPaddingEnd = UNDEFINED_PADDING; 5595 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 5596 || mAttachInfo == null 5597 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) { 5598 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom); 5599 return true; 5600 } else { 5601 internalSetPadding(0, 0, 0, 0); 5602 return false; 5603 } 5604 } 5605 return false; 5606 } 5607 5608 /** 5609 * Sets whether or not this view should account for system screen decorations 5610 * such as the status bar and inset its content; that is, controlling whether 5611 * the default implementation of {@link #fitSystemWindows(Rect)} will be 5612 * executed. See that method for more details. 5613 * 5614 * <p>Note that if you are providing your own implementation of 5615 * {@link #fitSystemWindows(Rect)}, then there is no need to set this 5616 * flag to true -- your implementation will be overriding the default 5617 * implementation that checks this flag. 5618 * 5619 * @param fitSystemWindows If true, then the default implementation of 5620 * {@link #fitSystemWindows(Rect)} will be executed. 5621 * 5622 * @attr ref android.R.styleable#View_fitsSystemWindows 5623 * @see #getFitsSystemWindows() 5624 * @see #fitSystemWindows(Rect) 5625 * @see #setSystemUiVisibility(int) 5626 */ 5627 public void setFitsSystemWindows(boolean fitSystemWindows) { 5628 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 5629 } 5630 5631 /** 5632 * Check for state of {@link #setFitsSystemWindows(boolean). If this method 5633 * returns true, the default implementation of {@link #fitSystemWindows(Rect)} 5634 * will be executed. 5635 * 5636 * @return Returns true if the default implementation of 5637 * {@link #fitSystemWindows(Rect)} will be executed. 5638 * 5639 * @attr ref android.R.styleable#View_fitsSystemWindows 5640 * @see #setFitsSystemWindows() 5641 * @see #fitSystemWindows(Rect) 5642 * @see #setSystemUiVisibility(int) 5643 */ 5644 public boolean getFitsSystemWindows() { 5645 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 5646 } 5647 5648 /** @hide */ 5649 public boolean fitsSystemWindows() { 5650 return getFitsSystemWindows(); 5651 } 5652 5653 /** 5654 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed. 5655 */ 5656 public void requestFitSystemWindows() { 5657 if (mParent != null) { 5658 mParent.requestFitSystemWindows(); 5659 } 5660 } 5661 5662 /** 5663 * For use by PhoneWindow to make its own system window fitting optional. 5664 * @hide 5665 */ 5666 public void makeOptionalFitsSystemWindows() { 5667 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS); 5668 } 5669 5670 /** 5671 * Returns the visibility status for this view. 5672 * 5673 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 5674 * @attr ref android.R.styleable#View_visibility 5675 */ 5676 @ViewDebug.ExportedProperty(mapping = { 5677 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 5678 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 5679 @ViewDebug.IntToString(from = GONE, to = "GONE") 5680 }) 5681 public int getVisibility() { 5682 return mViewFlags & VISIBILITY_MASK; 5683 } 5684 5685 /** 5686 * Set the enabled state of this view. 5687 * 5688 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 5689 * @attr ref android.R.styleable#View_visibility 5690 */ 5691 @RemotableViewMethod 5692 public void setVisibility(int visibility) { 5693 setFlags(visibility, VISIBILITY_MASK); 5694 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false); 5695 } 5696 5697 /** 5698 * Returns the enabled status for this view. The interpretation of the 5699 * enabled state varies by subclass. 5700 * 5701 * @return True if this view is enabled, false otherwise. 5702 */ 5703 @ViewDebug.ExportedProperty 5704 public boolean isEnabled() { 5705 return (mViewFlags & ENABLED_MASK) == ENABLED; 5706 } 5707 5708 /** 5709 * Set the enabled state of this view. The interpretation of the enabled 5710 * state varies by subclass. 5711 * 5712 * @param enabled True if this view is enabled, false otherwise. 5713 */ 5714 @RemotableViewMethod 5715 public void setEnabled(boolean enabled) { 5716 if (enabled == isEnabled()) return; 5717 5718 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 5719 5720 /* 5721 * The View most likely has to change its appearance, so refresh 5722 * the drawable state. 5723 */ 5724 refreshDrawableState(); 5725 5726 // Invalidate too, since the default behavior for views is to be 5727 // be drawn at 50% alpha rather than to change the drawable. 5728 invalidate(true); 5729 } 5730 5731 /** 5732 * Set whether this view can receive the focus. 5733 * 5734 * Setting this to false will also ensure that this view is not focusable 5735 * in touch mode. 5736 * 5737 * @param focusable If true, this view can receive the focus. 5738 * 5739 * @see #setFocusableInTouchMode(boolean) 5740 * @attr ref android.R.styleable#View_focusable 5741 */ 5742 public void setFocusable(boolean focusable) { 5743 if (!focusable) { 5744 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 5745 } 5746 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 5747 } 5748 5749 /** 5750 * Set whether this view can receive focus while in touch mode. 5751 * 5752 * Setting this to true will also ensure that this view is focusable. 5753 * 5754 * @param focusableInTouchMode If true, this view can receive the focus while 5755 * in touch mode. 5756 * 5757 * @see #setFocusable(boolean) 5758 * @attr ref android.R.styleable#View_focusableInTouchMode 5759 */ 5760 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 5761 // Focusable in touch mode should always be set before the focusable flag 5762 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 5763 // which, in touch mode, will not successfully request focus on this view 5764 // because the focusable in touch mode flag is not set 5765 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 5766 if (focusableInTouchMode) { 5767 setFlags(FOCUSABLE, FOCUSABLE_MASK); 5768 } 5769 } 5770 5771 /** 5772 * Set whether this view should have sound effects enabled for events such as 5773 * clicking and touching. 5774 * 5775 * <p>You may wish to disable sound effects for a view if you already play sounds, 5776 * for instance, a dial key that plays dtmf tones. 5777 * 5778 * @param soundEffectsEnabled whether sound effects are enabled for this view. 5779 * @see #isSoundEffectsEnabled() 5780 * @see #playSoundEffect(int) 5781 * @attr ref android.R.styleable#View_soundEffectsEnabled 5782 */ 5783 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 5784 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 5785 } 5786 5787 /** 5788 * @return whether this view should have sound effects enabled for events such as 5789 * clicking and touching. 5790 * 5791 * @see #setSoundEffectsEnabled(boolean) 5792 * @see #playSoundEffect(int) 5793 * @attr ref android.R.styleable#View_soundEffectsEnabled 5794 */ 5795 @ViewDebug.ExportedProperty 5796 public boolean isSoundEffectsEnabled() { 5797 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 5798 } 5799 5800 /** 5801 * Set whether this view should have haptic feedback for events such as 5802 * long presses. 5803 * 5804 * <p>You may wish to disable haptic feedback if your view already controls 5805 * its own haptic feedback. 5806 * 5807 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 5808 * @see #isHapticFeedbackEnabled() 5809 * @see #performHapticFeedback(int) 5810 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 5811 */ 5812 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 5813 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 5814 } 5815 5816 /** 5817 * @return whether this view should have haptic feedback enabled for events 5818 * long presses. 5819 * 5820 * @see #setHapticFeedbackEnabled(boolean) 5821 * @see #performHapticFeedback(int) 5822 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 5823 */ 5824 @ViewDebug.ExportedProperty 5825 public boolean isHapticFeedbackEnabled() { 5826 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 5827 } 5828 5829 /** 5830 * Returns the layout direction for this view. 5831 * 5832 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 5833 * {@link #LAYOUT_DIRECTION_RTL}, 5834 * {@link #LAYOUT_DIRECTION_INHERIT} or 5835 * {@link #LAYOUT_DIRECTION_LOCALE}. 5836 * @attr ref android.R.styleable#View_layoutDirection 5837 * 5838 * @hide 5839 */ 5840 @ViewDebug.ExportedProperty(category = "layout", mapping = { 5841 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 5842 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 5843 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 5844 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 5845 }) 5846 public int getRawLayoutDirection() { 5847 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT; 5848 } 5849 5850 /** 5851 * Set the layout direction for this view. This will propagate a reset of layout direction 5852 * resolution to the view's children and resolve layout direction for this view. 5853 * 5854 * @param layoutDirection the layout direction to set. Should be one of: 5855 * 5856 * {@link #LAYOUT_DIRECTION_LTR}, 5857 * {@link #LAYOUT_DIRECTION_RTL}, 5858 * {@link #LAYOUT_DIRECTION_INHERIT}, 5859 * {@link #LAYOUT_DIRECTION_LOCALE}. 5860 * 5861 * Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution 5862 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 5863 * will return the default {@link #LAYOUT_DIRECTION_LTR}. 5864 * 5865 * @attr ref android.R.styleable#View_layoutDirection 5866 */ 5867 @RemotableViewMethod 5868 public void setLayoutDirection(int layoutDirection) { 5869 if (getRawLayoutDirection() != layoutDirection) { 5870 // Reset the current layout direction and the resolved one 5871 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_MASK; 5872 resetRtlProperties(); 5873 // Set the new layout direction (filtered) 5874 mPrivateFlags2 |= 5875 ((layoutDirection << PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) & PFLAG2_LAYOUT_DIRECTION_MASK); 5876 // We need to resolve all RTL properties as they all depend on layout direction 5877 resolveRtlPropertiesIfNeeded(); 5878 requestLayout(); 5879 invalidate(true); 5880 } 5881 } 5882 5883 /** 5884 * Returns the resolved layout direction for this view. 5885 * 5886 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 5887 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. 5888 * 5889 * For compatibility, this will return {@link #LAYOUT_DIRECTION_LTR} if API version 5890 * is lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1}. 5891 */ 5892 @ViewDebug.ExportedProperty(category = "layout", mapping = { 5893 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 5894 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 5895 }) 5896 public int getLayoutDirection() { 5897 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 5898 if (targetSdkVersion < JELLY_BEAN_MR1) { 5899 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 5900 return LAYOUT_DIRECTION_LTR; 5901 } 5902 return ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) == 5903 PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL) ? LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 5904 } 5905 5906 /** 5907 * Indicates whether or not this view's layout is right-to-left. This is resolved from 5908 * layout attribute and/or the inherited value from the parent 5909 * 5910 * @return true if the layout is right-to-left. 5911 * 5912 * @hide 5913 */ 5914 @ViewDebug.ExportedProperty(category = "layout") 5915 public boolean isLayoutRtl() { 5916 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL); 5917 } 5918 5919 /** 5920 * Indicates whether the view is currently tracking transient state that the 5921 * app should not need to concern itself with saving and restoring, but that 5922 * the framework should take special note to preserve when possible. 5923 * 5924 * <p>A view with transient state cannot be trivially rebound from an external 5925 * data source, such as an adapter binding item views in a list. This may be 5926 * because the view is performing an animation, tracking user selection 5927 * of content, or similar.</p> 5928 * 5929 * @return true if the view has transient state 5930 */ 5931 @ViewDebug.ExportedProperty(category = "layout") 5932 public boolean hasTransientState() { 5933 return (mPrivateFlags2 & PFLAG2_HAS_TRANSIENT_STATE) == PFLAG2_HAS_TRANSIENT_STATE; 5934 } 5935 5936 /** 5937 * Set whether this view is currently tracking transient state that the 5938 * framework should attempt to preserve when possible. This flag is reference counted, 5939 * so every call to setHasTransientState(true) should be paired with a later call 5940 * to setHasTransientState(false). 5941 * 5942 * <p>A view with transient state cannot be trivially rebound from an external 5943 * data source, such as an adapter binding item views in a list. This may be 5944 * because the view is performing an animation, tracking user selection 5945 * of content, or similar.</p> 5946 * 5947 * @param hasTransientState true if this view has transient state 5948 */ 5949 public void setHasTransientState(boolean hasTransientState) { 5950 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 : 5951 mTransientStateCount - 1; 5952 if (mTransientStateCount < 0) { 5953 mTransientStateCount = 0; 5954 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " + 5955 "unmatched pair of setHasTransientState calls"); 5956 } 5957 if ((hasTransientState && mTransientStateCount == 1) || 5958 (!hasTransientState && mTransientStateCount == 0)) { 5959 // update flag if we've just incremented up from 0 or decremented down to 0 5960 mPrivateFlags2 = (mPrivateFlags2 & ~PFLAG2_HAS_TRANSIENT_STATE) | 5961 (hasTransientState ? PFLAG2_HAS_TRANSIENT_STATE : 0); 5962 if (mParent != null) { 5963 try { 5964 mParent.childHasTransientStateChanged(this, hasTransientState); 5965 } catch (AbstractMethodError e) { 5966 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 5967 " does not fully implement ViewParent", e); 5968 } 5969 } 5970 } 5971 } 5972 5973 /** 5974 * If this view doesn't do any drawing on its own, set this flag to 5975 * allow further optimizations. By default, this flag is not set on 5976 * View, but could be set on some View subclasses such as ViewGroup. 5977 * 5978 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 5979 * you should clear this flag. 5980 * 5981 * @param willNotDraw whether or not this View draw on its own 5982 */ 5983 public void setWillNotDraw(boolean willNotDraw) { 5984 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 5985 } 5986 5987 /** 5988 * Returns whether or not this View draws on its own. 5989 * 5990 * @return true if this view has nothing to draw, false otherwise 5991 */ 5992 @ViewDebug.ExportedProperty(category = "drawing") 5993 public boolean willNotDraw() { 5994 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 5995 } 5996 5997 /** 5998 * When a View's drawing cache is enabled, drawing is redirected to an 5999 * offscreen bitmap. Some views, like an ImageView, must be able to 6000 * bypass this mechanism if they already draw a single bitmap, to avoid 6001 * unnecessary usage of the memory. 6002 * 6003 * @param willNotCacheDrawing true if this view does not cache its 6004 * drawing, false otherwise 6005 */ 6006 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 6007 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 6008 } 6009 6010 /** 6011 * Returns whether or not this View can cache its drawing or not. 6012 * 6013 * @return true if this view does not cache its drawing, false otherwise 6014 */ 6015 @ViewDebug.ExportedProperty(category = "drawing") 6016 public boolean willNotCacheDrawing() { 6017 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 6018 } 6019 6020 /** 6021 * Indicates whether this view reacts to click events or not. 6022 * 6023 * @return true if the view is clickable, false otherwise 6024 * 6025 * @see #setClickable(boolean) 6026 * @attr ref android.R.styleable#View_clickable 6027 */ 6028 @ViewDebug.ExportedProperty 6029 public boolean isClickable() { 6030 return (mViewFlags & CLICKABLE) == CLICKABLE; 6031 } 6032 6033 /** 6034 * Enables or disables click events for this view. When a view 6035 * is clickable it will change its state to "pressed" on every click. 6036 * Subclasses should set the view clickable to visually react to 6037 * user's clicks. 6038 * 6039 * @param clickable true to make the view clickable, false otherwise 6040 * 6041 * @see #isClickable() 6042 * @attr ref android.R.styleable#View_clickable 6043 */ 6044 public void setClickable(boolean clickable) { 6045 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 6046 } 6047 6048 /** 6049 * Indicates whether this view reacts to long click events or not. 6050 * 6051 * @return true if the view is long clickable, false otherwise 6052 * 6053 * @see #setLongClickable(boolean) 6054 * @attr ref android.R.styleable#View_longClickable 6055 */ 6056 public boolean isLongClickable() { 6057 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 6058 } 6059 6060 /** 6061 * Enables or disables long click events for this view. When a view is long 6062 * clickable it reacts to the user holding down the button for a longer 6063 * duration than a tap. This event can either launch the listener or a 6064 * context menu. 6065 * 6066 * @param longClickable true to make the view long clickable, false otherwise 6067 * @see #isLongClickable() 6068 * @attr ref android.R.styleable#View_longClickable 6069 */ 6070 public void setLongClickable(boolean longClickable) { 6071 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 6072 } 6073 6074 /** 6075 * Sets the pressed state for this view. 6076 * 6077 * @see #isClickable() 6078 * @see #setClickable(boolean) 6079 * 6080 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 6081 * the View's internal state from a previously set "pressed" state. 6082 */ 6083 public void setPressed(boolean pressed) { 6084 final boolean needsRefresh = pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED); 6085 6086 if (pressed) { 6087 mPrivateFlags |= PFLAG_PRESSED; 6088 } else { 6089 mPrivateFlags &= ~PFLAG_PRESSED; 6090 } 6091 6092 if (needsRefresh) { 6093 refreshDrawableState(); 6094 } 6095 dispatchSetPressed(pressed); 6096 } 6097 6098 /** 6099 * Dispatch setPressed to all of this View's children. 6100 * 6101 * @see #setPressed(boolean) 6102 * 6103 * @param pressed The new pressed state 6104 */ 6105 protected void dispatchSetPressed(boolean pressed) { 6106 } 6107 6108 /** 6109 * Indicates whether the view is currently in pressed state. Unless 6110 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 6111 * the pressed state. 6112 * 6113 * @see #setPressed(boolean) 6114 * @see #isClickable() 6115 * @see #setClickable(boolean) 6116 * 6117 * @return true if the view is currently pressed, false otherwise 6118 */ 6119 public boolean isPressed() { 6120 return (mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED; 6121 } 6122 6123 /** 6124 * Indicates whether this view will save its state (that is, 6125 * whether its {@link #onSaveInstanceState} method will be called). 6126 * 6127 * @return Returns true if the view state saving is enabled, else false. 6128 * 6129 * @see #setSaveEnabled(boolean) 6130 * @attr ref android.R.styleable#View_saveEnabled 6131 */ 6132 public boolean isSaveEnabled() { 6133 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 6134 } 6135 6136 /** 6137 * Controls whether the saving of this view's state is 6138 * enabled (that is, whether its {@link #onSaveInstanceState} method 6139 * will be called). Note that even if freezing is enabled, the 6140 * view still must have an id assigned to it (via {@link #setId(int)}) 6141 * for its state to be saved. This flag can only disable the 6142 * saving of this view; any child views may still have their state saved. 6143 * 6144 * @param enabled Set to false to <em>disable</em> state saving, or true 6145 * (the default) to allow it. 6146 * 6147 * @see #isSaveEnabled() 6148 * @see #setId(int) 6149 * @see #onSaveInstanceState() 6150 * @attr ref android.R.styleable#View_saveEnabled 6151 */ 6152 public void setSaveEnabled(boolean enabled) { 6153 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 6154 } 6155 6156 /** 6157 * Gets whether the framework should discard touches when the view's 6158 * window is obscured by another visible window. 6159 * Refer to the {@link View} security documentation for more details. 6160 * 6161 * @return True if touch filtering is enabled. 6162 * 6163 * @see #setFilterTouchesWhenObscured(boolean) 6164 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 6165 */ 6166 @ViewDebug.ExportedProperty 6167 public boolean getFilterTouchesWhenObscured() { 6168 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 6169 } 6170 6171 /** 6172 * Sets whether the framework should discard touches when the view's 6173 * window is obscured by another visible window. 6174 * Refer to the {@link View} security documentation for more details. 6175 * 6176 * @param enabled True if touch filtering should be enabled. 6177 * 6178 * @see #getFilterTouchesWhenObscured 6179 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 6180 */ 6181 public void setFilterTouchesWhenObscured(boolean enabled) { 6182 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED, 6183 FILTER_TOUCHES_WHEN_OBSCURED); 6184 } 6185 6186 /** 6187 * Indicates whether the entire hierarchy under this view will save its 6188 * state when a state saving traversal occurs from its parent. The default 6189 * is true; if false, these views will not be saved unless 6190 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 6191 * 6192 * @return Returns true if the view state saving from parent is enabled, else false. 6193 * 6194 * @see #setSaveFromParentEnabled(boolean) 6195 */ 6196 public boolean isSaveFromParentEnabled() { 6197 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 6198 } 6199 6200 /** 6201 * Controls whether the entire hierarchy under this view will save its 6202 * state when a state saving traversal occurs from its parent. The default 6203 * is true; if false, these views will not be saved unless 6204 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 6205 * 6206 * @param enabled Set to false to <em>disable</em> state saving, or true 6207 * (the default) to allow it. 6208 * 6209 * @see #isSaveFromParentEnabled() 6210 * @see #setId(int) 6211 * @see #onSaveInstanceState() 6212 */ 6213 public void setSaveFromParentEnabled(boolean enabled) { 6214 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 6215 } 6216 6217 6218 /** 6219 * Returns whether this View is able to take focus. 6220 * 6221 * @return True if this view can take focus, or false otherwise. 6222 * @attr ref android.R.styleable#View_focusable 6223 */ 6224 @ViewDebug.ExportedProperty(category = "focus") 6225 public final boolean isFocusable() { 6226 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 6227 } 6228 6229 /** 6230 * When a view is focusable, it may not want to take focus when in touch mode. 6231 * For example, a button would like focus when the user is navigating via a D-pad 6232 * so that the user can click on it, but once the user starts touching the screen, 6233 * the button shouldn't take focus 6234 * @return Whether the view is focusable in touch mode. 6235 * @attr ref android.R.styleable#View_focusableInTouchMode 6236 */ 6237 @ViewDebug.ExportedProperty 6238 public final boolean isFocusableInTouchMode() { 6239 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 6240 } 6241 6242 /** 6243 * Find the nearest view in the specified direction that can take focus. 6244 * This does not actually give focus to that view. 6245 * 6246 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 6247 * 6248 * @return The nearest focusable in the specified direction, or null if none 6249 * can be found. 6250 */ 6251 public View focusSearch(int direction) { 6252 if (mParent != null) { 6253 return mParent.focusSearch(this, direction); 6254 } else { 6255 return null; 6256 } 6257 } 6258 6259 /** 6260 * This method is the last chance for the focused view and its ancestors to 6261 * respond to an arrow key. This is called when the focused view did not 6262 * consume the key internally, nor could the view system find a new view in 6263 * the requested direction to give focus to. 6264 * 6265 * @param focused The currently focused view. 6266 * @param direction The direction focus wants to move. One of FOCUS_UP, 6267 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 6268 * @return True if the this view consumed this unhandled move. 6269 */ 6270 public boolean dispatchUnhandledMove(View focused, int direction) { 6271 return false; 6272 } 6273 6274 /** 6275 * If a user manually specified the next view id for a particular direction, 6276 * use the root to look up the view. 6277 * @param root The root view of the hierarchy containing this view. 6278 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 6279 * or FOCUS_BACKWARD. 6280 * @return The user specified next view, or null if there is none. 6281 */ 6282 View findUserSetNextFocus(View root, int direction) { 6283 switch (direction) { 6284 case FOCUS_LEFT: 6285 if (mNextFocusLeftId == View.NO_ID) return null; 6286 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 6287 case FOCUS_RIGHT: 6288 if (mNextFocusRightId == View.NO_ID) return null; 6289 return findViewInsideOutShouldExist(root, mNextFocusRightId); 6290 case FOCUS_UP: 6291 if (mNextFocusUpId == View.NO_ID) return null; 6292 return findViewInsideOutShouldExist(root, mNextFocusUpId); 6293 case FOCUS_DOWN: 6294 if (mNextFocusDownId == View.NO_ID) return null; 6295 return findViewInsideOutShouldExist(root, mNextFocusDownId); 6296 case FOCUS_FORWARD: 6297 if (mNextFocusForwardId == View.NO_ID) return null; 6298 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 6299 case FOCUS_BACKWARD: { 6300 if (mID == View.NO_ID) return null; 6301 final int id = mID; 6302 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 6303 @Override 6304 public boolean apply(View t) { 6305 return t.mNextFocusForwardId == id; 6306 } 6307 }); 6308 } 6309 } 6310 return null; 6311 } 6312 6313 private View findViewInsideOutShouldExist(View root, int id) { 6314 if (mMatchIdPredicate == null) { 6315 mMatchIdPredicate = new MatchIdPredicate(); 6316 } 6317 mMatchIdPredicate.mId = id; 6318 View result = root.findViewByPredicateInsideOut(this, mMatchIdPredicate); 6319 if (result == null) { 6320 Log.w(VIEW_LOG_TAG, "couldn't find view with id " + id); 6321 } 6322 return result; 6323 } 6324 6325 /** 6326 * Find and return all focusable views that are descendants of this view, 6327 * possibly including this view if it is focusable itself. 6328 * 6329 * @param direction The direction of the focus 6330 * @return A list of focusable views 6331 */ 6332 public ArrayList<View> getFocusables(int direction) { 6333 ArrayList<View> result = new ArrayList<View>(24); 6334 addFocusables(result, direction); 6335 return result; 6336 } 6337 6338 /** 6339 * Add any focusable views that are descendants of this view (possibly 6340 * including this view if it is focusable itself) to views. If we are in touch mode, 6341 * only add views that are also focusable in touch mode. 6342 * 6343 * @param views Focusable views found so far 6344 * @param direction The direction of the focus 6345 */ 6346 public void addFocusables(ArrayList<View> views, int direction) { 6347 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 6348 } 6349 6350 /** 6351 * Adds any focusable views that are descendants of this view (possibly 6352 * including this view if it is focusable itself) to views. This method 6353 * adds all focusable views regardless if we are in touch mode or 6354 * only views focusable in touch mode if we are in touch mode or 6355 * only views that can take accessibility focus if accessibility is enabeld 6356 * depending on the focusable mode paramater. 6357 * 6358 * @param views Focusable views found so far or null if all we are interested is 6359 * the number of focusables. 6360 * @param direction The direction of the focus. 6361 * @param focusableMode The type of focusables to be added. 6362 * 6363 * @see #FOCUSABLES_ALL 6364 * @see #FOCUSABLES_TOUCH_MODE 6365 */ 6366 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) { 6367 if (views == null) { 6368 return; 6369 } 6370 if (!isFocusable()) { 6371 return; 6372 } 6373 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE 6374 && isInTouchMode() && !isFocusableInTouchMode()) { 6375 return; 6376 } 6377 views.add(this); 6378 } 6379 6380 /** 6381 * Finds the Views that contain given text. The containment is case insensitive. 6382 * The search is performed by either the text that the View renders or the content 6383 * description that describes the view for accessibility purposes and the view does 6384 * not render or both. Clients can specify how the search is to be performed via 6385 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 6386 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 6387 * 6388 * @param outViews The output list of matching Views. 6389 * @param searched The text to match against. 6390 * 6391 * @see #FIND_VIEWS_WITH_TEXT 6392 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 6393 * @see #setContentDescription(CharSequence) 6394 */ 6395 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) { 6396 if (getAccessibilityNodeProvider() != null) { 6397 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 6398 outViews.add(this); 6399 } 6400 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 6401 && (searched != null && searched.length() > 0) 6402 && (mContentDescription != null && mContentDescription.length() > 0)) { 6403 String searchedLowerCase = searched.toString().toLowerCase(); 6404 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 6405 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 6406 outViews.add(this); 6407 } 6408 } 6409 } 6410 6411 /** 6412 * Find and return all touchable views that are descendants of this view, 6413 * possibly including this view if it is touchable itself. 6414 * 6415 * @return A list of touchable views 6416 */ 6417 public ArrayList<View> getTouchables() { 6418 ArrayList<View> result = new ArrayList<View>(); 6419 addTouchables(result); 6420 return result; 6421 } 6422 6423 /** 6424 * Add any touchable views that are descendants of this view (possibly 6425 * including this view if it is touchable itself) to views. 6426 * 6427 * @param views Touchable views found so far 6428 */ 6429 public void addTouchables(ArrayList<View> views) { 6430 final int viewFlags = mViewFlags; 6431 6432 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 6433 && (viewFlags & ENABLED_MASK) == ENABLED) { 6434 views.add(this); 6435 } 6436 } 6437 6438 /** 6439 * Returns whether this View is accessibility focused. 6440 * 6441 * @return True if this View is accessibility focused. 6442 */ 6443 boolean isAccessibilityFocused() { 6444 return (mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0; 6445 } 6446 6447 /** 6448 * Call this to try to give accessibility focus to this view. 6449 * 6450 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()} 6451 * returns false or the view is no visible or the view already has accessibility 6452 * focus. 6453 * 6454 * See also {@link #focusSearch(int)}, which is what you call to say that you 6455 * have focus, and you want your parent to look for the next one. 6456 * 6457 * @return Whether this view actually took accessibility focus. 6458 * 6459 * @hide 6460 */ 6461 public boolean requestAccessibilityFocus() { 6462 AccessibilityManager manager = AccessibilityManager.getInstance(mContext); 6463 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) { 6464 return false; 6465 } 6466 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6467 return false; 6468 } 6469 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) == 0) { 6470 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_FOCUSED; 6471 ViewRootImpl viewRootImpl = getViewRootImpl(); 6472 if (viewRootImpl != null) { 6473 viewRootImpl.setAccessibilityFocus(this, null); 6474 } 6475 invalidate(); 6476 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED); 6477 notifyAccessibilityStateChanged(); 6478 return true; 6479 } 6480 return false; 6481 } 6482 6483 /** 6484 * Call this to try to clear accessibility focus of this view. 6485 * 6486 * See also {@link #focusSearch(int)}, which is what you call to say that you 6487 * have focus, and you want your parent to look for the next one. 6488 * 6489 * @hide 6490 */ 6491 public void clearAccessibilityFocus() { 6492 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) { 6493 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED; 6494 invalidate(); 6495 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED); 6496 notifyAccessibilityStateChanged(); 6497 } 6498 // Clear the global reference of accessibility focus if this 6499 // view or any of its descendants had accessibility focus. 6500 ViewRootImpl viewRootImpl = getViewRootImpl(); 6501 if (viewRootImpl != null) { 6502 View focusHost = viewRootImpl.getAccessibilityFocusedHost(); 6503 if (focusHost != null && ViewRootImpl.isViewDescendantOf(focusHost, this)) { 6504 viewRootImpl.setAccessibilityFocus(null, null); 6505 } 6506 } 6507 } 6508 6509 private void sendAccessibilityHoverEvent(int eventType) { 6510 // Since we are not delivering to a client accessibility events from not 6511 // important views (unless the clinet request that) we need to fire the 6512 // event from the deepest view exposed to the client. As a consequence if 6513 // the user crosses a not exposed view the client will see enter and exit 6514 // of the exposed predecessor followed by and enter and exit of that same 6515 // predecessor when entering and exiting the not exposed descendant. This 6516 // is fine since the client has a clear idea which view is hovered at the 6517 // price of a couple more events being sent. This is a simple and 6518 // working solution. 6519 View source = this; 6520 while (true) { 6521 if (source.includeForAccessibility()) { 6522 source.sendAccessibilityEvent(eventType); 6523 return; 6524 } 6525 ViewParent parent = source.getParent(); 6526 if (parent instanceof View) { 6527 source = (View) parent; 6528 } else { 6529 return; 6530 } 6531 } 6532 } 6533 6534 /** 6535 * Clears accessibility focus without calling any callback methods 6536 * normally invoked in {@link #clearAccessibilityFocus()}. This method 6537 * is used for clearing accessibility focus when giving this focus to 6538 * another view. 6539 */ 6540 void clearAccessibilityFocusNoCallbacks() { 6541 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_FOCUSED) != 0) { 6542 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_FOCUSED; 6543 invalidate(); 6544 } 6545 } 6546 6547 /** 6548 * Call this to try to give focus to a specific view or to one of its 6549 * descendants. 6550 * 6551 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 6552 * false), or if it is focusable and it is not focusable in touch mode 6553 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 6554 * 6555 * See also {@link #focusSearch(int)}, which is what you call to say that you 6556 * have focus, and you want your parent to look for the next one. 6557 * 6558 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 6559 * {@link #FOCUS_DOWN} and <code>null</code>. 6560 * 6561 * @return Whether this view or one of its descendants actually took focus. 6562 */ 6563 public final boolean requestFocus() { 6564 return requestFocus(View.FOCUS_DOWN); 6565 } 6566 6567 /** 6568 * Call this to try to give focus to a specific view or to one of its 6569 * descendants and give it a hint about what direction focus is heading. 6570 * 6571 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 6572 * false), or if it is focusable and it is not focusable in touch mode 6573 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 6574 * 6575 * See also {@link #focusSearch(int)}, which is what you call to say that you 6576 * have focus, and you want your parent to look for the next one. 6577 * 6578 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 6579 * <code>null</code> set for the previously focused rectangle. 6580 * 6581 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 6582 * @return Whether this view or one of its descendants actually took focus. 6583 */ 6584 public final boolean requestFocus(int direction) { 6585 return requestFocus(direction, null); 6586 } 6587 6588 /** 6589 * Call this to try to give focus to a specific view or to one of its descendants 6590 * and give it hints about the direction and a specific rectangle that the focus 6591 * is coming from. The rectangle can help give larger views a finer grained hint 6592 * about where focus is coming from, and therefore, where to show selection, or 6593 * forward focus change internally. 6594 * 6595 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 6596 * false), or if it is focusable and it is not focusable in touch mode 6597 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 6598 * 6599 * A View will not take focus if it is not visible. 6600 * 6601 * A View will not take focus if one of its parents has 6602 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 6603 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 6604 * 6605 * See also {@link #focusSearch(int)}, which is what you call to say that you 6606 * have focus, and you want your parent to look for the next one. 6607 * 6608 * You may wish to override this method if your custom {@link View} has an internal 6609 * {@link View} that it wishes to forward the request to. 6610 * 6611 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 6612 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 6613 * to give a finer grained hint about where focus is coming from. May be null 6614 * if there is no hint. 6615 * @return Whether this view or one of its descendants actually took focus. 6616 */ 6617 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 6618 return requestFocusNoSearch(direction, previouslyFocusedRect); 6619 } 6620 6621 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) { 6622 // need to be focusable 6623 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 6624 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6625 return false; 6626 } 6627 6628 // need to be focusable in touch mode if in touch mode 6629 if (isInTouchMode() && 6630 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 6631 return false; 6632 } 6633 6634 // need to not have any parents blocking us 6635 if (hasAncestorThatBlocksDescendantFocus()) { 6636 return false; 6637 } 6638 6639 handleFocusGainInternal(direction, previouslyFocusedRect); 6640 return true; 6641 } 6642 6643 /** 6644 * Call this to try to give focus to a specific view or to one of its descendants. This is a 6645 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 6646 * touch mode to request focus when they are touched. 6647 * 6648 * @return Whether this view or one of its descendants actually took focus. 6649 * 6650 * @see #isInTouchMode() 6651 * 6652 */ 6653 public final boolean requestFocusFromTouch() { 6654 // Leave touch mode if we need to 6655 if (isInTouchMode()) { 6656 ViewRootImpl viewRoot = getViewRootImpl(); 6657 if (viewRoot != null) { 6658 viewRoot.ensureTouchMode(false); 6659 } 6660 } 6661 return requestFocus(View.FOCUS_DOWN); 6662 } 6663 6664 /** 6665 * @return Whether any ancestor of this view blocks descendant focus. 6666 */ 6667 private boolean hasAncestorThatBlocksDescendantFocus() { 6668 ViewParent ancestor = mParent; 6669 while (ancestor instanceof ViewGroup) { 6670 final ViewGroup vgAncestor = (ViewGroup) ancestor; 6671 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) { 6672 return true; 6673 } else { 6674 ancestor = vgAncestor.getParent(); 6675 } 6676 } 6677 return false; 6678 } 6679 6680 /** 6681 * Gets the mode for determining whether this View is important for accessibility 6682 * which is if it fires accessibility events and if it is reported to 6683 * accessibility services that query the screen. 6684 * 6685 * @return The mode for determining whether a View is important for accessibility. 6686 * 6687 * @attr ref android.R.styleable#View_importantForAccessibility 6688 * 6689 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 6690 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 6691 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 6692 */ 6693 @ViewDebug.ExportedProperty(category = "accessibility", mapping = { 6694 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, to = "auto"), 6695 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, to = "yes"), 6696 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, to = "no") 6697 }) 6698 public int getImportantForAccessibility() { 6699 return (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 6700 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 6701 } 6702 6703 /** 6704 * Sets how to determine whether this view is important for accessibility 6705 * which is if it fires accessibility events and if it is reported to 6706 * accessibility services that query the screen. 6707 * 6708 * @param mode How to determine whether this view is important for accessibility. 6709 * 6710 * @attr ref android.R.styleable#View_importantForAccessibility 6711 * 6712 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 6713 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 6714 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 6715 */ 6716 public void setImportantForAccessibility(int mode) { 6717 if (mode != getImportantForAccessibility()) { 6718 mPrivateFlags2 &= ~PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 6719 mPrivateFlags2 |= (mode << PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT) 6720 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK; 6721 notifyAccessibilityStateChanged(); 6722 } 6723 } 6724 6725 /** 6726 * Gets whether this view should be exposed for accessibility. 6727 * 6728 * @return Whether the view is exposed for accessibility. 6729 * 6730 * @hide 6731 */ 6732 public boolean isImportantForAccessibility() { 6733 final int mode = (mPrivateFlags2 & PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_MASK) 6734 >> PFLAG2_IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 6735 switch (mode) { 6736 case IMPORTANT_FOR_ACCESSIBILITY_YES: 6737 return true; 6738 case IMPORTANT_FOR_ACCESSIBILITY_NO: 6739 return false; 6740 case IMPORTANT_FOR_ACCESSIBILITY_AUTO: 6741 return isActionableForAccessibility() || hasListenersForAccessibility() 6742 || getAccessibilityNodeProvider() != null; 6743 default: 6744 throw new IllegalArgumentException("Unknow important for accessibility mode: " 6745 + mode); 6746 } 6747 } 6748 6749 /** 6750 * Gets the parent for accessibility purposes. Note that the parent for 6751 * accessibility is not necessary the immediate parent. It is the first 6752 * predecessor that is important for accessibility. 6753 * 6754 * @return The parent for accessibility purposes. 6755 */ 6756 public ViewParent getParentForAccessibility() { 6757 if (mParent instanceof View) { 6758 View parentView = (View) mParent; 6759 if (parentView.includeForAccessibility()) { 6760 return mParent; 6761 } else { 6762 return mParent.getParentForAccessibility(); 6763 } 6764 } 6765 return null; 6766 } 6767 6768 /** 6769 * Adds the children of a given View for accessibility. Since some Views are 6770 * not important for accessibility the children for accessibility are not 6771 * necessarily direct children of the riew, rather they are the first level of 6772 * descendants important for accessibility. 6773 * 6774 * @param children The list of children for accessibility. 6775 */ 6776 public void addChildrenForAccessibility(ArrayList<View> children) { 6777 if (includeForAccessibility()) { 6778 children.add(this); 6779 } 6780 } 6781 6782 /** 6783 * Whether to regard this view for accessibility. A view is regarded for 6784 * accessibility if it is important for accessibility or the querying 6785 * accessibility service has explicitly requested that view not 6786 * important for accessibility are regarded. 6787 * 6788 * @return Whether to regard the view for accessibility. 6789 * 6790 * @hide 6791 */ 6792 public boolean includeForAccessibility() { 6793 if (mAttachInfo != null) { 6794 return mAttachInfo.mIncludeNotImportantViews || isImportantForAccessibility(); 6795 } 6796 return false; 6797 } 6798 6799 /** 6800 * Returns whether the View is considered actionable from 6801 * accessibility perspective. Such view are important for 6802 * accessibility. 6803 * 6804 * @return True if the view is actionable for accessibility. 6805 * 6806 * @hide 6807 */ 6808 public boolean isActionableForAccessibility() { 6809 return (isClickable() || isLongClickable() || isFocusable()); 6810 } 6811 6812 /** 6813 * Returns whether the View has registered callbacks wich makes it 6814 * important for accessibility. 6815 * 6816 * @return True if the view is actionable for accessibility. 6817 */ 6818 private boolean hasListenersForAccessibility() { 6819 ListenerInfo info = getListenerInfo(); 6820 return mTouchDelegate != null || info.mOnKeyListener != null 6821 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null 6822 || info.mOnHoverListener != null || info.mOnDragListener != null; 6823 } 6824 6825 /** 6826 * Notifies accessibility services that some view's important for 6827 * accessibility state has changed. Note that such notifications 6828 * are made at most once every 6829 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 6830 * to avoid unnecessary load to the system. Also once a view has 6831 * made a notifucation this method is a NOP until the notification has 6832 * been sent to clients. 6833 * 6834 * @hide 6835 * 6836 * TODO: Makse sure this method is called for any view state change 6837 * that is interesting for accessilility purposes. 6838 */ 6839 public void notifyAccessibilityStateChanged() { 6840 if (!AccessibilityManager.getInstance(mContext).isEnabled()) { 6841 return; 6842 } 6843 if ((mPrivateFlags2 & PFLAG2_ACCESSIBILITY_STATE_CHANGED) == 0) { 6844 mPrivateFlags2 |= PFLAG2_ACCESSIBILITY_STATE_CHANGED; 6845 if (mParent != null) { 6846 mParent.childAccessibilityStateChanged(this); 6847 } 6848 } 6849 } 6850 6851 /** 6852 * Reset the state indicating the this view has requested clients 6853 * interested in its accessibility state to be notified. 6854 * 6855 * @hide 6856 */ 6857 public void resetAccessibilityStateChanged() { 6858 mPrivateFlags2 &= ~PFLAG2_ACCESSIBILITY_STATE_CHANGED; 6859 } 6860 6861 /** 6862 * Performs the specified accessibility action on the view. For 6863 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 6864 * <p> 6865 * If an {@link AccessibilityDelegate} has been specified via calling 6866 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 6867 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)} 6868 * is responsible for handling this call. 6869 * </p> 6870 * 6871 * @param action The action to perform. 6872 * @param arguments Optional action arguments. 6873 * @return Whether the action was performed. 6874 */ 6875 public boolean performAccessibilityAction(int action, Bundle arguments) { 6876 if (mAccessibilityDelegate != null) { 6877 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments); 6878 } else { 6879 return performAccessibilityActionInternal(action, arguments); 6880 } 6881 } 6882 6883 /** 6884 * @see #performAccessibilityAction(int, Bundle) 6885 * 6886 * Note: Called from the default {@link AccessibilityDelegate}. 6887 */ 6888 boolean performAccessibilityActionInternal(int action, Bundle arguments) { 6889 switch (action) { 6890 case AccessibilityNodeInfo.ACTION_CLICK: { 6891 if (isClickable()) { 6892 performClick(); 6893 return true; 6894 } 6895 } break; 6896 case AccessibilityNodeInfo.ACTION_LONG_CLICK: { 6897 if (isLongClickable()) { 6898 performLongClick(); 6899 return true; 6900 } 6901 } break; 6902 case AccessibilityNodeInfo.ACTION_FOCUS: { 6903 if (!hasFocus()) { 6904 // Get out of touch mode since accessibility 6905 // wants to move focus around. 6906 getViewRootImpl().ensureTouchMode(false); 6907 return requestFocus(); 6908 } 6909 } break; 6910 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: { 6911 if (hasFocus()) { 6912 clearFocus(); 6913 return !isFocused(); 6914 } 6915 } break; 6916 case AccessibilityNodeInfo.ACTION_SELECT: { 6917 if (!isSelected()) { 6918 setSelected(true); 6919 return isSelected(); 6920 } 6921 } break; 6922 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: { 6923 if (isSelected()) { 6924 setSelected(false); 6925 return !isSelected(); 6926 } 6927 } break; 6928 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: { 6929 if (!isAccessibilityFocused()) { 6930 return requestAccessibilityFocus(); 6931 } 6932 } break; 6933 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: { 6934 if (isAccessibilityFocused()) { 6935 clearAccessibilityFocus(); 6936 return true; 6937 } 6938 } break; 6939 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: { 6940 if (arguments != null) { 6941 final int granularity = arguments.getInt( 6942 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 6943 return nextAtGranularity(granularity); 6944 } 6945 } break; 6946 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: { 6947 if (arguments != null) { 6948 final int granularity = arguments.getInt( 6949 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 6950 return previousAtGranularity(granularity); 6951 } 6952 } break; 6953 } 6954 return false; 6955 } 6956 6957 private boolean nextAtGranularity(int granularity) { 6958 CharSequence text = getIterableTextForAccessibility(); 6959 if (text == null || text.length() == 0) { 6960 return false; 6961 } 6962 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 6963 if (iterator == null) { 6964 return false; 6965 } 6966 final int current = getAccessibilityCursorPosition(); 6967 final int[] range = iterator.following(current); 6968 if (range == null) { 6969 return false; 6970 } 6971 final int start = range[0]; 6972 final int end = range[1]; 6973 setAccessibilityCursorPosition(end); 6974 sendViewTextTraversedAtGranularityEvent( 6975 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY, 6976 granularity, start, end); 6977 return true; 6978 } 6979 6980 private boolean previousAtGranularity(int granularity) { 6981 CharSequence text = getIterableTextForAccessibility(); 6982 if (text == null || text.length() == 0) { 6983 return false; 6984 } 6985 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 6986 if (iterator == null) { 6987 return false; 6988 } 6989 int current = getAccessibilityCursorPosition(); 6990 if (current == ACCESSIBILITY_CURSOR_POSITION_UNDEFINED) { 6991 current = text.length(); 6992 } else if (granularity == AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER) { 6993 // When traversing by character we always put the cursor after the character 6994 // to ease edit and have to compensate before asking the for previous segment. 6995 current--; 6996 } 6997 final int[] range = iterator.preceding(current); 6998 if (range == null) { 6999 return false; 7000 } 7001 final int start = range[0]; 7002 final int end = range[1]; 7003 // Always put the cursor after the character to ease edit. 7004 if (granularity == AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER) { 7005 setAccessibilityCursorPosition(end); 7006 } else { 7007 setAccessibilityCursorPosition(start); 7008 } 7009 sendViewTextTraversedAtGranularityEvent( 7010 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY, 7011 granularity, start, end); 7012 return true; 7013 } 7014 7015 /** 7016 * Gets the text reported for accessibility purposes. 7017 * 7018 * @return The accessibility text. 7019 * 7020 * @hide 7021 */ 7022 public CharSequence getIterableTextForAccessibility() { 7023 return getContentDescription(); 7024 } 7025 7026 /** 7027 * @hide 7028 */ 7029 public int getAccessibilityCursorPosition() { 7030 return mAccessibilityCursorPosition; 7031 } 7032 7033 /** 7034 * @hide 7035 */ 7036 public void setAccessibilityCursorPosition(int position) { 7037 mAccessibilityCursorPosition = position; 7038 } 7039 7040 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity, 7041 int fromIndex, int toIndex) { 7042 if (mParent == null) { 7043 return; 7044 } 7045 AccessibilityEvent event = AccessibilityEvent.obtain( 7046 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY); 7047 onInitializeAccessibilityEvent(event); 7048 onPopulateAccessibilityEvent(event); 7049 event.setFromIndex(fromIndex); 7050 event.setToIndex(toIndex); 7051 event.setAction(action); 7052 event.setMovementGranularity(granularity); 7053 mParent.requestSendAccessibilityEvent(this, event); 7054 } 7055 7056 /** 7057 * @hide 7058 */ 7059 public TextSegmentIterator getIteratorForGranularity(int granularity) { 7060 switch (granularity) { 7061 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: { 7062 CharSequence text = getIterableTextForAccessibility(); 7063 if (text != null && text.length() > 0) { 7064 CharacterTextSegmentIterator iterator = 7065 CharacterTextSegmentIterator.getInstance( 7066 mContext.getResources().getConfiguration().locale); 7067 iterator.initialize(text.toString()); 7068 return iterator; 7069 } 7070 } break; 7071 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: { 7072 CharSequence text = getIterableTextForAccessibility(); 7073 if (text != null && text.length() > 0) { 7074 WordTextSegmentIterator iterator = 7075 WordTextSegmentIterator.getInstance( 7076 mContext.getResources().getConfiguration().locale); 7077 iterator.initialize(text.toString()); 7078 return iterator; 7079 } 7080 } break; 7081 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: { 7082 CharSequence text = getIterableTextForAccessibility(); 7083 if (text != null && text.length() > 0) { 7084 ParagraphTextSegmentIterator iterator = 7085 ParagraphTextSegmentIterator.getInstance(); 7086 iterator.initialize(text.toString()); 7087 return iterator; 7088 } 7089 } break; 7090 } 7091 return null; 7092 } 7093 7094 /** 7095 * @hide 7096 */ 7097 public void dispatchStartTemporaryDetach() { 7098 clearAccessibilityFocus(); 7099 clearDisplayList(); 7100 7101 onStartTemporaryDetach(); 7102 } 7103 7104 /** 7105 * This is called when a container is going to temporarily detach a child, with 7106 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 7107 * It will either be followed by {@link #onFinishTemporaryDetach()} or 7108 * {@link #onDetachedFromWindow()} when the container is done. 7109 */ 7110 public void onStartTemporaryDetach() { 7111 removeUnsetPressCallback(); 7112 mPrivateFlags |= PFLAG_CANCEL_NEXT_UP_EVENT; 7113 } 7114 7115 /** 7116 * @hide 7117 */ 7118 public void dispatchFinishTemporaryDetach() { 7119 onFinishTemporaryDetach(); 7120 } 7121 7122 /** 7123 * Called after {@link #onStartTemporaryDetach} when the container is done 7124 * changing the view. 7125 */ 7126 public void onFinishTemporaryDetach() { 7127 } 7128 7129 /** 7130 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 7131 * for this view's window. Returns null if the view is not currently attached 7132 * to the window. Normally you will not need to use this directly, but 7133 * just use the standard high-level event callbacks like 7134 * {@link #onKeyDown(int, KeyEvent)}. 7135 */ 7136 public KeyEvent.DispatcherState getKeyDispatcherState() { 7137 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 7138 } 7139 7140 /** 7141 * Dispatch a key event before it is processed by any input method 7142 * associated with the view hierarchy. This can be used to intercept 7143 * key events in special situations before the IME consumes them; a 7144 * typical example would be handling the BACK key to update the application's 7145 * UI instead of allowing the IME to see it and close itself. 7146 * 7147 * @param event The key event to be dispatched. 7148 * @return True if the event was handled, false otherwise. 7149 */ 7150 public boolean dispatchKeyEventPreIme(KeyEvent event) { 7151 return onKeyPreIme(event.getKeyCode(), event); 7152 } 7153 7154 /** 7155 * Dispatch a key event to the next view on the focus path. This path runs 7156 * from the top of the view tree down to the currently focused view. If this 7157 * view has focus, it will dispatch to itself. Otherwise it will dispatch 7158 * the next node down the focus path. This method also fires any key 7159 * listeners. 7160 * 7161 * @param event The key event to be dispatched. 7162 * @return True if the event was handled, false otherwise. 7163 */ 7164 public boolean dispatchKeyEvent(KeyEvent event) { 7165 if (mInputEventConsistencyVerifier != null) { 7166 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 7167 } 7168 7169 // Give any attached key listener a first crack at the event. 7170 //noinspection SimplifiableIfStatement 7171 ListenerInfo li = mListenerInfo; 7172 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 7173 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 7174 return true; 7175 } 7176 7177 if (event.dispatch(this, mAttachInfo != null 7178 ? mAttachInfo.mKeyDispatchState : null, this)) { 7179 return true; 7180 } 7181 7182 if (mInputEventConsistencyVerifier != null) { 7183 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 7184 } 7185 return false; 7186 } 7187 7188 /** 7189 * Dispatches a key shortcut event. 7190 * 7191 * @param event The key event to be dispatched. 7192 * @return True if the event was handled by the view, false otherwise. 7193 */ 7194 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 7195 return onKeyShortcut(event.getKeyCode(), event); 7196 } 7197 7198 /** 7199 * Pass the touch screen motion event down to the target view, or this 7200 * view if it is the target. 7201 * 7202 * @param event The motion event to be dispatched. 7203 * @return True if the event was handled by the view, false otherwise. 7204 */ 7205 public boolean dispatchTouchEvent(MotionEvent event) { 7206 if (mInputEventConsistencyVerifier != null) { 7207 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 7208 } 7209 7210 if (onFilterTouchEventForSecurity(event)) { 7211 //noinspection SimplifiableIfStatement 7212 ListenerInfo li = mListenerInfo; 7213 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 7214 && li.mOnTouchListener.onTouch(this, event)) { 7215 return true; 7216 } 7217 7218 if (onTouchEvent(event)) { 7219 return true; 7220 } 7221 } 7222 7223 if (mInputEventConsistencyVerifier != null) { 7224 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 7225 } 7226 return false; 7227 } 7228 7229 /** 7230 * Filter the touch event to apply security policies. 7231 * 7232 * @param event The motion event to be filtered. 7233 * @return True if the event should be dispatched, false if the event should be dropped. 7234 * 7235 * @see #getFilterTouchesWhenObscured 7236 */ 7237 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 7238 //noinspection RedundantIfStatement 7239 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 7240 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 7241 // Window is obscured, drop this touch. 7242 return false; 7243 } 7244 return true; 7245 } 7246 7247 /** 7248 * Pass a trackball motion event down to the focused view. 7249 * 7250 * @param event The motion event to be dispatched. 7251 * @return True if the event was handled by the view, false otherwise. 7252 */ 7253 public boolean dispatchTrackballEvent(MotionEvent event) { 7254 if (mInputEventConsistencyVerifier != null) { 7255 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 7256 } 7257 7258 return onTrackballEvent(event); 7259 } 7260 7261 /** 7262 * Dispatch a generic motion event. 7263 * <p> 7264 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 7265 * are delivered to the view under the pointer. All other generic motion events are 7266 * delivered to the focused view. Hover events are handled specially and are delivered 7267 * to {@link #onHoverEvent(MotionEvent)}. 7268 * </p> 7269 * 7270 * @param event The motion event to be dispatched. 7271 * @return True if the event was handled by the view, false otherwise. 7272 */ 7273 public boolean dispatchGenericMotionEvent(MotionEvent event) { 7274 if (mInputEventConsistencyVerifier != null) { 7275 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 7276 } 7277 7278 final int source = event.getSource(); 7279 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 7280 final int action = event.getAction(); 7281 if (action == MotionEvent.ACTION_HOVER_ENTER 7282 || action == MotionEvent.ACTION_HOVER_MOVE 7283 || action == MotionEvent.ACTION_HOVER_EXIT) { 7284 if (dispatchHoverEvent(event)) { 7285 return true; 7286 } 7287 } else if (dispatchGenericPointerEvent(event)) { 7288 return true; 7289 } 7290 } else if (dispatchGenericFocusedEvent(event)) { 7291 return true; 7292 } 7293 7294 if (dispatchGenericMotionEventInternal(event)) { 7295 return true; 7296 } 7297 7298 if (mInputEventConsistencyVerifier != null) { 7299 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 7300 } 7301 return false; 7302 } 7303 7304 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 7305 //noinspection SimplifiableIfStatement 7306 ListenerInfo li = mListenerInfo; 7307 if (li != null && li.mOnGenericMotionListener != null 7308 && (mViewFlags & ENABLED_MASK) == ENABLED 7309 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 7310 return true; 7311 } 7312 7313 if (onGenericMotionEvent(event)) { 7314 return true; 7315 } 7316 7317 if (mInputEventConsistencyVerifier != null) { 7318 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 7319 } 7320 return false; 7321 } 7322 7323 /** 7324 * Dispatch a hover event. 7325 * <p> 7326 * Do not call this method directly. 7327 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 7328 * </p> 7329 * 7330 * @param event The motion event to be dispatched. 7331 * @return True if the event was handled by the view, false otherwise. 7332 */ 7333 protected boolean dispatchHoverEvent(MotionEvent event) { 7334 //noinspection SimplifiableIfStatement 7335 ListenerInfo li = mListenerInfo; 7336 if (li != null && li.mOnHoverListener != null 7337 && (mViewFlags & ENABLED_MASK) == ENABLED 7338 && li.mOnHoverListener.onHover(this, event)) { 7339 return true; 7340 } 7341 7342 return onHoverEvent(event); 7343 } 7344 7345 /** 7346 * Returns true if the view has a child to which it has recently sent 7347 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 7348 * it does not have a hovered child, then it must be the innermost hovered view. 7349 * @hide 7350 */ 7351 protected boolean hasHoveredChild() { 7352 return false; 7353 } 7354 7355 /** 7356 * Dispatch a generic motion event to the view under the first pointer. 7357 * <p> 7358 * Do not call this method directly. 7359 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 7360 * </p> 7361 * 7362 * @param event The motion event to be dispatched. 7363 * @return True if the event was handled by the view, false otherwise. 7364 */ 7365 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 7366 return false; 7367 } 7368 7369 /** 7370 * Dispatch a generic motion event to the currently focused view. 7371 * <p> 7372 * Do not call this method directly. 7373 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 7374 * </p> 7375 * 7376 * @param event The motion event to be dispatched. 7377 * @return True if the event was handled by the view, false otherwise. 7378 */ 7379 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 7380 return false; 7381 } 7382 7383 /** 7384 * Dispatch a pointer event. 7385 * <p> 7386 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 7387 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 7388 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 7389 * and should not be expected to handle other pointing device features. 7390 * </p> 7391 * 7392 * @param event The motion event to be dispatched. 7393 * @return True if the event was handled by the view, false otherwise. 7394 * @hide 7395 */ 7396 public final boolean dispatchPointerEvent(MotionEvent event) { 7397 if (event.isTouchEvent()) { 7398 return dispatchTouchEvent(event); 7399 } else { 7400 return dispatchGenericMotionEvent(event); 7401 } 7402 } 7403 7404 /** 7405 * Called when the window containing this view gains or loses window focus. 7406 * ViewGroups should override to route to their children. 7407 * 7408 * @param hasFocus True if the window containing this view now has focus, 7409 * false otherwise. 7410 */ 7411 public void dispatchWindowFocusChanged(boolean hasFocus) { 7412 onWindowFocusChanged(hasFocus); 7413 } 7414 7415 /** 7416 * Called when the window containing this view gains or loses focus. Note 7417 * that this is separate from view focus: to receive key events, both 7418 * your view and its window must have focus. If a window is displayed 7419 * on top of yours that takes input focus, then your own window will lose 7420 * focus but the view focus will remain unchanged. 7421 * 7422 * @param hasWindowFocus True if the window containing this view now has 7423 * focus, false otherwise. 7424 */ 7425 public void onWindowFocusChanged(boolean hasWindowFocus) { 7426 InputMethodManager imm = InputMethodManager.peekInstance(); 7427 if (!hasWindowFocus) { 7428 if (isPressed()) { 7429 setPressed(false); 7430 } 7431 if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 7432 imm.focusOut(this); 7433 } 7434 removeLongPressCallback(); 7435 removeTapCallback(); 7436 onFocusLost(); 7437 } else if (imm != null && (mPrivateFlags & PFLAG_FOCUSED) != 0) { 7438 imm.focusIn(this); 7439 } 7440 refreshDrawableState(); 7441 } 7442 7443 /** 7444 * Returns true if this view is in a window that currently has window focus. 7445 * Note that this is not the same as the view itself having focus. 7446 * 7447 * @return True if this view is in a window that currently has window focus. 7448 */ 7449 public boolean hasWindowFocus() { 7450 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 7451 } 7452 7453 /** 7454 * Dispatch a view visibility change down the view hierarchy. 7455 * ViewGroups should override to route to their children. 7456 * @param changedView The view whose visibility changed. Could be 'this' or 7457 * an ancestor view. 7458 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 7459 * {@link #INVISIBLE} or {@link #GONE}. 7460 */ 7461 protected void dispatchVisibilityChanged(View changedView, int visibility) { 7462 onVisibilityChanged(changedView, visibility); 7463 } 7464 7465 /** 7466 * Called when the visibility of the view or an ancestor of the view is changed. 7467 * @param changedView The view whose visibility changed. Could be 'this' or 7468 * an ancestor view. 7469 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 7470 * {@link #INVISIBLE} or {@link #GONE}. 7471 */ 7472 protected void onVisibilityChanged(View changedView, int visibility) { 7473 if (visibility == VISIBLE) { 7474 if (mAttachInfo != null) { 7475 initialAwakenScrollBars(); 7476 } else { 7477 mPrivateFlags |= PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 7478 } 7479 } 7480 } 7481 7482 /** 7483 * Dispatch a hint about whether this view is displayed. For instance, when 7484 * a View moves out of the screen, it might receives a display hint indicating 7485 * the view is not displayed. Applications should not <em>rely</em> on this hint 7486 * as there is no guarantee that they will receive one. 7487 * 7488 * @param hint A hint about whether or not this view is displayed: 7489 * {@link #VISIBLE} or {@link #INVISIBLE}. 7490 */ 7491 public void dispatchDisplayHint(int hint) { 7492 onDisplayHint(hint); 7493 } 7494 7495 /** 7496 * Gives this view a hint about whether is displayed or not. For instance, when 7497 * a View moves out of the screen, it might receives a display hint indicating 7498 * the view is not displayed. Applications should not <em>rely</em> on this hint 7499 * as there is no guarantee that they will receive one. 7500 * 7501 * @param hint A hint about whether or not this view is displayed: 7502 * {@link #VISIBLE} or {@link #INVISIBLE}. 7503 */ 7504 protected void onDisplayHint(int hint) { 7505 } 7506 7507 /** 7508 * Dispatch a window visibility change down the view hierarchy. 7509 * ViewGroups should override to route to their children. 7510 * 7511 * @param visibility The new visibility of the window. 7512 * 7513 * @see #onWindowVisibilityChanged(int) 7514 */ 7515 public void dispatchWindowVisibilityChanged(int visibility) { 7516 onWindowVisibilityChanged(visibility); 7517 } 7518 7519 /** 7520 * Called when the window containing has change its visibility 7521 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 7522 * that this tells you whether or not your window is being made visible 7523 * to the window manager; this does <em>not</em> tell you whether or not 7524 * your window is obscured by other windows on the screen, even if it 7525 * is itself visible. 7526 * 7527 * @param visibility The new visibility of the window. 7528 */ 7529 protected void onWindowVisibilityChanged(int visibility) { 7530 if (visibility == VISIBLE) { 7531 initialAwakenScrollBars(); 7532 } 7533 } 7534 7535 /** 7536 * Returns the current visibility of the window this view is attached to 7537 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 7538 * 7539 * @return Returns the current visibility of the view's window. 7540 */ 7541 public int getWindowVisibility() { 7542 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 7543 } 7544 7545 /** 7546 * Retrieve the overall visible display size in which the window this view is 7547 * attached to has been positioned in. This takes into account screen 7548 * decorations above the window, for both cases where the window itself 7549 * is being position inside of them or the window is being placed under 7550 * then and covered insets are used for the window to position its content 7551 * inside. In effect, this tells you the available area where content can 7552 * be placed and remain visible to users. 7553 * 7554 * <p>This function requires an IPC back to the window manager to retrieve 7555 * the requested information, so should not be used in performance critical 7556 * code like drawing. 7557 * 7558 * @param outRect Filled in with the visible display frame. If the view 7559 * is not attached to a window, this is simply the raw display size. 7560 */ 7561 public void getWindowVisibleDisplayFrame(Rect outRect) { 7562 if (mAttachInfo != null) { 7563 try { 7564 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 7565 } catch (RemoteException e) { 7566 return; 7567 } 7568 // XXX This is really broken, and probably all needs to be done 7569 // in the window manager, and we need to know more about whether 7570 // we want the area behind or in front of the IME. 7571 final Rect insets = mAttachInfo.mVisibleInsets; 7572 outRect.left += insets.left; 7573 outRect.top += insets.top; 7574 outRect.right -= insets.right; 7575 outRect.bottom -= insets.bottom; 7576 return; 7577 } 7578 // The view is not attached to a display so we don't have a context. 7579 // Make a best guess about the display size. 7580 Display d = DisplayManagerGlobal.getInstance().getRealDisplay(Display.DEFAULT_DISPLAY); 7581 d.getRectSize(outRect); 7582 } 7583 7584 /** 7585 * Dispatch a notification about a resource configuration change down 7586 * the view hierarchy. 7587 * ViewGroups should override to route to their children. 7588 * 7589 * @param newConfig The new resource configuration. 7590 * 7591 * @see #onConfigurationChanged(android.content.res.Configuration) 7592 */ 7593 public void dispatchConfigurationChanged(Configuration newConfig) { 7594 onConfigurationChanged(newConfig); 7595 } 7596 7597 /** 7598 * Called when the current configuration of the resources being used 7599 * by the application have changed. You can use this to decide when 7600 * to reload resources that can changed based on orientation and other 7601 * configuration characterstics. You only need to use this if you are 7602 * not relying on the normal {@link android.app.Activity} mechanism of 7603 * recreating the activity instance upon a configuration change. 7604 * 7605 * @param newConfig The new resource configuration. 7606 */ 7607 protected void onConfigurationChanged(Configuration newConfig) { 7608 } 7609 7610 /** 7611 * Private function to aggregate all per-view attributes in to the view 7612 * root. 7613 */ 7614 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) { 7615 performCollectViewAttributes(attachInfo, visibility); 7616 } 7617 7618 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) { 7619 if ((visibility & VISIBILITY_MASK) == VISIBLE) { 7620 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 7621 attachInfo.mKeepScreenOn = true; 7622 } 7623 attachInfo.mSystemUiVisibility |= mSystemUiVisibility; 7624 ListenerInfo li = mListenerInfo; 7625 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 7626 attachInfo.mHasSystemUiListeners = true; 7627 } 7628 } 7629 } 7630 7631 void needGlobalAttributesUpdate(boolean force) { 7632 final AttachInfo ai = mAttachInfo; 7633 if (ai != null && !ai.mRecomputeGlobalAttributes) { 7634 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 7635 || ai.mHasSystemUiListeners) { 7636 ai.mRecomputeGlobalAttributes = true; 7637 } 7638 } 7639 } 7640 7641 /** 7642 * Returns whether the device is currently in touch mode. Touch mode is entered 7643 * once the user begins interacting with the device by touch, and affects various 7644 * things like whether focus is always visible to the user. 7645 * 7646 * @return Whether the device is in touch mode. 7647 */ 7648 @ViewDebug.ExportedProperty 7649 public boolean isInTouchMode() { 7650 if (mAttachInfo != null) { 7651 return mAttachInfo.mInTouchMode; 7652 } else { 7653 return ViewRootImpl.isInTouchMode(); 7654 } 7655 } 7656 7657 /** 7658 * Returns the context the view is running in, through which it can 7659 * access the current theme, resources, etc. 7660 * 7661 * @return The view's Context. 7662 */ 7663 @ViewDebug.CapturedViewProperty 7664 public final Context getContext() { 7665 return mContext; 7666 } 7667 7668 /** 7669 * Handle a key event before it is processed by any input method 7670 * associated with the view hierarchy. This can be used to intercept 7671 * key events in special situations before the IME consumes them; a 7672 * typical example would be handling the BACK key to update the application's 7673 * UI instead of allowing the IME to see it and close itself. 7674 * 7675 * @param keyCode The value in event.getKeyCode(). 7676 * @param event Description of the key event. 7677 * @return If you handled the event, return true. If you want to allow the 7678 * event to be handled by the next receiver, return false. 7679 */ 7680 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 7681 return false; 7682 } 7683 7684 /** 7685 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 7686 * KeyEvent.Callback.onKeyDown()}: perform press of the view 7687 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 7688 * is released, if the view is enabled and clickable. 7689 * 7690 * <p>Key presses in software keyboards will generally NOT trigger this listener, 7691 * although some may elect to do so in some situations. Do not rely on this to 7692 * catch software key presses. 7693 * 7694 * @param keyCode A key code that represents the button pressed, from 7695 * {@link android.view.KeyEvent}. 7696 * @param event The KeyEvent object that defines the button action. 7697 */ 7698 public boolean onKeyDown(int keyCode, KeyEvent event) { 7699 boolean result = false; 7700 7701 switch (keyCode) { 7702 case KeyEvent.KEYCODE_DPAD_CENTER: 7703 case KeyEvent.KEYCODE_ENTER: { 7704 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 7705 return true; 7706 } 7707 // Long clickable items don't necessarily have to be clickable 7708 if (((mViewFlags & CLICKABLE) == CLICKABLE || 7709 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 7710 (event.getRepeatCount() == 0)) { 7711 setPressed(true); 7712 checkForLongClick(0); 7713 return true; 7714 } 7715 break; 7716 } 7717 } 7718 return result; 7719 } 7720 7721 /** 7722 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 7723 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 7724 * the event). 7725 * <p>Key presses in software keyboards will generally NOT trigger this listener, 7726 * although some may elect to do so in some situations. Do not rely on this to 7727 * catch software key presses. 7728 */ 7729 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 7730 return false; 7731 } 7732 7733 /** 7734 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 7735 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 7736 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 7737 * {@link KeyEvent#KEYCODE_ENTER} is released. 7738 * <p>Key presses in software keyboards will generally NOT trigger this listener, 7739 * although some may elect to do so in some situations. Do not rely on this to 7740 * catch software key presses. 7741 * 7742 * @param keyCode A key code that represents the button pressed, from 7743 * {@link android.view.KeyEvent}. 7744 * @param event The KeyEvent object that defines the button action. 7745 */ 7746 public boolean onKeyUp(int keyCode, KeyEvent event) { 7747 boolean result = false; 7748 7749 switch (keyCode) { 7750 case KeyEvent.KEYCODE_DPAD_CENTER: 7751 case KeyEvent.KEYCODE_ENTER: { 7752 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 7753 return true; 7754 } 7755 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 7756 setPressed(false); 7757 7758 if (!mHasPerformedLongPress) { 7759 // This is a tap, so remove the longpress check 7760 removeLongPressCallback(); 7761 7762 result = performClick(); 7763 } 7764 } 7765 break; 7766 } 7767 } 7768 return result; 7769 } 7770 7771 /** 7772 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 7773 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 7774 * the event). 7775 * <p>Key presses in software keyboards will generally NOT trigger this listener, 7776 * although some may elect to do so in some situations. Do not rely on this to 7777 * catch software key presses. 7778 * 7779 * @param keyCode A key code that represents the button pressed, from 7780 * {@link android.view.KeyEvent}. 7781 * @param repeatCount The number of times the action was made. 7782 * @param event The KeyEvent object that defines the button action. 7783 */ 7784 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 7785 return false; 7786 } 7787 7788 /** 7789 * Called on the focused view when a key shortcut event is not handled. 7790 * Override this method to implement local key shortcuts for the View. 7791 * Key shortcuts can also be implemented by setting the 7792 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 7793 * 7794 * @param keyCode The value in event.getKeyCode(). 7795 * @param event Description of the key event. 7796 * @return If you handled the event, return true. If you want to allow the 7797 * event to be handled by the next receiver, return false. 7798 */ 7799 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 7800 return false; 7801 } 7802 7803 /** 7804 * Check whether the called view is a text editor, in which case it 7805 * would make sense to automatically display a soft input window for 7806 * it. Subclasses should override this if they implement 7807 * {@link #onCreateInputConnection(EditorInfo)} to return true if 7808 * a call on that method would return a non-null InputConnection, and 7809 * they are really a first-class editor that the user would normally 7810 * start typing on when the go into a window containing your view. 7811 * 7812 * <p>The default implementation always returns false. This does 7813 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 7814 * will not be called or the user can not otherwise perform edits on your 7815 * view; it is just a hint to the system that this is not the primary 7816 * purpose of this view. 7817 * 7818 * @return Returns true if this view is a text editor, else false. 7819 */ 7820 public boolean onCheckIsTextEditor() { 7821 return false; 7822 } 7823 7824 /** 7825 * Create a new InputConnection for an InputMethod to interact 7826 * with the view. The default implementation returns null, since it doesn't 7827 * support input methods. You can override this to implement such support. 7828 * This is only needed for views that take focus and text input. 7829 * 7830 * <p>When implementing this, you probably also want to implement 7831 * {@link #onCheckIsTextEditor()} to indicate you will return a 7832 * non-null InputConnection. 7833 * 7834 * @param outAttrs Fill in with attribute information about the connection. 7835 */ 7836 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 7837 return null; 7838 } 7839 7840 /** 7841 * Called by the {@link android.view.inputmethod.InputMethodManager} 7842 * when a view who is not the current 7843 * input connection target is trying to make a call on the manager. The 7844 * default implementation returns false; you can override this to return 7845 * true for certain views if you are performing InputConnection proxying 7846 * to them. 7847 * @param view The View that is making the InputMethodManager call. 7848 * @return Return true to allow the call, false to reject. 7849 */ 7850 public boolean checkInputConnectionProxy(View view) { 7851 return false; 7852 } 7853 7854 /** 7855 * Show the context menu for this view. It is not safe to hold on to the 7856 * menu after returning from this method. 7857 * 7858 * You should normally not overload this method. Overload 7859 * {@link #onCreateContextMenu(ContextMenu)} or define an 7860 * {@link OnCreateContextMenuListener} to add items to the context menu. 7861 * 7862 * @param menu The context menu to populate 7863 */ 7864 public void createContextMenu(ContextMenu menu) { 7865 ContextMenuInfo menuInfo = getContextMenuInfo(); 7866 7867 // Sets the current menu info so all items added to menu will have 7868 // my extra info set. 7869 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 7870 7871 onCreateContextMenu(menu); 7872 ListenerInfo li = mListenerInfo; 7873 if (li != null && li.mOnCreateContextMenuListener != null) { 7874 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 7875 } 7876 7877 // Clear the extra information so subsequent items that aren't mine don't 7878 // have my extra info. 7879 ((MenuBuilder)menu).setCurrentMenuInfo(null); 7880 7881 if (mParent != null) { 7882 mParent.createContextMenu(menu); 7883 } 7884 } 7885 7886 /** 7887 * Views should implement this if they have extra information to associate 7888 * with the context menu. The return result is supplied as a parameter to 7889 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 7890 * callback. 7891 * 7892 * @return Extra information about the item for which the context menu 7893 * should be shown. This information will vary across different 7894 * subclasses of View. 7895 */ 7896 protected ContextMenuInfo getContextMenuInfo() { 7897 return null; 7898 } 7899 7900 /** 7901 * Views should implement this if the view itself is going to add items to 7902 * the context menu. 7903 * 7904 * @param menu the context menu to populate 7905 */ 7906 protected void onCreateContextMenu(ContextMenu menu) { 7907 } 7908 7909 /** 7910 * Implement this method to handle trackball motion events. The 7911 * <em>relative</em> movement of the trackball since the last event 7912 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 7913 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 7914 * that a movement of 1 corresponds to the user pressing one DPAD key (so 7915 * they will often be fractional values, representing the more fine-grained 7916 * movement information available from a trackball). 7917 * 7918 * @param event The motion event. 7919 * @return True if the event was handled, false otherwise. 7920 */ 7921 public boolean onTrackballEvent(MotionEvent event) { 7922 return false; 7923 } 7924 7925 /** 7926 * Implement this method to handle generic motion events. 7927 * <p> 7928 * Generic motion events describe joystick movements, mouse hovers, track pad 7929 * touches, scroll wheel movements and other input events. The 7930 * {@link MotionEvent#getSource() source} of the motion event specifies 7931 * the class of input that was received. Implementations of this method 7932 * must examine the bits in the source before processing the event. 7933 * The following code example shows how this is done. 7934 * </p><p> 7935 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 7936 * are delivered to the view under the pointer. All other generic motion events are 7937 * delivered to the focused view. 7938 * </p> 7939 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 7940 * if ((event.getSource() & InputDevice.SOURCE_CLASS_JOYSTICK) != 0) { 7941 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 7942 * // process the joystick movement... 7943 * return true; 7944 * } 7945 * } 7946 * if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) { 7947 * switch (event.getAction()) { 7948 * case MotionEvent.ACTION_HOVER_MOVE: 7949 * // process the mouse hover movement... 7950 * return true; 7951 * case MotionEvent.ACTION_SCROLL: 7952 * // process the scroll wheel movement... 7953 * return true; 7954 * } 7955 * } 7956 * return super.onGenericMotionEvent(event); 7957 * }</pre> 7958 * 7959 * @param event The generic motion event being processed. 7960 * @return True if the event was handled, false otherwise. 7961 */ 7962 public boolean onGenericMotionEvent(MotionEvent event) { 7963 return false; 7964 } 7965 7966 /** 7967 * Implement this method to handle hover events. 7968 * <p> 7969 * This method is called whenever a pointer is hovering into, over, or out of the 7970 * bounds of a view and the view is not currently being touched. 7971 * Hover events are represented as pointer events with action 7972 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 7973 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 7974 * </p> 7975 * <ul> 7976 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 7977 * when the pointer enters the bounds of the view.</li> 7978 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 7979 * when the pointer has already entered the bounds of the view and has moved.</li> 7980 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 7981 * when the pointer has exited the bounds of the view or when the pointer is 7982 * about to go down due to a button click, tap, or similar user action that 7983 * causes the view to be touched.</li> 7984 * </ul> 7985 * <p> 7986 * The view should implement this method to return true to indicate that it is 7987 * handling the hover event, such as by changing its drawable state. 7988 * </p><p> 7989 * The default implementation calls {@link #setHovered} to update the hovered state 7990 * of the view when a hover enter or hover exit event is received, if the view 7991 * is enabled and is clickable. The default implementation also sends hover 7992 * accessibility events. 7993 * </p> 7994 * 7995 * @param event The motion event that describes the hover. 7996 * @return True if the view handled the hover event. 7997 * 7998 * @see #isHovered 7999 * @see #setHovered 8000 * @see #onHoverChanged 8001 */ 8002 public boolean onHoverEvent(MotionEvent event) { 8003 // The root view may receive hover (or touch) events that are outside the bounds of 8004 // the window. This code ensures that we only send accessibility events for 8005 // hovers that are actually within the bounds of the root view. 8006 final int action = event.getActionMasked(); 8007 if (!mSendingHoverAccessibilityEvents) { 8008 if ((action == MotionEvent.ACTION_HOVER_ENTER 8009 || action == MotionEvent.ACTION_HOVER_MOVE) 8010 && !hasHoveredChild() 8011 && pointInView(event.getX(), event.getY())) { 8012 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 8013 mSendingHoverAccessibilityEvents = true; 8014 } 8015 } else { 8016 if (action == MotionEvent.ACTION_HOVER_EXIT 8017 || (action == MotionEvent.ACTION_MOVE 8018 && !pointInView(event.getX(), event.getY()))) { 8019 mSendingHoverAccessibilityEvents = false; 8020 sendAccessibilityHoverEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 8021 // If the window does not have input focus we take away accessibility 8022 // focus as soon as the user stop hovering over the view. 8023 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) { 8024 getViewRootImpl().setAccessibilityFocus(null, null); 8025 } 8026 } 8027 } 8028 8029 if (isHoverable()) { 8030 switch (action) { 8031 case MotionEvent.ACTION_HOVER_ENTER: 8032 setHovered(true); 8033 break; 8034 case MotionEvent.ACTION_HOVER_EXIT: 8035 setHovered(false); 8036 break; 8037 } 8038 8039 // Dispatch the event to onGenericMotionEvent before returning true. 8040 // This is to provide compatibility with existing applications that 8041 // handled HOVER_MOVE events in onGenericMotionEvent and that would 8042 // break because of the new default handling for hoverable views 8043 // in onHoverEvent. 8044 // Note that onGenericMotionEvent will be called by default when 8045 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 8046 dispatchGenericMotionEventInternal(event); 8047 return true; 8048 } 8049 8050 return false; 8051 } 8052 8053 /** 8054 * Returns true if the view should handle {@link #onHoverEvent} 8055 * by calling {@link #setHovered} to change its hovered state. 8056 * 8057 * @return True if the view is hoverable. 8058 */ 8059 private boolean isHoverable() { 8060 final int viewFlags = mViewFlags; 8061 if ((viewFlags & ENABLED_MASK) == DISABLED) { 8062 return false; 8063 } 8064 8065 return (viewFlags & CLICKABLE) == CLICKABLE 8066 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 8067 } 8068 8069 /** 8070 * Returns true if the view is currently hovered. 8071 * 8072 * @return True if the view is currently hovered. 8073 * 8074 * @see #setHovered 8075 * @see #onHoverChanged 8076 */ 8077 @ViewDebug.ExportedProperty 8078 public boolean isHovered() { 8079 return (mPrivateFlags & PFLAG_HOVERED) != 0; 8080 } 8081 8082 /** 8083 * Sets whether the view is currently hovered. 8084 * <p> 8085 * Calling this method also changes the drawable state of the view. This 8086 * enables the view to react to hover by using different drawable resources 8087 * to change its appearance. 8088 * </p><p> 8089 * The {@link #onHoverChanged} method is called when the hovered state changes. 8090 * </p> 8091 * 8092 * @param hovered True if the view is hovered. 8093 * 8094 * @see #isHovered 8095 * @see #onHoverChanged 8096 */ 8097 public void setHovered(boolean hovered) { 8098 if (hovered) { 8099 if ((mPrivateFlags & PFLAG_HOVERED) == 0) { 8100 mPrivateFlags |= PFLAG_HOVERED; 8101 refreshDrawableState(); 8102 onHoverChanged(true); 8103 } 8104 } else { 8105 if ((mPrivateFlags & PFLAG_HOVERED) != 0) { 8106 mPrivateFlags &= ~PFLAG_HOVERED; 8107 refreshDrawableState(); 8108 onHoverChanged(false); 8109 } 8110 } 8111 } 8112 8113 /** 8114 * Implement this method to handle hover state changes. 8115 * <p> 8116 * This method is called whenever the hover state changes as a result of a 8117 * call to {@link #setHovered}. 8118 * </p> 8119 * 8120 * @param hovered The current hover state, as returned by {@link #isHovered}. 8121 * 8122 * @see #isHovered 8123 * @see #setHovered 8124 */ 8125 public void onHoverChanged(boolean hovered) { 8126 } 8127 8128 /** 8129 * Implement this method to handle touch screen motion events. 8130 * 8131 * @param event The motion event. 8132 * @return True if the event was handled, false otherwise. 8133 */ 8134 public boolean onTouchEvent(MotionEvent event) { 8135 final int viewFlags = mViewFlags; 8136 8137 if ((viewFlags & ENABLED_MASK) == DISABLED) { 8138 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) { 8139 setPressed(false); 8140 } 8141 // A disabled view that is clickable still consumes the touch 8142 // events, it just doesn't respond to them. 8143 return (((viewFlags & CLICKABLE) == CLICKABLE || 8144 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 8145 } 8146 8147 if (mTouchDelegate != null) { 8148 if (mTouchDelegate.onTouchEvent(event)) { 8149 return true; 8150 } 8151 } 8152 8153 if (((viewFlags & CLICKABLE) == CLICKABLE || 8154 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 8155 switch (event.getAction()) { 8156 case MotionEvent.ACTION_UP: 8157 boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0; 8158 if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) { 8159 // take focus if we don't have it already and we should in 8160 // touch mode. 8161 boolean focusTaken = false; 8162 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 8163 focusTaken = requestFocus(); 8164 } 8165 8166 if (prepressed) { 8167 // The button is being released before we actually 8168 // showed it as pressed. Make it show the pressed 8169 // state now (before scheduling the click) to ensure 8170 // the user sees it. 8171 setPressed(true); 8172 } 8173 8174 if (!mHasPerformedLongPress) { 8175 // This is a tap, so remove the longpress check 8176 removeLongPressCallback(); 8177 8178 // Only perform take click actions if we were in the pressed state 8179 if (!focusTaken) { 8180 // Use a Runnable and post this rather than calling 8181 // performClick directly. This lets other visual state 8182 // of the view update before click actions start. 8183 if (mPerformClick == null) { 8184 mPerformClick = new PerformClick(); 8185 } 8186 if (!post(mPerformClick)) { 8187 performClick(); 8188 } 8189 } 8190 } 8191 8192 if (mUnsetPressedState == null) { 8193 mUnsetPressedState = new UnsetPressedState(); 8194 } 8195 8196 if (prepressed) { 8197 postDelayed(mUnsetPressedState, 8198 ViewConfiguration.getPressedStateDuration()); 8199 } else if (!post(mUnsetPressedState)) { 8200 // If the post failed, unpress right now 8201 mUnsetPressedState.run(); 8202 } 8203 removeTapCallback(); 8204 } 8205 break; 8206 8207 case MotionEvent.ACTION_DOWN: 8208 mHasPerformedLongPress = false; 8209 8210 if (performButtonActionOnTouchDown(event)) { 8211 break; 8212 } 8213 8214 // Walk up the hierarchy to determine if we're inside a scrolling container. 8215 boolean isInScrollingContainer = isInScrollingContainer(); 8216 8217 // For views inside a scrolling container, delay the pressed feedback for 8218 // a short period in case this is a scroll. 8219 if (isInScrollingContainer) { 8220 mPrivateFlags |= PFLAG_PREPRESSED; 8221 if (mPendingCheckForTap == null) { 8222 mPendingCheckForTap = new CheckForTap(); 8223 } 8224 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 8225 } else { 8226 // Not inside a scrolling container, so show the feedback right away 8227 setPressed(true); 8228 checkForLongClick(0); 8229 } 8230 break; 8231 8232 case MotionEvent.ACTION_CANCEL: 8233 setPressed(false); 8234 removeTapCallback(); 8235 break; 8236 8237 case MotionEvent.ACTION_MOVE: 8238 final int x = (int) event.getX(); 8239 final int y = (int) event.getY(); 8240 8241 // Be lenient about moving outside of buttons 8242 if (!pointInView(x, y, mTouchSlop)) { 8243 // Outside button 8244 removeTapCallback(); 8245 if ((mPrivateFlags & PFLAG_PRESSED) != 0) { 8246 // Remove any future long press/tap checks 8247 removeLongPressCallback(); 8248 8249 setPressed(false); 8250 } 8251 } 8252 break; 8253 } 8254 return true; 8255 } 8256 8257 return false; 8258 } 8259 8260 /** 8261 * @hide 8262 */ 8263 public boolean isInScrollingContainer() { 8264 ViewParent p = getParent(); 8265 while (p != null && p instanceof ViewGroup) { 8266 if (((ViewGroup) p).shouldDelayChildPressedState()) { 8267 return true; 8268 } 8269 p = p.getParent(); 8270 } 8271 return false; 8272 } 8273 8274 /** 8275 * Remove the longpress detection timer. 8276 */ 8277 private void removeLongPressCallback() { 8278 if (mPendingCheckForLongPress != null) { 8279 removeCallbacks(mPendingCheckForLongPress); 8280 } 8281 } 8282 8283 /** 8284 * Remove the pending click action 8285 */ 8286 private void removePerformClickCallback() { 8287 if (mPerformClick != null) { 8288 removeCallbacks(mPerformClick); 8289 } 8290 } 8291 8292 /** 8293 * Remove the prepress detection timer. 8294 */ 8295 private void removeUnsetPressCallback() { 8296 if ((mPrivateFlags & PFLAG_PRESSED) != 0 && mUnsetPressedState != null) { 8297 setPressed(false); 8298 removeCallbacks(mUnsetPressedState); 8299 } 8300 } 8301 8302 /** 8303 * Remove the tap detection timer. 8304 */ 8305 private void removeTapCallback() { 8306 if (mPendingCheckForTap != null) { 8307 mPrivateFlags &= ~PFLAG_PREPRESSED; 8308 removeCallbacks(mPendingCheckForTap); 8309 } 8310 } 8311 8312 /** 8313 * Cancels a pending long press. Your subclass can use this if you 8314 * want the context menu to come up if the user presses and holds 8315 * at the same place, but you don't want it to come up if they press 8316 * and then move around enough to cause scrolling. 8317 */ 8318 public void cancelLongPress() { 8319 removeLongPressCallback(); 8320 8321 /* 8322 * The prepressed state handled by the tap callback is a display 8323 * construct, but the tap callback will post a long press callback 8324 * less its own timeout. Remove it here. 8325 */ 8326 removeTapCallback(); 8327 } 8328 8329 /** 8330 * Remove the pending callback for sending a 8331 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 8332 */ 8333 private void removeSendViewScrolledAccessibilityEventCallback() { 8334 if (mSendViewScrolledAccessibilityEvent != null) { 8335 removeCallbacks(mSendViewScrolledAccessibilityEvent); 8336 mSendViewScrolledAccessibilityEvent.mIsPending = false; 8337 } 8338 } 8339 8340 /** 8341 * Sets the TouchDelegate for this View. 8342 */ 8343 public void setTouchDelegate(TouchDelegate delegate) { 8344 mTouchDelegate = delegate; 8345 } 8346 8347 /** 8348 * Gets the TouchDelegate for this View. 8349 */ 8350 public TouchDelegate getTouchDelegate() { 8351 return mTouchDelegate; 8352 } 8353 8354 /** 8355 * Set flags controlling behavior of this view. 8356 * 8357 * @param flags Constant indicating the value which should be set 8358 * @param mask Constant indicating the bit range that should be changed 8359 */ 8360 void setFlags(int flags, int mask) { 8361 int old = mViewFlags; 8362 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 8363 8364 int changed = mViewFlags ^ old; 8365 if (changed == 0) { 8366 return; 8367 } 8368 int privateFlags = mPrivateFlags; 8369 8370 /* Check if the FOCUSABLE bit has changed */ 8371 if (((changed & FOCUSABLE_MASK) != 0) && 8372 ((privateFlags & PFLAG_HAS_BOUNDS) !=0)) { 8373 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 8374 && ((privateFlags & PFLAG_FOCUSED) != 0)) { 8375 /* Give up focus if we are no longer focusable */ 8376 clearFocus(); 8377 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 8378 && ((privateFlags & PFLAG_FOCUSED) == 0)) { 8379 /* 8380 * Tell the view system that we are now available to take focus 8381 * if no one else already has it. 8382 */ 8383 if (mParent != null) mParent.focusableViewAvailable(this); 8384 } 8385 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 8386 notifyAccessibilityStateChanged(); 8387 } 8388 } 8389 8390 if ((flags & VISIBILITY_MASK) == VISIBLE) { 8391 if ((changed & VISIBILITY_MASK) != 0) { 8392 /* 8393 * If this view is becoming visible, invalidate it in case it changed while 8394 * it was not visible. Marking it drawn ensures that the invalidation will 8395 * go through. 8396 */ 8397 mPrivateFlags |= PFLAG_DRAWN; 8398 invalidate(true); 8399 8400 needGlobalAttributesUpdate(true); 8401 8402 // a view becoming visible is worth notifying the parent 8403 // about in case nothing has focus. even if this specific view 8404 // isn't focusable, it may contain something that is, so let 8405 // the root view try to give this focus if nothing else does. 8406 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 8407 mParent.focusableViewAvailable(this); 8408 } 8409 } 8410 } 8411 8412 /* Check if the GONE bit has changed */ 8413 if ((changed & GONE) != 0) { 8414 needGlobalAttributesUpdate(false); 8415 requestLayout(); 8416 8417 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 8418 if (hasFocus()) clearFocus(); 8419 clearAccessibilityFocus(); 8420 destroyDrawingCache(); 8421 if (mParent instanceof View) { 8422 // GONE views noop invalidation, so invalidate the parent 8423 ((View) mParent).invalidate(true); 8424 } 8425 // Mark the view drawn to ensure that it gets invalidated properly the next 8426 // time it is visible and gets invalidated 8427 mPrivateFlags |= PFLAG_DRAWN; 8428 } 8429 if (mAttachInfo != null) { 8430 mAttachInfo.mViewVisibilityChanged = true; 8431 } 8432 } 8433 8434 /* Check if the VISIBLE bit has changed */ 8435 if ((changed & INVISIBLE) != 0) { 8436 needGlobalAttributesUpdate(false); 8437 /* 8438 * If this view is becoming invisible, set the DRAWN flag so that 8439 * the next invalidate() will not be skipped. 8440 */ 8441 mPrivateFlags |= PFLAG_DRAWN; 8442 8443 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) { 8444 // root view becoming invisible shouldn't clear focus and accessibility focus 8445 if (getRootView() != this) { 8446 clearFocus(); 8447 clearAccessibilityFocus(); 8448 } 8449 } 8450 if (mAttachInfo != null) { 8451 mAttachInfo.mViewVisibilityChanged = true; 8452 } 8453 } 8454 8455 if ((changed & VISIBILITY_MASK) != 0) { 8456 if (mParent instanceof ViewGroup) { 8457 ((ViewGroup) mParent).onChildVisibilityChanged(this, 8458 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK)); 8459 ((View) mParent).invalidate(true); 8460 } else if (mParent != null) { 8461 mParent.invalidateChild(this, null); 8462 } 8463 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK)); 8464 } 8465 8466 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 8467 destroyDrawingCache(); 8468 } 8469 8470 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 8471 destroyDrawingCache(); 8472 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 8473 invalidateParentCaches(); 8474 } 8475 8476 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 8477 destroyDrawingCache(); 8478 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 8479 } 8480 8481 if ((changed & DRAW_MASK) != 0) { 8482 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 8483 if (mBackground != null) { 8484 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 8485 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 8486 } else { 8487 mPrivateFlags |= PFLAG_SKIP_DRAW; 8488 } 8489 } else { 8490 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 8491 } 8492 requestLayout(); 8493 invalidate(true); 8494 } 8495 8496 if ((changed & KEEP_SCREEN_ON) != 0) { 8497 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 8498 mParent.recomputeViewAttributes(this); 8499 } 8500 } 8501 8502 if (AccessibilityManager.getInstance(mContext).isEnabled() 8503 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0 8504 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) { 8505 notifyAccessibilityStateChanged(); 8506 } 8507 } 8508 8509 /** 8510 * Change the view's z order in the tree, so it's on top of other sibling 8511 * views 8512 */ 8513 public void bringToFront() { 8514 if (mParent != null) { 8515 mParent.bringChildToFront(this); 8516 } 8517 } 8518 8519 /** 8520 * This is called in response to an internal scroll in this view (i.e., the 8521 * view scrolled its own contents). This is typically as a result of 8522 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 8523 * called. 8524 * 8525 * @param l Current horizontal scroll origin. 8526 * @param t Current vertical scroll origin. 8527 * @param oldl Previous horizontal scroll origin. 8528 * @param oldt Previous vertical scroll origin. 8529 */ 8530 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 8531 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 8532 postSendViewScrolledAccessibilityEventCallback(); 8533 } 8534 8535 mBackgroundSizeChanged = true; 8536 8537 final AttachInfo ai = mAttachInfo; 8538 if (ai != null) { 8539 ai.mViewScrollChanged = true; 8540 } 8541 } 8542 8543 /** 8544 * Interface definition for a callback to be invoked when the layout bounds of a view 8545 * changes due to layout processing. 8546 */ 8547 public interface OnLayoutChangeListener { 8548 /** 8549 * Called when the focus state of a view has changed. 8550 * 8551 * @param v The view whose state has changed. 8552 * @param left The new value of the view's left property. 8553 * @param top The new value of the view's top property. 8554 * @param right The new value of the view's right property. 8555 * @param bottom The new value of the view's bottom property. 8556 * @param oldLeft The previous value of the view's left property. 8557 * @param oldTop The previous value of the view's top property. 8558 * @param oldRight The previous value of the view's right property. 8559 * @param oldBottom The previous value of the view's bottom property. 8560 */ 8561 void onLayoutChange(View v, int left, int top, int right, int bottom, 8562 int oldLeft, int oldTop, int oldRight, int oldBottom); 8563 } 8564 8565 /** 8566 * This is called during layout when the size of this view has changed. If 8567 * you were just added to the view hierarchy, you're called with the old 8568 * values of 0. 8569 * 8570 * @param w Current width of this view. 8571 * @param h Current height of this view. 8572 * @param oldw Old width of this view. 8573 * @param oldh Old height of this view. 8574 */ 8575 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 8576 } 8577 8578 /** 8579 * Called by draw to draw the child views. This may be overridden 8580 * by derived classes to gain control just before its children are drawn 8581 * (but after its own view has been drawn). 8582 * @param canvas the canvas on which to draw the view 8583 */ 8584 protected void dispatchDraw(Canvas canvas) { 8585 8586 } 8587 8588 /** 8589 * Gets the parent of this view. Note that the parent is a 8590 * ViewParent and not necessarily a View. 8591 * 8592 * @return Parent of this view. 8593 */ 8594 public final ViewParent getParent() { 8595 return mParent; 8596 } 8597 8598 /** 8599 * Set the horizontal scrolled position of your view. This will cause a call to 8600 * {@link #onScrollChanged(int, int, int, int)} and the view will be 8601 * invalidated. 8602 * @param value the x position to scroll to 8603 */ 8604 public void setScrollX(int value) { 8605 scrollTo(value, mScrollY); 8606 } 8607 8608 /** 8609 * Set the vertical scrolled position of your view. This will cause a call to 8610 * {@link #onScrollChanged(int, int, int, int)} and the view will be 8611 * invalidated. 8612 * @param value the y position to scroll to 8613 */ 8614 public void setScrollY(int value) { 8615 scrollTo(mScrollX, value); 8616 } 8617 8618 /** 8619 * Return the scrolled left position of this view. This is the left edge of 8620 * the displayed part of your view. You do not need to draw any pixels 8621 * farther left, since those are outside of the frame of your view on 8622 * screen. 8623 * 8624 * @return The left edge of the displayed part of your view, in pixels. 8625 */ 8626 public final int getScrollX() { 8627 return mScrollX; 8628 } 8629 8630 /** 8631 * Return the scrolled top position of this view. This is the top edge of 8632 * the displayed part of your view. You do not need to draw any pixels above 8633 * it, since those are outside of the frame of your view on screen. 8634 * 8635 * @return The top edge of the displayed part of your view, in pixels. 8636 */ 8637 public final int getScrollY() { 8638 return mScrollY; 8639 } 8640 8641 /** 8642 * Return the width of the your view. 8643 * 8644 * @return The width of your view, in pixels. 8645 */ 8646 @ViewDebug.ExportedProperty(category = "layout") 8647 public final int getWidth() { 8648 return mRight - mLeft; 8649 } 8650 8651 /** 8652 * Return the height of your view. 8653 * 8654 * @return The height of your view, in pixels. 8655 */ 8656 @ViewDebug.ExportedProperty(category = "layout") 8657 public final int getHeight() { 8658 return mBottom - mTop; 8659 } 8660 8661 /** 8662 * Return the visible drawing bounds of your view. Fills in the output 8663 * rectangle with the values from getScrollX(), getScrollY(), 8664 * getWidth(), and getHeight(). 8665 * 8666 * @param outRect The (scrolled) drawing bounds of the view. 8667 */ 8668 public void getDrawingRect(Rect outRect) { 8669 outRect.left = mScrollX; 8670 outRect.top = mScrollY; 8671 outRect.right = mScrollX + (mRight - mLeft); 8672 outRect.bottom = mScrollY + (mBottom - mTop); 8673 } 8674 8675 /** 8676 * Like {@link #getMeasuredWidthAndState()}, but only returns the 8677 * raw width component (that is the result is masked by 8678 * {@link #MEASURED_SIZE_MASK}). 8679 * 8680 * @return The raw measured width of this view. 8681 */ 8682 public final int getMeasuredWidth() { 8683 return mMeasuredWidth & MEASURED_SIZE_MASK; 8684 } 8685 8686 /** 8687 * Return the full width measurement information for this view as computed 8688 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 8689 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 8690 * This should be used during measurement and layout calculations only. Use 8691 * {@link #getWidth()} to see how wide a view is after layout. 8692 * 8693 * @return The measured width of this view as a bit mask. 8694 */ 8695 public final int getMeasuredWidthAndState() { 8696 return mMeasuredWidth; 8697 } 8698 8699 /** 8700 * Like {@link #getMeasuredHeightAndState()}, but only returns the 8701 * raw width component (that is the result is masked by 8702 * {@link #MEASURED_SIZE_MASK}). 8703 * 8704 * @return The raw measured height of this view. 8705 */ 8706 public final int getMeasuredHeight() { 8707 return mMeasuredHeight & MEASURED_SIZE_MASK; 8708 } 8709 8710 /** 8711 * Return the full height measurement information for this view as computed 8712 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 8713 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 8714 * This should be used during measurement and layout calculations only. Use 8715 * {@link #getHeight()} to see how wide a view is after layout. 8716 * 8717 * @return The measured width of this view as a bit mask. 8718 */ 8719 public final int getMeasuredHeightAndState() { 8720 return mMeasuredHeight; 8721 } 8722 8723 /** 8724 * Return only the state bits of {@link #getMeasuredWidthAndState()} 8725 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 8726 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 8727 * and the height component is at the shifted bits 8728 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 8729 */ 8730 public final int getMeasuredState() { 8731 return (mMeasuredWidth&MEASURED_STATE_MASK) 8732 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 8733 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 8734 } 8735 8736 /** 8737 * The transform matrix of this view, which is calculated based on the current 8738 * roation, scale, and pivot properties. 8739 * 8740 * @see #getRotation() 8741 * @see #getScaleX() 8742 * @see #getScaleY() 8743 * @see #getPivotX() 8744 * @see #getPivotY() 8745 * @return The current transform matrix for the view 8746 */ 8747 public Matrix getMatrix() { 8748 if (mTransformationInfo != null) { 8749 updateMatrix(); 8750 return mTransformationInfo.mMatrix; 8751 } 8752 return Matrix.IDENTITY_MATRIX; 8753 } 8754 8755 /** 8756 * Utility function to determine if the value is far enough away from zero to be 8757 * considered non-zero. 8758 * @param value A floating point value to check for zero-ness 8759 * @return whether the passed-in value is far enough away from zero to be considered non-zero 8760 */ 8761 private static boolean nonzero(float value) { 8762 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON); 8763 } 8764 8765 /** 8766 * Returns true if the transform matrix is the identity matrix. 8767 * Recomputes the matrix if necessary. 8768 * 8769 * @return True if the transform matrix is the identity matrix, false otherwise. 8770 */ 8771 final boolean hasIdentityMatrix() { 8772 if (mTransformationInfo != null) { 8773 updateMatrix(); 8774 return mTransformationInfo.mMatrixIsIdentity; 8775 } 8776 return true; 8777 } 8778 8779 void ensureTransformationInfo() { 8780 if (mTransformationInfo == null) { 8781 mTransformationInfo = new TransformationInfo(); 8782 } 8783 } 8784 8785 /** 8786 * Recomputes the transform matrix if necessary. 8787 */ 8788 private void updateMatrix() { 8789 final TransformationInfo info = mTransformationInfo; 8790 if (info == null) { 8791 return; 8792 } 8793 if (info.mMatrixDirty) { 8794 // transform-related properties have changed since the last time someone 8795 // asked for the matrix; recalculate it with the current values 8796 8797 // Figure out if we need to update the pivot point 8798 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) { 8799 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) { 8800 info.mPrevWidth = mRight - mLeft; 8801 info.mPrevHeight = mBottom - mTop; 8802 info.mPivotX = info.mPrevWidth / 2f; 8803 info.mPivotY = info.mPrevHeight / 2f; 8804 } 8805 } 8806 info.mMatrix.reset(); 8807 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) { 8808 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY); 8809 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY); 8810 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY); 8811 } else { 8812 if (info.mCamera == null) { 8813 info.mCamera = new Camera(); 8814 info.matrix3D = new Matrix(); 8815 } 8816 info.mCamera.save(); 8817 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY); 8818 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation); 8819 info.mCamera.getMatrix(info.matrix3D); 8820 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY); 8821 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX, 8822 info.mPivotY + info.mTranslationY); 8823 info.mMatrix.postConcat(info.matrix3D); 8824 info.mCamera.restore(); 8825 } 8826 info.mMatrixDirty = false; 8827 info.mMatrixIsIdentity = info.mMatrix.isIdentity(); 8828 info.mInverseMatrixDirty = true; 8829 } 8830 } 8831 8832 /** 8833 * Utility method to retrieve the inverse of the current mMatrix property. 8834 * We cache the matrix to avoid recalculating it when transform properties 8835 * have not changed. 8836 * 8837 * @return The inverse of the current matrix of this view. 8838 */ 8839 final Matrix getInverseMatrix() { 8840 final TransformationInfo info = mTransformationInfo; 8841 if (info != null) { 8842 updateMatrix(); 8843 if (info.mInverseMatrixDirty) { 8844 if (info.mInverseMatrix == null) { 8845 info.mInverseMatrix = new Matrix(); 8846 } 8847 info.mMatrix.invert(info.mInverseMatrix); 8848 info.mInverseMatrixDirty = false; 8849 } 8850 return info.mInverseMatrix; 8851 } 8852 return Matrix.IDENTITY_MATRIX; 8853 } 8854 8855 /** 8856 * Gets the distance along the Z axis from the camera to this view. 8857 * 8858 * @see #setCameraDistance(float) 8859 * 8860 * @return The distance along the Z axis. 8861 */ 8862 public float getCameraDistance() { 8863 ensureTransformationInfo(); 8864 final float dpi = mResources.getDisplayMetrics().densityDpi; 8865 final TransformationInfo info = mTransformationInfo; 8866 if (info.mCamera == null) { 8867 info.mCamera = new Camera(); 8868 info.matrix3D = new Matrix(); 8869 } 8870 return -(info.mCamera.getLocationZ() * dpi); 8871 } 8872 8873 /** 8874 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 8875 * views are drawn) from the camera to this view. The camera's distance 8876 * affects 3D transformations, for instance rotations around the X and Y 8877 * axis. If the rotationX or rotationY properties are changed and this view is 8878 * large (more than half the size of the screen), it is recommended to always 8879 * use a camera distance that's greater than the height (X axis rotation) or 8880 * the width (Y axis rotation) of this view.</p> 8881 * 8882 * <p>The distance of the camera from the view plane can have an affect on the 8883 * perspective distortion of the view when it is rotated around the x or y axis. 8884 * For example, a large distance will result in a large viewing angle, and there 8885 * will not be much perspective distortion of the view as it rotates. A short 8886 * distance may cause much more perspective distortion upon rotation, and can 8887 * also result in some drawing artifacts if the rotated view ends up partially 8888 * behind the camera (which is why the recommendation is to use a distance at 8889 * least as far as the size of the view, if the view is to be rotated.)</p> 8890 * 8891 * <p>The distance is expressed in "depth pixels." The default distance depends 8892 * on the screen density. For instance, on a medium density display, the 8893 * default distance is 1280. On a high density display, the default distance 8894 * is 1920.</p> 8895 * 8896 * <p>If you want to specify a distance that leads to visually consistent 8897 * results across various densities, use the following formula:</p> 8898 * <pre> 8899 * float scale = context.getResources().getDisplayMetrics().density; 8900 * view.setCameraDistance(distance * scale); 8901 * </pre> 8902 * 8903 * <p>The density scale factor of a high density display is 1.5, 8904 * and 1920 = 1280 * 1.5.</p> 8905 * 8906 * @param distance The distance in "depth pixels", if negative the opposite 8907 * value is used 8908 * 8909 * @see #setRotationX(float) 8910 * @see #setRotationY(float) 8911 */ 8912 public void setCameraDistance(float distance) { 8913 invalidateViewProperty(true, false); 8914 8915 ensureTransformationInfo(); 8916 final float dpi = mResources.getDisplayMetrics().densityDpi; 8917 final TransformationInfo info = mTransformationInfo; 8918 if (info.mCamera == null) { 8919 info.mCamera = new Camera(); 8920 info.matrix3D = new Matrix(); 8921 } 8922 8923 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi); 8924 info.mMatrixDirty = true; 8925 8926 invalidateViewProperty(false, false); 8927 if (mDisplayList != null) { 8928 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi); 8929 } 8930 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 8931 // View was rejected last time it was drawn by its parent; this may have changed 8932 invalidateParentIfNeeded(); 8933 } 8934 } 8935 8936 /** 8937 * The degrees that the view is rotated around the pivot point. 8938 * 8939 * @see #setRotation(float) 8940 * @see #getPivotX() 8941 * @see #getPivotY() 8942 * 8943 * @return The degrees of rotation. 8944 */ 8945 @ViewDebug.ExportedProperty(category = "drawing") 8946 public float getRotation() { 8947 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0; 8948 } 8949 8950 /** 8951 * Sets the degrees that the view is rotated around the pivot point. Increasing values 8952 * result in clockwise rotation. 8953 * 8954 * @param rotation The degrees of rotation. 8955 * 8956 * @see #getRotation() 8957 * @see #getPivotX() 8958 * @see #getPivotY() 8959 * @see #setRotationX(float) 8960 * @see #setRotationY(float) 8961 * 8962 * @attr ref android.R.styleable#View_rotation 8963 */ 8964 public void setRotation(float rotation) { 8965 ensureTransformationInfo(); 8966 final TransformationInfo info = mTransformationInfo; 8967 if (info.mRotation != rotation) { 8968 // Double-invalidation is necessary to capture view's old and new areas 8969 invalidateViewProperty(true, false); 8970 info.mRotation = rotation; 8971 info.mMatrixDirty = true; 8972 invalidateViewProperty(false, true); 8973 if (mDisplayList != null) { 8974 mDisplayList.setRotation(rotation); 8975 } 8976 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 8977 // View was rejected last time it was drawn by its parent; this may have changed 8978 invalidateParentIfNeeded(); 8979 } 8980 } 8981 } 8982 8983 /** 8984 * The degrees that the view is rotated around the vertical axis through the pivot point. 8985 * 8986 * @see #getPivotX() 8987 * @see #getPivotY() 8988 * @see #setRotationY(float) 8989 * 8990 * @return The degrees of Y rotation. 8991 */ 8992 @ViewDebug.ExportedProperty(category = "drawing") 8993 public float getRotationY() { 8994 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0; 8995 } 8996 8997 /** 8998 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 8999 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 9000 * down the y axis. 9001 * 9002 * When rotating large views, it is recommended to adjust the camera distance 9003 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 9004 * 9005 * @param rotationY The degrees of Y rotation. 9006 * 9007 * @see #getRotationY() 9008 * @see #getPivotX() 9009 * @see #getPivotY() 9010 * @see #setRotation(float) 9011 * @see #setRotationX(float) 9012 * @see #setCameraDistance(float) 9013 * 9014 * @attr ref android.R.styleable#View_rotationY 9015 */ 9016 public void setRotationY(float rotationY) { 9017 ensureTransformationInfo(); 9018 final TransformationInfo info = mTransformationInfo; 9019 if (info.mRotationY != rotationY) { 9020 invalidateViewProperty(true, false); 9021 info.mRotationY = rotationY; 9022 info.mMatrixDirty = true; 9023 invalidateViewProperty(false, true); 9024 if (mDisplayList != null) { 9025 mDisplayList.setRotationY(rotationY); 9026 } 9027 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9028 // View was rejected last time it was drawn by its parent; this may have changed 9029 invalidateParentIfNeeded(); 9030 } 9031 } 9032 } 9033 9034 /** 9035 * The degrees that the view is rotated around the horizontal axis through the pivot point. 9036 * 9037 * @see #getPivotX() 9038 * @see #getPivotY() 9039 * @see #setRotationX(float) 9040 * 9041 * @return The degrees of X rotation. 9042 */ 9043 @ViewDebug.ExportedProperty(category = "drawing") 9044 public float getRotationX() { 9045 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0; 9046 } 9047 9048 /** 9049 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 9050 * Increasing values result in clockwise rotation from the viewpoint of looking down the 9051 * x axis. 9052 * 9053 * When rotating large views, it is recommended to adjust the camera distance 9054 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 9055 * 9056 * @param rotationX The degrees of X rotation. 9057 * 9058 * @see #getRotationX() 9059 * @see #getPivotX() 9060 * @see #getPivotY() 9061 * @see #setRotation(float) 9062 * @see #setRotationY(float) 9063 * @see #setCameraDistance(float) 9064 * 9065 * @attr ref android.R.styleable#View_rotationX 9066 */ 9067 public void setRotationX(float rotationX) { 9068 ensureTransformationInfo(); 9069 final TransformationInfo info = mTransformationInfo; 9070 if (info.mRotationX != rotationX) { 9071 invalidateViewProperty(true, false); 9072 info.mRotationX = rotationX; 9073 info.mMatrixDirty = true; 9074 invalidateViewProperty(false, true); 9075 if (mDisplayList != null) { 9076 mDisplayList.setRotationX(rotationX); 9077 } 9078 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9079 // View was rejected last time it was drawn by its parent; this may have changed 9080 invalidateParentIfNeeded(); 9081 } 9082 } 9083 } 9084 9085 /** 9086 * The amount that the view is scaled in x around the pivot point, as a proportion of 9087 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 9088 * 9089 * <p>By default, this is 1.0f. 9090 * 9091 * @see #getPivotX() 9092 * @see #getPivotY() 9093 * @return The scaling factor. 9094 */ 9095 @ViewDebug.ExportedProperty(category = "drawing") 9096 public float getScaleX() { 9097 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1; 9098 } 9099 9100 /** 9101 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 9102 * the view's unscaled width. A value of 1 means that no scaling is applied. 9103 * 9104 * @param scaleX The scaling factor. 9105 * @see #getPivotX() 9106 * @see #getPivotY() 9107 * 9108 * @attr ref android.R.styleable#View_scaleX 9109 */ 9110 public void setScaleX(float scaleX) { 9111 ensureTransformationInfo(); 9112 final TransformationInfo info = mTransformationInfo; 9113 if (info.mScaleX != scaleX) { 9114 invalidateViewProperty(true, false); 9115 info.mScaleX = scaleX; 9116 info.mMatrixDirty = true; 9117 invalidateViewProperty(false, true); 9118 if (mDisplayList != null) { 9119 mDisplayList.setScaleX(scaleX); 9120 } 9121 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9122 // View was rejected last time it was drawn by its parent; this may have changed 9123 invalidateParentIfNeeded(); 9124 } 9125 } 9126 } 9127 9128 /** 9129 * The amount that the view is scaled in y around the pivot point, as a proportion of 9130 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 9131 * 9132 * <p>By default, this is 1.0f. 9133 * 9134 * @see #getPivotX() 9135 * @see #getPivotY() 9136 * @return The scaling factor. 9137 */ 9138 @ViewDebug.ExportedProperty(category = "drawing") 9139 public float getScaleY() { 9140 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1; 9141 } 9142 9143 /** 9144 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 9145 * the view's unscaled width. A value of 1 means that no scaling is applied. 9146 * 9147 * @param scaleY The scaling factor. 9148 * @see #getPivotX() 9149 * @see #getPivotY() 9150 * 9151 * @attr ref android.R.styleable#View_scaleY 9152 */ 9153 public void setScaleY(float scaleY) { 9154 ensureTransformationInfo(); 9155 final TransformationInfo info = mTransformationInfo; 9156 if (info.mScaleY != scaleY) { 9157 invalidateViewProperty(true, false); 9158 info.mScaleY = scaleY; 9159 info.mMatrixDirty = true; 9160 invalidateViewProperty(false, true); 9161 if (mDisplayList != null) { 9162 mDisplayList.setScaleY(scaleY); 9163 } 9164 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9165 // View was rejected last time it was drawn by its parent; this may have changed 9166 invalidateParentIfNeeded(); 9167 } 9168 } 9169 } 9170 9171 /** 9172 * The x location of the point around which the view is {@link #setRotation(float) rotated} 9173 * and {@link #setScaleX(float) scaled}. 9174 * 9175 * @see #getRotation() 9176 * @see #getScaleX() 9177 * @see #getScaleY() 9178 * @see #getPivotY() 9179 * @return The x location of the pivot point. 9180 * 9181 * @attr ref android.R.styleable#View_transformPivotX 9182 */ 9183 @ViewDebug.ExportedProperty(category = "drawing") 9184 public float getPivotX() { 9185 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0; 9186 } 9187 9188 /** 9189 * Sets the x location of the point around which the view is 9190 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 9191 * By default, the pivot point is centered on the object. 9192 * Setting this property disables this behavior and causes the view to use only the 9193 * explicitly set pivotX and pivotY values. 9194 * 9195 * @param pivotX The x location of the pivot point. 9196 * @see #getRotation() 9197 * @see #getScaleX() 9198 * @see #getScaleY() 9199 * @see #getPivotY() 9200 * 9201 * @attr ref android.R.styleable#View_transformPivotX 9202 */ 9203 public void setPivotX(float pivotX) { 9204 ensureTransformationInfo(); 9205 mPrivateFlags |= PFLAG_PIVOT_EXPLICITLY_SET; 9206 final TransformationInfo info = mTransformationInfo; 9207 if (info.mPivotX != pivotX) { 9208 invalidateViewProperty(true, false); 9209 info.mPivotX = pivotX; 9210 info.mMatrixDirty = true; 9211 invalidateViewProperty(false, true); 9212 if (mDisplayList != null) { 9213 mDisplayList.setPivotX(pivotX); 9214 } 9215 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9216 // View was rejected last time it was drawn by its parent; this may have changed 9217 invalidateParentIfNeeded(); 9218 } 9219 } 9220 } 9221 9222 /** 9223 * The y location of the point around which the view is {@link #setRotation(float) rotated} 9224 * and {@link #setScaleY(float) scaled}. 9225 * 9226 * @see #getRotation() 9227 * @see #getScaleX() 9228 * @see #getScaleY() 9229 * @see #getPivotY() 9230 * @return The y location of the pivot point. 9231 * 9232 * @attr ref android.R.styleable#View_transformPivotY 9233 */ 9234 @ViewDebug.ExportedProperty(category = "drawing") 9235 public float getPivotY() { 9236 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0; 9237 } 9238 9239 /** 9240 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 9241 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 9242 * Setting this property disables this behavior and causes the view to use only the 9243 * explicitly set pivotX and pivotY values. 9244 * 9245 * @param pivotY The y location of the pivot point. 9246 * @see #getRotation() 9247 * @see #getScaleX() 9248 * @see #getScaleY() 9249 * @see #getPivotY() 9250 * 9251 * @attr ref android.R.styleable#View_transformPivotY 9252 */ 9253 public void setPivotY(float pivotY) { 9254 ensureTransformationInfo(); 9255 mPrivateFlags |= PFLAG_PIVOT_EXPLICITLY_SET; 9256 final TransformationInfo info = mTransformationInfo; 9257 if (info.mPivotY != pivotY) { 9258 invalidateViewProperty(true, false); 9259 info.mPivotY = pivotY; 9260 info.mMatrixDirty = true; 9261 invalidateViewProperty(false, true); 9262 if (mDisplayList != null) { 9263 mDisplayList.setPivotY(pivotY); 9264 } 9265 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9266 // View was rejected last time it was drawn by its parent; this may have changed 9267 invalidateParentIfNeeded(); 9268 } 9269 } 9270 } 9271 9272 /** 9273 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 9274 * completely transparent and 1 means the view is completely opaque. 9275 * 9276 * <p>By default this is 1.0f. 9277 * @return The opacity of the view. 9278 */ 9279 @ViewDebug.ExportedProperty(category = "drawing") 9280 public float getAlpha() { 9281 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 9282 } 9283 9284 /** 9285 * Returns whether this View has content which overlaps. This function, intended to be 9286 * overridden by specific View types, is an optimization when alpha is set on a view. If 9287 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer 9288 * and then composited it into place, which can be expensive. If the view has no overlapping 9289 * rendering, the view can draw each primitive with the appropriate alpha value directly. 9290 * An example of overlapping rendering is a TextView with a background image, such as a 9291 * Button. An example of non-overlapping rendering is a TextView with no background, or 9292 * an ImageView with only the foreground image. The default implementation returns true; 9293 * subclasses should override if they have cases which can be optimized. 9294 * 9295 * @return true if the content in this view might overlap, false otherwise. 9296 */ 9297 public boolean hasOverlappingRendering() { 9298 return true; 9299 } 9300 9301 /** 9302 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 9303 * completely transparent and 1 means the view is completely opaque.</p> 9304 * 9305 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 9306 * responsible for applying the opacity itself. Otherwise, calling this method is 9307 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and 9308 * setting a hardware layer.</p> 9309 * 9310 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have 9311 * performance implications. It is generally best to use the alpha property sparingly and 9312 * transiently, as in the case of fading animations.</p> 9313 * 9314 * @param alpha The opacity of the view. 9315 * 9316 * @see #setLayerType(int, android.graphics.Paint) 9317 * 9318 * @attr ref android.R.styleable#View_alpha 9319 */ 9320 public void setAlpha(float alpha) { 9321 ensureTransformationInfo(); 9322 if (mTransformationInfo.mAlpha != alpha) { 9323 mTransformationInfo.mAlpha = alpha; 9324 if (onSetAlpha((int) (alpha * 255))) { 9325 mPrivateFlags |= PFLAG_ALPHA_SET; 9326 // subclass is handling alpha - don't optimize rendering cache invalidation 9327 invalidateParentCaches(); 9328 invalidate(true); 9329 } else { 9330 mPrivateFlags &= ~PFLAG_ALPHA_SET; 9331 invalidateViewProperty(true, false); 9332 if (mDisplayList != null) { 9333 mDisplayList.setAlpha(alpha); 9334 } 9335 } 9336 } 9337 } 9338 9339 /** 9340 * Faster version of setAlpha() which performs the same steps except there are 9341 * no calls to invalidate(). The caller of this function should perform proper invalidation 9342 * on the parent and this object. The return value indicates whether the subclass handles 9343 * alpha (the return value for onSetAlpha()). 9344 * 9345 * @param alpha The new value for the alpha property 9346 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 9347 * the new value for the alpha property is different from the old value 9348 */ 9349 boolean setAlphaNoInvalidation(float alpha) { 9350 ensureTransformationInfo(); 9351 if (mTransformationInfo.mAlpha != alpha) { 9352 mTransformationInfo.mAlpha = alpha; 9353 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 9354 if (subclassHandlesAlpha) { 9355 mPrivateFlags |= PFLAG_ALPHA_SET; 9356 return true; 9357 } else { 9358 mPrivateFlags &= ~PFLAG_ALPHA_SET; 9359 if (mDisplayList != null) { 9360 mDisplayList.setAlpha(alpha); 9361 } 9362 } 9363 } 9364 return false; 9365 } 9366 9367 /** 9368 * Top position of this view relative to its parent. 9369 * 9370 * @return The top of this view, in pixels. 9371 */ 9372 @ViewDebug.CapturedViewProperty 9373 public final int getTop() { 9374 return mTop; 9375 } 9376 9377 /** 9378 * Sets the top position of this view relative to its parent. This method is meant to be called 9379 * by the layout system and should not generally be called otherwise, because the property 9380 * may be changed at any time by the layout. 9381 * 9382 * @param top The top of this view, in pixels. 9383 */ 9384 public final void setTop(int top) { 9385 if (top != mTop) { 9386 updateMatrix(); 9387 final boolean matrixIsIdentity = mTransformationInfo == null 9388 || mTransformationInfo.mMatrixIsIdentity; 9389 if (matrixIsIdentity) { 9390 if (mAttachInfo != null) { 9391 int minTop; 9392 int yLoc; 9393 if (top < mTop) { 9394 minTop = top; 9395 yLoc = top - mTop; 9396 } else { 9397 minTop = mTop; 9398 yLoc = 0; 9399 } 9400 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 9401 } 9402 } else { 9403 // Double-invalidation is necessary to capture view's old and new areas 9404 invalidate(true); 9405 } 9406 9407 int width = mRight - mLeft; 9408 int oldHeight = mBottom - mTop; 9409 9410 mTop = top; 9411 if (mDisplayList != null) { 9412 mDisplayList.setTop(mTop); 9413 } 9414 9415 onSizeChanged(width, mBottom - mTop, width, oldHeight); 9416 9417 if (!matrixIsIdentity) { 9418 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) { 9419 // A change in dimension means an auto-centered pivot point changes, too 9420 mTransformationInfo.mMatrixDirty = true; 9421 } 9422 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 9423 invalidate(true); 9424 } 9425 mBackgroundSizeChanged = true; 9426 invalidateParentIfNeeded(); 9427 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9428 // View was rejected last time it was drawn by its parent; this may have changed 9429 invalidateParentIfNeeded(); 9430 } 9431 } 9432 } 9433 9434 /** 9435 * Bottom position of this view relative to its parent. 9436 * 9437 * @return The bottom of this view, in pixels. 9438 */ 9439 @ViewDebug.CapturedViewProperty 9440 public final int getBottom() { 9441 return mBottom; 9442 } 9443 9444 /** 9445 * True if this view has changed since the last time being drawn. 9446 * 9447 * @return The dirty state of this view. 9448 */ 9449 public boolean isDirty() { 9450 return (mPrivateFlags & PFLAG_DIRTY_MASK) != 0; 9451 } 9452 9453 /** 9454 * Sets the bottom position of this view relative to its parent. This method is meant to be 9455 * called by the layout system and should not generally be called otherwise, because the 9456 * property may be changed at any time by the layout. 9457 * 9458 * @param bottom The bottom of this view, in pixels. 9459 */ 9460 public final void setBottom(int bottom) { 9461 if (bottom != mBottom) { 9462 updateMatrix(); 9463 final boolean matrixIsIdentity = mTransformationInfo == null 9464 || mTransformationInfo.mMatrixIsIdentity; 9465 if (matrixIsIdentity) { 9466 if (mAttachInfo != null) { 9467 int maxBottom; 9468 if (bottom < mBottom) { 9469 maxBottom = mBottom; 9470 } else { 9471 maxBottom = bottom; 9472 } 9473 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 9474 } 9475 } else { 9476 // Double-invalidation is necessary to capture view's old and new areas 9477 invalidate(true); 9478 } 9479 9480 int width = mRight - mLeft; 9481 int oldHeight = mBottom - mTop; 9482 9483 mBottom = bottom; 9484 if (mDisplayList != null) { 9485 mDisplayList.setBottom(mBottom); 9486 } 9487 9488 onSizeChanged(width, mBottom - mTop, width, oldHeight); 9489 9490 if (!matrixIsIdentity) { 9491 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) { 9492 // A change in dimension means an auto-centered pivot point changes, too 9493 mTransformationInfo.mMatrixDirty = true; 9494 } 9495 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 9496 invalidate(true); 9497 } 9498 mBackgroundSizeChanged = true; 9499 invalidateParentIfNeeded(); 9500 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9501 // View was rejected last time it was drawn by its parent; this may have changed 9502 invalidateParentIfNeeded(); 9503 } 9504 } 9505 } 9506 9507 /** 9508 * Left position of this view relative to its parent. 9509 * 9510 * @return The left edge of this view, in pixels. 9511 */ 9512 @ViewDebug.CapturedViewProperty 9513 public final int getLeft() { 9514 return mLeft; 9515 } 9516 9517 /** 9518 * Sets the left position of this view relative to its parent. This method is meant to be called 9519 * by the layout system and should not generally be called otherwise, because the property 9520 * may be changed at any time by the layout. 9521 * 9522 * @param left The bottom of this view, in pixels. 9523 */ 9524 public final void setLeft(int left) { 9525 if (left != mLeft) { 9526 updateMatrix(); 9527 final boolean matrixIsIdentity = mTransformationInfo == null 9528 || mTransformationInfo.mMatrixIsIdentity; 9529 if (matrixIsIdentity) { 9530 if (mAttachInfo != null) { 9531 int minLeft; 9532 int xLoc; 9533 if (left < mLeft) { 9534 minLeft = left; 9535 xLoc = left - mLeft; 9536 } else { 9537 minLeft = mLeft; 9538 xLoc = 0; 9539 } 9540 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 9541 } 9542 } else { 9543 // Double-invalidation is necessary to capture view's old and new areas 9544 invalidate(true); 9545 } 9546 9547 int oldWidth = mRight - mLeft; 9548 int height = mBottom - mTop; 9549 9550 mLeft = left; 9551 if (mDisplayList != null) { 9552 mDisplayList.setLeft(left); 9553 } 9554 9555 onSizeChanged(mRight - mLeft, height, oldWidth, height); 9556 9557 if (!matrixIsIdentity) { 9558 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) { 9559 // A change in dimension means an auto-centered pivot point changes, too 9560 mTransformationInfo.mMatrixDirty = true; 9561 } 9562 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 9563 invalidate(true); 9564 } 9565 mBackgroundSizeChanged = true; 9566 invalidateParentIfNeeded(); 9567 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9568 // View was rejected last time it was drawn by its parent; this may have changed 9569 invalidateParentIfNeeded(); 9570 } 9571 } 9572 } 9573 9574 /** 9575 * Right position of this view relative to its parent. 9576 * 9577 * @return The right edge of this view, in pixels. 9578 */ 9579 @ViewDebug.CapturedViewProperty 9580 public final int getRight() { 9581 return mRight; 9582 } 9583 9584 /** 9585 * Sets the right position of this view relative to its parent. This method is meant to be called 9586 * by the layout system and should not generally be called otherwise, because the property 9587 * may be changed at any time by the layout. 9588 * 9589 * @param right The bottom of this view, in pixels. 9590 */ 9591 public final void setRight(int right) { 9592 if (right != mRight) { 9593 updateMatrix(); 9594 final boolean matrixIsIdentity = mTransformationInfo == null 9595 || mTransformationInfo.mMatrixIsIdentity; 9596 if (matrixIsIdentity) { 9597 if (mAttachInfo != null) { 9598 int maxRight; 9599 if (right < mRight) { 9600 maxRight = mRight; 9601 } else { 9602 maxRight = right; 9603 } 9604 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 9605 } 9606 } else { 9607 // Double-invalidation is necessary to capture view's old and new areas 9608 invalidate(true); 9609 } 9610 9611 int oldWidth = mRight - mLeft; 9612 int height = mBottom - mTop; 9613 9614 mRight = right; 9615 if (mDisplayList != null) { 9616 mDisplayList.setRight(mRight); 9617 } 9618 9619 onSizeChanged(mRight - mLeft, height, oldWidth, height); 9620 9621 if (!matrixIsIdentity) { 9622 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) { 9623 // A change in dimension means an auto-centered pivot point changes, too 9624 mTransformationInfo.mMatrixDirty = true; 9625 } 9626 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 9627 invalidate(true); 9628 } 9629 mBackgroundSizeChanged = true; 9630 invalidateParentIfNeeded(); 9631 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9632 // View was rejected last time it was drawn by its parent; this may have changed 9633 invalidateParentIfNeeded(); 9634 } 9635 } 9636 } 9637 9638 /** 9639 * The visual x position of this view, in pixels. This is equivalent to the 9640 * {@link #setTranslationX(float) translationX} property plus the current 9641 * {@link #getLeft() left} property. 9642 * 9643 * @return The visual x position of this view, in pixels. 9644 */ 9645 @ViewDebug.ExportedProperty(category = "drawing") 9646 public float getX() { 9647 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0); 9648 } 9649 9650 /** 9651 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 9652 * {@link #setTranslationX(float) translationX} property to be the difference between 9653 * the x value passed in and the current {@link #getLeft() left} property. 9654 * 9655 * @param x The visual x position of this view, in pixels. 9656 */ 9657 public void setX(float x) { 9658 setTranslationX(x - mLeft); 9659 } 9660 9661 /** 9662 * The visual y position of this view, in pixels. This is equivalent to the 9663 * {@link #setTranslationY(float) translationY} property plus the current 9664 * {@link #getTop() top} property. 9665 * 9666 * @return The visual y position of this view, in pixels. 9667 */ 9668 @ViewDebug.ExportedProperty(category = "drawing") 9669 public float getY() { 9670 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0); 9671 } 9672 9673 /** 9674 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 9675 * {@link #setTranslationY(float) translationY} property to be the difference between 9676 * the y value passed in and the current {@link #getTop() top} property. 9677 * 9678 * @param y The visual y position of this view, in pixels. 9679 */ 9680 public void setY(float y) { 9681 setTranslationY(y - mTop); 9682 } 9683 9684 9685 /** 9686 * The horizontal location of this view relative to its {@link #getLeft() left} position. 9687 * This position is post-layout, in addition to wherever the object's 9688 * layout placed it. 9689 * 9690 * @return The horizontal position of this view relative to its left position, in pixels. 9691 */ 9692 @ViewDebug.ExportedProperty(category = "drawing") 9693 public float getTranslationX() { 9694 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0; 9695 } 9696 9697 /** 9698 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 9699 * This effectively positions the object post-layout, in addition to wherever the object's 9700 * layout placed it. 9701 * 9702 * @param translationX The horizontal position of this view relative to its left position, 9703 * in pixels. 9704 * 9705 * @attr ref android.R.styleable#View_translationX 9706 */ 9707 public void setTranslationX(float translationX) { 9708 ensureTransformationInfo(); 9709 final TransformationInfo info = mTransformationInfo; 9710 if (info.mTranslationX != translationX) { 9711 // Double-invalidation is necessary to capture view's old and new areas 9712 invalidateViewProperty(true, false); 9713 info.mTranslationX = translationX; 9714 info.mMatrixDirty = true; 9715 invalidateViewProperty(false, true); 9716 if (mDisplayList != null) { 9717 mDisplayList.setTranslationX(translationX); 9718 } 9719 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9720 // View was rejected last time it was drawn by its parent; this may have changed 9721 invalidateParentIfNeeded(); 9722 } 9723 } 9724 } 9725 9726 /** 9727 * The horizontal location of this view relative to its {@link #getTop() top} position. 9728 * This position is post-layout, in addition to wherever the object's 9729 * layout placed it. 9730 * 9731 * @return The vertical position of this view relative to its top position, 9732 * in pixels. 9733 */ 9734 @ViewDebug.ExportedProperty(category = "drawing") 9735 public float getTranslationY() { 9736 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0; 9737 } 9738 9739 /** 9740 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 9741 * This effectively positions the object post-layout, in addition to wherever the object's 9742 * layout placed it. 9743 * 9744 * @param translationY The vertical position of this view relative to its top position, 9745 * in pixels. 9746 * 9747 * @attr ref android.R.styleable#View_translationY 9748 */ 9749 public void setTranslationY(float translationY) { 9750 ensureTransformationInfo(); 9751 final TransformationInfo info = mTransformationInfo; 9752 if (info.mTranslationY != translationY) { 9753 invalidateViewProperty(true, false); 9754 info.mTranslationY = translationY; 9755 info.mMatrixDirty = true; 9756 invalidateViewProperty(false, true); 9757 if (mDisplayList != null) { 9758 mDisplayList.setTranslationY(translationY); 9759 } 9760 if ((mPrivateFlags2 & PFLAG2_VIEW_QUICK_REJECTED) == PFLAG2_VIEW_QUICK_REJECTED) { 9761 // View was rejected last time it was drawn by its parent; this may have changed 9762 invalidateParentIfNeeded(); 9763 } 9764 } 9765 } 9766 9767 /** 9768 * Hit rectangle in parent's coordinates 9769 * 9770 * @param outRect The hit rectangle of the view. 9771 */ 9772 public void getHitRect(Rect outRect) { 9773 updateMatrix(); 9774 final TransformationInfo info = mTransformationInfo; 9775 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) { 9776 outRect.set(mLeft, mTop, mRight, mBottom); 9777 } else { 9778 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 9779 tmpRect.set(-info.mPivotX, -info.mPivotY, 9780 getWidth() - info.mPivotX, getHeight() - info.mPivotY); 9781 info.mMatrix.mapRect(tmpRect); 9782 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 9783 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 9784 } 9785 } 9786 9787 /** 9788 * Determines whether the given point, in local coordinates is inside the view. 9789 */ 9790 /*package*/ final boolean pointInView(float localX, float localY) { 9791 return localX >= 0 && localX < (mRight - mLeft) 9792 && localY >= 0 && localY < (mBottom - mTop); 9793 } 9794 9795 /** 9796 * Utility method to determine whether the given point, in local coordinates, 9797 * is inside the view, where the area of the view is expanded by the slop factor. 9798 * This method is called while processing touch-move events to determine if the event 9799 * is still within the view. 9800 */ 9801 private boolean pointInView(float localX, float localY, float slop) { 9802 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 9803 localY < ((mBottom - mTop) + slop); 9804 } 9805 9806 /** 9807 * When a view has focus and the user navigates away from it, the next view is searched for 9808 * starting from the rectangle filled in by this method. 9809 * 9810 * By default, the rectangle is the {@link #getDrawingRect(android.graphics.Rect)}) 9811 * of the view. However, if your view maintains some idea of internal selection, 9812 * such as a cursor, or a selected row or column, you should override this method and 9813 * fill in a more specific rectangle. 9814 * 9815 * @param r The rectangle to fill in, in this view's coordinates. 9816 */ 9817 public void getFocusedRect(Rect r) { 9818 getDrawingRect(r); 9819 } 9820 9821 /** 9822 * If some part of this view is not clipped by any of its parents, then 9823 * return that area in r in global (root) coordinates. To convert r to local 9824 * coordinates (without taking possible View rotations into account), offset 9825 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 9826 * If the view is completely clipped or translated out, return false. 9827 * 9828 * @param r If true is returned, r holds the global coordinates of the 9829 * visible portion of this view. 9830 * @param globalOffset If true is returned, globalOffset holds the dx,dy 9831 * between this view and its root. globalOffet may be null. 9832 * @return true if r is non-empty (i.e. part of the view is visible at the 9833 * root level. 9834 */ 9835 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 9836 int width = mRight - mLeft; 9837 int height = mBottom - mTop; 9838 if (width > 0 && height > 0) { 9839 r.set(0, 0, width, height); 9840 if (globalOffset != null) { 9841 globalOffset.set(-mScrollX, -mScrollY); 9842 } 9843 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 9844 } 9845 return false; 9846 } 9847 9848 public final boolean getGlobalVisibleRect(Rect r) { 9849 return getGlobalVisibleRect(r, null); 9850 } 9851 9852 public final boolean getLocalVisibleRect(Rect r) { 9853 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point(); 9854 if (getGlobalVisibleRect(r, offset)) { 9855 r.offset(-offset.x, -offset.y); // make r local 9856 return true; 9857 } 9858 return false; 9859 } 9860 9861 /** 9862 * Offset this view's vertical location by the specified number of pixels. 9863 * 9864 * @param offset the number of pixels to offset the view by 9865 */ 9866 public void offsetTopAndBottom(int offset) { 9867 if (offset != 0) { 9868 updateMatrix(); 9869 final boolean matrixIsIdentity = mTransformationInfo == null 9870 || mTransformationInfo.mMatrixIsIdentity; 9871 if (matrixIsIdentity) { 9872 if (mDisplayList != null) { 9873 invalidateViewProperty(false, false); 9874 } else { 9875 final ViewParent p = mParent; 9876 if (p != null && mAttachInfo != null) { 9877 final Rect r = mAttachInfo.mTmpInvalRect; 9878 int minTop; 9879 int maxBottom; 9880 int yLoc; 9881 if (offset < 0) { 9882 minTop = mTop + offset; 9883 maxBottom = mBottom; 9884 yLoc = offset; 9885 } else { 9886 minTop = mTop; 9887 maxBottom = mBottom + offset; 9888 yLoc = 0; 9889 } 9890 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 9891 p.invalidateChild(this, r); 9892 } 9893 } 9894 } else { 9895 invalidateViewProperty(false, false); 9896 } 9897 9898 mTop += offset; 9899 mBottom += offset; 9900 if (mDisplayList != null) { 9901 mDisplayList.offsetTopBottom(offset); 9902 invalidateViewProperty(false, false); 9903 } else { 9904 if (!matrixIsIdentity) { 9905 invalidateViewProperty(false, true); 9906 } 9907 invalidateParentIfNeeded(); 9908 } 9909 } 9910 } 9911 9912 /** 9913 * Offset this view's horizontal location by the specified amount of pixels. 9914 * 9915 * @param offset the numer of pixels to offset the view by 9916 */ 9917 public void offsetLeftAndRight(int offset) { 9918 if (offset != 0) { 9919 updateMatrix(); 9920 final boolean matrixIsIdentity = mTransformationInfo == null 9921 || mTransformationInfo.mMatrixIsIdentity; 9922 if (matrixIsIdentity) { 9923 if (mDisplayList != null) { 9924 invalidateViewProperty(false, false); 9925 } else { 9926 final ViewParent p = mParent; 9927 if (p != null && mAttachInfo != null) { 9928 final Rect r = mAttachInfo.mTmpInvalRect; 9929 int minLeft; 9930 int maxRight; 9931 if (offset < 0) { 9932 minLeft = mLeft + offset; 9933 maxRight = mRight; 9934 } else { 9935 minLeft = mLeft; 9936 maxRight = mRight + offset; 9937 } 9938 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 9939 p.invalidateChild(this, r); 9940 } 9941 } 9942 } else { 9943 invalidateViewProperty(false, false); 9944 } 9945 9946 mLeft += offset; 9947 mRight += offset; 9948 if (mDisplayList != null) { 9949 mDisplayList.offsetLeftRight(offset); 9950 invalidateViewProperty(false, false); 9951 } else { 9952 if (!matrixIsIdentity) { 9953 invalidateViewProperty(false, true); 9954 } 9955 invalidateParentIfNeeded(); 9956 } 9957 } 9958 } 9959 9960 /** 9961 * Get the LayoutParams associated with this view. All views should have 9962 * layout parameters. These supply parameters to the <i>parent</i> of this 9963 * view specifying how it should be arranged. There are many subclasses of 9964 * ViewGroup.LayoutParams, and these correspond to the different subclasses 9965 * of ViewGroup that are responsible for arranging their children. 9966 * 9967 * This method may return null if this View is not attached to a parent 9968 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 9969 * was not invoked successfully. When a View is attached to a parent 9970 * ViewGroup, this method must not return null. 9971 * 9972 * @return The LayoutParams associated with this view, or null if no 9973 * parameters have been set yet 9974 */ 9975 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 9976 public ViewGroup.LayoutParams getLayoutParams() { 9977 return mLayoutParams; 9978 } 9979 9980 /** 9981 * Set the layout parameters associated with this view. These supply 9982 * parameters to the <i>parent</i> of this view specifying how it should be 9983 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 9984 * correspond to the different subclasses of ViewGroup that are responsible 9985 * for arranging their children. 9986 * 9987 * @param params The layout parameters for this view, cannot be null 9988 */ 9989 public void setLayoutParams(ViewGroup.LayoutParams params) { 9990 if (params == null) { 9991 throw new NullPointerException("Layout parameters cannot be null"); 9992 } 9993 mLayoutParams = params; 9994 resolveLayoutParams(); 9995 if (mParent instanceof ViewGroup) { 9996 ((ViewGroup) mParent).onSetLayoutParams(this, params); 9997 } 9998 requestLayout(); 9999 } 10000 10001 /** 10002 * Resolve the layout parameters depending on the resolved layout direction 10003 */ 10004 private void resolveLayoutParams() { 10005 if (mLayoutParams != null) { 10006 mLayoutParams.resolveLayoutDirection(getLayoutDirection()); 10007 } 10008 } 10009 10010 /** 10011 * Set the scrolled position of your view. This will cause a call to 10012 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10013 * invalidated. 10014 * @param x the x position to scroll to 10015 * @param y the y position to scroll to 10016 */ 10017 public void scrollTo(int x, int y) { 10018 if (mScrollX != x || mScrollY != y) { 10019 int oldX = mScrollX; 10020 int oldY = mScrollY; 10021 mScrollX = x; 10022 mScrollY = y; 10023 invalidateParentCaches(); 10024 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 10025 if (!awakenScrollBars()) { 10026 postInvalidateOnAnimation(); 10027 } 10028 } 10029 } 10030 10031 /** 10032 * Move the scrolled position of your view. This will cause a call to 10033 * {@link #onScrollChanged(int, int, int, int)} and the view will be 10034 * invalidated. 10035 * @param x the amount of pixels to scroll by horizontally 10036 * @param y the amount of pixels to scroll by vertically 10037 */ 10038 public void scrollBy(int x, int y) { 10039 scrollTo(mScrollX + x, mScrollY + y); 10040 } 10041 10042 /** 10043 * <p>Trigger the scrollbars to draw. When invoked this method starts an 10044 * animation to fade the scrollbars out after a default delay. If a subclass 10045 * provides animated scrolling, the start delay should equal the duration 10046 * of the scrolling animation.</p> 10047 * 10048 * <p>The animation starts only if at least one of the scrollbars is 10049 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 10050 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 10051 * this method returns true, and false otherwise. If the animation is 10052 * started, this method calls {@link #invalidate()}; in that case the 10053 * caller should not call {@link #invalidate()}.</p> 10054 * 10055 * <p>This method should be invoked every time a subclass directly updates 10056 * the scroll parameters.</p> 10057 * 10058 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 10059 * and {@link #scrollTo(int, int)}.</p> 10060 * 10061 * @return true if the animation is played, false otherwise 10062 * 10063 * @see #awakenScrollBars(int) 10064 * @see #scrollBy(int, int) 10065 * @see #scrollTo(int, int) 10066 * @see #isHorizontalScrollBarEnabled() 10067 * @see #isVerticalScrollBarEnabled() 10068 * @see #setHorizontalScrollBarEnabled(boolean) 10069 * @see #setVerticalScrollBarEnabled(boolean) 10070 */ 10071 protected boolean awakenScrollBars() { 10072 return mScrollCache != null && 10073 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 10074 } 10075 10076 /** 10077 * Trigger the scrollbars to draw. 10078 * This method differs from awakenScrollBars() only in its default duration. 10079 * initialAwakenScrollBars() will show the scroll bars for longer than 10080 * usual to give the user more of a chance to notice them. 10081 * 10082 * @return true if the animation is played, false otherwise. 10083 */ 10084 private boolean initialAwakenScrollBars() { 10085 return mScrollCache != null && 10086 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 10087 } 10088 10089 /** 10090 * <p> 10091 * Trigger the scrollbars to draw. When invoked this method starts an 10092 * animation to fade the scrollbars out after a fixed delay. If a subclass 10093 * provides animated scrolling, the start delay should equal the duration of 10094 * the scrolling animation. 10095 * </p> 10096 * 10097 * <p> 10098 * The animation starts only if at least one of the scrollbars is enabled, 10099 * as specified by {@link #isHorizontalScrollBarEnabled()} and 10100 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 10101 * this method returns true, and false otherwise. If the animation is 10102 * started, this method calls {@link #invalidate()}; in that case the caller 10103 * should not call {@link #invalidate()}. 10104 * </p> 10105 * 10106 * <p> 10107 * This method should be invoked everytime a subclass directly updates the 10108 * scroll parameters. 10109 * </p> 10110 * 10111 * @param startDelay the delay, in milliseconds, after which the animation 10112 * should start; when the delay is 0, the animation starts 10113 * immediately 10114 * @return true if the animation is played, false otherwise 10115 * 10116 * @see #scrollBy(int, int) 10117 * @see #scrollTo(int, int) 10118 * @see #isHorizontalScrollBarEnabled() 10119 * @see #isVerticalScrollBarEnabled() 10120 * @see #setHorizontalScrollBarEnabled(boolean) 10121 * @see #setVerticalScrollBarEnabled(boolean) 10122 */ 10123 protected boolean awakenScrollBars(int startDelay) { 10124 return awakenScrollBars(startDelay, true); 10125 } 10126 10127 /** 10128 * <p> 10129 * Trigger the scrollbars to draw. When invoked this method starts an 10130 * animation to fade the scrollbars out after a fixed delay. If a subclass 10131 * provides animated scrolling, the start delay should equal the duration of 10132 * the scrolling animation. 10133 * </p> 10134 * 10135 * <p> 10136 * The animation starts only if at least one of the scrollbars is enabled, 10137 * as specified by {@link #isHorizontalScrollBarEnabled()} and 10138 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 10139 * this method returns true, and false otherwise. If the animation is 10140 * started, this method calls {@link #invalidate()} if the invalidate parameter 10141 * is set to true; in that case the caller 10142 * should not call {@link #invalidate()}. 10143 * </p> 10144 * 10145 * <p> 10146 * This method should be invoked everytime a subclass directly updates the 10147 * scroll parameters. 10148 * </p> 10149 * 10150 * @param startDelay the delay, in milliseconds, after which the animation 10151 * should start; when the delay is 0, the animation starts 10152 * immediately 10153 * 10154 * @param invalidate Wheter this method should call invalidate 10155 * 10156 * @return true if the animation is played, false otherwise 10157 * 10158 * @see #scrollBy(int, int) 10159 * @see #scrollTo(int, int) 10160 * @see #isHorizontalScrollBarEnabled() 10161 * @see #isVerticalScrollBarEnabled() 10162 * @see #setHorizontalScrollBarEnabled(boolean) 10163 * @see #setVerticalScrollBarEnabled(boolean) 10164 */ 10165 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 10166 final ScrollabilityCache scrollCache = mScrollCache; 10167 10168 if (scrollCache == null || !scrollCache.fadeScrollBars) { 10169 return false; 10170 } 10171 10172 if (scrollCache.scrollBar == null) { 10173 scrollCache.scrollBar = new ScrollBarDrawable(); 10174 } 10175 10176 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 10177 10178 if (invalidate) { 10179 // Invalidate to show the scrollbars 10180 postInvalidateOnAnimation(); 10181 } 10182 10183 if (scrollCache.state == ScrollabilityCache.OFF) { 10184 // FIXME: this is copied from WindowManagerService. 10185 // We should get this value from the system when it 10186 // is possible to do so. 10187 final int KEY_REPEAT_FIRST_DELAY = 750; 10188 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 10189 } 10190 10191 // Tell mScrollCache when we should start fading. This may 10192 // extend the fade start time if one was already scheduled 10193 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 10194 scrollCache.fadeStartTime = fadeStartTime; 10195 scrollCache.state = ScrollabilityCache.ON; 10196 10197 // Schedule our fader to run, unscheduling any old ones first 10198 if (mAttachInfo != null) { 10199 mAttachInfo.mHandler.removeCallbacks(scrollCache); 10200 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 10201 } 10202 10203 return true; 10204 } 10205 10206 return false; 10207 } 10208 10209 /** 10210 * Do not invalidate views which are not visible and which are not running an animation. They 10211 * will not get drawn and they should not set dirty flags as if they will be drawn 10212 */ 10213 private boolean skipInvalidate() { 10214 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 10215 (!(mParent instanceof ViewGroup) || 10216 !((ViewGroup) mParent).isViewTransitioning(this)); 10217 } 10218 /** 10219 * Mark the area defined by dirty as needing to be drawn. If the view is 10220 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point 10221 * in the future. This must be called from a UI thread. To call from a non-UI 10222 * thread, call {@link #postInvalidate()}. 10223 * 10224 * WARNING: This method is destructive to dirty. 10225 * @param dirty the rectangle representing the bounds of the dirty region 10226 */ 10227 public void invalidate(Rect dirty) { 10228 if (skipInvalidate()) { 10229 return; 10230 } 10231 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) || 10232 (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID || 10233 (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED) { 10234 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 10235 mPrivateFlags |= PFLAG_INVALIDATED; 10236 mPrivateFlags |= PFLAG_DIRTY; 10237 final ViewParent p = mParent; 10238 final AttachInfo ai = mAttachInfo; 10239 //noinspection PointlessBooleanExpression,ConstantConditions 10240 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 10241 if (p != null && ai != null && ai.mHardwareAccelerated) { 10242 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 10243 // with a null dirty rect, which tells the ViewAncestor to redraw everything 10244 p.invalidateChild(this, null); 10245 return; 10246 } 10247 } 10248 if (p != null && ai != null) { 10249 final int scrollX = mScrollX; 10250 final int scrollY = mScrollY; 10251 final Rect r = ai.mTmpInvalRect; 10252 r.set(dirty.left - scrollX, dirty.top - scrollY, 10253 dirty.right - scrollX, dirty.bottom - scrollY); 10254 mParent.invalidateChild(this, r); 10255 } 10256 } 10257 } 10258 10259 /** 10260 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. 10261 * The coordinates of the dirty rect are relative to the view. 10262 * If the view is visible, {@link #onDraw(android.graphics.Canvas)} 10263 * will be called at some point in the future. This must be called from 10264 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}. 10265 * @param l the left position of the dirty region 10266 * @param t the top position of the dirty region 10267 * @param r the right position of the dirty region 10268 * @param b the bottom position of the dirty region 10269 */ 10270 public void invalidate(int l, int t, int r, int b) { 10271 if (skipInvalidate()) { 10272 return; 10273 } 10274 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) || 10275 (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID || 10276 (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED) { 10277 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 10278 mPrivateFlags |= PFLAG_INVALIDATED; 10279 mPrivateFlags |= PFLAG_DIRTY; 10280 final ViewParent p = mParent; 10281 final AttachInfo ai = mAttachInfo; 10282 //noinspection PointlessBooleanExpression,ConstantConditions 10283 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 10284 if (p != null && ai != null && ai.mHardwareAccelerated) { 10285 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 10286 // with a null dirty rect, which tells the ViewAncestor to redraw everything 10287 p.invalidateChild(this, null); 10288 return; 10289 } 10290 } 10291 if (p != null && ai != null && l < r && t < b) { 10292 final int scrollX = mScrollX; 10293 final int scrollY = mScrollY; 10294 final Rect tmpr = ai.mTmpInvalRect; 10295 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY); 10296 p.invalidateChild(this, tmpr); 10297 } 10298 } 10299 } 10300 10301 /** 10302 * Invalidate the whole view. If the view is visible, 10303 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 10304 * the future. This must be called from a UI thread. To call from a non-UI thread, 10305 * call {@link #postInvalidate()}. 10306 */ 10307 public void invalidate() { 10308 invalidate(true); 10309 } 10310 10311 /** 10312 * This is where the invalidate() work actually happens. A full invalidate() 10313 * causes the drawing cache to be invalidated, but this function can be called with 10314 * invalidateCache set to false to skip that invalidation step for cases that do not 10315 * need it (for example, a component that remains at the same dimensions with the same 10316 * content). 10317 * 10318 * @param invalidateCache Whether the drawing cache for this view should be invalidated as 10319 * well. This is usually true for a full invalidate, but may be set to false if the 10320 * View's contents or dimensions have not changed. 10321 */ 10322 void invalidate(boolean invalidateCache) { 10323 if (skipInvalidate()) { 10324 return; 10325 } 10326 if ((mPrivateFlags & (PFLAG_DRAWN | PFLAG_HAS_BOUNDS)) == (PFLAG_DRAWN | PFLAG_HAS_BOUNDS) || 10327 (invalidateCache && (mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == PFLAG_DRAWING_CACHE_VALID) || 10328 (mPrivateFlags & PFLAG_INVALIDATED) != PFLAG_INVALIDATED || isOpaque() != mLastIsOpaque) { 10329 mLastIsOpaque = isOpaque(); 10330 mPrivateFlags &= ~PFLAG_DRAWN; 10331 mPrivateFlags |= PFLAG_DIRTY; 10332 if (invalidateCache) { 10333 mPrivateFlags |= PFLAG_INVALIDATED; 10334 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 10335 } 10336 final AttachInfo ai = mAttachInfo; 10337 final ViewParent p = mParent; 10338 //noinspection PointlessBooleanExpression,ConstantConditions 10339 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 10340 if (p != null && ai != null && ai.mHardwareAccelerated) { 10341 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 10342 // with a null dirty rect, which tells the ViewAncestor to redraw everything 10343 p.invalidateChild(this, null); 10344 return; 10345 } 10346 } 10347 10348 if (p != null && ai != null) { 10349 final Rect r = ai.mTmpInvalRect; 10350 r.set(0, 0, mRight - mLeft, mBottom - mTop); 10351 // Don't call invalidate -- we don't want to internally scroll 10352 // our own bounds 10353 p.invalidateChild(this, r); 10354 } 10355 } 10356 } 10357 10358 /** 10359 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to 10360 * set any flags or handle all of the cases handled by the default invalidation methods. 10361 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate 10362 * dirty rect. This method calls into fast invalidation methods in ViewGroup that 10363 * walk up the hierarchy, transforming the dirty rect as necessary. 10364 * 10365 * The method also handles normal invalidation logic if display list properties are not 10366 * being used in this view. The invalidateParent and forceRedraw flags are used by that 10367 * backup approach, to handle these cases used in the various property-setting methods. 10368 * 10369 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties 10370 * are not being used in this view 10371 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display 10372 * list properties are not being used in this view 10373 */ 10374 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) { 10375 if (mDisplayList == null || (mPrivateFlags & PFLAG_DRAW_ANIMATION) == PFLAG_DRAW_ANIMATION) { 10376 if (invalidateParent) { 10377 invalidateParentCaches(); 10378 } 10379 if (forceRedraw) { 10380 mPrivateFlags |= PFLAG_DRAWN; // force another invalidation with the new orientation 10381 } 10382 invalidate(false); 10383 } else { 10384 final AttachInfo ai = mAttachInfo; 10385 final ViewParent p = mParent; 10386 if (p != null && ai != null) { 10387 final Rect r = ai.mTmpInvalRect; 10388 r.set(0, 0, mRight - mLeft, mBottom - mTop); 10389 if (mParent instanceof ViewGroup) { 10390 ((ViewGroup) mParent).invalidateChildFast(this, r); 10391 } else { 10392 mParent.invalidateChild(this, r); 10393 } 10394 } 10395 } 10396 } 10397 10398 /** 10399 * Utility method to transform a given Rect by the current matrix of this view. 10400 */ 10401 void transformRect(final Rect rect) { 10402 if (!getMatrix().isIdentity()) { 10403 RectF boundingRect = mAttachInfo.mTmpTransformRect; 10404 boundingRect.set(rect); 10405 getMatrix().mapRect(boundingRect); 10406 rect.set((int) (boundingRect.left - 0.5f), 10407 (int) (boundingRect.top - 0.5f), 10408 (int) (boundingRect.right + 0.5f), 10409 (int) (boundingRect.bottom + 0.5f)); 10410 } 10411 } 10412 10413 /** 10414 * Used to indicate that the parent of this view should clear its caches. This functionality 10415 * is used to force the parent to rebuild its display list (when hardware-accelerated), 10416 * which is necessary when various parent-managed properties of the view change, such as 10417 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 10418 * clears the parent caches and does not causes an invalidate event. 10419 * 10420 * @hide 10421 */ 10422 protected void invalidateParentCaches() { 10423 if (mParent instanceof View) { 10424 ((View) mParent).mPrivateFlags |= PFLAG_INVALIDATED; 10425 } 10426 } 10427 10428 /** 10429 * Used to indicate that the parent of this view should be invalidated. This functionality 10430 * is used to force the parent to rebuild its display list (when hardware-accelerated), 10431 * which is necessary when various parent-managed properties of the view change, such as 10432 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 10433 * an invalidation event to the parent. 10434 * 10435 * @hide 10436 */ 10437 protected void invalidateParentIfNeeded() { 10438 if (isHardwareAccelerated() && mParent instanceof View) { 10439 ((View) mParent).invalidate(true); 10440 } 10441 } 10442 10443 /** 10444 * Indicates whether this View is opaque. An opaque View guarantees that it will 10445 * draw all the pixels overlapping its bounds using a fully opaque color. 10446 * 10447 * Subclasses of View should override this method whenever possible to indicate 10448 * whether an instance is opaque. Opaque Views are treated in a special way by 10449 * the View hierarchy, possibly allowing it to perform optimizations during 10450 * invalidate/draw passes. 10451 * 10452 * @return True if this View is guaranteed to be fully opaque, false otherwise. 10453 */ 10454 @ViewDebug.ExportedProperty(category = "drawing") 10455 public boolean isOpaque() { 10456 return (mPrivateFlags & PFLAG_OPAQUE_MASK) == PFLAG_OPAQUE_MASK && 10457 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1.0f) >= 1.0f); 10458 } 10459 10460 /** 10461 * @hide 10462 */ 10463 protected void computeOpaqueFlags() { 10464 // Opaque if: 10465 // - Has a background 10466 // - Background is opaque 10467 // - Doesn't have scrollbars or scrollbars are inside overlay 10468 10469 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) { 10470 mPrivateFlags |= PFLAG_OPAQUE_BACKGROUND; 10471 } else { 10472 mPrivateFlags &= ~PFLAG_OPAQUE_BACKGROUND; 10473 } 10474 10475 final int flags = mViewFlags; 10476 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 10477 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) { 10478 mPrivateFlags |= PFLAG_OPAQUE_SCROLLBARS; 10479 } else { 10480 mPrivateFlags &= ~PFLAG_OPAQUE_SCROLLBARS; 10481 } 10482 } 10483 10484 /** 10485 * @hide 10486 */ 10487 protected boolean hasOpaqueScrollbars() { 10488 return (mPrivateFlags & PFLAG_OPAQUE_SCROLLBARS) == PFLAG_OPAQUE_SCROLLBARS; 10489 } 10490 10491 /** 10492 * @return A handler associated with the thread running the View. This 10493 * handler can be used to pump events in the UI events queue. 10494 */ 10495 public Handler getHandler() { 10496 if (mAttachInfo != null) { 10497 return mAttachInfo.mHandler; 10498 } 10499 return null; 10500 } 10501 10502 /** 10503 * Gets the view root associated with the View. 10504 * @return The view root, or null if none. 10505 * @hide 10506 */ 10507 public ViewRootImpl getViewRootImpl() { 10508 if (mAttachInfo != null) { 10509 return mAttachInfo.mViewRootImpl; 10510 } 10511 return null; 10512 } 10513 10514 /** 10515 * <p>Causes the Runnable to be added to the message queue. 10516 * The runnable will be run on the user interface thread.</p> 10517 * 10518 * @param action The Runnable that will be executed. 10519 * 10520 * @return Returns true if the Runnable was successfully placed in to the 10521 * message queue. Returns false on failure, usually because the 10522 * looper processing the message queue is exiting. 10523 * 10524 * @see #postDelayed 10525 * @see #removeCallbacks 10526 */ 10527 public boolean post(Runnable action) { 10528 final AttachInfo attachInfo = mAttachInfo; 10529 if (attachInfo != null) { 10530 return attachInfo.mHandler.post(action); 10531 } 10532 // Assume that post will succeed later 10533 ViewRootImpl.getRunQueue().post(action); 10534 return true; 10535 } 10536 10537 /** 10538 * <p>Causes the Runnable to be added to the message queue, to be run 10539 * after the specified amount of time elapses. 10540 * The runnable will be run on the user interface thread.</p> 10541 * 10542 * @param action The Runnable that will be executed. 10543 * @param delayMillis The delay (in milliseconds) until the Runnable 10544 * will be executed. 10545 * 10546 * @return true if the Runnable was successfully placed in to the 10547 * message queue. Returns false on failure, usually because the 10548 * looper processing the message queue is exiting. Note that a 10549 * result of true does not mean the Runnable will be processed -- 10550 * if the looper is quit before the delivery time of the message 10551 * occurs then the message will be dropped. 10552 * 10553 * @see #post 10554 * @see #removeCallbacks 10555 */ 10556 public boolean postDelayed(Runnable action, long delayMillis) { 10557 final AttachInfo attachInfo = mAttachInfo; 10558 if (attachInfo != null) { 10559 return attachInfo.mHandler.postDelayed(action, delayMillis); 10560 } 10561 // Assume that post will succeed later 10562 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 10563 return true; 10564 } 10565 10566 /** 10567 * <p>Causes the Runnable to execute on the next animation time step. 10568 * The runnable will be run on the user interface thread.</p> 10569 * 10570 * @param action The Runnable that will be executed. 10571 * 10572 * @see #postOnAnimationDelayed 10573 * @see #removeCallbacks 10574 */ 10575 public void postOnAnimation(Runnable action) { 10576 final AttachInfo attachInfo = mAttachInfo; 10577 if (attachInfo != null) { 10578 attachInfo.mViewRootImpl.mChoreographer.postCallback( 10579 Choreographer.CALLBACK_ANIMATION, action, null); 10580 } else { 10581 // Assume that post will succeed later 10582 ViewRootImpl.getRunQueue().post(action); 10583 } 10584 } 10585 10586 /** 10587 * <p>Causes the Runnable to execute on the next animation time step, 10588 * after the specified amount of time elapses. 10589 * The runnable will be run on the user interface thread.</p> 10590 * 10591 * @param action The Runnable that will be executed. 10592 * @param delayMillis The delay (in milliseconds) until the Runnable 10593 * will be executed. 10594 * 10595 * @see #postOnAnimation 10596 * @see #removeCallbacks 10597 */ 10598 public void postOnAnimationDelayed(Runnable action, long delayMillis) { 10599 final AttachInfo attachInfo = mAttachInfo; 10600 if (attachInfo != null) { 10601 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 10602 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis); 10603 } else { 10604 // Assume that post will succeed later 10605 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 10606 } 10607 } 10608 10609 /** 10610 * <p>Removes the specified Runnable from the message queue.</p> 10611 * 10612 * @param action The Runnable to remove from the message handling queue 10613 * 10614 * @return true if this view could ask the Handler to remove the Runnable, 10615 * false otherwise. When the returned value is true, the Runnable 10616 * may or may not have been actually removed from the message queue 10617 * (for instance, if the Runnable was not in the queue already.) 10618 * 10619 * @see #post 10620 * @see #postDelayed 10621 * @see #postOnAnimation 10622 * @see #postOnAnimationDelayed 10623 */ 10624 public boolean removeCallbacks(Runnable action) { 10625 if (action != null) { 10626 final AttachInfo attachInfo = mAttachInfo; 10627 if (attachInfo != null) { 10628 attachInfo.mHandler.removeCallbacks(action); 10629 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 10630 Choreographer.CALLBACK_ANIMATION, action, null); 10631 } else { 10632 // Assume that post will succeed later 10633 ViewRootImpl.getRunQueue().removeCallbacks(action); 10634 } 10635 } 10636 return true; 10637 } 10638 10639 /** 10640 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 10641 * Use this to invalidate the View from a non-UI thread.</p> 10642 * 10643 * <p>This method can be invoked from outside of the UI thread 10644 * only when this View is attached to a window.</p> 10645 * 10646 * @see #invalidate() 10647 * @see #postInvalidateDelayed(long) 10648 */ 10649 public void postInvalidate() { 10650 postInvalidateDelayed(0); 10651 } 10652 10653 /** 10654 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 10655 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 10656 * 10657 * <p>This method can be invoked from outside of the UI thread 10658 * only when this View is attached to a window.</p> 10659 * 10660 * @param left The left coordinate of the rectangle to invalidate. 10661 * @param top The top coordinate of the rectangle to invalidate. 10662 * @param right The right coordinate of the rectangle to invalidate. 10663 * @param bottom The bottom coordinate of the rectangle to invalidate. 10664 * 10665 * @see #invalidate(int, int, int, int) 10666 * @see #invalidate(Rect) 10667 * @see #postInvalidateDelayed(long, int, int, int, int) 10668 */ 10669 public void postInvalidate(int left, int top, int right, int bottom) { 10670 postInvalidateDelayed(0, left, top, right, bottom); 10671 } 10672 10673 /** 10674 * <p>Cause an invalidate to happen on a subsequent cycle through the event 10675 * loop. Waits for the specified amount of time.</p> 10676 * 10677 * <p>This method can be invoked from outside of the UI thread 10678 * only when this View is attached to a window.</p> 10679 * 10680 * @param delayMilliseconds the duration in milliseconds to delay the 10681 * invalidation by 10682 * 10683 * @see #invalidate() 10684 * @see #postInvalidate() 10685 */ 10686 public void postInvalidateDelayed(long delayMilliseconds) { 10687 // We try only with the AttachInfo because there's no point in invalidating 10688 // if we are not attached to our window 10689 final AttachInfo attachInfo = mAttachInfo; 10690 if (attachInfo != null) { 10691 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds); 10692 } 10693 } 10694 10695 /** 10696 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 10697 * through the event loop. Waits for the specified amount of time.</p> 10698 * 10699 * <p>This method can be invoked from outside of the UI thread 10700 * only when this View is attached to a window.</p> 10701 * 10702 * @param delayMilliseconds the duration in milliseconds to delay the 10703 * invalidation by 10704 * @param left The left coordinate of the rectangle to invalidate. 10705 * @param top The top coordinate of the rectangle to invalidate. 10706 * @param right The right coordinate of the rectangle to invalidate. 10707 * @param bottom The bottom coordinate of the rectangle to invalidate. 10708 * 10709 * @see #invalidate(int, int, int, int) 10710 * @see #invalidate(Rect) 10711 * @see #postInvalidate(int, int, int, int) 10712 */ 10713 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 10714 int right, int bottom) { 10715 10716 // We try only with the AttachInfo because there's no point in invalidating 10717 // if we are not attached to our window 10718 final AttachInfo attachInfo = mAttachInfo; 10719 if (attachInfo != null) { 10720 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 10721 info.target = this; 10722 info.left = left; 10723 info.top = top; 10724 info.right = right; 10725 info.bottom = bottom; 10726 10727 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds); 10728 } 10729 } 10730 10731 /** 10732 * <p>Cause an invalidate to happen on the next animation time step, typically the 10733 * next display frame.</p> 10734 * 10735 * <p>This method can be invoked from outside of the UI thread 10736 * only when this View is attached to a window.</p> 10737 * 10738 * @see #invalidate() 10739 */ 10740 public void postInvalidateOnAnimation() { 10741 // We try only with the AttachInfo because there's no point in invalidating 10742 // if we are not attached to our window 10743 final AttachInfo attachInfo = mAttachInfo; 10744 if (attachInfo != null) { 10745 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this); 10746 } 10747 } 10748 10749 /** 10750 * <p>Cause an invalidate of the specified area to happen on the next animation 10751 * time step, typically the next display frame.</p> 10752 * 10753 * <p>This method can be invoked from outside of the UI thread 10754 * only when this View is attached to a window.</p> 10755 * 10756 * @param left The left coordinate of the rectangle to invalidate. 10757 * @param top The top coordinate of the rectangle to invalidate. 10758 * @param right The right coordinate of the rectangle to invalidate. 10759 * @param bottom The bottom coordinate of the rectangle to invalidate. 10760 * 10761 * @see #invalidate(int, int, int, int) 10762 * @see #invalidate(Rect) 10763 */ 10764 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) { 10765 // We try only with the AttachInfo because there's no point in invalidating 10766 // if we are not attached to our window 10767 final AttachInfo attachInfo = mAttachInfo; 10768 if (attachInfo != null) { 10769 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 10770 info.target = this; 10771 info.left = left; 10772 info.top = top; 10773 info.right = right; 10774 info.bottom = bottom; 10775 10776 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info); 10777 } 10778 } 10779 10780 /** 10781 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 10782 * This event is sent at most once every 10783 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 10784 */ 10785 private void postSendViewScrolledAccessibilityEventCallback() { 10786 if (mSendViewScrolledAccessibilityEvent == null) { 10787 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 10788 } 10789 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 10790 mSendViewScrolledAccessibilityEvent.mIsPending = true; 10791 postDelayed(mSendViewScrolledAccessibilityEvent, 10792 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 10793 } 10794 } 10795 10796 /** 10797 * Called by a parent to request that a child update its values for mScrollX 10798 * and mScrollY if necessary. This will typically be done if the child is 10799 * animating a scroll using a {@link android.widget.Scroller Scroller} 10800 * object. 10801 */ 10802 public void computeScroll() { 10803 } 10804 10805 /** 10806 * <p>Indicate whether the horizontal edges are faded when the view is 10807 * scrolled horizontally.</p> 10808 * 10809 * @return true if the horizontal edges should are faded on scroll, false 10810 * otherwise 10811 * 10812 * @see #setHorizontalFadingEdgeEnabled(boolean) 10813 * 10814 * @attr ref android.R.styleable#View_requiresFadingEdge 10815 */ 10816 public boolean isHorizontalFadingEdgeEnabled() { 10817 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 10818 } 10819 10820 /** 10821 * <p>Define whether the horizontal edges should be faded when this view 10822 * is scrolled horizontally.</p> 10823 * 10824 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 10825 * be faded when the view is scrolled 10826 * horizontally 10827 * 10828 * @see #isHorizontalFadingEdgeEnabled() 10829 * 10830 * @attr ref android.R.styleable#View_requiresFadingEdge 10831 */ 10832 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 10833 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 10834 if (horizontalFadingEdgeEnabled) { 10835 initScrollCache(); 10836 } 10837 10838 mViewFlags ^= FADING_EDGE_HORIZONTAL; 10839 } 10840 } 10841 10842 /** 10843 * <p>Indicate whether the vertical edges are faded when the view is 10844 * scrolled horizontally.</p> 10845 * 10846 * @return true if the vertical edges should are faded on scroll, false 10847 * otherwise 10848 * 10849 * @see #setVerticalFadingEdgeEnabled(boolean) 10850 * 10851 * @attr ref android.R.styleable#View_requiresFadingEdge 10852 */ 10853 public boolean isVerticalFadingEdgeEnabled() { 10854 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 10855 } 10856 10857 /** 10858 * <p>Define whether the vertical edges should be faded when this view 10859 * is scrolled vertically.</p> 10860 * 10861 * @param verticalFadingEdgeEnabled true if the vertical edges should 10862 * be faded when the view is scrolled 10863 * vertically 10864 * 10865 * @see #isVerticalFadingEdgeEnabled() 10866 * 10867 * @attr ref android.R.styleable#View_requiresFadingEdge 10868 */ 10869 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 10870 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 10871 if (verticalFadingEdgeEnabled) { 10872 initScrollCache(); 10873 } 10874 10875 mViewFlags ^= FADING_EDGE_VERTICAL; 10876 } 10877 } 10878 10879 /** 10880 * Returns the strength, or intensity, of the top faded edge. The strength is 10881 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10882 * returns 0.0 or 1.0 but no value in between. 10883 * 10884 * Subclasses should override this method to provide a smoother fade transition 10885 * when scrolling occurs. 10886 * 10887 * @return the intensity of the top fade as a float between 0.0f and 1.0f 10888 */ 10889 protected float getTopFadingEdgeStrength() { 10890 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 10891 } 10892 10893 /** 10894 * Returns the strength, or intensity, of the bottom faded edge. The strength is 10895 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10896 * returns 0.0 or 1.0 but no value in between. 10897 * 10898 * Subclasses should override this method to provide a smoother fade transition 10899 * when scrolling occurs. 10900 * 10901 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 10902 */ 10903 protected float getBottomFadingEdgeStrength() { 10904 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 10905 computeVerticalScrollRange() ? 1.0f : 0.0f; 10906 } 10907 10908 /** 10909 * Returns the strength, or intensity, of the left faded edge. The strength is 10910 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10911 * returns 0.0 or 1.0 but no value in between. 10912 * 10913 * Subclasses should override this method to provide a smoother fade transition 10914 * when scrolling occurs. 10915 * 10916 * @return the intensity of the left fade as a float between 0.0f and 1.0f 10917 */ 10918 protected float getLeftFadingEdgeStrength() { 10919 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 10920 } 10921 10922 /** 10923 * Returns the strength, or intensity, of the right faded edge. The strength is 10924 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10925 * returns 0.0 or 1.0 but no value in between. 10926 * 10927 * Subclasses should override this method to provide a smoother fade transition 10928 * when scrolling occurs. 10929 * 10930 * @return the intensity of the right fade as a float between 0.0f and 1.0f 10931 */ 10932 protected float getRightFadingEdgeStrength() { 10933 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 10934 computeHorizontalScrollRange() ? 1.0f : 0.0f; 10935 } 10936 10937 /** 10938 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 10939 * scrollbar is not drawn by default.</p> 10940 * 10941 * @return true if the horizontal scrollbar should be painted, false 10942 * otherwise 10943 * 10944 * @see #setHorizontalScrollBarEnabled(boolean) 10945 */ 10946 public boolean isHorizontalScrollBarEnabled() { 10947 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 10948 } 10949 10950 /** 10951 * <p>Define whether the horizontal scrollbar should be drawn or not. The 10952 * scrollbar is not drawn by default.</p> 10953 * 10954 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 10955 * be painted 10956 * 10957 * @see #isHorizontalScrollBarEnabled() 10958 */ 10959 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 10960 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 10961 mViewFlags ^= SCROLLBARS_HORIZONTAL; 10962 computeOpaqueFlags(); 10963 resolvePadding(); 10964 } 10965 } 10966 10967 /** 10968 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 10969 * scrollbar is not drawn by default.</p> 10970 * 10971 * @return true if the vertical scrollbar should be painted, false 10972 * otherwise 10973 * 10974 * @see #setVerticalScrollBarEnabled(boolean) 10975 */ 10976 public boolean isVerticalScrollBarEnabled() { 10977 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 10978 } 10979 10980 /** 10981 * <p>Define whether the vertical scrollbar should be drawn or not. The 10982 * scrollbar is not drawn by default.</p> 10983 * 10984 * @param verticalScrollBarEnabled true if the vertical scrollbar should 10985 * be painted 10986 * 10987 * @see #isVerticalScrollBarEnabled() 10988 */ 10989 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 10990 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 10991 mViewFlags ^= SCROLLBARS_VERTICAL; 10992 computeOpaqueFlags(); 10993 resolvePadding(); 10994 } 10995 } 10996 10997 /** 10998 * @hide 10999 */ 11000 protected void recomputePadding() { 11001 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 11002 } 11003 11004 /** 11005 * Define whether scrollbars will fade when the view is not scrolling. 11006 * 11007 * @param fadeScrollbars wheter to enable fading 11008 * 11009 * @attr ref android.R.styleable#View_fadeScrollbars 11010 */ 11011 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 11012 initScrollCache(); 11013 final ScrollabilityCache scrollabilityCache = mScrollCache; 11014 scrollabilityCache.fadeScrollBars = fadeScrollbars; 11015 if (fadeScrollbars) { 11016 scrollabilityCache.state = ScrollabilityCache.OFF; 11017 } else { 11018 scrollabilityCache.state = ScrollabilityCache.ON; 11019 } 11020 } 11021 11022 /** 11023 * 11024 * Returns true if scrollbars will fade when this view is not scrolling 11025 * 11026 * @return true if scrollbar fading is enabled 11027 * 11028 * @attr ref android.R.styleable#View_fadeScrollbars 11029 */ 11030 public boolean isScrollbarFadingEnabled() { 11031 return mScrollCache != null && mScrollCache.fadeScrollBars; 11032 } 11033 11034 /** 11035 * 11036 * Returns the delay before scrollbars fade. 11037 * 11038 * @return the delay before scrollbars fade 11039 * 11040 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 11041 */ 11042 public int getScrollBarDefaultDelayBeforeFade() { 11043 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() : 11044 mScrollCache.scrollBarDefaultDelayBeforeFade; 11045 } 11046 11047 /** 11048 * Define the delay before scrollbars fade. 11049 * 11050 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade 11051 * 11052 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 11053 */ 11054 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) { 11055 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade; 11056 } 11057 11058 /** 11059 * 11060 * Returns the scrollbar fade duration. 11061 * 11062 * @return the scrollbar fade duration 11063 * 11064 * @attr ref android.R.styleable#View_scrollbarFadeDuration 11065 */ 11066 public int getScrollBarFadeDuration() { 11067 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() : 11068 mScrollCache.scrollBarFadeDuration; 11069 } 11070 11071 /** 11072 * Define the scrollbar fade duration. 11073 * 11074 * @param scrollBarFadeDuration - the scrollbar fade duration 11075 * 11076 * @attr ref android.R.styleable#View_scrollbarFadeDuration 11077 */ 11078 public void setScrollBarFadeDuration(int scrollBarFadeDuration) { 11079 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration; 11080 } 11081 11082 /** 11083 * 11084 * Returns the scrollbar size. 11085 * 11086 * @return the scrollbar size 11087 * 11088 * @attr ref android.R.styleable#View_scrollbarSize 11089 */ 11090 public int getScrollBarSize() { 11091 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() : 11092 mScrollCache.scrollBarSize; 11093 } 11094 11095 /** 11096 * Define the scrollbar size. 11097 * 11098 * @param scrollBarSize - the scrollbar size 11099 * 11100 * @attr ref android.R.styleable#View_scrollbarSize 11101 */ 11102 public void setScrollBarSize(int scrollBarSize) { 11103 getScrollCache().scrollBarSize = scrollBarSize; 11104 } 11105 11106 /** 11107 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 11108 * inset. When inset, they add to the padding of the view. And the scrollbars 11109 * can be drawn inside the padding area or on the edge of the view. For example, 11110 * if a view has a background drawable and you want to draw the scrollbars 11111 * inside the padding specified by the drawable, you can use 11112 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 11113 * appear at the edge of the view, ignoring the padding, then you can use 11114 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 11115 * @param style the style of the scrollbars. Should be one of 11116 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 11117 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 11118 * @see #SCROLLBARS_INSIDE_OVERLAY 11119 * @see #SCROLLBARS_INSIDE_INSET 11120 * @see #SCROLLBARS_OUTSIDE_OVERLAY 11121 * @see #SCROLLBARS_OUTSIDE_INSET 11122 * 11123 * @attr ref android.R.styleable#View_scrollbarStyle 11124 */ 11125 public void setScrollBarStyle(int style) { 11126 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 11127 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 11128 computeOpaqueFlags(); 11129 resolvePadding(); 11130 } 11131 } 11132 11133 /** 11134 * <p>Returns the current scrollbar style.</p> 11135 * @return the current scrollbar style 11136 * @see #SCROLLBARS_INSIDE_OVERLAY 11137 * @see #SCROLLBARS_INSIDE_INSET 11138 * @see #SCROLLBARS_OUTSIDE_OVERLAY 11139 * @see #SCROLLBARS_OUTSIDE_INSET 11140 * 11141 * @attr ref android.R.styleable#View_scrollbarStyle 11142 */ 11143 @ViewDebug.ExportedProperty(mapping = { 11144 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 11145 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 11146 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 11147 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 11148 }) 11149 public int getScrollBarStyle() { 11150 return mViewFlags & SCROLLBARS_STYLE_MASK; 11151 } 11152 11153 /** 11154 * <p>Compute the horizontal range that the horizontal scrollbar 11155 * represents.</p> 11156 * 11157 * <p>The range is expressed in arbitrary units that must be the same as the 11158 * units used by {@link #computeHorizontalScrollExtent()} and 11159 * {@link #computeHorizontalScrollOffset()}.</p> 11160 * 11161 * <p>The default range is the drawing width of this view.</p> 11162 * 11163 * @return the total horizontal range represented by the horizontal 11164 * scrollbar 11165 * 11166 * @see #computeHorizontalScrollExtent() 11167 * @see #computeHorizontalScrollOffset() 11168 * @see android.widget.ScrollBarDrawable 11169 */ 11170 protected int computeHorizontalScrollRange() { 11171 return getWidth(); 11172 } 11173 11174 /** 11175 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 11176 * within the horizontal range. This value is used to compute the position 11177 * of the thumb within the scrollbar's track.</p> 11178 * 11179 * <p>The range is expressed in arbitrary units that must be the same as the 11180 * units used by {@link #computeHorizontalScrollRange()} and 11181 * {@link #computeHorizontalScrollExtent()}.</p> 11182 * 11183 * <p>The default offset is the scroll offset of this view.</p> 11184 * 11185 * @return the horizontal offset of the scrollbar's thumb 11186 * 11187 * @see #computeHorizontalScrollRange() 11188 * @see #computeHorizontalScrollExtent() 11189 * @see android.widget.ScrollBarDrawable 11190 */ 11191 protected int computeHorizontalScrollOffset() { 11192 return mScrollX; 11193 } 11194 11195 /** 11196 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 11197 * within the horizontal range. This value is used to compute the length 11198 * of the thumb within the scrollbar's track.</p> 11199 * 11200 * <p>The range is expressed in arbitrary units that must be the same as the 11201 * units used by {@link #computeHorizontalScrollRange()} and 11202 * {@link #computeHorizontalScrollOffset()}.</p> 11203 * 11204 * <p>The default extent is the drawing width of this view.</p> 11205 * 11206 * @return the horizontal extent of the scrollbar's thumb 11207 * 11208 * @see #computeHorizontalScrollRange() 11209 * @see #computeHorizontalScrollOffset() 11210 * @see android.widget.ScrollBarDrawable 11211 */ 11212 protected int computeHorizontalScrollExtent() { 11213 return getWidth(); 11214 } 11215 11216 /** 11217 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 11218 * 11219 * <p>The range is expressed in arbitrary units that must be the same as the 11220 * units used by {@link #computeVerticalScrollExtent()} and 11221 * {@link #computeVerticalScrollOffset()}.</p> 11222 * 11223 * @return the total vertical range represented by the vertical scrollbar 11224 * 11225 * <p>The default range is the drawing height of this view.</p> 11226 * 11227 * @see #computeVerticalScrollExtent() 11228 * @see #computeVerticalScrollOffset() 11229 * @see android.widget.ScrollBarDrawable 11230 */ 11231 protected int computeVerticalScrollRange() { 11232 return getHeight(); 11233 } 11234 11235 /** 11236 * <p>Compute the vertical offset of the vertical scrollbar's thumb 11237 * within the horizontal range. This value is used to compute the position 11238 * of the thumb within the scrollbar's track.</p> 11239 * 11240 * <p>The range is expressed in arbitrary units that must be the same as the 11241 * units used by {@link #computeVerticalScrollRange()} and 11242 * {@link #computeVerticalScrollExtent()}.</p> 11243 * 11244 * <p>The default offset is the scroll offset of this view.</p> 11245 * 11246 * @return the vertical offset of the scrollbar's thumb 11247 * 11248 * @see #computeVerticalScrollRange() 11249 * @see #computeVerticalScrollExtent() 11250 * @see android.widget.ScrollBarDrawable 11251 */ 11252 protected int computeVerticalScrollOffset() { 11253 return mScrollY; 11254 } 11255 11256 /** 11257 * <p>Compute the vertical extent of the horizontal scrollbar's thumb 11258 * within the vertical range. This value is used to compute the length 11259 * of the thumb within the scrollbar's track.</p> 11260 * 11261 * <p>The range is expressed in arbitrary units that must be the same as the 11262 * units used by {@link #computeVerticalScrollRange()} and 11263 * {@link #computeVerticalScrollOffset()}.</p> 11264 * 11265 * <p>The default extent is the drawing height of this view.</p> 11266 * 11267 * @return the vertical extent of the scrollbar's thumb 11268 * 11269 * @see #computeVerticalScrollRange() 11270 * @see #computeVerticalScrollOffset() 11271 * @see android.widget.ScrollBarDrawable 11272 */ 11273 protected int computeVerticalScrollExtent() { 11274 return getHeight(); 11275 } 11276 11277 /** 11278 * Check if this view can be scrolled horizontally in a certain direction. 11279 * 11280 * @param direction Negative to check scrolling left, positive to check scrolling right. 11281 * @return true if this view can be scrolled in the specified direction, false otherwise. 11282 */ 11283 public boolean canScrollHorizontally(int direction) { 11284 final int offset = computeHorizontalScrollOffset(); 11285 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 11286 if (range == 0) return false; 11287 if (direction < 0) { 11288 return offset > 0; 11289 } else { 11290 return offset < range - 1; 11291 } 11292 } 11293 11294 /** 11295 * Check if this view can be scrolled vertically in a certain direction. 11296 * 11297 * @param direction Negative to check scrolling up, positive to check scrolling down. 11298 * @return true if this view can be scrolled in the specified direction, false otherwise. 11299 */ 11300 public boolean canScrollVertically(int direction) { 11301 final int offset = computeVerticalScrollOffset(); 11302 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 11303 if (range == 0) return false; 11304 if (direction < 0) { 11305 return offset > 0; 11306 } else { 11307 return offset < range - 1; 11308 } 11309 } 11310 11311 /** 11312 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 11313 * scrollbars are painted only if they have been awakened first.</p> 11314 * 11315 * @param canvas the canvas on which to draw the scrollbars 11316 * 11317 * @see #awakenScrollBars(int) 11318 */ 11319 protected final void onDrawScrollBars(Canvas canvas) { 11320 // scrollbars are drawn only when the animation is running 11321 final ScrollabilityCache cache = mScrollCache; 11322 if (cache != null) { 11323 11324 int state = cache.state; 11325 11326 if (state == ScrollabilityCache.OFF) { 11327 return; 11328 } 11329 11330 boolean invalidate = false; 11331 11332 if (state == ScrollabilityCache.FADING) { 11333 // We're fading -- get our fade interpolation 11334 if (cache.interpolatorValues == null) { 11335 cache.interpolatorValues = new float[1]; 11336 } 11337 11338 float[] values = cache.interpolatorValues; 11339 11340 // Stops the animation if we're done 11341 if (cache.scrollBarInterpolator.timeToValues(values) == 11342 Interpolator.Result.FREEZE_END) { 11343 cache.state = ScrollabilityCache.OFF; 11344 } else { 11345 cache.scrollBar.setAlpha(Math.round(values[0])); 11346 } 11347 11348 // This will make the scroll bars inval themselves after 11349 // drawing. We only want this when we're fading so that 11350 // we prevent excessive redraws 11351 invalidate = true; 11352 } else { 11353 // We're just on -- but we may have been fading before so 11354 // reset alpha 11355 cache.scrollBar.setAlpha(255); 11356 } 11357 11358 11359 final int viewFlags = mViewFlags; 11360 11361 final boolean drawHorizontalScrollBar = 11362 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 11363 final boolean drawVerticalScrollBar = 11364 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 11365 && !isVerticalScrollBarHidden(); 11366 11367 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 11368 final int width = mRight - mLeft; 11369 final int height = mBottom - mTop; 11370 11371 final ScrollBarDrawable scrollBar = cache.scrollBar; 11372 11373 final int scrollX = mScrollX; 11374 final int scrollY = mScrollY; 11375 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 11376 11377 int left, top, right, bottom; 11378 11379 if (drawHorizontalScrollBar) { 11380 int size = scrollBar.getSize(false); 11381 if (size <= 0) { 11382 size = cache.scrollBarSize; 11383 } 11384 11385 scrollBar.setParameters(computeHorizontalScrollRange(), 11386 computeHorizontalScrollOffset(), 11387 computeHorizontalScrollExtent(), false); 11388 final int verticalScrollBarGap = drawVerticalScrollBar ? 11389 getVerticalScrollbarWidth() : 0; 11390 top = scrollY + height - size - (mUserPaddingBottom & inside); 11391 left = scrollX + (mPaddingLeft & inside); 11392 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 11393 bottom = top + size; 11394 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 11395 if (invalidate) { 11396 invalidate(left, top, right, bottom); 11397 } 11398 } 11399 11400 if (drawVerticalScrollBar) { 11401 int size = scrollBar.getSize(true); 11402 if (size <= 0) { 11403 size = cache.scrollBarSize; 11404 } 11405 11406 scrollBar.setParameters(computeVerticalScrollRange(), 11407 computeVerticalScrollOffset(), 11408 computeVerticalScrollExtent(), true); 11409 int verticalScrollbarPosition = mVerticalScrollbarPosition; 11410 if (verticalScrollbarPosition == SCROLLBAR_POSITION_DEFAULT) { 11411 verticalScrollbarPosition = isLayoutRtl() ? 11412 SCROLLBAR_POSITION_LEFT : SCROLLBAR_POSITION_RIGHT; 11413 } 11414 switch (verticalScrollbarPosition) { 11415 default: 11416 case SCROLLBAR_POSITION_RIGHT: 11417 left = scrollX + width - size - (mUserPaddingRight & inside); 11418 break; 11419 case SCROLLBAR_POSITION_LEFT: 11420 left = scrollX + (mUserPaddingLeft & inside); 11421 break; 11422 } 11423 top = scrollY + (mPaddingTop & inside); 11424 right = left + size; 11425 bottom = scrollY + height - (mUserPaddingBottom & inside); 11426 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 11427 if (invalidate) { 11428 invalidate(left, top, right, bottom); 11429 } 11430 } 11431 } 11432 } 11433 } 11434 11435 /** 11436 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 11437 * FastScroller is visible. 11438 * @return whether to temporarily hide the vertical scrollbar 11439 * @hide 11440 */ 11441 protected boolean isVerticalScrollBarHidden() { 11442 return false; 11443 } 11444 11445 /** 11446 * <p>Draw the horizontal scrollbar if 11447 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 11448 * 11449 * @param canvas the canvas on which to draw the scrollbar 11450 * @param scrollBar the scrollbar's drawable 11451 * 11452 * @see #isHorizontalScrollBarEnabled() 11453 * @see #computeHorizontalScrollRange() 11454 * @see #computeHorizontalScrollExtent() 11455 * @see #computeHorizontalScrollOffset() 11456 * @see android.widget.ScrollBarDrawable 11457 * @hide 11458 */ 11459 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 11460 int l, int t, int r, int b) { 11461 scrollBar.setBounds(l, t, r, b); 11462 scrollBar.draw(canvas); 11463 } 11464 11465 /** 11466 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 11467 * returns true.</p> 11468 * 11469 * @param canvas the canvas on which to draw the scrollbar 11470 * @param scrollBar the scrollbar's drawable 11471 * 11472 * @see #isVerticalScrollBarEnabled() 11473 * @see #computeVerticalScrollRange() 11474 * @see #computeVerticalScrollExtent() 11475 * @see #computeVerticalScrollOffset() 11476 * @see android.widget.ScrollBarDrawable 11477 * @hide 11478 */ 11479 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 11480 int l, int t, int r, int b) { 11481 scrollBar.setBounds(l, t, r, b); 11482 scrollBar.draw(canvas); 11483 } 11484 11485 /** 11486 * Implement this to do your drawing. 11487 * 11488 * @param canvas the canvas on which the background will be drawn 11489 */ 11490 protected void onDraw(Canvas canvas) { 11491 } 11492 11493 /* 11494 * Caller is responsible for calling requestLayout if necessary. 11495 * (This allows addViewInLayout to not request a new layout.) 11496 */ 11497 void assignParent(ViewParent parent) { 11498 if (mParent == null) { 11499 mParent = parent; 11500 } else if (parent == null) { 11501 mParent = null; 11502 } else { 11503 throw new RuntimeException("view " + this + " being added, but" 11504 + " it already has a parent"); 11505 } 11506 } 11507 11508 /** 11509 * This is called when the view is attached to a window. At this point it 11510 * has a Surface and will start drawing. Note that this function is 11511 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 11512 * however it may be called any time before the first onDraw -- including 11513 * before or after {@link #onMeasure(int, int)}. 11514 * 11515 * @see #onDetachedFromWindow() 11516 */ 11517 protected void onAttachedToWindow() { 11518 if ((mPrivateFlags & PFLAG_REQUEST_TRANSPARENT_REGIONS) != 0) { 11519 mParent.requestTransparentRegion(this); 11520 } 11521 11522 if ((mPrivateFlags & PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 11523 initialAwakenScrollBars(); 11524 mPrivateFlags &= ~PFLAG_AWAKEN_SCROLL_BARS_ON_ATTACH; 11525 } 11526 11527 jumpDrawablesToCurrentState(); 11528 11529 clearAccessibilityFocus(); 11530 if (isFocused()) { 11531 InputMethodManager imm = InputMethodManager.peekInstance(); 11532 imm.focusIn(this); 11533 } 11534 11535 if (mAttachInfo != null && mDisplayList != null) { 11536 mAttachInfo.mViewRootImpl.dequeueDisplayList(mDisplayList); 11537 } 11538 } 11539 11540 /** 11541 * Resolve all RTL related properties. 11542 * 11543 * @hide 11544 */ 11545 public void resolveRtlPropertiesIfNeeded() { 11546 if (!needRtlPropertiesResolution()) return; 11547 11548 // Order is important here: LayoutDirection MUST be resolved first 11549 if (!isLayoutDirectionResolved()) { 11550 resolveLayoutDirection(); 11551 resolveLayoutParams(); 11552 } 11553 // ... then we can resolve the others properties depending on the resolved LayoutDirection. 11554 if (!isTextDirectionResolved()) { 11555 resolveTextDirection(); 11556 } 11557 if (!isTextAlignmentResolved()) { 11558 resolveTextAlignment(); 11559 } 11560 if (!isPaddingResolved()) { 11561 resolvePadding(); 11562 } 11563 if (!isDrawablesResolved()) { 11564 resolveDrawables(); 11565 } 11566 onRtlPropertiesChanged(getLayoutDirection()); 11567 } 11568 11569 /** 11570 * Reset resolution of all RTL related properties. 11571 * 11572 * @hide 11573 */ 11574 public void resetRtlProperties() { 11575 resetResolvedLayoutDirection(); 11576 resetResolvedTextDirection(); 11577 resetResolvedTextAlignment(); 11578 resetResolvedPadding(); 11579 resetResolvedDrawables(); 11580 } 11581 11582 /** 11583 * @see #onScreenStateChanged(int) 11584 */ 11585 void dispatchScreenStateChanged(int screenState) { 11586 onScreenStateChanged(screenState); 11587 } 11588 11589 /** 11590 * This method is called whenever the state of the screen this view is 11591 * attached to changes. A state change will usually occurs when the screen 11592 * turns on or off (whether it happens automatically or the user does it 11593 * manually.) 11594 * 11595 * @param screenState The new state of the screen. Can be either 11596 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF} 11597 */ 11598 public void onScreenStateChanged(int screenState) { 11599 } 11600 11601 /** 11602 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true 11603 */ 11604 private boolean hasRtlSupport() { 11605 return mContext.getApplicationInfo().hasRtlSupport(); 11606 } 11607 11608 /** 11609 * Return true if we are in RTL compatibility mode (either before Jelly Bean MR1 or 11610 * RTL not supported) 11611 */ 11612 private boolean isRtlCompatibilityMode() { 11613 final int targetSdkVersion = getContext().getApplicationInfo().targetSdkVersion; 11614 return targetSdkVersion < JELLY_BEAN_MR1 || !hasRtlSupport(); 11615 } 11616 11617 /** 11618 * @return true if RTL properties need resolution. 11619 */ 11620 private boolean needRtlPropertiesResolution() { 11621 return (mPrivateFlags2 & ALL_RTL_PROPERTIES_RESOLVED) != ALL_RTL_PROPERTIES_RESOLVED; 11622 } 11623 11624 /** 11625 * Called when any RTL property (layout direction or text direction or text alignment) has 11626 * been changed. 11627 * 11628 * Subclasses need to override this method to take care of cached information that depends on the 11629 * resolved layout direction, or to inform child views that inherit their layout direction. 11630 * 11631 * The default implementation does nothing. 11632 * 11633 * @param layoutDirection the direction of the layout 11634 * 11635 * @see #LAYOUT_DIRECTION_LTR 11636 * @see #LAYOUT_DIRECTION_RTL 11637 */ 11638 public void onRtlPropertiesChanged(int layoutDirection) { 11639 } 11640 11641 /** 11642 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 11643 * that the parent directionality can and will be resolved before its children. 11644 * 11645 * @return true if resolution has been done, false otherwise. 11646 * 11647 * @hide 11648 */ 11649 public boolean resolveLayoutDirection() { 11650 // Clear any previous layout direction resolution 11651 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 11652 11653 if (hasRtlSupport()) { 11654 // Set resolved depending on layout direction 11655 switch ((mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_MASK) >> 11656 PFLAG2_LAYOUT_DIRECTION_MASK_SHIFT) { 11657 case LAYOUT_DIRECTION_INHERIT: 11658 // We cannot resolve yet. LTR is by default and let the resolution happen again 11659 // later to get the correct resolved value 11660 if (!canResolveLayoutDirection()) return false; 11661 11662 View parent = ((View) mParent); 11663 // Parent has not yet resolved, LTR is still the default 11664 if (!parent.isLayoutDirectionResolved()) return false; 11665 11666 if (parent.getLayoutDirection() == LAYOUT_DIRECTION_RTL) { 11667 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 11668 } 11669 break; 11670 case LAYOUT_DIRECTION_RTL: 11671 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 11672 break; 11673 case LAYOUT_DIRECTION_LOCALE: 11674 if((LAYOUT_DIRECTION_RTL == 11675 TextUtils.getLayoutDirectionFromLocale(Locale.getDefault()))) { 11676 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED_RTL; 11677 } 11678 break; 11679 default: 11680 // Nothing to do, LTR by default 11681 } 11682 } 11683 11684 // Set to resolved 11685 mPrivateFlags2 |= PFLAG2_LAYOUT_DIRECTION_RESOLVED; 11686 return true; 11687 } 11688 11689 /** 11690 * Check if layout direction resolution can be done. 11691 * 11692 * @return true if layout direction resolution can be done otherwise return false. 11693 * 11694 * @hide 11695 */ 11696 public boolean canResolveLayoutDirection() { 11697 switch (getRawLayoutDirection()) { 11698 case LAYOUT_DIRECTION_INHERIT: 11699 return (mParent != null) && (mParent instanceof ViewGroup) && 11700 ((ViewGroup) mParent).canResolveLayoutDirection(); 11701 default: 11702 return true; 11703 } 11704 } 11705 11706 /** 11707 * Reset the resolved layout direction. Layout direction will be resolved during a call to 11708 * {@link #onMeasure(int, int)}. 11709 * 11710 * @hide 11711 */ 11712 public void resetResolvedLayoutDirection() { 11713 // Reset the current resolved bits 11714 mPrivateFlags2 &= ~PFLAG2_LAYOUT_DIRECTION_RESOLVED_MASK; 11715 } 11716 11717 /** 11718 * @return true if the layout direction is inherited. 11719 * 11720 * @hide 11721 */ 11722 public boolean isLayoutDirectionInherited() { 11723 return (getRawLayoutDirection() == LAYOUT_DIRECTION_INHERIT); 11724 } 11725 11726 /** 11727 * @return true if layout direction has been resolved. 11728 */ 11729 private boolean isLayoutDirectionResolved() { 11730 return (mPrivateFlags2 & PFLAG2_LAYOUT_DIRECTION_RESOLVED) == PFLAG2_LAYOUT_DIRECTION_RESOLVED; 11731 } 11732 11733 /** 11734 * Return if padding has been resolved 11735 * 11736 * @hide 11737 */ 11738 boolean isPaddingResolved() { 11739 return (mPrivateFlags2 & PFLAG2_PADDING_RESOLVED) == PFLAG2_PADDING_RESOLVED; 11740 } 11741 11742 /** 11743 * Resolve padding depending on layout direction. 11744 * 11745 * @hide 11746 */ 11747 public void resolvePadding() { 11748 if (!isRtlCompatibilityMode()) { 11749 // Post Jelly Bean MR1 case: we need to take the resolved layout direction into account. 11750 // If start / end padding are defined, they will be resolved (hence overriding) to 11751 // left / right or right / left depending on the resolved layout direction. 11752 // If start / end padding are not defined, use the left / right ones. 11753 int resolvedLayoutDirection = getLayoutDirection(); 11754 // Set user padding to initial values ... 11755 mUserPaddingLeft = mUserPaddingLeftInitial; 11756 mUserPaddingRight = mUserPaddingRightInitial; 11757 // ... then resolve it. 11758 switch (resolvedLayoutDirection) { 11759 case LAYOUT_DIRECTION_RTL: 11760 if (mUserPaddingStart != UNDEFINED_PADDING) { 11761 mUserPaddingRight = mUserPaddingStart; 11762 } 11763 if (mUserPaddingEnd != UNDEFINED_PADDING) { 11764 mUserPaddingLeft = mUserPaddingEnd; 11765 } 11766 break; 11767 case LAYOUT_DIRECTION_LTR: 11768 default: 11769 if (mUserPaddingStart != UNDEFINED_PADDING) { 11770 mUserPaddingLeft = mUserPaddingStart; 11771 } 11772 if (mUserPaddingEnd != UNDEFINED_PADDING) { 11773 mUserPaddingRight = mUserPaddingEnd; 11774 } 11775 } 11776 11777 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 11778 11779 internalSetPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, 11780 mUserPaddingBottom); 11781 onRtlPropertiesChanged(resolvedLayoutDirection); 11782 } 11783 11784 mPrivateFlags2 |= PFLAG2_PADDING_RESOLVED; 11785 } 11786 11787 /** 11788 * Reset the resolved layout direction. 11789 * 11790 * @hide 11791 */ 11792 public void resetResolvedPadding() { 11793 mPrivateFlags2 &= ~PFLAG2_PADDING_RESOLVED; 11794 } 11795 11796 /** 11797 * This is called when the view is detached from a window. At this point it 11798 * no longer has a surface for drawing. 11799 * 11800 * @see #onAttachedToWindow() 11801 */ 11802 protected void onDetachedFromWindow() { 11803 mPrivateFlags &= ~PFLAG_CANCEL_NEXT_UP_EVENT; 11804 11805 removeUnsetPressCallback(); 11806 removeLongPressCallback(); 11807 removePerformClickCallback(); 11808 removeSendViewScrolledAccessibilityEventCallback(); 11809 11810 destroyDrawingCache(); 11811 11812 destroyLayer(false); 11813 11814 if (mAttachInfo != null) { 11815 if (mDisplayList != null) { 11816 mAttachInfo.mViewRootImpl.enqueueDisplayList(mDisplayList); 11817 } 11818 mAttachInfo.mViewRootImpl.cancelInvalidate(this); 11819 } else { 11820 // Should never happen 11821 clearDisplayList(); 11822 } 11823 11824 mCurrentAnimation = null; 11825 11826 resetRtlProperties(); 11827 onRtlPropertiesChanged(LAYOUT_DIRECTION_DEFAULT); 11828 resetAccessibilityStateChanged(); 11829 } 11830 11831 /** 11832 * @return The number of times this view has been attached to a window 11833 */ 11834 protected int getWindowAttachCount() { 11835 return mWindowAttachCount; 11836 } 11837 11838 /** 11839 * Retrieve a unique token identifying the window this view is attached to. 11840 * @return Return the window's token for use in 11841 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 11842 */ 11843 public IBinder getWindowToken() { 11844 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 11845 } 11846 11847 /** 11848 * Retrieve a unique token identifying the top-level "real" window of 11849 * the window that this view is attached to. That is, this is like 11850 * {@link #getWindowToken}, except if the window this view in is a panel 11851 * window (attached to another containing window), then the token of 11852 * the containing window is returned instead. 11853 * 11854 * @return Returns the associated window token, either 11855 * {@link #getWindowToken()} or the containing window's token. 11856 */ 11857 public IBinder getApplicationWindowToken() { 11858 AttachInfo ai = mAttachInfo; 11859 if (ai != null) { 11860 IBinder appWindowToken = ai.mPanelParentWindowToken; 11861 if (appWindowToken == null) { 11862 appWindowToken = ai.mWindowToken; 11863 } 11864 return appWindowToken; 11865 } 11866 return null; 11867 } 11868 11869 /** 11870 * Gets the logical display to which the view's window has been attached. 11871 * 11872 * @return The logical display, or null if the view is not currently attached to a window. 11873 */ 11874 public Display getDisplay() { 11875 return mAttachInfo != null ? mAttachInfo.mDisplay : null; 11876 } 11877 11878 /** 11879 * Retrieve private session object this view hierarchy is using to 11880 * communicate with the window manager. 11881 * @return the session object to communicate with the window manager 11882 */ 11883 /*package*/ IWindowSession getWindowSession() { 11884 return mAttachInfo != null ? mAttachInfo.mSession : null; 11885 } 11886 11887 /** 11888 * @param info the {@link android.view.View.AttachInfo} to associated with 11889 * this view 11890 */ 11891 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 11892 //System.out.println("Attached! " + this); 11893 mAttachInfo = info; 11894 mWindowAttachCount++; 11895 // We will need to evaluate the drawable state at least once. 11896 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 11897 if (mFloatingTreeObserver != null) { 11898 info.mTreeObserver.merge(mFloatingTreeObserver); 11899 mFloatingTreeObserver = null; 11900 } 11901 if ((mPrivateFlags&PFLAG_SCROLL_CONTAINER) != 0) { 11902 mAttachInfo.mScrollContainers.add(this); 11903 mPrivateFlags |= PFLAG_SCROLL_CONTAINER_ADDED; 11904 } 11905 performCollectViewAttributes(mAttachInfo, visibility); 11906 onAttachedToWindow(); 11907 11908 ListenerInfo li = mListenerInfo; 11909 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 11910 li != null ? li.mOnAttachStateChangeListeners : null; 11911 if (listeners != null && listeners.size() > 0) { 11912 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 11913 // perform the dispatching. The iterator is a safe guard against listeners that 11914 // could mutate the list by calling the various add/remove methods. This prevents 11915 // the array from being modified while we iterate it. 11916 for (OnAttachStateChangeListener listener : listeners) { 11917 listener.onViewAttachedToWindow(this); 11918 } 11919 } 11920 11921 int vis = info.mWindowVisibility; 11922 if (vis != GONE) { 11923 onWindowVisibilityChanged(vis); 11924 } 11925 if ((mPrivateFlags&PFLAG_DRAWABLE_STATE_DIRTY) != 0) { 11926 // If nobody has evaluated the drawable state yet, then do it now. 11927 refreshDrawableState(); 11928 } 11929 needGlobalAttributesUpdate(false); 11930 } 11931 11932 void dispatchDetachedFromWindow() { 11933 AttachInfo info = mAttachInfo; 11934 if (info != null) { 11935 int vis = info.mWindowVisibility; 11936 if (vis != GONE) { 11937 onWindowVisibilityChanged(GONE); 11938 } 11939 } 11940 11941 onDetachedFromWindow(); 11942 11943 ListenerInfo li = mListenerInfo; 11944 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 11945 li != null ? li.mOnAttachStateChangeListeners : null; 11946 if (listeners != null && listeners.size() > 0) { 11947 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 11948 // perform the dispatching. The iterator is a safe guard against listeners that 11949 // could mutate the list by calling the various add/remove methods. This prevents 11950 // the array from being modified while we iterate it. 11951 for (OnAttachStateChangeListener listener : listeners) { 11952 listener.onViewDetachedFromWindow(this); 11953 } 11954 } 11955 11956 if ((mPrivateFlags & PFLAG_SCROLL_CONTAINER_ADDED) != 0) { 11957 mAttachInfo.mScrollContainers.remove(this); 11958 mPrivateFlags &= ~PFLAG_SCROLL_CONTAINER_ADDED; 11959 } 11960 11961 mAttachInfo = null; 11962 } 11963 11964 /** 11965 * Store this view hierarchy's frozen state into the given container. 11966 * 11967 * @param container The SparseArray in which to save the view's state. 11968 * 11969 * @see #restoreHierarchyState(android.util.SparseArray) 11970 * @see #dispatchSaveInstanceState(android.util.SparseArray) 11971 * @see #onSaveInstanceState() 11972 */ 11973 public void saveHierarchyState(SparseArray<Parcelable> container) { 11974 dispatchSaveInstanceState(container); 11975 } 11976 11977 /** 11978 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 11979 * this view and its children. May be overridden to modify how freezing happens to a 11980 * view's children; for example, some views may want to not store state for their children. 11981 * 11982 * @param container The SparseArray in which to save the view's state. 11983 * 11984 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 11985 * @see #saveHierarchyState(android.util.SparseArray) 11986 * @see #onSaveInstanceState() 11987 */ 11988 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 11989 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 11990 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 11991 Parcelable state = onSaveInstanceState(); 11992 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 11993 throw new IllegalStateException( 11994 "Derived class did not call super.onSaveInstanceState()"); 11995 } 11996 if (state != null) { 11997 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 11998 // + ": " + state); 11999 container.put(mID, state); 12000 } 12001 } 12002 } 12003 12004 /** 12005 * Hook allowing a view to generate a representation of its internal state 12006 * that can later be used to create a new instance with that same state. 12007 * This state should only contain information that is not persistent or can 12008 * not be reconstructed later. For example, you will never store your 12009 * current position on screen because that will be computed again when a 12010 * new instance of the view is placed in its view hierarchy. 12011 * <p> 12012 * Some examples of things you may store here: the current cursor position 12013 * in a text view (but usually not the text itself since that is stored in a 12014 * content provider or other persistent storage), the currently selected 12015 * item in a list view. 12016 * 12017 * @return Returns a Parcelable object containing the view's current dynamic 12018 * state, or null if there is nothing interesting to save. The 12019 * default implementation returns null. 12020 * @see #onRestoreInstanceState(android.os.Parcelable) 12021 * @see #saveHierarchyState(android.util.SparseArray) 12022 * @see #dispatchSaveInstanceState(android.util.SparseArray) 12023 * @see #setSaveEnabled(boolean) 12024 */ 12025 protected Parcelable onSaveInstanceState() { 12026 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 12027 return BaseSavedState.EMPTY_STATE; 12028 } 12029 12030 /** 12031 * Restore this view hierarchy's frozen state from the given container. 12032 * 12033 * @param container The SparseArray which holds previously frozen states. 12034 * 12035 * @see #saveHierarchyState(android.util.SparseArray) 12036 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 12037 * @see #onRestoreInstanceState(android.os.Parcelable) 12038 */ 12039 public void restoreHierarchyState(SparseArray<Parcelable> container) { 12040 dispatchRestoreInstanceState(container); 12041 } 12042 12043 /** 12044 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 12045 * state for this view and its children. May be overridden to modify how restoring 12046 * happens to a view's children; for example, some views may want to not store state 12047 * for their children. 12048 * 12049 * @param container The SparseArray which holds previously saved state. 12050 * 12051 * @see #dispatchSaveInstanceState(android.util.SparseArray) 12052 * @see #restoreHierarchyState(android.util.SparseArray) 12053 * @see #onRestoreInstanceState(android.os.Parcelable) 12054 */ 12055 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 12056 if (mID != NO_ID) { 12057 Parcelable state = container.get(mID); 12058 if (state != null) { 12059 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 12060 // + ": " + state); 12061 mPrivateFlags &= ~PFLAG_SAVE_STATE_CALLED; 12062 onRestoreInstanceState(state); 12063 if ((mPrivateFlags & PFLAG_SAVE_STATE_CALLED) == 0) { 12064 throw new IllegalStateException( 12065 "Derived class did not call super.onRestoreInstanceState()"); 12066 } 12067 } 12068 } 12069 } 12070 12071 /** 12072 * Hook allowing a view to re-apply a representation of its internal state that had previously 12073 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 12074 * null state. 12075 * 12076 * @param state The frozen state that had previously been returned by 12077 * {@link #onSaveInstanceState}. 12078 * 12079 * @see #onSaveInstanceState() 12080 * @see #restoreHierarchyState(android.util.SparseArray) 12081 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 12082 */ 12083 protected void onRestoreInstanceState(Parcelable state) { 12084 mPrivateFlags |= PFLAG_SAVE_STATE_CALLED; 12085 if (state != BaseSavedState.EMPTY_STATE && state != null) { 12086 throw new IllegalArgumentException("Wrong state class, expecting View State but " 12087 + "received " + state.getClass().toString() + " instead. This usually happens " 12088 + "when two views of different type have the same id in the same hierarchy. " 12089 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 12090 + "other views do not use the same id."); 12091 } 12092 } 12093 12094 /** 12095 * <p>Return the time at which the drawing of the view hierarchy started.</p> 12096 * 12097 * @return the drawing start time in milliseconds 12098 */ 12099 public long getDrawingTime() { 12100 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 12101 } 12102 12103 /** 12104 * <p>Enables or disables the duplication of the parent's state into this view. When 12105 * duplication is enabled, this view gets its drawable state from its parent rather 12106 * than from its own internal properties.</p> 12107 * 12108 * <p>Note: in the current implementation, setting this property to true after the 12109 * view was added to a ViewGroup might have no effect at all. This property should 12110 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 12111 * 12112 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 12113 * property is enabled, an exception will be thrown.</p> 12114 * 12115 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 12116 * parent, these states should not be affected by this method.</p> 12117 * 12118 * @param enabled True to enable duplication of the parent's drawable state, false 12119 * to disable it. 12120 * 12121 * @see #getDrawableState() 12122 * @see #isDuplicateParentStateEnabled() 12123 */ 12124 public void setDuplicateParentStateEnabled(boolean enabled) { 12125 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 12126 } 12127 12128 /** 12129 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 12130 * 12131 * @return True if this view's drawable state is duplicated from the parent, 12132 * false otherwise 12133 * 12134 * @see #getDrawableState() 12135 * @see #setDuplicateParentStateEnabled(boolean) 12136 */ 12137 public boolean isDuplicateParentStateEnabled() { 12138 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 12139 } 12140 12141 /** 12142 * <p>Specifies the type of layer backing this view. The layer can be 12143 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or 12144 * {@link #LAYER_TYPE_HARDWARE hardware}.</p> 12145 * 12146 * <p>A layer is associated with an optional {@link android.graphics.Paint} 12147 * instance that controls how the layer is composed on screen. The following 12148 * properties of the paint are taken into account when composing the layer:</p> 12149 * <ul> 12150 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 12151 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 12152 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 12153 * </ul> 12154 * 12155 * <p>If this view has an alpha value set to < 1.0 by calling 12156 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by 12157 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore 12158 * equivalent to setting a hardware layer on this view and providing a paint with 12159 * the desired alpha value.</p> 12160 * 12161 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled}, 12162 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware} 12163 * for more information on when and how to use layers.</p> 12164 * 12165 * @param layerType The type of layer to use with this view, must be one of 12166 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 12167 * {@link #LAYER_TYPE_HARDWARE} 12168 * @param paint The paint used to compose the layer. This argument is optional 12169 * and can be null. It is ignored when the layer type is 12170 * {@link #LAYER_TYPE_NONE} 12171 * 12172 * @see #getLayerType() 12173 * @see #LAYER_TYPE_NONE 12174 * @see #LAYER_TYPE_SOFTWARE 12175 * @see #LAYER_TYPE_HARDWARE 12176 * @see #setAlpha(float) 12177 * 12178 * @attr ref android.R.styleable#View_layerType 12179 */ 12180 public void setLayerType(int layerType, Paint paint) { 12181 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 12182 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 12183 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 12184 } 12185 12186 if (layerType == mLayerType) { 12187 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) { 12188 mLayerPaint = paint == null ? new Paint() : paint; 12189 invalidateParentCaches(); 12190 invalidate(true); 12191 } 12192 return; 12193 } 12194 12195 // Destroy any previous software drawing cache if needed 12196 switch (mLayerType) { 12197 case LAYER_TYPE_HARDWARE: 12198 destroyLayer(false); 12199 // fall through - non-accelerated views may use software layer mechanism instead 12200 case LAYER_TYPE_SOFTWARE: 12201 destroyDrawingCache(); 12202 break; 12203 default: 12204 break; 12205 } 12206 12207 mLayerType = layerType; 12208 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE; 12209 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 12210 mLocalDirtyRect = layerDisabled ? null : new Rect(); 12211 12212 invalidateParentCaches(); 12213 invalidate(true); 12214 } 12215 12216 /** 12217 * Updates the {@link Paint} object used with the current layer (used only if the current 12218 * layer type is not set to {@link #LAYER_TYPE_NONE}). Changed properties of the Paint 12219 * provided to {@link #setLayerType(int, android.graphics.Paint)} will be used the next time 12220 * the View is redrawn, but {@link #setLayerPaint(android.graphics.Paint)} must be called to 12221 * ensure that the view gets redrawn immediately. 12222 * 12223 * <p>A layer is associated with an optional {@link android.graphics.Paint} 12224 * instance that controls how the layer is composed on screen. The following 12225 * properties of the paint are taken into account when composing the layer:</p> 12226 * <ul> 12227 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 12228 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 12229 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 12230 * </ul> 12231 * 12232 * <p>If this view has an alpha value set to < 1.0 by calling 12233 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by 12234 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore 12235 * equivalent to setting a hardware layer on this view and providing a paint with 12236 * the desired alpha value.</p> 12237 * 12238 * @param paint The paint used to compose the layer. This argument is optional 12239 * and can be null. It is ignored when the layer type is 12240 * {@link #LAYER_TYPE_NONE} 12241 * 12242 * @see #setLayerType(int, android.graphics.Paint) 12243 */ 12244 public void setLayerPaint(Paint paint) { 12245 int layerType = getLayerType(); 12246 if (layerType != LAYER_TYPE_NONE) { 12247 mLayerPaint = paint == null ? new Paint() : paint; 12248 if (layerType == LAYER_TYPE_HARDWARE) { 12249 HardwareLayer layer = getHardwareLayer(); 12250 if (layer != null) { 12251 layer.setLayerPaint(paint); 12252 } 12253 invalidateViewProperty(false, false); 12254 } else { 12255 invalidate(); 12256 } 12257 } 12258 } 12259 12260 /** 12261 * Indicates whether this view has a static layer. A view with layer type 12262 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 12263 * dynamic. 12264 */ 12265 boolean hasStaticLayer() { 12266 return true; 12267 } 12268 12269 /** 12270 * Indicates what type of layer is currently associated with this view. By default 12271 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 12272 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 12273 * for more information on the different types of layers. 12274 * 12275 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 12276 * {@link #LAYER_TYPE_HARDWARE} 12277 * 12278 * @see #setLayerType(int, android.graphics.Paint) 12279 * @see #buildLayer() 12280 * @see #LAYER_TYPE_NONE 12281 * @see #LAYER_TYPE_SOFTWARE 12282 * @see #LAYER_TYPE_HARDWARE 12283 */ 12284 public int getLayerType() { 12285 return mLayerType; 12286 } 12287 12288 /** 12289 * Forces this view's layer to be created and this view to be rendered 12290 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 12291 * invoking this method will have no effect. 12292 * 12293 * This method can for instance be used to render a view into its layer before 12294 * starting an animation. If this view is complex, rendering into the layer 12295 * before starting the animation will avoid skipping frames. 12296 * 12297 * @throws IllegalStateException If this view is not attached to a window 12298 * 12299 * @see #setLayerType(int, android.graphics.Paint) 12300 */ 12301 public void buildLayer() { 12302 if (mLayerType == LAYER_TYPE_NONE) return; 12303 12304 if (mAttachInfo == null) { 12305 throw new IllegalStateException("This view must be attached to a window first"); 12306 } 12307 12308 switch (mLayerType) { 12309 case LAYER_TYPE_HARDWARE: 12310 if (mAttachInfo.mHardwareRenderer != null && 12311 mAttachInfo.mHardwareRenderer.isEnabled() && 12312 mAttachInfo.mHardwareRenderer.validate()) { 12313 getHardwareLayer(); 12314 } 12315 break; 12316 case LAYER_TYPE_SOFTWARE: 12317 buildDrawingCache(true); 12318 break; 12319 } 12320 } 12321 12322 /** 12323 * <p>Returns a hardware layer that can be used to draw this view again 12324 * without executing its draw method.</p> 12325 * 12326 * @return A HardwareLayer ready to render, or null if an error occurred. 12327 */ 12328 HardwareLayer getHardwareLayer() { 12329 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null || 12330 !mAttachInfo.mHardwareRenderer.isEnabled()) { 12331 return null; 12332 } 12333 12334 if (!mAttachInfo.mHardwareRenderer.validate()) return null; 12335 12336 final int width = mRight - mLeft; 12337 final int height = mBottom - mTop; 12338 12339 if (width == 0 || height == 0) { 12340 return null; 12341 } 12342 12343 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) { 12344 if (mHardwareLayer == null) { 12345 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer( 12346 width, height, isOpaque()); 12347 mLocalDirtyRect.set(0, 0, width, height); 12348 } else { 12349 if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) { 12350 if (mHardwareLayer.resize(width, height)) { 12351 mLocalDirtyRect.set(0, 0, width, height); 12352 } 12353 } 12354 12355 // This should not be necessary but applications that change 12356 // the parameters of their background drawable without calling 12357 // this.setBackground(Drawable) can leave the view in a bad state 12358 // (for instance isOpaque() returns true, but the background is 12359 // not opaque.) 12360 computeOpaqueFlags(); 12361 12362 final boolean opaque = isOpaque(); 12363 if (mHardwareLayer.isValid() && mHardwareLayer.isOpaque() != opaque) { 12364 mHardwareLayer.setOpaque(opaque); 12365 mLocalDirtyRect.set(0, 0, width, height); 12366 } 12367 } 12368 12369 // The layer is not valid if the underlying GPU resources cannot be allocated 12370 if (!mHardwareLayer.isValid()) { 12371 return null; 12372 } 12373 12374 mHardwareLayer.setLayerPaint(mLayerPaint); 12375 mHardwareLayer.redrawLater(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect); 12376 ViewRootImpl viewRoot = getViewRootImpl(); 12377 if (viewRoot != null) viewRoot.pushHardwareLayerUpdate(mHardwareLayer); 12378 12379 mLocalDirtyRect.setEmpty(); 12380 } 12381 12382 return mHardwareLayer; 12383 } 12384 12385 /** 12386 * Destroys this View's hardware layer if possible. 12387 * 12388 * @return True if the layer was destroyed, false otherwise. 12389 * 12390 * @see #setLayerType(int, android.graphics.Paint) 12391 * @see #LAYER_TYPE_HARDWARE 12392 */ 12393 boolean destroyLayer(boolean valid) { 12394 if (mHardwareLayer != null) { 12395 AttachInfo info = mAttachInfo; 12396 if (info != null && info.mHardwareRenderer != null && 12397 info.mHardwareRenderer.isEnabled() && 12398 (valid || info.mHardwareRenderer.validate())) { 12399 mHardwareLayer.destroy(); 12400 mHardwareLayer = null; 12401 12402 if (mDisplayList != null) { 12403 mDisplayList.reset(); 12404 } 12405 invalidate(true); 12406 invalidateParentCaches(); 12407 } 12408 return true; 12409 } 12410 return false; 12411 } 12412 12413 /** 12414 * Destroys all hardware rendering resources. This method is invoked 12415 * when the system needs to reclaim resources. Upon execution of this 12416 * method, you should free any OpenGL resources created by the view. 12417 * 12418 * Note: you <strong>must</strong> call 12419 * <code>super.destroyHardwareResources()</code> when overriding 12420 * this method. 12421 * 12422 * @hide 12423 */ 12424 protected void destroyHardwareResources() { 12425 destroyLayer(true); 12426 } 12427 12428 /** 12429 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 12430 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 12431 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 12432 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 12433 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 12434 * null.</p> 12435 * 12436 * <p>Enabling the drawing cache is similar to 12437 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 12438 * acceleration is turned off. When hardware acceleration is turned on, enabling the 12439 * drawing cache has no effect on rendering because the system uses a different mechanism 12440 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 12441 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 12442 * for information on how to enable software and hardware layers.</p> 12443 * 12444 * <p>This API can be used to manually generate 12445 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 12446 * {@link #getDrawingCache()}.</p> 12447 * 12448 * @param enabled true to enable the drawing cache, false otherwise 12449 * 12450 * @see #isDrawingCacheEnabled() 12451 * @see #getDrawingCache() 12452 * @see #buildDrawingCache() 12453 * @see #setLayerType(int, android.graphics.Paint) 12454 */ 12455 public void setDrawingCacheEnabled(boolean enabled) { 12456 mCachingFailed = false; 12457 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 12458 } 12459 12460 /** 12461 * <p>Indicates whether the drawing cache is enabled for this view.</p> 12462 * 12463 * @return true if the drawing cache is enabled 12464 * 12465 * @see #setDrawingCacheEnabled(boolean) 12466 * @see #getDrawingCache() 12467 */ 12468 @ViewDebug.ExportedProperty(category = "drawing") 12469 public boolean isDrawingCacheEnabled() { 12470 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 12471 } 12472 12473 /** 12474 * Debugging utility which recursively outputs the dirty state of a view and its 12475 * descendants. 12476 * 12477 * @hide 12478 */ 12479 @SuppressWarnings({"UnusedDeclaration"}) 12480 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 12481 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.PFLAG_DIRTY_MASK) + 12482 ") DRAWN(" + (mPrivateFlags & PFLAG_DRAWN) + ")" + " CACHE_VALID(" + 12483 (mPrivateFlags & View.PFLAG_DRAWING_CACHE_VALID) + 12484 ") INVALIDATED(" + (mPrivateFlags & PFLAG_INVALIDATED) + ")"); 12485 if (clear) { 12486 mPrivateFlags &= clearMask; 12487 } 12488 if (this instanceof ViewGroup) { 12489 ViewGroup parent = (ViewGroup) this; 12490 final int count = parent.getChildCount(); 12491 for (int i = 0; i < count; i++) { 12492 final View child = parent.getChildAt(i); 12493 child.outputDirtyFlags(indent + " ", clear, clearMask); 12494 } 12495 } 12496 } 12497 12498 /** 12499 * This method is used by ViewGroup to cause its children to restore or recreate their 12500 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 12501 * to recreate its own display list, which would happen if it went through the normal 12502 * draw/dispatchDraw mechanisms. 12503 * 12504 * @hide 12505 */ 12506 protected void dispatchGetDisplayList() {} 12507 12508 /** 12509 * A view that is not attached or hardware accelerated cannot create a display list. 12510 * This method checks these conditions and returns the appropriate result. 12511 * 12512 * @return true if view has the ability to create a display list, false otherwise. 12513 * 12514 * @hide 12515 */ 12516 public boolean canHaveDisplayList() { 12517 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 12518 } 12519 12520 /** 12521 * @return The HardwareRenderer associated with that view or null if hardware rendering 12522 * is not supported or this this has not been attached to a window. 12523 * 12524 * @hide 12525 */ 12526 public HardwareRenderer getHardwareRenderer() { 12527 if (mAttachInfo != null) { 12528 return mAttachInfo.mHardwareRenderer; 12529 } 12530 return null; 12531 } 12532 12533 /** 12534 * Returns a DisplayList. If the incoming displayList is null, one will be created. 12535 * Otherwise, the same display list will be returned (after having been rendered into 12536 * along the way, depending on the invalidation state of the view). 12537 * 12538 * @param displayList The previous version of this displayList, could be null. 12539 * @param isLayer Whether the requester of the display list is a layer. If so, 12540 * the view will avoid creating a layer inside the resulting display list. 12541 * @return A new or reused DisplayList object. 12542 */ 12543 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) { 12544 if (!canHaveDisplayList()) { 12545 return null; 12546 } 12547 12548 if (((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || 12549 displayList == null || !displayList.isValid() || 12550 (!isLayer && mRecreateDisplayList))) { 12551 // Don't need to recreate the display list, just need to tell our 12552 // children to restore/recreate theirs 12553 if (displayList != null && displayList.isValid() && 12554 !isLayer && !mRecreateDisplayList) { 12555 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 12556 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 12557 dispatchGetDisplayList(); 12558 12559 return displayList; 12560 } 12561 12562 if (!isLayer) { 12563 // If we got here, we're recreating it. Mark it as such to ensure that 12564 // we copy in child display lists into ours in drawChild() 12565 mRecreateDisplayList = true; 12566 } 12567 if (displayList == null) { 12568 final String name = getClass().getSimpleName(); 12569 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name); 12570 // If we're creating a new display list, make sure our parent gets invalidated 12571 // since they will need to recreate their display list to account for this 12572 // new child display list. 12573 invalidateParentCaches(); 12574 } 12575 12576 boolean caching = false; 12577 final HardwareCanvas canvas = displayList.start(); 12578 int width = mRight - mLeft; 12579 int height = mBottom - mTop; 12580 12581 try { 12582 canvas.setViewport(width, height); 12583 // The dirty rect should always be null for a display list 12584 canvas.onPreDraw(null); 12585 int layerType = getLayerType(); 12586 if (!isLayer && layerType != LAYER_TYPE_NONE) { 12587 if (layerType == LAYER_TYPE_HARDWARE) { 12588 final HardwareLayer layer = getHardwareLayer(); 12589 if (layer != null && layer.isValid()) { 12590 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint); 12591 } else { 12592 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint, 12593 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | 12594 Canvas.CLIP_TO_LAYER_SAVE_FLAG); 12595 } 12596 caching = true; 12597 } else { 12598 buildDrawingCache(true); 12599 Bitmap cache = getDrawingCache(true); 12600 if (cache != null) { 12601 canvas.drawBitmap(cache, 0, 0, mLayerPaint); 12602 caching = true; 12603 } 12604 } 12605 } else { 12606 12607 computeScroll(); 12608 12609 canvas.translate(-mScrollX, -mScrollY); 12610 if (!isLayer) { 12611 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 12612 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 12613 } 12614 12615 // Fast path for layouts with no backgrounds 12616 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 12617 dispatchDraw(canvas); 12618 } else { 12619 draw(canvas); 12620 } 12621 } 12622 } finally { 12623 canvas.onPostDraw(); 12624 12625 displayList.end(); 12626 displayList.setCaching(caching); 12627 if (isLayer) { 12628 displayList.setLeftTopRightBottom(0, 0, width, height); 12629 } else { 12630 setDisplayListProperties(displayList); 12631 } 12632 } 12633 } else if (!isLayer) { 12634 mPrivateFlags |= PFLAG_DRAWN | PFLAG_DRAWING_CACHE_VALID; 12635 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 12636 } 12637 12638 return displayList; 12639 } 12640 12641 /** 12642 * Get the DisplayList for the HardwareLayer 12643 * 12644 * @param layer The HardwareLayer whose DisplayList we want 12645 * @return A DisplayList fopr the specified HardwareLayer 12646 */ 12647 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) { 12648 DisplayList displayList = getDisplayList(layer.getDisplayList(), true); 12649 layer.setDisplayList(displayList); 12650 return displayList; 12651 } 12652 12653 12654 /** 12655 * <p>Returns a display list that can be used to draw this view again 12656 * without executing its draw method.</p> 12657 * 12658 * @return A DisplayList ready to replay, or null if caching is not enabled. 12659 * 12660 * @hide 12661 */ 12662 public DisplayList getDisplayList() { 12663 mDisplayList = getDisplayList(mDisplayList, false); 12664 return mDisplayList; 12665 } 12666 12667 private void clearDisplayList() { 12668 if (mDisplayList != null) { 12669 mDisplayList.invalidate(); 12670 mDisplayList.clear(); 12671 } 12672 } 12673 12674 /** 12675 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 12676 * 12677 * @return A non-scaled bitmap representing this view or null if cache is disabled. 12678 * 12679 * @see #getDrawingCache(boolean) 12680 */ 12681 public Bitmap getDrawingCache() { 12682 return getDrawingCache(false); 12683 } 12684 12685 /** 12686 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 12687 * is null when caching is disabled. If caching is enabled and the cache is not ready, 12688 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 12689 * draw from the cache when the cache is enabled. To benefit from the cache, you must 12690 * request the drawing cache by calling this method and draw it on screen if the 12691 * returned bitmap is not null.</p> 12692 * 12693 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 12694 * this method will create a bitmap of the same size as this view. Because this bitmap 12695 * will be drawn scaled by the parent ViewGroup, the result on screen might show 12696 * scaling artifacts. To avoid such artifacts, you should call this method by setting 12697 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 12698 * size than the view. This implies that your application must be able to handle this 12699 * size.</p> 12700 * 12701 * @param autoScale Indicates whether the generated bitmap should be scaled based on 12702 * the current density of the screen when the application is in compatibility 12703 * mode. 12704 * 12705 * @return A bitmap representing this view or null if cache is disabled. 12706 * 12707 * @see #setDrawingCacheEnabled(boolean) 12708 * @see #isDrawingCacheEnabled() 12709 * @see #buildDrawingCache(boolean) 12710 * @see #destroyDrawingCache() 12711 */ 12712 public Bitmap getDrawingCache(boolean autoScale) { 12713 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 12714 return null; 12715 } 12716 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 12717 buildDrawingCache(autoScale); 12718 } 12719 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 12720 } 12721 12722 /** 12723 * <p>Frees the resources used by the drawing cache. If you call 12724 * {@link #buildDrawingCache()} manually without calling 12725 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 12726 * should cleanup the cache with this method afterwards.</p> 12727 * 12728 * @see #setDrawingCacheEnabled(boolean) 12729 * @see #buildDrawingCache() 12730 * @see #getDrawingCache() 12731 */ 12732 public void destroyDrawingCache() { 12733 if (mDrawingCache != null) { 12734 mDrawingCache.recycle(); 12735 mDrawingCache = null; 12736 } 12737 if (mUnscaledDrawingCache != null) { 12738 mUnscaledDrawingCache.recycle(); 12739 mUnscaledDrawingCache = null; 12740 } 12741 } 12742 12743 /** 12744 * Setting a solid background color for the drawing cache's bitmaps will improve 12745 * performance and memory usage. Note, though that this should only be used if this 12746 * view will always be drawn on top of a solid color. 12747 * 12748 * @param color The background color to use for the drawing cache's bitmap 12749 * 12750 * @see #setDrawingCacheEnabled(boolean) 12751 * @see #buildDrawingCache() 12752 * @see #getDrawingCache() 12753 */ 12754 public void setDrawingCacheBackgroundColor(int color) { 12755 if (color != mDrawingCacheBackgroundColor) { 12756 mDrawingCacheBackgroundColor = color; 12757 mPrivateFlags &= ~PFLAG_DRAWING_CACHE_VALID; 12758 } 12759 } 12760 12761 /** 12762 * @see #setDrawingCacheBackgroundColor(int) 12763 * 12764 * @return The background color to used for the drawing cache's bitmap 12765 */ 12766 public int getDrawingCacheBackgroundColor() { 12767 return mDrawingCacheBackgroundColor; 12768 } 12769 12770 /** 12771 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 12772 * 12773 * @see #buildDrawingCache(boolean) 12774 */ 12775 public void buildDrawingCache() { 12776 buildDrawingCache(false); 12777 } 12778 12779 /** 12780 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 12781 * 12782 * <p>If you call {@link #buildDrawingCache()} manually without calling 12783 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 12784 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 12785 * 12786 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 12787 * this method will create a bitmap of the same size as this view. Because this bitmap 12788 * will be drawn scaled by the parent ViewGroup, the result on screen might show 12789 * scaling artifacts. To avoid such artifacts, you should call this method by setting 12790 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 12791 * size than the view. This implies that your application must be able to handle this 12792 * size.</p> 12793 * 12794 * <p>You should avoid calling this method when hardware acceleration is enabled. If 12795 * you do not need the drawing cache bitmap, calling this method will increase memory 12796 * usage and cause the view to be rendered in software once, thus negatively impacting 12797 * performance.</p> 12798 * 12799 * @see #getDrawingCache() 12800 * @see #destroyDrawingCache() 12801 */ 12802 public void buildDrawingCache(boolean autoScale) { 12803 if ((mPrivateFlags & PFLAG_DRAWING_CACHE_VALID) == 0 || (autoScale ? 12804 mDrawingCache == null : mUnscaledDrawingCache == null)) { 12805 mCachingFailed = false; 12806 12807 int width = mRight - mLeft; 12808 int height = mBottom - mTop; 12809 12810 final AttachInfo attachInfo = mAttachInfo; 12811 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 12812 12813 if (autoScale && scalingRequired) { 12814 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 12815 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 12816 } 12817 12818 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 12819 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 12820 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 12821 12822 final long projectedBitmapSize = width * height * (opaque && !use32BitCache ? 2 : 4); 12823 final long drawingCacheSize = 12824 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize(); 12825 if (width <= 0 || height <= 0 || projectedBitmapSize > drawingCacheSize) { 12826 if (width > 0 && height > 0) { 12827 Log.w(VIEW_LOG_TAG, "View too large to fit into drawing cache, needs " 12828 + projectedBitmapSize + " bytes, only " 12829 + drawingCacheSize + " available"); 12830 } 12831 destroyDrawingCache(); 12832 mCachingFailed = true; 12833 return; 12834 } 12835 12836 boolean clear = true; 12837 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 12838 12839 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 12840 Bitmap.Config quality; 12841 if (!opaque) { 12842 // Never pick ARGB_4444 because it looks awful 12843 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 12844 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 12845 case DRAWING_CACHE_QUALITY_AUTO: 12846 quality = Bitmap.Config.ARGB_8888; 12847 break; 12848 case DRAWING_CACHE_QUALITY_LOW: 12849 quality = Bitmap.Config.ARGB_8888; 12850 break; 12851 case DRAWING_CACHE_QUALITY_HIGH: 12852 quality = Bitmap.Config.ARGB_8888; 12853 break; 12854 default: 12855 quality = Bitmap.Config.ARGB_8888; 12856 break; 12857 } 12858 } else { 12859 // Optimization for translucent windows 12860 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 12861 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 12862 } 12863 12864 // Try to cleanup memory 12865 if (bitmap != null) bitmap.recycle(); 12866 12867 try { 12868 bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 12869 width, height, quality); 12870 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 12871 if (autoScale) { 12872 mDrawingCache = bitmap; 12873 } else { 12874 mUnscaledDrawingCache = bitmap; 12875 } 12876 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 12877 } catch (OutOfMemoryError e) { 12878 // If there is not enough memory to create the bitmap cache, just 12879 // ignore the issue as bitmap caches are not required to draw the 12880 // view hierarchy 12881 if (autoScale) { 12882 mDrawingCache = null; 12883 } else { 12884 mUnscaledDrawingCache = null; 12885 } 12886 mCachingFailed = true; 12887 return; 12888 } 12889 12890 clear = drawingCacheBackgroundColor != 0; 12891 } 12892 12893 Canvas canvas; 12894 if (attachInfo != null) { 12895 canvas = attachInfo.mCanvas; 12896 if (canvas == null) { 12897 canvas = new Canvas(); 12898 } 12899 canvas.setBitmap(bitmap); 12900 // Temporarily clobber the cached Canvas in case one of our children 12901 // is also using a drawing cache. Without this, the children would 12902 // steal the canvas by attaching their own bitmap to it and bad, bad 12903 // thing would happen (invisible views, corrupted drawings, etc.) 12904 attachInfo.mCanvas = null; 12905 } else { 12906 // This case should hopefully never or seldom happen 12907 canvas = new Canvas(bitmap); 12908 } 12909 12910 if (clear) { 12911 bitmap.eraseColor(drawingCacheBackgroundColor); 12912 } 12913 12914 computeScroll(); 12915 final int restoreCount = canvas.save(); 12916 12917 if (autoScale && scalingRequired) { 12918 final float scale = attachInfo.mApplicationScale; 12919 canvas.scale(scale, scale); 12920 } 12921 12922 canvas.translate(-mScrollX, -mScrollY); 12923 12924 mPrivateFlags |= PFLAG_DRAWN; 12925 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 12926 mLayerType != LAYER_TYPE_NONE) { 12927 mPrivateFlags |= PFLAG_DRAWING_CACHE_VALID; 12928 } 12929 12930 // Fast path for layouts with no backgrounds 12931 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 12932 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 12933 dispatchDraw(canvas); 12934 } else { 12935 draw(canvas); 12936 } 12937 12938 canvas.restoreToCount(restoreCount); 12939 canvas.setBitmap(null); 12940 12941 if (attachInfo != null) { 12942 // Restore the cached Canvas for our siblings 12943 attachInfo.mCanvas = canvas; 12944 } 12945 } 12946 } 12947 12948 /** 12949 * Create a snapshot of the view into a bitmap. We should probably make 12950 * some form of this public, but should think about the API. 12951 */ 12952 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 12953 int width = mRight - mLeft; 12954 int height = mBottom - mTop; 12955 12956 final AttachInfo attachInfo = mAttachInfo; 12957 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 12958 width = (int) ((width * scale) + 0.5f); 12959 height = (int) ((height * scale) + 0.5f); 12960 12961 Bitmap bitmap = Bitmap.createBitmap(mResources.getDisplayMetrics(), 12962 width > 0 ? width : 1, height > 0 ? height : 1, quality); 12963 if (bitmap == null) { 12964 throw new OutOfMemoryError(); 12965 } 12966 12967 Resources resources = getResources(); 12968 if (resources != null) { 12969 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 12970 } 12971 12972 Canvas canvas; 12973 if (attachInfo != null) { 12974 canvas = attachInfo.mCanvas; 12975 if (canvas == null) { 12976 canvas = new Canvas(); 12977 } 12978 canvas.setBitmap(bitmap); 12979 // Temporarily clobber the cached Canvas in case one of our children 12980 // is also using a drawing cache. Without this, the children would 12981 // steal the canvas by attaching their own bitmap to it and bad, bad 12982 // things would happen (invisible views, corrupted drawings, etc.) 12983 attachInfo.mCanvas = null; 12984 } else { 12985 // This case should hopefully never or seldom happen 12986 canvas = new Canvas(bitmap); 12987 } 12988 12989 if ((backgroundColor & 0xff000000) != 0) { 12990 bitmap.eraseColor(backgroundColor); 12991 } 12992 12993 computeScroll(); 12994 final int restoreCount = canvas.save(); 12995 canvas.scale(scale, scale); 12996 canvas.translate(-mScrollX, -mScrollY); 12997 12998 // Temporarily remove the dirty mask 12999 int flags = mPrivateFlags; 13000 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 13001 13002 // Fast path for layouts with no backgrounds 13003 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 13004 dispatchDraw(canvas); 13005 } else { 13006 draw(canvas); 13007 } 13008 13009 mPrivateFlags = flags; 13010 13011 canvas.restoreToCount(restoreCount); 13012 canvas.setBitmap(null); 13013 13014 if (attachInfo != null) { 13015 // Restore the cached Canvas for our siblings 13016 attachInfo.mCanvas = canvas; 13017 } 13018 13019 return bitmap; 13020 } 13021 13022 /** 13023 * Indicates whether this View is currently in edit mode. A View is usually 13024 * in edit mode when displayed within a developer tool. For instance, if 13025 * this View is being drawn by a visual user interface builder, this method 13026 * should return true. 13027 * 13028 * Subclasses should check the return value of this method to provide 13029 * different behaviors if their normal behavior might interfere with the 13030 * host environment. For instance: the class spawns a thread in its 13031 * constructor, the drawing code relies on device-specific features, etc. 13032 * 13033 * This method is usually checked in the drawing code of custom widgets. 13034 * 13035 * @return True if this View is in edit mode, false otherwise. 13036 */ 13037 public boolean isInEditMode() { 13038 return false; 13039 } 13040 13041 /** 13042 * If the View draws content inside its padding and enables fading edges, 13043 * it needs to support padding offsets. Padding offsets are added to the 13044 * fading edges to extend the length of the fade so that it covers pixels 13045 * drawn inside the padding. 13046 * 13047 * Subclasses of this class should override this method if they need 13048 * to draw content inside the padding. 13049 * 13050 * @return True if padding offset must be applied, false otherwise. 13051 * 13052 * @see #getLeftPaddingOffset() 13053 * @see #getRightPaddingOffset() 13054 * @see #getTopPaddingOffset() 13055 * @see #getBottomPaddingOffset() 13056 * 13057 * @since CURRENT 13058 */ 13059 protected boolean isPaddingOffsetRequired() { 13060 return false; 13061 } 13062 13063 /** 13064 * Amount by which to extend the left fading region. Called only when 13065 * {@link #isPaddingOffsetRequired()} returns true. 13066 * 13067 * @return The left padding offset in pixels. 13068 * 13069 * @see #isPaddingOffsetRequired() 13070 * 13071 * @since CURRENT 13072 */ 13073 protected int getLeftPaddingOffset() { 13074 return 0; 13075 } 13076 13077 /** 13078 * Amount by which to extend the right fading region. Called only when 13079 * {@link #isPaddingOffsetRequired()} returns true. 13080 * 13081 * @return The right padding offset in pixels. 13082 * 13083 * @see #isPaddingOffsetRequired() 13084 * 13085 * @since CURRENT 13086 */ 13087 protected int getRightPaddingOffset() { 13088 return 0; 13089 } 13090 13091 /** 13092 * Amount by which to extend the top fading region. Called only when 13093 * {@link #isPaddingOffsetRequired()} returns true. 13094 * 13095 * @return The top padding offset in pixels. 13096 * 13097 * @see #isPaddingOffsetRequired() 13098 * 13099 * @since CURRENT 13100 */ 13101 protected int getTopPaddingOffset() { 13102 return 0; 13103 } 13104 13105 /** 13106 * Amount by which to extend the bottom fading region. Called only when 13107 * {@link #isPaddingOffsetRequired()} returns true. 13108 * 13109 * @return The bottom padding offset in pixels. 13110 * 13111 * @see #isPaddingOffsetRequired() 13112 * 13113 * @since CURRENT 13114 */ 13115 protected int getBottomPaddingOffset() { 13116 return 0; 13117 } 13118 13119 /** 13120 * @hide 13121 * @param offsetRequired 13122 */ 13123 protected int getFadeTop(boolean offsetRequired) { 13124 int top = mPaddingTop; 13125 if (offsetRequired) top += getTopPaddingOffset(); 13126 return top; 13127 } 13128 13129 /** 13130 * @hide 13131 * @param offsetRequired 13132 */ 13133 protected int getFadeHeight(boolean offsetRequired) { 13134 int padding = mPaddingTop; 13135 if (offsetRequired) padding += getTopPaddingOffset(); 13136 return mBottom - mTop - mPaddingBottom - padding; 13137 } 13138 13139 /** 13140 * <p>Indicates whether this view is attached to a hardware accelerated 13141 * window or not.</p> 13142 * 13143 * <p>Even if this method returns true, it does not mean that every call 13144 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 13145 * accelerated {@link android.graphics.Canvas}. For instance, if this view 13146 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its 13147 * window is hardware accelerated, 13148 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 13149 * return false, and this method will return true.</p> 13150 * 13151 * @return True if the view is attached to a window and the window is 13152 * hardware accelerated; false in any other case. 13153 */ 13154 public boolean isHardwareAccelerated() { 13155 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 13156 } 13157 13158 /** 13159 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common 13160 * case of an active Animation being run on the view. 13161 */ 13162 private boolean drawAnimation(ViewGroup parent, long drawingTime, 13163 Animation a, boolean scalingRequired) { 13164 Transformation invalidationTransform; 13165 final int flags = parent.mGroupFlags; 13166 final boolean initialized = a.isInitialized(); 13167 if (!initialized) { 13168 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight()); 13169 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop); 13170 if (mAttachInfo != null) a.setListenerHandler(mAttachInfo.mHandler); 13171 onAnimationStart(); 13172 } 13173 13174 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f); 13175 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) { 13176 if (parent.mInvalidationTransformation == null) { 13177 parent.mInvalidationTransformation = new Transformation(); 13178 } 13179 invalidationTransform = parent.mInvalidationTransformation; 13180 a.getTransformation(drawingTime, invalidationTransform, 1f); 13181 } else { 13182 invalidationTransform = parent.mChildTransformation; 13183 } 13184 13185 if (more) { 13186 if (!a.willChangeBounds()) { 13187 if ((flags & (ViewGroup.FLAG_OPTIMIZE_INVALIDATE | ViewGroup.FLAG_ANIMATION_DONE)) == 13188 ViewGroup.FLAG_OPTIMIZE_INVALIDATE) { 13189 parent.mGroupFlags |= ViewGroup.FLAG_INVALIDATE_REQUIRED; 13190 } else if ((flags & ViewGroup.FLAG_INVALIDATE_REQUIRED) == 0) { 13191 // The child need to draw an animation, potentially offscreen, so 13192 // make sure we do not cancel invalidate requests 13193 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 13194 parent.invalidate(mLeft, mTop, mRight, mBottom); 13195 } 13196 } else { 13197 if (parent.mInvalidateRegion == null) { 13198 parent.mInvalidateRegion = new RectF(); 13199 } 13200 final RectF region = parent.mInvalidateRegion; 13201 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region, 13202 invalidationTransform); 13203 13204 // The child need to draw an animation, potentially offscreen, so 13205 // make sure we do not cancel invalidate requests 13206 parent.mPrivateFlags |= PFLAG_DRAW_ANIMATION; 13207 13208 final int left = mLeft + (int) region.left; 13209 final int top = mTop + (int) region.top; 13210 parent.invalidate(left, top, left + (int) (region.width() + .5f), 13211 top + (int) (region.height() + .5f)); 13212 } 13213 } 13214 return more; 13215 } 13216 13217 /** 13218 * This method is called by getDisplayList() when a display list is created or re-rendered. 13219 * It sets or resets the current value of all properties on that display list (resetting is 13220 * necessary when a display list is being re-created, because we need to make sure that 13221 * previously-set transform values 13222 */ 13223 void setDisplayListProperties(DisplayList displayList) { 13224 if (displayList != null) { 13225 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 13226 displayList.setHasOverlappingRendering(hasOverlappingRendering()); 13227 if (mParent instanceof ViewGroup) { 13228 displayList.setClipChildren( 13229 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0); 13230 } 13231 float alpha = 1; 13232 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags & 13233 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 13234 ViewGroup parentVG = (ViewGroup) mParent; 13235 final boolean hasTransform = 13236 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation); 13237 if (hasTransform) { 13238 Transformation transform = parentVG.mChildTransformation; 13239 final int transformType = parentVG.mChildTransformation.getTransformationType(); 13240 if (transformType != Transformation.TYPE_IDENTITY) { 13241 if ((transformType & Transformation.TYPE_ALPHA) != 0) { 13242 alpha = transform.getAlpha(); 13243 } 13244 if ((transformType & Transformation.TYPE_MATRIX) != 0) { 13245 displayList.setStaticMatrix(transform.getMatrix()); 13246 } 13247 } 13248 } 13249 } 13250 if (mTransformationInfo != null) { 13251 alpha *= mTransformationInfo.mAlpha; 13252 if (alpha < 1) { 13253 final int multipliedAlpha = (int) (255 * alpha); 13254 if (onSetAlpha(multipliedAlpha)) { 13255 alpha = 1; 13256 } 13257 } 13258 displayList.setTransformationInfo(alpha, 13259 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY, 13260 mTransformationInfo.mRotation, mTransformationInfo.mRotationX, 13261 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX, 13262 mTransformationInfo.mScaleY); 13263 if (mTransformationInfo.mCamera == null) { 13264 mTransformationInfo.mCamera = new Camera(); 13265 mTransformationInfo.matrix3D = new Matrix(); 13266 } 13267 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ()); 13268 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == PFLAG_PIVOT_EXPLICITLY_SET) { 13269 displayList.setPivotX(getPivotX()); 13270 displayList.setPivotY(getPivotY()); 13271 } 13272 } else if (alpha < 1) { 13273 displayList.setAlpha(alpha); 13274 } 13275 } 13276 } 13277 13278 /** 13279 * This method is called by ViewGroup.drawChild() to have each child view draw itself. 13280 * This draw() method is an implementation detail and is not intended to be overridden or 13281 * to be called from anywhere else other than ViewGroup.drawChild(). 13282 */ 13283 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) { 13284 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 13285 boolean more = false; 13286 final boolean childHasIdentityMatrix = hasIdentityMatrix(); 13287 final int flags = parent.mGroupFlags; 13288 13289 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) { 13290 parent.mChildTransformation.clear(); 13291 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION; 13292 } 13293 13294 Transformation transformToApply = null; 13295 boolean concatMatrix = false; 13296 13297 boolean scalingRequired = false; 13298 boolean caching; 13299 int layerType = getLayerType(); 13300 13301 final boolean hardwareAccelerated = canvas.isHardwareAccelerated(); 13302 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 || 13303 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) { 13304 caching = true; 13305 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList 13306 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired; 13307 } else { 13308 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated; 13309 } 13310 13311 final Animation a = getAnimation(); 13312 if (a != null) { 13313 more = drawAnimation(parent, drawingTime, a, scalingRequired); 13314 concatMatrix = a.willChangeTransformationMatrix(); 13315 if (concatMatrix) { 13316 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 13317 } 13318 transformToApply = parent.mChildTransformation; 13319 } else { 13320 if ((mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_TRANSFORM) == PFLAG3_VIEW_IS_ANIMATING_TRANSFORM && 13321 mDisplayList != null) { 13322 // No longer animating: clear out old animation matrix 13323 mDisplayList.setAnimationMatrix(null); 13324 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_TRANSFORM; 13325 } 13326 if (!useDisplayListProperties && 13327 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 13328 final boolean hasTransform = 13329 parent.getChildStaticTransformation(this, parent.mChildTransformation); 13330 if (hasTransform) { 13331 final int transformType = parent.mChildTransformation.getTransformationType(); 13332 transformToApply = transformType != Transformation.TYPE_IDENTITY ? 13333 parent.mChildTransformation : null; 13334 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0; 13335 } 13336 } 13337 } 13338 13339 concatMatrix |= !childHasIdentityMatrix; 13340 13341 // Sets the flag as early as possible to allow draw() implementations 13342 // to call invalidate() successfully when doing animations 13343 mPrivateFlags |= PFLAG_DRAWN; 13344 13345 if (!concatMatrix && 13346 (flags & (ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS | 13347 ViewGroup.FLAG_CLIP_CHILDREN)) == ViewGroup.FLAG_CLIP_CHILDREN && 13348 canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) && 13349 (mPrivateFlags & PFLAG_DRAW_ANIMATION) == 0) { 13350 mPrivateFlags2 |= PFLAG2_VIEW_QUICK_REJECTED; 13351 return more; 13352 } 13353 mPrivateFlags2 &= ~PFLAG2_VIEW_QUICK_REJECTED; 13354 13355 if (hardwareAccelerated) { 13356 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but 13357 // retain the flag's value temporarily in the mRecreateDisplayList flag 13358 mRecreateDisplayList = (mPrivateFlags & PFLAG_INVALIDATED) == PFLAG_INVALIDATED; 13359 mPrivateFlags &= ~PFLAG_INVALIDATED; 13360 } 13361 13362 DisplayList displayList = null; 13363 Bitmap cache = null; 13364 boolean hasDisplayList = false; 13365 if (caching) { 13366 if (!hardwareAccelerated) { 13367 if (layerType != LAYER_TYPE_NONE) { 13368 layerType = LAYER_TYPE_SOFTWARE; 13369 buildDrawingCache(true); 13370 } 13371 cache = getDrawingCache(true); 13372 } else { 13373 switch (layerType) { 13374 case LAYER_TYPE_SOFTWARE: 13375 if (useDisplayListProperties) { 13376 hasDisplayList = canHaveDisplayList(); 13377 } else { 13378 buildDrawingCache(true); 13379 cache = getDrawingCache(true); 13380 } 13381 break; 13382 case LAYER_TYPE_HARDWARE: 13383 if (useDisplayListProperties) { 13384 hasDisplayList = canHaveDisplayList(); 13385 } 13386 break; 13387 case LAYER_TYPE_NONE: 13388 // Delay getting the display list until animation-driven alpha values are 13389 // set up and possibly passed on to the view 13390 hasDisplayList = canHaveDisplayList(); 13391 break; 13392 } 13393 } 13394 } 13395 useDisplayListProperties &= hasDisplayList; 13396 if (useDisplayListProperties) { 13397 displayList = getDisplayList(); 13398 if (!displayList.isValid()) { 13399 // Uncommon, but possible. If a view is removed from the hierarchy during the call 13400 // to getDisplayList(), the display list will be marked invalid and we should not 13401 // try to use it again. 13402 displayList = null; 13403 hasDisplayList = false; 13404 useDisplayListProperties = false; 13405 } 13406 } 13407 13408 int sx = 0; 13409 int sy = 0; 13410 if (!hasDisplayList) { 13411 computeScroll(); 13412 sx = mScrollX; 13413 sy = mScrollY; 13414 } 13415 13416 final boolean hasNoCache = cache == null || hasDisplayList; 13417 final boolean offsetForScroll = cache == null && !hasDisplayList && 13418 layerType != LAYER_TYPE_HARDWARE; 13419 13420 int restoreTo = -1; 13421 if (!useDisplayListProperties || transformToApply != null) { 13422 restoreTo = canvas.save(); 13423 } 13424 if (offsetForScroll) { 13425 canvas.translate(mLeft - sx, mTop - sy); 13426 } else { 13427 if (!useDisplayListProperties) { 13428 canvas.translate(mLeft, mTop); 13429 } 13430 if (scalingRequired) { 13431 if (useDisplayListProperties) { 13432 // TODO: Might not need this if we put everything inside the DL 13433 restoreTo = canvas.save(); 13434 } 13435 // mAttachInfo cannot be null, otherwise scalingRequired == false 13436 final float scale = 1.0f / mAttachInfo.mApplicationScale; 13437 canvas.scale(scale, scale); 13438 } 13439 } 13440 13441 float alpha = useDisplayListProperties ? 1 : getAlpha(); 13442 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix() || 13443 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 13444 if (transformToApply != null || !childHasIdentityMatrix) { 13445 int transX = 0; 13446 int transY = 0; 13447 13448 if (offsetForScroll) { 13449 transX = -sx; 13450 transY = -sy; 13451 } 13452 13453 if (transformToApply != null) { 13454 if (concatMatrix) { 13455 if (useDisplayListProperties) { 13456 displayList.setAnimationMatrix(transformToApply.getMatrix()); 13457 } else { 13458 // Undo the scroll translation, apply the transformation matrix, 13459 // then redo the scroll translate to get the correct result. 13460 canvas.translate(-transX, -transY); 13461 canvas.concat(transformToApply.getMatrix()); 13462 canvas.translate(transX, transY); 13463 } 13464 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 13465 } 13466 13467 float transformAlpha = transformToApply.getAlpha(); 13468 if (transformAlpha < 1) { 13469 alpha *= transformAlpha; 13470 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 13471 } 13472 } 13473 13474 if (!childHasIdentityMatrix && !useDisplayListProperties) { 13475 canvas.translate(-transX, -transY); 13476 canvas.concat(getMatrix()); 13477 canvas.translate(transX, transY); 13478 } 13479 } 13480 13481 // Deal with alpha if it is or used to be <1 13482 if (alpha < 1 || 13483 (mPrivateFlags3 & PFLAG3_VIEW_IS_ANIMATING_ALPHA) == PFLAG3_VIEW_IS_ANIMATING_ALPHA) { 13484 if (alpha < 1) { 13485 mPrivateFlags3 |= PFLAG3_VIEW_IS_ANIMATING_ALPHA; 13486 } else { 13487 mPrivateFlags3 &= ~PFLAG3_VIEW_IS_ANIMATING_ALPHA; 13488 } 13489 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 13490 if (hasNoCache) { 13491 final int multipliedAlpha = (int) (255 * alpha); 13492 if (!onSetAlpha(multipliedAlpha)) { 13493 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 13494 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 || 13495 layerType != LAYER_TYPE_NONE) { 13496 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG; 13497 } 13498 if (useDisplayListProperties) { 13499 displayList.setAlpha(alpha * getAlpha()); 13500 } else if (layerType == LAYER_TYPE_NONE) { 13501 final int scrollX = hasDisplayList ? 0 : sx; 13502 final int scrollY = hasDisplayList ? 0 : sy; 13503 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft, 13504 scrollY + mBottom - mTop, multipliedAlpha, layerFlags); 13505 } 13506 } else { 13507 // Alpha is handled by the child directly, clobber the layer's alpha 13508 mPrivateFlags |= PFLAG_ALPHA_SET; 13509 } 13510 } 13511 } 13512 } else if ((mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 13513 onSetAlpha(255); 13514 mPrivateFlags &= ~PFLAG_ALPHA_SET; 13515 } 13516 13517 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN && 13518 !useDisplayListProperties) { 13519 if (offsetForScroll) { 13520 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop)); 13521 } else { 13522 if (!scalingRequired || cache == null) { 13523 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop); 13524 } else { 13525 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight()); 13526 } 13527 } 13528 } 13529 13530 if (!useDisplayListProperties && hasDisplayList) { 13531 displayList = getDisplayList(); 13532 if (!displayList.isValid()) { 13533 // Uncommon, but possible. If a view is removed from the hierarchy during the call 13534 // to getDisplayList(), the display list will be marked invalid and we should not 13535 // try to use it again. 13536 displayList = null; 13537 hasDisplayList = false; 13538 } 13539 } 13540 13541 if (hasNoCache) { 13542 boolean layerRendered = false; 13543 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) { 13544 final HardwareLayer layer = getHardwareLayer(); 13545 if (layer != null && layer.isValid()) { 13546 mLayerPaint.setAlpha((int) (alpha * 255)); 13547 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint); 13548 layerRendered = true; 13549 } else { 13550 final int scrollX = hasDisplayList ? 0 : sx; 13551 final int scrollY = hasDisplayList ? 0 : sy; 13552 canvas.saveLayer(scrollX, scrollY, 13553 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint, 13554 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG); 13555 } 13556 } 13557 13558 if (!layerRendered) { 13559 if (!hasDisplayList) { 13560 // Fast path for layouts with no backgrounds 13561 if ((mPrivateFlags & PFLAG_SKIP_DRAW) == PFLAG_SKIP_DRAW) { 13562 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 13563 dispatchDraw(canvas); 13564 } else { 13565 draw(canvas); 13566 } 13567 } else { 13568 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 13569 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags); 13570 } 13571 } 13572 } else if (cache != null) { 13573 mPrivateFlags &= ~PFLAG_DIRTY_MASK; 13574 Paint cachePaint; 13575 13576 if (layerType == LAYER_TYPE_NONE) { 13577 cachePaint = parent.mCachePaint; 13578 if (cachePaint == null) { 13579 cachePaint = new Paint(); 13580 cachePaint.setDither(false); 13581 parent.mCachePaint = cachePaint; 13582 } 13583 if (alpha < 1) { 13584 cachePaint.setAlpha((int) (alpha * 255)); 13585 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE; 13586 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) { 13587 cachePaint.setAlpha(255); 13588 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE; 13589 } 13590 } else { 13591 cachePaint = mLayerPaint; 13592 cachePaint.setAlpha((int) (alpha * 255)); 13593 } 13594 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint); 13595 } 13596 13597 if (restoreTo >= 0) { 13598 canvas.restoreToCount(restoreTo); 13599 } 13600 13601 if (a != null && !more) { 13602 if (!hardwareAccelerated && !a.getFillAfter()) { 13603 onSetAlpha(255); 13604 } 13605 parent.finishAnimatingView(this, a); 13606 } 13607 13608 if (more && hardwareAccelerated) { 13609 // invalidation is the trigger to recreate display lists, so if we're using 13610 // display lists to render, force an invalidate to allow the animation to 13611 // continue drawing another frame 13612 parent.invalidate(true); 13613 if (a.hasAlpha() && (mPrivateFlags & PFLAG_ALPHA_SET) == PFLAG_ALPHA_SET) { 13614 // alpha animations should cause the child to recreate its display list 13615 invalidate(true); 13616 } 13617 } 13618 13619 mRecreateDisplayList = false; 13620 13621 return more; 13622 } 13623 13624 /** 13625 * Manually render this view (and all of its children) to the given Canvas. 13626 * The view must have already done a full layout before this function is 13627 * called. When implementing a view, implement 13628 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 13629 * If you do need to override this method, call the superclass version. 13630 * 13631 * @param canvas The Canvas to which the View is rendered. 13632 */ 13633 public void draw(Canvas canvas) { 13634 final int privateFlags = mPrivateFlags; 13635 final boolean dirtyOpaque = (privateFlags & PFLAG_DIRTY_MASK) == PFLAG_DIRTY_OPAQUE && 13636 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 13637 mPrivateFlags = (privateFlags & ~PFLAG_DIRTY_MASK) | PFLAG_DRAWN; 13638 13639 /* 13640 * Draw traversal performs several drawing steps which must be executed 13641 * in the appropriate order: 13642 * 13643 * 1. Draw the background 13644 * 2. If necessary, save the canvas' layers to prepare for fading 13645 * 3. Draw view's content 13646 * 4. Draw children 13647 * 5. If necessary, draw the fading edges and restore layers 13648 * 6. Draw decorations (scrollbars for instance) 13649 */ 13650 13651 // Step 1, draw the background, if needed 13652 int saveCount; 13653 13654 if (!dirtyOpaque) { 13655 final Drawable background = mBackground; 13656 if (background != null) { 13657 final int scrollX = mScrollX; 13658 final int scrollY = mScrollY; 13659 13660 if (mBackgroundSizeChanged) { 13661 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 13662 mBackgroundSizeChanged = false; 13663 } 13664 13665 if ((scrollX | scrollY) == 0) { 13666 background.draw(canvas); 13667 } else { 13668 canvas.translate(scrollX, scrollY); 13669 background.draw(canvas); 13670 canvas.translate(-scrollX, -scrollY); 13671 } 13672 } 13673 } 13674 13675 // skip step 2 & 5 if possible (common case) 13676 final int viewFlags = mViewFlags; 13677 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 13678 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 13679 if (!verticalEdges && !horizontalEdges) { 13680 // Step 3, draw the content 13681 if (!dirtyOpaque) onDraw(canvas); 13682 13683 // Step 4, draw the children 13684 dispatchDraw(canvas); 13685 13686 // Step 6, draw decorations (scrollbars) 13687 onDrawScrollBars(canvas); 13688 13689 // we're done... 13690 return; 13691 } 13692 13693 /* 13694 * Here we do the full fledged routine... 13695 * (this is an uncommon case where speed matters less, 13696 * this is why we repeat some of the tests that have been 13697 * done above) 13698 */ 13699 13700 boolean drawTop = false; 13701 boolean drawBottom = false; 13702 boolean drawLeft = false; 13703 boolean drawRight = false; 13704 13705 float topFadeStrength = 0.0f; 13706 float bottomFadeStrength = 0.0f; 13707 float leftFadeStrength = 0.0f; 13708 float rightFadeStrength = 0.0f; 13709 13710 // Step 2, save the canvas' layers 13711 int paddingLeft = mPaddingLeft; 13712 13713 final boolean offsetRequired = isPaddingOffsetRequired(); 13714 if (offsetRequired) { 13715 paddingLeft += getLeftPaddingOffset(); 13716 } 13717 13718 int left = mScrollX + paddingLeft; 13719 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 13720 int top = mScrollY + getFadeTop(offsetRequired); 13721 int bottom = top + getFadeHeight(offsetRequired); 13722 13723 if (offsetRequired) { 13724 right += getRightPaddingOffset(); 13725 bottom += getBottomPaddingOffset(); 13726 } 13727 13728 final ScrollabilityCache scrollabilityCache = mScrollCache; 13729 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 13730 int length = (int) fadeHeight; 13731 13732 // clip the fade length if top and bottom fades overlap 13733 // overlapping fades produce odd-looking artifacts 13734 if (verticalEdges && (top + length > bottom - length)) { 13735 length = (bottom - top) / 2; 13736 } 13737 13738 // also clip horizontal fades if necessary 13739 if (horizontalEdges && (left + length > right - length)) { 13740 length = (right - left) / 2; 13741 } 13742 13743 if (verticalEdges) { 13744 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 13745 drawTop = topFadeStrength * fadeHeight > 1.0f; 13746 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 13747 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 13748 } 13749 13750 if (horizontalEdges) { 13751 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 13752 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 13753 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 13754 drawRight = rightFadeStrength * fadeHeight > 1.0f; 13755 } 13756 13757 saveCount = canvas.getSaveCount(); 13758 13759 int solidColor = getSolidColor(); 13760 if (solidColor == 0) { 13761 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 13762 13763 if (drawTop) { 13764 canvas.saveLayer(left, top, right, top + length, null, flags); 13765 } 13766 13767 if (drawBottom) { 13768 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 13769 } 13770 13771 if (drawLeft) { 13772 canvas.saveLayer(left, top, left + length, bottom, null, flags); 13773 } 13774 13775 if (drawRight) { 13776 canvas.saveLayer(right - length, top, right, bottom, null, flags); 13777 } 13778 } else { 13779 scrollabilityCache.setFadeColor(solidColor); 13780 } 13781 13782 // Step 3, draw the content 13783 if (!dirtyOpaque) onDraw(canvas); 13784 13785 // Step 4, draw the children 13786 dispatchDraw(canvas); 13787 13788 // Step 5, draw the fade effect and restore layers 13789 final Paint p = scrollabilityCache.paint; 13790 final Matrix matrix = scrollabilityCache.matrix; 13791 final Shader fade = scrollabilityCache.shader; 13792 13793 if (drawTop) { 13794 matrix.setScale(1, fadeHeight * topFadeStrength); 13795 matrix.postTranslate(left, top); 13796 fade.setLocalMatrix(matrix); 13797 canvas.drawRect(left, top, right, top + length, p); 13798 } 13799 13800 if (drawBottom) { 13801 matrix.setScale(1, fadeHeight * bottomFadeStrength); 13802 matrix.postRotate(180); 13803 matrix.postTranslate(left, bottom); 13804 fade.setLocalMatrix(matrix); 13805 canvas.drawRect(left, bottom - length, right, bottom, p); 13806 } 13807 13808 if (drawLeft) { 13809 matrix.setScale(1, fadeHeight * leftFadeStrength); 13810 matrix.postRotate(-90); 13811 matrix.postTranslate(left, top); 13812 fade.setLocalMatrix(matrix); 13813 canvas.drawRect(left, top, left + length, bottom, p); 13814 } 13815 13816 if (drawRight) { 13817 matrix.setScale(1, fadeHeight * rightFadeStrength); 13818 matrix.postRotate(90); 13819 matrix.postTranslate(right, top); 13820 fade.setLocalMatrix(matrix); 13821 canvas.drawRect(right - length, top, right, bottom, p); 13822 } 13823 13824 canvas.restoreToCount(saveCount); 13825 13826 // Step 6, draw decorations (scrollbars) 13827 onDrawScrollBars(canvas); 13828 } 13829 13830 /** 13831 * Override this if your view is known to always be drawn on top of a solid color background, 13832 * and needs to draw fading edges. Returning a non-zero color enables the view system to 13833 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 13834 * should be set to 0xFF. 13835 * 13836 * @see #setVerticalFadingEdgeEnabled(boolean) 13837 * @see #setHorizontalFadingEdgeEnabled(boolean) 13838 * 13839 * @return The known solid color background for this view, or 0 if the color may vary 13840 */ 13841 @ViewDebug.ExportedProperty(category = "drawing") 13842 public int getSolidColor() { 13843 return 0; 13844 } 13845 13846 /** 13847 * Build a human readable string representation of the specified view flags. 13848 * 13849 * @param flags the view flags to convert to a string 13850 * @return a String representing the supplied flags 13851 */ 13852 private static String printFlags(int flags) { 13853 String output = ""; 13854 int numFlags = 0; 13855 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 13856 output += "TAKES_FOCUS"; 13857 numFlags++; 13858 } 13859 13860 switch (flags & VISIBILITY_MASK) { 13861 case INVISIBLE: 13862 if (numFlags > 0) { 13863 output += " "; 13864 } 13865 output += "INVISIBLE"; 13866 // USELESS HERE numFlags++; 13867 break; 13868 case GONE: 13869 if (numFlags > 0) { 13870 output += " "; 13871 } 13872 output += "GONE"; 13873 // USELESS HERE numFlags++; 13874 break; 13875 default: 13876 break; 13877 } 13878 return output; 13879 } 13880 13881 /** 13882 * Build a human readable string representation of the specified private 13883 * view flags. 13884 * 13885 * @param privateFlags the private view flags to convert to a string 13886 * @return a String representing the supplied flags 13887 */ 13888 private static String printPrivateFlags(int privateFlags) { 13889 String output = ""; 13890 int numFlags = 0; 13891 13892 if ((privateFlags & PFLAG_WANTS_FOCUS) == PFLAG_WANTS_FOCUS) { 13893 output += "WANTS_FOCUS"; 13894 numFlags++; 13895 } 13896 13897 if ((privateFlags & PFLAG_FOCUSED) == PFLAG_FOCUSED) { 13898 if (numFlags > 0) { 13899 output += " "; 13900 } 13901 output += "FOCUSED"; 13902 numFlags++; 13903 } 13904 13905 if ((privateFlags & PFLAG_SELECTED) == PFLAG_SELECTED) { 13906 if (numFlags > 0) { 13907 output += " "; 13908 } 13909 output += "SELECTED"; 13910 numFlags++; 13911 } 13912 13913 if ((privateFlags & PFLAG_IS_ROOT_NAMESPACE) == PFLAG_IS_ROOT_NAMESPACE) { 13914 if (numFlags > 0) { 13915 output += " "; 13916 } 13917 output += "IS_ROOT_NAMESPACE"; 13918 numFlags++; 13919 } 13920 13921 if ((privateFlags & PFLAG_HAS_BOUNDS) == PFLAG_HAS_BOUNDS) { 13922 if (numFlags > 0) { 13923 output += " "; 13924 } 13925 output += "HAS_BOUNDS"; 13926 numFlags++; 13927 } 13928 13929 if ((privateFlags & PFLAG_DRAWN) == PFLAG_DRAWN) { 13930 if (numFlags > 0) { 13931 output += " "; 13932 } 13933 output += "DRAWN"; 13934 // USELESS HERE numFlags++; 13935 } 13936 return output; 13937 } 13938 13939 /** 13940 * <p>Indicates whether or not this view's layout will be requested during 13941 * the next hierarchy layout pass.</p> 13942 * 13943 * @return true if the layout will be forced during next layout pass 13944 */ 13945 public boolean isLayoutRequested() { 13946 return (mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT; 13947 } 13948 13949 /** 13950 * Assign a size and position to a view and all of its 13951 * descendants 13952 * 13953 * <p>This is the second phase of the layout mechanism. 13954 * (The first is measuring). In this phase, each parent calls 13955 * layout on all of its children to position them. 13956 * This is typically done using the child measurements 13957 * that were stored in the measure pass().</p> 13958 * 13959 * <p>Derived classes should not override this method. 13960 * Derived classes with children should override 13961 * onLayout. In that method, they should 13962 * call layout on each of their children.</p> 13963 * 13964 * @param l Left position, relative to parent 13965 * @param t Top position, relative to parent 13966 * @param r Right position, relative to parent 13967 * @param b Bottom position, relative to parent 13968 */ 13969 @SuppressWarnings({"unchecked"}) 13970 public void layout(int l, int t, int r, int b) { 13971 int oldL = mLeft; 13972 int oldT = mTop; 13973 int oldB = mBottom; 13974 int oldR = mRight; 13975 boolean changed = setFrame(l, t, r, b); 13976 if (changed || (mPrivateFlags & PFLAG_LAYOUT_REQUIRED) == PFLAG_LAYOUT_REQUIRED) { 13977 onLayout(changed, l, t, r, b); 13978 mPrivateFlags &= ~PFLAG_LAYOUT_REQUIRED; 13979 13980 ListenerInfo li = mListenerInfo; 13981 if (li != null && li.mOnLayoutChangeListeners != null) { 13982 ArrayList<OnLayoutChangeListener> listenersCopy = 13983 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 13984 int numListeners = listenersCopy.size(); 13985 for (int i = 0; i < numListeners; ++i) { 13986 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 13987 } 13988 } 13989 } 13990 mPrivateFlags &= ~PFLAG_FORCE_LAYOUT; 13991 } 13992 13993 /** 13994 * Called from layout when this view should 13995 * assign a size and position to each of its children. 13996 * 13997 * Derived classes with children should override 13998 * this method and call layout on each of 13999 * their children. 14000 * @param changed This is a new size or position for this view 14001 * @param left Left position, relative to parent 14002 * @param top Top position, relative to parent 14003 * @param right Right position, relative to parent 14004 * @param bottom Bottom position, relative to parent 14005 */ 14006 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 14007 } 14008 14009 /** 14010 * Assign a size and position to this view. 14011 * 14012 * This is called from layout. 14013 * 14014 * @param left Left position, relative to parent 14015 * @param top Top position, relative to parent 14016 * @param right Right position, relative to parent 14017 * @param bottom Bottom position, relative to parent 14018 * @return true if the new size and position are different than the 14019 * previous ones 14020 * {@hide} 14021 */ 14022 protected boolean setFrame(int left, int top, int right, int bottom) { 14023 boolean changed = false; 14024 14025 if (DBG) { 14026 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 14027 + right + "," + bottom + ")"); 14028 } 14029 14030 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 14031 changed = true; 14032 14033 // Remember our drawn bit 14034 int drawn = mPrivateFlags & PFLAG_DRAWN; 14035 14036 int oldWidth = mRight - mLeft; 14037 int oldHeight = mBottom - mTop; 14038 int newWidth = right - left; 14039 int newHeight = bottom - top; 14040 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 14041 14042 // Invalidate our old position 14043 invalidate(sizeChanged); 14044 14045 mLeft = left; 14046 mTop = top; 14047 mRight = right; 14048 mBottom = bottom; 14049 if (mDisplayList != null) { 14050 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 14051 } 14052 14053 mPrivateFlags |= PFLAG_HAS_BOUNDS; 14054 14055 14056 if (sizeChanged) { 14057 if ((mPrivateFlags & PFLAG_PIVOT_EXPLICITLY_SET) == 0) { 14058 // A change in dimension means an auto-centered pivot point changes, too 14059 if (mTransformationInfo != null) { 14060 mTransformationInfo.mMatrixDirty = true; 14061 } 14062 } 14063 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 14064 } 14065 14066 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) { 14067 // If we are visible, force the DRAWN bit to on so that 14068 // this invalidate will go through (at least to our parent). 14069 // This is because someone may have invalidated this view 14070 // before this call to setFrame came in, thereby clearing 14071 // the DRAWN bit. 14072 mPrivateFlags |= PFLAG_DRAWN; 14073 invalidate(sizeChanged); 14074 // parent display list may need to be recreated based on a change in the bounds 14075 // of any child 14076 invalidateParentCaches(); 14077 } 14078 14079 // Reset drawn bit to original value (invalidate turns it off) 14080 mPrivateFlags |= drawn; 14081 14082 mBackgroundSizeChanged = true; 14083 } 14084 return changed; 14085 } 14086 14087 /** 14088 * Finalize inflating a view from XML. This is called as the last phase 14089 * of inflation, after all child views have been added. 14090 * 14091 * <p>Even if the subclass overrides onFinishInflate, they should always be 14092 * sure to call the super method, so that we get called. 14093 */ 14094 protected void onFinishInflate() { 14095 } 14096 14097 /** 14098 * Returns the resources associated with this view. 14099 * 14100 * @return Resources object. 14101 */ 14102 public Resources getResources() { 14103 return mResources; 14104 } 14105 14106 /** 14107 * Invalidates the specified Drawable. 14108 * 14109 * @param drawable the drawable to invalidate 14110 */ 14111 public void invalidateDrawable(Drawable drawable) { 14112 if (verifyDrawable(drawable)) { 14113 final Rect dirty = drawable.getBounds(); 14114 final int scrollX = mScrollX; 14115 final int scrollY = mScrollY; 14116 14117 invalidate(dirty.left + scrollX, dirty.top + scrollY, 14118 dirty.right + scrollX, dirty.bottom + scrollY); 14119 } 14120 } 14121 14122 /** 14123 * Schedules an action on a drawable to occur at a specified time. 14124 * 14125 * @param who the recipient of the action 14126 * @param what the action to run on the drawable 14127 * @param when the time at which the action must occur. Uses the 14128 * {@link SystemClock#uptimeMillis} timebase. 14129 */ 14130 public void scheduleDrawable(Drawable who, Runnable what, long when) { 14131 if (verifyDrawable(who) && what != null) { 14132 final long delay = when - SystemClock.uptimeMillis(); 14133 if (mAttachInfo != null) { 14134 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 14135 Choreographer.CALLBACK_ANIMATION, what, who, 14136 Choreographer.subtractFrameDelay(delay)); 14137 } else { 14138 ViewRootImpl.getRunQueue().postDelayed(what, delay); 14139 } 14140 } 14141 } 14142 14143 /** 14144 * Cancels a scheduled action on a drawable. 14145 * 14146 * @param who the recipient of the action 14147 * @param what the action to cancel 14148 */ 14149 public void unscheduleDrawable(Drawable who, Runnable what) { 14150 if (verifyDrawable(who) && what != null) { 14151 if (mAttachInfo != null) { 14152 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 14153 Choreographer.CALLBACK_ANIMATION, what, who); 14154 } else { 14155 ViewRootImpl.getRunQueue().removeCallbacks(what); 14156 } 14157 } 14158 } 14159 14160 /** 14161 * Unschedule any events associated with the given Drawable. This can be 14162 * used when selecting a new Drawable into a view, so that the previous 14163 * one is completely unscheduled. 14164 * 14165 * @param who The Drawable to unschedule. 14166 * 14167 * @see #drawableStateChanged 14168 */ 14169 public void unscheduleDrawable(Drawable who) { 14170 if (mAttachInfo != null && who != null) { 14171 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 14172 Choreographer.CALLBACK_ANIMATION, null, who); 14173 } 14174 } 14175 14176 /** 14177 * Resolve the Drawables depending on the layout direction. This is implicitly supposing 14178 * that the View directionality can and will be resolved before its Drawables. 14179 * 14180 * Will call {@link View#onResolveDrawables} when resolution is done. 14181 * 14182 * @hide 14183 */ 14184 protected void resolveDrawables() { 14185 if (mBackground != null) { 14186 mBackground.setLayoutDirection(getLayoutDirection()); 14187 } 14188 mPrivateFlags2 |= PFLAG2_DRAWABLE_RESOLVED; 14189 onResolveDrawables(getLayoutDirection()); 14190 } 14191 14192 /** 14193 * Called when layout direction has been resolved. 14194 * 14195 * The default implementation does nothing. 14196 * 14197 * @param layoutDirection The resolved layout direction. 14198 * 14199 * @see #LAYOUT_DIRECTION_LTR 14200 * @see #LAYOUT_DIRECTION_RTL 14201 * 14202 * @hide 14203 */ 14204 public void onResolveDrawables(int layoutDirection) { 14205 } 14206 14207 /** 14208 * @hide 14209 */ 14210 protected void resetResolvedDrawables() { 14211 mPrivateFlags2 &= ~PFLAG2_DRAWABLE_RESOLVED; 14212 } 14213 14214 private boolean isDrawablesResolved() { 14215 return (mPrivateFlags2 & PFLAG2_DRAWABLE_RESOLVED) == PFLAG2_DRAWABLE_RESOLVED; 14216 } 14217 14218 /** 14219 * If your view subclass is displaying its own Drawable objects, it should 14220 * override this function and return true for any Drawable it is 14221 * displaying. This allows animations for those drawables to be 14222 * scheduled. 14223 * 14224 * <p>Be sure to call through to the super class when overriding this 14225 * function. 14226 * 14227 * @param who The Drawable to verify. Return true if it is one you are 14228 * displaying, else return the result of calling through to the 14229 * super class. 14230 * 14231 * @return boolean If true than the Drawable is being displayed in the 14232 * view; else false and it is not allowed to animate. 14233 * 14234 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 14235 * @see #drawableStateChanged() 14236 */ 14237 protected boolean verifyDrawable(Drawable who) { 14238 return who == mBackground; 14239 } 14240 14241 /** 14242 * This function is called whenever the state of the view changes in such 14243 * a way that it impacts the state of drawables being shown. 14244 * 14245 * <p>Be sure to call through to the superclass when overriding this 14246 * function. 14247 * 14248 * @see Drawable#setState(int[]) 14249 */ 14250 protected void drawableStateChanged() { 14251 Drawable d = mBackground; 14252 if (d != null && d.isStateful()) { 14253 d.setState(getDrawableState()); 14254 } 14255 } 14256 14257 /** 14258 * Call this to force a view to update its drawable state. This will cause 14259 * drawableStateChanged to be called on this view. Views that are interested 14260 * in the new state should call getDrawableState. 14261 * 14262 * @see #drawableStateChanged 14263 * @see #getDrawableState 14264 */ 14265 public void refreshDrawableState() { 14266 mPrivateFlags |= PFLAG_DRAWABLE_STATE_DIRTY; 14267 drawableStateChanged(); 14268 14269 ViewParent parent = mParent; 14270 if (parent != null) { 14271 parent.childDrawableStateChanged(this); 14272 } 14273 } 14274 14275 /** 14276 * Return an array of resource IDs of the drawable states representing the 14277 * current state of the view. 14278 * 14279 * @return The current drawable state 14280 * 14281 * @see Drawable#setState(int[]) 14282 * @see #drawableStateChanged() 14283 * @see #onCreateDrawableState(int) 14284 */ 14285 public final int[] getDrawableState() { 14286 if ((mDrawableState != null) && ((mPrivateFlags & PFLAG_DRAWABLE_STATE_DIRTY) == 0)) { 14287 return mDrawableState; 14288 } else { 14289 mDrawableState = onCreateDrawableState(0); 14290 mPrivateFlags &= ~PFLAG_DRAWABLE_STATE_DIRTY; 14291 return mDrawableState; 14292 } 14293 } 14294 14295 /** 14296 * Generate the new {@link android.graphics.drawable.Drawable} state for 14297 * this view. This is called by the view 14298 * system when the cached Drawable state is determined to be invalid. To 14299 * retrieve the current state, you should use {@link #getDrawableState}. 14300 * 14301 * @param extraSpace if non-zero, this is the number of extra entries you 14302 * would like in the returned array in which you can place your own 14303 * states. 14304 * 14305 * @return Returns an array holding the current {@link Drawable} state of 14306 * the view. 14307 * 14308 * @see #mergeDrawableStates(int[], int[]) 14309 */ 14310 protected int[] onCreateDrawableState(int extraSpace) { 14311 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 14312 mParent instanceof View) { 14313 return ((View) mParent).onCreateDrawableState(extraSpace); 14314 } 14315 14316 int[] drawableState; 14317 14318 int privateFlags = mPrivateFlags; 14319 14320 int viewStateIndex = 0; 14321 if ((privateFlags & PFLAG_PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 14322 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 14323 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 14324 if ((privateFlags & PFLAG_SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 14325 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 14326 if ((privateFlags & PFLAG_ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 14327 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 14328 HardwareRenderer.isAvailable()) { 14329 // This is set if HW acceleration is requested, even if the current 14330 // process doesn't allow it. This is just to allow app preview 14331 // windows to better match their app. 14332 viewStateIndex |= VIEW_STATE_ACCELERATED; 14333 } 14334 if ((privateFlags & PFLAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 14335 14336 final int privateFlags2 = mPrivateFlags2; 14337 if ((privateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 14338 if ((privateFlags2 & PFLAG2_DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 14339 14340 drawableState = VIEW_STATE_SETS[viewStateIndex]; 14341 14342 //noinspection ConstantIfStatement 14343 if (false) { 14344 Log.i("View", "drawableStateIndex=" + viewStateIndex); 14345 Log.i("View", toString() 14346 + " pressed=" + ((privateFlags & PFLAG_PRESSED) != 0) 14347 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 14348 + " fo=" + hasFocus() 14349 + " sl=" + ((privateFlags & PFLAG_SELECTED) != 0) 14350 + " wf=" + hasWindowFocus() 14351 + ": " + Arrays.toString(drawableState)); 14352 } 14353 14354 if (extraSpace == 0) { 14355 return drawableState; 14356 } 14357 14358 final int[] fullState; 14359 if (drawableState != null) { 14360 fullState = new int[drawableState.length + extraSpace]; 14361 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 14362 } else { 14363 fullState = new int[extraSpace]; 14364 } 14365 14366 return fullState; 14367 } 14368 14369 /** 14370 * Merge your own state values in <var>additionalState</var> into the base 14371 * state values <var>baseState</var> that were returned by 14372 * {@link #onCreateDrawableState(int)}. 14373 * 14374 * @param baseState The base state values returned by 14375 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 14376 * own additional state values. 14377 * 14378 * @param additionalState The additional state values you would like 14379 * added to <var>baseState</var>; this array is not modified. 14380 * 14381 * @return As a convenience, the <var>baseState</var> array you originally 14382 * passed into the function is returned. 14383 * 14384 * @see #onCreateDrawableState(int) 14385 */ 14386 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 14387 final int N = baseState.length; 14388 int i = N - 1; 14389 while (i >= 0 && baseState[i] == 0) { 14390 i--; 14391 } 14392 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 14393 return baseState; 14394 } 14395 14396 /** 14397 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 14398 * on all Drawable objects associated with this view. 14399 */ 14400 public void jumpDrawablesToCurrentState() { 14401 if (mBackground != null) { 14402 mBackground.jumpToCurrentState(); 14403 } 14404 } 14405 14406 /** 14407 * Sets the background color for this view. 14408 * @param color the color of the background 14409 */ 14410 @RemotableViewMethod 14411 public void setBackgroundColor(int color) { 14412 if (mBackground instanceof ColorDrawable) { 14413 ((ColorDrawable) mBackground.mutate()).setColor(color); 14414 computeOpaqueFlags(); 14415 } else { 14416 setBackground(new ColorDrawable(color)); 14417 } 14418 } 14419 14420 /** 14421 * Set the background to a given resource. The resource should refer to 14422 * a Drawable object or 0 to remove the background. 14423 * @param resid The identifier of the resource. 14424 * 14425 * @attr ref android.R.styleable#View_background 14426 */ 14427 @RemotableViewMethod 14428 public void setBackgroundResource(int resid) { 14429 if (resid != 0 && resid == mBackgroundResource) { 14430 return; 14431 } 14432 14433 Drawable d= null; 14434 if (resid != 0) { 14435 d = mResources.getDrawable(resid); 14436 } 14437 setBackground(d); 14438 14439 mBackgroundResource = resid; 14440 } 14441 14442 /** 14443 * Set the background to a given Drawable, or remove the background. If the 14444 * background has padding, this View's padding is set to the background's 14445 * padding. However, when a background is removed, this View's padding isn't 14446 * touched. If setting the padding is desired, please use 14447 * {@link #setPadding(int, int, int, int)}. 14448 * 14449 * @param background The Drawable to use as the background, or null to remove the 14450 * background 14451 */ 14452 public void setBackground(Drawable background) { 14453 //noinspection deprecation 14454 setBackgroundDrawable(background); 14455 } 14456 14457 /** 14458 * @deprecated use {@link #setBackground(Drawable)} instead 14459 */ 14460 @Deprecated 14461 public void setBackgroundDrawable(Drawable background) { 14462 computeOpaqueFlags(); 14463 14464 if (background == mBackground) { 14465 return; 14466 } 14467 14468 boolean requestLayout = false; 14469 14470 mBackgroundResource = 0; 14471 14472 /* 14473 * Regardless of whether we're setting a new background or not, we want 14474 * to clear the previous drawable. 14475 */ 14476 if (mBackground != null) { 14477 mBackground.setCallback(null); 14478 unscheduleDrawable(mBackground); 14479 } 14480 14481 if (background != null) { 14482 Rect padding = sThreadLocal.get(); 14483 if (padding == null) { 14484 padding = new Rect(); 14485 sThreadLocal.set(padding); 14486 } 14487 resetResolvedDrawables(); 14488 background.setLayoutDirection(getLayoutDirection()); 14489 if (background.getPadding(padding)) { 14490 resetResolvedPadding(); 14491 switch (background.getLayoutDirection()) { 14492 case LAYOUT_DIRECTION_RTL: 14493 mUserPaddingLeftInitial = padding.right; 14494 mUserPaddingRightInitial = padding.left; 14495 internalSetPadding(padding.right, padding.top, padding.left, padding.bottom); 14496 break; 14497 case LAYOUT_DIRECTION_LTR: 14498 default: 14499 mUserPaddingLeftInitial = padding.left; 14500 mUserPaddingRightInitial = padding.right; 14501 internalSetPadding(padding.left, padding.top, padding.right, padding.bottom); 14502 } 14503 } 14504 14505 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 14506 // if it has a different minimum size, we should layout again 14507 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() || 14508 mBackground.getMinimumWidth() != background.getMinimumWidth()) { 14509 requestLayout = true; 14510 } 14511 14512 background.setCallback(this); 14513 if (background.isStateful()) { 14514 background.setState(getDrawableState()); 14515 } 14516 background.setVisible(getVisibility() == VISIBLE, false); 14517 mBackground = background; 14518 14519 if ((mPrivateFlags & PFLAG_SKIP_DRAW) != 0) { 14520 mPrivateFlags &= ~PFLAG_SKIP_DRAW; 14521 mPrivateFlags |= PFLAG_ONLY_DRAWS_BACKGROUND; 14522 requestLayout = true; 14523 } 14524 } else { 14525 /* Remove the background */ 14526 mBackground = null; 14527 14528 if ((mPrivateFlags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0) { 14529 /* 14530 * This view ONLY drew the background before and we're removing 14531 * the background, so now it won't draw anything 14532 * (hence we SKIP_DRAW) 14533 */ 14534 mPrivateFlags &= ~PFLAG_ONLY_DRAWS_BACKGROUND; 14535 mPrivateFlags |= PFLAG_SKIP_DRAW; 14536 } 14537 14538 /* 14539 * When the background is set, we try to apply its padding to this 14540 * View. When the background is removed, we don't touch this View's 14541 * padding. This is noted in the Javadocs. Hence, we don't need to 14542 * requestLayout(), the invalidate() below is sufficient. 14543 */ 14544 14545 // The old background's minimum size could have affected this 14546 // View's layout, so let's requestLayout 14547 requestLayout = true; 14548 } 14549 14550 computeOpaqueFlags(); 14551 14552 if (requestLayout) { 14553 requestLayout(); 14554 } 14555 14556 mBackgroundSizeChanged = true; 14557 invalidate(true); 14558 } 14559 14560 /** 14561 * Gets the background drawable 14562 * 14563 * @return The drawable used as the background for this view, if any. 14564 * 14565 * @see #setBackground(Drawable) 14566 * 14567 * @attr ref android.R.styleable#View_background 14568 */ 14569 public Drawable getBackground() { 14570 return mBackground; 14571 } 14572 14573 /** 14574 * Sets the padding. The view may add on the space required to display 14575 * the scrollbars, depending on the style and visibility of the scrollbars. 14576 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 14577 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 14578 * from the values set in this call. 14579 * 14580 * @attr ref android.R.styleable#View_padding 14581 * @attr ref android.R.styleable#View_paddingBottom 14582 * @attr ref android.R.styleable#View_paddingLeft 14583 * @attr ref android.R.styleable#View_paddingRight 14584 * @attr ref android.R.styleable#View_paddingTop 14585 * @param left the left padding in pixels 14586 * @param top the top padding in pixels 14587 * @param right the right padding in pixels 14588 * @param bottom the bottom padding in pixels 14589 */ 14590 public void setPadding(int left, int top, int right, int bottom) { 14591 resetResolvedPadding(); 14592 14593 mUserPaddingStart = UNDEFINED_PADDING; 14594 mUserPaddingEnd = UNDEFINED_PADDING; 14595 14596 mUserPaddingLeftInitial = left; 14597 mUserPaddingRightInitial = right; 14598 14599 internalSetPadding(left, top, right, bottom); 14600 } 14601 14602 /** 14603 * @hide 14604 */ 14605 protected void internalSetPadding(int left, int top, int right, int bottom) { 14606 mUserPaddingLeft = left; 14607 mUserPaddingRight = right; 14608 mUserPaddingBottom = bottom; 14609 14610 final int viewFlags = mViewFlags; 14611 boolean changed = false; 14612 14613 // Common case is there are no scroll bars. 14614 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 14615 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 14616 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 14617 ? 0 : getVerticalScrollbarWidth(); 14618 switch (mVerticalScrollbarPosition) { 14619 case SCROLLBAR_POSITION_DEFAULT: 14620 if (isLayoutRtl()) { 14621 left += offset; 14622 } else { 14623 right += offset; 14624 } 14625 break; 14626 case SCROLLBAR_POSITION_RIGHT: 14627 right += offset; 14628 break; 14629 case SCROLLBAR_POSITION_LEFT: 14630 left += offset; 14631 break; 14632 } 14633 } 14634 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 14635 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 14636 ? 0 : getHorizontalScrollbarHeight(); 14637 } 14638 } 14639 14640 if (mPaddingLeft != left) { 14641 changed = true; 14642 mPaddingLeft = left; 14643 } 14644 if (mPaddingTop != top) { 14645 changed = true; 14646 mPaddingTop = top; 14647 } 14648 if (mPaddingRight != right) { 14649 changed = true; 14650 mPaddingRight = right; 14651 } 14652 if (mPaddingBottom != bottom) { 14653 changed = true; 14654 mPaddingBottom = bottom; 14655 } 14656 14657 if (changed) { 14658 requestLayout(); 14659 } 14660 } 14661 14662 /** 14663 * Sets the relative padding. The view may add on the space required to display 14664 * the scrollbars, depending on the style and visibility of the scrollbars. 14665 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 14666 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 14667 * from the values set in this call. 14668 * 14669 * @attr ref android.R.styleable#View_padding 14670 * @attr ref android.R.styleable#View_paddingBottom 14671 * @attr ref android.R.styleable#View_paddingStart 14672 * @attr ref android.R.styleable#View_paddingEnd 14673 * @attr ref android.R.styleable#View_paddingTop 14674 * @param start the start padding in pixels 14675 * @param top the top padding in pixels 14676 * @param end the end padding in pixels 14677 * @param bottom the bottom padding in pixels 14678 */ 14679 public void setPaddingRelative(int start, int top, int end, int bottom) { 14680 resetResolvedPadding(); 14681 14682 mUserPaddingStart = start; 14683 mUserPaddingEnd = end; 14684 14685 switch(getLayoutDirection()) { 14686 case LAYOUT_DIRECTION_RTL: 14687 mUserPaddingLeftInitial = end; 14688 mUserPaddingRightInitial = start; 14689 internalSetPadding(end, top, start, bottom); 14690 break; 14691 case LAYOUT_DIRECTION_LTR: 14692 default: 14693 mUserPaddingLeftInitial = start; 14694 mUserPaddingRightInitial = end; 14695 internalSetPadding(start, top, end, bottom); 14696 } 14697 } 14698 14699 /** 14700 * Returns the top padding of this view. 14701 * 14702 * @return the top padding in pixels 14703 */ 14704 public int getPaddingTop() { 14705 return mPaddingTop; 14706 } 14707 14708 /** 14709 * Returns the bottom padding of this view. If there are inset and enabled 14710 * scrollbars, this value may include the space required to display the 14711 * scrollbars as well. 14712 * 14713 * @return the bottom padding in pixels 14714 */ 14715 public int getPaddingBottom() { 14716 return mPaddingBottom; 14717 } 14718 14719 /** 14720 * Returns the left padding of this view. If there are inset and enabled 14721 * scrollbars, this value may include the space required to display the 14722 * scrollbars as well. 14723 * 14724 * @return the left padding in pixels 14725 */ 14726 public int getPaddingLeft() { 14727 if (!isPaddingResolved()) { 14728 resolvePadding(); 14729 } 14730 return mPaddingLeft; 14731 } 14732 14733 /** 14734 * Returns the start padding of this view depending on its resolved layout direction. 14735 * If there are inset and enabled scrollbars, this value may include the space 14736 * required to display the scrollbars as well. 14737 * 14738 * @return the start padding in pixels 14739 */ 14740 public int getPaddingStart() { 14741 if (!isPaddingResolved()) { 14742 resolvePadding(); 14743 } 14744 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 14745 mPaddingRight : mPaddingLeft; 14746 } 14747 14748 /** 14749 * Returns the right padding of this view. If there are inset and enabled 14750 * scrollbars, this value may include the space required to display the 14751 * scrollbars as well. 14752 * 14753 * @return the right padding in pixels 14754 */ 14755 public int getPaddingRight() { 14756 if (!isPaddingResolved()) { 14757 resolvePadding(); 14758 } 14759 return mPaddingRight; 14760 } 14761 14762 /** 14763 * Returns the end padding of this view depending on its resolved layout direction. 14764 * If there are inset and enabled scrollbars, this value may include the space 14765 * required to display the scrollbars as well. 14766 * 14767 * @return the end padding in pixels 14768 */ 14769 public int getPaddingEnd() { 14770 if (!isPaddingResolved()) { 14771 resolvePadding(); 14772 } 14773 return (getLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 14774 mPaddingLeft : mPaddingRight; 14775 } 14776 14777 /** 14778 * Return if the padding as been set thru relative values 14779 * {@link #setPaddingRelative(int, int, int, int)} or thru 14780 * @attr ref android.R.styleable#View_paddingStart or 14781 * @attr ref android.R.styleable#View_paddingEnd 14782 * 14783 * @return true if the padding is relative or false if it is not. 14784 */ 14785 public boolean isPaddingRelative() { 14786 return (mUserPaddingStart != UNDEFINED_PADDING || mUserPaddingEnd != UNDEFINED_PADDING); 14787 } 14788 14789 /** 14790 * @hide 14791 */ 14792 public void resetPaddingToInitialValues() { 14793 if (isRtlCompatibilityMode()) { 14794 mPaddingLeft = mUserPaddingLeftInitial; 14795 mPaddingRight = mUserPaddingRightInitial; 14796 return; 14797 } 14798 if (isLayoutRtl()) { 14799 mPaddingLeft = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingLeftInitial; 14800 mPaddingRight = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingRightInitial; 14801 } else { 14802 mPaddingLeft = (mUserPaddingStart >= 0) ? mUserPaddingStart : mUserPaddingLeftInitial; 14803 mPaddingRight = (mUserPaddingEnd >= 0) ? mUserPaddingEnd : mUserPaddingRightInitial; 14804 } 14805 } 14806 14807 /** 14808 * @hide 14809 */ 14810 public Insets getOpticalInsets() { 14811 if (mLayoutInsets == null) { 14812 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets(); 14813 } 14814 return mLayoutInsets; 14815 } 14816 14817 /** 14818 * @hide 14819 */ 14820 public void setLayoutInsets(Insets layoutInsets) { 14821 mLayoutInsets = layoutInsets; 14822 } 14823 14824 /** 14825 * Changes the selection state of this view. A view can be selected or not. 14826 * Note that selection is not the same as focus. Views are typically 14827 * selected in the context of an AdapterView like ListView or GridView; 14828 * the selected view is the view that is highlighted. 14829 * 14830 * @param selected true if the view must be selected, false otherwise 14831 */ 14832 public void setSelected(boolean selected) { 14833 if (((mPrivateFlags & PFLAG_SELECTED) != 0) != selected) { 14834 mPrivateFlags = (mPrivateFlags & ~PFLAG_SELECTED) | (selected ? PFLAG_SELECTED : 0); 14835 if (!selected) resetPressedState(); 14836 invalidate(true); 14837 refreshDrawableState(); 14838 dispatchSetSelected(selected); 14839 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 14840 notifyAccessibilityStateChanged(); 14841 } 14842 } 14843 } 14844 14845 /** 14846 * Dispatch setSelected to all of this View's children. 14847 * 14848 * @see #setSelected(boolean) 14849 * 14850 * @param selected The new selected state 14851 */ 14852 protected void dispatchSetSelected(boolean selected) { 14853 } 14854 14855 /** 14856 * Indicates the selection state of this view. 14857 * 14858 * @return true if the view is selected, false otherwise 14859 */ 14860 @ViewDebug.ExportedProperty 14861 public boolean isSelected() { 14862 return (mPrivateFlags & PFLAG_SELECTED) != 0; 14863 } 14864 14865 /** 14866 * Changes the activated state of this view. A view can be activated or not. 14867 * Note that activation is not the same as selection. Selection is 14868 * a transient property, representing the view (hierarchy) the user is 14869 * currently interacting with. Activation is a longer-term state that the 14870 * user can move views in and out of. For example, in a list view with 14871 * single or multiple selection enabled, the views in the current selection 14872 * set are activated. (Um, yeah, we are deeply sorry about the terminology 14873 * here.) The activated state is propagated down to children of the view it 14874 * is set on. 14875 * 14876 * @param activated true if the view must be activated, false otherwise 14877 */ 14878 public void setActivated(boolean activated) { 14879 if (((mPrivateFlags & PFLAG_ACTIVATED) != 0) != activated) { 14880 mPrivateFlags = (mPrivateFlags & ~PFLAG_ACTIVATED) | (activated ? PFLAG_ACTIVATED : 0); 14881 invalidate(true); 14882 refreshDrawableState(); 14883 dispatchSetActivated(activated); 14884 } 14885 } 14886 14887 /** 14888 * Dispatch setActivated to all of this View's children. 14889 * 14890 * @see #setActivated(boolean) 14891 * 14892 * @param activated The new activated state 14893 */ 14894 protected void dispatchSetActivated(boolean activated) { 14895 } 14896 14897 /** 14898 * Indicates the activation state of this view. 14899 * 14900 * @return true if the view is activated, false otherwise 14901 */ 14902 @ViewDebug.ExportedProperty 14903 public boolean isActivated() { 14904 return (mPrivateFlags & PFLAG_ACTIVATED) != 0; 14905 } 14906 14907 /** 14908 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 14909 * observer can be used to get notifications when global events, like 14910 * layout, happen. 14911 * 14912 * The returned ViewTreeObserver observer is not guaranteed to remain 14913 * valid for the lifetime of this View. If the caller of this method keeps 14914 * a long-lived reference to ViewTreeObserver, it should always check for 14915 * the return value of {@link ViewTreeObserver#isAlive()}. 14916 * 14917 * @return The ViewTreeObserver for this view's hierarchy. 14918 */ 14919 public ViewTreeObserver getViewTreeObserver() { 14920 if (mAttachInfo != null) { 14921 return mAttachInfo.mTreeObserver; 14922 } 14923 if (mFloatingTreeObserver == null) { 14924 mFloatingTreeObserver = new ViewTreeObserver(); 14925 } 14926 return mFloatingTreeObserver; 14927 } 14928 14929 /** 14930 * <p>Finds the topmost view in the current view hierarchy.</p> 14931 * 14932 * @return the topmost view containing this view 14933 */ 14934 public View getRootView() { 14935 if (mAttachInfo != null) { 14936 final View v = mAttachInfo.mRootView; 14937 if (v != null) { 14938 return v; 14939 } 14940 } 14941 14942 View parent = this; 14943 14944 while (parent.mParent != null && parent.mParent instanceof View) { 14945 parent = (View) parent.mParent; 14946 } 14947 14948 return parent; 14949 } 14950 14951 /** 14952 * <p>Computes the coordinates of this view on the screen. The argument 14953 * must be an array of two integers. After the method returns, the array 14954 * contains the x and y location in that order.</p> 14955 * 14956 * @param location an array of two integers in which to hold the coordinates 14957 */ 14958 public void getLocationOnScreen(int[] location) { 14959 getLocationInWindow(location); 14960 14961 final AttachInfo info = mAttachInfo; 14962 if (info != null) { 14963 location[0] += info.mWindowLeft; 14964 location[1] += info.mWindowTop; 14965 } 14966 } 14967 14968 /** 14969 * <p>Computes the coordinates of this view in its window. The argument 14970 * must be an array of two integers. After the method returns, the array 14971 * contains the x and y location in that order.</p> 14972 * 14973 * @param location an array of two integers in which to hold the coordinates 14974 */ 14975 public void getLocationInWindow(int[] location) { 14976 if (location == null || location.length < 2) { 14977 throw new IllegalArgumentException("location must be an array of two integers"); 14978 } 14979 14980 if (mAttachInfo == null) { 14981 // When the view is not attached to a window, this method does not make sense 14982 location[0] = location[1] = 0; 14983 return; 14984 } 14985 14986 float[] position = mAttachInfo.mTmpTransformLocation; 14987 position[0] = position[1] = 0.0f; 14988 14989 if (!hasIdentityMatrix()) { 14990 getMatrix().mapPoints(position); 14991 } 14992 14993 position[0] += mLeft; 14994 position[1] += mTop; 14995 14996 ViewParent viewParent = mParent; 14997 while (viewParent instanceof View) { 14998 final View view = (View) viewParent; 14999 15000 position[0] -= view.mScrollX; 15001 position[1] -= view.mScrollY; 15002 15003 if (!view.hasIdentityMatrix()) { 15004 view.getMatrix().mapPoints(position); 15005 } 15006 15007 position[0] += view.mLeft; 15008 position[1] += view.mTop; 15009 15010 viewParent = view.mParent; 15011 } 15012 15013 if (viewParent instanceof ViewRootImpl) { 15014 // *cough* 15015 final ViewRootImpl vr = (ViewRootImpl) viewParent; 15016 position[1] -= vr.mCurScrollY; 15017 } 15018 15019 location[0] = (int) (position[0] + 0.5f); 15020 location[1] = (int) (position[1] + 0.5f); 15021 } 15022 15023 /** 15024 * {@hide} 15025 * @param id the id of the view to be found 15026 * @return the view of the specified id, null if cannot be found 15027 */ 15028 protected View findViewTraversal(int id) { 15029 if (id == mID) { 15030 return this; 15031 } 15032 return null; 15033 } 15034 15035 /** 15036 * {@hide} 15037 * @param tag the tag of the view to be found 15038 * @return the view of specified tag, null if cannot be found 15039 */ 15040 protected View findViewWithTagTraversal(Object tag) { 15041 if (tag != null && tag.equals(mTag)) { 15042 return this; 15043 } 15044 return null; 15045 } 15046 15047 /** 15048 * {@hide} 15049 * @param predicate The predicate to evaluate. 15050 * @param childToSkip If not null, ignores this child during the recursive traversal. 15051 * @return The first view that matches the predicate or null. 15052 */ 15053 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 15054 if (predicate.apply(this)) { 15055 return this; 15056 } 15057 return null; 15058 } 15059 15060 /** 15061 * Look for a child view with the given id. If this view has the given 15062 * id, return this view. 15063 * 15064 * @param id The id to search for. 15065 * @return The view that has the given id in the hierarchy or null 15066 */ 15067 public final View findViewById(int id) { 15068 if (id < 0) { 15069 return null; 15070 } 15071 return findViewTraversal(id); 15072 } 15073 15074 /** 15075 * Finds a view by its unuque and stable accessibility id. 15076 * 15077 * @param accessibilityId The searched accessibility id. 15078 * @return The found view. 15079 */ 15080 final View findViewByAccessibilityId(int accessibilityId) { 15081 if (accessibilityId < 0) { 15082 return null; 15083 } 15084 return findViewByAccessibilityIdTraversal(accessibilityId); 15085 } 15086 15087 /** 15088 * Performs the traversal to find a view by its unuque and stable accessibility id. 15089 * 15090 * <strong>Note:</strong>This method does not stop at the root namespace 15091 * boundary since the user can touch the screen at an arbitrary location 15092 * potentially crossing the root namespace bounday which will send an 15093 * accessibility event to accessibility services and they should be able 15094 * to obtain the event source. Also accessibility ids are guaranteed to be 15095 * unique in the window. 15096 * 15097 * @param accessibilityId The accessibility id. 15098 * @return The found view. 15099 */ 15100 View findViewByAccessibilityIdTraversal(int accessibilityId) { 15101 if (getAccessibilityViewId() == accessibilityId) { 15102 return this; 15103 } 15104 return null; 15105 } 15106 15107 /** 15108 * Look for a child view with the given tag. If this view has the given 15109 * tag, return this view. 15110 * 15111 * @param tag The tag to search for, using "tag.equals(getTag())". 15112 * @return The View that has the given tag in the hierarchy or null 15113 */ 15114 public final View findViewWithTag(Object tag) { 15115 if (tag == null) { 15116 return null; 15117 } 15118 return findViewWithTagTraversal(tag); 15119 } 15120 15121 /** 15122 * {@hide} 15123 * Look for a child view that matches the specified predicate. 15124 * If this view matches the predicate, return this view. 15125 * 15126 * @param predicate The predicate to evaluate. 15127 * @return The first view that matches the predicate or null. 15128 */ 15129 public final View findViewByPredicate(Predicate<View> predicate) { 15130 return findViewByPredicateTraversal(predicate, null); 15131 } 15132 15133 /** 15134 * {@hide} 15135 * Look for a child view that matches the specified predicate, 15136 * starting with the specified view and its descendents and then 15137 * recusively searching the ancestors and siblings of that view 15138 * until this view is reached. 15139 * 15140 * This method is useful in cases where the predicate does not match 15141 * a single unique view (perhaps multiple views use the same id) 15142 * and we are trying to find the view that is "closest" in scope to the 15143 * starting view. 15144 * 15145 * @param start The view to start from. 15146 * @param predicate The predicate to evaluate. 15147 * @return The first view that matches the predicate or null. 15148 */ 15149 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 15150 View childToSkip = null; 15151 for (;;) { 15152 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 15153 if (view != null || start == this) { 15154 return view; 15155 } 15156 15157 ViewParent parent = start.getParent(); 15158 if (parent == null || !(parent instanceof View)) { 15159 return null; 15160 } 15161 15162 childToSkip = start; 15163 start = (View) parent; 15164 } 15165 } 15166 15167 /** 15168 * Sets the identifier for this view. The identifier does not have to be 15169 * unique in this view's hierarchy. The identifier should be a positive 15170 * number. 15171 * 15172 * @see #NO_ID 15173 * @see #getId() 15174 * @see #findViewById(int) 15175 * 15176 * @param id a number used to identify the view 15177 * 15178 * @attr ref android.R.styleable#View_id 15179 */ 15180 public void setId(int id) { 15181 mID = id; 15182 if (mID == View.NO_ID && mLabelForId != View.NO_ID) { 15183 mID = generateViewId(); 15184 } 15185 } 15186 15187 /** 15188 * {@hide} 15189 * 15190 * @param isRoot true if the view belongs to the root namespace, false 15191 * otherwise 15192 */ 15193 public void setIsRootNamespace(boolean isRoot) { 15194 if (isRoot) { 15195 mPrivateFlags |= PFLAG_IS_ROOT_NAMESPACE; 15196 } else { 15197 mPrivateFlags &= ~PFLAG_IS_ROOT_NAMESPACE; 15198 } 15199 } 15200 15201 /** 15202 * {@hide} 15203 * 15204 * @return true if the view belongs to the root namespace, false otherwise 15205 */ 15206 public boolean isRootNamespace() { 15207 return (mPrivateFlags&PFLAG_IS_ROOT_NAMESPACE) != 0; 15208 } 15209 15210 /** 15211 * Returns this view's identifier. 15212 * 15213 * @return a positive integer used to identify the view or {@link #NO_ID} 15214 * if the view has no ID 15215 * 15216 * @see #setId(int) 15217 * @see #findViewById(int) 15218 * @attr ref android.R.styleable#View_id 15219 */ 15220 @ViewDebug.CapturedViewProperty 15221 public int getId() { 15222 return mID; 15223 } 15224 15225 /** 15226 * Returns this view's tag. 15227 * 15228 * @return the Object stored in this view as a tag 15229 * 15230 * @see #setTag(Object) 15231 * @see #getTag(int) 15232 */ 15233 @ViewDebug.ExportedProperty 15234 public Object getTag() { 15235 return mTag; 15236 } 15237 15238 /** 15239 * Sets the tag associated with this view. A tag can be used to mark 15240 * a view in its hierarchy and does not have to be unique within the 15241 * hierarchy. Tags can also be used to store data within a view without 15242 * resorting to another data structure. 15243 * 15244 * @param tag an Object to tag the view with 15245 * 15246 * @see #getTag() 15247 * @see #setTag(int, Object) 15248 */ 15249 public void setTag(final Object tag) { 15250 mTag = tag; 15251 } 15252 15253 /** 15254 * Returns the tag associated with this view and the specified key. 15255 * 15256 * @param key The key identifying the tag 15257 * 15258 * @return the Object stored in this view as a tag 15259 * 15260 * @see #setTag(int, Object) 15261 * @see #getTag() 15262 */ 15263 public Object getTag(int key) { 15264 if (mKeyedTags != null) return mKeyedTags.get(key); 15265 return null; 15266 } 15267 15268 /** 15269 * Sets a tag associated with this view and a key. A tag can be used 15270 * to mark a view in its hierarchy and does not have to be unique within 15271 * the hierarchy. Tags can also be used to store data within a view 15272 * without resorting to another data structure. 15273 * 15274 * The specified key should be an id declared in the resources of the 15275 * application to ensure it is unique (see the <a 15276 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 15277 * Keys identified as belonging to 15278 * the Android framework or not associated with any package will cause 15279 * an {@link IllegalArgumentException} to be thrown. 15280 * 15281 * @param key The key identifying the tag 15282 * @param tag An Object to tag the view with 15283 * 15284 * @throws IllegalArgumentException If they specified key is not valid 15285 * 15286 * @see #setTag(Object) 15287 * @see #getTag(int) 15288 */ 15289 public void setTag(int key, final Object tag) { 15290 // If the package id is 0x00 or 0x01, it's either an undefined package 15291 // or a framework id 15292 if ((key >>> 24) < 2) { 15293 throw new IllegalArgumentException("The key must be an application-specific " 15294 + "resource id."); 15295 } 15296 15297 setKeyedTag(key, tag); 15298 } 15299 15300 /** 15301 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 15302 * framework id. 15303 * 15304 * @hide 15305 */ 15306 public void setTagInternal(int key, Object tag) { 15307 if ((key >>> 24) != 0x1) { 15308 throw new IllegalArgumentException("The key must be a framework-specific " 15309 + "resource id."); 15310 } 15311 15312 setKeyedTag(key, tag); 15313 } 15314 15315 private void setKeyedTag(int key, Object tag) { 15316 if (mKeyedTags == null) { 15317 mKeyedTags = new SparseArray<Object>(); 15318 } 15319 15320 mKeyedTags.put(key, tag); 15321 } 15322 15323 /** 15324 * Prints information about this view in the log output, with the tag 15325 * {@link #VIEW_LOG_TAG}. 15326 * 15327 * @hide 15328 */ 15329 public void debug() { 15330 debug(0); 15331 } 15332 15333 /** 15334 * Prints information about this view in the log output, with the tag 15335 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 15336 * indentation defined by the <code>depth</code>. 15337 * 15338 * @param depth the indentation level 15339 * 15340 * @hide 15341 */ 15342 protected void debug(int depth) { 15343 String output = debugIndent(depth - 1); 15344 15345 output += "+ " + this; 15346 int id = getId(); 15347 if (id != -1) { 15348 output += " (id=" + id + ")"; 15349 } 15350 Object tag = getTag(); 15351 if (tag != null) { 15352 output += " (tag=" + tag + ")"; 15353 } 15354 Log.d(VIEW_LOG_TAG, output); 15355 15356 if ((mPrivateFlags & PFLAG_FOCUSED) != 0) { 15357 output = debugIndent(depth) + " FOCUSED"; 15358 Log.d(VIEW_LOG_TAG, output); 15359 } 15360 15361 output = debugIndent(depth); 15362 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 15363 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 15364 + "} "; 15365 Log.d(VIEW_LOG_TAG, output); 15366 15367 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 15368 || mPaddingBottom != 0) { 15369 output = debugIndent(depth); 15370 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 15371 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 15372 Log.d(VIEW_LOG_TAG, output); 15373 } 15374 15375 output = debugIndent(depth); 15376 output += "mMeasureWidth=" + mMeasuredWidth + 15377 " mMeasureHeight=" + mMeasuredHeight; 15378 Log.d(VIEW_LOG_TAG, output); 15379 15380 output = debugIndent(depth); 15381 if (mLayoutParams == null) { 15382 output += "BAD! no layout params"; 15383 } else { 15384 output = mLayoutParams.debug(output); 15385 } 15386 Log.d(VIEW_LOG_TAG, output); 15387 15388 output = debugIndent(depth); 15389 output += "flags={"; 15390 output += View.printFlags(mViewFlags); 15391 output += "}"; 15392 Log.d(VIEW_LOG_TAG, output); 15393 15394 output = debugIndent(depth); 15395 output += "privateFlags={"; 15396 output += View.printPrivateFlags(mPrivateFlags); 15397 output += "}"; 15398 Log.d(VIEW_LOG_TAG, output); 15399 } 15400 15401 /** 15402 * Creates a string of whitespaces used for indentation. 15403 * 15404 * @param depth the indentation level 15405 * @return a String containing (depth * 2 + 3) * 2 white spaces 15406 * 15407 * @hide 15408 */ 15409 protected static String debugIndent(int depth) { 15410 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 15411 for (int i = 0; i < (depth * 2) + 3; i++) { 15412 spaces.append(' ').append(' '); 15413 } 15414 return spaces.toString(); 15415 } 15416 15417 /** 15418 * <p>Return the offset of the widget's text baseline from the widget's top 15419 * boundary. If this widget does not support baseline alignment, this 15420 * method returns -1. </p> 15421 * 15422 * @return the offset of the baseline within the widget's bounds or -1 15423 * if baseline alignment is not supported 15424 */ 15425 @ViewDebug.ExportedProperty(category = "layout") 15426 public int getBaseline() { 15427 return -1; 15428 } 15429 15430 /** 15431 * Call this when something has changed which has invalidated the 15432 * layout of this view. This will schedule a layout pass of the view 15433 * tree. 15434 */ 15435 public void requestLayout() { 15436 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 15437 mPrivateFlags |= PFLAG_INVALIDATED; 15438 15439 if (mParent != null && !mParent.isLayoutRequested()) { 15440 mParent.requestLayout(); 15441 } 15442 } 15443 15444 /** 15445 * Forces this view to be laid out during the next layout pass. 15446 * This method does not call requestLayout() or forceLayout() 15447 * on the parent. 15448 */ 15449 public void forceLayout() { 15450 mPrivateFlags |= PFLAG_FORCE_LAYOUT; 15451 mPrivateFlags |= PFLAG_INVALIDATED; 15452 } 15453 15454 /** 15455 * <p> 15456 * This is called to find out how big a view should be. The parent 15457 * supplies constraint information in the width and height parameters. 15458 * </p> 15459 * 15460 * <p> 15461 * The actual measurement work of a view is performed in 15462 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 15463 * {@link #onMeasure(int, int)} can and must be overridden by subclasses. 15464 * </p> 15465 * 15466 * 15467 * @param widthMeasureSpec Horizontal space requirements as imposed by the 15468 * parent 15469 * @param heightMeasureSpec Vertical space requirements as imposed by the 15470 * parent 15471 * 15472 * @see #onMeasure(int, int) 15473 */ 15474 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 15475 if ((mPrivateFlags & PFLAG_FORCE_LAYOUT) == PFLAG_FORCE_LAYOUT || 15476 widthMeasureSpec != mOldWidthMeasureSpec || 15477 heightMeasureSpec != mOldHeightMeasureSpec) { 15478 15479 // first clears the measured dimension flag 15480 mPrivateFlags &= ~PFLAG_MEASURED_DIMENSION_SET; 15481 15482 resolveRtlPropertiesIfNeeded(); 15483 15484 // measure ourselves, this should set the measured dimension flag back 15485 onMeasure(widthMeasureSpec, heightMeasureSpec); 15486 15487 // flag not set, setMeasuredDimension() was not invoked, we raise 15488 // an exception to warn the developer 15489 if ((mPrivateFlags & PFLAG_MEASURED_DIMENSION_SET) != PFLAG_MEASURED_DIMENSION_SET) { 15490 throw new IllegalStateException("onMeasure() did not set the" 15491 + " measured dimension by calling" 15492 + " setMeasuredDimension()"); 15493 } 15494 15495 mPrivateFlags |= PFLAG_LAYOUT_REQUIRED; 15496 } 15497 15498 mOldWidthMeasureSpec = widthMeasureSpec; 15499 mOldHeightMeasureSpec = heightMeasureSpec; 15500 } 15501 15502 /** 15503 * <p> 15504 * Measure the view and its content to determine the measured width and the 15505 * measured height. This method is invoked by {@link #measure(int, int)} and 15506 * should be overriden by subclasses to provide accurate and efficient 15507 * measurement of their contents. 15508 * </p> 15509 * 15510 * <p> 15511 * <strong>CONTRACT:</strong> When overriding this method, you 15512 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 15513 * measured width and height of this view. Failure to do so will trigger an 15514 * <code>IllegalStateException</code>, thrown by 15515 * {@link #measure(int, int)}. Calling the superclass' 15516 * {@link #onMeasure(int, int)} is a valid use. 15517 * </p> 15518 * 15519 * <p> 15520 * The base class implementation of measure defaults to the background size, 15521 * unless a larger size is allowed by the MeasureSpec. Subclasses should 15522 * override {@link #onMeasure(int, int)} to provide better measurements of 15523 * their content. 15524 * </p> 15525 * 15526 * <p> 15527 * If this method is overridden, it is the subclass's responsibility to make 15528 * sure the measured height and width are at least the view's minimum height 15529 * and width ({@link #getSuggestedMinimumHeight()} and 15530 * {@link #getSuggestedMinimumWidth()}). 15531 * </p> 15532 * 15533 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 15534 * The requirements are encoded with 15535 * {@link android.view.View.MeasureSpec}. 15536 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 15537 * The requirements are encoded with 15538 * {@link android.view.View.MeasureSpec}. 15539 * 15540 * @see #getMeasuredWidth() 15541 * @see #getMeasuredHeight() 15542 * @see #setMeasuredDimension(int, int) 15543 * @see #getSuggestedMinimumHeight() 15544 * @see #getSuggestedMinimumWidth() 15545 * @see android.view.View.MeasureSpec#getMode(int) 15546 * @see android.view.View.MeasureSpec#getSize(int) 15547 */ 15548 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 15549 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 15550 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 15551 } 15552 15553 /** 15554 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the 15555 * measured width and measured height. Failing to do so will trigger an 15556 * exception at measurement time.</p> 15557 * 15558 * @param measuredWidth The measured width of this view. May be a complex 15559 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 15560 * {@link #MEASURED_STATE_TOO_SMALL}. 15561 * @param measuredHeight The measured height of this view. May be a complex 15562 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 15563 * {@link #MEASURED_STATE_TOO_SMALL}. 15564 */ 15565 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 15566 mMeasuredWidth = measuredWidth; 15567 mMeasuredHeight = measuredHeight; 15568 15569 mPrivateFlags |= PFLAG_MEASURED_DIMENSION_SET; 15570 } 15571 15572 /** 15573 * Merge two states as returned by {@link #getMeasuredState()}. 15574 * @param curState The current state as returned from a view or the result 15575 * of combining multiple views. 15576 * @param newState The new view state to combine. 15577 * @return Returns a new integer reflecting the combination of the two 15578 * states. 15579 */ 15580 public static int combineMeasuredStates(int curState, int newState) { 15581 return curState | newState; 15582 } 15583 15584 /** 15585 * Version of {@link #resolveSizeAndState(int, int, int)} 15586 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 15587 */ 15588 public static int resolveSize(int size, int measureSpec) { 15589 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 15590 } 15591 15592 /** 15593 * Utility to reconcile a desired size and state, with constraints imposed 15594 * by a MeasureSpec. Will take the desired size, unless a different size 15595 * is imposed by the constraints. The returned value is a compound integer, 15596 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 15597 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 15598 * size is smaller than the size the view wants to be. 15599 * 15600 * @param size How big the view wants to be 15601 * @param measureSpec Constraints imposed by the parent 15602 * @return Size information bit mask as defined by 15603 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 15604 */ 15605 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 15606 int result = size; 15607 int specMode = MeasureSpec.getMode(measureSpec); 15608 int specSize = MeasureSpec.getSize(measureSpec); 15609 switch (specMode) { 15610 case MeasureSpec.UNSPECIFIED: 15611 result = size; 15612 break; 15613 case MeasureSpec.AT_MOST: 15614 if (specSize < size) { 15615 result = specSize | MEASURED_STATE_TOO_SMALL; 15616 } else { 15617 result = size; 15618 } 15619 break; 15620 case MeasureSpec.EXACTLY: 15621 result = specSize; 15622 break; 15623 } 15624 return result | (childMeasuredState&MEASURED_STATE_MASK); 15625 } 15626 15627 /** 15628 * Utility to return a default size. Uses the supplied size if the 15629 * MeasureSpec imposed no constraints. Will get larger if allowed 15630 * by the MeasureSpec. 15631 * 15632 * @param size Default size for this view 15633 * @param measureSpec Constraints imposed by the parent 15634 * @return The size this view should be. 15635 */ 15636 public static int getDefaultSize(int size, int measureSpec) { 15637 int result = size; 15638 int specMode = MeasureSpec.getMode(measureSpec); 15639 int specSize = MeasureSpec.getSize(measureSpec); 15640 15641 switch (specMode) { 15642 case MeasureSpec.UNSPECIFIED: 15643 result = size; 15644 break; 15645 case MeasureSpec.AT_MOST: 15646 case MeasureSpec.EXACTLY: 15647 result = specSize; 15648 break; 15649 } 15650 return result; 15651 } 15652 15653 /** 15654 * Returns the suggested minimum height that the view should use. This 15655 * returns the maximum of the view's minimum height 15656 * and the background's minimum height 15657 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 15658 * <p> 15659 * When being used in {@link #onMeasure(int, int)}, the caller should still 15660 * ensure the returned height is within the requirements of the parent. 15661 * 15662 * @return The suggested minimum height of the view. 15663 */ 15664 protected int getSuggestedMinimumHeight() { 15665 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight()); 15666 15667 } 15668 15669 /** 15670 * Returns the suggested minimum width that the view should use. This 15671 * returns the maximum of the view's minimum width) 15672 * and the background's minimum width 15673 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 15674 * <p> 15675 * When being used in {@link #onMeasure(int, int)}, the caller should still 15676 * ensure the returned width is within the requirements of the parent. 15677 * 15678 * @return The suggested minimum width of the view. 15679 */ 15680 protected int getSuggestedMinimumWidth() { 15681 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth()); 15682 } 15683 15684 /** 15685 * Returns the minimum height of the view. 15686 * 15687 * @return the minimum height the view will try to be. 15688 * 15689 * @see #setMinimumHeight(int) 15690 * 15691 * @attr ref android.R.styleable#View_minHeight 15692 */ 15693 public int getMinimumHeight() { 15694 return mMinHeight; 15695 } 15696 15697 /** 15698 * Sets the minimum height of the view. It is not guaranteed the view will 15699 * be able to achieve this minimum height (for example, if its parent layout 15700 * constrains it with less available height). 15701 * 15702 * @param minHeight The minimum height the view will try to be. 15703 * 15704 * @see #getMinimumHeight() 15705 * 15706 * @attr ref android.R.styleable#View_minHeight 15707 */ 15708 public void setMinimumHeight(int minHeight) { 15709 mMinHeight = minHeight; 15710 requestLayout(); 15711 } 15712 15713 /** 15714 * Returns the minimum width of the view. 15715 * 15716 * @return the minimum width the view will try to be. 15717 * 15718 * @see #setMinimumWidth(int) 15719 * 15720 * @attr ref android.R.styleable#View_minWidth 15721 */ 15722 public int getMinimumWidth() { 15723 return mMinWidth; 15724 } 15725 15726 /** 15727 * Sets the minimum width of the view. It is not guaranteed the view will 15728 * be able to achieve this minimum width (for example, if its parent layout 15729 * constrains it with less available width). 15730 * 15731 * @param minWidth The minimum width the view will try to be. 15732 * 15733 * @see #getMinimumWidth() 15734 * 15735 * @attr ref android.R.styleable#View_minWidth 15736 */ 15737 public void setMinimumWidth(int minWidth) { 15738 mMinWidth = minWidth; 15739 requestLayout(); 15740 15741 } 15742 15743 /** 15744 * Get the animation currently associated with this view. 15745 * 15746 * @return The animation that is currently playing or 15747 * scheduled to play for this view. 15748 */ 15749 public Animation getAnimation() { 15750 return mCurrentAnimation; 15751 } 15752 15753 /** 15754 * Start the specified animation now. 15755 * 15756 * @param animation the animation to start now 15757 */ 15758 public void startAnimation(Animation animation) { 15759 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 15760 setAnimation(animation); 15761 invalidateParentCaches(); 15762 invalidate(true); 15763 } 15764 15765 /** 15766 * Cancels any animations for this view. 15767 */ 15768 public void clearAnimation() { 15769 if (mCurrentAnimation != null) { 15770 mCurrentAnimation.detach(); 15771 } 15772 mCurrentAnimation = null; 15773 invalidateParentIfNeeded(); 15774 } 15775 15776 /** 15777 * Sets the next animation to play for this view. 15778 * If you want the animation to play immediately, use 15779 * {@link #startAnimation(android.view.animation.Animation)} instead. 15780 * This method provides allows fine-grained 15781 * control over the start time and invalidation, but you 15782 * must make sure that 1) the animation has a start time set, and 15783 * 2) the view's parent (which controls animations on its children) 15784 * will be invalidated when the animation is supposed to 15785 * start. 15786 * 15787 * @param animation The next animation, or null. 15788 */ 15789 public void setAnimation(Animation animation) { 15790 mCurrentAnimation = animation; 15791 15792 if (animation != null) { 15793 // If the screen is off assume the animation start time is now instead of 15794 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time 15795 // would cause the animation to start when the screen turns back on 15796 if (mAttachInfo != null && !mAttachInfo.mScreenOn && 15797 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) { 15798 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis()); 15799 } 15800 animation.reset(); 15801 } 15802 } 15803 15804 /** 15805 * Invoked by a parent ViewGroup to notify the start of the animation 15806 * currently associated with this view. If you override this method, 15807 * always call super.onAnimationStart(); 15808 * 15809 * @see #setAnimation(android.view.animation.Animation) 15810 * @see #getAnimation() 15811 */ 15812 protected void onAnimationStart() { 15813 mPrivateFlags |= PFLAG_ANIMATION_STARTED; 15814 } 15815 15816 /** 15817 * Invoked by a parent ViewGroup to notify the end of the animation 15818 * currently associated with this view. If you override this method, 15819 * always call super.onAnimationEnd(); 15820 * 15821 * @see #setAnimation(android.view.animation.Animation) 15822 * @see #getAnimation() 15823 */ 15824 protected void onAnimationEnd() { 15825 mPrivateFlags &= ~PFLAG_ANIMATION_STARTED; 15826 } 15827 15828 /** 15829 * Invoked if there is a Transform that involves alpha. Subclass that can 15830 * draw themselves with the specified alpha should return true, and then 15831 * respect that alpha when their onDraw() is called. If this returns false 15832 * then the view may be redirected to draw into an offscreen buffer to 15833 * fulfill the request, which will look fine, but may be slower than if the 15834 * subclass handles it internally. The default implementation returns false. 15835 * 15836 * @param alpha The alpha (0..255) to apply to the view's drawing 15837 * @return true if the view can draw with the specified alpha. 15838 */ 15839 protected boolean onSetAlpha(int alpha) { 15840 return false; 15841 } 15842 15843 /** 15844 * This is used by the RootView to perform an optimization when 15845 * the view hierarchy contains one or several SurfaceView. 15846 * SurfaceView is always considered transparent, but its children are not, 15847 * therefore all View objects remove themselves from the global transparent 15848 * region (passed as a parameter to this function). 15849 * 15850 * @param region The transparent region for this ViewAncestor (window). 15851 * 15852 * @return Returns true if the effective visibility of the view at this 15853 * point is opaque, regardless of the transparent region; returns false 15854 * if it is possible for underlying windows to be seen behind the view. 15855 * 15856 * {@hide} 15857 */ 15858 public boolean gatherTransparentRegion(Region region) { 15859 final AttachInfo attachInfo = mAttachInfo; 15860 if (region != null && attachInfo != null) { 15861 final int pflags = mPrivateFlags; 15862 if ((pflags & PFLAG_SKIP_DRAW) == 0) { 15863 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 15864 // remove it from the transparent region. 15865 final int[] location = attachInfo.mTransparentLocation; 15866 getLocationInWindow(location); 15867 region.op(location[0], location[1], location[0] + mRight - mLeft, 15868 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 15869 } else if ((pflags & PFLAG_ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) { 15870 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 15871 // exists, so we remove the background drawable's non-transparent 15872 // parts from this transparent region. 15873 applyDrawableToTransparentRegion(mBackground, region); 15874 } 15875 } 15876 return true; 15877 } 15878 15879 /** 15880 * Play a sound effect for this view. 15881 * 15882 * <p>The framework will play sound effects for some built in actions, such as 15883 * clicking, but you may wish to play these effects in your widget, 15884 * for instance, for internal navigation. 15885 * 15886 * <p>The sound effect will only be played if sound effects are enabled by the user, and 15887 * {@link #isSoundEffectsEnabled()} is true. 15888 * 15889 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 15890 */ 15891 public void playSoundEffect(int soundConstant) { 15892 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 15893 return; 15894 } 15895 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 15896 } 15897 15898 /** 15899 * BZZZTT!!1! 15900 * 15901 * <p>Provide haptic feedback to the user for this view. 15902 * 15903 * <p>The framework will provide haptic feedback for some built in actions, 15904 * such as long presses, but you may wish to provide feedback for your 15905 * own widget. 15906 * 15907 * <p>The feedback will only be performed if 15908 * {@link #isHapticFeedbackEnabled()} is true. 15909 * 15910 * @param feedbackConstant One of the constants defined in 15911 * {@link HapticFeedbackConstants} 15912 */ 15913 public boolean performHapticFeedback(int feedbackConstant) { 15914 return performHapticFeedback(feedbackConstant, 0); 15915 } 15916 15917 /** 15918 * BZZZTT!!1! 15919 * 15920 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 15921 * 15922 * @param feedbackConstant One of the constants defined in 15923 * {@link HapticFeedbackConstants} 15924 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 15925 */ 15926 public boolean performHapticFeedback(int feedbackConstant, int flags) { 15927 if (mAttachInfo == null) { 15928 return false; 15929 } 15930 //noinspection SimplifiableIfStatement 15931 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 15932 && !isHapticFeedbackEnabled()) { 15933 return false; 15934 } 15935 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 15936 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 15937 } 15938 15939 /** 15940 * Request that the visibility of the status bar or other screen/window 15941 * decorations be changed. 15942 * 15943 * <p>This method is used to put the over device UI into temporary modes 15944 * where the user's attention is focused more on the application content, 15945 * by dimming or hiding surrounding system affordances. This is typically 15946 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY 15947 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content 15948 * to be placed behind the action bar (and with these flags other system 15949 * affordances) so that smooth transitions between hiding and showing them 15950 * can be done. 15951 * 15952 * <p>Two representative examples of the use of system UI visibility is 15953 * implementing a content browsing application (like a magazine reader) 15954 * and a video playing application. 15955 * 15956 * <p>The first code shows a typical implementation of a View in a content 15957 * browsing application. In this implementation, the application goes 15958 * into a content-oriented mode by hiding the status bar and action bar, 15959 * and putting the navigation elements into lights out mode. The user can 15960 * then interact with content while in this mode. Such an application should 15961 * provide an easy way for the user to toggle out of the mode (such as to 15962 * check information in the status bar or access notifications). In the 15963 * implementation here, this is done simply by tapping on the content. 15964 * 15965 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java 15966 * content} 15967 * 15968 * <p>This second code sample shows a typical implementation of a View 15969 * in a video playing application. In this situation, while the video is 15970 * playing the application would like to go into a complete full-screen mode, 15971 * to use as much of the display as possible for the video. When in this state 15972 * the user can not interact with the application; the system intercepts 15973 * touching on the screen to pop the UI out of full screen mode. See 15974 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code. 15975 * 15976 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java 15977 * content} 15978 * 15979 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 15980 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 15981 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 15982 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}. 15983 */ 15984 public void setSystemUiVisibility(int visibility) { 15985 if (visibility != mSystemUiVisibility) { 15986 mSystemUiVisibility = visibility; 15987 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 15988 mParent.recomputeViewAttributes(this); 15989 } 15990 } 15991 } 15992 15993 /** 15994 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested. 15995 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 15996 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 15997 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 15998 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}. 15999 */ 16000 public int getSystemUiVisibility() { 16001 return mSystemUiVisibility; 16002 } 16003 16004 /** 16005 * Returns the current system UI visibility that is currently set for 16006 * the entire window. This is the combination of the 16007 * {@link #setSystemUiVisibility(int)} values supplied by all of the 16008 * views in the window. 16009 */ 16010 public int getWindowSystemUiVisibility() { 16011 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0; 16012 } 16013 16014 /** 16015 * Override to find out when the window's requested system UI visibility 16016 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}. 16017 * This is different from the callbacks recieved through 16018 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)} 16019 * in that this is only telling you about the local request of the window, 16020 * not the actual values applied by the system. 16021 */ 16022 public void onWindowSystemUiVisibilityChanged(int visible) { 16023 } 16024 16025 /** 16026 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down 16027 * the view hierarchy. 16028 */ 16029 public void dispatchWindowSystemUiVisiblityChanged(int visible) { 16030 onWindowSystemUiVisibilityChanged(visible); 16031 } 16032 16033 /** 16034 * Set a listener to receive callbacks when the visibility of the system bar changes. 16035 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 16036 */ 16037 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 16038 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 16039 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 16040 mParent.recomputeViewAttributes(this); 16041 } 16042 } 16043 16044 /** 16045 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 16046 * the view hierarchy. 16047 */ 16048 public void dispatchSystemUiVisibilityChanged(int visibility) { 16049 ListenerInfo li = mListenerInfo; 16050 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 16051 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 16052 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 16053 } 16054 } 16055 16056 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) { 16057 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 16058 if (val != mSystemUiVisibility) { 16059 setSystemUiVisibility(val); 16060 return true; 16061 } 16062 return false; 16063 } 16064 16065 /** @hide */ 16066 public void setDisabledSystemUiVisibility(int flags) { 16067 if (mAttachInfo != null) { 16068 if (mAttachInfo.mDisabledSystemUiVisibility != flags) { 16069 mAttachInfo.mDisabledSystemUiVisibility = flags; 16070 if (mParent != null) { 16071 mParent.recomputeViewAttributes(this); 16072 } 16073 } 16074 } 16075 } 16076 16077 /** 16078 * Creates an image that the system displays during the drag and drop 16079 * operation. This is called a "drag shadow". The default implementation 16080 * for a DragShadowBuilder based on a View returns an image that has exactly the same 16081 * appearance as the given View. The default also positions the center of the drag shadow 16082 * directly under the touch point. If no View is provided (the constructor with no parameters 16083 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 16084 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 16085 * default is an invisible drag shadow. 16086 * <p> 16087 * You are not required to use the View you provide to the constructor as the basis of the 16088 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 16089 * anything you want as the drag shadow. 16090 * </p> 16091 * <p> 16092 * You pass a DragShadowBuilder object to the system when you start the drag. The system 16093 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 16094 * size and position of the drag shadow. It uses this data to construct a 16095 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 16096 * so that your application can draw the shadow image in the Canvas. 16097 * </p> 16098 * 16099 * <div class="special reference"> 16100 * <h3>Developer Guides</h3> 16101 * <p>For a guide to implementing drag and drop features, read the 16102 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 16103 * </div> 16104 */ 16105 public static class DragShadowBuilder { 16106 private final WeakReference<View> mView; 16107 16108 /** 16109 * Constructs a shadow image builder based on a View. By default, the resulting drag 16110 * shadow will have the same appearance and dimensions as the View, with the touch point 16111 * over the center of the View. 16112 * @param view A View. Any View in scope can be used. 16113 */ 16114 public DragShadowBuilder(View view) { 16115 mView = new WeakReference<View>(view); 16116 } 16117 16118 /** 16119 * Construct a shadow builder object with no associated View. This 16120 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 16121 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 16122 * to supply the drag shadow's dimensions and appearance without 16123 * reference to any View object. If they are not overridden, then the result is an 16124 * invisible drag shadow. 16125 */ 16126 public DragShadowBuilder() { 16127 mView = new WeakReference<View>(null); 16128 } 16129 16130 /** 16131 * Returns the View object that had been passed to the 16132 * {@link #View.DragShadowBuilder(View)} 16133 * constructor. If that View parameter was {@code null} or if the 16134 * {@link #View.DragShadowBuilder()} 16135 * constructor was used to instantiate the builder object, this method will return 16136 * null. 16137 * 16138 * @return The View object associate with this builder object. 16139 */ 16140 @SuppressWarnings({"JavadocReference"}) 16141 final public View getView() { 16142 return mView.get(); 16143 } 16144 16145 /** 16146 * Provides the metrics for the shadow image. These include the dimensions of 16147 * the shadow image, and the point within that shadow that should 16148 * be centered under the touch location while dragging. 16149 * <p> 16150 * The default implementation sets the dimensions of the shadow to be the 16151 * same as the dimensions of the View itself and centers the shadow under 16152 * the touch point. 16153 * </p> 16154 * 16155 * @param shadowSize A {@link android.graphics.Point} containing the width and height 16156 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 16157 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 16158 * image. 16159 * 16160 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 16161 * shadow image that should be underneath the touch point during the drag and drop 16162 * operation. Your application must set {@link android.graphics.Point#x} to the 16163 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 16164 */ 16165 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 16166 final View view = mView.get(); 16167 if (view != null) { 16168 shadowSize.set(view.getWidth(), view.getHeight()); 16169 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 16170 } else { 16171 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 16172 } 16173 } 16174 16175 /** 16176 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 16177 * based on the dimensions it received from the 16178 * {@link #onProvideShadowMetrics(Point, Point)} callback. 16179 * 16180 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 16181 */ 16182 public void onDrawShadow(Canvas canvas) { 16183 final View view = mView.get(); 16184 if (view != null) { 16185 view.draw(canvas); 16186 } else { 16187 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 16188 } 16189 } 16190 } 16191 16192 /** 16193 * Starts a drag and drop operation. When your application calls this method, it passes a 16194 * {@link android.view.View.DragShadowBuilder} object to the system. The 16195 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 16196 * to get metrics for the drag shadow, and then calls the object's 16197 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 16198 * <p> 16199 * Once the system has the drag shadow, it begins the drag and drop operation by sending 16200 * drag events to all the View objects in your application that are currently visible. It does 16201 * this either by calling the View object's drag listener (an implementation of 16202 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 16203 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 16204 * Both are passed a {@link android.view.DragEvent} object that has a 16205 * {@link android.view.DragEvent#getAction()} value of 16206 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 16207 * </p> 16208 * <p> 16209 * Your application can invoke startDrag() on any attached View object. The View object does not 16210 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 16211 * be related to the View the user selected for dragging. 16212 * </p> 16213 * @param data A {@link android.content.ClipData} object pointing to the data to be 16214 * transferred by the drag and drop operation. 16215 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 16216 * drag shadow. 16217 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 16218 * drop operation. This Object is put into every DragEvent object sent by the system during the 16219 * current drag. 16220 * <p> 16221 * myLocalState is a lightweight mechanism for the sending information from the dragged View 16222 * to the target Views. For example, it can contain flags that differentiate between a 16223 * a copy operation and a move operation. 16224 * </p> 16225 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 16226 * so the parameter should be set to 0. 16227 * @return {@code true} if the method completes successfully, or 16228 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 16229 * do a drag, and so no drag operation is in progress. 16230 */ 16231 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 16232 Object myLocalState, int flags) { 16233 if (ViewDebug.DEBUG_DRAG) { 16234 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 16235 } 16236 boolean okay = false; 16237 16238 Point shadowSize = new Point(); 16239 Point shadowTouchPoint = new Point(); 16240 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 16241 16242 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 16243 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 16244 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 16245 } 16246 16247 if (ViewDebug.DEBUG_DRAG) { 16248 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 16249 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 16250 } 16251 Surface surface = new Surface(); 16252 try { 16253 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 16254 flags, shadowSize.x, shadowSize.y, surface); 16255 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 16256 + " surface=" + surface); 16257 if (token != null) { 16258 Canvas canvas = surface.lockCanvas(null); 16259 try { 16260 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 16261 shadowBuilder.onDrawShadow(canvas); 16262 } finally { 16263 surface.unlockCanvasAndPost(canvas); 16264 } 16265 16266 final ViewRootImpl root = getViewRootImpl(); 16267 16268 // Cache the local state object for delivery with DragEvents 16269 root.setLocalDragState(myLocalState); 16270 16271 // repurpose 'shadowSize' for the last touch point 16272 root.getLastTouchPoint(shadowSize); 16273 16274 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 16275 shadowSize.x, shadowSize.y, 16276 shadowTouchPoint.x, shadowTouchPoint.y, data); 16277 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 16278 16279 // Off and running! Release our local surface instance; the drag 16280 // shadow surface is now managed by the system process. 16281 surface.release(); 16282 } 16283 } catch (Exception e) { 16284 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 16285 surface.destroy(); 16286 } 16287 16288 return okay; 16289 } 16290 16291 /** 16292 * Handles drag events sent by the system following a call to 16293 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 16294 *<p> 16295 * When the system calls this method, it passes a 16296 * {@link android.view.DragEvent} object. A call to 16297 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 16298 * in DragEvent. The method uses these to determine what is happening in the drag and drop 16299 * operation. 16300 * @param event The {@link android.view.DragEvent} sent by the system. 16301 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 16302 * in DragEvent, indicating the type of drag event represented by this object. 16303 * @return {@code true} if the method was successful, otherwise {@code false}. 16304 * <p> 16305 * The method should return {@code true} in response to an action type of 16306 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 16307 * operation. 16308 * </p> 16309 * <p> 16310 * The method should also return {@code true} in response to an action type of 16311 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 16312 * {@code false} if it didn't. 16313 * </p> 16314 */ 16315 public boolean onDragEvent(DragEvent event) { 16316 return false; 16317 } 16318 16319 /** 16320 * Detects if this View is enabled and has a drag event listener. 16321 * If both are true, then it calls the drag event listener with the 16322 * {@link android.view.DragEvent} it received. If the drag event listener returns 16323 * {@code true}, then dispatchDragEvent() returns {@code true}. 16324 * <p> 16325 * For all other cases, the method calls the 16326 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 16327 * method and returns its result. 16328 * </p> 16329 * <p> 16330 * This ensures that a drag event is always consumed, even if the View does not have a drag 16331 * event listener. However, if the View has a listener and the listener returns true, then 16332 * onDragEvent() is not called. 16333 * </p> 16334 */ 16335 public boolean dispatchDragEvent(DragEvent event) { 16336 //noinspection SimplifiableIfStatement 16337 ListenerInfo li = mListenerInfo; 16338 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 16339 && li.mOnDragListener.onDrag(this, event)) { 16340 return true; 16341 } 16342 return onDragEvent(event); 16343 } 16344 16345 boolean canAcceptDrag() { 16346 return (mPrivateFlags2 & PFLAG2_DRAG_CAN_ACCEPT) != 0; 16347 } 16348 16349 /** 16350 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 16351 * it is ever exposed at all. 16352 * @hide 16353 */ 16354 public void onCloseSystemDialogs(String reason) { 16355 } 16356 16357 /** 16358 * Given a Drawable whose bounds have been set to draw into this view, 16359 * update a Region being computed for 16360 * {@link #gatherTransparentRegion(android.graphics.Region)} so 16361 * that any non-transparent parts of the Drawable are removed from the 16362 * given transparent region. 16363 * 16364 * @param dr The Drawable whose transparency is to be applied to the region. 16365 * @param region A Region holding the current transparency information, 16366 * where any parts of the region that are set are considered to be 16367 * transparent. On return, this region will be modified to have the 16368 * transparency information reduced by the corresponding parts of the 16369 * Drawable that are not transparent. 16370 * {@hide} 16371 */ 16372 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 16373 if (DBG) { 16374 Log.i("View", "Getting transparent region for: " + this); 16375 } 16376 final Region r = dr.getTransparentRegion(); 16377 final Rect db = dr.getBounds(); 16378 final AttachInfo attachInfo = mAttachInfo; 16379 if (r != null && attachInfo != null) { 16380 final int w = getRight()-getLeft(); 16381 final int h = getBottom()-getTop(); 16382 if (db.left > 0) { 16383 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 16384 r.op(0, 0, db.left, h, Region.Op.UNION); 16385 } 16386 if (db.right < w) { 16387 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 16388 r.op(db.right, 0, w, h, Region.Op.UNION); 16389 } 16390 if (db.top > 0) { 16391 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 16392 r.op(0, 0, w, db.top, Region.Op.UNION); 16393 } 16394 if (db.bottom < h) { 16395 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 16396 r.op(0, db.bottom, w, h, Region.Op.UNION); 16397 } 16398 final int[] location = attachInfo.mTransparentLocation; 16399 getLocationInWindow(location); 16400 r.translate(location[0], location[1]); 16401 region.op(r, Region.Op.INTERSECT); 16402 } else { 16403 region.op(db, Region.Op.DIFFERENCE); 16404 } 16405 } 16406 16407 private void checkForLongClick(int delayOffset) { 16408 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 16409 mHasPerformedLongPress = false; 16410 16411 if (mPendingCheckForLongPress == null) { 16412 mPendingCheckForLongPress = new CheckForLongPress(); 16413 } 16414 mPendingCheckForLongPress.rememberWindowAttachCount(); 16415 postDelayed(mPendingCheckForLongPress, 16416 ViewConfiguration.getLongPressTimeout() - delayOffset); 16417 } 16418 } 16419 16420 /** 16421 * Inflate a view from an XML resource. This convenience method wraps the {@link 16422 * LayoutInflater} class, which provides a full range of options for view inflation. 16423 * 16424 * @param context The Context object for your activity or application. 16425 * @param resource The resource ID to inflate 16426 * @param root A view group that will be the parent. Used to properly inflate the 16427 * layout_* parameters. 16428 * @see LayoutInflater 16429 */ 16430 public static View inflate(Context context, int resource, ViewGroup root) { 16431 LayoutInflater factory = LayoutInflater.from(context); 16432 return factory.inflate(resource, root); 16433 } 16434 16435 /** 16436 * Scroll the view with standard behavior for scrolling beyond the normal 16437 * content boundaries. Views that call this method should override 16438 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 16439 * results of an over-scroll operation. 16440 * 16441 * Views can use this method to handle any touch or fling-based scrolling. 16442 * 16443 * @param deltaX Change in X in pixels 16444 * @param deltaY Change in Y in pixels 16445 * @param scrollX Current X scroll value in pixels before applying deltaX 16446 * @param scrollY Current Y scroll value in pixels before applying deltaY 16447 * @param scrollRangeX Maximum content scroll range along the X axis 16448 * @param scrollRangeY Maximum content scroll range along the Y axis 16449 * @param maxOverScrollX Number of pixels to overscroll by in either direction 16450 * along the X axis. 16451 * @param maxOverScrollY Number of pixels to overscroll by in either direction 16452 * along the Y axis. 16453 * @param isTouchEvent true if this scroll operation is the result of a touch event. 16454 * @return true if scrolling was clamped to an over-scroll boundary along either 16455 * axis, false otherwise. 16456 */ 16457 @SuppressWarnings({"UnusedParameters"}) 16458 protected boolean overScrollBy(int deltaX, int deltaY, 16459 int scrollX, int scrollY, 16460 int scrollRangeX, int scrollRangeY, 16461 int maxOverScrollX, int maxOverScrollY, 16462 boolean isTouchEvent) { 16463 final int overScrollMode = mOverScrollMode; 16464 final boolean canScrollHorizontal = 16465 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 16466 final boolean canScrollVertical = 16467 computeVerticalScrollRange() > computeVerticalScrollExtent(); 16468 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 16469 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 16470 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 16471 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 16472 16473 int newScrollX = scrollX + deltaX; 16474 if (!overScrollHorizontal) { 16475 maxOverScrollX = 0; 16476 } 16477 16478 int newScrollY = scrollY + deltaY; 16479 if (!overScrollVertical) { 16480 maxOverScrollY = 0; 16481 } 16482 16483 // Clamp values if at the limits and record 16484 final int left = -maxOverScrollX; 16485 final int right = maxOverScrollX + scrollRangeX; 16486 final int top = -maxOverScrollY; 16487 final int bottom = maxOverScrollY + scrollRangeY; 16488 16489 boolean clampedX = false; 16490 if (newScrollX > right) { 16491 newScrollX = right; 16492 clampedX = true; 16493 } else if (newScrollX < left) { 16494 newScrollX = left; 16495 clampedX = true; 16496 } 16497 16498 boolean clampedY = false; 16499 if (newScrollY > bottom) { 16500 newScrollY = bottom; 16501 clampedY = true; 16502 } else if (newScrollY < top) { 16503 newScrollY = top; 16504 clampedY = true; 16505 } 16506 16507 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 16508 16509 return clampedX || clampedY; 16510 } 16511 16512 /** 16513 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 16514 * respond to the results of an over-scroll operation. 16515 * 16516 * @param scrollX New X scroll value in pixels 16517 * @param scrollY New Y scroll value in pixels 16518 * @param clampedX True if scrollX was clamped to an over-scroll boundary 16519 * @param clampedY True if scrollY was clamped to an over-scroll boundary 16520 */ 16521 protected void onOverScrolled(int scrollX, int scrollY, 16522 boolean clampedX, boolean clampedY) { 16523 // Intentionally empty. 16524 } 16525 16526 /** 16527 * Returns the over-scroll mode for this view. The result will be 16528 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 16529 * (allow over-scrolling only if the view content is larger than the container), 16530 * or {@link #OVER_SCROLL_NEVER}. 16531 * 16532 * @return This view's over-scroll mode. 16533 */ 16534 public int getOverScrollMode() { 16535 return mOverScrollMode; 16536 } 16537 16538 /** 16539 * Set the over-scroll mode for this view. Valid over-scroll modes are 16540 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 16541 * (allow over-scrolling only if the view content is larger than the container), 16542 * or {@link #OVER_SCROLL_NEVER}. 16543 * 16544 * Setting the over-scroll mode of a view will have an effect only if the 16545 * view is capable of scrolling. 16546 * 16547 * @param overScrollMode The new over-scroll mode for this view. 16548 */ 16549 public void setOverScrollMode(int overScrollMode) { 16550 if (overScrollMode != OVER_SCROLL_ALWAYS && 16551 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 16552 overScrollMode != OVER_SCROLL_NEVER) { 16553 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 16554 } 16555 mOverScrollMode = overScrollMode; 16556 } 16557 16558 /** 16559 * Gets a scale factor that determines the distance the view should scroll 16560 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 16561 * @return The vertical scroll scale factor. 16562 * @hide 16563 */ 16564 protected float getVerticalScrollFactor() { 16565 if (mVerticalScrollFactor == 0) { 16566 TypedValue outValue = new TypedValue(); 16567 if (!mContext.getTheme().resolveAttribute( 16568 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 16569 throw new IllegalStateException( 16570 "Expected theme to define listPreferredItemHeight."); 16571 } 16572 mVerticalScrollFactor = outValue.getDimension( 16573 mContext.getResources().getDisplayMetrics()); 16574 } 16575 return mVerticalScrollFactor; 16576 } 16577 16578 /** 16579 * Gets a scale factor that determines the distance the view should scroll 16580 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 16581 * @return The horizontal scroll scale factor. 16582 * @hide 16583 */ 16584 protected float getHorizontalScrollFactor() { 16585 // TODO: Should use something else. 16586 return getVerticalScrollFactor(); 16587 } 16588 16589 /** 16590 * Return the value specifying the text direction or policy that was set with 16591 * {@link #setTextDirection(int)}. 16592 * 16593 * @return the defined text direction. It can be one of: 16594 * 16595 * {@link #TEXT_DIRECTION_INHERIT}, 16596 * {@link #TEXT_DIRECTION_FIRST_STRONG} 16597 * {@link #TEXT_DIRECTION_ANY_RTL}, 16598 * {@link #TEXT_DIRECTION_LTR}, 16599 * {@link #TEXT_DIRECTION_RTL}, 16600 * {@link #TEXT_DIRECTION_LOCALE} 16601 * 16602 * @hide 16603 */ 16604 @ViewDebug.ExportedProperty(category = "text", mapping = { 16605 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 16606 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 16607 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 16608 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 16609 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 16610 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 16611 }) 16612 public int getRawTextDirection() { 16613 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_MASK) >> PFLAG2_TEXT_DIRECTION_MASK_SHIFT; 16614 } 16615 16616 /** 16617 * Set the text direction. 16618 * 16619 * @param textDirection the direction to set. Should be one of: 16620 * 16621 * {@link #TEXT_DIRECTION_INHERIT}, 16622 * {@link #TEXT_DIRECTION_FIRST_STRONG} 16623 * {@link #TEXT_DIRECTION_ANY_RTL}, 16624 * {@link #TEXT_DIRECTION_LTR}, 16625 * {@link #TEXT_DIRECTION_RTL}, 16626 * {@link #TEXT_DIRECTION_LOCALE} 16627 * 16628 * Resolution will be done if the value is set to TEXT_DIRECTION_INHERIT. The resolution 16629 * proceeds up the parent chain of the view to get the value. If there is no parent, then it will 16630 * return the default {@link #TEXT_DIRECTION_FIRST_STRONG}. 16631 */ 16632 public void setTextDirection(int textDirection) { 16633 if (getRawTextDirection() != textDirection) { 16634 // Reset the current text direction and the resolved one 16635 mPrivateFlags2 &= ~PFLAG2_TEXT_DIRECTION_MASK; 16636 resetResolvedTextDirection(); 16637 // Set the new text direction 16638 mPrivateFlags2 |= ((textDirection << PFLAG2_TEXT_DIRECTION_MASK_SHIFT) & PFLAG2_TEXT_DIRECTION_MASK); 16639 // Do resolution 16640 resolveTextDirection(); 16641 // Notify change 16642 onRtlPropertiesChanged(getLayoutDirection()); 16643 // Refresh 16644 requestLayout(); 16645 invalidate(true); 16646 } 16647 } 16648 16649 /** 16650 * Return the resolved text direction. 16651 * 16652 * @return the resolved text direction. Returns one of: 16653 * 16654 * {@link #TEXT_DIRECTION_FIRST_STRONG} 16655 * {@link #TEXT_DIRECTION_ANY_RTL}, 16656 * {@link #TEXT_DIRECTION_LTR}, 16657 * {@link #TEXT_DIRECTION_RTL}, 16658 * {@link #TEXT_DIRECTION_LOCALE} 16659 */ 16660 public int getTextDirection() { 16661 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED_MASK) >> PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 16662 } 16663 16664 /** 16665 * Resolve the text direction. 16666 * 16667 * @return true if resolution has been done, false otherwise. 16668 * 16669 * @hide 16670 */ 16671 public boolean resolveTextDirection() { 16672 // Reset any previous text direction resolution 16673 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 16674 16675 if (hasRtlSupport()) { 16676 // Set resolved text direction flag depending on text direction flag 16677 final int textDirection = getRawTextDirection(); 16678 switch(textDirection) { 16679 case TEXT_DIRECTION_INHERIT: 16680 if (!canResolveTextDirection()) { 16681 // We cannot do the resolution if there is no parent, so use the default one 16682 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 16683 // Resolution will need to happen again later 16684 return false; 16685 } 16686 16687 View parent = ((View) mParent); 16688 // Parent has not yet resolved, so we still return the default 16689 if (!parent.isTextDirectionResolved()) { 16690 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 16691 // Resolution will need to happen again later 16692 return false; 16693 } 16694 16695 // Set current resolved direction to the same value as the parent's one 16696 final int parentResolvedDirection = parent.getTextDirection(); 16697 switch (parentResolvedDirection) { 16698 case TEXT_DIRECTION_FIRST_STRONG: 16699 case TEXT_DIRECTION_ANY_RTL: 16700 case TEXT_DIRECTION_LTR: 16701 case TEXT_DIRECTION_RTL: 16702 case TEXT_DIRECTION_LOCALE: 16703 mPrivateFlags2 |= 16704 (parentResolvedDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 16705 break; 16706 default: 16707 // Default resolved direction is "first strong" heuristic 16708 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 16709 } 16710 break; 16711 case TEXT_DIRECTION_FIRST_STRONG: 16712 case TEXT_DIRECTION_ANY_RTL: 16713 case TEXT_DIRECTION_LTR: 16714 case TEXT_DIRECTION_RTL: 16715 case TEXT_DIRECTION_LOCALE: 16716 // Resolved direction is the same as text direction 16717 mPrivateFlags2 |= (textDirection << PFLAG2_TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 16718 break; 16719 default: 16720 // Default resolved direction is "first strong" heuristic 16721 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 16722 } 16723 } else { 16724 // Default resolved direction is "first strong" heuristic 16725 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 16726 } 16727 16728 // Set to resolved 16729 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED; 16730 return true; 16731 } 16732 16733 /** 16734 * Check if text direction resolution can be done. 16735 * 16736 * @return true if text direction resolution can be done otherwise return false. 16737 */ 16738 private boolean canResolveTextDirection() { 16739 switch (getRawTextDirection()) { 16740 case TEXT_DIRECTION_INHERIT: 16741 return (mParent != null) && (mParent instanceof View) && 16742 ((View) mParent).canResolveTextDirection(); 16743 default: 16744 return true; 16745 } 16746 } 16747 16748 /** 16749 * Reset resolved text direction. Text direction will be resolved during a call to 16750 * {@link #onMeasure(int, int)}. 16751 * 16752 * @hide 16753 */ 16754 public void resetResolvedTextDirection() { 16755 // Reset any previous text direction resolution 16756 mPrivateFlags2 &= ~(PFLAG2_TEXT_DIRECTION_RESOLVED | PFLAG2_TEXT_DIRECTION_RESOLVED_MASK); 16757 // Set to default value 16758 mPrivateFlags2 |= PFLAG2_TEXT_DIRECTION_RESOLVED_DEFAULT; 16759 } 16760 16761 /** 16762 * @return true if text direction is inherited. 16763 * 16764 * @hide 16765 */ 16766 public boolean isTextDirectionInherited() { 16767 return (getRawTextDirection() == TEXT_DIRECTION_INHERIT); 16768 } 16769 16770 /** 16771 * @return true if text direction is resolved. 16772 */ 16773 private boolean isTextDirectionResolved() { 16774 return (mPrivateFlags2 & PFLAG2_TEXT_DIRECTION_RESOLVED) == PFLAG2_TEXT_DIRECTION_RESOLVED; 16775 } 16776 16777 /** 16778 * Return the value specifying the text alignment or policy that was set with 16779 * {@link #setTextAlignment(int)}. 16780 * 16781 * @return the defined text alignment. It can be one of: 16782 * 16783 * {@link #TEXT_ALIGNMENT_INHERIT}, 16784 * {@link #TEXT_ALIGNMENT_GRAVITY}, 16785 * {@link #TEXT_ALIGNMENT_CENTER}, 16786 * {@link #TEXT_ALIGNMENT_TEXT_START}, 16787 * {@link #TEXT_ALIGNMENT_TEXT_END}, 16788 * {@link #TEXT_ALIGNMENT_VIEW_START}, 16789 * {@link #TEXT_ALIGNMENT_VIEW_END} 16790 * 16791 * @hide 16792 */ 16793 @ViewDebug.ExportedProperty(category = "text", mapping = { 16794 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 16795 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 16796 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 16797 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 16798 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 16799 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 16800 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 16801 }) 16802 public int getRawTextAlignment() { 16803 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_MASK) >> PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT; 16804 } 16805 16806 /** 16807 * Set the text alignment. 16808 * 16809 * @param textAlignment The text alignment to set. Should be one of 16810 * 16811 * {@link #TEXT_ALIGNMENT_INHERIT}, 16812 * {@link #TEXT_ALIGNMENT_GRAVITY}, 16813 * {@link #TEXT_ALIGNMENT_CENTER}, 16814 * {@link #TEXT_ALIGNMENT_TEXT_START}, 16815 * {@link #TEXT_ALIGNMENT_TEXT_END}, 16816 * {@link #TEXT_ALIGNMENT_VIEW_START}, 16817 * {@link #TEXT_ALIGNMENT_VIEW_END} 16818 * 16819 * Resolution will be done if the value is set to TEXT_ALIGNMENT_INHERIT. The resolution 16820 * proceeds up the parent chain of the view to get the value. If there is no parent, then it 16821 * will return the default {@link #TEXT_ALIGNMENT_GRAVITY}. 16822 * 16823 * @attr ref android.R.styleable#View_textAlignment 16824 */ 16825 public void setTextAlignment(int textAlignment) { 16826 if (textAlignment != getRawTextAlignment()) { 16827 // Reset the current and resolved text alignment 16828 mPrivateFlags2 &= ~PFLAG2_TEXT_ALIGNMENT_MASK; 16829 resetResolvedTextAlignment(); 16830 // Set the new text alignment 16831 mPrivateFlags2 |= 16832 ((textAlignment << PFLAG2_TEXT_ALIGNMENT_MASK_SHIFT) & PFLAG2_TEXT_ALIGNMENT_MASK); 16833 // Do resolution 16834 resolveTextAlignment(); 16835 // Notify change 16836 onRtlPropertiesChanged(getLayoutDirection()); 16837 // Refresh 16838 requestLayout(); 16839 invalidate(true); 16840 } 16841 } 16842 16843 /** 16844 * Return the resolved text alignment. 16845 * 16846 * @return the resolved text alignment. Returns one of: 16847 * 16848 * {@link #TEXT_ALIGNMENT_GRAVITY}, 16849 * {@link #TEXT_ALIGNMENT_CENTER}, 16850 * {@link #TEXT_ALIGNMENT_TEXT_START}, 16851 * {@link #TEXT_ALIGNMENT_TEXT_END}, 16852 * {@link #TEXT_ALIGNMENT_VIEW_START}, 16853 * {@link #TEXT_ALIGNMENT_VIEW_END} 16854 */ 16855 @ViewDebug.ExportedProperty(category = "text", mapping = { 16856 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 16857 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 16858 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 16859 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 16860 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 16861 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 16862 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 16863 }) 16864 public int getTextAlignment() { 16865 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK) >> 16866 PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 16867 } 16868 16869 /** 16870 * Resolve the text alignment. 16871 * 16872 * @return true if resolution has been done, false otherwise. 16873 * 16874 * @hide 16875 */ 16876 public boolean resolveTextAlignment() { 16877 // Reset any previous text alignment resolution 16878 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 16879 16880 if (hasRtlSupport()) { 16881 // Set resolved text alignment flag depending on text alignment flag 16882 final int textAlignment = getRawTextAlignment(); 16883 switch (textAlignment) { 16884 case TEXT_ALIGNMENT_INHERIT: 16885 // Check if we can resolve the text alignment 16886 if (!canResolveTextAlignment()) { 16887 // We cannot do the resolution if there is no parent so use the default 16888 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16889 // Resolution will need to happen again later 16890 return false; 16891 } 16892 View parent = (View) mParent; 16893 16894 // Parent has not yet resolved, so we still return the default 16895 if (!parent.isTextAlignmentResolved()) { 16896 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16897 // Resolution will need to happen again later 16898 return false; 16899 } 16900 16901 final int parentResolvedTextAlignment = parent.getTextAlignment(); 16902 switch (parentResolvedTextAlignment) { 16903 case TEXT_ALIGNMENT_GRAVITY: 16904 case TEXT_ALIGNMENT_TEXT_START: 16905 case TEXT_ALIGNMENT_TEXT_END: 16906 case TEXT_ALIGNMENT_CENTER: 16907 case TEXT_ALIGNMENT_VIEW_START: 16908 case TEXT_ALIGNMENT_VIEW_END: 16909 // Resolved text alignment is the same as the parent resolved 16910 // text alignment 16911 mPrivateFlags2 |= 16912 (parentResolvedTextAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 16913 break; 16914 default: 16915 // Use default resolved text alignment 16916 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16917 } 16918 break; 16919 case TEXT_ALIGNMENT_GRAVITY: 16920 case TEXT_ALIGNMENT_TEXT_START: 16921 case TEXT_ALIGNMENT_TEXT_END: 16922 case TEXT_ALIGNMENT_CENTER: 16923 case TEXT_ALIGNMENT_VIEW_START: 16924 case TEXT_ALIGNMENT_VIEW_END: 16925 // Resolved text alignment is the same as text alignment 16926 mPrivateFlags2 |= (textAlignment << PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 16927 break; 16928 default: 16929 // Use default resolved text alignment 16930 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16931 } 16932 } else { 16933 // Use default resolved text alignment 16934 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16935 } 16936 16937 // Set the resolved 16938 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED; 16939 return true; 16940 } 16941 16942 /** 16943 * Check if text alignment resolution can be done. 16944 * 16945 * @return true if text alignment resolution can be done otherwise return false. 16946 */ 16947 private boolean canResolveTextAlignment() { 16948 switch (getRawTextAlignment()) { 16949 case TEXT_DIRECTION_INHERIT: 16950 return (mParent != null) && (mParent instanceof View) && 16951 ((View) mParent).canResolveTextAlignment(); 16952 default: 16953 return true; 16954 } 16955 } 16956 16957 /** 16958 * Reset resolved text alignment. Text alignment will be resolved during a call to 16959 * {@link #onMeasure(int, int)}. 16960 * 16961 * @hide 16962 */ 16963 public void resetResolvedTextAlignment() { 16964 // Reset any previous text alignment resolution 16965 mPrivateFlags2 &= ~(PFLAG2_TEXT_ALIGNMENT_RESOLVED | PFLAG2_TEXT_ALIGNMENT_RESOLVED_MASK); 16966 // Set to default 16967 mPrivateFlags2 |= PFLAG2_TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16968 } 16969 16970 /** 16971 * @return true if text alignment is inherited. 16972 * 16973 * @hide 16974 */ 16975 public boolean isTextAlignmentInherited() { 16976 return (getRawTextAlignment() == TEXT_ALIGNMENT_INHERIT); 16977 } 16978 16979 /** 16980 * @return true if text alignment is resolved. 16981 */ 16982 private boolean isTextAlignmentResolved() { 16983 return (mPrivateFlags2 & PFLAG2_TEXT_ALIGNMENT_RESOLVED) == PFLAG2_TEXT_ALIGNMENT_RESOLVED; 16984 } 16985 16986 /** 16987 * Generate a value suitable for use in {@link #setId(int)}. 16988 * This value will not collide with ID values generated at build time by aapt for R.id. 16989 * 16990 * @return a generated ID value 16991 */ 16992 public static int generateViewId() { 16993 for (;;) { 16994 final int result = sNextGeneratedId.get(); 16995 // aapt-generated IDs have the high byte nonzero; clamp to the range under that. 16996 int newValue = result + 1; 16997 if (newValue > 0x00FFFFFF) newValue = 1; // Roll over to 1, not 0. 16998 if (sNextGeneratedId.compareAndSet(result, newValue)) { 16999 return result; 17000 } 17001 } 17002 } 17003 17004 // 17005 // Properties 17006 // 17007 /** 17008 * A Property wrapper around the <code>alpha</code> functionality handled by the 17009 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 17010 */ 17011 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 17012 @Override 17013 public void setValue(View object, float value) { 17014 object.setAlpha(value); 17015 } 17016 17017 @Override 17018 public Float get(View object) { 17019 return object.getAlpha(); 17020 } 17021 }; 17022 17023 /** 17024 * A Property wrapper around the <code>translationX</code> functionality handled by the 17025 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 17026 */ 17027 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 17028 @Override 17029 public void setValue(View object, float value) { 17030 object.setTranslationX(value); 17031 } 17032 17033 @Override 17034 public Float get(View object) { 17035 return object.getTranslationX(); 17036 } 17037 }; 17038 17039 /** 17040 * A Property wrapper around the <code>translationY</code> functionality handled by the 17041 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 17042 */ 17043 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 17044 @Override 17045 public void setValue(View object, float value) { 17046 object.setTranslationY(value); 17047 } 17048 17049 @Override 17050 public Float get(View object) { 17051 return object.getTranslationY(); 17052 } 17053 }; 17054 17055 /** 17056 * A Property wrapper around the <code>x</code> functionality handled by the 17057 * {@link View#setX(float)} and {@link View#getX()} methods. 17058 */ 17059 public static final Property<View, Float> X = new FloatProperty<View>("x") { 17060 @Override 17061 public void setValue(View object, float value) { 17062 object.setX(value); 17063 } 17064 17065 @Override 17066 public Float get(View object) { 17067 return object.getX(); 17068 } 17069 }; 17070 17071 /** 17072 * A Property wrapper around the <code>y</code> functionality handled by the 17073 * {@link View#setY(float)} and {@link View#getY()} methods. 17074 */ 17075 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 17076 @Override 17077 public void setValue(View object, float value) { 17078 object.setY(value); 17079 } 17080 17081 @Override 17082 public Float get(View object) { 17083 return object.getY(); 17084 } 17085 }; 17086 17087 /** 17088 * A Property wrapper around the <code>rotation</code> functionality handled by the 17089 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 17090 */ 17091 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 17092 @Override 17093 public void setValue(View object, float value) { 17094 object.setRotation(value); 17095 } 17096 17097 @Override 17098 public Float get(View object) { 17099 return object.getRotation(); 17100 } 17101 }; 17102 17103 /** 17104 * A Property wrapper around the <code>rotationX</code> functionality handled by the 17105 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 17106 */ 17107 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 17108 @Override 17109 public void setValue(View object, float value) { 17110 object.setRotationX(value); 17111 } 17112 17113 @Override 17114 public Float get(View object) { 17115 return object.getRotationX(); 17116 } 17117 }; 17118 17119 /** 17120 * A Property wrapper around the <code>rotationY</code> functionality handled by the 17121 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 17122 */ 17123 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 17124 @Override 17125 public void setValue(View object, float value) { 17126 object.setRotationY(value); 17127 } 17128 17129 @Override 17130 public Float get(View object) { 17131 return object.getRotationY(); 17132 } 17133 }; 17134 17135 /** 17136 * A Property wrapper around the <code>scaleX</code> functionality handled by the 17137 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 17138 */ 17139 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 17140 @Override 17141 public void setValue(View object, float value) { 17142 object.setScaleX(value); 17143 } 17144 17145 @Override 17146 public Float get(View object) { 17147 return object.getScaleX(); 17148 } 17149 }; 17150 17151 /** 17152 * A Property wrapper around the <code>scaleY</code> functionality handled by the 17153 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 17154 */ 17155 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 17156 @Override 17157 public void setValue(View object, float value) { 17158 object.setScaleY(value); 17159 } 17160 17161 @Override 17162 public Float get(View object) { 17163 return object.getScaleY(); 17164 } 17165 }; 17166 17167 /** 17168 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 17169 * Each MeasureSpec represents a requirement for either the width or the height. 17170 * A MeasureSpec is comprised of a size and a mode. There are three possible 17171 * modes: 17172 * <dl> 17173 * <dt>UNSPECIFIED</dt> 17174 * <dd> 17175 * The parent has not imposed any constraint on the child. It can be whatever size 17176 * it wants. 17177 * </dd> 17178 * 17179 * <dt>EXACTLY</dt> 17180 * <dd> 17181 * The parent has determined an exact size for the child. The child is going to be 17182 * given those bounds regardless of how big it wants to be. 17183 * </dd> 17184 * 17185 * <dt>AT_MOST</dt> 17186 * <dd> 17187 * The child can be as large as it wants up to the specified size. 17188 * </dd> 17189 * </dl> 17190 * 17191 * MeasureSpecs are implemented as ints to reduce object allocation. This class 17192 * is provided to pack and unpack the <size, mode> tuple into the int. 17193 */ 17194 public static class MeasureSpec { 17195 private static final int MODE_SHIFT = 30; 17196 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 17197 17198 /** 17199 * Measure specification mode: The parent has not imposed any constraint 17200 * on the child. It can be whatever size it wants. 17201 */ 17202 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 17203 17204 /** 17205 * Measure specification mode: The parent has determined an exact size 17206 * for the child. The child is going to be given those bounds regardless 17207 * of how big it wants to be. 17208 */ 17209 public static final int EXACTLY = 1 << MODE_SHIFT; 17210 17211 /** 17212 * Measure specification mode: The child can be as large as it wants up 17213 * to the specified size. 17214 */ 17215 public static final int AT_MOST = 2 << MODE_SHIFT; 17216 17217 /** 17218 * Creates a measure specification based on the supplied size and mode. 17219 * 17220 * The mode must always be one of the following: 17221 * <ul> 17222 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 17223 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 17224 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 17225 * </ul> 17226 * 17227 * @param size the size of the measure specification 17228 * @param mode the mode of the measure specification 17229 * @return the measure specification based on size and mode 17230 */ 17231 public static int makeMeasureSpec(int size, int mode) { 17232 return size + mode; 17233 } 17234 17235 /** 17236 * Extracts the mode from the supplied measure specification. 17237 * 17238 * @param measureSpec the measure specification to extract the mode from 17239 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 17240 * {@link android.view.View.MeasureSpec#AT_MOST} or 17241 * {@link android.view.View.MeasureSpec#EXACTLY} 17242 */ 17243 public static int getMode(int measureSpec) { 17244 return (measureSpec & MODE_MASK); 17245 } 17246 17247 /** 17248 * Extracts the size from the supplied measure specification. 17249 * 17250 * @param measureSpec the measure specification to extract the size from 17251 * @return the size in pixels defined in the supplied measure specification 17252 */ 17253 public static int getSize(int measureSpec) { 17254 return (measureSpec & ~MODE_MASK); 17255 } 17256 17257 /** 17258 * Returns a String representation of the specified measure 17259 * specification. 17260 * 17261 * @param measureSpec the measure specification to convert to a String 17262 * @return a String with the following format: "MeasureSpec: MODE SIZE" 17263 */ 17264 public static String toString(int measureSpec) { 17265 int mode = getMode(measureSpec); 17266 int size = getSize(measureSpec); 17267 17268 StringBuilder sb = new StringBuilder("MeasureSpec: "); 17269 17270 if (mode == UNSPECIFIED) 17271 sb.append("UNSPECIFIED "); 17272 else if (mode == EXACTLY) 17273 sb.append("EXACTLY "); 17274 else if (mode == AT_MOST) 17275 sb.append("AT_MOST "); 17276 else 17277 sb.append(mode).append(" "); 17278 17279 sb.append(size); 17280 return sb.toString(); 17281 } 17282 } 17283 17284 class CheckForLongPress implements Runnable { 17285 17286 private int mOriginalWindowAttachCount; 17287 17288 public void run() { 17289 if (isPressed() && (mParent != null) 17290 && mOriginalWindowAttachCount == mWindowAttachCount) { 17291 if (performLongClick()) { 17292 mHasPerformedLongPress = true; 17293 } 17294 } 17295 } 17296 17297 public void rememberWindowAttachCount() { 17298 mOriginalWindowAttachCount = mWindowAttachCount; 17299 } 17300 } 17301 17302 private final class CheckForTap implements Runnable { 17303 public void run() { 17304 mPrivateFlags &= ~PFLAG_PREPRESSED; 17305 setPressed(true); 17306 checkForLongClick(ViewConfiguration.getTapTimeout()); 17307 } 17308 } 17309 17310 private final class PerformClick implements Runnable { 17311 public void run() { 17312 performClick(); 17313 } 17314 } 17315 17316 /** @hide */ 17317 public void hackTurnOffWindowResizeAnim(boolean off) { 17318 mAttachInfo.mTurnOffWindowResizeAnim = off; 17319 } 17320 17321 /** 17322 * This method returns a ViewPropertyAnimator object, which can be used to animate 17323 * specific properties on this View. 17324 * 17325 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 17326 */ 17327 public ViewPropertyAnimator animate() { 17328 if (mAnimator == null) { 17329 mAnimator = new ViewPropertyAnimator(this); 17330 } 17331 return mAnimator; 17332 } 17333 17334 /** 17335 * Interface definition for a callback to be invoked when a hardware key event is 17336 * dispatched to this view. The callback will be invoked before the key event is 17337 * given to the view. This is only useful for hardware keyboards; a software input 17338 * method has no obligation to trigger this listener. 17339 */ 17340 public interface OnKeyListener { 17341 /** 17342 * Called when a hardware key is dispatched to a view. This allows listeners to 17343 * get a chance to respond before the target view. 17344 * <p>Key presses in software keyboards will generally NOT trigger this method, 17345 * although some may elect to do so in some situations. Do not assume a 17346 * software input method has to be key-based; even if it is, it may use key presses 17347 * in a different way than you expect, so there is no way to reliably catch soft 17348 * input key presses. 17349 * 17350 * @param v The view the key has been dispatched to. 17351 * @param keyCode The code for the physical key that was pressed 17352 * @param event The KeyEvent object containing full information about 17353 * the event. 17354 * @return True if the listener has consumed the event, false otherwise. 17355 */ 17356 boolean onKey(View v, int keyCode, KeyEvent event); 17357 } 17358 17359 /** 17360 * Interface definition for a callback to be invoked when a touch event is 17361 * dispatched to this view. The callback will be invoked before the touch 17362 * event is given to the view. 17363 */ 17364 public interface OnTouchListener { 17365 /** 17366 * Called when a touch event is dispatched to a view. This allows listeners to 17367 * get a chance to respond before the target view. 17368 * 17369 * @param v The view the touch event has been dispatched to. 17370 * @param event The MotionEvent object containing full information about 17371 * the event. 17372 * @return True if the listener has consumed the event, false otherwise. 17373 */ 17374 boolean onTouch(View v, MotionEvent event); 17375 } 17376 17377 /** 17378 * Interface definition for a callback to be invoked when a hover event is 17379 * dispatched to this view. The callback will be invoked before the hover 17380 * event is given to the view. 17381 */ 17382 public interface OnHoverListener { 17383 /** 17384 * Called when a hover event is dispatched to a view. This allows listeners to 17385 * get a chance to respond before the target view. 17386 * 17387 * @param v The view the hover event has been dispatched to. 17388 * @param event The MotionEvent object containing full information about 17389 * the event. 17390 * @return True if the listener has consumed the event, false otherwise. 17391 */ 17392 boolean onHover(View v, MotionEvent event); 17393 } 17394 17395 /** 17396 * Interface definition for a callback to be invoked when a generic motion event is 17397 * dispatched to this view. The callback will be invoked before the generic motion 17398 * event is given to the view. 17399 */ 17400 public interface OnGenericMotionListener { 17401 /** 17402 * Called when a generic motion event is dispatched to a view. This allows listeners to 17403 * get a chance to respond before the target view. 17404 * 17405 * @param v The view the generic motion event has been dispatched to. 17406 * @param event The MotionEvent object containing full information about 17407 * the event. 17408 * @return True if the listener has consumed the event, false otherwise. 17409 */ 17410 boolean onGenericMotion(View v, MotionEvent event); 17411 } 17412 17413 /** 17414 * Interface definition for a callback to be invoked when a view has been clicked and held. 17415 */ 17416 public interface OnLongClickListener { 17417 /** 17418 * Called when a view has been clicked and held. 17419 * 17420 * @param v The view that was clicked and held. 17421 * 17422 * @return true if the callback consumed the long click, false otherwise. 17423 */ 17424 boolean onLongClick(View v); 17425 } 17426 17427 /** 17428 * Interface definition for a callback to be invoked when a drag is being dispatched 17429 * to this view. The callback will be invoked before the hosting view's own 17430 * onDrag(event) method. If the listener wants to fall back to the hosting view's 17431 * onDrag(event) behavior, it should return 'false' from this callback. 17432 * 17433 * <div class="special reference"> 17434 * <h3>Developer Guides</h3> 17435 * <p>For a guide to implementing drag and drop features, read the 17436 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 17437 * </div> 17438 */ 17439 public interface OnDragListener { 17440 /** 17441 * Called when a drag event is dispatched to a view. This allows listeners 17442 * to get a chance to override base View behavior. 17443 * 17444 * @param v The View that received the drag event. 17445 * @param event The {@link android.view.DragEvent} object for the drag event. 17446 * @return {@code true} if the drag event was handled successfully, or {@code false} 17447 * if the drag event was not handled. Note that {@code false} will trigger the View 17448 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 17449 */ 17450 boolean onDrag(View v, DragEvent event); 17451 } 17452 17453 /** 17454 * Interface definition for a callback to be invoked when the focus state of 17455 * a view changed. 17456 */ 17457 public interface OnFocusChangeListener { 17458 /** 17459 * Called when the focus state of a view has changed. 17460 * 17461 * @param v The view whose state has changed. 17462 * @param hasFocus The new focus state of v. 17463 */ 17464 void onFocusChange(View v, boolean hasFocus); 17465 } 17466 17467 /** 17468 * Interface definition for a callback to be invoked when a view is clicked. 17469 */ 17470 public interface OnClickListener { 17471 /** 17472 * Called when a view has been clicked. 17473 * 17474 * @param v The view that was clicked. 17475 */ 17476 void onClick(View v); 17477 } 17478 17479 /** 17480 * Interface definition for a callback to be invoked when the context menu 17481 * for this view is being built. 17482 */ 17483 public interface OnCreateContextMenuListener { 17484 /** 17485 * Called when the context menu for this view is being built. It is not 17486 * safe to hold onto the menu after this method returns. 17487 * 17488 * @param menu The context menu that is being built 17489 * @param v The view for which the context menu is being built 17490 * @param menuInfo Extra information about the item for which the 17491 * context menu should be shown. This information will vary 17492 * depending on the class of v. 17493 */ 17494 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 17495 } 17496 17497 /** 17498 * Interface definition for a callback to be invoked when the status bar changes 17499 * visibility. This reports <strong>global</strong> changes to the system UI 17500 * state, not what the application is requesting. 17501 * 17502 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 17503 */ 17504 public interface OnSystemUiVisibilityChangeListener { 17505 /** 17506 * Called when the status bar changes visibility because of a call to 17507 * {@link View#setSystemUiVisibility(int)}. 17508 * 17509 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 17510 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}. 17511 * This tells you the <strong>global</strong> state of these UI visibility 17512 * flags, not what your app is currently applying. 17513 */ 17514 public void onSystemUiVisibilityChange(int visibility); 17515 } 17516 17517 /** 17518 * Interface definition for a callback to be invoked when this view is attached 17519 * or detached from its window. 17520 */ 17521 public interface OnAttachStateChangeListener { 17522 /** 17523 * Called when the view is attached to a window. 17524 * @param v The view that was attached 17525 */ 17526 public void onViewAttachedToWindow(View v); 17527 /** 17528 * Called when the view is detached from a window. 17529 * @param v The view that was detached 17530 */ 17531 public void onViewDetachedFromWindow(View v); 17532 } 17533 17534 private final class UnsetPressedState implements Runnable { 17535 public void run() { 17536 setPressed(false); 17537 } 17538 } 17539 17540 /** 17541 * Base class for derived classes that want to save and restore their own 17542 * state in {@link android.view.View#onSaveInstanceState()}. 17543 */ 17544 public static class BaseSavedState extends AbsSavedState { 17545 /** 17546 * Constructor used when reading from a parcel. Reads the state of the superclass. 17547 * 17548 * @param source 17549 */ 17550 public BaseSavedState(Parcel source) { 17551 super(source); 17552 } 17553 17554 /** 17555 * Constructor called by derived classes when creating their SavedState objects 17556 * 17557 * @param superState The state of the superclass of this view 17558 */ 17559 public BaseSavedState(Parcelable superState) { 17560 super(superState); 17561 } 17562 17563 public static final Parcelable.Creator<BaseSavedState> CREATOR = 17564 new Parcelable.Creator<BaseSavedState>() { 17565 public BaseSavedState createFromParcel(Parcel in) { 17566 return new BaseSavedState(in); 17567 } 17568 17569 public BaseSavedState[] newArray(int size) { 17570 return new BaseSavedState[size]; 17571 } 17572 }; 17573 } 17574 17575 /** 17576 * A set of information given to a view when it is attached to its parent 17577 * window. 17578 */ 17579 static class AttachInfo { 17580 interface Callbacks { 17581 void playSoundEffect(int effectId); 17582 boolean performHapticFeedback(int effectId, boolean always); 17583 } 17584 17585 /** 17586 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 17587 * to a Handler. This class contains the target (View) to invalidate and 17588 * the coordinates of the dirty rectangle. 17589 * 17590 * For performance purposes, this class also implements a pool of up to 17591 * POOL_LIMIT objects that get reused. This reduces memory allocations 17592 * whenever possible. 17593 */ 17594 static class InvalidateInfo implements Poolable<InvalidateInfo> { 17595 private static final int POOL_LIMIT = 10; 17596 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool( 17597 Pools.finitePool(new PoolableManager<InvalidateInfo>() { 17598 public InvalidateInfo newInstance() { 17599 return new InvalidateInfo(); 17600 } 17601 17602 public void onAcquired(InvalidateInfo element) { 17603 } 17604 17605 public void onReleased(InvalidateInfo element) { 17606 element.target = null; 17607 } 17608 }, POOL_LIMIT) 17609 ); 17610 17611 private InvalidateInfo mNext; 17612 private boolean mIsPooled; 17613 17614 View target; 17615 17616 int left; 17617 int top; 17618 int right; 17619 int bottom; 17620 17621 public void setNextPoolable(InvalidateInfo element) { 17622 mNext = element; 17623 } 17624 17625 public InvalidateInfo getNextPoolable() { 17626 return mNext; 17627 } 17628 17629 static InvalidateInfo acquire() { 17630 return sPool.acquire(); 17631 } 17632 17633 void release() { 17634 sPool.release(this); 17635 } 17636 17637 public boolean isPooled() { 17638 return mIsPooled; 17639 } 17640 17641 public void setPooled(boolean isPooled) { 17642 mIsPooled = isPooled; 17643 } 17644 } 17645 17646 final IWindowSession mSession; 17647 17648 final IWindow mWindow; 17649 17650 final IBinder mWindowToken; 17651 17652 final Display mDisplay; 17653 17654 final Callbacks mRootCallbacks; 17655 17656 HardwareCanvas mHardwareCanvas; 17657 17658 /** 17659 * The top view of the hierarchy. 17660 */ 17661 View mRootView; 17662 17663 IBinder mPanelParentWindowToken; 17664 Surface mSurface; 17665 17666 boolean mHardwareAccelerated; 17667 boolean mHardwareAccelerationRequested; 17668 HardwareRenderer mHardwareRenderer; 17669 17670 boolean mScreenOn; 17671 17672 /** 17673 * Scale factor used by the compatibility mode 17674 */ 17675 float mApplicationScale; 17676 17677 /** 17678 * Indicates whether the application is in compatibility mode 17679 */ 17680 boolean mScalingRequired; 17681 17682 /** 17683 * If set, ViewAncestor doesn't use its lame animation for when the window resizes. 17684 */ 17685 boolean mTurnOffWindowResizeAnim; 17686 17687 /** 17688 * Left position of this view's window 17689 */ 17690 int mWindowLeft; 17691 17692 /** 17693 * Top position of this view's window 17694 */ 17695 int mWindowTop; 17696 17697 /** 17698 * Indicates whether views need to use 32-bit drawing caches 17699 */ 17700 boolean mUse32BitDrawingCache; 17701 17702 /** 17703 * For windows that are full-screen but using insets to layout inside 17704 * of the screen decorations, these are the current insets for the 17705 * content of the window. 17706 */ 17707 final Rect mContentInsets = new Rect(); 17708 17709 /** 17710 * For windows that are full-screen but using insets to layout inside 17711 * of the screen decorations, these are the current insets for the 17712 * actual visible parts of the window. 17713 */ 17714 final Rect mVisibleInsets = new Rect(); 17715 17716 /** 17717 * The internal insets given by this window. This value is 17718 * supplied by the client (through 17719 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 17720 * be given to the window manager when changed to be used in laying 17721 * out windows behind it. 17722 */ 17723 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 17724 = new ViewTreeObserver.InternalInsetsInfo(); 17725 17726 /** 17727 * All views in the window's hierarchy that serve as scroll containers, 17728 * used to determine if the window can be resized or must be panned 17729 * to adjust for a soft input area. 17730 */ 17731 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 17732 17733 final KeyEvent.DispatcherState mKeyDispatchState 17734 = new KeyEvent.DispatcherState(); 17735 17736 /** 17737 * Indicates whether the view's window currently has the focus. 17738 */ 17739 boolean mHasWindowFocus; 17740 17741 /** 17742 * The current visibility of the window. 17743 */ 17744 int mWindowVisibility; 17745 17746 /** 17747 * Indicates the time at which drawing started to occur. 17748 */ 17749 long mDrawingTime; 17750 17751 /** 17752 * Indicates whether or not ignoring the DIRTY_MASK flags. 17753 */ 17754 boolean mIgnoreDirtyState; 17755 17756 /** 17757 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 17758 * to avoid clearing that flag prematurely. 17759 */ 17760 boolean mSetIgnoreDirtyState = false; 17761 17762 /** 17763 * Indicates whether the view's window is currently in touch mode. 17764 */ 17765 boolean mInTouchMode; 17766 17767 /** 17768 * Indicates that ViewAncestor should trigger a global layout change 17769 * the next time it performs a traversal 17770 */ 17771 boolean mRecomputeGlobalAttributes; 17772 17773 /** 17774 * Always report new attributes at next traversal. 17775 */ 17776 boolean mForceReportNewAttributes; 17777 17778 /** 17779 * Set during a traveral if any views want to keep the screen on. 17780 */ 17781 boolean mKeepScreenOn; 17782 17783 /** 17784 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 17785 */ 17786 int mSystemUiVisibility; 17787 17788 /** 17789 * Hack to force certain system UI visibility flags to be cleared. 17790 */ 17791 int mDisabledSystemUiVisibility; 17792 17793 /** 17794 * Last global system UI visibility reported by the window manager. 17795 */ 17796 int mGlobalSystemUiVisibility; 17797 17798 /** 17799 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 17800 * attached. 17801 */ 17802 boolean mHasSystemUiListeners; 17803 17804 /** 17805 * Set if the visibility of any views has changed. 17806 */ 17807 boolean mViewVisibilityChanged; 17808 17809 /** 17810 * Set to true if a view has been scrolled. 17811 */ 17812 boolean mViewScrollChanged; 17813 17814 /** 17815 * Global to the view hierarchy used as a temporary for dealing with 17816 * x/y points in the transparent region computations. 17817 */ 17818 final int[] mTransparentLocation = new int[2]; 17819 17820 /** 17821 * Global to the view hierarchy used as a temporary for dealing with 17822 * x/y points in the ViewGroup.invalidateChild implementation. 17823 */ 17824 final int[] mInvalidateChildLocation = new int[2]; 17825 17826 17827 /** 17828 * Global to the view hierarchy used as a temporary for dealing with 17829 * x/y location when view is transformed. 17830 */ 17831 final float[] mTmpTransformLocation = new float[2]; 17832 17833 /** 17834 * The view tree observer used to dispatch global events like 17835 * layout, pre-draw, touch mode change, etc. 17836 */ 17837 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 17838 17839 /** 17840 * A Canvas used by the view hierarchy to perform bitmap caching. 17841 */ 17842 Canvas mCanvas; 17843 17844 /** 17845 * The view root impl. 17846 */ 17847 final ViewRootImpl mViewRootImpl; 17848 17849 /** 17850 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 17851 * handler can be used to pump events in the UI events queue. 17852 */ 17853 final Handler mHandler; 17854 17855 /** 17856 * Temporary for use in computing invalidate rectangles while 17857 * calling up the hierarchy. 17858 */ 17859 final Rect mTmpInvalRect = new Rect(); 17860 17861 /** 17862 * Temporary for use in computing hit areas with transformed views 17863 */ 17864 final RectF mTmpTransformRect = new RectF(); 17865 17866 /** 17867 * Temporary for use in transforming invalidation rect 17868 */ 17869 final Matrix mTmpMatrix = new Matrix(); 17870 17871 /** 17872 * Temporary for use in transforming invalidation rect 17873 */ 17874 final Transformation mTmpTransformation = new Transformation(); 17875 17876 /** 17877 * Temporary list for use in collecting focusable descendents of a view. 17878 */ 17879 final ArrayList<View> mTempArrayList = new ArrayList<View>(24); 17880 17881 /** 17882 * The id of the window for accessibility purposes. 17883 */ 17884 int mAccessibilityWindowId = View.NO_ID; 17885 17886 /** 17887 * Whether to ingore not exposed for accessibility Views when 17888 * reporting the view tree to accessibility services. 17889 */ 17890 boolean mIncludeNotImportantViews; 17891 17892 /** 17893 * The drawable for highlighting accessibility focus. 17894 */ 17895 Drawable mAccessibilityFocusDrawable; 17896 17897 /** 17898 * Show where the margins, bounds and layout bounds are for each view. 17899 */ 17900 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false); 17901 17902 /** 17903 * Point used to compute visible regions. 17904 */ 17905 final Point mPoint = new Point(); 17906 17907 /** 17908 * Creates a new set of attachment information with the specified 17909 * events handler and thread. 17910 * 17911 * @param handler the events handler the view must use 17912 */ 17913 AttachInfo(IWindowSession session, IWindow window, Display display, 17914 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) { 17915 mSession = session; 17916 mWindow = window; 17917 mWindowToken = window.asBinder(); 17918 mDisplay = display; 17919 mViewRootImpl = viewRootImpl; 17920 mHandler = handler; 17921 mRootCallbacks = effectPlayer; 17922 } 17923 } 17924 17925 /** 17926 * <p>ScrollabilityCache holds various fields used by a View when scrolling 17927 * is supported. This avoids keeping too many unused fields in most 17928 * instances of View.</p> 17929 */ 17930 private static class ScrollabilityCache implements Runnable { 17931 17932 /** 17933 * Scrollbars are not visible 17934 */ 17935 public static final int OFF = 0; 17936 17937 /** 17938 * Scrollbars are visible 17939 */ 17940 public static final int ON = 1; 17941 17942 /** 17943 * Scrollbars are fading away 17944 */ 17945 public static final int FADING = 2; 17946 17947 public boolean fadeScrollBars; 17948 17949 public int fadingEdgeLength; 17950 public int scrollBarDefaultDelayBeforeFade; 17951 public int scrollBarFadeDuration; 17952 17953 public int scrollBarSize; 17954 public ScrollBarDrawable scrollBar; 17955 public float[] interpolatorValues; 17956 public View host; 17957 17958 public final Paint paint; 17959 public final Matrix matrix; 17960 public Shader shader; 17961 17962 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 17963 17964 private static final float[] OPAQUE = { 255 }; 17965 private static final float[] TRANSPARENT = { 0.0f }; 17966 17967 /** 17968 * When fading should start. This time moves into the future every time 17969 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 17970 */ 17971 public long fadeStartTime; 17972 17973 17974 /** 17975 * The current state of the scrollbars: ON, OFF, or FADING 17976 */ 17977 public int state = OFF; 17978 17979 private int mLastColor; 17980 17981 public ScrollabilityCache(ViewConfiguration configuration, View host) { 17982 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 17983 scrollBarSize = configuration.getScaledScrollBarSize(); 17984 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 17985 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 17986 17987 paint = new Paint(); 17988 matrix = new Matrix(); 17989 // use use a height of 1, and then wack the matrix each time we 17990 // actually use it. 17991 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 17992 paint.setShader(shader); 17993 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 17994 17995 this.host = host; 17996 } 17997 17998 public void setFadeColor(int color) { 17999 if (color != mLastColor) { 18000 mLastColor = color; 18001 18002 if (color != 0) { 18003 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 18004 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 18005 paint.setShader(shader); 18006 // Restore the default transfer mode (src_over) 18007 paint.setXfermode(null); 18008 } else { 18009 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 18010 paint.setShader(shader); 18011 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 18012 } 18013 } 18014 } 18015 18016 public void run() { 18017 long now = AnimationUtils.currentAnimationTimeMillis(); 18018 if (now >= fadeStartTime) { 18019 18020 // the animation fades the scrollbars out by changing 18021 // the opacity (alpha) from fully opaque to fully 18022 // transparent 18023 int nextFrame = (int) now; 18024 int framesCount = 0; 18025 18026 Interpolator interpolator = scrollBarInterpolator; 18027 18028 // Start opaque 18029 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 18030 18031 // End transparent 18032 nextFrame += scrollBarFadeDuration; 18033 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 18034 18035 state = FADING; 18036 18037 // Kick off the fade animation 18038 host.invalidate(true); 18039 } 18040 } 18041 } 18042 18043 /** 18044 * Resuable callback for sending 18045 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 18046 */ 18047 private class SendViewScrolledAccessibilityEvent implements Runnable { 18048 public volatile boolean mIsPending; 18049 18050 public void run() { 18051 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 18052 mIsPending = false; 18053 } 18054 } 18055 18056 /** 18057 * <p> 18058 * This class represents a delegate that can be registered in a {@link View} 18059 * to enhance accessibility support via composition rather via inheritance. 18060 * It is specifically targeted to widget developers that extend basic View 18061 * classes i.e. classes in package android.view, that would like their 18062 * applications to be backwards compatible. 18063 * </p> 18064 * <div class="special reference"> 18065 * <h3>Developer Guides</h3> 18066 * <p>For more information about making applications accessible, read the 18067 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a> 18068 * developer guide.</p> 18069 * </div> 18070 * <p> 18071 * A scenario in which a developer would like to use an accessibility delegate 18072 * is overriding a method introduced in a later API version then the minimal API 18073 * version supported by the application. For example, the method 18074 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 18075 * in API version 4 when the accessibility APIs were first introduced. If a 18076 * developer would like his application to run on API version 4 devices (assuming 18077 * all other APIs used by the application are version 4 or lower) and take advantage 18078 * of this method, instead of overriding the method which would break the application's 18079 * backwards compatibility, he can override the corresponding method in this 18080 * delegate and register the delegate in the target View if the API version of 18081 * the system is high enough i.e. the API version is same or higher to the API 18082 * version that introduced 18083 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 18084 * </p> 18085 * <p> 18086 * Here is an example implementation: 18087 * </p> 18088 * <code><pre><p> 18089 * if (Build.VERSION.SDK_INT >= 14) { 18090 * // If the API version is equal of higher than the version in 18091 * // which onInitializeAccessibilityNodeInfo was introduced we 18092 * // register a delegate with a customized implementation. 18093 * View view = findViewById(R.id.view_id); 18094 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 18095 * public void onInitializeAccessibilityNodeInfo(View host, 18096 * AccessibilityNodeInfo info) { 18097 * // Let the default implementation populate the info. 18098 * super.onInitializeAccessibilityNodeInfo(host, info); 18099 * // Set some other information. 18100 * info.setEnabled(host.isEnabled()); 18101 * } 18102 * }); 18103 * } 18104 * </code></pre></p> 18105 * <p> 18106 * This delegate contains methods that correspond to the accessibility methods 18107 * in View. If a delegate has been specified the implementation in View hands 18108 * off handling to the corresponding method in this delegate. The default 18109 * implementation the delegate methods behaves exactly as the corresponding 18110 * method in View for the case of no accessibility delegate been set. Hence, 18111 * to customize the behavior of a View method, clients can override only the 18112 * corresponding delegate method without altering the behavior of the rest 18113 * accessibility related methods of the host view. 18114 * </p> 18115 */ 18116 public static class AccessibilityDelegate { 18117 18118 /** 18119 * Sends an accessibility event of the given type. If accessibility is not 18120 * enabled this method has no effect. 18121 * <p> 18122 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 18123 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 18124 * been set. 18125 * </p> 18126 * 18127 * @param host The View hosting the delegate. 18128 * @param eventType The type of the event to send. 18129 * 18130 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 18131 */ 18132 public void sendAccessibilityEvent(View host, int eventType) { 18133 host.sendAccessibilityEventInternal(eventType); 18134 } 18135 18136 /** 18137 * Performs the specified accessibility action on the view. For 18138 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 18139 * <p> 18140 * The default implementation behaves as 18141 * {@link View#performAccessibilityAction(int, Bundle) 18142 * View#performAccessibilityAction(int, Bundle)} for the case of 18143 * no accessibility delegate been set. 18144 * </p> 18145 * 18146 * @param action The action to perform. 18147 * @return Whether the action was performed. 18148 * 18149 * @see View#performAccessibilityAction(int, Bundle) 18150 * View#performAccessibilityAction(int, Bundle) 18151 */ 18152 public boolean performAccessibilityAction(View host, int action, Bundle args) { 18153 return host.performAccessibilityActionInternal(action, args); 18154 } 18155 18156 /** 18157 * Sends an accessibility event. This method behaves exactly as 18158 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 18159 * empty {@link AccessibilityEvent} and does not perform a check whether 18160 * accessibility is enabled. 18161 * <p> 18162 * The default implementation behaves as 18163 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 18164 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 18165 * the case of no accessibility delegate been set. 18166 * </p> 18167 * 18168 * @param host The View hosting the delegate. 18169 * @param event The event to send. 18170 * 18171 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 18172 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 18173 */ 18174 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 18175 host.sendAccessibilityEventUncheckedInternal(event); 18176 } 18177 18178 /** 18179 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 18180 * to its children for adding their text content to the event. 18181 * <p> 18182 * The default implementation behaves as 18183 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 18184 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 18185 * the case of no accessibility delegate been set. 18186 * </p> 18187 * 18188 * @param host The View hosting the delegate. 18189 * @param event The event. 18190 * @return True if the event population was completed. 18191 * 18192 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 18193 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 18194 */ 18195 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 18196 return host.dispatchPopulateAccessibilityEventInternal(event); 18197 } 18198 18199 /** 18200 * Gives a chance to the host View to populate the accessibility event with its 18201 * text content. 18202 * <p> 18203 * The default implementation behaves as 18204 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 18205 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 18206 * the case of no accessibility delegate been set. 18207 * </p> 18208 * 18209 * @param host The View hosting the delegate. 18210 * @param event The accessibility event which to populate. 18211 * 18212 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 18213 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 18214 */ 18215 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 18216 host.onPopulateAccessibilityEventInternal(event); 18217 } 18218 18219 /** 18220 * Initializes an {@link AccessibilityEvent} with information about the 18221 * the host View which is the event source. 18222 * <p> 18223 * The default implementation behaves as 18224 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 18225 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 18226 * the case of no accessibility delegate been set. 18227 * </p> 18228 * 18229 * @param host The View hosting the delegate. 18230 * @param event The event to initialize. 18231 * 18232 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 18233 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 18234 */ 18235 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 18236 host.onInitializeAccessibilityEventInternal(event); 18237 } 18238 18239 /** 18240 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 18241 * <p> 18242 * The default implementation behaves as 18243 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 18244 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 18245 * the case of no accessibility delegate been set. 18246 * </p> 18247 * 18248 * @param host The View hosting the delegate. 18249 * @param info The instance to initialize. 18250 * 18251 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 18252 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 18253 */ 18254 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 18255 host.onInitializeAccessibilityNodeInfoInternal(info); 18256 } 18257 18258 /** 18259 * Called when a child of the host View has requested sending an 18260 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 18261 * to augment the event. 18262 * <p> 18263 * The default implementation behaves as 18264 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 18265 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 18266 * the case of no accessibility delegate been set. 18267 * </p> 18268 * 18269 * @param host The View hosting the delegate. 18270 * @param child The child which requests sending the event. 18271 * @param event The event to be sent. 18272 * @return True if the event should be sent 18273 * 18274 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 18275 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 18276 */ 18277 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 18278 AccessibilityEvent event) { 18279 return host.onRequestSendAccessibilityEventInternal(child, event); 18280 } 18281 18282 /** 18283 * Gets the provider for managing a virtual view hierarchy rooted at this View 18284 * and reported to {@link android.accessibilityservice.AccessibilityService}s 18285 * that explore the window content. 18286 * <p> 18287 * The default implementation behaves as 18288 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 18289 * the case of no accessibility delegate been set. 18290 * </p> 18291 * 18292 * @return The provider. 18293 * 18294 * @see AccessibilityNodeProvider 18295 */ 18296 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 18297 return null; 18298 } 18299 } 18300 18301 private class MatchIdPredicate implements Predicate<View> { 18302 public int mId; 18303 18304 @Override 18305 public boolean apply(View view) { 18306 return (view.mID == mId); 18307 } 18308 } 18309 18310 private class MatchLabelForPredicate implements Predicate<View> { 18311 private int mLabeledId; 18312 18313 @Override 18314 public boolean apply(View view) { 18315 return (view.mLabelForId == mLabeledId); 18316 } 18317 } 18318 18319 /** 18320 * Dump all private flags in readable format, useful for documentation and 18321 * sanity checking. 18322 */ 18323 private static void dumpFlags() { 18324 final HashMap<String, String> found = Maps.newHashMap(); 18325 try { 18326 for (Field field : View.class.getDeclaredFields()) { 18327 final int modifiers = field.getModifiers(); 18328 if (Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers)) { 18329 if (field.getType().equals(int.class)) { 18330 final int value = field.getInt(null); 18331 dumpFlag(found, field.getName(), value); 18332 } else if (field.getType().equals(int[].class)) { 18333 final int[] values = (int[]) field.get(null); 18334 for (int i = 0; i < values.length; i++) { 18335 dumpFlag(found, field.getName() + "[" + i + "]", values[i]); 18336 } 18337 } 18338 } 18339 } 18340 } catch (IllegalAccessException e) { 18341 throw new RuntimeException(e); 18342 } 18343 18344 final ArrayList<String> keys = Lists.newArrayList(); 18345 keys.addAll(found.keySet()); 18346 Collections.sort(keys); 18347 for (String key : keys) { 18348 Log.d(VIEW_LOG_TAG, found.get(key)); 18349 } 18350 } 18351 18352 private static void dumpFlag(HashMap<String, String> found, String name, int value) { 18353 // Sort flags by prefix, then by bits, always keeping unique keys 18354 final String bits = String.format("%32s", Integer.toBinaryString(value)).replace('0', ' '); 18355 final int prefix = name.indexOf('_'); 18356 final String key = (prefix > 0 ? name.substring(0, prefix) : name) + bits + name; 18357 final String output = bits + " " + name; 18358 found.put(key, output); 18359 } 18360} 18361