View.java revision 9e34b95a1db9f28b31560405687dd651492048e1
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.Interpolator; 28import android.graphics.LinearGradient; 29import android.graphics.Matrix; 30import android.graphics.Paint; 31import android.graphics.PixelFormat; 32import android.graphics.Point; 33import android.graphics.PorterDuff; 34import android.graphics.PorterDuffXfermode; 35import android.graphics.Rect; 36import android.graphics.RectF; 37import android.graphics.Region; 38import android.graphics.Shader; 39import android.graphics.drawable.ColorDrawable; 40import android.graphics.drawable.Drawable; 41import android.os.Handler; 42import android.os.IBinder; 43import android.os.Message; 44import android.os.Parcel; 45import android.os.Parcelable; 46import android.os.RemoteException; 47import android.os.SystemClock; 48import android.text.TextUtils; 49import android.util.AttributeSet; 50import android.util.FloatProperty; 51import android.util.LocaleUtil; 52import android.util.Log; 53import android.util.Pool; 54import android.util.Poolable; 55import android.util.PoolableManager; 56import android.util.Pools; 57import android.util.Property; 58import android.util.SparseArray; 59import android.util.TypedValue; 60import android.view.ContextMenu.ContextMenuInfo; 61import android.view.accessibility.AccessibilityEvent; 62import android.view.accessibility.AccessibilityEventSource; 63import android.view.accessibility.AccessibilityManager; 64import android.view.accessibility.AccessibilityNodeInfo; 65import android.view.accessibility.AccessibilityNodeProvider; 66import android.view.animation.Animation; 67import android.view.animation.AnimationUtils; 68import android.view.inputmethod.EditorInfo; 69import android.view.inputmethod.InputConnection; 70import android.view.inputmethod.InputMethodManager; 71import android.widget.ScrollBarDrawable; 72 73import static android.os.Build.VERSION_CODES.*; 74 75import com.android.internal.R; 76import com.android.internal.util.Predicate; 77import com.android.internal.view.menu.MenuBuilder; 78 79import java.lang.ref.WeakReference; 80import java.lang.reflect.InvocationTargetException; 81import java.lang.reflect.Method; 82import java.util.ArrayList; 83import java.util.Arrays; 84import java.util.Locale; 85import java.util.concurrent.CopyOnWriteArrayList; 86 87/** 88 * <p> 89 * This class represents the basic building block for user interface components. A View 90 * occupies a rectangular area on the screen and is responsible for drawing and 91 * event handling. View is the base class for <em>widgets</em>, which are 92 * used to create interactive UI components (buttons, text fields, etc.). The 93 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which 94 * are invisible containers that hold other Views (or other ViewGroups) and define 95 * their layout properties. 96 * </p> 97 * 98 * <div class="special reference"> 99 * <h3>Developer Guides</h3> 100 * <p>For information about using this class to develop your application's user interface, 101 * read the <a href="{@docRoot}guide/topics/ui/index.html">User Interface</a> developer guide. 102 * </div> 103 * 104 * <a name="Using"></a> 105 * <h3>Using Views</h3> 106 * <p> 107 * All of the views in a window are arranged in a single tree. You can add views 108 * either from code or by specifying a tree of views in one or more XML layout 109 * files. There are many specialized subclasses of views that act as controls or 110 * are capable of displaying text, images, or other content. 111 * </p> 112 * <p> 113 * Once you have created a tree of views, there are typically a few types of 114 * common operations you may wish to perform: 115 * <ul> 116 * <li><strong>Set properties:</strong> for example setting the text of a 117 * {@link android.widget.TextView}. The available properties and the methods 118 * that set them will vary among the different subclasses of views. Note that 119 * properties that are known at build time can be set in the XML layout 120 * files.</li> 121 * <li><strong>Set focus:</strong> The framework will handled moving focus in 122 * response to user input. To force focus to a specific view, call 123 * {@link #requestFocus}.</li> 124 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners 125 * that will be notified when something interesting happens to the view. For 126 * example, all views will let you set a listener to be notified when the view 127 * gains or loses focus. You can register such a listener using 128 * {@link #setOnFocusChangeListener(android.view.View.OnFocusChangeListener)}. 129 * Other view subclasses offer more specialized listeners. For example, a Button 130 * exposes a listener to notify clients when the button is clicked.</li> 131 * <li><strong>Set visibility:</strong> You can hide or show views using 132 * {@link #setVisibility(int)}.</li> 133 * </ul> 134 * </p> 135 * <p><em> 136 * Note: The Android framework is responsible for measuring, laying out and 137 * drawing views. You should not call methods that perform these actions on 138 * views yourself unless you are actually implementing a 139 * {@link android.view.ViewGroup}. 140 * </em></p> 141 * 142 * <a name="Lifecycle"></a> 143 * <h3>Implementing a Custom View</h3> 144 * 145 * <p> 146 * To implement a custom view, you will usually begin by providing overrides for 147 * some of the standard methods that the framework calls on all views. You do 148 * not need to override all of these methods. In fact, you can start by just 149 * overriding {@link #onDraw(android.graphics.Canvas)}. 150 * <table border="2" width="85%" align="center" cellpadding="5"> 151 * <thead> 152 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr> 153 * </thead> 154 * 155 * <tbody> 156 * <tr> 157 * <td rowspan="2">Creation</td> 158 * <td>Constructors</td> 159 * <td>There is a form of the constructor that are called when the view 160 * is created from code and a form that is called when the view is 161 * inflated from a layout file. The second form should parse and apply 162 * any attributes defined in the layout file. 163 * </td> 164 * </tr> 165 * <tr> 166 * <td><code>{@link #onFinishInflate()}</code></td> 167 * <td>Called after a view and all of its children has been inflated 168 * from XML.</td> 169 * </tr> 170 * 171 * <tr> 172 * <td rowspan="3">Layout</td> 173 * <td><code>{@link #onMeasure(int, int)}</code></td> 174 * <td>Called to determine the size requirements for this view and all 175 * of its children. 176 * </td> 177 * </tr> 178 * <tr> 179 * <td><code>{@link #onLayout(boolean, int, int, int, int)}</code></td> 180 * <td>Called when this view should assign a size and position to all 181 * of its children. 182 * </td> 183 * </tr> 184 * <tr> 185 * <td><code>{@link #onSizeChanged(int, int, int, int)}</code></td> 186 * <td>Called when the size of this view has changed. 187 * </td> 188 * </tr> 189 * 190 * <tr> 191 * <td>Drawing</td> 192 * <td><code>{@link #onDraw(android.graphics.Canvas)}</code></td> 193 * <td>Called when the view should render its content. 194 * </td> 195 * </tr> 196 * 197 * <tr> 198 * <td rowspan="4">Event processing</td> 199 * <td><code>{@link #onKeyDown(int, KeyEvent)}</code></td> 200 * <td>Called when a new key event occurs. 201 * </td> 202 * </tr> 203 * <tr> 204 * <td><code>{@link #onKeyUp(int, KeyEvent)}</code></td> 205 * <td>Called when a key up event occurs. 206 * </td> 207 * </tr> 208 * <tr> 209 * <td><code>{@link #onTrackballEvent(MotionEvent)}</code></td> 210 * <td>Called when a trackball motion event occurs. 211 * </td> 212 * </tr> 213 * <tr> 214 * <td><code>{@link #onTouchEvent(MotionEvent)}</code></td> 215 * <td>Called when a touch screen motion event occurs. 216 * </td> 217 * </tr> 218 * 219 * <tr> 220 * <td rowspan="2">Focus</td> 221 * <td><code>{@link #onFocusChanged(boolean, int, android.graphics.Rect)}</code></td> 222 * <td>Called when the view gains or loses focus. 223 * </td> 224 * </tr> 225 * 226 * <tr> 227 * <td><code>{@link #onWindowFocusChanged(boolean)}</code></td> 228 * <td>Called when the window containing the view gains or loses focus. 229 * </td> 230 * </tr> 231 * 232 * <tr> 233 * <td rowspan="3">Attaching</td> 234 * <td><code>{@link #onAttachedToWindow()}</code></td> 235 * <td>Called when the view is attached to a window. 236 * </td> 237 * </tr> 238 * 239 * <tr> 240 * <td><code>{@link #onDetachedFromWindow}</code></td> 241 * <td>Called when the view is detached from its window. 242 * </td> 243 * </tr> 244 * 245 * <tr> 246 * <td><code>{@link #onWindowVisibilityChanged(int)}</code></td> 247 * <td>Called when the visibility of the window containing the view 248 * has changed. 249 * </td> 250 * </tr> 251 * </tbody> 252 * 253 * </table> 254 * </p> 255 * 256 * <a name="IDs"></a> 257 * <h3>IDs</h3> 258 * Views may have an integer id associated with them. These ids are typically 259 * assigned in the layout XML files, and are used to find specific views within 260 * the view tree. A common pattern is to: 261 * <ul> 262 * <li>Define a Button in the layout file and assign it a unique ID. 263 * <pre> 264 * <Button 265 * android:id="@+id/my_button" 266 * android:layout_width="wrap_content" 267 * android:layout_height="wrap_content" 268 * android:text="@string/my_button_text"/> 269 * </pre></li> 270 * <li>From the onCreate method of an Activity, find the Button 271 * <pre class="prettyprint"> 272 * Button myButton = (Button) findViewById(R.id.my_button); 273 * </pre></li> 274 * </ul> 275 * <p> 276 * View IDs need not be unique throughout the tree, but it is good practice to 277 * ensure that they are at least unique within the part of the tree you are 278 * searching. 279 * </p> 280 * 281 * <a name="Position"></a> 282 * <h3>Position</h3> 283 * <p> 284 * The geometry of a view is that of a rectangle. A view has a location, 285 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and 286 * two dimensions, expressed as a width and a height. The unit for location 287 * and dimensions is the pixel. 288 * </p> 289 * 290 * <p> 291 * It is possible to retrieve the location of a view by invoking the methods 292 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X, 293 * coordinate of the rectangle representing the view. The latter returns the 294 * top, or Y, coordinate of the rectangle representing the view. These methods 295 * both return the location of the view relative to its parent. For instance, 296 * when getLeft() returns 20, that means the view is located 20 pixels to the 297 * right of the left edge of its direct parent. 298 * </p> 299 * 300 * <p> 301 * In addition, several convenience methods are offered to avoid unnecessary 302 * computations, namely {@link #getRight()} and {@link #getBottom()}. 303 * These methods return the coordinates of the right and bottom edges of the 304 * rectangle representing the view. For instance, calling {@link #getRight()} 305 * is similar to the following computation: <code>getLeft() + getWidth()</code> 306 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.) 307 * </p> 308 * 309 * <a name="SizePaddingMargins"></a> 310 * <h3>Size, padding and margins</h3> 311 * <p> 312 * The size of a view is expressed with a width and a height. A view actually 313 * possess two pairs of width and height values. 314 * </p> 315 * 316 * <p> 317 * The first pair is known as <em>measured width</em> and 318 * <em>measured height</em>. These dimensions define how big a view wants to be 319 * within its parent (see <a href="#Layout">Layout</a> for more details.) The 320 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()} 321 * and {@link #getMeasuredHeight()}. 322 * </p> 323 * 324 * <p> 325 * The second pair is simply known as <em>width</em> and <em>height</em>, or 326 * sometimes <em>drawing width</em> and <em>drawing height</em>. These 327 * dimensions define the actual size of the view on screen, at drawing time and 328 * after layout. These values may, but do not have to, be different from the 329 * measured width and height. The width and height can be obtained by calling 330 * {@link #getWidth()} and {@link #getHeight()}. 331 * </p> 332 * 333 * <p> 334 * To measure its dimensions, a view takes into account its padding. The padding 335 * is expressed in pixels for the left, top, right and bottom parts of the view. 336 * Padding can be used to offset the content of the view by a specific amount of 337 * pixels. For instance, a left padding of 2 will push the view's content by 338 * 2 pixels to the right of the left edge. Padding can be set using the 339 * {@link #setPadding(int, int, int, int)} method and queried by calling 340 * {@link #getPaddingLeft()}, {@link #getPaddingTop()}, 341 * {@link #getPaddingRight()}, {@link #getPaddingBottom()}. 342 * </p> 343 * 344 * <p> 345 * Even though a view can define a padding, it does not provide any support for 346 * margins. However, view groups provide such a support. Refer to 347 * {@link android.view.ViewGroup} and 348 * {@link android.view.ViewGroup.MarginLayoutParams} for further information. 349 * </p> 350 * 351 * <a name="Layout"></a> 352 * <h3>Layout</h3> 353 * <p> 354 * Layout is a two pass process: a measure pass and a layout pass. The measuring 355 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal 356 * of the view tree. Each view pushes dimension specifications down the tree 357 * during the recursion. At the end of the measure pass, every view has stored 358 * its measurements. The second pass happens in 359 * {@link #layout(int,int,int,int)} and is also top-down. During 360 * this pass each parent is responsible for positioning all of its children 361 * using the sizes computed in the measure pass. 362 * </p> 363 * 364 * <p> 365 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and 366 * {@link #getMeasuredHeight()} values must be set, along with those for all of 367 * that view's descendants. A view's measured width and measured height values 368 * must respect the constraints imposed by the view's parents. This guarantees 369 * that at the end of the measure pass, all parents accept all of their 370 * children's measurements. A parent view may call measure() more than once on 371 * its children. For example, the parent may measure each child once with 372 * unspecified dimensions to find out how big they want to be, then call 373 * measure() on them again with actual numbers if the sum of all the children's 374 * unconstrained sizes is too big or too small. 375 * </p> 376 * 377 * <p> 378 * The measure pass uses two classes to communicate dimensions. The 379 * {@link MeasureSpec} class is used by views to tell their parents how they 380 * want to be measured and positioned. The base LayoutParams class just 381 * describes how big the view wants to be for both width and height. For each 382 * dimension, it can specify one of: 383 * <ul> 384 * <li> an exact number 385 * <li>MATCH_PARENT, which means the view wants to be as big as its parent 386 * (minus padding) 387 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to 388 * enclose its content (plus padding). 389 * </ul> 390 * There are subclasses of LayoutParams for different subclasses of ViewGroup. 391 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds 392 * an X and Y value. 393 * </p> 394 * 395 * <p> 396 * MeasureSpecs are used to push requirements down the tree from parent to 397 * child. A MeasureSpec can be in one of three modes: 398 * <ul> 399 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension 400 * of a child view. For example, a LinearLayout may call measure() on its child 401 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how 402 * tall the child view wants to be given a width of 240 pixels. 403 * <li>EXACTLY: This is used by the parent to impose an exact size on the 404 * child. The child must use this size, and guarantee that all of its 405 * descendants will fit within this size. 406 * <li>AT_MOST: This is used by the parent to impose a maximum size on the 407 * child. The child must gurantee that it and all of its descendants will fit 408 * within this size. 409 * </ul> 410 * </p> 411 * 412 * <p> 413 * To intiate a layout, call {@link #requestLayout}. This method is typically 414 * called by a view on itself when it believes that is can no longer fit within 415 * its current bounds. 416 * </p> 417 * 418 * <a name="Drawing"></a> 419 * <h3>Drawing</h3> 420 * <p> 421 * Drawing is handled by walking the tree and rendering each view that 422 * intersects the invalid region. Because the tree is traversed in-order, 423 * this means that parents will draw before (i.e., behind) their children, with 424 * siblings drawn in the order they appear in the tree. 425 * If you set a background drawable for a View, then the View will draw it for you 426 * before calling back to its <code>onDraw()</code> method. 427 * </p> 428 * 429 * <p> 430 * Note that the framework will not draw views that are not in the invalid region. 431 * </p> 432 * 433 * <p> 434 * To force a view to draw, call {@link #invalidate()}. 435 * </p> 436 * 437 * <a name="EventHandlingThreading"></a> 438 * <h3>Event Handling and Threading</h3> 439 * <p> 440 * The basic cycle of a view is as follows: 441 * <ol> 442 * <li>An event comes in and is dispatched to the appropriate view. The view 443 * handles the event and notifies any listeners.</li> 444 * <li>If in the course of processing the event, the view's bounds may need 445 * to be changed, the view will call {@link #requestLayout()}.</li> 446 * <li>Similarly, if in the course of processing the event the view's appearance 447 * may need to be changed, the view will call {@link #invalidate()}.</li> 448 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called, 449 * the framework will take care of measuring, laying out, and drawing the tree 450 * as appropriate.</li> 451 * </ol> 452 * </p> 453 * 454 * <p><em>Note: The entire view tree is single threaded. You must always be on 455 * the UI thread when calling any method on any view.</em> 456 * If you are doing work on other threads and want to update the state of a view 457 * from that thread, you should use a {@link Handler}. 458 * </p> 459 * 460 * <a name="FocusHandling"></a> 461 * <h3>Focus Handling</h3> 462 * <p> 463 * The framework will handle routine focus movement in response to user input. 464 * This includes changing the focus as views are removed or hidden, or as new 465 * views become available. Views indicate their willingness to take focus 466 * through the {@link #isFocusable} method. To change whether a view can take 467 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below) 468 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode} 469 * and can change this via {@link #setFocusableInTouchMode(boolean)}. 470 * </p> 471 * <p> 472 * Focus movement is based on an algorithm which finds the nearest neighbor in a 473 * given direction. In rare cases, the default algorithm may not match the 474 * intended behavior of the developer. In these situations, you can provide 475 * explicit overrides by using these XML attributes in the layout file: 476 * <pre> 477 * nextFocusDown 478 * nextFocusLeft 479 * nextFocusRight 480 * nextFocusUp 481 * </pre> 482 * </p> 483 * 484 * 485 * <p> 486 * To get a particular view to take focus, call {@link #requestFocus()}. 487 * </p> 488 * 489 * <a name="TouchMode"></a> 490 * <h3>Touch Mode</h3> 491 * <p> 492 * When a user is navigating a user interface via directional keys such as a D-pad, it is 493 * necessary to give focus to actionable items such as buttons so the user can see 494 * what will take input. If the device has touch capabilities, however, and the user 495 * begins interacting with the interface by touching it, it is no longer necessary to 496 * always highlight, or give focus to, a particular view. This motivates a mode 497 * for interaction named 'touch mode'. 498 * </p> 499 * <p> 500 * For a touch capable device, once the user touches the screen, the device 501 * will enter touch mode. From this point onward, only views for which 502 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets. 503 * Other views that are touchable, like buttons, will not take focus when touched; they will 504 * only fire the on click listeners. 505 * </p> 506 * <p> 507 * Any time a user hits a directional key, such as a D-pad direction, the view device will 508 * exit touch mode, and find a view to take focus, so that the user may resume interacting 509 * with the user interface without touching the screen again. 510 * </p> 511 * <p> 512 * The touch mode state is maintained across {@link android.app.Activity}s. Call 513 * {@link #isInTouchMode} to see whether the device is currently in touch mode. 514 * </p> 515 * 516 * <a name="Scrolling"></a> 517 * <h3>Scrolling</h3> 518 * <p> 519 * The framework provides basic support for views that wish to internally 520 * scroll their content. This includes keeping track of the X and Y scroll 521 * offset as well as mechanisms for drawing scrollbars. See 522 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and 523 * {@link #awakenScrollBars()} for more details. 524 * </p> 525 * 526 * <a name="Tags"></a> 527 * <h3>Tags</h3> 528 * <p> 529 * Unlike IDs, tags are not used to identify views. Tags are essentially an 530 * extra piece of information that can be associated with a view. They are most 531 * often used as a convenience to store data related to views in the views 532 * themselves rather than by putting them in a separate structure. 533 * </p> 534 * 535 * <a name="Animation"></a> 536 * <h3>Animation</h3> 537 * <p> 538 * You can attach an {@link Animation} object to a view using 539 * {@link #setAnimation(Animation)} or 540 * {@link #startAnimation(Animation)}. The animation can alter the scale, 541 * rotation, translation and alpha of a view over time. If the animation is 542 * attached to a view that has children, the animation will affect the entire 543 * subtree rooted by that node. When an animation is started, the framework will 544 * take care of redrawing the appropriate views until the animation completes. 545 * </p> 546 * <p> 547 * Starting with Android 3.0, the preferred way of animating views is to use the 548 * {@link android.animation} package APIs. 549 * </p> 550 * 551 * <a name="Security"></a> 552 * <h3>Security</h3> 553 * <p> 554 * Sometimes it is essential that an application be able to verify that an action 555 * is being performed with the full knowledge and consent of the user, such as 556 * granting a permission request, making a purchase or clicking on an advertisement. 557 * Unfortunately, a malicious application could try to spoof the user into 558 * performing these actions, unaware, by concealing the intended purpose of the view. 559 * As a remedy, the framework offers a touch filtering mechanism that can be used to 560 * improve the security of views that provide access to sensitive functionality. 561 * </p><p> 562 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the 563 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework 564 * will discard touches that are received whenever the view's window is obscured by 565 * another visible window. As a result, the view will not receive touches whenever a 566 * toast, dialog or other window appears above the view's window. 567 * </p><p> 568 * For more fine-grained control over security, consider overriding the 569 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own 570 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}. 571 * </p> 572 * 573 * @attr ref android.R.styleable#View_alpha 574 * @attr ref android.R.styleable#View_background 575 * @attr ref android.R.styleable#View_clickable 576 * @attr ref android.R.styleable#View_contentDescription 577 * @attr ref android.R.styleable#View_drawingCacheQuality 578 * @attr ref android.R.styleable#View_duplicateParentState 579 * @attr ref android.R.styleable#View_id 580 * @attr ref android.R.styleable#View_requiresFadingEdge 581 * @attr ref android.R.styleable#View_fadingEdgeLength 582 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 583 * @attr ref android.R.styleable#View_fitsSystemWindows 584 * @attr ref android.R.styleable#View_isScrollContainer 585 * @attr ref android.R.styleable#View_focusable 586 * @attr ref android.R.styleable#View_focusableInTouchMode 587 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 588 * @attr ref android.R.styleable#View_keepScreenOn 589 * @attr ref android.R.styleable#View_layerType 590 * @attr ref android.R.styleable#View_longClickable 591 * @attr ref android.R.styleable#View_minHeight 592 * @attr ref android.R.styleable#View_minWidth 593 * @attr ref android.R.styleable#View_nextFocusDown 594 * @attr ref android.R.styleable#View_nextFocusLeft 595 * @attr ref android.R.styleable#View_nextFocusRight 596 * @attr ref android.R.styleable#View_nextFocusUp 597 * @attr ref android.R.styleable#View_onClick 598 * @attr ref android.R.styleable#View_padding 599 * @attr ref android.R.styleable#View_paddingBottom 600 * @attr ref android.R.styleable#View_paddingLeft 601 * @attr ref android.R.styleable#View_paddingRight 602 * @attr ref android.R.styleable#View_paddingTop 603 * @attr ref android.R.styleable#View_saveEnabled 604 * @attr ref android.R.styleable#View_rotation 605 * @attr ref android.R.styleable#View_rotationX 606 * @attr ref android.R.styleable#View_rotationY 607 * @attr ref android.R.styleable#View_scaleX 608 * @attr ref android.R.styleable#View_scaleY 609 * @attr ref android.R.styleable#View_scrollX 610 * @attr ref android.R.styleable#View_scrollY 611 * @attr ref android.R.styleable#View_scrollbarSize 612 * @attr ref android.R.styleable#View_scrollbarStyle 613 * @attr ref android.R.styleable#View_scrollbars 614 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 615 * @attr ref android.R.styleable#View_scrollbarFadeDuration 616 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal 617 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal 618 * @attr ref android.R.styleable#View_scrollbarThumbVertical 619 * @attr ref android.R.styleable#View_scrollbarTrackVertical 620 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack 621 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack 622 * @attr ref android.R.styleable#View_soundEffectsEnabled 623 * @attr ref android.R.styleable#View_tag 624 * @attr ref android.R.styleable#View_transformPivotX 625 * @attr ref android.R.styleable#View_transformPivotY 626 * @attr ref android.R.styleable#View_translationX 627 * @attr ref android.R.styleable#View_translationY 628 * @attr ref android.R.styleable#View_visibility 629 * 630 * @see android.view.ViewGroup 631 */ 632public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Callback, 633 AccessibilityEventSource { 634 private static final boolean DBG = false; 635 636 /** 637 * The logging tag used by this class with android.util.Log. 638 */ 639 protected static final String VIEW_LOG_TAG = "View"; 640 641 /** 642 * Used to mark a View that has no ID. 643 */ 644 public static final int NO_ID = -1; 645 646 /** 647 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when 648 * calling setFlags. 649 */ 650 private static final int NOT_FOCUSABLE = 0x00000000; 651 652 /** 653 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling 654 * setFlags. 655 */ 656 private static final int FOCUSABLE = 0x00000001; 657 658 /** 659 * Mask for use with setFlags indicating bits used for focus. 660 */ 661 private static final int FOCUSABLE_MASK = 0x00000001; 662 663 /** 664 * This view will adjust its padding to fit sytem windows (e.g. status bar) 665 */ 666 private static final int FITS_SYSTEM_WINDOWS = 0x00000002; 667 668 /** 669 * This view is visible. 670 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 671 * android:visibility}. 672 */ 673 public static final int VISIBLE = 0x00000000; 674 675 /** 676 * This view is invisible, but it still takes up space for layout purposes. 677 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 678 * android:visibility}. 679 */ 680 public static final int INVISIBLE = 0x00000004; 681 682 /** 683 * This view is invisible, and it doesn't take any space for layout 684 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code 685 * android:visibility}. 686 */ 687 public static final int GONE = 0x00000008; 688 689 /** 690 * Mask for use with setFlags indicating bits used for visibility. 691 * {@hide} 692 */ 693 static final int VISIBILITY_MASK = 0x0000000C; 694 695 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE}; 696 697 /** 698 * This view is enabled. Intrepretation varies by subclass. 699 * Use with ENABLED_MASK when calling setFlags. 700 * {@hide} 701 */ 702 static final int ENABLED = 0x00000000; 703 704 /** 705 * This view is disabled. Intrepretation varies by subclass. 706 * Use with ENABLED_MASK when calling setFlags. 707 * {@hide} 708 */ 709 static final int DISABLED = 0x00000020; 710 711 /** 712 * Mask for use with setFlags indicating bits used for indicating whether 713 * this view is enabled 714 * {@hide} 715 */ 716 static final int ENABLED_MASK = 0x00000020; 717 718 /** 719 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be 720 * called and further optimizations will be performed. It is okay to have 721 * this flag set and a background. Use with DRAW_MASK when calling setFlags. 722 * {@hide} 723 */ 724 static final int WILL_NOT_DRAW = 0x00000080; 725 726 /** 727 * Mask for use with setFlags indicating bits used for indicating whether 728 * this view is will draw 729 * {@hide} 730 */ 731 static final int DRAW_MASK = 0x00000080; 732 733 /** 734 * <p>This view doesn't show scrollbars.</p> 735 * {@hide} 736 */ 737 static final int SCROLLBARS_NONE = 0x00000000; 738 739 /** 740 * <p>This view shows horizontal scrollbars.</p> 741 * {@hide} 742 */ 743 static final int SCROLLBARS_HORIZONTAL = 0x00000100; 744 745 /** 746 * <p>This view shows vertical scrollbars.</p> 747 * {@hide} 748 */ 749 static final int SCROLLBARS_VERTICAL = 0x00000200; 750 751 /** 752 * <p>Mask for use with setFlags indicating bits used for indicating which 753 * scrollbars are enabled.</p> 754 * {@hide} 755 */ 756 static final int SCROLLBARS_MASK = 0x00000300; 757 758 /** 759 * Indicates that the view should filter touches when its window is obscured. 760 * Refer to the class comments for more information about this security feature. 761 * {@hide} 762 */ 763 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400; 764 765 // note flag value 0x00000800 is now available for next flags... 766 767 /** 768 * <p>This view doesn't show fading edges.</p> 769 * {@hide} 770 */ 771 static final int FADING_EDGE_NONE = 0x00000000; 772 773 /** 774 * <p>This view shows horizontal fading edges.</p> 775 * {@hide} 776 */ 777 static final int FADING_EDGE_HORIZONTAL = 0x00001000; 778 779 /** 780 * <p>This view shows vertical fading edges.</p> 781 * {@hide} 782 */ 783 static final int FADING_EDGE_VERTICAL = 0x00002000; 784 785 /** 786 * <p>Mask for use with setFlags indicating bits used for indicating which 787 * fading edges are enabled.</p> 788 * {@hide} 789 */ 790 static final int FADING_EDGE_MASK = 0x00003000; 791 792 /** 793 * <p>Indicates this view can be clicked. When clickable, a View reacts 794 * to clicks by notifying the OnClickListener.<p> 795 * {@hide} 796 */ 797 static final int CLICKABLE = 0x00004000; 798 799 /** 800 * <p>Indicates this view is caching its drawing into a bitmap.</p> 801 * {@hide} 802 */ 803 static final int DRAWING_CACHE_ENABLED = 0x00008000; 804 805 /** 806 * <p>Indicates that no icicle should be saved for this view.<p> 807 * {@hide} 808 */ 809 static final int SAVE_DISABLED = 0x000010000; 810 811 /** 812 * <p>Mask for use with setFlags indicating bits used for the saveEnabled 813 * property.</p> 814 * {@hide} 815 */ 816 static final int SAVE_DISABLED_MASK = 0x000010000; 817 818 /** 819 * <p>Indicates that no drawing cache should ever be created for this view.<p> 820 * {@hide} 821 */ 822 static final int WILL_NOT_CACHE_DRAWING = 0x000020000; 823 824 /** 825 * <p>Indicates this view can take / keep focus when int touch mode.</p> 826 * {@hide} 827 */ 828 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000; 829 830 /** 831 * <p>Enables low quality mode for the drawing cache.</p> 832 */ 833 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000; 834 835 /** 836 * <p>Enables high quality mode for the drawing cache.</p> 837 */ 838 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000; 839 840 /** 841 * <p>Enables automatic quality mode for the drawing cache.</p> 842 */ 843 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000; 844 845 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = { 846 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH 847 }; 848 849 /** 850 * <p>Mask for use with setFlags indicating bits used for the cache 851 * quality property.</p> 852 * {@hide} 853 */ 854 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000; 855 856 /** 857 * <p> 858 * Indicates this view can be long clicked. When long clickable, a View 859 * reacts to long clicks by notifying the OnLongClickListener or showing a 860 * context menu. 861 * </p> 862 * {@hide} 863 */ 864 static final int LONG_CLICKABLE = 0x00200000; 865 866 /** 867 * <p>Indicates that this view gets its drawable states from its direct parent 868 * and ignores its original internal states.</p> 869 * 870 * @hide 871 */ 872 static final int DUPLICATE_PARENT_STATE = 0x00400000; 873 874 /** 875 * The scrollbar style to display the scrollbars inside the content area, 876 * without increasing the padding. The scrollbars will be overlaid with 877 * translucency on the view's content. 878 */ 879 public static final int SCROLLBARS_INSIDE_OVERLAY = 0; 880 881 /** 882 * The scrollbar style to display the scrollbars inside the padded area, 883 * increasing the padding of the view. The scrollbars will not overlap the 884 * content area of the view. 885 */ 886 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000; 887 888 /** 889 * The scrollbar style to display the scrollbars at the edge of the view, 890 * without increasing the padding. The scrollbars will be overlaid with 891 * translucency. 892 */ 893 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000; 894 895 /** 896 * The scrollbar style to display the scrollbars at the edge of the view, 897 * increasing the padding of the view. The scrollbars will only overlap the 898 * background, if any. 899 */ 900 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000; 901 902 /** 903 * Mask to check if the scrollbar style is overlay or inset. 904 * {@hide} 905 */ 906 static final int SCROLLBARS_INSET_MASK = 0x01000000; 907 908 /** 909 * Mask to check if the scrollbar style is inside or outside. 910 * {@hide} 911 */ 912 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000; 913 914 /** 915 * Mask for scrollbar style. 916 * {@hide} 917 */ 918 static final int SCROLLBARS_STYLE_MASK = 0x03000000; 919 920 /** 921 * View flag indicating that the screen should remain on while the 922 * window containing this view is visible to the user. This effectively 923 * takes care of automatically setting the WindowManager's 924 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}. 925 */ 926 public static final int KEEP_SCREEN_ON = 0x04000000; 927 928 /** 929 * View flag indicating whether this view should have sound effects enabled 930 * for events such as clicking and touching. 931 */ 932 public static final int SOUND_EFFECTS_ENABLED = 0x08000000; 933 934 /** 935 * View flag indicating whether this view should have haptic feedback 936 * enabled for events such as long presses. 937 */ 938 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000; 939 940 /** 941 * <p>Indicates that the view hierarchy should stop saving state when 942 * it reaches this view. If state saving is initiated immediately at 943 * the view, it will be allowed. 944 * {@hide} 945 */ 946 static final int PARENT_SAVE_DISABLED = 0x20000000; 947 948 /** 949 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p> 950 * {@hide} 951 */ 952 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000; 953 954 /** 955 * Horizontal direction of this view is from Left to Right. 956 * Use with {@link #setLayoutDirection}. 957 * {@hide} 958 */ 959 public static final int LAYOUT_DIRECTION_LTR = 0x00000000; 960 961 /** 962 * Horizontal direction of this view is from Right to Left. 963 * Use with {@link #setLayoutDirection}. 964 * {@hide} 965 */ 966 public static final int LAYOUT_DIRECTION_RTL = 0x40000000; 967 968 /** 969 * Horizontal direction of this view is inherited from its parent. 970 * Use with {@link #setLayoutDirection}. 971 * {@hide} 972 */ 973 public static final int LAYOUT_DIRECTION_INHERIT = 0x80000000; 974 975 /** 976 * Horizontal direction of this view is from deduced from the default language 977 * script for the locale. Use with {@link #setLayoutDirection}. 978 * {@hide} 979 */ 980 public static final int LAYOUT_DIRECTION_LOCALE = 0xC0000000; 981 982 /** 983 * Mask for use with setFlags indicating bits used for horizontalDirection. 984 * {@hide} 985 */ 986 static final int LAYOUT_DIRECTION_MASK = 0xC0000000; 987 988 /* 989 * Array of horizontal direction flags for mapping attribute "horizontalDirection" to correct 990 * flag value. 991 * {@hide} 992 */ 993 private static final int[] LAYOUT_DIRECTION_FLAGS = {LAYOUT_DIRECTION_LTR, 994 LAYOUT_DIRECTION_RTL, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE}; 995 996 /** 997 * Default horizontalDirection. 998 * {@hide} 999 */ 1000 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT; 1001 1002 /** 1003 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1004 * should add all focusable Views regardless if they are focusable in touch mode. 1005 */ 1006 public static final int FOCUSABLES_ALL = 0x00000000; 1007 1008 /** 1009 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 1010 * should add only Views focusable in touch mode. 1011 */ 1012 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001; 1013 1014 /** 1015 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable 1016 * item. 1017 */ 1018 public static final int FOCUS_BACKWARD = 0x00000001; 1019 1020 /** 1021 * Use with {@link #focusSearch(int)}. Move focus to the next selectable 1022 * item. 1023 */ 1024 public static final int FOCUS_FORWARD = 0x00000002; 1025 1026 /** 1027 * Use with {@link #focusSearch(int)}. Move focus to the left. 1028 */ 1029 public static final int FOCUS_LEFT = 0x00000011; 1030 1031 /** 1032 * Use with {@link #focusSearch(int)}. Move focus up. 1033 */ 1034 public static final int FOCUS_UP = 0x00000021; 1035 1036 /** 1037 * Use with {@link #focusSearch(int)}. Move focus to the right. 1038 */ 1039 public static final int FOCUS_RIGHT = 0x00000042; 1040 1041 /** 1042 * Use with {@link #focusSearch(int)}. Move focus down. 1043 */ 1044 public static final int FOCUS_DOWN = 0x00000082; 1045 1046 /** 1047 * Bits of {@link #getMeasuredWidthAndState()} and 1048 * {@link #getMeasuredWidthAndState()} that provide the actual measured size. 1049 */ 1050 public static final int MEASURED_SIZE_MASK = 0x00ffffff; 1051 1052 /** 1053 * Bits of {@link #getMeasuredWidthAndState()} and 1054 * {@link #getMeasuredWidthAndState()} that provide the additional state bits. 1055 */ 1056 public static final int MEASURED_STATE_MASK = 0xff000000; 1057 1058 /** 1059 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits 1060 * for functions that combine both width and height into a single int, 1061 * such as {@link #getMeasuredState()} and the childState argument of 1062 * {@link #resolveSizeAndState(int, int, int)}. 1063 */ 1064 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16; 1065 1066 /** 1067 * Bit of {@link #getMeasuredWidthAndState()} and 1068 * {@link #getMeasuredWidthAndState()} that indicates the measured size 1069 * is smaller that the space the view would like to have. 1070 */ 1071 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000; 1072 1073 /** 1074 * Base View state sets 1075 */ 1076 // Singles 1077 /** 1078 * Indicates the view has no states set. States are used with 1079 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1080 * view depending on its state. 1081 * 1082 * @see android.graphics.drawable.Drawable 1083 * @see #getDrawableState() 1084 */ 1085 protected static final int[] EMPTY_STATE_SET; 1086 /** 1087 * Indicates the view is enabled. States are used with 1088 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1089 * view depending on its state. 1090 * 1091 * @see android.graphics.drawable.Drawable 1092 * @see #getDrawableState() 1093 */ 1094 protected static final int[] ENABLED_STATE_SET; 1095 /** 1096 * Indicates the view is focused. States are used with 1097 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1098 * view depending on its state. 1099 * 1100 * @see android.graphics.drawable.Drawable 1101 * @see #getDrawableState() 1102 */ 1103 protected static final int[] FOCUSED_STATE_SET; 1104 /** 1105 * Indicates the view is selected. States are used with 1106 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1107 * view depending on its state. 1108 * 1109 * @see android.graphics.drawable.Drawable 1110 * @see #getDrawableState() 1111 */ 1112 protected static final int[] SELECTED_STATE_SET; 1113 /** 1114 * Indicates the view is pressed. States are used with 1115 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1116 * view depending on its state. 1117 * 1118 * @see android.graphics.drawable.Drawable 1119 * @see #getDrawableState() 1120 * @hide 1121 */ 1122 protected static final int[] PRESSED_STATE_SET; 1123 /** 1124 * Indicates the view's window has focus. States are used with 1125 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1126 * view depending on its state. 1127 * 1128 * @see android.graphics.drawable.Drawable 1129 * @see #getDrawableState() 1130 */ 1131 protected static final int[] WINDOW_FOCUSED_STATE_SET; 1132 // Doubles 1133 /** 1134 * Indicates the view is enabled and has the focus. 1135 * 1136 * @see #ENABLED_STATE_SET 1137 * @see #FOCUSED_STATE_SET 1138 */ 1139 protected static final int[] ENABLED_FOCUSED_STATE_SET; 1140 /** 1141 * Indicates the view is enabled and selected. 1142 * 1143 * @see #ENABLED_STATE_SET 1144 * @see #SELECTED_STATE_SET 1145 */ 1146 protected static final int[] ENABLED_SELECTED_STATE_SET; 1147 /** 1148 * Indicates the view is enabled and that its window has focus. 1149 * 1150 * @see #ENABLED_STATE_SET 1151 * @see #WINDOW_FOCUSED_STATE_SET 1152 */ 1153 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET; 1154 /** 1155 * Indicates the view is focused and selected. 1156 * 1157 * @see #FOCUSED_STATE_SET 1158 * @see #SELECTED_STATE_SET 1159 */ 1160 protected static final int[] FOCUSED_SELECTED_STATE_SET; 1161 /** 1162 * Indicates the view has the focus and that its window has the focus. 1163 * 1164 * @see #FOCUSED_STATE_SET 1165 * @see #WINDOW_FOCUSED_STATE_SET 1166 */ 1167 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET; 1168 /** 1169 * Indicates the view is selected and that its window has the focus. 1170 * 1171 * @see #SELECTED_STATE_SET 1172 * @see #WINDOW_FOCUSED_STATE_SET 1173 */ 1174 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET; 1175 // Triples 1176 /** 1177 * Indicates the view is enabled, focused and selected. 1178 * 1179 * @see #ENABLED_STATE_SET 1180 * @see #FOCUSED_STATE_SET 1181 * @see #SELECTED_STATE_SET 1182 */ 1183 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET; 1184 /** 1185 * Indicates the view is enabled, focused and its window has the focus. 1186 * 1187 * @see #ENABLED_STATE_SET 1188 * @see #FOCUSED_STATE_SET 1189 * @see #WINDOW_FOCUSED_STATE_SET 1190 */ 1191 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1192 /** 1193 * Indicates the view is enabled, selected and its window has the focus. 1194 * 1195 * @see #ENABLED_STATE_SET 1196 * @see #SELECTED_STATE_SET 1197 * @see #WINDOW_FOCUSED_STATE_SET 1198 */ 1199 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1200 /** 1201 * Indicates the view is focused, selected and its window has the focus. 1202 * 1203 * @see #FOCUSED_STATE_SET 1204 * @see #SELECTED_STATE_SET 1205 * @see #WINDOW_FOCUSED_STATE_SET 1206 */ 1207 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1208 /** 1209 * Indicates the view is enabled, focused, selected and its window 1210 * has the focus. 1211 * 1212 * @see #ENABLED_STATE_SET 1213 * @see #FOCUSED_STATE_SET 1214 * @see #SELECTED_STATE_SET 1215 * @see #WINDOW_FOCUSED_STATE_SET 1216 */ 1217 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1218 /** 1219 * Indicates the view is pressed and its window has the focus. 1220 * 1221 * @see #PRESSED_STATE_SET 1222 * @see #WINDOW_FOCUSED_STATE_SET 1223 */ 1224 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET; 1225 /** 1226 * Indicates the view is pressed and selected. 1227 * 1228 * @see #PRESSED_STATE_SET 1229 * @see #SELECTED_STATE_SET 1230 */ 1231 protected static final int[] PRESSED_SELECTED_STATE_SET; 1232 /** 1233 * Indicates the view is pressed, selected and its window has the focus. 1234 * 1235 * @see #PRESSED_STATE_SET 1236 * @see #SELECTED_STATE_SET 1237 * @see #WINDOW_FOCUSED_STATE_SET 1238 */ 1239 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1240 /** 1241 * Indicates the view is pressed and focused. 1242 * 1243 * @see #PRESSED_STATE_SET 1244 * @see #FOCUSED_STATE_SET 1245 */ 1246 protected static final int[] PRESSED_FOCUSED_STATE_SET; 1247 /** 1248 * Indicates the view is pressed, focused and its window has the focus. 1249 * 1250 * @see #PRESSED_STATE_SET 1251 * @see #FOCUSED_STATE_SET 1252 * @see #WINDOW_FOCUSED_STATE_SET 1253 */ 1254 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1255 /** 1256 * Indicates the view is pressed, focused and selected. 1257 * 1258 * @see #PRESSED_STATE_SET 1259 * @see #SELECTED_STATE_SET 1260 * @see #FOCUSED_STATE_SET 1261 */ 1262 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET; 1263 /** 1264 * Indicates the view is pressed, focused, selected and its window has the focus. 1265 * 1266 * @see #PRESSED_STATE_SET 1267 * @see #FOCUSED_STATE_SET 1268 * @see #SELECTED_STATE_SET 1269 * @see #WINDOW_FOCUSED_STATE_SET 1270 */ 1271 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1272 /** 1273 * Indicates the view is pressed and enabled. 1274 * 1275 * @see #PRESSED_STATE_SET 1276 * @see #ENABLED_STATE_SET 1277 */ 1278 protected static final int[] PRESSED_ENABLED_STATE_SET; 1279 /** 1280 * Indicates the view is pressed, enabled and its window has the focus. 1281 * 1282 * @see #PRESSED_STATE_SET 1283 * @see #ENABLED_STATE_SET 1284 * @see #WINDOW_FOCUSED_STATE_SET 1285 */ 1286 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET; 1287 /** 1288 * Indicates the view is pressed, enabled and selected. 1289 * 1290 * @see #PRESSED_STATE_SET 1291 * @see #ENABLED_STATE_SET 1292 * @see #SELECTED_STATE_SET 1293 */ 1294 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET; 1295 /** 1296 * Indicates the view is pressed, enabled, selected and its window has the 1297 * focus. 1298 * 1299 * @see #PRESSED_STATE_SET 1300 * @see #ENABLED_STATE_SET 1301 * @see #SELECTED_STATE_SET 1302 * @see #WINDOW_FOCUSED_STATE_SET 1303 */ 1304 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1305 /** 1306 * Indicates the view is pressed, enabled and focused. 1307 * 1308 * @see #PRESSED_STATE_SET 1309 * @see #ENABLED_STATE_SET 1310 * @see #FOCUSED_STATE_SET 1311 */ 1312 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET; 1313 /** 1314 * Indicates the view is pressed, enabled, focused and its window has the 1315 * focus. 1316 * 1317 * @see #PRESSED_STATE_SET 1318 * @see #ENABLED_STATE_SET 1319 * @see #FOCUSED_STATE_SET 1320 * @see #WINDOW_FOCUSED_STATE_SET 1321 */ 1322 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1323 /** 1324 * Indicates the view is pressed, enabled, focused and selected. 1325 * 1326 * @see #PRESSED_STATE_SET 1327 * @see #ENABLED_STATE_SET 1328 * @see #SELECTED_STATE_SET 1329 * @see #FOCUSED_STATE_SET 1330 */ 1331 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET; 1332 /** 1333 * Indicates the view is pressed, enabled, focused, selected and its window 1334 * has the focus. 1335 * 1336 * @see #PRESSED_STATE_SET 1337 * @see #ENABLED_STATE_SET 1338 * @see #SELECTED_STATE_SET 1339 * @see #FOCUSED_STATE_SET 1340 * @see #WINDOW_FOCUSED_STATE_SET 1341 */ 1342 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1343 1344 /** 1345 * The order here is very important to {@link #getDrawableState()} 1346 */ 1347 private static final int[][] VIEW_STATE_SETS; 1348 1349 static final int VIEW_STATE_WINDOW_FOCUSED = 1; 1350 static final int VIEW_STATE_SELECTED = 1 << 1; 1351 static final int VIEW_STATE_FOCUSED = 1 << 2; 1352 static final int VIEW_STATE_ENABLED = 1 << 3; 1353 static final int VIEW_STATE_PRESSED = 1 << 4; 1354 static final int VIEW_STATE_ACTIVATED = 1 << 5; 1355 static final int VIEW_STATE_ACCELERATED = 1 << 6; 1356 static final int VIEW_STATE_HOVERED = 1 << 7; 1357 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8; 1358 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9; 1359 1360 static final int[] VIEW_STATE_IDS = new int[] { 1361 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED, 1362 R.attr.state_selected, VIEW_STATE_SELECTED, 1363 R.attr.state_focused, VIEW_STATE_FOCUSED, 1364 R.attr.state_enabled, VIEW_STATE_ENABLED, 1365 R.attr.state_pressed, VIEW_STATE_PRESSED, 1366 R.attr.state_activated, VIEW_STATE_ACTIVATED, 1367 R.attr.state_accelerated, VIEW_STATE_ACCELERATED, 1368 R.attr.state_hovered, VIEW_STATE_HOVERED, 1369 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT, 1370 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED, 1371 }; 1372 1373 static { 1374 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) { 1375 throw new IllegalStateException( 1376 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array"); 1377 } 1378 int[] orderedIds = new int[VIEW_STATE_IDS.length]; 1379 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) { 1380 int viewState = R.styleable.ViewDrawableStates[i]; 1381 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) { 1382 if (VIEW_STATE_IDS[j] == viewState) { 1383 orderedIds[i * 2] = viewState; 1384 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1]; 1385 } 1386 } 1387 } 1388 final int NUM_BITS = VIEW_STATE_IDS.length / 2; 1389 VIEW_STATE_SETS = new int[1 << NUM_BITS][]; 1390 for (int i = 0; i < VIEW_STATE_SETS.length; i++) { 1391 int numBits = Integer.bitCount(i); 1392 int[] set = new int[numBits]; 1393 int pos = 0; 1394 for (int j = 0; j < orderedIds.length; j += 2) { 1395 if ((i & orderedIds[j+1]) != 0) { 1396 set[pos++] = orderedIds[j]; 1397 } 1398 } 1399 VIEW_STATE_SETS[i] = set; 1400 } 1401 1402 EMPTY_STATE_SET = VIEW_STATE_SETS[0]; 1403 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED]; 1404 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED]; 1405 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1406 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED]; 1407 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED]; 1408 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1409 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED]; 1410 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1411 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED]; 1412 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1413 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1414 | VIEW_STATE_FOCUSED]; 1415 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED]; 1416 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1417 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED]; 1418 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1419 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED]; 1420 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1421 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1422 | VIEW_STATE_ENABLED]; 1423 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1424 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED]; 1425 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1426 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1427 | VIEW_STATE_ENABLED]; 1428 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1429 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1430 | VIEW_STATE_ENABLED]; 1431 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1432 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1433 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED]; 1434 1435 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED]; 1436 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1437 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED]; 1438 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1439 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED]; 1440 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1441 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1442 | VIEW_STATE_PRESSED]; 1443 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1444 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1445 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1446 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1447 | VIEW_STATE_PRESSED]; 1448 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1449 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1450 | VIEW_STATE_PRESSED]; 1451 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1452 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1453 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1454 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[ 1455 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1456 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1457 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED 1458 | VIEW_STATE_PRESSED]; 1459 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1460 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED 1461 | VIEW_STATE_PRESSED]; 1462 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1463 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1464 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1465 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1466 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED 1467 | VIEW_STATE_PRESSED]; 1468 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1469 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1470 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1471 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1472 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1473 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1474 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1475 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1476 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED 1477 | VIEW_STATE_PRESSED]; 1478 } 1479 1480 /** 1481 * Accessibility event types that are dispatched for text population. 1482 */ 1483 private static final int POPULATING_ACCESSIBILITY_EVENT_TYPES = 1484 AccessibilityEvent.TYPE_VIEW_CLICKED 1485 | AccessibilityEvent.TYPE_VIEW_LONG_CLICKED 1486 | AccessibilityEvent.TYPE_VIEW_SELECTED 1487 | AccessibilityEvent.TYPE_VIEW_FOCUSED 1488 | AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED 1489 | AccessibilityEvent.TYPE_VIEW_HOVER_ENTER 1490 | AccessibilityEvent.TYPE_VIEW_HOVER_EXIT 1491 | AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED 1492 | AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED; 1493 1494 /** 1495 * Temporary Rect currently for use in setBackground(). This will probably 1496 * be extended in the future to hold our own class with more than just 1497 * a Rect. :) 1498 */ 1499 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>(); 1500 1501 /** 1502 * Map used to store views' tags. 1503 */ 1504 private SparseArray<Object> mKeyedTags; 1505 1506 /** 1507 * The next available accessiiblity id. 1508 */ 1509 private static int sNextAccessibilityViewId; 1510 1511 /** 1512 * The animation currently associated with this view. 1513 * @hide 1514 */ 1515 protected Animation mCurrentAnimation = null; 1516 1517 /** 1518 * Width as measured during measure pass. 1519 * {@hide} 1520 */ 1521 @ViewDebug.ExportedProperty(category = "measurement") 1522 int mMeasuredWidth; 1523 1524 /** 1525 * Height as measured during measure pass. 1526 * {@hide} 1527 */ 1528 @ViewDebug.ExportedProperty(category = "measurement") 1529 int mMeasuredHeight; 1530 1531 /** 1532 * Flag to indicate that this view was marked INVALIDATED, or had its display list 1533 * invalidated, prior to the current drawing iteration. If true, the view must re-draw 1534 * its display list. This flag, used only when hw accelerated, allows us to clear the 1535 * flag while retaining this information until it's needed (at getDisplayList() time and 1536 * in drawChild(), when we decide to draw a view's children's display lists into our own). 1537 * 1538 * {@hide} 1539 */ 1540 boolean mRecreateDisplayList = false; 1541 1542 /** 1543 * The view's identifier. 1544 * {@hide} 1545 * 1546 * @see #setId(int) 1547 * @see #getId() 1548 */ 1549 @ViewDebug.ExportedProperty(resolveId = true) 1550 int mID = NO_ID; 1551 1552 /** 1553 * The stable ID of this view for accessibility purposes. 1554 */ 1555 int mAccessibilityViewId = NO_ID; 1556 1557 /** 1558 * The view's tag. 1559 * {@hide} 1560 * 1561 * @see #setTag(Object) 1562 * @see #getTag() 1563 */ 1564 protected Object mTag; 1565 1566 // for mPrivateFlags: 1567 /** {@hide} */ 1568 static final int WANTS_FOCUS = 0x00000001; 1569 /** {@hide} */ 1570 static final int FOCUSED = 0x00000002; 1571 /** {@hide} */ 1572 static final int SELECTED = 0x00000004; 1573 /** {@hide} */ 1574 static final int IS_ROOT_NAMESPACE = 0x00000008; 1575 /** {@hide} */ 1576 static final int HAS_BOUNDS = 0x00000010; 1577 /** {@hide} */ 1578 static final int DRAWN = 0x00000020; 1579 /** 1580 * When this flag is set, this view is running an animation on behalf of its 1581 * children and should therefore not cancel invalidate requests, even if they 1582 * lie outside of this view's bounds. 1583 * 1584 * {@hide} 1585 */ 1586 static final int DRAW_ANIMATION = 0x00000040; 1587 /** {@hide} */ 1588 static final int SKIP_DRAW = 0x00000080; 1589 /** {@hide} */ 1590 static final int ONLY_DRAWS_BACKGROUND = 0x00000100; 1591 /** {@hide} */ 1592 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200; 1593 /** {@hide} */ 1594 static final int DRAWABLE_STATE_DIRTY = 0x00000400; 1595 /** {@hide} */ 1596 static final int MEASURED_DIMENSION_SET = 0x00000800; 1597 /** {@hide} */ 1598 static final int FORCE_LAYOUT = 0x00001000; 1599 /** {@hide} */ 1600 static final int LAYOUT_REQUIRED = 0x00002000; 1601 1602 private static final int PRESSED = 0x00004000; 1603 1604 /** {@hide} */ 1605 static final int DRAWING_CACHE_VALID = 0x00008000; 1606 /** 1607 * Flag used to indicate that this view should be drawn once more (and only once 1608 * more) after its animation has completed. 1609 * {@hide} 1610 */ 1611 static final int ANIMATION_STARTED = 0x00010000; 1612 1613 private static final int SAVE_STATE_CALLED = 0x00020000; 1614 1615 /** 1616 * Indicates that the View returned true when onSetAlpha() was called and that 1617 * the alpha must be restored. 1618 * {@hide} 1619 */ 1620 static final int ALPHA_SET = 0x00040000; 1621 1622 /** 1623 * Set by {@link #setScrollContainer(boolean)}. 1624 */ 1625 static final int SCROLL_CONTAINER = 0x00080000; 1626 1627 /** 1628 * Set by {@link #setScrollContainer(boolean)}. 1629 */ 1630 static final int SCROLL_CONTAINER_ADDED = 0x00100000; 1631 1632 /** 1633 * View flag indicating whether this view was invalidated (fully or partially.) 1634 * 1635 * @hide 1636 */ 1637 static final int DIRTY = 0x00200000; 1638 1639 /** 1640 * View flag indicating whether this view was invalidated by an opaque 1641 * invalidate request. 1642 * 1643 * @hide 1644 */ 1645 static final int DIRTY_OPAQUE = 0x00400000; 1646 1647 /** 1648 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}. 1649 * 1650 * @hide 1651 */ 1652 static final int DIRTY_MASK = 0x00600000; 1653 1654 /** 1655 * Indicates whether the background is opaque. 1656 * 1657 * @hide 1658 */ 1659 static final int OPAQUE_BACKGROUND = 0x00800000; 1660 1661 /** 1662 * Indicates whether the scrollbars are opaque. 1663 * 1664 * @hide 1665 */ 1666 static final int OPAQUE_SCROLLBARS = 0x01000000; 1667 1668 /** 1669 * Indicates whether the view is opaque. 1670 * 1671 * @hide 1672 */ 1673 static final int OPAQUE_MASK = 0x01800000; 1674 1675 /** 1676 * Indicates a prepressed state; 1677 * the short time between ACTION_DOWN and recognizing 1678 * a 'real' press. Prepressed is used to recognize quick taps 1679 * even when they are shorter than ViewConfiguration.getTapTimeout(). 1680 * 1681 * @hide 1682 */ 1683 private static final int PREPRESSED = 0x02000000; 1684 1685 /** 1686 * Indicates whether the view is temporarily detached. 1687 * 1688 * @hide 1689 */ 1690 static final int CANCEL_NEXT_UP_EVENT = 0x04000000; 1691 1692 /** 1693 * Indicates that we should awaken scroll bars once attached 1694 * 1695 * @hide 1696 */ 1697 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000; 1698 1699 /** 1700 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT. 1701 * @hide 1702 */ 1703 private static final int HOVERED = 0x10000000; 1704 1705 /** 1706 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center 1707 * for transform operations 1708 * 1709 * @hide 1710 */ 1711 private static final int PIVOT_EXPLICITLY_SET = 0x20000000; 1712 1713 /** {@hide} */ 1714 static final int ACTIVATED = 0x40000000; 1715 1716 /** 1717 * Indicates that this view was specifically invalidated, not just dirtied because some 1718 * child view was invalidated. The flag is used to determine when we need to recreate 1719 * a view's display list (as opposed to just returning a reference to its existing 1720 * display list). 1721 * 1722 * @hide 1723 */ 1724 static final int INVALIDATED = 0x80000000; 1725 1726 /* Masks for mPrivateFlags2 */ 1727 1728 /** 1729 * Indicates that this view has reported that it can accept the current drag's content. 1730 * Cleared when the drag operation concludes. 1731 * @hide 1732 */ 1733 static final int DRAG_CAN_ACCEPT = 0x00000001; 1734 1735 /** 1736 * Indicates that this view is currently directly under the drag location in a 1737 * drag-and-drop operation involving content that it can accept. Cleared when 1738 * the drag exits the view, or when the drag operation concludes. 1739 * @hide 1740 */ 1741 static final int DRAG_HOVERED = 0x00000002; 1742 1743 /** 1744 * Indicates whether the view layout direction has been resolved and drawn to the 1745 * right-to-left direction. 1746 * 1747 * @hide 1748 */ 1749 static final int LAYOUT_DIRECTION_RESOLVED_RTL = 0x00000004; 1750 1751 /** 1752 * Indicates whether the view layout direction has been resolved. 1753 * 1754 * @hide 1755 */ 1756 static final int LAYOUT_DIRECTION_RESOLVED = 0x00000008; 1757 1758 1759 /* End of masks for mPrivateFlags2 */ 1760 1761 static final int DRAG_MASK = DRAG_CAN_ACCEPT | DRAG_HOVERED; 1762 1763 /** 1764 * Always allow a user to over-scroll this view, provided it is a 1765 * view that can scroll. 1766 * 1767 * @see #getOverScrollMode() 1768 * @see #setOverScrollMode(int) 1769 */ 1770 public static final int OVER_SCROLL_ALWAYS = 0; 1771 1772 /** 1773 * Allow a user to over-scroll this view only if the content is large 1774 * enough to meaningfully scroll, provided it is a view that can scroll. 1775 * 1776 * @see #getOverScrollMode() 1777 * @see #setOverScrollMode(int) 1778 */ 1779 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1; 1780 1781 /** 1782 * Never allow a user to over-scroll this view. 1783 * 1784 * @see #getOverScrollMode() 1785 * @see #setOverScrollMode(int) 1786 */ 1787 public static final int OVER_SCROLL_NEVER = 2; 1788 1789 /** 1790 * View has requested the system UI (status bar) to be visible (the default). 1791 * 1792 * @see #setSystemUiVisibility(int) 1793 */ 1794 public static final int SYSTEM_UI_FLAG_VISIBLE = 0; 1795 1796 /** 1797 * View has requested the system UI to enter an unobtrusive "low profile" mode. 1798 * 1799 * This is for use in games, book readers, video players, or any other "immersive" application 1800 * where the usual system chrome is deemed too distracting. 1801 * 1802 * In low profile mode, the status bar and/or navigation icons may dim. 1803 * 1804 * @see #setSystemUiVisibility(int) 1805 */ 1806 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001; 1807 1808 /** 1809 * View has requested that the system navigation be temporarily hidden. 1810 * 1811 * This is an even less obtrusive state than that called for by 1812 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls 1813 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause 1814 * those to disappear. This is useful (in conjunction with the 1815 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and 1816 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN} 1817 * window flags) for displaying content using every last pixel on the display. 1818 * 1819 * There is a limitation: because navigation controls are so important, the least user 1820 * interaction will cause them to reappear immediately. 1821 * 1822 * @see #setSystemUiVisibility(int) 1823 */ 1824 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002; 1825 1826 /** 1827 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead. 1828 */ 1829 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE; 1830 1831 /** 1832 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead. 1833 */ 1834 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE; 1835 1836 /** 1837 * @hide 1838 * 1839 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1840 * out of the public fields to keep the undefined bits out of the developer's way. 1841 * 1842 * Flag to make the status bar not expandable. Unless you also 1843 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show. 1844 */ 1845 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000; 1846 1847 /** 1848 * @hide 1849 * 1850 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1851 * out of the public fields to keep the undefined bits out of the developer's way. 1852 * 1853 * Flag to hide notification icons and scrolling ticker text. 1854 */ 1855 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000; 1856 1857 /** 1858 * @hide 1859 * 1860 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1861 * out of the public fields to keep the undefined bits out of the developer's way. 1862 * 1863 * Flag to disable incoming notification alerts. This will not block 1864 * icons, but it will block sound, vibrating and other visual or aural notifications. 1865 */ 1866 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000; 1867 1868 /** 1869 * @hide 1870 * 1871 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1872 * out of the public fields to keep the undefined bits out of the developer's way. 1873 * 1874 * Flag to hide only the scrolling ticker. Note that 1875 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies 1876 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}. 1877 */ 1878 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000; 1879 1880 /** 1881 * @hide 1882 * 1883 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1884 * out of the public fields to keep the undefined bits out of the developer's way. 1885 * 1886 * Flag to hide the center system info area. 1887 */ 1888 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000; 1889 1890 /** 1891 * @hide 1892 * 1893 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1894 * out of the public fields to keep the undefined bits out of the developer's way. 1895 * 1896 * Flag to hide only the home button. Don't use this 1897 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 1898 */ 1899 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000; 1900 1901 /** 1902 * @hide 1903 * 1904 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1905 * out of the public fields to keep the undefined bits out of the developer's way. 1906 * 1907 * Flag to hide only the back button. Don't use this 1908 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 1909 */ 1910 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000; 1911 1912 /** 1913 * @hide 1914 * 1915 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1916 * out of the public fields to keep the undefined bits out of the developer's way. 1917 * 1918 * Flag to hide only the clock. You might use this if your activity has 1919 * its own clock making the status bar's clock redundant. 1920 */ 1921 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000; 1922 1923 /** 1924 * @hide 1925 * 1926 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked 1927 * out of the public fields to keep the undefined bits out of the developer's way. 1928 * 1929 * Flag to hide only the recent apps button. Don't use this 1930 * unless you're a special part of the system UI (i.e., setup wizard, keyguard). 1931 */ 1932 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000; 1933 1934 /** 1935 * @hide 1936 * 1937 * NOTE: This flag may only be used in subtreeSystemUiVisibility, etc. etc. 1938 * 1939 * This hides HOME and RECENT and is provided for compatibility with interim implementations. 1940 */ 1941 @Deprecated 1942 public static final int STATUS_BAR_DISABLE_NAVIGATION = 1943 STATUS_BAR_DISABLE_HOME | STATUS_BAR_DISABLE_RECENT; 1944 1945 /** 1946 * @hide 1947 */ 1948 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF; 1949 1950 /** 1951 * These are the system UI flags that can be cleared by events outside 1952 * of an application. Currently this is just the ability to tap on the 1953 * screen while hiding the navigation bar to have it return. 1954 * @hide 1955 */ 1956 public static final int SYSTEM_UI_CLEARABLE_FLAGS = 1957 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION; 1958 1959 /** 1960 * Find views that render the specified text. 1961 * 1962 * @see #findViewsWithText(ArrayList, CharSequence, int) 1963 */ 1964 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001; 1965 1966 /** 1967 * Find find views that contain the specified content description. 1968 * 1969 * @see #findViewsWithText(ArrayList, CharSequence, int) 1970 */ 1971 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002; 1972 1973 /** 1974 * Find views that contain {@link AccessibilityNodeProvider}. Such 1975 * a View is a root of virtual view hierarchy and may contain the searched 1976 * text. If this flag is set Views with providers are automatically 1977 * added and it is a responsibility of the client to call the APIs of 1978 * the provider to determine whether the virtual tree rooted at this View 1979 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s 1980 * represeting the virtual views with this text. 1981 * 1982 * @see #findViewsWithText(ArrayList, CharSequence, int) 1983 * 1984 * @hide 1985 */ 1986 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004; 1987 1988 /** 1989 * Controls the over-scroll mode for this view. 1990 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)}, 1991 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}, 1992 * and {@link #OVER_SCROLL_NEVER}. 1993 */ 1994 private int mOverScrollMode; 1995 1996 /** 1997 * The parent this view is attached to. 1998 * {@hide} 1999 * 2000 * @see #getParent() 2001 */ 2002 protected ViewParent mParent; 2003 2004 /** 2005 * {@hide} 2006 */ 2007 AttachInfo mAttachInfo; 2008 2009 /** 2010 * {@hide} 2011 */ 2012 @ViewDebug.ExportedProperty(flagMapping = { 2013 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT, 2014 name = "FORCE_LAYOUT"), 2015 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED, 2016 name = "LAYOUT_REQUIRED"), 2017 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID, 2018 name = "DRAWING_CACHE_INVALID", outputIf = false), 2019 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true), 2020 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false), 2021 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"), 2022 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY") 2023 }) 2024 int mPrivateFlags; 2025 int mPrivateFlags2; 2026 2027 /** 2028 * This view's request for the visibility of the status bar. 2029 * @hide 2030 */ 2031 @ViewDebug.ExportedProperty(flagMapping = { 2032 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE, 2033 equals = SYSTEM_UI_FLAG_LOW_PROFILE, 2034 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true), 2035 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2036 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION, 2037 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true), 2038 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK, 2039 equals = SYSTEM_UI_FLAG_VISIBLE, 2040 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true) 2041 }) 2042 int mSystemUiVisibility; 2043 2044 /** 2045 * Count of how many windows this view has been attached to. 2046 */ 2047 int mWindowAttachCount; 2048 2049 /** 2050 * The layout parameters associated with this view and used by the parent 2051 * {@link android.view.ViewGroup} to determine how this view should be 2052 * laid out. 2053 * {@hide} 2054 */ 2055 protected ViewGroup.LayoutParams mLayoutParams; 2056 2057 /** 2058 * The view flags hold various views states. 2059 * {@hide} 2060 */ 2061 @ViewDebug.ExportedProperty 2062 int mViewFlags; 2063 2064 static class TransformationInfo { 2065 /** 2066 * The transform matrix for the View. This transform is calculated internally 2067 * based on the rotation, scaleX, and scaleY properties. The identity matrix 2068 * is used by default. Do *not* use this variable directly; instead call 2069 * getMatrix(), which will automatically recalculate the matrix if necessary 2070 * to get the correct matrix based on the latest rotation and scale properties. 2071 */ 2072 private final Matrix mMatrix = new Matrix(); 2073 2074 /** 2075 * The transform matrix for the View. This transform is calculated internally 2076 * based on the rotation, scaleX, and scaleY properties. The identity matrix 2077 * is used by default. Do *not* use this variable directly; instead call 2078 * getInverseMatrix(), which will automatically recalculate the matrix if necessary 2079 * to get the correct matrix based on the latest rotation and scale properties. 2080 */ 2081 private Matrix mInverseMatrix; 2082 2083 /** 2084 * An internal variable that tracks whether we need to recalculate the 2085 * transform matrix, based on whether the rotation or scaleX/Y properties 2086 * have changed since the matrix was last calculated. 2087 */ 2088 boolean mMatrixDirty = false; 2089 2090 /** 2091 * An internal variable that tracks whether we need to recalculate the 2092 * transform matrix, based on whether the rotation or scaleX/Y properties 2093 * have changed since the matrix was last calculated. 2094 */ 2095 private boolean mInverseMatrixDirty = true; 2096 2097 /** 2098 * A variable that tracks whether we need to recalculate the 2099 * transform matrix, based on whether the rotation or scaleX/Y properties 2100 * have changed since the matrix was last calculated. This variable 2101 * is only valid after a call to updateMatrix() or to a function that 2102 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix(). 2103 */ 2104 private boolean mMatrixIsIdentity = true; 2105 2106 /** 2107 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set. 2108 */ 2109 private Camera mCamera = null; 2110 2111 /** 2112 * This matrix is used when computing the matrix for 3D rotations. 2113 */ 2114 private Matrix matrix3D = null; 2115 2116 /** 2117 * These prev values are used to recalculate a centered pivot point when necessary. The 2118 * pivot point is only used in matrix operations (when rotation, scale, or translation are 2119 * set), so thes values are only used then as well. 2120 */ 2121 private int mPrevWidth = -1; 2122 private int mPrevHeight = -1; 2123 2124 /** 2125 * The degrees rotation around the vertical axis through the pivot point. 2126 */ 2127 @ViewDebug.ExportedProperty 2128 float mRotationY = 0f; 2129 2130 /** 2131 * The degrees rotation around the horizontal axis through the pivot point. 2132 */ 2133 @ViewDebug.ExportedProperty 2134 float mRotationX = 0f; 2135 2136 /** 2137 * The degrees rotation around the pivot point. 2138 */ 2139 @ViewDebug.ExportedProperty 2140 float mRotation = 0f; 2141 2142 /** 2143 * The amount of translation of the object away from its left property (post-layout). 2144 */ 2145 @ViewDebug.ExportedProperty 2146 float mTranslationX = 0f; 2147 2148 /** 2149 * The amount of translation of the object away from its top property (post-layout). 2150 */ 2151 @ViewDebug.ExportedProperty 2152 float mTranslationY = 0f; 2153 2154 /** 2155 * The amount of scale in the x direction around the pivot point. A 2156 * value of 1 means no scaling is applied. 2157 */ 2158 @ViewDebug.ExportedProperty 2159 float mScaleX = 1f; 2160 2161 /** 2162 * The amount of scale in the y direction around the pivot point. A 2163 * value of 1 means no scaling is applied. 2164 */ 2165 @ViewDebug.ExportedProperty 2166 float mScaleY = 1f; 2167 2168 /** 2169 * The amount of scale in the x direction around the pivot point. A 2170 * value of 1 means no scaling is applied. 2171 */ 2172 @ViewDebug.ExportedProperty 2173 float mPivotX = 0f; 2174 2175 /** 2176 * The amount of scale in the y direction around the pivot point. A 2177 * value of 1 means no scaling is applied. 2178 */ 2179 @ViewDebug.ExportedProperty 2180 float mPivotY = 0f; 2181 2182 /** 2183 * The opacity of the View. This is a value from 0 to 1, where 0 means 2184 * completely transparent and 1 means completely opaque. 2185 */ 2186 @ViewDebug.ExportedProperty 2187 float mAlpha = 1f; 2188 } 2189 2190 TransformationInfo mTransformationInfo; 2191 2192 private boolean mLastIsOpaque; 2193 2194 /** 2195 * Convenience value to check for float values that are close enough to zero to be considered 2196 * zero. 2197 */ 2198 private static final float NONZERO_EPSILON = .001f; 2199 2200 /** 2201 * The distance in pixels from the left edge of this view's parent 2202 * to the left edge of this view. 2203 * {@hide} 2204 */ 2205 @ViewDebug.ExportedProperty(category = "layout") 2206 protected int mLeft; 2207 /** 2208 * The distance in pixels from the left edge of this view's parent 2209 * to the right edge of this view. 2210 * {@hide} 2211 */ 2212 @ViewDebug.ExportedProperty(category = "layout") 2213 protected int mRight; 2214 /** 2215 * The distance in pixels from the top edge of this view's parent 2216 * to the top edge of this view. 2217 * {@hide} 2218 */ 2219 @ViewDebug.ExportedProperty(category = "layout") 2220 protected int mTop; 2221 /** 2222 * The distance in pixels from the top edge of this view's parent 2223 * to the bottom edge of this view. 2224 * {@hide} 2225 */ 2226 @ViewDebug.ExportedProperty(category = "layout") 2227 protected int mBottom; 2228 2229 /** 2230 * The offset, in pixels, by which the content of this view is scrolled 2231 * horizontally. 2232 * {@hide} 2233 */ 2234 @ViewDebug.ExportedProperty(category = "scrolling") 2235 protected int mScrollX; 2236 /** 2237 * The offset, in pixels, by which the content of this view is scrolled 2238 * vertically. 2239 * {@hide} 2240 */ 2241 @ViewDebug.ExportedProperty(category = "scrolling") 2242 protected int mScrollY; 2243 2244 /** 2245 * The left padding in pixels, that is the distance in pixels between the 2246 * left edge of this view and the left edge of its content. 2247 * {@hide} 2248 */ 2249 @ViewDebug.ExportedProperty(category = "padding") 2250 protected int mPaddingLeft; 2251 /** 2252 * The right padding in pixels, that is the distance in pixels between the 2253 * right edge of this view and the right edge of its content. 2254 * {@hide} 2255 */ 2256 @ViewDebug.ExportedProperty(category = "padding") 2257 protected int mPaddingRight; 2258 /** 2259 * The top padding in pixels, that is the distance in pixels between the 2260 * top edge of this view and the top edge of its content. 2261 * {@hide} 2262 */ 2263 @ViewDebug.ExportedProperty(category = "padding") 2264 protected int mPaddingTop; 2265 /** 2266 * The bottom padding in pixels, that is the distance in pixels between the 2267 * bottom edge of this view and the bottom edge of its content. 2268 * {@hide} 2269 */ 2270 @ViewDebug.ExportedProperty(category = "padding") 2271 protected int mPaddingBottom; 2272 2273 /** 2274 * Briefly describes the view and is primarily used for accessibility support. 2275 */ 2276 private CharSequence mContentDescription; 2277 2278 /** 2279 * Cache the paddingRight set by the user to append to the scrollbar's size. 2280 * 2281 * @hide 2282 */ 2283 @ViewDebug.ExportedProperty(category = "padding") 2284 protected int mUserPaddingRight; 2285 2286 /** 2287 * Cache the paddingBottom set by the user to append to the scrollbar's size. 2288 * 2289 * @hide 2290 */ 2291 @ViewDebug.ExportedProperty(category = "padding") 2292 protected int mUserPaddingBottom; 2293 2294 /** 2295 * Cache the paddingLeft set by the user to append to the scrollbar's size. 2296 * 2297 * @hide 2298 */ 2299 @ViewDebug.ExportedProperty(category = "padding") 2300 protected int mUserPaddingLeft; 2301 2302 /** 2303 * Cache if the user padding is relative. 2304 * 2305 */ 2306 @ViewDebug.ExportedProperty(category = "padding") 2307 boolean mUserPaddingRelative; 2308 2309 /** 2310 * Cache the paddingStart set by the user to append to the scrollbar's size. 2311 * 2312 */ 2313 @ViewDebug.ExportedProperty(category = "padding") 2314 int mUserPaddingStart; 2315 2316 /** 2317 * Cache the paddingEnd set by the user to append to the scrollbar's size. 2318 * 2319 */ 2320 @ViewDebug.ExportedProperty(category = "padding") 2321 int mUserPaddingEnd; 2322 2323 /** 2324 * @hide 2325 */ 2326 int mOldWidthMeasureSpec = Integer.MIN_VALUE; 2327 /** 2328 * @hide 2329 */ 2330 int mOldHeightMeasureSpec = Integer.MIN_VALUE; 2331 2332 private Drawable mBGDrawable; 2333 2334 private int mBackgroundResource; 2335 private boolean mBackgroundSizeChanged; 2336 2337 static class ListenerInfo { 2338 /** 2339 * Listener used to dispatch focus change events. 2340 * This field should be made private, so it is hidden from the SDK. 2341 * {@hide} 2342 */ 2343 protected OnFocusChangeListener mOnFocusChangeListener; 2344 2345 /** 2346 * Listeners for layout change events. 2347 */ 2348 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners; 2349 2350 /** 2351 * Listeners for attach events. 2352 */ 2353 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners; 2354 2355 /** 2356 * Listener used to dispatch click events. 2357 * This field should be made private, so it is hidden from the SDK. 2358 * {@hide} 2359 */ 2360 public OnClickListener mOnClickListener; 2361 2362 /** 2363 * Listener used to dispatch long click events. 2364 * This field should be made private, so it is hidden from the SDK. 2365 * {@hide} 2366 */ 2367 protected OnLongClickListener mOnLongClickListener; 2368 2369 /** 2370 * Listener used to build the context menu. 2371 * This field should be made private, so it is hidden from the SDK. 2372 * {@hide} 2373 */ 2374 protected OnCreateContextMenuListener mOnCreateContextMenuListener; 2375 2376 private OnKeyListener mOnKeyListener; 2377 2378 private OnTouchListener mOnTouchListener; 2379 2380 private OnHoverListener mOnHoverListener; 2381 2382 private OnGenericMotionListener mOnGenericMotionListener; 2383 2384 private OnDragListener mOnDragListener; 2385 2386 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener; 2387 } 2388 2389 ListenerInfo mListenerInfo; 2390 2391 /** 2392 * The application environment this view lives in. 2393 * This field should be made private, so it is hidden from the SDK. 2394 * {@hide} 2395 */ 2396 protected Context mContext; 2397 2398 private final Resources mResources; 2399 2400 private ScrollabilityCache mScrollCache; 2401 2402 private int[] mDrawableState = null; 2403 2404 /** 2405 * Set to true when drawing cache is enabled and cannot be created. 2406 * 2407 * @hide 2408 */ 2409 public boolean mCachingFailed; 2410 2411 private Bitmap mDrawingCache; 2412 private Bitmap mUnscaledDrawingCache; 2413 private HardwareLayer mHardwareLayer; 2414 DisplayList mDisplayList; 2415 2416 /** 2417 * When this view has focus and the next focus is {@link #FOCUS_LEFT}, 2418 * the user may specify which view to go to next. 2419 */ 2420 private int mNextFocusLeftId = View.NO_ID; 2421 2422 /** 2423 * When this view has focus and the next focus is {@link #FOCUS_RIGHT}, 2424 * the user may specify which view to go to next. 2425 */ 2426 private int mNextFocusRightId = View.NO_ID; 2427 2428 /** 2429 * When this view has focus and the next focus is {@link #FOCUS_UP}, 2430 * the user may specify which view to go to next. 2431 */ 2432 private int mNextFocusUpId = View.NO_ID; 2433 2434 /** 2435 * When this view has focus and the next focus is {@link #FOCUS_DOWN}, 2436 * the user may specify which view to go to next. 2437 */ 2438 private int mNextFocusDownId = View.NO_ID; 2439 2440 /** 2441 * When this view has focus and the next focus is {@link #FOCUS_FORWARD}, 2442 * the user may specify which view to go to next. 2443 */ 2444 int mNextFocusForwardId = View.NO_ID; 2445 2446 private CheckForLongPress mPendingCheckForLongPress; 2447 private CheckForTap mPendingCheckForTap = null; 2448 private PerformClick mPerformClick; 2449 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent; 2450 2451 private UnsetPressedState mUnsetPressedState; 2452 2453 /** 2454 * Whether the long press's action has been invoked. The tap's action is invoked on the 2455 * up event while a long press is invoked as soon as the long press duration is reached, so 2456 * a long press could be performed before the tap is checked, in which case the tap's action 2457 * should not be invoked. 2458 */ 2459 private boolean mHasPerformedLongPress; 2460 2461 /** 2462 * The minimum height of the view. We'll try our best to have the height 2463 * of this view to at least this amount. 2464 */ 2465 @ViewDebug.ExportedProperty(category = "measurement") 2466 private int mMinHeight; 2467 2468 /** 2469 * The minimum width of the view. We'll try our best to have the width 2470 * of this view to at least this amount. 2471 */ 2472 @ViewDebug.ExportedProperty(category = "measurement") 2473 private int mMinWidth; 2474 2475 /** 2476 * The delegate to handle touch events that are physically in this view 2477 * but should be handled by another view. 2478 */ 2479 private TouchDelegate mTouchDelegate = null; 2480 2481 /** 2482 * Solid color to use as a background when creating the drawing cache. Enables 2483 * the cache to use 16 bit bitmaps instead of 32 bit. 2484 */ 2485 private int mDrawingCacheBackgroundColor = 0; 2486 2487 /** 2488 * Special tree observer used when mAttachInfo is null. 2489 */ 2490 private ViewTreeObserver mFloatingTreeObserver; 2491 2492 /** 2493 * Cache the touch slop from the context that created the view. 2494 */ 2495 private int mTouchSlop; 2496 2497 /** 2498 * Object that handles automatic animation of view properties. 2499 */ 2500 private ViewPropertyAnimator mAnimator = null; 2501 2502 /** 2503 * Flag indicating that a drag can cross window boundaries. When 2504 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called 2505 * with this flag set, all visible applications will be able to participate 2506 * in the drag operation and receive the dragged content. 2507 * 2508 * @hide 2509 */ 2510 public static final int DRAG_FLAG_GLOBAL = 1; 2511 2512 /** 2513 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}. 2514 */ 2515 private float mVerticalScrollFactor; 2516 2517 /** 2518 * Position of the vertical scroll bar. 2519 */ 2520 private int mVerticalScrollbarPosition; 2521 2522 /** 2523 * Position the scroll bar at the default position as determined by the system. 2524 */ 2525 public static final int SCROLLBAR_POSITION_DEFAULT = 0; 2526 2527 /** 2528 * Position the scroll bar along the left edge. 2529 */ 2530 public static final int SCROLLBAR_POSITION_LEFT = 1; 2531 2532 /** 2533 * Position the scroll bar along the right edge. 2534 */ 2535 public static final int SCROLLBAR_POSITION_RIGHT = 2; 2536 2537 /** 2538 * Indicates that the view does not have a layer. 2539 * 2540 * @see #getLayerType() 2541 * @see #setLayerType(int, android.graphics.Paint) 2542 * @see #LAYER_TYPE_SOFTWARE 2543 * @see #LAYER_TYPE_HARDWARE 2544 */ 2545 public static final int LAYER_TYPE_NONE = 0; 2546 2547 /** 2548 * <p>Indicates that the view has a software layer. A software layer is backed 2549 * by a bitmap and causes the view to be rendered using Android's software 2550 * rendering pipeline, even if hardware acceleration is enabled.</p> 2551 * 2552 * <p>Software layers have various usages:</p> 2553 * <p>When the application is not using hardware acceleration, a software layer 2554 * is useful to apply a specific color filter and/or blending mode and/or 2555 * translucency to a view and all its children.</p> 2556 * <p>When the application is using hardware acceleration, a software layer 2557 * is useful to render drawing primitives not supported by the hardware 2558 * accelerated pipeline. It can also be used to cache a complex view tree 2559 * into a texture and reduce the complexity of drawing operations. For instance, 2560 * when animating a complex view tree with a translation, a software layer can 2561 * be used to render the view tree only once.</p> 2562 * <p>Software layers should be avoided when the affected view tree updates 2563 * often. Every update will require to re-render the software layer, which can 2564 * potentially be slow (particularly when hardware acceleration is turned on 2565 * since the layer will have to be uploaded into a hardware texture after every 2566 * update.)</p> 2567 * 2568 * @see #getLayerType() 2569 * @see #setLayerType(int, android.graphics.Paint) 2570 * @see #LAYER_TYPE_NONE 2571 * @see #LAYER_TYPE_HARDWARE 2572 */ 2573 public static final int LAYER_TYPE_SOFTWARE = 1; 2574 2575 /** 2576 * <p>Indicates that the view has a hardware layer. A hardware layer is backed 2577 * by a hardware specific texture (generally Frame Buffer Objects or FBO on 2578 * OpenGL hardware) and causes the view to be rendered using Android's hardware 2579 * rendering pipeline, but only if hardware acceleration is turned on for the 2580 * view hierarchy. When hardware acceleration is turned off, hardware layers 2581 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p> 2582 * 2583 * <p>A hardware layer is useful to apply a specific color filter and/or 2584 * blending mode and/or translucency to a view and all its children.</p> 2585 * <p>A hardware layer can be used to cache a complex view tree into a 2586 * texture and reduce the complexity of drawing operations. For instance, 2587 * when animating a complex view tree with a translation, a hardware layer can 2588 * be used to render the view tree only once.</p> 2589 * <p>A hardware layer can also be used to increase the rendering quality when 2590 * rotation transformations are applied on a view. It can also be used to 2591 * prevent potential clipping issues when applying 3D transforms on a view.</p> 2592 * 2593 * @see #getLayerType() 2594 * @see #setLayerType(int, android.graphics.Paint) 2595 * @see #LAYER_TYPE_NONE 2596 * @see #LAYER_TYPE_SOFTWARE 2597 */ 2598 public static final int LAYER_TYPE_HARDWARE = 2; 2599 2600 @ViewDebug.ExportedProperty(category = "drawing", mapping = { 2601 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"), 2602 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"), 2603 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE") 2604 }) 2605 int mLayerType = LAYER_TYPE_NONE; 2606 Paint mLayerPaint; 2607 Rect mLocalDirtyRect; 2608 2609 /** 2610 * Set to true when the view is sending hover accessibility events because it 2611 * is the innermost hovered view. 2612 */ 2613 private boolean mSendingHoverAccessibilityEvents; 2614 2615 /** 2616 * Delegate for injecting accessiblity functionality. 2617 */ 2618 AccessibilityDelegate mAccessibilityDelegate; 2619 2620 /** 2621 * Text direction is inherited thru {@link ViewGroup} 2622 * @hide 2623 */ 2624 public static final int TEXT_DIRECTION_INHERIT = 0; 2625 2626 /** 2627 * Text direction is using "first strong algorithm". The first strong directional character 2628 * determines the paragraph direction. If there is no strong directional character, the 2629 * paragraph direction is the view's resolved layout direction. 2630 * 2631 * @hide 2632 */ 2633 public static final int TEXT_DIRECTION_FIRST_STRONG = 1; 2634 2635 /** 2636 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains 2637 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters. 2638 * If there are neither, the paragraph direction is the view's resolved layout direction. 2639 * 2640 * @hide 2641 */ 2642 public static final int TEXT_DIRECTION_ANY_RTL = 2; 2643 2644 /** 2645 * Text direction is forced to LTR. 2646 * 2647 * @hide 2648 */ 2649 public static final int TEXT_DIRECTION_LTR = 3; 2650 2651 /** 2652 * Text direction is forced to RTL. 2653 * 2654 * @hide 2655 */ 2656 public static final int TEXT_DIRECTION_RTL = 4; 2657 2658 /** 2659 * Text direction is coming from the system Locale. 2660 * 2661 * @hide 2662 */ 2663 public static final int TEXT_DIRECTION_LOCALE = 5; 2664 2665 /** 2666 * Default text direction is inherited 2667 * 2668 * @hide 2669 */ 2670 protected static int DEFAULT_TEXT_DIRECTION = TEXT_DIRECTION_INHERIT; 2671 2672 /** 2673 * The text direction that has been defined by {@link #setTextDirection(int)}. 2674 * 2675 * {@hide} 2676 */ 2677 @ViewDebug.ExportedProperty(category = "text", mapping = { 2678 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 2679 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 2680 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 2681 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 2682 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 2683 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 2684 }) 2685 private int mTextDirection = DEFAULT_TEXT_DIRECTION; 2686 2687 /** 2688 * The resolved text direction. This needs resolution if the value is 2689 * TEXT_DIRECTION_INHERIT. The resolution matches mTextDirection if it is 2690 * not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds up the parent 2691 * chain of the view. 2692 * 2693 * {@hide} 2694 */ 2695 @ViewDebug.ExportedProperty(category = "text", mapping = { 2696 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"), 2697 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"), 2698 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"), 2699 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"), 2700 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"), 2701 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE") 2702 }) 2703 private int mResolvedTextDirection = TEXT_DIRECTION_INHERIT; 2704 2705 /** 2706 * Consistency verifier for debugging purposes. 2707 * @hide 2708 */ 2709 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier = 2710 InputEventConsistencyVerifier.isInstrumentationEnabled() ? 2711 new InputEventConsistencyVerifier(this, 0) : null; 2712 2713 /** 2714 * Simple constructor to use when creating a view from code. 2715 * 2716 * @param context The Context the view is running in, through which it can 2717 * access the current theme, resources, etc. 2718 */ 2719 public View(Context context) { 2720 mContext = context; 2721 mResources = context != null ? context.getResources() : null; 2722 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED | LAYOUT_DIRECTION_INHERIT; 2723 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop(); 2724 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS); 2725 mUserPaddingStart = -1; 2726 mUserPaddingEnd = -1; 2727 mUserPaddingRelative = false; 2728 } 2729 2730 /** 2731 * Constructor that is called when inflating a view from XML. This is called 2732 * when a view is being constructed from an XML file, supplying attributes 2733 * that were specified in the XML file. This version uses a default style of 2734 * 0, so the only attribute values applied are those in the Context's Theme 2735 * and the given AttributeSet. 2736 * 2737 * <p> 2738 * The method onFinishInflate() will be called after all children have been 2739 * added. 2740 * 2741 * @param context The Context the view is running in, through which it can 2742 * access the current theme, resources, etc. 2743 * @param attrs The attributes of the XML tag that is inflating the view. 2744 * @see #View(Context, AttributeSet, int) 2745 */ 2746 public View(Context context, AttributeSet attrs) { 2747 this(context, attrs, 0); 2748 } 2749 2750 /** 2751 * Perform inflation from XML and apply a class-specific base style. This 2752 * constructor of View allows subclasses to use their own base style when 2753 * they are inflating. For example, a Button class's constructor would call 2754 * this version of the super class constructor and supply 2755 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows 2756 * the theme's button style to modify all of the base view attributes (in 2757 * particular its background) as well as the Button class's attributes. 2758 * 2759 * @param context The Context the view is running in, through which it can 2760 * access the current theme, resources, etc. 2761 * @param attrs The attributes of the XML tag that is inflating the view. 2762 * @param defStyle The default style to apply to this view. If 0, no style 2763 * will be applied (beyond what is included in the theme). This may 2764 * either be an attribute resource, whose value will be retrieved 2765 * from the current theme, or an explicit style resource. 2766 * @see #View(Context, AttributeSet) 2767 */ 2768 public View(Context context, AttributeSet attrs, int defStyle) { 2769 this(context); 2770 2771 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View, 2772 defStyle, 0); 2773 2774 Drawable background = null; 2775 2776 int leftPadding = -1; 2777 int topPadding = -1; 2778 int rightPadding = -1; 2779 int bottomPadding = -1; 2780 int startPadding = -1; 2781 int endPadding = -1; 2782 2783 int padding = -1; 2784 2785 int viewFlagValues = 0; 2786 int viewFlagMasks = 0; 2787 2788 boolean setScrollContainer = false; 2789 2790 int x = 0; 2791 int y = 0; 2792 2793 float tx = 0; 2794 float ty = 0; 2795 float rotation = 0; 2796 float rotationX = 0; 2797 float rotationY = 0; 2798 float sx = 1f; 2799 float sy = 1f; 2800 boolean transformSet = false; 2801 2802 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY; 2803 2804 int overScrollMode = mOverScrollMode; 2805 final int N = a.getIndexCount(); 2806 for (int i = 0; i < N; i++) { 2807 int attr = a.getIndex(i); 2808 switch (attr) { 2809 case com.android.internal.R.styleable.View_background: 2810 background = a.getDrawable(attr); 2811 break; 2812 case com.android.internal.R.styleable.View_padding: 2813 padding = a.getDimensionPixelSize(attr, -1); 2814 break; 2815 case com.android.internal.R.styleable.View_paddingLeft: 2816 leftPadding = a.getDimensionPixelSize(attr, -1); 2817 break; 2818 case com.android.internal.R.styleable.View_paddingTop: 2819 topPadding = a.getDimensionPixelSize(attr, -1); 2820 break; 2821 case com.android.internal.R.styleable.View_paddingRight: 2822 rightPadding = a.getDimensionPixelSize(attr, -1); 2823 break; 2824 case com.android.internal.R.styleable.View_paddingBottom: 2825 bottomPadding = a.getDimensionPixelSize(attr, -1); 2826 break; 2827 case com.android.internal.R.styleable.View_paddingStart: 2828 startPadding = a.getDimensionPixelSize(attr, -1); 2829 break; 2830 case com.android.internal.R.styleable.View_paddingEnd: 2831 endPadding = a.getDimensionPixelSize(attr, -1); 2832 break; 2833 case com.android.internal.R.styleable.View_scrollX: 2834 x = a.getDimensionPixelOffset(attr, 0); 2835 break; 2836 case com.android.internal.R.styleable.View_scrollY: 2837 y = a.getDimensionPixelOffset(attr, 0); 2838 break; 2839 case com.android.internal.R.styleable.View_alpha: 2840 setAlpha(a.getFloat(attr, 1f)); 2841 break; 2842 case com.android.internal.R.styleable.View_transformPivotX: 2843 setPivotX(a.getDimensionPixelOffset(attr, 0)); 2844 break; 2845 case com.android.internal.R.styleable.View_transformPivotY: 2846 setPivotY(a.getDimensionPixelOffset(attr, 0)); 2847 break; 2848 case com.android.internal.R.styleable.View_translationX: 2849 tx = a.getDimensionPixelOffset(attr, 0); 2850 transformSet = true; 2851 break; 2852 case com.android.internal.R.styleable.View_translationY: 2853 ty = a.getDimensionPixelOffset(attr, 0); 2854 transformSet = true; 2855 break; 2856 case com.android.internal.R.styleable.View_rotation: 2857 rotation = a.getFloat(attr, 0); 2858 transformSet = true; 2859 break; 2860 case com.android.internal.R.styleable.View_rotationX: 2861 rotationX = a.getFloat(attr, 0); 2862 transformSet = true; 2863 break; 2864 case com.android.internal.R.styleable.View_rotationY: 2865 rotationY = a.getFloat(attr, 0); 2866 transformSet = true; 2867 break; 2868 case com.android.internal.R.styleable.View_scaleX: 2869 sx = a.getFloat(attr, 1f); 2870 transformSet = true; 2871 break; 2872 case com.android.internal.R.styleable.View_scaleY: 2873 sy = a.getFloat(attr, 1f); 2874 transformSet = true; 2875 break; 2876 case com.android.internal.R.styleable.View_id: 2877 mID = a.getResourceId(attr, NO_ID); 2878 break; 2879 case com.android.internal.R.styleable.View_tag: 2880 mTag = a.getText(attr); 2881 break; 2882 case com.android.internal.R.styleable.View_fitsSystemWindows: 2883 if (a.getBoolean(attr, false)) { 2884 viewFlagValues |= FITS_SYSTEM_WINDOWS; 2885 viewFlagMasks |= FITS_SYSTEM_WINDOWS; 2886 } 2887 break; 2888 case com.android.internal.R.styleable.View_focusable: 2889 if (a.getBoolean(attr, false)) { 2890 viewFlagValues |= FOCUSABLE; 2891 viewFlagMasks |= FOCUSABLE_MASK; 2892 } 2893 break; 2894 case com.android.internal.R.styleable.View_focusableInTouchMode: 2895 if (a.getBoolean(attr, false)) { 2896 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE; 2897 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK; 2898 } 2899 break; 2900 case com.android.internal.R.styleable.View_clickable: 2901 if (a.getBoolean(attr, false)) { 2902 viewFlagValues |= CLICKABLE; 2903 viewFlagMasks |= CLICKABLE; 2904 } 2905 break; 2906 case com.android.internal.R.styleable.View_longClickable: 2907 if (a.getBoolean(attr, false)) { 2908 viewFlagValues |= LONG_CLICKABLE; 2909 viewFlagMasks |= LONG_CLICKABLE; 2910 } 2911 break; 2912 case com.android.internal.R.styleable.View_saveEnabled: 2913 if (!a.getBoolean(attr, true)) { 2914 viewFlagValues |= SAVE_DISABLED; 2915 viewFlagMasks |= SAVE_DISABLED_MASK; 2916 } 2917 break; 2918 case com.android.internal.R.styleable.View_duplicateParentState: 2919 if (a.getBoolean(attr, false)) { 2920 viewFlagValues |= DUPLICATE_PARENT_STATE; 2921 viewFlagMasks |= DUPLICATE_PARENT_STATE; 2922 } 2923 break; 2924 case com.android.internal.R.styleable.View_visibility: 2925 final int visibility = a.getInt(attr, 0); 2926 if (visibility != 0) { 2927 viewFlagValues |= VISIBILITY_FLAGS[visibility]; 2928 viewFlagMasks |= VISIBILITY_MASK; 2929 } 2930 break; 2931 case com.android.internal.R.styleable.View_layoutDirection: 2932 // Clear any HORIZONTAL_DIRECTION flag already set 2933 viewFlagValues &= ~LAYOUT_DIRECTION_MASK; 2934 // Set the HORIZONTAL_DIRECTION flags depending on the value of the attribute 2935 final int layoutDirection = a.getInt(attr, -1); 2936 if (layoutDirection != -1) { 2937 viewFlagValues |= LAYOUT_DIRECTION_FLAGS[layoutDirection]; 2938 } else { 2939 // Set to default (LAYOUT_DIRECTION_INHERIT) 2940 viewFlagValues |= LAYOUT_DIRECTION_DEFAULT; 2941 } 2942 viewFlagMasks |= LAYOUT_DIRECTION_MASK; 2943 break; 2944 case com.android.internal.R.styleable.View_drawingCacheQuality: 2945 final int cacheQuality = a.getInt(attr, 0); 2946 if (cacheQuality != 0) { 2947 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality]; 2948 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK; 2949 } 2950 break; 2951 case com.android.internal.R.styleable.View_contentDescription: 2952 mContentDescription = a.getString(attr); 2953 break; 2954 case com.android.internal.R.styleable.View_soundEffectsEnabled: 2955 if (!a.getBoolean(attr, true)) { 2956 viewFlagValues &= ~SOUND_EFFECTS_ENABLED; 2957 viewFlagMasks |= SOUND_EFFECTS_ENABLED; 2958 } 2959 break; 2960 case com.android.internal.R.styleable.View_hapticFeedbackEnabled: 2961 if (!a.getBoolean(attr, true)) { 2962 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED; 2963 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED; 2964 } 2965 break; 2966 case R.styleable.View_scrollbars: 2967 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE); 2968 if (scrollbars != SCROLLBARS_NONE) { 2969 viewFlagValues |= scrollbars; 2970 viewFlagMasks |= SCROLLBARS_MASK; 2971 initializeScrollbars(a); 2972 } 2973 break; 2974 //noinspection deprecation 2975 case R.styleable.View_fadingEdge: 2976 if (context.getApplicationInfo().targetSdkVersion >= ICE_CREAM_SANDWICH) { 2977 // Ignore the attribute starting with ICS 2978 break; 2979 } 2980 // With builds < ICS, fall through and apply fading edges 2981 case R.styleable.View_requiresFadingEdge: 2982 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE); 2983 if (fadingEdge != FADING_EDGE_NONE) { 2984 viewFlagValues |= fadingEdge; 2985 viewFlagMasks |= FADING_EDGE_MASK; 2986 initializeFadingEdge(a); 2987 } 2988 break; 2989 case R.styleable.View_scrollbarStyle: 2990 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY); 2991 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 2992 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK; 2993 viewFlagMasks |= SCROLLBARS_STYLE_MASK; 2994 } 2995 break; 2996 case R.styleable.View_isScrollContainer: 2997 setScrollContainer = true; 2998 if (a.getBoolean(attr, false)) { 2999 setScrollContainer(true); 3000 } 3001 break; 3002 case com.android.internal.R.styleable.View_keepScreenOn: 3003 if (a.getBoolean(attr, false)) { 3004 viewFlagValues |= KEEP_SCREEN_ON; 3005 viewFlagMasks |= KEEP_SCREEN_ON; 3006 } 3007 break; 3008 case R.styleable.View_filterTouchesWhenObscured: 3009 if (a.getBoolean(attr, false)) { 3010 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED; 3011 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED; 3012 } 3013 break; 3014 case R.styleable.View_nextFocusLeft: 3015 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID); 3016 break; 3017 case R.styleable.View_nextFocusRight: 3018 mNextFocusRightId = a.getResourceId(attr, View.NO_ID); 3019 break; 3020 case R.styleable.View_nextFocusUp: 3021 mNextFocusUpId = a.getResourceId(attr, View.NO_ID); 3022 break; 3023 case R.styleable.View_nextFocusDown: 3024 mNextFocusDownId = a.getResourceId(attr, View.NO_ID); 3025 break; 3026 case R.styleable.View_nextFocusForward: 3027 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID); 3028 break; 3029 case R.styleable.View_minWidth: 3030 mMinWidth = a.getDimensionPixelSize(attr, 0); 3031 break; 3032 case R.styleable.View_minHeight: 3033 mMinHeight = a.getDimensionPixelSize(attr, 0); 3034 break; 3035 case R.styleable.View_onClick: 3036 if (context.isRestricted()) { 3037 throw new IllegalStateException("The android:onClick attribute cannot " 3038 + "be used within a restricted context"); 3039 } 3040 3041 final String handlerName = a.getString(attr); 3042 if (handlerName != null) { 3043 setOnClickListener(new OnClickListener() { 3044 private Method mHandler; 3045 3046 public void onClick(View v) { 3047 if (mHandler == null) { 3048 try { 3049 mHandler = getContext().getClass().getMethod(handlerName, 3050 View.class); 3051 } catch (NoSuchMethodException e) { 3052 int id = getId(); 3053 String idText = id == NO_ID ? "" : " with id '" 3054 + getContext().getResources().getResourceEntryName( 3055 id) + "'"; 3056 throw new IllegalStateException("Could not find a method " + 3057 handlerName + "(View) in the activity " 3058 + getContext().getClass() + " for onClick handler" 3059 + " on view " + View.this.getClass() + idText, e); 3060 } 3061 } 3062 3063 try { 3064 mHandler.invoke(getContext(), View.this); 3065 } catch (IllegalAccessException e) { 3066 throw new IllegalStateException("Could not execute non " 3067 + "public method of the activity", e); 3068 } catch (InvocationTargetException e) { 3069 throw new IllegalStateException("Could not execute " 3070 + "method of the activity", e); 3071 } 3072 } 3073 }); 3074 } 3075 break; 3076 case R.styleable.View_overScrollMode: 3077 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS); 3078 break; 3079 case R.styleable.View_verticalScrollbarPosition: 3080 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT); 3081 break; 3082 case R.styleable.View_layerType: 3083 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null); 3084 break; 3085 case R.styleable.View_textDirection: 3086 mTextDirection = a.getInt(attr, DEFAULT_TEXT_DIRECTION); 3087 break; 3088 } 3089 } 3090 3091 a.recycle(); 3092 3093 setOverScrollMode(overScrollMode); 3094 3095 if (background != null) { 3096 setBackgroundDrawable(background); 3097 } 3098 3099 mUserPaddingRelative = (startPadding >= 0 || endPadding >= 0); 3100 3101 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved 3102 // layout direction). Those cached values will be used later during padding resolution. 3103 mUserPaddingStart = startPadding; 3104 mUserPaddingEnd = endPadding; 3105 3106 if (padding >= 0) { 3107 leftPadding = padding; 3108 topPadding = padding; 3109 rightPadding = padding; 3110 bottomPadding = padding; 3111 } 3112 3113 // If the user specified the padding (either with android:padding or 3114 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise 3115 // use the default padding or the padding from the background drawable 3116 // (stored at this point in mPadding*) 3117 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft, 3118 topPadding >= 0 ? topPadding : mPaddingTop, 3119 rightPadding >= 0 ? rightPadding : mPaddingRight, 3120 bottomPadding >= 0 ? bottomPadding : mPaddingBottom); 3121 3122 if (viewFlagMasks != 0) { 3123 setFlags(viewFlagValues, viewFlagMasks); 3124 } 3125 3126 // Needs to be called after mViewFlags is set 3127 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 3128 recomputePadding(); 3129 } 3130 3131 if (x != 0 || y != 0) { 3132 scrollTo(x, y); 3133 } 3134 3135 if (transformSet) { 3136 setTranslationX(tx); 3137 setTranslationY(ty); 3138 setRotation(rotation); 3139 setRotationX(rotationX); 3140 setRotationY(rotationY); 3141 setScaleX(sx); 3142 setScaleY(sy); 3143 } 3144 3145 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) { 3146 setScrollContainer(true); 3147 } 3148 3149 computeOpaqueFlags(); 3150 } 3151 3152 /** 3153 * Non-public constructor for use in testing 3154 */ 3155 View() { 3156 mResources = null; 3157 } 3158 3159 /** 3160 * <p> 3161 * Initializes the fading edges from a given set of styled attributes. This 3162 * method should be called by subclasses that need fading edges and when an 3163 * instance of these subclasses is created programmatically rather than 3164 * being inflated from XML. This method is automatically called when the XML 3165 * is inflated. 3166 * </p> 3167 * 3168 * @param a the styled attributes set to initialize the fading edges from 3169 */ 3170 protected void initializeFadingEdge(TypedArray a) { 3171 initScrollCache(); 3172 3173 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize( 3174 R.styleable.View_fadingEdgeLength, 3175 ViewConfiguration.get(mContext).getScaledFadingEdgeLength()); 3176 } 3177 3178 /** 3179 * Returns the size of the vertical faded edges used to indicate that more 3180 * content in this view is visible. 3181 * 3182 * @return The size in pixels of the vertical faded edge or 0 if vertical 3183 * faded edges are not enabled for this view. 3184 * @attr ref android.R.styleable#View_fadingEdgeLength 3185 */ 3186 public int getVerticalFadingEdgeLength() { 3187 if (isVerticalFadingEdgeEnabled()) { 3188 ScrollabilityCache cache = mScrollCache; 3189 if (cache != null) { 3190 return cache.fadingEdgeLength; 3191 } 3192 } 3193 return 0; 3194 } 3195 3196 /** 3197 * Set the size of the faded edge used to indicate that more content in this 3198 * view is available. Will not change whether the fading edge is enabled; use 3199 * {@link #setVerticalFadingEdgeEnabled(boolean)} or 3200 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge 3201 * for the vertical or horizontal fading edges. 3202 * 3203 * @param length The size in pixels of the faded edge used to indicate that more 3204 * content in this view is visible. 3205 */ 3206 public void setFadingEdgeLength(int length) { 3207 initScrollCache(); 3208 mScrollCache.fadingEdgeLength = length; 3209 } 3210 3211 /** 3212 * Returns the size of the horizontal faded edges used to indicate that more 3213 * content in this view is visible. 3214 * 3215 * @return The size in pixels of the horizontal faded edge or 0 if horizontal 3216 * faded edges are not enabled for this view. 3217 * @attr ref android.R.styleable#View_fadingEdgeLength 3218 */ 3219 public int getHorizontalFadingEdgeLength() { 3220 if (isHorizontalFadingEdgeEnabled()) { 3221 ScrollabilityCache cache = mScrollCache; 3222 if (cache != null) { 3223 return cache.fadingEdgeLength; 3224 } 3225 } 3226 return 0; 3227 } 3228 3229 /** 3230 * Returns the width of the vertical scrollbar. 3231 * 3232 * @return The width in pixels of the vertical scrollbar or 0 if there 3233 * is no vertical scrollbar. 3234 */ 3235 public int getVerticalScrollbarWidth() { 3236 ScrollabilityCache cache = mScrollCache; 3237 if (cache != null) { 3238 ScrollBarDrawable scrollBar = cache.scrollBar; 3239 if (scrollBar != null) { 3240 int size = scrollBar.getSize(true); 3241 if (size <= 0) { 3242 size = cache.scrollBarSize; 3243 } 3244 return size; 3245 } 3246 return 0; 3247 } 3248 return 0; 3249 } 3250 3251 /** 3252 * Returns the height of the horizontal scrollbar. 3253 * 3254 * @return The height in pixels of the horizontal scrollbar or 0 if 3255 * there is no horizontal scrollbar. 3256 */ 3257 protected int getHorizontalScrollbarHeight() { 3258 ScrollabilityCache cache = mScrollCache; 3259 if (cache != null) { 3260 ScrollBarDrawable scrollBar = cache.scrollBar; 3261 if (scrollBar != null) { 3262 int size = scrollBar.getSize(false); 3263 if (size <= 0) { 3264 size = cache.scrollBarSize; 3265 } 3266 return size; 3267 } 3268 return 0; 3269 } 3270 return 0; 3271 } 3272 3273 /** 3274 * <p> 3275 * Initializes the scrollbars from a given set of styled attributes. This 3276 * method should be called by subclasses that need scrollbars and when an 3277 * instance of these subclasses is created programmatically rather than 3278 * being inflated from XML. This method is automatically called when the XML 3279 * is inflated. 3280 * </p> 3281 * 3282 * @param a the styled attributes set to initialize the scrollbars from 3283 */ 3284 protected void initializeScrollbars(TypedArray a) { 3285 initScrollCache(); 3286 3287 final ScrollabilityCache scrollabilityCache = mScrollCache; 3288 3289 if (scrollabilityCache.scrollBar == null) { 3290 scrollabilityCache.scrollBar = new ScrollBarDrawable(); 3291 } 3292 3293 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true); 3294 3295 if (!fadeScrollbars) { 3296 scrollabilityCache.state = ScrollabilityCache.ON; 3297 } 3298 scrollabilityCache.fadeScrollBars = fadeScrollbars; 3299 3300 3301 scrollabilityCache.scrollBarFadeDuration = a.getInt( 3302 R.styleable.View_scrollbarFadeDuration, ViewConfiguration 3303 .getScrollBarFadeDuration()); 3304 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt( 3305 R.styleable.View_scrollbarDefaultDelayBeforeFade, 3306 ViewConfiguration.getScrollDefaultDelay()); 3307 3308 3309 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize( 3310 com.android.internal.R.styleable.View_scrollbarSize, 3311 ViewConfiguration.get(mContext).getScaledScrollBarSize()); 3312 3313 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal); 3314 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track); 3315 3316 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal); 3317 if (thumb != null) { 3318 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb); 3319 } 3320 3321 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack, 3322 false); 3323 if (alwaysDraw) { 3324 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true); 3325 } 3326 3327 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical); 3328 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track); 3329 3330 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical); 3331 if (thumb != null) { 3332 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb); 3333 } 3334 3335 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack, 3336 false); 3337 if (alwaysDraw) { 3338 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true); 3339 } 3340 3341 // Re-apply user/background padding so that scrollbar(s) get added 3342 resolvePadding(); 3343 } 3344 3345 /** 3346 * <p> 3347 * Initalizes the scrollability cache if necessary. 3348 * </p> 3349 */ 3350 private void initScrollCache() { 3351 if (mScrollCache == null) { 3352 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this); 3353 } 3354 } 3355 3356 /** 3357 * Set the position of the vertical scroll bar. Should be one of 3358 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or 3359 * {@link #SCROLLBAR_POSITION_RIGHT}. 3360 * 3361 * @param position Where the vertical scroll bar should be positioned. 3362 */ 3363 public void setVerticalScrollbarPosition(int position) { 3364 if (mVerticalScrollbarPosition != position) { 3365 mVerticalScrollbarPosition = position; 3366 computeOpaqueFlags(); 3367 resolvePadding(); 3368 } 3369 } 3370 3371 /** 3372 * @return The position where the vertical scroll bar will show, if applicable. 3373 * @see #setVerticalScrollbarPosition(int) 3374 */ 3375 public int getVerticalScrollbarPosition() { 3376 return mVerticalScrollbarPosition; 3377 } 3378 3379 ListenerInfo getListenerInfo() { 3380 if (mListenerInfo != null) { 3381 return mListenerInfo; 3382 } 3383 mListenerInfo = new ListenerInfo(); 3384 return mListenerInfo; 3385 } 3386 3387 /** 3388 * Register a callback to be invoked when focus of this view changed. 3389 * 3390 * @param l The callback that will run. 3391 */ 3392 public void setOnFocusChangeListener(OnFocusChangeListener l) { 3393 getListenerInfo().mOnFocusChangeListener = l; 3394 } 3395 3396 /** 3397 * Add a listener that will be called when the bounds of the view change due to 3398 * layout processing. 3399 * 3400 * @param listener The listener that will be called when layout bounds change. 3401 */ 3402 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) { 3403 ListenerInfo li = getListenerInfo(); 3404 if (li.mOnLayoutChangeListeners == null) { 3405 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>(); 3406 } 3407 if (!li.mOnLayoutChangeListeners.contains(listener)) { 3408 li.mOnLayoutChangeListeners.add(listener); 3409 } 3410 } 3411 3412 /** 3413 * Remove a listener for layout changes. 3414 * 3415 * @param listener The listener for layout bounds change. 3416 */ 3417 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) { 3418 ListenerInfo li = mListenerInfo; 3419 if (li == null || li.mOnLayoutChangeListeners == null) { 3420 return; 3421 } 3422 li.mOnLayoutChangeListeners.remove(listener); 3423 } 3424 3425 /** 3426 * Add a listener for attach state changes. 3427 * 3428 * This listener will be called whenever this view is attached or detached 3429 * from a window. Remove the listener using 3430 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}. 3431 * 3432 * @param listener Listener to attach 3433 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener) 3434 */ 3435 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 3436 ListenerInfo li = getListenerInfo(); 3437 if (li.mOnAttachStateChangeListeners == null) { 3438 li.mOnAttachStateChangeListeners 3439 = new CopyOnWriteArrayList<OnAttachStateChangeListener>(); 3440 } 3441 li.mOnAttachStateChangeListeners.add(listener); 3442 } 3443 3444 /** 3445 * Remove a listener for attach state changes. The listener will receive no further 3446 * notification of window attach/detach events. 3447 * 3448 * @param listener Listener to remove 3449 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener) 3450 */ 3451 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) { 3452 ListenerInfo li = mListenerInfo; 3453 if (li == null || li.mOnAttachStateChangeListeners == null) { 3454 return; 3455 } 3456 li.mOnAttachStateChangeListeners.remove(listener); 3457 } 3458 3459 /** 3460 * Returns the focus-change callback registered for this view. 3461 * 3462 * @return The callback, or null if one is not registered. 3463 */ 3464 public OnFocusChangeListener getOnFocusChangeListener() { 3465 ListenerInfo li = mListenerInfo; 3466 return li != null ? li.mOnFocusChangeListener : null; 3467 } 3468 3469 /** 3470 * Register a callback to be invoked when this view is clicked. If this view is not 3471 * clickable, it becomes clickable. 3472 * 3473 * @param l The callback that will run 3474 * 3475 * @see #setClickable(boolean) 3476 */ 3477 public void setOnClickListener(OnClickListener l) { 3478 if (!isClickable()) { 3479 setClickable(true); 3480 } 3481 getListenerInfo().mOnClickListener = l; 3482 } 3483 3484 /** 3485 * Return whether this view has an attached OnClickListener. Returns 3486 * true if there is a listener, false if there is none. 3487 */ 3488 public boolean hasOnClickListeners() { 3489 ListenerInfo li = mListenerInfo; 3490 return (li != null && li.mOnClickListener != null); 3491 } 3492 3493 /** 3494 * Register a callback to be invoked when this view is clicked and held. If this view is not 3495 * long clickable, it becomes long clickable. 3496 * 3497 * @param l The callback that will run 3498 * 3499 * @see #setLongClickable(boolean) 3500 */ 3501 public void setOnLongClickListener(OnLongClickListener l) { 3502 if (!isLongClickable()) { 3503 setLongClickable(true); 3504 } 3505 getListenerInfo().mOnLongClickListener = l; 3506 } 3507 3508 /** 3509 * Register a callback to be invoked when the context menu for this view is 3510 * being built. If this view is not long clickable, it becomes long clickable. 3511 * 3512 * @param l The callback that will run 3513 * 3514 */ 3515 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) { 3516 if (!isLongClickable()) { 3517 setLongClickable(true); 3518 } 3519 getListenerInfo().mOnCreateContextMenuListener = l; 3520 } 3521 3522 /** 3523 * Call this view's OnClickListener, if it is defined. Performs all normal 3524 * actions associated with clicking: reporting accessibility event, playing 3525 * a sound, etc. 3526 * 3527 * @return True there was an assigned OnClickListener that was called, false 3528 * otherwise is returned. 3529 */ 3530 public boolean performClick() { 3531 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED); 3532 3533 ListenerInfo li = mListenerInfo; 3534 if (li != null && li.mOnClickListener != null) { 3535 playSoundEffect(SoundEffectConstants.CLICK); 3536 li.mOnClickListener.onClick(this); 3537 return true; 3538 } 3539 3540 return false; 3541 } 3542 3543 /** 3544 * Directly call any attached OnClickListener. Unlike {@link #performClick()}, 3545 * this only calls the listener, and does not do any associated clicking 3546 * actions like reporting an accessibility event. 3547 * 3548 * @return True there was an assigned OnClickListener that was called, false 3549 * otherwise is returned. 3550 */ 3551 public boolean callOnClick() { 3552 ListenerInfo li = mListenerInfo; 3553 if (li != null && li.mOnClickListener != null) { 3554 li.mOnClickListener.onClick(this); 3555 return true; 3556 } 3557 return false; 3558 } 3559 3560 /** 3561 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the 3562 * OnLongClickListener did not consume the event. 3563 * 3564 * @return True if one of the above receivers consumed the event, false otherwise. 3565 */ 3566 public boolean performLongClick() { 3567 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED); 3568 3569 boolean handled = false; 3570 ListenerInfo li = mListenerInfo; 3571 if (li != null && li.mOnLongClickListener != null) { 3572 handled = li.mOnLongClickListener.onLongClick(View.this); 3573 } 3574 if (!handled) { 3575 handled = showContextMenu(); 3576 } 3577 if (handled) { 3578 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); 3579 } 3580 return handled; 3581 } 3582 3583 /** 3584 * Performs button-related actions during a touch down event. 3585 * 3586 * @param event The event. 3587 * @return True if the down was consumed. 3588 * 3589 * @hide 3590 */ 3591 protected boolean performButtonActionOnTouchDown(MotionEvent event) { 3592 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) { 3593 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) { 3594 return true; 3595 } 3596 } 3597 return false; 3598 } 3599 3600 /** 3601 * Bring up the context menu for this view. 3602 * 3603 * @return Whether a context menu was displayed. 3604 */ 3605 public boolean showContextMenu() { 3606 return getParent().showContextMenuForChild(this); 3607 } 3608 3609 /** 3610 * Bring up the context menu for this view, referring to the item under the specified point. 3611 * 3612 * @param x The referenced x coordinate. 3613 * @param y The referenced y coordinate. 3614 * @param metaState The keyboard modifiers that were pressed. 3615 * @return Whether a context menu was displayed. 3616 * 3617 * @hide 3618 */ 3619 public boolean showContextMenu(float x, float y, int metaState) { 3620 return showContextMenu(); 3621 } 3622 3623 /** 3624 * Start an action mode. 3625 * 3626 * @param callback Callback that will control the lifecycle of the action mode 3627 * @return The new action mode if it is started, null otherwise 3628 * 3629 * @see ActionMode 3630 */ 3631 public ActionMode startActionMode(ActionMode.Callback callback) { 3632 return getParent().startActionModeForChild(this, callback); 3633 } 3634 3635 /** 3636 * Register a callback to be invoked when a key is pressed in this view. 3637 * @param l the key listener to attach to this view 3638 */ 3639 public void setOnKeyListener(OnKeyListener l) { 3640 getListenerInfo().mOnKeyListener = l; 3641 } 3642 3643 /** 3644 * Register a callback to be invoked when a touch event is sent to this view. 3645 * @param l the touch listener to attach to this view 3646 */ 3647 public void setOnTouchListener(OnTouchListener l) { 3648 getListenerInfo().mOnTouchListener = l; 3649 } 3650 3651 /** 3652 * Register a callback to be invoked when a generic motion event is sent to this view. 3653 * @param l the generic motion listener to attach to this view 3654 */ 3655 public void setOnGenericMotionListener(OnGenericMotionListener l) { 3656 getListenerInfo().mOnGenericMotionListener = l; 3657 } 3658 3659 /** 3660 * Register a callback to be invoked when a hover event is sent to this view. 3661 * @param l the hover listener to attach to this view 3662 */ 3663 public void setOnHoverListener(OnHoverListener l) { 3664 getListenerInfo().mOnHoverListener = l; 3665 } 3666 3667 /** 3668 * Register a drag event listener callback object for this View. The parameter is 3669 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a 3670 * View, the system calls the 3671 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method. 3672 * @param l An implementation of {@link android.view.View.OnDragListener}. 3673 */ 3674 public void setOnDragListener(OnDragListener l) { 3675 getListenerInfo().mOnDragListener = l; 3676 } 3677 3678 /** 3679 * Give this view focus. This will cause 3680 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called. 3681 * 3682 * Note: this does not check whether this {@link View} should get focus, it just 3683 * gives it focus no matter what. It should only be called internally by framework 3684 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}. 3685 * 3686 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN}, 3687 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which 3688 * focus moved when requestFocus() is called. It may not always 3689 * apply, in which case use the default View.FOCUS_DOWN. 3690 * @param previouslyFocusedRect The rectangle of the view that had focus 3691 * prior in this View's coordinate system. 3692 */ 3693 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) { 3694 if (DBG) { 3695 System.out.println(this + " requestFocus()"); 3696 } 3697 3698 if ((mPrivateFlags & FOCUSED) == 0) { 3699 mPrivateFlags |= FOCUSED; 3700 3701 if (mParent != null) { 3702 mParent.requestChildFocus(this, this); 3703 } 3704 3705 onFocusChanged(true, direction, previouslyFocusedRect); 3706 refreshDrawableState(); 3707 } 3708 } 3709 3710 /** 3711 * Request that a rectangle of this view be visible on the screen, 3712 * scrolling if necessary just enough. 3713 * 3714 * <p>A View should call this if it maintains some notion of which part 3715 * of its content is interesting. For example, a text editing view 3716 * should call this when its cursor moves. 3717 * 3718 * @param rectangle The rectangle. 3719 * @return Whether any parent scrolled. 3720 */ 3721 public boolean requestRectangleOnScreen(Rect rectangle) { 3722 return requestRectangleOnScreen(rectangle, false); 3723 } 3724 3725 /** 3726 * Request that a rectangle of this view be visible on the screen, 3727 * scrolling if necessary just enough. 3728 * 3729 * <p>A View should call this if it maintains some notion of which part 3730 * of its content is interesting. For example, a text editing view 3731 * should call this when its cursor moves. 3732 * 3733 * <p>When <code>immediate</code> is set to true, scrolling will not be 3734 * animated. 3735 * 3736 * @param rectangle The rectangle. 3737 * @param immediate True to forbid animated scrolling, false otherwise 3738 * @return Whether any parent scrolled. 3739 */ 3740 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) { 3741 View child = this; 3742 ViewParent parent = mParent; 3743 boolean scrolled = false; 3744 while (parent != null) { 3745 scrolled |= parent.requestChildRectangleOnScreen(child, 3746 rectangle, immediate); 3747 3748 // offset rect so next call has the rectangle in the 3749 // coordinate system of its direct child. 3750 rectangle.offset(child.getLeft(), child.getTop()); 3751 rectangle.offset(-child.getScrollX(), -child.getScrollY()); 3752 3753 if (!(parent instanceof View)) { 3754 break; 3755 } 3756 3757 child = (View) parent; 3758 parent = child.getParent(); 3759 } 3760 return scrolled; 3761 } 3762 3763 /** 3764 * Called when this view wants to give up focus. This will cause 3765 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called. 3766 */ 3767 public void clearFocus() { 3768 if (DBG) { 3769 System.out.println(this + " clearFocus()"); 3770 } 3771 3772 if ((mPrivateFlags & FOCUSED) != 0) { 3773 mPrivateFlags &= ~FOCUSED; 3774 3775 if (mParent != null) { 3776 mParent.clearChildFocus(this); 3777 } 3778 3779 onFocusChanged(false, 0, null); 3780 refreshDrawableState(); 3781 } 3782 } 3783 3784 /** 3785 * Called to clear the focus of a view that is about to be removed. 3786 * Doesn't call clearChildFocus, which prevents this view from taking 3787 * focus again before it has been removed from the parent 3788 */ 3789 void clearFocusForRemoval() { 3790 if ((mPrivateFlags & FOCUSED) != 0) { 3791 mPrivateFlags &= ~FOCUSED; 3792 3793 onFocusChanged(false, 0, null); 3794 refreshDrawableState(); 3795 } 3796 } 3797 3798 /** 3799 * Called internally by the view system when a new view is getting focus. 3800 * This is what clears the old focus. 3801 */ 3802 void unFocus() { 3803 if (DBG) { 3804 System.out.println(this + " unFocus()"); 3805 } 3806 3807 if ((mPrivateFlags & FOCUSED) != 0) { 3808 mPrivateFlags &= ~FOCUSED; 3809 3810 onFocusChanged(false, 0, null); 3811 refreshDrawableState(); 3812 } 3813 } 3814 3815 /** 3816 * Returns true if this view has focus iteself, or is the ancestor of the 3817 * view that has focus. 3818 * 3819 * @return True if this view has or contains focus, false otherwise. 3820 */ 3821 @ViewDebug.ExportedProperty(category = "focus") 3822 public boolean hasFocus() { 3823 return (mPrivateFlags & FOCUSED) != 0; 3824 } 3825 3826 /** 3827 * Returns true if this view is focusable or if it contains a reachable View 3828 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()" 3829 * is a View whose parents do not block descendants focus. 3830 * 3831 * Only {@link #VISIBLE} views are considered focusable. 3832 * 3833 * @return True if the view is focusable or if the view contains a focusable 3834 * View, false otherwise. 3835 * 3836 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS 3837 */ 3838 public boolean hasFocusable() { 3839 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable(); 3840 } 3841 3842 /** 3843 * Called by the view system when the focus state of this view changes. 3844 * When the focus change event is caused by directional navigation, direction 3845 * and previouslyFocusedRect provide insight into where the focus is coming from. 3846 * When overriding, be sure to call up through to the super class so that 3847 * the standard focus handling will occur. 3848 * 3849 * @param gainFocus True if the View has focus; false otherwise. 3850 * @param direction The direction focus has moved when requestFocus() 3851 * is called to give this view focus. Values are 3852 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT}, 3853 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}. 3854 * It may not always apply, in which case use the default. 3855 * @param previouslyFocusedRect The rectangle, in this view's coordinate 3856 * system, of the previously focused view. If applicable, this will be 3857 * passed in as finer grained information about where the focus is coming 3858 * from (in addition to direction). Will be <code>null</code> otherwise. 3859 */ 3860 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) { 3861 if (gainFocus) { 3862 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED); 3863 } 3864 3865 InputMethodManager imm = InputMethodManager.peekInstance(); 3866 if (!gainFocus) { 3867 if (isPressed()) { 3868 setPressed(false); 3869 } 3870 if (imm != null && mAttachInfo != null 3871 && mAttachInfo.mHasWindowFocus) { 3872 imm.focusOut(this); 3873 } 3874 onFocusLost(); 3875 } else if (imm != null && mAttachInfo != null 3876 && mAttachInfo.mHasWindowFocus) { 3877 imm.focusIn(this); 3878 } 3879 3880 invalidate(true); 3881 ListenerInfo li = mListenerInfo; 3882 if (li != null && li.mOnFocusChangeListener != null) { 3883 li.mOnFocusChangeListener.onFocusChange(this, gainFocus); 3884 } 3885 3886 if (mAttachInfo != null) { 3887 mAttachInfo.mKeyDispatchState.reset(this); 3888 } 3889 } 3890 3891 /** 3892 * Sends an accessibility event of the given type. If accessiiblity is 3893 * not enabled this method has no effect. The default implementation calls 3894 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first 3895 * to populate information about the event source (this View), then calls 3896 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to 3897 * populate the text content of the event source including its descendants, 3898 * and last calls 3899 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)} 3900 * on its parent to resuest sending of the event to interested parties. 3901 * <p> 3902 * If an {@link AccessibilityDelegate} has been specified via calling 3903 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 3904 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is 3905 * responsible for handling this call. 3906 * </p> 3907 * 3908 * @param eventType The type of the event to send, as defined by several types from 3909 * {@link android.view.accessibility.AccessibilityEvent}, such as 3910 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or 3911 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}. 3912 * 3913 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 3914 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 3915 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent) 3916 * @see AccessibilityDelegate 3917 */ 3918 public void sendAccessibilityEvent(int eventType) { 3919 if (mAccessibilityDelegate != null) { 3920 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType); 3921 } else { 3922 sendAccessibilityEventInternal(eventType); 3923 } 3924 } 3925 3926 /** 3927 * @see #sendAccessibilityEvent(int) 3928 * 3929 * Note: Called from the default {@link AccessibilityDelegate}. 3930 */ 3931 void sendAccessibilityEventInternal(int eventType) { 3932 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 3933 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType)); 3934 } 3935 } 3936 3937 /** 3938 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but 3939 * takes as an argument an empty {@link AccessibilityEvent} and does not 3940 * perform a check whether accessibility is enabled. 3941 * <p> 3942 * If an {@link AccessibilityDelegate} has been specified via calling 3943 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 3944 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)} 3945 * is responsible for handling this call. 3946 * </p> 3947 * 3948 * @param event The event to send. 3949 * 3950 * @see #sendAccessibilityEvent(int) 3951 */ 3952 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) { 3953 if (mAccessibilityDelegate != null) { 3954 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event); 3955 } else { 3956 sendAccessibilityEventUncheckedInternal(event); 3957 } 3958 } 3959 3960 /** 3961 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent) 3962 * 3963 * Note: Called from the default {@link AccessibilityDelegate}. 3964 */ 3965 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) { 3966 if (!isShown()) { 3967 return; 3968 } 3969 onInitializeAccessibilityEvent(event); 3970 // Only a subset of accessibility events populates text content. 3971 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) { 3972 dispatchPopulateAccessibilityEvent(event); 3973 } 3974 // In the beginning we called #isShown(), so we know that getParent() is not null. 3975 getParent().requestSendAccessibilityEvent(this, event); 3976 } 3977 3978 /** 3979 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then 3980 * to its children for adding their text content to the event. Note that the 3981 * event text is populated in a separate dispatch path since we add to the 3982 * event not only the text of the source but also the text of all its descendants. 3983 * A typical implementation will call 3984 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view 3985 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 3986 * on each child. Override this method if custom population of the event text 3987 * content is required. 3988 * <p> 3989 * If an {@link AccessibilityDelegate} has been specified via calling 3990 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 3991 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)} 3992 * is responsible for handling this call. 3993 * </p> 3994 * <p> 3995 * <em>Note:</em> Accessibility events of certain types are not dispatched for 3996 * populating the event text via this method. For details refer to {@link AccessibilityEvent}. 3997 * </p> 3998 * 3999 * @param event The event. 4000 * 4001 * @return True if the event population was completed. 4002 */ 4003 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 4004 if (mAccessibilityDelegate != null) { 4005 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event); 4006 } else { 4007 return dispatchPopulateAccessibilityEventInternal(event); 4008 } 4009 } 4010 4011 /** 4012 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4013 * 4014 * Note: Called from the default {@link AccessibilityDelegate}. 4015 */ 4016 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) { 4017 onPopulateAccessibilityEvent(event); 4018 return false; 4019 } 4020 4021 /** 4022 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} 4023 * giving a chance to this View to populate the accessibility event with its 4024 * text content. While this method is free to modify event 4025 * attributes other than text content, doing so should normally be performed in 4026 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}. 4027 * <p> 4028 * Example: Adding formatted date string to an accessibility event in addition 4029 * to the text added by the super implementation: 4030 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 4031 * super.onPopulateAccessibilityEvent(event); 4032 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY; 4033 * String selectedDateUtterance = DateUtils.formatDateTime(mContext, 4034 * mCurrentDate.getTimeInMillis(), flags); 4035 * event.getText().add(selectedDateUtterance); 4036 * }</pre> 4037 * <p> 4038 * If an {@link AccessibilityDelegate} has been specified via calling 4039 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4040 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)} 4041 * is responsible for handling this call. 4042 * </p> 4043 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 4044 * information to the event, in case the default implementation has basic information to add. 4045 * </p> 4046 * 4047 * @param event The accessibility event which to populate. 4048 * 4049 * @see #sendAccessibilityEvent(int) 4050 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4051 */ 4052 public void onPopulateAccessibilityEvent(AccessibilityEvent event) { 4053 if (mAccessibilityDelegate != null) { 4054 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event); 4055 } else { 4056 onPopulateAccessibilityEventInternal(event); 4057 } 4058 } 4059 4060 /** 4061 * @see #onPopulateAccessibilityEvent(AccessibilityEvent) 4062 * 4063 * Note: Called from the default {@link AccessibilityDelegate}. 4064 */ 4065 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) { 4066 4067 } 4068 4069 /** 4070 * Initializes an {@link AccessibilityEvent} with information about 4071 * this View which is the event source. In other words, the source of 4072 * an accessibility event is the view whose state change triggered firing 4073 * the event. 4074 * <p> 4075 * Example: Setting the password property of an event in addition 4076 * to properties set by the super implementation: 4077 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 4078 * super.onInitializeAccessibilityEvent(event); 4079 * event.setPassword(true); 4080 * }</pre> 4081 * <p> 4082 * If an {@link AccessibilityDelegate} has been specified via calling 4083 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4084 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)} 4085 * is responsible for handling this call. 4086 * </p> 4087 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding 4088 * information to the event, in case the default implementation has basic information to add. 4089 * </p> 4090 * @param event The event to initialize. 4091 * 4092 * @see #sendAccessibilityEvent(int) 4093 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent) 4094 */ 4095 public void onInitializeAccessibilityEvent(AccessibilityEvent event) { 4096 if (mAccessibilityDelegate != null) { 4097 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event); 4098 } else { 4099 onInitializeAccessibilityEventInternal(event); 4100 } 4101 } 4102 4103 /** 4104 * @see #onInitializeAccessibilityEvent(AccessibilityEvent) 4105 * 4106 * Note: Called from the default {@link AccessibilityDelegate}. 4107 */ 4108 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) { 4109 event.setSource(this); 4110 event.setClassName(getClass().getName()); 4111 event.setPackageName(getContext().getPackageName()); 4112 event.setEnabled(isEnabled()); 4113 event.setContentDescription(mContentDescription); 4114 4115 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) { 4116 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList; 4117 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, 4118 FOCUSABLES_ALL); 4119 event.setItemCount(focusablesTempList.size()); 4120 event.setCurrentItemIndex(focusablesTempList.indexOf(this)); 4121 focusablesTempList.clear(); 4122 } 4123 } 4124 4125 /** 4126 * Returns an {@link AccessibilityNodeInfo} representing this view from the 4127 * point of view of an {@link android.accessibilityservice.AccessibilityService}. 4128 * This method is responsible for obtaining an accessibility node info from a 4129 * pool of reusable instances and calling 4130 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to 4131 * initialize the former. 4132 * <p> 4133 * Note: The client is responsible for recycling the obtained instance by calling 4134 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation. 4135 * </p> 4136 * 4137 * @return A populated {@link AccessibilityNodeInfo}. 4138 * 4139 * @see AccessibilityNodeInfo 4140 */ 4141 public AccessibilityNodeInfo createAccessibilityNodeInfo() { 4142 AccessibilityNodeProvider provider = getAccessibilityNodeProvider(); 4143 if (provider != null) { 4144 return provider.createAccessibilityNodeInfo(View.NO_ID); 4145 } else { 4146 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this); 4147 onInitializeAccessibilityNodeInfo(info); 4148 return info; 4149 } 4150 } 4151 4152 /** 4153 * Initializes an {@link AccessibilityNodeInfo} with information about this view. 4154 * The base implementation sets: 4155 * <ul> 4156 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li> 4157 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li> 4158 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li> 4159 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li> 4160 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li> 4161 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li> 4162 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li> 4163 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li> 4164 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li> 4165 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li> 4166 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li> 4167 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li> 4168 * </ul> 4169 * <p> 4170 * Subclasses should override this method, call the super implementation, 4171 * and set additional attributes. 4172 * </p> 4173 * <p> 4174 * If an {@link AccessibilityDelegate} has been specified via calling 4175 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4176 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)} 4177 * is responsible for handling this call. 4178 * </p> 4179 * 4180 * @param info The instance to initialize. 4181 */ 4182 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 4183 if (mAccessibilityDelegate != null) { 4184 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info); 4185 } else { 4186 onInitializeAccessibilityNodeInfoInternal(info); 4187 } 4188 } 4189 4190 /** 4191 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 4192 * 4193 * Note: Called from the default {@link AccessibilityDelegate}. 4194 */ 4195 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) { 4196 Rect bounds = mAttachInfo.mTmpInvalRect; 4197 getDrawingRect(bounds); 4198 info.setBoundsInParent(bounds); 4199 4200 int[] locationOnScreen = mAttachInfo.mInvalidateChildLocation; 4201 getLocationOnScreen(locationOnScreen); 4202 bounds.offsetTo(0, 0); 4203 bounds.offset(locationOnScreen[0], locationOnScreen[1]); 4204 info.setBoundsInScreen(bounds); 4205 4206 if ((mPrivateFlags & IS_ROOT_NAMESPACE) == 0) { 4207 ViewParent parent = getParent(); 4208 if (parent instanceof View) { 4209 View parentView = (View) parent; 4210 info.setParent(parentView); 4211 } 4212 } 4213 4214 info.setPackageName(mContext.getPackageName()); 4215 info.setClassName(getClass().getName()); 4216 info.setContentDescription(getContentDescription()); 4217 4218 info.setEnabled(isEnabled()); 4219 info.setClickable(isClickable()); 4220 info.setFocusable(isFocusable()); 4221 info.setFocused(isFocused()); 4222 info.setSelected(isSelected()); 4223 info.setLongClickable(isLongClickable()); 4224 4225 // TODO: These make sense only if we are in an AdapterView but all 4226 // views can be selected. Maybe from accessiiblity perspective 4227 // we should report as selectable view in an AdapterView. 4228 info.addAction(AccessibilityNodeInfo.ACTION_SELECT); 4229 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION); 4230 4231 if (isFocusable()) { 4232 if (isFocused()) { 4233 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS); 4234 } else { 4235 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS); 4236 } 4237 } 4238 } 4239 4240 /** 4241 * Sets a delegate for implementing accessibility support via compositon as 4242 * opposed to inheritance. The delegate's primary use is for implementing 4243 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}. 4244 * 4245 * @param delegate The delegate instance. 4246 * 4247 * @see AccessibilityDelegate 4248 */ 4249 public void setAccessibilityDelegate(AccessibilityDelegate delegate) { 4250 mAccessibilityDelegate = delegate; 4251 } 4252 4253 /** 4254 * Gets the provider for managing a virtual view hierarchy rooted at this View 4255 * and reported to {@link android.accessibilityservice.AccessibilityService}s 4256 * that explore the window content. 4257 * <p> 4258 * If this method returns an instance, this instance is responsible for managing 4259 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this 4260 * View including the one representing the View itself. Similarly the returned 4261 * instance is responsible for performing accessibility actions on any virtual 4262 * view or the root view itself. 4263 * </p> 4264 * <p> 4265 * If an {@link AccessibilityDelegate} has been specified via calling 4266 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its 4267 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)} 4268 * is responsible for handling this call. 4269 * </p> 4270 * 4271 * @return The provider. 4272 * 4273 * @see AccessibilityNodeProvider 4274 */ 4275 public AccessibilityNodeProvider getAccessibilityNodeProvider() { 4276 if (mAccessibilityDelegate != null) { 4277 return mAccessibilityDelegate.getAccessibilityNodeProvider(this); 4278 } else { 4279 return null; 4280 } 4281 } 4282 4283 /** 4284 * Gets the unique identifier of this view on the screen for accessibility purposes. 4285 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned. 4286 * 4287 * @return The view accessibility id. 4288 * 4289 * @hide 4290 */ 4291 public int getAccessibilityViewId() { 4292 if (mAccessibilityViewId == NO_ID) { 4293 mAccessibilityViewId = sNextAccessibilityViewId++; 4294 } 4295 return mAccessibilityViewId; 4296 } 4297 4298 /** 4299 * Gets the unique identifier of the window in which this View reseides. 4300 * 4301 * @return The window accessibility id. 4302 * 4303 * @hide 4304 */ 4305 public int getAccessibilityWindowId() { 4306 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID; 4307 } 4308 4309 /** 4310 * Gets the {@link View} description. It briefly describes the view and is 4311 * primarily used for accessibility support. Set this property to enable 4312 * better accessibility support for your application. This is especially 4313 * true for views that do not have textual representation (For example, 4314 * ImageButton). 4315 * 4316 * @return The content descriptiopn. 4317 * 4318 * @attr ref android.R.styleable#View_contentDescription 4319 */ 4320 public CharSequence getContentDescription() { 4321 return mContentDescription; 4322 } 4323 4324 /** 4325 * Sets the {@link View} description. It briefly describes the view and is 4326 * primarily used for accessibility support. Set this property to enable 4327 * better accessibility support for your application. This is especially 4328 * true for views that do not have textual representation (For example, 4329 * ImageButton). 4330 * 4331 * @param contentDescription The content description. 4332 * 4333 * @attr ref android.R.styleable#View_contentDescription 4334 */ 4335 @RemotableViewMethod 4336 public void setContentDescription(CharSequence contentDescription) { 4337 mContentDescription = contentDescription; 4338 } 4339 4340 /** 4341 * Invoked whenever this view loses focus, either by losing window focus or by losing 4342 * focus within its window. This method can be used to clear any state tied to the 4343 * focus. For instance, if a button is held pressed with the trackball and the window 4344 * loses focus, this method can be used to cancel the press. 4345 * 4346 * Subclasses of View overriding this method should always call super.onFocusLost(). 4347 * 4348 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 4349 * @see #onWindowFocusChanged(boolean) 4350 * 4351 * @hide pending API council approval 4352 */ 4353 protected void onFocusLost() { 4354 resetPressedState(); 4355 } 4356 4357 private void resetPressedState() { 4358 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 4359 return; 4360 } 4361 4362 if (isPressed()) { 4363 setPressed(false); 4364 4365 if (!mHasPerformedLongPress) { 4366 removeLongPressCallback(); 4367 } 4368 } 4369 } 4370 4371 /** 4372 * Returns true if this view has focus 4373 * 4374 * @return True if this view has focus, false otherwise. 4375 */ 4376 @ViewDebug.ExportedProperty(category = "focus") 4377 public boolean isFocused() { 4378 return (mPrivateFlags & FOCUSED) != 0; 4379 } 4380 4381 /** 4382 * Find the view in the hierarchy rooted at this view that currently has 4383 * focus. 4384 * 4385 * @return The view that currently has focus, or null if no focused view can 4386 * be found. 4387 */ 4388 public View findFocus() { 4389 return (mPrivateFlags & FOCUSED) != 0 ? this : null; 4390 } 4391 4392 /** 4393 * Change whether this view is one of the set of scrollable containers in 4394 * its window. This will be used to determine whether the window can 4395 * resize or must pan when a soft input area is open -- scrollable 4396 * containers allow the window to use resize mode since the container 4397 * will appropriately shrink. 4398 */ 4399 public void setScrollContainer(boolean isScrollContainer) { 4400 if (isScrollContainer) { 4401 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) { 4402 mAttachInfo.mScrollContainers.add(this); 4403 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 4404 } 4405 mPrivateFlags |= SCROLL_CONTAINER; 4406 } else { 4407 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) { 4408 mAttachInfo.mScrollContainers.remove(this); 4409 } 4410 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED); 4411 } 4412 } 4413 4414 /** 4415 * Returns the quality of the drawing cache. 4416 * 4417 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 4418 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 4419 * 4420 * @see #setDrawingCacheQuality(int) 4421 * @see #setDrawingCacheEnabled(boolean) 4422 * @see #isDrawingCacheEnabled() 4423 * 4424 * @attr ref android.R.styleable#View_drawingCacheQuality 4425 */ 4426 public int getDrawingCacheQuality() { 4427 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 4428 } 4429 4430 /** 4431 * Set the drawing cache quality of this view. This value is used only when the 4432 * drawing cache is enabled 4433 * 4434 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 4435 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 4436 * 4437 * @see #getDrawingCacheQuality() 4438 * @see #setDrawingCacheEnabled(boolean) 4439 * @see #isDrawingCacheEnabled() 4440 * 4441 * @attr ref android.R.styleable#View_drawingCacheQuality 4442 */ 4443 public void setDrawingCacheQuality(int quality) { 4444 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 4445 } 4446 4447 /** 4448 * Returns whether the screen should remain on, corresponding to the current 4449 * value of {@link #KEEP_SCREEN_ON}. 4450 * 4451 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 4452 * 4453 * @see #setKeepScreenOn(boolean) 4454 * 4455 * @attr ref android.R.styleable#View_keepScreenOn 4456 */ 4457 public boolean getKeepScreenOn() { 4458 return (mViewFlags & KEEP_SCREEN_ON) != 0; 4459 } 4460 4461 /** 4462 * Controls whether the screen should remain on, modifying the 4463 * value of {@link #KEEP_SCREEN_ON}. 4464 * 4465 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 4466 * 4467 * @see #getKeepScreenOn() 4468 * 4469 * @attr ref android.R.styleable#View_keepScreenOn 4470 */ 4471 public void setKeepScreenOn(boolean keepScreenOn) { 4472 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 4473 } 4474 4475 /** 4476 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 4477 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 4478 * 4479 * @attr ref android.R.styleable#View_nextFocusLeft 4480 */ 4481 public int getNextFocusLeftId() { 4482 return mNextFocusLeftId; 4483 } 4484 4485 /** 4486 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 4487 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 4488 * decide automatically. 4489 * 4490 * @attr ref android.R.styleable#View_nextFocusLeft 4491 */ 4492 public void setNextFocusLeftId(int nextFocusLeftId) { 4493 mNextFocusLeftId = nextFocusLeftId; 4494 } 4495 4496 /** 4497 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 4498 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 4499 * 4500 * @attr ref android.R.styleable#View_nextFocusRight 4501 */ 4502 public int getNextFocusRightId() { 4503 return mNextFocusRightId; 4504 } 4505 4506 /** 4507 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 4508 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 4509 * decide automatically. 4510 * 4511 * @attr ref android.R.styleable#View_nextFocusRight 4512 */ 4513 public void setNextFocusRightId(int nextFocusRightId) { 4514 mNextFocusRightId = nextFocusRightId; 4515 } 4516 4517 /** 4518 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 4519 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 4520 * 4521 * @attr ref android.R.styleable#View_nextFocusUp 4522 */ 4523 public int getNextFocusUpId() { 4524 return mNextFocusUpId; 4525 } 4526 4527 /** 4528 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 4529 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 4530 * decide automatically. 4531 * 4532 * @attr ref android.R.styleable#View_nextFocusUp 4533 */ 4534 public void setNextFocusUpId(int nextFocusUpId) { 4535 mNextFocusUpId = nextFocusUpId; 4536 } 4537 4538 /** 4539 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 4540 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 4541 * 4542 * @attr ref android.R.styleable#View_nextFocusDown 4543 */ 4544 public int getNextFocusDownId() { 4545 return mNextFocusDownId; 4546 } 4547 4548 /** 4549 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 4550 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 4551 * decide automatically. 4552 * 4553 * @attr ref android.R.styleable#View_nextFocusDown 4554 */ 4555 public void setNextFocusDownId(int nextFocusDownId) { 4556 mNextFocusDownId = nextFocusDownId; 4557 } 4558 4559 /** 4560 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 4561 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 4562 * 4563 * @attr ref android.R.styleable#View_nextFocusForward 4564 */ 4565 public int getNextFocusForwardId() { 4566 return mNextFocusForwardId; 4567 } 4568 4569 /** 4570 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 4571 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 4572 * decide automatically. 4573 * 4574 * @attr ref android.R.styleable#View_nextFocusForward 4575 */ 4576 public void setNextFocusForwardId(int nextFocusForwardId) { 4577 mNextFocusForwardId = nextFocusForwardId; 4578 } 4579 4580 /** 4581 * Returns the visibility of this view and all of its ancestors 4582 * 4583 * @return True if this view and all of its ancestors are {@link #VISIBLE} 4584 */ 4585 public boolean isShown() { 4586 View current = this; 4587 //noinspection ConstantConditions 4588 do { 4589 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 4590 return false; 4591 } 4592 ViewParent parent = current.mParent; 4593 if (parent == null) { 4594 return false; // We are not attached to the view root 4595 } 4596 if (!(parent instanceof View)) { 4597 return true; 4598 } 4599 current = (View) parent; 4600 } while (current != null); 4601 4602 return false; 4603 } 4604 4605 /** 4606 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag 4607 * is set 4608 * 4609 * @param insets Insets for system windows 4610 * 4611 * @return True if this view applied the insets, false otherwise 4612 */ 4613 protected boolean fitSystemWindows(Rect insets) { 4614 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 4615 mPaddingLeft = insets.left; 4616 mPaddingTop = insets.top; 4617 mPaddingRight = insets.right; 4618 mPaddingBottom = insets.bottom; 4619 requestLayout(); 4620 return true; 4621 } 4622 return false; 4623 } 4624 4625 /** 4626 * Set whether or not this view should account for system screen decorations 4627 * such as the status bar and inset its content. This allows this view to be 4628 * positioned in absolute screen coordinates and remain visible to the user. 4629 * 4630 * <p>This should only be used by top-level window decor views. 4631 * 4632 * @param fitSystemWindows true to inset content for system screen decorations, false for 4633 * default behavior. 4634 * 4635 * @attr ref android.R.styleable#View_fitsSystemWindows 4636 */ 4637 public void setFitsSystemWindows(boolean fitSystemWindows) { 4638 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS); 4639 } 4640 4641 /** 4642 * Check for the FITS_SYSTEM_WINDOWS flag. If this method returns true, this view 4643 * will account for system screen decorations such as the status bar and inset its 4644 * content. This allows the view to be positioned in absolute screen coordinates 4645 * and remain visible to the user. 4646 * 4647 * @return true if this view will adjust its content bounds for system screen decorations. 4648 * 4649 * @attr ref android.R.styleable#View_fitsSystemWindows 4650 */ 4651 public boolean fitsSystemWindows() { 4652 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 4653 } 4654 4655 /** 4656 * Returns the visibility status for this view. 4657 * 4658 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 4659 * @attr ref android.R.styleable#View_visibility 4660 */ 4661 @ViewDebug.ExportedProperty(mapping = { 4662 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 4663 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 4664 @ViewDebug.IntToString(from = GONE, to = "GONE") 4665 }) 4666 public int getVisibility() { 4667 return mViewFlags & VISIBILITY_MASK; 4668 } 4669 4670 /** 4671 * Set the enabled state of this view. 4672 * 4673 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 4674 * @attr ref android.R.styleable#View_visibility 4675 */ 4676 @RemotableViewMethod 4677 public void setVisibility(int visibility) { 4678 setFlags(visibility, VISIBILITY_MASK); 4679 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false); 4680 } 4681 4682 /** 4683 * Returns the enabled status for this view. The interpretation of the 4684 * enabled state varies by subclass. 4685 * 4686 * @return True if this view is enabled, false otherwise. 4687 */ 4688 @ViewDebug.ExportedProperty 4689 public boolean isEnabled() { 4690 return (mViewFlags & ENABLED_MASK) == ENABLED; 4691 } 4692 4693 /** 4694 * Set the enabled state of this view. The interpretation of the enabled 4695 * state varies by subclass. 4696 * 4697 * @param enabled True if this view is enabled, false otherwise. 4698 */ 4699 @RemotableViewMethod 4700 public void setEnabled(boolean enabled) { 4701 if (enabled == isEnabled()) return; 4702 4703 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 4704 4705 /* 4706 * The View most likely has to change its appearance, so refresh 4707 * the drawable state. 4708 */ 4709 refreshDrawableState(); 4710 4711 // Invalidate too, since the default behavior for views is to be 4712 // be drawn at 50% alpha rather than to change the drawable. 4713 invalidate(true); 4714 } 4715 4716 /** 4717 * Set whether this view can receive the focus. 4718 * 4719 * Setting this to false will also ensure that this view is not focusable 4720 * in touch mode. 4721 * 4722 * @param focusable If true, this view can receive the focus. 4723 * 4724 * @see #setFocusableInTouchMode(boolean) 4725 * @attr ref android.R.styleable#View_focusable 4726 */ 4727 public void setFocusable(boolean focusable) { 4728 if (!focusable) { 4729 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 4730 } 4731 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 4732 } 4733 4734 /** 4735 * Set whether this view can receive focus while in touch mode. 4736 * 4737 * Setting this to true will also ensure that this view is focusable. 4738 * 4739 * @param focusableInTouchMode If true, this view can receive the focus while 4740 * in touch mode. 4741 * 4742 * @see #setFocusable(boolean) 4743 * @attr ref android.R.styleable#View_focusableInTouchMode 4744 */ 4745 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 4746 // Focusable in touch mode should always be set before the focusable flag 4747 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 4748 // which, in touch mode, will not successfully request focus on this view 4749 // because the focusable in touch mode flag is not set 4750 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 4751 if (focusableInTouchMode) { 4752 setFlags(FOCUSABLE, FOCUSABLE_MASK); 4753 } 4754 } 4755 4756 /** 4757 * Set whether this view should have sound effects enabled for events such as 4758 * clicking and touching. 4759 * 4760 * <p>You may wish to disable sound effects for a view if you already play sounds, 4761 * for instance, a dial key that plays dtmf tones. 4762 * 4763 * @param soundEffectsEnabled whether sound effects are enabled for this view. 4764 * @see #isSoundEffectsEnabled() 4765 * @see #playSoundEffect(int) 4766 * @attr ref android.R.styleable#View_soundEffectsEnabled 4767 */ 4768 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 4769 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 4770 } 4771 4772 /** 4773 * @return whether this view should have sound effects enabled for events such as 4774 * clicking and touching. 4775 * 4776 * @see #setSoundEffectsEnabled(boolean) 4777 * @see #playSoundEffect(int) 4778 * @attr ref android.R.styleable#View_soundEffectsEnabled 4779 */ 4780 @ViewDebug.ExportedProperty 4781 public boolean isSoundEffectsEnabled() { 4782 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 4783 } 4784 4785 /** 4786 * Set whether this view should have haptic feedback for events such as 4787 * long presses. 4788 * 4789 * <p>You may wish to disable haptic feedback if your view already controls 4790 * its own haptic feedback. 4791 * 4792 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 4793 * @see #isHapticFeedbackEnabled() 4794 * @see #performHapticFeedback(int) 4795 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 4796 */ 4797 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 4798 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 4799 } 4800 4801 /** 4802 * @return whether this view should have haptic feedback enabled for events 4803 * long presses. 4804 * 4805 * @see #setHapticFeedbackEnabled(boolean) 4806 * @see #performHapticFeedback(int) 4807 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 4808 */ 4809 @ViewDebug.ExportedProperty 4810 public boolean isHapticFeedbackEnabled() { 4811 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 4812 } 4813 4814 /** 4815 * Returns the layout direction for this view. 4816 * 4817 * @return One of {@link #LAYOUT_DIRECTION_LTR}, 4818 * {@link #LAYOUT_DIRECTION_RTL}, 4819 * {@link #LAYOUT_DIRECTION_INHERIT} or 4820 * {@link #LAYOUT_DIRECTION_LOCALE}. 4821 * @attr ref android.R.styleable#View_layoutDirection 4822 * 4823 * @hide 4824 */ 4825 @ViewDebug.ExportedProperty(category = "layout", mapping = { 4826 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"), 4827 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"), 4828 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"), 4829 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE") 4830 }) 4831 public int getLayoutDirection() { 4832 return mViewFlags & LAYOUT_DIRECTION_MASK; 4833 } 4834 4835 /** 4836 * Set the layout direction for this view. This will propagate a reset of layout direction 4837 * resolution to the view's children and resolve layout direction for this view. 4838 * 4839 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR}, 4840 * {@link #LAYOUT_DIRECTION_RTL}, 4841 * {@link #LAYOUT_DIRECTION_INHERIT} or 4842 * {@link #LAYOUT_DIRECTION_LOCALE}. 4843 * 4844 * @attr ref android.R.styleable#View_layoutDirection 4845 * 4846 * @hide 4847 */ 4848 @RemotableViewMethod 4849 public void setLayoutDirection(int layoutDirection) { 4850 if (getLayoutDirection() != layoutDirection) { 4851 resetResolvedLayoutDirection(); 4852 // Setting the flag will also request a layout. 4853 setFlags(layoutDirection, LAYOUT_DIRECTION_MASK); 4854 } 4855 } 4856 4857 /** 4858 * Returns the resolved layout direction for this view. 4859 * 4860 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns 4861 * {@link #LAYOUT_DIRECTION_LTR} id the layout direction is not RTL. 4862 * 4863 * @hide 4864 */ 4865 @ViewDebug.ExportedProperty(category = "layout", mapping = { 4866 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"), 4867 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL") 4868 }) 4869 public int getResolvedLayoutDirection() { 4870 resolveLayoutDirectionIfNeeded(); 4871 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ? 4872 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR; 4873 } 4874 4875 /** 4876 * <p>Indicates whether or not this view's layout is right-to-left. This is resolved from 4877 * layout attribute and/or the inherited value from the parent.</p> 4878 * 4879 * @return true if the layout is right-to-left. 4880 * 4881 * @hide 4882 */ 4883 @ViewDebug.ExportedProperty(category = "layout") 4884 public boolean isLayoutRtl() { 4885 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL); 4886 } 4887 4888 /** 4889 * If this view doesn't do any drawing on its own, set this flag to 4890 * allow further optimizations. By default, this flag is not set on 4891 * View, but could be set on some View subclasses such as ViewGroup. 4892 * 4893 * Typically, if you override {@link #onDraw(android.graphics.Canvas)} 4894 * you should clear this flag. 4895 * 4896 * @param willNotDraw whether or not this View draw on its own 4897 */ 4898 public void setWillNotDraw(boolean willNotDraw) { 4899 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 4900 } 4901 4902 /** 4903 * Returns whether or not this View draws on its own. 4904 * 4905 * @return true if this view has nothing to draw, false otherwise 4906 */ 4907 @ViewDebug.ExportedProperty(category = "drawing") 4908 public boolean willNotDraw() { 4909 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 4910 } 4911 4912 /** 4913 * When a View's drawing cache is enabled, drawing is redirected to an 4914 * offscreen bitmap. Some views, like an ImageView, must be able to 4915 * bypass this mechanism if they already draw a single bitmap, to avoid 4916 * unnecessary usage of the memory. 4917 * 4918 * @param willNotCacheDrawing true if this view does not cache its 4919 * drawing, false otherwise 4920 */ 4921 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 4922 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 4923 } 4924 4925 /** 4926 * Returns whether or not this View can cache its drawing or not. 4927 * 4928 * @return true if this view does not cache its drawing, false otherwise 4929 */ 4930 @ViewDebug.ExportedProperty(category = "drawing") 4931 public boolean willNotCacheDrawing() { 4932 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 4933 } 4934 4935 /** 4936 * Indicates whether this view reacts to click events or not. 4937 * 4938 * @return true if the view is clickable, false otherwise 4939 * 4940 * @see #setClickable(boolean) 4941 * @attr ref android.R.styleable#View_clickable 4942 */ 4943 @ViewDebug.ExportedProperty 4944 public boolean isClickable() { 4945 return (mViewFlags & CLICKABLE) == CLICKABLE; 4946 } 4947 4948 /** 4949 * Enables or disables click events for this view. When a view 4950 * is clickable it will change its state to "pressed" on every click. 4951 * Subclasses should set the view clickable to visually react to 4952 * user's clicks. 4953 * 4954 * @param clickable true to make the view clickable, false otherwise 4955 * 4956 * @see #isClickable() 4957 * @attr ref android.R.styleable#View_clickable 4958 */ 4959 public void setClickable(boolean clickable) { 4960 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 4961 } 4962 4963 /** 4964 * Indicates whether this view reacts to long click events or not. 4965 * 4966 * @return true if the view is long clickable, false otherwise 4967 * 4968 * @see #setLongClickable(boolean) 4969 * @attr ref android.R.styleable#View_longClickable 4970 */ 4971 public boolean isLongClickable() { 4972 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 4973 } 4974 4975 /** 4976 * Enables or disables long click events for this view. When a view is long 4977 * clickable it reacts to the user holding down the button for a longer 4978 * duration than a tap. This event can either launch the listener or a 4979 * context menu. 4980 * 4981 * @param longClickable true to make the view long clickable, false otherwise 4982 * @see #isLongClickable() 4983 * @attr ref android.R.styleable#View_longClickable 4984 */ 4985 public void setLongClickable(boolean longClickable) { 4986 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 4987 } 4988 4989 /** 4990 * Sets the pressed state for this view. 4991 * 4992 * @see #isClickable() 4993 * @see #setClickable(boolean) 4994 * 4995 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 4996 * the View's internal state from a previously set "pressed" state. 4997 */ 4998 public void setPressed(boolean pressed) { 4999 if (pressed) { 5000 mPrivateFlags |= PRESSED; 5001 } else { 5002 mPrivateFlags &= ~PRESSED; 5003 } 5004 refreshDrawableState(); 5005 dispatchSetPressed(pressed); 5006 } 5007 5008 /** 5009 * Dispatch setPressed to all of this View's children. 5010 * 5011 * @see #setPressed(boolean) 5012 * 5013 * @param pressed The new pressed state 5014 */ 5015 protected void dispatchSetPressed(boolean pressed) { 5016 } 5017 5018 /** 5019 * Indicates whether the view is currently in pressed state. Unless 5020 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 5021 * the pressed state. 5022 * 5023 * @see #setPressed(boolean) 5024 * @see #isClickable() 5025 * @see #setClickable(boolean) 5026 * 5027 * @return true if the view is currently pressed, false otherwise 5028 */ 5029 public boolean isPressed() { 5030 return (mPrivateFlags & PRESSED) == PRESSED; 5031 } 5032 5033 /** 5034 * Indicates whether this view will save its state (that is, 5035 * whether its {@link #onSaveInstanceState} method will be called). 5036 * 5037 * @return Returns true if the view state saving is enabled, else false. 5038 * 5039 * @see #setSaveEnabled(boolean) 5040 * @attr ref android.R.styleable#View_saveEnabled 5041 */ 5042 public boolean isSaveEnabled() { 5043 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 5044 } 5045 5046 /** 5047 * Controls whether the saving of this view's state is 5048 * enabled (that is, whether its {@link #onSaveInstanceState} method 5049 * will be called). Note that even if freezing is enabled, the 5050 * view still must have an id assigned to it (via {@link #setId(int)}) 5051 * for its state to be saved. This flag can only disable the 5052 * saving of this view; any child views may still have their state saved. 5053 * 5054 * @param enabled Set to false to <em>disable</em> state saving, or true 5055 * (the default) to allow it. 5056 * 5057 * @see #isSaveEnabled() 5058 * @see #setId(int) 5059 * @see #onSaveInstanceState() 5060 * @attr ref android.R.styleable#View_saveEnabled 5061 */ 5062 public void setSaveEnabled(boolean enabled) { 5063 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 5064 } 5065 5066 /** 5067 * Gets whether the framework should discard touches when the view's 5068 * window is obscured by another visible window. 5069 * Refer to the {@link View} security documentation for more details. 5070 * 5071 * @return True if touch filtering is enabled. 5072 * 5073 * @see #setFilterTouchesWhenObscured(boolean) 5074 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 5075 */ 5076 @ViewDebug.ExportedProperty 5077 public boolean getFilterTouchesWhenObscured() { 5078 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 5079 } 5080 5081 /** 5082 * Sets whether the framework should discard touches when the view's 5083 * window is obscured by another visible window. 5084 * Refer to the {@link View} security documentation for more details. 5085 * 5086 * @param enabled True if touch filtering should be enabled. 5087 * 5088 * @see #getFilterTouchesWhenObscured 5089 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 5090 */ 5091 public void setFilterTouchesWhenObscured(boolean enabled) { 5092 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED, 5093 FILTER_TOUCHES_WHEN_OBSCURED); 5094 } 5095 5096 /** 5097 * Indicates whether the entire hierarchy under this view will save its 5098 * state when a state saving traversal occurs from its parent. The default 5099 * is true; if false, these views will not be saved unless 5100 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 5101 * 5102 * @return Returns true if the view state saving from parent is enabled, else false. 5103 * 5104 * @see #setSaveFromParentEnabled(boolean) 5105 */ 5106 public boolean isSaveFromParentEnabled() { 5107 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 5108 } 5109 5110 /** 5111 * Controls whether the entire hierarchy under this view will save its 5112 * state when a state saving traversal occurs from its parent. The default 5113 * is true; if false, these views will not be saved unless 5114 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 5115 * 5116 * @param enabled Set to false to <em>disable</em> state saving, or true 5117 * (the default) to allow it. 5118 * 5119 * @see #isSaveFromParentEnabled() 5120 * @see #setId(int) 5121 * @see #onSaveInstanceState() 5122 */ 5123 public void setSaveFromParentEnabled(boolean enabled) { 5124 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 5125 } 5126 5127 5128 /** 5129 * Returns whether this View is able to take focus. 5130 * 5131 * @return True if this view can take focus, or false otherwise. 5132 * @attr ref android.R.styleable#View_focusable 5133 */ 5134 @ViewDebug.ExportedProperty(category = "focus") 5135 public final boolean isFocusable() { 5136 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 5137 } 5138 5139 /** 5140 * When a view is focusable, it may not want to take focus when in touch mode. 5141 * For example, a button would like focus when the user is navigating via a D-pad 5142 * so that the user can click on it, but once the user starts touching the screen, 5143 * the button shouldn't take focus 5144 * @return Whether the view is focusable in touch mode. 5145 * @attr ref android.R.styleable#View_focusableInTouchMode 5146 */ 5147 @ViewDebug.ExportedProperty 5148 public final boolean isFocusableInTouchMode() { 5149 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 5150 } 5151 5152 /** 5153 * Find the nearest view in the specified direction that can take focus. 5154 * This does not actually give focus to that view. 5155 * 5156 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 5157 * 5158 * @return The nearest focusable in the specified direction, or null if none 5159 * can be found. 5160 */ 5161 public View focusSearch(int direction) { 5162 if (mParent != null) { 5163 return mParent.focusSearch(this, direction); 5164 } else { 5165 return null; 5166 } 5167 } 5168 5169 /** 5170 * This method is the last chance for the focused view and its ancestors to 5171 * respond to an arrow key. This is called when the focused view did not 5172 * consume the key internally, nor could the view system find a new view in 5173 * the requested direction to give focus to. 5174 * 5175 * @param focused The currently focused view. 5176 * @param direction The direction focus wants to move. One of FOCUS_UP, 5177 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 5178 * @return True if the this view consumed this unhandled move. 5179 */ 5180 public boolean dispatchUnhandledMove(View focused, int direction) { 5181 return false; 5182 } 5183 5184 /** 5185 * If a user manually specified the next view id for a particular direction, 5186 * use the root to look up the view. 5187 * @param root The root view of the hierarchy containing this view. 5188 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 5189 * or FOCUS_BACKWARD. 5190 * @return The user specified next view, or null if there is none. 5191 */ 5192 View findUserSetNextFocus(View root, int direction) { 5193 switch (direction) { 5194 case FOCUS_LEFT: 5195 if (mNextFocusLeftId == View.NO_ID) return null; 5196 return findViewInsideOutShouldExist(root, mNextFocusLeftId); 5197 case FOCUS_RIGHT: 5198 if (mNextFocusRightId == View.NO_ID) return null; 5199 return findViewInsideOutShouldExist(root, mNextFocusRightId); 5200 case FOCUS_UP: 5201 if (mNextFocusUpId == View.NO_ID) return null; 5202 return findViewInsideOutShouldExist(root, mNextFocusUpId); 5203 case FOCUS_DOWN: 5204 if (mNextFocusDownId == View.NO_ID) return null; 5205 return findViewInsideOutShouldExist(root, mNextFocusDownId); 5206 case FOCUS_FORWARD: 5207 if (mNextFocusForwardId == View.NO_ID) return null; 5208 return findViewInsideOutShouldExist(root, mNextFocusForwardId); 5209 case FOCUS_BACKWARD: { 5210 final int id = mID; 5211 return root.findViewByPredicateInsideOut(this, new Predicate<View>() { 5212 @Override 5213 public boolean apply(View t) { 5214 return t.mNextFocusForwardId == id; 5215 } 5216 }); 5217 } 5218 } 5219 return null; 5220 } 5221 5222 private View findViewInsideOutShouldExist(View root, final int childViewId) { 5223 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() { 5224 @Override 5225 public boolean apply(View t) { 5226 return t.mID == childViewId; 5227 } 5228 }); 5229 5230 if (result == null) { 5231 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified " 5232 + "by user for id " + childViewId); 5233 } 5234 return result; 5235 } 5236 5237 /** 5238 * Find and return all focusable views that are descendants of this view, 5239 * possibly including this view if it is focusable itself. 5240 * 5241 * @param direction The direction of the focus 5242 * @return A list of focusable views 5243 */ 5244 public ArrayList<View> getFocusables(int direction) { 5245 ArrayList<View> result = new ArrayList<View>(24); 5246 addFocusables(result, direction); 5247 return result; 5248 } 5249 5250 /** 5251 * Add any focusable views that are descendants of this view (possibly 5252 * including this view if it is focusable itself) to views. If we are in touch mode, 5253 * only add views that are also focusable in touch mode. 5254 * 5255 * @param views Focusable views found so far 5256 * @param direction The direction of the focus 5257 */ 5258 public void addFocusables(ArrayList<View> views, int direction) { 5259 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 5260 } 5261 5262 /** 5263 * Adds any focusable views that are descendants of this view (possibly 5264 * including this view if it is focusable itself) to views. This method 5265 * adds all focusable views regardless if we are in touch mode or 5266 * only views focusable in touch mode if we are in touch mode depending on 5267 * the focusable mode paramater. 5268 * 5269 * @param views Focusable views found so far or null if all we are interested is 5270 * the number of focusables. 5271 * @param direction The direction of the focus. 5272 * @param focusableMode The type of focusables to be added. 5273 * 5274 * @see #FOCUSABLES_ALL 5275 * @see #FOCUSABLES_TOUCH_MODE 5276 */ 5277 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) { 5278 if (!isFocusable()) { 5279 return; 5280 } 5281 5282 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE && 5283 isInTouchMode() && !isFocusableInTouchMode()) { 5284 return; 5285 } 5286 5287 if (views != null) { 5288 views.add(this); 5289 } 5290 } 5291 5292 /** 5293 * Finds the Views that contain given text. The containment is case insensitive. 5294 * The search is performed by either the text that the View renders or the content 5295 * description that describes the view for accessibility purposes and the view does 5296 * not render or both. Clients can specify how the search is to be performed via 5297 * passing the {@link #FIND_VIEWS_WITH_TEXT} and 5298 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags. 5299 * 5300 * @param outViews The output list of matching Views. 5301 * @param searched The text to match against. 5302 * 5303 * @see #FIND_VIEWS_WITH_TEXT 5304 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION 5305 * @see #setContentDescription(CharSequence) 5306 */ 5307 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) { 5308 if (getAccessibilityNodeProvider() != null) { 5309 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) { 5310 outViews.add(this); 5311 } 5312 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0 5313 && !TextUtils.isEmpty(searched) && !TextUtils.isEmpty(mContentDescription)) { 5314 String searchedLowerCase = searched.toString().toLowerCase(); 5315 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase(); 5316 if (contentDescriptionLowerCase.contains(searchedLowerCase)) { 5317 outViews.add(this); 5318 } 5319 } 5320 } 5321 5322 /** 5323 * Find and return all touchable views that are descendants of this view, 5324 * possibly including this view if it is touchable itself. 5325 * 5326 * @return A list of touchable views 5327 */ 5328 public ArrayList<View> getTouchables() { 5329 ArrayList<View> result = new ArrayList<View>(); 5330 addTouchables(result); 5331 return result; 5332 } 5333 5334 /** 5335 * Add any touchable views that are descendants of this view (possibly 5336 * including this view if it is touchable itself) to views. 5337 * 5338 * @param views Touchable views found so far 5339 */ 5340 public void addTouchables(ArrayList<View> views) { 5341 final int viewFlags = mViewFlags; 5342 5343 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 5344 && (viewFlags & ENABLED_MASK) == ENABLED) { 5345 views.add(this); 5346 } 5347 } 5348 5349 /** 5350 * Call this to try to give focus to a specific view or to one of its 5351 * descendants. 5352 * 5353 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 5354 * false), or if it is focusable and it is not focusable in touch mode 5355 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 5356 * 5357 * See also {@link #focusSearch(int)}, which is what you call to say that you 5358 * have focus, and you want your parent to look for the next one. 5359 * 5360 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 5361 * {@link #FOCUS_DOWN} and <code>null</code>. 5362 * 5363 * @return Whether this view or one of its descendants actually took focus. 5364 */ 5365 public final boolean requestFocus() { 5366 return requestFocus(View.FOCUS_DOWN); 5367 } 5368 5369 5370 /** 5371 * Call this to try to give focus to a specific view or to one of its 5372 * descendants and give it a hint about what direction focus is heading. 5373 * 5374 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 5375 * false), or if it is focusable and it is not focusable in touch mode 5376 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 5377 * 5378 * See also {@link #focusSearch(int)}, which is what you call to say that you 5379 * have focus, and you want your parent to look for the next one. 5380 * 5381 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 5382 * <code>null</code> set for the previously focused rectangle. 5383 * 5384 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 5385 * @return Whether this view or one of its descendants actually took focus. 5386 */ 5387 public final boolean requestFocus(int direction) { 5388 return requestFocus(direction, null); 5389 } 5390 5391 /** 5392 * Call this to try to give focus to a specific view or to one of its descendants 5393 * and give it hints about the direction and a specific rectangle that the focus 5394 * is coming from. The rectangle can help give larger views a finer grained hint 5395 * about where focus is coming from, and therefore, where to show selection, or 5396 * forward focus change internally. 5397 * 5398 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns 5399 * false), or if it is focusable and it is not focusable in touch mode 5400 * ({@link #isFocusableInTouchMode}) while the device is in touch mode. 5401 * 5402 * A View will not take focus if it is not visible. 5403 * 5404 * A View will not take focus if one of its parents has 5405 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to 5406 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 5407 * 5408 * See also {@link #focusSearch(int)}, which is what you call to say that you 5409 * have focus, and you want your parent to look for the next one. 5410 * 5411 * You may wish to override this method if your custom {@link View} has an internal 5412 * {@link View} that it wishes to forward the request to. 5413 * 5414 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 5415 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 5416 * to give a finer grained hint about where focus is coming from. May be null 5417 * if there is no hint. 5418 * @return Whether this view or one of its descendants actually took focus. 5419 */ 5420 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 5421 // need to be focusable 5422 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 5423 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 5424 return false; 5425 } 5426 5427 // need to be focusable in touch mode if in touch mode 5428 if (isInTouchMode() && 5429 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 5430 return false; 5431 } 5432 5433 // need to not have any parents blocking us 5434 if (hasAncestorThatBlocksDescendantFocus()) { 5435 return false; 5436 } 5437 5438 handleFocusGainInternal(direction, previouslyFocusedRect); 5439 return true; 5440 } 5441 5442 /** Gets the ViewAncestor, or null if not attached. */ 5443 /*package*/ ViewRootImpl getViewRootImpl() { 5444 View root = getRootView(); 5445 return root != null ? (ViewRootImpl)root.getParent() : null; 5446 } 5447 5448 /** 5449 * Call this to try to give focus to a specific view or to one of its descendants. This is a 5450 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 5451 * touch mode to request focus when they are touched. 5452 * 5453 * @return Whether this view or one of its descendants actually took focus. 5454 * 5455 * @see #isInTouchMode() 5456 * 5457 */ 5458 public final boolean requestFocusFromTouch() { 5459 // Leave touch mode if we need to 5460 if (isInTouchMode()) { 5461 ViewRootImpl viewRoot = getViewRootImpl(); 5462 if (viewRoot != null) { 5463 viewRoot.ensureTouchMode(false); 5464 } 5465 } 5466 return requestFocus(View.FOCUS_DOWN); 5467 } 5468 5469 /** 5470 * @return Whether any ancestor of this view blocks descendant focus. 5471 */ 5472 private boolean hasAncestorThatBlocksDescendantFocus() { 5473 ViewParent ancestor = mParent; 5474 while (ancestor instanceof ViewGroup) { 5475 final ViewGroup vgAncestor = (ViewGroup) ancestor; 5476 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) { 5477 return true; 5478 } else { 5479 ancestor = vgAncestor.getParent(); 5480 } 5481 } 5482 return false; 5483 } 5484 5485 /** 5486 * @hide 5487 */ 5488 public void dispatchStartTemporaryDetach() { 5489 onStartTemporaryDetach(); 5490 } 5491 5492 /** 5493 * This is called when a container is going to temporarily detach a child, with 5494 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 5495 * It will either be followed by {@link #onFinishTemporaryDetach()} or 5496 * {@link #onDetachedFromWindow()} when the container is done. 5497 */ 5498 public void onStartTemporaryDetach() { 5499 removeUnsetPressCallback(); 5500 mPrivateFlags |= CANCEL_NEXT_UP_EVENT; 5501 } 5502 5503 /** 5504 * @hide 5505 */ 5506 public void dispatchFinishTemporaryDetach() { 5507 onFinishTemporaryDetach(); 5508 } 5509 5510 /** 5511 * Called after {@link #onStartTemporaryDetach} when the container is done 5512 * changing the view. 5513 */ 5514 public void onFinishTemporaryDetach() { 5515 } 5516 5517 /** 5518 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 5519 * for this view's window. Returns null if the view is not currently attached 5520 * to the window. Normally you will not need to use this directly, but 5521 * just use the standard high-level event callbacks like 5522 * {@link #onKeyDown(int, KeyEvent)}. 5523 */ 5524 public KeyEvent.DispatcherState getKeyDispatcherState() { 5525 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 5526 } 5527 5528 /** 5529 * Dispatch a key event before it is processed by any input method 5530 * associated with the view hierarchy. This can be used to intercept 5531 * key events in special situations before the IME consumes them; a 5532 * typical example would be handling the BACK key to update the application's 5533 * UI instead of allowing the IME to see it and close itself. 5534 * 5535 * @param event The key event to be dispatched. 5536 * @return True if the event was handled, false otherwise. 5537 */ 5538 public boolean dispatchKeyEventPreIme(KeyEvent event) { 5539 return onKeyPreIme(event.getKeyCode(), event); 5540 } 5541 5542 /** 5543 * Dispatch a key event to the next view on the focus path. This path runs 5544 * from the top of the view tree down to the currently focused view. If this 5545 * view has focus, it will dispatch to itself. Otherwise it will dispatch 5546 * the next node down the focus path. This method also fires any key 5547 * listeners. 5548 * 5549 * @param event The key event to be dispatched. 5550 * @return True if the event was handled, false otherwise. 5551 */ 5552 public boolean dispatchKeyEvent(KeyEvent event) { 5553 if (mInputEventConsistencyVerifier != null) { 5554 mInputEventConsistencyVerifier.onKeyEvent(event, 0); 5555 } 5556 5557 // Give any attached key listener a first crack at the event. 5558 //noinspection SimplifiableIfStatement 5559 ListenerInfo li = mListenerInfo; 5560 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 5561 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 5562 return true; 5563 } 5564 5565 if (event.dispatch(this, mAttachInfo != null 5566 ? mAttachInfo.mKeyDispatchState : null, this)) { 5567 return true; 5568 } 5569 5570 if (mInputEventConsistencyVerifier != null) { 5571 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 5572 } 5573 return false; 5574 } 5575 5576 /** 5577 * Dispatches a key shortcut event. 5578 * 5579 * @param event The key event to be dispatched. 5580 * @return True if the event was handled by the view, false otherwise. 5581 */ 5582 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 5583 return onKeyShortcut(event.getKeyCode(), event); 5584 } 5585 5586 /** 5587 * Pass the touch screen motion event down to the target view, or this 5588 * view if it is the target. 5589 * 5590 * @param event The motion event to be dispatched. 5591 * @return True if the event was handled by the view, false otherwise. 5592 */ 5593 public boolean dispatchTouchEvent(MotionEvent event) { 5594 if (mInputEventConsistencyVerifier != null) { 5595 mInputEventConsistencyVerifier.onTouchEvent(event, 0); 5596 } 5597 5598 if (onFilterTouchEventForSecurity(event)) { 5599 //noinspection SimplifiableIfStatement 5600 ListenerInfo li = mListenerInfo; 5601 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 5602 && li.mOnTouchListener.onTouch(this, event)) { 5603 return true; 5604 } 5605 5606 if (onTouchEvent(event)) { 5607 return true; 5608 } 5609 } 5610 5611 if (mInputEventConsistencyVerifier != null) { 5612 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 5613 } 5614 return false; 5615 } 5616 5617 /** 5618 * Filter the touch event to apply security policies. 5619 * 5620 * @param event The motion event to be filtered. 5621 * @return True if the event should be dispatched, false if the event should be dropped. 5622 * 5623 * @see #getFilterTouchesWhenObscured 5624 */ 5625 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 5626 //noinspection RedundantIfStatement 5627 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 5628 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 5629 // Window is obscured, drop this touch. 5630 return false; 5631 } 5632 return true; 5633 } 5634 5635 /** 5636 * Pass a trackball motion event down to the focused view. 5637 * 5638 * @param event The motion event to be dispatched. 5639 * @return True if the event was handled by the view, false otherwise. 5640 */ 5641 public boolean dispatchTrackballEvent(MotionEvent event) { 5642 if (mInputEventConsistencyVerifier != null) { 5643 mInputEventConsistencyVerifier.onTrackballEvent(event, 0); 5644 } 5645 5646 return onTrackballEvent(event); 5647 } 5648 5649 /** 5650 * Dispatch a generic motion event. 5651 * <p> 5652 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 5653 * are delivered to the view under the pointer. All other generic motion events are 5654 * delivered to the focused view. Hover events are handled specially and are delivered 5655 * to {@link #onHoverEvent(MotionEvent)}. 5656 * </p> 5657 * 5658 * @param event The motion event to be dispatched. 5659 * @return True if the event was handled by the view, false otherwise. 5660 */ 5661 public boolean dispatchGenericMotionEvent(MotionEvent event) { 5662 if (mInputEventConsistencyVerifier != null) { 5663 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0); 5664 } 5665 5666 final int source = event.getSource(); 5667 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 5668 final int action = event.getAction(); 5669 if (action == MotionEvent.ACTION_HOVER_ENTER 5670 || action == MotionEvent.ACTION_HOVER_MOVE 5671 || action == MotionEvent.ACTION_HOVER_EXIT) { 5672 if (dispatchHoverEvent(event)) { 5673 return true; 5674 } 5675 } else if (dispatchGenericPointerEvent(event)) { 5676 return true; 5677 } 5678 } else if (dispatchGenericFocusedEvent(event)) { 5679 return true; 5680 } 5681 5682 if (dispatchGenericMotionEventInternal(event)) { 5683 return true; 5684 } 5685 5686 if (mInputEventConsistencyVerifier != null) { 5687 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 5688 } 5689 return false; 5690 } 5691 5692 private boolean dispatchGenericMotionEventInternal(MotionEvent event) { 5693 //noinspection SimplifiableIfStatement 5694 ListenerInfo li = mListenerInfo; 5695 if (li != null && li.mOnGenericMotionListener != null 5696 && (mViewFlags & ENABLED_MASK) == ENABLED 5697 && li.mOnGenericMotionListener.onGenericMotion(this, event)) { 5698 return true; 5699 } 5700 5701 if (onGenericMotionEvent(event)) { 5702 return true; 5703 } 5704 5705 if (mInputEventConsistencyVerifier != null) { 5706 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0); 5707 } 5708 return false; 5709 } 5710 5711 /** 5712 * Dispatch a hover event. 5713 * <p> 5714 * Do not call this method directly. 5715 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 5716 * </p> 5717 * 5718 * @param event The motion event to be dispatched. 5719 * @return True if the event was handled by the view, false otherwise. 5720 */ 5721 protected boolean dispatchHoverEvent(MotionEvent event) { 5722 //noinspection SimplifiableIfStatement 5723 ListenerInfo li = mListenerInfo; 5724 if (li != null && li.mOnHoverListener != null 5725 && (mViewFlags & ENABLED_MASK) == ENABLED 5726 && li.mOnHoverListener.onHover(this, event)) { 5727 return true; 5728 } 5729 5730 return onHoverEvent(event); 5731 } 5732 5733 /** 5734 * Returns true if the view has a child to which it has recently sent 5735 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and 5736 * it does not have a hovered child, then it must be the innermost hovered view. 5737 * @hide 5738 */ 5739 protected boolean hasHoveredChild() { 5740 return false; 5741 } 5742 5743 /** 5744 * Dispatch a generic motion event to the view under the first pointer. 5745 * <p> 5746 * Do not call this method directly. 5747 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 5748 * </p> 5749 * 5750 * @param event The motion event to be dispatched. 5751 * @return True if the event was handled by the view, false otherwise. 5752 */ 5753 protected boolean dispatchGenericPointerEvent(MotionEvent event) { 5754 return false; 5755 } 5756 5757 /** 5758 * Dispatch a generic motion event to the currently focused view. 5759 * <p> 5760 * Do not call this method directly. 5761 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead. 5762 * </p> 5763 * 5764 * @param event The motion event to be dispatched. 5765 * @return True if the event was handled by the view, false otherwise. 5766 */ 5767 protected boolean dispatchGenericFocusedEvent(MotionEvent event) { 5768 return false; 5769 } 5770 5771 /** 5772 * Dispatch a pointer event. 5773 * <p> 5774 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all 5775 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns 5776 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches 5777 * and should not be expected to handle other pointing device features. 5778 * </p> 5779 * 5780 * @param event The motion event to be dispatched. 5781 * @return True if the event was handled by the view, false otherwise. 5782 * @hide 5783 */ 5784 public final boolean dispatchPointerEvent(MotionEvent event) { 5785 if (event.isTouchEvent()) { 5786 return dispatchTouchEvent(event); 5787 } else { 5788 return dispatchGenericMotionEvent(event); 5789 } 5790 } 5791 5792 /** 5793 * Called when the window containing this view gains or loses window focus. 5794 * ViewGroups should override to route to their children. 5795 * 5796 * @param hasFocus True if the window containing this view now has focus, 5797 * false otherwise. 5798 */ 5799 public void dispatchWindowFocusChanged(boolean hasFocus) { 5800 onWindowFocusChanged(hasFocus); 5801 } 5802 5803 /** 5804 * Called when the window containing this view gains or loses focus. Note 5805 * that this is separate from view focus: to receive key events, both 5806 * your view and its window must have focus. If a window is displayed 5807 * on top of yours that takes input focus, then your own window will lose 5808 * focus but the view focus will remain unchanged. 5809 * 5810 * @param hasWindowFocus True if the window containing this view now has 5811 * focus, false otherwise. 5812 */ 5813 public void onWindowFocusChanged(boolean hasWindowFocus) { 5814 InputMethodManager imm = InputMethodManager.peekInstance(); 5815 if (!hasWindowFocus) { 5816 if (isPressed()) { 5817 setPressed(false); 5818 } 5819 if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 5820 imm.focusOut(this); 5821 } 5822 removeLongPressCallback(); 5823 removeTapCallback(); 5824 onFocusLost(); 5825 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 5826 imm.focusIn(this); 5827 } 5828 refreshDrawableState(); 5829 } 5830 5831 /** 5832 * Returns true if this view is in a window that currently has window focus. 5833 * Note that this is not the same as the view itself having focus. 5834 * 5835 * @return True if this view is in a window that currently has window focus. 5836 */ 5837 public boolean hasWindowFocus() { 5838 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 5839 } 5840 5841 /** 5842 * Dispatch a view visibility change down the view hierarchy. 5843 * ViewGroups should override to route to their children. 5844 * @param changedView The view whose visibility changed. Could be 'this' or 5845 * an ancestor view. 5846 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 5847 * {@link #INVISIBLE} or {@link #GONE}. 5848 */ 5849 protected void dispatchVisibilityChanged(View changedView, int visibility) { 5850 onVisibilityChanged(changedView, visibility); 5851 } 5852 5853 /** 5854 * Called when the visibility of the view or an ancestor of the view is changed. 5855 * @param changedView The view whose visibility changed. Could be 'this' or 5856 * an ancestor view. 5857 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 5858 * {@link #INVISIBLE} or {@link #GONE}. 5859 */ 5860 protected void onVisibilityChanged(View changedView, int visibility) { 5861 if (visibility == VISIBLE) { 5862 if (mAttachInfo != null) { 5863 initialAwakenScrollBars(); 5864 } else { 5865 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH; 5866 } 5867 } 5868 } 5869 5870 /** 5871 * Dispatch a hint about whether this view is displayed. For instance, when 5872 * a View moves out of the screen, it might receives a display hint indicating 5873 * the view is not displayed. Applications should not <em>rely</em> on this hint 5874 * as there is no guarantee that they will receive one. 5875 * 5876 * @param hint A hint about whether or not this view is displayed: 5877 * {@link #VISIBLE} or {@link #INVISIBLE}. 5878 */ 5879 public void dispatchDisplayHint(int hint) { 5880 onDisplayHint(hint); 5881 } 5882 5883 /** 5884 * Gives this view a hint about whether is displayed or not. For instance, when 5885 * a View moves out of the screen, it might receives a display hint indicating 5886 * the view is not displayed. Applications should not <em>rely</em> on this hint 5887 * as there is no guarantee that they will receive one. 5888 * 5889 * @param hint A hint about whether or not this view is displayed: 5890 * {@link #VISIBLE} or {@link #INVISIBLE}. 5891 */ 5892 protected void onDisplayHint(int hint) { 5893 } 5894 5895 /** 5896 * Dispatch a window visibility change down the view hierarchy. 5897 * ViewGroups should override to route to their children. 5898 * 5899 * @param visibility The new visibility of the window. 5900 * 5901 * @see #onWindowVisibilityChanged(int) 5902 */ 5903 public void dispatchWindowVisibilityChanged(int visibility) { 5904 onWindowVisibilityChanged(visibility); 5905 } 5906 5907 /** 5908 * Called when the window containing has change its visibility 5909 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 5910 * that this tells you whether or not your window is being made visible 5911 * to the window manager; this does <em>not</em> tell you whether or not 5912 * your window is obscured by other windows on the screen, even if it 5913 * is itself visible. 5914 * 5915 * @param visibility The new visibility of the window. 5916 */ 5917 protected void onWindowVisibilityChanged(int visibility) { 5918 if (visibility == VISIBLE) { 5919 initialAwakenScrollBars(); 5920 } 5921 } 5922 5923 /** 5924 * Returns the current visibility of the window this view is attached to 5925 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 5926 * 5927 * @return Returns the current visibility of the view's window. 5928 */ 5929 public int getWindowVisibility() { 5930 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 5931 } 5932 5933 /** 5934 * Retrieve the overall visible display size in which the window this view is 5935 * attached to has been positioned in. This takes into account screen 5936 * decorations above the window, for both cases where the window itself 5937 * is being position inside of them or the window is being placed under 5938 * then and covered insets are used for the window to position its content 5939 * inside. In effect, this tells you the available area where content can 5940 * be placed and remain visible to users. 5941 * 5942 * <p>This function requires an IPC back to the window manager to retrieve 5943 * the requested information, so should not be used in performance critical 5944 * code like drawing. 5945 * 5946 * @param outRect Filled in with the visible display frame. If the view 5947 * is not attached to a window, this is simply the raw display size. 5948 */ 5949 public void getWindowVisibleDisplayFrame(Rect outRect) { 5950 if (mAttachInfo != null) { 5951 try { 5952 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 5953 } catch (RemoteException e) { 5954 return; 5955 } 5956 // XXX This is really broken, and probably all needs to be done 5957 // in the window manager, and we need to know more about whether 5958 // we want the area behind or in front of the IME. 5959 final Rect insets = mAttachInfo.mVisibleInsets; 5960 outRect.left += insets.left; 5961 outRect.top += insets.top; 5962 outRect.right -= insets.right; 5963 outRect.bottom -= insets.bottom; 5964 return; 5965 } 5966 Display d = WindowManagerImpl.getDefault().getDefaultDisplay(); 5967 d.getRectSize(outRect); 5968 } 5969 5970 /** 5971 * Dispatch a notification about a resource configuration change down 5972 * the view hierarchy. 5973 * ViewGroups should override to route to their children. 5974 * 5975 * @param newConfig The new resource configuration. 5976 * 5977 * @see #onConfigurationChanged(android.content.res.Configuration) 5978 */ 5979 public void dispatchConfigurationChanged(Configuration newConfig) { 5980 onConfigurationChanged(newConfig); 5981 } 5982 5983 /** 5984 * Called when the current configuration of the resources being used 5985 * by the application have changed. You can use this to decide when 5986 * to reload resources that can changed based on orientation and other 5987 * configuration characterstics. You only need to use this if you are 5988 * not relying on the normal {@link android.app.Activity} mechanism of 5989 * recreating the activity instance upon a configuration change. 5990 * 5991 * @param newConfig The new resource configuration. 5992 */ 5993 protected void onConfigurationChanged(Configuration newConfig) { 5994 } 5995 5996 /** 5997 * Private function to aggregate all per-view attributes in to the view 5998 * root. 5999 */ 6000 void dispatchCollectViewAttributes(int visibility) { 6001 performCollectViewAttributes(visibility); 6002 } 6003 6004 void performCollectViewAttributes(int visibility) { 6005 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) { 6006 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 6007 mAttachInfo.mKeepScreenOn = true; 6008 } 6009 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility; 6010 ListenerInfo li = mListenerInfo; 6011 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 6012 mAttachInfo.mHasSystemUiListeners = true; 6013 } 6014 } 6015 } 6016 6017 void needGlobalAttributesUpdate(boolean force) { 6018 final AttachInfo ai = mAttachInfo; 6019 if (ai != null) { 6020 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 6021 || ai.mHasSystemUiListeners) { 6022 ai.mRecomputeGlobalAttributes = true; 6023 } 6024 } 6025 } 6026 6027 /** 6028 * Returns whether the device is currently in touch mode. Touch mode is entered 6029 * once the user begins interacting with the device by touch, and affects various 6030 * things like whether focus is always visible to the user. 6031 * 6032 * @return Whether the device is in touch mode. 6033 */ 6034 @ViewDebug.ExportedProperty 6035 public boolean isInTouchMode() { 6036 if (mAttachInfo != null) { 6037 return mAttachInfo.mInTouchMode; 6038 } else { 6039 return ViewRootImpl.isInTouchMode(); 6040 } 6041 } 6042 6043 /** 6044 * Returns the context the view is running in, through which it can 6045 * access the current theme, resources, etc. 6046 * 6047 * @return The view's Context. 6048 */ 6049 @ViewDebug.CapturedViewProperty 6050 public final Context getContext() { 6051 return mContext; 6052 } 6053 6054 /** 6055 * Handle a key event before it is processed by any input method 6056 * associated with the view hierarchy. This can be used to intercept 6057 * key events in special situations before the IME consumes them; a 6058 * typical example would be handling the BACK key to update the application's 6059 * UI instead of allowing the IME to see it and close itself. 6060 * 6061 * @param keyCode The value in event.getKeyCode(). 6062 * @param event Description of the key event. 6063 * @return If you handled the event, return true. If you want to allow the 6064 * event to be handled by the next receiver, return false. 6065 */ 6066 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 6067 return false; 6068 } 6069 6070 /** 6071 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 6072 * KeyEvent.Callback.onKeyDown()}: perform press of the view 6073 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 6074 * is released, if the view is enabled and clickable. 6075 * 6076 * @param keyCode A key code that represents the button pressed, from 6077 * {@link android.view.KeyEvent}. 6078 * @param event The KeyEvent object that defines the button action. 6079 */ 6080 public boolean onKeyDown(int keyCode, KeyEvent event) { 6081 boolean result = false; 6082 6083 switch (keyCode) { 6084 case KeyEvent.KEYCODE_DPAD_CENTER: 6085 case KeyEvent.KEYCODE_ENTER: { 6086 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 6087 return true; 6088 } 6089 // Long clickable items don't necessarily have to be clickable 6090 if (((mViewFlags & CLICKABLE) == CLICKABLE || 6091 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 6092 (event.getRepeatCount() == 0)) { 6093 setPressed(true); 6094 checkForLongClick(0); 6095 return true; 6096 } 6097 break; 6098 } 6099 } 6100 return result; 6101 } 6102 6103 /** 6104 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 6105 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 6106 * the event). 6107 */ 6108 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 6109 return false; 6110 } 6111 6112 /** 6113 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 6114 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 6115 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 6116 * {@link KeyEvent#KEYCODE_ENTER} is released. 6117 * 6118 * @param keyCode A key code that represents the button pressed, from 6119 * {@link android.view.KeyEvent}. 6120 * @param event The KeyEvent object that defines the button action. 6121 */ 6122 public boolean onKeyUp(int keyCode, KeyEvent event) { 6123 boolean result = false; 6124 6125 switch (keyCode) { 6126 case KeyEvent.KEYCODE_DPAD_CENTER: 6127 case KeyEvent.KEYCODE_ENTER: { 6128 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 6129 return true; 6130 } 6131 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 6132 setPressed(false); 6133 6134 if (!mHasPerformedLongPress) { 6135 // This is a tap, so remove the longpress check 6136 removeLongPressCallback(); 6137 6138 result = performClick(); 6139 } 6140 } 6141 break; 6142 } 6143 } 6144 return result; 6145 } 6146 6147 /** 6148 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 6149 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 6150 * the event). 6151 * 6152 * @param keyCode A key code that represents the button pressed, from 6153 * {@link android.view.KeyEvent}. 6154 * @param repeatCount The number of times the action was made. 6155 * @param event The KeyEvent object that defines the button action. 6156 */ 6157 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 6158 return false; 6159 } 6160 6161 /** 6162 * Called on the focused view when a key shortcut event is not handled. 6163 * Override this method to implement local key shortcuts for the View. 6164 * Key shortcuts can also be implemented by setting the 6165 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 6166 * 6167 * @param keyCode The value in event.getKeyCode(). 6168 * @param event Description of the key event. 6169 * @return If you handled the event, return true. If you want to allow the 6170 * event to be handled by the next receiver, return false. 6171 */ 6172 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 6173 return false; 6174 } 6175 6176 /** 6177 * Check whether the called view is a text editor, in which case it 6178 * would make sense to automatically display a soft input window for 6179 * it. Subclasses should override this if they implement 6180 * {@link #onCreateInputConnection(EditorInfo)} to return true if 6181 * a call on that method would return a non-null InputConnection, and 6182 * they are really a first-class editor that the user would normally 6183 * start typing on when the go into a window containing your view. 6184 * 6185 * <p>The default implementation always returns false. This does 6186 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 6187 * will not be called or the user can not otherwise perform edits on your 6188 * view; it is just a hint to the system that this is not the primary 6189 * purpose of this view. 6190 * 6191 * @return Returns true if this view is a text editor, else false. 6192 */ 6193 public boolean onCheckIsTextEditor() { 6194 return false; 6195 } 6196 6197 /** 6198 * Create a new InputConnection for an InputMethod to interact 6199 * with the view. The default implementation returns null, since it doesn't 6200 * support input methods. You can override this to implement such support. 6201 * This is only needed for views that take focus and text input. 6202 * 6203 * <p>When implementing this, you probably also want to implement 6204 * {@link #onCheckIsTextEditor()} to indicate you will return a 6205 * non-null InputConnection. 6206 * 6207 * @param outAttrs Fill in with attribute information about the connection. 6208 */ 6209 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 6210 return null; 6211 } 6212 6213 /** 6214 * Called by the {@link android.view.inputmethod.InputMethodManager} 6215 * when a view who is not the current 6216 * input connection target is trying to make a call on the manager. The 6217 * default implementation returns false; you can override this to return 6218 * true for certain views if you are performing InputConnection proxying 6219 * to them. 6220 * @param view The View that is making the InputMethodManager call. 6221 * @return Return true to allow the call, false to reject. 6222 */ 6223 public boolean checkInputConnectionProxy(View view) { 6224 return false; 6225 } 6226 6227 /** 6228 * Show the context menu for this view. It is not safe to hold on to the 6229 * menu after returning from this method. 6230 * 6231 * You should normally not overload this method. Overload 6232 * {@link #onCreateContextMenu(ContextMenu)} or define an 6233 * {@link OnCreateContextMenuListener} to add items to the context menu. 6234 * 6235 * @param menu The context menu to populate 6236 */ 6237 public void createContextMenu(ContextMenu menu) { 6238 ContextMenuInfo menuInfo = getContextMenuInfo(); 6239 6240 // Sets the current menu info so all items added to menu will have 6241 // my extra info set. 6242 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 6243 6244 onCreateContextMenu(menu); 6245 ListenerInfo li = mListenerInfo; 6246 if (li != null && li.mOnCreateContextMenuListener != null) { 6247 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 6248 } 6249 6250 // Clear the extra information so subsequent items that aren't mine don't 6251 // have my extra info. 6252 ((MenuBuilder)menu).setCurrentMenuInfo(null); 6253 6254 if (mParent != null) { 6255 mParent.createContextMenu(menu); 6256 } 6257 } 6258 6259 /** 6260 * Views should implement this if they have extra information to associate 6261 * with the context menu. The return result is supplied as a parameter to 6262 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 6263 * callback. 6264 * 6265 * @return Extra information about the item for which the context menu 6266 * should be shown. This information will vary across different 6267 * subclasses of View. 6268 */ 6269 protected ContextMenuInfo getContextMenuInfo() { 6270 return null; 6271 } 6272 6273 /** 6274 * Views should implement this if the view itself is going to add items to 6275 * the context menu. 6276 * 6277 * @param menu the context menu to populate 6278 */ 6279 protected void onCreateContextMenu(ContextMenu menu) { 6280 } 6281 6282 /** 6283 * Implement this method to handle trackball motion events. The 6284 * <em>relative</em> movement of the trackball since the last event 6285 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 6286 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 6287 * that a movement of 1 corresponds to the user pressing one DPAD key (so 6288 * they will often be fractional values, representing the more fine-grained 6289 * movement information available from a trackball). 6290 * 6291 * @param event The motion event. 6292 * @return True if the event was handled, false otherwise. 6293 */ 6294 public boolean onTrackballEvent(MotionEvent event) { 6295 return false; 6296 } 6297 6298 /** 6299 * Implement this method to handle generic motion events. 6300 * <p> 6301 * Generic motion events describe joystick movements, mouse hovers, track pad 6302 * touches, scroll wheel movements and other input events. The 6303 * {@link MotionEvent#getSource() source} of the motion event specifies 6304 * the class of input that was received. Implementations of this method 6305 * must examine the bits in the source before processing the event. 6306 * The following code example shows how this is done. 6307 * </p><p> 6308 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER} 6309 * are delivered to the view under the pointer. All other generic motion events are 6310 * delivered to the focused view. 6311 * </p> 6312 * <pre> public boolean onGenericMotionEvent(MotionEvent event) { 6313 * if ((event.getSource() & InputDevice.SOURCE_CLASS_JOYSTICK) != 0) { 6314 * if (event.getAction() == MotionEvent.ACTION_MOVE) { 6315 * // process the joystick movement... 6316 * return true; 6317 * } 6318 * } 6319 * if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) { 6320 * switch (event.getAction()) { 6321 * case MotionEvent.ACTION_HOVER_MOVE: 6322 * // process the mouse hover movement... 6323 * return true; 6324 * case MotionEvent.ACTION_SCROLL: 6325 * // process the scroll wheel movement... 6326 * return true; 6327 * } 6328 * } 6329 * return super.onGenericMotionEvent(event); 6330 * }</pre> 6331 * 6332 * @param event The generic motion event being processed. 6333 * @return True if the event was handled, false otherwise. 6334 */ 6335 public boolean onGenericMotionEvent(MotionEvent event) { 6336 return false; 6337 } 6338 6339 /** 6340 * Implement this method to handle hover events. 6341 * <p> 6342 * This method is called whenever a pointer is hovering into, over, or out of the 6343 * bounds of a view and the view is not currently being touched. 6344 * Hover events are represented as pointer events with action 6345 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE}, 6346 * or {@link MotionEvent#ACTION_HOVER_EXIT}. 6347 * </p> 6348 * <ul> 6349 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER} 6350 * when the pointer enters the bounds of the view.</li> 6351 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE} 6352 * when the pointer has already entered the bounds of the view and has moved.</li> 6353 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT} 6354 * when the pointer has exited the bounds of the view or when the pointer is 6355 * about to go down due to a button click, tap, or similar user action that 6356 * causes the view to be touched.</li> 6357 * </ul> 6358 * <p> 6359 * The view should implement this method to return true to indicate that it is 6360 * handling the hover event, such as by changing its drawable state. 6361 * </p><p> 6362 * The default implementation calls {@link #setHovered} to update the hovered state 6363 * of the view when a hover enter or hover exit event is received, if the view 6364 * is enabled and is clickable. The default implementation also sends hover 6365 * accessibility events. 6366 * </p> 6367 * 6368 * @param event The motion event that describes the hover. 6369 * @return True if the view handled the hover event. 6370 * 6371 * @see #isHovered 6372 * @see #setHovered 6373 * @see #onHoverChanged 6374 */ 6375 public boolean onHoverEvent(MotionEvent event) { 6376 // The root view may receive hover (or touch) events that are outside the bounds of 6377 // the window. This code ensures that we only send accessibility events for 6378 // hovers that are actually within the bounds of the root view. 6379 final int action = event.getAction(); 6380 if (!mSendingHoverAccessibilityEvents) { 6381 if ((action == MotionEvent.ACTION_HOVER_ENTER 6382 || action == MotionEvent.ACTION_HOVER_MOVE) 6383 && !hasHoveredChild() 6384 && pointInView(event.getX(), event.getY())) { 6385 mSendingHoverAccessibilityEvents = true; 6386 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER); 6387 } 6388 } else { 6389 if (action == MotionEvent.ACTION_HOVER_EXIT 6390 || (action == MotionEvent.ACTION_HOVER_MOVE 6391 && !pointInView(event.getX(), event.getY()))) { 6392 mSendingHoverAccessibilityEvents = false; 6393 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT); 6394 } 6395 } 6396 6397 if (isHoverable()) { 6398 switch (action) { 6399 case MotionEvent.ACTION_HOVER_ENTER: 6400 setHovered(true); 6401 break; 6402 case MotionEvent.ACTION_HOVER_EXIT: 6403 setHovered(false); 6404 break; 6405 } 6406 6407 // Dispatch the event to onGenericMotionEvent before returning true. 6408 // This is to provide compatibility with existing applications that 6409 // handled HOVER_MOVE events in onGenericMotionEvent and that would 6410 // break because of the new default handling for hoverable views 6411 // in onHoverEvent. 6412 // Note that onGenericMotionEvent will be called by default when 6413 // onHoverEvent returns false (refer to dispatchGenericMotionEvent). 6414 dispatchGenericMotionEventInternal(event); 6415 return true; 6416 } 6417 return false; 6418 } 6419 6420 /** 6421 * Returns true if the view should handle {@link #onHoverEvent} 6422 * by calling {@link #setHovered} to change its hovered state. 6423 * 6424 * @return True if the view is hoverable. 6425 */ 6426 private boolean isHoverable() { 6427 final int viewFlags = mViewFlags; 6428 //noinspection SimplifiableIfStatement 6429 if ((viewFlags & ENABLED_MASK) == DISABLED) { 6430 return false; 6431 } 6432 6433 return (viewFlags & CLICKABLE) == CLICKABLE 6434 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 6435 } 6436 6437 /** 6438 * Returns true if the view is currently hovered. 6439 * 6440 * @return True if the view is currently hovered. 6441 * 6442 * @see #setHovered 6443 * @see #onHoverChanged 6444 */ 6445 @ViewDebug.ExportedProperty 6446 public boolean isHovered() { 6447 return (mPrivateFlags & HOVERED) != 0; 6448 } 6449 6450 /** 6451 * Sets whether the view is currently hovered. 6452 * <p> 6453 * Calling this method also changes the drawable state of the view. This 6454 * enables the view to react to hover by using different drawable resources 6455 * to change its appearance. 6456 * </p><p> 6457 * The {@link #onHoverChanged} method is called when the hovered state changes. 6458 * </p> 6459 * 6460 * @param hovered True if the view is hovered. 6461 * 6462 * @see #isHovered 6463 * @see #onHoverChanged 6464 */ 6465 public void setHovered(boolean hovered) { 6466 if (hovered) { 6467 if ((mPrivateFlags & HOVERED) == 0) { 6468 mPrivateFlags |= HOVERED; 6469 refreshDrawableState(); 6470 onHoverChanged(true); 6471 } 6472 } else { 6473 if ((mPrivateFlags & HOVERED) != 0) { 6474 mPrivateFlags &= ~HOVERED; 6475 refreshDrawableState(); 6476 onHoverChanged(false); 6477 } 6478 } 6479 } 6480 6481 /** 6482 * Implement this method to handle hover state changes. 6483 * <p> 6484 * This method is called whenever the hover state changes as a result of a 6485 * call to {@link #setHovered}. 6486 * </p> 6487 * 6488 * @param hovered The current hover state, as returned by {@link #isHovered}. 6489 * 6490 * @see #isHovered 6491 * @see #setHovered 6492 */ 6493 public void onHoverChanged(boolean hovered) { 6494 } 6495 6496 /** 6497 * Implement this method to handle touch screen motion events. 6498 * 6499 * @param event The motion event. 6500 * @return True if the event was handled, false otherwise. 6501 */ 6502 public boolean onTouchEvent(MotionEvent event) { 6503 final int viewFlags = mViewFlags; 6504 6505 if ((viewFlags & ENABLED_MASK) == DISABLED) { 6506 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) { 6507 mPrivateFlags &= ~PRESSED; 6508 refreshDrawableState(); 6509 } 6510 // A disabled view that is clickable still consumes the touch 6511 // events, it just doesn't respond to them. 6512 return (((viewFlags & CLICKABLE) == CLICKABLE || 6513 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 6514 } 6515 6516 if (mTouchDelegate != null) { 6517 if (mTouchDelegate.onTouchEvent(event)) { 6518 return true; 6519 } 6520 } 6521 6522 if (((viewFlags & CLICKABLE) == CLICKABLE || 6523 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 6524 switch (event.getAction()) { 6525 case MotionEvent.ACTION_UP: 6526 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0; 6527 if ((mPrivateFlags & PRESSED) != 0 || prepressed) { 6528 // take focus if we don't have it already and we should in 6529 // touch mode. 6530 boolean focusTaken = false; 6531 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 6532 focusTaken = requestFocus(); 6533 } 6534 6535 if (prepressed) { 6536 // The button is being released before we actually 6537 // showed it as pressed. Make it show the pressed 6538 // state now (before scheduling the click) to ensure 6539 // the user sees it. 6540 mPrivateFlags |= PRESSED; 6541 refreshDrawableState(); 6542 } 6543 6544 if (!mHasPerformedLongPress) { 6545 // This is a tap, so remove the longpress check 6546 removeLongPressCallback(); 6547 6548 // Only perform take click actions if we were in the pressed state 6549 if (!focusTaken) { 6550 // Use a Runnable and post this rather than calling 6551 // performClick directly. This lets other visual state 6552 // of the view update before click actions start. 6553 if (mPerformClick == null) { 6554 mPerformClick = new PerformClick(); 6555 } 6556 if (!post(mPerformClick)) { 6557 performClick(); 6558 } 6559 } 6560 } 6561 6562 if (mUnsetPressedState == null) { 6563 mUnsetPressedState = new UnsetPressedState(); 6564 } 6565 6566 if (prepressed) { 6567 postDelayed(mUnsetPressedState, 6568 ViewConfiguration.getPressedStateDuration()); 6569 } else if (!post(mUnsetPressedState)) { 6570 // If the post failed, unpress right now 6571 mUnsetPressedState.run(); 6572 } 6573 removeTapCallback(); 6574 } 6575 break; 6576 6577 case MotionEvent.ACTION_DOWN: 6578 mHasPerformedLongPress = false; 6579 6580 if (performButtonActionOnTouchDown(event)) { 6581 break; 6582 } 6583 6584 // Walk up the hierarchy to determine if we're inside a scrolling container. 6585 boolean isInScrollingContainer = isInScrollingContainer(); 6586 6587 // For views inside a scrolling container, delay the pressed feedback for 6588 // a short period in case this is a scroll. 6589 if (isInScrollingContainer) { 6590 mPrivateFlags |= PREPRESSED; 6591 if (mPendingCheckForTap == null) { 6592 mPendingCheckForTap = new CheckForTap(); 6593 } 6594 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 6595 } else { 6596 // Not inside a scrolling container, so show the feedback right away 6597 mPrivateFlags |= PRESSED; 6598 refreshDrawableState(); 6599 checkForLongClick(0); 6600 } 6601 break; 6602 6603 case MotionEvent.ACTION_CANCEL: 6604 mPrivateFlags &= ~PRESSED; 6605 refreshDrawableState(); 6606 removeTapCallback(); 6607 break; 6608 6609 case MotionEvent.ACTION_MOVE: 6610 final int x = (int) event.getX(); 6611 final int y = (int) event.getY(); 6612 6613 // Be lenient about moving outside of buttons 6614 if (!pointInView(x, y, mTouchSlop)) { 6615 // Outside button 6616 removeTapCallback(); 6617 if ((mPrivateFlags & PRESSED) != 0) { 6618 // Remove any future long press/tap checks 6619 removeLongPressCallback(); 6620 6621 // Need to switch from pressed to not pressed 6622 mPrivateFlags &= ~PRESSED; 6623 refreshDrawableState(); 6624 } 6625 } 6626 break; 6627 } 6628 return true; 6629 } 6630 6631 return false; 6632 } 6633 6634 /** 6635 * @hide 6636 */ 6637 public boolean isInScrollingContainer() { 6638 ViewParent p = getParent(); 6639 while (p != null && p instanceof ViewGroup) { 6640 if (((ViewGroup) p).shouldDelayChildPressedState()) { 6641 return true; 6642 } 6643 p = p.getParent(); 6644 } 6645 return false; 6646 } 6647 6648 /** 6649 * Remove the longpress detection timer. 6650 */ 6651 private void removeLongPressCallback() { 6652 if (mPendingCheckForLongPress != null) { 6653 removeCallbacks(mPendingCheckForLongPress); 6654 } 6655 } 6656 6657 /** 6658 * Remove the pending click action 6659 */ 6660 private void removePerformClickCallback() { 6661 if (mPerformClick != null) { 6662 removeCallbacks(mPerformClick); 6663 } 6664 } 6665 6666 /** 6667 * Remove the prepress detection timer. 6668 */ 6669 private void removeUnsetPressCallback() { 6670 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) { 6671 setPressed(false); 6672 removeCallbacks(mUnsetPressedState); 6673 } 6674 } 6675 6676 /** 6677 * Remove the tap detection timer. 6678 */ 6679 private void removeTapCallback() { 6680 if (mPendingCheckForTap != null) { 6681 mPrivateFlags &= ~PREPRESSED; 6682 removeCallbacks(mPendingCheckForTap); 6683 } 6684 } 6685 6686 /** 6687 * Cancels a pending long press. Your subclass can use this if you 6688 * want the context menu to come up if the user presses and holds 6689 * at the same place, but you don't want it to come up if they press 6690 * and then move around enough to cause scrolling. 6691 */ 6692 public void cancelLongPress() { 6693 removeLongPressCallback(); 6694 6695 /* 6696 * The prepressed state handled by the tap callback is a display 6697 * construct, but the tap callback will post a long press callback 6698 * less its own timeout. Remove it here. 6699 */ 6700 removeTapCallback(); 6701 } 6702 6703 /** 6704 * Remove the pending callback for sending a 6705 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 6706 */ 6707 private void removeSendViewScrolledAccessibilityEventCallback() { 6708 if (mSendViewScrolledAccessibilityEvent != null) { 6709 removeCallbacks(mSendViewScrolledAccessibilityEvent); 6710 } 6711 } 6712 6713 /** 6714 * Sets the TouchDelegate for this View. 6715 */ 6716 public void setTouchDelegate(TouchDelegate delegate) { 6717 mTouchDelegate = delegate; 6718 } 6719 6720 /** 6721 * Gets the TouchDelegate for this View. 6722 */ 6723 public TouchDelegate getTouchDelegate() { 6724 return mTouchDelegate; 6725 } 6726 6727 /** 6728 * Set flags controlling behavior of this view. 6729 * 6730 * @param flags Constant indicating the value which should be set 6731 * @param mask Constant indicating the bit range that should be changed 6732 */ 6733 void setFlags(int flags, int mask) { 6734 int old = mViewFlags; 6735 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 6736 6737 int changed = mViewFlags ^ old; 6738 if (changed == 0) { 6739 return; 6740 } 6741 int privateFlags = mPrivateFlags; 6742 6743 /* Check if the FOCUSABLE bit has changed */ 6744 if (((changed & FOCUSABLE_MASK) != 0) && 6745 ((privateFlags & HAS_BOUNDS) !=0)) { 6746 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 6747 && ((privateFlags & FOCUSED) != 0)) { 6748 /* Give up focus if we are no longer focusable */ 6749 clearFocus(); 6750 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 6751 && ((privateFlags & FOCUSED) == 0)) { 6752 /* 6753 * Tell the view system that we are now available to take focus 6754 * if no one else already has it. 6755 */ 6756 if (mParent != null) mParent.focusableViewAvailable(this); 6757 } 6758 } 6759 6760 if ((flags & VISIBILITY_MASK) == VISIBLE) { 6761 if ((changed & VISIBILITY_MASK) != 0) { 6762 /* 6763 * If this view is becoming visible, invalidate it in case it changed while 6764 * it was not visible. Marking it drawn ensures that the invalidation will 6765 * go through. 6766 */ 6767 mPrivateFlags |= DRAWN; 6768 invalidate(true); 6769 6770 needGlobalAttributesUpdate(true); 6771 6772 // a view becoming visible is worth notifying the parent 6773 // about in case nothing has focus. even if this specific view 6774 // isn't focusable, it may contain something that is, so let 6775 // the root view try to give this focus if nothing else does. 6776 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 6777 mParent.focusableViewAvailable(this); 6778 } 6779 } 6780 } 6781 6782 /* Check if the GONE bit has changed */ 6783 if ((changed & GONE) != 0) { 6784 needGlobalAttributesUpdate(false); 6785 requestLayout(); 6786 6787 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 6788 if (hasFocus()) clearFocus(); 6789 destroyDrawingCache(); 6790 if (mParent instanceof View) { 6791 // GONE views noop invalidation, so invalidate the parent 6792 ((View) mParent).invalidate(true); 6793 } 6794 // Mark the view drawn to ensure that it gets invalidated properly the next 6795 // time it is visible and gets invalidated 6796 mPrivateFlags |= DRAWN; 6797 } 6798 if (mAttachInfo != null) { 6799 mAttachInfo.mViewVisibilityChanged = true; 6800 } 6801 } 6802 6803 /* Check if the VISIBLE bit has changed */ 6804 if ((changed & INVISIBLE) != 0) { 6805 needGlobalAttributesUpdate(false); 6806 /* 6807 * If this view is becoming invisible, set the DRAWN flag so that 6808 * the next invalidate() will not be skipped. 6809 */ 6810 mPrivateFlags |= DRAWN; 6811 6812 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) { 6813 // root view becoming invisible shouldn't clear focus 6814 if (getRootView() != this) { 6815 clearFocus(); 6816 } 6817 } 6818 if (mAttachInfo != null) { 6819 mAttachInfo.mViewVisibilityChanged = true; 6820 } 6821 } 6822 6823 if ((changed & VISIBILITY_MASK) != 0) { 6824 if (mParent instanceof ViewGroup) { 6825 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK)); 6826 ((View) mParent).invalidate(true); 6827 } else if (mParent != null) { 6828 mParent.invalidateChild(this, null); 6829 } 6830 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK)); 6831 } 6832 6833 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 6834 destroyDrawingCache(); 6835 } 6836 6837 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 6838 destroyDrawingCache(); 6839 mPrivateFlags &= ~DRAWING_CACHE_VALID; 6840 invalidateParentCaches(); 6841 } 6842 6843 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 6844 destroyDrawingCache(); 6845 mPrivateFlags &= ~DRAWING_CACHE_VALID; 6846 } 6847 6848 if ((changed & DRAW_MASK) != 0) { 6849 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 6850 if (mBGDrawable != null) { 6851 mPrivateFlags &= ~SKIP_DRAW; 6852 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 6853 } else { 6854 mPrivateFlags |= SKIP_DRAW; 6855 } 6856 } else { 6857 mPrivateFlags &= ~SKIP_DRAW; 6858 } 6859 requestLayout(); 6860 invalidate(true); 6861 } 6862 6863 if ((changed & KEEP_SCREEN_ON) != 0) { 6864 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 6865 mParent.recomputeViewAttributes(this); 6866 } 6867 } 6868 6869 if ((changed & LAYOUT_DIRECTION_MASK) != 0) { 6870 requestLayout(); 6871 } 6872 } 6873 6874 /** 6875 * Change the view's z order in the tree, so it's on top of other sibling 6876 * views 6877 */ 6878 public void bringToFront() { 6879 if (mParent != null) { 6880 mParent.bringChildToFront(this); 6881 } 6882 } 6883 6884 /** 6885 * This is called in response to an internal scroll in this view (i.e., the 6886 * view scrolled its own contents). This is typically as a result of 6887 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 6888 * called. 6889 * 6890 * @param l Current horizontal scroll origin. 6891 * @param t Current vertical scroll origin. 6892 * @param oldl Previous horizontal scroll origin. 6893 * @param oldt Previous vertical scroll origin. 6894 */ 6895 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 6896 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 6897 postSendViewScrolledAccessibilityEventCallback(); 6898 } 6899 6900 mBackgroundSizeChanged = true; 6901 6902 final AttachInfo ai = mAttachInfo; 6903 if (ai != null) { 6904 ai.mViewScrollChanged = true; 6905 } 6906 } 6907 6908 /** 6909 * Interface definition for a callback to be invoked when the layout bounds of a view 6910 * changes due to layout processing. 6911 */ 6912 public interface OnLayoutChangeListener { 6913 /** 6914 * Called when the focus state of a view has changed. 6915 * 6916 * @param v The view whose state has changed. 6917 * @param left The new value of the view's left property. 6918 * @param top The new value of the view's top property. 6919 * @param right The new value of the view's right property. 6920 * @param bottom The new value of the view's bottom property. 6921 * @param oldLeft The previous value of the view's left property. 6922 * @param oldTop The previous value of the view's top property. 6923 * @param oldRight The previous value of the view's right property. 6924 * @param oldBottom The previous value of the view's bottom property. 6925 */ 6926 void onLayoutChange(View v, int left, int top, int right, int bottom, 6927 int oldLeft, int oldTop, int oldRight, int oldBottom); 6928 } 6929 6930 /** 6931 * This is called during layout when the size of this view has changed. If 6932 * you were just added to the view hierarchy, you're called with the old 6933 * values of 0. 6934 * 6935 * @param w Current width of this view. 6936 * @param h Current height of this view. 6937 * @param oldw Old width of this view. 6938 * @param oldh Old height of this view. 6939 */ 6940 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 6941 } 6942 6943 /** 6944 * Called by draw to draw the child views. This may be overridden 6945 * by derived classes to gain control just before its children are drawn 6946 * (but after its own view has been drawn). 6947 * @param canvas the canvas on which to draw the view 6948 */ 6949 protected void dispatchDraw(Canvas canvas) { 6950 } 6951 6952 /** 6953 * Gets the parent of this view. Note that the parent is a 6954 * ViewParent and not necessarily a View. 6955 * 6956 * @return Parent of this view. 6957 */ 6958 public final ViewParent getParent() { 6959 return mParent; 6960 } 6961 6962 /** 6963 * Set the horizontal scrolled position of your view. This will cause a call to 6964 * {@link #onScrollChanged(int, int, int, int)} and the view will be 6965 * invalidated. 6966 * @param value the x position to scroll to 6967 */ 6968 public void setScrollX(int value) { 6969 scrollTo(value, mScrollY); 6970 } 6971 6972 /** 6973 * Set the vertical scrolled position of your view. This will cause a call to 6974 * {@link #onScrollChanged(int, int, int, int)} and the view will be 6975 * invalidated. 6976 * @param value the y position to scroll to 6977 */ 6978 public void setScrollY(int value) { 6979 scrollTo(mScrollX, value); 6980 } 6981 6982 /** 6983 * Return the scrolled left position of this view. This is the left edge of 6984 * the displayed part of your view. You do not need to draw any pixels 6985 * farther left, since those are outside of the frame of your view on 6986 * screen. 6987 * 6988 * @return The left edge of the displayed part of your view, in pixels. 6989 */ 6990 public final int getScrollX() { 6991 return mScrollX; 6992 } 6993 6994 /** 6995 * Return the scrolled top position of this view. This is the top edge of 6996 * the displayed part of your view. You do not need to draw any pixels above 6997 * it, since those are outside of the frame of your view on screen. 6998 * 6999 * @return The top edge of the displayed part of your view, in pixels. 7000 */ 7001 public final int getScrollY() { 7002 return mScrollY; 7003 } 7004 7005 /** 7006 * Return the width of the your view. 7007 * 7008 * @return The width of your view, in pixels. 7009 */ 7010 @ViewDebug.ExportedProperty(category = "layout") 7011 public final int getWidth() { 7012 return mRight - mLeft; 7013 } 7014 7015 /** 7016 * Return the height of your view. 7017 * 7018 * @return The height of your view, in pixels. 7019 */ 7020 @ViewDebug.ExportedProperty(category = "layout") 7021 public final int getHeight() { 7022 return mBottom - mTop; 7023 } 7024 7025 /** 7026 * Return the visible drawing bounds of your view. Fills in the output 7027 * rectangle with the values from getScrollX(), getScrollY(), 7028 * getWidth(), and getHeight(). 7029 * 7030 * @param outRect The (scrolled) drawing bounds of the view. 7031 */ 7032 public void getDrawingRect(Rect outRect) { 7033 outRect.left = mScrollX; 7034 outRect.top = mScrollY; 7035 outRect.right = mScrollX + (mRight - mLeft); 7036 outRect.bottom = mScrollY + (mBottom - mTop); 7037 } 7038 7039 /** 7040 * Like {@link #getMeasuredWidthAndState()}, but only returns the 7041 * raw width component (that is the result is masked by 7042 * {@link #MEASURED_SIZE_MASK}). 7043 * 7044 * @return The raw measured width of this view. 7045 */ 7046 public final int getMeasuredWidth() { 7047 return mMeasuredWidth & MEASURED_SIZE_MASK; 7048 } 7049 7050 /** 7051 * Return the full width measurement information for this view as computed 7052 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 7053 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 7054 * This should be used during measurement and layout calculations only. Use 7055 * {@link #getWidth()} to see how wide a view is after layout. 7056 * 7057 * @return The measured width of this view as a bit mask. 7058 */ 7059 public final int getMeasuredWidthAndState() { 7060 return mMeasuredWidth; 7061 } 7062 7063 /** 7064 * Like {@link #getMeasuredHeightAndState()}, but only returns the 7065 * raw width component (that is the result is masked by 7066 * {@link #MEASURED_SIZE_MASK}). 7067 * 7068 * @return The raw measured height of this view. 7069 */ 7070 public final int getMeasuredHeight() { 7071 return mMeasuredHeight & MEASURED_SIZE_MASK; 7072 } 7073 7074 /** 7075 * Return the full height measurement information for this view as computed 7076 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask 7077 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 7078 * This should be used during measurement and layout calculations only. Use 7079 * {@link #getHeight()} to see how wide a view is after layout. 7080 * 7081 * @return The measured width of this view as a bit mask. 7082 */ 7083 public final int getMeasuredHeightAndState() { 7084 return mMeasuredHeight; 7085 } 7086 7087 /** 7088 * Return only the state bits of {@link #getMeasuredWidthAndState()} 7089 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 7090 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 7091 * and the height component is at the shifted bits 7092 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 7093 */ 7094 public final int getMeasuredState() { 7095 return (mMeasuredWidth&MEASURED_STATE_MASK) 7096 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 7097 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 7098 } 7099 7100 /** 7101 * The transform matrix of this view, which is calculated based on the current 7102 * roation, scale, and pivot properties. 7103 * 7104 * @see #getRotation() 7105 * @see #getScaleX() 7106 * @see #getScaleY() 7107 * @see #getPivotX() 7108 * @see #getPivotY() 7109 * @return The current transform matrix for the view 7110 */ 7111 public Matrix getMatrix() { 7112 if (mTransformationInfo != null) { 7113 updateMatrix(); 7114 return mTransformationInfo.mMatrix; 7115 } 7116 return Matrix.IDENTITY_MATRIX; 7117 } 7118 7119 /** 7120 * Utility function to determine if the value is far enough away from zero to be 7121 * considered non-zero. 7122 * @param value A floating point value to check for zero-ness 7123 * @return whether the passed-in value is far enough away from zero to be considered non-zero 7124 */ 7125 private static boolean nonzero(float value) { 7126 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON); 7127 } 7128 7129 /** 7130 * Returns true if the transform matrix is the identity matrix. 7131 * Recomputes the matrix if necessary. 7132 * 7133 * @return True if the transform matrix is the identity matrix, false otherwise. 7134 */ 7135 final boolean hasIdentityMatrix() { 7136 if (mTransformationInfo != null) { 7137 updateMatrix(); 7138 return mTransformationInfo.mMatrixIsIdentity; 7139 } 7140 return true; 7141 } 7142 7143 void ensureTransformationInfo() { 7144 if (mTransformationInfo == null) { 7145 mTransformationInfo = new TransformationInfo(); 7146 } 7147 } 7148 7149 /** 7150 * Recomputes the transform matrix if necessary. 7151 */ 7152 private void updateMatrix() { 7153 final TransformationInfo info = mTransformationInfo; 7154 if (info == null) { 7155 return; 7156 } 7157 if (info.mMatrixDirty) { 7158 // transform-related properties have changed since the last time someone 7159 // asked for the matrix; recalculate it with the current values 7160 7161 // Figure out if we need to update the pivot point 7162 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 7163 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) { 7164 info.mPrevWidth = mRight - mLeft; 7165 info.mPrevHeight = mBottom - mTop; 7166 info.mPivotX = info.mPrevWidth / 2f; 7167 info.mPivotY = info.mPrevHeight / 2f; 7168 } 7169 } 7170 info.mMatrix.reset(); 7171 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) { 7172 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY); 7173 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY); 7174 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY); 7175 } else { 7176 if (info.mCamera == null) { 7177 info.mCamera = new Camera(); 7178 info.matrix3D = new Matrix(); 7179 } 7180 info.mCamera.save(); 7181 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY); 7182 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation); 7183 info.mCamera.getMatrix(info.matrix3D); 7184 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY); 7185 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX, 7186 info.mPivotY + info.mTranslationY); 7187 info.mMatrix.postConcat(info.matrix3D); 7188 info.mCamera.restore(); 7189 } 7190 info.mMatrixDirty = false; 7191 info.mMatrixIsIdentity = info.mMatrix.isIdentity(); 7192 info.mInverseMatrixDirty = true; 7193 } 7194 } 7195 7196 /** 7197 * Utility method to retrieve the inverse of the current mMatrix property. 7198 * We cache the matrix to avoid recalculating it when transform properties 7199 * have not changed. 7200 * 7201 * @return The inverse of the current matrix of this view. 7202 */ 7203 final Matrix getInverseMatrix() { 7204 final TransformationInfo info = mTransformationInfo; 7205 if (info != null) { 7206 updateMatrix(); 7207 if (info.mInverseMatrixDirty) { 7208 if (info.mInverseMatrix == null) { 7209 info.mInverseMatrix = new Matrix(); 7210 } 7211 info.mMatrix.invert(info.mInverseMatrix); 7212 info.mInverseMatrixDirty = false; 7213 } 7214 return info.mInverseMatrix; 7215 } 7216 return Matrix.IDENTITY_MATRIX; 7217 } 7218 7219 /** 7220 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which 7221 * views are drawn) from the camera to this view. The camera's distance 7222 * affects 3D transformations, for instance rotations around the X and Y 7223 * axis. If the rotationX or rotationY properties are changed and this view is 7224 * large (more than half the size of the screen), it is recommended to always 7225 * use a camera distance that's greater than the height (X axis rotation) or 7226 * the width (Y axis rotation) of this view.</p> 7227 * 7228 * <p>The distance of the camera from the view plane can have an affect on the 7229 * perspective distortion of the view when it is rotated around the x or y axis. 7230 * For example, a large distance will result in a large viewing angle, and there 7231 * will not be much perspective distortion of the view as it rotates. A short 7232 * distance may cause much more perspective distortion upon rotation, and can 7233 * also result in some drawing artifacts if the rotated view ends up partially 7234 * behind the camera (which is why the recommendation is to use a distance at 7235 * least as far as the size of the view, if the view is to be rotated.)</p> 7236 * 7237 * <p>The distance is expressed in "depth pixels." The default distance depends 7238 * on the screen density. For instance, on a medium density display, the 7239 * default distance is 1280. On a high density display, the default distance 7240 * is 1920.</p> 7241 * 7242 * <p>If you want to specify a distance that leads to visually consistent 7243 * results across various densities, use the following formula:</p> 7244 * <pre> 7245 * float scale = context.getResources().getDisplayMetrics().density; 7246 * view.setCameraDistance(distance * scale); 7247 * </pre> 7248 * 7249 * <p>The density scale factor of a high density display is 1.5, 7250 * and 1920 = 1280 * 1.5.</p> 7251 * 7252 * @param distance The distance in "depth pixels", if negative the opposite 7253 * value is used 7254 * 7255 * @see #setRotationX(float) 7256 * @see #setRotationY(float) 7257 */ 7258 public void setCameraDistance(float distance) { 7259 invalidateParentCaches(); 7260 invalidate(false); 7261 7262 ensureTransformationInfo(); 7263 final float dpi = mResources.getDisplayMetrics().densityDpi; 7264 final TransformationInfo info = mTransformationInfo; 7265 if (info.mCamera == null) { 7266 info.mCamera = new Camera(); 7267 info.matrix3D = new Matrix(); 7268 } 7269 7270 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi); 7271 info.mMatrixDirty = true; 7272 7273 invalidate(false); 7274 } 7275 7276 /** 7277 * The degrees that the view is rotated around the pivot point. 7278 * 7279 * @see #setRotation(float) 7280 * @see #getPivotX() 7281 * @see #getPivotY() 7282 * 7283 * @return The degrees of rotation. 7284 */ 7285 public float getRotation() { 7286 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0; 7287 } 7288 7289 /** 7290 * Sets the degrees that the view is rotated around the pivot point. Increasing values 7291 * result in clockwise rotation. 7292 * 7293 * @param rotation The degrees of rotation. 7294 * 7295 * @see #getRotation() 7296 * @see #getPivotX() 7297 * @see #getPivotY() 7298 * @see #setRotationX(float) 7299 * @see #setRotationY(float) 7300 * 7301 * @attr ref android.R.styleable#View_rotation 7302 */ 7303 public void setRotation(float rotation) { 7304 ensureTransformationInfo(); 7305 final TransformationInfo info = mTransformationInfo; 7306 if (info.mRotation != rotation) { 7307 invalidateParentCaches(); 7308 // Double-invalidation is necessary to capture view's old and new areas 7309 invalidate(false); 7310 info.mRotation = rotation; 7311 info.mMatrixDirty = true; 7312 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7313 invalidate(false); 7314 } 7315 } 7316 7317 /** 7318 * The degrees that the view is rotated around the vertical axis through the pivot point. 7319 * 7320 * @see #getPivotX() 7321 * @see #getPivotY() 7322 * @see #setRotationY(float) 7323 * 7324 * @return The degrees of Y rotation. 7325 */ 7326 public float getRotationY() { 7327 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0; 7328 } 7329 7330 /** 7331 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 7332 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 7333 * down the y axis. 7334 * 7335 * When rotating large views, it is recommended to adjust the camera distance 7336 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 7337 * 7338 * @param rotationY The degrees of Y rotation. 7339 * 7340 * @see #getRotationY() 7341 * @see #getPivotX() 7342 * @see #getPivotY() 7343 * @see #setRotation(float) 7344 * @see #setRotationX(float) 7345 * @see #setCameraDistance(float) 7346 * 7347 * @attr ref android.R.styleable#View_rotationY 7348 */ 7349 public void setRotationY(float rotationY) { 7350 ensureTransformationInfo(); 7351 final TransformationInfo info = mTransformationInfo; 7352 if (info.mRotationY != rotationY) { 7353 invalidateParentCaches(); 7354 // Double-invalidation is necessary to capture view's old and new areas 7355 invalidate(false); 7356 info.mRotationY = rotationY; 7357 info.mMatrixDirty = true; 7358 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7359 invalidate(false); 7360 } 7361 } 7362 7363 /** 7364 * The degrees that the view is rotated around the horizontal axis through the pivot point. 7365 * 7366 * @see #getPivotX() 7367 * @see #getPivotY() 7368 * @see #setRotationX(float) 7369 * 7370 * @return The degrees of X rotation. 7371 */ 7372 public float getRotationX() { 7373 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0; 7374 } 7375 7376 /** 7377 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 7378 * Increasing values result in clockwise rotation from the viewpoint of looking down the 7379 * x axis. 7380 * 7381 * When rotating large views, it is recommended to adjust the camera distance 7382 * accordingly. Refer to {@link #setCameraDistance(float)} for more information. 7383 * 7384 * @param rotationX The degrees of X rotation. 7385 * 7386 * @see #getRotationX() 7387 * @see #getPivotX() 7388 * @see #getPivotY() 7389 * @see #setRotation(float) 7390 * @see #setRotationY(float) 7391 * @see #setCameraDistance(float) 7392 * 7393 * @attr ref android.R.styleable#View_rotationX 7394 */ 7395 public void setRotationX(float rotationX) { 7396 ensureTransformationInfo(); 7397 final TransformationInfo info = mTransformationInfo; 7398 if (info.mRotationX != rotationX) { 7399 invalidateParentCaches(); 7400 // Double-invalidation is necessary to capture view's old and new areas 7401 invalidate(false); 7402 info.mRotationX = rotationX; 7403 info.mMatrixDirty = true; 7404 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7405 invalidate(false); 7406 } 7407 } 7408 7409 /** 7410 * The amount that the view is scaled in x around the pivot point, as a proportion of 7411 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 7412 * 7413 * <p>By default, this is 1.0f. 7414 * 7415 * @see #getPivotX() 7416 * @see #getPivotY() 7417 * @return The scaling factor. 7418 */ 7419 public float getScaleX() { 7420 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1; 7421 } 7422 7423 /** 7424 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 7425 * the view's unscaled width. A value of 1 means that no scaling is applied. 7426 * 7427 * @param scaleX The scaling factor. 7428 * @see #getPivotX() 7429 * @see #getPivotY() 7430 * 7431 * @attr ref android.R.styleable#View_scaleX 7432 */ 7433 public void setScaleX(float scaleX) { 7434 ensureTransformationInfo(); 7435 final TransformationInfo info = mTransformationInfo; 7436 if (info.mScaleX != scaleX) { 7437 invalidateParentCaches(); 7438 // Double-invalidation is necessary to capture view's old and new areas 7439 invalidate(false); 7440 info.mScaleX = scaleX; 7441 info.mMatrixDirty = true; 7442 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7443 invalidate(false); 7444 } 7445 } 7446 7447 /** 7448 * The amount that the view is scaled in y around the pivot point, as a proportion of 7449 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 7450 * 7451 * <p>By default, this is 1.0f. 7452 * 7453 * @see #getPivotX() 7454 * @see #getPivotY() 7455 * @return The scaling factor. 7456 */ 7457 public float getScaleY() { 7458 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1; 7459 } 7460 7461 /** 7462 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 7463 * the view's unscaled width. A value of 1 means that no scaling is applied. 7464 * 7465 * @param scaleY The scaling factor. 7466 * @see #getPivotX() 7467 * @see #getPivotY() 7468 * 7469 * @attr ref android.R.styleable#View_scaleY 7470 */ 7471 public void setScaleY(float scaleY) { 7472 ensureTransformationInfo(); 7473 final TransformationInfo info = mTransformationInfo; 7474 if (info.mScaleY != scaleY) { 7475 invalidateParentCaches(); 7476 // Double-invalidation is necessary to capture view's old and new areas 7477 invalidate(false); 7478 info.mScaleY = scaleY; 7479 info.mMatrixDirty = true; 7480 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7481 invalidate(false); 7482 } 7483 } 7484 7485 /** 7486 * The x location of the point around which the view is {@link #setRotation(float) rotated} 7487 * and {@link #setScaleX(float) scaled}. 7488 * 7489 * @see #getRotation() 7490 * @see #getScaleX() 7491 * @see #getScaleY() 7492 * @see #getPivotY() 7493 * @return The x location of the pivot point. 7494 */ 7495 public float getPivotX() { 7496 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0; 7497 } 7498 7499 /** 7500 * Sets the x location of the point around which the view is 7501 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 7502 * By default, the pivot point is centered on the object. 7503 * Setting this property disables this behavior and causes the view to use only the 7504 * explicitly set pivotX and pivotY values. 7505 * 7506 * @param pivotX The x location of the pivot point. 7507 * @see #getRotation() 7508 * @see #getScaleX() 7509 * @see #getScaleY() 7510 * @see #getPivotY() 7511 * 7512 * @attr ref android.R.styleable#View_transformPivotX 7513 */ 7514 public void setPivotX(float pivotX) { 7515 ensureTransformationInfo(); 7516 mPrivateFlags |= PIVOT_EXPLICITLY_SET; 7517 final TransformationInfo info = mTransformationInfo; 7518 if (info.mPivotX != pivotX) { 7519 invalidateParentCaches(); 7520 // Double-invalidation is necessary to capture view's old and new areas 7521 invalidate(false); 7522 info.mPivotX = pivotX; 7523 info.mMatrixDirty = true; 7524 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7525 invalidate(false); 7526 } 7527 } 7528 7529 /** 7530 * The y location of the point around which the view is {@link #setRotation(float) rotated} 7531 * and {@link #setScaleY(float) scaled}. 7532 * 7533 * @see #getRotation() 7534 * @see #getScaleX() 7535 * @see #getScaleY() 7536 * @see #getPivotY() 7537 * @return The y location of the pivot point. 7538 */ 7539 public float getPivotY() { 7540 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0; 7541 } 7542 7543 /** 7544 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 7545 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 7546 * Setting this property disables this behavior and causes the view to use only the 7547 * explicitly set pivotX and pivotY values. 7548 * 7549 * @param pivotY The y location of the pivot point. 7550 * @see #getRotation() 7551 * @see #getScaleX() 7552 * @see #getScaleY() 7553 * @see #getPivotY() 7554 * 7555 * @attr ref android.R.styleable#View_transformPivotY 7556 */ 7557 public void setPivotY(float pivotY) { 7558 ensureTransformationInfo(); 7559 mPrivateFlags |= PIVOT_EXPLICITLY_SET; 7560 final TransformationInfo info = mTransformationInfo; 7561 if (info.mPivotY != pivotY) { 7562 invalidateParentCaches(); 7563 // Double-invalidation is necessary to capture view's old and new areas 7564 invalidate(false); 7565 info.mPivotY = pivotY; 7566 info.mMatrixDirty = true; 7567 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7568 invalidate(false); 7569 } 7570 } 7571 7572 /** 7573 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 7574 * completely transparent and 1 means the view is completely opaque. 7575 * 7576 * <p>By default this is 1.0f. 7577 * @return The opacity of the view. 7578 */ 7579 public float getAlpha() { 7580 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1; 7581 } 7582 7583 /** 7584 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 7585 * completely transparent and 1 means the view is completely opaque.</p> 7586 * 7587 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 7588 * responsible for applying the opacity itself. Otherwise, calling this method is 7589 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and 7590 * setting a hardware layer.</p> 7591 * 7592 * @param alpha The opacity of the view. 7593 * 7594 * @see #setLayerType(int, android.graphics.Paint) 7595 * 7596 * @attr ref android.R.styleable#View_alpha 7597 */ 7598 public void setAlpha(float alpha) { 7599 ensureTransformationInfo(); 7600 if (mTransformationInfo.mAlpha != alpha) { 7601 mTransformationInfo.mAlpha = alpha; 7602 invalidateParentCaches(); 7603 if (onSetAlpha((int) (alpha * 255))) { 7604 mPrivateFlags |= ALPHA_SET; 7605 // subclass is handling alpha - don't optimize rendering cache invalidation 7606 invalidate(true); 7607 } else { 7608 mPrivateFlags &= ~ALPHA_SET; 7609 invalidate(false); 7610 } 7611 } 7612 } 7613 7614 /** 7615 * Faster version of setAlpha() which performs the same steps except there are 7616 * no calls to invalidate(). The caller of this function should perform proper invalidation 7617 * on the parent and this object. The return value indicates whether the subclass handles 7618 * alpha (the return value for onSetAlpha()). 7619 * 7620 * @param alpha The new value for the alpha property 7621 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and 7622 * the new value for the alpha property is different from the old value 7623 */ 7624 boolean setAlphaNoInvalidation(float alpha) { 7625 ensureTransformationInfo(); 7626 if (mTransformationInfo.mAlpha != alpha) { 7627 mTransformationInfo.mAlpha = alpha; 7628 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255)); 7629 if (subclassHandlesAlpha) { 7630 mPrivateFlags |= ALPHA_SET; 7631 return true; 7632 } else { 7633 mPrivateFlags &= ~ALPHA_SET; 7634 } 7635 } 7636 return false; 7637 } 7638 7639 /** 7640 * Top position of this view relative to its parent. 7641 * 7642 * @return The top of this view, in pixels. 7643 */ 7644 @ViewDebug.CapturedViewProperty 7645 public final int getTop() { 7646 return mTop; 7647 } 7648 7649 /** 7650 * Sets the top position of this view relative to its parent. This method is meant to be called 7651 * by the layout system and should not generally be called otherwise, because the property 7652 * may be changed at any time by the layout. 7653 * 7654 * @param top The top of this view, in pixels. 7655 */ 7656 public final void setTop(int top) { 7657 if (top != mTop) { 7658 updateMatrix(); 7659 final boolean matrixIsIdentity = mTransformationInfo == null 7660 || mTransformationInfo.mMatrixIsIdentity; 7661 if (matrixIsIdentity) { 7662 if (mAttachInfo != null) { 7663 int minTop; 7664 int yLoc; 7665 if (top < mTop) { 7666 minTop = top; 7667 yLoc = top - mTop; 7668 } else { 7669 minTop = mTop; 7670 yLoc = 0; 7671 } 7672 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop); 7673 } 7674 } else { 7675 // Double-invalidation is necessary to capture view's old and new areas 7676 invalidate(true); 7677 } 7678 7679 int width = mRight - mLeft; 7680 int oldHeight = mBottom - mTop; 7681 7682 mTop = top; 7683 7684 onSizeChanged(width, mBottom - mTop, width, oldHeight); 7685 7686 if (!matrixIsIdentity) { 7687 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 7688 // A change in dimension means an auto-centered pivot point changes, too 7689 mTransformationInfo.mMatrixDirty = true; 7690 } 7691 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7692 invalidate(true); 7693 } 7694 mBackgroundSizeChanged = true; 7695 invalidateParentIfNeeded(); 7696 } 7697 } 7698 7699 /** 7700 * Bottom position of this view relative to its parent. 7701 * 7702 * @return The bottom of this view, in pixels. 7703 */ 7704 @ViewDebug.CapturedViewProperty 7705 public final int getBottom() { 7706 return mBottom; 7707 } 7708 7709 /** 7710 * True if this view has changed since the last time being drawn. 7711 * 7712 * @return The dirty state of this view. 7713 */ 7714 public boolean isDirty() { 7715 return (mPrivateFlags & DIRTY_MASK) != 0; 7716 } 7717 7718 /** 7719 * Sets the bottom position of this view relative to its parent. This method is meant to be 7720 * called by the layout system and should not generally be called otherwise, because the 7721 * property may be changed at any time by the layout. 7722 * 7723 * @param bottom The bottom of this view, in pixels. 7724 */ 7725 public final void setBottom(int bottom) { 7726 if (bottom != mBottom) { 7727 updateMatrix(); 7728 final boolean matrixIsIdentity = mTransformationInfo == null 7729 || mTransformationInfo.mMatrixIsIdentity; 7730 if (matrixIsIdentity) { 7731 if (mAttachInfo != null) { 7732 int maxBottom; 7733 if (bottom < mBottom) { 7734 maxBottom = mBottom; 7735 } else { 7736 maxBottom = bottom; 7737 } 7738 invalidate(0, 0, mRight - mLeft, maxBottom - mTop); 7739 } 7740 } else { 7741 // Double-invalidation is necessary to capture view's old and new areas 7742 invalidate(true); 7743 } 7744 7745 int width = mRight - mLeft; 7746 int oldHeight = mBottom - mTop; 7747 7748 mBottom = bottom; 7749 7750 onSizeChanged(width, mBottom - mTop, width, oldHeight); 7751 7752 if (!matrixIsIdentity) { 7753 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 7754 // A change in dimension means an auto-centered pivot point changes, too 7755 mTransformationInfo.mMatrixDirty = true; 7756 } 7757 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7758 invalidate(true); 7759 } 7760 mBackgroundSizeChanged = true; 7761 invalidateParentIfNeeded(); 7762 } 7763 } 7764 7765 /** 7766 * Left position of this view relative to its parent. 7767 * 7768 * @return The left edge of this view, in pixels. 7769 */ 7770 @ViewDebug.CapturedViewProperty 7771 public final int getLeft() { 7772 return mLeft; 7773 } 7774 7775 /** 7776 * Sets the left position of this view relative to its parent. This method is meant to be called 7777 * by the layout system and should not generally be called otherwise, because the property 7778 * may be changed at any time by the layout. 7779 * 7780 * @param left The bottom of this view, in pixels. 7781 */ 7782 public final void setLeft(int left) { 7783 if (left != mLeft) { 7784 updateMatrix(); 7785 final boolean matrixIsIdentity = mTransformationInfo == null 7786 || mTransformationInfo.mMatrixIsIdentity; 7787 if (matrixIsIdentity) { 7788 if (mAttachInfo != null) { 7789 int minLeft; 7790 int xLoc; 7791 if (left < mLeft) { 7792 minLeft = left; 7793 xLoc = left - mLeft; 7794 } else { 7795 minLeft = mLeft; 7796 xLoc = 0; 7797 } 7798 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop); 7799 } 7800 } else { 7801 // Double-invalidation is necessary to capture view's old and new areas 7802 invalidate(true); 7803 } 7804 7805 int oldWidth = mRight - mLeft; 7806 int height = mBottom - mTop; 7807 7808 mLeft = left; 7809 7810 onSizeChanged(mRight - mLeft, height, oldWidth, height); 7811 7812 if (!matrixIsIdentity) { 7813 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 7814 // A change in dimension means an auto-centered pivot point changes, too 7815 mTransformationInfo.mMatrixDirty = true; 7816 } 7817 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7818 invalidate(true); 7819 } 7820 mBackgroundSizeChanged = true; 7821 invalidateParentIfNeeded(); 7822 } 7823 } 7824 7825 /** 7826 * Right position of this view relative to its parent. 7827 * 7828 * @return The right edge of this view, in pixels. 7829 */ 7830 @ViewDebug.CapturedViewProperty 7831 public final int getRight() { 7832 return mRight; 7833 } 7834 7835 /** 7836 * Sets the right position of this view relative to its parent. This method is meant to be called 7837 * by the layout system and should not generally be called otherwise, because the property 7838 * may be changed at any time by the layout. 7839 * 7840 * @param right The bottom of this view, in pixels. 7841 */ 7842 public final void setRight(int right) { 7843 if (right != mRight) { 7844 updateMatrix(); 7845 final boolean matrixIsIdentity = mTransformationInfo == null 7846 || mTransformationInfo.mMatrixIsIdentity; 7847 if (matrixIsIdentity) { 7848 if (mAttachInfo != null) { 7849 int maxRight; 7850 if (right < mRight) { 7851 maxRight = mRight; 7852 } else { 7853 maxRight = right; 7854 } 7855 invalidate(0, 0, maxRight - mLeft, mBottom - mTop); 7856 } 7857 } else { 7858 // Double-invalidation is necessary to capture view's old and new areas 7859 invalidate(true); 7860 } 7861 7862 int oldWidth = mRight - mLeft; 7863 int height = mBottom - mTop; 7864 7865 mRight = right; 7866 7867 onSizeChanged(mRight - mLeft, height, oldWidth, height); 7868 7869 if (!matrixIsIdentity) { 7870 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 7871 // A change in dimension means an auto-centered pivot point changes, too 7872 mTransformationInfo.mMatrixDirty = true; 7873 } 7874 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7875 invalidate(true); 7876 } 7877 mBackgroundSizeChanged = true; 7878 invalidateParentIfNeeded(); 7879 } 7880 } 7881 7882 /** 7883 * The visual x position of this view, in pixels. This is equivalent to the 7884 * {@link #setTranslationX(float) translationX} property plus the current 7885 * {@link #getLeft() left} property. 7886 * 7887 * @return The visual x position of this view, in pixels. 7888 */ 7889 public float getX() { 7890 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0); 7891 } 7892 7893 /** 7894 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 7895 * {@link #setTranslationX(float) translationX} property to be the difference between 7896 * the x value passed in and the current {@link #getLeft() left} property. 7897 * 7898 * @param x The visual x position of this view, in pixels. 7899 */ 7900 public void setX(float x) { 7901 setTranslationX(x - mLeft); 7902 } 7903 7904 /** 7905 * The visual y position of this view, in pixels. This is equivalent to the 7906 * {@link #setTranslationY(float) translationY} property plus the current 7907 * {@link #getTop() top} property. 7908 * 7909 * @return The visual y position of this view, in pixels. 7910 */ 7911 public float getY() { 7912 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0); 7913 } 7914 7915 /** 7916 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 7917 * {@link #setTranslationY(float) translationY} property to be the difference between 7918 * the y value passed in and the current {@link #getTop() top} property. 7919 * 7920 * @param y The visual y position of this view, in pixels. 7921 */ 7922 public void setY(float y) { 7923 setTranslationY(y - mTop); 7924 } 7925 7926 7927 /** 7928 * The horizontal location of this view relative to its {@link #getLeft() left} position. 7929 * This position is post-layout, in addition to wherever the object's 7930 * layout placed it. 7931 * 7932 * @return The horizontal position of this view relative to its left position, in pixels. 7933 */ 7934 public float getTranslationX() { 7935 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0; 7936 } 7937 7938 /** 7939 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 7940 * This effectively positions the object post-layout, in addition to wherever the object's 7941 * layout placed it. 7942 * 7943 * @param translationX The horizontal position of this view relative to its left position, 7944 * in pixels. 7945 * 7946 * @attr ref android.R.styleable#View_translationX 7947 */ 7948 public void setTranslationX(float translationX) { 7949 ensureTransformationInfo(); 7950 final TransformationInfo info = mTransformationInfo; 7951 if (info.mTranslationX != translationX) { 7952 invalidateParentCaches(); 7953 // Double-invalidation is necessary to capture view's old and new areas 7954 invalidate(false); 7955 info.mTranslationX = translationX; 7956 info.mMatrixDirty = true; 7957 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7958 invalidate(false); 7959 } 7960 } 7961 7962 /** 7963 * The horizontal location of this view relative to its {@link #getTop() top} position. 7964 * This position is post-layout, in addition to wherever the object's 7965 * layout placed it. 7966 * 7967 * @return The vertical position of this view relative to its top position, 7968 * in pixels. 7969 */ 7970 public float getTranslationY() { 7971 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0; 7972 } 7973 7974 /** 7975 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 7976 * This effectively positions the object post-layout, in addition to wherever the object's 7977 * layout placed it. 7978 * 7979 * @param translationY The vertical position of this view relative to its top position, 7980 * in pixels. 7981 * 7982 * @attr ref android.R.styleable#View_translationY 7983 */ 7984 public void setTranslationY(float translationY) { 7985 ensureTransformationInfo(); 7986 final TransformationInfo info = mTransformationInfo; 7987 if (info.mTranslationY != translationY) { 7988 invalidateParentCaches(); 7989 // Double-invalidation is necessary to capture view's old and new areas 7990 invalidate(false); 7991 info.mTranslationY = translationY; 7992 info.mMatrixDirty = true; 7993 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 7994 invalidate(false); 7995 } 7996 } 7997 7998 /** 7999 * Hit rectangle in parent's coordinates 8000 * 8001 * @param outRect The hit rectangle of the view. 8002 */ 8003 public void getHitRect(Rect outRect) { 8004 updateMatrix(); 8005 final TransformationInfo info = mTransformationInfo; 8006 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) { 8007 outRect.set(mLeft, mTop, mRight, mBottom); 8008 } else { 8009 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 8010 tmpRect.set(-info.mPivotX, -info.mPivotY, 8011 getWidth() - info.mPivotX, getHeight() - info.mPivotY); 8012 info.mMatrix.mapRect(tmpRect); 8013 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 8014 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 8015 } 8016 } 8017 8018 /** 8019 * Determines whether the given point, in local coordinates is inside the view. 8020 */ 8021 /*package*/ final boolean pointInView(float localX, float localY) { 8022 return localX >= 0 && localX < (mRight - mLeft) 8023 && localY >= 0 && localY < (mBottom - mTop); 8024 } 8025 8026 /** 8027 * Utility method to determine whether the given point, in local coordinates, 8028 * is inside the view, where the area of the view is expanded by the slop factor. 8029 * This method is called while processing touch-move events to determine if the event 8030 * is still within the view. 8031 */ 8032 private boolean pointInView(float localX, float localY, float slop) { 8033 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 8034 localY < ((mBottom - mTop) + slop); 8035 } 8036 8037 /** 8038 * When a view has focus and the user navigates away from it, the next view is searched for 8039 * starting from the rectangle filled in by this method. 8040 * 8041 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)}) 8042 * of the view. However, if your view maintains some idea of internal selection, 8043 * such as a cursor, or a selected row or column, you should override this method and 8044 * fill in a more specific rectangle. 8045 * 8046 * @param r The rectangle to fill in, in this view's coordinates. 8047 */ 8048 public void getFocusedRect(Rect r) { 8049 getDrawingRect(r); 8050 } 8051 8052 /** 8053 * If some part of this view is not clipped by any of its parents, then 8054 * return that area in r in global (root) coordinates. To convert r to local 8055 * coordinates (without taking possible View rotations into account), offset 8056 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). 8057 * If the view is completely clipped or translated out, return false. 8058 * 8059 * @param r If true is returned, r holds the global coordinates of the 8060 * visible portion of this view. 8061 * @param globalOffset If true is returned, globalOffset holds the dx,dy 8062 * between this view and its root. globalOffet may be null. 8063 * @return true if r is non-empty (i.e. part of the view is visible at the 8064 * root level. 8065 */ 8066 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 8067 int width = mRight - mLeft; 8068 int height = mBottom - mTop; 8069 if (width > 0 && height > 0) { 8070 r.set(0, 0, width, height); 8071 if (globalOffset != null) { 8072 globalOffset.set(-mScrollX, -mScrollY); 8073 } 8074 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 8075 } 8076 return false; 8077 } 8078 8079 public final boolean getGlobalVisibleRect(Rect r) { 8080 return getGlobalVisibleRect(r, null); 8081 } 8082 8083 public final boolean getLocalVisibleRect(Rect r) { 8084 Point offset = new Point(); 8085 if (getGlobalVisibleRect(r, offset)) { 8086 r.offset(-offset.x, -offset.y); // make r local 8087 return true; 8088 } 8089 return false; 8090 } 8091 8092 /** 8093 * Offset this view's vertical location by the specified number of pixels. 8094 * 8095 * @param offset the number of pixels to offset the view by 8096 */ 8097 public void offsetTopAndBottom(int offset) { 8098 if (offset != 0) { 8099 updateMatrix(); 8100 final boolean matrixIsIdentity = mTransformationInfo == null 8101 || mTransformationInfo.mMatrixIsIdentity; 8102 if (matrixIsIdentity) { 8103 final ViewParent p = mParent; 8104 if (p != null && mAttachInfo != null) { 8105 final Rect r = mAttachInfo.mTmpInvalRect; 8106 int minTop; 8107 int maxBottom; 8108 int yLoc; 8109 if (offset < 0) { 8110 minTop = mTop + offset; 8111 maxBottom = mBottom; 8112 yLoc = offset; 8113 } else { 8114 minTop = mTop; 8115 maxBottom = mBottom + offset; 8116 yLoc = 0; 8117 } 8118 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 8119 p.invalidateChild(this, r); 8120 } 8121 } else { 8122 invalidate(false); 8123 } 8124 8125 mTop += offset; 8126 mBottom += offset; 8127 8128 if (!matrixIsIdentity) { 8129 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 8130 invalidate(false); 8131 } 8132 invalidateParentIfNeeded(); 8133 } 8134 } 8135 8136 /** 8137 * Offset this view's horizontal location by the specified amount of pixels. 8138 * 8139 * @param offset the numer of pixels to offset the view by 8140 */ 8141 public void offsetLeftAndRight(int offset) { 8142 if (offset != 0) { 8143 updateMatrix(); 8144 final boolean matrixIsIdentity = mTransformationInfo == null 8145 || mTransformationInfo.mMatrixIsIdentity; 8146 if (matrixIsIdentity) { 8147 final ViewParent p = mParent; 8148 if (p != null && mAttachInfo != null) { 8149 final Rect r = mAttachInfo.mTmpInvalRect; 8150 int minLeft; 8151 int maxRight; 8152 if (offset < 0) { 8153 minLeft = mLeft + offset; 8154 maxRight = mRight; 8155 } else { 8156 minLeft = mLeft; 8157 maxRight = mRight + offset; 8158 } 8159 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 8160 p.invalidateChild(this, r); 8161 } 8162 } else { 8163 invalidate(false); 8164 } 8165 8166 mLeft += offset; 8167 mRight += offset; 8168 8169 if (!matrixIsIdentity) { 8170 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 8171 invalidate(false); 8172 } 8173 invalidateParentIfNeeded(); 8174 } 8175 } 8176 8177 /** 8178 * Get the LayoutParams associated with this view. All views should have 8179 * layout parameters. These supply parameters to the <i>parent</i> of this 8180 * view specifying how it should be arranged. There are many subclasses of 8181 * ViewGroup.LayoutParams, and these correspond to the different subclasses 8182 * of ViewGroup that are responsible for arranging their children. 8183 * 8184 * This method may return null if this View is not attached to a parent 8185 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)} 8186 * was not invoked successfully. When a View is attached to a parent 8187 * ViewGroup, this method must not return null. 8188 * 8189 * @return The LayoutParams associated with this view, or null if no 8190 * parameters have been set yet 8191 */ 8192 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 8193 public ViewGroup.LayoutParams getLayoutParams() { 8194 return mLayoutParams; 8195 } 8196 8197 /** 8198 * Set the layout parameters associated with this view. These supply 8199 * parameters to the <i>parent</i> of this view specifying how it should be 8200 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 8201 * correspond to the different subclasses of ViewGroup that are responsible 8202 * for arranging their children. 8203 * 8204 * @param params The layout parameters for this view, cannot be null 8205 */ 8206 public void setLayoutParams(ViewGroup.LayoutParams params) { 8207 if (params == null) { 8208 throw new NullPointerException("Layout parameters cannot be null"); 8209 } 8210 mLayoutParams = params; 8211 requestLayout(); 8212 } 8213 8214 /** 8215 * Set the scrolled position of your view. This will cause a call to 8216 * {@link #onScrollChanged(int, int, int, int)} and the view will be 8217 * invalidated. 8218 * @param x the x position to scroll to 8219 * @param y the y position to scroll to 8220 */ 8221 public void scrollTo(int x, int y) { 8222 if (mScrollX != x || mScrollY != y) { 8223 int oldX = mScrollX; 8224 int oldY = mScrollY; 8225 mScrollX = x; 8226 mScrollY = y; 8227 invalidateParentCaches(); 8228 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 8229 if (!awakenScrollBars()) { 8230 invalidate(true); 8231 } 8232 } 8233 } 8234 8235 /** 8236 * Move the scrolled position of your view. This will cause a call to 8237 * {@link #onScrollChanged(int, int, int, int)} and the view will be 8238 * invalidated. 8239 * @param x the amount of pixels to scroll by horizontally 8240 * @param y the amount of pixels to scroll by vertically 8241 */ 8242 public void scrollBy(int x, int y) { 8243 scrollTo(mScrollX + x, mScrollY + y); 8244 } 8245 8246 /** 8247 * <p>Trigger the scrollbars to draw. When invoked this method starts an 8248 * animation to fade the scrollbars out after a default delay. If a subclass 8249 * provides animated scrolling, the start delay should equal the duration 8250 * of the scrolling animation.</p> 8251 * 8252 * <p>The animation starts only if at least one of the scrollbars is 8253 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 8254 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 8255 * this method returns true, and false otherwise. If the animation is 8256 * started, this method calls {@link #invalidate()}; in that case the 8257 * caller should not call {@link #invalidate()}.</p> 8258 * 8259 * <p>This method should be invoked every time a subclass directly updates 8260 * the scroll parameters.</p> 8261 * 8262 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 8263 * and {@link #scrollTo(int, int)}.</p> 8264 * 8265 * @return true if the animation is played, false otherwise 8266 * 8267 * @see #awakenScrollBars(int) 8268 * @see #scrollBy(int, int) 8269 * @see #scrollTo(int, int) 8270 * @see #isHorizontalScrollBarEnabled() 8271 * @see #isVerticalScrollBarEnabled() 8272 * @see #setHorizontalScrollBarEnabled(boolean) 8273 * @see #setVerticalScrollBarEnabled(boolean) 8274 */ 8275 protected boolean awakenScrollBars() { 8276 return mScrollCache != null && 8277 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 8278 } 8279 8280 /** 8281 * Trigger the scrollbars to draw. 8282 * This method differs from awakenScrollBars() only in its default duration. 8283 * initialAwakenScrollBars() will show the scroll bars for longer than 8284 * usual to give the user more of a chance to notice them. 8285 * 8286 * @return true if the animation is played, false otherwise. 8287 */ 8288 private boolean initialAwakenScrollBars() { 8289 return mScrollCache != null && 8290 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 8291 } 8292 8293 /** 8294 * <p> 8295 * Trigger the scrollbars to draw. When invoked this method starts an 8296 * animation to fade the scrollbars out after a fixed delay. If a subclass 8297 * provides animated scrolling, the start delay should equal the duration of 8298 * the scrolling animation. 8299 * </p> 8300 * 8301 * <p> 8302 * The animation starts only if at least one of the scrollbars is enabled, 8303 * as specified by {@link #isHorizontalScrollBarEnabled()} and 8304 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 8305 * this method returns true, and false otherwise. If the animation is 8306 * started, this method calls {@link #invalidate()}; in that case the caller 8307 * should not call {@link #invalidate()}. 8308 * </p> 8309 * 8310 * <p> 8311 * This method should be invoked everytime a subclass directly updates the 8312 * scroll parameters. 8313 * </p> 8314 * 8315 * @param startDelay the delay, in milliseconds, after which the animation 8316 * should start; when the delay is 0, the animation starts 8317 * immediately 8318 * @return true if the animation is played, false otherwise 8319 * 8320 * @see #scrollBy(int, int) 8321 * @see #scrollTo(int, int) 8322 * @see #isHorizontalScrollBarEnabled() 8323 * @see #isVerticalScrollBarEnabled() 8324 * @see #setHorizontalScrollBarEnabled(boolean) 8325 * @see #setVerticalScrollBarEnabled(boolean) 8326 */ 8327 protected boolean awakenScrollBars(int startDelay) { 8328 return awakenScrollBars(startDelay, true); 8329 } 8330 8331 /** 8332 * <p> 8333 * Trigger the scrollbars to draw. When invoked this method starts an 8334 * animation to fade the scrollbars out after a fixed delay. If a subclass 8335 * provides animated scrolling, the start delay should equal the duration of 8336 * the scrolling animation. 8337 * </p> 8338 * 8339 * <p> 8340 * The animation starts only if at least one of the scrollbars is enabled, 8341 * as specified by {@link #isHorizontalScrollBarEnabled()} and 8342 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 8343 * this method returns true, and false otherwise. If the animation is 8344 * started, this method calls {@link #invalidate()} if the invalidate parameter 8345 * is set to true; in that case the caller 8346 * should not call {@link #invalidate()}. 8347 * </p> 8348 * 8349 * <p> 8350 * This method should be invoked everytime a subclass directly updates the 8351 * scroll parameters. 8352 * </p> 8353 * 8354 * @param startDelay the delay, in milliseconds, after which the animation 8355 * should start; when the delay is 0, the animation starts 8356 * immediately 8357 * 8358 * @param invalidate Wheter this method should call invalidate 8359 * 8360 * @return true if the animation is played, false otherwise 8361 * 8362 * @see #scrollBy(int, int) 8363 * @see #scrollTo(int, int) 8364 * @see #isHorizontalScrollBarEnabled() 8365 * @see #isVerticalScrollBarEnabled() 8366 * @see #setHorizontalScrollBarEnabled(boolean) 8367 * @see #setVerticalScrollBarEnabled(boolean) 8368 */ 8369 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 8370 final ScrollabilityCache scrollCache = mScrollCache; 8371 8372 if (scrollCache == null || !scrollCache.fadeScrollBars) { 8373 return false; 8374 } 8375 8376 if (scrollCache.scrollBar == null) { 8377 scrollCache.scrollBar = new ScrollBarDrawable(); 8378 } 8379 8380 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 8381 8382 if (invalidate) { 8383 // Invalidate to show the scrollbars 8384 invalidate(true); 8385 } 8386 8387 if (scrollCache.state == ScrollabilityCache.OFF) { 8388 // FIXME: this is copied from WindowManagerService. 8389 // We should get this value from the system when it 8390 // is possible to do so. 8391 final int KEY_REPEAT_FIRST_DELAY = 750; 8392 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 8393 } 8394 8395 // Tell mScrollCache when we should start fading. This may 8396 // extend the fade start time if one was already scheduled 8397 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 8398 scrollCache.fadeStartTime = fadeStartTime; 8399 scrollCache.state = ScrollabilityCache.ON; 8400 8401 // Schedule our fader to run, unscheduling any old ones first 8402 if (mAttachInfo != null) { 8403 mAttachInfo.mHandler.removeCallbacks(scrollCache); 8404 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 8405 } 8406 8407 return true; 8408 } 8409 8410 return false; 8411 } 8412 8413 /** 8414 * Do not invalidate views which are not visible and which are not running an animation. They 8415 * will not get drawn and they should not set dirty flags as if they will be drawn 8416 */ 8417 private boolean skipInvalidate() { 8418 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null && 8419 (!(mParent instanceof ViewGroup) || 8420 !((ViewGroup) mParent).isViewTransitioning(this)); 8421 } 8422 /** 8423 * Mark the area defined by dirty as needing to be drawn. If the view is 8424 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point 8425 * in the future. This must be called from a UI thread. To call from a non-UI 8426 * thread, call {@link #postInvalidate()}. 8427 * 8428 * WARNING: This method is destructive to dirty. 8429 * @param dirty the rectangle representing the bounds of the dirty region 8430 */ 8431 public void invalidate(Rect dirty) { 8432 if (ViewDebug.TRACE_HIERARCHY) { 8433 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 8434 } 8435 8436 if (skipInvalidate()) { 8437 return; 8438 } 8439 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 8440 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID || 8441 (mPrivateFlags & INVALIDATED) != INVALIDATED) { 8442 mPrivateFlags &= ~DRAWING_CACHE_VALID; 8443 mPrivateFlags |= INVALIDATED; 8444 mPrivateFlags |= DIRTY; 8445 final ViewParent p = mParent; 8446 final AttachInfo ai = mAttachInfo; 8447 //noinspection PointlessBooleanExpression,ConstantConditions 8448 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 8449 if (p != null && ai != null && ai.mHardwareAccelerated) { 8450 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 8451 // with a null dirty rect, which tells the ViewAncestor to redraw everything 8452 p.invalidateChild(this, null); 8453 return; 8454 } 8455 } 8456 if (p != null && ai != null) { 8457 final int scrollX = mScrollX; 8458 final int scrollY = mScrollY; 8459 final Rect r = ai.mTmpInvalRect; 8460 r.set(dirty.left - scrollX, dirty.top - scrollY, 8461 dirty.right - scrollX, dirty.bottom - scrollY); 8462 mParent.invalidateChild(this, r); 8463 } 8464 } 8465 } 8466 8467 /** 8468 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. 8469 * The coordinates of the dirty rect are relative to the view. 8470 * If the view is visible, {@link #onDraw(android.graphics.Canvas)} 8471 * will be called at some point in the future. This must be called from 8472 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}. 8473 * @param l the left position of the dirty region 8474 * @param t the top position of the dirty region 8475 * @param r the right position of the dirty region 8476 * @param b the bottom position of the dirty region 8477 */ 8478 public void invalidate(int l, int t, int r, int b) { 8479 if (ViewDebug.TRACE_HIERARCHY) { 8480 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 8481 } 8482 8483 if (skipInvalidate()) { 8484 return; 8485 } 8486 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 8487 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID || 8488 (mPrivateFlags & INVALIDATED) != INVALIDATED) { 8489 mPrivateFlags &= ~DRAWING_CACHE_VALID; 8490 mPrivateFlags |= INVALIDATED; 8491 mPrivateFlags |= DIRTY; 8492 final ViewParent p = mParent; 8493 final AttachInfo ai = mAttachInfo; 8494 //noinspection PointlessBooleanExpression,ConstantConditions 8495 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 8496 if (p != null && ai != null && ai.mHardwareAccelerated) { 8497 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 8498 // with a null dirty rect, which tells the ViewAncestor to redraw everything 8499 p.invalidateChild(this, null); 8500 return; 8501 } 8502 } 8503 if (p != null && ai != null && l < r && t < b) { 8504 final int scrollX = mScrollX; 8505 final int scrollY = mScrollY; 8506 final Rect tmpr = ai.mTmpInvalRect; 8507 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY); 8508 p.invalidateChild(this, tmpr); 8509 } 8510 } 8511 } 8512 8513 /** 8514 * Invalidate the whole view. If the view is visible, 8515 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in 8516 * the future. This must be called from a UI thread. To call from a non-UI thread, 8517 * call {@link #postInvalidate()}. 8518 */ 8519 public void invalidate() { 8520 invalidate(true); 8521 } 8522 8523 /** 8524 * This is where the invalidate() work actually happens. A full invalidate() 8525 * causes the drawing cache to be invalidated, but this function can be called with 8526 * invalidateCache set to false to skip that invalidation step for cases that do not 8527 * need it (for example, a component that remains at the same dimensions with the same 8528 * content). 8529 * 8530 * @param invalidateCache Whether the drawing cache for this view should be invalidated as 8531 * well. This is usually true for a full invalidate, but may be set to false if the 8532 * View's contents or dimensions have not changed. 8533 */ 8534 void invalidate(boolean invalidateCache) { 8535 if (ViewDebug.TRACE_HIERARCHY) { 8536 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 8537 } 8538 8539 if (skipInvalidate()) { 8540 return; 8541 } 8542 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 8543 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) || 8544 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) { 8545 mLastIsOpaque = isOpaque(); 8546 mPrivateFlags &= ~DRAWN; 8547 mPrivateFlags |= DIRTY; 8548 if (invalidateCache) { 8549 mPrivateFlags |= INVALIDATED; 8550 mPrivateFlags &= ~DRAWING_CACHE_VALID; 8551 } 8552 final AttachInfo ai = mAttachInfo; 8553 final ViewParent p = mParent; 8554 //noinspection PointlessBooleanExpression,ConstantConditions 8555 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 8556 if (p != null && ai != null && ai.mHardwareAccelerated) { 8557 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 8558 // with a null dirty rect, which tells the ViewAncestor to redraw everything 8559 p.invalidateChild(this, null); 8560 return; 8561 } 8562 } 8563 8564 if (p != null && ai != null) { 8565 final Rect r = ai.mTmpInvalRect; 8566 r.set(0, 0, mRight - mLeft, mBottom - mTop); 8567 // Don't call invalidate -- we don't want to internally scroll 8568 // our own bounds 8569 p.invalidateChild(this, r); 8570 } 8571 } 8572 } 8573 8574 /** 8575 * Used to indicate that the parent of this view should clear its caches. This functionality 8576 * is used to force the parent to rebuild its display list (when hardware-accelerated), 8577 * which is necessary when various parent-managed properties of the view change, such as 8578 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 8579 * clears the parent caches and does not causes an invalidate event. 8580 * 8581 * @hide 8582 */ 8583 protected void invalidateParentCaches() { 8584 if (mParent instanceof View) { 8585 ((View) mParent).mPrivateFlags |= INVALIDATED; 8586 } 8587 } 8588 8589 /** 8590 * Used to indicate that the parent of this view should be invalidated. This functionality 8591 * is used to force the parent to rebuild its display list (when hardware-accelerated), 8592 * which is necessary when various parent-managed properties of the view change, such as 8593 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 8594 * an invalidation event to the parent. 8595 * 8596 * @hide 8597 */ 8598 protected void invalidateParentIfNeeded() { 8599 if (isHardwareAccelerated() && mParent instanceof View) { 8600 ((View) mParent).invalidate(true); 8601 } 8602 } 8603 8604 /** 8605 * Indicates whether this View is opaque. An opaque View guarantees that it will 8606 * draw all the pixels overlapping its bounds using a fully opaque color. 8607 * 8608 * Subclasses of View should override this method whenever possible to indicate 8609 * whether an instance is opaque. Opaque Views are treated in a special way by 8610 * the View hierarchy, possibly allowing it to perform optimizations during 8611 * invalidate/draw passes. 8612 * 8613 * @return True if this View is guaranteed to be fully opaque, false otherwise. 8614 */ 8615 @ViewDebug.ExportedProperty(category = "drawing") 8616 public boolean isOpaque() { 8617 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK && 8618 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1) 8619 >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD); 8620 } 8621 8622 /** 8623 * @hide 8624 */ 8625 protected void computeOpaqueFlags() { 8626 // Opaque if: 8627 // - Has a background 8628 // - Background is opaque 8629 // - Doesn't have scrollbars or scrollbars are inside overlay 8630 8631 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) { 8632 mPrivateFlags |= OPAQUE_BACKGROUND; 8633 } else { 8634 mPrivateFlags &= ~OPAQUE_BACKGROUND; 8635 } 8636 8637 final int flags = mViewFlags; 8638 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 8639 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) { 8640 mPrivateFlags |= OPAQUE_SCROLLBARS; 8641 } else { 8642 mPrivateFlags &= ~OPAQUE_SCROLLBARS; 8643 } 8644 } 8645 8646 /** 8647 * @hide 8648 */ 8649 protected boolean hasOpaqueScrollbars() { 8650 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS; 8651 } 8652 8653 /** 8654 * @return A handler associated with the thread running the View. This 8655 * handler can be used to pump events in the UI events queue. 8656 */ 8657 public Handler getHandler() { 8658 if (mAttachInfo != null) { 8659 return mAttachInfo.mHandler; 8660 } 8661 return null; 8662 } 8663 8664 /** 8665 * <p>Causes the Runnable to be added to the message queue. 8666 * The runnable will be run on the user interface thread.</p> 8667 * 8668 * <p>This method can be invoked from outside of the UI thread 8669 * only when this View is attached to a window.</p> 8670 * 8671 * @param action The Runnable that will be executed. 8672 * 8673 * @return Returns true if the Runnable was successfully placed in to the 8674 * message queue. Returns false on failure, usually because the 8675 * looper processing the message queue is exiting. 8676 */ 8677 public boolean post(Runnable action) { 8678 Handler handler; 8679 AttachInfo attachInfo = mAttachInfo; 8680 if (attachInfo != null) { 8681 handler = attachInfo.mHandler; 8682 } else { 8683 // Assume that post will succeed later 8684 ViewRootImpl.getRunQueue().post(action); 8685 return true; 8686 } 8687 8688 return handler.post(action); 8689 } 8690 8691 /** 8692 * <p>Causes the Runnable to be added to the message queue, to be run 8693 * after the specified amount of time elapses. 8694 * The runnable will be run on the user interface thread.</p> 8695 * 8696 * <p>This method can be invoked from outside of the UI thread 8697 * only when this View is attached to a window.</p> 8698 * 8699 * @param action The Runnable that will be executed. 8700 * @param delayMillis The delay (in milliseconds) until the Runnable 8701 * will be executed. 8702 * 8703 * @return true if the Runnable was successfully placed in to the 8704 * message queue. Returns false on failure, usually because the 8705 * looper processing the message queue is exiting. Note that a 8706 * result of true does not mean the Runnable will be processed -- 8707 * if the looper is quit before the delivery time of the message 8708 * occurs then the message will be dropped. 8709 */ 8710 public boolean postDelayed(Runnable action, long delayMillis) { 8711 Handler handler; 8712 AttachInfo attachInfo = mAttachInfo; 8713 if (attachInfo != null) { 8714 handler = attachInfo.mHandler; 8715 } else { 8716 // Assume that post will succeed later 8717 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis); 8718 return true; 8719 } 8720 8721 return handler.postDelayed(action, delayMillis); 8722 } 8723 8724 /** 8725 * <p>Removes the specified Runnable from the message queue.</p> 8726 * 8727 * <p>This method can be invoked from outside of the UI thread 8728 * only when this View is attached to a window.</p> 8729 * 8730 * @param action The Runnable to remove from the message handling queue 8731 * 8732 * @return true if this view could ask the Handler to remove the Runnable, 8733 * false otherwise. When the returned value is true, the Runnable 8734 * may or may not have been actually removed from the message queue 8735 * (for instance, if the Runnable was not in the queue already.) 8736 */ 8737 public boolean removeCallbacks(Runnable action) { 8738 Handler handler; 8739 AttachInfo attachInfo = mAttachInfo; 8740 if (attachInfo != null) { 8741 handler = attachInfo.mHandler; 8742 } else { 8743 // Assume that post will succeed later 8744 ViewRootImpl.getRunQueue().removeCallbacks(action); 8745 return true; 8746 } 8747 8748 handler.removeCallbacks(action); 8749 return true; 8750 } 8751 8752 /** 8753 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop. 8754 * Use this to invalidate the View from a non-UI thread.</p> 8755 * 8756 * <p>This method can be invoked from outside of the UI thread 8757 * only when this View is attached to a window.</p> 8758 * 8759 * @see #invalidate() 8760 */ 8761 public void postInvalidate() { 8762 postInvalidateDelayed(0); 8763 } 8764 8765 /** 8766 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 8767 * through the event loop. Use this to invalidate the View from a non-UI thread.</p> 8768 * 8769 * <p>This method can be invoked from outside of the UI thread 8770 * only when this View is attached to a window.</p> 8771 * 8772 * @param left The left coordinate of the rectangle to invalidate. 8773 * @param top The top coordinate of the rectangle to invalidate. 8774 * @param right The right coordinate of the rectangle to invalidate. 8775 * @param bottom The bottom coordinate of the rectangle to invalidate. 8776 * 8777 * @see #invalidate(int, int, int, int) 8778 * @see #invalidate(Rect) 8779 */ 8780 public void postInvalidate(int left, int top, int right, int bottom) { 8781 postInvalidateDelayed(0, left, top, right, bottom); 8782 } 8783 8784 /** 8785 * <p>Cause an invalidate to happen on a subsequent cycle through the event 8786 * loop. Waits for the specified amount of time.</p> 8787 * 8788 * <p>This method can be invoked from outside of the UI thread 8789 * only when this View is attached to a window.</p> 8790 * 8791 * @param delayMilliseconds the duration in milliseconds to delay the 8792 * invalidation by 8793 */ 8794 public void postInvalidateDelayed(long delayMilliseconds) { 8795 // We try only with the AttachInfo because there's no point in invalidating 8796 // if we are not attached to our window 8797 AttachInfo attachInfo = mAttachInfo; 8798 if (attachInfo != null) { 8799 Message msg = Message.obtain(); 8800 msg.what = AttachInfo.INVALIDATE_MSG; 8801 msg.obj = this; 8802 attachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds); 8803 } 8804 } 8805 8806 /** 8807 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle 8808 * through the event loop. Waits for the specified amount of time.</p> 8809 * 8810 * <p>This method can be invoked from outside of the UI thread 8811 * only when this View is attached to a window.</p> 8812 * 8813 * @param delayMilliseconds the duration in milliseconds to delay the 8814 * invalidation by 8815 * @param left The left coordinate of the rectangle to invalidate. 8816 * @param top The top coordinate of the rectangle to invalidate. 8817 * @param right The right coordinate of the rectangle to invalidate. 8818 * @param bottom The bottom coordinate of the rectangle to invalidate. 8819 */ 8820 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 8821 int right, int bottom) { 8822 8823 // We try only with the AttachInfo because there's no point in invalidating 8824 // if we are not attached to our window 8825 AttachInfo attachInfo = mAttachInfo; 8826 if (attachInfo != null) { 8827 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 8828 info.target = this; 8829 info.left = left; 8830 info.top = top; 8831 info.right = right; 8832 info.bottom = bottom; 8833 8834 final Message msg = Message.obtain(); 8835 msg.what = AttachInfo.INVALIDATE_RECT_MSG; 8836 msg.obj = info; 8837 attachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds); 8838 } 8839 } 8840 8841 /** 8842 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event. 8843 * This event is sent at most once every 8844 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}. 8845 */ 8846 private void postSendViewScrolledAccessibilityEventCallback() { 8847 if (mSendViewScrolledAccessibilityEvent == null) { 8848 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent(); 8849 } 8850 if (!mSendViewScrolledAccessibilityEvent.mIsPending) { 8851 mSendViewScrolledAccessibilityEvent.mIsPending = true; 8852 postDelayed(mSendViewScrolledAccessibilityEvent, 8853 ViewConfiguration.getSendRecurringAccessibilityEventsInterval()); 8854 } 8855 } 8856 8857 /** 8858 * Called by a parent to request that a child update its values for mScrollX 8859 * and mScrollY if necessary. This will typically be done if the child is 8860 * animating a scroll using a {@link android.widget.Scroller Scroller} 8861 * object. 8862 */ 8863 public void computeScroll() { 8864 } 8865 8866 /** 8867 * <p>Indicate whether the horizontal edges are faded when the view is 8868 * scrolled horizontally.</p> 8869 * 8870 * @return true if the horizontal edges should are faded on scroll, false 8871 * otherwise 8872 * 8873 * @see #setHorizontalFadingEdgeEnabled(boolean) 8874 * @attr ref android.R.styleable#View_requiresFadingEdge 8875 */ 8876 public boolean isHorizontalFadingEdgeEnabled() { 8877 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 8878 } 8879 8880 /** 8881 * <p>Define whether the horizontal edges should be faded when this view 8882 * is scrolled horizontally.</p> 8883 * 8884 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 8885 * be faded when the view is scrolled 8886 * horizontally 8887 * 8888 * @see #isHorizontalFadingEdgeEnabled() 8889 * @attr ref android.R.styleable#View_requiresFadingEdge 8890 */ 8891 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 8892 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 8893 if (horizontalFadingEdgeEnabled) { 8894 initScrollCache(); 8895 } 8896 8897 mViewFlags ^= FADING_EDGE_HORIZONTAL; 8898 } 8899 } 8900 8901 /** 8902 * <p>Indicate whether the vertical edges are faded when the view is 8903 * scrolled horizontally.</p> 8904 * 8905 * @return true if the vertical edges should are faded on scroll, false 8906 * otherwise 8907 * 8908 * @see #setVerticalFadingEdgeEnabled(boolean) 8909 * @attr ref android.R.styleable#View_requiresFadingEdge 8910 */ 8911 public boolean isVerticalFadingEdgeEnabled() { 8912 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 8913 } 8914 8915 /** 8916 * <p>Define whether the vertical edges should be faded when this view 8917 * is scrolled vertically.</p> 8918 * 8919 * @param verticalFadingEdgeEnabled true if the vertical edges should 8920 * be faded when the view is scrolled 8921 * vertically 8922 * 8923 * @see #isVerticalFadingEdgeEnabled() 8924 * @attr ref android.R.styleable#View_requiresFadingEdge 8925 */ 8926 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 8927 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 8928 if (verticalFadingEdgeEnabled) { 8929 initScrollCache(); 8930 } 8931 8932 mViewFlags ^= FADING_EDGE_VERTICAL; 8933 } 8934 } 8935 8936 /** 8937 * Returns the strength, or intensity, of the top faded edge. The strength is 8938 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 8939 * returns 0.0 or 1.0 but no value in between. 8940 * 8941 * Subclasses should override this method to provide a smoother fade transition 8942 * when scrolling occurs. 8943 * 8944 * @return the intensity of the top fade as a float between 0.0f and 1.0f 8945 */ 8946 protected float getTopFadingEdgeStrength() { 8947 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 8948 } 8949 8950 /** 8951 * Returns the strength, or intensity, of the bottom faded edge. The strength is 8952 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 8953 * returns 0.0 or 1.0 but no value in between. 8954 * 8955 * Subclasses should override this method to provide a smoother fade transition 8956 * when scrolling occurs. 8957 * 8958 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 8959 */ 8960 protected float getBottomFadingEdgeStrength() { 8961 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 8962 computeVerticalScrollRange() ? 1.0f : 0.0f; 8963 } 8964 8965 /** 8966 * Returns the strength, or intensity, of the left faded edge. The strength is 8967 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 8968 * returns 0.0 or 1.0 but no value in between. 8969 * 8970 * Subclasses should override this method to provide a smoother fade transition 8971 * when scrolling occurs. 8972 * 8973 * @return the intensity of the left fade as a float between 0.0f and 1.0f 8974 */ 8975 protected float getLeftFadingEdgeStrength() { 8976 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 8977 } 8978 8979 /** 8980 * Returns the strength, or intensity, of the right faded edge. The strength is 8981 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 8982 * returns 0.0 or 1.0 but no value in between. 8983 * 8984 * Subclasses should override this method to provide a smoother fade transition 8985 * when scrolling occurs. 8986 * 8987 * @return the intensity of the right fade as a float between 0.0f and 1.0f 8988 */ 8989 protected float getRightFadingEdgeStrength() { 8990 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 8991 computeHorizontalScrollRange() ? 1.0f : 0.0f; 8992 } 8993 8994 /** 8995 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 8996 * scrollbar is not drawn by default.</p> 8997 * 8998 * @return true if the horizontal scrollbar should be painted, false 8999 * otherwise 9000 * 9001 * @see #setHorizontalScrollBarEnabled(boolean) 9002 */ 9003 public boolean isHorizontalScrollBarEnabled() { 9004 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 9005 } 9006 9007 /** 9008 * <p>Define whether the horizontal scrollbar should be drawn or not. The 9009 * scrollbar is not drawn by default.</p> 9010 * 9011 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 9012 * be painted 9013 * 9014 * @see #isHorizontalScrollBarEnabled() 9015 */ 9016 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 9017 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 9018 mViewFlags ^= SCROLLBARS_HORIZONTAL; 9019 computeOpaqueFlags(); 9020 resolvePadding(); 9021 } 9022 } 9023 9024 /** 9025 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 9026 * scrollbar is not drawn by default.</p> 9027 * 9028 * @return true if the vertical scrollbar should be painted, false 9029 * otherwise 9030 * 9031 * @see #setVerticalScrollBarEnabled(boolean) 9032 */ 9033 public boolean isVerticalScrollBarEnabled() { 9034 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 9035 } 9036 9037 /** 9038 * <p>Define whether the vertical scrollbar should be drawn or not. The 9039 * scrollbar is not drawn by default.</p> 9040 * 9041 * @param verticalScrollBarEnabled true if the vertical scrollbar should 9042 * be painted 9043 * 9044 * @see #isVerticalScrollBarEnabled() 9045 */ 9046 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 9047 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 9048 mViewFlags ^= SCROLLBARS_VERTICAL; 9049 computeOpaqueFlags(); 9050 resolvePadding(); 9051 } 9052 } 9053 9054 /** 9055 * @hide 9056 */ 9057 protected void recomputePadding() { 9058 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 9059 } 9060 9061 /** 9062 * Define whether scrollbars will fade when the view is not scrolling. 9063 * 9064 * @param fadeScrollbars wheter to enable fading 9065 * 9066 */ 9067 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 9068 initScrollCache(); 9069 final ScrollabilityCache scrollabilityCache = mScrollCache; 9070 scrollabilityCache.fadeScrollBars = fadeScrollbars; 9071 if (fadeScrollbars) { 9072 scrollabilityCache.state = ScrollabilityCache.OFF; 9073 } else { 9074 scrollabilityCache.state = ScrollabilityCache.ON; 9075 } 9076 } 9077 9078 /** 9079 * 9080 * Returns true if scrollbars will fade when this view is not scrolling 9081 * 9082 * @return true if scrollbar fading is enabled 9083 */ 9084 public boolean isScrollbarFadingEnabled() { 9085 return mScrollCache != null && mScrollCache.fadeScrollBars; 9086 } 9087 9088 /** 9089 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 9090 * inset. When inset, they add to the padding of the view. And the scrollbars 9091 * can be drawn inside the padding area or on the edge of the view. For example, 9092 * if a view has a background drawable and you want to draw the scrollbars 9093 * inside the padding specified by the drawable, you can use 9094 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 9095 * appear at the edge of the view, ignoring the padding, then you can use 9096 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 9097 * @param style the style of the scrollbars. Should be one of 9098 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 9099 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 9100 * @see #SCROLLBARS_INSIDE_OVERLAY 9101 * @see #SCROLLBARS_INSIDE_INSET 9102 * @see #SCROLLBARS_OUTSIDE_OVERLAY 9103 * @see #SCROLLBARS_OUTSIDE_INSET 9104 */ 9105 public void setScrollBarStyle(int style) { 9106 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 9107 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 9108 computeOpaqueFlags(); 9109 resolvePadding(); 9110 } 9111 } 9112 9113 /** 9114 * <p>Returns the current scrollbar style.</p> 9115 * @return the current scrollbar style 9116 * @see #SCROLLBARS_INSIDE_OVERLAY 9117 * @see #SCROLLBARS_INSIDE_INSET 9118 * @see #SCROLLBARS_OUTSIDE_OVERLAY 9119 * @see #SCROLLBARS_OUTSIDE_INSET 9120 */ 9121 @ViewDebug.ExportedProperty(mapping = { 9122 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"), 9123 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"), 9124 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"), 9125 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET") 9126 }) 9127 public int getScrollBarStyle() { 9128 return mViewFlags & SCROLLBARS_STYLE_MASK; 9129 } 9130 9131 /** 9132 * <p>Compute the horizontal range that the horizontal scrollbar 9133 * represents.</p> 9134 * 9135 * <p>The range is expressed in arbitrary units that must be the same as the 9136 * units used by {@link #computeHorizontalScrollExtent()} and 9137 * {@link #computeHorizontalScrollOffset()}.</p> 9138 * 9139 * <p>The default range is the drawing width of this view.</p> 9140 * 9141 * @return the total horizontal range represented by the horizontal 9142 * scrollbar 9143 * 9144 * @see #computeHorizontalScrollExtent() 9145 * @see #computeHorizontalScrollOffset() 9146 * @see android.widget.ScrollBarDrawable 9147 */ 9148 protected int computeHorizontalScrollRange() { 9149 return getWidth(); 9150 } 9151 9152 /** 9153 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 9154 * within the horizontal range. This value is used to compute the position 9155 * of the thumb within the scrollbar's track.</p> 9156 * 9157 * <p>The range is expressed in arbitrary units that must be the same as the 9158 * units used by {@link #computeHorizontalScrollRange()} and 9159 * {@link #computeHorizontalScrollExtent()}.</p> 9160 * 9161 * <p>The default offset is the scroll offset of this view.</p> 9162 * 9163 * @return the horizontal offset of the scrollbar's thumb 9164 * 9165 * @see #computeHorizontalScrollRange() 9166 * @see #computeHorizontalScrollExtent() 9167 * @see android.widget.ScrollBarDrawable 9168 */ 9169 protected int computeHorizontalScrollOffset() { 9170 return mScrollX; 9171 } 9172 9173 /** 9174 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 9175 * within the horizontal range. This value is used to compute the length 9176 * of the thumb within the scrollbar's track.</p> 9177 * 9178 * <p>The range is expressed in arbitrary units that must be the same as the 9179 * units used by {@link #computeHorizontalScrollRange()} and 9180 * {@link #computeHorizontalScrollOffset()}.</p> 9181 * 9182 * <p>The default extent is the drawing width of this view.</p> 9183 * 9184 * @return the horizontal extent of the scrollbar's thumb 9185 * 9186 * @see #computeHorizontalScrollRange() 9187 * @see #computeHorizontalScrollOffset() 9188 * @see android.widget.ScrollBarDrawable 9189 */ 9190 protected int computeHorizontalScrollExtent() { 9191 return getWidth(); 9192 } 9193 9194 /** 9195 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 9196 * 9197 * <p>The range is expressed in arbitrary units that must be the same as the 9198 * units used by {@link #computeVerticalScrollExtent()} and 9199 * {@link #computeVerticalScrollOffset()}.</p> 9200 * 9201 * @return the total vertical range represented by the vertical scrollbar 9202 * 9203 * <p>The default range is the drawing height of this view.</p> 9204 * 9205 * @see #computeVerticalScrollExtent() 9206 * @see #computeVerticalScrollOffset() 9207 * @see android.widget.ScrollBarDrawable 9208 */ 9209 protected int computeVerticalScrollRange() { 9210 return getHeight(); 9211 } 9212 9213 /** 9214 * <p>Compute the vertical offset of the vertical scrollbar's thumb 9215 * within the horizontal range. This value is used to compute the position 9216 * of the thumb within the scrollbar's track.</p> 9217 * 9218 * <p>The range is expressed in arbitrary units that must be the same as the 9219 * units used by {@link #computeVerticalScrollRange()} and 9220 * {@link #computeVerticalScrollExtent()}.</p> 9221 * 9222 * <p>The default offset is the scroll offset of this view.</p> 9223 * 9224 * @return the vertical offset of the scrollbar's thumb 9225 * 9226 * @see #computeVerticalScrollRange() 9227 * @see #computeVerticalScrollExtent() 9228 * @see android.widget.ScrollBarDrawable 9229 */ 9230 protected int computeVerticalScrollOffset() { 9231 return mScrollY; 9232 } 9233 9234 /** 9235 * <p>Compute the vertical extent of the horizontal scrollbar's thumb 9236 * within the vertical range. This value is used to compute the length 9237 * of the thumb within the scrollbar's track.</p> 9238 * 9239 * <p>The range is expressed in arbitrary units that must be the same as the 9240 * units used by {@link #computeVerticalScrollRange()} and 9241 * {@link #computeVerticalScrollOffset()}.</p> 9242 * 9243 * <p>The default extent is the drawing height of this view.</p> 9244 * 9245 * @return the vertical extent of the scrollbar's thumb 9246 * 9247 * @see #computeVerticalScrollRange() 9248 * @see #computeVerticalScrollOffset() 9249 * @see android.widget.ScrollBarDrawable 9250 */ 9251 protected int computeVerticalScrollExtent() { 9252 return getHeight(); 9253 } 9254 9255 /** 9256 * Check if this view can be scrolled horizontally in a certain direction. 9257 * 9258 * @param direction Negative to check scrolling left, positive to check scrolling right. 9259 * @return true if this view can be scrolled in the specified direction, false otherwise. 9260 */ 9261 public boolean canScrollHorizontally(int direction) { 9262 final int offset = computeHorizontalScrollOffset(); 9263 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); 9264 if (range == 0) return false; 9265 if (direction < 0) { 9266 return offset > 0; 9267 } else { 9268 return offset < range - 1; 9269 } 9270 } 9271 9272 /** 9273 * Check if this view can be scrolled vertically in a certain direction. 9274 * 9275 * @param direction Negative to check scrolling up, positive to check scrolling down. 9276 * @return true if this view can be scrolled in the specified direction, false otherwise. 9277 */ 9278 public boolean canScrollVertically(int direction) { 9279 final int offset = computeVerticalScrollOffset(); 9280 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent(); 9281 if (range == 0) return false; 9282 if (direction < 0) { 9283 return offset > 0; 9284 } else { 9285 return offset < range - 1; 9286 } 9287 } 9288 9289 /** 9290 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 9291 * scrollbars are painted only if they have been awakened first.</p> 9292 * 9293 * @param canvas the canvas on which to draw the scrollbars 9294 * 9295 * @see #awakenScrollBars(int) 9296 */ 9297 protected final void onDrawScrollBars(Canvas canvas) { 9298 // scrollbars are drawn only when the animation is running 9299 final ScrollabilityCache cache = mScrollCache; 9300 if (cache != null) { 9301 9302 int state = cache.state; 9303 9304 if (state == ScrollabilityCache.OFF) { 9305 return; 9306 } 9307 9308 boolean invalidate = false; 9309 9310 if (state == ScrollabilityCache.FADING) { 9311 // We're fading -- get our fade interpolation 9312 if (cache.interpolatorValues == null) { 9313 cache.interpolatorValues = new float[1]; 9314 } 9315 9316 float[] values = cache.interpolatorValues; 9317 9318 // Stops the animation if we're done 9319 if (cache.scrollBarInterpolator.timeToValues(values) == 9320 Interpolator.Result.FREEZE_END) { 9321 cache.state = ScrollabilityCache.OFF; 9322 } else { 9323 cache.scrollBar.setAlpha(Math.round(values[0])); 9324 } 9325 9326 // This will make the scroll bars inval themselves after 9327 // drawing. We only want this when we're fading so that 9328 // we prevent excessive redraws 9329 invalidate = true; 9330 } else { 9331 // We're just on -- but we may have been fading before so 9332 // reset alpha 9333 cache.scrollBar.setAlpha(255); 9334 } 9335 9336 9337 final int viewFlags = mViewFlags; 9338 9339 final boolean drawHorizontalScrollBar = 9340 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 9341 final boolean drawVerticalScrollBar = 9342 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 9343 && !isVerticalScrollBarHidden(); 9344 9345 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 9346 final int width = mRight - mLeft; 9347 final int height = mBottom - mTop; 9348 9349 final ScrollBarDrawable scrollBar = cache.scrollBar; 9350 9351 final int scrollX = mScrollX; 9352 final int scrollY = mScrollY; 9353 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 9354 9355 int left, top, right, bottom; 9356 9357 if (drawHorizontalScrollBar) { 9358 int size = scrollBar.getSize(false); 9359 if (size <= 0) { 9360 size = cache.scrollBarSize; 9361 } 9362 9363 scrollBar.setParameters(computeHorizontalScrollRange(), 9364 computeHorizontalScrollOffset(), 9365 computeHorizontalScrollExtent(), false); 9366 final int verticalScrollBarGap = drawVerticalScrollBar ? 9367 getVerticalScrollbarWidth() : 0; 9368 top = scrollY + height - size - (mUserPaddingBottom & inside); 9369 left = scrollX + (mPaddingLeft & inside); 9370 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 9371 bottom = top + size; 9372 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 9373 if (invalidate) { 9374 invalidate(left, top, right, bottom); 9375 } 9376 } 9377 9378 if (drawVerticalScrollBar) { 9379 int size = scrollBar.getSize(true); 9380 if (size <= 0) { 9381 size = cache.scrollBarSize; 9382 } 9383 9384 scrollBar.setParameters(computeVerticalScrollRange(), 9385 computeVerticalScrollOffset(), 9386 computeVerticalScrollExtent(), true); 9387 switch (mVerticalScrollbarPosition) { 9388 default: 9389 case SCROLLBAR_POSITION_DEFAULT: 9390 case SCROLLBAR_POSITION_RIGHT: 9391 left = scrollX + width - size - (mUserPaddingRight & inside); 9392 break; 9393 case SCROLLBAR_POSITION_LEFT: 9394 left = scrollX + (mUserPaddingLeft & inside); 9395 break; 9396 } 9397 top = scrollY + (mPaddingTop & inside); 9398 right = left + size; 9399 bottom = scrollY + height - (mUserPaddingBottom & inside); 9400 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 9401 if (invalidate) { 9402 invalidate(left, top, right, bottom); 9403 } 9404 } 9405 } 9406 } 9407 } 9408 9409 /** 9410 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 9411 * FastScroller is visible. 9412 * @return whether to temporarily hide the vertical scrollbar 9413 * @hide 9414 */ 9415 protected boolean isVerticalScrollBarHidden() { 9416 return false; 9417 } 9418 9419 /** 9420 * <p>Draw the horizontal scrollbar if 9421 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 9422 * 9423 * @param canvas the canvas on which to draw the scrollbar 9424 * @param scrollBar the scrollbar's drawable 9425 * 9426 * @see #isHorizontalScrollBarEnabled() 9427 * @see #computeHorizontalScrollRange() 9428 * @see #computeHorizontalScrollExtent() 9429 * @see #computeHorizontalScrollOffset() 9430 * @see android.widget.ScrollBarDrawable 9431 * @hide 9432 */ 9433 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 9434 int l, int t, int r, int b) { 9435 scrollBar.setBounds(l, t, r, b); 9436 scrollBar.draw(canvas); 9437 } 9438 9439 /** 9440 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 9441 * returns true.</p> 9442 * 9443 * @param canvas the canvas on which to draw the scrollbar 9444 * @param scrollBar the scrollbar's drawable 9445 * 9446 * @see #isVerticalScrollBarEnabled() 9447 * @see #computeVerticalScrollRange() 9448 * @see #computeVerticalScrollExtent() 9449 * @see #computeVerticalScrollOffset() 9450 * @see android.widget.ScrollBarDrawable 9451 * @hide 9452 */ 9453 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 9454 int l, int t, int r, int b) { 9455 scrollBar.setBounds(l, t, r, b); 9456 scrollBar.draw(canvas); 9457 } 9458 9459 /** 9460 * Implement this to do your drawing. 9461 * 9462 * @param canvas the canvas on which the background will be drawn 9463 */ 9464 protected void onDraw(Canvas canvas) { 9465 } 9466 9467 /* 9468 * Caller is responsible for calling requestLayout if necessary. 9469 * (This allows addViewInLayout to not request a new layout.) 9470 */ 9471 void assignParent(ViewParent parent) { 9472 if (mParent == null) { 9473 mParent = parent; 9474 } else if (parent == null) { 9475 mParent = null; 9476 } else { 9477 throw new RuntimeException("view " + this + " being added, but" 9478 + " it already has a parent"); 9479 } 9480 } 9481 9482 /** 9483 * This is called when the view is attached to a window. At this point it 9484 * has a Surface and will start drawing. Note that this function is 9485 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)}, 9486 * however it may be called any time before the first onDraw -- including 9487 * before or after {@link #onMeasure(int, int)}. 9488 * 9489 * @see #onDetachedFromWindow() 9490 */ 9491 protected void onAttachedToWindow() { 9492 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) { 9493 mParent.requestTransparentRegion(this); 9494 } 9495 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 9496 initialAwakenScrollBars(); 9497 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH; 9498 } 9499 jumpDrawablesToCurrentState(); 9500 // Order is important here: LayoutDirection MUST be resolved before Padding 9501 // and TextDirection 9502 resolveLayoutDirectionIfNeeded(); 9503 resolvePadding(); 9504 resolveTextDirection(); 9505 if (isFocused()) { 9506 InputMethodManager imm = InputMethodManager.peekInstance(); 9507 imm.focusIn(this); 9508 } 9509 } 9510 9511 /** 9512 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing 9513 * that the parent directionality can and will be resolved before its children. 9514 */ 9515 private void resolveLayoutDirectionIfNeeded() { 9516 // Do not resolve if it is not needed 9517 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) == LAYOUT_DIRECTION_RESOLVED) return; 9518 9519 // Clear any previous layout direction resolution 9520 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_RTL; 9521 9522 // Reset also TextDirection as a change into LayoutDirection may impact the selected 9523 // TextDirectionHeuristic 9524 resetResolvedTextDirection(); 9525 9526 // Set resolved depending on layout direction 9527 switch (getLayoutDirection()) { 9528 case LAYOUT_DIRECTION_INHERIT: 9529 // We cannot do the resolution if there is no parent 9530 if (mParent == null) return; 9531 9532 // If this is root view, no need to look at parent's layout dir. 9533 if (mParent instanceof ViewGroup) { 9534 ViewGroup viewGroup = ((ViewGroup) mParent); 9535 9536 // Check if the parent view group can resolve 9537 if (! viewGroup.canResolveLayoutDirection()) { 9538 return; 9539 } 9540 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) { 9541 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL; 9542 } 9543 } 9544 break; 9545 case LAYOUT_DIRECTION_RTL: 9546 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL; 9547 break; 9548 case LAYOUT_DIRECTION_LOCALE: 9549 if(isLayoutDirectionRtl(Locale.getDefault())) { 9550 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL; 9551 } 9552 break; 9553 default: 9554 // Nothing to do, LTR by default 9555 } 9556 9557 // Set to resolved 9558 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED; 9559 } 9560 9561 /** 9562 * @hide 9563 */ 9564 protected void resolvePadding() { 9565 // If the user specified the absolute padding (either with android:padding or 9566 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise 9567 // use the default padding or the padding from the background drawable 9568 // (stored at this point in mPadding*) 9569 switch (getResolvedLayoutDirection()) { 9570 case LAYOUT_DIRECTION_RTL: 9571 // Start user padding override Right user padding. Otherwise, if Right user 9572 // padding is not defined, use the default Right padding. If Right user padding 9573 // is defined, just use it. 9574 if (mUserPaddingStart >= 0) { 9575 mUserPaddingRight = mUserPaddingStart; 9576 } else if (mUserPaddingRight < 0) { 9577 mUserPaddingRight = mPaddingRight; 9578 } 9579 if (mUserPaddingEnd >= 0) { 9580 mUserPaddingLeft = mUserPaddingEnd; 9581 } else if (mUserPaddingLeft < 0) { 9582 mUserPaddingLeft = mPaddingLeft; 9583 } 9584 break; 9585 case LAYOUT_DIRECTION_LTR: 9586 default: 9587 // Start user padding override Left user padding. Otherwise, if Left user 9588 // padding is not defined, use the default left padding. If Left user padding 9589 // is defined, just use it. 9590 if (mUserPaddingStart >= 0) { 9591 mUserPaddingLeft = mUserPaddingStart; 9592 } else if (mUserPaddingLeft < 0) { 9593 mUserPaddingLeft = mPaddingLeft; 9594 } 9595 if (mUserPaddingEnd >= 0) { 9596 mUserPaddingRight = mUserPaddingEnd; 9597 } else if (mUserPaddingRight < 0) { 9598 mUserPaddingRight = mPaddingRight; 9599 } 9600 } 9601 9602 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom; 9603 9604 recomputePadding(); 9605 } 9606 9607 /** 9608 * Return true if layout direction resolution can be done 9609 * 9610 * @hide 9611 */ 9612 protected boolean canResolveLayoutDirection() { 9613 switch (getLayoutDirection()) { 9614 case LAYOUT_DIRECTION_INHERIT: 9615 return (mParent != null); 9616 default: 9617 return true; 9618 } 9619 } 9620 9621 /** 9622 * Reset the resolved layout direction. 9623 * 9624 * Subclasses need to override this method to clear cached information that depends on the 9625 * resolved layout direction, or to inform child views that inherit their layout direction. 9626 * Overrides must also call the superclass implementation at the start of their implementation. 9627 * 9628 * @hide 9629 */ 9630 protected void resetResolvedLayoutDirection() { 9631 // Reset the current View resolution 9632 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED; 9633 } 9634 9635 /** 9636 * Check if a Locale is corresponding to a RTL script. 9637 * 9638 * @param locale Locale to check 9639 * @return true if a Locale is corresponding to a RTL script. 9640 * 9641 * @hide 9642 */ 9643 protected static boolean isLayoutDirectionRtl(Locale locale) { 9644 return (LocaleUtil.TEXT_LAYOUT_DIRECTION_RTL_DO_NOT_USE == 9645 LocaleUtil.getLayoutDirectionFromLocale(locale)); 9646 } 9647 9648 /** 9649 * This is called when the view is detached from a window. At this point it 9650 * no longer has a surface for drawing. 9651 * 9652 * @see #onAttachedToWindow() 9653 */ 9654 protected void onDetachedFromWindow() { 9655 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT; 9656 9657 removeUnsetPressCallback(); 9658 removeLongPressCallback(); 9659 removePerformClickCallback(); 9660 removeSendViewScrolledAccessibilityEventCallback(); 9661 9662 destroyDrawingCache(); 9663 9664 destroyLayer(); 9665 9666 if (mDisplayList != null) { 9667 mDisplayList.invalidate(); 9668 } 9669 9670 if (mAttachInfo != null) { 9671 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this); 9672 } 9673 9674 mCurrentAnimation = null; 9675 9676 resetResolvedLayoutDirection(); 9677 resetResolvedTextDirection(); 9678 } 9679 9680 /** 9681 * @return The number of times this view has been attached to a window 9682 */ 9683 protected int getWindowAttachCount() { 9684 return mWindowAttachCount; 9685 } 9686 9687 /** 9688 * Retrieve a unique token identifying the window this view is attached to. 9689 * @return Return the window's token for use in 9690 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 9691 */ 9692 public IBinder getWindowToken() { 9693 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 9694 } 9695 9696 /** 9697 * Retrieve a unique token identifying the top-level "real" window of 9698 * the window that this view is attached to. That is, this is like 9699 * {@link #getWindowToken}, except if the window this view in is a panel 9700 * window (attached to another containing window), then the token of 9701 * the containing window is returned instead. 9702 * 9703 * @return Returns the associated window token, either 9704 * {@link #getWindowToken()} or the containing window's token. 9705 */ 9706 public IBinder getApplicationWindowToken() { 9707 AttachInfo ai = mAttachInfo; 9708 if (ai != null) { 9709 IBinder appWindowToken = ai.mPanelParentWindowToken; 9710 if (appWindowToken == null) { 9711 appWindowToken = ai.mWindowToken; 9712 } 9713 return appWindowToken; 9714 } 9715 return null; 9716 } 9717 9718 /** 9719 * Retrieve private session object this view hierarchy is using to 9720 * communicate with the window manager. 9721 * @return the session object to communicate with the window manager 9722 */ 9723 /*package*/ IWindowSession getWindowSession() { 9724 return mAttachInfo != null ? mAttachInfo.mSession : null; 9725 } 9726 9727 /** 9728 * @param info the {@link android.view.View.AttachInfo} to associated with 9729 * this view 9730 */ 9731 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 9732 //System.out.println("Attached! " + this); 9733 mAttachInfo = info; 9734 mWindowAttachCount++; 9735 // We will need to evaluate the drawable state at least once. 9736 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 9737 if (mFloatingTreeObserver != null) { 9738 info.mTreeObserver.merge(mFloatingTreeObserver); 9739 mFloatingTreeObserver = null; 9740 } 9741 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) { 9742 mAttachInfo.mScrollContainers.add(this); 9743 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 9744 } 9745 performCollectViewAttributes(visibility); 9746 onAttachedToWindow(); 9747 9748 ListenerInfo li = mListenerInfo; 9749 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 9750 li != null ? li.mOnAttachStateChangeListeners : null; 9751 if (listeners != null && listeners.size() > 0) { 9752 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 9753 // perform the dispatching. The iterator is a safe guard against listeners that 9754 // could mutate the list by calling the various add/remove methods. This prevents 9755 // the array from being modified while we iterate it. 9756 for (OnAttachStateChangeListener listener : listeners) { 9757 listener.onViewAttachedToWindow(this); 9758 } 9759 } 9760 9761 int vis = info.mWindowVisibility; 9762 if (vis != GONE) { 9763 onWindowVisibilityChanged(vis); 9764 } 9765 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) { 9766 // If nobody has evaluated the drawable state yet, then do it now. 9767 refreshDrawableState(); 9768 } 9769 } 9770 9771 void dispatchDetachedFromWindow() { 9772 AttachInfo info = mAttachInfo; 9773 if (info != null) { 9774 int vis = info.mWindowVisibility; 9775 if (vis != GONE) { 9776 onWindowVisibilityChanged(GONE); 9777 } 9778 } 9779 9780 onDetachedFromWindow(); 9781 9782 ListenerInfo li = mListenerInfo; 9783 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners = 9784 li != null ? li.mOnAttachStateChangeListeners : null; 9785 if (listeners != null && listeners.size() > 0) { 9786 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to 9787 // perform the dispatching. The iterator is a safe guard against listeners that 9788 // could mutate the list by calling the various add/remove methods. This prevents 9789 // the array from being modified while we iterate it. 9790 for (OnAttachStateChangeListener listener : listeners) { 9791 listener.onViewDetachedFromWindow(this); 9792 } 9793 } 9794 9795 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) { 9796 mAttachInfo.mScrollContainers.remove(this); 9797 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED; 9798 } 9799 9800 mAttachInfo = null; 9801 } 9802 9803 /** 9804 * Store this view hierarchy's frozen state into the given container. 9805 * 9806 * @param container The SparseArray in which to save the view's state. 9807 * 9808 * @see #restoreHierarchyState(android.util.SparseArray) 9809 * @see #dispatchSaveInstanceState(android.util.SparseArray) 9810 * @see #onSaveInstanceState() 9811 */ 9812 public void saveHierarchyState(SparseArray<Parcelable> container) { 9813 dispatchSaveInstanceState(container); 9814 } 9815 9816 /** 9817 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for 9818 * this view and its children. May be overridden to modify how freezing happens to a 9819 * view's children; for example, some views may want to not store state for their children. 9820 * 9821 * @param container The SparseArray in which to save the view's state. 9822 * 9823 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 9824 * @see #saveHierarchyState(android.util.SparseArray) 9825 * @see #onSaveInstanceState() 9826 */ 9827 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 9828 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 9829 mPrivateFlags &= ~SAVE_STATE_CALLED; 9830 Parcelable state = onSaveInstanceState(); 9831 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 9832 throw new IllegalStateException( 9833 "Derived class did not call super.onSaveInstanceState()"); 9834 } 9835 if (state != null) { 9836 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 9837 // + ": " + state); 9838 container.put(mID, state); 9839 } 9840 } 9841 } 9842 9843 /** 9844 * Hook allowing a view to generate a representation of its internal state 9845 * that can later be used to create a new instance with that same state. 9846 * This state should only contain information that is not persistent or can 9847 * not be reconstructed later. For example, you will never store your 9848 * current position on screen because that will be computed again when a 9849 * new instance of the view is placed in its view hierarchy. 9850 * <p> 9851 * Some examples of things you may store here: the current cursor position 9852 * in a text view (but usually not the text itself since that is stored in a 9853 * content provider or other persistent storage), the currently selected 9854 * item in a list view. 9855 * 9856 * @return Returns a Parcelable object containing the view's current dynamic 9857 * state, or null if there is nothing interesting to save. The 9858 * default implementation returns null. 9859 * @see #onRestoreInstanceState(android.os.Parcelable) 9860 * @see #saveHierarchyState(android.util.SparseArray) 9861 * @see #dispatchSaveInstanceState(android.util.SparseArray) 9862 * @see #setSaveEnabled(boolean) 9863 */ 9864 protected Parcelable onSaveInstanceState() { 9865 mPrivateFlags |= SAVE_STATE_CALLED; 9866 return BaseSavedState.EMPTY_STATE; 9867 } 9868 9869 /** 9870 * Restore this view hierarchy's frozen state from the given container. 9871 * 9872 * @param container The SparseArray which holds previously frozen states. 9873 * 9874 * @see #saveHierarchyState(android.util.SparseArray) 9875 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 9876 * @see #onRestoreInstanceState(android.os.Parcelable) 9877 */ 9878 public void restoreHierarchyState(SparseArray<Parcelable> container) { 9879 dispatchRestoreInstanceState(container); 9880 } 9881 9882 /** 9883 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the 9884 * state for this view and its children. May be overridden to modify how restoring 9885 * happens to a view's children; for example, some views may want to not store state 9886 * for their children. 9887 * 9888 * @param container The SparseArray which holds previously saved state. 9889 * 9890 * @see #dispatchSaveInstanceState(android.util.SparseArray) 9891 * @see #restoreHierarchyState(android.util.SparseArray) 9892 * @see #onRestoreInstanceState(android.os.Parcelable) 9893 */ 9894 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 9895 if (mID != NO_ID) { 9896 Parcelable state = container.get(mID); 9897 if (state != null) { 9898 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 9899 // + ": " + state); 9900 mPrivateFlags &= ~SAVE_STATE_CALLED; 9901 onRestoreInstanceState(state); 9902 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 9903 throw new IllegalStateException( 9904 "Derived class did not call super.onRestoreInstanceState()"); 9905 } 9906 } 9907 } 9908 } 9909 9910 /** 9911 * Hook allowing a view to re-apply a representation of its internal state that had previously 9912 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 9913 * null state. 9914 * 9915 * @param state The frozen state that had previously been returned by 9916 * {@link #onSaveInstanceState}. 9917 * 9918 * @see #onSaveInstanceState() 9919 * @see #restoreHierarchyState(android.util.SparseArray) 9920 * @see #dispatchRestoreInstanceState(android.util.SparseArray) 9921 */ 9922 protected void onRestoreInstanceState(Parcelable state) { 9923 mPrivateFlags |= SAVE_STATE_CALLED; 9924 if (state != BaseSavedState.EMPTY_STATE && state != null) { 9925 throw new IllegalArgumentException("Wrong state class, expecting View State but " 9926 + "received " + state.getClass().toString() + " instead. This usually happens " 9927 + "when two views of different type have the same id in the same hierarchy. " 9928 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 9929 + "other views do not use the same id."); 9930 } 9931 } 9932 9933 /** 9934 * <p>Return the time at which the drawing of the view hierarchy started.</p> 9935 * 9936 * @return the drawing start time in milliseconds 9937 */ 9938 public long getDrawingTime() { 9939 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 9940 } 9941 9942 /** 9943 * <p>Enables or disables the duplication of the parent's state into this view. When 9944 * duplication is enabled, this view gets its drawable state from its parent rather 9945 * than from its own internal properties.</p> 9946 * 9947 * <p>Note: in the current implementation, setting this property to true after the 9948 * view was added to a ViewGroup might have no effect at all. This property should 9949 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 9950 * 9951 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 9952 * property is enabled, an exception will be thrown.</p> 9953 * 9954 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 9955 * parent, these states should not be affected by this method.</p> 9956 * 9957 * @param enabled True to enable duplication of the parent's drawable state, false 9958 * to disable it. 9959 * 9960 * @see #getDrawableState() 9961 * @see #isDuplicateParentStateEnabled() 9962 */ 9963 public void setDuplicateParentStateEnabled(boolean enabled) { 9964 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 9965 } 9966 9967 /** 9968 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 9969 * 9970 * @return True if this view's drawable state is duplicated from the parent, 9971 * false otherwise 9972 * 9973 * @see #getDrawableState() 9974 * @see #setDuplicateParentStateEnabled(boolean) 9975 */ 9976 public boolean isDuplicateParentStateEnabled() { 9977 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 9978 } 9979 9980 /** 9981 * <p>Specifies the type of layer backing this view. The layer can be 9982 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or 9983 * {@link #LAYER_TYPE_HARDWARE hardware}.</p> 9984 * 9985 * <p>A layer is associated with an optional {@link android.graphics.Paint} 9986 * instance that controls how the layer is composed on screen. The following 9987 * properties of the paint are taken into account when composing the layer:</p> 9988 * <ul> 9989 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 9990 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 9991 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 9992 * </ul> 9993 * 9994 * <p>If this view has an alpha value set to < 1.0 by calling 9995 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by 9996 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore 9997 * equivalent to setting a hardware layer on this view and providing a paint with 9998 * the desired alpha value.<p> 9999 * 10000 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled}, 10001 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware} 10002 * for more information on when and how to use layers.</p> 10003 * 10004 * @param layerType The ype of layer to use with this view, must be one of 10005 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 10006 * {@link #LAYER_TYPE_HARDWARE} 10007 * @param paint The paint used to compose the layer. This argument is optional 10008 * and can be null. It is ignored when the layer type is 10009 * {@link #LAYER_TYPE_NONE} 10010 * 10011 * @see #getLayerType() 10012 * @see #LAYER_TYPE_NONE 10013 * @see #LAYER_TYPE_SOFTWARE 10014 * @see #LAYER_TYPE_HARDWARE 10015 * @see #setAlpha(float) 10016 * 10017 * @attr ref android.R.styleable#View_layerType 10018 */ 10019 public void setLayerType(int layerType, Paint paint) { 10020 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 10021 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 10022 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 10023 } 10024 10025 if (layerType == mLayerType) { 10026 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) { 10027 mLayerPaint = paint == null ? new Paint() : paint; 10028 invalidateParentCaches(); 10029 invalidate(true); 10030 } 10031 return; 10032 } 10033 10034 // Destroy any previous software drawing cache if needed 10035 switch (mLayerType) { 10036 case LAYER_TYPE_HARDWARE: 10037 destroyLayer(); 10038 // fall through - non-accelerated views may use software layer mechanism instead 10039 case LAYER_TYPE_SOFTWARE: 10040 destroyDrawingCache(); 10041 break; 10042 default: 10043 break; 10044 } 10045 10046 mLayerType = layerType; 10047 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE; 10048 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint); 10049 mLocalDirtyRect = layerDisabled ? null : new Rect(); 10050 10051 invalidateParentCaches(); 10052 invalidate(true); 10053 } 10054 10055 /** 10056 * Indicates whether this view has a static layer. A view with layer type 10057 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are 10058 * dynamic. 10059 */ 10060 boolean hasStaticLayer() { 10061 return mLayerType == LAYER_TYPE_NONE; 10062 } 10063 10064 /** 10065 * Indicates what type of layer is currently associated with this view. By default 10066 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 10067 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 10068 * for more information on the different types of layers. 10069 * 10070 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 10071 * {@link #LAYER_TYPE_HARDWARE} 10072 * 10073 * @see #setLayerType(int, android.graphics.Paint) 10074 * @see #buildLayer() 10075 * @see #LAYER_TYPE_NONE 10076 * @see #LAYER_TYPE_SOFTWARE 10077 * @see #LAYER_TYPE_HARDWARE 10078 */ 10079 public int getLayerType() { 10080 return mLayerType; 10081 } 10082 10083 /** 10084 * Forces this view's layer to be created and this view to be rendered 10085 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE}, 10086 * invoking this method will have no effect. 10087 * 10088 * This method can for instance be used to render a view into its layer before 10089 * starting an animation. If this view is complex, rendering into the layer 10090 * before starting the animation will avoid skipping frames. 10091 * 10092 * @throws IllegalStateException If this view is not attached to a window 10093 * 10094 * @see #setLayerType(int, android.graphics.Paint) 10095 */ 10096 public void buildLayer() { 10097 if (mLayerType == LAYER_TYPE_NONE) return; 10098 10099 if (mAttachInfo == null) { 10100 throw new IllegalStateException("This view must be attached to a window first"); 10101 } 10102 10103 switch (mLayerType) { 10104 case LAYER_TYPE_HARDWARE: 10105 if (mAttachInfo.mHardwareRenderer != null && 10106 mAttachInfo.mHardwareRenderer.isEnabled() && 10107 mAttachInfo.mHardwareRenderer.validate()) { 10108 getHardwareLayer(); 10109 } 10110 break; 10111 case LAYER_TYPE_SOFTWARE: 10112 buildDrawingCache(true); 10113 break; 10114 } 10115 } 10116 10117 // Make sure the HardwareRenderer.validate() was invoked before calling this method 10118 void flushLayer() { 10119 if (mLayerType == LAYER_TYPE_HARDWARE && mHardwareLayer != null) { 10120 mHardwareLayer.flush(); 10121 } 10122 } 10123 10124 /** 10125 * <p>Returns a hardware layer that can be used to draw this view again 10126 * without executing its draw method.</p> 10127 * 10128 * @return A HardwareLayer ready to render, or null if an error occurred. 10129 */ 10130 HardwareLayer getHardwareLayer() { 10131 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null || 10132 !mAttachInfo.mHardwareRenderer.isEnabled()) { 10133 return null; 10134 } 10135 10136 if (!mAttachInfo.mHardwareRenderer.validate()) return null; 10137 10138 final int width = mRight - mLeft; 10139 final int height = mBottom - mTop; 10140 10141 if (width == 0 || height == 0) { 10142 return null; 10143 } 10144 10145 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) { 10146 if (mHardwareLayer == null) { 10147 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer( 10148 width, height, isOpaque()); 10149 mLocalDirtyRect.setEmpty(); 10150 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) { 10151 mHardwareLayer.resize(width, height); 10152 mLocalDirtyRect.setEmpty(); 10153 } 10154 10155 // The layer is not valid if the underlying GPU resources cannot be allocated 10156 if (!mHardwareLayer.isValid()) { 10157 return null; 10158 } 10159 10160 HardwareCanvas currentCanvas = mAttachInfo.mHardwareCanvas; 10161 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas); 10162 10163 // Make sure all the GPU resources have been properly allocated 10164 if (canvas == null) { 10165 mHardwareLayer.end(currentCanvas); 10166 return null; 10167 } 10168 10169 mAttachInfo.mHardwareCanvas = canvas; 10170 try { 10171 canvas.setViewport(width, height); 10172 canvas.onPreDraw(mLocalDirtyRect); 10173 mLocalDirtyRect.setEmpty(); 10174 10175 final int restoreCount = canvas.save(); 10176 10177 computeScroll(); 10178 canvas.translate(-mScrollX, -mScrollY); 10179 10180 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 10181 10182 // Fast path for layouts with no backgrounds 10183 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 10184 mPrivateFlags &= ~DIRTY_MASK; 10185 dispatchDraw(canvas); 10186 } else { 10187 draw(canvas); 10188 } 10189 10190 canvas.restoreToCount(restoreCount); 10191 } finally { 10192 canvas.onPostDraw(); 10193 mHardwareLayer.end(currentCanvas); 10194 mAttachInfo.mHardwareCanvas = currentCanvas; 10195 } 10196 } 10197 10198 return mHardwareLayer; 10199 } 10200 10201 /** 10202 * Destroys this View's hardware layer if possible. 10203 * 10204 * @return True if the layer was destroyed, false otherwise. 10205 * 10206 * @see #setLayerType(int, android.graphics.Paint) 10207 * @see #LAYER_TYPE_HARDWARE 10208 */ 10209 boolean destroyLayer() { 10210 if (mHardwareLayer != null) { 10211 AttachInfo info = mAttachInfo; 10212 if (info != null && info.mHardwareRenderer != null && 10213 info.mHardwareRenderer.isEnabled() && info.mHardwareRenderer.validate()) { 10214 mHardwareLayer.destroy(); 10215 mHardwareLayer = null; 10216 10217 invalidate(true); 10218 invalidateParentCaches(); 10219 } 10220 return true; 10221 } 10222 return false; 10223 } 10224 10225 /** 10226 * Destroys all hardware rendering resources. This method is invoked 10227 * when the system needs to reclaim resources. Upon execution of this 10228 * method, you should free any OpenGL resources created by the view. 10229 * 10230 * Note: you <strong>must</strong> call 10231 * <code>super.destroyHardwareResources()</code> when overriding 10232 * this method. 10233 * 10234 * @hide 10235 */ 10236 protected void destroyHardwareResources() { 10237 destroyLayer(); 10238 } 10239 10240 /** 10241 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 10242 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 10243 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 10244 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 10245 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 10246 * null.</p> 10247 * 10248 * <p>Enabling the drawing cache is similar to 10249 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 10250 * acceleration is turned off. When hardware acceleration is turned on, enabling the 10251 * drawing cache has no effect on rendering because the system uses a different mechanism 10252 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 10253 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 10254 * for information on how to enable software and hardware layers.</p> 10255 * 10256 * <p>This API can be used to manually generate 10257 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 10258 * {@link #getDrawingCache()}.</p> 10259 * 10260 * @param enabled true to enable the drawing cache, false otherwise 10261 * 10262 * @see #isDrawingCacheEnabled() 10263 * @see #getDrawingCache() 10264 * @see #buildDrawingCache() 10265 * @see #setLayerType(int, android.graphics.Paint) 10266 */ 10267 public void setDrawingCacheEnabled(boolean enabled) { 10268 mCachingFailed = false; 10269 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 10270 } 10271 10272 /** 10273 * <p>Indicates whether the drawing cache is enabled for this view.</p> 10274 * 10275 * @return true if the drawing cache is enabled 10276 * 10277 * @see #setDrawingCacheEnabled(boolean) 10278 * @see #getDrawingCache() 10279 */ 10280 @ViewDebug.ExportedProperty(category = "drawing") 10281 public boolean isDrawingCacheEnabled() { 10282 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 10283 } 10284 10285 /** 10286 * Debugging utility which recursively outputs the dirty state of a view and its 10287 * descendants. 10288 * 10289 * @hide 10290 */ 10291 @SuppressWarnings({"UnusedDeclaration"}) 10292 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 10293 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) + 10294 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" + 10295 (mPrivateFlags & View.DRAWING_CACHE_VALID) + 10296 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")"); 10297 if (clear) { 10298 mPrivateFlags &= clearMask; 10299 } 10300 if (this instanceof ViewGroup) { 10301 ViewGroup parent = (ViewGroup) this; 10302 final int count = parent.getChildCount(); 10303 for (int i = 0; i < count; i++) { 10304 final View child = parent.getChildAt(i); 10305 child.outputDirtyFlags(indent + " ", clear, clearMask); 10306 } 10307 } 10308 } 10309 10310 /** 10311 * This method is used by ViewGroup to cause its children to restore or recreate their 10312 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 10313 * to recreate its own display list, which would happen if it went through the normal 10314 * draw/dispatchDraw mechanisms. 10315 * 10316 * @hide 10317 */ 10318 protected void dispatchGetDisplayList() {} 10319 10320 /** 10321 * A view that is not attached or hardware accelerated cannot create a display list. 10322 * This method checks these conditions and returns the appropriate result. 10323 * 10324 * @return true if view has the ability to create a display list, false otherwise. 10325 * 10326 * @hide 10327 */ 10328 public boolean canHaveDisplayList() { 10329 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null); 10330 } 10331 10332 /** 10333 * @return The HardwareRenderer associated with that view or null if hardware rendering 10334 * is not supported or this this has not been attached to a window. 10335 * 10336 * @hide 10337 */ 10338 public HardwareRenderer getHardwareRenderer() { 10339 if (mAttachInfo != null) { 10340 return mAttachInfo.mHardwareRenderer; 10341 } 10342 return null; 10343 } 10344 10345 /** 10346 * <p>Returns a display list that can be used to draw this view again 10347 * without executing its draw method.</p> 10348 * 10349 * @return A DisplayList ready to replay, or null if caching is not enabled. 10350 * 10351 * @hide 10352 */ 10353 public DisplayList getDisplayList() { 10354 if (!canHaveDisplayList()) { 10355 return null; 10356 } 10357 10358 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || 10359 mDisplayList == null || !mDisplayList.isValid() || 10360 mRecreateDisplayList)) { 10361 // Don't need to recreate the display list, just need to tell our 10362 // children to restore/recreate theirs 10363 if (mDisplayList != null && mDisplayList.isValid() && 10364 !mRecreateDisplayList) { 10365 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 10366 mPrivateFlags &= ~DIRTY_MASK; 10367 dispatchGetDisplayList(); 10368 10369 return mDisplayList; 10370 } 10371 10372 // If we got here, we're recreating it. Mark it as such to ensure that 10373 // we copy in child display lists into ours in drawChild() 10374 mRecreateDisplayList = true; 10375 if (mDisplayList == null) { 10376 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList(); 10377 // If we're creating a new display list, make sure our parent gets invalidated 10378 // since they will need to recreate their display list to account for this 10379 // new child display list. 10380 invalidateParentCaches(); 10381 } 10382 10383 final HardwareCanvas canvas = mDisplayList.start(); 10384 int restoreCount = 0; 10385 try { 10386 int width = mRight - mLeft; 10387 int height = mBottom - mTop; 10388 10389 canvas.setViewport(width, height); 10390 // The dirty rect should always be null for a display list 10391 canvas.onPreDraw(null); 10392 10393 computeScroll(); 10394 10395 restoreCount = canvas.save(); 10396 canvas.translate(-mScrollX, -mScrollY); 10397 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 10398 mPrivateFlags &= ~DIRTY_MASK; 10399 10400 // Fast path for layouts with no backgrounds 10401 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 10402 dispatchDraw(canvas); 10403 } else { 10404 draw(canvas); 10405 } 10406 } finally { 10407 canvas.restoreToCount(restoreCount); 10408 canvas.onPostDraw(); 10409 10410 mDisplayList.end(); 10411 } 10412 } else { 10413 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 10414 mPrivateFlags &= ~DIRTY_MASK; 10415 } 10416 10417 return mDisplayList; 10418 } 10419 10420 /** 10421 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 10422 * 10423 * @return A non-scaled bitmap representing this view or null if cache is disabled. 10424 * 10425 * @see #getDrawingCache(boolean) 10426 */ 10427 public Bitmap getDrawingCache() { 10428 return getDrawingCache(false); 10429 } 10430 10431 /** 10432 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 10433 * is null when caching is disabled. If caching is enabled and the cache is not ready, 10434 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 10435 * draw from the cache when the cache is enabled. To benefit from the cache, you must 10436 * request the drawing cache by calling this method and draw it on screen if the 10437 * returned bitmap is not null.</p> 10438 * 10439 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 10440 * this method will create a bitmap of the same size as this view. Because this bitmap 10441 * will be drawn scaled by the parent ViewGroup, the result on screen might show 10442 * scaling artifacts. To avoid such artifacts, you should call this method by setting 10443 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 10444 * size than the view. This implies that your application must be able to handle this 10445 * size.</p> 10446 * 10447 * @param autoScale Indicates whether the generated bitmap should be scaled based on 10448 * the current density of the screen when the application is in compatibility 10449 * mode. 10450 * 10451 * @return A bitmap representing this view or null if cache is disabled. 10452 * 10453 * @see #setDrawingCacheEnabled(boolean) 10454 * @see #isDrawingCacheEnabled() 10455 * @see #buildDrawingCache(boolean) 10456 * @see #destroyDrawingCache() 10457 */ 10458 public Bitmap getDrawingCache(boolean autoScale) { 10459 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 10460 return null; 10461 } 10462 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 10463 buildDrawingCache(autoScale); 10464 } 10465 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 10466 } 10467 10468 /** 10469 * <p>Frees the resources used by the drawing cache. If you call 10470 * {@link #buildDrawingCache()} manually without calling 10471 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 10472 * should cleanup the cache with this method afterwards.</p> 10473 * 10474 * @see #setDrawingCacheEnabled(boolean) 10475 * @see #buildDrawingCache() 10476 * @see #getDrawingCache() 10477 */ 10478 public void destroyDrawingCache() { 10479 if (mDrawingCache != null) { 10480 mDrawingCache.recycle(); 10481 mDrawingCache = null; 10482 } 10483 if (mUnscaledDrawingCache != null) { 10484 mUnscaledDrawingCache.recycle(); 10485 mUnscaledDrawingCache = null; 10486 } 10487 } 10488 10489 /** 10490 * Setting a solid background color for the drawing cache's bitmaps will improve 10491 * performance and memory usage. Note, though that this should only be used if this 10492 * view will always be drawn on top of a solid color. 10493 * 10494 * @param color The background color to use for the drawing cache's bitmap 10495 * 10496 * @see #setDrawingCacheEnabled(boolean) 10497 * @see #buildDrawingCache() 10498 * @see #getDrawingCache() 10499 */ 10500 public void setDrawingCacheBackgroundColor(int color) { 10501 if (color != mDrawingCacheBackgroundColor) { 10502 mDrawingCacheBackgroundColor = color; 10503 mPrivateFlags &= ~DRAWING_CACHE_VALID; 10504 } 10505 } 10506 10507 /** 10508 * @see #setDrawingCacheBackgroundColor(int) 10509 * 10510 * @return The background color to used for the drawing cache's bitmap 10511 */ 10512 public int getDrawingCacheBackgroundColor() { 10513 return mDrawingCacheBackgroundColor; 10514 } 10515 10516 /** 10517 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 10518 * 10519 * @see #buildDrawingCache(boolean) 10520 */ 10521 public void buildDrawingCache() { 10522 buildDrawingCache(false); 10523 } 10524 10525 /** 10526 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 10527 * 10528 * <p>If you call {@link #buildDrawingCache()} manually without calling 10529 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 10530 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 10531 * 10532 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 10533 * this method will create a bitmap of the same size as this view. Because this bitmap 10534 * will be drawn scaled by the parent ViewGroup, the result on screen might show 10535 * scaling artifacts. To avoid such artifacts, you should call this method by setting 10536 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 10537 * size than the view. This implies that your application must be able to handle this 10538 * size.</p> 10539 * 10540 * <p>You should avoid calling this method when hardware acceleration is enabled. If 10541 * you do not need the drawing cache bitmap, calling this method will increase memory 10542 * usage and cause the view to be rendered in software once, thus negatively impacting 10543 * performance.</p> 10544 * 10545 * @see #getDrawingCache() 10546 * @see #destroyDrawingCache() 10547 */ 10548 public void buildDrawingCache(boolean autoScale) { 10549 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ? 10550 mDrawingCache == null : mUnscaledDrawingCache == null)) { 10551 mCachingFailed = false; 10552 10553 if (ViewDebug.TRACE_HIERARCHY) { 10554 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE); 10555 } 10556 10557 int width = mRight - mLeft; 10558 int height = mBottom - mTop; 10559 10560 final AttachInfo attachInfo = mAttachInfo; 10561 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 10562 10563 if (autoScale && scalingRequired) { 10564 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 10565 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 10566 } 10567 10568 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 10569 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 10570 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 10571 10572 if (width <= 0 || height <= 0 || 10573 // Projected bitmap size in bytes 10574 (width * height * (opaque && !use32BitCache ? 2 : 4) > 10575 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) { 10576 destroyDrawingCache(); 10577 mCachingFailed = true; 10578 return; 10579 } 10580 10581 boolean clear = true; 10582 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 10583 10584 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 10585 Bitmap.Config quality; 10586 if (!opaque) { 10587 // Never pick ARGB_4444 because it looks awful 10588 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case 10589 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 10590 case DRAWING_CACHE_QUALITY_AUTO: 10591 quality = Bitmap.Config.ARGB_8888; 10592 break; 10593 case DRAWING_CACHE_QUALITY_LOW: 10594 quality = Bitmap.Config.ARGB_8888; 10595 break; 10596 case DRAWING_CACHE_QUALITY_HIGH: 10597 quality = Bitmap.Config.ARGB_8888; 10598 break; 10599 default: 10600 quality = Bitmap.Config.ARGB_8888; 10601 break; 10602 } 10603 } else { 10604 // Optimization for translucent windows 10605 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 10606 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 10607 } 10608 10609 // Try to cleanup memory 10610 if (bitmap != null) bitmap.recycle(); 10611 10612 try { 10613 bitmap = Bitmap.createBitmap(width, height, quality); 10614 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 10615 if (autoScale) { 10616 mDrawingCache = bitmap; 10617 } else { 10618 mUnscaledDrawingCache = bitmap; 10619 } 10620 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 10621 } catch (OutOfMemoryError e) { 10622 // If there is not enough memory to create the bitmap cache, just 10623 // ignore the issue as bitmap caches are not required to draw the 10624 // view hierarchy 10625 if (autoScale) { 10626 mDrawingCache = null; 10627 } else { 10628 mUnscaledDrawingCache = null; 10629 } 10630 mCachingFailed = true; 10631 return; 10632 } 10633 10634 clear = drawingCacheBackgroundColor != 0; 10635 } 10636 10637 Canvas canvas; 10638 if (attachInfo != null) { 10639 canvas = attachInfo.mCanvas; 10640 if (canvas == null) { 10641 canvas = new Canvas(); 10642 } 10643 canvas.setBitmap(bitmap); 10644 // Temporarily clobber the cached Canvas in case one of our children 10645 // is also using a drawing cache. Without this, the children would 10646 // steal the canvas by attaching their own bitmap to it and bad, bad 10647 // thing would happen (invisible views, corrupted drawings, etc.) 10648 attachInfo.mCanvas = null; 10649 } else { 10650 // This case should hopefully never or seldom happen 10651 canvas = new Canvas(bitmap); 10652 } 10653 10654 if (clear) { 10655 bitmap.eraseColor(drawingCacheBackgroundColor); 10656 } 10657 10658 computeScroll(); 10659 final int restoreCount = canvas.save(); 10660 10661 if (autoScale && scalingRequired) { 10662 final float scale = attachInfo.mApplicationScale; 10663 canvas.scale(scale, scale); 10664 } 10665 10666 canvas.translate(-mScrollX, -mScrollY); 10667 10668 mPrivateFlags |= DRAWN; 10669 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 10670 mLayerType != LAYER_TYPE_NONE) { 10671 mPrivateFlags |= DRAWING_CACHE_VALID; 10672 } 10673 10674 // Fast path for layouts with no backgrounds 10675 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 10676 if (ViewDebug.TRACE_HIERARCHY) { 10677 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 10678 } 10679 mPrivateFlags &= ~DIRTY_MASK; 10680 dispatchDraw(canvas); 10681 } else { 10682 draw(canvas); 10683 } 10684 10685 canvas.restoreToCount(restoreCount); 10686 canvas.setBitmap(null); 10687 10688 if (attachInfo != null) { 10689 // Restore the cached Canvas for our siblings 10690 attachInfo.mCanvas = canvas; 10691 } 10692 } 10693 } 10694 10695 /** 10696 * Create a snapshot of the view into a bitmap. We should probably make 10697 * some form of this public, but should think about the API. 10698 */ 10699 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 10700 int width = mRight - mLeft; 10701 int height = mBottom - mTop; 10702 10703 final AttachInfo attachInfo = mAttachInfo; 10704 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 10705 width = (int) ((width * scale) + 0.5f); 10706 height = (int) ((height * scale) + 0.5f); 10707 10708 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality); 10709 if (bitmap == null) { 10710 throw new OutOfMemoryError(); 10711 } 10712 10713 Resources resources = getResources(); 10714 if (resources != null) { 10715 bitmap.setDensity(resources.getDisplayMetrics().densityDpi); 10716 } 10717 10718 Canvas canvas; 10719 if (attachInfo != null) { 10720 canvas = attachInfo.mCanvas; 10721 if (canvas == null) { 10722 canvas = new Canvas(); 10723 } 10724 canvas.setBitmap(bitmap); 10725 // Temporarily clobber the cached Canvas in case one of our children 10726 // is also using a drawing cache. Without this, the children would 10727 // steal the canvas by attaching their own bitmap to it and bad, bad 10728 // things would happen (invisible views, corrupted drawings, etc.) 10729 attachInfo.mCanvas = null; 10730 } else { 10731 // This case should hopefully never or seldom happen 10732 canvas = new Canvas(bitmap); 10733 } 10734 10735 if ((backgroundColor & 0xff000000) != 0) { 10736 bitmap.eraseColor(backgroundColor); 10737 } 10738 10739 computeScroll(); 10740 final int restoreCount = canvas.save(); 10741 canvas.scale(scale, scale); 10742 canvas.translate(-mScrollX, -mScrollY); 10743 10744 // Temporarily remove the dirty mask 10745 int flags = mPrivateFlags; 10746 mPrivateFlags &= ~DIRTY_MASK; 10747 10748 // Fast path for layouts with no backgrounds 10749 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 10750 dispatchDraw(canvas); 10751 } else { 10752 draw(canvas); 10753 } 10754 10755 mPrivateFlags = flags; 10756 10757 canvas.restoreToCount(restoreCount); 10758 canvas.setBitmap(null); 10759 10760 if (attachInfo != null) { 10761 // Restore the cached Canvas for our siblings 10762 attachInfo.mCanvas = canvas; 10763 } 10764 10765 return bitmap; 10766 } 10767 10768 /** 10769 * Indicates whether this View is currently in edit mode. A View is usually 10770 * in edit mode when displayed within a developer tool. For instance, if 10771 * this View is being drawn by a visual user interface builder, this method 10772 * should return true. 10773 * 10774 * Subclasses should check the return value of this method to provide 10775 * different behaviors if their normal behavior might interfere with the 10776 * host environment. For instance: the class spawns a thread in its 10777 * constructor, the drawing code relies on device-specific features, etc. 10778 * 10779 * This method is usually checked in the drawing code of custom widgets. 10780 * 10781 * @return True if this View is in edit mode, false otherwise. 10782 */ 10783 public boolean isInEditMode() { 10784 return false; 10785 } 10786 10787 /** 10788 * If the View draws content inside its padding and enables fading edges, 10789 * it needs to support padding offsets. Padding offsets are added to the 10790 * fading edges to extend the length of the fade so that it covers pixels 10791 * drawn inside the padding. 10792 * 10793 * Subclasses of this class should override this method if they need 10794 * to draw content inside the padding. 10795 * 10796 * @return True if padding offset must be applied, false otherwise. 10797 * 10798 * @see #getLeftPaddingOffset() 10799 * @see #getRightPaddingOffset() 10800 * @see #getTopPaddingOffset() 10801 * @see #getBottomPaddingOffset() 10802 * 10803 * @since CURRENT 10804 */ 10805 protected boolean isPaddingOffsetRequired() { 10806 return false; 10807 } 10808 10809 /** 10810 * Amount by which to extend the left fading region. Called only when 10811 * {@link #isPaddingOffsetRequired()} returns true. 10812 * 10813 * @return The left padding offset in pixels. 10814 * 10815 * @see #isPaddingOffsetRequired() 10816 * 10817 * @since CURRENT 10818 */ 10819 protected int getLeftPaddingOffset() { 10820 return 0; 10821 } 10822 10823 /** 10824 * Amount by which to extend the right fading region. Called only when 10825 * {@link #isPaddingOffsetRequired()} returns true. 10826 * 10827 * @return The right padding offset in pixels. 10828 * 10829 * @see #isPaddingOffsetRequired() 10830 * 10831 * @since CURRENT 10832 */ 10833 protected int getRightPaddingOffset() { 10834 return 0; 10835 } 10836 10837 /** 10838 * Amount by which to extend the top fading region. Called only when 10839 * {@link #isPaddingOffsetRequired()} returns true. 10840 * 10841 * @return The top padding offset in pixels. 10842 * 10843 * @see #isPaddingOffsetRequired() 10844 * 10845 * @since CURRENT 10846 */ 10847 protected int getTopPaddingOffset() { 10848 return 0; 10849 } 10850 10851 /** 10852 * Amount by which to extend the bottom fading region. Called only when 10853 * {@link #isPaddingOffsetRequired()} returns true. 10854 * 10855 * @return The bottom padding offset in pixels. 10856 * 10857 * @see #isPaddingOffsetRequired() 10858 * 10859 * @since CURRENT 10860 */ 10861 protected int getBottomPaddingOffset() { 10862 return 0; 10863 } 10864 10865 /** 10866 * @hide 10867 * @param offsetRequired 10868 */ 10869 protected int getFadeTop(boolean offsetRequired) { 10870 int top = mPaddingTop; 10871 if (offsetRequired) top += getTopPaddingOffset(); 10872 return top; 10873 } 10874 10875 /** 10876 * @hide 10877 * @param offsetRequired 10878 */ 10879 protected int getFadeHeight(boolean offsetRequired) { 10880 int padding = mPaddingTop; 10881 if (offsetRequired) padding += getTopPaddingOffset(); 10882 return mBottom - mTop - mPaddingBottom - padding; 10883 } 10884 10885 /** 10886 * <p>Indicates whether this view is attached to an hardware accelerated 10887 * window or not.</p> 10888 * 10889 * <p>Even if this method returns true, it does not mean that every call 10890 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 10891 * accelerated {@link android.graphics.Canvas}. For instance, if this view 10892 * is drawn onto an offscren {@link android.graphics.Bitmap} and its 10893 * window is hardware accelerated, 10894 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 10895 * return false, and this method will return true.</p> 10896 * 10897 * @return True if the view is attached to a window and the window is 10898 * hardware accelerated; false in any other case. 10899 */ 10900 public boolean isHardwareAccelerated() { 10901 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 10902 } 10903 10904 /** 10905 * Manually render this view (and all of its children) to the given Canvas. 10906 * The view must have already done a full layout before this function is 10907 * called. When implementing a view, implement 10908 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method. 10909 * If you do need to override this method, call the superclass version. 10910 * 10911 * @param canvas The Canvas to which the View is rendered. 10912 */ 10913 public void draw(Canvas canvas) { 10914 if (ViewDebug.TRACE_HIERARCHY) { 10915 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 10916 } 10917 10918 final int privateFlags = mPrivateFlags; 10919 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE && 10920 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 10921 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN; 10922 10923 /* 10924 * Draw traversal performs several drawing steps which must be executed 10925 * in the appropriate order: 10926 * 10927 * 1. Draw the background 10928 * 2. If necessary, save the canvas' layers to prepare for fading 10929 * 3. Draw view's content 10930 * 4. Draw children 10931 * 5. If necessary, draw the fading edges and restore layers 10932 * 6. Draw decorations (scrollbars for instance) 10933 */ 10934 10935 // Step 1, draw the background, if needed 10936 int saveCount; 10937 10938 if (!dirtyOpaque) { 10939 final Drawable background = mBGDrawable; 10940 if (background != null) { 10941 final int scrollX = mScrollX; 10942 final int scrollY = mScrollY; 10943 10944 if (mBackgroundSizeChanged) { 10945 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 10946 mBackgroundSizeChanged = false; 10947 } 10948 10949 if ((scrollX | scrollY) == 0) { 10950 background.draw(canvas); 10951 } else { 10952 canvas.translate(scrollX, scrollY); 10953 background.draw(canvas); 10954 canvas.translate(-scrollX, -scrollY); 10955 } 10956 } 10957 } 10958 10959 // skip step 2 & 5 if possible (common case) 10960 final int viewFlags = mViewFlags; 10961 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 10962 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 10963 if (!verticalEdges && !horizontalEdges) { 10964 // Step 3, draw the content 10965 if (!dirtyOpaque) onDraw(canvas); 10966 10967 // Step 4, draw the children 10968 dispatchDraw(canvas); 10969 10970 // Step 6, draw decorations (scrollbars) 10971 onDrawScrollBars(canvas); 10972 10973 // we're done... 10974 return; 10975 } 10976 10977 /* 10978 * Here we do the full fledged routine... 10979 * (this is an uncommon case where speed matters less, 10980 * this is why we repeat some of the tests that have been 10981 * done above) 10982 */ 10983 10984 boolean drawTop = false; 10985 boolean drawBottom = false; 10986 boolean drawLeft = false; 10987 boolean drawRight = false; 10988 10989 float topFadeStrength = 0.0f; 10990 float bottomFadeStrength = 0.0f; 10991 float leftFadeStrength = 0.0f; 10992 float rightFadeStrength = 0.0f; 10993 10994 // Step 2, save the canvas' layers 10995 int paddingLeft = mPaddingLeft; 10996 10997 final boolean offsetRequired = isPaddingOffsetRequired(); 10998 if (offsetRequired) { 10999 paddingLeft += getLeftPaddingOffset(); 11000 } 11001 11002 int left = mScrollX + paddingLeft; 11003 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 11004 int top = mScrollY + getFadeTop(offsetRequired); 11005 int bottom = top + getFadeHeight(offsetRequired); 11006 11007 if (offsetRequired) { 11008 right += getRightPaddingOffset(); 11009 bottom += getBottomPaddingOffset(); 11010 } 11011 11012 final ScrollabilityCache scrollabilityCache = mScrollCache; 11013 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 11014 int length = (int) fadeHeight; 11015 11016 // clip the fade length if top and bottom fades overlap 11017 // overlapping fades produce odd-looking artifacts 11018 if (verticalEdges && (top + length > bottom - length)) { 11019 length = (bottom - top) / 2; 11020 } 11021 11022 // also clip horizontal fades if necessary 11023 if (horizontalEdges && (left + length > right - length)) { 11024 length = (right - left) / 2; 11025 } 11026 11027 if (verticalEdges) { 11028 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 11029 drawTop = topFadeStrength * fadeHeight > 1.0f; 11030 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 11031 drawBottom = bottomFadeStrength * fadeHeight > 1.0f; 11032 } 11033 11034 if (horizontalEdges) { 11035 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 11036 drawLeft = leftFadeStrength * fadeHeight > 1.0f; 11037 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 11038 drawRight = rightFadeStrength * fadeHeight > 1.0f; 11039 } 11040 11041 saveCount = canvas.getSaveCount(); 11042 11043 int solidColor = getSolidColor(); 11044 if (solidColor == 0) { 11045 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 11046 11047 if (drawTop) { 11048 canvas.saveLayer(left, top, right, top + length, null, flags); 11049 } 11050 11051 if (drawBottom) { 11052 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 11053 } 11054 11055 if (drawLeft) { 11056 canvas.saveLayer(left, top, left + length, bottom, null, flags); 11057 } 11058 11059 if (drawRight) { 11060 canvas.saveLayer(right - length, top, right, bottom, null, flags); 11061 } 11062 } else { 11063 scrollabilityCache.setFadeColor(solidColor); 11064 } 11065 11066 // Step 3, draw the content 11067 if (!dirtyOpaque) onDraw(canvas); 11068 11069 // Step 4, draw the children 11070 dispatchDraw(canvas); 11071 11072 // Step 5, draw the fade effect and restore layers 11073 final Paint p = scrollabilityCache.paint; 11074 final Matrix matrix = scrollabilityCache.matrix; 11075 final Shader fade = scrollabilityCache.shader; 11076 11077 if (drawTop) { 11078 matrix.setScale(1, fadeHeight * topFadeStrength); 11079 matrix.postTranslate(left, top); 11080 fade.setLocalMatrix(matrix); 11081 canvas.drawRect(left, top, right, top + length, p); 11082 } 11083 11084 if (drawBottom) { 11085 matrix.setScale(1, fadeHeight * bottomFadeStrength); 11086 matrix.postRotate(180); 11087 matrix.postTranslate(left, bottom); 11088 fade.setLocalMatrix(matrix); 11089 canvas.drawRect(left, bottom - length, right, bottom, p); 11090 } 11091 11092 if (drawLeft) { 11093 matrix.setScale(1, fadeHeight * leftFadeStrength); 11094 matrix.postRotate(-90); 11095 matrix.postTranslate(left, top); 11096 fade.setLocalMatrix(matrix); 11097 canvas.drawRect(left, top, left + length, bottom, p); 11098 } 11099 11100 if (drawRight) { 11101 matrix.setScale(1, fadeHeight * rightFadeStrength); 11102 matrix.postRotate(90); 11103 matrix.postTranslate(right, top); 11104 fade.setLocalMatrix(matrix); 11105 canvas.drawRect(right - length, top, right, bottom, p); 11106 } 11107 11108 canvas.restoreToCount(saveCount); 11109 11110 // Step 6, draw decorations (scrollbars) 11111 onDrawScrollBars(canvas); 11112 } 11113 11114 /** 11115 * Override this if your view is known to always be drawn on top of a solid color background, 11116 * and needs to draw fading edges. Returning a non-zero color enables the view system to 11117 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 11118 * should be set to 0xFF. 11119 * 11120 * @see #setVerticalFadingEdgeEnabled(boolean) 11121 * @see #setHorizontalFadingEdgeEnabled(boolean) 11122 * 11123 * @return The known solid color background for this view, or 0 if the color may vary 11124 */ 11125 @ViewDebug.ExportedProperty(category = "drawing") 11126 public int getSolidColor() { 11127 return 0; 11128 } 11129 11130 /** 11131 * Build a human readable string representation of the specified view flags. 11132 * 11133 * @param flags the view flags to convert to a string 11134 * @return a String representing the supplied flags 11135 */ 11136 private static String printFlags(int flags) { 11137 String output = ""; 11138 int numFlags = 0; 11139 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 11140 output += "TAKES_FOCUS"; 11141 numFlags++; 11142 } 11143 11144 switch (flags & VISIBILITY_MASK) { 11145 case INVISIBLE: 11146 if (numFlags > 0) { 11147 output += " "; 11148 } 11149 output += "INVISIBLE"; 11150 // USELESS HERE numFlags++; 11151 break; 11152 case GONE: 11153 if (numFlags > 0) { 11154 output += " "; 11155 } 11156 output += "GONE"; 11157 // USELESS HERE numFlags++; 11158 break; 11159 default: 11160 break; 11161 } 11162 return output; 11163 } 11164 11165 /** 11166 * Build a human readable string representation of the specified private 11167 * view flags. 11168 * 11169 * @param privateFlags the private view flags to convert to a string 11170 * @return a String representing the supplied flags 11171 */ 11172 private static String printPrivateFlags(int privateFlags) { 11173 String output = ""; 11174 int numFlags = 0; 11175 11176 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) { 11177 output += "WANTS_FOCUS"; 11178 numFlags++; 11179 } 11180 11181 if ((privateFlags & FOCUSED) == FOCUSED) { 11182 if (numFlags > 0) { 11183 output += " "; 11184 } 11185 output += "FOCUSED"; 11186 numFlags++; 11187 } 11188 11189 if ((privateFlags & SELECTED) == SELECTED) { 11190 if (numFlags > 0) { 11191 output += " "; 11192 } 11193 output += "SELECTED"; 11194 numFlags++; 11195 } 11196 11197 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) { 11198 if (numFlags > 0) { 11199 output += " "; 11200 } 11201 output += "IS_ROOT_NAMESPACE"; 11202 numFlags++; 11203 } 11204 11205 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) { 11206 if (numFlags > 0) { 11207 output += " "; 11208 } 11209 output += "HAS_BOUNDS"; 11210 numFlags++; 11211 } 11212 11213 if ((privateFlags & DRAWN) == DRAWN) { 11214 if (numFlags > 0) { 11215 output += " "; 11216 } 11217 output += "DRAWN"; 11218 // USELESS HERE numFlags++; 11219 } 11220 return output; 11221 } 11222 11223 /** 11224 * <p>Indicates whether or not this view's layout will be requested during 11225 * the next hierarchy layout pass.</p> 11226 * 11227 * @return true if the layout will be forced during next layout pass 11228 */ 11229 public boolean isLayoutRequested() { 11230 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT; 11231 } 11232 11233 /** 11234 * Assign a size and position to a view and all of its 11235 * descendants 11236 * 11237 * <p>This is the second phase of the layout mechanism. 11238 * (The first is measuring). In this phase, each parent calls 11239 * layout on all of its children to position them. 11240 * This is typically done using the child measurements 11241 * that were stored in the measure pass().</p> 11242 * 11243 * <p>Derived classes should not override this method. 11244 * Derived classes with children should override 11245 * onLayout. In that method, they should 11246 * call layout on each of their children.</p> 11247 * 11248 * @param l Left position, relative to parent 11249 * @param t Top position, relative to parent 11250 * @param r Right position, relative to parent 11251 * @param b Bottom position, relative to parent 11252 */ 11253 @SuppressWarnings({"unchecked"}) 11254 public void layout(int l, int t, int r, int b) { 11255 int oldL = mLeft; 11256 int oldT = mTop; 11257 int oldB = mBottom; 11258 int oldR = mRight; 11259 boolean changed = setFrame(l, t, r, b); 11260 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) { 11261 if (ViewDebug.TRACE_HIERARCHY) { 11262 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT); 11263 } 11264 11265 onLayout(changed, l, t, r, b); 11266 mPrivateFlags &= ~LAYOUT_REQUIRED; 11267 11268 ListenerInfo li = mListenerInfo; 11269 if (li != null && li.mOnLayoutChangeListeners != null) { 11270 ArrayList<OnLayoutChangeListener> listenersCopy = 11271 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone(); 11272 int numListeners = listenersCopy.size(); 11273 for (int i = 0; i < numListeners; ++i) { 11274 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 11275 } 11276 } 11277 } 11278 mPrivateFlags &= ~FORCE_LAYOUT; 11279 } 11280 11281 /** 11282 * Called from layout when this view should 11283 * assign a size and position to each of its children. 11284 * 11285 * Derived classes with children should override 11286 * this method and call layout on each of 11287 * their children. 11288 * @param changed This is a new size or position for this view 11289 * @param left Left position, relative to parent 11290 * @param top Top position, relative to parent 11291 * @param right Right position, relative to parent 11292 * @param bottom Bottom position, relative to parent 11293 */ 11294 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 11295 } 11296 11297 /** 11298 * Assign a size and position to this view. 11299 * 11300 * This is called from layout. 11301 * 11302 * @param left Left position, relative to parent 11303 * @param top Top position, relative to parent 11304 * @param right Right position, relative to parent 11305 * @param bottom Bottom position, relative to parent 11306 * @return true if the new size and position are different than the 11307 * previous ones 11308 * {@hide} 11309 */ 11310 protected boolean setFrame(int left, int top, int right, int bottom) { 11311 boolean changed = false; 11312 11313 if (DBG) { 11314 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 11315 + right + "," + bottom + ")"); 11316 } 11317 11318 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 11319 changed = true; 11320 11321 // Remember our drawn bit 11322 int drawn = mPrivateFlags & DRAWN; 11323 11324 int oldWidth = mRight - mLeft; 11325 int oldHeight = mBottom - mTop; 11326 int newWidth = right - left; 11327 int newHeight = bottom - top; 11328 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight); 11329 11330 // Invalidate our old position 11331 invalidate(sizeChanged); 11332 11333 mLeft = left; 11334 mTop = top; 11335 mRight = right; 11336 mBottom = bottom; 11337 11338 mPrivateFlags |= HAS_BOUNDS; 11339 11340 11341 if (sizeChanged) { 11342 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 11343 // A change in dimension means an auto-centered pivot point changes, too 11344 if (mTransformationInfo != null) { 11345 mTransformationInfo.mMatrixDirty = true; 11346 } 11347 } 11348 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 11349 } 11350 11351 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) { 11352 // If we are visible, force the DRAWN bit to on so that 11353 // this invalidate will go through (at least to our parent). 11354 // This is because someone may have invalidated this view 11355 // before this call to setFrame came in, thereby clearing 11356 // the DRAWN bit. 11357 mPrivateFlags |= DRAWN; 11358 invalidate(sizeChanged); 11359 // parent display list may need to be recreated based on a change in the bounds 11360 // of any child 11361 invalidateParentCaches(); 11362 } 11363 11364 // Reset drawn bit to original value (invalidate turns it off) 11365 mPrivateFlags |= drawn; 11366 11367 mBackgroundSizeChanged = true; 11368 } 11369 return changed; 11370 } 11371 11372 /** 11373 * Finalize inflating a view from XML. This is called as the last phase 11374 * of inflation, after all child views have been added. 11375 * 11376 * <p>Even if the subclass overrides onFinishInflate, they should always be 11377 * sure to call the super method, so that we get called. 11378 */ 11379 protected void onFinishInflate() { 11380 } 11381 11382 /** 11383 * Returns the resources associated with this view. 11384 * 11385 * @return Resources object. 11386 */ 11387 public Resources getResources() { 11388 return mResources; 11389 } 11390 11391 /** 11392 * Invalidates the specified Drawable. 11393 * 11394 * @param drawable the drawable to invalidate 11395 */ 11396 public void invalidateDrawable(Drawable drawable) { 11397 if (verifyDrawable(drawable)) { 11398 final Rect dirty = drawable.getBounds(); 11399 final int scrollX = mScrollX; 11400 final int scrollY = mScrollY; 11401 11402 invalidate(dirty.left + scrollX, dirty.top + scrollY, 11403 dirty.right + scrollX, dirty.bottom + scrollY); 11404 } 11405 } 11406 11407 /** 11408 * Schedules an action on a drawable to occur at a specified time. 11409 * 11410 * @param who the recipient of the action 11411 * @param what the action to run on the drawable 11412 * @param when the time at which the action must occur. Uses the 11413 * {@link SystemClock#uptimeMillis} timebase. 11414 */ 11415 public void scheduleDrawable(Drawable who, Runnable what, long when) { 11416 if (verifyDrawable(who) && what != null) { 11417 if (mAttachInfo != null) { 11418 mAttachInfo.mHandler.postAtTime(what, who, when); 11419 } else { 11420 ViewRootImpl.getRunQueue().postDelayed(what, when - SystemClock.uptimeMillis()); 11421 } 11422 } 11423 } 11424 11425 /** 11426 * Cancels a scheduled action on a drawable. 11427 * 11428 * @param who the recipient of the action 11429 * @param what the action to cancel 11430 */ 11431 public void unscheduleDrawable(Drawable who, Runnable what) { 11432 if (verifyDrawable(who) && what != null) { 11433 if (mAttachInfo != null) { 11434 mAttachInfo.mHandler.removeCallbacks(what, who); 11435 } else { 11436 ViewRootImpl.getRunQueue().removeCallbacks(what); 11437 } 11438 } 11439 } 11440 11441 /** 11442 * Unschedule any events associated with the given Drawable. This can be 11443 * used when selecting a new Drawable into a view, so that the previous 11444 * one is completely unscheduled. 11445 * 11446 * @param who The Drawable to unschedule. 11447 * 11448 * @see #drawableStateChanged 11449 */ 11450 public void unscheduleDrawable(Drawable who) { 11451 if (mAttachInfo != null) { 11452 mAttachInfo.mHandler.removeCallbacksAndMessages(who); 11453 } 11454 } 11455 11456 /** 11457 * Return the layout direction of a given Drawable. 11458 * 11459 * @param who the Drawable to query 11460 * 11461 * @hide 11462 */ 11463 public int getResolvedLayoutDirection(Drawable who) { 11464 return (who == mBGDrawable) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT; 11465 } 11466 11467 /** 11468 * If your view subclass is displaying its own Drawable objects, it should 11469 * override this function and return true for any Drawable it is 11470 * displaying. This allows animations for those drawables to be 11471 * scheduled. 11472 * 11473 * <p>Be sure to call through to the super class when overriding this 11474 * function. 11475 * 11476 * @param who The Drawable to verify. Return true if it is one you are 11477 * displaying, else return the result of calling through to the 11478 * super class. 11479 * 11480 * @return boolean If true than the Drawable is being displayed in the 11481 * view; else false and it is not allowed to animate. 11482 * 11483 * @see #unscheduleDrawable(android.graphics.drawable.Drawable) 11484 * @see #drawableStateChanged() 11485 */ 11486 protected boolean verifyDrawable(Drawable who) { 11487 return who == mBGDrawable; 11488 } 11489 11490 /** 11491 * This function is called whenever the state of the view changes in such 11492 * a way that it impacts the state of drawables being shown. 11493 * 11494 * <p>Be sure to call through to the superclass when overriding this 11495 * function. 11496 * 11497 * @see Drawable#setState(int[]) 11498 */ 11499 protected void drawableStateChanged() { 11500 Drawable d = mBGDrawable; 11501 if (d != null && d.isStateful()) { 11502 d.setState(getDrawableState()); 11503 } 11504 } 11505 11506 /** 11507 * Call this to force a view to update its drawable state. This will cause 11508 * drawableStateChanged to be called on this view. Views that are interested 11509 * in the new state should call getDrawableState. 11510 * 11511 * @see #drawableStateChanged 11512 * @see #getDrawableState 11513 */ 11514 public void refreshDrawableState() { 11515 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 11516 drawableStateChanged(); 11517 11518 ViewParent parent = mParent; 11519 if (parent != null) { 11520 parent.childDrawableStateChanged(this); 11521 } 11522 } 11523 11524 /** 11525 * Return an array of resource IDs of the drawable states representing the 11526 * current state of the view. 11527 * 11528 * @return The current drawable state 11529 * 11530 * @see Drawable#setState(int[]) 11531 * @see #drawableStateChanged() 11532 * @see #onCreateDrawableState(int) 11533 */ 11534 public final int[] getDrawableState() { 11535 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) { 11536 return mDrawableState; 11537 } else { 11538 mDrawableState = onCreateDrawableState(0); 11539 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY; 11540 return mDrawableState; 11541 } 11542 } 11543 11544 /** 11545 * Generate the new {@link android.graphics.drawable.Drawable} state for 11546 * this view. This is called by the view 11547 * system when the cached Drawable state is determined to be invalid. To 11548 * retrieve the current state, you should use {@link #getDrawableState}. 11549 * 11550 * @param extraSpace if non-zero, this is the number of extra entries you 11551 * would like in the returned array in which you can place your own 11552 * states. 11553 * 11554 * @return Returns an array holding the current {@link Drawable} state of 11555 * the view. 11556 * 11557 * @see #mergeDrawableStates(int[], int[]) 11558 */ 11559 protected int[] onCreateDrawableState(int extraSpace) { 11560 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 11561 mParent instanceof View) { 11562 return ((View) mParent).onCreateDrawableState(extraSpace); 11563 } 11564 11565 int[] drawableState; 11566 11567 int privateFlags = mPrivateFlags; 11568 11569 int viewStateIndex = 0; 11570 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 11571 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 11572 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 11573 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 11574 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 11575 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 11576 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested && 11577 HardwareRenderer.isAvailable()) { 11578 // This is set if HW acceleration is requested, even if the current 11579 // process doesn't allow it. This is just to allow app preview 11580 // windows to better match their app. 11581 viewStateIndex |= VIEW_STATE_ACCELERATED; 11582 } 11583 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED; 11584 11585 final int privateFlags2 = mPrivateFlags2; 11586 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT; 11587 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED; 11588 11589 drawableState = VIEW_STATE_SETS[viewStateIndex]; 11590 11591 //noinspection ConstantIfStatement 11592 if (false) { 11593 Log.i("View", "drawableStateIndex=" + viewStateIndex); 11594 Log.i("View", toString() 11595 + " pressed=" + ((privateFlags & PRESSED) != 0) 11596 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 11597 + " fo=" + hasFocus() 11598 + " sl=" + ((privateFlags & SELECTED) != 0) 11599 + " wf=" + hasWindowFocus() 11600 + ": " + Arrays.toString(drawableState)); 11601 } 11602 11603 if (extraSpace == 0) { 11604 return drawableState; 11605 } 11606 11607 final int[] fullState; 11608 if (drawableState != null) { 11609 fullState = new int[drawableState.length + extraSpace]; 11610 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 11611 } else { 11612 fullState = new int[extraSpace]; 11613 } 11614 11615 return fullState; 11616 } 11617 11618 /** 11619 * Merge your own state values in <var>additionalState</var> into the base 11620 * state values <var>baseState</var> that were returned by 11621 * {@link #onCreateDrawableState(int)}. 11622 * 11623 * @param baseState The base state values returned by 11624 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your 11625 * own additional state values. 11626 * 11627 * @param additionalState The additional state values you would like 11628 * added to <var>baseState</var>; this array is not modified. 11629 * 11630 * @return As a convenience, the <var>baseState</var> array you originally 11631 * passed into the function is returned. 11632 * 11633 * @see #onCreateDrawableState(int) 11634 */ 11635 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 11636 final int N = baseState.length; 11637 int i = N - 1; 11638 while (i >= 0 && baseState[i] == 0) { 11639 i--; 11640 } 11641 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 11642 return baseState; 11643 } 11644 11645 /** 11646 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 11647 * on all Drawable objects associated with this view. 11648 */ 11649 public void jumpDrawablesToCurrentState() { 11650 if (mBGDrawable != null) { 11651 mBGDrawable.jumpToCurrentState(); 11652 } 11653 } 11654 11655 /** 11656 * Sets the background color for this view. 11657 * @param color the color of the background 11658 */ 11659 @RemotableViewMethod 11660 public void setBackgroundColor(int color) { 11661 if (mBGDrawable instanceof ColorDrawable) { 11662 ((ColorDrawable) mBGDrawable).setColor(color); 11663 } else { 11664 setBackgroundDrawable(new ColorDrawable(color)); 11665 } 11666 } 11667 11668 /** 11669 * Set the background to a given resource. The resource should refer to 11670 * a Drawable object or 0 to remove the background. 11671 * @param resid The identifier of the resource. 11672 * @attr ref android.R.styleable#View_background 11673 */ 11674 @RemotableViewMethod 11675 public void setBackgroundResource(int resid) { 11676 if (resid != 0 && resid == mBackgroundResource) { 11677 return; 11678 } 11679 11680 Drawable d= null; 11681 if (resid != 0) { 11682 d = mResources.getDrawable(resid); 11683 } 11684 setBackgroundDrawable(d); 11685 11686 mBackgroundResource = resid; 11687 } 11688 11689 /** 11690 * Set the background to a given Drawable, or remove the background. If the 11691 * background has padding, this View's padding is set to the background's 11692 * padding. However, when a background is removed, this View's padding isn't 11693 * touched. If setting the padding is desired, please use 11694 * {@link #setPadding(int, int, int, int)}. 11695 * 11696 * @param d The Drawable to use as the background, or null to remove the 11697 * background 11698 */ 11699 public void setBackgroundDrawable(Drawable d) { 11700 if (d == mBGDrawable) { 11701 return; 11702 } 11703 11704 boolean requestLayout = false; 11705 11706 mBackgroundResource = 0; 11707 11708 /* 11709 * Regardless of whether we're setting a new background or not, we want 11710 * to clear the previous drawable. 11711 */ 11712 if (mBGDrawable != null) { 11713 mBGDrawable.setCallback(null); 11714 unscheduleDrawable(mBGDrawable); 11715 } 11716 11717 if (d != null) { 11718 Rect padding = sThreadLocal.get(); 11719 if (padding == null) { 11720 padding = new Rect(); 11721 sThreadLocal.set(padding); 11722 } 11723 if (d.getPadding(padding)) { 11724 switch (d.getResolvedLayoutDirectionSelf()) { 11725 case LAYOUT_DIRECTION_RTL: 11726 setPadding(padding.right, padding.top, padding.left, padding.bottom); 11727 break; 11728 case LAYOUT_DIRECTION_LTR: 11729 default: 11730 setPadding(padding.left, padding.top, padding.right, padding.bottom); 11731 } 11732 } 11733 11734 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 11735 // if it has a different minimum size, we should layout again 11736 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() || 11737 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) { 11738 requestLayout = true; 11739 } 11740 11741 d.setCallback(this); 11742 if (d.isStateful()) { 11743 d.setState(getDrawableState()); 11744 } 11745 d.setVisible(getVisibility() == VISIBLE, false); 11746 mBGDrawable = d; 11747 11748 if ((mPrivateFlags & SKIP_DRAW) != 0) { 11749 mPrivateFlags &= ~SKIP_DRAW; 11750 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 11751 requestLayout = true; 11752 } 11753 } else { 11754 /* Remove the background */ 11755 mBGDrawable = null; 11756 11757 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) { 11758 /* 11759 * This view ONLY drew the background before and we're removing 11760 * the background, so now it won't draw anything 11761 * (hence we SKIP_DRAW) 11762 */ 11763 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND; 11764 mPrivateFlags |= SKIP_DRAW; 11765 } 11766 11767 /* 11768 * When the background is set, we try to apply its padding to this 11769 * View. When the background is removed, we don't touch this View's 11770 * padding. This is noted in the Javadocs. Hence, we don't need to 11771 * requestLayout(), the invalidate() below is sufficient. 11772 */ 11773 11774 // The old background's minimum size could have affected this 11775 // View's layout, so let's requestLayout 11776 requestLayout = true; 11777 } 11778 11779 computeOpaqueFlags(); 11780 11781 if (requestLayout) { 11782 requestLayout(); 11783 } 11784 11785 mBackgroundSizeChanged = true; 11786 invalidate(true); 11787 } 11788 11789 /** 11790 * Gets the background drawable 11791 * @return The drawable used as the background for this view, if any. 11792 */ 11793 public Drawable getBackground() { 11794 return mBGDrawable; 11795 } 11796 11797 /** 11798 * Sets the padding. The view may add on the space required to display 11799 * the scrollbars, depending on the style and visibility of the scrollbars. 11800 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 11801 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 11802 * from the values set in this call. 11803 * 11804 * @attr ref android.R.styleable#View_padding 11805 * @attr ref android.R.styleable#View_paddingBottom 11806 * @attr ref android.R.styleable#View_paddingLeft 11807 * @attr ref android.R.styleable#View_paddingRight 11808 * @attr ref android.R.styleable#View_paddingTop 11809 * @param left the left padding in pixels 11810 * @param top the top padding in pixels 11811 * @param right the right padding in pixels 11812 * @param bottom the bottom padding in pixels 11813 */ 11814 public void setPadding(int left, int top, int right, int bottom) { 11815 boolean changed = false; 11816 11817 mUserPaddingRelative = false; 11818 11819 mUserPaddingLeft = left; 11820 mUserPaddingRight = right; 11821 mUserPaddingBottom = bottom; 11822 11823 final int viewFlags = mViewFlags; 11824 11825 // Common case is there are no scroll bars. 11826 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 11827 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 11828 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 11829 ? 0 : getVerticalScrollbarWidth(); 11830 switch (mVerticalScrollbarPosition) { 11831 case SCROLLBAR_POSITION_DEFAULT: 11832 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) { 11833 left += offset; 11834 } else { 11835 right += offset; 11836 } 11837 break; 11838 case SCROLLBAR_POSITION_RIGHT: 11839 right += offset; 11840 break; 11841 case SCROLLBAR_POSITION_LEFT: 11842 left += offset; 11843 break; 11844 } 11845 } 11846 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 11847 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 11848 ? 0 : getHorizontalScrollbarHeight(); 11849 } 11850 } 11851 11852 if (mPaddingLeft != left) { 11853 changed = true; 11854 mPaddingLeft = left; 11855 } 11856 if (mPaddingTop != top) { 11857 changed = true; 11858 mPaddingTop = top; 11859 } 11860 if (mPaddingRight != right) { 11861 changed = true; 11862 mPaddingRight = right; 11863 } 11864 if (mPaddingBottom != bottom) { 11865 changed = true; 11866 mPaddingBottom = bottom; 11867 } 11868 11869 if (changed) { 11870 requestLayout(); 11871 } 11872 } 11873 11874 /** 11875 * Sets the relative padding. The view may add on the space required to display 11876 * the scrollbars, depending on the style and visibility of the scrollbars. 11877 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop}, 11878 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different 11879 * from the values set in this call. 11880 * 11881 * @attr ref android.R.styleable#View_padding 11882 * @attr ref android.R.styleable#View_paddingBottom 11883 * @attr ref android.R.styleable#View_paddingStart 11884 * @attr ref android.R.styleable#View_paddingEnd 11885 * @attr ref android.R.styleable#View_paddingTop 11886 * @param start the start padding in pixels 11887 * @param top the top padding in pixels 11888 * @param end the end padding in pixels 11889 * @param bottom the bottom padding in pixels 11890 * 11891 * @hide 11892 */ 11893 public void setPaddingRelative(int start, int top, int end, int bottom) { 11894 mUserPaddingRelative = true; 11895 11896 mUserPaddingStart = start; 11897 mUserPaddingEnd = end; 11898 11899 switch(getResolvedLayoutDirection()) { 11900 case LAYOUT_DIRECTION_RTL: 11901 setPadding(end, top, start, bottom); 11902 break; 11903 case LAYOUT_DIRECTION_LTR: 11904 default: 11905 setPadding(start, top, end, bottom); 11906 } 11907 } 11908 11909 /** 11910 * Returns the top padding of this view. 11911 * 11912 * @return the top padding in pixels 11913 */ 11914 public int getPaddingTop() { 11915 return mPaddingTop; 11916 } 11917 11918 /** 11919 * Returns the bottom padding of this view. If there are inset and enabled 11920 * scrollbars, this value may include the space required to display the 11921 * scrollbars as well. 11922 * 11923 * @return the bottom padding in pixels 11924 */ 11925 public int getPaddingBottom() { 11926 return mPaddingBottom; 11927 } 11928 11929 /** 11930 * Returns the left padding of this view. If there are inset and enabled 11931 * scrollbars, this value may include the space required to display the 11932 * scrollbars as well. 11933 * 11934 * @return the left padding in pixels 11935 */ 11936 public int getPaddingLeft() { 11937 return mPaddingLeft; 11938 } 11939 11940 /** 11941 * Returns the start padding of this view. If there are inset and enabled 11942 * scrollbars, this value may include the space required to display the 11943 * scrollbars as well. 11944 * 11945 * @return the start padding in pixels 11946 * 11947 * @hide 11948 */ 11949 public int getPaddingStart() { 11950 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 11951 mPaddingRight : mPaddingLeft; 11952 } 11953 11954 /** 11955 * Returns the right padding of this view. If there are inset and enabled 11956 * scrollbars, this value may include the space required to display the 11957 * scrollbars as well. 11958 * 11959 * @return the right padding in pixels 11960 */ 11961 public int getPaddingRight() { 11962 return mPaddingRight; 11963 } 11964 11965 /** 11966 * Returns the end padding of this view. If there are inset and enabled 11967 * scrollbars, this value may include the space required to display the 11968 * scrollbars as well. 11969 * 11970 * @return the end padding in pixels 11971 * 11972 * @hide 11973 */ 11974 public int getPaddingEnd() { 11975 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ? 11976 mPaddingLeft : mPaddingRight; 11977 } 11978 11979 /** 11980 * Return if the padding as been set thru relative values 11981 * {@link #setPaddingRelative(int, int, int, int)} or thru 11982 * @attr ref android.R.styleable#View_paddingStart or 11983 * @attr ref android.R.styleable#View_paddingEnd 11984 * 11985 * @return true if the padding is relative or false if it is not. 11986 * 11987 * @hide 11988 */ 11989 public boolean isPaddingRelative() { 11990 return mUserPaddingRelative; 11991 } 11992 11993 /** 11994 * Changes the selection state of this view. A view can be selected or not. 11995 * Note that selection is not the same as focus. Views are typically 11996 * selected in the context of an AdapterView like ListView or GridView; 11997 * the selected view is the view that is highlighted. 11998 * 11999 * @param selected true if the view must be selected, false otherwise 12000 */ 12001 public void setSelected(boolean selected) { 12002 if (((mPrivateFlags & SELECTED) != 0) != selected) { 12003 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0); 12004 if (!selected) resetPressedState(); 12005 invalidate(true); 12006 refreshDrawableState(); 12007 dispatchSetSelected(selected); 12008 } 12009 } 12010 12011 /** 12012 * Dispatch setSelected to all of this View's children. 12013 * 12014 * @see #setSelected(boolean) 12015 * 12016 * @param selected The new selected state 12017 */ 12018 protected void dispatchSetSelected(boolean selected) { 12019 } 12020 12021 /** 12022 * Indicates the selection state of this view. 12023 * 12024 * @return true if the view is selected, false otherwise 12025 */ 12026 @ViewDebug.ExportedProperty 12027 public boolean isSelected() { 12028 return (mPrivateFlags & SELECTED) != 0; 12029 } 12030 12031 /** 12032 * Changes the activated state of this view. A view can be activated or not. 12033 * Note that activation is not the same as selection. Selection is 12034 * a transient property, representing the view (hierarchy) the user is 12035 * currently interacting with. Activation is a longer-term state that the 12036 * user can move views in and out of. For example, in a list view with 12037 * single or multiple selection enabled, the views in the current selection 12038 * set are activated. (Um, yeah, we are deeply sorry about the terminology 12039 * here.) The activated state is propagated down to children of the view it 12040 * is set on. 12041 * 12042 * @param activated true if the view must be activated, false otherwise 12043 */ 12044 public void setActivated(boolean activated) { 12045 if (((mPrivateFlags & ACTIVATED) != 0) != activated) { 12046 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0); 12047 invalidate(true); 12048 refreshDrawableState(); 12049 dispatchSetActivated(activated); 12050 } 12051 } 12052 12053 /** 12054 * Dispatch setActivated to all of this View's children. 12055 * 12056 * @see #setActivated(boolean) 12057 * 12058 * @param activated The new activated state 12059 */ 12060 protected void dispatchSetActivated(boolean activated) { 12061 } 12062 12063 /** 12064 * Indicates the activation state of this view. 12065 * 12066 * @return true if the view is activated, false otherwise 12067 */ 12068 @ViewDebug.ExportedProperty 12069 public boolean isActivated() { 12070 return (mPrivateFlags & ACTIVATED) != 0; 12071 } 12072 12073 /** 12074 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 12075 * observer can be used to get notifications when global events, like 12076 * layout, happen. 12077 * 12078 * The returned ViewTreeObserver observer is not guaranteed to remain 12079 * valid for the lifetime of this View. If the caller of this method keeps 12080 * a long-lived reference to ViewTreeObserver, it should always check for 12081 * the return value of {@link ViewTreeObserver#isAlive()}. 12082 * 12083 * @return The ViewTreeObserver for this view's hierarchy. 12084 */ 12085 public ViewTreeObserver getViewTreeObserver() { 12086 if (mAttachInfo != null) { 12087 return mAttachInfo.mTreeObserver; 12088 } 12089 if (mFloatingTreeObserver == null) { 12090 mFloatingTreeObserver = new ViewTreeObserver(); 12091 } 12092 return mFloatingTreeObserver; 12093 } 12094 12095 /** 12096 * <p>Finds the topmost view in the current view hierarchy.</p> 12097 * 12098 * @return the topmost view containing this view 12099 */ 12100 public View getRootView() { 12101 if (mAttachInfo != null) { 12102 final View v = mAttachInfo.mRootView; 12103 if (v != null) { 12104 return v; 12105 } 12106 } 12107 12108 View parent = this; 12109 12110 while (parent.mParent != null && parent.mParent instanceof View) { 12111 parent = (View) parent.mParent; 12112 } 12113 12114 return parent; 12115 } 12116 12117 /** 12118 * <p>Computes the coordinates of this view on the screen. The argument 12119 * must be an array of two integers. After the method returns, the array 12120 * contains the x and y location in that order.</p> 12121 * 12122 * @param location an array of two integers in which to hold the coordinates 12123 */ 12124 public void getLocationOnScreen(int[] location) { 12125 getLocationInWindow(location); 12126 12127 final AttachInfo info = mAttachInfo; 12128 if (info != null) { 12129 location[0] += info.mWindowLeft; 12130 location[1] += info.mWindowTop; 12131 } 12132 } 12133 12134 /** 12135 * <p>Computes the coordinates of this view in its window. The argument 12136 * must be an array of two integers. After the method returns, the array 12137 * contains the x and y location in that order.</p> 12138 * 12139 * @param location an array of two integers in which to hold the coordinates 12140 */ 12141 public void getLocationInWindow(int[] location) { 12142 if (location == null || location.length < 2) { 12143 throw new IllegalArgumentException("location must be an array of two integers"); 12144 } 12145 12146 if (mAttachInfo == null) { 12147 // When the view is not attached to a window, this method does not make sense 12148 location[0] = location[1] = 0; 12149 return; 12150 } 12151 12152 float[] position = mAttachInfo.mTmpTransformLocation; 12153 position[0] = position[1] = 0.0f; 12154 12155 if (!hasIdentityMatrix()) { 12156 getMatrix().mapPoints(position); 12157 } 12158 12159 position[0] += mLeft; 12160 position[1] += mTop; 12161 12162 ViewParent viewParent = mParent; 12163 while (viewParent instanceof View) { 12164 final View view = (View) viewParent; 12165 12166 position[0] -= view.mScrollX; 12167 position[1] -= view.mScrollY; 12168 12169 if (!view.hasIdentityMatrix()) { 12170 view.getMatrix().mapPoints(position); 12171 } 12172 12173 position[0] += view.mLeft; 12174 position[1] += view.mTop; 12175 12176 viewParent = view.mParent; 12177 } 12178 12179 if (viewParent instanceof ViewRootImpl) { 12180 // *cough* 12181 final ViewRootImpl vr = (ViewRootImpl) viewParent; 12182 position[1] -= vr.mCurScrollY; 12183 } 12184 12185 location[0] = (int) (position[0] + 0.5f); 12186 location[1] = (int) (position[1] + 0.5f); 12187 } 12188 12189 /** 12190 * {@hide} 12191 * @param id the id of the view to be found 12192 * @return the view of the specified id, null if cannot be found 12193 */ 12194 protected View findViewTraversal(int id) { 12195 if (id == mID) { 12196 return this; 12197 } 12198 return null; 12199 } 12200 12201 /** 12202 * {@hide} 12203 * @param tag the tag of the view to be found 12204 * @return the view of specified tag, null if cannot be found 12205 */ 12206 protected View findViewWithTagTraversal(Object tag) { 12207 if (tag != null && tag.equals(mTag)) { 12208 return this; 12209 } 12210 return null; 12211 } 12212 12213 /** 12214 * {@hide} 12215 * @param predicate The predicate to evaluate. 12216 * @param childToSkip If not null, ignores this child during the recursive traversal. 12217 * @return The first view that matches the predicate or null. 12218 */ 12219 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) { 12220 if (predicate.apply(this)) { 12221 return this; 12222 } 12223 return null; 12224 } 12225 12226 /** 12227 * Look for a child view with the given id. If this view has the given 12228 * id, return this view. 12229 * 12230 * @param id The id to search for. 12231 * @return The view that has the given id in the hierarchy or null 12232 */ 12233 public final View findViewById(int id) { 12234 if (id < 0) { 12235 return null; 12236 } 12237 return findViewTraversal(id); 12238 } 12239 12240 /** 12241 * Finds a view by its unuque and stable accessibility id. 12242 * 12243 * @param accessibilityId The searched accessibility id. 12244 * @return The found view. 12245 */ 12246 final View findViewByAccessibilityId(int accessibilityId) { 12247 if (accessibilityId < 0) { 12248 return null; 12249 } 12250 return findViewByAccessibilityIdTraversal(accessibilityId); 12251 } 12252 12253 /** 12254 * Performs the traversal to find a view by its unuque and stable accessibility id. 12255 * 12256 * <strong>Note:</strong>This method does not stop at the root namespace 12257 * boundary since the user can touch the screen at an arbitrary location 12258 * potentially crossing the root namespace bounday which will send an 12259 * accessibility event to accessibility services and they should be able 12260 * to obtain the event source. Also accessibility ids are guaranteed to be 12261 * unique in the window. 12262 * 12263 * @param accessibilityId The accessibility id. 12264 * @return The found view. 12265 */ 12266 View findViewByAccessibilityIdTraversal(int accessibilityId) { 12267 if (getAccessibilityViewId() == accessibilityId) { 12268 return this; 12269 } 12270 return null; 12271 } 12272 12273 /** 12274 * Look for a child view with the given tag. If this view has the given 12275 * tag, return this view. 12276 * 12277 * @param tag The tag to search for, using "tag.equals(getTag())". 12278 * @return The View that has the given tag in the hierarchy or null 12279 */ 12280 public final View findViewWithTag(Object tag) { 12281 if (tag == null) { 12282 return null; 12283 } 12284 return findViewWithTagTraversal(tag); 12285 } 12286 12287 /** 12288 * {@hide} 12289 * Look for a child view that matches the specified predicate. 12290 * If this view matches the predicate, return this view. 12291 * 12292 * @param predicate The predicate to evaluate. 12293 * @return The first view that matches the predicate or null. 12294 */ 12295 public final View findViewByPredicate(Predicate<View> predicate) { 12296 return findViewByPredicateTraversal(predicate, null); 12297 } 12298 12299 /** 12300 * {@hide} 12301 * Look for a child view that matches the specified predicate, 12302 * starting with the specified view and its descendents and then 12303 * recusively searching the ancestors and siblings of that view 12304 * until this view is reached. 12305 * 12306 * This method is useful in cases where the predicate does not match 12307 * a single unique view (perhaps multiple views use the same id) 12308 * and we are trying to find the view that is "closest" in scope to the 12309 * starting view. 12310 * 12311 * @param start The view to start from. 12312 * @param predicate The predicate to evaluate. 12313 * @return The first view that matches the predicate or null. 12314 */ 12315 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) { 12316 View childToSkip = null; 12317 for (;;) { 12318 View view = start.findViewByPredicateTraversal(predicate, childToSkip); 12319 if (view != null || start == this) { 12320 return view; 12321 } 12322 12323 ViewParent parent = start.getParent(); 12324 if (parent == null || !(parent instanceof View)) { 12325 return null; 12326 } 12327 12328 childToSkip = start; 12329 start = (View) parent; 12330 } 12331 } 12332 12333 /** 12334 * Sets the identifier for this view. The identifier does not have to be 12335 * unique in this view's hierarchy. The identifier should be a positive 12336 * number. 12337 * 12338 * @see #NO_ID 12339 * @see #getId() 12340 * @see #findViewById(int) 12341 * 12342 * @param id a number used to identify the view 12343 * 12344 * @attr ref android.R.styleable#View_id 12345 */ 12346 public void setId(int id) { 12347 mID = id; 12348 } 12349 12350 /** 12351 * {@hide} 12352 * 12353 * @param isRoot true if the view belongs to the root namespace, false 12354 * otherwise 12355 */ 12356 public void setIsRootNamespace(boolean isRoot) { 12357 if (isRoot) { 12358 mPrivateFlags |= IS_ROOT_NAMESPACE; 12359 } else { 12360 mPrivateFlags &= ~IS_ROOT_NAMESPACE; 12361 } 12362 } 12363 12364 /** 12365 * {@hide} 12366 * 12367 * @return true if the view belongs to the root namespace, false otherwise 12368 */ 12369 public boolean isRootNamespace() { 12370 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0; 12371 } 12372 12373 /** 12374 * Returns this view's identifier. 12375 * 12376 * @return a positive integer used to identify the view or {@link #NO_ID} 12377 * if the view has no ID 12378 * 12379 * @see #setId(int) 12380 * @see #findViewById(int) 12381 * @attr ref android.R.styleable#View_id 12382 */ 12383 @ViewDebug.CapturedViewProperty 12384 public int getId() { 12385 return mID; 12386 } 12387 12388 /** 12389 * Returns this view's tag. 12390 * 12391 * @return the Object stored in this view as a tag 12392 * 12393 * @see #setTag(Object) 12394 * @see #getTag(int) 12395 */ 12396 @ViewDebug.ExportedProperty 12397 public Object getTag() { 12398 return mTag; 12399 } 12400 12401 /** 12402 * Sets the tag associated with this view. A tag can be used to mark 12403 * a view in its hierarchy and does not have to be unique within the 12404 * hierarchy. Tags can also be used to store data within a view without 12405 * resorting to another data structure. 12406 * 12407 * @param tag an Object to tag the view with 12408 * 12409 * @see #getTag() 12410 * @see #setTag(int, Object) 12411 */ 12412 public void setTag(final Object tag) { 12413 mTag = tag; 12414 } 12415 12416 /** 12417 * Returns the tag associated with this view and the specified key. 12418 * 12419 * @param key The key identifying the tag 12420 * 12421 * @return the Object stored in this view as a tag 12422 * 12423 * @see #setTag(int, Object) 12424 * @see #getTag() 12425 */ 12426 public Object getTag(int key) { 12427 if (mKeyedTags != null) return mKeyedTags.get(key); 12428 return null; 12429 } 12430 12431 /** 12432 * Sets a tag associated with this view and a key. A tag can be used 12433 * to mark a view in its hierarchy and does not have to be unique within 12434 * the hierarchy. Tags can also be used to store data within a view 12435 * without resorting to another data structure. 12436 * 12437 * The specified key should be an id declared in the resources of the 12438 * application to ensure it is unique (see the <a 12439 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 12440 * Keys identified as belonging to 12441 * the Android framework or not associated with any package will cause 12442 * an {@link IllegalArgumentException} to be thrown. 12443 * 12444 * @param key The key identifying the tag 12445 * @param tag An Object to tag the view with 12446 * 12447 * @throws IllegalArgumentException If they specified key is not valid 12448 * 12449 * @see #setTag(Object) 12450 * @see #getTag(int) 12451 */ 12452 public void setTag(int key, final Object tag) { 12453 // If the package id is 0x00 or 0x01, it's either an undefined package 12454 // or a framework id 12455 if ((key >>> 24) < 2) { 12456 throw new IllegalArgumentException("The key must be an application-specific " 12457 + "resource id."); 12458 } 12459 12460 setKeyedTag(key, tag); 12461 } 12462 12463 /** 12464 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 12465 * framework id. 12466 * 12467 * @hide 12468 */ 12469 public void setTagInternal(int key, Object tag) { 12470 if ((key >>> 24) != 0x1) { 12471 throw new IllegalArgumentException("The key must be a framework-specific " 12472 + "resource id."); 12473 } 12474 12475 setKeyedTag(key, tag); 12476 } 12477 12478 private void setKeyedTag(int key, Object tag) { 12479 if (mKeyedTags == null) { 12480 mKeyedTags = new SparseArray<Object>(); 12481 } 12482 12483 mKeyedTags.put(key, tag); 12484 } 12485 12486 /** 12487 * @param consistency The type of consistency. See ViewDebug for more information. 12488 * 12489 * @hide 12490 */ 12491 protected boolean dispatchConsistencyCheck(int consistency) { 12492 return onConsistencyCheck(consistency); 12493 } 12494 12495 /** 12496 * Method that subclasses should implement to check their consistency. The type of 12497 * consistency check is indicated by the bit field passed as a parameter. 12498 * 12499 * @param consistency The type of consistency. See ViewDebug for more information. 12500 * 12501 * @throws IllegalStateException if the view is in an inconsistent state. 12502 * 12503 * @hide 12504 */ 12505 protected boolean onConsistencyCheck(int consistency) { 12506 boolean result = true; 12507 12508 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0; 12509 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0; 12510 12511 if (checkLayout) { 12512 if (getParent() == null) { 12513 result = false; 12514 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 12515 "View " + this + " does not have a parent."); 12516 } 12517 12518 if (mAttachInfo == null) { 12519 result = false; 12520 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 12521 "View " + this + " is not attached to a window."); 12522 } 12523 } 12524 12525 if (checkDrawing) { 12526 // Do not check the DIRTY/DRAWN flags because views can call invalidate() 12527 // from their draw() method 12528 12529 if ((mPrivateFlags & DRAWN) != DRAWN && 12530 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) { 12531 result = false; 12532 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 12533 "View " + this + " was invalidated but its drawing cache is valid."); 12534 } 12535 } 12536 12537 return result; 12538 } 12539 12540 /** 12541 * Prints information about this view in the log output, with the tag 12542 * {@link #VIEW_LOG_TAG}. 12543 * 12544 * @hide 12545 */ 12546 public void debug() { 12547 debug(0); 12548 } 12549 12550 /** 12551 * Prints information about this view in the log output, with the tag 12552 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 12553 * indentation defined by the <code>depth</code>. 12554 * 12555 * @param depth the indentation level 12556 * 12557 * @hide 12558 */ 12559 protected void debug(int depth) { 12560 String output = debugIndent(depth - 1); 12561 12562 output += "+ " + this; 12563 int id = getId(); 12564 if (id != -1) { 12565 output += " (id=" + id + ")"; 12566 } 12567 Object tag = getTag(); 12568 if (tag != null) { 12569 output += " (tag=" + tag + ")"; 12570 } 12571 Log.d(VIEW_LOG_TAG, output); 12572 12573 if ((mPrivateFlags & FOCUSED) != 0) { 12574 output = debugIndent(depth) + " FOCUSED"; 12575 Log.d(VIEW_LOG_TAG, output); 12576 } 12577 12578 output = debugIndent(depth); 12579 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 12580 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 12581 + "} "; 12582 Log.d(VIEW_LOG_TAG, output); 12583 12584 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 12585 || mPaddingBottom != 0) { 12586 output = debugIndent(depth); 12587 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 12588 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 12589 Log.d(VIEW_LOG_TAG, output); 12590 } 12591 12592 output = debugIndent(depth); 12593 output += "mMeasureWidth=" + mMeasuredWidth + 12594 " mMeasureHeight=" + mMeasuredHeight; 12595 Log.d(VIEW_LOG_TAG, output); 12596 12597 output = debugIndent(depth); 12598 if (mLayoutParams == null) { 12599 output += "BAD! no layout params"; 12600 } else { 12601 output = mLayoutParams.debug(output); 12602 } 12603 Log.d(VIEW_LOG_TAG, output); 12604 12605 output = debugIndent(depth); 12606 output += "flags={"; 12607 output += View.printFlags(mViewFlags); 12608 output += "}"; 12609 Log.d(VIEW_LOG_TAG, output); 12610 12611 output = debugIndent(depth); 12612 output += "privateFlags={"; 12613 output += View.printPrivateFlags(mPrivateFlags); 12614 output += "}"; 12615 Log.d(VIEW_LOG_TAG, output); 12616 } 12617 12618 /** 12619 * Creates an string of whitespaces used for indentation. 12620 * 12621 * @param depth the indentation level 12622 * @return a String containing (depth * 2 + 3) * 2 white spaces 12623 * 12624 * @hide 12625 */ 12626 protected static String debugIndent(int depth) { 12627 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 12628 for (int i = 0; i < (depth * 2) + 3; i++) { 12629 spaces.append(' ').append(' '); 12630 } 12631 return spaces.toString(); 12632 } 12633 12634 /** 12635 * <p>Return the offset of the widget's text baseline from the widget's top 12636 * boundary. If this widget does not support baseline alignment, this 12637 * method returns -1. </p> 12638 * 12639 * @return the offset of the baseline within the widget's bounds or -1 12640 * if baseline alignment is not supported 12641 */ 12642 @ViewDebug.ExportedProperty(category = "layout") 12643 public int getBaseline() { 12644 return -1; 12645 } 12646 12647 /** 12648 * Call this when something has changed which has invalidated the 12649 * layout of this view. This will schedule a layout pass of the view 12650 * tree. 12651 */ 12652 public void requestLayout() { 12653 if (ViewDebug.TRACE_HIERARCHY) { 12654 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT); 12655 } 12656 12657 mPrivateFlags |= FORCE_LAYOUT; 12658 mPrivateFlags |= INVALIDATED; 12659 12660 if (mParent != null) { 12661 if (mLayoutParams != null) { 12662 mLayoutParams.resolveWithDirection(getResolvedLayoutDirection()); 12663 } 12664 if (!mParent.isLayoutRequested()) { 12665 mParent.requestLayout(); 12666 } 12667 } 12668 } 12669 12670 /** 12671 * Forces this view to be laid out during the next layout pass. 12672 * This method does not call requestLayout() or forceLayout() 12673 * on the parent. 12674 */ 12675 public void forceLayout() { 12676 mPrivateFlags |= FORCE_LAYOUT; 12677 mPrivateFlags |= INVALIDATED; 12678 } 12679 12680 /** 12681 * <p> 12682 * This is called to find out how big a view should be. The parent 12683 * supplies constraint information in the width and height parameters. 12684 * </p> 12685 * 12686 * <p> 12687 * The actual mesurement work of a view is performed in 12688 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 12689 * {@link #onMeasure(int, int)} can and must be overriden by subclasses. 12690 * </p> 12691 * 12692 * 12693 * @param widthMeasureSpec Horizontal space requirements as imposed by the 12694 * parent 12695 * @param heightMeasureSpec Vertical space requirements as imposed by the 12696 * parent 12697 * 12698 * @see #onMeasure(int, int) 12699 */ 12700 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 12701 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT || 12702 widthMeasureSpec != mOldWidthMeasureSpec || 12703 heightMeasureSpec != mOldHeightMeasureSpec) { 12704 12705 // first clears the measured dimension flag 12706 mPrivateFlags &= ~MEASURED_DIMENSION_SET; 12707 12708 if (ViewDebug.TRACE_HIERARCHY) { 12709 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE); 12710 } 12711 12712 // measure ourselves, this should set the measured dimension flag back 12713 onMeasure(widthMeasureSpec, heightMeasureSpec); 12714 12715 // flag not set, setMeasuredDimension() was not invoked, we raise 12716 // an exception to warn the developer 12717 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) { 12718 throw new IllegalStateException("onMeasure() did not set the" 12719 + " measured dimension by calling" 12720 + " setMeasuredDimension()"); 12721 } 12722 12723 mPrivateFlags |= LAYOUT_REQUIRED; 12724 } 12725 12726 mOldWidthMeasureSpec = widthMeasureSpec; 12727 mOldHeightMeasureSpec = heightMeasureSpec; 12728 } 12729 12730 /** 12731 * <p> 12732 * Measure the view and its content to determine the measured width and the 12733 * measured height. This method is invoked by {@link #measure(int, int)} and 12734 * should be overriden by subclasses to provide accurate and efficient 12735 * measurement of their contents. 12736 * </p> 12737 * 12738 * <p> 12739 * <strong>CONTRACT:</strong> When overriding this method, you 12740 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 12741 * measured width and height of this view. Failure to do so will trigger an 12742 * <code>IllegalStateException</code>, thrown by 12743 * {@link #measure(int, int)}. Calling the superclass' 12744 * {@link #onMeasure(int, int)} is a valid use. 12745 * </p> 12746 * 12747 * <p> 12748 * The base class implementation of measure defaults to the background size, 12749 * unless a larger size is allowed by the MeasureSpec. Subclasses should 12750 * override {@link #onMeasure(int, int)} to provide better measurements of 12751 * their content. 12752 * </p> 12753 * 12754 * <p> 12755 * If this method is overridden, it is the subclass's responsibility to make 12756 * sure the measured height and width are at least the view's minimum height 12757 * and width ({@link #getSuggestedMinimumHeight()} and 12758 * {@link #getSuggestedMinimumWidth()}). 12759 * </p> 12760 * 12761 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 12762 * The requirements are encoded with 12763 * {@link android.view.View.MeasureSpec}. 12764 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 12765 * The requirements are encoded with 12766 * {@link android.view.View.MeasureSpec}. 12767 * 12768 * @see #getMeasuredWidth() 12769 * @see #getMeasuredHeight() 12770 * @see #setMeasuredDimension(int, int) 12771 * @see #getSuggestedMinimumHeight() 12772 * @see #getSuggestedMinimumWidth() 12773 * @see android.view.View.MeasureSpec#getMode(int) 12774 * @see android.view.View.MeasureSpec#getSize(int) 12775 */ 12776 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 12777 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 12778 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 12779 } 12780 12781 /** 12782 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the 12783 * measured width and measured height. Failing to do so will trigger an 12784 * exception at measurement time.</p> 12785 * 12786 * @param measuredWidth The measured width of this view. May be a complex 12787 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 12788 * {@link #MEASURED_STATE_TOO_SMALL}. 12789 * @param measuredHeight The measured height of this view. May be a complex 12790 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 12791 * {@link #MEASURED_STATE_TOO_SMALL}. 12792 */ 12793 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 12794 mMeasuredWidth = measuredWidth; 12795 mMeasuredHeight = measuredHeight; 12796 12797 mPrivateFlags |= MEASURED_DIMENSION_SET; 12798 } 12799 12800 /** 12801 * Merge two states as returned by {@link #getMeasuredState()}. 12802 * @param curState The current state as returned from a view or the result 12803 * of combining multiple views. 12804 * @param newState The new view state to combine. 12805 * @return Returns a new integer reflecting the combination of the two 12806 * states. 12807 */ 12808 public static int combineMeasuredStates(int curState, int newState) { 12809 return curState | newState; 12810 } 12811 12812 /** 12813 * Version of {@link #resolveSizeAndState(int, int, int)} 12814 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 12815 */ 12816 public static int resolveSize(int size, int measureSpec) { 12817 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 12818 } 12819 12820 /** 12821 * Utility to reconcile a desired size and state, with constraints imposed 12822 * by a MeasureSpec. Will take the desired size, unless a different size 12823 * is imposed by the constraints. The returned value is a compound integer, 12824 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 12825 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 12826 * size is smaller than the size the view wants to be. 12827 * 12828 * @param size How big the view wants to be 12829 * @param measureSpec Constraints imposed by the parent 12830 * @return Size information bit mask as defined by 12831 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 12832 */ 12833 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 12834 int result = size; 12835 int specMode = MeasureSpec.getMode(measureSpec); 12836 int specSize = MeasureSpec.getSize(measureSpec); 12837 switch (specMode) { 12838 case MeasureSpec.UNSPECIFIED: 12839 result = size; 12840 break; 12841 case MeasureSpec.AT_MOST: 12842 if (specSize < size) { 12843 result = specSize | MEASURED_STATE_TOO_SMALL; 12844 } else { 12845 result = size; 12846 } 12847 break; 12848 case MeasureSpec.EXACTLY: 12849 result = specSize; 12850 break; 12851 } 12852 return result | (childMeasuredState&MEASURED_STATE_MASK); 12853 } 12854 12855 /** 12856 * Utility to return a default size. Uses the supplied size if the 12857 * MeasureSpec imposed no constraints. Will get larger if allowed 12858 * by the MeasureSpec. 12859 * 12860 * @param size Default size for this view 12861 * @param measureSpec Constraints imposed by the parent 12862 * @return The size this view should be. 12863 */ 12864 public static int getDefaultSize(int size, int measureSpec) { 12865 int result = size; 12866 int specMode = MeasureSpec.getMode(measureSpec); 12867 int specSize = MeasureSpec.getSize(measureSpec); 12868 12869 switch (specMode) { 12870 case MeasureSpec.UNSPECIFIED: 12871 result = size; 12872 break; 12873 case MeasureSpec.AT_MOST: 12874 case MeasureSpec.EXACTLY: 12875 result = specSize; 12876 break; 12877 } 12878 return result; 12879 } 12880 12881 /** 12882 * Returns the suggested minimum height that the view should use. This 12883 * returns the maximum of the view's minimum height 12884 * and the background's minimum height 12885 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 12886 * <p> 12887 * When being used in {@link #onMeasure(int, int)}, the caller should still 12888 * ensure the returned height is within the requirements of the parent. 12889 * 12890 * @return The suggested minimum height of the view. 12891 */ 12892 protected int getSuggestedMinimumHeight() { 12893 int suggestedMinHeight = mMinHeight; 12894 12895 if (mBGDrawable != null) { 12896 final int bgMinHeight = mBGDrawable.getMinimumHeight(); 12897 if (suggestedMinHeight < bgMinHeight) { 12898 suggestedMinHeight = bgMinHeight; 12899 } 12900 } 12901 12902 return suggestedMinHeight; 12903 } 12904 12905 /** 12906 * Returns the suggested minimum width that the view should use. This 12907 * returns the maximum of the view's minimum width) 12908 * and the background's minimum width 12909 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 12910 * <p> 12911 * When being used in {@link #onMeasure(int, int)}, the caller should still 12912 * ensure the returned width is within the requirements of the parent. 12913 * 12914 * @return The suggested minimum width of the view. 12915 */ 12916 protected int getSuggestedMinimumWidth() { 12917 int suggestedMinWidth = mMinWidth; 12918 12919 if (mBGDrawable != null) { 12920 final int bgMinWidth = mBGDrawable.getMinimumWidth(); 12921 if (suggestedMinWidth < bgMinWidth) { 12922 suggestedMinWidth = bgMinWidth; 12923 } 12924 } 12925 12926 return suggestedMinWidth; 12927 } 12928 12929 /** 12930 * Sets the minimum height of the view. It is not guaranteed the view will 12931 * be able to achieve this minimum height (for example, if its parent layout 12932 * constrains it with less available height). 12933 * 12934 * @param minHeight The minimum height the view will try to be. 12935 */ 12936 public void setMinimumHeight(int minHeight) { 12937 mMinHeight = minHeight; 12938 } 12939 12940 /** 12941 * Sets the minimum width of the view. It is not guaranteed the view will 12942 * be able to achieve this minimum width (for example, if its parent layout 12943 * constrains it with less available width). 12944 * 12945 * @param minWidth The minimum width the view will try to be. 12946 */ 12947 public void setMinimumWidth(int minWidth) { 12948 mMinWidth = minWidth; 12949 } 12950 12951 /** 12952 * Get the animation currently associated with this view. 12953 * 12954 * @return The animation that is currently playing or 12955 * scheduled to play for this view. 12956 */ 12957 public Animation getAnimation() { 12958 return mCurrentAnimation; 12959 } 12960 12961 /** 12962 * Start the specified animation now. 12963 * 12964 * @param animation the animation to start now 12965 */ 12966 public void startAnimation(Animation animation) { 12967 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 12968 setAnimation(animation); 12969 invalidateParentCaches(); 12970 invalidate(true); 12971 } 12972 12973 /** 12974 * Cancels any animations for this view. 12975 */ 12976 public void clearAnimation() { 12977 if (mCurrentAnimation != null) { 12978 mCurrentAnimation.detach(); 12979 } 12980 mCurrentAnimation = null; 12981 invalidateParentIfNeeded(); 12982 } 12983 12984 /** 12985 * Sets the next animation to play for this view. 12986 * If you want the animation to play immediately, use 12987 * startAnimation. This method provides allows fine-grained 12988 * control over the start time and invalidation, but you 12989 * must make sure that 1) the animation has a start time set, and 12990 * 2) the view will be invalidated when the animation is supposed to 12991 * start. 12992 * 12993 * @param animation The next animation, or null. 12994 */ 12995 public void setAnimation(Animation animation) { 12996 mCurrentAnimation = animation; 12997 if (animation != null) { 12998 animation.reset(); 12999 } 13000 } 13001 13002 /** 13003 * Invoked by a parent ViewGroup to notify the start of the animation 13004 * currently associated with this view. If you override this method, 13005 * always call super.onAnimationStart(); 13006 * 13007 * @see #setAnimation(android.view.animation.Animation) 13008 * @see #getAnimation() 13009 */ 13010 protected void onAnimationStart() { 13011 mPrivateFlags |= ANIMATION_STARTED; 13012 } 13013 13014 /** 13015 * Invoked by a parent ViewGroup to notify the end of the animation 13016 * currently associated with this view. If you override this method, 13017 * always call super.onAnimationEnd(); 13018 * 13019 * @see #setAnimation(android.view.animation.Animation) 13020 * @see #getAnimation() 13021 */ 13022 protected void onAnimationEnd() { 13023 mPrivateFlags &= ~ANIMATION_STARTED; 13024 } 13025 13026 /** 13027 * Invoked if there is a Transform that involves alpha. Subclass that can 13028 * draw themselves with the specified alpha should return true, and then 13029 * respect that alpha when their onDraw() is called. If this returns false 13030 * then the view may be redirected to draw into an offscreen buffer to 13031 * fulfill the request, which will look fine, but may be slower than if the 13032 * subclass handles it internally. The default implementation returns false. 13033 * 13034 * @param alpha The alpha (0..255) to apply to the view's drawing 13035 * @return true if the view can draw with the specified alpha. 13036 */ 13037 protected boolean onSetAlpha(int alpha) { 13038 return false; 13039 } 13040 13041 /** 13042 * This is used by the RootView to perform an optimization when 13043 * the view hierarchy contains one or several SurfaceView. 13044 * SurfaceView is always considered transparent, but its children are not, 13045 * therefore all View objects remove themselves from the global transparent 13046 * region (passed as a parameter to this function). 13047 * 13048 * @param region The transparent region for this ViewAncestor (window). 13049 * 13050 * @return Returns true if the effective visibility of the view at this 13051 * point is opaque, regardless of the transparent region; returns false 13052 * if it is possible for underlying windows to be seen behind the view. 13053 * 13054 * {@hide} 13055 */ 13056 public boolean gatherTransparentRegion(Region region) { 13057 final AttachInfo attachInfo = mAttachInfo; 13058 if (region != null && attachInfo != null) { 13059 final int pflags = mPrivateFlags; 13060 if ((pflags & SKIP_DRAW) == 0) { 13061 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 13062 // remove it from the transparent region. 13063 final int[] location = attachInfo.mTransparentLocation; 13064 getLocationInWindow(location); 13065 region.op(location[0], location[1], location[0] + mRight - mLeft, 13066 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 13067 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) { 13068 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 13069 // exists, so we remove the background drawable's non-transparent 13070 // parts from this transparent region. 13071 applyDrawableToTransparentRegion(mBGDrawable, region); 13072 } 13073 } 13074 return true; 13075 } 13076 13077 /** 13078 * Play a sound effect for this view. 13079 * 13080 * <p>The framework will play sound effects for some built in actions, such as 13081 * clicking, but you may wish to play these effects in your widget, 13082 * for instance, for internal navigation. 13083 * 13084 * <p>The sound effect will only be played if sound effects are enabled by the user, and 13085 * {@link #isSoundEffectsEnabled()} is true. 13086 * 13087 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 13088 */ 13089 public void playSoundEffect(int soundConstant) { 13090 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 13091 return; 13092 } 13093 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 13094 } 13095 13096 /** 13097 * BZZZTT!!1! 13098 * 13099 * <p>Provide haptic feedback to the user for this view. 13100 * 13101 * <p>The framework will provide haptic feedback for some built in actions, 13102 * such as long presses, but you may wish to provide feedback for your 13103 * own widget. 13104 * 13105 * <p>The feedback will only be performed if 13106 * {@link #isHapticFeedbackEnabled()} is true. 13107 * 13108 * @param feedbackConstant One of the constants defined in 13109 * {@link HapticFeedbackConstants} 13110 */ 13111 public boolean performHapticFeedback(int feedbackConstant) { 13112 return performHapticFeedback(feedbackConstant, 0); 13113 } 13114 13115 /** 13116 * BZZZTT!!1! 13117 * 13118 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 13119 * 13120 * @param feedbackConstant One of the constants defined in 13121 * {@link HapticFeedbackConstants} 13122 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 13123 */ 13124 public boolean performHapticFeedback(int feedbackConstant, int flags) { 13125 if (mAttachInfo == null) { 13126 return false; 13127 } 13128 //noinspection SimplifiableIfStatement 13129 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 13130 && !isHapticFeedbackEnabled()) { 13131 return false; 13132 } 13133 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 13134 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 13135 } 13136 13137 /** 13138 * Request that the visibility of the status bar be changed. 13139 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or 13140 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}. 13141 */ 13142 public void setSystemUiVisibility(int visibility) { 13143 if (visibility != mSystemUiVisibility) { 13144 mSystemUiVisibility = visibility; 13145 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 13146 mParent.recomputeViewAttributes(this); 13147 } 13148 } 13149 } 13150 13151 /** 13152 * Returns the status bar visibility that this view has requested. 13153 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or 13154 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}. 13155 */ 13156 public int getSystemUiVisibility() { 13157 return mSystemUiVisibility; 13158 } 13159 13160 /** 13161 * Set a listener to receive callbacks when the visibility of the system bar changes. 13162 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks. 13163 */ 13164 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 13165 getListenerInfo().mOnSystemUiVisibilityChangeListener = l; 13166 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 13167 mParent.recomputeViewAttributes(this); 13168 } 13169 } 13170 13171 /** 13172 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down 13173 * the view hierarchy. 13174 */ 13175 public void dispatchSystemUiVisibilityChanged(int visibility) { 13176 ListenerInfo li = mListenerInfo; 13177 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) { 13178 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange( 13179 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK); 13180 } 13181 } 13182 13183 void updateLocalSystemUiVisibility(int localValue, int localChanges) { 13184 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges); 13185 if (val != mSystemUiVisibility) { 13186 setSystemUiVisibility(val); 13187 } 13188 } 13189 13190 /** 13191 * Creates an image that the system displays during the drag and drop 13192 * operation. This is called a "drag shadow". The default implementation 13193 * for a DragShadowBuilder based on a View returns an image that has exactly the same 13194 * appearance as the given View. The default also positions the center of the drag shadow 13195 * directly under the touch point. If no View is provided (the constructor with no parameters 13196 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and 13197 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the 13198 * default is an invisible drag shadow. 13199 * <p> 13200 * You are not required to use the View you provide to the constructor as the basis of the 13201 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw 13202 * anything you want as the drag shadow. 13203 * </p> 13204 * <p> 13205 * You pass a DragShadowBuilder object to the system when you start the drag. The system 13206 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the 13207 * size and position of the drag shadow. It uses this data to construct a 13208 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} 13209 * so that your application can draw the shadow image in the Canvas. 13210 * </p> 13211 * 13212 * <div class="special reference"> 13213 * <h3>Developer Guides</h3> 13214 * <p>For a guide to implementing drag and drop features, read the 13215 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 13216 * </div> 13217 */ 13218 public static class DragShadowBuilder { 13219 private final WeakReference<View> mView; 13220 13221 /** 13222 * Constructs a shadow image builder based on a View. By default, the resulting drag 13223 * shadow will have the same appearance and dimensions as the View, with the touch point 13224 * over the center of the View. 13225 * @param view A View. Any View in scope can be used. 13226 */ 13227 public DragShadowBuilder(View view) { 13228 mView = new WeakReference<View>(view); 13229 } 13230 13231 /** 13232 * Construct a shadow builder object with no associated View. This 13233 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 13234 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 13235 * to supply the drag shadow's dimensions and appearance without 13236 * reference to any View object. If they are not overridden, then the result is an 13237 * invisible drag shadow. 13238 */ 13239 public DragShadowBuilder() { 13240 mView = new WeakReference<View>(null); 13241 } 13242 13243 /** 13244 * Returns the View object that had been passed to the 13245 * {@link #View.DragShadowBuilder(View)} 13246 * constructor. If that View parameter was {@code null} or if the 13247 * {@link #View.DragShadowBuilder()} 13248 * constructor was used to instantiate the builder object, this method will return 13249 * null. 13250 * 13251 * @return The View object associate with this builder object. 13252 */ 13253 @SuppressWarnings({"JavadocReference"}) 13254 final public View getView() { 13255 return mView.get(); 13256 } 13257 13258 /** 13259 * Provides the metrics for the shadow image. These include the dimensions of 13260 * the shadow image, and the point within that shadow that should 13261 * be centered under the touch location while dragging. 13262 * <p> 13263 * The default implementation sets the dimensions of the shadow to be the 13264 * same as the dimensions of the View itself and centers the shadow under 13265 * the touch point. 13266 * </p> 13267 * 13268 * @param shadowSize A {@link android.graphics.Point} containing the width and height 13269 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the 13270 * desired width and must set {@link android.graphics.Point#y} to the desired height of the 13271 * image. 13272 * 13273 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the 13274 * shadow image that should be underneath the touch point during the drag and drop 13275 * operation. Your application must set {@link android.graphics.Point#x} to the 13276 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position. 13277 */ 13278 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 13279 final View view = mView.get(); 13280 if (view != null) { 13281 shadowSize.set(view.getWidth(), view.getHeight()); 13282 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 13283 } else { 13284 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 13285 } 13286 } 13287 13288 /** 13289 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object 13290 * based on the dimensions it received from the 13291 * {@link #onProvideShadowMetrics(Point, Point)} callback. 13292 * 13293 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image. 13294 */ 13295 public void onDrawShadow(Canvas canvas) { 13296 final View view = mView.get(); 13297 if (view != null) { 13298 view.draw(canvas); 13299 } else { 13300 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 13301 } 13302 } 13303 } 13304 13305 /** 13306 * Starts a drag and drop operation. When your application calls this method, it passes a 13307 * {@link android.view.View.DragShadowBuilder} object to the system. The 13308 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} 13309 * to get metrics for the drag shadow, and then calls the object's 13310 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself. 13311 * <p> 13312 * Once the system has the drag shadow, it begins the drag and drop operation by sending 13313 * drag events to all the View objects in your application that are currently visible. It does 13314 * this either by calling the View object's drag listener (an implementation of 13315 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the 13316 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method. 13317 * Both are passed a {@link android.view.DragEvent} object that has a 13318 * {@link android.view.DragEvent#getAction()} value of 13319 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}. 13320 * </p> 13321 * <p> 13322 * Your application can invoke startDrag() on any attached View object. The View object does not 13323 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to 13324 * be related to the View the user selected for dragging. 13325 * </p> 13326 * @param data A {@link android.content.ClipData} object pointing to the data to be 13327 * transferred by the drag and drop operation. 13328 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the 13329 * drag shadow. 13330 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and 13331 * drop operation. This Object is put into every DragEvent object sent by the system during the 13332 * current drag. 13333 * <p> 13334 * myLocalState is a lightweight mechanism for the sending information from the dragged View 13335 * to the target Views. For example, it can contain flags that differentiate between a 13336 * a copy operation and a move operation. 13337 * </p> 13338 * @param flags Flags that control the drag and drop operation. No flags are currently defined, 13339 * so the parameter should be set to 0. 13340 * @return {@code true} if the method completes successfully, or 13341 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to 13342 * do a drag, and so no drag operation is in progress. 13343 */ 13344 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 13345 Object myLocalState, int flags) { 13346 if (ViewDebug.DEBUG_DRAG) { 13347 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 13348 } 13349 boolean okay = false; 13350 13351 Point shadowSize = new Point(); 13352 Point shadowTouchPoint = new Point(); 13353 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 13354 13355 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 13356 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 13357 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 13358 } 13359 13360 if (ViewDebug.DEBUG_DRAG) { 13361 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 13362 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 13363 } 13364 Surface surface = new Surface(); 13365 try { 13366 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 13367 flags, shadowSize.x, shadowSize.y, surface); 13368 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 13369 + " surface=" + surface); 13370 if (token != null) { 13371 Canvas canvas = surface.lockCanvas(null); 13372 try { 13373 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 13374 shadowBuilder.onDrawShadow(canvas); 13375 } finally { 13376 surface.unlockCanvasAndPost(canvas); 13377 } 13378 13379 final ViewRootImpl root = getViewRootImpl(); 13380 13381 // Cache the local state object for delivery with DragEvents 13382 root.setLocalDragState(myLocalState); 13383 13384 // repurpose 'shadowSize' for the last touch point 13385 root.getLastTouchPoint(shadowSize); 13386 13387 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 13388 shadowSize.x, shadowSize.y, 13389 shadowTouchPoint.x, shadowTouchPoint.y, data); 13390 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 13391 13392 // Off and running! Release our local surface instance; the drag 13393 // shadow surface is now managed by the system process. 13394 surface.release(); 13395 } 13396 } catch (Exception e) { 13397 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 13398 surface.destroy(); 13399 } 13400 13401 return okay; 13402 } 13403 13404 /** 13405 * Handles drag events sent by the system following a call to 13406 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}. 13407 *<p> 13408 * When the system calls this method, it passes a 13409 * {@link android.view.DragEvent} object. A call to 13410 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined 13411 * in DragEvent. The method uses these to determine what is happening in the drag and drop 13412 * operation. 13413 * @param event The {@link android.view.DragEvent} sent by the system. 13414 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined 13415 * in DragEvent, indicating the type of drag event represented by this object. 13416 * @return {@code true} if the method was successful, otherwise {@code false}. 13417 * <p> 13418 * The method should return {@code true} in response to an action type of 13419 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current 13420 * operation. 13421 * </p> 13422 * <p> 13423 * The method should also return {@code true} in response to an action type of 13424 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or 13425 * {@code false} if it didn't. 13426 * </p> 13427 */ 13428 public boolean onDragEvent(DragEvent event) { 13429 return false; 13430 } 13431 13432 /** 13433 * Detects if this View is enabled and has a drag event listener. 13434 * If both are true, then it calls the drag event listener with the 13435 * {@link android.view.DragEvent} it received. If the drag event listener returns 13436 * {@code true}, then dispatchDragEvent() returns {@code true}. 13437 * <p> 13438 * For all other cases, the method calls the 13439 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler 13440 * method and returns its result. 13441 * </p> 13442 * <p> 13443 * This ensures that a drag event is always consumed, even if the View does not have a drag 13444 * event listener. However, if the View has a listener and the listener returns true, then 13445 * onDragEvent() is not called. 13446 * </p> 13447 */ 13448 public boolean dispatchDragEvent(DragEvent event) { 13449 //noinspection SimplifiableIfStatement 13450 ListenerInfo li = mListenerInfo; 13451 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 13452 && li.mOnDragListener.onDrag(this, event)) { 13453 return true; 13454 } 13455 return onDragEvent(event); 13456 } 13457 13458 boolean canAcceptDrag() { 13459 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0; 13460 } 13461 13462 /** 13463 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 13464 * it is ever exposed at all. 13465 * @hide 13466 */ 13467 public void onCloseSystemDialogs(String reason) { 13468 } 13469 13470 /** 13471 * Given a Drawable whose bounds have been set to draw into this view, 13472 * update a Region being computed for 13473 * {@link #gatherTransparentRegion(android.graphics.Region)} so 13474 * that any non-transparent parts of the Drawable are removed from the 13475 * given transparent region. 13476 * 13477 * @param dr The Drawable whose transparency is to be applied to the region. 13478 * @param region A Region holding the current transparency information, 13479 * where any parts of the region that are set are considered to be 13480 * transparent. On return, this region will be modified to have the 13481 * transparency information reduced by the corresponding parts of the 13482 * Drawable that are not transparent. 13483 * {@hide} 13484 */ 13485 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 13486 if (DBG) { 13487 Log.i("View", "Getting transparent region for: " + this); 13488 } 13489 final Region r = dr.getTransparentRegion(); 13490 final Rect db = dr.getBounds(); 13491 final AttachInfo attachInfo = mAttachInfo; 13492 if (r != null && attachInfo != null) { 13493 final int w = getRight()-getLeft(); 13494 final int h = getBottom()-getTop(); 13495 if (db.left > 0) { 13496 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 13497 r.op(0, 0, db.left, h, Region.Op.UNION); 13498 } 13499 if (db.right < w) { 13500 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 13501 r.op(db.right, 0, w, h, Region.Op.UNION); 13502 } 13503 if (db.top > 0) { 13504 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 13505 r.op(0, 0, w, db.top, Region.Op.UNION); 13506 } 13507 if (db.bottom < h) { 13508 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 13509 r.op(0, db.bottom, w, h, Region.Op.UNION); 13510 } 13511 final int[] location = attachInfo.mTransparentLocation; 13512 getLocationInWindow(location); 13513 r.translate(location[0], location[1]); 13514 region.op(r, Region.Op.INTERSECT); 13515 } else { 13516 region.op(db, Region.Op.DIFFERENCE); 13517 } 13518 } 13519 13520 private void checkForLongClick(int delayOffset) { 13521 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 13522 mHasPerformedLongPress = false; 13523 13524 if (mPendingCheckForLongPress == null) { 13525 mPendingCheckForLongPress = new CheckForLongPress(); 13526 } 13527 mPendingCheckForLongPress.rememberWindowAttachCount(); 13528 postDelayed(mPendingCheckForLongPress, 13529 ViewConfiguration.getLongPressTimeout() - delayOffset); 13530 } 13531 } 13532 13533 /** 13534 * Inflate a view from an XML resource. This convenience method wraps the {@link 13535 * LayoutInflater} class, which provides a full range of options for view inflation. 13536 * 13537 * @param context The Context object for your activity or application. 13538 * @param resource The resource ID to inflate 13539 * @param root A view group that will be the parent. Used to properly inflate the 13540 * layout_* parameters. 13541 * @see LayoutInflater 13542 */ 13543 public static View inflate(Context context, int resource, ViewGroup root) { 13544 LayoutInflater factory = LayoutInflater.from(context); 13545 return factory.inflate(resource, root); 13546 } 13547 13548 /** 13549 * Scroll the view with standard behavior for scrolling beyond the normal 13550 * content boundaries. Views that call this method should override 13551 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 13552 * results of an over-scroll operation. 13553 * 13554 * Views can use this method to handle any touch or fling-based scrolling. 13555 * 13556 * @param deltaX Change in X in pixels 13557 * @param deltaY Change in Y in pixels 13558 * @param scrollX Current X scroll value in pixels before applying deltaX 13559 * @param scrollY Current Y scroll value in pixels before applying deltaY 13560 * @param scrollRangeX Maximum content scroll range along the X axis 13561 * @param scrollRangeY Maximum content scroll range along the Y axis 13562 * @param maxOverScrollX Number of pixels to overscroll by in either direction 13563 * along the X axis. 13564 * @param maxOverScrollY Number of pixels to overscroll by in either direction 13565 * along the Y axis. 13566 * @param isTouchEvent true if this scroll operation is the result of a touch event. 13567 * @return true if scrolling was clamped to an over-scroll boundary along either 13568 * axis, false otherwise. 13569 */ 13570 @SuppressWarnings({"UnusedParameters"}) 13571 protected boolean overScrollBy(int deltaX, int deltaY, 13572 int scrollX, int scrollY, 13573 int scrollRangeX, int scrollRangeY, 13574 int maxOverScrollX, int maxOverScrollY, 13575 boolean isTouchEvent) { 13576 final int overScrollMode = mOverScrollMode; 13577 final boolean canScrollHorizontal = 13578 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 13579 final boolean canScrollVertical = 13580 computeVerticalScrollRange() > computeVerticalScrollExtent(); 13581 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 13582 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 13583 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 13584 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 13585 13586 int newScrollX = scrollX + deltaX; 13587 if (!overScrollHorizontal) { 13588 maxOverScrollX = 0; 13589 } 13590 13591 int newScrollY = scrollY + deltaY; 13592 if (!overScrollVertical) { 13593 maxOverScrollY = 0; 13594 } 13595 13596 // Clamp values if at the limits and record 13597 final int left = -maxOverScrollX; 13598 final int right = maxOverScrollX + scrollRangeX; 13599 final int top = -maxOverScrollY; 13600 final int bottom = maxOverScrollY + scrollRangeY; 13601 13602 boolean clampedX = false; 13603 if (newScrollX > right) { 13604 newScrollX = right; 13605 clampedX = true; 13606 } else if (newScrollX < left) { 13607 newScrollX = left; 13608 clampedX = true; 13609 } 13610 13611 boolean clampedY = false; 13612 if (newScrollY > bottom) { 13613 newScrollY = bottom; 13614 clampedY = true; 13615 } else if (newScrollY < top) { 13616 newScrollY = top; 13617 clampedY = true; 13618 } 13619 13620 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 13621 13622 return clampedX || clampedY; 13623 } 13624 13625 /** 13626 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 13627 * respond to the results of an over-scroll operation. 13628 * 13629 * @param scrollX New X scroll value in pixels 13630 * @param scrollY New Y scroll value in pixels 13631 * @param clampedX True if scrollX was clamped to an over-scroll boundary 13632 * @param clampedY True if scrollY was clamped to an over-scroll boundary 13633 */ 13634 protected void onOverScrolled(int scrollX, int scrollY, 13635 boolean clampedX, boolean clampedY) { 13636 // Intentionally empty. 13637 } 13638 13639 /** 13640 * Returns the over-scroll mode for this view. The result will be 13641 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 13642 * (allow over-scrolling only if the view content is larger than the container), 13643 * or {@link #OVER_SCROLL_NEVER}. 13644 * 13645 * @return This view's over-scroll mode. 13646 */ 13647 public int getOverScrollMode() { 13648 return mOverScrollMode; 13649 } 13650 13651 /** 13652 * Set the over-scroll mode for this view. Valid over-scroll modes are 13653 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 13654 * (allow over-scrolling only if the view content is larger than the container), 13655 * or {@link #OVER_SCROLL_NEVER}. 13656 * 13657 * Setting the over-scroll mode of a view will have an effect only if the 13658 * view is capable of scrolling. 13659 * 13660 * @param overScrollMode The new over-scroll mode for this view. 13661 */ 13662 public void setOverScrollMode(int overScrollMode) { 13663 if (overScrollMode != OVER_SCROLL_ALWAYS && 13664 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 13665 overScrollMode != OVER_SCROLL_NEVER) { 13666 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 13667 } 13668 mOverScrollMode = overScrollMode; 13669 } 13670 13671 /** 13672 * Gets a scale factor that determines the distance the view should scroll 13673 * vertically in response to {@link MotionEvent#ACTION_SCROLL}. 13674 * @return The vertical scroll scale factor. 13675 * @hide 13676 */ 13677 protected float getVerticalScrollFactor() { 13678 if (mVerticalScrollFactor == 0) { 13679 TypedValue outValue = new TypedValue(); 13680 if (!mContext.getTheme().resolveAttribute( 13681 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) { 13682 throw new IllegalStateException( 13683 "Expected theme to define listPreferredItemHeight."); 13684 } 13685 mVerticalScrollFactor = outValue.getDimension( 13686 mContext.getResources().getDisplayMetrics()); 13687 } 13688 return mVerticalScrollFactor; 13689 } 13690 13691 /** 13692 * Gets a scale factor that determines the distance the view should scroll 13693 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}. 13694 * @return The horizontal scroll scale factor. 13695 * @hide 13696 */ 13697 protected float getHorizontalScrollFactor() { 13698 // TODO: Should use something else. 13699 return getVerticalScrollFactor(); 13700 } 13701 13702 /** 13703 * Return the value specifying the text direction or policy that was set with 13704 * {@link #setTextDirection(int)}. 13705 * 13706 * @return the defined text direction. It can be one of: 13707 * 13708 * {@link #TEXT_DIRECTION_INHERIT}, 13709 * {@link #TEXT_DIRECTION_FIRST_STRONG} 13710 * {@link #TEXT_DIRECTION_ANY_RTL}, 13711 * {@link #TEXT_DIRECTION_LTR}, 13712 * {@link #TEXT_DIRECTION_RTL}, 13713 * {@link #TEXT_DIRECTION_LOCALE}, 13714 * 13715 * @hide 13716 */ 13717 public int getTextDirection() { 13718 return mTextDirection; 13719 } 13720 13721 /** 13722 * Set the text direction. 13723 * 13724 * @param textDirection the direction to set. Should be one of: 13725 * 13726 * {@link #TEXT_DIRECTION_INHERIT}, 13727 * {@link #TEXT_DIRECTION_FIRST_STRONG} 13728 * {@link #TEXT_DIRECTION_ANY_RTL}, 13729 * {@link #TEXT_DIRECTION_LTR}, 13730 * {@link #TEXT_DIRECTION_RTL}, 13731 * {@link #TEXT_DIRECTION_LOCALE}, 13732 * 13733 * @hide 13734 */ 13735 public void setTextDirection(int textDirection) { 13736 if (textDirection != mTextDirection) { 13737 mTextDirection = textDirection; 13738 resetResolvedTextDirection(); 13739 requestLayout(); 13740 } 13741 } 13742 13743 /** 13744 * Return the resolved text direction. 13745 * 13746 * @return the resolved text direction. Return one of: 13747 * 13748 * {@link #TEXT_DIRECTION_FIRST_STRONG} 13749 * {@link #TEXT_DIRECTION_ANY_RTL}, 13750 * {@link #TEXT_DIRECTION_LTR}, 13751 * {@link #TEXT_DIRECTION_RTL}, 13752 * {@link #TEXT_DIRECTION_LOCALE}, 13753 * 13754 * @hide 13755 */ 13756 public int getResolvedTextDirection() { 13757 if (mResolvedTextDirection == TEXT_DIRECTION_INHERIT) { 13758 resolveTextDirection(); 13759 } 13760 return mResolvedTextDirection; 13761 } 13762 13763 /** 13764 * Resolve the text direction. 13765 * 13766 * @hide 13767 */ 13768 protected void resolveTextDirection() { 13769 if (mTextDirection != TEXT_DIRECTION_INHERIT) { 13770 mResolvedTextDirection = mTextDirection; 13771 return; 13772 } 13773 if (mParent != null && mParent instanceof ViewGroup) { 13774 mResolvedTextDirection = ((ViewGroup) mParent).getResolvedTextDirection(); 13775 return; 13776 } 13777 mResolvedTextDirection = TEXT_DIRECTION_FIRST_STRONG; 13778 } 13779 13780 /** 13781 * Reset resolved text direction. Will be resolved during a call to getResolvedTextDirection(). 13782 * 13783 * @hide 13784 */ 13785 protected void resetResolvedTextDirection() { 13786 mResolvedTextDirection = TEXT_DIRECTION_INHERIT; 13787 } 13788 13789 // 13790 // Properties 13791 // 13792 /** 13793 * A Property wrapper around the <code>alpha</code> functionality handled by the 13794 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods. 13795 */ 13796 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") { 13797 @Override 13798 public void setValue(View object, float value) { 13799 object.setAlpha(value); 13800 } 13801 13802 @Override 13803 public Float get(View object) { 13804 return object.getAlpha(); 13805 } 13806 }; 13807 13808 /** 13809 * A Property wrapper around the <code>translationX</code> functionality handled by the 13810 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods. 13811 */ 13812 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") { 13813 @Override 13814 public void setValue(View object, float value) { 13815 object.setTranslationX(value); 13816 } 13817 13818 @Override 13819 public Float get(View object) { 13820 return object.getTranslationX(); 13821 } 13822 }; 13823 13824 /** 13825 * A Property wrapper around the <code>translationY</code> functionality handled by the 13826 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods. 13827 */ 13828 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") { 13829 @Override 13830 public void setValue(View object, float value) { 13831 object.setTranslationY(value); 13832 } 13833 13834 @Override 13835 public Float get(View object) { 13836 return object.getTranslationY(); 13837 } 13838 }; 13839 13840 /** 13841 * A Property wrapper around the <code>x</code> functionality handled by the 13842 * {@link View#setX(float)} and {@link View#getX()} methods. 13843 */ 13844 public static final Property<View, Float> X = new FloatProperty<View>("x") { 13845 @Override 13846 public void setValue(View object, float value) { 13847 object.setX(value); 13848 } 13849 13850 @Override 13851 public Float get(View object) { 13852 return object.getX(); 13853 } 13854 }; 13855 13856 /** 13857 * A Property wrapper around the <code>y</code> functionality handled by the 13858 * {@link View#setY(float)} and {@link View#getY()} methods. 13859 */ 13860 public static final Property<View, Float> Y = new FloatProperty<View>("y") { 13861 @Override 13862 public void setValue(View object, float value) { 13863 object.setY(value); 13864 } 13865 13866 @Override 13867 public Float get(View object) { 13868 return object.getY(); 13869 } 13870 }; 13871 13872 /** 13873 * A Property wrapper around the <code>rotation</code> functionality handled by the 13874 * {@link View#setRotation(float)} and {@link View#getRotation()} methods. 13875 */ 13876 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") { 13877 @Override 13878 public void setValue(View object, float value) { 13879 object.setRotation(value); 13880 } 13881 13882 @Override 13883 public Float get(View object) { 13884 return object.getRotation(); 13885 } 13886 }; 13887 13888 /** 13889 * A Property wrapper around the <code>rotationX</code> functionality handled by the 13890 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods. 13891 */ 13892 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") { 13893 @Override 13894 public void setValue(View object, float value) { 13895 object.setRotationX(value); 13896 } 13897 13898 @Override 13899 public Float get(View object) { 13900 return object.getRotationX(); 13901 } 13902 }; 13903 13904 /** 13905 * A Property wrapper around the <code>rotationY</code> functionality handled by the 13906 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods. 13907 */ 13908 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") { 13909 @Override 13910 public void setValue(View object, float value) { 13911 object.setRotationY(value); 13912 } 13913 13914 @Override 13915 public Float get(View object) { 13916 return object.getRotationY(); 13917 } 13918 }; 13919 13920 /** 13921 * A Property wrapper around the <code>scaleX</code> functionality handled by the 13922 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods. 13923 */ 13924 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") { 13925 @Override 13926 public void setValue(View object, float value) { 13927 object.setScaleX(value); 13928 } 13929 13930 @Override 13931 public Float get(View object) { 13932 return object.getScaleX(); 13933 } 13934 }; 13935 13936 /** 13937 * A Property wrapper around the <code>scaleY</code> functionality handled by the 13938 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods. 13939 */ 13940 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") { 13941 @Override 13942 public void setValue(View object, float value) { 13943 object.setScaleY(value); 13944 } 13945 13946 @Override 13947 public Float get(View object) { 13948 return object.getScaleY(); 13949 } 13950 }; 13951 13952 /** 13953 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 13954 * Each MeasureSpec represents a requirement for either the width or the height. 13955 * A MeasureSpec is comprised of a size and a mode. There are three possible 13956 * modes: 13957 * <dl> 13958 * <dt>UNSPECIFIED</dt> 13959 * <dd> 13960 * The parent has not imposed any constraint on the child. It can be whatever size 13961 * it wants. 13962 * </dd> 13963 * 13964 * <dt>EXACTLY</dt> 13965 * <dd> 13966 * The parent has determined an exact size for the child. The child is going to be 13967 * given those bounds regardless of how big it wants to be. 13968 * </dd> 13969 * 13970 * <dt>AT_MOST</dt> 13971 * <dd> 13972 * The child can be as large as it wants up to the specified size. 13973 * </dd> 13974 * </dl> 13975 * 13976 * MeasureSpecs are implemented as ints to reduce object allocation. This class 13977 * is provided to pack and unpack the <size, mode> tuple into the int. 13978 */ 13979 public static class MeasureSpec { 13980 private static final int MODE_SHIFT = 30; 13981 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 13982 13983 /** 13984 * Measure specification mode: The parent has not imposed any constraint 13985 * on the child. It can be whatever size it wants. 13986 */ 13987 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 13988 13989 /** 13990 * Measure specification mode: The parent has determined an exact size 13991 * for the child. The child is going to be given those bounds regardless 13992 * of how big it wants to be. 13993 */ 13994 public static final int EXACTLY = 1 << MODE_SHIFT; 13995 13996 /** 13997 * Measure specification mode: The child can be as large as it wants up 13998 * to the specified size. 13999 */ 14000 public static final int AT_MOST = 2 << MODE_SHIFT; 14001 14002 /** 14003 * Creates a measure specification based on the supplied size and mode. 14004 * 14005 * The mode must always be one of the following: 14006 * <ul> 14007 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 14008 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 14009 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 14010 * </ul> 14011 * 14012 * @param size the size of the measure specification 14013 * @param mode the mode of the measure specification 14014 * @return the measure specification based on size and mode 14015 */ 14016 public static int makeMeasureSpec(int size, int mode) { 14017 return size + mode; 14018 } 14019 14020 /** 14021 * Extracts the mode from the supplied measure specification. 14022 * 14023 * @param measureSpec the measure specification to extract the mode from 14024 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 14025 * {@link android.view.View.MeasureSpec#AT_MOST} or 14026 * {@link android.view.View.MeasureSpec#EXACTLY} 14027 */ 14028 public static int getMode(int measureSpec) { 14029 return (measureSpec & MODE_MASK); 14030 } 14031 14032 /** 14033 * Extracts the size from the supplied measure specification. 14034 * 14035 * @param measureSpec the measure specification to extract the size from 14036 * @return the size in pixels defined in the supplied measure specification 14037 */ 14038 public static int getSize(int measureSpec) { 14039 return (measureSpec & ~MODE_MASK); 14040 } 14041 14042 /** 14043 * Returns a String representation of the specified measure 14044 * specification. 14045 * 14046 * @param measureSpec the measure specification to convert to a String 14047 * @return a String with the following format: "MeasureSpec: MODE SIZE" 14048 */ 14049 public static String toString(int measureSpec) { 14050 int mode = getMode(measureSpec); 14051 int size = getSize(measureSpec); 14052 14053 StringBuilder sb = new StringBuilder("MeasureSpec: "); 14054 14055 if (mode == UNSPECIFIED) 14056 sb.append("UNSPECIFIED "); 14057 else if (mode == EXACTLY) 14058 sb.append("EXACTLY "); 14059 else if (mode == AT_MOST) 14060 sb.append("AT_MOST "); 14061 else 14062 sb.append(mode).append(" "); 14063 14064 sb.append(size); 14065 return sb.toString(); 14066 } 14067 } 14068 14069 class CheckForLongPress implements Runnable { 14070 14071 private int mOriginalWindowAttachCount; 14072 14073 public void run() { 14074 if (isPressed() && (mParent != null) 14075 && mOriginalWindowAttachCount == mWindowAttachCount) { 14076 if (performLongClick()) { 14077 mHasPerformedLongPress = true; 14078 } 14079 } 14080 } 14081 14082 public void rememberWindowAttachCount() { 14083 mOriginalWindowAttachCount = mWindowAttachCount; 14084 } 14085 } 14086 14087 private final class CheckForTap implements Runnable { 14088 public void run() { 14089 mPrivateFlags &= ~PREPRESSED; 14090 mPrivateFlags |= PRESSED; 14091 refreshDrawableState(); 14092 checkForLongClick(ViewConfiguration.getTapTimeout()); 14093 } 14094 } 14095 14096 private final class PerformClick implements Runnable { 14097 public void run() { 14098 performClick(); 14099 } 14100 } 14101 14102 /** @hide */ 14103 public void hackTurnOffWindowResizeAnim(boolean off) { 14104 mAttachInfo.mTurnOffWindowResizeAnim = off; 14105 } 14106 14107 /** 14108 * This method returns a ViewPropertyAnimator object, which can be used to animate 14109 * specific properties on this View. 14110 * 14111 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View. 14112 */ 14113 public ViewPropertyAnimator animate() { 14114 if (mAnimator == null) { 14115 mAnimator = new ViewPropertyAnimator(this); 14116 } 14117 return mAnimator; 14118 } 14119 14120 /** 14121 * Interface definition for a callback to be invoked when a key event is 14122 * dispatched to this view. The callback will be invoked before the key 14123 * event is given to the view. 14124 */ 14125 public interface OnKeyListener { 14126 /** 14127 * Called when a key is dispatched to a view. This allows listeners to 14128 * get a chance to respond before the target view. 14129 * 14130 * @param v The view the key has been dispatched to. 14131 * @param keyCode The code for the physical key that was pressed 14132 * @param event The KeyEvent object containing full information about 14133 * the event. 14134 * @return True if the listener has consumed the event, false otherwise. 14135 */ 14136 boolean onKey(View v, int keyCode, KeyEvent event); 14137 } 14138 14139 /** 14140 * Interface definition for a callback to be invoked when a touch event is 14141 * dispatched to this view. The callback will be invoked before the touch 14142 * event is given to the view. 14143 */ 14144 public interface OnTouchListener { 14145 /** 14146 * Called when a touch event is dispatched to a view. This allows listeners to 14147 * get a chance to respond before the target view. 14148 * 14149 * @param v The view the touch event has been dispatched to. 14150 * @param event The MotionEvent object containing full information about 14151 * the event. 14152 * @return True if the listener has consumed the event, false otherwise. 14153 */ 14154 boolean onTouch(View v, MotionEvent event); 14155 } 14156 14157 /** 14158 * Interface definition for a callback to be invoked when a hover event is 14159 * dispatched to this view. The callback will be invoked before the hover 14160 * event is given to the view. 14161 */ 14162 public interface OnHoverListener { 14163 /** 14164 * Called when a hover event is dispatched to a view. This allows listeners to 14165 * get a chance to respond before the target view. 14166 * 14167 * @param v The view the hover event has been dispatched to. 14168 * @param event The MotionEvent object containing full information about 14169 * the event. 14170 * @return True if the listener has consumed the event, false otherwise. 14171 */ 14172 boolean onHover(View v, MotionEvent event); 14173 } 14174 14175 /** 14176 * Interface definition for a callback to be invoked when a generic motion event is 14177 * dispatched to this view. The callback will be invoked before the generic motion 14178 * event is given to the view. 14179 */ 14180 public interface OnGenericMotionListener { 14181 /** 14182 * Called when a generic motion event is dispatched to a view. This allows listeners to 14183 * get a chance to respond before the target view. 14184 * 14185 * @param v The view the generic motion event has been dispatched to. 14186 * @param event The MotionEvent object containing full information about 14187 * the event. 14188 * @return True if the listener has consumed the event, false otherwise. 14189 */ 14190 boolean onGenericMotion(View v, MotionEvent event); 14191 } 14192 14193 /** 14194 * Interface definition for a callback to be invoked when a view has been clicked and held. 14195 */ 14196 public interface OnLongClickListener { 14197 /** 14198 * Called when a view has been clicked and held. 14199 * 14200 * @param v The view that was clicked and held. 14201 * 14202 * @return true if the callback consumed the long click, false otherwise. 14203 */ 14204 boolean onLongClick(View v); 14205 } 14206 14207 /** 14208 * Interface definition for a callback to be invoked when a drag is being dispatched 14209 * to this view. The callback will be invoked before the hosting view's own 14210 * onDrag(event) method. If the listener wants to fall back to the hosting view's 14211 * onDrag(event) behavior, it should return 'false' from this callback. 14212 * 14213 * <div class="special reference"> 14214 * <h3>Developer Guides</h3> 14215 * <p>For a guide to implementing drag and drop features, read the 14216 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> 14217 * </div> 14218 */ 14219 public interface OnDragListener { 14220 /** 14221 * Called when a drag event is dispatched to a view. This allows listeners 14222 * to get a chance to override base View behavior. 14223 * 14224 * @param v The View that received the drag event. 14225 * @param event The {@link android.view.DragEvent} object for the drag event. 14226 * @return {@code true} if the drag event was handled successfully, or {@code false} 14227 * if the drag event was not handled. Note that {@code false} will trigger the View 14228 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler. 14229 */ 14230 boolean onDrag(View v, DragEvent event); 14231 } 14232 14233 /** 14234 * Interface definition for a callback to be invoked when the focus state of 14235 * a view changed. 14236 */ 14237 public interface OnFocusChangeListener { 14238 /** 14239 * Called when the focus state of a view has changed. 14240 * 14241 * @param v The view whose state has changed. 14242 * @param hasFocus The new focus state of v. 14243 */ 14244 void onFocusChange(View v, boolean hasFocus); 14245 } 14246 14247 /** 14248 * Interface definition for a callback to be invoked when a view is clicked. 14249 */ 14250 public interface OnClickListener { 14251 /** 14252 * Called when a view has been clicked. 14253 * 14254 * @param v The view that was clicked. 14255 */ 14256 void onClick(View v); 14257 } 14258 14259 /** 14260 * Interface definition for a callback to be invoked when the context menu 14261 * for this view is being built. 14262 */ 14263 public interface OnCreateContextMenuListener { 14264 /** 14265 * Called when the context menu for this view is being built. It is not 14266 * safe to hold onto the menu after this method returns. 14267 * 14268 * @param menu The context menu that is being built 14269 * @param v The view for which the context menu is being built 14270 * @param menuInfo Extra information about the item for which the 14271 * context menu should be shown. This information will vary 14272 * depending on the class of v. 14273 */ 14274 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 14275 } 14276 14277 /** 14278 * Interface definition for a callback to be invoked when the status bar changes 14279 * visibility. This reports <strong>global</strong> changes to the system UI 14280 * state, not just what the application is requesting. 14281 * 14282 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) 14283 */ 14284 public interface OnSystemUiVisibilityChangeListener { 14285 /** 14286 * Called when the status bar changes visibility because of a call to 14287 * {@link View#setSystemUiVisibility(int)}. 14288 * 14289 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or 14290 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}. This tells you the 14291 * <strong>global</strong> state of the UI visibility flags, not what your 14292 * app is currently applying. 14293 */ 14294 public void onSystemUiVisibilityChange(int visibility); 14295 } 14296 14297 /** 14298 * Interface definition for a callback to be invoked when this view is attached 14299 * or detached from its window. 14300 */ 14301 public interface OnAttachStateChangeListener { 14302 /** 14303 * Called when the view is attached to a window. 14304 * @param v The view that was attached 14305 */ 14306 public void onViewAttachedToWindow(View v); 14307 /** 14308 * Called when the view is detached from a window. 14309 * @param v The view that was detached 14310 */ 14311 public void onViewDetachedFromWindow(View v); 14312 } 14313 14314 private final class UnsetPressedState implements Runnable { 14315 public void run() { 14316 setPressed(false); 14317 } 14318 } 14319 14320 /** 14321 * Base class for derived classes that want to save and restore their own 14322 * state in {@link android.view.View#onSaveInstanceState()}. 14323 */ 14324 public static class BaseSavedState extends AbsSavedState { 14325 /** 14326 * Constructor used when reading from a parcel. Reads the state of the superclass. 14327 * 14328 * @param source 14329 */ 14330 public BaseSavedState(Parcel source) { 14331 super(source); 14332 } 14333 14334 /** 14335 * Constructor called by derived classes when creating their SavedState objects 14336 * 14337 * @param superState The state of the superclass of this view 14338 */ 14339 public BaseSavedState(Parcelable superState) { 14340 super(superState); 14341 } 14342 14343 public static final Parcelable.Creator<BaseSavedState> CREATOR = 14344 new Parcelable.Creator<BaseSavedState>() { 14345 public BaseSavedState createFromParcel(Parcel in) { 14346 return new BaseSavedState(in); 14347 } 14348 14349 public BaseSavedState[] newArray(int size) { 14350 return new BaseSavedState[size]; 14351 } 14352 }; 14353 } 14354 14355 /** 14356 * A set of information given to a view when it is attached to its parent 14357 * window. 14358 */ 14359 static class AttachInfo { 14360 interface Callbacks { 14361 void playSoundEffect(int effectId); 14362 boolean performHapticFeedback(int effectId, boolean always); 14363 } 14364 14365 /** 14366 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 14367 * to a Handler. This class contains the target (View) to invalidate and 14368 * the coordinates of the dirty rectangle. 14369 * 14370 * For performance purposes, this class also implements a pool of up to 14371 * POOL_LIMIT objects that get reused. This reduces memory allocations 14372 * whenever possible. 14373 */ 14374 static class InvalidateInfo implements Poolable<InvalidateInfo> { 14375 private static final int POOL_LIMIT = 10; 14376 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool( 14377 Pools.finitePool(new PoolableManager<InvalidateInfo>() { 14378 public InvalidateInfo newInstance() { 14379 return new InvalidateInfo(); 14380 } 14381 14382 public void onAcquired(InvalidateInfo element) { 14383 } 14384 14385 public void onReleased(InvalidateInfo element) { 14386 element.target = null; 14387 } 14388 }, POOL_LIMIT) 14389 ); 14390 14391 private InvalidateInfo mNext; 14392 private boolean mIsPooled; 14393 14394 View target; 14395 14396 int left; 14397 int top; 14398 int right; 14399 int bottom; 14400 14401 public void setNextPoolable(InvalidateInfo element) { 14402 mNext = element; 14403 } 14404 14405 public InvalidateInfo getNextPoolable() { 14406 return mNext; 14407 } 14408 14409 static InvalidateInfo acquire() { 14410 return sPool.acquire(); 14411 } 14412 14413 void release() { 14414 sPool.release(this); 14415 } 14416 14417 public boolean isPooled() { 14418 return mIsPooled; 14419 } 14420 14421 public void setPooled(boolean isPooled) { 14422 mIsPooled = isPooled; 14423 } 14424 } 14425 14426 final IWindowSession mSession; 14427 14428 final IWindow mWindow; 14429 14430 final IBinder mWindowToken; 14431 14432 final Callbacks mRootCallbacks; 14433 14434 HardwareCanvas mHardwareCanvas; 14435 14436 /** 14437 * The top view of the hierarchy. 14438 */ 14439 View mRootView; 14440 14441 IBinder mPanelParentWindowToken; 14442 Surface mSurface; 14443 14444 boolean mHardwareAccelerated; 14445 boolean mHardwareAccelerationRequested; 14446 HardwareRenderer mHardwareRenderer; 14447 14448 /** 14449 * Scale factor used by the compatibility mode 14450 */ 14451 float mApplicationScale; 14452 14453 /** 14454 * Indicates whether the application is in compatibility mode 14455 */ 14456 boolean mScalingRequired; 14457 14458 /** 14459 * If set, ViewAncestor doesn't use its lame animation for when the window resizes. 14460 */ 14461 boolean mTurnOffWindowResizeAnim; 14462 14463 /** 14464 * Left position of this view's window 14465 */ 14466 int mWindowLeft; 14467 14468 /** 14469 * Top position of this view's window 14470 */ 14471 int mWindowTop; 14472 14473 /** 14474 * Indicates whether views need to use 32-bit drawing caches 14475 */ 14476 boolean mUse32BitDrawingCache; 14477 14478 /** 14479 * For windows that are full-screen but using insets to layout inside 14480 * of the screen decorations, these are the current insets for the 14481 * content of the window. 14482 */ 14483 final Rect mContentInsets = new Rect(); 14484 14485 /** 14486 * For windows that are full-screen but using insets to layout inside 14487 * of the screen decorations, these are the current insets for the 14488 * actual visible parts of the window. 14489 */ 14490 final Rect mVisibleInsets = new Rect(); 14491 14492 /** 14493 * The internal insets given by this window. This value is 14494 * supplied by the client (through 14495 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 14496 * be given to the window manager when changed to be used in laying 14497 * out windows behind it. 14498 */ 14499 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 14500 = new ViewTreeObserver.InternalInsetsInfo(); 14501 14502 /** 14503 * All views in the window's hierarchy that serve as scroll containers, 14504 * used to determine if the window can be resized or must be panned 14505 * to adjust for a soft input area. 14506 */ 14507 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 14508 14509 final KeyEvent.DispatcherState mKeyDispatchState 14510 = new KeyEvent.DispatcherState(); 14511 14512 /** 14513 * Indicates whether the view's window currently has the focus. 14514 */ 14515 boolean mHasWindowFocus; 14516 14517 /** 14518 * The current visibility of the window. 14519 */ 14520 int mWindowVisibility; 14521 14522 /** 14523 * Indicates the time at which drawing started to occur. 14524 */ 14525 long mDrawingTime; 14526 14527 /** 14528 * Indicates whether or not ignoring the DIRTY_MASK flags. 14529 */ 14530 boolean mIgnoreDirtyState; 14531 14532 /** 14533 * This flag tracks when the mIgnoreDirtyState flag is set during draw(), 14534 * to avoid clearing that flag prematurely. 14535 */ 14536 boolean mSetIgnoreDirtyState = false; 14537 14538 /** 14539 * Indicates whether the view's window is currently in touch mode. 14540 */ 14541 boolean mInTouchMode; 14542 14543 /** 14544 * Indicates that ViewAncestor should trigger a global layout change 14545 * the next time it performs a traversal 14546 */ 14547 boolean mRecomputeGlobalAttributes; 14548 14549 /** 14550 * Always report new attributes at next traversal. 14551 */ 14552 boolean mForceReportNewAttributes; 14553 14554 /** 14555 * Set during a traveral if any views want to keep the screen on. 14556 */ 14557 boolean mKeepScreenOn; 14558 14559 /** 14560 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 14561 */ 14562 int mSystemUiVisibility; 14563 14564 /** 14565 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 14566 * attached. 14567 */ 14568 boolean mHasSystemUiListeners; 14569 14570 /** 14571 * Set if the visibility of any views has changed. 14572 */ 14573 boolean mViewVisibilityChanged; 14574 14575 /** 14576 * Set to true if a view has been scrolled. 14577 */ 14578 boolean mViewScrollChanged; 14579 14580 /** 14581 * Global to the view hierarchy used as a temporary for dealing with 14582 * x/y points in the transparent region computations. 14583 */ 14584 final int[] mTransparentLocation = new int[2]; 14585 14586 /** 14587 * Global to the view hierarchy used as a temporary for dealing with 14588 * x/y points in the ViewGroup.invalidateChild implementation. 14589 */ 14590 final int[] mInvalidateChildLocation = new int[2]; 14591 14592 14593 /** 14594 * Global to the view hierarchy used as a temporary for dealing with 14595 * x/y location when view is transformed. 14596 */ 14597 final float[] mTmpTransformLocation = new float[2]; 14598 14599 /** 14600 * The view tree observer used to dispatch global events like 14601 * layout, pre-draw, touch mode change, etc. 14602 */ 14603 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 14604 14605 /** 14606 * A Canvas used by the view hierarchy to perform bitmap caching. 14607 */ 14608 Canvas mCanvas; 14609 14610 /** 14611 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This 14612 * handler can be used to pump events in the UI events queue. 14613 */ 14614 final Handler mHandler; 14615 14616 /** 14617 * Identifier for messages requesting the view to be invalidated. 14618 * Such messages should be sent to {@link #mHandler}. 14619 */ 14620 static final int INVALIDATE_MSG = 0x1; 14621 14622 /** 14623 * Identifier for messages requesting the view to invalidate a region. 14624 * Such messages should be sent to {@link #mHandler}. 14625 */ 14626 static final int INVALIDATE_RECT_MSG = 0x2; 14627 14628 /** 14629 * Temporary for use in computing invalidate rectangles while 14630 * calling up the hierarchy. 14631 */ 14632 final Rect mTmpInvalRect = new Rect(); 14633 14634 /** 14635 * Temporary for use in computing hit areas with transformed views 14636 */ 14637 final RectF mTmpTransformRect = new RectF(); 14638 14639 /** 14640 * Temporary list for use in collecting focusable descendents of a view. 14641 */ 14642 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24); 14643 14644 /** 14645 * The id of the window for accessibility purposes. 14646 */ 14647 int mAccessibilityWindowId = View.NO_ID; 14648 14649 /** 14650 * Creates a new set of attachment information with the specified 14651 * events handler and thread. 14652 * 14653 * @param handler the events handler the view must use 14654 */ 14655 AttachInfo(IWindowSession session, IWindow window, 14656 Handler handler, Callbacks effectPlayer) { 14657 mSession = session; 14658 mWindow = window; 14659 mWindowToken = window.asBinder(); 14660 mHandler = handler; 14661 mRootCallbacks = effectPlayer; 14662 } 14663 } 14664 14665 /** 14666 * <p>ScrollabilityCache holds various fields used by a View when scrolling 14667 * is supported. This avoids keeping too many unused fields in most 14668 * instances of View.</p> 14669 */ 14670 private static class ScrollabilityCache implements Runnable { 14671 14672 /** 14673 * Scrollbars are not visible 14674 */ 14675 public static final int OFF = 0; 14676 14677 /** 14678 * Scrollbars are visible 14679 */ 14680 public static final int ON = 1; 14681 14682 /** 14683 * Scrollbars are fading away 14684 */ 14685 public static final int FADING = 2; 14686 14687 public boolean fadeScrollBars; 14688 14689 public int fadingEdgeLength; 14690 public int scrollBarDefaultDelayBeforeFade; 14691 public int scrollBarFadeDuration; 14692 14693 public int scrollBarSize; 14694 public ScrollBarDrawable scrollBar; 14695 public float[] interpolatorValues; 14696 public View host; 14697 14698 public final Paint paint; 14699 public final Matrix matrix; 14700 public Shader shader; 14701 14702 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 14703 14704 private static final float[] OPAQUE = { 255 }; 14705 private static final float[] TRANSPARENT = { 0.0f }; 14706 14707 /** 14708 * When fading should start. This time moves into the future every time 14709 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 14710 */ 14711 public long fadeStartTime; 14712 14713 14714 /** 14715 * The current state of the scrollbars: ON, OFF, or FADING 14716 */ 14717 public int state = OFF; 14718 14719 private int mLastColor; 14720 14721 public ScrollabilityCache(ViewConfiguration configuration, View host) { 14722 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 14723 scrollBarSize = configuration.getScaledScrollBarSize(); 14724 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 14725 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 14726 14727 paint = new Paint(); 14728 matrix = new Matrix(); 14729 // use use a height of 1, and then wack the matrix each time we 14730 // actually use it. 14731 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 14732 14733 paint.setShader(shader); 14734 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 14735 this.host = host; 14736 } 14737 14738 public void setFadeColor(int color) { 14739 if (color != 0 && color != mLastColor) { 14740 mLastColor = color; 14741 color |= 0xFF000000; 14742 14743 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 14744 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 14745 14746 paint.setShader(shader); 14747 // Restore the default transfer mode (src_over) 14748 paint.setXfermode(null); 14749 } 14750 } 14751 14752 public void run() { 14753 long now = AnimationUtils.currentAnimationTimeMillis(); 14754 if (now >= fadeStartTime) { 14755 14756 // the animation fades the scrollbars out by changing 14757 // the opacity (alpha) from fully opaque to fully 14758 // transparent 14759 int nextFrame = (int) now; 14760 int framesCount = 0; 14761 14762 Interpolator interpolator = scrollBarInterpolator; 14763 14764 // Start opaque 14765 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 14766 14767 // End transparent 14768 nextFrame += scrollBarFadeDuration; 14769 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 14770 14771 state = FADING; 14772 14773 // Kick off the fade animation 14774 host.invalidate(true); 14775 } 14776 } 14777 } 14778 14779 /** 14780 * Resuable callback for sending 14781 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event. 14782 */ 14783 private class SendViewScrolledAccessibilityEvent implements Runnable { 14784 public volatile boolean mIsPending; 14785 14786 public void run() { 14787 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED); 14788 mIsPending = false; 14789 } 14790 } 14791 14792 /** 14793 * <p> 14794 * This class represents a delegate that can be registered in a {@link View} 14795 * to enhance accessibility support via composition rather via inheritance. 14796 * It is specifically targeted to widget developers that extend basic View 14797 * classes i.e. classes in package android.view, that would like their 14798 * applications to be backwards compatible. 14799 * </p> 14800 * <p> 14801 * A scenario in which a developer would like to use an accessibility delegate 14802 * is overriding a method introduced in a later API version then the minimal API 14803 * version supported by the application. For example, the method 14804 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available 14805 * in API version 4 when the accessibility APIs were first introduced. If a 14806 * developer would like his application to run on API version 4 devices (assuming 14807 * all other APIs used by the application are version 4 or lower) and take advantage 14808 * of this method, instead of overriding the method which would break the application's 14809 * backwards compatibility, he can override the corresponding method in this 14810 * delegate and register the delegate in the target View if the API version of 14811 * the system is high enough i.e. the API version is same or higher to the API 14812 * version that introduced 14813 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}. 14814 * </p> 14815 * <p> 14816 * Here is an example implementation: 14817 * </p> 14818 * <code><pre><p> 14819 * if (Build.VERSION.SDK_INT >= 14) { 14820 * // If the API version is equal of higher than the version in 14821 * // which onInitializeAccessibilityNodeInfo was introduced we 14822 * // register a delegate with a customized implementation. 14823 * View view = findViewById(R.id.view_id); 14824 * view.setAccessibilityDelegate(new AccessibilityDelegate() { 14825 * public void onInitializeAccessibilityNodeInfo(View host, 14826 * AccessibilityNodeInfo info) { 14827 * // Let the default implementation populate the info. 14828 * super.onInitializeAccessibilityNodeInfo(host, info); 14829 * // Set some other information. 14830 * info.setEnabled(host.isEnabled()); 14831 * } 14832 * }); 14833 * } 14834 * </code></pre></p> 14835 * <p> 14836 * This delegate contains methods that correspond to the accessibility methods 14837 * in View. If a delegate has been specified the implementation in View hands 14838 * off handling to the corresponding method in this delegate. The default 14839 * implementation the delegate methods behaves exactly as the corresponding 14840 * method in View for the case of no accessibility delegate been set. Hence, 14841 * to customize the behavior of a View method, clients can override only the 14842 * corresponding delegate method without altering the behavior of the rest 14843 * accessibility related methods of the host view. 14844 * </p> 14845 */ 14846 public static class AccessibilityDelegate { 14847 14848 /** 14849 * Sends an accessibility event of the given type. If accessibility is not 14850 * enabled this method has no effect. 14851 * <p> 14852 * The default implementation behaves as {@link View#sendAccessibilityEvent(int) 14853 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate 14854 * been set. 14855 * </p> 14856 * 14857 * @param host The View hosting the delegate. 14858 * @param eventType The type of the event to send. 14859 * 14860 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int) 14861 */ 14862 public void sendAccessibilityEvent(View host, int eventType) { 14863 host.sendAccessibilityEventInternal(eventType); 14864 } 14865 14866 /** 14867 * Sends an accessibility event. This method behaves exactly as 14868 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an 14869 * empty {@link AccessibilityEvent} and does not perform a check whether 14870 * accessibility is enabled. 14871 * <p> 14872 * The default implementation behaves as 14873 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent) 14874 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for 14875 * the case of no accessibility delegate been set. 14876 * </p> 14877 * 14878 * @param host The View hosting the delegate. 14879 * @param event The event to send. 14880 * 14881 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent) 14882 * View#sendAccessibilityEventUnchecked(AccessibilityEvent) 14883 */ 14884 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) { 14885 host.sendAccessibilityEventUncheckedInternal(event); 14886 } 14887 14888 /** 14889 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then 14890 * to its children for adding their text content to the event. 14891 * <p> 14892 * The default implementation behaves as 14893 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 14894 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for 14895 * the case of no accessibility delegate been set. 14896 * </p> 14897 * 14898 * @param host The View hosting the delegate. 14899 * @param event The event. 14900 * @return True if the event population was completed. 14901 * 14902 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 14903 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent) 14904 */ 14905 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 14906 return host.dispatchPopulateAccessibilityEventInternal(event); 14907 } 14908 14909 /** 14910 * Gives a chance to the host View to populate the accessibility event with its 14911 * text content. 14912 * <p> 14913 * The default implementation behaves as 14914 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent) 14915 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for 14916 * the case of no accessibility delegate been set. 14917 * </p> 14918 * 14919 * @param host The View hosting the delegate. 14920 * @param event The accessibility event which to populate. 14921 * 14922 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent) 14923 * View#onPopulateAccessibilityEvent(AccessibilityEvent) 14924 */ 14925 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) { 14926 host.onPopulateAccessibilityEventInternal(event); 14927 } 14928 14929 /** 14930 * Initializes an {@link AccessibilityEvent} with information about the 14931 * the host View which is the event source. 14932 * <p> 14933 * The default implementation behaves as 14934 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent) 14935 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for 14936 * the case of no accessibility delegate been set. 14937 * </p> 14938 * 14939 * @param host The View hosting the delegate. 14940 * @param event The event to initialize. 14941 * 14942 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent) 14943 * View#onInitializeAccessibilityEvent(AccessibilityEvent) 14944 */ 14945 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) { 14946 host.onInitializeAccessibilityEventInternal(event); 14947 } 14948 14949 /** 14950 * Initializes an {@link AccessibilityNodeInfo} with information about the host view. 14951 * <p> 14952 * The default implementation behaves as 14953 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 14954 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for 14955 * the case of no accessibility delegate been set. 14956 * </p> 14957 * 14958 * @param host The View hosting the delegate. 14959 * @param info The instance to initialize. 14960 * 14961 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 14962 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo) 14963 */ 14964 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) { 14965 host.onInitializeAccessibilityNodeInfoInternal(info); 14966 } 14967 14968 /** 14969 * Called when a child of the host View has requested sending an 14970 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host) 14971 * to augment the event. 14972 * <p> 14973 * The default implementation behaves as 14974 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 14975 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for 14976 * the case of no accessibility delegate been set. 14977 * </p> 14978 * 14979 * @param host The View hosting the delegate. 14980 * @param child The child which requests sending the event. 14981 * @param event The event to be sent. 14982 * @return True if the event should be sent 14983 * 14984 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 14985 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent) 14986 */ 14987 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child, 14988 AccessibilityEvent event) { 14989 return host.onRequestSendAccessibilityEventInternal(child, event); 14990 } 14991 14992 /** 14993 * Gets the provider for managing a virtual view hierarchy rooted at this View 14994 * and reported to {@link android.accessibilityservice.AccessibilityService}s 14995 * that explore the window content. 14996 * <p> 14997 * The default implementation behaves as 14998 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for 14999 * the case of no accessibility delegate been set. 15000 * </p> 15001 * 15002 * @return The provider. 15003 * 15004 * @see AccessibilityNodeProvider 15005 */ 15006 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) { 15007 return null; 15008 } 15009 } 15010} 15011