View.java revision 50d99215023ee346a95eb72c413759d6a58f82a5
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.os.Bundle; 43import android.os.Handler; 44import android.os.IBinder; 45import android.os.Parcel; 46import android.os.Parcelable; 47import android.os.RemoteException; 48import android.os.SystemClock; 49import android.os.SystemProperties; 50import android.util.AttributeSet; 51import android.util.FloatProperty; 52import android.util.LocaleUtil; 53import android.util.Log; 54import android.util.Pool; 55import android.util.Poolable; 56import android.util.PoolableManager; 57import android.util.Pools; 58import android.util.Property; 59import android.util.SparseArray; 60import android.util.TypedValue; 61import android.view.ContextMenu.ContextMenuInfo; 62import android.view.AccessibilityIterators.TextSegmentIterator; 63import android.view.AccessibilityIterators.CharacterTextSegmentIterator; 64import android.view.AccessibilityIterators.WordTextSegmentIterator; 65import android.view.AccessibilityIterators.ParagraphTextSegmentIterator; 66import android.view.accessibility.AccessibilityEvent; 67import android.view.accessibility.AccessibilityEventSource; 68import android.view.accessibility.AccessibilityManager; 69import android.view.accessibility.AccessibilityNodeInfo; 70import android.view.accessibility.AccessibilityNodeProvider; 71import android.view.animation.Animation; 72import android.view.animation.AnimationUtils; 73import android.view.animation.Transformation; 74import android.view.inputmethod.EditorInfo; 75import android.view.inputmethod.InputConnection; 76import android.view.inputmethod.InputMethodManager; 77import android.widget.ScrollBarDrawable; 78 79import static android.os.Build.VERSION_CODES.*; 80import static java.lang.Math.max; 81 82import com.android.internal.R; 83import com.android.internal.util.Predicate; 84import com.android.internal.view.menu.MenuBuilder; 85 86import java.lang.ref.WeakReference; 87import java.lang.reflect.InvocationTargetException; 88import java.lang.reflect.Method; 89import java.util.ArrayList; 90import java.util.Arrays; 91import java.util.Locale; 92import java.util.concurrent.CopyOnWriteArrayList; 93 94/** 95 * <p> 96 * This class represents the basic building block for user interface components. A View 97 * occupies a rectangular area on the screen and is responsible for drawing and 98 * event handling. View is the base class for <em>widgets</em>, which are 99 * used to create interactive UI components (buttons, text fields, etc.). The 100 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which 101 * are invisible containers that hold other Views (or other ViewGroups) and define 102 * their layout properties. 103 * </p> 104 * 105 * <div class="special reference"> 106 * <h3>Developer Guides</h3> 107 * <p>For information about using this class to develop your application's user interface, 108 * read the <a href="{@docRoot}guide/topics/ui/index.html">User Interface</a> developer guide. 109 * </div> 110 * 111 * <a name="Using"></a> 112 * <h3>Using Views</h3> 113 * <p> 114 * All of the views in a window are arranged in a single tree. You can add views 115 * either from code or by specifying a tree of views in one or more XML layout 116 * files. There are many specialized subclasses of views that act as controls or 117 * are capable of displaying text, images, or other content. 118 * </p> 119 * <p> 120 * Once you have created a tree of views, there are typically a few types of 121 * common operations you may wish to perform: 122 * <ul> 123 * <li><strong>Set properties:</strong> for example setting the text of a 124 * {@link android.widget.TextView}. The available properties and the methods 125 * that set them will vary among the different subclasses of views. Note that 126 * properties that are known at build time can be set in the XML layout 127 * files.</li> 128 * <li><strong>Set focus:</strong> The framework will handled moving focus in 129 * response to user input. To force focus to a specific view, call 130 * {@link #requestFocus}.</li> 131 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners 132 * that will be notified when something interesting happens to the view. For 133 * example, all views will let you set a listener to be notified when the view 134 * gains or loses focus. You can register such a listener using 135 * {@link #setOnFocusChangeListener(android.view.View.OnFocusChangeListener)}. 136 * Other view subclasses offer more specialized listeners. For example, a Button 137 * exposes a listener to notify clients when the button is clicked.</li> 138 * <li><strong>Set visibility:</strong> You can hide or show views using 139 * {@link #setVisibility(int)}.</li> 140 * </ul> 141 * </p> 142 * <p><em> 143 * Note: The Android framework is responsible for measuring, laying out and 144 * drawing views. You should not call methods that perform these actions on 145 * views yourself unless you are actually implementing a 146 * {@link android.view.ViewGroup}. 147 * </em></p> 148 * 149 * <a name="Lifecycle"></a> 150 * <h3>Implementing a Custom View</h3> 151 * 152 * <p> 153 * To implement a custom view, you will usually begin by providing overrides for 154 * some of the standard methods that the framework calls on all views. You do 155 * not need to override all of these methods. In fact, you can start by just 156 * overriding {@link #onDraw(android.graphics.Canvas)}. 157 * <table border="2" width="85%" align="center" cellpadding="5"> 158 * <thead> 159 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr> 160 * </thead> 161 * 162 * <tbody> 163 * <tr> 164 * <td rowspan="2">Creation</td> 165 * <td>Constructors</td> 166 * <td>There is a form of the constructor that are called when the view 167 * is created from code and a form that is called when the view is 168 * inflated from a layout file. The second form should parse and apply 169 * any attributes defined in the layout file. 170 * </td> 171 * </tr> 172 * <tr> 173 * <td><code>{@link #onFinishInflate()}</code></td> 174 * <td>Called after a view and all of its children has been inflated 175 * from XML.</td> 176 * </tr> 177 * 178 * <tr> 179 * <td rowspan="3">Layout</td> 180 * <td><code>{@link #onMeasure(int, int)}</code></td> 181 * <td>Called to determine the size requirements for this view and all 182 * of its children. 183 * </td> 184 * </tr> 185 * <tr> 186 * <td><code>{@link #onLayout(boolean, int, int, int, int)}</code></td> 187 * <td>Called when this view should assign a size and position to all 188 * of its children. 189 * </td> 190 * </tr> 191 * <tr> 192 * <td><code>{@link #onSizeChanged(int, int, int, int)}</code></td> 193 * <td>Called when the size of this view has changed. 194 * </td> 195 * </tr> 196 * 197 * <tr> 198 * <td>Drawing</td> 199 * <td><code>{@link #onDraw(android.graphics.Canvas)}</code></td> 200 * <td>Called when the view should render its content. 201 * </td> 202 * </tr> 203 * 204 * <tr> 205 * <td rowspan="4">Event processing</td> 206 * <td><code>{@link #onKeyDown(int, KeyEvent)}</code></td> 207 * <td>Called when a new key event occurs. 208 * </td> 209 * </tr> 210 * <tr> 211 * <td><code>{@link #onKeyUp(int, KeyEvent)}</code></td> 212 * <td>Called when a key up event occurs. 213 * </td> 214 * </tr> 215 * <tr> 216 * <td><code>{@link #onTrackballEvent(MotionEvent)}</code></td> 217 * <td>Called when a trackball motion event occurs. 218 * </td> 219 * </tr> 220 * <tr> 221 * <td><code>{@link #onTouchEvent(MotionEvent)}</code></td> 222 * <td>Called when a touch screen motion event occurs. 223 * </td> 224 * </tr> 225 * 226 * <tr> 227 * <td rowspan="2">Focus</td> 228 * <td><code>{@link #onFocusChanged(boolean, int, android.graphics.Rect)}</code></td> 229 * <td>Called when the view gains or loses focus. 230 * </td> 231 * </tr> 232 * 233 * <tr> 234 * <td><code>{@link #onWindowFocusChanged(boolean)}</code></td> 235 * <td>Called when the window containing the view gains or loses focus. 236 * </td> 237 * </tr> 238 * 239 * <tr> 240 * <td rowspan="3">Attaching</td> 241 * <td><code>{@link #onAttachedToWindow()}</code></td> 242 * <td>Called when the view is attached to a window. 243 * </td> 244 * </tr> 245 * 246 * <tr> 247 * <td><code>{@link #onDetachedFromWindow}</code></td> 248 * <td>Called when the view is detached from its window. 249 * </td> 250 * </tr> 251 * 252 * <tr> 253 * <td><code>{@link #onWindowVisibilityChanged(int)}</code></td> 254 * <td>Called when the visibility of the window containing the view 255 * has changed. 256 * </td> 257 * </tr> 258 * </tbody> 259 * 260 * </table> 261 * </p> 262 * 263 * <a name="IDs"></a> 264 * <h3>IDs</h3> 265 * Views may have an integer id associated with them. These ids are typically 266 * assigned in the layout XML files, and are used to find specific views within 267 * the view tree. A common pattern is to: 268 * <ul> 269 * <li>Define a Button in the layout file and assign it a unique ID. 270 * <pre> 271 * <Button 272 * android:id="@+id/my_button" 273 * android:layout_width="wrap_content" 274 * android:layout_height="wrap_content" 275 * android:text="@string/my_button_text"/> 276 * </pre></li> 277 * <li>From the onCreate method of an Activity, find the Button 278 * <pre class="prettyprint"> 279 * Button myButton = (Button) findViewById(R.id.my_button); 280 * </pre></li> 281 * </ul> 282 * <p> 283 * View IDs need not be unique throughout the tree, but it is good practice to 284 * ensure that they are at least unique within the part of the tree you are 285 * searching. 286 * </p> 287 * 288 * <a name="Position"></a> 289 * <h3>Position</h3> 290 * <p> 291 * The geometry of a view is that of a rectangle. A view has a location, 292 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and 293 * two dimensions, expressed as a width and a height. The unit for location 294 * and dimensions is the pixel. 295 * </p> 296 * 297 * <p> 298 * It is possible to retrieve the location of a view by invoking the methods 299 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X, 300 * coordinate of the rectangle representing the view. The latter returns the 301 * top, or Y, coordinate of the rectangle representing the view. These methods 302 * both return the location of the view relative to its parent. For instance, 303 * when getLeft() returns 20, that means the view is located 20 pixels to the 304 * right of the left edge of its direct parent. 305 * </p> 306 * 307 * <p> 308 * In addition, several convenience methods are offered to avoid unnecessary 309 * computations, namely {@link #getRight()} and {@link #getBottom()}. 310 * These methods return the coordinates of the right and bottom edges of the 311 * rectangle representing the view. For instance, calling {@link #getRight()} 312 * is similar to the following computation: <code>getLeft() + getWidth()</code> 313 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.) 314 * </p> 315 * 316 * <a name="SizePaddingMargins"></a> 317 * <h3>Size, padding and margins</h3> 318 * <p> 319 * The size of a view is expressed with a width and a height. A view actually 320 * possess two pairs of width and height values. 321 * </p> 322 * 323 * <p> 324 * The first pair is known as <em>measured width</em> and 325 * <em>measured height</em>. These dimensions define how big a view wants to be 326 * within its parent (see <a href="#Layout">Layout</a> for more details.) The 327 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()} 328 * and {@link #getMeasuredHeight()}. 329 * </p> 330 * 331 * <p> 332 * The second pair is simply known as <em>width</em> and <em>height</em>, or 333 * sometimes <em>drawing width</em> and <em>drawing height</em>. These 334 * dimensions define the actual size of the view on screen, at drawing time and 335 * after layout. These values may, but do not have to, be different from the 336 * measured width and height. The width and height can be obtained by calling 337 * {@link #getWidth()} and {@link #getHeight()}. 338 * </p> 339 * 340 * <p> 341 * To measure its dimensions, a view takes into account its padding. The padding 342 * is expressed in pixels for the left, top, right and bottom parts of the view. 343 * Padding can be used to offset the content of the view by a specific amount of 344 * pixels. For instance, a left padding of 2 will push the view's content by 345 * 2 pixels to the right of the left edge. Padding can be set using the 346 * {@link #setPadding(int, int, int, int)} or {@link #setPaddingRelative(int, int, int, int)} 347 * method and queried by calling {@link #getPaddingLeft()}, {@link #getPaddingTop()}, 348 * {@link #getPaddingRight()}, {@link #getPaddingBottom()}, {@link #getPaddingStart()}, 349 * {@link #getPaddingEnd()}. 350 * </p> 351 * 352 * <p> 353 * Even though a view can define a padding, it does not provide any support for 354 * margins. However, view groups provide such a support. Refer to 355 * {@link android.view.ViewGroup} and 356 * {@link android.view.ViewGroup.MarginLayoutParams} for further information. 357 * </p> 358 * 359 * <a name="Layout"></a> 360 * <h3>Layout</h3> 361 * <p> 362 * Layout is a two pass process: a measure pass and a layout pass. The measuring 363 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal 364 * of the view tree. Each view pushes dimension specifications down the tree 365 * during the recursion. At the end of the measure pass, every view has stored 366 * its measurements. The second pass happens in 367 * {@link #layout(int,int,int,int)} and is also top-down. During 368 * this pass each parent is responsible for positioning all of its children 369 * using the sizes computed in the measure pass. 370 * </p> 371 * 372 * <p> 373 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and 374 * {@link #getMeasuredHeight()} values must be set, along with those for all of 375 * that view's descendants. A view's measured width and measured height values 376 * must respect the constraints imposed by the view's parents. This guarantees 377 * that at the end of the measure pass, all parents accept all of their 378 * children's measurements. A parent view may call measure() more than once on 379 * its children. For example, the parent may measure each child once with 380 * unspecified dimensions to find out how big they want to be, then call 381 * measure() on them again with actual numbers if the sum of all the children's 382 * unconstrained sizes is too big or too small. 383 * </p> 384 * 385 * <p> 386 * The measure pass uses two classes to communicate dimensions. The 387 * {@link MeasureSpec} class is used by views to tell their parents how they 388 * want to be measured and positioned. The base LayoutParams class just 389 * describes how big the view wants to be for both width and height. For each 390 * dimension, it can specify one of: 391 * <ul> 392 * <li> an exact number 393 * <li>MATCH_PARENT, which means the view wants to be as big as its parent 394 * (minus padding) 395 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to 396 * enclose its content (plus padding). 397 * </ul> 398 * There are subclasses of LayoutParams for different subclasses of ViewGroup. 399 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds 400 * an X and Y value. 401 * </p> 402 * 403 * <p> 404 * MeasureSpecs are used to push requirements down the tree from parent to 405 * child. A MeasureSpec can be in one of three modes: 406 * <ul> 407 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension 408 * of a child view. For example, a LinearLayout may call measure() on its child 409 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how 410 * tall the child view wants to be given a width of 240 pixels. 411 * <li>EXACTLY: This is used by the parent to impose an exact size on the 412 * child. The child must use this size, and guarantee that all of its 413 * descendants will fit within this size. 414 * <li>AT_MOST: This is used by the parent to impose a maximum size on the 415 * child. The child must gurantee that it and all of its descendants will fit 416 * within this size. 417 * </ul> 418 * </p> 419 * 420 * <p> 421 * To intiate a layout, call {@link #requestLayout}. This method is typically 422 * called by a view on itself when it believes that is can no longer fit within 423 * its current bounds. 424 * </p> 425 * 426 * <a name="Drawing"></a> 427 * <h3>Drawing</h3> 428 * <p> 429 * Drawing is handled by walking the tree and rendering each view that 430 * intersects the invalid region. Because the tree is traversed in-order, 431 * this means that parents will draw before (i.e., behind) their children, with 432 * siblings drawn in the order they appear in the tree. 433 * If you set a background drawable for a View, then the View will draw it for you 434 * before calling back to its <code>onDraw()</code> method. 435 * </p> 436 * 437 * <p> 438 * Note that the framework will not draw views that are not in the invalid region. 439 * </p> 440 * 441 * <p> 442 * To force a view to draw, call {@link #invalidate()}. 443 * </p> 444 * 445 * <a name="EventHandlingThreading"></a> 446 * <h3>Event Handling and Threading</h3> 447 * <p> 448 * The basic cycle of a view is as follows: 449 * <ol> 450 * <li>An event comes in and is dispatched to the appropriate view. The view 451 * handles the event and notifies any listeners.</li> 452 * <li>If in the course of processing the event, the view's bounds may need 453 * to be changed, the view will call {@link #requestLayout()}.</li> 454 * <li>Similarly, if in the course of processing the event the view's appearance 455 * may need to be changed, the view will call {@link #invalidate()}.</li> 456 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called, 457 * the framework will take care of measuring, laying out, and drawing the tree 458 * as appropriate.</li> 459 * </ol> 460 * </p> 461 * 462 * <p><em>Note: The entire view tree is single threaded. You must always be on 463 * the UI thread when calling any method on any view.</em> 464 * If you are doing work on other threads and want to update the state of a view 465 * from that thread, you should use a {@link Handler}. 466 * </p> 467 * 468 * <a name="FocusHandling"></a> 469 * <h3>Focus Handling</h3> 470 * <p> 471 * The framework will handle routine focus movement in response to user input. 472 * This includes changing the focus as views are removed or hidden, or as new 473 * views become available. Views indicate their willingness to take focus 474 * through the {@link #isFocusable} method. To change whether a view can take 475 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below) 476 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode} 477 * and can change this via {@link #setFocusableInTouchMode(boolean)}. 478 * </p> 479 * <p> 480 * Focus movement is based on an algorithm which finds the nearest neighbor in a 481 * given direction. In rare cases, the default algorithm may not match the 482 * intended behavior of the developer. In these situations, you can provide 483 * explicit overrides by using these XML attributes in the layout file: 484 * <pre> 485 * nextFocusDown 486 * nextFocusLeft 487 * nextFocusRight 488 * nextFocusUp 489 * </pre> 490 * </p> 491 * 492 * 493 * <p> 494 * To get a particular view to take focus, call {@link #requestFocus()}. 495 * </p> 496 * 497 * <a name="TouchMode"></a> 498 * <h3>Touch Mode</h3> 499 * <p> 500 * When a user is navigating a user interface via directional keys such as a D-pad, it is 501 * necessary to give focus to actionable items such as buttons so the user can see 502 * what will take input. If the device has touch capabilities, however, and the user 503 * begins interacting with the interface by touching it, it is no longer necessary to 504 * always highlight, or give focus to, a particular view. This motivates a mode 505 * for interaction named 'touch mode'. 506 * </p> 507 * <p> 508 * For a touch capable device, once the user touches the screen, the device 509 * will enter touch mode. From this point onward, only views for which 510 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets. 511 * Other views that are touchable, like buttons, will not take focus when touched; they will 512 * only fire the on click listeners. 513 * </p> 514 * <p> 515 * Any time a user hits a directional key, such as a D-pad direction, the view device will 516 * exit touch mode, and find a view to take focus, so that the user may resume interacting 517 * with the user interface without touching the screen again. 518 * </p> 519 * <p> 520 * The touch mode state is maintained across {@link android.app.Activity}s. Call 521 * {@link #isInTouchMode} to see whether the device is currently in touch mode. 522 * </p> 523 * 524 * <a name="Scrolling"></a> 525 * <h3>Scrolling</h3> 526 * <p> 527 * The framework provides basic support for views that wish to internally 528 * scroll their content. This includes keeping track of the X and Y scroll 529 * offset as well as mechanisms for drawing scrollbars. See 530 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and 531 * {@link #awakenScrollBars()} for more details. 532 * </p> 533 * 534 * <a name="Tags"></a> 535 * <h3>Tags</h3> 536 * <p> 537 * Unlike IDs, tags are not used to identify views. Tags are essentially an 538 * extra piece of information that can be associated with a view. They are most 539 * often used as a convenience to store data related to views in the views 540 * themselves rather than by putting them in a separate structure. 541 * </p> 542 * 543 * <a name="Properties"></a> 544 * <h3>Properties</h3> 545 * <p> 546 * The View class exposes an {@link #ALPHA} property, as well as several transform-related 547 * properties, such as {@link #TRANSLATION_X} and {@link #TRANSLATION_Y}. These properties are 548 * available both in the {@link Property} form as well as in similarly-named setter/getter 549 * methods (such as {@link #setAlpha(float)} for {@link #ALPHA}). These properties can 550 * be used to set persistent state associated with these rendering-related properties on the view. 551 * The properties and methods can also be used in conjunction with 552 * {@link android.animation.Animator Animator}-based animations, described more in the 553 * <a href="#Animation">Animation</a> section. 554 * </p> 555 * 556 * <a name="Animation"></a> 557 * <h3>Animation</h3> 558 * <p> 559 * Starting with Android 3.0, the preferred way of animating views is to use the 560 * {@link android.animation} package APIs. These {@link android.animation.Animator Animator}-based 561 * classes change actual properties of the View object, such as {@link #setAlpha(float) alpha} and 562 * {@link #setTranslationX(float) translationX}. This behavior is contrasted to that of the pre-3.0 563 * {@link android.view.animation.Animation Animation}-based classes, which instead animate only 564 * how the view is drawn on the display. In particular, the {@link ViewPropertyAnimator} class 565 * makes animating these View properties particularly easy and efficient. 566 * </p> 567 * <p> 568 * Alternatively, you can use the pre-3.0 animation classes to animate how Views are rendered. 569 * You can attach an {@link Animation} object to a view using 570 * {@link #setAnimation(Animation)} or 571 * {@link #startAnimation(Animation)}. The animation can alter the scale, 572 * rotation, translation and alpha of a view over time. If the animation is 573 * attached to a view that has children, the animation will affect the entire 574 * subtree rooted by that node. When an animation is started, the framework will 575 * take care of redrawing the appropriate views until the animation completes. 576 * </p> 577 * 578 * <a name="Security"></a> 579 * <h3>Security</h3> 580 * <p> 581 * Sometimes it is essential that an application be able to verify that an action 582 * is being performed with the full knowledge and consent of the user, such as 583 * granting a permission request, making a purchase or clicking on an advertisement. 584 * Unfortunately, a malicious application could try to spoof the user into 585 * performing these actions, unaware, by concealing the intended purpose of the view. 586 * As a remedy, the framework offers a touch filtering mechanism that can be used to 587 * improve the security of views that provide access to sensitive functionality. 588 * </p><p> 589 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the 590 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework 591 * will discard touches that are received whenever the view's window is obscured by 592 * another visible window. As a result, the view will not receive touches whenever a 593 * toast, dialog or other window appears above the view's window. 594 * </p><p> 595 * For more fine-grained control over security, consider overriding the 596 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own 597 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}. 598 * </p> 599 * 600 * @attr ref android.R.styleable#View_alpha 601 * @attr ref android.R.styleable#View_background 602 * @attr ref android.R.styleable#View_clickable 603 * @attr ref android.R.styleable#View_contentDescription 604 * @attr ref android.R.styleable#View_drawingCacheQuality 605 * @attr ref android.R.styleable#View_duplicateParentState 606 * @attr ref android.R.styleable#View_id 607 * @attr ref android.R.styleable#View_requiresFadingEdge 608 * @attr ref android.R.styleable#View_fadeScrollbars 609 * @attr ref android.R.styleable#View_fadingEdgeLength 610 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 611 * @attr ref android.R.styleable#View_fitsSystemWindows 612 * @attr ref android.R.styleable#View_isScrollContainer 613 * @attr ref android.R.styleable#View_focusable 614 * @attr ref android.R.styleable#View_focusableInTouchMode 615 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 616 * @attr ref android.R.styleable#View_keepScreenOn 617 * @attr ref android.R.styleable#View_layerType 618 * @attr ref android.R.styleable#View_longClickable 619 * @attr ref android.R.styleable#View_minHeight 620 * @attr ref android.R.styleable#View_minWidth 621 * @attr ref android.R.styleable#View_nextFocusDown 622 * @attr ref android.R.styleable#View_nextFocusLeft 623 * @attr ref android.R.styleable#View_nextFocusRight 624 * @attr ref android.R.styleable#View_nextFocusUp 625 * @attr ref android.R.styleable#View_onClick 626 * @attr ref android.R.styleable#View_padding 627 * @attr ref android.R.styleable#View_paddingBottom 628 * @attr ref android.R.styleable#View_paddingLeft 629 * @attr ref android.R.styleable#View_paddingRight 630 * @attr ref android.R.styleable#View_paddingTop 631 * @attr ref android.R.styleable#View_paddingStart 632 * @attr ref android.R.styleable#View_paddingEnd 633 * @attr ref android.R.styleable#View_saveEnabled 634 * @attr ref android.R.styleable#View_rotation 635 * @attr ref android.R.styleable#View_rotationX 636 * @attr ref android.R.styleable#View_rotationY 637 * @attr ref android.R.styleable#View_scaleX 638 * @attr ref android.R.styleable#View_scaleY 639 * @attr ref android.R.styleable#View_scrollX 640 * @attr ref android.R.styleable#View_scrollY 641 * @attr ref android.R.styleable#View_scrollbarSize 642 * @attr ref android.R.styleable#View_scrollbarStyle 643 * @attr ref android.R.styleable#View_scrollbars 644 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 645 * @attr ref android.R.styleable#View_scrollbarFadeDuration 646 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal 647 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal 648 * @attr ref android.R.styleable#View_scrollbarThumbVertical 649 * @attr ref android.R.styleable#View_scrollbarTrackVertical 650 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack 651 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack 652 * @attr ref android.R.styleable#View_soundEffectsEnabled 653 * @attr ref android.R.styleable#View_tag 654 * @attr ref android.R.styleable#View_textAlignment 655 * @attr ref android.R.styleable#View_transformPivotX 656 * @attr ref android.R.styleable#View_transformPivotY 657 * @attr ref android.R.styleable#View_translationX 658 * @attr ref android.R.styleable#View_translationY 659 * @attr ref android.R.styleable#View_visibility 660 * 661 * @see android.view.ViewGroup 662 */ 663public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Callback, 664 AccessibilityEventSource { 665 private static final boolean DBG = false; 666 667 /** 668 * The logging tag used by this class with android.util.Log. 669 */ 670 protected static final String VIEW_LOG_TAG = "View"; 671 672 /** 673 * When set to true, apps will draw debugging information about their layouts. 674 * 675 * @hide 676 */ 677 public static final String DEBUG_LAYOUT_PROPERTY = "debug.layout"; 678 679 /** 680 * Used to mark a View that has no ID. 681 */ 682 public static final int NO_ID = -1; 683 684 /** 685 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when 686 * calling setFlags. 687 */ 688 private static final int NOT_FOCUSABLE = 0x00000000; 689 690 /** 691 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling 692 * setFlags. 693 */ 694 private static final int FOCUSABLE = 0x00000001; 695 696 /** 697 * Mask for use with setFlags indicating bits used for focus. 698 */ 699 private static final int FOCUSABLE_MASK = 0x00000001; 700 701 /** 702 * This view will adjust its padding to fit sytem windows (e.g. status bar) 703 */ 704 private static final int FITS_SYSTEM_WINDOWS = 0x00000002; 705 706 /** 707 * This view is visible. 708 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 709 * android:visibility}. 710 */ 711 public static final int VISIBLE = 0x00000000; 712 713 /** 714 * This view is invisible, but it still takes up space for layout purposes. 715 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 716 * android:visibility}. 717 */ 718 public static final int INVISIBLE = 0x00000004; 719 720 /** 721 * This view is invisible, and it doesn't take any space for layout 722 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 723 * android:visibility}. 724 */ 725 public static final int GONE = 0x00000008; 726 727 /** 728 * Mask for use with setFlags indicating bits used for visibility. 729 * {@hide} 730 */ 731 static final int VISIBILITY_MASK = 0x0000000C; 732 733 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE}; 734 735 /** 736 * This view is enabled. Interpretation varies by subclass. 737 * Use with ENABLED_MASK when calling setFlags. 738 * {@hide} 739 */ 740 static final int ENABLED = 0x00000000; 741 742 /** 743 * This view is disabled. Interpretation varies by subclass. 744 * Use with ENABLED_MASK when calling setFlags. 745 * {@hide} 746 */ 747 static final int DISABLED = 0x00000020; 748 749 /** 750 * Mask for use with setFlags indicating bits used for indicating whether 751 * this view is enabled 752 * {@hide} 753 */ 754 static final int ENABLED_MASK = 0x00000020; 755 756 /** 757 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be 758 * called and further optimizations will be performed. It is okay to have 759 * this flag set and a background. Use with DRAW_MASK when calling setFlags. 760 * {@hide} 761 */ 762 static final int WILL_NOT_DRAW = 0x00000080; 763 764 /** 765 * Mask for use with setFlags indicating bits used for indicating whether 766 * this view is will draw 767 * {@hide} 768 */ 769 static final int DRAW_MASK = 0x00000080; 770 771 /** 772 * <p>This view doesn't show scrollbars.</p> 773 * {@hide} 774 */ 775 static final int SCROLLBARS_NONE = 0x00000000; 776 777 /** 778 * <p>This view shows horizontal scrollbars.</p> 779 * {@hide} 780 */ 781 static final int SCROLLBARS_HORIZONTAL = 0x00000100; 782 783 /** 784 * <p>This view shows vertical scrollbars.</p> 785 * {@hide} 786 */ 787 static final int SCROLLBARS_VERTICAL = 0x00000200; 788 789 /** 790 * <p>Mask for use with setFlags indicating bits used for indicating which 791 * scrollbars are enabled.</p> 792 * {@hide} 793 */ 794 static final int SCROLLBARS_MASK = 0x00000300; 795 796 /** 797 * Indicates that the view should filter touches when its window is obscured. 798 * Refer to the class comments for more information about this security feature. 799 * {@hide} 800 */ 801 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400; 802 803 /** 804 * Set for framework elements that use FITS_SYSTEM_WINDOWS, to indicate 805 * that they are optional and should be skipped if the window has 806 * requested system UI flags that ignore those insets for layout. 807 */ 808 static final int OPTIONAL_FITS_SYSTEM_WINDOWS = 0x00000800; 809 810 /** 811 * <p>This view doesn't show fading edges.</p> 812 * {@hide} 813 */ 814 static final int FADING_EDGE_NONE = 0x00000000; 815 816 /** 817 * <p>This view shows horizontal fading edges.</p> 818 * {@hide} 819 */ 820 static final int FADING_EDGE_HORIZONTAL = 0x00001000; 821 822 /** 823 * <p>This view shows vertical fading edges.</p> 824 * {@hide} 825 */ 826 static final int FADING_EDGE_VERTICAL = 0x00002000; 827 828 /** 829 * <p>Mask for use with setFlags indicating bits used for indicating which 830 * fading edges are enabled.</p> 831 * {@hide} 832 */ 833 static final int FADING_EDGE_MASK = 0x00003000; 834 835 /** 836 * <p>Indicates this view can be clicked. When clickable, a View reacts 837 * to clicks by notifying the OnClickListener.<p> 838 * {@hide} 839 */ 840 static final int CLICKABLE = 0x00004000; 841 842 /** 843 * <p>Indicates this view is caching its drawing into a bitmap.</p> 844 * {@hide} 845 */ 846 static final int DRAWING_CACHE_ENABLED = 0x00008000; 847 848 /** 849 * <p>Indicates that no icicle should be saved for this view.<p> 850 * {@hide} 851 */ 852 static final int SAVE_DISABLED = 0x000010000; 853 854 /** 855 * <p>Mask for use with setFlags indicating bits used for the saveEnabled 856 * property.</p> 857 * {@hide} 858 */ 859 static final int SAVE_DISABLED_MASK = 0x000010000; 860 861 /** 862 * <p>Indicates that no drawing cache should ever be created for this view.<p> 863 * {@hide} 864 */ 865 static final int WILL_NOT_CACHE_DRAWING = 0x000020000; 866 867 /** 868 * <p>Indicates this view can take / keep focus when int touch mode.</p> 869 * {@hide} 870 */ 871 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000; 872 873 /** 874 * <p>Enables low quality mode for the drawing cache.</p> 875 */ 876 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000; 877 878 /** 879 * <p>Enables high quality mode for the drawing cache.</p> 880 */ 881 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000; 882 883 /** 884 * <p>Enables automatic quality mode for the drawing cache.</p> 885 */ 886 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000; 887 888 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = { 889 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH 890 }; 891 892 /** 893 * <p>Mask for use with setFlags indicating bits used for the cache 894 * quality property.</p> 895 * {@hide} 896 */ 897 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000; 898 899 /** 900 * <p> 901 * Indicates this view can be long clicked. When long clickable, a View 902 * reacts to long clicks by notifying the OnLongClickListener or showing a 903 * context menu. 904 * </p> 905 * {@hide} 906 */ 907 static final int LONG_CLICKABLE = 0x00200000; 908 909 /** 910 * <p>Indicates that this view gets its drawable states from its direct parent 911 * and ignores its original internal states.</p> 912 * 913 * @hide 914 */ 915 static final int DUPLICATE_PARENT_STATE = 0x00400000; 916 917 /** 918 * The scrollbar style to display the scrollbars inside the content area, 919 * without increasing the padding. The scrollbars will be overlaid with 920 * translucency on the view's content. 921 */ 922 public static final int SCROLLBARS_INSIDE_OVERLAY = 0; 923 924 /** 925 * The scrollbar style to display the scrollbars inside the padded area, 926 * increasing the padding of the view. The scrollbars will not overlap the 927 * content area of the view. 928 */ 929 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000; 930 931 /** 932 * The scrollbar style to display the scrollbars at the edge of the view, 933 * without increasing the padding. The scrollbars will be overlaid with 934 * translucency. 935 */ 936 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000; 937 938 /** 939 * The scrollbar style to display the scrollbars at the edge of the view, 940 * increasing the padding of the view. The scrollbars will only overlap the 941 * background, if any. 942 */ 943 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000; 944 945 /** 946 * Mask to check if the scrollbar style is overlay or inset. 947 * {@hide} 948 */ 949 static final int SCROLLBARS_INSET_MASK = 0x01000000; 950 951 /** 952 * Mask to check if the scrollbar style is inside or outside. 953 * {@hide} 954 */ 955 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000; 956 957 /** 958 * Mask for scrollbar style. 959 * {@hide} 960 */ 961 static final int SCROLLBARS_STYLE_MASK = 0x03000000; 962 963 /** 964 * View flag indicating that the screen should remain on while the 965 * window containing this view is visible to the user. This effectively 966 * takes care of automatically setting the WindowManager's 967 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}. 968 */ 969 public static final int KEEP_SCREEN_ON = 0x04000000; 970 971 /** 972 * View flag indicating whether this view should have sound effects enabled 973 * for events such as clicking and touching. 974 */ 975 public static final int SOUND_EFFECTS_ENABLED = 0x08000000; 976 977 /** 978 * View flag indicating whether this view should have haptic feedback 979 * enabled for events such as long presses. 980 */ 981 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000; 982 983 /** 984 * <p>Indicates that the view hierarchy should stop saving state when 985 * it reaches this view. If state saving is initiated immediately at 986 * the view, it will be allowed. 987 * {@hide} 988 */ 989 static final int PARENT_SAVE_DISABLED = 0x20000000; 990 991 /** 992 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p> 993 * {@hide} 994 */ 995 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000; 996 997 /** 998 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 999 * should add all focusable Views regardless if they are focusable in touch mode. 1000 */ 1001 public static final int FOCUSABLES_ALL = 0x00000000; 1002 1003 /** 1004 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1005 * should add only Views focusable in touch mode. 1006 */ 1007 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001; 1008 1009 /** 1010 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1011 * should add only accessibility focusable Views. 1012 * 1013 * @hide 1014 */ 1015 public static final int FOCUSABLES_ACCESSIBILITY = 0x00000002; 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 // Accessibility focus directions. 1050 1051 /** 1052 * The accessibility focus which is the current user position when 1053 * interacting with the accessibility framework. 1054 */ 1055 public static final int FOCUS_ACCESSIBILITY = 0x00001000; 1056 1057 /** 1058 * Use with {@link #focusSearch(int)}. Move acessibility focus left. 1059 */ 1060 public static final int ACCESSIBILITY_FOCUS_LEFT = FOCUS_LEFT | FOCUS_ACCESSIBILITY; 1061 1062 /** 1063 * Use with {@link #focusSearch(int)}. Move acessibility focus up. 1064 */ 1065 public static final int ACCESSIBILITY_FOCUS_UP = FOCUS_UP | FOCUS_ACCESSIBILITY; 1066 1067 /** 1068 * Use with {@link #focusSearch(int)}. Move acessibility focus right. 1069 */ 1070 public static final int ACCESSIBILITY_FOCUS_RIGHT = FOCUS_RIGHT | FOCUS_ACCESSIBILITY; 1071 1072 /** 1073 * Use with {@link #focusSearch(int)}. Move acessibility focus down. 1074 */ 1075 public static final int ACCESSIBILITY_FOCUS_DOWN = FOCUS_DOWN | FOCUS_ACCESSIBILITY; 1076 1077 /** 1078 * Use with {@link #focusSearch(int)}. Move acessibility focus forward. 1079 */ 1080 public static final int ACCESSIBILITY_FOCUS_FORWARD = FOCUS_FORWARD | FOCUS_ACCESSIBILITY; 1081 1082 /** 1083 * Use with {@link #focusSearch(int)}. Move acessibility focus backward. 1084 */ 1085 public static final int ACCESSIBILITY_FOCUS_BACKWARD = FOCUS_BACKWARD | FOCUS_ACCESSIBILITY; 1086 1087 /** 1088 * Bits of {@link #getMeasuredWidthAndState()} and 1089 * {@link #getMeasuredWidthAndState()} that provide the actual measured size. 1090 */ 1091 public static final int MEASURED_SIZE_MASK = 0x00ffffff; 1092 1093 /** 1094 * Bits of {@link #getMeasuredWidthAndState()} and 1095 * {@link #getMeasuredWidthAndState()} that provide the additional state bits. 1096 */ 1097 public static final int MEASURED_STATE_MASK = 0xff000000; 1098 1099 /** 1100 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits 1101 * for functions that combine both width and height into a single int, 1102 * such as {@link #getMeasuredState()} and the childState argument of 1103 * {@link #resolveSizeAndState(int, int, int)}. 1104 */ 1105 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16; 1106 1107 /** 1108 * Bit of {@link #getMeasuredWidthAndState()} and 1109 * {@link #getMeasuredWidthAndState()} that indicates the measured size 1110 * is smaller that the space the view would like to have. 1111 */ 1112 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000; 1113 1114 /** 1115 * Base View state sets 1116 */ 1117 // Singles 1118 /** 1119 * Indicates the view has no states set. States are used with 1120 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1121 * view depending on its state. 1122 * 1123 * @see android.graphics.drawable.Drawable 1124 * @see #getDrawableState() 1125 */ 1126 protected static final int[] EMPTY_STATE_SET; 1127 /** 1128 * Indicates the view is enabled. States are used with 1129 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1130 * view depending on its state. 1131 * 1132 * @see android.graphics.drawable.Drawable 1133 * @see #getDrawableState() 1134 */ 1135 protected static final int[] ENABLED_STATE_SET; 1136 /** 1137 * Indicates the view is focused. States are used with 1138 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1139 * view depending on its state. 1140 * 1141 * @see android.graphics.drawable.Drawable 1142 * @see #getDrawableState() 1143 */ 1144 protected static final int[] FOCUSED_STATE_SET; 1145 /** 1146 * Indicates the view is selected. States are used with 1147 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1148 * view depending on its state. 1149 * 1150 * @see android.graphics.drawable.Drawable 1151 * @see #getDrawableState() 1152 */ 1153 protected static final int[] SELECTED_STATE_SET; 1154 /** 1155 * Indicates the view is pressed. States are used with 1156 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1157 * view depending on its state. 1158 * 1159 * @see android.graphics.drawable.Drawable 1160 * @see #getDrawableState() 1161 * @hide 1162 */ 1163 protected static final int[] PRESSED_STATE_SET; 1164 /** 1165 * Indicates the view's window has focus. States are used with 1166 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1167 * view depending on its state. 1168 * 1169 * @see android.graphics.drawable.Drawable 1170 * @see #getDrawableState() 1171 */ 1172 protected static final int[] WINDOW_FOCUSED_STATE_SET; 1173 // Doubles 1174 /** 1175 * Indicates the view is enabled and has the focus. 1176 * 1177 * @see #ENABLED_STATE_SET 1178 * @see #FOCUSED_STATE_SET 1179 */ 1180 protected static final int[] ENABLED_FOCUSED_STATE_SET; 1181 /** 1182 * Indicates the view is enabled and selected. 1183 * 1184 * @see #ENABLED_STATE_SET 1185 * @see #SELECTED_STATE_SET 1186 */ 1187 protected static final int[] ENABLED_SELECTED_STATE_SET; 1188 /** 1189 * Indicates the view is enabled and that its window has focus. 1190 * 1191 * @see #ENABLED_STATE_SET 1192 * @see #WINDOW_FOCUSED_STATE_SET 1193 */ 1194 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET; 1195 /** 1196 * Indicates the view is focused and selected. 1197 * 1198 * @see #FOCUSED_STATE_SET 1199 * @see #SELECTED_STATE_SET 1200 */ 1201 protected static final int[] FOCUSED_SELECTED_STATE_SET; 1202 /** 1203 * Indicates the view has the focus and that its window has the focus. 1204 * 1205 * @see #FOCUSED_STATE_SET 1206 * @see #WINDOW_FOCUSED_STATE_SET 1207 */ 1208 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET; 1209 /** 1210 * Indicates the view is selected and that its window has the focus. 1211 * 1212 * @see #SELECTED_STATE_SET 1213 * @see #WINDOW_FOCUSED_STATE_SET 1214 */ 1215 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET; 1216 // Triples 1217 /** 1218 * Indicates the view is enabled, focused and selected. 1219 * 1220 * @see #ENABLED_STATE_SET 1221 * @see #FOCUSED_STATE_SET 1222 * @see #SELECTED_STATE_SET 1223 */ 1224 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET; 1225 /** 1226 * Indicates the view is enabled, focused and its window has the focus. 1227 * 1228 * @see #ENABLED_STATE_SET 1229 * @see #FOCUSED_STATE_SET 1230 * @see #WINDOW_FOCUSED_STATE_SET 1231 */ 1232 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1233 /** 1234 * Indicates the view is enabled, selected and its window has the focus. 1235 * 1236 * @see #ENABLED_STATE_SET 1237 * @see #SELECTED_STATE_SET 1238 * @see #WINDOW_FOCUSED_STATE_SET 1239 */ 1240 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1241 /** 1242 * Indicates the view is focused, selected and its window has the focus. 1243 * 1244 * @see #FOCUSED_STATE_SET 1245 * @see #SELECTED_STATE_SET 1246 * @see #WINDOW_FOCUSED_STATE_SET 1247 */ 1248 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1249 /** 1250 * Indicates the view is enabled, focused, selected and its window 1251 * has the focus. 1252 * 1253 * @see #ENABLED_STATE_SET 1254 * @see #FOCUSED_STATE_SET 1255 * @see #SELECTED_STATE_SET 1256 * @see #WINDOW_FOCUSED_STATE_SET 1257 */ 1258 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1259 /** 1260 * Indicates the view is pressed and its window has the focus. 1261 * 1262 * @see #PRESSED_STATE_SET 1263 * @see #WINDOW_FOCUSED_STATE_SET 1264 */ 1265 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET; 1266 /** 1267 * Indicates the view is pressed and selected. 1268 * 1269 * @see #PRESSED_STATE_SET 1270 * @see #SELECTED_STATE_SET 1271 */ 1272 protected static final int[] PRESSED_SELECTED_STATE_SET; 1273 /** 1274 * Indicates the view is pressed, selected and its window has the focus. 1275 * 1276 * @see #PRESSED_STATE_SET 1277 * @see #SELECTED_STATE_SET 1278 * @see #WINDOW_FOCUSED_STATE_SET 1279 */ 1280 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1281 /** 1282 * Indicates the view is pressed and focused. 1283 * 1284 * @see #PRESSED_STATE_SET 1285 * @see #FOCUSED_STATE_SET 1286 */ 1287 protected static final int[] PRESSED_FOCUSED_STATE_SET; 1288 /** 1289 * Indicates the view is pressed, focused and its window has the focus. 1290 * 1291 * @see #PRESSED_STATE_SET 1292 * @see #FOCUSED_STATE_SET 1293 * @see #WINDOW_FOCUSED_STATE_SET 1294 */ 1295 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1296 /** 1297 * Indicates the view is pressed, focused and selected. 1298 * 1299 * @see #PRESSED_STATE_SET 1300 * @see #SELECTED_STATE_SET 1301 * @see #FOCUSED_STATE_SET 1302 */ 1303 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET; 1304 /** 1305 * Indicates the view is pressed, focused, selected and its window has the focus. 1306 * 1307 * @see #PRESSED_STATE_SET 1308 * @see #FOCUSED_STATE_SET 1309 * @see #SELECTED_STATE_SET 1310 * @see #WINDOW_FOCUSED_STATE_SET 1311 */ 1312 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1313 /** 1314 * Indicates the view is pressed and enabled. 1315 * 1316 * @see #PRESSED_STATE_SET 1317 * @see #ENABLED_STATE_SET 1318 */ 1319 protected static final int[] PRESSED_ENABLED_STATE_SET; 1320 /** 1321 * Indicates the view is pressed, enabled and its window has the focus. 1322 * 1323 * @see #PRESSED_STATE_SET 1324 * @see #ENABLED_STATE_SET 1325 * @see #WINDOW_FOCUSED_STATE_SET 1326 */ 1327 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET; 1328 /** 1329 * Indicates the view is pressed, enabled and selected. 1330 * 1331 * @see #PRESSED_STATE_SET 1332 * @see #ENABLED_STATE_SET 1333 * @see #SELECTED_STATE_SET 1334 */ 1335 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET; 1336 /** 1337 * Indicates the view is pressed, enabled, selected and its window has the 1338 * focus. 1339 * 1340 * @see #PRESSED_STATE_SET 1341 * @see #ENABLED_STATE_SET 1342 * @see #SELECTED_STATE_SET 1343 * @see #WINDOW_FOCUSED_STATE_SET 1344 */ 1345 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1346 /** 1347 * Indicates the view is pressed, enabled and focused. 1348 * 1349 * @see #PRESSED_STATE_SET 1350 * @see #ENABLED_STATE_SET 1351 * @see #FOCUSED_STATE_SET 1352 */ 1353 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET; 1354 /** 1355 * Indicates the view is pressed, enabled, focused and its window has the 1356 * focus. 1357 * 1358 * @see #PRESSED_STATE_SET 1359 * @see #ENABLED_STATE_SET 1360 * @see #FOCUSED_STATE_SET 1361 * @see #WINDOW_FOCUSED_STATE_SET 1362 */ 1363 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1364 /** 1365 * Indicates the view is pressed, enabled, focused and selected. 1366 * 1367 * @see #PRESSED_STATE_SET 1368 * @see #ENABLED_STATE_SET 1369 * @see #SELECTED_STATE_SET 1370 * @see #FOCUSED_STATE_SET 1371 */ 1372 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET; 1373 /** 1374 * Indicates the view is pressed, enabled, focused, selected and its window 1375 * has the focus. 1376 * 1377 * @see #PRESSED_STATE_SET 1378 * @see #ENABLED_STATE_SET 1379 * @see #SELECTED_STATE_SET 1380 * @see #FOCUSED_STATE_SET 1381 * @see #WINDOW_FOCUSED_STATE_SET 1382 */ 1383 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1384 1385 /** 1386 * The order here is very important to {@link #getDrawableState()} 1387 */ 1388 private static final int[][] VIEW_STATE_SETS; 1389 1390 static final int VIEW_STATE_WINDOW_FOCUSED = 1; 1391 static final int VIEW_STATE_SELECTED = 1 << 1; 1392 static final int VIEW_STATE_FOCUSED = 1 << 2; 1393 static final int VIEW_STATE_ENABLED = 1 << 3; 1394 static final int VIEW_STATE_PRESSED = 1 << 4; 1395 static final int VIEW_STATE_ACTIVATED = 1 << 5; 1396 static final int VIEW_STATE_ACCELERATED = 1 << 6; 1397 static final int VIEW_STATE_HOVERED = 1 << 7; 1398 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8; 1399 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9; 1400 1401 static final int[] VIEW_STATE_IDS = new int[] { 1402 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED, 1403 R.attr.state_selected, VIEW_STATE_SELECTED, 1404 R.attr.state_focused, VIEW_STATE_FOCUSED, 1405 R.attr.state_enabled, VIEW_STATE_ENABLED, 1406 R.attr.state_pressed, VIEW_STATE_PRESSED, 1407 R.attr.state_activated, VIEW_STATE_ACTIVATED, 1408 R.attr.state_accelerated, VIEW_STATE_ACCELERATED, 1409 R.attr.state_hovered, VIEW_STATE_HOVERED, 1410 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT, 1411 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED 1412 }; 1413 1414 static { 1415 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) { 1416 throw new IllegalStateException( 1417 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array"); 1418 } 1419 int[] orderedIds = new int[VIEW_STATE_IDS.length]; 1420 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) { 1421 int viewState = R.styleable.ViewDrawableStates[i]; 1422 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) { 1423 if (VIEW_STATE_IDS[j] == viewState) { 1424 orderedIds[i * 2] = viewState; 1425 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1]; 1426 } 1427 } 1428 } 1429 final int NUM_BITS = VIEW_STATE_IDS.length / 2; 1430 VIEW_STATE_SETS = new int[1 << NUM_BITS][]; 1431 for (int i = 0; i < VIEW_STATE_SETS.length; i++) { 1432 int numBits = Integer.bitCount(i); 1433 int[] set = new int[numBits]; 1434 int pos = 0; 1435 for (int j = 0; j < orderedIds.length; j += 2) { 1436 if ((i & orderedIds[j+1]) != 0) { 1437 set[pos++] = orderedIds[j]; 1438 } 1439 } 1440 VIEW_STATE_SETS[i] = set; 1441 } 1442 1443 EMPTY_STATE_SET = VIEW_STATE_SETS[0]; 1444 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED]; 1445 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED]; 1446 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1447 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED]; 1448 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED]; 1449 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1450 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED]; 1451 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1452 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED]; 1453 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1454 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1455 | VIEW_STATE_FOCUSED]; 1456 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED]; 1457 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1458 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED]; 1459 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1460 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED]; 1461 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1462 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1463 | VIEW_STATE_ENABLED]; 1464 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1465 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED]; 1466 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1467 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1468 | VIEW_STATE_ENABLED]; 1469 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1470 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1471 | VIEW_STATE_ENABLED]; 1472 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1473 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1474 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED]; 1475 1476 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED]; 1477 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1478 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED]; 1479 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1480 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED]; 1481 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1482 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1483 | VIEW_STATE_PRESSED]; 1484 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1485 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1486 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1487 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1488 | VIEW_STATE_PRESSED]; 1489 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1490 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1491 | VIEW_STATE_PRESSED]; 1492 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1493 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1494 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1495 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[ 1496 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1497 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1498 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED 1499 | VIEW_STATE_PRESSED]; 1500 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1501 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED 1502 | VIEW_STATE_PRESSED]; 1503 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1504 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1505 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1506 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1507 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED 1508 | VIEW_STATE_PRESSED]; 1509 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1510 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1511 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1512 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1513 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1514 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1515 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1516 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1517 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED 1518 | VIEW_STATE_PRESSED]; 1519 } 1520 1521 /** 1522 * Accessibility event types that are dispatched for text population. 1523 */ 1524 private static final int POPULATING_ACCESSIBILITY_EVENT_TYPES = 1525 AccessibilityEvent.TYPE_VIEW_CLICKED 1526 | AccessibilityEvent.TYPE_VIEW_LONG_CLICKED 1527 | AccessibilityEvent.TYPE_VIEW_SELECTED 1528 | AccessibilityEvent.TYPE_VIEW_FOCUSED 1529 | AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED 1530 | AccessibilityEvent.TYPE_VIEW_HOVER_ENTER 1531 | AccessibilityEvent.TYPE_VIEW_HOVER_EXIT 1532 | AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED 1533 | AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED 1534 | AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED 1535 | AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY; 1536 1537 /** 1538 * Temporary Rect currently for use in setBackground(). This will probably 1539 * be extended in the future to hold our own class with more than just 1540 * a Rect. :) 1541 */ 1542 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>(); 1543 1544 /** 1545 * Map used to store views' tags. 1546 */ 1547 private SparseArray<Object> mKeyedTags; 1548 1549 /** 1550 * The next available accessiiblity id. 1551 */ 1552 private static int sNextAccessibilityViewId; 1553 1554 /** 1555 * The animation currently associated with this view. 1556 * @hide 1557 */ 1558 protected Animation mCurrentAnimation = null; 1559 1560 /** 1561 * Width as measured during measure pass. 1562 * {@hide} 1563 */ 1564 @ViewDebug.ExportedProperty(category = "measurement") 1565 int mMeasuredWidth; 1566 1567 /** 1568 * Height as measured during measure pass. 1569 * {@hide} 1570 */ 1571 @ViewDebug.ExportedProperty(category = "measurement") 1572 int mMeasuredHeight; 1573 1574 /** 1575 * Flag to indicate that this view was marked INVALIDATED, or had its display list 1576 * invalidated, prior to the current drawing iteration. If true, the view must re-draw 1577 * its display list. This flag, used only when hw accelerated, allows us to clear the 1578 * flag while retaining this information until it's needed (at getDisplayList() time and 1579 * in drawChild(), when we decide to draw a view's children's display lists into our own). 1580 * 1581 * {@hide} 1582 */ 1583 boolean mRecreateDisplayList = false; 1584 1585 /** 1586 * The view's identifier. 1587 * {@hide} 1588 * 1589 * @see #setId(int) 1590 * @see #getId() 1591 */ 1592 @ViewDebug.ExportedProperty(resolveId = true) 1593 int mID = NO_ID; 1594 1595 /** 1596 * The stable ID of this view for accessibility purposes. 1597 */ 1598 int mAccessibilityViewId = NO_ID; 1599 1600 /** 1601 * @hide 1602 */ 1603 private int mAccessibilityCursorPosition = -1; 1604 1605 /** 1606 * The view's tag. 1607 * {@hide} 1608 * 1609 * @see #setTag(Object) 1610 * @see #getTag() 1611 */ 1612 protected Object mTag; 1613 1614 // for mPrivateFlags: 1615 /** {@hide} */ 1616 static final int WANTS_FOCUS = 0x00000001; 1617 /** {@hide} */ 1618 static final int FOCUSED = 0x00000002; 1619 /** {@hide} */ 1620 static final int SELECTED = 0x00000004; 1621 /** {@hide} */ 1622 static final int IS_ROOT_NAMESPACE = 0x00000008; 1623 /** {@hide} */ 1624 static final int HAS_BOUNDS = 0x00000010; 1625 /** {@hide} */ 1626 static final int DRAWN = 0x00000020; 1627 /** 1628 * When this flag is set, this view is running an animation on behalf of its 1629 * children and should therefore not cancel invalidate requests, even if they 1630 * lie outside of this view's bounds. 1631 * 1632 * {@hide} 1633 */ 1634 static final int DRAW_ANIMATION = 0x00000040; 1635 /** {@hide} */ 1636 static final int SKIP_DRAW = 0x00000080; 1637 /** {@hide} */ 1638 static final int ONLY_DRAWS_BACKGROUND = 0x00000100; 1639 /** {@hide} */ 1640 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200; 1641 /** {@hide} */ 1642 static final int DRAWABLE_STATE_DIRTY = 0x00000400; 1643 /** {@hide} */ 1644 static final int MEASURED_DIMENSION_SET = 0x00000800; 1645 /** {@hide} */ 1646 static final int FORCE_LAYOUT = 0x00001000; 1647 /** {@hide} */ 1648 static final int LAYOUT_REQUIRED = 0x00002000; 1649 1650 private static final int PRESSED = 0x00004000; 1651 1652 /** {@hide} */ 1653 static final int DRAWING_CACHE_VALID = 0x00008000; 1654 /** 1655 * Flag used to indicate that this view should be drawn once more (and only once 1656 * more) after its animation has completed. 1657 * {@hide} 1658 */ 1659 static final int ANIMATION_STARTED = 0x00010000; 1660 1661 private static final int SAVE_STATE_CALLED = 0x00020000; 1662 1663 /** 1664 * Indicates that the View returned true when onSetAlpha() was called and that 1665 * the alpha must be restored. 1666 * {@hide} 1667 */ 1668 static final int ALPHA_SET = 0x00040000; 1669 1670 /** 1671 * Set by {@link #setScrollContainer(boolean)}. 1672 */ 1673 static final int SCROLL_CONTAINER = 0x00080000; 1674 1675 /** 1676 * Set by {@link #setScrollContainer(boolean)}. 1677 */ 1678 static final int SCROLL_CONTAINER_ADDED = 0x00100000; 1679 1680 /** 1681 * View flag indicating whether this view was invalidated (fully or partially.) 1682 * 1683 * @hide 1684 */ 1685 static final int DIRTY = 0x00200000; 1686 1687 /** 1688 * View flag indicating whether this view was invalidated by an opaque 1689 * invalidate request. 1690 * 1691 * @hide 1692 */ 1693 static final int DIRTY_OPAQUE = 0x00400000; 1694 1695 /** 1696 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}. 1697 * 1698 * @hide 1699 */ 1700 static final int DIRTY_MASK = 0x00600000; 1701 1702 /** 1703 * Indicates whether the background is opaque. 1704 * 1705 * @hide 1706 */ 1707 static final int OPAQUE_BACKGROUND = 0x00800000; 1708 1709 /** 1710 * Indicates whether the scrollbars are opaque. 1711 * 1712 * @hide 1713 */ 1714 static final int OPAQUE_SCROLLBARS = 0x01000000; 1715 1716 /** 1717 * Indicates whether the view is opaque. 1718 * 1719 * @hide 1720 */ 1721 static final int OPAQUE_MASK = 0x01800000; 1722 1723 /** 1724 * Indicates a prepressed state; 1725 * the short time between ACTION_DOWN and recognizing 1726 * a 'real' press. Prepressed is used to recognize quick taps 1727 * even when they are shorter than ViewConfiguration.getTapTimeout(). 1728 * 1729 * @hide 1730 */ 1731 private static final int PREPRESSED = 0x02000000; 1732 1733 /** 1734 * Indicates whether the view is temporarily detached. 1735 * 1736 * @hide 1737 */ 1738 static final int CANCEL_NEXT_UP_EVENT = 0x04000000; 1739 1740 /** 1741 * Indicates that we should awaken scroll bars once attached 1742 * 1743 * @hide 1744 */ 1745 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000; 1746 1747 /** 1748 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT. 1749 * @hide 1750 */ 1751 private static final int HOVERED = 0x10000000; 1752 1753 /** 1754 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center 1755 * for transform operations 1756 * 1757 * @hide 1758 */ 1759 private static final int PIVOT_EXPLICITLY_SET = 0x20000000; 1760 1761 /** {@hide} */ 1762 static final int ACTIVATED = 0x40000000; 1763 1764 /** 1765 * Indicates that this view was specifically invalidated, not just dirtied because some 1766 * child view was invalidated. The flag is used to determine when we need to recreate 1767 * a view's display list (as opposed to just returning a reference to its existing 1768 * display list). 1769 * 1770 * @hide 1771 */ 1772 static final int INVALIDATED = 0x80000000; 1773 1774 /* Masks for mPrivateFlags2 */ 1775 1776 /** 1777 * Indicates that this view has reported that it can accept the current drag's content. 1778 * Cleared when the drag operation concludes. 1779 * @hide 1780 */ 1781 static final int DRAG_CAN_ACCEPT = 0x00000001; 1782 1783 /** 1784 * Indicates that this view is currently directly under the drag location in a 1785 * drag-and-drop operation involving content that it can accept. Cleared when 1786 * the drag exits the view, or when the drag operation concludes. 1787 * @hide 1788 */ 1789 static final int DRAG_HOVERED = 0x00000002; 1790 1791 /** 1792 * Horizontal layout direction of this view is from Left to Right. 1793 * Use with {@link #setLayoutDirection}. 1794 */ 1795 public static final int LAYOUT_DIRECTION_LTR = 0; 1796 1797 /** 1798 * Horizontal layout direction of this view is from Right to Left. 1799 * Use with {@link #setLayoutDirection}. 1800 */ 1801 public static final int LAYOUT_DIRECTION_RTL = 1; 1802 1803 /** 1804 * Horizontal layout direction of this view is inherited from its parent. 1805 * Use with {@link #setLayoutDirection}. 1806 */ 1807 public static final int LAYOUT_DIRECTION_INHERIT = 2; 1808 1809 /** 1810 * Horizontal layout direction of this view is from deduced from the default language 1811 * script for the locale. Use with {@link #setLayoutDirection}. 1812 */ 1813 public static final int LAYOUT_DIRECTION_LOCALE = 3; 1814 1815 /** 1816 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 1817 * @hide 1818 */ 1819 static final int LAYOUT_DIRECTION_MASK_SHIFT = 2; 1820 1821 /** 1822 * Mask for use with private flags indicating bits used for horizontal layout direction. 1823 * @hide 1824 */ 1825 static final int LAYOUT_DIRECTION_MASK = 0x00000003 << LAYOUT_DIRECTION_MASK_SHIFT; 1826 1827 /** 1828 * Indicates whether the view horizontal layout direction has been resolved and drawn to the 1829 * right-to-left direction. 1830 * @hide 1831 */ 1832 static final int LAYOUT_DIRECTION_RESOLVED_RTL = 4 << LAYOUT_DIRECTION_MASK_SHIFT; 1833 1834 /** 1835 * Indicates whether the view horizontal layout direction has been resolved. 1836 * @hide 1837 */ 1838 static final int LAYOUT_DIRECTION_RESOLVED = 8 << LAYOUT_DIRECTION_MASK_SHIFT; 1839 1840 /** 1841 * Mask for use with private flags indicating bits used for resolved horizontal layout direction. 1842 * @hide 1843 */ 1844 static final int LAYOUT_DIRECTION_RESOLVED_MASK = 0x0000000C << LAYOUT_DIRECTION_MASK_SHIFT; 1845 1846 /* 1847 * Array of horizontal layout direction flags for mapping attribute "layoutDirection" to correct 1848 * flag value. 1849 * @hide 1850 */ 1851 private static final int[] LAYOUT_DIRECTION_FLAGS = { 1852 LAYOUT_DIRECTION_LTR, 1853 LAYOUT_DIRECTION_RTL, 1854 LAYOUT_DIRECTION_INHERIT, 1855 LAYOUT_DIRECTION_LOCALE 1856 }; 1857 1858 /** 1859 * Default horizontal layout direction. 1860 * @hide 1861 */ 1862 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT; 1863 1864 /** 1865 * Indicates that the view is tracking some sort of transient state 1866 * that the app should not need to be aware of, but that the framework 1867 * should take special care to preserve. 1868 * 1869 * @hide 1870 */ 1871 static final int HAS_TRANSIENT_STATE = 0x00000100; 1872 1873 1874 /** 1875 * Text direction is inherited thru {@link ViewGroup} 1876 */ 1877 public static final int TEXT_DIRECTION_INHERIT = 0; 1878 1879 /** 1880 * Text direction is using "first strong algorithm". The first strong directional character 1881 * determines the paragraph direction. If there is no strong directional character, the 1882 * paragraph direction is the view's resolved layout direction. 1883 */ 1884 public static final int TEXT_DIRECTION_FIRST_STRONG = 1; 1885 1886 /** 1887 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains 1888 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters. 1889 * If there are neither, the paragraph direction is the view's resolved layout direction. 1890 */ 1891 public static final int TEXT_DIRECTION_ANY_RTL = 2; 1892 1893 /** 1894 * Text direction is forced to LTR. 1895 */ 1896 public static final int TEXT_DIRECTION_LTR = 3; 1897 1898 /** 1899 * Text direction is forced to RTL. 1900 */ 1901 public static final int TEXT_DIRECTION_RTL = 4; 1902 1903 /** 1904 * Text direction is coming from the system Locale. 1905 */ 1906 public static final int TEXT_DIRECTION_LOCALE = 5; 1907 1908 /** 1909 * Default text direction is inherited 1910 */ 1911 protected static int TEXT_DIRECTION_DEFAULT = TEXT_DIRECTION_INHERIT; 1912 1913 /** 1914 * Bit shift to get the horizontal layout direction. (bits after LAYOUT_DIRECTION_RESOLVED) 1915 * @hide 1916 */ 1917 static final int TEXT_DIRECTION_MASK_SHIFT = 6; 1918 1919 /** 1920 * Mask for use with private flags indicating bits used for text direction. 1921 * @hide 1922 */ 1923 static final int TEXT_DIRECTION_MASK = 0x00000007 << TEXT_DIRECTION_MASK_SHIFT; 1924 1925 /** 1926 * Array of text direction flags for mapping attribute "textDirection" to correct 1927 * flag value. 1928 * @hide 1929 */ 1930 private static final int[] TEXT_DIRECTION_FLAGS = { 1931 TEXT_DIRECTION_INHERIT << TEXT_DIRECTION_MASK_SHIFT, 1932 TEXT_DIRECTION_FIRST_STRONG << TEXT_DIRECTION_MASK_SHIFT, 1933 TEXT_DIRECTION_ANY_RTL << TEXT_DIRECTION_MASK_SHIFT, 1934 TEXT_DIRECTION_LTR << TEXT_DIRECTION_MASK_SHIFT, 1935 TEXT_DIRECTION_RTL << TEXT_DIRECTION_MASK_SHIFT, 1936 TEXT_DIRECTION_LOCALE << TEXT_DIRECTION_MASK_SHIFT 1937 }; 1938 1939 /** 1940 * Indicates whether the view text direction has been resolved. 1941 * @hide 1942 */ 1943 static final int TEXT_DIRECTION_RESOLVED = 0x00000008 << TEXT_DIRECTION_MASK_SHIFT; 1944 1945 /** 1946 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 1947 * @hide 1948 */ 1949 static final int TEXT_DIRECTION_RESOLVED_MASK_SHIFT = 10; 1950 1951 /** 1952 * Mask for use with private flags indicating bits used for resolved text direction. 1953 * @hide 1954 */ 1955 static final int TEXT_DIRECTION_RESOLVED_MASK = 0x00000007 << TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 1956 1957 /** 1958 * Indicates whether the view text direction has been resolved to the "first strong" heuristic. 1959 * @hide 1960 */ 1961 static final int TEXT_DIRECTION_RESOLVED_DEFAULT = 1962 TEXT_DIRECTION_FIRST_STRONG << TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 1963 1964 /* 1965 * Default text alignment. The text alignment of this View is inherited from its parent. 1966 * Use with {@link #setTextAlignment(int)} 1967 */ 1968 public static final int TEXT_ALIGNMENT_INHERIT = 0; 1969 1970 /** 1971 * Default for the root view. The gravity determines the text alignment, ALIGN_NORMAL, 1972 * ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph’s text direction. 1973 * 1974 * Use with {@link #setTextAlignment(int)} 1975 */ 1976 public static final int TEXT_ALIGNMENT_GRAVITY = 1; 1977 1978 /** 1979 * Align to the start of the paragraph, e.g. ALIGN_NORMAL. 1980 * 1981 * Use with {@link #setTextAlignment(int)} 1982 */ 1983 public static final int TEXT_ALIGNMENT_TEXT_START = 2; 1984 1985 /** 1986 * Align to the end of the paragraph, e.g. ALIGN_OPPOSITE. 1987 * 1988 * Use with {@link #setTextAlignment(int)} 1989 */ 1990 public static final int TEXT_ALIGNMENT_TEXT_END = 3; 1991 1992 /** 1993 * Center the paragraph, e.g. ALIGN_CENTER. 1994 * 1995 * Use with {@link #setTextAlignment(int)} 1996 */ 1997 public static final int TEXT_ALIGNMENT_CENTER = 4; 1998 1999 /** 2000 * Align to the start of the view, which is ALIGN_LEFT if the view’s resolved 2001 * layoutDirection is LTR, and ALIGN_RIGHT otherwise. 2002 * 2003 * Use with {@link #setTextAlignment(int)} 2004 */ 2005 public static final int TEXT_ALIGNMENT_VIEW_START = 5; 2006 2007 /** 2008 * Align to the end of the view, which is ALIGN_RIGHT if the view’s resolved 2009 * layoutDirection is LTR, and ALIGN_LEFT otherwise. 2010 * 2011 * Use with {@link #setTextAlignment(int)} 2012 */ 2013 public static final int TEXT_ALIGNMENT_VIEW_END = 6; 2014 2015 /** 2016 * Default text alignment is inherited 2017 */ 2018 protected static int TEXT_ALIGNMENT_DEFAULT = TEXT_ALIGNMENT_GRAVITY; 2019 2020 /** 2021 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED) 2022 * @hide 2023 */ 2024 static final int TEXT_ALIGNMENT_MASK_SHIFT = 13; 2025 2026 /** 2027 * Mask for use with private flags indicating bits used for text alignment. 2028 * @hide 2029 */ 2030 static final int TEXT_ALIGNMENT_MASK = 0x00000007 << TEXT_ALIGNMENT_MASK_SHIFT; 2031 2032 /** 2033 * Array of text direction flags for mapping attribute "textAlignment" to correct 2034 * flag value. 2035 * @hide 2036 */ 2037 private static final int[] TEXT_ALIGNMENT_FLAGS = { 2038 TEXT_ALIGNMENT_INHERIT << TEXT_ALIGNMENT_MASK_SHIFT, 2039 TEXT_ALIGNMENT_GRAVITY << TEXT_ALIGNMENT_MASK_SHIFT, 2040 TEXT_ALIGNMENT_TEXT_START << TEXT_ALIGNMENT_MASK_SHIFT, 2041 TEXT_ALIGNMENT_TEXT_END << TEXT_ALIGNMENT_MASK_SHIFT, 2042 TEXT_ALIGNMENT_CENTER << TEXT_ALIGNMENT_MASK_SHIFT, 2043 TEXT_ALIGNMENT_VIEW_START << TEXT_ALIGNMENT_MASK_SHIFT, 2044 TEXT_ALIGNMENT_VIEW_END << TEXT_ALIGNMENT_MASK_SHIFT 2045 }; 2046 2047 /** 2048 * Indicates whether the view text alignment has been resolved. 2049 * @hide 2050 */ 2051 static final int TEXT_ALIGNMENT_RESOLVED = 0x00000008 << TEXT_ALIGNMENT_MASK_SHIFT; 2052 2053 /** 2054 * Bit shift to get the resolved text alignment. 2055 * @hide 2056 */ 2057 static final int TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT = 17; 2058 2059 /** 2060 * Mask for use with private flags indicating bits used for text alignment. 2061 * @hide 2062 */ 2063 static final int TEXT_ALIGNMENT_RESOLVED_MASK = 0x00000007 << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 2064 2065 /** 2066 * Indicates whether if the view text alignment has been resolved to gravity 2067 */ 2068 public static final int TEXT_ALIGNMENT_RESOLVED_DEFAULT = 2069 TEXT_ALIGNMENT_GRAVITY << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 2070 2071 // Accessiblity constants for mPrivateFlags2 2072 2073 /** 2074 * Shift for accessibility related bits in {@link #mPrivateFlags2}. 2075 */ 2076 static final int IMPORTANT_FOR_ACCESSIBILITY_SHIFT = 20; 2077 2078 /** 2079 * Automatically determine whether a view is important for accessibility. 2080 */ 2081 public static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0x00000000; 2082 2083 /** 2084 * The view is important for accessibility. 2085 */ 2086 public static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 0x00000001; 2087 2088 /** 2089 * The view is not important for accessibility. 2090 */ 2091 public static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 0x00000002; 2092 2093 /** 2094 * The default whether the view is important for accessiblity. 2095 */ 2096 static final int IMPORTANT_FOR_ACCESSIBILITY_DEFAULT = IMPORTANT_FOR_ACCESSIBILITY_AUTO; 2097 2098 /** 2099 * Mask for obtainig the bits which specify how to determine 2100 * whether a view is important for accessibility. 2101 */ 2102 static final int IMPORTANT_FOR_ACCESSIBILITY_MASK = (IMPORTANT_FOR_ACCESSIBILITY_AUTO 2103 | IMPORTANT_FOR_ACCESSIBILITY_YES | IMPORTANT_FOR_ACCESSIBILITY_NO) 2104 << IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2105 2106 /** 2107 * Flag indicating whether a view has accessibility focus. 2108 */ 2109 static final int ACCESSIBILITY_FOCUSED = 0x00000040 << IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2110 2111 /** 2112 * Flag indicating whether a view state for accessibility has changed. 2113 */ 2114 static final int ACCESSIBILITY_STATE_CHANGED = 0x00000080 << IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 2115 2116 /* End of masks for mPrivateFlags2 */ 2117 2118 static final int DRAG_MASK = DRAG_CAN_ACCEPT | DRAG_HOVERED; 2119 2120 /** 2121 * Always allow a user to over-scroll this view, provided it is a 2122 * view that can scroll. 2123 * 2124 * @see #getOverScrollMode() 2125 * @see #setOverScrollMode(int) 2126 */ 2127 public static final int OVER_SCROLL_ALWAYS = 0; 2128 2129 /** 2130 * Allow a user to over-scroll this view only if the content is large 2131 * enough to meaningfully scroll, provided it is a view that can scroll. 2132 * 2133 * @see #getOverScrollMode() 2134 * @see #setOverScrollMode(int) 2135 */ 2136 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1; 2137 2138 /** 2139 * Never allow a user to over-scroll this view. 2140 * 2141 * @see #getOverScrollMode() 2142 * @see #setOverScrollMode(int) 2143 */ 2144 public static final int OVER_SCROLL_NEVER = 2; 2145 2146 /** 2147 * Special constant for {@link #setSystemUiVisibility(int)}: View has 2148 * requested the system UI (status bar) to be visible (the default). 2149 * 2150 * @see #setSystemUiVisibility(int) 2151 */ 2152 public static final int SYSTEM_UI_FLAG_VISIBLE = 0; 2153 2154 /** 2155 * Flag for {@link #setSystemUiVisibility(int)}: View has requested the 2156 * system UI to enter an unobtrusive "low profile" mode. 2157 * 2158 * <p>This is for use in games, book readers, video players, or any other 2159 * "immersive" application where the usual system chrome is deemed too distracting. 2160 * 2161 * <p>In low profile mode, the status bar and/or navigation icons may dim. 2162 * 2163 * @see #setSystemUiVisibility(int) 2164 */ 2165 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001; 2166 2167 /** 2168 * Flag for {@link #setSystemUiVisibility(int)}: View has requested that the 2169 * system navigation be temporarily hidden. 2170 * 2171 * <p>This is an even less obtrusive state than that called for by 2172 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls 2173 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause 2174 * those to disappear. This is useful (in conjunction with the 2175 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and 2176 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN} 2177 * window flags) for displaying content using every last pixel on the display. 2178 * 2179 * <p>There is a limitation: because navigation controls are so important, the least user 2180 * interaction will cause them to reappear immediately. When this happens, both 2181 * this flag and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be cleared automatically, 2182 * so that both elements reappear at the same time. 2183 * 2184 * @see #setSystemUiVisibility(int) 2185 */ 2186 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002; 2187 2188 /** 2189 * Flag for {@link #setSystemUiVisibility(int)}: View has requested to go 2190 * into the normal fullscreen mode so that its content can take over the screen 2191 * while still allowing the user to interact with the application. 2192 * 2193 * <p>This has the same visual effect as 2194 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN 2195 * WindowManager.LayoutParams.FLAG_FULLSCREEN}, 2196 * meaning that non-critical screen decorations (such as the status bar) will be 2197 * hidden while the user is in the View's window, focusing the experience on 2198 * that content. Unlike the window flag, if you are using ActionBar in 2199 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY 2200 * Window.FEATURE_ACTION_BAR_OVERLAY}, then enabling this flag will also 2201 * hide the action bar. 2202 * 2203 * <p>This approach to going fullscreen is best used over the window flag when 2204 * it is a transient state -- that is, the application does this at certain 2205 * points in its user interaction where it wants to allow the user to focus 2206 * on content, but not as a continuous state. For situations where the application 2207 * would like to simply stay full screen the entire time (such as a game that 2208 * wants to take over the screen), the 2209 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN window flag} 2210 * is usually a better approach. The state set here will be removed by the system 2211 * in various situations (such as the user moving to another application) like 2212 * the other system UI states. 2213 * 2214 * <p>When using this flag, the application should provide some easy facility 2215 * for the user to go out of it. A common example would be in an e-book 2216 * reader, where tapping on the screen brings back whatever screen and UI 2217 * decorations that had been hidden while the user was immersed in reading 2218 * the book. 2219 * 2220 * @see #setSystemUiVisibility(int) 2221 */ 2222 public static final int SYSTEM_UI_FLAG_FULLSCREEN = 0x00000004; 2223 2224 /** 2225 * Flag for {@link #setSystemUiVisibility(int)}: When using other layout 2226 * flags, we would like a stable view of the content insets given to 2227 * {@link #fitSystemWindows(Rect)}. This means that the insets seen there 2228 * will always represent the worst case that the application can expect 2229 * as a continue state. In practice this means with any of system bar, 2230 * nav bar, and status bar shown, but not the space that would be needed 2231 * for an input method. 2232 * 2233 * <p>If you are using ActionBar in 2234 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY 2235 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the 2236 * insets it adds to those given to the application. 2237 */ 2238 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100; 2239 2240 /** 2241 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window 2242 * to be layed out as if it has requested 2243 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This 2244 * allows it to avoid artifacts when switching in and out of that mode, at 2245 * the expense that some of its user interface may be covered by screen 2246 * decorations when they are shown. You can perform layout of your inner 2247 * UI elements to account for the navagation system UI through the 2248 * {@link #fitSystemWindows(Rect)} method. 2249 */ 2250 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200; 2251 2252 /** 2253 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window 2254 * to be layed out as if it has requested 2255 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This 2256 * allows it to avoid artifacts when switching in and out of that mode, at 2257 * the expense that some of its user interface may be covered by screen 2258 * decorations when they are shown. You can perform layout of your inner 2259 * UI elements to account for non-fullscreen system UI through the 2260 * {@link #fitSystemWindows(Rect)} method. 2261 */ 2262 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400; 2263 2264 /** 2265 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead. 2266 */ 2267 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE; 2268 2269 /** 2270 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead. 2271 */ 2272 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE; 2273 2274 /** 2275 * @hide 2276 * 2277 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2278 * out of the public fields to keep the undefined bits out of the developer's way. 2279 * 2280 * Flag to make the status bar not expandable. Unless you also 2281 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show. 2282 */ 2283 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000; 2284 2285 /** 2286 * @hide 2287 * 2288 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2289 * out of the public fields to keep the undefined bits out of the developer's way. 2290 * 2291 * Flag to hide notification icons and scrolling ticker text. 2292 */ 2293 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000; 2294 2295 /** 2296 * @hide 2297 * 2298 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2299 * out of the public fields to keep the undefined bits out of the developer's way. 2300 * 2301 * Flag to disable incoming notification alerts. This will not block 2302 * icons, but it will block sound, vibrating and other visual or aural notifications. 2303 */ 2304 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000; 2305 2306 /** 2307 * @hide 2308 * 2309 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2310 * out of the public fields to keep the undefined bits out of the developer's way. 2311 * 2312 * Flag to hide only the scrolling ticker. Note that 2313 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies 2314 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}. 2315 */ 2316 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000; 2317 2318 /** 2319 * @hide 2320 * 2321 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2322 * out of the public fields to keep the undefined bits out of the developer's way. 2323 * 2324 * Flag to hide the center system info area. 2325 */ 2326 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000; 2327 2328 /** 2329 * @hide 2330 * 2331 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2332 * out of the public fields to keep the undefined bits out of the developer's way. 2333 * 2334 * Flag to hide only the home button. Don't use this 2335 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2336 */ 2337 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000; 2338 2339 /** 2340 * @hide 2341 * 2342 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2343 * out of the public fields to keep the undefined bits out of the developer's way. 2344 * 2345 * Flag to hide only the back button. Don't use this 2346 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2347 */ 2348 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000; 2349 2350 /** 2351 * @hide 2352 * 2353 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2354 * out of the public fields to keep the undefined bits out of the developer's way. 2355 * 2356 * Flag to hide only the clock. You might use this if your activity has 2357 * its own clock making the status bar's clock redundant. 2358 */ 2359 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000; 2360 2361 /** 2362 * @hide 2363 * 2364 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 2365 * out of the public fields to keep the undefined bits out of the developer's way. 2366 * 2367 * Flag to hide only the recent apps button. Don't use this 2368 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 2369 */ 2370 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000; 2371 2372 /** 2373 * @hide 2374 */ 2375 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF; 2376 2377 /** 2378 * These are the system UI flags that can be cleared by events outside 2379 * of an application. Currently this is just the ability to tap on the 2380 * screen while hiding the navigation bar to have it return. 2381 * @hide 2382 */ 2383 public static final int SYSTEM_UI_CLEARABLE_FLAGS = 2384 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION 2385 | SYSTEM_UI_FLAG_FULLSCREEN; 2386 2387 /** 2388 * Flags that can impact the layout in relation to system UI. 2389 */ 2390 public static final int SYSTEM_UI_LAYOUT_FLAGS = 2391 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION 2392 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN; 2393 2394 /** 2395 * Find views that render the specified text. 2396 * 2397 * @see #findViewsWithText(ArrayList, CharSequence, int) 2398 */ 2399 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001; 2400 2401 /** 2402 * Find find views that contain the specified content description. 2403 * 2404 * @see #findViewsWithText(ArrayList, CharSequence, int) 2405 */ 2406 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002; 2407 2408 /** 2409 * Find views that contain {@link AccessibilityNodeProvider}. Such 2410 * a View is a root of virtual view hierarchy and may contain the searched 2411 * text. If this flag is set Views with providers are automatically 2412 * added and it is a responsibility of the client to call the APIs of 2413 * the provider to determine whether the virtual tree rooted at this View 2414 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s 2415 * represeting the virtual views with this text. 2416 * 2417 * @see #findViewsWithText(ArrayList, CharSequence, int) 2418 * 2419 * @hide 2420 */ 2421 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004; 2422 2423 /** 2424 * Indicates that the screen has changed state and is now off. 2425 * 2426 * @see #onScreenStateChanged(int) 2427 */ 2428 public static final int SCREEN_STATE_OFF = 0x0; 2429 2430 /** 2431 * Indicates that the screen has changed state and is now on. 2432 * 2433 * @see #onScreenStateChanged(int) 2434 */ 2435 public static final int SCREEN_STATE_ON = 0x1; 2436 2437 /** 2438 * Controls the over-scroll mode for this view. 2439 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)}, 2440 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}, 2441 * and {@link #OVER_SCROLL_NEVER}. 2442 */ 2443 private int mOverScrollMode; 2444 2445 /** 2446 * The parent this view is attached to. 2447 * {@hide} 2448 * 2449 * @see #getParent() 2450 */ 2451 protected ViewParent mParent; 2452 2453 /** 2454 * {@hide} 2455 */ 2456 AttachInfo mAttachInfo; 2457 2458 /** 2459 * {@hide} 2460 */ 2461 @ViewDebug.ExportedProperty(flagMapping = { 2462 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT, 2463 name = "FORCE_LAYOUT"), 2464 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED, 2465 name = "LAYOUT_REQUIRED"), 2466 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID, 2467 name = "DRAWING_CACHE_INVALID", outputIf = false), 2468 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true), 2469 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false), 2470 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"), 2471 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY") 2472 }) 2473 int mPrivateFlags; 2474 int mPrivateFlags2; 2475 2476 /** 2477 * This view's request for the visibility of the status bar. 2478 * @hide 2479 */ 2480 @ViewDebug.ExportedProperty(flagMapping = { 2481 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE, 2482 equals = SYSTEM_UI_FLAG_LOW_PROFILE, 2483 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true), 2484 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2485 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2486 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true), 2487 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK, 2488 equals = SYSTEM_UI_FLAG_VISIBLE, 2489 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true) 2490 }) 2491 int mSystemUiVisibility; 2492 2493 /** 2494 * Reference count for transient state. 2495 * @see #setHasTransientState(boolean) 2496 */ 2497 int mTransientStateCount = 0; 2498 2499 /** 2500 * Count of how many windows this view has been attached to. 2501 */ 2502 int mWindowAttachCount; 2503 2504 /** 2505 * The layout parameters associated with this view and used by the parent 2506 * {@link android.view.ViewGroup} to determine how this view should be 2507 * laid out. 2508 * {@hide} 2509 */ 2510 protected ViewGroup.LayoutParams mLayoutParams; 2511 2512 /** 2513 * The view flags hold various views states. 2514 * {@hide} 2515 */ 2516 @ViewDebug.ExportedProperty 2517 int mViewFlags; 2518 2519 static class TransformationInfo { 2520 /** 2521 * The transform matrix for the View. This transform is calculated internally 2522 * based on the rotation, scaleX, and scaleY properties. The identity matrix 2523 * is used by default. Do *not* use this variable directly; instead call 2524 * getMatrix(), which will automatically recalculate the matrix if necessary 2525 * to get the correct matrix based on the latest rotation and scale properties. 2526 */ 2527 private final Matrix mMatrix = new Matrix(); 2528 2529 /** 2530 * The transform matrix for the View. This transform is calculated internally 2531 * based on the rotation, scaleX, and scaleY properties. The identity matrix 2532 * is used by default. Do *not* use this variable directly; instead call 2533 * getInverseMatrix(), which will automatically recalculate the matrix if necessary 2534 * to get the correct matrix based on the latest rotation and scale properties. 2535 */ 2536 private Matrix mInverseMatrix; 2537 2538 /** 2539 * An internal variable that tracks whether we need to recalculate the 2540 * transform matrix, based on whether the rotation or scaleX/Y properties 2541 * have changed since the matrix was last calculated. 2542 */ 2543 boolean mMatrixDirty = false; 2544 2545 /** 2546 * An internal variable that tracks whether we need to recalculate the 2547 * transform matrix, based on whether the rotation or scaleX/Y properties 2548 * have changed since the matrix was last calculated. 2549 */ 2550 private boolean mInverseMatrixDirty = true; 2551 2552 /** 2553 * A variable that tracks whether we need to recalculate the 2554 * transform matrix, based on whether the rotation or scaleX/Y properties 2555 * have changed since the matrix was last calculated. This variable 2556 * is only valid after a call to updateMatrix() or to a function that 2557 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix(). 2558 */ 2559 private boolean mMatrixIsIdentity = true; 2560 2561 /** 2562 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set. 2563 */ 2564 private Camera mCamera = null; 2565 2566 /** 2567 * This matrix is used when computing the matrix for 3D rotations. 2568 */ 2569 private Matrix matrix3D = null; 2570 2571 /** 2572 * These prev values are used to recalculate a centered pivot point when necessary. The 2573 * pivot point is only used in matrix operations (when rotation, scale, or translation are 2574 * set), so thes values are only used then as well. 2575 */ 2576 private int mPrevWidth = -1; 2577 private int mPrevHeight = -1; 2578 2579 /** 2580 * The degrees rotation around the vertical axis through the pivot point. 2581 */ 2582 @ViewDebug.ExportedProperty 2583 float mRotationY = 0f; 2584 2585 /** 2586 * The degrees rotation around the horizontal axis through the pivot point. 2587 */ 2588 @ViewDebug.ExportedProperty 2589 float mRotationX = 0f; 2590 2591 /** 2592 * The degrees rotation around the pivot point. 2593 */ 2594 @ViewDebug.ExportedProperty 2595 float mRotation = 0f; 2596 2597 /** 2598 * The amount of translation of the object away from its left property (post-layout). 2599 */ 2600 @ViewDebug.ExportedProperty 2601 float mTranslationX = 0f; 2602 2603 /** 2604 * The amount of translation of the object away from its top property (post-layout). 2605 */ 2606 @ViewDebug.ExportedProperty 2607 float mTranslationY = 0f; 2608 2609 /** 2610 * The amount of scale in the x direction around the pivot point. A 2611 * value of 1 means no scaling is applied. 2612 */ 2613 @ViewDebug.ExportedProperty 2614 float mScaleX = 1f; 2615 2616 /** 2617 * The amount of scale in the y direction around the pivot point. A 2618 * value of 1 means no scaling is applied. 2619 */ 2620 @ViewDebug.ExportedProperty 2621 float mScaleY = 1f; 2622 2623 /** 2624 * The x location of the point around which the view is rotated and scaled. 2625 */ 2626 @ViewDebug.ExportedProperty 2627 float mPivotX = 0f; 2628 2629 /** 2630 * The y location of the point around which the view is rotated and scaled. 2631 */ 2632 @ViewDebug.ExportedProperty 2633 float mPivotY = 0f; 2634 2635 /** 2636 * The opacity of the View. This is a value from 0 to 1, where 0 means 2637 * completely transparent and 1 means completely opaque. 2638 */ 2639 @ViewDebug.ExportedProperty 2640 float mAlpha = 1f; 2641 } 2642 2643 TransformationInfo mTransformationInfo; 2644 2645 private boolean mLastIsOpaque; 2646 2647 /** 2648 * Convenience value to check for float values that are close enough to zero to be considered 2649 * zero. 2650 */ 2651 private static final float NONZERO_EPSILON = .001f; 2652 2653 /** 2654 * The distance in pixels from the left edge of this view's parent 2655 * to the left edge of this view. 2656 * {@hide} 2657 */ 2658 @ViewDebug.ExportedProperty(category = "layout") 2659 protected int mLeft; 2660 /** 2661 * The distance in pixels from the left edge of this view's parent 2662 * to the right edge of this view. 2663 * {@hide} 2664 */ 2665 @ViewDebug.ExportedProperty(category = "layout") 2666 protected int mRight; 2667 /** 2668 * The distance in pixels from the top edge of this view's parent 2669 * to the top edge of this view. 2670 * {@hide} 2671 */ 2672 @ViewDebug.ExportedProperty(category = "layout") 2673 protected int mTop; 2674 /** 2675 * The distance in pixels from the top edge of this view's parent 2676 * to the bottom edge of this view. 2677 * {@hide} 2678 */ 2679 @ViewDebug.ExportedProperty(category = "layout") 2680 protected int mBottom; 2681 2682 /** 2683 * The offset, in pixels, by which the content of this view is scrolled 2684 * horizontally. 2685 * {@hide} 2686 */ 2687 @ViewDebug.ExportedProperty(category = "scrolling") 2688 protected int mScrollX; 2689 /** 2690 * The offset, in pixels, by which the content of this view is scrolled 2691 * vertically. 2692 * {@hide} 2693 */ 2694 @ViewDebug.ExportedProperty(category = "scrolling") 2695 protected int mScrollY; 2696 2697 /** 2698 * The left padding in pixels, that is the distance in pixels between the 2699 * left edge of this view and the left edge of its content. 2700 * {@hide} 2701 */ 2702 @ViewDebug.ExportedProperty(category = "padding") 2703 protected int mPaddingLeft; 2704 /** 2705 * The right padding in pixels, that is the distance in pixels between the 2706 * right edge of this view and the right edge of its content. 2707 * {@hide} 2708 */ 2709 @ViewDebug.ExportedProperty(category = "padding") 2710 protected int mPaddingRight; 2711 /** 2712 * The top padding in pixels, that is the distance in pixels between the 2713 * top edge of this view and the top edge of its content. 2714 * {@hide} 2715 */ 2716 @ViewDebug.ExportedProperty(category = "padding") 2717 protected int mPaddingTop; 2718 /** 2719 * The bottom padding in pixels, that is the distance in pixels between the 2720 * bottom edge of this view and the bottom edge of its content. 2721 * {@hide} 2722 */ 2723 @ViewDebug.ExportedProperty(category = "padding") 2724 protected int mPaddingBottom; 2725 2726 /** 2727 * The layout insets in pixels, that is the distance in pixels between the 2728 * visible edges of this view its bounds. 2729 */ 2730 private Insets mLayoutInsets; 2731 2732 /** 2733 * Briefly describes the view and is primarily used for accessibility support. 2734 */ 2735 private CharSequence mContentDescription; 2736 2737 /** 2738 * Cache the paddingRight set by the user to append to the scrollbar's size. 2739 * 2740 * @hide 2741 */ 2742 @ViewDebug.ExportedProperty(category = "padding") 2743 protected int mUserPaddingRight; 2744 2745 /** 2746 * Cache the paddingBottom set by the user to append to the scrollbar's size. 2747 * 2748 * @hide 2749 */ 2750 @ViewDebug.ExportedProperty(category = "padding") 2751 protected int mUserPaddingBottom; 2752 2753 /** 2754 * Cache the paddingLeft set by the user to append to the scrollbar's size. 2755 * 2756 * @hide 2757 */ 2758 @ViewDebug.ExportedProperty(category = "padding") 2759 protected int mUserPaddingLeft; 2760 2761 /** 2762 * Cache if the user padding is relative. 2763 * 2764 */ 2765 @ViewDebug.ExportedProperty(category = "padding") 2766 boolean mUserPaddingRelative; 2767 2768 /** 2769 * Cache the paddingStart set by the user to append to the scrollbar's size. 2770 * 2771 */ 2772 @ViewDebug.ExportedProperty(category = "padding") 2773 int mUserPaddingStart; 2774 2775 /** 2776 * Cache the paddingEnd set by the user to append to the scrollbar's size. 2777 * 2778 */ 2779 @ViewDebug.ExportedProperty(category = "padding") 2780 int mUserPaddingEnd; 2781 2782 /** 2783 * @hide 2784 */ 2785 int mOldWidthMeasureSpec = Integer.MIN_VALUE; 2786 /** 2787 * @hide 2788 */ 2789 int mOldHeightMeasureSpec = Integer.MIN_VALUE; 2790 2791 private Drawable mBackground; 2792 2793 private int mBackgroundResource; 2794 private boolean mBackgroundSizeChanged; 2795 2796 static class ListenerInfo { 2797 /** 2798 * Listener used to dispatch focus change events. 2799 * This field should be made private, so it is hidden from the SDK. 2800 * {@hide} 2801 */ 2802 protected OnFocusChangeListener mOnFocusChangeListener; 2803 2804 /** 2805 * Listeners for layout change events. 2806 */ 2807 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners; 2808 2809 /** 2810 * Listeners for attach events. 2811 */ 2812 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners; 2813 2814 /** 2815 * Listener used to dispatch click events. 2816 * This field should be made private, so it is hidden from the SDK. 2817 * {@hide} 2818 */ 2819 public OnClickListener mOnClickListener; 2820 2821 /** 2822 * Listener used to dispatch long click events. 2823 * This field should be made private, so it is hidden from the SDK. 2824 * {@hide} 2825 */ 2826 protected OnLongClickListener mOnLongClickListener; 2827 2828 /** 2829 * Listener used to build the context menu. 2830 * This field should be made private, so it is hidden from the SDK. 2831 * {@hide} 2832 */ 2833 protected OnCreateContextMenuListener mOnCreateContextMenuListener; 2834 2835 private OnKeyListener mOnKeyListener; 2836 2837 private OnTouchListener mOnTouchListener; 2838 2839 private OnHoverListener mOnHoverListener; 2840 2841 private OnGenericMotionListener mOnGenericMotionListener; 2842 2843 private OnDragListener mOnDragListener; 2844 2845 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener; 2846 } 2847 2848 ListenerInfo mListenerInfo; 2849 2850 /** 2851 * The application environment this view lives in. 2852 * This field should be made private, so it is hidden from the SDK. 2853 * {@hide} 2854 */ 2855 protected Context mContext; 2856 2857 private final Resources mResources; 2858 2859 private ScrollabilityCache mScrollCache; 2860 2861 private int[] mDrawableState = null; 2862 2863 /** 2864 * Set to true when drawing cache is enabled and cannot be created. 2865 * 2866 * @hide 2867 */ 2868 public boolean mCachingFailed; 2869 2870 private Bitmap mDrawingCache; 2871 private Bitmap mUnscaledDrawingCache; 2872 private HardwareLayer mHardwareLayer; 2873 DisplayList mDisplayList; 2874 2875 /** 2876 * When this view has focus and the next focus is {@link #FOCUS_LEFT}, 2877 * the user may specify which view to go to next. 2878 */ 2879 private int mNextFocusLeftId = View.NO_ID; 2880 2881 /** 2882 * When this view has focus and the next focus is {@link #FOCUS_RIGHT}, 2883 * the user may specify which view to go to next. 2884 */ 2885 private int mNextFocusRightId = View.NO_ID; 2886 2887 /** 2888 * When this view has focus and the next focus is {@link #FOCUS_UP}, 2889 * the user may specify which view to go to next. 2890 */ 2891 private int mNextFocusUpId = View.NO_ID; 2892 2893 /** 2894 * When this view has focus and the next focus is {@link #FOCUS_DOWN}, 2895 * the user may specify which view to go to next. 2896 */ 2897 private int mNextFocusDownId = View.NO_ID; 2898 2899 /** 2900 * When this view has focus and the next focus is {@link #FOCUS_FORWARD}, 2901 * the user may specify which view to go to next. 2902 */ 2903 int mNextFocusForwardId = View.NO_ID; 2904 2905 private CheckForLongPress mPendingCheckForLongPress; 2906 private CheckForTap mPendingCheckForTap = null; 2907 private PerformClick mPerformClick; 2908 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent; 2909 2910 private UnsetPressedState mUnsetPressedState; 2911 2912 /** 2913 * Whether the long press's action has been invoked. The tap's action is invoked on the 2914 * up event while a long press is invoked as soon as the long press duration is reached, so 2915 * a long press could be performed before the tap is checked, in which case the tap's action 2916 * should not be invoked. 2917 */ 2918 private boolean mHasPerformedLongPress; 2919 2920 /** 2921 * The minimum height of the view. We'll try our best to have the height 2922 * of this view to at least this amount. 2923 */ 2924 @ViewDebug.ExportedProperty(category = "measurement") 2925 private int mMinHeight; 2926 2927 /** 2928 * The minimum width of the view. We'll try our best to have the width 2929 * of this view to at least this amount. 2930 */ 2931 @ViewDebug.ExportedProperty(category = "measurement") 2932 private int mMinWidth; 2933 2934 /** 2935 * The delegate to handle touch events that are physically in this view 2936 * but should be handled by another view. 2937 */ 2938 private TouchDelegate mTouchDelegate = null; 2939 2940 /** 2941 * Solid color to use as a background when creating the drawing cache. Enables 2942 * the cache to use 16 bit bitmaps instead of 32 bit. 2943 */ 2944 private int mDrawingCacheBackgroundColor = 0; 2945 2946 /** 2947 * Special tree observer used when mAttachInfo is null. 2948 */ 2949 private ViewTreeObserver mFloatingTreeObserver; 2950 2951 /** 2952 * Cache the touch slop from the context that created the view. 2953 */ 2954 private int mTouchSlop; 2955 2956 /** 2957 * Object that handles automatic animation of view properties. 2958 */ 2959 private ViewPropertyAnimator mAnimator = null; 2960 2961 /** 2962 * Flag indicating that a drag can cross window boundaries. When 2963 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called 2964 * with this flag set, all visible applications will be able to participate 2965 * in the drag operation and receive the dragged content. 2966 * 2967 * @hide 2968 */ 2969 public static final int DRAG_FLAG_GLOBAL = 1; 2970 2971 /** 2972 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}. 2973 */ 2974 private float mVerticalScrollFactor; 2975 2976 /** 2977 * Position of the vertical scroll bar. 2978 */ 2979 private int mVerticalScrollbarPosition; 2980 2981 /** 2982 * Position the scroll bar at the default position as determined by the system. 2983 */ 2984 public static final int SCROLLBAR_POSITION_DEFAULT = 0; 2985 2986 /** 2987 * Position the scroll bar along the left edge. 2988 */ 2989 public static final int SCROLLBAR_POSITION_LEFT = 1; 2990 2991 /** 2992 * Position the scroll bar along the right edge. 2993 */ 2994 public static final int SCROLLBAR_POSITION_RIGHT = 2; 2995 2996 /** 2997 * Indicates that the view does not have a layer. 2998 * 2999 * @see #getLayerType() 3000 * @see #setLayerType(int, android.graphics.Paint) 3001 * @see #LAYER_TYPE_SOFTWARE 3002 * @see #LAYER_TYPE_HARDWARE 3003 */ 3004 public static final int LAYER_TYPE_NONE = 0; 3005 3006 /** 3007 * <p>Indicates that the view has a software layer. A software layer is backed 3008 * by a bitmap and causes the view to be rendered using Android's software 3009 * rendering pipeline, even if hardware acceleration is enabled.</p> 3010 * 3011 * <p>Software layers have various usages:</p> 3012 * <p>When the application is not using hardware acceleration, a software layer 3013 * is useful to apply a specific color filter and/or blending mode and/or 3014 * translucency to a view and all its children.</p> 3015 * <p>When the application is using hardware acceleration, a software layer 3016 * is useful to render drawing primitives not supported by the hardware 3017 * accelerated pipeline. It can also be used to cache a complex view tree 3018 * into a texture and reduce the complexity of drawing operations. For instance, 3019 * when animating a complex view tree with a translation, a software layer can 3020 * be used to render the view tree only once.</p> 3021 * <p>Software layers should be avoided when the affected view tree updates 3022 * often. Every update will require to re-render the software layer, which can 3023 * potentially be slow (particularly when hardware acceleration is turned on 3024 * since the layer will have to be uploaded into a hardware texture after every 3025 * update.)</p> 3026 * 3027 * @see #getLayerType() 3028 * @see #setLayerType(int, android.graphics.Paint) 3029 * @see #LAYER_TYPE_NONE 3030 * @see #LAYER_TYPE_HARDWARE 3031 */ 3032 public static final int LAYER_TYPE_SOFTWARE = 1; 3033 3034 /** 3035 * <p>Indicates that the view has a hardware layer. A hardware layer is backed 3036 * by a hardware specific texture (generally Frame Buffer Objects or FBO on 3037 * OpenGL hardware) and causes the view to be rendered using Android's hardware 3038 * rendering pipeline, but only if hardware acceleration is turned on for the 3039 * view hierarchy. When hardware acceleration is turned off, hardware layers 3040 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p> 3041 * 3042 * <p>A hardware layer is useful to apply a specific color filter and/or 3043 * blending mode and/or translucency to a view and all its children.</p> 3044 * <p>A hardware layer can be used to cache a complex view tree into a 3045 * texture and reduce the complexity of drawing operations. For instance, 3046 * when animating a complex view tree with a translation, a hardware layer can 3047 * be used to render the view tree only once.</p> 3048 * <p>A hardware layer can also be used to increase the rendering quality when 3049 * rotation transformations are applied on a view. It can also be used to 3050 * prevent potential clipping issues when applying 3D transforms on a view.</p> 3051 * 3052 * @see #getLayerType() 3053 * @see #setLayerType(int, android.graphics.Paint) 3054 * @see #LAYER_TYPE_NONE 3055 * @see #LAYER_TYPE_SOFTWARE 3056 */ 3057 public static final int LAYER_TYPE_HARDWARE = 2; 3058 3059 @ViewDebug.ExportedProperty(category = "drawing", mapping = { 3060 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"), 3061 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"), 3062 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE") 3063 }) 3064 int mLayerType = LAYER_TYPE_NONE; 3065 Paint mLayerPaint; 3066 Rect mLocalDirtyRect; 3067 3068 /** 3069 * Set to true when the view is sending hover accessibility events because it 3070 * is the innermost hovered view. 3071 */ 3072 private boolean mSendingHoverAccessibilityEvents; 3073 3074 /** 3075 * Simple constructor to use when creating a view from code. 3076 * 3077 * @param context The Context the view is running in, through which it can 3078 * access the current theme, resources, etc. 3079 */ 3080 public View(Context context) { 3081 mContext = context; 3082 mResources = context != null ? context.getResources() : null; 3083 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED; 3084 // Set layout and text direction defaults 3085 mPrivateFlags2 = (LAYOUT_DIRECTION_DEFAULT << LAYOUT_DIRECTION_MASK_SHIFT) | 3086 (TEXT_DIRECTION_DEFAULT << TEXT_DIRECTION_MASK_SHIFT) | 3087 (TEXT_ALIGNMENT_DEFAULT << TEXT_ALIGNMENT_MASK_SHIFT) | 3088 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << IMPORTANT_FOR_ACCESSIBILITY_SHIFT); 3089 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop(); 3090 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS); 3091 mUserPaddingStart = -1; 3092 mUserPaddingEnd = -1; 3093 mUserPaddingRelative = false; 3094 } 3095 3096 /** 3097 * Delegate for injecting accessiblity functionality. 3098 */ 3099 AccessibilityDelegate mAccessibilityDelegate; 3100 3101 /** 3102 * Consistency verifier for debugging purposes. 3103 * @hide 3104 */ 3105 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier = 3106 InputEventConsistencyVerifier.isInstrumentationEnabled() ? 3107 new InputEventConsistencyVerifier(this, 0) : null; 3108 3109 /** 3110 * Constructor that is called when inflating a view from XML. This is called 3111 * when a view is being constructed from an XML file, supplying attributes 3112 * that were specified in the XML file. This version uses a default style of 3113 * 0, so the only attribute values applied are those in the Context's Theme 3114 * and the given AttributeSet. 3115 * 3116 * <p> 3117 * The method onFinishInflate() will be called after all children have been 3118 * added. 3119 * 3120 * @param context The Context the view is running in, through which it can 3121 * access the current theme, resources, etc. 3122 * @param attrs The attributes of the XML tag that is inflating the view. 3123 * @see #View(Context, AttributeSet, int) 3124 */ 3125 public View(Context context, AttributeSet attrs) { 3126 this(context, attrs, 0); 3127 } 3128 3129 /** 3130 * Perform inflation from XML and apply a class-specific base style. This 3131 * constructor of View allows subclasses to use their own base style when 3132 * they are inflating. For example, a Button class's constructor would call 3133 * this version of the super class constructor and supply 3134 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows 3135 * the theme's button style to modify all of the base view attributes (in 3136 * particular its background) as well as the Button class's attributes. 3137 * 3138 * @param context The Context the view is running in, through which it can 3139 * access the current theme, resources, etc. 3140 * @param attrs The attributes of the XML tag that is inflating the view. 3141 * @param defStyle The default style to apply to this view. If 0, no style 3142 * will be applied (beyond what is included in the theme). This may 3143 * either be an attribute resource, whose value will be retrieved 3144 * from the current theme, or an explicit style resource. 3145 * @see #View(Context, AttributeSet) 3146 */ 3147 public View(Context context, AttributeSet attrs, int defStyle) { 3148 this(context); 3149 3150 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View, 3151 defStyle, 0); 3152 3153 Drawable background = null; 3154 3155 int leftPadding = -1; 3156 int topPadding = -1; 3157 int rightPadding = -1; 3158 int bottomPadding = -1; 3159 int startPadding = -1; 3160 int endPadding = -1; 3161 3162 int padding = -1; 3163 3164 int viewFlagValues = 0; 3165 int viewFlagMasks = 0; 3166 3167 boolean setScrollContainer = false; 3168 3169 int x = 0; 3170 int y = 0; 3171 3172 float tx = 0; 3173 float ty = 0; 3174 float rotation = 0; 3175 float rotationX = 0; 3176 float rotationY = 0; 3177 float sx = 1f; 3178 float sy = 1f; 3179 boolean transformSet = false; 3180 3181 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY; 3182 3183 int overScrollMode = mOverScrollMode; 3184 final int N = a.getIndexCount(); 3185 for (int i = 0; i < N; i++) { 3186 int attr = a.getIndex(i); 3187 switch (attr) { 3188 case com.android.internal.R.styleable.View_background: 3189 background = a.getDrawable(attr); 3190 break; 3191 case com.android.internal.R.styleable.View_padding: 3192 padding = a.getDimensionPixelSize(attr, -1); 3193 break; 3194 case com.android.internal.R.styleable.View_paddingLeft: 3195 leftPadding = a.getDimensionPixelSize(attr, -1); 3196 break; 3197 case com.android.internal.R.styleable.View_paddingTop: 3198 topPadding = a.getDimensionPixelSize(attr, -1); 3199 break; 3200 case com.android.internal.R.styleable.View_paddingRight: 3201 rightPadding = a.getDimensionPixelSize(attr, -1); 3202 break; 3203 case com.android.internal.R.styleable.View_paddingBottom: 3204 bottomPadding = a.getDimensionPixelSize(attr, -1); 3205 break; 3206 case com.android.internal.R.styleable.View_paddingStart: 3207 startPadding = a.getDimensionPixelSize(attr, -1); 3208 break; 3209 case com.android.internal.R.styleable.View_paddingEnd: 3210 endPadding = a.getDimensionPixelSize(attr, -1); 3211 break; 3212 case com.android.internal.R.styleable.View_scrollX: 3213 x = a.getDimensionPixelOffset(attr, 0); 3214 break; 3215 case com.android.internal.R.styleable.View_scrollY: 3216 y = a.getDimensionPixelOffset(attr, 0); 3217 break; 3218 case com.android.internal.R.styleable.View_alpha: 3219 setAlpha(a.getFloat(attr, 1f)); 3220 break; 3221 case com.android.internal.R.styleable.View_transformPivotX: 3222 setPivotX(a.getDimensionPixelOffset(attr, 0)); 3223 break; 3224 case com.android.internal.R.styleable.View_transformPivotY: 3225 setPivotY(a.getDimensionPixelOffset(attr, 0)); 3226 break; 3227 case com.android.internal.R.styleable.View_translationX: 3228 tx = a.getDimensionPixelOffset(attr, 0); 3229 transformSet = true; 3230 break; 3231 case com.android.internal.R.styleable.View_translationY: 3232 ty = a.getDimensionPixelOffset(attr, 0); 3233 transformSet = true; 3234 break; 3235 case com.android.internal.R.styleable.View_rotation: 3236 rotation = a.getFloat(attr, 0); 3237 transformSet = true; 3238 break; 3239 case com.android.internal.R.styleable.View_rotationX: 3240 rotationX = a.getFloat(attr, 0); 3241 transformSet = true; 3242 break; 3243 case com.android.internal.R.styleable.View_rotationY: 3244 rotationY = a.getFloat(attr, 0); 3245 transformSet = true; 3246 break; 3247 case com.android.internal.R.styleable.View_scaleX: 3248 sx = a.getFloat(attr, 1f); 3249 transformSet = true; 3250 break; 3251 case com.android.internal.R.styleable.View_scaleY: 3252 sy = a.getFloat(attr, 1f); 3253 transformSet = true; 3254 break; 3255 case com.android.internal.R.styleable.View_id: 3256 mID = a.getResourceId(attr, NO_ID); 3257 break; 3258 case com.android.internal.R.styleable.View_tag: 3259 mTag = a.getText(attr); 3260 break; 3261 case com.android.internal.R.styleable.View_fitsSystemWindows: 3262 if (a.getBoolean(attr, false)) { 3263 viewFlagValues |= FITS_SYSTEM_WINDOWS; 3264 viewFlagMasks |= FITS_SYSTEM_WINDOWS; 3265 } 3266 break; 3267 case com.android.internal.R.styleable.View_focusable: 3268 if (a.getBoolean(attr, false)) { 3269 viewFlagValues |= FOCUSABLE; 3270 viewFlagMasks |= FOCUSABLE_MASK; 3271 } 3272 break; 3273 case com.android.internal.R.styleable.View_focusableInTouchMode: 3274 if (a.getBoolean(attr, false)) { 3275 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE; 3276 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK; 3277 } 3278 break; 3279 case com.android.internal.R.styleable.View_clickable: 3280 if (a.getBoolean(attr, false)) { 3281 viewFlagValues |= CLICKABLE; 3282 viewFlagMasks |= CLICKABLE; 3283 } 3284 break; 3285 case com.android.internal.R.styleable.View_longClickable: 3286 if (a.getBoolean(attr, false)) { 3287 viewFlagValues |= LONG_CLICKABLE; 3288 viewFlagMasks |= LONG_CLICKABLE; 3289 } 3290 break; 3291 case com.android.internal.R.styleable.View_saveEnabled: 3292 if (!a.getBoolean(attr, true)) { 3293 viewFlagValues |= SAVE_DISABLED; 3294 viewFlagMasks |= SAVE_DISABLED_MASK; 3295 } 3296 break; 3297 case com.android.internal.R.styleable.View_duplicateParentState: 3298 if (a.getBoolean(attr, false)) { 3299 viewFlagValues |= DUPLICATE_PARENT_STATE; 3300 viewFlagMasks |= DUPLICATE_PARENT_STATE; 3301 } 3302 break; 3303 case com.android.internal.R.styleable.View_visibility: 3304 final int visibility = a.getInt(attr, 0); 3305 if (visibility != 0) { 3306 viewFlagValues |= VISIBILITY_FLAGS[visibility]; 3307 viewFlagMasks |= VISIBILITY_MASK; 3308 } 3309 break; 3310 case com.android.internal.R.styleable.View_layoutDirection: 3311 // Clear any layout direction flags (included resolved bits) already set 3312 mPrivateFlags2 &= ~(LAYOUT_DIRECTION_MASK | LAYOUT_DIRECTION_RESOLVED_MASK); 3313 // Set the layout direction flags depending on the value of the attribute 3314 final int layoutDirection = a.getInt(attr, -1); 3315 final int value = (layoutDirection != -1) ? 3316 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT; 3317 mPrivateFlags2 |= (value << LAYOUT_DIRECTION_MASK_SHIFT); 3318 break; 3319 case com.android.internal.R.styleable.View_drawingCacheQuality: 3320 final int cacheQuality = a.getInt(attr, 0); 3321 if (cacheQuality != 0) { 3322 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality]; 3323 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK; 3324 } 3325 break; 3326 case com.android.internal.R.styleable.View_contentDescription: 3327 mContentDescription = a.getString(attr); 3328 break; 3329 case com.android.internal.R.styleable.View_soundEffectsEnabled: 3330 if (!a.getBoolean(attr, true)) { 3331 viewFlagValues &= ~SOUND_EFFECTS_ENABLED; 3332 viewFlagMasks |= SOUND_EFFECTS_ENABLED; 3333 } 3334 break; 3335 case com.android.internal.R.styleable.View_hapticFeedbackEnabled: 3336 if (!a.getBoolean(attr, true)) { 3337 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED; 3338 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED; 3339 } 3340 break; 3341 case R.styleable.View_scrollbars: 3342 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE); 3343 if (scrollbars != SCROLLBARS_NONE) { 3344 viewFlagValues |= scrollbars; 3345 viewFlagMasks |= SCROLLBARS_MASK; 3346 initializeScrollbars(a); 3347 } 3348 break; 3349 //noinspection deprecation 3350 case R.styleable.View_fadingEdge: 3351 if (context.getApplicationInfo().targetSdkVersion >= ICE_CREAM_SANDWICH) { 3352 // Ignore the attribute starting with ICS 3353 break; 3354 } 3355 // With builds < ICS, fall through and apply fading edges 3356 case R.styleable.View_requiresFadingEdge: 3357 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE); 3358 if (fadingEdge != FADING_EDGE_NONE) { 3359 viewFlagValues |= fadingEdge; 3360 viewFlagMasks |= FADING_EDGE_MASK; 3361 initializeFadingEdge(a); 3362 } 3363 break; 3364 case R.styleable.View_scrollbarStyle: 3365 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY); 3366 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 3367 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK; 3368 viewFlagMasks |= SCROLLBARS_STYLE_MASK; 3369 } 3370 break; 3371 case R.styleable.View_isScrollContainer: 3372 setScrollContainer = true; 3373 if (a.getBoolean(attr, false)) { 3374 setScrollContainer(true); 3375 } 3376 break; 3377 case com.android.internal.R.styleable.View_keepScreenOn: 3378 if (a.getBoolean(attr, false)) { 3379 viewFlagValues |= KEEP_SCREEN_ON; 3380 viewFlagMasks |= KEEP_SCREEN_ON; 3381 } 3382 break; 3383 case R.styleable.View_filterTouchesWhenObscured: 3384 if (a.getBoolean(attr, false)) { 3385 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED; 3386 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED; 3387 } 3388 break; 3389 case R.styleable.View_nextFocusLeft: 3390 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID); 3391 break; 3392 case R.styleable.View_nextFocusRight: 3393 mNextFocusRightId = a.getResourceId(attr, View.NO_ID); 3394 break; 3395 case R.styleable.View_nextFocusUp: 3396 mNextFocusUpId = a.getResourceId(attr, View.NO_ID); 3397 break; 3398 case R.styleable.View_nextFocusDown: 3399 mNextFocusDownId = a.getResourceId(attr, View.NO_ID); 3400 break; 3401 case R.styleable.View_nextFocusForward: 3402 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID); 3403 break; 3404 case R.styleable.View_minWidth: 3405 mMinWidth = a.getDimensionPixelSize(attr, 0); 3406 break; 3407 case R.styleable.View_minHeight: 3408 mMinHeight = a.getDimensionPixelSize(attr, 0); 3409 break; 3410 case R.styleable.View_onClick: 3411 if (context.isRestricted()) { 3412 throw new IllegalStateException("The android:onClick attribute cannot " 3413 + "be used within a restricted context"); 3414 } 3415 3416 final String handlerName = a.getString(attr); 3417 if (handlerName != null) { 3418 setOnClickListener(new OnClickListener() { 3419 private Method mHandler; 3420 3421 public void onClick(View v) { 3422 if (mHandler == null) { 3423 try { 3424 mHandler = getContext().getClass().getMethod(handlerName, 3425 View.class); 3426 } catch (NoSuchMethodException e) { 3427 int id = getId(); 3428 String idText = id == NO_ID ? "" : " with id '" 3429 + getContext().getResources().getResourceEntryName( 3430 id) + "'"; 3431 throw new IllegalStateException("Could not find a method " + 3432 handlerName + "(View) in the activity " 3433 + getContext().getClass() + " for onClick handler" 3434 + " on view " + View.this.getClass() + idText, e); 3435 } 3436 } 3437 3438 try { 3439 mHandler.invoke(getContext(), View.this); 3440 } catch (IllegalAccessException e) { 3441 throw new IllegalStateException("Could not execute non " 3442 + "public method of the activity", e); 3443 } catch (InvocationTargetException e) { 3444 throw new IllegalStateException("Could not execute " 3445 + "method of the activity", e); 3446 } 3447 } 3448 }); 3449 } 3450 break; 3451 case R.styleable.View_overScrollMode: 3452 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS); 3453 break; 3454 case R.styleable.View_verticalScrollbarPosition: 3455 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT); 3456 break; 3457 case R.styleable.View_layerType: 3458 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null); 3459 break; 3460 case R.styleable.View_textDirection: 3461 // Clear any text direction flag already set 3462 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK; 3463 // Set the text direction flags depending on the value of the attribute 3464 final int textDirection = a.getInt(attr, -1); 3465 if (textDirection != -1) { 3466 mPrivateFlags2 |= TEXT_DIRECTION_FLAGS[textDirection]; 3467 } 3468 break; 3469 case R.styleable.View_textAlignment: 3470 // Clear any text alignment flag already set 3471 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK; 3472 // Set the text alignment flag depending on the value of the attribute 3473 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT); 3474 mPrivateFlags2 |= TEXT_ALIGNMENT_FLAGS[textAlignment]; 3475 break; 3476 case R.styleable.View_importantForAccessibility: 3477 setImportantForAccessibility(a.getInt(attr, 3478 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT)); 3479 } 3480 } 3481 3482 a.recycle(); 3483 3484 setOverScrollMode(overScrollMode); 3485 3486 if (background != null) { 3487 setBackground(background); 3488 } 3489 3490 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved 3491 // layout direction). Those cached values will be used later during padding resolution. 3492 mUserPaddingStart = startPadding; 3493 mUserPaddingEnd = endPadding; 3494 3495 updateUserPaddingRelative(); 3496 3497 if (padding >= 0) { 3498 leftPadding = padding; 3499 topPadding = padding; 3500 rightPadding = padding; 3501 bottomPadding = padding; 3502 } 3503 3504 // If the user specified the padding (either with android:padding or 3505 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise 3506 // use the default padding or the padding from the background drawable 3507 // (stored at this point in mPadding*) 3508 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft, 3509 topPadding >= 0 ? topPadding : mPaddingTop, 3510 rightPadding >= 0 ? rightPadding : mPaddingRight, 3511 bottomPadding >= 0 ? bottomPadding : mPaddingBottom); 3512 3513 if (viewFlagMasks != 0) { 3514 setFlags(viewFlagValues, viewFlagMasks); 3515 } 3516 3517 // Needs to be called after mViewFlags is set 3518 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 3519 recomputePadding(); 3520 } 3521 3522 if (x != 0 || y != 0) { 3523 scrollTo(x, y); 3524 } 3525 3526 if (transformSet) { 3527 setTranslationX(tx); 3528 setTranslationY(ty); 3529 setRotation(rotation); 3530 setRotationX(rotationX); 3531 setRotationY(rotationY); 3532 setScaleX(sx); 3533 setScaleY(sy); 3534 } 3535 3536 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) { 3537 setScrollContainer(true); 3538 } 3539 3540 computeOpaqueFlags(); 3541 } 3542 3543 private void updateUserPaddingRelative() { 3544 mUserPaddingRelative = (mUserPaddingStart >= 0 || mUserPaddingEnd >= 0); 3545 } 3546 3547 /** 3548 * Non-public constructor for use in testing 3549 */ 3550 View() { 3551 mResources = null; 3552 } 3553 3554 /** 3555 * <p> 3556 * Initializes the fading edges from a given set of styled attributes. This 3557 * method should be called by subclasses that need fading edges and when an 3558 * instance of these subclasses is created programmatically rather than 3559 * being inflated from XML. This method is automatically called when the XML 3560 * is inflated. 3561 * </p> 3562 * 3563 * @param a the styled attributes set to initialize the fading edges from 3564 */ 3565 protected void initializeFadingEdge(TypedArray a) { 3566 initScrollCache(); 3567 3568 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize( 3569 R.styleable.View_fadingEdgeLength, 3570 ViewConfiguration.get(mContext).getScaledFadingEdgeLength()); 3571 } 3572 3573 /** 3574 * Returns the size of the vertical faded edges used to indicate that more 3575 * content in this view is visible. 3576 * 3577 * @return The size in pixels of the vertical faded edge or 0 if vertical 3578 * faded edges are not enabled for this view. 3579 * @attr ref android.R.styleable#View_fadingEdgeLength 3580 */ 3581 public int getVerticalFadingEdgeLength() { 3582 if (isVerticalFadingEdgeEnabled()) { 3583 ScrollabilityCache cache = mScrollCache; 3584 if (cache != null) { 3585 return cache.fadingEdgeLength; 3586 } 3587 } 3588 return 0; 3589 } 3590 3591 /** 3592 * Set the size of the faded edge used to indicate that more content in this 3593 * view is available. Will not change whether the fading edge is enabled; use 3594 * {@link #setVerticalFadingEdgeEnabled(boolean)} or 3595 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge 3596 * for the vertical or horizontal fading edges. 3597 * 3598 * @param length The size in pixels of the faded edge used to indicate that more 3599 * content in this view is visible. 3600 */ 3601 public void setFadingEdgeLength(int length) { 3602 initScrollCache(); 3603 mScrollCache.fadingEdgeLength = length; 3604 } 3605 3606 /** 3607 * Returns the size of the horizontal faded edges used to indicate that more 3608 * content in this view is visible. 3609 * 3610 * @return The size in pixels of the horizontal faded edge or 0 if horizontal 3611 * faded edges are not enabled for this view. 3612 * @attr ref android.R.styleable#View_fadingEdgeLength 3613 */ 3614 public int getHorizontalFadingEdgeLength() { 3615 if (isHorizontalFadingEdgeEnabled()) { 3616 ScrollabilityCache cache = mScrollCache; 3617 if (cache != null) { 3618 return cache.fadingEdgeLength; 3619 } 3620 } 3621 return 0; 3622 } 3623 3624 /** 3625 * Returns the width of the vertical scrollbar. 3626 * 3627 * @return The width in pixels of the vertical scrollbar or 0 if there 3628 * is no vertical scrollbar. 3629 */ 3630 public int getVerticalScrollbarWidth() { 3631 ScrollabilityCache cache = mScrollCache; 3632 if (cache != null) { 3633 ScrollBarDrawable scrollBar = cache.scrollBar; 3634 if (scrollBar != null) { 3635 int size = scrollBar.getSize(true); 3636 if (size <= 0) { 3637 size = cache.scrollBarSize; 3638 } 3639 return size; 3640 } 3641 return 0; 3642 } 3643 return 0; 3644 } 3645 3646 /** 3647 * Returns the height of the horizontal scrollbar. 3648 * 3649 * @return The height in pixels of the horizontal scrollbar or 0 if 3650 * there is no horizontal scrollbar. 3651 */ 3652 protected int getHorizontalScrollbarHeight() { 3653 ScrollabilityCache cache = mScrollCache; 3654 if (cache != null) { 3655 ScrollBarDrawable scrollBar = cache.scrollBar; 3656 if (scrollBar != null) { 3657 int size = scrollBar.getSize(false); 3658 if (size <= 0) { 3659 size = cache.scrollBarSize; 3660 } 3661 return size; 3662 } 3663 return 0; 3664 } 3665 return 0; 3666 } 3667 3668 /** 3669 * <p> 3670 * Initializes the scrollbars from a given set of styled attributes. This 3671 * method should be called by subclasses that need scrollbars and when an 3672 * instance of these subclasses is created programmatically rather than 3673 * being inflated from XML. This method is automatically called when the XML 3674 * is inflated. 3675 * </p> 3676 * 3677 * @param a the styled attributes set to initialize the scrollbars from 3678 */ 3679 protected void initializeScrollbars(TypedArray a) { 3680 initScrollCache(); 3681 3682 final ScrollabilityCache scrollabilityCache = mScrollCache; 3683 3684 if (scrollabilityCache.scrollBar == null) { 3685 scrollabilityCache.scrollBar = new ScrollBarDrawable(); 3686 } 3687 3688 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true); 3689 3690 if (!fadeScrollbars) { 3691 scrollabilityCache.state = ScrollabilityCache.ON; 3692 } 3693 scrollabilityCache.fadeScrollBars = fadeScrollbars; 3694 3695 3696 scrollabilityCache.scrollBarFadeDuration = a.getInt( 3697 R.styleable.View_scrollbarFadeDuration, ViewConfiguration 3698 .getScrollBarFadeDuration()); 3699 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt( 3700 R.styleable.View_scrollbarDefaultDelayBeforeFade, 3701 ViewConfiguration.getScrollDefaultDelay()); 3702 3703 3704 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize( 3705 com.android.internal.R.styleable.View_scrollbarSize, 3706 ViewConfiguration.get(mContext).getScaledScrollBarSize()); 3707 3708 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal); 3709 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track); 3710 3711 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal); 3712 if (thumb != null) { 3713 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb); 3714 } 3715 3716 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack, 3717 false); 3718 if (alwaysDraw) { 3719 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true); 3720 } 3721 3722 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical); 3723 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track); 3724 3725 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical); 3726 if (thumb != null) { 3727 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb); 3728 } 3729 3730 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack, 3731 false); 3732 if (alwaysDraw) { 3733 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true); 3734 } 3735 3736 // Re-apply user/background padding so that scrollbar(s) get added 3737 resolvePadding(); 3738 } 3739 3740 /** 3741 * <p> 3742 * Initalizes the scrollability cache if necessary. 3743 * </p> 3744 */ 3745 private void initScrollCache() { 3746 if (mScrollCache == null) { 3747 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this); 3748 } 3749 } 3750 3751 private ScrollabilityCache getScrollCache() { 3752 initScrollCache(); 3753 return mScrollCache; 3754 } 3755 3756 /** 3757 * Set the position of the vertical scroll bar. Should be one of 3758 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or 3759 * {@link #SCROLLBAR_POSITION_RIGHT}. 3760 * 3761 * @param position Where the vertical scroll bar should be positioned. 3762 */ 3763 public void setVerticalScrollbarPosition(int position) { 3764 if (mVerticalScrollbarPosition != position) { 3765 mVerticalScrollbarPosition = position; 3766 computeOpaqueFlags(); 3767 resolvePadding(); 3768 } 3769 } 3770 3771 /** 3772 * @return The position where the vertical scroll bar will show, if applicable. 3773 * @see #setVerticalScrollbarPosition(int) 3774 */ 3775 public int getVerticalScrollbarPosition() { 3776 return mVerticalScrollbarPosition; 3777 } 3778 3779 ListenerInfo getListenerInfo() { 3780 if (mListenerInfo != null) { 3781 return mListenerInfo; 3782 } 3783 mListenerInfo = new ListenerInfo(); 3784 return mListenerInfo; 3785 } 3786 3787 /** 3788 * Register a callback to be invoked when focus of this view changed. 3789 * 3790 * @param l The callback that will run. 3791 */ 3792 public void setOnFocusChangeListener(OnFocusChangeListener l) { 3793 getListenerInfo().mOnFocusChangeListener = l; 3794 } 3795 3796 /** 3797 * Add a listener that will be called when the bounds of the view change due to 3798 * layout processing. 3799 * 3800 * @param listener The listener that will be called when layout bounds change. 3801 */ 3802 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) { 3803 ListenerInfo li = getListenerInfo(); 3804 if (li.mOnLayoutChangeListeners == null) { 3805 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>(); 3806 } 3807 if (!li.mOnLayoutChangeListeners.contains(listener)) { 3808 li.mOnLayoutChangeListeners.add(listener); 3809 } 3810 } 3811 3812 /** 3813 * Remove a listener for layout changes. 3814 * 3815 * @param listener The listener for layout bounds change. 3816 */ 3817 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) { 3818 ListenerInfo li = mListenerInfo; 3819 if (li == null || li.mOnLayoutChangeListeners == null) { 3820 return; 3821 } 3822 li.mOnLayoutChangeListeners.remove(listener); 3823 } 3824 3825 /** 3826 * Add a listener for attach state changes. 3827 * 3828 * This listener will be called whenever this view is attached or detached 3829 * from a window. Remove the listener using 3830 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}. 3831 * 3832 * @param listener Listener to attach 3833 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener) 3834 */ 3835 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 3836 ListenerInfo li = getListenerInfo(); 3837 if (li.mOnAttachStateChangeListeners == null) { 3838 li.mOnAttachStateChangeListeners 3839 = new CopyOnWriteArrayList<OnAttachStateChangeListener>(); 3840 } 3841 li.mOnAttachStateChangeListeners.add(listener); 3842 } 3843 3844 /** 3845 * Remove a listener for attach state changes. The listener will receive no further 3846 * notification of window attach/detach events. 3847 * 3848 * @param listener Listener to remove 3849 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener) 3850 */ 3851 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 3852 ListenerInfo li = mListenerInfo; 3853 if (li == null || li.mOnAttachStateChangeListeners == null) { 3854 return; 3855 } 3856 li.mOnAttachStateChangeListeners.remove(listener); 3857 } 3858 3859 /** 3860 * Returns the focus-change callback registered for this view. 3861 * 3862 * @return The callback, or null if one is not registered. 3863 */ 3864 public OnFocusChangeListener getOnFocusChangeListener() { 3865 ListenerInfo li = mListenerInfo; 3866 return li != null ? li.mOnFocusChangeListener : null; 3867 } 3868 3869 /** 3870 * Register a callback to be invoked when this view is clicked. If this view is not 3871 * clickable, it becomes clickable. 3872 * 3873 * @param l The callback that will run 3874 * 3875 * @see #setClickable(boolean) 3876 */ 3877 public void setOnClickListener(OnClickListener l) { 3878 if (!isClickable()) { 3879 setClickable(true); 3880 } 3881 getListenerInfo().mOnClickListener = l; 3882 } 3883 3884 /** 3885 * Return whether this view has an attached OnClickListener. Returns 3886 * true if there is a listener, false if there is none. 3887 */ 3888 public boolean hasOnClickListeners() { 3889 ListenerInfo li = mListenerInfo; 3890 return (li != null && li.mOnClickListener != null); 3891 } 3892 3893 /** 3894 * Register a callback to be invoked when this view is clicked and held. If this view is not 3895 * long clickable, it becomes long clickable. 3896 * 3897 * @param l The callback that will run 3898 * 3899 * @see #setLongClickable(boolean) 3900 */ 3901 public void setOnLongClickListener(OnLongClickListener l) { 3902 if (!isLongClickable()) { 3903 setLongClickable(true); 3904 } 3905 getListenerInfo().mOnLongClickListener = l; 3906 } 3907 3908 /** 3909 * Register a callback to be invoked when the context menu for this view is 3910 * being built. If this view is not long clickable, it becomes long clickable. 3911 * 3912 * @param l The callback that will run 3913 * 3914 */ 3915 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) { 3916 if (!isLongClickable()) { 3917 setLongClickable(true); 3918 } 3919 getListenerInfo().mOnCreateContextMenuListener = l; 3920 } 3921 3922 /** 3923 * Call this view's OnClickListener, if it is defined. Performs all normal 3924 * actions associated with clicking: reporting accessibility event, playing 3925 * a sound, etc. 3926 * 3927 * @return True there was an assigned OnClickListener that was called, false 3928 * otherwise is returned. 3929 */ 3930 public boolean performClick() { 3931 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED); 3932 3933 ListenerInfo li = mListenerInfo; 3934 if (li != null && li.mOnClickListener != null) { 3935 playSoundEffect(SoundEffectConstants.CLICK); 3936 li.mOnClickListener.onClick(this); 3937 return true; 3938 } 3939 3940 return false; 3941 } 3942 3943 /** 3944 * Directly call any attached OnClickListener. Unlike {@link #performClick()}, 3945 * this only calls the listener, and does not do any associated clicking 3946 * actions like reporting an accessibility event. 3947 * 3948 * @return True there was an assigned OnClickListener that was called, false 3949 * otherwise is returned. 3950 */ 3951 public boolean callOnClick() { 3952 ListenerInfo li = mListenerInfo; 3953 if (li != null && li.mOnClickListener != null) { 3954 li.mOnClickListener.onClick(this); 3955 return true; 3956 } 3957 return false; 3958 } 3959 3960 /** 3961 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the 3962 * OnLongClickListener did not consume the event. 3963 * 3964 * @return True if one of the above receivers consumed the event, false otherwise. 3965 */ 3966 public boolean performLongClick() { 3967 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED); 3968 3969 boolean handled = false; 3970 ListenerInfo li = mListenerInfo; 3971 if (li != null && li.mOnLongClickListener != null) { 3972 handled = li.mOnLongClickListener.onLongClick(View.this); 3973 } 3974 if (!handled) { 3975 handled = showContextMenu(); 3976 } 3977 if (handled) { 3978 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); 3979 } 3980 return handled; 3981 } 3982 3983 /** 3984 * Performs button-related actions during a touch down event. 3985 * 3986 * @param event The event. 3987 * @return True if the down was consumed. 3988 * 3989 * @hide 3990 */ 3991 protected boolean performButtonActionOnTouchDown(MotionEvent event) { 3992 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) { 3993 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) { 3994 return true; 3995 } 3996 } 3997 return false; 3998 } 3999 4000 /** 4001 * Bring up the context menu for this view. 4002 * 4003 * @return Whether a context menu was displayed. 4004 */ 4005 public boolean showContextMenu() { 4006 return getParent().showContextMenuForChild(this); 4007 } 4008 4009 /** 4010 * Bring up the context menu for this view, referring to the item under the specified point. 4011 * 4012 * @param x The referenced x coordinate. 4013 * @param y The referenced y coordinate. 4014 * @param metaState The keyboard modifiers that were pressed. 4015 * @return Whether a context menu was displayed. 4016 * 4017 * @hide 4018 */ 4019 public boolean showContextMenu(float x, float y, int metaState) { 4020 return showContextMenu(); 4021 } 4022 4023 /** 4024 * Start an action mode. 4025 * 4026 * @param callback Callback that will control the lifecycle of the action mode 4027 * @return The new action mode if it is started, null otherwise 4028 * 4029 * @see ActionMode 4030 */ 4031 public ActionMode startActionMode(ActionMode.Callback callback) { 4032 ViewParent parent = getParent(); 4033 if (parent == null) return null; 4034 return parent.startActionModeForChild(this, callback); 4035 } 4036 4037 /** 4038 * Register a callback to be invoked when a key is pressed in this view. 4039 * @param l the key listener to attach to this view 4040 */ 4041 public void setOnKeyListener(OnKeyListener l) { 4042 getListenerInfo().mOnKeyListener = l; 4043 } 4044 4045 /** 4046 * Register a callback to be invoked when a touch event is sent to this view. 4047 * @param l the touch listener to attach to this view 4048 */ 4049 public void setOnTouchListener(OnTouchListener l) { 4050 getListenerInfo().mOnTouchListener = l; 4051 } 4052 4053 /** 4054 * Register a callback to be invoked when a generic motion event is sent to this view. 4055 * @param l the generic motion listener to attach to this view 4056 */ 4057 public void setOnGenericMotionListener(OnGenericMotionListener l) { 4058 getListenerInfo().mOnGenericMotionListener = l; 4059 } 4060 4061 /** 4062 * Register a callback to be invoked when a hover event is sent to this view. 4063 * @param l the hover listener to attach to this view 4064 */ 4065 public void setOnHoverListener(OnHoverListener l) { 4066 getListenerInfo().mOnHoverListener = l; 4067 } 4068 4069 /** 4070 * Register a drag event listener callback object for this View. The parameter is 4071 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a 4072 * View, the system calls the 4073 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method. 4074 * @param l An implementation of {@link android.view.View.OnDragListener}. 4075 */ 4076 public void setOnDragListener(OnDragListener l) { 4077 getListenerInfo().mOnDragListener = l; 4078 } 4079 4080 /** 4081 * Give this view focus. This will cause 4082 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called. 4083 * 4084 * Note: this does not check whether this {@link View} should get focus, it just 4085 * gives it focus no matter what. It should only be called internally by framework 4086 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}. 4087 * 4088 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN}, 4089 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which 4090 * focus moved when requestFocus() is called. It may not always 4091 * apply, in which case use the default View.FOCUS_DOWN. 4092 * @param previouslyFocusedRect The rectangle of the view that had focus 4093 * prior in this View's coordinate system. 4094 */ 4095 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) { 4096 if (DBG) { 4097 System.out.println(this + " requestFocus()"); 4098 } 4099 4100 if ((mPrivateFlags & FOCUSED) == 0) { 4101 mPrivateFlags |= FOCUSED; 4102 4103 if (mParent != null) { 4104 mParent.requestChildFocus(this, this); 4105 } 4106 4107 onFocusChanged(true, direction, previouslyFocusedRect); 4108 refreshDrawableState(); 4109 4110 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4111 notifyAccessibilityStateChanged(); 4112 } 4113 } 4114 } 4115 4116 /** 4117 * Request that a rectangle of this view be visible on the screen, 4118 * scrolling if necessary just enough. 4119 * 4120 * <p>A View should call this if it maintains some notion of which part 4121 * of its content is interesting. For example, a text editing view 4122 * should call this when its cursor moves. 4123 * 4124 * @param rectangle The rectangle. 4125 * @return Whether any parent scrolled. 4126 */ 4127 public boolean requestRectangleOnScreen(Rect rectangle) { 4128 return requestRectangleOnScreen(rectangle, false); 4129 } 4130 4131 /** 4132 * Request that a rectangle of this view be visible on the screen, 4133 * scrolling if necessary just enough. 4134 * 4135 * <p>A View should call this if it maintains some notion of which part 4136 * of its content is interesting. For example, a text editing view 4137 * should call this when its cursor moves. 4138 * 4139 * <p>When <code>immediate</code> is set to true, scrolling will not be 4140 * animated. 4141 * 4142 * @param rectangle The rectangle. 4143 * @param immediate True to forbid animated scrolling, false otherwise 4144 * @return Whether any parent scrolled. 4145 */ 4146 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) { 4147 View child = this; 4148 ViewParent parent = mParent; 4149 boolean scrolled = false; 4150 while (parent != null) { 4151 scrolled |= parent.requestChildRectangleOnScreen(child, 4152 rectangle, immediate); 4153 4154 // offset rect so next call has the rectangle in the 4155 // coordinate system of its direct child. 4156 rectangle.offset(child.getLeft(), child.getTop()); 4157 rectangle.offset(-child.getScrollX(), -child.getScrollY()); 4158 4159 if (!(parent instanceof View)) { 4160 break; 4161 } 4162 4163 child = (View) parent; 4164 parent = child.getParent(); 4165 } 4166 return scrolled; 4167 } 4168 4169 /** 4170 * Called when this view wants to give up focus. If focus is cleared 4171 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called. 4172 * <p> 4173 * <strong>Note:</strong> When a View clears focus the framework is trying 4174 * to give focus to the first focusable View from the top. Hence, if this 4175 * View is the first from the top that can take focus, then all callbacks 4176 * related to clearing focus will be invoked after wich the framework will 4177 * give focus to this view. 4178 * </p> 4179 */ 4180 public void clearFocus() { 4181 if (DBG) { 4182 System.out.println(this + " clearFocus()"); 4183 } 4184 4185 if ((mPrivateFlags & FOCUSED) != 0) { 4186 mPrivateFlags &= ~FOCUSED; 4187 4188 if (mParent != null) { 4189 mParent.clearChildFocus(this); 4190 } 4191 4192 onFocusChanged(false, 0, null); 4193 4194 refreshDrawableState(); 4195 4196 ensureInputFocusOnFirstFocusable(); 4197 4198 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4199 notifyAccessibilityStateChanged(); 4200 } 4201 } 4202 } 4203 4204 void ensureInputFocusOnFirstFocusable() { 4205 View root = getRootView(); 4206 if (root != null) { 4207 root.requestFocus(); 4208 } 4209 } 4210 4211 /** 4212 * Called internally by the view system when a new view is getting focus. 4213 * This is what clears the old focus. 4214 */ 4215 void unFocus() { 4216 if (DBG) { 4217 System.out.println(this + " unFocus()"); 4218 } 4219 4220 if ((mPrivateFlags & FOCUSED) != 0) { 4221 mPrivateFlags &= ~FOCUSED; 4222 4223 onFocusChanged(false, 0, null); 4224 refreshDrawableState(); 4225 4226 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4227 notifyAccessibilityStateChanged(); 4228 } 4229 } 4230 } 4231 4232 /** 4233 * Returns true if this view has focus iteself, or is the ancestor of the 4234 * view that has focus. 4235 * 4236 * @return True if this view has or contains focus, false otherwise. 4237 */ 4238 @ViewDebug.ExportedProperty(category = "focus") 4239 public boolean hasFocus() { 4240 return (mPrivateFlags & FOCUSED) != 0; 4241 } 4242 4243 /** 4244 * Returns true if this view is focusable or if it contains a reachable View 4245 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()" 4246 * is a View whose parents do not block descendants focus. 4247 * 4248 * Only {@link #VISIBLE} views are considered focusable. 4249 * 4250 * @return True if the view is focusable or if the view contains a focusable 4251 * View, false otherwise. 4252 * 4253 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS 4254 */ 4255 public boolean hasFocusable() { 4256 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable(); 4257 } 4258 4259 /** 4260 * Called by the view system when the focus state of this view changes. 4261 * When the focus change event is caused by directional navigation, direction 4262 * and previouslyFocusedRect provide insight into where the focus is coming from. 4263 * When overriding, be sure to call up through to the super class so that 4264 * the standard focus handling will occur. 4265 * 4266 * @param gainFocus True if the View has focus; false otherwise. 4267 * @param direction The direction focus has moved when requestFocus() 4268 * is called to give this view focus. Values are 4269 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT}, 4270 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}. 4271 * It may not always apply, in which case use the default. 4272 * @param previouslyFocusedRect The rectangle, in this view's coordinate 4273 * system, of the previously focused view. If applicable, this will be 4274 * passed in as finer grained information about where the focus is coming 4275 * from (in addition to direction). Will be <code>null</code> otherwise. 4276 */ 4277 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) { 4278 if (gainFocus) { 4279 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4280 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED); 4281 requestAccessibilityFocus(); 4282 } 4283 } 4284 4285 InputMethodManager imm = InputMethodManager.peekInstance(); 4286 if (!gainFocus) { 4287 if (isPressed()) { 4288 setPressed(false); 4289 } 4290 if (imm != null && mAttachInfo != null 4291 && mAttachInfo.mHasWindowFocus) { 4292 imm.focusOut(this); 4293 } 4294 onFocusLost(); 4295 } else if (imm != null && mAttachInfo != null 4296 && mAttachInfo.mHasWindowFocus) { 4297 imm.focusIn(this); 4298 } 4299 4300 invalidate(true); 4301 ListenerInfo li = mListenerInfo; 4302 if (li != null && li.mOnFocusChangeListener != null) { 4303 li.mOnFocusChangeListener.onFocusChange(this, gainFocus); 4304 } 4305 4306 if (mAttachInfo != null) { 4307 mAttachInfo.mKeyDispatchState.reset(this); 4308 } 4309 } 4310 4311 /** 4312 * Sends an accessibility event of the given type. If accessiiblity is 4313 * not enabled this method has no effect. The default implementation calls 4314 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first 4315 * to populate information about the event source (this View), then calls 4316 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to 4317 * populate the text content of the event source including its descendants, 4318 * and last calls 4319 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)} 4320 * on its parent to resuest sending of the event to interested parties. 4321 * <p> 4322 * If an {@link AccessibilityDelegate} has been specified via calling 4323 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4324 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is 4325 * responsible for handling this call. 4326 * </p> 4327 * 4328 * @param eventType The type of the event to send, as defined by several types from 4329 * {@link android.view.accessibility.AccessibilityEvent}, such as 4330 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or 4331 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}. 4332 * 4333 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 4334 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4335 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent) 4336 * @see AccessibilityDelegate 4337 */ 4338 public void sendAccessibilityEvent(int eventType) { 4339 if (mAccessibilityDelegate != null) { 4340 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType); 4341 } else { 4342 sendAccessibilityEventInternal(eventType); 4343 } 4344 } 4345 4346 /** 4347 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT} 4348 * {@link AccessibilityEvent} to make an announcement which is related to some 4349 * sort of a context change for which none of the events representing UI transitions 4350 * is a good fit. For example, announcing a new page in a book. If accessibility 4351 * is not enabled this method does nothing. 4352 * 4353 * @param text The announcement text. 4354 */ 4355 public void announceForAccessibility(CharSequence text) { 4356 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4357 AccessibilityEvent event = AccessibilityEvent.obtain( 4358 AccessibilityEvent.TYPE_ANNOUNCEMENT); 4359 event.getText().add(text); 4360 sendAccessibilityEventUnchecked(event); 4361 } 4362 } 4363 4364 /** 4365 * @see #sendAccessibilityEvent(int) 4366 * 4367 * Note: Called from the default {@link AccessibilityDelegate}. 4368 */ 4369 void sendAccessibilityEventInternal(int eventType) { 4370 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 4371 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType)); 4372 } 4373 } 4374 4375 /** 4376 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but 4377 * takes as an argument an empty {@link AccessibilityEvent} and does not 4378 * perform a check whether accessibility is enabled. 4379 * <p> 4380 * If an {@link AccessibilityDelegate} has been specified via calling 4381 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4382 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)} 4383 * is responsible for handling this call. 4384 * </p> 4385 * 4386 * @param event The event to send. 4387 * 4388 * @see #sendAccessibilityEvent(int) 4389 */ 4390 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) { 4391 if (mAccessibilityDelegate != null) { 4392 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event); 4393 } else { 4394 sendAccessibilityEventUncheckedInternal(event); 4395 } 4396 } 4397 4398 /** 4399 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent) 4400 * 4401 * Note: Called from the default {@link AccessibilityDelegate}. 4402 */ 4403 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) { 4404 if (!isShown()) { 4405 return; 4406 } 4407 onInitializeAccessibilityEvent(event); 4408 // Only a subset of accessibility events populates text content. 4409 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) { 4410 dispatchPopulateAccessibilityEvent(event); 4411 } 4412 // Intercept accessibility focus events fired by virtual nodes to keep 4413 // track of accessibility focus position in such nodes. 4414 final int eventType = event.getEventType(); 4415 switch (eventType) { 4416 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED: { 4417 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId( 4418 event.getSourceNodeId()); 4419 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) { 4420 ViewRootImpl viewRootImpl = getViewRootImpl(); 4421 if (viewRootImpl != null) { 4422 viewRootImpl.setAccessibilityFocusedHost(this); 4423 } 4424 } 4425 } break; 4426 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED: { 4427 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId( 4428 event.getSourceNodeId()); 4429 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) { 4430 ViewRootImpl viewRootImpl = getViewRootImpl(); 4431 if (viewRootImpl != null) { 4432 viewRootImpl.setAccessibilityFocusedHost(null); 4433 } 4434 } 4435 } break; 4436 } 4437 // In the beginning we called #isShown(), so we know that getParent() is not null. 4438 getParent().requestSendAccessibilityEvent(this, event); 4439 } 4440 4441 /** 4442 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then 4443 * to its children for adding their text content to the event. Note that the 4444 * event text is populated in a separate dispatch path since we add to the 4445 * event not only the text of the source but also the text of all its descendants. 4446 * A typical implementation will call 4447 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view 4448 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 4449 * on each child. Override this method if custom population of the event text 4450 * content is required. 4451 * <p> 4452 * If an {@link AccessibilityDelegate} has been specified via calling 4453 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4454 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)} 4455 * is responsible for handling this call. 4456 * </p> 4457 * <p> 4458 * <em>Note:</em> Accessibility events of certain types are not dispatched for 4459 * populating the event text via this method. For details refer to {@link AccessibilityEvent}. 4460 * </p> 4461 * 4462 * @param event The event. 4463 * 4464 * @return True if the event population was completed. 4465 */ 4466 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 4467 if (mAccessibilityDelegate != null) { 4468 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event); 4469 } else { 4470 return dispatchPopulateAccessibilityEventInternal(event); 4471 } 4472 } 4473 4474 /** 4475 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4476 * 4477 * Note: Called from the default {@link AccessibilityDelegate}. 4478 */ 4479 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) { 4480 onPopulateAccessibilityEvent(event); 4481 return false; 4482 } 4483 4484 /** 4485 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 4486 * giving a chance to this View to populate the accessibility event with its 4487 * text content. While this method is free to modify event 4488 * attributes other than text content, doing so should normally be performed in 4489 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}. 4490 * <p> 4491 * Example: Adding formatted date string to an accessibility event in addition 4492 * to the text added by the super implementation: 4493 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 4494 * super.onPopulateAccessibilityEvent(event); 4495 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY; 4496 * String selectedDateUtterance = DateUtils.formatDateTime(mContext, 4497 * mCurrentDate.getTimeInMillis(), flags); 4498 * event.getText().add(selectedDateUtterance); 4499 * }</pre> 4500 * <p> 4501 * If an {@link AccessibilityDelegate} has been specified via calling 4502 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4503 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)} 4504 * is responsible for handling this call. 4505 * </p> 4506 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 4507 * information to the event, in case the default implementation has basic information to add. 4508 * </p> 4509 * 4510 * @param event The accessibility event which to populate. 4511 * 4512 * @see #sendAccessibilityEvent(int) 4513 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4514 */ 4515 public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 4516 if (mAccessibilityDelegate != null) { 4517 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event); 4518 } else { 4519 onPopulateAccessibilityEventInternal(event); 4520 } 4521 } 4522 4523 /** 4524 * @see #onPopulateAccessibilityEvent(AccessibilityEvent) 4525 * 4526 * Note: Called from the default {@link AccessibilityDelegate}. 4527 */ 4528 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) { 4529 4530 } 4531 4532 /** 4533 * Initializes an {@link AccessibilityEvent} with information about 4534 * this View which is the event source. In other words, the source of 4535 * an accessibility event is the view whose state change triggered firing 4536 * the event. 4537 * <p> 4538 * Example: Setting the password property of an event in addition 4539 * to properties set by the super implementation: 4540 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 4541 * super.onInitializeAccessibilityEvent(event); 4542 * event.setPassword(true); 4543 * }</pre> 4544 * <p> 4545 * If an {@link AccessibilityDelegate} has been specified via calling 4546 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4547 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)} 4548 * is responsible for handling this call. 4549 * </p> 4550 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 4551 * information to the event, in case the default implementation has basic information to add. 4552 * </p> 4553 * @param event The event to initialize. 4554 * 4555 * @see #sendAccessibilityEvent(int) 4556 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4557 */ 4558 public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 4559 if (mAccessibilityDelegate != null) { 4560 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event); 4561 } else { 4562 onInitializeAccessibilityEventInternal(event); 4563 } 4564 } 4565 4566 /** 4567 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 4568 * 4569 * Note: Called from the default {@link AccessibilityDelegate}. 4570 */ 4571 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) { 4572 event.setSource(this); 4573 event.setClassName(View.class.getName()); 4574 event.setPackageName(getContext().getPackageName()); 4575 event.setEnabled(isEnabled()); 4576 event.setContentDescription(mContentDescription); 4577 4578 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) { 4579 ArrayList<View> focusablesTempList = mAttachInfo.mTempArrayList; 4580 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, 4581 FOCUSABLES_ALL); 4582 event.setItemCount(focusablesTempList.size()); 4583 event.setCurrentItemIndex(focusablesTempList.indexOf(this)); 4584 focusablesTempList.clear(); 4585 } 4586 } 4587 4588 /** 4589 * Returns an {@link AccessibilityNodeInfo} representing this view from the 4590 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 4591 * This method is responsible for obtaining an accessibility node info from a 4592 * pool of reusable instances and calling 4593 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to 4594 * initialize the former. 4595 * <p> 4596 * Note: The client is responsible for recycling the obtained instance by calling 4597 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation. 4598 * </p> 4599 * 4600 * @return A populated {@link AccessibilityNodeInfo}. 4601 * 4602 * @see AccessibilityNodeInfo 4603 */ 4604 public AccessibilityNodeInfo createAccessibilityNodeInfo() { 4605 AccessibilityNodeProvider provider = getAccessibilityNodeProvider(); 4606 if (provider != null) { 4607 return provider.createAccessibilityNodeInfo(View.NO_ID); 4608 } else { 4609 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this); 4610 onInitializeAccessibilityNodeInfo(info); 4611 return info; 4612 } 4613 } 4614 4615 /** 4616 * Initializes an {@link AccessibilityNodeInfo} with information about this view. 4617 * The base implementation sets: 4618 * <ul> 4619 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li> 4620 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li> 4621 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li> 4622 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li> 4623 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li> 4624 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li> 4625 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li> 4626 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li> 4627 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li> 4628 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li> 4629 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li> 4630 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li> 4631 * </ul> 4632 * <p> 4633 * Subclasses should override this method, call the super implementation, 4634 * and set additional attributes. 4635 * </p> 4636 * <p> 4637 * If an {@link AccessibilityDelegate} has been specified via calling 4638 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4639 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)} 4640 * is responsible for handling this call. 4641 * </p> 4642 * 4643 * @param info The instance to initialize. 4644 */ 4645 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 4646 if (mAccessibilityDelegate != null) { 4647 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info); 4648 } else { 4649 onInitializeAccessibilityNodeInfoInternal(info); 4650 } 4651 } 4652 4653 /** 4654 * Gets the location of this view in screen coordintates. 4655 * 4656 * @param outRect The output location 4657 */ 4658 private void getBoundsOnScreen(Rect outRect) { 4659 if (mAttachInfo == null) { 4660 return; 4661 } 4662 4663 RectF position = mAttachInfo.mTmpTransformRect; 4664 position.set(0, 0, mRight - mLeft, mBottom - mTop); 4665 4666 if (!hasIdentityMatrix()) { 4667 getMatrix().mapRect(position); 4668 } 4669 4670 position.offset(mLeft, mTop); 4671 4672 ViewParent parent = mParent; 4673 while (parent instanceof View) { 4674 View parentView = (View) parent; 4675 4676 position.offset(-parentView.mScrollX, -parentView.mScrollY); 4677 4678 if (!parentView.hasIdentityMatrix()) { 4679 parentView.getMatrix().mapRect(position); 4680 } 4681 4682 position.offset(parentView.mLeft, parentView.mTop); 4683 4684 parent = parentView.mParent; 4685 } 4686 4687 if (parent instanceof ViewRootImpl) { 4688 ViewRootImpl viewRootImpl = (ViewRootImpl) parent; 4689 position.offset(0, -viewRootImpl.mCurScrollY); 4690 } 4691 4692 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop); 4693 4694 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f), 4695 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f)); 4696 } 4697 4698 /** 4699 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 4700 * 4701 * Note: Called from the default {@link AccessibilityDelegate}. 4702 */ 4703 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) { 4704 Rect bounds = mAttachInfo.mTmpInvalRect; 4705 getDrawingRect(bounds); 4706 info.setBoundsInParent(bounds); 4707 4708 getBoundsOnScreen(bounds); 4709 info.setBoundsInScreen(bounds); 4710 4711 if ((mPrivateFlags & IS_ROOT_NAMESPACE) == 0) { 4712 ViewParent parent = getParentForAccessibility(); 4713 if (parent instanceof View) { 4714 info.setParent((View) parent); 4715 } 4716 } 4717 4718 info.setVisibleToUser(isVisibleToUser()); 4719 4720 info.setPackageName(mContext.getPackageName()); 4721 info.setClassName(View.class.getName()); 4722 info.setContentDescription(getContentDescription()); 4723 4724 info.setEnabled(isEnabled()); 4725 info.setClickable(isClickable()); 4726 info.setFocusable(isFocusable()); 4727 info.setFocused(isFocused()); 4728 info.setAccessibilityFocused(isAccessibilityFocused()); 4729 info.setSelected(isSelected()); 4730 info.setLongClickable(isLongClickable()); 4731 4732 // TODO: These make sense only if we are in an AdapterView but all 4733 // views can be selected. Maybe from accessiiblity perspective 4734 // we should report as selectable view in an AdapterView. 4735 info.addAction(AccessibilityNodeInfo.ACTION_SELECT); 4736 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION); 4737 4738 if (isFocusable()) { 4739 if (isFocused()) { 4740 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS); 4741 } else { 4742 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS); 4743 } 4744 } 4745 4746 if (!isAccessibilityFocused()) { 4747 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS); 4748 } else { 4749 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS); 4750 } 4751 4752 if (isClickable()) { 4753 info.addAction(AccessibilityNodeInfo.ACTION_CLICK); 4754 } 4755 4756 if (isLongClickable()) { 4757 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK); 4758 } 4759 4760 if (mContentDescription != null && mContentDescription.length() > 0) { 4761 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY); 4762 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY); 4763 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER 4764 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD 4765 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH); 4766 } 4767 } 4768 4769 /** 4770 * Computes whether this view is visible to the user. Such a view is 4771 * attached, visible, all its predecessors are visible, it is not clipped 4772 * entirely by its predecessors, and has an alpha greater than zero. 4773 * 4774 * @return Whether the view is visible on the screen. 4775 */ 4776 private boolean isVisibleToUser() { 4777 // The first two checks are made also made by isShown() which 4778 // however traverses the tree up to the parent to catch that. 4779 // Therefore, we do some fail fast check to minimize the up 4780 // tree traversal. 4781 return (mAttachInfo != null 4782 && mAttachInfo.mWindowVisibility == View.VISIBLE 4783 && getAlpha() > 0 4784 && isShown() 4785 && getGlobalVisibleRect(mAttachInfo.mTmpInvalRect)); 4786 } 4787 4788 /** 4789 * Sets a delegate for implementing accessibility support via compositon as 4790 * opposed to inheritance. The delegate's primary use is for implementing 4791 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 4792 * 4793 * @param delegate The delegate instance. 4794 * 4795 * @see AccessibilityDelegate 4796 */ 4797 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 4798 mAccessibilityDelegate = delegate; 4799 } 4800 4801 /** 4802 * Gets the provider for managing a virtual view hierarchy rooted at this View 4803 * and reported to {@link android.accessibilityservice.AccessibilityService}s 4804 * that explore the window content. 4805 * <p> 4806 * If this method returns an instance, this instance is responsible for managing 4807 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 4808 * View including the one representing the View itself. Similarly the returned 4809 * instance is responsible for performing accessibility actions on any virtual 4810 * view or the root view itself. 4811 * </p> 4812 * <p> 4813 * If an {@link AccessibilityDelegate} has been specified via calling 4814 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4815 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 4816 * is responsible for handling this call. 4817 * </p> 4818 * 4819 * @return The provider. 4820 * 4821 * @see AccessibilityNodeProvider 4822 */ 4823 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 4824 if (mAccessibilityDelegate != null) { 4825 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 4826 } else { 4827 return null; 4828 } 4829 } 4830 4831 /** 4832 * Gets the unique identifier of this view on the screen for accessibility purposes. 4833 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 4834 * 4835 * @return The view accessibility id. 4836 * 4837 * @hide 4838 */ 4839 public int getAccessibilityViewId() { 4840 if (mAccessibilityViewId == NO_ID) { 4841 mAccessibilityViewId = sNextAccessibilityViewId++; 4842 } 4843 return mAccessibilityViewId; 4844 } 4845 4846 /** 4847 * Gets the unique identifier of the window in which this View reseides. 4848 * 4849 * @return The window accessibility id. 4850 * 4851 * @hide 4852 */ 4853 public int getAccessibilityWindowId() { 4854 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID; 4855 } 4856 4857 /** 4858 * Gets the {@link View} description. It briefly describes the view and is 4859 * primarily used for accessibility support. Set this property to enable 4860 * better accessibility support for your application. This is especially 4861 * true for views that do not have textual representation (For example, 4862 * ImageButton). 4863 * 4864 * @return The content description. 4865 * 4866 * @attr ref android.R.styleable#View_contentDescription 4867 */ 4868 @ViewDebug.ExportedProperty(category = "accessibility") 4869 public CharSequence getContentDescription() { 4870 return mContentDescription; 4871 } 4872 4873 /** 4874 * Sets the {@link View} description. It briefly describes the view and is 4875 * primarily used for accessibility support. Set this property to enable 4876 * better accessibility support for your application. This is especially 4877 * true for views that do not have textual representation (For example, 4878 * ImageButton). 4879 * 4880 * @param contentDescription The content description. 4881 * 4882 * @attr ref android.R.styleable#View_contentDescription 4883 */ 4884 @RemotableViewMethod 4885 public void setContentDescription(CharSequence contentDescription) { 4886 mContentDescription = contentDescription; 4887 } 4888 4889 /** 4890 * Invoked whenever this view loses focus, either by losing window focus or by losing 4891 * focus within its window. This method can be used to clear any state tied to the 4892 * focus. For instance, if a button is held pressed with the trackball and the window 4893 * loses focus, this method can be used to cancel the press. 4894 * 4895 * Subclasses of View overriding this method should always call super.onFocusLost(). 4896 * 4897 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 4898 * @see #onWindowFocusChanged(boolean) 4899 * 4900 * @hide pending API council approval 4901 */ 4902 protected void onFocusLost() { 4903 resetPressedState(); 4904 } 4905 4906 private void resetPressedState() { 4907 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 4908 return; 4909 } 4910 4911 if (isPressed()) { 4912 setPressed(false); 4913 4914 if (!mHasPerformedLongPress) { 4915 removeLongPressCallback(); 4916 } 4917 } 4918 } 4919 4920 /** 4921 * Returns true if this view has focus 4922 * 4923 * @return True if this view has focus, false otherwise. 4924 */ 4925 @ViewDebug.ExportedProperty(category = "focus") 4926 public boolean isFocused() { 4927 return (mPrivateFlags & FOCUSED) != 0; 4928 } 4929 4930 /** 4931 * Find the view in the hierarchy rooted at this view that currently has 4932 * focus. 4933 * 4934 * @return The view that currently has focus, or null if no focused view can 4935 * be found. 4936 */ 4937 public View findFocus() { 4938 return (mPrivateFlags & FOCUSED) != 0 ? this : null; 4939 } 4940 4941 /** 4942 * Indicates whether this view is one of the set of scrollable containers in 4943 * its window. 4944 * 4945 * @return whether this view is one of the set of scrollable containers in 4946 * its window 4947 * 4948 * @attr ref android.R.styleable#View_isScrollContainer 4949 */ 4950 public boolean isScrollContainer() { 4951 return (mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0; 4952 } 4953 4954 /** 4955 * Change whether this view is one of the set of scrollable containers in 4956 * its window. This will be used to determine whether the window can 4957 * resize or must pan when a soft input area is open -- scrollable 4958 * containers allow the window to use resize mode since the container 4959 * will appropriately shrink. 4960 * 4961 * @attr ref android.R.styleable#View_isScrollContainer 4962 */ 4963 public void setScrollContainer(boolean isScrollContainer) { 4964 if (isScrollContainer) { 4965 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) { 4966 mAttachInfo.mScrollContainers.add(this); 4967 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 4968 } 4969 mPrivateFlags |= SCROLL_CONTAINER; 4970 } else { 4971 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) { 4972 mAttachInfo.mScrollContainers.remove(this); 4973 } 4974 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED); 4975 } 4976 } 4977 4978 /** 4979 * Returns the quality of the drawing cache. 4980 * 4981 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 4982 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 4983 * 4984 * @see #setDrawingCacheQuality(int) 4985 * @see #setDrawingCacheEnabled(boolean) 4986 * @see #isDrawingCacheEnabled() 4987 * 4988 * @attr ref android.R.styleable#View_drawingCacheQuality 4989 */ 4990 public int getDrawingCacheQuality() { 4991 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 4992 } 4993 4994 /** 4995 * Set the drawing cache quality of this view. This value is used only when the 4996 * drawing cache is enabled 4997 * 4998 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 4999 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 5000 * 5001 * @see #getDrawingCacheQuality() 5002 * @see #setDrawingCacheEnabled(boolean) 5003 * @see #isDrawingCacheEnabled() 5004 * 5005 * @attr ref android.R.styleable#View_drawingCacheQuality 5006 */ 5007 public void setDrawingCacheQuality(int quality) { 5008 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 5009 } 5010 5011 /** 5012 * Returns whether the screen should remain on, corresponding to the current 5013 * value of {@link #KEEP_SCREEN_ON}. 5014 * 5015 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 5016 * 5017 * @see #setKeepScreenOn(boolean) 5018 * 5019 * @attr ref android.R.styleable#View_keepScreenOn 5020 */ 5021 public boolean getKeepScreenOn() { 5022 return (mViewFlags & KEEP_SCREEN_ON) != 0; 5023 } 5024 5025 /** 5026 * Controls whether the screen should remain on, modifying the 5027 * value of {@link #KEEP_SCREEN_ON}. 5028 * 5029 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 5030 * 5031 * @see #getKeepScreenOn() 5032 * 5033 * @attr ref android.R.styleable#View_keepScreenOn 5034 */ 5035 public void setKeepScreenOn(boolean keepScreenOn) { 5036 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 5037 } 5038 5039 /** 5040 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 5041 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5042 * 5043 * @attr ref android.R.styleable#View_nextFocusLeft 5044 */ 5045 public int getNextFocusLeftId() { 5046 return mNextFocusLeftId; 5047 } 5048 5049 /** 5050 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 5051 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 5052 * decide automatically. 5053 * 5054 * @attr ref android.R.styleable#View_nextFocusLeft 5055 */ 5056 public void setNextFocusLeftId(int nextFocusLeftId) { 5057 mNextFocusLeftId = nextFocusLeftId; 5058 } 5059 5060 /** 5061 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 5062 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5063 * 5064 * @attr ref android.R.styleable#View_nextFocusRight 5065 */ 5066 public int getNextFocusRightId() { 5067 return mNextFocusRightId; 5068 } 5069 5070 /** 5071 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 5072 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 5073 * decide automatically. 5074 * 5075 * @attr ref android.R.styleable#View_nextFocusRight 5076 */ 5077 public void setNextFocusRightId(int nextFocusRightId) { 5078 mNextFocusRightId = nextFocusRightId; 5079 } 5080 5081 /** 5082 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 5083 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5084 * 5085 * @attr ref android.R.styleable#View_nextFocusUp 5086 */ 5087 public int getNextFocusUpId() { 5088 return mNextFocusUpId; 5089 } 5090 5091 /** 5092 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 5093 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 5094 * decide automatically. 5095 * 5096 * @attr ref android.R.styleable#View_nextFocusUp 5097 */ 5098 public void setNextFocusUpId(int nextFocusUpId) { 5099 mNextFocusUpId = nextFocusUpId; 5100 } 5101 5102 /** 5103 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 5104 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5105 * 5106 * @attr ref android.R.styleable#View_nextFocusDown 5107 */ 5108 public int getNextFocusDownId() { 5109 return mNextFocusDownId; 5110 } 5111 5112 /** 5113 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 5114 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 5115 * decide automatically. 5116 * 5117 * @attr ref android.R.styleable#View_nextFocusDown 5118 */ 5119 public void setNextFocusDownId(int nextFocusDownId) { 5120 mNextFocusDownId = nextFocusDownId; 5121 } 5122 5123 /** 5124 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 5125 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 5126 * 5127 * @attr ref android.R.styleable#View_nextFocusForward 5128 */ 5129 public int getNextFocusForwardId() { 5130 return mNextFocusForwardId; 5131 } 5132 5133 /** 5134 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 5135 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 5136 * decide automatically. 5137 * 5138 * @attr ref android.R.styleable#View_nextFocusForward 5139 */ 5140 public void setNextFocusForwardId(int nextFocusForwardId) { 5141 mNextFocusForwardId = nextFocusForwardId; 5142 } 5143 5144 /** 5145 * Returns the visibility of this view and all of its ancestors 5146 * 5147 * @return True if this view and all of its ancestors are {@link #VISIBLE} 5148 */ 5149 public boolean isShown() { 5150 View current = this; 5151 //noinspection ConstantConditions 5152 do { 5153 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 5154 return false; 5155 } 5156 ViewParent parent = current.mParent; 5157 if (parent == null) { 5158 return false; // We are not attached to the view root 5159 } 5160 if (!(parent instanceof View)) { 5161 return true; 5162 } 5163 current = (View) parent; 5164 } while (current != null); 5165 5166 return false; 5167 } 5168 5169 /** 5170 * Called by the view hierarchy when the content insets for a window have 5171 * changed, to allow it to adjust its content to fit within those windows. 5172 * The content insets tell you the space that the status bar, input method, 5173 * and other system windows infringe on the application's window. 5174 * 5175 * <p>You do not normally need to deal with this function, since the default 5176 * window decoration given to applications takes care of applying it to the 5177 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} 5178 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case, 5179 * and your content can be placed under those system elements. You can then 5180 * use this method within your view hierarchy if you have parts of your UI 5181 * which you would like to ensure are not being covered. 5182 * 5183 * <p>The default implementation of this method simply applies the content 5184 * inset's to the view's padding. This can be enabled through 5185 * {@link #setFitsSystemWindows(boolean)}. Alternatively, you can override 5186 * the method and handle the insets however you would like. Note that the 5187 * insets provided by the framework are always relative to the far edges 5188 * of the window, not accounting for the location of the called view within 5189 * that window. (In fact when this method is called you do not yet know 5190 * where the layout will place the view, as it is done before layout happens.) 5191 * 5192 * <p>Note: unlike many View methods, there is no dispatch phase to this 5193 * call. If you are overriding it in a ViewGroup and want to allow the 5194 * call to continue to your children, you must be sure to call the super 5195 * implementation. 5196 * 5197 * <p>Here is a sample layout that makes use of fitting system windows 5198 * to have controls for a video view placed inside of the window decorations 5199 * that it hides and shows. This can be used with code like the second 5200 * sample (video player) shown in {@link #setSystemUiVisibility(int)}. 5201 * 5202 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete} 5203 * 5204 * @param insets Current content insets of the window. Prior to 5205 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify 5206 * the insets or else you and Android will be unhappy. 5207 * 5208 * @return Return true if this view applied the insets and it should not 5209 * continue propagating further down the hierarchy, false otherwise. 5210 */ 5211 protected boolean fitSystemWindows(Rect insets) { 5212 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 5213 mUserPaddingStart = -1; 5214 mUserPaddingEnd = -1; 5215 mUserPaddingRelative = false; 5216 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0 5217 || mAttachInfo == null 5218 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) { 5219 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom); 5220 return true; 5221 } else { 5222 internalSetPadding(0, 0, 0, 0); 5223 return false; 5224 } 5225 } 5226 return false; 5227 } 5228 5229 /** 5230 * Set whether or not this view should account for system screen decorations 5231 * such as the status bar and inset its content. This allows this view to be 5232 * positioned in absolute screen coordinates and remain visible to the user. 5233 * 5234 * <p>This should only be used by top-level window decor views. 5235 * 5236 * @param fitSystemWindows true to inset content for system screen decorations, false for 5237 * default behavior. 5238 * 5239 * @attr ref android.R.styleable#View_fitsSystemWindows 5240 */ 5241 public void setFitsSystemWindows(boolean fitSystemWindows) { 5242 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 5243 } 5244 5245 /** 5246 * Check for state of {@link #setFitsSystemWindows(boolean). If this method 5247 * returns true, this view 5248 * will account for system screen decorations such as the status bar and inset its 5249 * content. This allows the view to be positioned in absolute screen coordinates 5250 * and remain visible to the user. 5251 * 5252 * @return true if this view will adjust its content bounds for system screen decorations. 5253 * 5254 * @attr ref android.R.styleable#View_fitsSystemWindows 5255 */ 5256 public boolean getFitsSystemWindows() { 5257 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 5258 } 5259 5260 /** 5261 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed. 5262 */ 5263 public void requestFitSystemWindows() { 5264 if (mParent != null) { 5265 mParent.requestFitSystemWindows(); 5266 } 5267 } 5268 5269 /** 5270 * For use by PhoneWindow to make its own system window fitting optional. 5271 * @hide 5272 */ 5273 public void makeOptionalFitsSystemWindows() { 5274 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS); 5275 } 5276 5277 /** 5278 * Returns the visibility status for this view. 5279 * 5280 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 5281 * @attr ref android.R.styleable#View_visibility 5282 */ 5283 @ViewDebug.ExportedProperty(mapping = { 5284 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 5285 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 5286 @ViewDebug.IntToString(from = GONE, to = "GONE") 5287 }) 5288 public int getVisibility() { 5289 return mViewFlags & VISIBILITY_MASK; 5290 } 5291 5292 /** 5293 * Set the enabled state of this view. 5294 * 5295 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 5296 * @attr ref android.R.styleable#View_visibility 5297 */ 5298 @RemotableViewMethod 5299 public void setVisibility(int visibility) { 5300 setFlags(visibility, VISIBILITY_MASK); 5301 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false); 5302 } 5303 5304 /** 5305 * Returns the enabled status for this view. The interpretation of the 5306 * enabled state varies by subclass. 5307 * 5308 * @return True if this view is enabled, false otherwise. 5309 */ 5310 @ViewDebug.ExportedProperty 5311 public boolean isEnabled() { 5312 return (mViewFlags & ENABLED_MASK) == ENABLED; 5313 } 5314 5315 /** 5316 * Set the enabled state of this view. The interpretation of the enabled 5317 * state varies by subclass. 5318 * 5319 * @param enabled True if this view is enabled, false otherwise. 5320 */ 5321 @RemotableViewMethod 5322 public void setEnabled(boolean enabled) { 5323 if (enabled == isEnabled()) return; 5324 5325 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 5326 5327 /* 5328 * The View most likely has to change its appearance, so refresh 5329 * the drawable state. 5330 */ 5331 refreshDrawableState(); 5332 5333 // Invalidate too, since the default behavior for views is to be 5334 // be drawn at 50% alpha rather than to change the drawable. 5335 invalidate(true); 5336 } 5337 5338 /** 5339 * Set whether this view can receive the focus. 5340 * 5341 * Setting this to false will also ensure that this view is not focusable 5342 * in touch mode. 5343 * 5344 * @param focusable If true, this view can receive the focus. 5345 * 5346 * @see #setFocusableInTouchMode(boolean) 5347 * @attr ref android.R.styleable#View_focusable 5348 */ 5349 public void setFocusable(boolean focusable) { 5350 if (!focusable) { 5351 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 5352 } 5353 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 5354 } 5355 5356 /** 5357 * Set whether this view can receive focus while in touch mode. 5358 * 5359 * Setting this to true will also ensure that this view is focusable. 5360 * 5361 * @param focusableInTouchMode If true, this view can receive the focus while 5362 * in touch mode. 5363 * 5364 * @see #setFocusable(boolean) 5365 * @attr ref android.R.styleable#View_focusableInTouchMode 5366 */ 5367 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 5368 // Focusable in touch mode should always be set before the focusable flag 5369 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 5370 // which, in touch mode, will not successfully request focus on this view 5371 // because the focusable in touch mode flag is not set 5372 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 5373 if (focusableInTouchMode) { 5374 setFlags(FOCUSABLE, FOCUSABLE_MASK); 5375 } 5376 } 5377 5378 /** 5379 * Set whether this view should have sound effects enabled for events such as 5380 * clicking and touching. 5381 * 5382 * <p>You may wish to disable sound effects for a view if you already play sounds, 5383 * for instance, a dial key that plays dtmf tones. 5384 * 5385 * @param soundEffectsEnabled whether sound effects are enabled for this view. 5386 * @see #isSoundEffectsEnabled() 5387 * @see #playSoundEffect(int) 5388 * @attr ref android.R.styleable#View_soundEffectsEnabled 5389 */ 5390 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 5391 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 5392 } 5393 5394 /** 5395 * @return whether this view should have sound effects enabled for events such as 5396 * clicking and touching. 5397 * 5398 * @see #setSoundEffectsEnabled(boolean) 5399 * @see #playSoundEffect(int) 5400 * @attr ref android.R.styleable#View_soundEffectsEnabled 5401 */ 5402 @ViewDebug.ExportedProperty 5403 public boolean isSoundEffectsEnabled() { 5404 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 5405 } 5406 5407 /** 5408 * Set whether this view should have haptic feedback for events such as 5409 * long presses. 5410 * 5411 * <p>You may wish to disable haptic feedback if your view already controls 5412 * its own haptic feedback. 5413 * 5414 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 5415 * @see #isHapticFeedbackEnabled() 5416 * @see #performHapticFeedback(int) 5417 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 5418 */ 5419 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 5420 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 5421 } 5422 5423 /** 5424 * @return whether this view should have haptic feedback enabled for events 5425 * long presses. 5426 * 5427 * @see #setHapticFeedbackEnabled(boolean) 5428 * @see #performHapticFeedback(int) 5429 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 5430 */ 5431 @ViewDebug.ExportedProperty 5432 public boolean isHapticFeedbackEnabled() { 5433 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 5434 } 5435 5436 /** 5437 * Returns the layout direction for this view. 5438 * 5439 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 5440 * {@link #LAYOUT_DIRECTION_RTL}, 5441 * {@link #LAYOUT_DIRECTION_INHERIT} or 5442 * {@link #LAYOUT_DIRECTION_LOCALE}. 5443 * @attr ref android.R.styleable#View_layoutDirection 5444 */ 5445 @ViewDebug.ExportedProperty(category = "layout", mapping = { 5446 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 5447 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 5448 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 5449 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 5450 }) 5451 public int getLayoutDirection() { 5452 return (mPrivateFlags2 & LAYOUT_DIRECTION_MASK) >> LAYOUT_DIRECTION_MASK_SHIFT; 5453 } 5454 5455 /** 5456 * Set the layout direction for this view. This will propagate a reset of layout direction 5457 * resolution to the view's children and resolve layout direction for this view. 5458 * 5459 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR}, 5460 * {@link #LAYOUT_DIRECTION_RTL}, 5461 * {@link #LAYOUT_DIRECTION_INHERIT} or 5462 * {@link #LAYOUT_DIRECTION_LOCALE}. 5463 * 5464 * @attr ref android.R.styleable#View_layoutDirection 5465 */ 5466 @RemotableViewMethod 5467 public void setLayoutDirection(int layoutDirection) { 5468 if (getLayoutDirection() != layoutDirection) { 5469 // Reset the current layout direction and the resolved one 5470 mPrivateFlags2 &= ~LAYOUT_DIRECTION_MASK; 5471 resetResolvedLayoutDirection(); 5472 // Set the new layout direction (filtered) and ask for a layout pass 5473 mPrivateFlags2 |= 5474 ((layoutDirection << LAYOUT_DIRECTION_MASK_SHIFT) & LAYOUT_DIRECTION_MASK); 5475 requestLayout(); 5476 } 5477 } 5478 5479 /** 5480 * Returns the resolved layout direction for this view. 5481 * 5482 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 5483 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL. 5484 */ 5485 @ViewDebug.ExportedProperty(category = "layout", mapping = { 5486 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 5487 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 5488 }) 5489 public int getResolvedLayoutDirection() { 5490 // The layout diretion will be resolved only if needed 5491 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) != LAYOUT_DIRECTION_RESOLVED) { 5492 resolveLayoutDirection(); 5493 } 5494 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ? 5495 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 5496 } 5497 5498 /** 5499 * Indicates whether or not this view's layout is right-to-left. This is resolved from 5500 * layout attribute and/or the inherited value from the parent 5501 * 5502 * @return true if the layout is right-to-left. 5503 */ 5504 @ViewDebug.ExportedProperty(category = "layout") 5505 public boolean isLayoutRtl() { 5506 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL); 5507 } 5508 5509 /** 5510 * Indicates whether the view is currently tracking transient state that the 5511 * app should not need to concern itself with saving and restoring, but that 5512 * the framework should take special note to preserve when possible. 5513 * 5514 * <p>A view with transient state cannot be trivially rebound from an external 5515 * data source, such as an adapter binding item views in a list. This may be 5516 * because the view is performing an animation, tracking user selection 5517 * of content, or similar.</p> 5518 * 5519 * @return true if the view has transient state 5520 */ 5521 @ViewDebug.ExportedProperty(category = "layout") 5522 public boolean hasTransientState() { 5523 return (mPrivateFlags2 & HAS_TRANSIENT_STATE) == HAS_TRANSIENT_STATE; 5524 } 5525 5526 /** 5527 * Set whether this view is currently tracking transient state that the 5528 * framework should attempt to preserve when possible. This flag is reference counted, 5529 * so every call to setHasTransientState(true) should be paired with a later call 5530 * to setHasTransientState(false). 5531 * 5532 * <p>A view with transient state cannot be trivially rebound from an external 5533 * data source, such as an adapter binding item views in a list. This may be 5534 * because the view is performing an animation, tracking user selection 5535 * of content, or similar.</p> 5536 * 5537 * @param hasTransientState true if this view has transient state 5538 */ 5539 public void setHasTransientState(boolean hasTransientState) { 5540 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 : 5541 mTransientStateCount - 1; 5542 if (mTransientStateCount < 0) { 5543 mTransientStateCount = 0; 5544 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " + 5545 "unmatched pair of setHasTransientState calls"); 5546 } 5547 if ((hasTransientState && mTransientStateCount == 1) || 5548 (hasTransientState && mTransientStateCount == 0)) { 5549 // update flag if we've just incremented up from 0 or decremented down to 0 5550 mPrivateFlags2 = (mPrivateFlags2 & ~HAS_TRANSIENT_STATE) | 5551 (hasTransientState ? HAS_TRANSIENT_STATE : 0); 5552 if (mParent != null) { 5553 try { 5554 mParent.childHasTransientStateChanged(this, hasTransientState); 5555 } catch (AbstractMethodError e) { 5556 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() + 5557 " does not fully implement ViewParent", e); 5558 } 5559 } 5560 } 5561 } 5562 5563 /** 5564 * If this view doesn't do any drawing on its own, set this flag to 5565 * allow further optimizations. By default, this flag is not set on 5566 * View, but could be set on some View subclasses such as ViewGroup. 5567 * 5568 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 5569 * you should clear this flag. 5570 * 5571 * @param willNotDraw whether or not this View draw on its own 5572 */ 5573 public void setWillNotDraw(boolean willNotDraw) { 5574 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 5575 } 5576 5577 /** 5578 * Returns whether or not this View draws on its own. 5579 * 5580 * @return true if this view has nothing to draw, false otherwise 5581 */ 5582 @ViewDebug.ExportedProperty(category = "drawing") 5583 public boolean willNotDraw() { 5584 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 5585 } 5586 5587 /** 5588 * When a View's drawing cache is enabled, drawing is redirected to an 5589 * offscreen bitmap. Some views, like an ImageView, must be able to 5590 * bypass this mechanism if they already draw a single bitmap, to avoid 5591 * unnecessary usage of the memory. 5592 * 5593 * @param willNotCacheDrawing true if this view does not cache its 5594 * drawing, false otherwise 5595 */ 5596 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 5597 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 5598 } 5599 5600 /** 5601 * Returns whether or not this View can cache its drawing or not. 5602 * 5603 * @return true if this view does not cache its drawing, false otherwise 5604 */ 5605 @ViewDebug.ExportedProperty(category = "drawing") 5606 public boolean willNotCacheDrawing() { 5607 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 5608 } 5609 5610 /** 5611 * Indicates whether this view reacts to click events or not. 5612 * 5613 * @return true if the view is clickable, false otherwise 5614 * 5615 * @see #setClickable(boolean) 5616 * @attr ref android.R.styleable#View_clickable 5617 */ 5618 @ViewDebug.ExportedProperty 5619 public boolean isClickable() { 5620 return (mViewFlags & CLICKABLE) == CLICKABLE; 5621 } 5622 5623 /** 5624 * Enables or disables click events for this view. When a view 5625 * is clickable it will change its state to "pressed" on every click. 5626 * Subclasses should set the view clickable to visually react to 5627 * user's clicks. 5628 * 5629 * @param clickable true to make the view clickable, false otherwise 5630 * 5631 * @see #isClickable() 5632 * @attr ref android.R.styleable#View_clickable 5633 */ 5634 public void setClickable(boolean clickable) { 5635 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 5636 } 5637 5638 /** 5639 * Indicates whether this view reacts to long click events or not. 5640 * 5641 * @return true if the view is long clickable, false otherwise 5642 * 5643 * @see #setLongClickable(boolean) 5644 * @attr ref android.R.styleable#View_longClickable 5645 */ 5646 public boolean isLongClickable() { 5647 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 5648 } 5649 5650 /** 5651 * Enables or disables long click events for this view. When a view is long 5652 * clickable it reacts to the user holding down the button for a longer 5653 * duration than a tap. This event can either launch the listener or a 5654 * context menu. 5655 * 5656 * @param longClickable true to make the view long clickable, false otherwise 5657 * @see #isLongClickable() 5658 * @attr ref android.R.styleable#View_longClickable 5659 */ 5660 public void setLongClickable(boolean longClickable) { 5661 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 5662 } 5663 5664 /** 5665 * Sets the pressed state for this view. 5666 * 5667 * @see #isClickable() 5668 * @see #setClickable(boolean) 5669 * 5670 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 5671 * the View's internal state from a previously set "pressed" state. 5672 */ 5673 public void setPressed(boolean pressed) { 5674 final boolean needsRefresh = pressed != ((mPrivateFlags & PRESSED) == PRESSED); 5675 5676 if (pressed) { 5677 mPrivateFlags |= PRESSED; 5678 } else { 5679 mPrivateFlags &= ~PRESSED; 5680 } 5681 5682 if (needsRefresh) { 5683 refreshDrawableState(); 5684 } 5685 dispatchSetPressed(pressed); 5686 } 5687 5688 /** 5689 * Dispatch setPressed to all of this View's children. 5690 * 5691 * @see #setPressed(boolean) 5692 * 5693 * @param pressed The new pressed state 5694 */ 5695 protected void dispatchSetPressed(boolean pressed) { 5696 } 5697 5698 /** 5699 * Indicates whether the view is currently in pressed state. Unless 5700 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 5701 * the pressed state. 5702 * 5703 * @see #setPressed(boolean) 5704 * @see #isClickable() 5705 * @see #setClickable(boolean) 5706 * 5707 * @return true if the view is currently pressed, false otherwise 5708 */ 5709 public boolean isPressed() { 5710 return (mPrivateFlags & PRESSED) == PRESSED; 5711 } 5712 5713 /** 5714 * Indicates whether this view will save its state (that is, 5715 * whether its {@link #onSaveInstanceState} method will be called). 5716 * 5717 * @return Returns true if the view state saving is enabled, else false. 5718 * 5719 * @see #setSaveEnabled(boolean) 5720 * @attr ref android.R.styleable#View_saveEnabled 5721 */ 5722 public boolean isSaveEnabled() { 5723 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 5724 } 5725 5726 /** 5727 * Controls whether the saving of this view's state is 5728 * enabled (that is, whether its {@link #onSaveInstanceState} method 5729 * will be called). Note that even if freezing is enabled, the 5730 * view still must have an id assigned to it (via {@link #setId(int)}) 5731 * for its state to be saved. This flag can only disable the 5732 * saving of this view; any child views may still have their state saved. 5733 * 5734 * @param enabled Set to false to <em>disable</em> state saving, or true 5735 * (the default) to allow it. 5736 * 5737 * @see #isSaveEnabled() 5738 * @see #setId(int) 5739 * @see #onSaveInstanceState() 5740 * @attr ref android.R.styleable#View_saveEnabled 5741 */ 5742 public void setSaveEnabled(boolean enabled) { 5743 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 5744 } 5745 5746 /** 5747 * Gets whether the framework should discard touches when the view's 5748 * window is obscured by another visible window. 5749 * Refer to the {@link View} security documentation for more details. 5750 * 5751 * @return True if touch filtering is enabled. 5752 * 5753 * @see #setFilterTouchesWhenObscured(boolean) 5754 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 5755 */ 5756 @ViewDebug.ExportedProperty 5757 public boolean getFilterTouchesWhenObscured() { 5758 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 5759 } 5760 5761 /** 5762 * Sets whether the framework should discard touches when the view's 5763 * window is obscured by another visible window. 5764 * Refer to the {@link View} security documentation for more details. 5765 * 5766 * @param enabled True if touch filtering should be enabled. 5767 * 5768 * @see #getFilterTouchesWhenObscured 5769 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 5770 */ 5771 public void setFilterTouchesWhenObscured(boolean enabled) { 5772 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED, 5773 FILTER_TOUCHES_WHEN_OBSCURED); 5774 } 5775 5776 /** 5777 * Indicates whether the entire hierarchy under this view will save its 5778 * state when a state saving traversal occurs from its parent. The default 5779 * is true; if false, these views will not be saved unless 5780 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 5781 * 5782 * @return Returns true if the view state saving from parent is enabled, else false. 5783 * 5784 * @see #setSaveFromParentEnabled(boolean) 5785 */ 5786 public boolean isSaveFromParentEnabled() { 5787 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 5788 } 5789 5790 /** 5791 * Controls whether the entire hierarchy under this view will save its 5792 * state when a state saving traversal occurs from its parent. The default 5793 * is true; if false, these views will not be saved unless 5794 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 5795 * 5796 * @param enabled Set to false to <em>disable</em> state saving, or true 5797 * (the default) to allow it. 5798 * 5799 * @see #isSaveFromParentEnabled() 5800 * @see #setId(int) 5801 * @see #onSaveInstanceState() 5802 */ 5803 public void setSaveFromParentEnabled(boolean enabled) { 5804 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 5805 } 5806 5807 5808 /** 5809 * Returns whether this View is able to take focus. 5810 * 5811 * @return True if this view can take focus, or false otherwise. 5812 * @attr ref android.R.styleable#View_focusable 5813 */ 5814 @ViewDebug.ExportedProperty(category = "focus") 5815 public final boolean isFocusable() { 5816 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 5817 } 5818 5819 /** 5820 * When a view is focusable, it may not want to take focus when in touch mode. 5821 * For example, a button would like focus when the user is navigating via a D-pad 5822 * so that the user can click on it, but once the user starts touching the screen, 5823 * the button shouldn't take focus 5824 * @return Whether the view is focusable in touch mode. 5825 * @attr ref android.R.styleable#View_focusableInTouchMode 5826 */ 5827 @ViewDebug.ExportedProperty 5828 public final boolean isFocusableInTouchMode() { 5829 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 5830 } 5831 5832 /** 5833 * Find the nearest view in the specified direction that can take focus. 5834 * This does not actually give focus to that view. 5835 * 5836 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 5837 * 5838 * @return The nearest focusable in the specified direction, or null if none 5839 * can be found. 5840 */ 5841 public View focusSearch(int direction) { 5842 if (mParent != null) { 5843 return mParent.focusSearch(this, direction); 5844 } else { 5845 return null; 5846 } 5847 } 5848 5849 /** 5850 * This method is the last chance for the focused view and its ancestors to 5851 * respond to an arrow key. This is called when the focused view did not 5852 * consume the key internally, nor could the view system find a new view in 5853 * the requested direction to give focus to. 5854 * 5855 * @param focused The currently focused view. 5856 * @param direction The direction focus wants to move. One of FOCUS_UP, 5857 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 5858 * @return True if the this view consumed this unhandled move. 5859 */ 5860 public boolean dispatchUnhandledMove(View focused, int direction) { 5861 return false; 5862 } 5863 5864 /** 5865 * If a user manually specified the next view id for a particular direction, 5866 * use the root to look up the view. 5867 * @param root The root view of the hierarchy containing this view. 5868 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 5869 * or FOCUS_BACKWARD. 5870 * @return The user specified next view, or null if there is none. 5871 */ 5872 View findUserSetNextFocus(View root, int direction) { 5873 switch (direction) { 5874 case FOCUS_LEFT: 5875 if (mNextFocusLeftId == View.NO_ID) return null; 5876 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 5877 case FOCUS_RIGHT: 5878 if (mNextFocusRightId == View.NO_ID) return null; 5879 return findViewInsideOutShouldExist(root, mNextFocusRightId); 5880 case FOCUS_UP: 5881 if (mNextFocusUpId == View.NO_ID) return null; 5882 return findViewInsideOutShouldExist(root, mNextFocusUpId); 5883 case FOCUS_DOWN: 5884 if (mNextFocusDownId == View.NO_ID) return null; 5885 return findViewInsideOutShouldExist(root, mNextFocusDownId); 5886 case FOCUS_FORWARD: 5887 if (mNextFocusForwardId == View.NO_ID) return null; 5888 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 5889 case FOCUS_BACKWARD: { 5890 if (mID == View.NO_ID) return null; 5891 final int id = mID; 5892 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 5893 @Override 5894 public boolean apply(View t) { 5895 return t.mNextFocusForwardId == id; 5896 } 5897 }); 5898 } 5899 } 5900 return null; 5901 } 5902 5903 private View findViewInsideOutShouldExist(View root, final int childViewId) { 5904 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() { 5905 @Override 5906 public boolean apply(View t) { 5907 return t.mID == childViewId; 5908 } 5909 }); 5910 5911 if (result == null) { 5912 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified " 5913 + "by user for id " + childViewId); 5914 } 5915 return result; 5916 } 5917 5918 /** 5919 * Find and return all focusable views that are descendants of this view, 5920 * possibly including this view if it is focusable itself. 5921 * 5922 * @param direction The direction of the focus 5923 * @return A list of focusable views 5924 */ 5925 public ArrayList<View> getFocusables(int direction) { 5926 ArrayList<View> result = new ArrayList<View>(24); 5927 addFocusables(result, direction); 5928 return result; 5929 } 5930 5931 /** 5932 * Add any focusable views that are descendants of this view (possibly 5933 * including this view if it is focusable itself) to views. If we are in touch mode, 5934 * only add views that are also focusable in touch mode. 5935 * 5936 * @param views Focusable views found so far 5937 * @param direction The direction of the focus 5938 */ 5939 public void addFocusables(ArrayList<View> views, int direction) { 5940 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 5941 } 5942 5943 /** 5944 * Adds any focusable views that are descendants of this view (possibly 5945 * including this view if it is focusable itself) to views. This method 5946 * adds all focusable views regardless if we are in touch mode or 5947 * only views focusable in touch mode if we are in touch mode or 5948 * only views that can take accessibility focus if accessibility is enabeld 5949 * depending on the focusable mode paramater. 5950 * 5951 * @param views Focusable views found so far or null if all we are interested is 5952 * the number of focusables. 5953 * @param direction The direction of the focus. 5954 * @param focusableMode The type of focusables to be added. 5955 * 5956 * @see #FOCUSABLES_ALL 5957 * @see #FOCUSABLES_TOUCH_MODE 5958 */ 5959 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) { 5960 if (views == null) { 5961 return; 5962 } 5963 if ((focusableMode & FOCUSABLES_ACCESSIBILITY) == FOCUSABLES_ACCESSIBILITY) { 5964 if (AccessibilityManager.getInstance(mContext).isEnabled() 5965 && includeForAccessibility()) { 5966 views.add(this); 5967 return; 5968 } 5969 } 5970 if (!isFocusable()) { 5971 return; 5972 } 5973 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE 5974 && isInTouchMode() && !isFocusableInTouchMode()) { 5975 return; 5976 } 5977 views.add(this); 5978 } 5979 5980 /** 5981 * Finds the Views that contain given text. The containment is case insensitive. 5982 * The search is performed by either the text that the View renders or the content 5983 * description that describes the view for accessibility purposes and the view does 5984 * not render or both. Clients can specify how the search is to be performed via 5985 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 5986 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 5987 * 5988 * @param outViews The output list of matching Views. 5989 * @param searched The text to match against. 5990 * 5991 * @see #FIND_VIEWS_WITH_TEXT 5992 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 5993 * @see #setContentDescription(CharSequence) 5994 */ 5995 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) { 5996 if (getAccessibilityNodeProvider() != null) { 5997 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 5998 outViews.add(this); 5999 } 6000 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 6001 && (searched != null && searched.length() > 0) 6002 && (mContentDescription != null && mContentDescription.length() > 0)) { 6003 String searchedLowerCase = searched.toString().toLowerCase(); 6004 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 6005 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 6006 outViews.add(this); 6007 } 6008 } 6009 } 6010 6011 /** 6012 * Find and return all touchable views that are descendants of this view, 6013 * possibly including this view if it is touchable itself. 6014 * 6015 * @return A list of touchable views 6016 */ 6017 public ArrayList<View> getTouchables() { 6018 ArrayList<View> result = new ArrayList<View>(); 6019 addTouchables(result); 6020 return result; 6021 } 6022 6023 /** 6024 * Add any touchable views that are descendants of this view (possibly 6025 * including this view if it is touchable itself) to views. 6026 * 6027 * @param views Touchable views found so far 6028 */ 6029 public void addTouchables(ArrayList<View> views) { 6030 final int viewFlags = mViewFlags; 6031 6032 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 6033 && (viewFlags & ENABLED_MASK) == ENABLED) { 6034 views.add(this); 6035 } 6036 } 6037 6038 /** 6039 * Returns whether this View is accessibility focused. 6040 * 6041 * @return True if this View is accessibility focused. 6042 */ 6043 boolean isAccessibilityFocused() { 6044 return (mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0; 6045 } 6046 6047 /** 6048 * Call this to try to give accessibility focus to this view. 6049 * 6050 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()} 6051 * returns false or the view is no visible or the view already has accessibility 6052 * focus. 6053 * 6054 * See also {@link #focusSearch(int)}, which is what you call to say that you 6055 * have focus, and you want your parent to look for the next one. 6056 * 6057 * @return Whether this view actually took accessibility focus. 6058 * 6059 * @hide 6060 */ 6061 public boolean requestAccessibilityFocus() { 6062 AccessibilityManager manager = AccessibilityManager.getInstance(mContext); 6063 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) { 6064 return false; 6065 } 6066 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6067 return false; 6068 } 6069 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) == 0) { 6070 mPrivateFlags2 |= ACCESSIBILITY_FOCUSED; 6071 ViewRootImpl viewRootImpl = getViewRootImpl(); 6072 if (viewRootImpl != null) { 6073 viewRootImpl.setAccessibilityFocusedHost(this); 6074 } 6075 invalidate(); 6076 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED); 6077 notifyAccessibilityStateChanged(); 6078 // Try to give input focus to this view - not a descendant. 6079 requestFocusNoSearch(View.FOCUS_DOWN, null); 6080 return true; 6081 } 6082 return false; 6083 } 6084 6085 /** 6086 * Call this to try to clear accessibility focus of this view. 6087 * 6088 * See also {@link #focusSearch(int)}, which is what you call to say that you 6089 * have focus, and you want your parent to look for the next one. 6090 * 6091 * @hide 6092 */ 6093 public void clearAccessibilityFocus() { 6094 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) { 6095 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED; 6096 ViewRootImpl viewRootImpl = getViewRootImpl(); 6097 if (viewRootImpl != null) { 6098 viewRootImpl.setAccessibilityFocusedHost(null); 6099 } 6100 invalidate(); 6101 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED); 6102 notifyAccessibilityStateChanged(); 6103 6104 // Clear the text navigation state. 6105 setAccessibilityCursorPosition(-1); 6106 6107 // Try to move accessibility focus to the input focus. 6108 View rootView = getRootView(); 6109 if (rootView != null) { 6110 View inputFocus = rootView.findFocus(); 6111 if (inputFocus != null) { 6112 inputFocus.requestAccessibilityFocus(); 6113 } 6114 } 6115 } 6116 } 6117 6118 /** 6119 * Find the best view to take accessibility focus from a hover. 6120 * This function finds the deepest actionable view and if that 6121 * fails ask the parent to take accessibility focus from hover. 6122 * 6123 * @param x The X hovered location in this view coorditantes. 6124 * @param y The Y hovered location in this view coorditantes. 6125 * @return Whether the request was handled. 6126 * 6127 * @hide 6128 */ 6129 public boolean requestAccessibilityFocusFromHover(float x, float y) { 6130 if (onRequestAccessibilityFocusFromHover(x, y)) { 6131 return true; 6132 } 6133 ViewParent parent = mParent; 6134 if (parent instanceof View) { 6135 View parentView = (View) parent; 6136 6137 float[] position = mAttachInfo.mTmpTransformLocation; 6138 position[0] = x; 6139 position[1] = y; 6140 6141 // Compensate for the transformation of the current matrix. 6142 if (!hasIdentityMatrix()) { 6143 getMatrix().mapPoints(position); 6144 } 6145 6146 // Compensate for the parent scroll and the offset 6147 // of this view stop from the parent top. 6148 position[0] += mLeft - parentView.mScrollX; 6149 position[1] += mTop - parentView.mScrollY; 6150 6151 return parentView.requestAccessibilityFocusFromHover(position[0], position[1]); 6152 } 6153 return false; 6154 } 6155 6156 /** 6157 * Requests to give this View focus from hover. 6158 * 6159 * @param x The X hovered location in this view coorditantes. 6160 * @param y The Y hovered location in this view coorditantes. 6161 * @return Whether the request was handled. 6162 * 6163 * @hide 6164 */ 6165 public boolean onRequestAccessibilityFocusFromHover(float x, float y) { 6166 if (includeForAccessibility() 6167 && (isActionableForAccessibility() || hasListenersForAccessibility())) { 6168 return requestAccessibilityFocus(); 6169 } 6170 return false; 6171 } 6172 6173 /** 6174 * Clears accessibility focus without calling any callback methods 6175 * normally invoked in {@link #clearAccessibilityFocus()}. This method 6176 * is used for clearing accessibility focus when giving this focus to 6177 * another view. 6178 */ 6179 void clearAccessibilityFocusNoCallbacks() { 6180 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) { 6181 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED; 6182 invalidate(); 6183 } 6184 } 6185 6186 /** 6187 * Call this to try to give focus to a specific view or to one of its 6188 * descendants. 6189 * 6190 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 6191 * false), or if it is focusable and it is not focusable in touch mode 6192 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 6193 * 6194 * See also {@link #focusSearch(int)}, which is what you call to say that you 6195 * have focus, and you want your parent to look for the next one. 6196 * 6197 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 6198 * {@link #FOCUS_DOWN} and <code>null</code>. 6199 * 6200 * @return Whether this view or one of its descendants actually took focus. 6201 */ 6202 public final boolean requestFocus() { 6203 return requestFocus(View.FOCUS_DOWN); 6204 } 6205 6206 /** 6207 * Call this to try to give focus to a specific view or to one of its 6208 * descendants and give it a hint about what direction focus is heading. 6209 * 6210 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 6211 * false), or if it is focusable and it is not focusable in touch mode 6212 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 6213 * 6214 * See also {@link #focusSearch(int)}, which is what you call to say that you 6215 * have focus, and you want your parent to look for the next one. 6216 * 6217 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 6218 * <code>null</code> set for the previously focused rectangle. 6219 * 6220 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 6221 * @return Whether this view or one of its descendants actually took focus. 6222 */ 6223 public final boolean requestFocus(int direction) { 6224 return requestFocus(direction, null); 6225 } 6226 6227 /** 6228 * Call this to try to give focus to a specific view or to one of its descendants 6229 * and give it hints about the direction and a specific rectangle that the focus 6230 * is coming from. The rectangle can help give larger views a finer grained hint 6231 * about where focus is coming from, and therefore, where to show selection, or 6232 * forward focus change internally. 6233 * 6234 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 6235 * false), or if it is focusable and it is not focusable in touch mode 6236 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 6237 * 6238 * A View will not take focus if it is not visible. 6239 * 6240 * A View will not take focus if one of its parents has 6241 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 6242 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 6243 * 6244 * See also {@link #focusSearch(int)}, which is what you call to say that you 6245 * have focus, and you want your parent to look for the next one. 6246 * 6247 * You may wish to override this method if your custom {@link View} has an internal 6248 * {@link View} that it wishes to forward the request to. 6249 * 6250 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 6251 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 6252 * to give a finer grained hint about where focus is coming from. May be null 6253 * if there is no hint. 6254 * @return Whether this view or one of its descendants actually took focus. 6255 */ 6256 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 6257 return requestFocusNoSearch(direction, previouslyFocusedRect); 6258 } 6259 6260 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) { 6261 // need to be focusable 6262 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 6263 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 6264 return false; 6265 } 6266 6267 // need to be focusable in touch mode if in touch mode 6268 if (isInTouchMode() && 6269 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 6270 return false; 6271 } 6272 6273 // need to not have any parents blocking us 6274 if (hasAncestorThatBlocksDescendantFocus()) { 6275 return false; 6276 } 6277 6278 handleFocusGainInternal(direction, previouslyFocusedRect); 6279 return true; 6280 } 6281 6282 /** 6283 * Call this to try to give focus to a specific view or to one of its descendants. This is a 6284 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 6285 * touch mode to request focus when they are touched. 6286 * 6287 * @return Whether this view or one of its descendants actually took focus. 6288 * 6289 * @see #isInTouchMode() 6290 * 6291 */ 6292 public final boolean requestFocusFromTouch() { 6293 // Leave touch mode if we need to 6294 if (isInTouchMode()) { 6295 ViewRootImpl viewRoot = getViewRootImpl(); 6296 if (viewRoot != null) { 6297 viewRoot.ensureTouchMode(false); 6298 } 6299 } 6300 return requestFocus(View.FOCUS_DOWN); 6301 } 6302 6303 /** 6304 * @return Whether any ancestor of this view blocks descendant focus. 6305 */ 6306 private boolean hasAncestorThatBlocksDescendantFocus() { 6307 ViewParent ancestor = mParent; 6308 while (ancestor instanceof ViewGroup) { 6309 final ViewGroup vgAncestor = (ViewGroup) ancestor; 6310 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) { 6311 return true; 6312 } else { 6313 ancestor = vgAncestor.getParent(); 6314 } 6315 } 6316 return false; 6317 } 6318 6319 /** 6320 * Gets the mode for determining whether this View is important for accessibility 6321 * which is if it fires accessibility events and if it is reported to 6322 * accessibility services that query the screen. 6323 * 6324 * @return The mode for determining whether a View is important for accessibility. 6325 * 6326 * @attr ref android.R.styleable#View_importantForAccessibility 6327 * 6328 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 6329 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 6330 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 6331 */ 6332 @ViewDebug.ExportedProperty(category = "accessibility", mapping = { 6333 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO, 6334 to = "IMPORTANT_FOR_ACCESSIBILITY_AUTO"), 6335 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES, 6336 to = "IMPORTANT_FOR_ACCESSIBILITY_YES"), 6337 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO, 6338 to = "IMPORTANT_FOR_ACCESSIBILITY_NO") 6339 }) 6340 public int getImportantForAccessibility() { 6341 return (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK) 6342 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 6343 } 6344 6345 /** 6346 * Sets how to determine whether this view is important for accessibility 6347 * which is if it fires accessibility events and if it is reported to 6348 * accessibility services that query the screen. 6349 * 6350 * @param mode How to determine whether this view is important for accessibility. 6351 * 6352 * @attr ref android.R.styleable#View_importantForAccessibility 6353 * 6354 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES 6355 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO 6356 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO 6357 */ 6358 public void setImportantForAccessibility(int mode) { 6359 if (mode != getImportantForAccessibility()) { 6360 mPrivateFlags2 &= ~IMPORTANT_FOR_ACCESSIBILITY_MASK; 6361 mPrivateFlags2 |= (mode << IMPORTANT_FOR_ACCESSIBILITY_SHIFT) 6362 & IMPORTANT_FOR_ACCESSIBILITY_MASK; 6363 notifyAccessibilityStateChanged(); 6364 } 6365 } 6366 6367 /** 6368 * Gets whether this view should be exposed for accessibility. 6369 * 6370 * @return Whether the view is exposed for accessibility. 6371 * 6372 * @hide 6373 */ 6374 public boolean isImportantForAccessibility() { 6375 final int mode = (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK) 6376 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT; 6377 switch (mode) { 6378 case IMPORTANT_FOR_ACCESSIBILITY_YES: 6379 return true; 6380 case IMPORTANT_FOR_ACCESSIBILITY_NO: 6381 return false; 6382 case IMPORTANT_FOR_ACCESSIBILITY_AUTO: 6383 return isActionableForAccessibility() || hasListenersForAccessibility(); 6384 default: 6385 throw new IllegalArgumentException("Unknow important for accessibility mode: " 6386 + mode); 6387 } 6388 } 6389 6390 /** 6391 * Gets the parent for accessibility purposes. Note that the parent for 6392 * accessibility is not necessary the immediate parent. It is the first 6393 * predecessor that is important for accessibility. 6394 * 6395 * @return The parent for accessibility purposes. 6396 */ 6397 public ViewParent getParentForAccessibility() { 6398 if (mParent instanceof View) { 6399 View parentView = (View) mParent; 6400 if (parentView.includeForAccessibility()) { 6401 return mParent; 6402 } else { 6403 return mParent.getParentForAccessibility(); 6404 } 6405 } 6406 return null; 6407 } 6408 6409 /** 6410 * Adds the children of a given View for accessibility. Since some Views are 6411 * not important for accessibility the children for accessibility are not 6412 * necessarily direct children of the riew, rather they are the first level of 6413 * descendants important for accessibility. 6414 * 6415 * @param children The list of children for accessibility. 6416 */ 6417 public void addChildrenForAccessibility(ArrayList<View> children) { 6418 if (includeForAccessibility()) { 6419 children.add(this); 6420 } 6421 } 6422 6423 /** 6424 * Whether to regard this view for accessibility. A view is regarded for 6425 * accessibility if it is important for accessibility or the querying 6426 * accessibility service has explicitly requested that view not 6427 * important for accessibility are regarded. 6428 * 6429 * @return Whether to regard the view for accessibility. 6430 */ 6431 boolean includeForAccessibility() { 6432 if (mAttachInfo != null) { 6433 if (!mAttachInfo.mIncludeNotImportantViews) { 6434 return isImportantForAccessibility(); 6435 } else { 6436 return true; 6437 } 6438 } 6439 return false; 6440 } 6441 6442 /** 6443 * Returns whether the View is considered actionable from 6444 * accessibility perspective. Such view are important for 6445 * accessiiblity. 6446 * 6447 * @return True if the view is actionable for accessibility. 6448 */ 6449 private boolean isActionableForAccessibility() { 6450 return (isClickable() || isLongClickable() || isFocusable()); 6451 } 6452 6453 /** 6454 * Returns whether the View has registered callbacks wich makes it 6455 * important for accessiiblity. 6456 * 6457 * @return True if the view is actionable for accessibility. 6458 */ 6459 private boolean hasListenersForAccessibility() { 6460 ListenerInfo info = getListenerInfo(); 6461 return mTouchDelegate != null || info.mOnKeyListener != null 6462 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null 6463 || info.mOnHoverListener != null || info.mOnDragListener != null; 6464 } 6465 6466 /** 6467 * Notifies accessibility services that some view's important for 6468 * accessibility state has changed. Note that such notifications 6469 * are made at most once every 6470 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()} 6471 * to avoid unnecessary load to the system. Also once a view has 6472 * made a notifucation this method is a NOP until the notification has 6473 * been sent to clients. 6474 * 6475 * @hide 6476 * 6477 * TODO: Makse sure this method is called for any view state change 6478 * that is interesting for accessilility purposes. 6479 */ 6480 public void notifyAccessibilityStateChanged() { 6481 if ((mPrivateFlags2 & ACCESSIBILITY_STATE_CHANGED) == 0) { 6482 mPrivateFlags2 |= ACCESSIBILITY_STATE_CHANGED; 6483 if (mParent != null) { 6484 mParent.childAccessibilityStateChanged(this); 6485 } 6486 } 6487 } 6488 6489 /** 6490 * Reset the state indicating the this view has requested clients 6491 * interested in its accessiblity state to be notified. 6492 * 6493 * @hide 6494 */ 6495 public void resetAccessibilityStateChanged() { 6496 mPrivateFlags2 &= ~ACCESSIBILITY_STATE_CHANGED; 6497 } 6498 6499 /** 6500 * Performs the specified accessibility action on the view. For 6501 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 6502 * <p> 6503 * If an {@link AccessibilityDelegate} has been specified via calling 6504 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 6505 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)} 6506 * is responsible for handling this call. 6507 * </p> 6508 * 6509 * @param action The action to perform. 6510 * @param arguments Optional action arguments. 6511 * @return Whether the action was performed. 6512 */ 6513 public boolean performAccessibilityAction(int action, Bundle arguments) { 6514 if (mAccessibilityDelegate != null) { 6515 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments); 6516 } else { 6517 return performAccessibilityActionInternal(action, arguments); 6518 } 6519 } 6520 6521 /** 6522 * @see #performAccessibilityAction(int, Bundle) 6523 * 6524 * Note: Called from the default {@link AccessibilityDelegate}. 6525 */ 6526 boolean performAccessibilityActionInternal(int action, Bundle arguments) { 6527 switch (action) { 6528 case AccessibilityNodeInfo.ACTION_CLICK: { 6529 if (isClickable()) { 6530 return performClick(); 6531 } 6532 } break; 6533 case AccessibilityNodeInfo.ACTION_LONG_CLICK: { 6534 if (isLongClickable()) { 6535 return performLongClick(); 6536 } 6537 } break; 6538 case AccessibilityNodeInfo.ACTION_FOCUS: { 6539 if (!hasFocus()) { 6540 // Get out of touch mode since accessibility 6541 // wants to move focus around. 6542 getViewRootImpl().ensureTouchMode(false); 6543 return requestFocus(); 6544 } 6545 } break; 6546 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: { 6547 if (hasFocus()) { 6548 clearFocus(); 6549 return !isFocused(); 6550 } 6551 } break; 6552 case AccessibilityNodeInfo.ACTION_SELECT: { 6553 if (!isSelected()) { 6554 setSelected(true); 6555 return isSelected(); 6556 } 6557 } break; 6558 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: { 6559 if (isSelected()) { 6560 setSelected(false); 6561 return !isSelected(); 6562 } 6563 } break; 6564 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: { 6565 if (!isAccessibilityFocused()) { 6566 return requestAccessibilityFocus(); 6567 } 6568 } break; 6569 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: { 6570 if (isAccessibilityFocused()) { 6571 clearAccessibilityFocus(); 6572 return true; 6573 } 6574 } break; 6575 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: { 6576 if (arguments != null) { 6577 final int granularity = arguments.getInt( 6578 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 6579 return nextAtGranularity(granularity); 6580 } 6581 } break; 6582 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: { 6583 if (arguments != null) { 6584 final int granularity = arguments.getInt( 6585 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT); 6586 return previousAtGranularity(granularity); 6587 } 6588 } break; 6589 } 6590 return false; 6591 } 6592 6593 private boolean nextAtGranularity(int granularity) { 6594 CharSequence text = getIterableTextForAccessibility(); 6595 if (text != null && text.length() > 0) { 6596 return false; 6597 } 6598 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 6599 if (iterator == null) { 6600 return false; 6601 } 6602 final int current = getAccessibilityCursorPosition(); 6603 final int[] range = iterator.following(current); 6604 if (range == null) { 6605 setAccessibilityCursorPosition(-1); 6606 return false; 6607 } 6608 final int start = range[0]; 6609 final int end = range[1]; 6610 setAccessibilityCursorPosition(start); 6611 sendViewTextTraversedAtGranularityEvent( 6612 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY, 6613 granularity, start, end); 6614 return true; 6615 } 6616 6617 private boolean previousAtGranularity(int granularity) { 6618 CharSequence text = getIterableTextForAccessibility(); 6619 if (text != null && text.length() > 0) { 6620 return false; 6621 } 6622 TextSegmentIterator iterator = getIteratorForGranularity(granularity); 6623 if (iterator == null) { 6624 return false; 6625 } 6626 final int selectionStart = getAccessibilityCursorPosition(); 6627 final int current = selectionStart >= 0 ? selectionStart : text.length() + 1; 6628 final int[] range = iterator.preceding(current); 6629 if (range == null) { 6630 setAccessibilityCursorPosition(-1); 6631 return false; 6632 } 6633 final int start = range[0]; 6634 final int end = range[1]; 6635 setAccessibilityCursorPosition(end); 6636 sendViewTextTraversedAtGranularityEvent( 6637 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY, 6638 granularity, start, end); 6639 return true; 6640 } 6641 6642 /** 6643 * Gets the text reported for accessibility purposes. 6644 * 6645 * @return The accessibility text. 6646 * 6647 * @hide 6648 */ 6649 public CharSequence getIterableTextForAccessibility() { 6650 return mContentDescription; 6651 } 6652 6653 /** 6654 * @hide 6655 */ 6656 public int getAccessibilityCursorPosition() { 6657 return mAccessibilityCursorPosition; 6658 } 6659 6660 /** 6661 * @hide 6662 */ 6663 public void setAccessibilityCursorPosition(int position) { 6664 mAccessibilityCursorPosition = position; 6665 } 6666 6667 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity, 6668 int fromIndex, int toIndex) { 6669 if (mParent == null) { 6670 return; 6671 } 6672 AccessibilityEvent event = AccessibilityEvent.obtain( 6673 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY); 6674 onInitializeAccessibilityEvent(event); 6675 onPopulateAccessibilityEvent(event); 6676 event.setFromIndex(fromIndex); 6677 event.setToIndex(toIndex); 6678 event.setAction(action); 6679 event.setMovementGranularity(granularity); 6680 mParent.requestSendAccessibilityEvent(this, event); 6681 } 6682 6683 /** 6684 * @hide 6685 */ 6686 public TextSegmentIterator getIteratorForGranularity(int granularity) { 6687 switch (granularity) { 6688 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: { 6689 CharSequence text = getIterableTextForAccessibility(); 6690 if (text != null && text.length() > 0) { 6691 CharacterTextSegmentIterator iterator = 6692 CharacterTextSegmentIterator.getInstance(mContext); 6693 iterator.initialize(text.toString()); 6694 return iterator; 6695 } 6696 } break; 6697 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: { 6698 CharSequence text = getIterableTextForAccessibility(); 6699 if (text != null && text.length() > 0) { 6700 WordTextSegmentIterator iterator = 6701 WordTextSegmentIterator.getInstance(mContext); 6702 iterator.initialize(text.toString()); 6703 return iterator; 6704 } 6705 } break; 6706 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: { 6707 CharSequence text = getIterableTextForAccessibility(); 6708 if (text != null && text.length() > 0) { 6709 ParagraphTextSegmentIterator iterator = 6710 ParagraphTextSegmentIterator.getInstance(); 6711 iterator.initialize(text.toString()); 6712 return iterator; 6713 } 6714 } break; 6715 } 6716 return null; 6717 } 6718 6719 /** 6720 * @hide 6721 */ 6722 public void dispatchStartTemporaryDetach() { 6723 clearAccessibilityFocus(); 6724 onStartTemporaryDetach(); 6725 } 6726 6727 /** 6728 * This is called when a container is going to temporarily detach a child, with 6729 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 6730 * It will either be followed by {@link #onFinishTemporaryDetach()} or 6731 * {@link #onDetachedFromWindow()} when the container is done. 6732 */ 6733 public void onStartTemporaryDetach() { 6734 removeUnsetPressCallback(); 6735 mPrivateFlags |= CANCEL_NEXT_UP_EVENT; 6736 } 6737 6738 /** 6739 * @hide 6740 */ 6741 public void dispatchFinishTemporaryDetach() { 6742 onFinishTemporaryDetach(); 6743 } 6744 6745 /** 6746 * Called after {@link #onStartTemporaryDetach} when the container is done 6747 * changing the view. 6748 */ 6749 public void onFinishTemporaryDetach() { 6750 } 6751 6752 /** 6753 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 6754 * for this view's window. Returns null if the view is not currently attached 6755 * to the window. Normally you will not need to use this directly, but 6756 * just use the standard high-level event callbacks like 6757 * {@link #onKeyDown(int, KeyEvent)}. 6758 */ 6759 public KeyEvent.DispatcherState getKeyDispatcherState() { 6760 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 6761 } 6762 6763 /** 6764 * Dispatch a key event before it is processed by any input method 6765 * associated with the view hierarchy. This can be used to intercept 6766 * key events in special situations before the IME consumes them; a 6767 * typical example would be handling the BACK key to update the application's 6768 * UI instead of allowing the IME to see it and close itself. 6769 * 6770 * @param event The key event to be dispatched. 6771 * @return True if the event was handled, false otherwise. 6772 */ 6773 public boolean dispatchKeyEventPreIme(KeyEvent event) { 6774 return onKeyPreIme(event.getKeyCode(), event); 6775 } 6776 6777 /** 6778 * Dispatch a key event to the next view on the focus path. This path runs 6779 * from the top of the view tree down to the currently focused view. If this 6780 * view has focus, it will dispatch to itself. Otherwise it will dispatch 6781 * the next node down the focus path. This method also fires any key 6782 * listeners. 6783 * 6784 * @param event The key event to be dispatched. 6785 * @return True if the event was handled, false otherwise. 6786 */ 6787 public boolean dispatchKeyEvent(KeyEvent event) { 6788 if (mInputEventConsistencyVerifier != null) { 6789 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 6790 } 6791 6792 // Give any attached key listener a first crack at the event. 6793 //noinspection SimplifiableIfStatement 6794 ListenerInfo li = mListenerInfo; 6795 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 6796 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 6797 return true; 6798 } 6799 6800 if (event.dispatch(this, mAttachInfo != null 6801 ? mAttachInfo.mKeyDispatchState : null, this)) { 6802 return true; 6803 } 6804 6805 if (mInputEventConsistencyVerifier != null) { 6806 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 6807 } 6808 return false; 6809 } 6810 6811 /** 6812 * Dispatches a key shortcut event. 6813 * 6814 * @param event The key event to be dispatched. 6815 * @return True if the event was handled by the view, false otherwise. 6816 */ 6817 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 6818 return onKeyShortcut(event.getKeyCode(), event); 6819 } 6820 6821 /** 6822 * Pass the touch screen motion event down to the target view, or this 6823 * view if it is the target. 6824 * 6825 * @param event The motion event to be dispatched. 6826 * @return True if the event was handled by the view, false otherwise. 6827 */ 6828 public boolean dispatchTouchEvent(MotionEvent event) { 6829 if (mInputEventConsistencyVerifier != null) { 6830 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 6831 } 6832 6833 if (onFilterTouchEventForSecurity(event)) { 6834 //noinspection SimplifiableIfStatement 6835 ListenerInfo li = mListenerInfo; 6836 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 6837 && li.mOnTouchListener.onTouch(this, event)) { 6838 return true; 6839 } 6840 6841 if (onTouchEvent(event)) { 6842 return true; 6843 } 6844 } 6845 6846 if (mInputEventConsistencyVerifier != null) { 6847 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 6848 } 6849 return false; 6850 } 6851 6852 /** 6853 * Filter the touch event to apply security policies. 6854 * 6855 * @param event The motion event to be filtered. 6856 * @return True if the event should be dispatched, false if the event should be dropped. 6857 * 6858 * @see #getFilterTouchesWhenObscured 6859 */ 6860 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 6861 //noinspection RedundantIfStatement 6862 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 6863 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 6864 // Window is obscured, drop this touch. 6865 return false; 6866 } 6867 return true; 6868 } 6869 6870 /** 6871 * Pass a trackball motion event down to the focused view. 6872 * 6873 * @param event The motion event to be dispatched. 6874 * @return True if the event was handled by the view, false otherwise. 6875 */ 6876 public boolean dispatchTrackballEvent(MotionEvent event) { 6877 if (mInputEventConsistencyVerifier != null) { 6878 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 6879 } 6880 6881 return onTrackballEvent(event); 6882 } 6883 6884 /** 6885 * Dispatch a generic motion event. 6886 * <p> 6887 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 6888 * are delivered to the view under the pointer. All other generic motion events are 6889 * delivered to the focused view. Hover events are handled specially and are delivered 6890 * to {@link #onHoverEvent(MotionEvent)}. 6891 * </p> 6892 * 6893 * @param event The motion event to be dispatched. 6894 * @return True if the event was handled by the view, false otherwise. 6895 */ 6896 public boolean dispatchGenericMotionEvent(MotionEvent event) { 6897 if (mInputEventConsistencyVerifier != null) { 6898 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 6899 } 6900 6901 final int source = event.getSource(); 6902 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 6903 final int action = event.getAction(); 6904 if (action == MotionEvent.ACTION_HOVER_ENTER 6905 || action == MotionEvent.ACTION_HOVER_MOVE 6906 || action == MotionEvent.ACTION_HOVER_EXIT) { 6907 if (dispatchHoverEvent(event)) { 6908 return true; 6909 } 6910 } else if (dispatchGenericPointerEvent(event)) { 6911 return true; 6912 } 6913 } else if (dispatchGenericFocusedEvent(event)) { 6914 return true; 6915 } 6916 6917 if (dispatchGenericMotionEventInternal(event)) { 6918 return true; 6919 } 6920 6921 if (mInputEventConsistencyVerifier != null) { 6922 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 6923 } 6924 return false; 6925 } 6926 6927 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 6928 //noinspection SimplifiableIfStatement 6929 ListenerInfo li = mListenerInfo; 6930 if (li != null && li.mOnGenericMotionListener != null 6931 && (mViewFlags & ENABLED_MASK) == ENABLED 6932 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 6933 return true; 6934 } 6935 6936 if (onGenericMotionEvent(event)) { 6937 return true; 6938 } 6939 6940 if (mInputEventConsistencyVerifier != null) { 6941 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 6942 } 6943 return false; 6944 } 6945 6946 /** 6947 * Dispatch a hover event. 6948 * <p> 6949 * Do not call this method directly. 6950 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 6951 * </p> 6952 * 6953 * @param event The motion event to be dispatched. 6954 * @return True if the event was handled by the view, false otherwise. 6955 */ 6956 protected boolean dispatchHoverEvent(MotionEvent event) { 6957 //noinspection SimplifiableIfStatement 6958 ListenerInfo li = mListenerInfo; 6959 if (li != null && li.mOnHoverListener != null 6960 && (mViewFlags & ENABLED_MASK) == ENABLED 6961 && li.mOnHoverListener.onHover(this, event)) { 6962 return true; 6963 } 6964 6965 return onHoverEvent(event); 6966 } 6967 6968 /** 6969 * Returns true if the view has a child to which it has recently sent 6970 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 6971 * it does not have a hovered child, then it must be the innermost hovered view. 6972 * @hide 6973 */ 6974 protected boolean hasHoveredChild() { 6975 return false; 6976 } 6977 6978 /** 6979 * Dispatch a generic motion event to the view under the first pointer. 6980 * <p> 6981 * Do not call this method directly. 6982 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 6983 * </p> 6984 * 6985 * @param event The motion event to be dispatched. 6986 * @return True if the event was handled by the view, false otherwise. 6987 */ 6988 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 6989 return false; 6990 } 6991 6992 /** 6993 * Dispatch a generic motion event to the currently focused view. 6994 * <p> 6995 * Do not call this method directly. 6996 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 6997 * </p> 6998 * 6999 * @param event The motion event to be dispatched. 7000 * @return True if the event was handled by the view, false otherwise. 7001 */ 7002 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 7003 return false; 7004 } 7005 7006 /** 7007 * Dispatch a pointer event. 7008 * <p> 7009 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 7010 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 7011 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 7012 * and should not be expected to handle other pointing device features. 7013 * </p> 7014 * 7015 * @param event The motion event to be dispatched. 7016 * @return True if the event was handled by the view, false otherwise. 7017 * @hide 7018 */ 7019 public final boolean dispatchPointerEvent(MotionEvent event) { 7020 if (event.isTouchEvent()) { 7021 return dispatchTouchEvent(event); 7022 } else { 7023 return dispatchGenericMotionEvent(event); 7024 } 7025 } 7026 7027 /** 7028 * Called when the window containing this view gains or loses window focus. 7029 * ViewGroups should override to route to their children. 7030 * 7031 * @param hasFocus True if the window containing this view now has focus, 7032 * false otherwise. 7033 */ 7034 public void dispatchWindowFocusChanged(boolean hasFocus) { 7035 onWindowFocusChanged(hasFocus); 7036 } 7037 7038 /** 7039 * Called when the window containing this view gains or loses focus. Note 7040 * that this is separate from view focus: to receive key events, both 7041 * your view and its window must have focus. If a window is displayed 7042 * on top of yours that takes input focus, then your own window will lose 7043 * focus but the view focus will remain unchanged. 7044 * 7045 * @param hasWindowFocus True if the window containing this view now has 7046 * focus, false otherwise. 7047 */ 7048 public void onWindowFocusChanged(boolean hasWindowFocus) { 7049 InputMethodManager imm = InputMethodManager.peekInstance(); 7050 if (!hasWindowFocus) { 7051 if (isPressed()) { 7052 setPressed(false); 7053 } 7054 if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 7055 imm.focusOut(this); 7056 } 7057 removeLongPressCallback(); 7058 removeTapCallback(); 7059 onFocusLost(); 7060 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 7061 imm.focusIn(this); 7062 } 7063 refreshDrawableState(); 7064 } 7065 7066 /** 7067 * Returns true if this view is in a window that currently has window focus. 7068 * Note that this is not the same as the view itself having focus. 7069 * 7070 * @return True if this view is in a window that currently has window focus. 7071 */ 7072 public boolean hasWindowFocus() { 7073 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 7074 } 7075 7076 /** 7077 * Dispatch a view visibility change down the view hierarchy. 7078 * ViewGroups should override to route to their children. 7079 * @param changedView The view whose visibility changed. Could be 'this' or 7080 * an ancestor view. 7081 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 7082 * {@link #INVISIBLE} or {@link #GONE}. 7083 */ 7084 protected void dispatchVisibilityChanged(View changedView, int visibility) { 7085 onVisibilityChanged(changedView, visibility); 7086 } 7087 7088 /** 7089 * Called when the visibility of the view or an ancestor of the view is changed. 7090 * @param changedView The view whose visibility changed. Could be 'this' or 7091 * an ancestor view. 7092 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 7093 * {@link #INVISIBLE} or {@link #GONE}. 7094 */ 7095 protected void onVisibilityChanged(View changedView, int visibility) { 7096 if (visibility == VISIBLE) { 7097 if (mAttachInfo != null) { 7098 initialAwakenScrollBars(); 7099 } else { 7100 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH; 7101 } 7102 } 7103 } 7104 7105 /** 7106 * Dispatch a hint about whether this view is displayed. For instance, when 7107 * a View moves out of the screen, it might receives a display hint indicating 7108 * the view is not displayed. Applications should not <em>rely</em> on this hint 7109 * as there is no guarantee that they will receive one. 7110 * 7111 * @param hint A hint about whether or not this view is displayed: 7112 * {@link #VISIBLE} or {@link #INVISIBLE}. 7113 */ 7114 public void dispatchDisplayHint(int hint) { 7115 onDisplayHint(hint); 7116 } 7117 7118 /** 7119 * Gives this view a hint about whether is displayed or not. For instance, when 7120 * a View moves out of the screen, it might receives a display hint indicating 7121 * the view is not displayed. Applications should not <em>rely</em> on this hint 7122 * as there is no guarantee that they will receive one. 7123 * 7124 * @param hint A hint about whether or not this view is displayed: 7125 * {@link #VISIBLE} or {@link #INVISIBLE}. 7126 */ 7127 protected void onDisplayHint(int hint) { 7128 } 7129 7130 /** 7131 * Dispatch a window visibility change down the view hierarchy. 7132 * ViewGroups should override to route to their children. 7133 * 7134 * @param visibility The new visibility of the window. 7135 * 7136 * @see #onWindowVisibilityChanged(int) 7137 */ 7138 public void dispatchWindowVisibilityChanged(int visibility) { 7139 onWindowVisibilityChanged(visibility); 7140 } 7141 7142 /** 7143 * Called when the window containing has change its visibility 7144 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 7145 * that this tells you whether or not your window is being made visible 7146 * to the window manager; this does <em>not</em> tell you whether or not 7147 * your window is obscured by other windows on the screen, even if it 7148 * is itself visible. 7149 * 7150 * @param visibility The new visibility of the window. 7151 */ 7152 protected void onWindowVisibilityChanged(int visibility) { 7153 if (visibility == VISIBLE) { 7154 initialAwakenScrollBars(); 7155 } 7156 } 7157 7158 /** 7159 * Returns the current visibility of the window this view is attached to 7160 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 7161 * 7162 * @return Returns the current visibility of the view's window. 7163 */ 7164 public int getWindowVisibility() { 7165 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 7166 } 7167 7168 /** 7169 * Retrieve the overall visible display size in which the window this view is 7170 * attached to has been positioned in. This takes into account screen 7171 * decorations above the window, for both cases where the window itself 7172 * is being position inside of them or the window is being placed under 7173 * then and covered insets are used for the window to position its content 7174 * inside. In effect, this tells you the available area where content can 7175 * be placed and remain visible to users. 7176 * 7177 * <p>This function requires an IPC back to the window manager to retrieve 7178 * the requested information, so should not be used in performance critical 7179 * code like drawing. 7180 * 7181 * @param outRect Filled in with the visible display frame. If the view 7182 * is not attached to a window, this is simply the raw display size. 7183 */ 7184 public void getWindowVisibleDisplayFrame(Rect outRect) { 7185 if (mAttachInfo != null) { 7186 try { 7187 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 7188 } catch (RemoteException e) { 7189 return; 7190 } 7191 // XXX This is really broken, and probably all needs to be done 7192 // in the window manager, and we need to know more about whether 7193 // we want the area behind or in front of the IME. 7194 final Rect insets = mAttachInfo.mVisibleInsets; 7195 outRect.left += insets.left; 7196 outRect.top += insets.top; 7197 outRect.right -= insets.right; 7198 outRect.bottom -= insets.bottom; 7199 return; 7200 } 7201 Display d = WindowManagerImpl.getDefault().getDefaultDisplay(); 7202 d.getRectSize(outRect); 7203 } 7204 7205 /** 7206 * Dispatch a notification about a resource configuration change down 7207 * the view hierarchy. 7208 * ViewGroups should override to route to their children. 7209 * 7210 * @param newConfig The new resource configuration. 7211 * 7212 * @see #onConfigurationChanged(android.content.res.Configuration) 7213 */ 7214 public void dispatchConfigurationChanged(Configuration newConfig) { 7215 onConfigurationChanged(newConfig); 7216 } 7217 7218 /** 7219 * Called when the current configuration of the resources being used 7220 * by the application have changed. You can use this to decide when 7221 * to reload resources that can changed based on orientation and other 7222 * configuration characterstics. You only need to use this if you are 7223 * not relying on the normal {@link android.app.Activity} mechanism of 7224 * recreating the activity instance upon a configuration change. 7225 * 7226 * @param newConfig The new resource configuration. 7227 */ 7228 protected void onConfigurationChanged(Configuration newConfig) { 7229 } 7230 7231 /** 7232 * Private function to aggregate all per-view attributes in to the view 7233 * root. 7234 */ 7235 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) { 7236 performCollectViewAttributes(attachInfo, visibility); 7237 } 7238 7239 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) { 7240 if ((visibility & VISIBILITY_MASK) == VISIBLE) { 7241 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 7242 attachInfo.mKeepScreenOn = true; 7243 } 7244 attachInfo.mSystemUiVisibility |= mSystemUiVisibility; 7245 ListenerInfo li = mListenerInfo; 7246 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 7247 attachInfo.mHasSystemUiListeners = true; 7248 } 7249 } 7250 } 7251 7252 void needGlobalAttributesUpdate(boolean force) { 7253 final AttachInfo ai = mAttachInfo; 7254 if (ai != null) { 7255 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 7256 || ai.mHasSystemUiListeners) { 7257 ai.mRecomputeGlobalAttributes = true; 7258 } 7259 } 7260 } 7261 7262 /** 7263 * Returns whether the device is currently in touch mode. Touch mode is entered 7264 * once the user begins interacting with the device by touch, and affects various 7265 * things like whether focus is always visible to the user. 7266 * 7267 * @return Whether the device is in touch mode. 7268 */ 7269 @ViewDebug.ExportedProperty 7270 public boolean isInTouchMode() { 7271 if (mAttachInfo != null) { 7272 return mAttachInfo.mInTouchMode; 7273 } else { 7274 return ViewRootImpl.isInTouchMode(); 7275 } 7276 } 7277 7278 /** 7279 * Returns the context the view is running in, through which it can 7280 * access the current theme, resources, etc. 7281 * 7282 * @return The view's Context. 7283 */ 7284 @ViewDebug.CapturedViewProperty 7285 public final Context getContext() { 7286 return mContext; 7287 } 7288 7289 /** 7290 * Handle a key event before it is processed by any input method 7291 * associated with the view hierarchy. This can be used to intercept 7292 * key events in special situations before the IME consumes them; a 7293 * typical example would be handling the BACK key to update the application's 7294 * UI instead of allowing the IME to see it and close itself. 7295 * 7296 * @param keyCode The value in event.getKeyCode(). 7297 * @param event Description of the key event. 7298 * @return If you handled the event, return true. If you want to allow the 7299 * event to be handled by the next receiver, return false. 7300 */ 7301 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 7302 return false; 7303 } 7304 7305 /** 7306 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 7307 * KeyEvent.Callback.onKeyDown()}: perform press of the view 7308 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 7309 * is released, if the view is enabled and clickable. 7310 * 7311 * @param keyCode A key code that represents the button pressed, from 7312 * {@link android.view.KeyEvent}. 7313 * @param event The KeyEvent object that defines the button action. 7314 */ 7315 public boolean onKeyDown(int keyCode, KeyEvent event) { 7316 boolean result = false; 7317 7318 switch (keyCode) { 7319 case KeyEvent.KEYCODE_DPAD_CENTER: 7320 case KeyEvent.KEYCODE_ENTER: { 7321 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 7322 return true; 7323 } 7324 // Long clickable items don't necessarily have to be clickable 7325 if (((mViewFlags & CLICKABLE) == CLICKABLE || 7326 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 7327 (event.getRepeatCount() == 0)) { 7328 setPressed(true); 7329 checkForLongClick(0); 7330 return true; 7331 } 7332 break; 7333 } 7334 } 7335 return result; 7336 } 7337 7338 /** 7339 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 7340 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 7341 * the event). 7342 */ 7343 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 7344 return false; 7345 } 7346 7347 /** 7348 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 7349 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 7350 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 7351 * {@link KeyEvent#KEYCODE_ENTER} is released. 7352 * 7353 * @param keyCode A key code that represents the button pressed, from 7354 * {@link android.view.KeyEvent}. 7355 * @param event The KeyEvent object that defines the button action. 7356 */ 7357 public boolean onKeyUp(int keyCode, KeyEvent event) { 7358 boolean result = false; 7359 7360 switch (keyCode) { 7361 case KeyEvent.KEYCODE_DPAD_CENTER: 7362 case KeyEvent.KEYCODE_ENTER: { 7363 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 7364 return true; 7365 } 7366 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 7367 setPressed(false); 7368 7369 if (!mHasPerformedLongPress) { 7370 // This is a tap, so remove the longpress check 7371 removeLongPressCallback(); 7372 7373 result = performClick(); 7374 } 7375 } 7376 break; 7377 } 7378 } 7379 return result; 7380 } 7381 7382 /** 7383 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 7384 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 7385 * the event). 7386 * 7387 * @param keyCode A key code that represents the button pressed, from 7388 * {@link android.view.KeyEvent}. 7389 * @param repeatCount The number of times the action was made. 7390 * @param event The KeyEvent object that defines the button action. 7391 */ 7392 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 7393 return false; 7394 } 7395 7396 /** 7397 * Called on the focused view when a key shortcut event is not handled. 7398 * Override this method to implement local key shortcuts for the View. 7399 * Key shortcuts can also be implemented by setting the 7400 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 7401 * 7402 * @param keyCode The value in event.getKeyCode(). 7403 * @param event Description of the key event. 7404 * @return If you handled the event, return true. If you want to allow the 7405 * event to be handled by the next receiver, return false. 7406 */ 7407 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 7408 return false; 7409 } 7410 7411 /** 7412 * Check whether the called view is a text editor, in which case it 7413 * would make sense to automatically display a soft input window for 7414 * it. Subclasses should override this if they implement 7415 * {@link #onCreateInputConnection(EditorInfo)} to return true if 7416 * a call on that method would return a non-null InputConnection, and 7417 * they are really a first-class editor that the user would normally 7418 * start typing on when the go into a window containing your view. 7419 * 7420 * <p>The default implementation always returns false. This does 7421 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 7422 * will not be called or the user can not otherwise perform edits on your 7423 * view; it is just a hint to the system that this is not the primary 7424 * purpose of this view. 7425 * 7426 * @return Returns true if this view is a text editor, else false. 7427 */ 7428 public boolean onCheckIsTextEditor() { 7429 return false; 7430 } 7431 7432 /** 7433 * Create a new InputConnection for an InputMethod to interact 7434 * with the view. The default implementation returns null, since it doesn't 7435 * support input methods. You can override this to implement such support. 7436 * This is only needed for views that take focus and text input. 7437 * 7438 * <p>When implementing this, you probably also want to implement 7439 * {@link #onCheckIsTextEditor()} to indicate you will return a 7440 * non-null InputConnection. 7441 * 7442 * @param outAttrs Fill in with attribute information about the connection. 7443 */ 7444 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 7445 return null; 7446 } 7447 7448 /** 7449 * Called by the {@link android.view.inputmethod.InputMethodManager} 7450 * when a view who is not the current 7451 * input connection target is trying to make a call on the manager. The 7452 * default implementation returns false; you can override this to return 7453 * true for certain views if you are performing InputConnection proxying 7454 * to them. 7455 * @param view The View that is making the InputMethodManager call. 7456 * @return Return true to allow the call, false to reject. 7457 */ 7458 public boolean checkInputConnectionProxy(View view) { 7459 return false; 7460 } 7461 7462 /** 7463 * Show the context menu for this view. It is not safe to hold on to the 7464 * menu after returning from this method. 7465 * 7466 * You should normally not overload this method. Overload 7467 * {@link #onCreateContextMenu(ContextMenu)} or define an 7468 * {@link OnCreateContextMenuListener} to add items to the context menu. 7469 * 7470 * @param menu The context menu to populate 7471 */ 7472 public void createContextMenu(ContextMenu menu) { 7473 ContextMenuInfo menuInfo = getContextMenuInfo(); 7474 7475 // Sets the current menu info so all items added to menu will have 7476 // my extra info set. 7477 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 7478 7479 onCreateContextMenu(menu); 7480 ListenerInfo li = mListenerInfo; 7481 if (li != null && li.mOnCreateContextMenuListener != null) { 7482 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 7483 } 7484 7485 // Clear the extra information so subsequent items that aren't mine don't 7486 // have my extra info. 7487 ((MenuBuilder)menu).setCurrentMenuInfo(null); 7488 7489 if (mParent != null) { 7490 mParent.createContextMenu(menu); 7491 } 7492 } 7493 7494 /** 7495 * Views should implement this if they have extra information to associate 7496 * with the context menu. The return result is supplied as a parameter to 7497 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 7498 * callback. 7499 * 7500 * @return Extra information about the item for which the context menu 7501 * should be shown. This information will vary across different 7502 * subclasses of View. 7503 */ 7504 protected ContextMenuInfo getContextMenuInfo() { 7505 return null; 7506 } 7507 7508 /** 7509 * Views should implement this if the view itself is going to add items to 7510 * the context menu. 7511 * 7512 * @param menu the context menu to populate 7513 */ 7514 protected void onCreateContextMenu(ContextMenu menu) { 7515 } 7516 7517 /** 7518 * Implement this method to handle trackball motion events. The 7519 * <em>relative</em> movement of the trackball since the last event 7520 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 7521 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 7522 * that a movement of 1 corresponds to the user pressing one DPAD key (so 7523 * they will often be fractional values, representing the more fine-grained 7524 * movement information available from a trackball). 7525 * 7526 * @param event The motion event. 7527 * @return True if the event was handled, false otherwise. 7528 */ 7529 public boolean onTrackballEvent(MotionEvent event) { 7530 return false; 7531 } 7532 7533 /** 7534 * Implement this method to handle generic motion events. 7535 * <p> 7536 * Generic motion events describe joystick movements, mouse hovers, track pad 7537 * touches, scroll wheel movements and other input events. The 7538 * {@link MotionEvent#getSource() source} of the motion event specifies 7539 * the class of input that was received. Implementations of this method 7540 * must examine the bits in the source before processing the event. 7541 * The following code example shows how this is done. 7542 * </p><p> 7543 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 7544 * are delivered to the view under the pointer. All other generic motion events are 7545 * delivered to the focused view. 7546 * </p> 7547 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 7548 * if ((event.getSource() & InputDevice.SOURCE_CLASS_JOYSTICK) != 0) { 7549 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 7550 * // process the joystick movement... 7551 * return true; 7552 * } 7553 * } 7554 * if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) { 7555 * switch (event.getAction()) { 7556 * case MotionEvent.ACTION_HOVER_MOVE: 7557 * // process the mouse hover movement... 7558 * return true; 7559 * case MotionEvent.ACTION_SCROLL: 7560 * // process the scroll wheel movement... 7561 * return true; 7562 * } 7563 * } 7564 * return super.onGenericMotionEvent(event); 7565 * }</pre> 7566 * 7567 * @param event The generic motion event being processed. 7568 * @return True if the event was handled, false otherwise. 7569 */ 7570 public boolean onGenericMotionEvent(MotionEvent event) { 7571 return false; 7572 } 7573 7574 /** 7575 * Implement this method to handle hover events. 7576 * <p> 7577 * This method is called whenever a pointer is hovering into, over, or out of the 7578 * bounds of a view and the view is not currently being touched. 7579 * Hover events are represented as pointer events with action 7580 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 7581 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 7582 * </p> 7583 * <ul> 7584 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 7585 * when the pointer enters the bounds of the view.</li> 7586 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 7587 * when the pointer has already entered the bounds of the view and has moved.</li> 7588 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 7589 * when the pointer has exited the bounds of the view or when the pointer is 7590 * about to go down due to a button click, tap, or similar user action that 7591 * causes the view to be touched.</li> 7592 * </ul> 7593 * <p> 7594 * The view should implement this method to return true to indicate that it is 7595 * handling the hover event, such as by changing its drawable state. 7596 * </p><p> 7597 * The default implementation calls {@link #setHovered} to update the hovered state 7598 * of the view when a hover enter or hover exit event is received, if the view 7599 * is enabled and is clickable. The default implementation also sends hover 7600 * accessibility events. 7601 * </p> 7602 * 7603 * @param event The motion event that describes the hover. 7604 * @return True if the view handled the hover event. 7605 * 7606 * @see #isHovered 7607 * @see #setHovered 7608 * @see #onHoverChanged 7609 */ 7610 public boolean onHoverEvent(MotionEvent event) { 7611 // The root view may receive hover (or touch) events that are outside the bounds of 7612 // the window. This code ensures that we only send accessibility events for 7613 // hovers that are actually within the bounds of the root view. 7614 final int action = event.getActionMasked(); 7615 if (!mSendingHoverAccessibilityEvents) { 7616 if ((action == MotionEvent.ACTION_HOVER_ENTER 7617 || action == MotionEvent.ACTION_HOVER_MOVE) 7618 && !hasHoveredChild() 7619 && pointInView(event.getX(), event.getY())) { 7620 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 7621 mSendingHoverAccessibilityEvents = true; 7622 requestAccessibilityFocusFromHover((int) event.getX(), (int) event.getY()); 7623 } 7624 } else { 7625 if (action == MotionEvent.ACTION_HOVER_EXIT 7626 || (action == MotionEvent.ACTION_MOVE 7627 && !pointInView(event.getX(), event.getY()))) { 7628 mSendingHoverAccessibilityEvents = false; 7629 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 7630 // If the window does not have input focus we take away accessibility 7631 // focus as soon as the user stop hovering over the view. 7632 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) { 7633 getViewRootImpl().setAccessibilityFocusedHost(null); 7634 } 7635 } 7636 } 7637 7638 if (isHoverable()) { 7639 switch (action) { 7640 case MotionEvent.ACTION_HOVER_ENTER: 7641 setHovered(true); 7642 break; 7643 case MotionEvent.ACTION_HOVER_EXIT: 7644 setHovered(false); 7645 break; 7646 } 7647 7648 // Dispatch the event to onGenericMotionEvent before returning true. 7649 // This is to provide compatibility with existing applications that 7650 // handled HOVER_MOVE events in onGenericMotionEvent and that would 7651 // break because of the new default handling for hoverable views 7652 // in onHoverEvent. 7653 // Note that onGenericMotionEvent will be called by default when 7654 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 7655 dispatchGenericMotionEventInternal(event); 7656 return true; 7657 } 7658 7659 return false; 7660 } 7661 7662 /** 7663 * Returns true if the view should handle {@link #onHoverEvent} 7664 * by calling {@link #setHovered} to change its hovered state. 7665 * 7666 * @return True if the view is hoverable. 7667 */ 7668 private boolean isHoverable() { 7669 final int viewFlags = mViewFlags; 7670 if ((viewFlags & ENABLED_MASK) == DISABLED) { 7671 return false; 7672 } 7673 7674 return (viewFlags & CLICKABLE) == CLICKABLE 7675 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 7676 } 7677 7678 /** 7679 * Returns true if the view is currently hovered. 7680 * 7681 * @return True if the view is currently hovered. 7682 * 7683 * @see #setHovered 7684 * @see #onHoverChanged 7685 */ 7686 @ViewDebug.ExportedProperty 7687 public boolean isHovered() { 7688 return (mPrivateFlags & HOVERED) != 0; 7689 } 7690 7691 /** 7692 * Sets whether the view is currently hovered. 7693 * <p> 7694 * Calling this method also changes the drawable state of the view. This 7695 * enables the view to react to hover by using different drawable resources 7696 * to change its appearance. 7697 * </p><p> 7698 * The {@link #onHoverChanged} method is called when the hovered state changes. 7699 * </p> 7700 * 7701 * @param hovered True if the view is hovered. 7702 * 7703 * @see #isHovered 7704 * @see #onHoverChanged 7705 */ 7706 public void setHovered(boolean hovered) { 7707 if (hovered) { 7708 if ((mPrivateFlags & HOVERED) == 0) { 7709 mPrivateFlags |= HOVERED; 7710 refreshDrawableState(); 7711 onHoverChanged(true); 7712 } 7713 } else { 7714 if ((mPrivateFlags & HOVERED) != 0) { 7715 mPrivateFlags &= ~HOVERED; 7716 refreshDrawableState(); 7717 onHoverChanged(false); 7718 } 7719 } 7720 } 7721 7722 /** 7723 * Implement this method to handle hover state changes. 7724 * <p> 7725 * This method is called whenever the hover state changes as a result of a 7726 * call to {@link #setHovered}. 7727 * </p> 7728 * 7729 * @param hovered The current hover state, as returned by {@link #isHovered}. 7730 * 7731 * @see #isHovered 7732 * @see #setHovered 7733 */ 7734 public void onHoverChanged(boolean hovered) { 7735 } 7736 7737 /** 7738 * Implement this method to handle touch screen motion events. 7739 * 7740 * @param event The motion event. 7741 * @return True if the event was handled, false otherwise. 7742 */ 7743 public boolean onTouchEvent(MotionEvent event) { 7744 final int viewFlags = mViewFlags; 7745 7746 if ((viewFlags & ENABLED_MASK) == DISABLED) { 7747 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) { 7748 setPressed(false); 7749 } 7750 // A disabled view that is clickable still consumes the touch 7751 // events, it just doesn't respond to them. 7752 return (((viewFlags & CLICKABLE) == CLICKABLE || 7753 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 7754 } 7755 7756 if (mTouchDelegate != null) { 7757 if (mTouchDelegate.onTouchEvent(event)) { 7758 return true; 7759 } 7760 } 7761 7762 if (((viewFlags & CLICKABLE) == CLICKABLE || 7763 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 7764 switch (event.getAction()) { 7765 case MotionEvent.ACTION_UP: 7766 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0; 7767 if ((mPrivateFlags & PRESSED) != 0 || prepressed) { 7768 // take focus if we don't have it already and we should in 7769 // touch mode. 7770 boolean focusTaken = false; 7771 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 7772 focusTaken = requestFocus(); 7773 } 7774 7775 if (prepressed) { 7776 // The button is being released before we actually 7777 // showed it as pressed. Make it show the pressed 7778 // state now (before scheduling the click) to ensure 7779 // the user sees it. 7780 setPressed(true); 7781 } 7782 7783 if (!mHasPerformedLongPress) { 7784 // This is a tap, so remove the longpress check 7785 removeLongPressCallback(); 7786 7787 // Only perform take click actions if we were in the pressed state 7788 if (!focusTaken) { 7789 // Use a Runnable and post this rather than calling 7790 // performClick directly. This lets other visual state 7791 // of the view update before click actions start. 7792 if (mPerformClick == null) { 7793 mPerformClick = new PerformClick(); 7794 } 7795 if (!post(mPerformClick)) { 7796 performClick(); 7797 } 7798 } 7799 } 7800 7801 if (mUnsetPressedState == null) { 7802 mUnsetPressedState = new UnsetPressedState(); 7803 } 7804 7805 if (prepressed) { 7806 postDelayed(mUnsetPressedState, 7807 ViewConfiguration.getPressedStateDuration()); 7808 } else if (!post(mUnsetPressedState)) { 7809 // If the post failed, unpress right now 7810 mUnsetPressedState.run(); 7811 } 7812 removeTapCallback(); 7813 } 7814 break; 7815 7816 case MotionEvent.ACTION_DOWN: 7817 mHasPerformedLongPress = false; 7818 7819 if (performButtonActionOnTouchDown(event)) { 7820 break; 7821 } 7822 7823 // Walk up the hierarchy to determine if we're inside a scrolling container. 7824 boolean isInScrollingContainer = isInScrollingContainer(); 7825 7826 // For views inside a scrolling container, delay the pressed feedback for 7827 // a short period in case this is a scroll. 7828 if (isInScrollingContainer) { 7829 mPrivateFlags |= PREPRESSED; 7830 if (mPendingCheckForTap == null) { 7831 mPendingCheckForTap = new CheckForTap(); 7832 } 7833 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 7834 } else { 7835 // Not inside a scrolling container, so show the feedback right away 7836 setPressed(true); 7837 checkForLongClick(0); 7838 } 7839 break; 7840 7841 case MotionEvent.ACTION_CANCEL: 7842 setPressed(false); 7843 removeTapCallback(); 7844 break; 7845 7846 case MotionEvent.ACTION_MOVE: 7847 final int x = (int) event.getX(); 7848 final int y = (int) event.getY(); 7849 7850 // Be lenient about moving outside of buttons 7851 if (!pointInView(x, y, mTouchSlop)) { 7852 // Outside button 7853 removeTapCallback(); 7854 if ((mPrivateFlags & PRESSED) != 0) { 7855 // Remove any future long press/tap checks 7856 removeLongPressCallback(); 7857 7858 setPressed(false); 7859 } 7860 } 7861 break; 7862 } 7863 return true; 7864 } 7865 7866 return false; 7867 } 7868 7869 /** 7870 * @hide 7871 */ 7872 public boolean isInScrollingContainer() { 7873 ViewParent p = getParent(); 7874 while (p != null && p instanceof ViewGroup) { 7875 if (((ViewGroup) p).shouldDelayChildPressedState()) { 7876 return true; 7877 } 7878 p = p.getParent(); 7879 } 7880 return false; 7881 } 7882 7883 /** 7884 * Remove the longpress detection timer. 7885 */ 7886 private void removeLongPressCallback() { 7887 if (mPendingCheckForLongPress != null) { 7888 removeCallbacks(mPendingCheckForLongPress); 7889 } 7890 } 7891 7892 /** 7893 * Remove the pending click action 7894 */ 7895 private void removePerformClickCallback() { 7896 if (mPerformClick != null) { 7897 removeCallbacks(mPerformClick); 7898 } 7899 } 7900 7901 /** 7902 * Remove the prepress detection timer. 7903 */ 7904 private void removeUnsetPressCallback() { 7905 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) { 7906 setPressed(false); 7907 removeCallbacks(mUnsetPressedState); 7908 } 7909 } 7910 7911 /** 7912 * Remove the tap detection timer. 7913 */ 7914 private void removeTapCallback() { 7915 if (mPendingCheckForTap != null) { 7916 mPrivateFlags &= ~PREPRESSED; 7917 removeCallbacks(mPendingCheckForTap); 7918 } 7919 } 7920 7921 /** 7922 * Cancels a pending long press. Your subclass can use this if you 7923 * want the context menu to come up if the user presses and holds 7924 * at the same place, but you don't want it to come up if they press 7925 * and then move around enough to cause scrolling. 7926 */ 7927 public void cancelLongPress() { 7928 removeLongPressCallback(); 7929 7930 /* 7931 * The prepressed state handled by the tap callback is a display 7932 * construct, but the tap callback will post a long press callback 7933 * less its own timeout. Remove it here. 7934 */ 7935 removeTapCallback(); 7936 } 7937 7938 /** 7939 * Remove the pending callback for sending a 7940 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 7941 */ 7942 private void removeSendViewScrolledAccessibilityEventCallback() { 7943 if (mSendViewScrolledAccessibilityEvent != null) { 7944 removeCallbacks(mSendViewScrolledAccessibilityEvent); 7945 } 7946 } 7947 7948 /** 7949 * Sets the TouchDelegate for this View. 7950 */ 7951 public void setTouchDelegate(TouchDelegate delegate) { 7952 mTouchDelegate = delegate; 7953 } 7954 7955 /** 7956 * Gets the TouchDelegate for this View. 7957 */ 7958 public TouchDelegate getTouchDelegate() { 7959 return mTouchDelegate; 7960 } 7961 7962 /** 7963 * Set flags controlling behavior of this view. 7964 * 7965 * @param flags Constant indicating the value which should be set 7966 * @param mask Constant indicating the bit range that should be changed 7967 */ 7968 void setFlags(int flags, int mask) { 7969 int old = mViewFlags; 7970 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 7971 7972 int changed = mViewFlags ^ old; 7973 if (changed == 0) { 7974 return; 7975 } 7976 int privateFlags = mPrivateFlags; 7977 7978 /* Check if the FOCUSABLE bit has changed */ 7979 if (((changed & FOCUSABLE_MASK) != 0) && 7980 ((privateFlags & HAS_BOUNDS) !=0)) { 7981 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 7982 && ((privateFlags & FOCUSED) != 0)) { 7983 /* Give up focus if we are no longer focusable */ 7984 clearFocus(); 7985 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 7986 && ((privateFlags & FOCUSED) == 0)) { 7987 /* 7988 * Tell the view system that we are now available to take focus 7989 * if no one else already has it. 7990 */ 7991 if (mParent != null) mParent.focusableViewAvailable(this); 7992 } 7993 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 7994 notifyAccessibilityStateChanged(); 7995 } 7996 } 7997 7998 if ((flags & VISIBILITY_MASK) == VISIBLE) { 7999 if ((changed & VISIBILITY_MASK) != 0) { 8000 /* 8001 * If this view is becoming visible, invalidate it in case it changed while 8002 * it was not visible. Marking it drawn ensures that the invalidation will 8003 * go through. 8004 */ 8005 mPrivateFlags |= DRAWN; 8006 invalidate(true); 8007 8008 needGlobalAttributesUpdate(true); 8009 8010 // a view becoming visible is worth notifying the parent 8011 // about in case nothing has focus. even if this specific view 8012 // isn't focusable, it may contain something that is, so let 8013 // the root view try to give this focus if nothing else does. 8014 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 8015 mParent.focusableViewAvailable(this); 8016 } 8017 } 8018 } 8019 8020 /* Check if the GONE bit has changed */ 8021 if ((changed & GONE) != 0) { 8022 needGlobalAttributesUpdate(false); 8023 requestLayout(); 8024 8025 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 8026 if (hasFocus()) clearFocus(); 8027 clearAccessibilityFocus(); 8028 destroyDrawingCache(); 8029 if (mParent instanceof View) { 8030 // GONE views noop invalidation, so invalidate the parent 8031 ((View) mParent).invalidate(true); 8032 } 8033 // Mark the view drawn to ensure that it gets invalidated properly the next 8034 // time it is visible and gets invalidated 8035 mPrivateFlags |= DRAWN; 8036 } 8037 if (mAttachInfo != null) { 8038 mAttachInfo.mViewVisibilityChanged = true; 8039 } 8040 } 8041 8042 /* Check if the VISIBLE bit has changed */ 8043 if ((changed & INVISIBLE) != 0) { 8044 needGlobalAttributesUpdate(false); 8045 /* 8046 * If this view is becoming invisible, set the DRAWN flag so that 8047 * the next invalidate() will not be skipped. 8048 */ 8049 mPrivateFlags |= DRAWN; 8050 8051 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) { 8052 // root view becoming invisible shouldn't clear focus and accessibility focus 8053 if (getRootView() != this) { 8054 clearFocus(); 8055 clearAccessibilityFocus(); 8056 } 8057 } 8058 if (mAttachInfo != null) { 8059 mAttachInfo.mViewVisibilityChanged = true; 8060 } 8061 } 8062 8063 if ((changed & VISIBILITY_MASK) != 0) { 8064 if (mParent instanceof ViewGroup) { 8065 ((ViewGroup) mParent).onChildVisibilityChanged(this, 8066 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK)); 8067 ((View) mParent).invalidate(true); 8068 } else if (mParent != null) { 8069 mParent.invalidateChild(this, null); 8070 } 8071 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK)); 8072 } 8073 8074 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 8075 destroyDrawingCache(); 8076 } 8077 8078 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 8079 destroyDrawingCache(); 8080 mPrivateFlags &= ~DRAWING_CACHE_VALID; 8081 invalidateParentCaches(); 8082 } 8083 8084 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 8085 destroyDrawingCache(); 8086 mPrivateFlags &= ~DRAWING_CACHE_VALID; 8087 } 8088 8089 if ((changed & DRAW_MASK) != 0) { 8090 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 8091 if (mBackground != null) { 8092 mPrivateFlags &= ~SKIP_DRAW; 8093 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 8094 } else { 8095 mPrivateFlags |= SKIP_DRAW; 8096 } 8097 } else { 8098 mPrivateFlags &= ~SKIP_DRAW; 8099 } 8100 requestLayout(); 8101 invalidate(true); 8102 } 8103 8104 if ((changed & KEEP_SCREEN_ON) != 0) { 8105 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 8106 mParent.recomputeViewAttributes(this); 8107 } 8108 } 8109 8110 if (AccessibilityManager.getInstance(mContext).isEnabled() 8111 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0 8112 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) { 8113 notifyAccessibilityStateChanged(); 8114 } 8115 } 8116 8117 /** 8118 * Change the view's z order in the tree, so it's on top of other sibling 8119 * views 8120 */ 8121 public void bringToFront() { 8122 if (mParent != null) { 8123 mParent.bringChildToFront(this); 8124 } 8125 } 8126 8127 /** 8128 * This is called in response to an internal scroll in this view (i.e., the 8129 * view scrolled its own contents). This is typically as a result of 8130 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 8131 * called. 8132 * 8133 * @param l Current horizontal scroll origin. 8134 * @param t Current vertical scroll origin. 8135 * @param oldl Previous horizontal scroll origin. 8136 * @param oldt Previous vertical scroll origin. 8137 */ 8138 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 8139 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 8140 postSendViewScrolledAccessibilityEventCallback(); 8141 } 8142 8143 mBackgroundSizeChanged = true; 8144 8145 final AttachInfo ai = mAttachInfo; 8146 if (ai != null) { 8147 ai.mViewScrollChanged = true; 8148 } 8149 } 8150 8151 /** 8152 * Interface definition for a callback to be invoked when the layout bounds of a view 8153 * changes due to layout processing. 8154 */ 8155 public interface OnLayoutChangeListener { 8156 /** 8157 * Called when the focus state of a view has changed. 8158 * 8159 * @param v The view whose state has changed. 8160 * @param left The new value of the view's left property. 8161 * @param top The new value of the view's top property. 8162 * @param right The new value of the view's right property. 8163 * @param bottom The new value of the view's bottom property. 8164 * @param oldLeft The previous value of the view's left property. 8165 * @param oldTop The previous value of the view's top property. 8166 * @param oldRight The previous value of the view's right property. 8167 * @param oldBottom The previous value of the view's bottom property. 8168 */ 8169 void onLayoutChange(View v, int left, int top, int right, int bottom, 8170 int oldLeft, int oldTop, int oldRight, int oldBottom); 8171 } 8172 8173 /** 8174 * This is called during layout when the size of this view has changed. If 8175 * you were just added to the view hierarchy, you're called with the old 8176 * values of 0. 8177 * 8178 * @param w Current width of this view. 8179 * @param h Current height of this view. 8180 * @param oldw Old width of this view. 8181 * @param oldh Old height of this view. 8182 */ 8183 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 8184 } 8185 8186 /** 8187 * Called by draw to draw the child views. This may be overridden 8188 * by derived classes to gain control just before its children are drawn 8189 * (but after its own view has been drawn). 8190 * @param canvas the canvas on which to draw the view 8191 */ 8192 protected void dispatchDraw(Canvas canvas) { 8193 8194 } 8195 8196 /** 8197 * Gets the parent of this view. Note that the parent is a 8198 * ViewParent and not necessarily a View. 8199 * 8200 * @return Parent of this view. 8201 */ 8202 public final ViewParent getParent() { 8203 return mParent; 8204 } 8205 8206 /** 8207 * Set the horizontal scrolled position of your view. This will cause a call to 8208 * {@link #onScrollChanged(int, int, int, int)} and the view will be 8209 * invalidated. 8210 * @param value the x position to scroll to 8211 */ 8212 public void setScrollX(int value) { 8213 scrollTo(value, mScrollY); 8214 } 8215 8216 /** 8217 * Set the vertical scrolled position of your view. This will cause a call to 8218 * {@link #onScrollChanged(int, int, int, int)} and the view will be 8219 * invalidated. 8220 * @param value the y position to scroll to 8221 */ 8222 public void setScrollY(int value) { 8223 scrollTo(mScrollX, value); 8224 } 8225 8226 /** 8227 * Return the scrolled left position of this view. This is the left edge of 8228 * the displayed part of your view. You do not need to draw any pixels 8229 * farther left, since those are outside of the frame of your view on 8230 * screen. 8231 * 8232 * @return The left edge of the displayed part of your view, in pixels. 8233 */ 8234 public final int getScrollX() { 8235 return mScrollX; 8236 } 8237 8238 /** 8239 * Return the scrolled top position of this view. This is the top edge of 8240 * the displayed part of your view. You do not need to draw any pixels above 8241 * it, since those are outside of the frame of your view on screen. 8242 * 8243 * @return The top edge of the displayed part of your view, in pixels. 8244 */ 8245 public final int getScrollY() { 8246 return mScrollY; 8247 } 8248 8249 /** 8250 * Return the width of the your view. 8251 * 8252 * @return The width of your view, in pixels. 8253 */ 8254 @ViewDebug.ExportedProperty(category = "layout") 8255 public final int getWidth() { 8256 return mRight - mLeft; 8257 } 8258 8259 /** 8260 * Return the height of your view. 8261 * 8262 * @return The height of your view, in pixels. 8263 */ 8264 @ViewDebug.ExportedProperty(category = "layout") 8265 public final int getHeight() { 8266 return mBottom - mTop; 8267 } 8268 8269 /** 8270 * Return the visible drawing bounds of your view. Fills in the output 8271 * rectangle with the values from getScrollX(), getScrollY(), 8272 * getWidth(), and getHeight(). 8273 * 8274 * @param outRect The (scrolled) drawing bounds of the view. 8275 */ 8276 public void getDrawingRect(Rect outRect) { 8277 outRect.left = mScrollX; 8278 outRect.top = mScrollY; 8279 outRect.right = mScrollX + (mRight - mLeft); 8280 outRect.bottom = mScrollY + (mBottom - mTop); 8281 } 8282 8283 /** 8284 * Like {@link #getMeasuredWidthAndState()}, but only returns the 8285 * raw width component (that is the result is masked by 8286 * {@link #MEASURED_SIZE_MASK}). 8287 * 8288 * @return The raw measured width of this view. 8289 */ 8290 public final int getMeasuredWidth() { 8291 return mMeasuredWidth & MEASURED_SIZE_MASK; 8292 } 8293 8294 /** 8295 * Return the full width measurement information for this view as computed 8296 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 8297 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 8298 * This should be used during measurement and layout calculations only. Use 8299 * {@link #getWidth()} to see how wide a view is after layout. 8300 * 8301 * @return The measured width of this view as a bit mask. 8302 */ 8303 public final int getMeasuredWidthAndState() { 8304 return mMeasuredWidth; 8305 } 8306 8307 /** 8308 * Like {@link #getMeasuredHeightAndState()}, but only returns the 8309 * raw width component (that is the result is masked by 8310 * {@link #MEASURED_SIZE_MASK}). 8311 * 8312 * @return The raw measured height of this view. 8313 */ 8314 public final int getMeasuredHeight() { 8315 return mMeasuredHeight & MEASURED_SIZE_MASK; 8316 } 8317 8318 /** 8319 * Return the full height measurement information for this view as computed 8320 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 8321 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 8322 * This should be used during measurement and layout calculations only. Use 8323 * {@link #getHeight()} to see how wide a view is after layout. 8324 * 8325 * @return The measured width of this view as a bit mask. 8326 */ 8327 public final int getMeasuredHeightAndState() { 8328 return mMeasuredHeight; 8329 } 8330 8331 /** 8332 * Return only the state bits of {@link #getMeasuredWidthAndState()} 8333 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 8334 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 8335 * and the height component is at the shifted bits 8336 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 8337 */ 8338 public final int getMeasuredState() { 8339 return (mMeasuredWidth&MEASURED_STATE_MASK) 8340 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 8341 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 8342 } 8343 8344 /** 8345 * The transform matrix of this view, which is calculated based on the current 8346 * roation, scale, and pivot properties. 8347 * 8348 * @see #getRotation() 8349 * @see #getScaleX() 8350 * @see #getScaleY() 8351 * @see #getPivotX() 8352 * @see #getPivotY() 8353 * @return The current transform matrix for the view 8354 */ 8355 public Matrix getMatrix() { 8356 if (mTransformationInfo != null) { 8357 updateMatrix(); 8358 return mTransformationInfo.mMatrix; 8359 } 8360 return Matrix.IDENTITY_MATRIX; 8361 } 8362 8363 /** 8364 * Utility function to determine if the value is far enough away from zero to be 8365 * considered non-zero. 8366 * @param value A floating point value to check for zero-ness 8367 * @return whether the passed-in value is far enough away from zero to be considered non-zero 8368 */ 8369 private static boolean nonzero(float value) { 8370 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON); 8371 } 8372 8373 /** 8374 * Returns true if the transform matrix is the identity matrix. 8375 * Recomputes the matrix if necessary. 8376 * 8377 * @return True if the transform matrix is the identity matrix, false otherwise. 8378 */ 8379 final boolean hasIdentityMatrix() { 8380 if (mTransformationInfo != null) { 8381 updateMatrix(); 8382 return mTransformationInfo.mMatrixIsIdentity; 8383 } 8384 return true; 8385 } 8386 8387 void ensureTransformationInfo() { 8388 if (mTransformationInfo == null) { 8389 mTransformationInfo = new TransformationInfo(); 8390 } 8391 } 8392 8393 /** 8394 * Recomputes the transform matrix if necessary. 8395 */ 8396 private void updateMatrix() { 8397 final TransformationInfo info = mTransformationInfo; 8398 if (info == null) { 8399 return; 8400 } 8401 if (info.mMatrixDirty) { 8402 // transform-related properties have changed since the last time someone 8403 // asked for the matrix; recalculate it with the current values 8404 8405 // Figure out if we need to update the pivot point 8406 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 8407 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) { 8408 info.mPrevWidth = mRight - mLeft; 8409 info.mPrevHeight = mBottom - mTop; 8410 info.mPivotX = info.mPrevWidth / 2f; 8411 info.mPivotY = info.mPrevHeight / 2f; 8412 } 8413 } 8414 info.mMatrix.reset(); 8415 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) { 8416 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY); 8417 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY); 8418 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY); 8419 } else { 8420 if (info.mCamera == null) { 8421 info.mCamera = new Camera(); 8422 info.matrix3D = new Matrix(); 8423 } 8424 info.mCamera.save(); 8425 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY); 8426 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation); 8427 info.mCamera.getMatrix(info.matrix3D); 8428 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY); 8429 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX, 8430 info.mPivotY + info.mTranslationY); 8431 info.mMatrix.postConcat(info.matrix3D); 8432 info.mCamera.restore(); 8433 } 8434 info.mMatrixDirty = false; 8435 info.mMatrixIsIdentity = info.mMatrix.isIdentity(); 8436 info.mInverseMatrixDirty = true; 8437 } 8438 } 8439 8440 /** 8441 * Utility method to retrieve the inverse of the current mMatrix property. 8442 * We cache the matrix to avoid recalculating it when transform properties 8443 * have not changed. 8444 * 8445 * @return The inverse of the current matrix of this view. 8446 */ 8447 final Matrix getInverseMatrix() { 8448 final TransformationInfo info = mTransformationInfo; 8449 if (info != null) { 8450 updateMatrix(); 8451 if (info.mInverseMatrixDirty) { 8452 if (info.mInverseMatrix == null) { 8453 info.mInverseMatrix = new Matrix(); 8454 } 8455 info.mMatrix.invert(info.mInverseMatrix); 8456 info.mInverseMatrixDirty = false; 8457 } 8458 return info.mInverseMatrix; 8459 } 8460 return Matrix.IDENTITY_MATRIX; 8461 } 8462 8463 /** 8464 * Gets the distance along the Z axis from the camera to this view. 8465 * 8466 * @see #setCameraDistance(float) 8467 * 8468 * @return The distance along the Z axis. 8469 */ 8470 public float getCameraDistance() { 8471 ensureTransformationInfo(); 8472 final float dpi = mResources.getDisplayMetrics().densityDpi; 8473 final TransformationInfo info = mTransformationInfo; 8474 if (info.mCamera == null) { 8475 info.mCamera = new Camera(); 8476 info.matrix3D = new Matrix(); 8477 } 8478 return -(info.mCamera.getLocationZ() * dpi); 8479 } 8480 8481 /** 8482 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 8483 * views are drawn) from the camera to this view. The camera's distance 8484 * affects 3D transformations, for instance rotations around the X and Y 8485 * axis. If the rotationX or rotationY properties are changed and this view is 8486 * large (more than half the size of the screen), it is recommended to always 8487 * use a camera distance that's greater than the height (X axis rotation) or 8488 * the width (Y axis rotation) of this view.</p> 8489 * 8490 * <p>The distance of the camera from the view plane can have an affect on the 8491 * perspective distortion of the view when it is rotated around the x or y axis. 8492 * For example, a large distance will result in a large viewing angle, and there 8493 * will not be much perspective distortion of the view as it rotates. A short 8494 * distance may cause much more perspective distortion upon rotation, and can 8495 * also result in some drawing artifacts if the rotated view ends up partially 8496 * behind the camera (which is why the recommendation is to use a distance at 8497 * least as far as the size of the view, if the view is to be rotated.)</p> 8498 * 8499 * <p>The distance is expressed in "depth pixels." The default distance depends 8500 * on the screen density. For instance, on a medium density display, the 8501 * default distance is 1280. On a high density display, the default distance 8502 * is 1920.</p> 8503 * 8504 * <p>If you want to specify a distance that leads to visually consistent 8505 * results across various densities, use the following formula:</p> 8506 * <pre> 8507 * float scale = context.getResources().getDisplayMetrics().density; 8508 * view.setCameraDistance(distance * scale); 8509 * </pre> 8510 * 8511 * <p>The density scale factor of a high density display is 1.5, 8512 * and 1920 = 1280 * 1.5.</p> 8513 * 8514 * @param distance The distance in "depth pixels", if negative the opposite 8515 * value is used 8516 * 8517 * @see #setRotationX(float) 8518 * @see #setRotationY(float) 8519 */ 8520 public void setCameraDistance(float distance) { 8521 invalidateViewProperty(true, false); 8522 8523 ensureTransformationInfo(); 8524 final float dpi = mResources.getDisplayMetrics().densityDpi; 8525 final TransformationInfo info = mTransformationInfo; 8526 if (info.mCamera == null) { 8527 info.mCamera = new Camera(); 8528 info.matrix3D = new Matrix(); 8529 } 8530 8531 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi); 8532 info.mMatrixDirty = true; 8533 8534 invalidateViewProperty(false, false); 8535 if (mDisplayList != null) { 8536 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi); 8537 } 8538 } 8539 8540 /** 8541 * The degrees that the view is rotated around the pivot point. 8542 * 8543 * @see #setRotation(float) 8544 * @see #getPivotX() 8545 * @see #getPivotY() 8546 * 8547 * @return The degrees of rotation. 8548 */ 8549 @ViewDebug.ExportedProperty(category = "drawing") 8550 public float getRotation() { 8551 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0; 8552 } 8553 8554 /** 8555 * Sets the degrees that the view is rotated around the pivot point. Increasing values 8556 * result in clockwise rotation. 8557 * 8558 * @param rotation The degrees of rotation. 8559 * 8560 * @see #getRotation() 8561 * @see #getPivotX() 8562 * @see #getPivotY() 8563 * @see #setRotationX(float) 8564 * @see #setRotationY(float) 8565 * 8566 * @attr ref android.R.styleable#View_rotation 8567 */ 8568 public void setRotation(float rotation) { 8569 ensureTransformationInfo(); 8570 final TransformationInfo info = mTransformationInfo; 8571 if (info.mRotation != rotation) { 8572 // Double-invalidation is necessary to capture view's old and new areas 8573 invalidateViewProperty(true, false); 8574 info.mRotation = rotation; 8575 info.mMatrixDirty = true; 8576 invalidateViewProperty(false, true); 8577 if (mDisplayList != null) { 8578 mDisplayList.setRotation(rotation); 8579 } 8580 } 8581 } 8582 8583 /** 8584 * The degrees that the view is rotated around the vertical axis through the pivot point. 8585 * 8586 * @see #getPivotX() 8587 * @see #getPivotY() 8588 * @see #setRotationY(float) 8589 * 8590 * @return The degrees of Y rotation. 8591 */ 8592 @ViewDebug.ExportedProperty(category = "drawing") 8593 public float getRotationY() { 8594 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0; 8595 } 8596 8597 /** 8598 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 8599 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 8600 * down the y axis. 8601 * 8602 * When rotating large views, it is recommended to adjust the camera distance 8603 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 8604 * 8605 * @param rotationY The degrees of Y rotation. 8606 * 8607 * @see #getRotationY() 8608 * @see #getPivotX() 8609 * @see #getPivotY() 8610 * @see #setRotation(float) 8611 * @see #setRotationX(float) 8612 * @see #setCameraDistance(float) 8613 * 8614 * @attr ref android.R.styleable#View_rotationY 8615 */ 8616 public void setRotationY(float rotationY) { 8617 ensureTransformationInfo(); 8618 final TransformationInfo info = mTransformationInfo; 8619 if (info.mRotationY != rotationY) { 8620 invalidateViewProperty(true, false); 8621 info.mRotationY = rotationY; 8622 info.mMatrixDirty = true; 8623 invalidateViewProperty(false, true); 8624 if (mDisplayList != null) { 8625 mDisplayList.setRotationY(rotationY); 8626 } 8627 } 8628 } 8629 8630 /** 8631 * The degrees that the view is rotated around the horizontal axis through the pivot point. 8632 * 8633 * @see #getPivotX() 8634 * @see #getPivotY() 8635 * @see #setRotationX(float) 8636 * 8637 * @return The degrees of X rotation. 8638 */ 8639 @ViewDebug.ExportedProperty(category = "drawing") 8640 public float getRotationX() { 8641 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0; 8642 } 8643 8644 /** 8645 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 8646 * Increasing values result in clockwise rotation from the viewpoint of looking down the 8647 * x axis. 8648 * 8649 * When rotating large views, it is recommended to adjust the camera distance 8650 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 8651 * 8652 * @param rotationX The degrees of X rotation. 8653 * 8654 * @see #getRotationX() 8655 * @see #getPivotX() 8656 * @see #getPivotY() 8657 * @see #setRotation(float) 8658 * @see #setRotationY(float) 8659 * @see #setCameraDistance(float) 8660 * 8661 * @attr ref android.R.styleable#View_rotationX 8662 */ 8663 public void setRotationX(float rotationX) { 8664 ensureTransformationInfo(); 8665 final TransformationInfo info = mTransformationInfo; 8666 if (info.mRotationX != rotationX) { 8667 invalidateViewProperty(true, false); 8668 info.mRotationX = rotationX; 8669 info.mMatrixDirty = true; 8670 invalidateViewProperty(false, true); 8671 if (mDisplayList != null) { 8672 mDisplayList.setRotationX(rotationX); 8673 } 8674 } 8675 } 8676 8677 /** 8678 * The amount that the view is scaled in x around the pivot point, as a proportion of 8679 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 8680 * 8681 * <p>By default, this is 1.0f. 8682 * 8683 * @see #getPivotX() 8684 * @see #getPivotY() 8685 * @return The scaling factor. 8686 */ 8687 @ViewDebug.ExportedProperty(category = "drawing") 8688 public float getScaleX() { 8689 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1; 8690 } 8691 8692 /** 8693 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 8694 * the view's unscaled width. A value of 1 means that no scaling is applied. 8695 * 8696 * @param scaleX The scaling factor. 8697 * @see #getPivotX() 8698 * @see #getPivotY() 8699 * 8700 * @attr ref android.R.styleable#View_scaleX 8701 */ 8702 public void setScaleX(float scaleX) { 8703 ensureTransformationInfo(); 8704 final TransformationInfo info = mTransformationInfo; 8705 if (info.mScaleX != scaleX) { 8706 invalidateViewProperty(true, false); 8707 info.mScaleX = scaleX; 8708 info.mMatrixDirty = true; 8709 invalidateViewProperty(false, true); 8710 if (mDisplayList != null) { 8711 mDisplayList.setScaleX(scaleX); 8712 } 8713 } 8714 } 8715 8716 /** 8717 * The amount that the view is scaled in y around the pivot point, as a proportion of 8718 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 8719 * 8720 * <p>By default, this is 1.0f. 8721 * 8722 * @see #getPivotX() 8723 * @see #getPivotY() 8724 * @return The scaling factor. 8725 */ 8726 @ViewDebug.ExportedProperty(category = "drawing") 8727 public float getScaleY() { 8728 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1; 8729 } 8730 8731 /** 8732 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 8733 * the view's unscaled width. A value of 1 means that no scaling is applied. 8734 * 8735 * @param scaleY The scaling factor. 8736 * @see #getPivotX() 8737 * @see #getPivotY() 8738 * 8739 * @attr ref android.R.styleable#View_scaleY 8740 */ 8741 public void setScaleY(float scaleY) { 8742 ensureTransformationInfo(); 8743 final TransformationInfo info = mTransformationInfo; 8744 if (info.mScaleY != scaleY) { 8745 invalidateViewProperty(true, false); 8746 info.mScaleY = scaleY; 8747 info.mMatrixDirty = true; 8748 invalidateViewProperty(false, true); 8749 if (mDisplayList != null) { 8750 mDisplayList.setScaleY(scaleY); 8751 } 8752 } 8753 } 8754 8755 /** 8756 * The x location of the point around which the view is {@link #setRotation(float) rotated} 8757 * and {@link #setScaleX(float) scaled}. 8758 * 8759 * @see #getRotation() 8760 * @see #getScaleX() 8761 * @see #getScaleY() 8762 * @see #getPivotY() 8763 * @return The x location of the pivot point. 8764 * 8765 * @attr ref android.R.styleable#View_transformPivotX 8766 */ 8767 @ViewDebug.ExportedProperty(category = "drawing") 8768 public float getPivotX() { 8769 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0; 8770 } 8771 8772 /** 8773 * Sets the x location of the point around which the view is 8774 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 8775 * By default, the pivot point is centered on the object. 8776 * Setting this property disables this behavior and causes the view to use only the 8777 * explicitly set pivotX and pivotY values. 8778 * 8779 * @param pivotX The x location of the pivot point. 8780 * @see #getRotation() 8781 * @see #getScaleX() 8782 * @see #getScaleY() 8783 * @see #getPivotY() 8784 * 8785 * @attr ref android.R.styleable#View_transformPivotX 8786 */ 8787 public void setPivotX(float pivotX) { 8788 ensureTransformationInfo(); 8789 mPrivateFlags |= PIVOT_EXPLICITLY_SET; 8790 final TransformationInfo info = mTransformationInfo; 8791 if (info.mPivotX != pivotX) { 8792 invalidateViewProperty(true, false); 8793 info.mPivotX = pivotX; 8794 info.mMatrixDirty = true; 8795 invalidateViewProperty(false, true); 8796 if (mDisplayList != null) { 8797 mDisplayList.setPivotX(pivotX); 8798 } 8799 } 8800 } 8801 8802 /** 8803 * The y location of the point around which the view is {@link #setRotation(float) rotated} 8804 * and {@link #setScaleY(float) scaled}. 8805 * 8806 * @see #getRotation() 8807 * @see #getScaleX() 8808 * @see #getScaleY() 8809 * @see #getPivotY() 8810 * @return The y location of the pivot point. 8811 * 8812 * @attr ref android.R.styleable#View_transformPivotY 8813 */ 8814 @ViewDebug.ExportedProperty(category = "drawing") 8815 public float getPivotY() { 8816 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0; 8817 } 8818 8819 /** 8820 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 8821 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 8822 * Setting this property disables this behavior and causes the view to use only the 8823 * explicitly set pivotX and pivotY values. 8824 * 8825 * @param pivotY The y location of the pivot point. 8826 * @see #getRotation() 8827 * @see #getScaleX() 8828 * @see #getScaleY() 8829 * @see #getPivotY() 8830 * 8831 * @attr ref android.R.styleable#View_transformPivotY 8832 */ 8833 public void setPivotY(float pivotY) { 8834 ensureTransformationInfo(); 8835 mPrivateFlags |= PIVOT_EXPLICITLY_SET; 8836 final TransformationInfo info = mTransformationInfo; 8837 if (info.mPivotY != pivotY) { 8838 invalidateViewProperty(true, false); 8839 info.mPivotY = pivotY; 8840 info.mMatrixDirty = true; 8841 invalidateViewProperty(false, true); 8842 if (mDisplayList != null) { 8843 mDisplayList.setPivotY(pivotY); 8844 } 8845 } 8846 } 8847 8848 /** 8849 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 8850 * completely transparent and 1 means the view is completely opaque. 8851 * 8852 * <p>By default this is 1.0f. 8853 * @return The opacity of the view. 8854 */ 8855 @ViewDebug.ExportedProperty(category = "drawing") 8856 public float getAlpha() { 8857 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 8858 } 8859 8860 /** 8861 * Returns whether this View has content which overlaps. This function, intended to be 8862 * overridden by specific View types, is an optimization when alpha is set on a view. If 8863 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer 8864 * and then composited it into place, which can be expensive. If the view has no overlapping 8865 * rendering, the view can draw each primitive with the appropriate alpha value directly. 8866 * An example of overlapping rendering is a TextView with a background image, such as a 8867 * Button. An example of non-overlapping rendering is a TextView with no background, or 8868 * an ImageView with only the foreground image. The default implementation returns true; 8869 * subclasses should override if they have cases which can be optimized. 8870 * 8871 * @return true if the content in this view might overlap, false otherwise. 8872 */ 8873 public boolean hasOverlappingRendering() { 8874 return true; 8875 } 8876 8877 /** 8878 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 8879 * completely transparent and 1 means the view is completely opaque.</p> 8880 * 8881 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 8882 * responsible for applying the opacity itself. Otherwise, calling this method is 8883 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and 8884 * setting a hardware layer.</p> 8885 * 8886 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have 8887 * performance implications. It is generally best to use the alpha property sparingly and 8888 * transiently, as in the case of fading animations.</p> 8889 * 8890 * @param alpha The opacity of the view. 8891 * 8892 * @see #setLayerType(int, android.graphics.Paint) 8893 * 8894 * @attr ref android.R.styleable#View_alpha 8895 */ 8896 public void setAlpha(float alpha) { 8897 ensureTransformationInfo(); 8898 if (mTransformationInfo.mAlpha != alpha) { 8899 mTransformationInfo.mAlpha = alpha; 8900 if (onSetAlpha((int) (alpha * 255))) { 8901 mPrivateFlags |= ALPHA_SET; 8902 // subclass is handling alpha - don't optimize rendering cache invalidation 8903 invalidateParentCaches(); 8904 invalidate(true); 8905 } else { 8906 mPrivateFlags &= ~ALPHA_SET; 8907 invalidateViewProperty(true, false); 8908 if (mDisplayList != null) { 8909 mDisplayList.setAlpha(alpha); 8910 } 8911 } 8912 } 8913 } 8914 8915 /** 8916 * Faster version of setAlpha() which performs the same steps except there are 8917 * no calls to invalidate(). The caller of this function should perform proper invalidation 8918 * on the parent and this object. The return value indicates whether the subclass handles 8919 * alpha (the return value for onSetAlpha()). 8920 * 8921 * @param alpha The new value for the alpha property 8922 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 8923 * the new value for the alpha property is different from the old value 8924 */ 8925 boolean setAlphaNoInvalidation(float alpha) { 8926 ensureTransformationInfo(); 8927 if (mTransformationInfo.mAlpha != alpha) { 8928 mTransformationInfo.mAlpha = alpha; 8929 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 8930 if (subclassHandlesAlpha) { 8931 mPrivateFlags |= ALPHA_SET; 8932 return true; 8933 } else { 8934 mPrivateFlags &= ~ALPHA_SET; 8935 if (mDisplayList != null) { 8936 mDisplayList.setAlpha(alpha); 8937 } 8938 } 8939 } 8940 return false; 8941 } 8942 8943 /** 8944 * Top position of this view relative to its parent. 8945 * 8946 * @return The top of this view, in pixels. 8947 */ 8948 @ViewDebug.CapturedViewProperty 8949 public final int getTop() { 8950 return mTop; 8951 } 8952 8953 /** 8954 * Sets the top position of this view relative to its parent. This method is meant to be called 8955 * by the layout system and should not generally be called otherwise, because the property 8956 * may be changed at any time by the layout. 8957 * 8958 * @param top The top of this view, in pixels. 8959 */ 8960 public final void setTop(int top) { 8961 if (top != mTop) { 8962 updateMatrix(); 8963 final boolean matrixIsIdentity = mTransformationInfo == null 8964 || mTransformationInfo.mMatrixIsIdentity; 8965 if (matrixIsIdentity) { 8966 if (mAttachInfo != null) { 8967 int minTop; 8968 int yLoc; 8969 if (top < mTop) { 8970 minTop = top; 8971 yLoc = top - mTop; 8972 } else { 8973 minTop = mTop; 8974 yLoc = 0; 8975 } 8976 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 8977 } 8978 } else { 8979 // Double-invalidation is necessary to capture view's old and new areas 8980 invalidate(true); 8981 } 8982 8983 int width = mRight - mLeft; 8984 int oldHeight = mBottom - mTop; 8985 8986 mTop = top; 8987 if (mDisplayList != null) { 8988 mDisplayList.setTop(mTop); 8989 } 8990 8991 onSizeChanged(width, mBottom - mTop, width, oldHeight); 8992 8993 if (!matrixIsIdentity) { 8994 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 8995 // A change in dimension means an auto-centered pivot point changes, too 8996 mTransformationInfo.mMatrixDirty = true; 8997 } 8998 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 8999 invalidate(true); 9000 } 9001 mBackgroundSizeChanged = true; 9002 invalidateParentIfNeeded(); 9003 } 9004 } 9005 9006 /** 9007 * Bottom position of this view relative to its parent. 9008 * 9009 * @return The bottom of this view, in pixels. 9010 */ 9011 @ViewDebug.CapturedViewProperty 9012 public final int getBottom() { 9013 return mBottom; 9014 } 9015 9016 /** 9017 * True if this view has changed since the last time being drawn. 9018 * 9019 * @return The dirty state of this view. 9020 */ 9021 public boolean isDirty() { 9022 return (mPrivateFlags & DIRTY_MASK) != 0; 9023 } 9024 9025 /** 9026 * Sets the bottom position of this view relative to its parent. This method is meant to be 9027 * called by the layout system and should not generally be called otherwise, because the 9028 * property may be changed at any time by the layout. 9029 * 9030 * @param bottom The bottom of this view, in pixels. 9031 */ 9032 public final void setBottom(int bottom) { 9033 if (bottom != mBottom) { 9034 updateMatrix(); 9035 final boolean matrixIsIdentity = mTransformationInfo == null 9036 || mTransformationInfo.mMatrixIsIdentity; 9037 if (matrixIsIdentity) { 9038 if (mAttachInfo != null) { 9039 int maxBottom; 9040 if (bottom < mBottom) { 9041 maxBottom = mBottom; 9042 } else { 9043 maxBottom = bottom; 9044 } 9045 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 9046 } 9047 } else { 9048 // Double-invalidation is necessary to capture view's old and new areas 9049 invalidate(true); 9050 } 9051 9052 int width = mRight - mLeft; 9053 int oldHeight = mBottom - mTop; 9054 9055 mBottom = bottom; 9056 if (mDisplayList != null) { 9057 mDisplayList.setBottom(mBottom); 9058 } 9059 9060 onSizeChanged(width, mBottom - mTop, width, oldHeight); 9061 9062 if (!matrixIsIdentity) { 9063 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 9064 // A change in dimension means an auto-centered pivot point changes, too 9065 mTransformationInfo.mMatrixDirty = true; 9066 } 9067 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 9068 invalidate(true); 9069 } 9070 mBackgroundSizeChanged = true; 9071 invalidateParentIfNeeded(); 9072 } 9073 } 9074 9075 /** 9076 * Left position of this view relative to its parent. 9077 * 9078 * @return The left edge of this view, in pixels. 9079 */ 9080 @ViewDebug.CapturedViewProperty 9081 public final int getLeft() { 9082 return mLeft; 9083 } 9084 9085 /** 9086 * Sets the left position of this view relative to its parent. This method is meant to be called 9087 * by the layout system and should not generally be called otherwise, because the property 9088 * may be changed at any time by the layout. 9089 * 9090 * @param left The bottom of this view, in pixels. 9091 */ 9092 public final void setLeft(int left) { 9093 if (left != mLeft) { 9094 updateMatrix(); 9095 final boolean matrixIsIdentity = mTransformationInfo == null 9096 || mTransformationInfo.mMatrixIsIdentity; 9097 if (matrixIsIdentity) { 9098 if (mAttachInfo != null) { 9099 int minLeft; 9100 int xLoc; 9101 if (left < mLeft) { 9102 minLeft = left; 9103 xLoc = left - mLeft; 9104 } else { 9105 minLeft = mLeft; 9106 xLoc = 0; 9107 } 9108 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 9109 } 9110 } else { 9111 // Double-invalidation is necessary to capture view's old and new areas 9112 invalidate(true); 9113 } 9114 9115 int oldWidth = mRight - mLeft; 9116 int height = mBottom - mTop; 9117 9118 mLeft = left; 9119 if (mDisplayList != null) { 9120 mDisplayList.setLeft(left); 9121 } 9122 9123 onSizeChanged(mRight - mLeft, height, oldWidth, height); 9124 9125 if (!matrixIsIdentity) { 9126 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 9127 // A change in dimension means an auto-centered pivot point changes, too 9128 mTransformationInfo.mMatrixDirty = true; 9129 } 9130 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 9131 invalidate(true); 9132 } 9133 mBackgroundSizeChanged = true; 9134 invalidateParentIfNeeded(); 9135 } 9136 } 9137 9138 /** 9139 * Right position of this view relative to its parent. 9140 * 9141 * @return The right edge of this view, in pixels. 9142 */ 9143 @ViewDebug.CapturedViewProperty 9144 public final int getRight() { 9145 return mRight; 9146 } 9147 9148 /** 9149 * Sets the right position of this view relative to its parent. This method is meant to be called 9150 * by the layout system and should not generally be called otherwise, because the property 9151 * may be changed at any time by the layout. 9152 * 9153 * @param right The bottom of this view, in pixels. 9154 */ 9155 public final void setRight(int right) { 9156 if (right != mRight) { 9157 updateMatrix(); 9158 final boolean matrixIsIdentity = mTransformationInfo == null 9159 || mTransformationInfo.mMatrixIsIdentity; 9160 if (matrixIsIdentity) { 9161 if (mAttachInfo != null) { 9162 int maxRight; 9163 if (right < mRight) { 9164 maxRight = mRight; 9165 } else { 9166 maxRight = right; 9167 } 9168 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 9169 } 9170 } else { 9171 // Double-invalidation is necessary to capture view's old and new areas 9172 invalidate(true); 9173 } 9174 9175 int oldWidth = mRight - mLeft; 9176 int height = mBottom - mTop; 9177 9178 mRight = right; 9179 if (mDisplayList != null) { 9180 mDisplayList.setRight(mRight); 9181 } 9182 9183 onSizeChanged(mRight - mLeft, height, oldWidth, height); 9184 9185 if (!matrixIsIdentity) { 9186 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 9187 // A change in dimension means an auto-centered pivot point changes, too 9188 mTransformationInfo.mMatrixDirty = true; 9189 } 9190 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 9191 invalidate(true); 9192 } 9193 mBackgroundSizeChanged = true; 9194 invalidateParentIfNeeded(); 9195 } 9196 } 9197 9198 /** 9199 * The visual x position of this view, in pixels. This is equivalent to the 9200 * {@link #setTranslationX(float) translationX} property plus the current 9201 * {@link #getLeft() left} property. 9202 * 9203 * @return The visual x position of this view, in pixels. 9204 */ 9205 @ViewDebug.ExportedProperty(category = "drawing") 9206 public float getX() { 9207 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0); 9208 } 9209 9210 /** 9211 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 9212 * {@link #setTranslationX(float) translationX} property to be the difference between 9213 * the x value passed in and the current {@link #getLeft() left} property. 9214 * 9215 * @param x The visual x position of this view, in pixels. 9216 */ 9217 public void setX(float x) { 9218 setTranslationX(x - mLeft); 9219 } 9220 9221 /** 9222 * The visual y position of this view, in pixels. This is equivalent to the 9223 * {@link #setTranslationY(float) translationY} property plus the current 9224 * {@link #getTop() top} property. 9225 * 9226 * @return The visual y position of this view, in pixels. 9227 */ 9228 @ViewDebug.ExportedProperty(category = "drawing") 9229 public float getY() { 9230 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0); 9231 } 9232 9233 /** 9234 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 9235 * {@link #setTranslationY(float) translationY} property to be the difference between 9236 * the y value passed in and the current {@link #getTop() top} property. 9237 * 9238 * @param y The visual y position of this view, in pixels. 9239 */ 9240 public void setY(float y) { 9241 setTranslationY(y - mTop); 9242 } 9243 9244 9245 /** 9246 * The horizontal location of this view relative to its {@link #getLeft() left} position. 9247 * This position is post-layout, in addition to wherever the object's 9248 * layout placed it. 9249 * 9250 * @return The horizontal position of this view relative to its left position, in pixels. 9251 */ 9252 @ViewDebug.ExportedProperty(category = "drawing") 9253 public float getTranslationX() { 9254 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0; 9255 } 9256 9257 /** 9258 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 9259 * This effectively positions the object post-layout, in addition to wherever the object's 9260 * layout placed it. 9261 * 9262 * @param translationX The horizontal position of this view relative to its left position, 9263 * in pixels. 9264 * 9265 * @attr ref android.R.styleable#View_translationX 9266 */ 9267 public void setTranslationX(float translationX) { 9268 ensureTransformationInfo(); 9269 final TransformationInfo info = mTransformationInfo; 9270 if (info.mTranslationX != translationX) { 9271 // Double-invalidation is necessary to capture view's old and new areas 9272 invalidateViewProperty(true, false); 9273 info.mTranslationX = translationX; 9274 info.mMatrixDirty = true; 9275 invalidateViewProperty(false, true); 9276 if (mDisplayList != null) { 9277 mDisplayList.setTranslationX(translationX); 9278 } 9279 } 9280 } 9281 9282 /** 9283 * The horizontal location of this view relative to its {@link #getTop() top} position. 9284 * This position is post-layout, in addition to wherever the object's 9285 * layout placed it. 9286 * 9287 * @return The vertical position of this view relative to its top position, 9288 * in pixels. 9289 */ 9290 @ViewDebug.ExportedProperty(category = "drawing") 9291 public float getTranslationY() { 9292 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0; 9293 } 9294 9295 /** 9296 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 9297 * This effectively positions the object post-layout, in addition to wherever the object's 9298 * layout placed it. 9299 * 9300 * @param translationY The vertical position of this view relative to its top position, 9301 * in pixels. 9302 * 9303 * @attr ref android.R.styleable#View_translationY 9304 */ 9305 public void setTranslationY(float translationY) { 9306 ensureTransformationInfo(); 9307 final TransformationInfo info = mTransformationInfo; 9308 if (info.mTranslationY != translationY) { 9309 invalidateViewProperty(true, false); 9310 info.mTranslationY = translationY; 9311 info.mMatrixDirty = true; 9312 invalidateViewProperty(false, true); 9313 if (mDisplayList != null) { 9314 mDisplayList.setTranslationY(translationY); 9315 } 9316 } 9317 } 9318 9319 /** 9320 * Hit rectangle in parent's coordinates 9321 * 9322 * @param outRect The hit rectangle of the view. 9323 */ 9324 public void getHitRect(Rect outRect) { 9325 updateMatrix(); 9326 final TransformationInfo info = mTransformationInfo; 9327 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) { 9328 outRect.set(mLeft, mTop, mRight, mBottom); 9329 } else { 9330 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 9331 tmpRect.set(-info.mPivotX, -info.mPivotY, 9332 getWidth() - info.mPivotX, getHeight() - info.mPivotY); 9333 info.mMatrix.mapRect(tmpRect); 9334 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 9335 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 9336 } 9337 } 9338 9339 /** 9340 * Determines whether the given point, in local coordinates is inside the view. 9341 */ 9342 /*package*/ final boolean pointInView(float localX, float localY) { 9343 return localX >= 0 && localX < (mRight - mLeft) 9344 && localY >= 0 && localY < (mBottom - mTop); 9345 } 9346 9347 /** 9348 * Utility method to determine whether the given point, in local coordinates, 9349 * is inside the view, where the area of the view is expanded by the slop factor. 9350 * This method is called while processing touch-move events to determine if the event 9351 * is still within the view. 9352 */ 9353 private boolean pointInView(float localX, float localY, float slop) { 9354 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 9355 localY < ((mBottom - mTop) + slop); 9356 } 9357 9358 /** 9359 * When a view has focus and the user navigates away from it, the next view is searched for 9360 * starting from the rectangle filled in by this method. 9361 * 9362 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)}) 9363 * of the view. However, if your view maintains some idea of internal selection, 9364 * such as a cursor, or a selected row or column, you should override this method and 9365 * fill in a more specific rectangle. 9366 * 9367 * @param r The rectangle to fill in, in this view's coordinates. 9368 */ 9369 public void getFocusedRect(Rect r) { 9370 getDrawingRect(r); 9371 } 9372 9373 /** 9374 * If some part of this view is not clipped by any of its parents, then 9375 * return that area in r in global (root) coordinates. To convert r to local 9376 * coordinates (without taking possible View rotations into account), offset 9377 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 9378 * If the view is completely clipped or translated out, return false. 9379 * 9380 * @param r If true is returned, r holds the global coordinates of the 9381 * visible portion of this view. 9382 * @param globalOffset If true is returned, globalOffset holds the dx,dy 9383 * between this view and its root. globalOffet may be null. 9384 * @return true if r is non-empty (i.e. part of the view is visible at the 9385 * root level. 9386 */ 9387 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 9388 int width = mRight - mLeft; 9389 int height = mBottom - mTop; 9390 if (width > 0 && height > 0) { 9391 r.set(0, 0, width, height); 9392 if (globalOffset != null) { 9393 globalOffset.set(-mScrollX, -mScrollY); 9394 } 9395 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 9396 } 9397 return false; 9398 } 9399 9400 public final boolean getGlobalVisibleRect(Rect r) { 9401 return getGlobalVisibleRect(r, null); 9402 } 9403 9404 public final boolean getLocalVisibleRect(Rect r) { 9405 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point(); 9406 if (getGlobalVisibleRect(r, offset)) { 9407 r.offset(-offset.x, -offset.y); // make r local 9408 return true; 9409 } 9410 return false; 9411 } 9412 9413 /** 9414 * Offset this view's vertical location by the specified number of pixels. 9415 * 9416 * @param offset the number of pixels to offset the view by 9417 */ 9418 public void offsetTopAndBottom(int offset) { 9419 if (offset != 0) { 9420 updateMatrix(); 9421 final boolean matrixIsIdentity = mTransformationInfo == null 9422 || mTransformationInfo.mMatrixIsIdentity; 9423 if (matrixIsIdentity) { 9424 if (mDisplayList != null) { 9425 invalidateViewProperty(false, false); 9426 } else { 9427 final ViewParent p = mParent; 9428 if (p != null && mAttachInfo != null) { 9429 final Rect r = mAttachInfo.mTmpInvalRect; 9430 int minTop; 9431 int maxBottom; 9432 int yLoc; 9433 if (offset < 0) { 9434 minTop = mTop + offset; 9435 maxBottom = mBottom; 9436 yLoc = offset; 9437 } else { 9438 minTop = mTop; 9439 maxBottom = mBottom + offset; 9440 yLoc = 0; 9441 } 9442 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 9443 p.invalidateChild(this, r); 9444 } 9445 } 9446 } else { 9447 invalidateViewProperty(false, false); 9448 } 9449 9450 mTop += offset; 9451 mBottom += offset; 9452 if (mDisplayList != null) { 9453 mDisplayList.offsetTopBottom(offset); 9454 invalidateViewProperty(false, false); 9455 } else { 9456 if (!matrixIsIdentity) { 9457 invalidateViewProperty(false, true); 9458 } 9459 invalidateParentIfNeeded(); 9460 } 9461 } 9462 } 9463 9464 /** 9465 * Offset this view's horizontal location by the specified amount of pixels. 9466 * 9467 * @param offset the numer of pixels to offset the view by 9468 */ 9469 public void offsetLeftAndRight(int offset) { 9470 if (offset != 0) { 9471 updateMatrix(); 9472 final boolean matrixIsIdentity = mTransformationInfo == null 9473 || mTransformationInfo.mMatrixIsIdentity; 9474 if (matrixIsIdentity) { 9475 if (mDisplayList != null) { 9476 invalidateViewProperty(false, false); 9477 } else { 9478 final ViewParent p = mParent; 9479 if (p != null && mAttachInfo != null) { 9480 final Rect r = mAttachInfo.mTmpInvalRect; 9481 int minLeft; 9482 int maxRight; 9483 if (offset < 0) { 9484 minLeft = mLeft + offset; 9485 maxRight = mRight; 9486 } else { 9487 minLeft = mLeft; 9488 maxRight = mRight + offset; 9489 } 9490 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 9491 p.invalidateChild(this, r); 9492 } 9493 } 9494 } else { 9495 invalidateViewProperty(false, false); 9496 } 9497 9498 mLeft += offset; 9499 mRight += offset; 9500 if (mDisplayList != null) { 9501 mDisplayList.offsetLeftRight(offset); 9502 invalidateViewProperty(false, false); 9503 } else { 9504 if (!matrixIsIdentity) { 9505 invalidateViewProperty(false, true); 9506 } 9507 invalidateParentIfNeeded(); 9508 } 9509 } 9510 } 9511 9512 /** 9513 * Get the LayoutParams associated with this view. All views should have 9514 * layout parameters. These supply parameters to the <i>parent</i> of this 9515 * view specifying how it should be arranged. There are many subclasses of 9516 * ViewGroup.LayoutParams, and these correspond to the different subclasses 9517 * of ViewGroup that are responsible for arranging their children. 9518 * 9519 * This method may return null if this View is not attached to a parent 9520 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 9521 * was not invoked successfully. When a View is attached to a parent 9522 * ViewGroup, this method must not return null. 9523 * 9524 * @return The LayoutParams associated with this view, or null if no 9525 * parameters have been set yet 9526 */ 9527 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 9528 public ViewGroup.LayoutParams getLayoutParams() { 9529 return mLayoutParams; 9530 } 9531 9532 /** 9533 * Set the layout parameters associated with this view. These supply 9534 * parameters to the <i>parent</i> of this view specifying how it should be 9535 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 9536 * correspond to the different subclasses of ViewGroup that are responsible 9537 * for arranging their children. 9538 * 9539 * @param params The layout parameters for this view, cannot be null 9540 */ 9541 public void setLayoutParams(ViewGroup.LayoutParams params) { 9542 if (params == null) { 9543 throw new NullPointerException("Layout parameters cannot be null"); 9544 } 9545 mLayoutParams = params; 9546 if (mParent instanceof ViewGroup) { 9547 ((ViewGroup) mParent).onSetLayoutParams(this, params); 9548 } 9549 requestLayout(); 9550 } 9551 9552 /** 9553 * Set the scrolled position of your view. This will cause a call to 9554 * {@link #onScrollChanged(int, int, int, int)} and the view will be 9555 * invalidated. 9556 * @param x the x position to scroll to 9557 * @param y the y position to scroll to 9558 */ 9559 public void scrollTo(int x, int y) { 9560 if (mScrollX != x || mScrollY != y) { 9561 int oldX = mScrollX; 9562 int oldY = mScrollY; 9563 mScrollX = x; 9564 mScrollY = y; 9565 invalidateParentCaches(); 9566 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 9567 if (!awakenScrollBars()) { 9568 postInvalidateOnAnimation(); 9569 } 9570 } 9571 } 9572 9573 /** 9574 * Move the scrolled position of your view. This will cause a call to 9575 * {@link #onScrollChanged(int, int, int, int)} and the view will be 9576 * invalidated. 9577 * @param x the amount of pixels to scroll by horizontally 9578 * @param y the amount of pixels to scroll by vertically 9579 */ 9580 public void scrollBy(int x, int y) { 9581 scrollTo(mScrollX + x, mScrollY + y); 9582 } 9583 9584 /** 9585 * <p>Trigger the scrollbars to draw. When invoked this method starts an 9586 * animation to fade the scrollbars out after a default delay. If a subclass 9587 * provides animated scrolling, the start delay should equal the duration 9588 * of the scrolling animation.</p> 9589 * 9590 * <p>The animation starts only if at least one of the scrollbars is 9591 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 9592 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 9593 * this method returns true, and false otherwise. If the animation is 9594 * started, this method calls {@link #invalidate()}; in that case the 9595 * caller should not call {@link #invalidate()}.</p> 9596 * 9597 * <p>This method should be invoked every time a subclass directly updates 9598 * the scroll parameters.</p> 9599 * 9600 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 9601 * and {@link #scrollTo(int, int)}.</p> 9602 * 9603 * @return true if the animation is played, false otherwise 9604 * 9605 * @see #awakenScrollBars(int) 9606 * @see #scrollBy(int, int) 9607 * @see #scrollTo(int, int) 9608 * @see #isHorizontalScrollBarEnabled() 9609 * @see #isVerticalScrollBarEnabled() 9610 * @see #setHorizontalScrollBarEnabled(boolean) 9611 * @see #setVerticalScrollBarEnabled(boolean) 9612 */ 9613 protected boolean awakenScrollBars() { 9614 return mScrollCache != null && 9615 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 9616 } 9617 9618 /** 9619 * Trigger the scrollbars to draw. 9620 * This method differs from awakenScrollBars() only in its default duration. 9621 * initialAwakenScrollBars() will show the scroll bars for longer than 9622 * usual to give the user more of a chance to notice them. 9623 * 9624 * @return true if the animation is played, false otherwise. 9625 */ 9626 private boolean initialAwakenScrollBars() { 9627 return mScrollCache != null && 9628 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 9629 } 9630 9631 /** 9632 * <p> 9633 * Trigger the scrollbars to draw. When invoked this method starts an 9634 * animation to fade the scrollbars out after a fixed delay. If a subclass 9635 * provides animated scrolling, the start delay should equal the duration of 9636 * the scrolling animation. 9637 * </p> 9638 * 9639 * <p> 9640 * The animation starts only if at least one of the scrollbars is enabled, 9641 * as specified by {@link #isHorizontalScrollBarEnabled()} and 9642 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 9643 * this method returns true, and false otherwise. If the animation is 9644 * started, this method calls {@link #invalidate()}; in that case the caller 9645 * should not call {@link #invalidate()}. 9646 * </p> 9647 * 9648 * <p> 9649 * This method should be invoked everytime a subclass directly updates the 9650 * scroll parameters. 9651 * </p> 9652 * 9653 * @param startDelay the delay, in milliseconds, after which the animation 9654 * should start; when the delay is 0, the animation starts 9655 * immediately 9656 * @return true if the animation is played, false otherwise 9657 * 9658 * @see #scrollBy(int, int) 9659 * @see #scrollTo(int, int) 9660 * @see #isHorizontalScrollBarEnabled() 9661 * @see #isVerticalScrollBarEnabled() 9662 * @see #setHorizontalScrollBarEnabled(boolean) 9663 * @see #setVerticalScrollBarEnabled(boolean) 9664 */ 9665 protected boolean awakenScrollBars(int startDelay) { 9666 return awakenScrollBars(startDelay, true); 9667 } 9668 9669 /** 9670 * <p> 9671 * Trigger the scrollbars to draw. When invoked this method starts an 9672 * animation to fade the scrollbars out after a fixed delay. If a subclass 9673 * provides animated scrolling, the start delay should equal the duration of 9674 * the scrolling animation. 9675 * </p> 9676 * 9677 * <p> 9678 * The animation starts only if at least one of the scrollbars is enabled, 9679 * as specified by {@link #isHorizontalScrollBarEnabled()} and 9680 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 9681 * this method returns true, and false otherwise. If the animation is 9682 * started, this method calls {@link #invalidate()} if the invalidate parameter 9683 * is set to true; in that case the caller 9684 * should not call {@link #invalidate()}. 9685 * </p> 9686 * 9687 * <p> 9688 * This method should be invoked everytime a subclass directly updates the 9689 * scroll parameters. 9690 * </p> 9691 * 9692 * @param startDelay the delay, in milliseconds, after which the animation 9693 * should start; when the delay is 0, the animation starts 9694 * immediately 9695 * 9696 * @param invalidate Wheter this method should call invalidate 9697 * 9698 * @return true if the animation is played, false otherwise 9699 * 9700 * @see #scrollBy(int, int) 9701 * @see #scrollTo(int, int) 9702 * @see #isHorizontalScrollBarEnabled() 9703 * @see #isVerticalScrollBarEnabled() 9704 * @see #setHorizontalScrollBarEnabled(boolean) 9705 * @see #setVerticalScrollBarEnabled(boolean) 9706 */ 9707 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 9708 final ScrollabilityCache scrollCache = mScrollCache; 9709 9710 if (scrollCache == null || !scrollCache.fadeScrollBars) { 9711 return false; 9712 } 9713 9714 if (scrollCache.scrollBar == null) { 9715 scrollCache.scrollBar = new ScrollBarDrawable(); 9716 } 9717 9718 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 9719 9720 if (invalidate) { 9721 // Invalidate to show the scrollbars 9722 postInvalidateOnAnimation(); 9723 } 9724 9725 if (scrollCache.state == ScrollabilityCache.OFF) { 9726 // FIXME: this is copied from WindowManagerService. 9727 // We should get this value from the system when it 9728 // is possible to do so. 9729 final int KEY_REPEAT_FIRST_DELAY = 750; 9730 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 9731 } 9732 9733 // Tell mScrollCache when we should start fading. This may 9734 // extend the fade start time if one was already scheduled 9735 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 9736 scrollCache.fadeStartTime = fadeStartTime; 9737 scrollCache.state = ScrollabilityCache.ON; 9738 9739 // Schedule our fader to run, unscheduling any old ones first 9740 if (mAttachInfo != null) { 9741 mAttachInfo.mHandler.removeCallbacks(scrollCache); 9742 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 9743 } 9744 9745 return true; 9746 } 9747 9748 return false; 9749 } 9750 9751 /** 9752 * Do not invalidate views which are not visible and which are not running an animation. They 9753 * will not get drawn and they should not set dirty flags as if they will be drawn 9754 */ 9755 private boolean skipInvalidate() { 9756 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 9757 (!(mParent instanceof ViewGroup) || 9758 !((ViewGroup) mParent).isViewTransitioning(this)); 9759 } 9760 /** 9761 * Mark the area defined by dirty as needing to be drawn. If the view is 9762 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point 9763 * in the future. This must be called from a UI thread. To call from a non-UI 9764 * thread, call {@link #postInvalidate()}. 9765 * 9766 * WARNING: This method is destructive to dirty. 9767 * @param dirty the rectangle representing the bounds of the dirty region 9768 */ 9769 public void invalidate(Rect dirty) { 9770 if (ViewDebug.TRACE_HIERARCHY) { 9771 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 9772 } 9773 9774 if (skipInvalidate()) { 9775 return; 9776 } 9777 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 9778 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID || 9779 (mPrivateFlags & INVALIDATED) != INVALIDATED) { 9780 mPrivateFlags &= ~DRAWING_CACHE_VALID; 9781 mPrivateFlags |= INVALIDATED; 9782 mPrivateFlags |= DIRTY; 9783 final ViewParent p = mParent; 9784 final AttachInfo ai = mAttachInfo; 9785 //noinspection PointlessBooleanExpression,ConstantConditions 9786 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 9787 if (p != null && ai != null && ai.mHardwareAccelerated) { 9788 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 9789 // with a null dirty rect, which tells the ViewAncestor to redraw everything 9790 p.invalidateChild(this, null); 9791 return; 9792 } 9793 } 9794 if (p != null && ai != null) { 9795 final int scrollX = mScrollX; 9796 final int scrollY = mScrollY; 9797 final Rect r = ai.mTmpInvalRect; 9798 r.set(dirty.left - scrollX, dirty.top - scrollY, 9799 dirty.right - scrollX, dirty.bottom - scrollY); 9800 mParent.invalidateChild(this, r); 9801 } 9802 } 9803 } 9804 9805 /** 9806 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. 9807 * The coordinates of the dirty rect are relative to the view. 9808 * If the view is visible, {@link #onDraw(android.graphics.Canvas)} 9809 * will be called at some point in the future. This must be called from 9810 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}. 9811 * @param l the left position of the dirty region 9812 * @param t the top position of the dirty region 9813 * @param r the right position of the dirty region 9814 * @param b the bottom position of the dirty region 9815 */ 9816 public void invalidate(int l, int t, int r, int b) { 9817 if (ViewDebug.TRACE_HIERARCHY) { 9818 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 9819 } 9820 9821 if (skipInvalidate()) { 9822 return; 9823 } 9824 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 9825 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID || 9826 (mPrivateFlags & INVALIDATED) != INVALIDATED) { 9827 mPrivateFlags &= ~DRAWING_CACHE_VALID; 9828 mPrivateFlags |= INVALIDATED; 9829 mPrivateFlags |= DIRTY; 9830 final ViewParent p = mParent; 9831 final AttachInfo ai = mAttachInfo; 9832 //noinspection PointlessBooleanExpression,ConstantConditions 9833 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 9834 if (p != null && ai != null && ai.mHardwareAccelerated) { 9835 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 9836 // with a null dirty rect, which tells the ViewAncestor to redraw everything 9837 p.invalidateChild(this, null); 9838 return; 9839 } 9840 } 9841 if (p != null && ai != null && l < r && t < b) { 9842 final int scrollX = mScrollX; 9843 final int scrollY = mScrollY; 9844 final Rect tmpr = ai.mTmpInvalRect; 9845 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY); 9846 p.invalidateChild(this, tmpr); 9847 } 9848 } 9849 } 9850 9851 /** 9852 * Invalidate the whole view. If the view is visible, 9853 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 9854 * the future. This must be called from a UI thread. To call from a non-UI thread, 9855 * call {@link #postInvalidate()}. 9856 */ 9857 public void invalidate() { 9858 invalidate(true); 9859 } 9860 9861 /** 9862 * This is where the invalidate() work actually happens. A full invalidate() 9863 * causes the drawing cache to be invalidated, but this function can be called with 9864 * invalidateCache set to false to skip that invalidation step for cases that do not 9865 * need it (for example, a component that remains at the same dimensions with the same 9866 * content). 9867 * 9868 * @param invalidateCache Whether the drawing cache for this view should be invalidated as 9869 * well. This is usually true for a full invalidate, but may be set to false if the 9870 * View's contents or dimensions have not changed. 9871 */ 9872 void invalidate(boolean invalidateCache) { 9873 if (ViewDebug.TRACE_HIERARCHY) { 9874 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 9875 } 9876 9877 if (skipInvalidate()) { 9878 return; 9879 } 9880 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 9881 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) || 9882 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) { 9883 mLastIsOpaque = isOpaque(); 9884 mPrivateFlags &= ~DRAWN; 9885 mPrivateFlags |= DIRTY; 9886 if (invalidateCache) { 9887 mPrivateFlags |= INVALIDATED; 9888 mPrivateFlags &= ~DRAWING_CACHE_VALID; 9889 } 9890 final AttachInfo ai = mAttachInfo; 9891 final ViewParent p = mParent; 9892 //noinspection PointlessBooleanExpression,ConstantConditions 9893 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 9894 if (p != null && ai != null && ai.mHardwareAccelerated) { 9895 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 9896 // with a null dirty rect, which tells the ViewAncestor to redraw everything 9897 p.invalidateChild(this, null); 9898 return; 9899 } 9900 } 9901 9902 if (p != null && ai != null) { 9903 final Rect r = ai.mTmpInvalRect; 9904 r.set(0, 0, mRight - mLeft, mBottom - mTop); 9905 // Don't call invalidate -- we don't want to internally scroll 9906 // our own bounds 9907 p.invalidateChild(this, r); 9908 } 9909 } 9910 } 9911 9912 /** 9913 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to 9914 * set any flags or handle all of the cases handled by the default invalidation methods. 9915 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate 9916 * dirty rect. This method calls into fast invalidation methods in ViewGroup that 9917 * walk up the hierarchy, transforming the dirty rect as necessary. 9918 * 9919 * The method also handles normal invalidation logic if display list properties are not 9920 * being used in this view. The invalidateParent and forceRedraw flags are used by that 9921 * backup approach, to handle these cases used in the various property-setting methods. 9922 * 9923 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties 9924 * are not being used in this view 9925 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display 9926 * list properties are not being used in this view 9927 */ 9928 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) { 9929 if (mDisplayList == null || (mPrivateFlags & DRAW_ANIMATION) == DRAW_ANIMATION) { 9930 if (invalidateParent) { 9931 invalidateParentCaches(); 9932 } 9933 if (forceRedraw) { 9934 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 9935 } 9936 invalidate(false); 9937 } else { 9938 final AttachInfo ai = mAttachInfo; 9939 final ViewParent p = mParent; 9940 if (p != null && ai != null) { 9941 final Rect r = ai.mTmpInvalRect; 9942 r.set(0, 0, mRight - mLeft, mBottom - mTop); 9943 if (mParent instanceof ViewGroup) { 9944 ((ViewGroup) mParent).invalidateChildFast(this, r); 9945 } else { 9946 mParent.invalidateChild(this, r); 9947 } 9948 } 9949 } 9950 } 9951 9952 /** 9953 * Utility method to transform a given Rect by the current matrix of this view. 9954 */ 9955 void transformRect(final Rect rect) { 9956 if (!getMatrix().isIdentity()) { 9957 RectF boundingRect = mAttachInfo.mTmpTransformRect; 9958 boundingRect.set(rect); 9959 getMatrix().mapRect(boundingRect); 9960 rect.set((int) (boundingRect.left - 0.5f), 9961 (int) (boundingRect.top - 0.5f), 9962 (int) (boundingRect.right + 0.5f), 9963 (int) (boundingRect.bottom + 0.5f)); 9964 } 9965 } 9966 9967 /** 9968 * Used to indicate that the parent of this view should clear its caches. This functionality 9969 * is used to force the parent to rebuild its display list (when hardware-accelerated), 9970 * which is necessary when various parent-managed properties of the view change, such as 9971 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 9972 * clears the parent caches and does not causes an invalidate event. 9973 * 9974 * @hide 9975 */ 9976 protected void invalidateParentCaches() { 9977 if (mParent instanceof View) { 9978 ((View) mParent).mPrivateFlags |= INVALIDATED; 9979 } 9980 } 9981 9982 /** 9983 * Used to indicate that the parent of this view should be invalidated. This functionality 9984 * is used to force the parent to rebuild its display list (when hardware-accelerated), 9985 * which is necessary when various parent-managed properties of the view change, such as 9986 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 9987 * an invalidation event to the parent. 9988 * 9989 * @hide 9990 */ 9991 protected void invalidateParentIfNeeded() { 9992 if (isHardwareAccelerated() && mParent instanceof View) { 9993 ((View) mParent).invalidate(true); 9994 } 9995 } 9996 9997 /** 9998 * Indicates whether this View is opaque. An opaque View guarantees that it will 9999 * draw all the pixels overlapping its bounds using a fully opaque color. 10000 * 10001 * Subclasses of View should override this method whenever possible to indicate 10002 * whether an instance is opaque. Opaque Views are treated in a special way by 10003 * the View hierarchy, possibly allowing it to perform optimizations during 10004 * invalidate/draw passes. 10005 * 10006 * @return True if this View is guaranteed to be fully opaque, false otherwise. 10007 */ 10008 @ViewDebug.ExportedProperty(category = "drawing") 10009 public boolean isOpaque() { 10010 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK && 10011 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1) 10012 >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD); 10013 } 10014 10015 /** 10016 * @hide 10017 */ 10018 protected void computeOpaqueFlags() { 10019 // Opaque if: 10020 // - Has a background 10021 // - Background is opaque 10022 // - Doesn't have scrollbars or scrollbars are inside overlay 10023 10024 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) { 10025 mPrivateFlags |= OPAQUE_BACKGROUND; 10026 } else { 10027 mPrivateFlags &= ~OPAQUE_BACKGROUND; 10028 } 10029 10030 final int flags = mViewFlags; 10031 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 10032 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) { 10033 mPrivateFlags |= OPAQUE_SCROLLBARS; 10034 } else { 10035 mPrivateFlags &= ~OPAQUE_SCROLLBARS; 10036 } 10037 } 10038 10039 /** 10040 * @hide 10041 */ 10042 protected boolean hasOpaqueScrollbars() { 10043 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS; 10044 } 10045 10046 /** 10047 * @return A handler associated with the thread running the View. This 10048 * handler can be used to pump events in the UI events queue. 10049 */ 10050 public Handler getHandler() { 10051 if (mAttachInfo != null) { 10052 return mAttachInfo.mHandler; 10053 } 10054 return null; 10055 } 10056 10057 /** 10058 * Gets the view root associated with the View. 10059 * @return The view root, or null if none. 10060 * @hide 10061 */ 10062 public ViewRootImpl getViewRootImpl() { 10063 if (mAttachInfo != null) { 10064 return mAttachInfo.mViewRootImpl; 10065 } 10066 return null; 10067 } 10068 10069 /** 10070 * <p>Causes the Runnable to be added to the message queue. 10071 * The runnable will be run on the user interface thread.</p> 10072 * 10073 * <p>This method can be invoked from outside of the UI thread 10074 * only when this View is attached to a window.</p> 10075 * 10076 * @param action The Runnable that will be executed. 10077 * 10078 * @return Returns true if the Runnable was successfully placed in to the 10079 * message queue. Returns false on failure, usually because the 10080 * looper processing the message queue is exiting. 10081 * 10082 * @see #postDelayed 10083 * @see #removeCallbacks 10084 */ 10085 public boolean post(Runnable action) { 10086 final AttachInfo attachInfo = mAttachInfo; 10087 if (attachInfo != null) { 10088 return attachInfo.mHandler.post(action); 10089 } 10090 // Assume that post will succeed later 10091 ViewRootImpl.getRunQueue().post(action); 10092 return true; 10093 } 10094 10095 /** 10096 * <p>Causes the Runnable to be added to the message queue, to be run 10097 * after the specified amount of time elapses. 10098 * The runnable will be run on the user interface thread.</p> 10099 * 10100 * <p>This method can be invoked from outside of the UI thread 10101 * only when this View is attached to a window.</p> 10102 * 10103 * @param action The Runnable that will be executed. 10104 * @param delayMillis The delay (in milliseconds) until the Runnable 10105 * will be executed. 10106 * 10107 * @return true if the Runnable was successfully placed in to the 10108 * message queue. Returns false on failure, usually because the 10109 * looper processing the message queue is exiting. Note that a 10110 * result of true does not mean the Runnable will be processed -- 10111 * if the looper is quit before the delivery time of the message 10112 * occurs then the message will be dropped. 10113 * 10114 * @see #post 10115 * @see #removeCallbacks 10116 */ 10117 public boolean postDelayed(Runnable action, long delayMillis) { 10118 final AttachInfo attachInfo = mAttachInfo; 10119 if (attachInfo != null) { 10120 return attachInfo.mHandler.postDelayed(action, delayMillis); 10121 } 10122 // Assume that post will succeed later 10123 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 10124 return true; 10125 } 10126 10127 /** 10128 * <p>Causes the Runnable to execute on the next animation time step. 10129 * The runnable will be run on the user interface thread.</p> 10130 * 10131 * <p>This method can be invoked from outside of the UI thread 10132 * only when this View is attached to a window.</p> 10133 * 10134 * @param action The Runnable that will be executed. 10135 * 10136 * @see #postOnAnimationDelayed 10137 * @see #removeCallbacks 10138 */ 10139 public void postOnAnimation(Runnable action) { 10140 final AttachInfo attachInfo = mAttachInfo; 10141 if (attachInfo != null) { 10142 attachInfo.mViewRootImpl.mChoreographer.postCallback( 10143 Choreographer.CALLBACK_ANIMATION, action, null); 10144 } else { 10145 // Assume that post will succeed later 10146 ViewRootImpl.getRunQueue().post(action); 10147 } 10148 } 10149 10150 /** 10151 * <p>Causes the Runnable to execute on the next animation time step, 10152 * after the specified amount of time elapses. 10153 * The runnable will be run on the user interface thread.</p> 10154 * 10155 * <p>This method can be invoked from outside of the UI thread 10156 * only when this View is attached to a window.</p> 10157 * 10158 * @param action The Runnable that will be executed. 10159 * @param delayMillis The delay (in milliseconds) until the Runnable 10160 * will be executed. 10161 * 10162 * @see #postOnAnimation 10163 * @see #removeCallbacks 10164 */ 10165 public void postOnAnimationDelayed(Runnable action, long delayMillis) { 10166 final AttachInfo attachInfo = mAttachInfo; 10167 if (attachInfo != null) { 10168 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 10169 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis); 10170 } else { 10171 // Assume that post will succeed later 10172 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 10173 } 10174 } 10175 10176 /** 10177 * <p>Removes the specified Runnable from the message queue.</p> 10178 * 10179 * <p>This method can be invoked from outside of the UI thread 10180 * only when this View is attached to a window.</p> 10181 * 10182 * @param action The Runnable to remove from the message handling queue 10183 * 10184 * @return true if this view could ask the Handler to remove the Runnable, 10185 * false otherwise. When the returned value is true, the Runnable 10186 * may or may not have been actually removed from the message queue 10187 * (for instance, if the Runnable was not in the queue already.) 10188 * 10189 * @see #post 10190 * @see #postDelayed 10191 * @see #postOnAnimation 10192 * @see #postOnAnimationDelayed 10193 */ 10194 public boolean removeCallbacks(Runnable action) { 10195 if (action != null) { 10196 final AttachInfo attachInfo = mAttachInfo; 10197 if (attachInfo != null) { 10198 attachInfo.mHandler.removeCallbacks(action); 10199 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 10200 Choreographer.CALLBACK_ANIMATION, action, null); 10201 } else { 10202 // Assume that post will succeed later 10203 ViewRootImpl.getRunQueue().removeCallbacks(action); 10204 } 10205 } 10206 return true; 10207 } 10208 10209 /** 10210 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 10211 * Use this to invalidate the View from a non-UI thread.</p> 10212 * 10213 * <p>This method can be invoked from outside of the UI thread 10214 * only when this View is attached to a window.</p> 10215 * 10216 * @see #invalidate() 10217 * @see #postInvalidateDelayed(long) 10218 */ 10219 public void postInvalidate() { 10220 postInvalidateDelayed(0); 10221 } 10222 10223 /** 10224 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 10225 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 10226 * 10227 * <p>This method can be invoked from outside of the UI thread 10228 * only when this View is attached to a window.</p> 10229 * 10230 * @param left The left coordinate of the rectangle to invalidate. 10231 * @param top The top coordinate of the rectangle to invalidate. 10232 * @param right The right coordinate of the rectangle to invalidate. 10233 * @param bottom The bottom coordinate of the rectangle to invalidate. 10234 * 10235 * @see #invalidate(int, int, int, int) 10236 * @see #invalidate(Rect) 10237 * @see #postInvalidateDelayed(long, int, int, int, int) 10238 */ 10239 public void postInvalidate(int left, int top, int right, int bottom) { 10240 postInvalidateDelayed(0, left, top, right, bottom); 10241 } 10242 10243 /** 10244 * <p>Cause an invalidate to happen on a subsequent cycle through the event 10245 * loop. Waits for the specified amount of time.</p> 10246 * 10247 * <p>This method can be invoked from outside of the UI thread 10248 * only when this View is attached to a window.</p> 10249 * 10250 * @param delayMilliseconds the duration in milliseconds to delay the 10251 * invalidation by 10252 * 10253 * @see #invalidate() 10254 * @see #postInvalidate() 10255 */ 10256 public void postInvalidateDelayed(long delayMilliseconds) { 10257 // We try only with the AttachInfo because there's no point in invalidating 10258 // if we are not attached to our window 10259 final AttachInfo attachInfo = mAttachInfo; 10260 if (attachInfo != null) { 10261 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds); 10262 } 10263 } 10264 10265 /** 10266 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 10267 * through the event loop. Waits for the specified amount of time.</p> 10268 * 10269 * <p>This method can be invoked from outside of the UI thread 10270 * only when this View is attached to a window.</p> 10271 * 10272 * @param delayMilliseconds the duration in milliseconds to delay the 10273 * invalidation by 10274 * @param left The left coordinate of the rectangle to invalidate. 10275 * @param top The top coordinate of the rectangle to invalidate. 10276 * @param right The right coordinate of the rectangle to invalidate. 10277 * @param bottom The bottom coordinate of the rectangle to invalidate. 10278 * 10279 * @see #invalidate(int, int, int, int) 10280 * @see #invalidate(Rect) 10281 * @see #postInvalidate(int, int, int, int) 10282 */ 10283 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 10284 int right, int bottom) { 10285 10286 // We try only with the AttachInfo because there's no point in invalidating 10287 // if we are not attached to our window 10288 final AttachInfo attachInfo = mAttachInfo; 10289 if (attachInfo != null) { 10290 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 10291 info.target = this; 10292 info.left = left; 10293 info.top = top; 10294 info.right = right; 10295 info.bottom = bottom; 10296 10297 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds); 10298 } 10299 } 10300 10301 /** 10302 * <p>Cause an invalidate to happen on the next animation time step, typically the 10303 * next display frame.</p> 10304 * 10305 * <p>This method can be invoked from outside of the UI thread 10306 * only when this View is attached to a window.</p> 10307 * 10308 * @see #invalidate() 10309 */ 10310 public void postInvalidateOnAnimation() { 10311 // We try only with the AttachInfo because there's no point in invalidating 10312 // if we are not attached to our window 10313 final AttachInfo attachInfo = mAttachInfo; 10314 if (attachInfo != null) { 10315 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this); 10316 } 10317 } 10318 10319 /** 10320 * <p>Cause an invalidate of the specified area to happen on the next animation 10321 * time step, typically the next display frame.</p> 10322 * 10323 * <p>This method can be invoked from outside of the UI thread 10324 * only when this View is attached to a window.</p> 10325 * 10326 * @param left The left coordinate of the rectangle to invalidate. 10327 * @param top The top coordinate of the rectangle to invalidate. 10328 * @param right The right coordinate of the rectangle to invalidate. 10329 * @param bottom The bottom coordinate of the rectangle to invalidate. 10330 * 10331 * @see #invalidate(int, int, int, int) 10332 * @see #invalidate(Rect) 10333 */ 10334 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) { 10335 // We try only with the AttachInfo because there's no point in invalidating 10336 // if we are not attached to our window 10337 final AttachInfo attachInfo = mAttachInfo; 10338 if (attachInfo != null) { 10339 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 10340 info.target = this; 10341 info.left = left; 10342 info.top = top; 10343 info.right = right; 10344 info.bottom = bottom; 10345 10346 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info); 10347 } 10348 } 10349 10350 /** 10351 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 10352 * This event is sent at most once every 10353 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 10354 */ 10355 private void postSendViewScrolledAccessibilityEventCallback() { 10356 if (mSendViewScrolledAccessibilityEvent == null) { 10357 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 10358 } 10359 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 10360 mSendViewScrolledAccessibilityEvent.mIsPending = true; 10361 postDelayed(mSendViewScrolledAccessibilityEvent, 10362 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 10363 } 10364 } 10365 10366 /** 10367 * Called by a parent to request that a child update its values for mScrollX 10368 * and mScrollY if necessary. This will typically be done if the child is 10369 * animating a scroll using a {@link android.widget.Scroller Scroller} 10370 * object. 10371 */ 10372 public void computeScroll() { 10373 } 10374 10375 /** 10376 * <p>Indicate whether the horizontal edges are faded when the view is 10377 * scrolled horizontally.</p> 10378 * 10379 * @return true if the horizontal edges should are faded on scroll, false 10380 * otherwise 10381 * 10382 * @see #setHorizontalFadingEdgeEnabled(boolean) 10383 * 10384 * @attr ref android.R.styleable#View_requiresFadingEdge 10385 */ 10386 public boolean isHorizontalFadingEdgeEnabled() { 10387 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 10388 } 10389 10390 /** 10391 * <p>Define whether the horizontal edges should be faded when this view 10392 * is scrolled horizontally.</p> 10393 * 10394 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 10395 * be faded when the view is scrolled 10396 * horizontally 10397 * 10398 * @see #isHorizontalFadingEdgeEnabled() 10399 * 10400 * @attr ref android.R.styleable#View_requiresFadingEdge 10401 */ 10402 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 10403 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 10404 if (horizontalFadingEdgeEnabled) { 10405 initScrollCache(); 10406 } 10407 10408 mViewFlags ^= FADING_EDGE_HORIZONTAL; 10409 } 10410 } 10411 10412 /** 10413 * <p>Indicate whether the vertical edges are faded when the view is 10414 * scrolled horizontally.</p> 10415 * 10416 * @return true if the vertical edges should are faded on scroll, false 10417 * otherwise 10418 * 10419 * @see #setVerticalFadingEdgeEnabled(boolean) 10420 * 10421 * @attr ref android.R.styleable#View_requiresFadingEdge 10422 */ 10423 public boolean isVerticalFadingEdgeEnabled() { 10424 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 10425 } 10426 10427 /** 10428 * <p>Define whether the vertical edges should be faded when this view 10429 * is scrolled vertically.</p> 10430 * 10431 * @param verticalFadingEdgeEnabled true if the vertical edges should 10432 * be faded when the view is scrolled 10433 * vertically 10434 * 10435 * @see #isVerticalFadingEdgeEnabled() 10436 * 10437 * @attr ref android.R.styleable#View_requiresFadingEdge 10438 */ 10439 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 10440 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 10441 if (verticalFadingEdgeEnabled) { 10442 initScrollCache(); 10443 } 10444 10445 mViewFlags ^= FADING_EDGE_VERTICAL; 10446 } 10447 } 10448 10449 /** 10450 * Returns the strength, or intensity, of the top faded edge. The strength is 10451 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10452 * returns 0.0 or 1.0 but no value in between. 10453 * 10454 * Subclasses should override this method to provide a smoother fade transition 10455 * when scrolling occurs. 10456 * 10457 * @return the intensity of the top fade as a float between 0.0f and 1.0f 10458 */ 10459 protected float getTopFadingEdgeStrength() { 10460 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 10461 } 10462 10463 /** 10464 * Returns the strength, or intensity, of the bottom faded edge. The strength is 10465 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10466 * returns 0.0 or 1.0 but no value in between. 10467 * 10468 * Subclasses should override this method to provide a smoother fade transition 10469 * when scrolling occurs. 10470 * 10471 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 10472 */ 10473 protected float getBottomFadingEdgeStrength() { 10474 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 10475 computeVerticalScrollRange() ? 1.0f : 0.0f; 10476 } 10477 10478 /** 10479 * Returns the strength, or intensity, of the left faded edge. The strength is 10480 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10481 * returns 0.0 or 1.0 but no value in between. 10482 * 10483 * Subclasses should override this method to provide a smoother fade transition 10484 * when scrolling occurs. 10485 * 10486 * @return the intensity of the left fade as a float between 0.0f and 1.0f 10487 */ 10488 protected float getLeftFadingEdgeStrength() { 10489 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 10490 } 10491 10492 /** 10493 * Returns the strength, or intensity, of the right faded edge. The strength is 10494 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 10495 * returns 0.0 or 1.0 but no value in between. 10496 * 10497 * Subclasses should override this method to provide a smoother fade transition 10498 * when scrolling occurs. 10499 * 10500 * @return the intensity of the right fade as a float between 0.0f and 1.0f 10501 */ 10502 protected float getRightFadingEdgeStrength() { 10503 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 10504 computeHorizontalScrollRange() ? 1.0f : 0.0f; 10505 } 10506 10507 /** 10508 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 10509 * scrollbar is not drawn by default.</p> 10510 * 10511 * @return true if the horizontal scrollbar should be painted, false 10512 * otherwise 10513 * 10514 * @see #setHorizontalScrollBarEnabled(boolean) 10515 */ 10516 public boolean isHorizontalScrollBarEnabled() { 10517 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 10518 } 10519 10520 /** 10521 * <p>Define whether the horizontal scrollbar should be drawn or not. The 10522 * scrollbar is not drawn by default.</p> 10523 * 10524 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 10525 * be painted 10526 * 10527 * @see #isHorizontalScrollBarEnabled() 10528 */ 10529 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 10530 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 10531 mViewFlags ^= SCROLLBARS_HORIZONTAL; 10532 computeOpaqueFlags(); 10533 resolvePadding(); 10534 } 10535 } 10536 10537 /** 10538 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 10539 * scrollbar is not drawn by default.</p> 10540 * 10541 * @return true if the vertical scrollbar should be painted, false 10542 * otherwise 10543 * 10544 * @see #setVerticalScrollBarEnabled(boolean) 10545 */ 10546 public boolean isVerticalScrollBarEnabled() { 10547 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 10548 } 10549 10550 /** 10551 * <p>Define whether the vertical scrollbar should be drawn or not. The 10552 * scrollbar is not drawn by default.</p> 10553 * 10554 * @param verticalScrollBarEnabled true if the vertical scrollbar should 10555 * be painted 10556 * 10557 * @see #isVerticalScrollBarEnabled() 10558 */ 10559 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 10560 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 10561 mViewFlags ^= SCROLLBARS_VERTICAL; 10562 computeOpaqueFlags(); 10563 resolvePadding(); 10564 } 10565 } 10566 10567 /** 10568 * @hide 10569 */ 10570 protected void recomputePadding() { 10571 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 10572 } 10573 10574 /** 10575 * Define whether scrollbars will fade when the view is not scrolling. 10576 * 10577 * @param fadeScrollbars wheter to enable fading 10578 * 10579 * @attr ref android.R.styleable#View_fadeScrollbars 10580 */ 10581 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 10582 initScrollCache(); 10583 final ScrollabilityCache scrollabilityCache = mScrollCache; 10584 scrollabilityCache.fadeScrollBars = fadeScrollbars; 10585 if (fadeScrollbars) { 10586 scrollabilityCache.state = ScrollabilityCache.OFF; 10587 } else { 10588 scrollabilityCache.state = ScrollabilityCache.ON; 10589 } 10590 } 10591 10592 /** 10593 * 10594 * Returns true if scrollbars will fade when this view is not scrolling 10595 * 10596 * @return true if scrollbar fading is enabled 10597 * 10598 * @attr ref android.R.styleable#View_fadeScrollbars 10599 */ 10600 public boolean isScrollbarFadingEnabled() { 10601 return mScrollCache != null && mScrollCache.fadeScrollBars; 10602 } 10603 10604 /** 10605 * 10606 * Returns the delay before scrollbars fade. 10607 * 10608 * @return the delay before scrollbars fade 10609 * 10610 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 10611 */ 10612 public int getScrollBarDefaultDelayBeforeFade() { 10613 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() : 10614 mScrollCache.scrollBarDefaultDelayBeforeFade; 10615 } 10616 10617 /** 10618 * Define the delay before scrollbars fade. 10619 * 10620 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade 10621 * 10622 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 10623 */ 10624 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) { 10625 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade; 10626 } 10627 10628 /** 10629 * 10630 * Returns the scrollbar fade duration. 10631 * 10632 * @return the scrollbar fade duration 10633 * 10634 * @attr ref android.R.styleable#View_scrollbarFadeDuration 10635 */ 10636 public int getScrollBarFadeDuration() { 10637 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() : 10638 mScrollCache.scrollBarFadeDuration; 10639 } 10640 10641 /** 10642 * Define the scrollbar fade duration. 10643 * 10644 * @param scrollBarFadeDuration - the scrollbar fade duration 10645 * 10646 * @attr ref android.R.styleable#View_scrollbarFadeDuration 10647 */ 10648 public void setScrollBarFadeDuration(int scrollBarFadeDuration) { 10649 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration; 10650 } 10651 10652 /** 10653 * 10654 * Returns the scrollbar size. 10655 * 10656 * @return the scrollbar size 10657 * 10658 * @attr ref android.R.styleable#View_scrollbarSize 10659 */ 10660 public int getScrollBarSize() { 10661 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() : 10662 mScrollCache.scrollBarSize; 10663 } 10664 10665 /** 10666 * Define the scrollbar size. 10667 * 10668 * @param scrollBarSize - the scrollbar size 10669 * 10670 * @attr ref android.R.styleable#View_scrollbarSize 10671 */ 10672 public void setScrollBarSize(int scrollBarSize) { 10673 getScrollCache().scrollBarSize = scrollBarSize; 10674 } 10675 10676 /** 10677 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 10678 * inset. When inset, they add to the padding of the view. And the scrollbars 10679 * can be drawn inside the padding area or on the edge of the view. For example, 10680 * if a view has a background drawable and you want to draw the scrollbars 10681 * inside the padding specified by the drawable, you can use 10682 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 10683 * appear at the edge of the view, ignoring the padding, then you can use 10684 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 10685 * @param style the style of the scrollbars. Should be one of 10686 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 10687 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 10688 * @see #SCROLLBARS_INSIDE_OVERLAY 10689 * @see #SCROLLBARS_INSIDE_INSET 10690 * @see #SCROLLBARS_OUTSIDE_OVERLAY 10691 * @see #SCROLLBARS_OUTSIDE_INSET 10692 * 10693 * @attr ref android.R.styleable#View_scrollbarStyle 10694 */ 10695 public void setScrollBarStyle(int style) { 10696 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 10697 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 10698 computeOpaqueFlags(); 10699 resolvePadding(); 10700 } 10701 } 10702 10703 /** 10704 * <p>Returns the current scrollbar style.</p> 10705 * @return the current scrollbar style 10706 * @see #SCROLLBARS_INSIDE_OVERLAY 10707 * @see #SCROLLBARS_INSIDE_INSET 10708 * @see #SCROLLBARS_OUTSIDE_OVERLAY 10709 * @see #SCROLLBARS_OUTSIDE_INSET 10710 * 10711 * @attr ref android.R.styleable#View_scrollbarStyle 10712 */ 10713 @ViewDebug.ExportedProperty(mapping = { 10714 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 10715 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 10716 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 10717 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 10718 }) 10719 public int getScrollBarStyle() { 10720 return mViewFlags & SCROLLBARS_STYLE_MASK; 10721 } 10722 10723 /** 10724 * <p>Compute the horizontal range that the horizontal scrollbar 10725 * represents.</p> 10726 * 10727 * <p>The range is expressed in arbitrary units that must be the same as the 10728 * units used by {@link #computeHorizontalScrollExtent()} and 10729 * {@link #computeHorizontalScrollOffset()}.</p> 10730 * 10731 * <p>The default range is the drawing width of this view.</p> 10732 * 10733 * @return the total horizontal range represented by the horizontal 10734 * scrollbar 10735 * 10736 * @see #computeHorizontalScrollExtent() 10737 * @see #computeHorizontalScrollOffset() 10738 * @see android.widget.ScrollBarDrawable 10739 */ 10740 protected int computeHorizontalScrollRange() { 10741 return getWidth(); 10742 } 10743 10744 /** 10745 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 10746 * within the horizontal range. This value is used to compute the position 10747 * of the thumb within the scrollbar's track.</p> 10748 * 10749 * <p>The range is expressed in arbitrary units that must be the same as the 10750 * units used by {@link #computeHorizontalScrollRange()} and 10751 * {@link #computeHorizontalScrollExtent()}.</p> 10752 * 10753 * <p>The default offset is the scroll offset of this view.</p> 10754 * 10755 * @return the horizontal offset of the scrollbar's thumb 10756 * 10757 * @see #computeHorizontalScrollRange() 10758 * @see #computeHorizontalScrollExtent() 10759 * @see android.widget.ScrollBarDrawable 10760 */ 10761 protected int computeHorizontalScrollOffset() { 10762 return mScrollX; 10763 } 10764 10765 /** 10766 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 10767 * within the horizontal range. This value is used to compute the length 10768 * of the thumb within the scrollbar's track.</p> 10769 * 10770 * <p>The range is expressed in arbitrary units that must be the same as the 10771 * units used by {@link #computeHorizontalScrollRange()} and 10772 * {@link #computeHorizontalScrollOffset()}.</p> 10773 * 10774 * <p>The default extent is the drawing width of this view.</p> 10775 * 10776 * @return the horizontal extent of the scrollbar's thumb 10777 * 10778 * @see #computeHorizontalScrollRange() 10779 * @see #computeHorizontalScrollOffset() 10780 * @see android.widget.ScrollBarDrawable 10781 */ 10782 protected int computeHorizontalScrollExtent() { 10783 return getWidth(); 10784 } 10785 10786 /** 10787 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 10788 * 10789 * <p>The range is expressed in arbitrary units that must be the same as the 10790 * units used by {@link #computeVerticalScrollExtent()} and 10791 * {@link #computeVerticalScrollOffset()}.</p> 10792 * 10793 * @return the total vertical range represented by the vertical scrollbar 10794 * 10795 * <p>The default range is the drawing height of this view.</p> 10796 * 10797 * @see #computeVerticalScrollExtent() 10798 * @see #computeVerticalScrollOffset() 10799 * @see android.widget.ScrollBarDrawable 10800 */ 10801 protected int computeVerticalScrollRange() { 10802 return getHeight(); 10803 } 10804 10805 /** 10806 * <p>Compute the vertical offset of the vertical scrollbar's thumb 10807 * within the horizontal range. This value is used to compute the position 10808 * of the thumb within the scrollbar's track.</p> 10809 * 10810 * <p>The range is expressed in arbitrary units that must be the same as the 10811 * units used by {@link #computeVerticalScrollRange()} and 10812 * {@link #computeVerticalScrollExtent()}.</p> 10813 * 10814 * <p>The default offset is the scroll offset of this view.</p> 10815 * 10816 * @return the vertical offset of the scrollbar's thumb 10817 * 10818 * @see #computeVerticalScrollRange() 10819 * @see #computeVerticalScrollExtent() 10820 * @see android.widget.ScrollBarDrawable 10821 */ 10822 protected int computeVerticalScrollOffset() { 10823 return mScrollY; 10824 } 10825 10826 /** 10827 * <p>Compute the vertical extent of the horizontal scrollbar's thumb 10828 * within the vertical range. This value is used to compute the length 10829 * of the thumb within the scrollbar's track.</p> 10830 * 10831 * <p>The range is expressed in arbitrary units that must be the same as the 10832 * units used by {@link #computeVerticalScrollRange()} and 10833 * {@link #computeVerticalScrollOffset()}.</p> 10834 * 10835 * <p>The default extent is the drawing height of this view.</p> 10836 * 10837 * @return the vertical extent of the scrollbar's thumb 10838 * 10839 * @see #computeVerticalScrollRange() 10840 * @see #computeVerticalScrollOffset() 10841 * @see android.widget.ScrollBarDrawable 10842 */ 10843 protected int computeVerticalScrollExtent() { 10844 return getHeight(); 10845 } 10846 10847 /** 10848 * Check if this view can be scrolled horizontally in a certain direction. 10849 * 10850 * @param direction Negative to check scrolling left, positive to check scrolling right. 10851 * @return true if this view can be scrolled in the specified direction, false otherwise. 10852 */ 10853 public boolean canScrollHorizontally(int direction) { 10854 final int offset = computeHorizontalScrollOffset(); 10855 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 10856 if (range == 0) return false; 10857 if (direction < 0) { 10858 return offset > 0; 10859 } else { 10860 return offset < range - 1; 10861 } 10862 } 10863 10864 /** 10865 * Check if this view can be scrolled vertically in a certain direction. 10866 * 10867 * @param direction Negative to check scrolling up, positive to check scrolling down. 10868 * @return true if this view can be scrolled in the specified direction, false otherwise. 10869 */ 10870 public boolean canScrollVertically(int direction) { 10871 final int offset = computeVerticalScrollOffset(); 10872 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 10873 if (range == 0) return false; 10874 if (direction < 0) { 10875 return offset > 0; 10876 } else { 10877 return offset < range - 1; 10878 } 10879 } 10880 10881 /** 10882 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 10883 * scrollbars are painted only if they have been awakened first.</p> 10884 * 10885 * @param canvas the canvas on which to draw the scrollbars 10886 * 10887 * @see #awakenScrollBars(int) 10888 */ 10889 protected final void onDrawScrollBars(Canvas canvas) { 10890 // scrollbars are drawn only when the animation is running 10891 final ScrollabilityCache cache = mScrollCache; 10892 if (cache != null) { 10893 10894 int state = cache.state; 10895 10896 if (state == ScrollabilityCache.OFF) { 10897 return; 10898 } 10899 10900 boolean invalidate = false; 10901 10902 if (state == ScrollabilityCache.FADING) { 10903 // We're fading -- get our fade interpolation 10904 if (cache.interpolatorValues == null) { 10905 cache.interpolatorValues = new float[1]; 10906 } 10907 10908 float[] values = cache.interpolatorValues; 10909 10910 // Stops the animation if we're done 10911 if (cache.scrollBarInterpolator.timeToValues(values) == 10912 Interpolator.Result.FREEZE_END) { 10913 cache.state = ScrollabilityCache.OFF; 10914 } else { 10915 cache.scrollBar.setAlpha(Math.round(values[0])); 10916 } 10917 10918 // This will make the scroll bars inval themselves after 10919 // drawing. We only want this when we're fading so that 10920 // we prevent excessive redraws 10921 invalidate = true; 10922 } else { 10923 // We're just on -- but we may have been fading before so 10924 // reset alpha 10925 cache.scrollBar.setAlpha(255); 10926 } 10927 10928 10929 final int viewFlags = mViewFlags; 10930 10931 final boolean drawHorizontalScrollBar = 10932 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 10933 final boolean drawVerticalScrollBar = 10934 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 10935 && !isVerticalScrollBarHidden(); 10936 10937 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 10938 final int width = mRight - mLeft; 10939 final int height = mBottom - mTop; 10940 10941 final ScrollBarDrawable scrollBar = cache.scrollBar; 10942 10943 final int scrollX = mScrollX; 10944 final int scrollY = mScrollY; 10945 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 10946 10947 int left, top, right, bottom; 10948 10949 if (drawHorizontalScrollBar) { 10950 int size = scrollBar.getSize(false); 10951 if (size <= 0) { 10952 size = cache.scrollBarSize; 10953 } 10954 10955 scrollBar.setParameters(computeHorizontalScrollRange(), 10956 computeHorizontalScrollOffset(), 10957 computeHorizontalScrollExtent(), false); 10958 final int verticalScrollBarGap = drawVerticalScrollBar ? 10959 getVerticalScrollbarWidth() : 0; 10960 top = scrollY + height - size - (mUserPaddingBottom & inside); 10961 left = scrollX + (mPaddingLeft & inside); 10962 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 10963 bottom = top + size; 10964 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 10965 if (invalidate) { 10966 invalidate(left, top, right, bottom); 10967 } 10968 } 10969 10970 if (drawVerticalScrollBar) { 10971 int size = scrollBar.getSize(true); 10972 if (size <= 0) { 10973 size = cache.scrollBarSize; 10974 } 10975 10976 scrollBar.setParameters(computeVerticalScrollRange(), 10977 computeVerticalScrollOffset(), 10978 computeVerticalScrollExtent(), true); 10979 switch (mVerticalScrollbarPosition) { 10980 default: 10981 case SCROLLBAR_POSITION_DEFAULT: 10982 case SCROLLBAR_POSITION_RIGHT: 10983 left = scrollX + width - size - (mUserPaddingRight & inside); 10984 break; 10985 case SCROLLBAR_POSITION_LEFT: 10986 left = scrollX + (mUserPaddingLeft & inside); 10987 break; 10988 } 10989 top = scrollY + (mPaddingTop & inside); 10990 right = left + size; 10991 bottom = scrollY + height - (mUserPaddingBottom & inside); 10992 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 10993 if (invalidate) { 10994 invalidate(left, top, right, bottom); 10995 } 10996 } 10997 } 10998 } 10999 } 11000 11001 /** 11002 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 11003 * FastScroller is visible. 11004 * @return whether to temporarily hide the vertical scrollbar 11005 * @hide 11006 */ 11007 protected boolean isVerticalScrollBarHidden() { 11008 return false; 11009 } 11010 11011 /** 11012 * <p>Draw the horizontal scrollbar if 11013 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 11014 * 11015 * @param canvas the canvas on which to draw the scrollbar 11016 * @param scrollBar the scrollbar's drawable 11017 * 11018 * @see #isHorizontalScrollBarEnabled() 11019 * @see #computeHorizontalScrollRange() 11020 * @see #computeHorizontalScrollExtent() 11021 * @see #computeHorizontalScrollOffset() 11022 * @see android.widget.ScrollBarDrawable 11023 * @hide 11024 */ 11025 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 11026 int l, int t, int r, int b) { 11027 scrollBar.setBounds(l, t, r, b); 11028 scrollBar.draw(canvas); 11029 } 11030 11031 /** 11032 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 11033 * returns true.</p> 11034 * 11035 * @param canvas the canvas on which to draw the scrollbar 11036 * @param scrollBar the scrollbar's drawable 11037 * 11038 * @see #isVerticalScrollBarEnabled() 11039 * @see #computeVerticalScrollRange() 11040 * @see #computeVerticalScrollExtent() 11041 * @see #computeVerticalScrollOffset() 11042 * @see android.widget.ScrollBarDrawable 11043 * @hide 11044 */ 11045 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 11046 int l, int t, int r, int b) { 11047 scrollBar.setBounds(l, t, r, b); 11048 scrollBar.draw(canvas); 11049 } 11050 11051 /** 11052 * Implement this to do your drawing. 11053 * 11054 * @param canvas the canvas on which the background will be drawn 11055 */ 11056 protected void onDraw(Canvas canvas) { 11057 } 11058 11059 /* 11060 * Caller is responsible for calling requestLayout if necessary. 11061 * (This allows addViewInLayout to not request a new layout.) 11062 */ 11063 void assignParent(ViewParent parent) { 11064 if (mParent == null) { 11065 mParent = parent; 11066 } else if (parent == null) { 11067 mParent = null; 11068 } else { 11069 throw new RuntimeException("view " + this + " being added, but" 11070 + " it already has a parent"); 11071 } 11072 } 11073 11074 /** 11075 * This is called when the view is attached to a window. At this point it 11076 * has a Surface and will start drawing. Note that this function is 11077 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 11078 * however it may be called any time before the first onDraw -- including 11079 * before or after {@link #onMeasure(int, int)}. 11080 * 11081 * @see #onDetachedFromWindow() 11082 */ 11083 protected void onAttachedToWindow() { 11084 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) { 11085 mParent.requestTransparentRegion(this); 11086 } 11087 11088 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 11089 initialAwakenScrollBars(); 11090 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH; 11091 } 11092 11093 jumpDrawablesToCurrentState(); 11094 11095 // Order is important here: LayoutDirection MUST be resolved before Padding 11096 // and TextDirection 11097 resolveLayoutDirection(); 11098 resolvePadding(); 11099 resolveTextDirection(); 11100 resolveTextAlignment(); 11101 11102 clearAccessibilityFocus(); 11103 if (isFocused()) { 11104 InputMethodManager imm = InputMethodManager.peekInstance(); 11105 imm.focusIn(this); 11106 } 11107 11108 if (mAttachInfo != null && mDisplayList != null) { 11109 mAttachInfo.mViewRootImpl.dequeueDisplayList(mDisplayList); 11110 } 11111 } 11112 11113 /** 11114 * @see #onScreenStateChanged(int) 11115 */ 11116 void dispatchScreenStateChanged(int screenState) { 11117 onScreenStateChanged(screenState); 11118 } 11119 11120 /** 11121 * This method is called whenever the state of the screen this view is 11122 * attached to changes. A state change will usually occurs when the screen 11123 * turns on or off (whether it happens automatically or the user does it 11124 * manually.) 11125 * 11126 * @param screenState The new state of the screen. Can be either 11127 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF} 11128 */ 11129 public void onScreenStateChanged(int screenState) { 11130 } 11131 11132 /** 11133 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true 11134 */ 11135 private boolean hasRtlSupport() { 11136 return mContext.getApplicationInfo().hasRtlSupport(); 11137 } 11138 11139 /** 11140 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 11141 * that the parent directionality can and will be resolved before its children. 11142 * Will call {@link View#onResolvedLayoutDirectionChanged} when resolution is done. 11143 */ 11144 public void resolveLayoutDirection() { 11145 // Clear any previous layout direction resolution 11146 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK; 11147 11148 if (hasRtlSupport()) { 11149 // Set resolved depending on layout direction 11150 switch (getLayoutDirection()) { 11151 case LAYOUT_DIRECTION_INHERIT: 11152 // If this is root view, no need to look at parent's layout dir. 11153 if (canResolveLayoutDirection()) { 11154 ViewGroup viewGroup = ((ViewGroup) mParent); 11155 11156 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) { 11157 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL; 11158 } 11159 } else { 11160 // Nothing to do, LTR by default 11161 } 11162 break; 11163 case LAYOUT_DIRECTION_RTL: 11164 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL; 11165 break; 11166 case LAYOUT_DIRECTION_LOCALE: 11167 if(isLayoutDirectionRtl(Locale.getDefault())) { 11168 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL; 11169 } 11170 break; 11171 default: 11172 // Nothing to do, LTR by default 11173 } 11174 } 11175 11176 // Set to resolved 11177 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED; 11178 onResolvedLayoutDirectionChanged(); 11179 // Resolve padding 11180 resolvePadding(); 11181 } 11182 11183 /** 11184 * Called when layout direction has been resolved. 11185 * 11186 * The default implementation does nothing. 11187 */ 11188 public void onResolvedLayoutDirectionChanged() { 11189 } 11190 11191 /** 11192 * Resolve padding depending on layout direction. 11193 */ 11194 public void resolvePadding() { 11195 // If the user specified the absolute padding (either with android:padding or 11196 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise 11197 // use the default padding or the padding from the background drawable 11198 // (stored at this point in mPadding*) 11199 int resolvedLayoutDirection = getResolvedLayoutDirection(); 11200 switch (resolvedLayoutDirection) { 11201 case LAYOUT_DIRECTION_RTL: 11202 // Start user padding override Right user padding. Otherwise, if Right user 11203 // padding is not defined, use the default Right padding. If Right user padding 11204 // is defined, just use it. 11205 if (mUserPaddingStart >= 0) { 11206 mUserPaddingRight = mUserPaddingStart; 11207 } else if (mUserPaddingRight < 0) { 11208 mUserPaddingRight = mPaddingRight; 11209 } 11210 if (mUserPaddingEnd >= 0) { 11211 mUserPaddingLeft = mUserPaddingEnd; 11212 } else if (mUserPaddingLeft < 0) { 11213 mUserPaddingLeft = mPaddingLeft; 11214 } 11215 break; 11216 case LAYOUT_DIRECTION_LTR: 11217 default: 11218 // Start user padding override Left user padding. Otherwise, if Left user 11219 // padding is not defined, use the default left padding. If Left user padding 11220 // is defined, just use it. 11221 if (mUserPaddingStart >= 0) { 11222 mUserPaddingLeft = mUserPaddingStart; 11223 } else if (mUserPaddingLeft < 0) { 11224 mUserPaddingLeft = mPaddingLeft; 11225 } 11226 if (mUserPaddingEnd >= 0) { 11227 mUserPaddingRight = mUserPaddingEnd; 11228 } else if (mUserPaddingRight < 0) { 11229 mUserPaddingRight = mPaddingRight; 11230 } 11231 } 11232 11233 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 11234 11235 if(isPaddingRelative()) { 11236 setPaddingRelative(mUserPaddingStart, mPaddingTop, mUserPaddingEnd, mUserPaddingBottom); 11237 } else { 11238 recomputePadding(); 11239 } 11240 onPaddingChanged(resolvedLayoutDirection); 11241 } 11242 11243 /** 11244 * Resolve padding depending on the layout direction. Subclasses that care about 11245 * padding resolution should override this method. The default implementation does 11246 * nothing. 11247 * 11248 * @param layoutDirection the direction of the layout 11249 * 11250 * @see {@link #LAYOUT_DIRECTION_LTR} 11251 * @see {@link #LAYOUT_DIRECTION_RTL} 11252 */ 11253 public void onPaddingChanged(int layoutDirection) { 11254 } 11255 11256 /** 11257 * Check if layout direction resolution can be done. 11258 * 11259 * @return true if layout direction resolution can be done otherwise return false. 11260 */ 11261 public boolean canResolveLayoutDirection() { 11262 switch (getLayoutDirection()) { 11263 case LAYOUT_DIRECTION_INHERIT: 11264 return (mParent != null) && (mParent instanceof ViewGroup); 11265 default: 11266 return true; 11267 } 11268 } 11269 11270 /** 11271 * Reset the resolved layout direction. Will call {@link View#onResolvedLayoutDirectionReset} 11272 * when reset is done. 11273 */ 11274 public void resetResolvedLayoutDirection() { 11275 // Reset the current resolved bits 11276 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK; 11277 onResolvedLayoutDirectionReset(); 11278 // Reset also the text direction 11279 resetResolvedTextDirection(); 11280 } 11281 11282 /** 11283 * Called during reset of resolved layout direction. 11284 * 11285 * Subclasses need to override this method to clear cached information that depends on the 11286 * resolved layout direction, or to inform child views that inherit their layout direction. 11287 * 11288 * The default implementation does nothing. 11289 */ 11290 public void onResolvedLayoutDirectionReset() { 11291 } 11292 11293 /** 11294 * Check if a Locale uses an RTL script. 11295 * 11296 * @param locale Locale to check 11297 * @return true if the Locale uses an RTL script. 11298 */ 11299 protected static boolean isLayoutDirectionRtl(Locale locale) { 11300 return (LAYOUT_DIRECTION_RTL == LocaleUtil.getLayoutDirectionFromLocale(locale)); 11301 } 11302 11303 /** 11304 * This is called when the view is detached from a window. At this point it 11305 * no longer has a surface for drawing. 11306 * 11307 * @see #onAttachedToWindow() 11308 */ 11309 protected void onDetachedFromWindow() { 11310 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT; 11311 11312 removeUnsetPressCallback(); 11313 removeLongPressCallback(); 11314 removePerformClickCallback(); 11315 removeSendViewScrolledAccessibilityEventCallback(); 11316 11317 destroyDrawingCache(); 11318 11319 destroyLayer(false); 11320 11321 if (mAttachInfo != null) { 11322 if (mDisplayList != null) { 11323 mAttachInfo.mViewRootImpl.enqueueDisplayList(mDisplayList); 11324 } 11325 mAttachInfo.mViewRootImpl.cancelInvalidate(this); 11326 } else { 11327 if (mDisplayList != null) { 11328 // Should never happen 11329 mDisplayList.invalidate(); 11330 } 11331 } 11332 11333 mCurrentAnimation = null; 11334 11335 resetResolvedLayoutDirection(); 11336 resetResolvedTextAlignment(); 11337 resetAccessibilityStateChanged(); 11338 } 11339 11340 /** 11341 * @return The number of times this view has been attached to a window 11342 */ 11343 protected int getWindowAttachCount() { 11344 return mWindowAttachCount; 11345 } 11346 11347 /** 11348 * Retrieve a unique token identifying the window this view is attached to. 11349 * @return Return the window's token for use in 11350 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 11351 */ 11352 public IBinder getWindowToken() { 11353 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 11354 } 11355 11356 /** 11357 * Retrieve a unique token identifying the top-level "real" window of 11358 * the window that this view is attached to. That is, this is like 11359 * {@link #getWindowToken}, except if the window this view in is a panel 11360 * window (attached to another containing window), then the token of 11361 * the containing window is returned instead. 11362 * 11363 * @return Returns the associated window token, either 11364 * {@link #getWindowToken()} or the containing window's token. 11365 */ 11366 public IBinder getApplicationWindowToken() { 11367 AttachInfo ai = mAttachInfo; 11368 if (ai != null) { 11369 IBinder appWindowToken = ai.mPanelParentWindowToken; 11370 if (appWindowToken == null) { 11371 appWindowToken = ai.mWindowToken; 11372 } 11373 return appWindowToken; 11374 } 11375 return null; 11376 } 11377 11378 /** 11379 * Retrieve private session object this view hierarchy is using to 11380 * communicate with the window manager. 11381 * @return the session object to communicate with the window manager 11382 */ 11383 /*package*/ IWindowSession getWindowSession() { 11384 return mAttachInfo != null ? mAttachInfo.mSession : null; 11385 } 11386 11387 /** 11388 * @param info the {@link android.view.View.AttachInfo} to associated with 11389 * this view 11390 */ 11391 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 11392 //System.out.println("Attached! " + this); 11393 mAttachInfo = info; 11394 mWindowAttachCount++; 11395 // We will need to evaluate the drawable state at least once. 11396 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 11397 if (mFloatingTreeObserver != null) { 11398 info.mTreeObserver.merge(mFloatingTreeObserver); 11399 mFloatingTreeObserver = null; 11400 } 11401 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) { 11402 mAttachInfo.mScrollContainers.add(this); 11403 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 11404 } 11405 performCollectViewAttributes(mAttachInfo, visibility); 11406 onAttachedToWindow(); 11407 11408 ListenerInfo li = mListenerInfo; 11409 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 11410 li != null ? li.mOnAttachStateChangeListeners : null; 11411 if (listeners != null && listeners.size() > 0) { 11412 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 11413 // perform the dispatching. The iterator is a safe guard against listeners that 11414 // could mutate the list by calling the various add/remove methods. This prevents 11415 // the array from being modified while we iterate it. 11416 for (OnAttachStateChangeListener listener : listeners) { 11417 listener.onViewAttachedToWindow(this); 11418 } 11419 } 11420 11421 int vis = info.mWindowVisibility; 11422 if (vis != GONE) { 11423 onWindowVisibilityChanged(vis); 11424 } 11425 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) { 11426 // If nobody has evaluated the drawable state yet, then do it now. 11427 refreshDrawableState(); 11428 } 11429 } 11430 11431 void dispatchDetachedFromWindow() { 11432 AttachInfo info = mAttachInfo; 11433 if (info != null) { 11434 int vis = info.mWindowVisibility; 11435 if (vis != GONE) { 11436 onWindowVisibilityChanged(GONE); 11437 } 11438 } 11439 11440 onDetachedFromWindow(); 11441 11442 ListenerInfo li = mListenerInfo; 11443 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 11444 li != null ? li.mOnAttachStateChangeListeners : null; 11445 if (listeners != null && listeners.size() > 0) { 11446 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 11447 // perform the dispatching. The iterator is a safe guard against listeners that 11448 // could mutate the list by calling the various add/remove methods. This prevents 11449 // the array from being modified while we iterate it. 11450 for (OnAttachStateChangeListener listener : listeners) { 11451 listener.onViewDetachedFromWindow(this); 11452 } 11453 } 11454 11455 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) { 11456 mAttachInfo.mScrollContainers.remove(this); 11457 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED; 11458 } 11459 11460 mAttachInfo = null; 11461 } 11462 11463 /** 11464 * Store this view hierarchy's frozen state into the given container. 11465 * 11466 * @param container The SparseArray in which to save the view's state. 11467 * 11468 * @see #restoreHierarchyState(android.util.SparseArray) 11469 * @see #dispatchSaveInstanceState(android.util.SparseArray) 11470 * @see #onSaveInstanceState() 11471 */ 11472 public void saveHierarchyState(SparseArray<Parcelable> container) { 11473 dispatchSaveInstanceState(container); 11474 } 11475 11476 /** 11477 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 11478 * this view and its children. May be overridden to modify how freezing happens to a 11479 * view's children; for example, some views may want to not store state for their children. 11480 * 11481 * @param container The SparseArray in which to save the view's state. 11482 * 11483 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 11484 * @see #saveHierarchyState(android.util.SparseArray) 11485 * @see #onSaveInstanceState() 11486 */ 11487 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 11488 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 11489 mPrivateFlags &= ~SAVE_STATE_CALLED; 11490 Parcelable state = onSaveInstanceState(); 11491 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 11492 throw new IllegalStateException( 11493 "Derived class did not call super.onSaveInstanceState()"); 11494 } 11495 if (state != null) { 11496 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 11497 // + ": " + state); 11498 container.put(mID, state); 11499 } 11500 } 11501 } 11502 11503 /** 11504 * Hook allowing a view to generate a representation of its internal state 11505 * that can later be used to create a new instance with that same state. 11506 * This state should only contain information that is not persistent or can 11507 * not be reconstructed later. For example, you will never store your 11508 * current position on screen because that will be computed again when a 11509 * new instance of the view is placed in its view hierarchy. 11510 * <p> 11511 * Some examples of things you may store here: the current cursor position 11512 * in a text view (but usually not the text itself since that is stored in a 11513 * content provider or other persistent storage), the currently selected 11514 * item in a list view. 11515 * 11516 * @return Returns a Parcelable object containing the view's current dynamic 11517 * state, or null if there is nothing interesting to save. The 11518 * default implementation returns null. 11519 * @see #onRestoreInstanceState(android.os.Parcelable) 11520 * @see #saveHierarchyState(android.util.SparseArray) 11521 * @see #dispatchSaveInstanceState(android.util.SparseArray) 11522 * @see #setSaveEnabled(boolean) 11523 */ 11524 protected Parcelable onSaveInstanceState() { 11525 mPrivateFlags |= SAVE_STATE_CALLED; 11526 return BaseSavedState.EMPTY_STATE; 11527 } 11528 11529 /** 11530 * Restore this view hierarchy's frozen state from the given container. 11531 * 11532 * @param container The SparseArray which holds previously frozen states. 11533 * 11534 * @see #saveHierarchyState(android.util.SparseArray) 11535 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 11536 * @see #onRestoreInstanceState(android.os.Parcelable) 11537 */ 11538 public void restoreHierarchyState(SparseArray<Parcelable> container) { 11539 dispatchRestoreInstanceState(container); 11540 } 11541 11542 /** 11543 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 11544 * state for this view and its children. May be overridden to modify how restoring 11545 * happens to a view's children; for example, some views may want to not store state 11546 * for their children. 11547 * 11548 * @param container The SparseArray which holds previously saved state. 11549 * 11550 * @see #dispatchSaveInstanceState(android.util.SparseArray) 11551 * @see #restoreHierarchyState(android.util.SparseArray) 11552 * @see #onRestoreInstanceState(android.os.Parcelable) 11553 */ 11554 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 11555 if (mID != NO_ID) { 11556 Parcelable state = container.get(mID); 11557 if (state != null) { 11558 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 11559 // + ": " + state); 11560 mPrivateFlags &= ~SAVE_STATE_CALLED; 11561 onRestoreInstanceState(state); 11562 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 11563 throw new IllegalStateException( 11564 "Derived class did not call super.onRestoreInstanceState()"); 11565 } 11566 } 11567 } 11568 } 11569 11570 /** 11571 * Hook allowing a view to re-apply a representation of its internal state that had previously 11572 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 11573 * null state. 11574 * 11575 * @param state The frozen state that had previously been returned by 11576 * {@link #onSaveInstanceState}. 11577 * 11578 * @see #onSaveInstanceState() 11579 * @see #restoreHierarchyState(android.util.SparseArray) 11580 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 11581 */ 11582 protected void onRestoreInstanceState(Parcelable state) { 11583 mPrivateFlags |= SAVE_STATE_CALLED; 11584 if (state != BaseSavedState.EMPTY_STATE && state != null) { 11585 throw new IllegalArgumentException("Wrong state class, expecting View State but " 11586 + "received " + state.getClass().toString() + " instead. This usually happens " 11587 + "when two views of different type have the same id in the same hierarchy. " 11588 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 11589 + "other views do not use the same id."); 11590 } 11591 } 11592 11593 /** 11594 * <p>Return the time at which the drawing of the view hierarchy started.</p> 11595 * 11596 * @return the drawing start time in milliseconds 11597 */ 11598 public long getDrawingTime() { 11599 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 11600 } 11601 11602 /** 11603 * <p>Enables or disables the duplication of the parent's state into this view. When 11604 * duplication is enabled, this view gets its drawable state from its parent rather 11605 * than from its own internal properties.</p> 11606 * 11607 * <p>Note: in the current implementation, setting this property to true after the 11608 * view was added to a ViewGroup might have no effect at all. This property should 11609 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 11610 * 11611 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 11612 * property is enabled, an exception will be thrown.</p> 11613 * 11614 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 11615 * parent, these states should not be affected by this method.</p> 11616 * 11617 * @param enabled True to enable duplication of the parent's drawable state, false 11618 * to disable it. 11619 * 11620 * @see #getDrawableState() 11621 * @see #isDuplicateParentStateEnabled() 11622 */ 11623 public void setDuplicateParentStateEnabled(boolean enabled) { 11624 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 11625 } 11626 11627 /** 11628 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 11629 * 11630 * @return True if this view's drawable state is duplicated from the parent, 11631 * false otherwise 11632 * 11633 * @see #getDrawableState() 11634 * @see #setDuplicateParentStateEnabled(boolean) 11635 */ 11636 public boolean isDuplicateParentStateEnabled() { 11637 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 11638 } 11639 11640 /** 11641 * <p>Specifies the type of layer backing this view. The layer can be 11642 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or 11643 * {@link #LAYER_TYPE_HARDWARE hardware}.</p> 11644 * 11645 * <p>A layer is associated with an optional {@link android.graphics.Paint} 11646 * instance that controls how the layer is composed on screen. The following 11647 * properties of the paint are taken into account when composing the layer:</p> 11648 * <ul> 11649 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 11650 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 11651 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 11652 * </ul> 11653 * 11654 * <p>If this view has an alpha value set to < 1.0 by calling 11655 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by 11656 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore 11657 * equivalent to setting a hardware layer on this view and providing a paint with 11658 * the desired alpha value.<p> 11659 * 11660 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled}, 11661 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware} 11662 * for more information on when and how to use layers.</p> 11663 * 11664 * @param layerType The ype of layer to use with this view, must be one of 11665 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 11666 * {@link #LAYER_TYPE_HARDWARE} 11667 * @param paint The paint used to compose the layer. This argument is optional 11668 * and can be null. It is ignored when the layer type is 11669 * {@link #LAYER_TYPE_NONE} 11670 * 11671 * @see #getLayerType() 11672 * @see #LAYER_TYPE_NONE 11673 * @see #LAYER_TYPE_SOFTWARE 11674 * @see #LAYER_TYPE_HARDWARE 11675 * @see #setAlpha(float) 11676 * 11677 * @attr ref android.R.styleable#View_layerType 11678 */ 11679 public void setLayerType(int layerType, Paint paint) { 11680 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 11681 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 11682 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 11683 } 11684 11685 if (layerType == mLayerType) { 11686 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) { 11687 mLayerPaint = paint == null ? new Paint() : paint; 11688 invalidateParentCaches(); 11689 invalidate(true); 11690 } 11691 return; 11692 } 11693 11694 // Destroy any previous software drawing cache if needed 11695 switch (mLayerType) { 11696 case LAYER_TYPE_HARDWARE: 11697 destroyLayer(false); 11698 // fall through - non-accelerated views may use software layer mechanism instead 11699 case LAYER_TYPE_SOFTWARE: 11700 destroyDrawingCache(); 11701 break; 11702 default: 11703 break; 11704 } 11705 11706 mLayerType = layerType; 11707 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE; 11708 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 11709 mLocalDirtyRect = layerDisabled ? null : new Rect(); 11710 11711 invalidateParentCaches(); 11712 invalidate(true); 11713 } 11714 11715 /** 11716 * Indicates whether this view has a static layer. A view with layer type 11717 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 11718 * dynamic. 11719 */ 11720 boolean hasStaticLayer() { 11721 return true; 11722 } 11723 11724 /** 11725 * Indicates what type of layer is currently associated with this view. By default 11726 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 11727 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 11728 * for more information on the different types of layers. 11729 * 11730 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 11731 * {@link #LAYER_TYPE_HARDWARE} 11732 * 11733 * @see #setLayerType(int, android.graphics.Paint) 11734 * @see #buildLayer() 11735 * @see #LAYER_TYPE_NONE 11736 * @see #LAYER_TYPE_SOFTWARE 11737 * @see #LAYER_TYPE_HARDWARE 11738 */ 11739 public int getLayerType() { 11740 return mLayerType; 11741 } 11742 11743 /** 11744 * Forces this view's layer to be created and this view to be rendered 11745 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 11746 * invoking this method will have no effect. 11747 * 11748 * This method can for instance be used to render a view into its layer before 11749 * starting an animation. If this view is complex, rendering into the layer 11750 * before starting the animation will avoid skipping frames. 11751 * 11752 * @throws IllegalStateException If this view is not attached to a window 11753 * 11754 * @see #setLayerType(int, android.graphics.Paint) 11755 */ 11756 public void buildLayer() { 11757 if (mLayerType == LAYER_TYPE_NONE) return; 11758 11759 if (mAttachInfo == null) { 11760 throw new IllegalStateException("This view must be attached to a window first"); 11761 } 11762 11763 switch (mLayerType) { 11764 case LAYER_TYPE_HARDWARE: 11765 if (mAttachInfo.mHardwareRenderer != null && 11766 mAttachInfo.mHardwareRenderer.isEnabled() && 11767 mAttachInfo.mHardwareRenderer.validate()) { 11768 getHardwareLayer(); 11769 } 11770 break; 11771 case LAYER_TYPE_SOFTWARE: 11772 buildDrawingCache(true); 11773 break; 11774 } 11775 } 11776 11777 // Make sure the HardwareRenderer.validate() was invoked before calling this method 11778 void flushLayer() { 11779 if (mLayerType == LAYER_TYPE_HARDWARE && mHardwareLayer != null) { 11780 mHardwareLayer.flush(); 11781 } 11782 } 11783 11784 /** 11785 * <p>Returns a hardware layer that can be used to draw this view again 11786 * without executing its draw method.</p> 11787 * 11788 * @return A HardwareLayer ready to render, or null if an error occurred. 11789 */ 11790 HardwareLayer getHardwareLayer() { 11791 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null || 11792 !mAttachInfo.mHardwareRenderer.isEnabled()) { 11793 return null; 11794 } 11795 11796 if (!mAttachInfo.mHardwareRenderer.validate()) return null; 11797 11798 final int width = mRight - mLeft; 11799 final int height = mBottom - mTop; 11800 11801 if (width == 0 || height == 0) { 11802 return null; 11803 } 11804 11805 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) { 11806 if (mHardwareLayer == null) { 11807 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer( 11808 width, height, isOpaque()); 11809 mLocalDirtyRect.set(0, 0, width, height); 11810 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) { 11811 mHardwareLayer.resize(width, height); 11812 mLocalDirtyRect.set(0, 0, width, height); 11813 } 11814 11815 // The layer is not valid if the underlying GPU resources cannot be allocated 11816 if (!mHardwareLayer.isValid()) { 11817 return null; 11818 } 11819 11820 mHardwareLayer.redraw(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect); 11821 mLocalDirtyRect.setEmpty(); 11822 } 11823 11824 return mHardwareLayer; 11825 } 11826 11827 /** 11828 * Destroys this View's hardware layer if possible. 11829 * 11830 * @return True if the layer was destroyed, false otherwise. 11831 * 11832 * @see #setLayerType(int, android.graphics.Paint) 11833 * @see #LAYER_TYPE_HARDWARE 11834 */ 11835 boolean destroyLayer(boolean valid) { 11836 if (mHardwareLayer != null) { 11837 AttachInfo info = mAttachInfo; 11838 if (info != null && info.mHardwareRenderer != null && 11839 info.mHardwareRenderer.isEnabled() && 11840 (valid || info.mHardwareRenderer.validate())) { 11841 mHardwareLayer.destroy(); 11842 mHardwareLayer = null; 11843 11844 invalidate(true); 11845 invalidateParentCaches(); 11846 } 11847 return true; 11848 } 11849 return false; 11850 } 11851 11852 /** 11853 * Destroys all hardware rendering resources. This method is invoked 11854 * when the system needs to reclaim resources. Upon execution of this 11855 * method, you should free any OpenGL resources created by the view. 11856 * 11857 * Note: you <strong>must</strong> call 11858 * <code>super.destroyHardwareResources()</code> when overriding 11859 * this method. 11860 * 11861 * @hide 11862 */ 11863 protected void destroyHardwareResources() { 11864 destroyLayer(true); 11865 } 11866 11867 /** 11868 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 11869 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 11870 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 11871 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 11872 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 11873 * null.</p> 11874 * 11875 * <p>Enabling the drawing cache is similar to 11876 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 11877 * acceleration is turned off. When hardware acceleration is turned on, enabling the 11878 * drawing cache has no effect on rendering because the system uses a different mechanism 11879 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 11880 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 11881 * for information on how to enable software and hardware layers.</p> 11882 * 11883 * <p>This API can be used to manually generate 11884 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 11885 * {@link #getDrawingCache()}.</p> 11886 * 11887 * @param enabled true to enable the drawing cache, false otherwise 11888 * 11889 * @see #isDrawingCacheEnabled() 11890 * @see #getDrawingCache() 11891 * @see #buildDrawingCache() 11892 * @see #setLayerType(int, android.graphics.Paint) 11893 */ 11894 public void setDrawingCacheEnabled(boolean enabled) { 11895 mCachingFailed = false; 11896 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 11897 } 11898 11899 /** 11900 * <p>Indicates whether the drawing cache is enabled for this view.</p> 11901 * 11902 * @return true if the drawing cache is enabled 11903 * 11904 * @see #setDrawingCacheEnabled(boolean) 11905 * @see #getDrawingCache() 11906 */ 11907 @ViewDebug.ExportedProperty(category = "drawing") 11908 public boolean isDrawingCacheEnabled() { 11909 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 11910 } 11911 11912 /** 11913 * Debugging utility which recursively outputs the dirty state of a view and its 11914 * descendants. 11915 * 11916 * @hide 11917 */ 11918 @SuppressWarnings({"UnusedDeclaration"}) 11919 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 11920 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) + 11921 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" + 11922 (mPrivateFlags & View.DRAWING_CACHE_VALID) + 11923 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")"); 11924 if (clear) { 11925 mPrivateFlags &= clearMask; 11926 } 11927 if (this instanceof ViewGroup) { 11928 ViewGroup parent = (ViewGroup) this; 11929 final int count = parent.getChildCount(); 11930 for (int i = 0; i < count; i++) { 11931 final View child = parent.getChildAt(i); 11932 child.outputDirtyFlags(indent + " ", clear, clearMask); 11933 } 11934 } 11935 } 11936 11937 /** 11938 * This method is used by ViewGroup to cause its children to restore or recreate their 11939 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 11940 * to recreate its own display list, which would happen if it went through the normal 11941 * draw/dispatchDraw mechanisms. 11942 * 11943 * @hide 11944 */ 11945 protected void dispatchGetDisplayList() {} 11946 11947 /** 11948 * A view that is not attached or hardware accelerated cannot create a display list. 11949 * This method checks these conditions and returns the appropriate result. 11950 * 11951 * @return true if view has the ability to create a display list, false otherwise. 11952 * 11953 * @hide 11954 */ 11955 public boolean canHaveDisplayList() { 11956 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 11957 } 11958 11959 /** 11960 * @return The HardwareRenderer associated with that view or null if hardware rendering 11961 * is not supported or this this has not been attached to a window. 11962 * 11963 * @hide 11964 */ 11965 public HardwareRenderer getHardwareRenderer() { 11966 if (mAttachInfo != null) { 11967 return mAttachInfo.mHardwareRenderer; 11968 } 11969 return null; 11970 } 11971 11972 /** 11973 * Returns a DisplayList. If the incoming displayList is null, one will be created. 11974 * Otherwise, the same display list will be returned (after having been rendered into 11975 * along the way, depending on the invalidation state of the view). 11976 * 11977 * @param displayList The previous version of this displayList, could be null. 11978 * @param isLayer Whether the requester of the display list is a layer. If so, 11979 * the view will avoid creating a layer inside the resulting display list. 11980 * @return A new or reused DisplayList object. 11981 */ 11982 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) { 11983 if (!canHaveDisplayList()) { 11984 return null; 11985 } 11986 11987 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || 11988 displayList == null || !displayList.isValid() || 11989 (!isLayer && mRecreateDisplayList))) { 11990 // Don't need to recreate the display list, just need to tell our 11991 // children to restore/recreate theirs 11992 if (displayList != null && displayList.isValid() && 11993 !isLayer && !mRecreateDisplayList) { 11994 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 11995 mPrivateFlags &= ~DIRTY_MASK; 11996 dispatchGetDisplayList(); 11997 11998 return displayList; 11999 } 12000 12001 if (!isLayer) { 12002 // If we got here, we're recreating it. Mark it as such to ensure that 12003 // we copy in child display lists into ours in drawChild() 12004 mRecreateDisplayList = true; 12005 } 12006 if (displayList == null) { 12007 final String name = getClass().getSimpleName(); 12008 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name); 12009 // If we're creating a new display list, make sure our parent gets invalidated 12010 // since they will need to recreate their display list to account for this 12011 // new child display list. 12012 invalidateParentCaches(); 12013 } 12014 12015 boolean caching = false; 12016 final HardwareCanvas canvas = displayList.start(); 12017 int width = mRight - mLeft; 12018 int height = mBottom - mTop; 12019 12020 try { 12021 canvas.setViewport(width, height); 12022 // The dirty rect should always be null for a display list 12023 canvas.onPreDraw(null); 12024 int layerType = ( 12025 !(mParent instanceof ViewGroup) || ((ViewGroup)mParent).mDrawLayers) ? 12026 getLayerType() : LAYER_TYPE_NONE; 12027 if (!isLayer && layerType != LAYER_TYPE_NONE) { 12028 if (layerType == LAYER_TYPE_HARDWARE) { 12029 final HardwareLayer layer = getHardwareLayer(); 12030 if (layer != null && layer.isValid()) { 12031 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint); 12032 } else { 12033 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint, 12034 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | 12035 Canvas.CLIP_TO_LAYER_SAVE_FLAG); 12036 } 12037 caching = true; 12038 } else { 12039 buildDrawingCache(true); 12040 Bitmap cache = getDrawingCache(true); 12041 if (cache != null) { 12042 canvas.drawBitmap(cache, 0, 0, mLayerPaint); 12043 caching = true; 12044 } 12045 } 12046 } else { 12047 12048 computeScroll(); 12049 12050 canvas.translate(-mScrollX, -mScrollY); 12051 if (!isLayer) { 12052 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 12053 mPrivateFlags &= ~DIRTY_MASK; 12054 } 12055 12056 // Fast path for layouts with no backgrounds 12057 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 12058 dispatchDraw(canvas); 12059 } else { 12060 draw(canvas); 12061 } 12062 } 12063 } finally { 12064 canvas.onPostDraw(); 12065 12066 displayList.end(); 12067 displayList.setCaching(caching); 12068 if (isLayer) { 12069 displayList.setLeftTopRightBottom(0, 0, width, height); 12070 } else { 12071 setDisplayListProperties(displayList); 12072 } 12073 } 12074 } else if (!isLayer) { 12075 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 12076 mPrivateFlags &= ~DIRTY_MASK; 12077 } 12078 12079 return displayList; 12080 } 12081 12082 /** 12083 * Get the DisplayList for the HardwareLayer 12084 * 12085 * @param layer The HardwareLayer whose DisplayList we want 12086 * @return A DisplayList fopr the specified HardwareLayer 12087 */ 12088 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) { 12089 DisplayList displayList = getDisplayList(layer.getDisplayList(), true); 12090 layer.setDisplayList(displayList); 12091 return displayList; 12092 } 12093 12094 12095 /** 12096 * <p>Returns a display list that can be used to draw this view again 12097 * without executing its draw method.</p> 12098 * 12099 * @return A DisplayList ready to replay, or null if caching is not enabled. 12100 * 12101 * @hide 12102 */ 12103 public DisplayList getDisplayList() { 12104 mDisplayList = getDisplayList(mDisplayList, false); 12105 return mDisplayList; 12106 } 12107 12108 /** 12109 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 12110 * 12111 * @return A non-scaled bitmap representing this view or null if cache is disabled. 12112 * 12113 * @see #getDrawingCache(boolean) 12114 */ 12115 public Bitmap getDrawingCache() { 12116 return getDrawingCache(false); 12117 } 12118 12119 /** 12120 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 12121 * is null when caching is disabled. If caching is enabled and the cache is not ready, 12122 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 12123 * draw from the cache when the cache is enabled. To benefit from the cache, you must 12124 * request the drawing cache by calling this method and draw it on screen if the 12125 * returned bitmap is not null.</p> 12126 * 12127 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 12128 * this method will create a bitmap of the same size as this view. Because this bitmap 12129 * will be drawn scaled by the parent ViewGroup, the result on screen might show 12130 * scaling artifacts. To avoid such artifacts, you should call this method by setting 12131 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 12132 * size than the view. This implies that your application must be able to handle this 12133 * size.</p> 12134 * 12135 * @param autoScale Indicates whether the generated bitmap should be scaled based on 12136 * the current density of the screen when the application is in compatibility 12137 * mode. 12138 * 12139 * @return A bitmap representing this view or null if cache is disabled. 12140 * 12141 * @see #setDrawingCacheEnabled(boolean) 12142 * @see #isDrawingCacheEnabled() 12143 * @see #buildDrawingCache(boolean) 12144 * @see #destroyDrawingCache() 12145 */ 12146 public Bitmap getDrawingCache(boolean autoScale) { 12147 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 12148 return null; 12149 } 12150 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 12151 buildDrawingCache(autoScale); 12152 } 12153 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 12154 } 12155 12156 /** 12157 * <p>Frees the resources used by the drawing cache. If you call 12158 * {@link #buildDrawingCache()} manually without calling 12159 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 12160 * should cleanup the cache with this method afterwards.</p> 12161 * 12162 * @see #setDrawingCacheEnabled(boolean) 12163 * @see #buildDrawingCache() 12164 * @see #getDrawingCache() 12165 */ 12166 public void destroyDrawingCache() { 12167 if (mDrawingCache != null) { 12168 mDrawingCache.recycle(); 12169 mDrawingCache = null; 12170 } 12171 if (mUnscaledDrawingCache != null) { 12172 mUnscaledDrawingCache.recycle(); 12173 mUnscaledDrawingCache = null; 12174 } 12175 } 12176 12177 /** 12178 * Setting a solid background color for the drawing cache's bitmaps will improve 12179 * performance and memory usage. Note, though that this should only be used if this 12180 * view will always be drawn on top of a solid color. 12181 * 12182 * @param color The background color to use for the drawing cache's bitmap 12183 * 12184 * @see #setDrawingCacheEnabled(boolean) 12185 * @see #buildDrawingCache() 12186 * @see #getDrawingCache() 12187 */ 12188 public void setDrawingCacheBackgroundColor(int color) { 12189 if (color != mDrawingCacheBackgroundColor) { 12190 mDrawingCacheBackgroundColor = color; 12191 mPrivateFlags &= ~DRAWING_CACHE_VALID; 12192 } 12193 } 12194 12195 /** 12196 * @see #setDrawingCacheBackgroundColor(int) 12197 * 12198 * @return The background color to used for the drawing cache's bitmap 12199 */ 12200 public int getDrawingCacheBackgroundColor() { 12201 return mDrawingCacheBackgroundColor; 12202 } 12203 12204 /** 12205 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 12206 * 12207 * @see #buildDrawingCache(boolean) 12208 */ 12209 public void buildDrawingCache() { 12210 buildDrawingCache(false); 12211 } 12212 12213 /** 12214 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 12215 * 12216 * <p>If you call {@link #buildDrawingCache()} manually without calling 12217 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 12218 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 12219 * 12220 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 12221 * this method will create a bitmap of the same size as this view. Because this bitmap 12222 * will be drawn scaled by the parent ViewGroup, the result on screen might show 12223 * scaling artifacts. To avoid such artifacts, you should call this method by setting 12224 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 12225 * size than the view. This implies that your application must be able to handle this 12226 * size.</p> 12227 * 12228 * <p>You should avoid calling this method when hardware acceleration is enabled. If 12229 * you do not need the drawing cache bitmap, calling this method will increase memory 12230 * usage and cause the view to be rendered in software once, thus negatively impacting 12231 * performance.</p> 12232 * 12233 * @see #getDrawingCache() 12234 * @see #destroyDrawingCache() 12235 */ 12236 public void buildDrawingCache(boolean autoScale) { 12237 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ? 12238 mDrawingCache == null : mUnscaledDrawingCache == null)) { 12239 mCachingFailed = false; 12240 12241 if (ViewDebug.TRACE_HIERARCHY) { 12242 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE); 12243 } 12244 12245 int width = mRight - mLeft; 12246 int height = mBottom - mTop; 12247 12248 final AttachInfo attachInfo = mAttachInfo; 12249 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 12250 12251 if (autoScale && scalingRequired) { 12252 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 12253 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 12254 } 12255 12256 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 12257 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 12258 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 12259 12260 if (width <= 0 || height <= 0 || 12261 // Projected bitmap size in bytes 12262 (width * height * (opaque && !use32BitCache ? 2 : 4) > 12263 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) { 12264 destroyDrawingCache(); 12265 mCachingFailed = true; 12266 return; 12267 } 12268 12269 boolean clear = true; 12270 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 12271 12272 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 12273 Bitmap.Config quality; 12274 if (!opaque) { 12275 // Never pick ARGB_4444 because it looks awful 12276 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 12277 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 12278 case DRAWING_CACHE_QUALITY_AUTO: 12279 quality = Bitmap.Config.ARGB_8888; 12280 break; 12281 case DRAWING_CACHE_QUALITY_LOW: 12282 quality = Bitmap.Config.ARGB_8888; 12283 break; 12284 case DRAWING_CACHE_QUALITY_HIGH: 12285 quality = Bitmap.Config.ARGB_8888; 12286 break; 12287 default: 12288 quality = Bitmap.Config.ARGB_8888; 12289 break; 12290 } 12291 } else { 12292 // Optimization for translucent windows 12293 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 12294 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 12295 } 12296 12297 // Try to cleanup memory 12298 if (bitmap != null) bitmap.recycle(); 12299 12300 try { 12301 bitmap = Bitmap.createBitmap(width, height, quality); 12302 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 12303 if (autoScale) { 12304 mDrawingCache = bitmap; 12305 } else { 12306 mUnscaledDrawingCache = bitmap; 12307 } 12308 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 12309 } catch (OutOfMemoryError e) { 12310 // If there is not enough memory to create the bitmap cache, just 12311 // ignore the issue as bitmap caches are not required to draw the 12312 // view hierarchy 12313 if (autoScale) { 12314 mDrawingCache = null; 12315 } else { 12316 mUnscaledDrawingCache = null; 12317 } 12318 mCachingFailed = true; 12319 return; 12320 } 12321 12322 clear = drawingCacheBackgroundColor != 0; 12323 } 12324 12325 Canvas canvas; 12326 if (attachInfo != null) { 12327 canvas = attachInfo.mCanvas; 12328 if (canvas == null) { 12329 canvas = new Canvas(); 12330 } 12331 canvas.setBitmap(bitmap); 12332 // Temporarily clobber the cached Canvas in case one of our children 12333 // is also using a drawing cache. Without this, the children would 12334 // steal the canvas by attaching their own bitmap to it and bad, bad 12335 // thing would happen (invisible views, corrupted drawings, etc.) 12336 attachInfo.mCanvas = null; 12337 } else { 12338 // This case should hopefully never or seldom happen 12339 canvas = new Canvas(bitmap); 12340 } 12341 12342 if (clear) { 12343 bitmap.eraseColor(drawingCacheBackgroundColor); 12344 } 12345 12346 computeScroll(); 12347 final int restoreCount = canvas.save(); 12348 12349 if (autoScale && scalingRequired) { 12350 final float scale = attachInfo.mApplicationScale; 12351 canvas.scale(scale, scale); 12352 } 12353 12354 canvas.translate(-mScrollX, -mScrollY); 12355 12356 mPrivateFlags |= DRAWN; 12357 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 12358 mLayerType != LAYER_TYPE_NONE) { 12359 mPrivateFlags |= DRAWING_CACHE_VALID; 12360 } 12361 12362 // Fast path for layouts with no backgrounds 12363 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 12364 if (ViewDebug.TRACE_HIERARCHY) { 12365 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 12366 } 12367 mPrivateFlags &= ~DIRTY_MASK; 12368 dispatchDraw(canvas); 12369 } else { 12370 draw(canvas); 12371 } 12372 12373 canvas.restoreToCount(restoreCount); 12374 canvas.setBitmap(null); 12375 12376 if (attachInfo != null) { 12377 // Restore the cached Canvas for our siblings 12378 attachInfo.mCanvas = canvas; 12379 } 12380 } 12381 } 12382 12383 /** 12384 * Create a snapshot of the view into a bitmap. We should probably make 12385 * some form of this public, but should think about the API. 12386 */ 12387 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 12388 int width = mRight - mLeft; 12389 int height = mBottom - mTop; 12390 12391 final AttachInfo attachInfo = mAttachInfo; 12392 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 12393 width = (int) ((width * scale) + 0.5f); 12394 height = (int) ((height * scale) + 0.5f); 12395 12396 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality); 12397 if (bitmap == null) { 12398 throw new OutOfMemoryError(); 12399 } 12400 12401 Resources resources = getResources(); 12402 if (resources != null) { 12403 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 12404 } 12405 12406 Canvas canvas; 12407 if (attachInfo != null) { 12408 canvas = attachInfo.mCanvas; 12409 if (canvas == null) { 12410 canvas = new Canvas(); 12411 } 12412 canvas.setBitmap(bitmap); 12413 // Temporarily clobber the cached Canvas in case one of our children 12414 // is also using a drawing cache. Without this, the children would 12415 // steal the canvas by attaching their own bitmap to it and bad, bad 12416 // things would happen (invisible views, corrupted drawings, etc.) 12417 attachInfo.mCanvas = null; 12418 } else { 12419 // This case should hopefully never or seldom happen 12420 canvas = new Canvas(bitmap); 12421 } 12422 12423 if ((backgroundColor & 0xff000000) != 0) { 12424 bitmap.eraseColor(backgroundColor); 12425 } 12426 12427 computeScroll(); 12428 final int restoreCount = canvas.save(); 12429 canvas.scale(scale, scale); 12430 canvas.translate(-mScrollX, -mScrollY); 12431 12432 // Temporarily remove the dirty mask 12433 int flags = mPrivateFlags; 12434 mPrivateFlags &= ~DIRTY_MASK; 12435 12436 // Fast path for layouts with no backgrounds 12437 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 12438 dispatchDraw(canvas); 12439 } else { 12440 draw(canvas); 12441 } 12442 12443 mPrivateFlags = flags; 12444 12445 canvas.restoreToCount(restoreCount); 12446 canvas.setBitmap(null); 12447 12448 if (attachInfo != null) { 12449 // Restore the cached Canvas for our siblings 12450 attachInfo.mCanvas = canvas; 12451 } 12452 12453 return bitmap; 12454 } 12455 12456 /** 12457 * Indicates whether this View is currently in edit mode. A View is usually 12458 * in edit mode when displayed within a developer tool. For instance, if 12459 * this View is being drawn by a visual user interface builder, this method 12460 * should return true. 12461 * 12462 * Subclasses should check the return value of this method to provide 12463 * different behaviors if their normal behavior might interfere with the 12464 * host environment. For instance: the class spawns a thread in its 12465 * constructor, the drawing code relies on device-specific features, etc. 12466 * 12467 * This method is usually checked in the drawing code of custom widgets. 12468 * 12469 * @return True if this View is in edit mode, false otherwise. 12470 */ 12471 public boolean isInEditMode() { 12472 return false; 12473 } 12474 12475 /** 12476 * If the View draws content inside its padding and enables fading edges, 12477 * it needs to support padding offsets. Padding offsets are added to the 12478 * fading edges to extend the length of the fade so that it covers pixels 12479 * drawn inside the padding. 12480 * 12481 * Subclasses of this class should override this method if they need 12482 * to draw content inside the padding. 12483 * 12484 * @return True if padding offset must be applied, false otherwise. 12485 * 12486 * @see #getLeftPaddingOffset() 12487 * @see #getRightPaddingOffset() 12488 * @see #getTopPaddingOffset() 12489 * @see #getBottomPaddingOffset() 12490 * 12491 * @since CURRENT 12492 */ 12493 protected boolean isPaddingOffsetRequired() { 12494 return false; 12495 } 12496 12497 /** 12498 * Amount by which to extend the left fading region. Called only when 12499 * {@link #isPaddingOffsetRequired()} returns true. 12500 * 12501 * @return The left padding offset in pixels. 12502 * 12503 * @see #isPaddingOffsetRequired() 12504 * 12505 * @since CURRENT 12506 */ 12507 protected int getLeftPaddingOffset() { 12508 return 0; 12509 } 12510 12511 /** 12512 * Amount by which to extend the right fading region. Called only when 12513 * {@link #isPaddingOffsetRequired()} returns true. 12514 * 12515 * @return The right padding offset in pixels. 12516 * 12517 * @see #isPaddingOffsetRequired() 12518 * 12519 * @since CURRENT 12520 */ 12521 protected int getRightPaddingOffset() { 12522 return 0; 12523 } 12524 12525 /** 12526 * Amount by which to extend the top fading region. Called only when 12527 * {@link #isPaddingOffsetRequired()} returns true. 12528 * 12529 * @return The top padding offset in pixels. 12530 * 12531 * @see #isPaddingOffsetRequired() 12532 * 12533 * @since CURRENT 12534 */ 12535 protected int getTopPaddingOffset() { 12536 return 0; 12537 } 12538 12539 /** 12540 * Amount by which to extend the bottom fading region. Called only when 12541 * {@link #isPaddingOffsetRequired()} returns true. 12542 * 12543 * @return The bottom padding offset in pixels. 12544 * 12545 * @see #isPaddingOffsetRequired() 12546 * 12547 * @since CURRENT 12548 */ 12549 protected int getBottomPaddingOffset() { 12550 return 0; 12551 } 12552 12553 /** 12554 * @hide 12555 * @param offsetRequired 12556 */ 12557 protected int getFadeTop(boolean offsetRequired) { 12558 int top = mPaddingTop; 12559 if (offsetRequired) top += getTopPaddingOffset(); 12560 return top; 12561 } 12562 12563 /** 12564 * @hide 12565 * @param offsetRequired 12566 */ 12567 protected int getFadeHeight(boolean offsetRequired) { 12568 int padding = mPaddingTop; 12569 if (offsetRequired) padding += getTopPaddingOffset(); 12570 return mBottom - mTop - mPaddingBottom - padding; 12571 } 12572 12573 /** 12574 * <p>Indicates whether this view is attached to a hardware accelerated 12575 * window or not.</p> 12576 * 12577 * <p>Even if this method returns true, it does not mean that every call 12578 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 12579 * accelerated {@link android.graphics.Canvas}. For instance, if this view 12580 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its 12581 * window is hardware accelerated, 12582 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 12583 * return false, and this method will return true.</p> 12584 * 12585 * @return True if the view is attached to a window and the window is 12586 * hardware accelerated; false in any other case. 12587 */ 12588 public boolean isHardwareAccelerated() { 12589 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 12590 } 12591 12592 /** 12593 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common 12594 * case of an active Animation being run on the view. 12595 */ 12596 private boolean drawAnimation(ViewGroup parent, long drawingTime, 12597 Animation a, boolean scalingRequired) { 12598 Transformation invalidationTransform; 12599 final int flags = parent.mGroupFlags; 12600 final boolean initialized = a.isInitialized(); 12601 if (!initialized) { 12602 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight()); 12603 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop); 12604 onAnimationStart(); 12605 } 12606 12607 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f); 12608 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) { 12609 if (parent.mInvalidationTransformation == null) { 12610 parent.mInvalidationTransformation = new Transformation(); 12611 } 12612 invalidationTransform = parent.mInvalidationTransformation; 12613 a.getTransformation(drawingTime, invalidationTransform, 1f); 12614 } else { 12615 invalidationTransform = parent.mChildTransformation; 12616 } 12617 if (more) { 12618 if (!a.willChangeBounds()) { 12619 if ((flags & (parent.FLAG_OPTIMIZE_INVALIDATE | parent.FLAG_ANIMATION_DONE)) == 12620 parent.FLAG_OPTIMIZE_INVALIDATE) { 12621 parent.mGroupFlags |= parent.FLAG_INVALIDATE_REQUIRED; 12622 } else if ((flags & parent.FLAG_INVALIDATE_REQUIRED) == 0) { 12623 // The child need to draw an animation, potentially offscreen, so 12624 // make sure we do not cancel invalidate requests 12625 parent.mPrivateFlags |= DRAW_ANIMATION; 12626 parent.invalidate(mLeft, mTop, mRight, mBottom); 12627 } 12628 } else { 12629 if (parent.mInvalidateRegion == null) { 12630 parent.mInvalidateRegion = new RectF(); 12631 } 12632 final RectF region = parent.mInvalidateRegion; 12633 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region, 12634 invalidationTransform); 12635 12636 // The child need to draw an animation, potentially offscreen, so 12637 // make sure we do not cancel invalidate requests 12638 parent.mPrivateFlags |= DRAW_ANIMATION; 12639 12640 final int left = mLeft + (int) region.left; 12641 final int top = mTop + (int) region.top; 12642 parent.invalidate(left, top, left + (int) (region.width() + .5f), 12643 top + (int) (region.height() + .5f)); 12644 } 12645 } 12646 return more; 12647 } 12648 12649 /** 12650 * This method is called by getDisplayList() when a display list is created or re-rendered. 12651 * It sets or resets the current value of all properties on that display list (resetting is 12652 * necessary when a display list is being re-created, because we need to make sure that 12653 * previously-set transform values 12654 */ 12655 void setDisplayListProperties(DisplayList displayList) { 12656 if (displayList != null) { 12657 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 12658 displayList.setHasOverlappingRendering(hasOverlappingRendering()); 12659 if (mParent instanceof ViewGroup) { 12660 displayList.setClipChildren( 12661 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0); 12662 } 12663 float alpha = 1; 12664 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags & 12665 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 12666 ViewGroup parentVG = (ViewGroup) mParent; 12667 final boolean hasTransform = 12668 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation); 12669 if (hasTransform) { 12670 Transformation transform = parentVG.mChildTransformation; 12671 final int transformType = parentVG.mChildTransformation.getTransformationType(); 12672 if (transformType != Transformation.TYPE_IDENTITY) { 12673 if ((transformType & Transformation.TYPE_ALPHA) != 0) { 12674 alpha = transform.getAlpha(); 12675 } 12676 if ((transformType & Transformation.TYPE_MATRIX) != 0) { 12677 displayList.setStaticMatrix(transform.getMatrix()); 12678 } 12679 } 12680 } 12681 } 12682 if (mTransformationInfo != null) { 12683 alpha *= mTransformationInfo.mAlpha; 12684 if (alpha < 1) { 12685 final int multipliedAlpha = (int) (255 * alpha); 12686 if (onSetAlpha(multipliedAlpha)) { 12687 alpha = 1; 12688 } 12689 } 12690 displayList.setTransformationInfo(alpha, 12691 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY, 12692 mTransformationInfo.mRotation, mTransformationInfo.mRotationX, 12693 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX, 12694 mTransformationInfo.mScaleY); 12695 if (mTransformationInfo.mCamera == null) { 12696 mTransformationInfo.mCamera = new Camera(); 12697 mTransformationInfo.matrix3D = new Matrix(); 12698 } 12699 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ()); 12700 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == PIVOT_EXPLICITLY_SET) { 12701 displayList.setPivotX(getPivotX()); 12702 displayList.setPivotY(getPivotY()); 12703 } 12704 } else if (alpha < 1) { 12705 displayList.setAlpha(alpha); 12706 } 12707 } 12708 } 12709 12710 /** 12711 * This method is called by ViewGroup.drawChild() to have each child view draw itself. 12712 * This draw() method is an implementation detail and is not intended to be overridden or 12713 * to be called from anywhere else other than ViewGroup.drawChild(). 12714 */ 12715 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) { 12716 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 12717 boolean more = false; 12718 final boolean childHasIdentityMatrix = hasIdentityMatrix(); 12719 final int flags = parent.mGroupFlags; 12720 12721 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) { 12722 parent.mChildTransformation.clear(); 12723 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION; 12724 } 12725 12726 Transformation transformToApply = null; 12727 boolean concatMatrix = false; 12728 12729 boolean scalingRequired = false; 12730 boolean caching; 12731 int layerType = parent.mDrawLayers ? getLayerType() : LAYER_TYPE_NONE; 12732 12733 final boolean hardwareAccelerated = canvas.isHardwareAccelerated(); 12734 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 || 12735 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) { 12736 caching = true; 12737 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList 12738 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired; 12739 } else { 12740 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated; 12741 } 12742 12743 final Animation a = getAnimation(); 12744 if (a != null) { 12745 more = drawAnimation(parent, drawingTime, a, scalingRequired); 12746 concatMatrix = a.willChangeTransformationMatrix(); 12747 transformToApply = parent.mChildTransformation; 12748 } else if (!useDisplayListProperties && 12749 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) { 12750 final boolean hasTransform = 12751 parent.getChildStaticTransformation(this, parent.mChildTransformation); 12752 if (hasTransform) { 12753 final int transformType = parent.mChildTransformation.getTransformationType(); 12754 transformToApply = transformType != Transformation.TYPE_IDENTITY ? 12755 parent.mChildTransformation : null; 12756 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0; 12757 } 12758 } 12759 12760 concatMatrix |= !childHasIdentityMatrix; 12761 12762 // Sets the flag as early as possible to allow draw() implementations 12763 // to call invalidate() successfully when doing animations 12764 mPrivateFlags |= DRAWN; 12765 12766 if (!concatMatrix && canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) && 12767 (mPrivateFlags & DRAW_ANIMATION) == 0) { 12768 return more; 12769 } 12770 12771 if (hardwareAccelerated) { 12772 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but 12773 // retain the flag's value temporarily in the mRecreateDisplayList flag 12774 mRecreateDisplayList = (mPrivateFlags & INVALIDATED) == INVALIDATED; 12775 mPrivateFlags &= ~INVALIDATED; 12776 } 12777 12778 computeScroll(); 12779 12780 final int sx = mScrollX; 12781 final int sy = mScrollY; 12782 12783 DisplayList displayList = null; 12784 Bitmap cache = null; 12785 boolean hasDisplayList = false; 12786 if (caching) { 12787 if (!hardwareAccelerated) { 12788 if (layerType != LAYER_TYPE_NONE) { 12789 layerType = LAYER_TYPE_SOFTWARE; 12790 buildDrawingCache(true); 12791 } 12792 cache = getDrawingCache(true); 12793 } else { 12794 switch (layerType) { 12795 case LAYER_TYPE_SOFTWARE: 12796 if (useDisplayListProperties) { 12797 hasDisplayList = canHaveDisplayList(); 12798 } else { 12799 buildDrawingCache(true); 12800 cache = getDrawingCache(true); 12801 } 12802 break; 12803 case LAYER_TYPE_HARDWARE: 12804 if (useDisplayListProperties) { 12805 hasDisplayList = canHaveDisplayList(); 12806 } 12807 break; 12808 case LAYER_TYPE_NONE: 12809 // Delay getting the display list until animation-driven alpha values are 12810 // set up and possibly passed on to the view 12811 hasDisplayList = canHaveDisplayList(); 12812 break; 12813 } 12814 } 12815 } 12816 useDisplayListProperties &= hasDisplayList; 12817 if (useDisplayListProperties) { 12818 displayList = getDisplayList(); 12819 if (!displayList.isValid()) { 12820 // Uncommon, but possible. If a view is removed from the hierarchy during the call 12821 // to getDisplayList(), the display list will be marked invalid and we should not 12822 // try to use it again. 12823 displayList = null; 12824 hasDisplayList = false; 12825 useDisplayListProperties = false; 12826 } 12827 } 12828 12829 final boolean hasNoCache = cache == null || hasDisplayList; 12830 final boolean offsetForScroll = cache == null && !hasDisplayList && 12831 layerType != LAYER_TYPE_HARDWARE; 12832 12833 int restoreTo = -1; 12834 if (!useDisplayListProperties || transformToApply != null) { 12835 restoreTo = canvas.save(); 12836 } 12837 if (offsetForScroll) { 12838 canvas.translate(mLeft - sx, mTop - sy); 12839 } else { 12840 if (!useDisplayListProperties) { 12841 canvas.translate(mLeft, mTop); 12842 } 12843 if (scalingRequired) { 12844 if (useDisplayListProperties) { 12845 // TODO: Might not need this if we put everything inside the DL 12846 restoreTo = canvas.save(); 12847 } 12848 // mAttachInfo cannot be null, otherwise scalingRequired == false 12849 final float scale = 1.0f / mAttachInfo.mApplicationScale; 12850 canvas.scale(scale, scale); 12851 } 12852 } 12853 12854 float alpha = useDisplayListProperties ? 1 : getAlpha(); 12855 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix()) { 12856 if (transformToApply != null || !childHasIdentityMatrix) { 12857 int transX = 0; 12858 int transY = 0; 12859 12860 if (offsetForScroll) { 12861 transX = -sx; 12862 transY = -sy; 12863 } 12864 12865 if (transformToApply != null) { 12866 if (concatMatrix) { 12867 if (useDisplayListProperties) { 12868 displayList.setAnimationMatrix(transformToApply.getMatrix()); 12869 } else { 12870 // Undo the scroll translation, apply the transformation matrix, 12871 // then redo the scroll translate to get the correct result. 12872 canvas.translate(-transX, -transY); 12873 canvas.concat(transformToApply.getMatrix()); 12874 canvas.translate(transX, transY); 12875 } 12876 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 12877 } 12878 12879 float transformAlpha = transformToApply.getAlpha(); 12880 if (transformAlpha < 1) { 12881 alpha *= transformToApply.getAlpha(); 12882 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 12883 } 12884 } 12885 12886 if (!childHasIdentityMatrix && !useDisplayListProperties) { 12887 canvas.translate(-transX, -transY); 12888 canvas.concat(getMatrix()); 12889 canvas.translate(transX, transY); 12890 } 12891 } 12892 12893 if (alpha < 1) { 12894 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION; 12895 if (hasNoCache) { 12896 final int multipliedAlpha = (int) (255 * alpha); 12897 if (!onSetAlpha(multipliedAlpha)) { 12898 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 12899 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 || 12900 layerType != LAYER_TYPE_NONE) { 12901 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG; 12902 } 12903 if (useDisplayListProperties) { 12904 displayList.setAlpha(alpha * getAlpha()); 12905 } else if (layerType == LAYER_TYPE_NONE) { 12906 final int scrollX = hasDisplayList ? 0 : sx; 12907 final int scrollY = hasDisplayList ? 0 : sy; 12908 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft, 12909 scrollY + mBottom - mTop, multipliedAlpha, layerFlags); 12910 } 12911 } else { 12912 // Alpha is handled by the child directly, clobber the layer's alpha 12913 mPrivateFlags |= ALPHA_SET; 12914 } 12915 } 12916 } 12917 } else if ((mPrivateFlags & ALPHA_SET) == ALPHA_SET) { 12918 onSetAlpha(255); 12919 mPrivateFlags &= ~ALPHA_SET; 12920 } 12921 12922 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN && 12923 !useDisplayListProperties) { 12924 if (offsetForScroll) { 12925 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop)); 12926 } else { 12927 if (!scalingRequired || cache == null) { 12928 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop); 12929 } else { 12930 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight()); 12931 } 12932 } 12933 } 12934 12935 if (!useDisplayListProperties && hasDisplayList) { 12936 displayList = getDisplayList(); 12937 if (!displayList.isValid()) { 12938 // Uncommon, but possible. If a view is removed from the hierarchy during the call 12939 // to getDisplayList(), the display list will be marked invalid and we should not 12940 // try to use it again. 12941 displayList = null; 12942 hasDisplayList = false; 12943 } 12944 } 12945 12946 if (hasNoCache) { 12947 boolean layerRendered = false; 12948 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) { 12949 final HardwareLayer layer = getHardwareLayer(); 12950 if (layer != null && layer.isValid()) { 12951 mLayerPaint.setAlpha((int) (alpha * 255)); 12952 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint); 12953 layerRendered = true; 12954 } else { 12955 final int scrollX = hasDisplayList ? 0 : sx; 12956 final int scrollY = hasDisplayList ? 0 : sy; 12957 canvas.saveLayer(scrollX, scrollY, 12958 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint, 12959 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG); 12960 } 12961 } 12962 12963 if (!layerRendered) { 12964 if (!hasDisplayList) { 12965 // Fast path for layouts with no backgrounds 12966 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 12967 if (ViewDebug.TRACE_HIERARCHY) { 12968 ViewDebug.trace(parent, ViewDebug.HierarchyTraceType.DRAW); 12969 } 12970 mPrivateFlags &= ~DIRTY_MASK; 12971 dispatchDraw(canvas); 12972 } else { 12973 draw(canvas); 12974 } 12975 } else { 12976 mPrivateFlags &= ~DIRTY_MASK; 12977 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags); 12978 } 12979 } 12980 } else if (cache != null) { 12981 mPrivateFlags &= ~DIRTY_MASK; 12982 Paint cachePaint; 12983 12984 if (layerType == LAYER_TYPE_NONE) { 12985 cachePaint = parent.mCachePaint; 12986 if (cachePaint == null) { 12987 cachePaint = new Paint(); 12988 cachePaint.setDither(false); 12989 parent.mCachePaint = cachePaint; 12990 } 12991 if (alpha < 1) { 12992 cachePaint.setAlpha((int) (alpha * 255)); 12993 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE; 12994 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) { 12995 cachePaint.setAlpha(255); 12996 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE; 12997 } 12998 } else { 12999 cachePaint = mLayerPaint; 13000 cachePaint.setAlpha((int) (alpha * 255)); 13001 } 13002 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint); 13003 } 13004 13005 if (restoreTo >= 0) { 13006 canvas.restoreToCount(restoreTo); 13007 } 13008 13009 if (a != null && !more) { 13010 if (!hardwareAccelerated && !a.getFillAfter()) { 13011 onSetAlpha(255); 13012 } 13013 parent.finishAnimatingView(this, a); 13014 } 13015 13016 if (more && hardwareAccelerated) { 13017 // invalidation is the trigger to recreate display lists, so if we're using 13018 // display lists to render, force an invalidate to allow the animation to 13019 // continue drawing another frame 13020 parent.invalidate(true); 13021 if (a.hasAlpha() && (mPrivateFlags & ALPHA_SET) == ALPHA_SET) { 13022 // alpha animations should cause the child to recreate its display list 13023 invalidate(true); 13024 } 13025 } 13026 13027 mRecreateDisplayList = false; 13028 13029 return more; 13030 } 13031 13032 /** 13033 * Manually render this view (and all of its children) to the given Canvas. 13034 * The view must have already done a full layout before this function is 13035 * called. When implementing a view, implement 13036 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 13037 * If you do need to override this method, call the superclass version. 13038 * 13039 * @param canvas The Canvas to which the View is rendered. 13040 */ 13041 public void draw(Canvas canvas) { 13042 if (ViewDebug.TRACE_HIERARCHY) { 13043 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 13044 } 13045 13046 final int privateFlags = mPrivateFlags; 13047 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE && 13048 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 13049 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN; 13050 13051 /* 13052 * Draw traversal performs several drawing steps which must be executed 13053 * in the appropriate order: 13054 * 13055 * 1. Draw the background 13056 * 2. If necessary, save the canvas' layers to prepare for fading 13057 * 3. Draw view's content 13058 * 4. Draw children 13059 * 5. If necessary, draw the fading edges and restore layers 13060 * 6. Draw decorations (scrollbars for instance) 13061 */ 13062 13063 // Step 1, draw the background, if needed 13064 int saveCount; 13065 13066 if (!dirtyOpaque) { 13067 final Drawable background = mBackground; 13068 if (background != null) { 13069 final int scrollX = mScrollX; 13070 final int scrollY = mScrollY; 13071 13072 if (mBackgroundSizeChanged) { 13073 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 13074 mBackgroundSizeChanged = false; 13075 } 13076 13077 if ((scrollX | scrollY) == 0) { 13078 background.draw(canvas); 13079 } else { 13080 canvas.translate(scrollX, scrollY); 13081 background.draw(canvas); 13082 canvas.translate(-scrollX, -scrollY); 13083 } 13084 } 13085 } 13086 13087 // skip step 2 & 5 if possible (common case) 13088 final int viewFlags = mViewFlags; 13089 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 13090 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 13091 if (!verticalEdges && !horizontalEdges) { 13092 // Step 3, draw the content 13093 if (!dirtyOpaque) onDraw(canvas); 13094 13095 // Step 4, draw the children 13096 dispatchDraw(canvas); 13097 13098 // Step 6, draw decorations (scrollbars) 13099 onDrawScrollBars(canvas); 13100 13101 // we're done... 13102 return; 13103 } 13104 13105 /* 13106 * Here we do the full fledged routine... 13107 * (this is an uncommon case where speed matters less, 13108 * this is why we repeat some of the tests that have been 13109 * done above) 13110 */ 13111 13112 boolean drawTop = false; 13113 boolean drawBottom = false; 13114 boolean drawLeft = false; 13115 boolean drawRight = false; 13116 13117 float topFadeStrength = 0.0f; 13118 float bottomFadeStrength = 0.0f; 13119 float leftFadeStrength = 0.0f; 13120 float rightFadeStrength = 0.0f; 13121 13122 // Step 2, save the canvas' layers 13123 int paddingLeft = mPaddingLeft; 13124 13125 final boolean offsetRequired = isPaddingOffsetRequired(); 13126 if (offsetRequired) { 13127 paddingLeft += getLeftPaddingOffset(); 13128 } 13129 13130 int left = mScrollX + paddingLeft; 13131 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 13132 int top = mScrollY + getFadeTop(offsetRequired); 13133 int bottom = top + getFadeHeight(offsetRequired); 13134 13135 if (offsetRequired) { 13136 right += getRightPaddingOffset(); 13137 bottom += getBottomPaddingOffset(); 13138 } 13139 13140 final ScrollabilityCache scrollabilityCache = mScrollCache; 13141 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 13142 int length = (int) fadeHeight; 13143 13144 // clip the fade length if top and bottom fades overlap 13145 // overlapping fades produce odd-looking artifacts 13146 if (verticalEdges && (top + length > bottom - length)) { 13147 length = (bottom - top) / 2; 13148 } 13149 13150 // also clip horizontal fades if necessary 13151 if (horizontalEdges && (left + length > right - length)) { 13152 length = (right - left) / 2; 13153 } 13154 13155 if (verticalEdges) { 13156 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 13157 drawTop = topFadeStrength * fadeHeight > 1.0f; 13158 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 13159 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 13160 } 13161 13162 if (horizontalEdges) { 13163 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 13164 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 13165 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 13166 drawRight = rightFadeStrength * fadeHeight > 1.0f; 13167 } 13168 13169 saveCount = canvas.getSaveCount(); 13170 13171 int solidColor = getSolidColor(); 13172 if (solidColor == 0) { 13173 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 13174 13175 if (drawTop) { 13176 canvas.saveLayer(left, top, right, top + length, null, flags); 13177 } 13178 13179 if (drawBottom) { 13180 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 13181 } 13182 13183 if (drawLeft) { 13184 canvas.saveLayer(left, top, left + length, bottom, null, flags); 13185 } 13186 13187 if (drawRight) { 13188 canvas.saveLayer(right - length, top, right, bottom, null, flags); 13189 } 13190 } else { 13191 scrollabilityCache.setFadeColor(solidColor); 13192 } 13193 13194 // Step 3, draw the content 13195 if (!dirtyOpaque) onDraw(canvas); 13196 13197 // Step 4, draw the children 13198 dispatchDraw(canvas); 13199 13200 // Step 5, draw the fade effect and restore layers 13201 final Paint p = scrollabilityCache.paint; 13202 final Matrix matrix = scrollabilityCache.matrix; 13203 final Shader fade = scrollabilityCache.shader; 13204 13205 if (drawTop) { 13206 matrix.setScale(1, fadeHeight * topFadeStrength); 13207 matrix.postTranslate(left, top); 13208 fade.setLocalMatrix(matrix); 13209 canvas.drawRect(left, top, right, top + length, p); 13210 } 13211 13212 if (drawBottom) { 13213 matrix.setScale(1, fadeHeight * bottomFadeStrength); 13214 matrix.postRotate(180); 13215 matrix.postTranslate(left, bottom); 13216 fade.setLocalMatrix(matrix); 13217 canvas.drawRect(left, bottom - length, right, bottom, p); 13218 } 13219 13220 if (drawLeft) { 13221 matrix.setScale(1, fadeHeight * leftFadeStrength); 13222 matrix.postRotate(-90); 13223 matrix.postTranslate(left, top); 13224 fade.setLocalMatrix(matrix); 13225 canvas.drawRect(left, top, left + length, bottom, p); 13226 } 13227 13228 if (drawRight) { 13229 matrix.setScale(1, fadeHeight * rightFadeStrength); 13230 matrix.postRotate(90); 13231 matrix.postTranslate(right, top); 13232 fade.setLocalMatrix(matrix); 13233 canvas.drawRect(right - length, top, right, bottom, p); 13234 } 13235 13236 canvas.restoreToCount(saveCount); 13237 13238 // Step 6, draw decorations (scrollbars) 13239 onDrawScrollBars(canvas); 13240 } 13241 13242 /** 13243 * Override this if your view is known to always be drawn on top of a solid color background, 13244 * and needs to draw fading edges. Returning a non-zero color enables the view system to 13245 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 13246 * should be set to 0xFF. 13247 * 13248 * @see #setVerticalFadingEdgeEnabled(boolean) 13249 * @see #setHorizontalFadingEdgeEnabled(boolean) 13250 * 13251 * @return The known solid color background for this view, or 0 if the color may vary 13252 */ 13253 @ViewDebug.ExportedProperty(category = "drawing") 13254 public int getSolidColor() { 13255 return 0; 13256 } 13257 13258 /** 13259 * Build a human readable string representation of the specified view flags. 13260 * 13261 * @param flags the view flags to convert to a string 13262 * @return a String representing the supplied flags 13263 */ 13264 private static String printFlags(int flags) { 13265 String output = ""; 13266 int numFlags = 0; 13267 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 13268 output += "TAKES_FOCUS"; 13269 numFlags++; 13270 } 13271 13272 switch (flags & VISIBILITY_MASK) { 13273 case INVISIBLE: 13274 if (numFlags > 0) { 13275 output += " "; 13276 } 13277 output += "INVISIBLE"; 13278 // USELESS HERE numFlags++; 13279 break; 13280 case GONE: 13281 if (numFlags > 0) { 13282 output += " "; 13283 } 13284 output += "GONE"; 13285 // USELESS HERE numFlags++; 13286 break; 13287 default: 13288 break; 13289 } 13290 return output; 13291 } 13292 13293 /** 13294 * Build a human readable string representation of the specified private 13295 * view flags. 13296 * 13297 * @param privateFlags the private view flags to convert to a string 13298 * @return a String representing the supplied flags 13299 */ 13300 private static String printPrivateFlags(int privateFlags) { 13301 String output = ""; 13302 int numFlags = 0; 13303 13304 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) { 13305 output += "WANTS_FOCUS"; 13306 numFlags++; 13307 } 13308 13309 if ((privateFlags & FOCUSED) == FOCUSED) { 13310 if (numFlags > 0) { 13311 output += " "; 13312 } 13313 output += "FOCUSED"; 13314 numFlags++; 13315 } 13316 13317 if ((privateFlags & SELECTED) == SELECTED) { 13318 if (numFlags > 0) { 13319 output += " "; 13320 } 13321 output += "SELECTED"; 13322 numFlags++; 13323 } 13324 13325 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) { 13326 if (numFlags > 0) { 13327 output += " "; 13328 } 13329 output += "IS_ROOT_NAMESPACE"; 13330 numFlags++; 13331 } 13332 13333 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) { 13334 if (numFlags > 0) { 13335 output += " "; 13336 } 13337 output += "HAS_BOUNDS"; 13338 numFlags++; 13339 } 13340 13341 if ((privateFlags & DRAWN) == DRAWN) { 13342 if (numFlags > 0) { 13343 output += " "; 13344 } 13345 output += "DRAWN"; 13346 // USELESS HERE numFlags++; 13347 } 13348 return output; 13349 } 13350 13351 /** 13352 * <p>Indicates whether or not this view's layout will be requested during 13353 * the next hierarchy layout pass.</p> 13354 * 13355 * @return true if the layout will be forced during next layout pass 13356 */ 13357 public boolean isLayoutRequested() { 13358 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT; 13359 } 13360 13361 /** 13362 * Assign a size and position to a view and all of its 13363 * descendants 13364 * 13365 * <p>This is the second phase of the layout mechanism. 13366 * (The first is measuring). In this phase, each parent calls 13367 * layout on all of its children to position them. 13368 * This is typically done using the child measurements 13369 * that were stored in the measure pass().</p> 13370 * 13371 * <p>Derived classes should not override this method. 13372 * Derived classes with children should override 13373 * onLayout. In that method, they should 13374 * call layout on each of their children.</p> 13375 * 13376 * @param l Left position, relative to parent 13377 * @param t Top position, relative to parent 13378 * @param r Right position, relative to parent 13379 * @param b Bottom position, relative to parent 13380 */ 13381 @SuppressWarnings({"unchecked"}) 13382 public void layout(int l, int t, int r, int b) { 13383 int oldL = mLeft; 13384 int oldT = mTop; 13385 int oldB = mBottom; 13386 int oldR = mRight; 13387 boolean changed = setFrame(l, t, r, b); 13388 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) { 13389 if (ViewDebug.TRACE_HIERARCHY) { 13390 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT); 13391 } 13392 13393 onLayout(changed, l, t, r, b); 13394 mPrivateFlags &= ~LAYOUT_REQUIRED; 13395 13396 ListenerInfo li = mListenerInfo; 13397 if (li != null && li.mOnLayoutChangeListeners != null) { 13398 ArrayList<OnLayoutChangeListener> listenersCopy = 13399 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 13400 int numListeners = listenersCopy.size(); 13401 for (int i = 0; i < numListeners; ++i) { 13402 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 13403 } 13404 } 13405 } 13406 mPrivateFlags &= ~FORCE_LAYOUT; 13407 } 13408 13409 /** 13410 * Called from layout when this view should 13411 * assign a size and position to each of its children. 13412 * 13413 * Derived classes with children should override 13414 * this method and call layout on each of 13415 * their children. 13416 * @param changed This is a new size or position for this view 13417 * @param left Left position, relative to parent 13418 * @param top Top position, relative to parent 13419 * @param right Right position, relative to parent 13420 * @param bottom Bottom position, relative to parent 13421 */ 13422 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 13423 } 13424 13425 /** 13426 * Assign a size and position to this view. 13427 * 13428 * This is called from layout. 13429 * 13430 * @param left Left position, relative to parent 13431 * @param top Top position, relative to parent 13432 * @param right Right position, relative to parent 13433 * @param bottom Bottom position, relative to parent 13434 * @return true if the new size and position are different than the 13435 * previous ones 13436 * {@hide} 13437 */ 13438 protected boolean setFrame(int left, int top, int right, int bottom) { 13439 boolean changed = false; 13440 13441 if (DBG) { 13442 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 13443 + right + "," + bottom + ")"); 13444 } 13445 13446 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 13447 changed = true; 13448 13449 // Remember our drawn bit 13450 int drawn = mPrivateFlags & DRAWN; 13451 13452 int oldWidth = mRight - mLeft; 13453 int oldHeight = mBottom - mTop; 13454 int newWidth = right - left; 13455 int newHeight = bottom - top; 13456 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 13457 13458 // Invalidate our old position 13459 invalidate(sizeChanged); 13460 13461 mLeft = left; 13462 mTop = top; 13463 mRight = right; 13464 mBottom = bottom; 13465 if (mDisplayList != null) { 13466 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom); 13467 } 13468 13469 mPrivateFlags |= HAS_BOUNDS; 13470 13471 13472 if (sizeChanged) { 13473 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 13474 // A change in dimension means an auto-centered pivot point changes, too 13475 if (mTransformationInfo != null) { 13476 mTransformationInfo.mMatrixDirty = true; 13477 } 13478 } 13479 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 13480 } 13481 13482 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) { 13483 // If we are visible, force the DRAWN bit to on so that 13484 // this invalidate will go through (at least to our parent). 13485 // This is because someone may have invalidated this view 13486 // before this call to setFrame came in, thereby clearing 13487 // the DRAWN bit. 13488 mPrivateFlags |= DRAWN; 13489 invalidate(sizeChanged); 13490 // parent display list may need to be recreated based on a change in the bounds 13491 // of any child 13492 invalidateParentCaches(); 13493 } 13494 13495 // Reset drawn bit to original value (invalidate turns it off) 13496 mPrivateFlags |= drawn; 13497 13498 mBackgroundSizeChanged = true; 13499 } 13500 return changed; 13501 } 13502 13503 /** 13504 * Finalize inflating a view from XML. This is called as the last phase 13505 * of inflation, after all child views have been added. 13506 * 13507 * <p>Even if the subclass overrides onFinishInflate, they should always be 13508 * sure to call the super method, so that we get called. 13509 */ 13510 protected void onFinishInflate() { 13511 } 13512 13513 /** 13514 * Returns the resources associated with this view. 13515 * 13516 * @return Resources object. 13517 */ 13518 public Resources getResources() { 13519 return mResources; 13520 } 13521 13522 /** 13523 * Invalidates the specified Drawable. 13524 * 13525 * @param drawable the drawable to invalidate 13526 */ 13527 public void invalidateDrawable(Drawable drawable) { 13528 if (verifyDrawable(drawable)) { 13529 final Rect dirty = drawable.getBounds(); 13530 final int scrollX = mScrollX; 13531 final int scrollY = mScrollY; 13532 13533 invalidate(dirty.left + scrollX, dirty.top + scrollY, 13534 dirty.right + scrollX, dirty.bottom + scrollY); 13535 } 13536 } 13537 13538 /** 13539 * Schedules an action on a drawable to occur at a specified time. 13540 * 13541 * @param who the recipient of the action 13542 * @param what the action to run on the drawable 13543 * @param when the time at which the action must occur. Uses the 13544 * {@link SystemClock#uptimeMillis} timebase. 13545 */ 13546 public void scheduleDrawable(Drawable who, Runnable what, long when) { 13547 if (verifyDrawable(who) && what != null) { 13548 final long delay = when - SystemClock.uptimeMillis(); 13549 if (mAttachInfo != null) { 13550 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed( 13551 Choreographer.CALLBACK_ANIMATION, what, who, 13552 Choreographer.subtractFrameDelay(delay)); 13553 } else { 13554 ViewRootImpl.getRunQueue().postDelayed(what, delay); 13555 } 13556 } 13557 } 13558 13559 /** 13560 * Cancels a scheduled action on a drawable. 13561 * 13562 * @param who the recipient of the action 13563 * @param what the action to cancel 13564 */ 13565 public void unscheduleDrawable(Drawable who, Runnable what) { 13566 if (verifyDrawable(who) && what != null) { 13567 if (mAttachInfo != null) { 13568 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 13569 Choreographer.CALLBACK_ANIMATION, what, who); 13570 } else { 13571 ViewRootImpl.getRunQueue().removeCallbacks(what); 13572 } 13573 } 13574 } 13575 13576 /** 13577 * Unschedule any events associated with the given Drawable. This can be 13578 * used when selecting a new Drawable into a view, so that the previous 13579 * one is completely unscheduled. 13580 * 13581 * @param who The Drawable to unschedule. 13582 * 13583 * @see #drawableStateChanged 13584 */ 13585 public void unscheduleDrawable(Drawable who) { 13586 if (mAttachInfo != null && who != null) { 13587 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks( 13588 Choreographer.CALLBACK_ANIMATION, null, who); 13589 } 13590 } 13591 13592 /** 13593 * Return the layout direction of a given Drawable. 13594 * 13595 * @param who the Drawable to query 13596 */ 13597 public int getResolvedLayoutDirection(Drawable who) { 13598 return (who == mBackground) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT; 13599 } 13600 13601 /** 13602 * If your view subclass is displaying its own Drawable objects, it should 13603 * override this function and return true for any Drawable it is 13604 * displaying. This allows animations for those drawables to be 13605 * scheduled. 13606 * 13607 * <p>Be sure to call through to the super class when overriding this 13608 * function. 13609 * 13610 * @param who The Drawable to verify. Return true if it is one you are 13611 * displaying, else return the result of calling through to the 13612 * super class. 13613 * 13614 * @return boolean If true than the Drawable is being displayed in the 13615 * view; else false and it is not allowed to animate. 13616 * 13617 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 13618 * @see #drawableStateChanged() 13619 */ 13620 protected boolean verifyDrawable(Drawable who) { 13621 return who == mBackground; 13622 } 13623 13624 /** 13625 * This function is called whenever the state of the view changes in such 13626 * a way that it impacts the state of drawables being shown. 13627 * 13628 * <p>Be sure to call through to the superclass when overriding this 13629 * function. 13630 * 13631 * @see Drawable#setState(int[]) 13632 */ 13633 protected void drawableStateChanged() { 13634 Drawable d = mBackground; 13635 if (d != null && d.isStateful()) { 13636 d.setState(getDrawableState()); 13637 } 13638 } 13639 13640 /** 13641 * Call this to force a view to update its drawable state. This will cause 13642 * drawableStateChanged to be called on this view. Views that are interested 13643 * in the new state should call getDrawableState. 13644 * 13645 * @see #drawableStateChanged 13646 * @see #getDrawableState 13647 */ 13648 public void refreshDrawableState() { 13649 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 13650 drawableStateChanged(); 13651 13652 ViewParent parent = mParent; 13653 if (parent != null) { 13654 parent.childDrawableStateChanged(this); 13655 } 13656 } 13657 13658 /** 13659 * Return an array of resource IDs of the drawable states representing the 13660 * current state of the view. 13661 * 13662 * @return The current drawable state 13663 * 13664 * @see Drawable#setState(int[]) 13665 * @see #drawableStateChanged() 13666 * @see #onCreateDrawableState(int) 13667 */ 13668 public final int[] getDrawableState() { 13669 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) { 13670 return mDrawableState; 13671 } else { 13672 mDrawableState = onCreateDrawableState(0); 13673 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY; 13674 return mDrawableState; 13675 } 13676 } 13677 13678 /** 13679 * Generate the new {@link android.graphics.drawable.Drawable} state for 13680 * this view. This is called by the view 13681 * system when the cached Drawable state is determined to be invalid. To 13682 * retrieve the current state, you should use {@link #getDrawableState}. 13683 * 13684 * @param extraSpace if non-zero, this is the number of extra entries you 13685 * would like in the returned array in which you can place your own 13686 * states. 13687 * 13688 * @return Returns an array holding the current {@link Drawable} state of 13689 * the view. 13690 * 13691 * @see #mergeDrawableStates(int[], int[]) 13692 */ 13693 protected int[] onCreateDrawableState(int extraSpace) { 13694 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 13695 mParent instanceof View) { 13696 return ((View) mParent).onCreateDrawableState(extraSpace); 13697 } 13698 13699 int[] drawableState; 13700 13701 int privateFlags = mPrivateFlags; 13702 13703 int viewStateIndex = 0; 13704 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 13705 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 13706 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 13707 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 13708 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 13709 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 13710 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 13711 HardwareRenderer.isAvailable()) { 13712 // This is set if HW acceleration is requested, even if the current 13713 // process doesn't allow it. This is just to allow app preview 13714 // windows to better match their app. 13715 viewStateIndex |= VIEW_STATE_ACCELERATED; 13716 } 13717 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 13718 13719 final int privateFlags2 = mPrivateFlags2; 13720 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 13721 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 13722 13723 drawableState = VIEW_STATE_SETS[viewStateIndex]; 13724 13725 //noinspection ConstantIfStatement 13726 if (false) { 13727 Log.i("View", "drawableStateIndex=" + viewStateIndex); 13728 Log.i("View", toString() 13729 + " pressed=" + ((privateFlags & PRESSED) != 0) 13730 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 13731 + " fo=" + hasFocus() 13732 + " sl=" + ((privateFlags & SELECTED) != 0) 13733 + " wf=" + hasWindowFocus() 13734 + ": " + Arrays.toString(drawableState)); 13735 } 13736 13737 if (extraSpace == 0) { 13738 return drawableState; 13739 } 13740 13741 final int[] fullState; 13742 if (drawableState != null) { 13743 fullState = new int[drawableState.length + extraSpace]; 13744 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 13745 } else { 13746 fullState = new int[extraSpace]; 13747 } 13748 13749 return fullState; 13750 } 13751 13752 /** 13753 * Merge your own state values in <var>additionalState</var> into the base 13754 * state values <var>baseState</var> that were returned by 13755 * {@link #onCreateDrawableState(int)}. 13756 * 13757 * @param baseState The base state values returned by 13758 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 13759 * own additional state values. 13760 * 13761 * @param additionalState The additional state values you would like 13762 * added to <var>baseState</var>; this array is not modified. 13763 * 13764 * @return As a convenience, the <var>baseState</var> array you originally 13765 * passed into the function is returned. 13766 * 13767 * @see #onCreateDrawableState(int) 13768 */ 13769 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 13770 final int N = baseState.length; 13771 int i = N - 1; 13772 while (i >= 0 && baseState[i] == 0) { 13773 i--; 13774 } 13775 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 13776 return baseState; 13777 } 13778 13779 /** 13780 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 13781 * on all Drawable objects associated with this view. 13782 */ 13783 public void jumpDrawablesToCurrentState() { 13784 if (mBackground != null) { 13785 mBackground.jumpToCurrentState(); 13786 } 13787 } 13788 13789 /** 13790 * Sets the background color for this view. 13791 * @param color the color of the background 13792 */ 13793 @RemotableViewMethod 13794 public void setBackgroundColor(int color) { 13795 if (mBackground instanceof ColorDrawable) { 13796 ((ColorDrawable) mBackground).setColor(color); 13797 } else { 13798 setBackground(new ColorDrawable(color)); 13799 } 13800 } 13801 13802 /** 13803 * Set the background to a given resource. The resource should refer to 13804 * a Drawable object or 0 to remove the background. 13805 * @param resid The identifier of the resource. 13806 * 13807 * @attr ref android.R.styleable#View_background 13808 */ 13809 @RemotableViewMethod 13810 public void setBackgroundResource(int resid) { 13811 if (resid != 0 && resid == mBackgroundResource) { 13812 return; 13813 } 13814 13815 Drawable d= null; 13816 if (resid != 0) { 13817 d = mResources.getDrawable(resid); 13818 } 13819 setBackground(d); 13820 13821 mBackgroundResource = resid; 13822 } 13823 13824 /** 13825 * Set the background to a given Drawable, or remove the background. If the 13826 * background has padding, this View's padding is set to the background's 13827 * padding. However, when a background is removed, this View's padding isn't 13828 * touched. If setting the padding is desired, please use 13829 * {@link #setPadding(int, int, int, int)}. 13830 * 13831 * @param background The Drawable to use as the background, or null to remove the 13832 * background 13833 */ 13834 public void setBackground(Drawable background) { 13835 //noinspection deprecation 13836 setBackgroundDrawable(background); 13837 } 13838 13839 /** 13840 * @deprecated use {@link #setBackground(Drawable)} instead 13841 */ 13842 @Deprecated 13843 public void setBackgroundDrawable(Drawable background) { 13844 if (background == mBackground) { 13845 return; 13846 } 13847 13848 boolean requestLayout = false; 13849 13850 mBackgroundResource = 0; 13851 13852 /* 13853 * Regardless of whether we're setting a new background or not, we want 13854 * to clear the previous drawable. 13855 */ 13856 if (mBackground != null) { 13857 mBackground.setCallback(null); 13858 unscheduleDrawable(mBackground); 13859 } 13860 13861 if (background != null) { 13862 Rect padding = sThreadLocal.get(); 13863 if (padding == null) { 13864 padding = new Rect(); 13865 sThreadLocal.set(padding); 13866 } 13867 if (background.getPadding(padding)) { 13868 switch (background.getResolvedLayoutDirectionSelf()) { 13869 case LAYOUT_DIRECTION_RTL: 13870 setPadding(padding.right, padding.top, padding.left, padding.bottom); 13871 break; 13872 case LAYOUT_DIRECTION_LTR: 13873 default: 13874 setPadding(padding.left, padding.top, padding.right, padding.bottom); 13875 } 13876 } 13877 13878 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 13879 // if it has a different minimum size, we should layout again 13880 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() || 13881 mBackground.getMinimumWidth() != background.getMinimumWidth()) { 13882 requestLayout = true; 13883 } 13884 13885 background.setCallback(this); 13886 if (background.isStateful()) { 13887 background.setState(getDrawableState()); 13888 } 13889 background.setVisible(getVisibility() == VISIBLE, false); 13890 mBackground = background; 13891 13892 if ((mPrivateFlags & SKIP_DRAW) != 0) { 13893 mPrivateFlags &= ~SKIP_DRAW; 13894 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 13895 requestLayout = true; 13896 } 13897 } else { 13898 /* Remove the background */ 13899 mBackground = null; 13900 13901 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) { 13902 /* 13903 * This view ONLY drew the background before and we're removing 13904 * the background, so now it won't draw anything 13905 * (hence we SKIP_DRAW) 13906 */ 13907 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND; 13908 mPrivateFlags |= SKIP_DRAW; 13909 } 13910 13911 /* 13912 * When the background is set, we try to apply its padding to this 13913 * View. When the background is removed, we don't touch this View's 13914 * padding. This is noted in the Javadocs. Hence, we don't need to 13915 * requestLayout(), the invalidate() below is sufficient. 13916 */ 13917 13918 // The old background's minimum size could have affected this 13919 // View's layout, so let's requestLayout 13920 requestLayout = true; 13921 } 13922 13923 computeOpaqueFlags(); 13924 13925 if (requestLayout) { 13926 requestLayout(); 13927 } 13928 13929 mBackgroundSizeChanged = true; 13930 invalidate(true); 13931 } 13932 13933 /** 13934 * Gets the background drawable 13935 * 13936 * @return The drawable used as the background for this view, if any. 13937 * 13938 * @see #setBackground(Drawable) 13939 * 13940 * @attr ref android.R.styleable#View_background 13941 */ 13942 public Drawable getBackground() { 13943 return mBackground; 13944 } 13945 13946 /** 13947 * Sets the padding. The view may add on the space required to display 13948 * the scrollbars, depending on the style and visibility of the scrollbars. 13949 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 13950 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 13951 * from the values set in this call. 13952 * 13953 * @attr ref android.R.styleable#View_padding 13954 * @attr ref android.R.styleable#View_paddingBottom 13955 * @attr ref android.R.styleable#View_paddingLeft 13956 * @attr ref android.R.styleable#View_paddingRight 13957 * @attr ref android.R.styleable#View_paddingTop 13958 * @param left the left padding in pixels 13959 * @param top the top padding in pixels 13960 * @param right the right padding in pixels 13961 * @param bottom the bottom padding in pixels 13962 */ 13963 public void setPadding(int left, int top, int right, int bottom) { 13964 mUserPaddingStart = -1; 13965 mUserPaddingEnd = -1; 13966 mUserPaddingRelative = false; 13967 13968 internalSetPadding(left, top, right, bottom); 13969 } 13970 13971 private void internalSetPadding(int left, int top, int right, int bottom) { 13972 mUserPaddingLeft = left; 13973 mUserPaddingRight = right; 13974 mUserPaddingBottom = bottom; 13975 13976 final int viewFlags = mViewFlags; 13977 boolean changed = false; 13978 13979 // Common case is there are no scroll bars. 13980 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 13981 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 13982 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 13983 ? 0 : getVerticalScrollbarWidth(); 13984 switch (mVerticalScrollbarPosition) { 13985 case SCROLLBAR_POSITION_DEFAULT: 13986 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) { 13987 left += offset; 13988 } else { 13989 right += offset; 13990 } 13991 break; 13992 case SCROLLBAR_POSITION_RIGHT: 13993 right += offset; 13994 break; 13995 case SCROLLBAR_POSITION_LEFT: 13996 left += offset; 13997 break; 13998 } 13999 } 14000 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 14001 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 14002 ? 0 : getHorizontalScrollbarHeight(); 14003 } 14004 } 14005 14006 if (mPaddingLeft != left) { 14007 changed = true; 14008 mPaddingLeft = left; 14009 } 14010 if (mPaddingTop != top) { 14011 changed = true; 14012 mPaddingTop = top; 14013 } 14014 if (mPaddingRight != right) { 14015 changed = true; 14016 mPaddingRight = right; 14017 } 14018 if (mPaddingBottom != bottom) { 14019 changed = true; 14020 mPaddingBottom = bottom; 14021 } 14022 14023 if (changed) { 14024 requestLayout(); 14025 } 14026 } 14027 14028 /** 14029 * Sets the relative padding. The view may add on the space required to display 14030 * the scrollbars, depending on the style and visibility of the scrollbars. 14031 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 14032 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 14033 * from the values set in this call. 14034 * 14035 * @attr ref android.R.styleable#View_padding 14036 * @attr ref android.R.styleable#View_paddingBottom 14037 * @attr ref android.R.styleable#View_paddingStart 14038 * @attr ref android.R.styleable#View_paddingEnd 14039 * @attr ref android.R.styleable#View_paddingTop 14040 * @param start the start padding in pixels 14041 * @param top the top padding in pixels 14042 * @param end the end padding in pixels 14043 * @param bottom the bottom padding in pixels 14044 */ 14045 public void setPaddingRelative(int start, int top, int end, int bottom) { 14046 mUserPaddingStart = start; 14047 mUserPaddingEnd = end; 14048 mUserPaddingRelative = true; 14049 14050 switch(getResolvedLayoutDirection()) { 14051 case LAYOUT_DIRECTION_RTL: 14052 internalSetPadding(end, top, start, bottom); 14053 break; 14054 case LAYOUT_DIRECTION_LTR: 14055 default: 14056 internalSetPadding(start, top, end, bottom); 14057 } 14058 } 14059 14060 /** 14061 * Returns the top padding of this view. 14062 * 14063 * @return the top padding in pixels 14064 */ 14065 public int getPaddingTop() { 14066 return mPaddingTop; 14067 } 14068 14069 /** 14070 * Returns the bottom padding of this view. If there are inset and enabled 14071 * scrollbars, this value may include the space required to display the 14072 * scrollbars as well. 14073 * 14074 * @return the bottom padding in pixels 14075 */ 14076 public int getPaddingBottom() { 14077 return mPaddingBottom; 14078 } 14079 14080 /** 14081 * Returns the left padding of this view. If there are inset and enabled 14082 * scrollbars, this value may include the space required to display the 14083 * scrollbars as well. 14084 * 14085 * @return the left padding in pixels 14086 */ 14087 public int getPaddingLeft() { 14088 return mPaddingLeft; 14089 } 14090 14091 /** 14092 * Returns the start padding of this view depending on its resolved layout direction. 14093 * If there are inset and enabled scrollbars, this value may include the space 14094 * required to display the scrollbars as well. 14095 * 14096 * @return the start padding in pixels 14097 */ 14098 public int getPaddingStart() { 14099 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 14100 mPaddingRight : mPaddingLeft; 14101 } 14102 14103 /** 14104 * Returns the right padding of this view. If there are inset and enabled 14105 * scrollbars, this value may include the space required to display the 14106 * scrollbars as well. 14107 * 14108 * @return the right padding in pixels 14109 */ 14110 public int getPaddingRight() { 14111 return mPaddingRight; 14112 } 14113 14114 /** 14115 * Returns the end padding of this view depending on its resolved layout direction. 14116 * If there are inset and enabled scrollbars, this value may include the space 14117 * required to display the scrollbars as well. 14118 * 14119 * @return the end padding in pixels 14120 */ 14121 public int getPaddingEnd() { 14122 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 14123 mPaddingLeft : mPaddingRight; 14124 } 14125 14126 /** 14127 * Return if the padding as been set thru relative values 14128 * {@link #setPaddingRelative(int, int, int, int)} or thru 14129 * @attr ref android.R.styleable#View_paddingStart or 14130 * @attr ref android.R.styleable#View_paddingEnd 14131 * 14132 * @return true if the padding is relative or false if it is not. 14133 */ 14134 public boolean isPaddingRelative() { 14135 return mUserPaddingRelative; 14136 } 14137 14138 /** 14139 * @hide 14140 */ 14141 public Insets getOpticalInsets() { 14142 if (mLayoutInsets == null) { 14143 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets(); 14144 } 14145 return mLayoutInsets; 14146 } 14147 14148 /** 14149 * @hide 14150 */ 14151 public void setLayoutInsets(Insets layoutInsets) { 14152 mLayoutInsets = layoutInsets; 14153 } 14154 14155 /** 14156 * Changes the selection state of this view. A view can be selected or not. 14157 * Note that selection is not the same as focus. Views are typically 14158 * selected in the context of an AdapterView like ListView or GridView; 14159 * the selected view is the view that is highlighted. 14160 * 14161 * @param selected true if the view must be selected, false otherwise 14162 */ 14163 public void setSelected(boolean selected) { 14164 if (((mPrivateFlags & SELECTED) != 0) != selected) { 14165 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0); 14166 if (!selected) resetPressedState(); 14167 invalidate(true); 14168 refreshDrawableState(); 14169 dispatchSetSelected(selected); 14170 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 14171 notifyAccessibilityStateChanged(); 14172 } 14173 } 14174 } 14175 14176 /** 14177 * Dispatch setSelected to all of this View's children. 14178 * 14179 * @see #setSelected(boolean) 14180 * 14181 * @param selected The new selected state 14182 */ 14183 protected void dispatchSetSelected(boolean selected) { 14184 } 14185 14186 /** 14187 * Indicates the selection state of this view. 14188 * 14189 * @return true if the view is selected, false otherwise 14190 */ 14191 @ViewDebug.ExportedProperty 14192 public boolean isSelected() { 14193 return (mPrivateFlags & SELECTED) != 0; 14194 } 14195 14196 /** 14197 * Changes the activated state of this view. A view can be activated or not. 14198 * Note that activation is not the same as selection. Selection is 14199 * a transient property, representing the view (hierarchy) the user is 14200 * currently interacting with. Activation is a longer-term state that the 14201 * user can move views in and out of. For example, in a list view with 14202 * single or multiple selection enabled, the views in the current selection 14203 * set are activated. (Um, yeah, we are deeply sorry about the terminology 14204 * here.) The activated state is propagated down to children of the view it 14205 * is set on. 14206 * 14207 * @param activated true if the view must be activated, false otherwise 14208 */ 14209 public void setActivated(boolean activated) { 14210 if (((mPrivateFlags & ACTIVATED) != 0) != activated) { 14211 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0); 14212 invalidate(true); 14213 refreshDrawableState(); 14214 dispatchSetActivated(activated); 14215 } 14216 } 14217 14218 /** 14219 * Dispatch setActivated to all of this View's children. 14220 * 14221 * @see #setActivated(boolean) 14222 * 14223 * @param activated The new activated state 14224 */ 14225 protected void dispatchSetActivated(boolean activated) { 14226 } 14227 14228 /** 14229 * Indicates the activation state of this view. 14230 * 14231 * @return true if the view is activated, false otherwise 14232 */ 14233 @ViewDebug.ExportedProperty 14234 public boolean isActivated() { 14235 return (mPrivateFlags & ACTIVATED) != 0; 14236 } 14237 14238 /** 14239 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 14240 * observer can be used to get notifications when global events, like 14241 * layout, happen. 14242 * 14243 * The returned ViewTreeObserver observer is not guaranteed to remain 14244 * valid for the lifetime of this View. If the caller of this method keeps 14245 * a long-lived reference to ViewTreeObserver, it should always check for 14246 * the return value of {@link ViewTreeObserver#isAlive()}. 14247 * 14248 * @return The ViewTreeObserver for this view's hierarchy. 14249 */ 14250 public ViewTreeObserver getViewTreeObserver() { 14251 if (mAttachInfo != null) { 14252 return mAttachInfo.mTreeObserver; 14253 } 14254 if (mFloatingTreeObserver == null) { 14255 mFloatingTreeObserver = new ViewTreeObserver(); 14256 } 14257 return mFloatingTreeObserver; 14258 } 14259 14260 /** 14261 * <p>Finds the topmost view in the current view hierarchy.</p> 14262 * 14263 * @return the topmost view containing this view 14264 */ 14265 public View getRootView() { 14266 if (mAttachInfo != null) { 14267 final View v = mAttachInfo.mRootView; 14268 if (v != null) { 14269 return v; 14270 } 14271 } 14272 14273 View parent = this; 14274 14275 while (parent.mParent != null && parent.mParent instanceof View) { 14276 parent = (View) parent.mParent; 14277 } 14278 14279 return parent; 14280 } 14281 14282 /** 14283 * <p>Computes the coordinates of this view on the screen. The argument 14284 * must be an array of two integers. After the method returns, the array 14285 * contains the x and y location in that order.</p> 14286 * 14287 * @param location an array of two integers in which to hold the coordinates 14288 */ 14289 public void getLocationOnScreen(int[] location) { 14290 getLocationInWindow(location); 14291 14292 final AttachInfo info = mAttachInfo; 14293 if (info != null) { 14294 location[0] += info.mWindowLeft; 14295 location[1] += info.mWindowTop; 14296 } 14297 } 14298 14299 /** 14300 * <p>Computes the coordinates of this view in its window. The argument 14301 * must be an array of two integers. After the method returns, the array 14302 * contains the x and y location in that order.</p> 14303 * 14304 * @param location an array of two integers in which to hold the coordinates 14305 */ 14306 public void getLocationInWindow(int[] location) { 14307 if (location == null || location.length < 2) { 14308 throw new IllegalArgumentException("location must be an array of two integers"); 14309 } 14310 14311 if (mAttachInfo == null) { 14312 // When the view is not attached to a window, this method does not make sense 14313 location[0] = location[1] = 0; 14314 return; 14315 } 14316 14317 float[] position = mAttachInfo.mTmpTransformLocation; 14318 position[0] = position[1] = 0.0f; 14319 14320 if (!hasIdentityMatrix()) { 14321 getMatrix().mapPoints(position); 14322 } 14323 14324 position[0] += mLeft; 14325 position[1] += mTop; 14326 14327 ViewParent viewParent = mParent; 14328 while (viewParent instanceof View) { 14329 final View view = (View) viewParent; 14330 14331 position[0] -= view.mScrollX; 14332 position[1] -= view.mScrollY; 14333 14334 if (!view.hasIdentityMatrix()) { 14335 view.getMatrix().mapPoints(position); 14336 } 14337 14338 position[0] += view.mLeft; 14339 position[1] += view.mTop; 14340 14341 viewParent = view.mParent; 14342 } 14343 14344 if (viewParent instanceof ViewRootImpl) { 14345 // *cough* 14346 final ViewRootImpl vr = (ViewRootImpl) viewParent; 14347 position[1] -= vr.mCurScrollY; 14348 } 14349 14350 location[0] = (int) (position[0] + 0.5f); 14351 location[1] = (int) (position[1] + 0.5f); 14352 } 14353 14354 /** 14355 * {@hide} 14356 * @param id the id of the view to be found 14357 * @return the view of the specified id, null if cannot be found 14358 */ 14359 protected View findViewTraversal(int id) { 14360 if (id == mID) { 14361 return this; 14362 } 14363 return null; 14364 } 14365 14366 /** 14367 * {@hide} 14368 * @param tag the tag of the view to be found 14369 * @return the view of specified tag, null if cannot be found 14370 */ 14371 protected View findViewWithTagTraversal(Object tag) { 14372 if (tag != null && tag.equals(mTag)) { 14373 return this; 14374 } 14375 return null; 14376 } 14377 14378 /** 14379 * {@hide} 14380 * @param predicate The predicate to evaluate. 14381 * @param childToSkip If not null, ignores this child during the recursive traversal. 14382 * @return The first view that matches the predicate or null. 14383 */ 14384 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 14385 if (predicate.apply(this)) { 14386 return this; 14387 } 14388 return null; 14389 } 14390 14391 /** 14392 * Look for a child view with the given id. If this view has the given 14393 * id, return this view. 14394 * 14395 * @param id The id to search for. 14396 * @return The view that has the given id in the hierarchy or null 14397 */ 14398 public final View findViewById(int id) { 14399 if (id < 0) { 14400 return null; 14401 } 14402 return findViewTraversal(id); 14403 } 14404 14405 /** 14406 * Finds a view by its unuque and stable accessibility id. 14407 * 14408 * @param accessibilityId The searched accessibility id. 14409 * @return The found view. 14410 */ 14411 final View findViewByAccessibilityId(int accessibilityId) { 14412 if (accessibilityId < 0) { 14413 return null; 14414 } 14415 return findViewByAccessibilityIdTraversal(accessibilityId); 14416 } 14417 14418 /** 14419 * Performs the traversal to find a view by its unuque and stable accessibility id. 14420 * 14421 * <strong>Note:</strong>This method does not stop at the root namespace 14422 * boundary since the user can touch the screen at an arbitrary location 14423 * potentially crossing the root namespace bounday which will send an 14424 * accessibility event to accessibility services and they should be able 14425 * to obtain the event source. Also accessibility ids are guaranteed to be 14426 * unique in the window. 14427 * 14428 * @param accessibilityId The accessibility id. 14429 * @return The found view. 14430 */ 14431 View findViewByAccessibilityIdTraversal(int accessibilityId) { 14432 if (getAccessibilityViewId() == accessibilityId) { 14433 return this; 14434 } 14435 return null; 14436 } 14437 14438 /** 14439 * Look for a child view with the given tag. If this view has the given 14440 * tag, return this view. 14441 * 14442 * @param tag The tag to search for, using "tag.equals(getTag())". 14443 * @return The View that has the given tag in the hierarchy or null 14444 */ 14445 public final View findViewWithTag(Object tag) { 14446 if (tag == null) { 14447 return null; 14448 } 14449 return findViewWithTagTraversal(tag); 14450 } 14451 14452 /** 14453 * {@hide} 14454 * Look for a child view that matches the specified predicate. 14455 * If this view matches the predicate, return this view. 14456 * 14457 * @param predicate The predicate to evaluate. 14458 * @return The first view that matches the predicate or null. 14459 */ 14460 public final View findViewByPredicate(Predicate<View> predicate) { 14461 return findViewByPredicateTraversal(predicate, null); 14462 } 14463 14464 /** 14465 * {@hide} 14466 * Look for a child view that matches the specified predicate, 14467 * starting with the specified view and its descendents and then 14468 * recusively searching the ancestors and siblings of that view 14469 * until this view is reached. 14470 * 14471 * This method is useful in cases where the predicate does not match 14472 * a single unique view (perhaps multiple views use the same id) 14473 * and we are trying to find the view that is "closest" in scope to the 14474 * starting view. 14475 * 14476 * @param start The view to start from. 14477 * @param predicate The predicate to evaluate. 14478 * @return The first view that matches the predicate or null. 14479 */ 14480 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 14481 View childToSkip = null; 14482 for (;;) { 14483 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 14484 if (view != null || start == this) { 14485 return view; 14486 } 14487 14488 ViewParent parent = start.getParent(); 14489 if (parent == null || !(parent instanceof View)) { 14490 return null; 14491 } 14492 14493 childToSkip = start; 14494 start = (View) parent; 14495 } 14496 } 14497 14498 /** 14499 * Sets the identifier for this view. The identifier does not have to be 14500 * unique in this view's hierarchy. The identifier should be a positive 14501 * number. 14502 * 14503 * @see #NO_ID 14504 * @see #getId() 14505 * @see #findViewById(int) 14506 * 14507 * @param id a number used to identify the view 14508 * 14509 * @attr ref android.R.styleable#View_id 14510 */ 14511 public void setId(int id) { 14512 mID = id; 14513 } 14514 14515 /** 14516 * {@hide} 14517 * 14518 * @param isRoot true if the view belongs to the root namespace, false 14519 * otherwise 14520 */ 14521 public void setIsRootNamespace(boolean isRoot) { 14522 if (isRoot) { 14523 mPrivateFlags |= IS_ROOT_NAMESPACE; 14524 } else { 14525 mPrivateFlags &= ~IS_ROOT_NAMESPACE; 14526 } 14527 } 14528 14529 /** 14530 * {@hide} 14531 * 14532 * @return true if the view belongs to the root namespace, false otherwise 14533 */ 14534 public boolean isRootNamespace() { 14535 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0; 14536 } 14537 14538 /** 14539 * Returns this view's identifier. 14540 * 14541 * @return a positive integer used to identify the view or {@link #NO_ID} 14542 * if the view has no ID 14543 * 14544 * @see #setId(int) 14545 * @see #findViewById(int) 14546 * @attr ref android.R.styleable#View_id 14547 */ 14548 @ViewDebug.CapturedViewProperty 14549 public int getId() { 14550 return mID; 14551 } 14552 14553 /** 14554 * Returns this view's tag. 14555 * 14556 * @return the Object stored in this view as a tag 14557 * 14558 * @see #setTag(Object) 14559 * @see #getTag(int) 14560 */ 14561 @ViewDebug.ExportedProperty 14562 public Object getTag() { 14563 return mTag; 14564 } 14565 14566 /** 14567 * Sets the tag associated with this view. A tag can be used to mark 14568 * a view in its hierarchy and does not have to be unique within the 14569 * hierarchy. Tags can also be used to store data within a view without 14570 * resorting to another data structure. 14571 * 14572 * @param tag an Object to tag the view with 14573 * 14574 * @see #getTag() 14575 * @see #setTag(int, Object) 14576 */ 14577 public void setTag(final Object tag) { 14578 mTag = tag; 14579 } 14580 14581 /** 14582 * Returns the tag associated with this view and the specified key. 14583 * 14584 * @param key The key identifying the tag 14585 * 14586 * @return the Object stored in this view as a tag 14587 * 14588 * @see #setTag(int, Object) 14589 * @see #getTag() 14590 */ 14591 public Object getTag(int key) { 14592 if (mKeyedTags != null) return mKeyedTags.get(key); 14593 return null; 14594 } 14595 14596 /** 14597 * Sets a tag associated with this view and a key. A tag can be used 14598 * to mark a view in its hierarchy and does not have to be unique within 14599 * the hierarchy. Tags can also be used to store data within a view 14600 * without resorting to another data structure. 14601 * 14602 * The specified key should be an id declared in the resources of the 14603 * application to ensure it is unique (see the <a 14604 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 14605 * Keys identified as belonging to 14606 * the Android framework or not associated with any package will cause 14607 * an {@link IllegalArgumentException} to be thrown. 14608 * 14609 * @param key The key identifying the tag 14610 * @param tag An Object to tag the view with 14611 * 14612 * @throws IllegalArgumentException If they specified key is not valid 14613 * 14614 * @see #setTag(Object) 14615 * @see #getTag(int) 14616 */ 14617 public void setTag(int key, final Object tag) { 14618 // If the package id is 0x00 or 0x01, it's either an undefined package 14619 // or a framework id 14620 if ((key >>> 24) < 2) { 14621 throw new IllegalArgumentException("The key must be an application-specific " 14622 + "resource id."); 14623 } 14624 14625 setKeyedTag(key, tag); 14626 } 14627 14628 /** 14629 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 14630 * framework id. 14631 * 14632 * @hide 14633 */ 14634 public void setTagInternal(int key, Object tag) { 14635 if ((key >>> 24) != 0x1) { 14636 throw new IllegalArgumentException("The key must be a framework-specific " 14637 + "resource id."); 14638 } 14639 14640 setKeyedTag(key, tag); 14641 } 14642 14643 private void setKeyedTag(int key, Object tag) { 14644 if (mKeyedTags == null) { 14645 mKeyedTags = new SparseArray<Object>(); 14646 } 14647 14648 mKeyedTags.put(key, tag); 14649 } 14650 14651 /** 14652 * @param consistency The type of consistency. See ViewDebug for more information. 14653 * 14654 * @hide 14655 */ 14656 protected boolean dispatchConsistencyCheck(int consistency) { 14657 return onConsistencyCheck(consistency); 14658 } 14659 14660 /** 14661 * Method that subclasses should implement to check their consistency. The type of 14662 * consistency check is indicated by the bit field passed as a parameter. 14663 * 14664 * @param consistency The type of consistency. See ViewDebug for more information. 14665 * 14666 * @throws IllegalStateException if the view is in an inconsistent state. 14667 * 14668 * @hide 14669 */ 14670 protected boolean onConsistencyCheck(int consistency) { 14671 boolean result = true; 14672 14673 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0; 14674 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0; 14675 14676 if (checkLayout) { 14677 if (getParent() == null) { 14678 result = false; 14679 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 14680 "View " + this + " does not have a parent."); 14681 } 14682 14683 if (mAttachInfo == null) { 14684 result = false; 14685 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 14686 "View " + this + " is not attached to a window."); 14687 } 14688 } 14689 14690 if (checkDrawing) { 14691 // Do not check the DIRTY/DRAWN flags because views can call invalidate() 14692 // from their draw() method 14693 14694 if ((mPrivateFlags & DRAWN) != DRAWN && 14695 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) { 14696 result = false; 14697 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 14698 "View " + this + " was invalidated but its drawing cache is valid."); 14699 } 14700 } 14701 14702 return result; 14703 } 14704 14705 /** 14706 * Prints information about this view in the log output, with the tag 14707 * {@link #VIEW_LOG_TAG}. 14708 * 14709 * @hide 14710 */ 14711 public void debug() { 14712 debug(0); 14713 } 14714 14715 /** 14716 * Prints information about this view in the log output, with the tag 14717 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 14718 * indentation defined by the <code>depth</code>. 14719 * 14720 * @param depth the indentation level 14721 * 14722 * @hide 14723 */ 14724 protected void debug(int depth) { 14725 String output = debugIndent(depth - 1); 14726 14727 output += "+ " + this; 14728 int id = getId(); 14729 if (id != -1) { 14730 output += " (id=" + id + ")"; 14731 } 14732 Object tag = getTag(); 14733 if (tag != null) { 14734 output += " (tag=" + tag + ")"; 14735 } 14736 Log.d(VIEW_LOG_TAG, output); 14737 14738 if ((mPrivateFlags & FOCUSED) != 0) { 14739 output = debugIndent(depth) + " FOCUSED"; 14740 Log.d(VIEW_LOG_TAG, output); 14741 } 14742 14743 output = debugIndent(depth); 14744 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 14745 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 14746 + "} "; 14747 Log.d(VIEW_LOG_TAG, output); 14748 14749 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 14750 || mPaddingBottom != 0) { 14751 output = debugIndent(depth); 14752 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 14753 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 14754 Log.d(VIEW_LOG_TAG, output); 14755 } 14756 14757 output = debugIndent(depth); 14758 output += "mMeasureWidth=" + mMeasuredWidth + 14759 " mMeasureHeight=" + mMeasuredHeight; 14760 Log.d(VIEW_LOG_TAG, output); 14761 14762 output = debugIndent(depth); 14763 if (mLayoutParams == null) { 14764 output += "BAD! no layout params"; 14765 } else { 14766 output = mLayoutParams.debug(output); 14767 } 14768 Log.d(VIEW_LOG_TAG, output); 14769 14770 output = debugIndent(depth); 14771 output += "flags={"; 14772 output += View.printFlags(mViewFlags); 14773 output += "}"; 14774 Log.d(VIEW_LOG_TAG, output); 14775 14776 output = debugIndent(depth); 14777 output += "privateFlags={"; 14778 output += View.printPrivateFlags(mPrivateFlags); 14779 output += "}"; 14780 Log.d(VIEW_LOG_TAG, output); 14781 } 14782 14783 /** 14784 * Creates a string of whitespaces used for indentation. 14785 * 14786 * @param depth the indentation level 14787 * @return a String containing (depth * 2 + 3) * 2 white spaces 14788 * 14789 * @hide 14790 */ 14791 protected static String debugIndent(int depth) { 14792 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 14793 for (int i = 0; i < (depth * 2) + 3; i++) { 14794 spaces.append(' ').append(' '); 14795 } 14796 return spaces.toString(); 14797 } 14798 14799 /** 14800 * <p>Return the offset of the widget's text baseline from the widget's top 14801 * boundary. If this widget does not support baseline alignment, this 14802 * method returns -1. </p> 14803 * 14804 * @return the offset of the baseline within the widget's bounds or -1 14805 * if baseline alignment is not supported 14806 */ 14807 @ViewDebug.ExportedProperty(category = "layout") 14808 public int getBaseline() { 14809 return -1; 14810 } 14811 14812 /** 14813 * Call this when something has changed which has invalidated the 14814 * layout of this view. This will schedule a layout pass of the view 14815 * tree. 14816 */ 14817 public void requestLayout() { 14818 if (ViewDebug.TRACE_HIERARCHY) { 14819 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT); 14820 } 14821 14822 mPrivateFlags |= FORCE_LAYOUT; 14823 mPrivateFlags |= INVALIDATED; 14824 14825 if (mLayoutParams != null) { 14826 mLayoutParams.onResolveLayoutDirection(getResolvedLayoutDirection()); 14827 } 14828 14829 if (mParent != null && !mParent.isLayoutRequested()) { 14830 mParent.requestLayout(); 14831 } 14832 } 14833 14834 /** 14835 * Forces this view to be laid out during the next layout pass. 14836 * This method does not call requestLayout() or forceLayout() 14837 * on the parent. 14838 */ 14839 public void forceLayout() { 14840 mPrivateFlags |= FORCE_LAYOUT; 14841 mPrivateFlags |= INVALIDATED; 14842 } 14843 14844 /** 14845 * <p> 14846 * This is called to find out how big a view should be. The parent 14847 * supplies constraint information in the width and height parameters. 14848 * </p> 14849 * 14850 * <p> 14851 * The actual measurement work of a view is performed in 14852 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 14853 * {@link #onMeasure(int, int)} can and must be overridden by subclasses. 14854 * </p> 14855 * 14856 * 14857 * @param widthMeasureSpec Horizontal space requirements as imposed by the 14858 * parent 14859 * @param heightMeasureSpec Vertical space requirements as imposed by the 14860 * parent 14861 * 14862 * @see #onMeasure(int, int) 14863 */ 14864 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 14865 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT || 14866 widthMeasureSpec != mOldWidthMeasureSpec || 14867 heightMeasureSpec != mOldHeightMeasureSpec) { 14868 14869 // first clears the measured dimension flag 14870 mPrivateFlags &= ~MEASURED_DIMENSION_SET; 14871 14872 if (ViewDebug.TRACE_HIERARCHY) { 14873 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE); 14874 } 14875 14876 // measure ourselves, this should set the measured dimension flag back 14877 onMeasure(widthMeasureSpec, heightMeasureSpec); 14878 14879 // flag not set, setMeasuredDimension() was not invoked, we raise 14880 // an exception to warn the developer 14881 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) { 14882 throw new IllegalStateException("onMeasure() did not set the" 14883 + " measured dimension by calling" 14884 + " setMeasuredDimension()"); 14885 } 14886 14887 mPrivateFlags |= LAYOUT_REQUIRED; 14888 } 14889 14890 mOldWidthMeasureSpec = widthMeasureSpec; 14891 mOldHeightMeasureSpec = heightMeasureSpec; 14892 } 14893 14894 /** 14895 * <p> 14896 * Measure the view and its content to determine the measured width and the 14897 * measured height. This method is invoked by {@link #measure(int, int)} and 14898 * should be overriden by subclasses to provide accurate and efficient 14899 * measurement of their contents. 14900 * </p> 14901 * 14902 * <p> 14903 * <strong>CONTRACT:</strong> When overriding this method, you 14904 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 14905 * measured width and height of this view. Failure to do so will trigger an 14906 * <code>IllegalStateException</code>, thrown by 14907 * {@link #measure(int, int)}. Calling the superclass' 14908 * {@link #onMeasure(int, int)} is a valid use. 14909 * </p> 14910 * 14911 * <p> 14912 * The base class implementation of measure defaults to the background size, 14913 * unless a larger size is allowed by the MeasureSpec. Subclasses should 14914 * override {@link #onMeasure(int, int)} to provide better measurements of 14915 * their content. 14916 * </p> 14917 * 14918 * <p> 14919 * If this method is overridden, it is the subclass's responsibility to make 14920 * sure the measured height and width are at least the view's minimum height 14921 * and width ({@link #getSuggestedMinimumHeight()} and 14922 * {@link #getSuggestedMinimumWidth()}). 14923 * </p> 14924 * 14925 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 14926 * The requirements are encoded with 14927 * {@link android.view.View.MeasureSpec}. 14928 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 14929 * The requirements are encoded with 14930 * {@link android.view.View.MeasureSpec}. 14931 * 14932 * @see #getMeasuredWidth() 14933 * @see #getMeasuredHeight() 14934 * @see #setMeasuredDimension(int, int) 14935 * @see #getSuggestedMinimumHeight() 14936 * @see #getSuggestedMinimumWidth() 14937 * @see android.view.View.MeasureSpec#getMode(int) 14938 * @see android.view.View.MeasureSpec#getSize(int) 14939 */ 14940 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 14941 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 14942 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 14943 } 14944 14945 /** 14946 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the 14947 * measured width and measured height. Failing to do so will trigger an 14948 * exception at measurement time.</p> 14949 * 14950 * @param measuredWidth The measured width of this view. May be a complex 14951 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 14952 * {@link #MEASURED_STATE_TOO_SMALL}. 14953 * @param measuredHeight The measured height of this view. May be a complex 14954 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 14955 * {@link #MEASURED_STATE_TOO_SMALL}. 14956 */ 14957 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 14958 mMeasuredWidth = measuredWidth; 14959 mMeasuredHeight = measuredHeight; 14960 14961 mPrivateFlags |= MEASURED_DIMENSION_SET; 14962 } 14963 14964 /** 14965 * Merge two states as returned by {@link #getMeasuredState()}. 14966 * @param curState The current state as returned from a view or the result 14967 * of combining multiple views. 14968 * @param newState The new view state to combine. 14969 * @return Returns a new integer reflecting the combination of the two 14970 * states. 14971 */ 14972 public static int combineMeasuredStates(int curState, int newState) { 14973 return curState | newState; 14974 } 14975 14976 /** 14977 * Version of {@link #resolveSizeAndState(int, int, int)} 14978 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 14979 */ 14980 public static int resolveSize(int size, int measureSpec) { 14981 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 14982 } 14983 14984 /** 14985 * Utility to reconcile a desired size and state, with constraints imposed 14986 * by a MeasureSpec. Will take the desired size, unless a different size 14987 * is imposed by the constraints. The returned value is a compound integer, 14988 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 14989 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 14990 * size is smaller than the size the view wants to be. 14991 * 14992 * @param size How big the view wants to be 14993 * @param measureSpec Constraints imposed by the parent 14994 * @return Size information bit mask as defined by 14995 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 14996 */ 14997 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 14998 int result = size; 14999 int specMode = MeasureSpec.getMode(measureSpec); 15000 int specSize = MeasureSpec.getSize(measureSpec); 15001 switch (specMode) { 15002 case MeasureSpec.UNSPECIFIED: 15003 result = size; 15004 break; 15005 case MeasureSpec.AT_MOST: 15006 if (specSize < size) { 15007 result = specSize | MEASURED_STATE_TOO_SMALL; 15008 } else { 15009 result = size; 15010 } 15011 break; 15012 case MeasureSpec.EXACTLY: 15013 result = specSize; 15014 break; 15015 } 15016 return result | (childMeasuredState&MEASURED_STATE_MASK); 15017 } 15018 15019 /** 15020 * Utility to return a default size. Uses the supplied size if the 15021 * MeasureSpec imposed no constraints. Will get larger if allowed 15022 * by the MeasureSpec. 15023 * 15024 * @param size Default size for this view 15025 * @param measureSpec Constraints imposed by the parent 15026 * @return The size this view should be. 15027 */ 15028 public static int getDefaultSize(int size, int measureSpec) { 15029 int result = size; 15030 int specMode = MeasureSpec.getMode(measureSpec); 15031 int specSize = MeasureSpec.getSize(measureSpec); 15032 15033 switch (specMode) { 15034 case MeasureSpec.UNSPECIFIED: 15035 result = size; 15036 break; 15037 case MeasureSpec.AT_MOST: 15038 case MeasureSpec.EXACTLY: 15039 result = specSize; 15040 break; 15041 } 15042 return result; 15043 } 15044 15045 /** 15046 * Returns the suggested minimum height that the view should use. This 15047 * returns the maximum of the view's minimum height 15048 * and the background's minimum height 15049 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 15050 * <p> 15051 * When being used in {@link #onMeasure(int, int)}, the caller should still 15052 * ensure the returned height is within the requirements of the parent. 15053 * 15054 * @return The suggested minimum height of the view. 15055 */ 15056 protected int getSuggestedMinimumHeight() { 15057 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight()); 15058 15059 } 15060 15061 /** 15062 * Returns the suggested minimum width that the view should use. This 15063 * returns the maximum of the view's minimum width) 15064 * and the background's minimum width 15065 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 15066 * <p> 15067 * When being used in {@link #onMeasure(int, int)}, the caller should still 15068 * ensure the returned width is within the requirements of the parent. 15069 * 15070 * @return The suggested minimum width of the view. 15071 */ 15072 protected int getSuggestedMinimumWidth() { 15073 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth()); 15074 } 15075 15076 /** 15077 * Returns the minimum height of the view. 15078 * 15079 * @return the minimum height the view will try to be. 15080 * 15081 * @see #setMinimumHeight(int) 15082 * 15083 * @attr ref android.R.styleable#View_minHeight 15084 */ 15085 public int getMinimumHeight() { 15086 return mMinHeight; 15087 } 15088 15089 /** 15090 * Sets the minimum height of the view. It is not guaranteed the view will 15091 * be able to achieve this minimum height (for example, if its parent layout 15092 * constrains it with less available height). 15093 * 15094 * @param minHeight The minimum height the view will try to be. 15095 * 15096 * @see #getMinimumHeight() 15097 * 15098 * @attr ref android.R.styleable#View_minHeight 15099 */ 15100 public void setMinimumHeight(int minHeight) { 15101 mMinHeight = minHeight; 15102 requestLayout(); 15103 } 15104 15105 /** 15106 * Returns the minimum width of the view. 15107 * 15108 * @return the minimum width the view will try to be. 15109 * 15110 * @see #setMinimumWidth(int) 15111 * 15112 * @attr ref android.R.styleable#View_minWidth 15113 */ 15114 public int getMinimumWidth() { 15115 return mMinWidth; 15116 } 15117 15118 /** 15119 * Sets the minimum width of the view. It is not guaranteed the view will 15120 * be able to achieve this minimum width (for example, if its parent layout 15121 * constrains it with less available width). 15122 * 15123 * @param minWidth The minimum width the view will try to be. 15124 * 15125 * @see #getMinimumWidth() 15126 * 15127 * @attr ref android.R.styleable#View_minWidth 15128 */ 15129 public void setMinimumWidth(int minWidth) { 15130 mMinWidth = minWidth; 15131 requestLayout(); 15132 15133 } 15134 15135 /** 15136 * Get the animation currently associated with this view. 15137 * 15138 * @return The animation that is currently playing or 15139 * scheduled to play for this view. 15140 */ 15141 public Animation getAnimation() { 15142 return mCurrentAnimation; 15143 } 15144 15145 /** 15146 * Start the specified animation now. 15147 * 15148 * @param animation the animation to start now 15149 */ 15150 public void startAnimation(Animation animation) { 15151 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 15152 setAnimation(animation); 15153 invalidateParentCaches(); 15154 invalidate(true); 15155 } 15156 15157 /** 15158 * Cancels any animations for this view. 15159 */ 15160 public void clearAnimation() { 15161 if (mCurrentAnimation != null) { 15162 mCurrentAnimation.detach(); 15163 } 15164 mCurrentAnimation = null; 15165 invalidateParentIfNeeded(); 15166 } 15167 15168 /** 15169 * Sets the next animation to play for this view. 15170 * If you want the animation to play immediately, use 15171 * startAnimation. This method provides allows fine-grained 15172 * control over the start time and invalidation, but you 15173 * must make sure that 1) the animation has a start time set, and 15174 * 2) the view will be invalidated when the animation is supposed to 15175 * start. 15176 * 15177 * @param animation The next animation, or null. 15178 */ 15179 public void setAnimation(Animation animation) { 15180 mCurrentAnimation = animation; 15181 15182 if (animation != null) { 15183 // If the screen is off assume the animation start time is now instead of 15184 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time 15185 // would cause the animation to start when the screen turns back on 15186 if (mAttachInfo != null && !mAttachInfo.mScreenOn && 15187 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) { 15188 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis()); 15189 } 15190 animation.reset(); 15191 } 15192 } 15193 15194 /** 15195 * Invoked by a parent ViewGroup to notify the start of the animation 15196 * currently associated with this view. If you override this method, 15197 * always call super.onAnimationStart(); 15198 * 15199 * @see #setAnimation(android.view.animation.Animation) 15200 * @see #getAnimation() 15201 */ 15202 protected void onAnimationStart() { 15203 mPrivateFlags |= ANIMATION_STARTED; 15204 } 15205 15206 /** 15207 * Invoked by a parent ViewGroup to notify the end of the animation 15208 * currently associated with this view. If you override this method, 15209 * always call super.onAnimationEnd(); 15210 * 15211 * @see #setAnimation(android.view.animation.Animation) 15212 * @see #getAnimation() 15213 */ 15214 protected void onAnimationEnd() { 15215 mPrivateFlags &= ~ANIMATION_STARTED; 15216 } 15217 15218 /** 15219 * Invoked if there is a Transform that involves alpha. Subclass that can 15220 * draw themselves with the specified alpha should return true, and then 15221 * respect that alpha when their onDraw() is called. If this returns false 15222 * then the view may be redirected to draw into an offscreen buffer to 15223 * fulfill the request, which will look fine, but may be slower than if the 15224 * subclass handles it internally. The default implementation returns false. 15225 * 15226 * @param alpha The alpha (0..255) to apply to the view's drawing 15227 * @return true if the view can draw with the specified alpha. 15228 */ 15229 protected boolean onSetAlpha(int alpha) { 15230 return false; 15231 } 15232 15233 /** 15234 * This is used by the RootView to perform an optimization when 15235 * the view hierarchy contains one or several SurfaceView. 15236 * SurfaceView is always considered transparent, but its children are not, 15237 * therefore all View objects remove themselves from the global transparent 15238 * region (passed as a parameter to this function). 15239 * 15240 * @param region The transparent region for this ViewAncestor (window). 15241 * 15242 * @return Returns true if the effective visibility of the view at this 15243 * point is opaque, regardless of the transparent region; returns false 15244 * if it is possible for underlying windows to be seen behind the view. 15245 * 15246 * {@hide} 15247 */ 15248 public boolean gatherTransparentRegion(Region region) { 15249 final AttachInfo attachInfo = mAttachInfo; 15250 if (region != null && attachInfo != null) { 15251 final int pflags = mPrivateFlags; 15252 if ((pflags & SKIP_DRAW) == 0) { 15253 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 15254 // remove it from the transparent region. 15255 final int[] location = attachInfo.mTransparentLocation; 15256 getLocationInWindow(location); 15257 region.op(location[0], location[1], location[0] + mRight - mLeft, 15258 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 15259 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) { 15260 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 15261 // exists, so we remove the background drawable's non-transparent 15262 // parts from this transparent region. 15263 applyDrawableToTransparentRegion(mBackground, region); 15264 } 15265 } 15266 return true; 15267 } 15268 15269 /** 15270 * Play a sound effect for this view. 15271 * 15272 * <p>The framework will play sound effects for some built in actions, such as 15273 * clicking, but you may wish to play these effects in your widget, 15274 * for instance, for internal navigation. 15275 * 15276 * <p>The sound effect will only be played if sound effects are enabled by the user, and 15277 * {@link #isSoundEffectsEnabled()} is true. 15278 * 15279 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 15280 */ 15281 public void playSoundEffect(int soundConstant) { 15282 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 15283 return; 15284 } 15285 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 15286 } 15287 15288 /** 15289 * BZZZTT!!1! 15290 * 15291 * <p>Provide haptic feedback to the user for this view. 15292 * 15293 * <p>The framework will provide haptic feedback for some built in actions, 15294 * such as long presses, but you may wish to provide feedback for your 15295 * own widget. 15296 * 15297 * <p>The feedback will only be performed if 15298 * {@link #isHapticFeedbackEnabled()} is true. 15299 * 15300 * @param feedbackConstant One of the constants defined in 15301 * {@link HapticFeedbackConstants} 15302 */ 15303 public boolean performHapticFeedback(int feedbackConstant) { 15304 return performHapticFeedback(feedbackConstant, 0); 15305 } 15306 15307 /** 15308 * BZZZTT!!1! 15309 * 15310 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 15311 * 15312 * @param feedbackConstant One of the constants defined in 15313 * {@link HapticFeedbackConstants} 15314 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 15315 */ 15316 public boolean performHapticFeedback(int feedbackConstant, int flags) { 15317 if (mAttachInfo == null) { 15318 return false; 15319 } 15320 //noinspection SimplifiableIfStatement 15321 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 15322 && !isHapticFeedbackEnabled()) { 15323 return false; 15324 } 15325 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 15326 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 15327 } 15328 15329 /** 15330 * Request that the visibility of the status bar or other screen/window 15331 * decorations be changed. 15332 * 15333 * <p>This method is used to put the over device UI into temporary modes 15334 * where the user's attention is focused more on the application content, 15335 * by dimming or hiding surrounding system affordances. This is typically 15336 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY 15337 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content 15338 * to be placed behind the action bar (and with these flags other system 15339 * affordances) so that smooth transitions between hiding and showing them 15340 * can be done. 15341 * 15342 * <p>Two representative examples of the use of system UI visibility is 15343 * implementing a content browsing application (like a magazine reader) 15344 * and a video playing application. 15345 * 15346 * <p>The first code shows a typical implementation of a View in a content 15347 * browsing application. In this implementation, the application goes 15348 * into a content-oriented mode by hiding the status bar and action bar, 15349 * and putting the navigation elements into lights out mode. The user can 15350 * then interact with content while in this mode. Such an application should 15351 * provide an easy way for the user to toggle out of the mode (such as to 15352 * check information in the status bar or access notifications). In the 15353 * implementation here, this is done simply by tapping on the content. 15354 * 15355 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java 15356 * content} 15357 * 15358 * <p>This second code sample shows a typical implementation of a View 15359 * in a video playing application. In this situation, while the video is 15360 * playing the application would like to go into a complete full-screen mode, 15361 * to use as much of the display as possible for the video. When in this state 15362 * the user can not interact with the application; the system intercepts 15363 * touching on the screen to pop the UI out of full screen mode. See 15364 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code. 15365 * 15366 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java 15367 * content} 15368 * 15369 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 15370 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 15371 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 15372 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}. 15373 */ 15374 public void setSystemUiVisibility(int visibility) { 15375 if (visibility != mSystemUiVisibility) { 15376 mSystemUiVisibility = visibility; 15377 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 15378 mParent.recomputeViewAttributes(this); 15379 } 15380 } 15381 } 15382 15383 /** 15384 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested. 15385 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 15386 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN}, 15387 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, 15388 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}. 15389 */ 15390 public int getSystemUiVisibility() { 15391 return mSystemUiVisibility; 15392 } 15393 15394 /** 15395 * Returns the current system UI visibility that is currently set for 15396 * the entire window. This is the combination of the 15397 * {@link #setSystemUiVisibility(int)} values supplied by all of the 15398 * views in the window. 15399 */ 15400 public int getWindowSystemUiVisibility() { 15401 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0; 15402 } 15403 15404 /** 15405 * Override to find out when the window's requested system UI visibility 15406 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}. 15407 * This is different from the callbacks recieved through 15408 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)} 15409 * in that this is only telling you about the local request of the window, 15410 * not the actual values applied by the system. 15411 */ 15412 public void onWindowSystemUiVisibilityChanged(int visible) { 15413 } 15414 15415 /** 15416 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down 15417 * the view hierarchy. 15418 */ 15419 public void dispatchWindowSystemUiVisiblityChanged(int visible) { 15420 onWindowSystemUiVisibilityChanged(visible); 15421 } 15422 15423 /** 15424 * Set a listener to receive callbacks when the visibility of the system bar changes. 15425 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 15426 */ 15427 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 15428 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 15429 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 15430 mParent.recomputeViewAttributes(this); 15431 } 15432 } 15433 15434 /** 15435 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 15436 * the view hierarchy. 15437 */ 15438 public void dispatchSystemUiVisibilityChanged(int visibility) { 15439 ListenerInfo li = mListenerInfo; 15440 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 15441 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 15442 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 15443 } 15444 } 15445 15446 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) { 15447 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 15448 if (val != mSystemUiVisibility) { 15449 setSystemUiVisibility(val); 15450 return true; 15451 } 15452 return false; 15453 } 15454 15455 /** @hide */ 15456 public void setDisabledSystemUiVisibility(int flags) { 15457 if (mAttachInfo != null) { 15458 if (mAttachInfo.mDisabledSystemUiVisibility != flags) { 15459 mAttachInfo.mDisabledSystemUiVisibility = flags; 15460 if (mParent != null) { 15461 mParent.recomputeViewAttributes(this); 15462 } 15463 } 15464 } 15465 } 15466 15467 /** 15468 * Creates an image that the system displays during the drag and drop 15469 * operation. This is called a "drag shadow". The default implementation 15470 * for a DragShadowBuilder based on a View returns an image that has exactly the same 15471 * appearance as the given View. The default also positions the center of the drag shadow 15472 * directly under the touch point. If no View is provided (the constructor with no parameters 15473 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 15474 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 15475 * default is an invisible drag shadow. 15476 * <p> 15477 * You are not required to use the View you provide to the constructor as the basis of the 15478 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 15479 * anything you want as the drag shadow. 15480 * </p> 15481 * <p> 15482 * You pass a DragShadowBuilder object to the system when you start the drag. The system 15483 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 15484 * size and position of the drag shadow. It uses this data to construct a 15485 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 15486 * so that your application can draw the shadow image in the Canvas. 15487 * </p> 15488 * 15489 * <div class="special reference"> 15490 * <h3>Developer Guides</h3> 15491 * <p>For a guide to implementing drag and drop features, read the 15492 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 15493 * </div> 15494 */ 15495 public static class DragShadowBuilder { 15496 private final WeakReference<View> mView; 15497 15498 /** 15499 * Constructs a shadow image builder based on a View. By default, the resulting drag 15500 * shadow will have the same appearance and dimensions as the View, with the touch point 15501 * over the center of the View. 15502 * @param view A View. Any View in scope can be used. 15503 */ 15504 public DragShadowBuilder(View view) { 15505 mView = new WeakReference<View>(view); 15506 } 15507 15508 /** 15509 * Construct a shadow builder object with no associated View. This 15510 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 15511 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 15512 * to supply the drag shadow's dimensions and appearance without 15513 * reference to any View object. If they are not overridden, then the result is an 15514 * invisible drag shadow. 15515 */ 15516 public DragShadowBuilder() { 15517 mView = new WeakReference<View>(null); 15518 } 15519 15520 /** 15521 * Returns the View object that had been passed to the 15522 * {@link #View.DragShadowBuilder(View)} 15523 * constructor. If that View parameter was {@code null} or if the 15524 * {@link #View.DragShadowBuilder()} 15525 * constructor was used to instantiate the builder object, this method will return 15526 * null. 15527 * 15528 * @return The View object associate with this builder object. 15529 */ 15530 @SuppressWarnings({"JavadocReference"}) 15531 final public View getView() { 15532 return mView.get(); 15533 } 15534 15535 /** 15536 * Provides the metrics for the shadow image. These include the dimensions of 15537 * the shadow image, and the point within that shadow that should 15538 * be centered under the touch location while dragging. 15539 * <p> 15540 * The default implementation sets the dimensions of the shadow to be the 15541 * same as the dimensions of the View itself and centers the shadow under 15542 * the touch point. 15543 * </p> 15544 * 15545 * @param shadowSize A {@link android.graphics.Point} containing the width and height 15546 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 15547 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 15548 * image. 15549 * 15550 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 15551 * shadow image that should be underneath the touch point during the drag and drop 15552 * operation. Your application must set {@link android.graphics.Point#x} to the 15553 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 15554 */ 15555 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 15556 final View view = mView.get(); 15557 if (view != null) { 15558 shadowSize.set(view.getWidth(), view.getHeight()); 15559 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 15560 } else { 15561 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 15562 } 15563 } 15564 15565 /** 15566 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 15567 * based on the dimensions it received from the 15568 * {@link #onProvideShadowMetrics(Point, Point)} callback. 15569 * 15570 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 15571 */ 15572 public void onDrawShadow(Canvas canvas) { 15573 final View view = mView.get(); 15574 if (view != null) { 15575 view.draw(canvas); 15576 } else { 15577 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 15578 } 15579 } 15580 } 15581 15582 /** 15583 * Starts a drag and drop operation. When your application calls this method, it passes a 15584 * {@link android.view.View.DragShadowBuilder} object to the system. The 15585 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 15586 * to get metrics for the drag shadow, and then calls the object's 15587 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 15588 * <p> 15589 * Once the system has the drag shadow, it begins the drag and drop operation by sending 15590 * drag events to all the View objects in your application that are currently visible. It does 15591 * this either by calling the View object's drag listener (an implementation of 15592 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 15593 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 15594 * Both are passed a {@link android.view.DragEvent} object that has a 15595 * {@link android.view.DragEvent#getAction()} value of 15596 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 15597 * </p> 15598 * <p> 15599 * Your application can invoke startDrag() on any attached View object. The View object does not 15600 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 15601 * be related to the View the user selected for dragging. 15602 * </p> 15603 * @param data A {@link android.content.ClipData} object pointing to the data to be 15604 * transferred by the drag and drop operation. 15605 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 15606 * drag shadow. 15607 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 15608 * drop operation. This Object is put into every DragEvent object sent by the system during the 15609 * current drag. 15610 * <p> 15611 * myLocalState is a lightweight mechanism for the sending information from the dragged View 15612 * to the target Views. For example, it can contain flags that differentiate between a 15613 * a copy operation and a move operation. 15614 * </p> 15615 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 15616 * so the parameter should be set to 0. 15617 * @return {@code true} if the method completes successfully, or 15618 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 15619 * do a drag, and so no drag operation is in progress. 15620 */ 15621 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 15622 Object myLocalState, int flags) { 15623 if (ViewDebug.DEBUG_DRAG) { 15624 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 15625 } 15626 boolean okay = false; 15627 15628 Point shadowSize = new Point(); 15629 Point shadowTouchPoint = new Point(); 15630 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 15631 15632 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 15633 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 15634 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 15635 } 15636 15637 if (ViewDebug.DEBUG_DRAG) { 15638 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 15639 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 15640 } 15641 Surface surface = new Surface(); 15642 try { 15643 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 15644 flags, shadowSize.x, shadowSize.y, surface); 15645 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 15646 + " surface=" + surface); 15647 if (token != null) { 15648 Canvas canvas = surface.lockCanvas(null); 15649 try { 15650 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 15651 shadowBuilder.onDrawShadow(canvas); 15652 } finally { 15653 surface.unlockCanvasAndPost(canvas); 15654 } 15655 15656 final ViewRootImpl root = getViewRootImpl(); 15657 15658 // Cache the local state object for delivery with DragEvents 15659 root.setLocalDragState(myLocalState); 15660 15661 // repurpose 'shadowSize' for the last touch point 15662 root.getLastTouchPoint(shadowSize); 15663 15664 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 15665 shadowSize.x, shadowSize.y, 15666 shadowTouchPoint.x, shadowTouchPoint.y, data); 15667 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 15668 15669 // Off and running! Release our local surface instance; the drag 15670 // shadow surface is now managed by the system process. 15671 surface.release(); 15672 } 15673 } catch (Exception e) { 15674 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 15675 surface.destroy(); 15676 } 15677 15678 return okay; 15679 } 15680 15681 /** 15682 * Handles drag events sent by the system following a call to 15683 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 15684 *<p> 15685 * When the system calls this method, it passes a 15686 * {@link android.view.DragEvent} object. A call to 15687 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 15688 * in DragEvent. The method uses these to determine what is happening in the drag and drop 15689 * operation. 15690 * @param event The {@link android.view.DragEvent} sent by the system. 15691 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 15692 * in DragEvent, indicating the type of drag event represented by this object. 15693 * @return {@code true} if the method was successful, otherwise {@code false}. 15694 * <p> 15695 * The method should return {@code true} in response to an action type of 15696 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 15697 * operation. 15698 * </p> 15699 * <p> 15700 * The method should also return {@code true} in response to an action type of 15701 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 15702 * {@code false} if it didn't. 15703 * </p> 15704 */ 15705 public boolean onDragEvent(DragEvent event) { 15706 return false; 15707 } 15708 15709 /** 15710 * Detects if this View is enabled and has a drag event listener. 15711 * If both are true, then it calls the drag event listener with the 15712 * {@link android.view.DragEvent} it received. If the drag event listener returns 15713 * {@code true}, then dispatchDragEvent() returns {@code true}. 15714 * <p> 15715 * For all other cases, the method calls the 15716 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 15717 * method and returns its result. 15718 * </p> 15719 * <p> 15720 * This ensures that a drag event is always consumed, even if the View does not have a drag 15721 * event listener. However, if the View has a listener and the listener returns true, then 15722 * onDragEvent() is not called. 15723 * </p> 15724 */ 15725 public boolean dispatchDragEvent(DragEvent event) { 15726 //noinspection SimplifiableIfStatement 15727 ListenerInfo li = mListenerInfo; 15728 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 15729 && li.mOnDragListener.onDrag(this, event)) { 15730 return true; 15731 } 15732 return onDragEvent(event); 15733 } 15734 15735 boolean canAcceptDrag() { 15736 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0; 15737 } 15738 15739 /** 15740 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 15741 * it is ever exposed at all. 15742 * @hide 15743 */ 15744 public void onCloseSystemDialogs(String reason) { 15745 } 15746 15747 /** 15748 * Given a Drawable whose bounds have been set to draw into this view, 15749 * update a Region being computed for 15750 * {@link #gatherTransparentRegion(android.graphics.Region)} so 15751 * that any non-transparent parts of the Drawable are removed from the 15752 * given transparent region. 15753 * 15754 * @param dr The Drawable whose transparency is to be applied to the region. 15755 * @param region A Region holding the current transparency information, 15756 * where any parts of the region that are set are considered to be 15757 * transparent. On return, this region will be modified to have the 15758 * transparency information reduced by the corresponding parts of the 15759 * Drawable that are not transparent. 15760 * {@hide} 15761 */ 15762 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 15763 if (DBG) { 15764 Log.i("View", "Getting transparent region for: " + this); 15765 } 15766 final Region r = dr.getTransparentRegion(); 15767 final Rect db = dr.getBounds(); 15768 final AttachInfo attachInfo = mAttachInfo; 15769 if (r != null && attachInfo != null) { 15770 final int w = getRight()-getLeft(); 15771 final int h = getBottom()-getTop(); 15772 if (db.left > 0) { 15773 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 15774 r.op(0, 0, db.left, h, Region.Op.UNION); 15775 } 15776 if (db.right < w) { 15777 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 15778 r.op(db.right, 0, w, h, Region.Op.UNION); 15779 } 15780 if (db.top > 0) { 15781 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 15782 r.op(0, 0, w, db.top, Region.Op.UNION); 15783 } 15784 if (db.bottom < h) { 15785 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 15786 r.op(0, db.bottom, w, h, Region.Op.UNION); 15787 } 15788 final int[] location = attachInfo.mTransparentLocation; 15789 getLocationInWindow(location); 15790 r.translate(location[0], location[1]); 15791 region.op(r, Region.Op.INTERSECT); 15792 } else { 15793 region.op(db, Region.Op.DIFFERENCE); 15794 } 15795 } 15796 15797 private void checkForLongClick(int delayOffset) { 15798 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 15799 mHasPerformedLongPress = false; 15800 15801 if (mPendingCheckForLongPress == null) { 15802 mPendingCheckForLongPress = new CheckForLongPress(); 15803 } 15804 mPendingCheckForLongPress.rememberWindowAttachCount(); 15805 postDelayed(mPendingCheckForLongPress, 15806 ViewConfiguration.getLongPressTimeout() - delayOffset); 15807 } 15808 } 15809 15810 /** 15811 * Inflate a view from an XML resource. This convenience method wraps the {@link 15812 * LayoutInflater} class, which provides a full range of options for view inflation. 15813 * 15814 * @param context The Context object for your activity or application. 15815 * @param resource The resource ID to inflate 15816 * @param root A view group that will be the parent. Used to properly inflate the 15817 * layout_* parameters. 15818 * @see LayoutInflater 15819 */ 15820 public static View inflate(Context context, int resource, ViewGroup root) { 15821 LayoutInflater factory = LayoutInflater.from(context); 15822 return factory.inflate(resource, root); 15823 } 15824 15825 /** 15826 * Scroll the view with standard behavior for scrolling beyond the normal 15827 * content boundaries. Views that call this method should override 15828 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 15829 * results of an over-scroll operation. 15830 * 15831 * Views can use this method to handle any touch or fling-based scrolling. 15832 * 15833 * @param deltaX Change in X in pixels 15834 * @param deltaY Change in Y in pixels 15835 * @param scrollX Current X scroll value in pixels before applying deltaX 15836 * @param scrollY Current Y scroll value in pixels before applying deltaY 15837 * @param scrollRangeX Maximum content scroll range along the X axis 15838 * @param scrollRangeY Maximum content scroll range along the Y axis 15839 * @param maxOverScrollX Number of pixels to overscroll by in either direction 15840 * along the X axis. 15841 * @param maxOverScrollY Number of pixels to overscroll by in either direction 15842 * along the Y axis. 15843 * @param isTouchEvent true if this scroll operation is the result of a touch event. 15844 * @return true if scrolling was clamped to an over-scroll boundary along either 15845 * axis, false otherwise. 15846 */ 15847 @SuppressWarnings({"UnusedParameters"}) 15848 protected boolean overScrollBy(int deltaX, int deltaY, 15849 int scrollX, int scrollY, 15850 int scrollRangeX, int scrollRangeY, 15851 int maxOverScrollX, int maxOverScrollY, 15852 boolean isTouchEvent) { 15853 final int overScrollMode = mOverScrollMode; 15854 final boolean canScrollHorizontal = 15855 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 15856 final boolean canScrollVertical = 15857 computeVerticalScrollRange() > computeVerticalScrollExtent(); 15858 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 15859 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 15860 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 15861 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 15862 15863 int newScrollX = scrollX + deltaX; 15864 if (!overScrollHorizontal) { 15865 maxOverScrollX = 0; 15866 } 15867 15868 int newScrollY = scrollY + deltaY; 15869 if (!overScrollVertical) { 15870 maxOverScrollY = 0; 15871 } 15872 15873 // Clamp values if at the limits and record 15874 final int left = -maxOverScrollX; 15875 final int right = maxOverScrollX + scrollRangeX; 15876 final int top = -maxOverScrollY; 15877 final int bottom = maxOverScrollY + scrollRangeY; 15878 15879 boolean clampedX = false; 15880 if (newScrollX > right) { 15881 newScrollX = right; 15882 clampedX = true; 15883 } else if (newScrollX < left) { 15884 newScrollX = left; 15885 clampedX = true; 15886 } 15887 15888 boolean clampedY = false; 15889 if (newScrollY > bottom) { 15890 newScrollY = bottom; 15891 clampedY = true; 15892 } else if (newScrollY < top) { 15893 newScrollY = top; 15894 clampedY = true; 15895 } 15896 15897 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 15898 15899 return clampedX || clampedY; 15900 } 15901 15902 /** 15903 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 15904 * respond to the results of an over-scroll operation. 15905 * 15906 * @param scrollX New X scroll value in pixels 15907 * @param scrollY New Y scroll value in pixels 15908 * @param clampedX True if scrollX was clamped to an over-scroll boundary 15909 * @param clampedY True if scrollY was clamped to an over-scroll boundary 15910 */ 15911 protected void onOverScrolled(int scrollX, int scrollY, 15912 boolean clampedX, boolean clampedY) { 15913 // Intentionally empty. 15914 } 15915 15916 /** 15917 * Returns the over-scroll mode for this view. The result will be 15918 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 15919 * (allow over-scrolling only if the view content is larger than the container), 15920 * or {@link #OVER_SCROLL_NEVER}. 15921 * 15922 * @return This view's over-scroll mode. 15923 */ 15924 public int getOverScrollMode() { 15925 return mOverScrollMode; 15926 } 15927 15928 /** 15929 * Set the over-scroll mode for this view. Valid over-scroll modes are 15930 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 15931 * (allow over-scrolling only if the view content is larger than the container), 15932 * or {@link #OVER_SCROLL_NEVER}. 15933 * 15934 * Setting the over-scroll mode of a view will have an effect only if the 15935 * view is capable of scrolling. 15936 * 15937 * @param overScrollMode The new over-scroll mode for this view. 15938 */ 15939 public void setOverScrollMode(int overScrollMode) { 15940 if (overScrollMode != OVER_SCROLL_ALWAYS && 15941 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 15942 overScrollMode != OVER_SCROLL_NEVER) { 15943 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 15944 } 15945 mOverScrollMode = overScrollMode; 15946 } 15947 15948 /** 15949 * Gets a scale factor that determines the distance the view should scroll 15950 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 15951 * @return The vertical scroll scale factor. 15952 * @hide 15953 */ 15954 protected float getVerticalScrollFactor() { 15955 if (mVerticalScrollFactor == 0) { 15956 TypedValue outValue = new TypedValue(); 15957 if (!mContext.getTheme().resolveAttribute( 15958 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 15959 throw new IllegalStateException( 15960 "Expected theme to define listPreferredItemHeight."); 15961 } 15962 mVerticalScrollFactor = outValue.getDimension( 15963 mContext.getResources().getDisplayMetrics()); 15964 } 15965 return mVerticalScrollFactor; 15966 } 15967 15968 /** 15969 * Gets a scale factor that determines the distance the view should scroll 15970 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 15971 * @return The horizontal scroll scale factor. 15972 * @hide 15973 */ 15974 protected float getHorizontalScrollFactor() { 15975 // TODO: Should use something else. 15976 return getVerticalScrollFactor(); 15977 } 15978 15979 /** 15980 * Return the value specifying the text direction or policy that was set with 15981 * {@link #setTextDirection(int)}. 15982 * 15983 * @return the defined text direction. It can be one of: 15984 * 15985 * {@link #TEXT_DIRECTION_INHERIT}, 15986 * {@link #TEXT_DIRECTION_FIRST_STRONG} 15987 * {@link #TEXT_DIRECTION_ANY_RTL}, 15988 * {@link #TEXT_DIRECTION_LTR}, 15989 * {@link #TEXT_DIRECTION_RTL}, 15990 * {@link #TEXT_DIRECTION_LOCALE} 15991 */ 15992 @ViewDebug.ExportedProperty(category = "text", mapping = { 15993 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 15994 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 15995 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 15996 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 15997 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 15998 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 15999 }) 16000 public int getTextDirection() { 16001 return (mPrivateFlags2 & TEXT_DIRECTION_MASK) >> TEXT_DIRECTION_MASK_SHIFT; 16002 } 16003 16004 /** 16005 * Set the text direction. 16006 * 16007 * @param textDirection the direction to set. Should be one of: 16008 * 16009 * {@link #TEXT_DIRECTION_INHERIT}, 16010 * {@link #TEXT_DIRECTION_FIRST_STRONG} 16011 * {@link #TEXT_DIRECTION_ANY_RTL}, 16012 * {@link #TEXT_DIRECTION_LTR}, 16013 * {@link #TEXT_DIRECTION_RTL}, 16014 * {@link #TEXT_DIRECTION_LOCALE} 16015 */ 16016 public void setTextDirection(int textDirection) { 16017 if (getTextDirection() != textDirection) { 16018 // Reset the current text direction and the resolved one 16019 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK; 16020 resetResolvedTextDirection(); 16021 // Set the new text direction 16022 mPrivateFlags2 |= ((textDirection << TEXT_DIRECTION_MASK_SHIFT) & TEXT_DIRECTION_MASK); 16023 // Refresh 16024 requestLayout(); 16025 invalidate(true); 16026 } 16027 } 16028 16029 /** 16030 * Return the resolved text direction. 16031 * 16032 * This needs resolution if the value is TEXT_DIRECTION_INHERIT. The resolution matches 16033 * {@link #getTextDirection()}if it is not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds 16034 * up the parent chain of the view. if there is no parent, then it will return the default 16035 * {@link #TEXT_DIRECTION_FIRST_STRONG}. 16036 * 16037 * @return the resolved text direction. Returns one of: 16038 * 16039 * {@link #TEXT_DIRECTION_FIRST_STRONG} 16040 * {@link #TEXT_DIRECTION_ANY_RTL}, 16041 * {@link #TEXT_DIRECTION_LTR}, 16042 * {@link #TEXT_DIRECTION_RTL}, 16043 * {@link #TEXT_DIRECTION_LOCALE} 16044 */ 16045 public int getResolvedTextDirection() { 16046 // The text direction will be resolved only if needed 16047 if ((mPrivateFlags2 & TEXT_DIRECTION_RESOLVED) != TEXT_DIRECTION_RESOLVED) { 16048 resolveTextDirection(); 16049 } 16050 return (mPrivateFlags2 & TEXT_DIRECTION_RESOLVED_MASK) >> TEXT_DIRECTION_RESOLVED_MASK_SHIFT; 16051 } 16052 16053 /** 16054 * Resolve the text direction. Will call {@link View#onResolvedTextDirectionChanged} when 16055 * resolution is done. 16056 */ 16057 public void resolveTextDirection() { 16058 // Reset any previous text direction resolution 16059 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK); 16060 16061 if (hasRtlSupport()) { 16062 // Set resolved text direction flag depending on text direction flag 16063 final int textDirection = getTextDirection(); 16064 switch(textDirection) { 16065 case TEXT_DIRECTION_INHERIT: 16066 if (canResolveTextDirection()) { 16067 ViewGroup viewGroup = ((ViewGroup) mParent); 16068 16069 // Set current resolved direction to the same value as the parent's one 16070 final int parentResolvedDirection = viewGroup.getResolvedTextDirection(); 16071 switch (parentResolvedDirection) { 16072 case TEXT_DIRECTION_FIRST_STRONG: 16073 case TEXT_DIRECTION_ANY_RTL: 16074 case TEXT_DIRECTION_LTR: 16075 case TEXT_DIRECTION_RTL: 16076 case TEXT_DIRECTION_LOCALE: 16077 mPrivateFlags2 |= 16078 (parentResolvedDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 16079 break; 16080 default: 16081 // Default resolved direction is "first strong" heuristic 16082 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT; 16083 } 16084 } else { 16085 // We cannot do the resolution if there is no parent, so use the default one 16086 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT; 16087 } 16088 break; 16089 case TEXT_DIRECTION_FIRST_STRONG: 16090 case TEXT_DIRECTION_ANY_RTL: 16091 case TEXT_DIRECTION_LTR: 16092 case TEXT_DIRECTION_RTL: 16093 case TEXT_DIRECTION_LOCALE: 16094 // Resolved direction is the same as text direction 16095 mPrivateFlags2 |= (textDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT); 16096 break; 16097 default: 16098 // Default resolved direction is "first strong" heuristic 16099 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT; 16100 } 16101 } else { 16102 // Default resolved direction is "first strong" heuristic 16103 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT; 16104 } 16105 16106 // Set to resolved 16107 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED; 16108 onResolvedTextDirectionChanged(); 16109 } 16110 16111 /** 16112 * Called when text direction has been resolved. Subclasses that care about text direction 16113 * resolution should override this method. 16114 * 16115 * The default implementation does nothing. 16116 */ 16117 public void onResolvedTextDirectionChanged() { 16118 } 16119 16120 /** 16121 * Check if text direction resolution can be done. 16122 * 16123 * @return true if text direction resolution can be done otherwise return false. 16124 */ 16125 public boolean canResolveTextDirection() { 16126 switch (getTextDirection()) { 16127 case TEXT_DIRECTION_INHERIT: 16128 return (mParent != null) && (mParent instanceof ViewGroup); 16129 default: 16130 return true; 16131 } 16132 } 16133 16134 /** 16135 * Reset resolved text direction. Text direction can be resolved with a call to 16136 * getResolvedTextDirection(). Will call {@link View#onResolvedTextDirectionReset} when 16137 * reset is done. 16138 */ 16139 public void resetResolvedTextDirection() { 16140 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK); 16141 onResolvedTextDirectionReset(); 16142 } 16143 16144 /** 16145 * Called when text direction is reset. Subclasses that care about text direction reset should 16146 * override this method and do a reset of the text direction of their children. The default 16147 * implementation does nothing. 16148 */ 16149 public void onResolvedTextDirectionReset() { 16150 } 16151 16152 /** 16153 * Return the value specifying the text alignment or policy that was set with 16154 * {@link #setTextAlignment(int)}. 16155 * 16156 * @return the defined text alignment. It can be one of: 16157 * 16158 * {@link #TEXT_ALIGNMENT_INHERIT}, 16159 * {@link #TEXT_ALIGNMENT_GRAVITY}, 16160 * {@link #TEXT_ALIGNMENT_CENTER}, 16161 * {@link #TEXT_ALIGNMENT_TEXT_START}, 16162 * {@link #TEXT_ALIGNMENT_TEXT_END}, 16163 * {@link #TEXT_ALIGNMENT_VIEW_START}, 16164 * {@link #TEXT_ALIGNMENT_VIEW_END} 16165 */ 16166 @ViewDebug.ExportedProperty(category = "text", mapping = { 16167 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 16168 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 16169 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 16170 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 16171 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 16172 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 16173 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 16174 }) 16175 public int getTextAlignment() { 16176 return (mPrivateFlags2 & TEXT_ALIGNMENT_MASK) >> TEXT_ALIGNMENT_MASK_SHIFT; 16177 } 16178 16179 /** 16180 * Set the text alignment. 16181 * 16182 * @param textAlignment The text alignment to set. Should be one of 16183 * 16184 * {@link #TEXT_ALIGNMENT_INHERIT}, 16185 * {@link #TEXT_ALIGNMENT_GRAVITY}, 16186 * {@link #TEXT_ALIGNMENT_CENTER}, 16187 * {@link #TEXT_ALIGNMENT_TEXT_START}, 16188 * {@link #TEXT_ALIGNMENT_TEXT_END}, 16189 * {@link #TEXT_ALIGNMENT_VIEW_START}, 16190 * {@link #TEXT_ALIGNMENT_VIEW_END} 16191 * 16192 * @attr ref android.R.styleable#View_textAlignment 16193 */ 16194 public void setTextAlignment(int textAlignment) { 16195 if (textAlignment != getTextAlignment()) { 16196 // Reset the current and resolved text alignment 16197 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK; 16198 resetResolvedTextAlignment(); 16199 // Set the new text alignment 16200 mPrivateFlags2 |= ((textAlignment << TEXT_ALIGNMENT_MASK_SHIFT) & TEXT_ALIGNMENT_MASK); 16201 // Refresh 16202 requestLayout(); 16203 invalidate(true); 16204 } 16205 } 16206 16207 /** 16208 * Return the resolved text alignment. 16209 * 16210 * The resolved text alignment. This needs resolution if the value is 16211 * TEXT_ALIGNMENT_INHERIT. The resolution matches {@link #setTextAlignment(int)} if it is 16212 * not TEXT_ALIGNMENT_INHERIT, otherwise resolution proceeds up the parent chain of the view. 16213 * 16214 * @return the resolved text alignment. Returns one of: 16215 * 16216 * {@link #TEXT_ALIGNMENT_GRAVITY}, 16217 * {@link #TEXT_ALIGNMENT_CENTER}, 16218 * {@link #TEXT_ALIGNMENT_TEXT_START}, 16219 * {@link #TEXT_ALIGNMENT_TEXT_END}, 16220 * {@link #TEXT_ALIGNMENT_VIEW_START}, 16221 * {@link #TEXT_ALIGNMENT_VIEW_END} 16222 */ 16223 @ViewDebug.ExportedProperty(category = "text", mapping = { 16224 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"), 16225 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"), 16226 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"), 16227 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"), 16228 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"), 16229 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"), 16230 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END") 16231 }) 16232 public int getResolvedTextAlignment() { 16233 // If text alignment is not resolved, then resolve it 16234 if ((mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED) != TEXT_ALIGNMENT_RESOLVED) { 16235 resolveTextAlignment(); 16236 } 16237 return (mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED_MASK) >> TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT; 16238 } 16239 16240 /** 16241 * Resolve the text alignment. Will call {@link View#onResolvedTextAlignmentChanged} when 16242 * resolution is done. 16243 */ 16244 public void resolveTextAlignment() { 16245 // Reset any previous text alignment resolution 16246 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK); 16247 16248 if (hasRtlSupport()) { 16249 // Set resolved text alignment flag depending on text alignment flag 16250 final int textAlignment = getTextAlignment(); 16251 switch (textAlignment) { 16252 case TEXT_ALIGNMENT_INHERIT: 16253 // Check if we can resolve the text alignment 16254 if (canResolveLayoutDirection() && mParent instanceof View) { 16255 View view = (View) mParent; 16256 16257 final int parentResolvedTextAlignment = view.getResolvedTextAlignment(); 16258 switch (parentResolvedTextAlignment) { 16259 case TEXT_ALIGNMENT_GRAVITY: 16260 case TEXT_ALIGNMENT_TEXT_START: 16261 case TEXT_ALIGNMENT_TEXT_END: 16262 case TEXT_ALIGNMENT_CENTER: 16263 case TEXT_ALIGNMENT_VIEW_START: 16264 case TEXT_ALIGNMENT_VIEW_END: 16265 // Resolved text alignment is the same as the parent resolved 16266 // text alignment 16267 mPrivateFlags2 |= 16268 (parentResolvedTextAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 16269 break; 16270 default: 16271 // Use default resolved text alignment 16272 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16273 } 16274 } 16275 else { 16276 // We cannot do the resolution if there is no parent so use the default 16277 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16278 } 16279 break; 16280 case TEXT_ALIGNMENT_GRAVITY: 16281 case TEXT_ALIGNMENT_TEXT_START: 16282 case TEXT_ALIGNMENT_TEXT_END: 16283 case TEXT_ALIGNMENT_CENTER: 16284 case TEXT_ALIGNMENT_VIEW_START: 16285 case TEXT_ALIGNMENT_VIEW_END: 16286 // Resolved text alignment is the same as text alignment 16287 mPrivateFlags2 |= (textAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT); 16288 break; 16289 default: 16290 // Use default resolved text alignment 16291 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16292 } 16293 } else { 16294 // Use default resolved text alignment 16295 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT; 16296 } 16297 16298 // Set the resolved 16299 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED; 16300 onResolvedTextAlignmentChanged(); 16301 } 16302 16303 /** 16304 * Check if text alignment resolution can be done. 16305 * 16306 * @return true if text alignment resolution can be done otherwise return false. 16307 */ 16308 public boolean canResolveTextAlignment() { 16309 switch (getTextAlignment()) { 16310 case TEXT_DIRECTION_INHERIT: 16311 return (mParent != null); 16312 default: 16313 return true; 16314 } 16315 } 16316 16317 /** 16318 * Called when text alignment has been resolved. Subclasses that care about text alignment 16319 * resolution should override this method. 16320 * 16321 * The default implementation does nothing. 16322 */ 16323 public void onResolvedTextAlignmentChanged() { 16324 } 16325 16326 /** 16327 * Reset resolved text alignment. Text alignment can be resolved with a call to 16328 * getResolvedTextAlignment(). Will call {@link View#onResolvedTextAlignmentReset} when 16329 * reset is done. 16330 */ 16331 public void resetResolvedTextAlignment() { 16332 // Reset any previous text alignment resolution 16333 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK); 16334 onResolvedTextAlignmentReset(); 16335 } 16336 16337 /** 16338 * Called when text alignment is reset. Subclasses that care about text alignment reset should 16339 * override this method and do a reset of the text alignment of their children. The default 16340 * implementation does nothing. 16341 */ 16342 public void onResolvedTextAlignmentReset() { 16343 } 16344 16345 // 16346 // Properties 16347 // 16348 /** 16349 * A Property wrapper around the <code>alpha</code> functionality handled by the 16350 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 16351 */ 16352 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 16353 @Override 16354 public void setValue(View object, float value) { 16355 object.setAlpha(value); 16356 } 16357 16358 @Override 16359 public Float get(View object) { 16360 return object.getAlpha(); 16361 } 16362 }; 16363 16364 /** 16365 * A Property wrapper around the <code>translationX</code> functionality handled by the 16366 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 16367 */ 16368 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 16369 @Override 16370 public void setValue(View object, float value) { 16371 object.setTranslationX(value); 16372 } 16373 16374 @Override 16375 public Float get(View object) { 16376 return object.getTranslationX(); 16377 } 16378 }; 16379 16380 /** 16381 * A Property wrapper around the <code>translationY</code> functionality handled by the 16382 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 16383 */ 16384 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 16385 @Override 16386 public void setValue(View object, float value) { 16387 object.setTranslationY(value); 16388 } 16389 16390 @Override 16391 public Float get(View object) { 16392 return object.getTranslationY(); 16393 } 16394 }; 16395 16396 /** 16397 * A Property wrapper around the <code>x</code> functionality handled by the 16398 * {@link View#setX(float)} and {@link View#getX()} methods. 16399 */ 16400 public static final Property<View, Float> X = new FloatProperty<View>("x") { 16401 @Override 16402 public void setValue(View object, float value) { 16403 object.setX(value); 16404 } 16405 16406 @Override 16407 public Float get(View object) { 16408 return object.getX(); 16409 } 16410 }; 16411 16412 /** 16413 * A Property wrapper around the <code>y</code> functionality handled by the 16414 * {@link View#setY(float)} and {@link View#getY()} methods. 16415 */ 16416 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 16417 @Override 16418 public void setValue(View object, float value) { 16419 object.setY(value); 16420 } 16421 16422 @Override 16423 public Float get(View object) { 16424 return object.getY(); 16425 } 16426 }; 16427 16428 /** 16429 * A Property wrapper around the <code>rotation</code> functionality handled by the 16430 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 16431 */ 16432 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 16433 @Override 16434 public void setValue(View object, float value) { 16435 object.setRotation(value); 16436 } 16437 16438 @Override 16439 public Float get(View object) { 16440 return object.getRotation(); 16441 } 16442 }; 16443 16444 /** 16445 * A Property wrapper around the <code>rotationX</code> functionality handled by the 16446 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 16447 */ 16448 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 16449 @Override 16450 public void setValue(View object, float value) { 16451 object.setRotationX(value); 16452 } 16453 16454 @Override 16455 public Float get(View object) { 16456 return object.getRotationX(); 16457 } 16458 }; 16459 16460 /** 16461 * A Property wrapper around the <code>rotationY</code> functionality handled by the 16462 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 16463 */ 16464 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 16465 @Override 16466 public void setValue(View object, float value) { 16467 object.setRotationY(value); 16468 } 16469 16470 @Override 16471 public Float get(View object) { 16472 return object.getRotationY(); 16473 } 16474 }; 16475 16476 /** 16477 * A Property wrapper around the <code>scaleX</code> functionality handled by the 16478 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 16479 */ 16480 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 16481 @Override 16482 public void setValue(View object, float value) { 16483 object.setScaleX(value); 16484 } 16485 16486 @Override 16487 public Float get(View object) { 16488 return object.getScaleX(); 16489 } 16490 }; 16491 16492 /** 16493 * A Property wrapper around the <code>scaleY</code> functionality handled by the 16494 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 16495 */ 16496 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 16497 @Override 16498 public void setValue(View object, float value) { 16499 object.setScaleY(value); 16500 } 16501 16502 @Override 16503 public Float get(View object) { 16504 return object.getScaleY(); 16505 } 16506 }; 16507 16508 /** 16509 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 16510 * Each MeasureSpec represents a requirement for either the width or the height. 16511 * A MeasureSpec is comprised of a size and a mode. There are three possible 16512 * modes: 16513 * <dl> 16514 * <dt>UNSPECIFIED</dt> 16515 * <dd> 16516 * The parent has not imposed any constraint on the child. It can be whatever size 16517 * it wants. 16518 * </dd> 16519 * 16520 * <dt>EXACTLY</dt> 16521 * <dd> 16522 * The parent has determined an exact size for the child. The child is going to be 16523 * given those bounds regardless of how big it wants to be. 16524 * </dd> 16525 * 16526 * <dt>AT_MOST</dt> 16527 * <dd> 16528 * The child can be as large as it wants up to the specified size. 16529 * </dd> 16530 * </dl> 16531 * 16532 * MeasureSpecs are implemented as ints to reduce object allocation. This class 16533 * is provided to pack and unpack the <size, mode> tuple into the int. 16534 */ 16535 public static class MeasureSpec { 16536 private static final int MODE_SHIFT = 30; 16537 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 16538 16539 /** 16540 * Measure specification mode: The parent has not imposed any constraint 16541 * on the child. It can be whatever size it wants. 16542 */ 16543 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 16544 16545 /** 16546 * Measure specification mode: The parent has determined an exact size 16547 * for the child. The child is going to be given those bounds regardless 16548 * of how big it wants to be. 16549 */ 16550 public static final int EXACTLY = 1 << MODE_SHIFT; 16551 16552 /** 16553 * Measure specification mode: The child can be as large as it wants up 16554 * to the specified size. 16555 */ 16556 public static final int AT_MOST = 2 << MODE_SHIFT; 16557 16558 /** 16559 * Creates a measure specification based on the supplied size and mode. 16560 * 16561 * The mode must always be one of the following: 16562 * <ul> 16563 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 16564 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 16565 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 16566 * </ul> 16567 * 16568 * @param size the size of the measure specification 16569 * @param mode the mode of the measure specification 16570 * @return the measure specification based on size and mode 16571 */ 16572 public static int makeMeasureSpec(int size, int mode) { 16573 return size + mode; 16574 } 16575 16576 /** 16577 * Extracts the mode from the supplied measure specification. 16578 * 16579 * @param measureSpec the measure specification to extract the mode from 16580 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 16581 * {@link android.view.View.MeasureSpec#AT_MOST} or 16582 * {@link android.view.View.MeasureSpec#EXACTLY} 16583 */ 16584 public static int getMode(int measureSpec) { 16585 return (measureSpec & MODE_MASK); 16586 } 16587 16588 /** 16589 * Extracts the size from the supplied measure specification. 16590 * 16591 * @param measureSpec the measure specification to extract the size from 16592 * @return the size in pixels defined in the supplied measure specification 16593 */ 16594 public static int getSize(int measureSpec) { 16595 return (measureSpec & ~MODE_MASK); 16596 } 16597 16598 /** 16599 * Returns a String representation of the specified measure 16600 * specification. 16601 * 16602 * @param measureSpec the measure specification to convert to a String 16603 * @return a String with the following format: "MeasureSpec: MODE SIZE" 16604 */ 16605 public static String toString(int measureSpec) { 16606 int mode = getMode(measureSpec); 16607 int size = getSize(measureSpec); 16608 16609 StringBuilder sb = new StringBuilder("MeasureSpec: "); 16610 16611 if (mode == UNSPECIFIED) 16612 sb.append("UNSPECIFIED "); 16613 else if (mode == EXACTLY) 16614 sb.append("EXACTLY "); 16615 else if (mode == AT_MOST) 16616 sb.append("AT_MOST "); 16617 else 16618 sb.append(mode).append(" "); 16619 16620 sb.append(size); 16621 return sb.toString(); 16622 } 16623 } 16624 16625 class CheckForLongPress implements Runnable { 16626 16627 private int mOriginalWindowAttachCount; 16628 16629 public void run() { 16630 if (isPressed() && (mParent != null) 16631 && mOriginalWindowAttachCount == mWindowAttachCount) { 16632 if (performLongClick()) { 16633 mHasPerformedLongPress = true; 16634 } 16635 } 16636 } 16637 16638 public void rememberWindowAttachCount() { 16639 mOriginalWindowAttachCount = mWindowAttachCount; 16640 } 16641 } 16642 16643 private final class CheckForTap implements Runnable { 16644 public void run() { 16645 mPrivateFlags &= ~PREPRESSED; 16646 setPressed(true); 16647 checkForLongClick(ViewConfiguration.getTapTimeout()); 16648 } 16649 } 16650 16651 private final class PerformClick implements Runnable { 16652 public void run() { 16653 performClick(); 16654 } 16655 } 16656 16657 /** @hide */ 16658 public void hackTurnOffWindowResizeAnim(boolean off) { 16659 mAttachInfo.mTurnOffWindowResizeAnim = off; 16660 } 16661 16662 /** 16663 * This method returns a ViewPropertyAnimator object, which can be used to animate 16664 * specific properties on this View. 16665 * 16666 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 16667 */ 16668 public ViewPropertyAnimator animate() { 16669 if (mAnimator == null) { 16670 mAnimator = new ViewPropertyAnimator(this); 16671 } 16672 return mAnimator; 16673 } 16674 16675 /** 16676 * Interface definition for a callback to be invoked when a key event is 16677 * dispatched to this view. The callback will be invoked before the key 16678 * event is given to the view. 16679 */ 16680 public interface OnKeyListener { 16681 /** 16682 * Called when a key is dispatched to a view. This allows listeners to 16683 * get a chance to respond before the target view. 16684 * 16685 * @param v The view the key has been dispatched to. 16686 * @param keyCode The code for the physical key that was pressed 16687 * @param event The KeyEvent object containing full information about 16688 * the event. 16689 * @return True if the listener has consumed the event, false otherwise. 16690 */ 16691 boolean onKey(View v, int keyCode, KeyEvent event); 16692 } 16693 16694 /** 16695 * Interface definition for a callback to be invoked when a touch event is 16696 * dispatched to this view. The callback will be invoked before the touch 16697 * event is given to the view. 16698 */ 16699 public interface OnTouchListener { 16700 /** 16701 * Called when a touch event is dispatched to a view. This allows listeners to 16702 * get a chance to respond before the target view. 16703 * 16704 * @param v The view the touch event has been dispatched to. 16705 * @param event The MotionEvent object containing full information about 16706 * the event. 16707 * @return True if the listener has consumed the event, false otherwise. 16708 */ 16709 boolean onTouch(View v, MotionEvent event); 16710 } 16711 16712 /** 16713 * Interface definition for a callback to be invoked when a hover event is 16714 * dispatched to this view. The callback will be invoked before the hover 16715 * event is given to the view. 16716 */ 16717 public interface OnHoverListener { 16718 /** 16719 * Called when a hover event is dispatched to a view. This allows listeners to 16720 * get a chance to respond before the target view. 16721 * 16722 * @param v The view the hover event has been dispatched to. 16723 * @param event The MotionEvent object containing full information about 16724 * the event. 16725 * @return True if the listener has consumed the event, false otherwise. 16726 */ 16727 boolean onHover(View v, MotionEvent event); 16728 } 16729 16730 /** 16731 * Interface definition for a callback to be invoked when a generic motion event is 16732 * dispatched to this view. The callback will be invoked before the generic motion 16733 * event is given to the view. 16734 */ 16735 public interface OnGenericMotionListener { 16736 /** 16737 * Called when a generic motion event is dispatched to a view. This allows listeners to 16738 * get a chance to respond before the target view. 16739 * 16740 * @param v The view the generic motion event has been dispatched to. 16741 * @param event The MotionEvent object containing full information about 16742 * the event. 16743 * @return True if the listener has consumed the event, false otherwise. 16744 */ 16745 boolean onGenericMotion(View v, MotionEvent event); 16746 } 16747 16748 /** 16749 * Interface definition for a callback to be invoked when a view has been clicked and held. 16750 */ 16751 public interface OnLongClickListener { 16752 /** 16753 * Called when a view has been clicked and held. 16754 * 16755 * @param v The view that was clicked and held. 16756 * 16757 * @return true if the callback consumed the long click, false otherwise. 16758 */ 16759 boolean onLongClick(View v); 16760 } 16761 16762 /** 16763 * Interface definition for a callback to be invoked when a drag is being dispatched 16764 * to this view. The callback will be invoked before the hosting view's own 16765 * onDrag(event) method. If the listener wants to fall back to the hosting view's 16766 * onDrag(event) behavior, it should return 'false' from this callback. 16767 * 16768 * <div class="special reference"> 16769 * <h3>Developer Guides</h3> 16770 * <p>For a guide to implementing drag and drop features, read the 16771 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 16772 * </div> 16773 */ 16774 public interface OnDragListener { 16775 /** 16776 * Called when a drag event is dispatched to a view. This allows listeners 16777 * to get a chance to override base View behavior. 16778 * 16779 * @param v The View that received the drag event. 16780 * @param event The {@link android.view.DragEvent} object for the drag event. 16781 * @return {@code true} if the drag event was handled successfully, or {@code false} 16782 * if the drag event was not handled. Note that {@code false} will trigger the View 16783 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 16784 */ 16785 boolean onDrag(View v, DragEvent event); 16786 } 16787 16788 /** 16789 * Interface definition for a callback to be invoked when the focus state of 16790 * a view changed. 16791 */ 16792 public interface OnFocusChangeListener { 16793 /** 16794 * Called when the focus state of a view has changed. 16795 * 16796 * @param v The view whose state has changed. 16797 * @param hasFocus The new focus state of v. 16798 */ 16799 void onFocusChange(View v, boolean hasFocus); 16800 } 16801 16802 /** 16803 * Interface definition for a callback to be invoked when a view is clicked. 16804 */ 16805 public interface OnClickListener { 16806 /** 16807 * Called when a view has been clicked. 16808 * 16809 * @param v The view that was clicked. 16810 */ 16811 void onClick(View v); 16812 } 16813 16814 /** 16815 * Interface definition for a callback to be invoked when the context menu 16816 * for this view is being built. 16817 */ 16818 public interface OnCreateContextMenuListener { 16819 /** 16820 * Called when the context menu for this view is being built. It is not 16821 * safe to hold onto the menu after this method returns. 16822 * 16823 * @param menu The context menu that is being built 16824 * @param v The view for which the context menu is being built 16825 * @param menuInfo Extra information about the item for which the 16826 * context menu should be shown. This information will vary 16827 * depending on the class of v. 16828 */ 16829 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 16830 } 16831 16832 /** 16833 * Interface definition for a callback to be invoked when the status bar changes 16834 * visibility. This reports <strong>global</strong> changes to the system UI 16835 * state, not what the application is requesting. 16836 * 16837 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 16838 */ 16839 public interface OnSystemUiVisibilityChangeListener { 16840 /** 16841 * Called when the status bar changes visibility because of a call to 16842 * {@link View#setSystemUiVisibility(int)}. 16843 * 16844 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE}, 16845 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}. 16846 * This tells you the <strong>global</strong> state of these UI visibility 16847 * flags, not what your app is currently applying. 16848 */ 16849 public void onSystemUiVisibilityChange(int visibility); 16850 } 16851 16852 /** 16853 * Interface definition for a callback to be invoked when this view is attached 16854 * or detached from its window. 16855 */ 16856 public interface OnAttachStateChangeListener { 16857 /** 16858 * Called when the view is attached to a window. 16859 * @param v The view that was attached 16860 */ 16861 public void onViewAttachedToWindow(View v); 16862 /** 16863 * Called when the view is detached from a window. 16864 * @param v The view that was detached 16865 */ 16866 public void onViewDetachedFromWindow(View v); 16867 } 16868 16869 private final class UnsetPressedState implements Runnable { 16870 public void run() { 16871 setPressed(false); 16872 } 16873 } 16874 16875 /** 16876 * Base class for derived classes that want to save and restore their own 16877 * state in {@link android.view.View#onSaveInstanceState()}. 16878 */ 16879 public static class BaseSavedState extends AbsSavedState { 16880 /** 16881 * Constructor used when reading from a parcel. Reads the state of the superclass. 16882 * 16883 * @param source 16884 */ 16885 public BaseSavedState(Parcel source) { 16886 super(source); 16887 } 16888 16889 /** 16890 * Constructor called by derived classes when creating their SavedState objects 16891 * 16892 * @param superState The state of the superclass of this view 16893 */ 16894 public BaseSavedState(Parcelable superState) { 16895 super(superState); 16896 } 16897 16898 public static final Parcelable.Creator<BaseSavedState> CREATOR = 16899 new Parcelable.Creator<BaseSavedState>() { 16900 public BaseSavedState createFromParcel(Parcel in) { 16901 return new BaseSavedState(in); 16902 } 16903 16904 public BaseSavedState[] newArray(int size) { 16905 return new BaseSavedState[size]; 16906 } 16907 }; 16908 } 16909 16910 /** 16911 * A set of information given to a view when it is attached to its parent 16912 * window. 16913 */ 16914 static class AttachInfo { 16915 interface Callbacks { 16916 void playSoundEffect(int effectId); 16917 boolean performHapticFeedback(int effectId, boolean always); 16918 } 16919 16920 /** 16921 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 16922 * to a Handler. This class contains the target (View) to invalidate and 16923 * the coordinates of the dirty rectangle. 16924 * 16925 * For performance purposes, this class also implements a pool of up to 16926 * POOL_LIMIT objects that get reused. This reduces memory allocations 16927 * whenever possible. 16928 */ 16929 static class InvalidateInfo implements Poolable<InvalidateInfo> { 16930 private static final int POOL_LIMIT = 10; 16931 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool( 16932 Pools.finitePool(new PoolableManager<InvalidateInfo>() { 16933 public InvalidateInfo newInstance() { 16934 return new InvalidateInfo(); 16935 } 16936 16937 public void onAcquired(InvalidateInfo element) { 16938 } 16939 16940 public void onReleased(InvalidateInfo element) { 16941 element.target = null; 16942 } 16943 }, POOL_LIMIT) 16944 ); 16945 16946 private InvalidateInfo mNext; 16947 private boolean mIsPooled; 16948 16949 View target; 16950 16951 int left; 16952 int top; 16953 int right; 16954 int bottom; 16955 16956 public void setNextPoolable(InvalidateInfo element) { 16957 mNext = element; 16958 } 16959 16960 public InvalidateInfo getNextPoolable() { 16961 return mNext; 16962 } 16963 16964 static InvalidateInfo acquire() { 16965 return sPool.acquire(); 16966 } 16967 16968 void release() { 16969 sPool.release(this); 16970 } 16971 16972 public boolean isPooled() { 16973 return mIsPooled; 16974 } 16975 16976 public void setPooled(boolean isPooled) { 16977 mIsPooled = isPooled; 16978 } 16979 } 16980 16981 final IWindowSession mSession; 16982 16983 final IWindow mWindow; 16984 16985 final IBinder mWindowToken; 16986 16987 final Callbacks mRootCallbacks; 16988 16989 HardwareCanvas mHardwareCanvas; 16990 16991 /** 16992 * The top view of the hierarchy. 16993 */ 16994 View mRootView; 16995 16996 IBinder mPanelParentWindowToken; 16997 Surface mSurface; 16998 16999 boolean mHardwareAccelerated; 17000 boolean mHardwareAccelerationRequested; 17001 HardwareRenderer mHardwareRenderer; 17002 17003 boolean mScreenOn; 17004 17005 /** 17006 * Scale factor used by the compatibility mode 17007 */ 17008 float mApplicationScale; 17009 17010 /** 17011 * Indicates whether the application is in compatibility mode 17012 */ 17013 boolean mScalingRequired; 17014 17015 /** 17016 * If set, ViewAncestor doesn't use its lame animation for when the window resizes. 17017 */ 17018 boolean mTurnOffWindowResizeAnim; 17019 17020 /** 17021 * Left position of this view's window 17022 */ 17023 int mWindowLeft; 17024 17025 /** 17026 * Top position of this view's window 17027 */ 17028 int mWindowTop; 17029 17030 /** 17031 * Indicates whether views need to use 32-bit drawing caches 17032 */ 17033 boolean mUse32BitDrawingCache; 17034 17035 /** 17036 * Describes the parts of the window that are currently completely 17037 * obscured by system UI elements. 17038 */ 17039 final Rect mSystemInsets = new Rect(); 17040 17041 /** 17042 * For windows that are full-screen but using insets to layout inside 17043 * of the screen decorations, these are the current insets for the 17044 * content of the window. 17045 */ 17046 final Rect mContentInsets = new Rect(); 17047 17048 /** 17049 * For windows that are full-screen but using insets to layout inside 17050 * of the screen decorations, these are the current insets for the 17051 * actual visible parts of the window. 17052 */ 17053 final Rect mVisibleInsets = new Rect(); 17054 17055 /** 17056 * The internal insets given by this window. This value is 17057 * supplied by the client (through 17058 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 17059 * be given to the window manager when changed to be used in laying 17060 * out windows behind it. 17061 */ 17062 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 17063 = new ViewTreeObserver.InternalInsetsInfo(); 17064 17065 /** 17066 * All views in the window's hierarchy that serve as scroll containers, 17067 * used to determine if the window can be resized or must be panned 17068 * to adjust for a soft input area. 17069 */ 17070 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 17071 17072 final KeyEvent.DispatcherState mKeyDispatchState 17073 = new KeyEvent.DispatcherState(); 17074 17075 /** 17076 * Indicates whether the view's window currently has the focus. 17077 */ 17078 boolean mHasWindowFocus; 17079 17080 /** 17081 * The current visibility of the window. 17082 */ 17083 int mWindowVisibility; 17084 17085 /** 17086 * Indicates the time at which drawing started to occur. 17087 */ 17088 long mDrawingTime; 17089 17090 /** 17091 * Indicates whether or not ignoring the DIRTY_MASK flags. 17092 */ 17093 boolean mIgnoreDirtyState; 17094 17095 /** 17096 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 17097 * to avoid clearing that flag prematurely. 17098 */ 17099 boolean mSetIgnoreDirtyState = false; 17100 17101 /** 17102 * Indicates whether the view's window is currently in touch mode. 17103 */ 17104 boolean mInTouchMode; 17105 17106 /** 17107 * Indicates that ViewAncestor should trigger a global layout change 17108 * the next time it performs a traversal 17109 */ 17110 boolean mRecomputeGlobalAttributes; 17111 17112 /** 17113 * Always report new attributes at next traversal. 17114 */ 17115 boolean mForceReportNewAttributes; 17116 17117 /** 17118 * Set during a traveral if any views want to keep the screen on. 17119 */ 17120 boolean mKeepScreenOn; 17121 17122 /** 17123 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 17124 */ 17125 int mSystemUiVisibility; 17126 17127 /** 17128 * Hack to force certain system UI visibility flags to be cleared. 17129 */ 17130 int mDisabledSystemUiVisibility; 17131 17132 /** 17133 * Last global system UI visibility reported by the window manager. 17134 */ 17135 int mGlobalSystemUiVisibility; 17136 17137 /** 17138 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 17139 * attached. 17140 */ 17141 boolean mHasSystemUiListeners; 17142 17143 /** 17144 * Set if the visibility of any views has changed. 17145 */ 17146 boolean mViewVisibilityChanged; 17147 17148 /** 17149 * Set to true if a view has been scrolled. 17150 */ 17151 boolean mViewScrollChanged; 17152 17153 /** 17154 * Global to the view hierarchy used as a temporary for dealing with 17155 * x/y points in the transparent region computations. 17156 */ 17157 final int[] mTransparentLocation = new int[2]; 17158 17159 /** 17160 * Global to the view hierarchy used as a temporary for dealing with 17161 * x/y points in the ViewGroup.invalidateChild implementation. 17162 */ 17163 final int[] mInvalidateChildLocation = new int[2]; 17164 17165 17166 /** 17167 * Global to the view hierarchy used as a temporary for dealing with 17168 * x/y location when view is transformed. 17169 */ 17170 final float[] mTmpTransformLocation = new float[2]; 17171 17172 /** 17173 * The view tree observer used to dispatch global events like 17174 * layout, pre-draw, touch mode change, etc. 17175 */ 17176 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 17177 17178 /** 17179 * A Canvas used by the view hierarchy to perform bitmap caching. 17180 */ 17181 Canvas mCanvas; 17182 17183 /** 17184 * The view root impl. 17185 */ 17186 final ViewRootImpl mViewRootImpl; 17187 17188 /** 17189 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 17190 * handler can be used to pump events in the UI events queue. 17191 */ 17192 final Handler mHandler; 17193 17194 /** 17195 * Temporary for use in computing invalidate rectangles while 17196 * calling up the hierarchy. 17197 */ 17198 final Rect mTmpInvalRect = new Rect(); 17199 17200 /** 17201 * Temporary for use in computing hit areas with transformed views 17202 */ 17203 final RectF mTmpTransformRect = new RectF(); 17204 17205 /** 17206 * Temporary list for use in collecting focusable descendents of a view. 17207 */ 17208 final ArrayList<View> mTempArrayList = new ArrayList<View>(24); 17209 17210 /** 17211 * The id of the window for accessibility purposes. 17212 */ 17213 int mAccessibilityWindowId = View.NO_ID; 17214 17215 /** 17216 * Whether to ingore not exposed for accessibility Views when 17217 * reporting the view tree to accessibility services. 17218 */ 17219 boolean mIncludeNotImportantViews; 17220 17221 /** 17222 * The drawable for highlighting accessibility focus. 17223 */ 17224 Drawable mAccessibilityFocusDrawable; 17225 17226 /** 17227 * Show where the margins, bounds and layout bounds are for each view. 17228 */ 17229 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false); 17230 17231 /** 17232 * Point used to compute visible regions. 17233 */ 17234 final Point mPoint = new Point(); 17235 17236 /** 17237 * Creates a new set of attachment information with the specified 17238 * events handler and thread. 17239 * 17240 * @param handler the events handler the view must use 17241 */ 17242 AttachInfo(IWindowSession session, IWindow window, 17243 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) { 17244 mSession = session; 17245 mWindow = window; 17246 mWindowToken = window.asBinder(); 17247 mViewRootImpl = viewRootImpl; 17248 mHandler = handler; 17249 mRootCallbacks = effectPlayer; 17250 } 17251 } 17252 17253 /** 17254 * <p>ScrollabilityCache holds various fields used by a View when scrolling 17255 * is supported. This avoids keeping too many unused fields in most 17256 * instances of View.</p> 17257 */ 17258 private static class ScrollabilityCache implements Runnable { 17259 17260 /** 17261 * Scrollbars are not visible 17262 */ 17263 public static final int OFF = 0; 17264 17265 /** 17266 * Scrollbars are visible 17267 */ 17268 public static final int ON = 1; 17269 17270 /** 17271 * Scrollbars are fading away 17272 */ 17273 public static final int FADING = 2; 17274 17275 public boolean fadeScrollBars; 17276 17277 public int fadingEdgeLength; 17278 public int scrollBarDefaultDelayBeforeFade; 17279 public int scrollBarFadeDuration; 17280 17281 public int scrollBarSize; 17282 public ScrollBarDrawable scrollBar; 17283 public float[] interpolatorValues; 17284 public View host; 17285 17286 public final Paint paint; 17287 public final Matrix matrix; 17288 public Shader shader; 17289 17290 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 17291 17292 private static final float[] OPAQUE = { 255 }; 17293 private static final float[] TRANSPARENT = { 0.0f }; 17294 17295 /** 17296 * When fading should start. This time moves into the future every time 17297 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 17298 */ 17299 public long fadeStartTime; 17300 17301 17302 /** 17303 * The current state of the scrollbars: ON, OFF, or FADING 17304 */ 17305 public int state = OFF; 17306 17307 private int mLastColor; 17308 17309 public ScrollabilityCache(ViewConfiguration configuration, View host) { 17310 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 17311 scrollBarSize = configuration.getScaledScrollBarSize(); 17312 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 17313 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 17314 17315 paint = new Paint(); 17316 matrix = new Matrix(); 17317 // use use a height of 1, and then wack the matrix each time we 17318 // actually use it. 17319 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 17320 17321 paint.setShader(shader); 17322 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 17323 this.host = host; 17324 } 17325 17326 public void setFadeColor(int color) { 17327 if (color != 0 && color != mLastColor) { 17328 mLastColor = color; 17329 color |= 0xFF000000; 17330 17331 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 17332 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 17333 17334 paint.setShader(shader); 17335 // Restore the default transfer mode (src_over) 17336 paint.setXfermode(null); 17337 } 17338 } 17339 17340 public void run() { 17341 long now = AnimationUtils.currentAnimationTimeMillis(); 17342 if (now >= fadeStartTime) { 17343 17344 // the animation fades the scrollbars out by changing 17345 // the opacity (alpha) from fully opaque to fully 17346 // transparent 17347 int nextFrame = (int) now; 17348 int framesCount = 0; 17349 17350 Interpolator interpolator = scrollBarInterpolator; 17351 17352 // Start opaque 17353 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 17354 17355 // End transparent 17356 nextFrame += scrollBarFadeDuration; 17357 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 17358 17359 state = FADING; 17360 17361 // Kick off the fade animation 17362 host.invalidate(true); 17363 } 17364 } 17365 } 17366 17367 /** 17368 * Resuable callback for sending 17369 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 17370 */ 17371 private class SendViewScrolledAccessibilityEvent implements Runnable { 17372 public volatile boolean mIsPending; 17373 17374 public void run() { 17375 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 17376 mIsPending = false; 17377 } 17378 } 17379 17380 /** 17381 * <p> 17382 * This class represents a delegate that can be registered in a {@link View} 17383 * to enhance accessibility support via composition rather via inheritance. 17384 * It is specifically targeted to widget developers that extend basic View 17385 * classes i.e. classes in package android.view, that would like their 17386 * applications to be backwards compatible. 17387 * </p> 17388 * <div class="special reference"> 17389 * <h3>Developer Guides</h3> 17390 * <p>For more information about making applications accessible, read the 17391 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a> 17392 * developer guide.</p> 17393 * </div> 17394 * <p> 17395 * A scenario in which a developer would like to use an accessibility delegate 17396 * is overriding a method introduced in a later API version then the minimal API 17397 * version supported by the application. For example, the method 17398 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 17399 * in API version 4 when the accessibility APIs were first introduced. If a 17400 * developer would like his application to run on API version 4 devices (assuming 17401 * all other APIs used by the application are version 4 or lower) and take advantage 17402 * of this method, instead of overriding the method which would break the application's 17403 * backwards compatibility, he can override the corresponding method in this 17404 * delegate and register the delegate in the target View if the API version of 17405 * the system is high enough i.e. the API version is same or higher to the API 17406 * version that introduced 17407 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 17408 * </p> 17409 * <p> 17410 * Here is an example implementation: 17411 * </p> 17412 * <code><pre><p> 17413 * if (Build.VERSION.SDK_INT >= 14) { 17414 * // If the API version is equal of higher than the version in 17415 * // which onInitializeAccessibilityNodeInfo was introduced we 17416 * // register a delegate with a customized implementation. 17417 * View view = findViewById(R.id.view_id); 17418 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 17419 * public void onInitializeAccessibilityNodeInfo(View host, 17420 * AccessibilityNodeInfo info) { 17421 * // Let the default implementation populate the info. 17422 * super.onInitializeAccessibilityNodeInfo(host, info); 17423 * // Set some other information. 17424 * info.setEnabled(host.isEnabled()); 17425 * } 17426 * }); 17427 * } 17428 * </code></pre></p> 17429 * <p> 17430 * This delegate contains methods that correspond to the accessibility methods 17431 * in View. If a delegate has been specified the implementation in View hands 17432 * off handling to the corresponding method in this delegate. The default 17433 * implementation the delegate methods behaves exactly as the corresponding 17434 * method in View for the case of no accessibility delegate been set. Hence, 17435 * to customize the behavior of a View method, clients can override only the 17436 * corresponding delegate method without altering the behavior of the rest 17437 * accessibility related methods of the host view. 17438 * </p> 17439 */ 17440 public static class AccessibilityDelegate { 17441 17442 /** 17443 * Sends an accessibility event of the given type. If accessibility is not 17444 * enabled this method has no effect. 17445 * <p> 17446 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 17447 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 17448 * been set. 17449 * </p> 17450 * 17451 * @param host The View hosting the delegate. 17452 * @param eventType The type of the event to send. 17453 * 17454 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 17455 */ 17456 public void sendAccessibilityEvent(View host, int eventType) { 17457 host.sendAccessibilityEventInternal(eventType); 17458 } 17459 17460 /** 17461 * Performs the specified accessibility action on the view. For 17462 * possible accessibility actions look at {@link AccessibilityNodeInfo}. 17463 * <p> 17464 * The default implementation behaves as 17465 * {@link View#performAccessibilityAction(int, Bundle) 17466 * View#performAccessibilityAction(int, Bundle)} for the case of 17467 * no accessibility delegate been set. 17468 * </p> 17469 * 17470 * @param action The action to perform. 17471 * @return Whether the action was performed. 17472 * 17473 * @see View#performAccessibilityAction(int, Bundle) 17474 * View#performAccessibilityAction(int, Bundle) 17475 */ 17476 public boolean performAccessibilityAction(View host, int action, Bundle args) { 17477 return host.performAccessibilityActionInternal(action, args); 17478 } 17479 17480 /** 17481 * Sends an accessibility event. This method behaves exactly as 17482 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 17483 * empty {@link AccessibilityEvent} and does not perform a check whether 17484 * accessibility is enabled. 17485 * <p> 17486 * The default implementation behaves as 17487 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 17488 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 17489 * the case of no accessibility delegate been set. 17490 * </p> 17491 * 17492 * @param host The View hosting the delegate. 17493 * @param event The event to send. 17494 * 17495 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 17496 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 17497 */ 17498 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 17499 host.sendAccessibilityEventUncheckedInternal(event); 17500 } 17501 17502 /** 17503 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 17504 * to its children for adding their text content to the event. 17505 * <p> 17506 * The default implementation behaves as 17507 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 17508 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 17509 * the case of no accessibility delegate been set. 17510 * </p> 17511 * 17512 * @param host The View hosting the delegate. 17513 * @param event The event. 17514 * @return True if the event population was completed. 17515 * 17516 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 17517 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 17518 */ 17519 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 17520 return host.dispatchPopulateAccessibilityEventInternal(event); 17521 } 17522 17523 /** 17524 * Gives a chance to the host View to populate the accessibility event with its 17525 * text content. 17526 * <p> 17527 * The default implementation behaves as 17528 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 17529 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 17530 * the case of no accessibility delegate been set. 17531 * </p> 17532 * 17533 * @param host The View hosting the delegate. 17534 * @param event The accessibility event which to populate. 17535 * 17536 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 17537 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 17538 */ 17539 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 17540 host.onPopulateAccessibilityEventInternal(event); 17541 } 17542 17543 /** 17544 * Initializes an {@link AccessibilityEvent} with information about the 17545 * the host View which is the event source. 17546 * <p> 17547 * The default implementation behaves as 17548 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 17549 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 17550 * the case of no accessibility delegate been set. 17551 * </p> 17552 * 17553 * @param host The View hosting the delegate. 17554 * @param event The event to initialize. 17555 * 17556 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 17557 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 17558 */ 17559 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 17560 host.onInitializeAccessibilityEventInternal(event); 17561 } 17562 17563 /** 17564 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 17565 * <p> 17566 * The default implementation behaves as 17567 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 17568 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 17569 * the case of no accessibility delegate been set. 17570 * </p> 17571 * 17572 * @param host The View hosting the delegate. 17573 * @param info The instance to initialize. 17574 * 17575 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 17576 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 17577 */ 17578 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 17579 host.onInitializeAccessibilityNodeInfoInternal(info); 17580 } 17581 17582 /** 17583 * Called when a child of the host View has requested sending an 17584 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 17585 * to augment the event. 17586 * <p> 17587 * The default implementation behaves as 17588 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 17589 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 17590 * the case of no accessibility delegate been set. 17591 * </p> 17592 * 17593 * @param host The View hosting the delegate. 17594 * @param child The child which requests sending the event. 17595 * @param event The event to be sent. 17596 * @return True if the event should be sent 17597 * 17598 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 17599 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 17600 */ 17601 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 17602 AccessibilityEvent event) { 17603 return host.onRequestSendAccessibilityEventInternal(child, event); 17604 } 17605 17606 /** 17607 * Gets the provider for managing a virtual view hierarchy rooted at this View 17608 * and reported to {@link android.accessibilityservice.AccessibilityService}s 17609 * that explore the window content. 17610 * <p> 17611 * The default implementation behaves as 17612 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 17613 * the case of no accessibility delegate been set. 17614 * </p> 17615 * 17616 * @return The provider. 17617 * 17618 * @see AccessibilityNodeProvider 17619 */ 17620 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 17621 return null; 17622 } 17623 } 17624} 17625