View.java revision 4d7b10630a5192bfe84181a83c70c38ef0655b5f
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 com.android.internal.R; 20import com.android.internal.util.Predicate; 21import com.android.internal.view.menu.MenuBuilder; 22 23import android.content.ClipData; 24import android.content.Context; 25import android.content.res.Configuration; 26import android.content.res.Resources; 27import android.content.res.TypedArray; 28import android.graphics.Bitmap; 29import android.graphics.Camera; 30import android.graphics.Canvas; 31import android.graphics.Interpolator; 32import android.graphics.LinearGradient; 33import android.graphics.Matrix; 34import android.graphics.Paint; 35import android.graphics.PixelFormat; 36import android.graphics.Point; 37import android.graphics.PorterDuff; 38import android.graphics.PorterDuffXfermode; 39import android.graphics.Rect; 40import android.graphics.RectF; 41import android.graphics.Region; 42import android.graphics.Shader; 43import android.graphics.drawable.ColorDrawable; 44import android.graphics.drawable.Drawable; 45import android.os.Handler; 46import android.os.IBinder; 47import android.os.Message; 48import android.os.Parcel; 49import android.os.Parcelable; 50import android.os.RemoteException; 51import android.os.SystemClock; 52import android.os.SystemProperties; 53import android.util.AttributeSet; 54import android.util.Log; 55import android.util.Pool; 56import android.util.Poolable; 57import android.util.PoolableManager; 58import android.util.Pools; 59import android.util.SparseArray; 60import android.view.ContextMenu.ContextMenuInfo; 61import android.view.accessibility.AccessibilityEvent; 62import android.view.accessibility.AccessibilityEventSource; 63import android.view.accessibility.AccessibilityManager; 64import android.view.animation.Animation; 65import android.view.animation.AnimationUtils; 66import android.view.inputmethod.EditorInfo; 67import android.view.inputmethod.InputConnection; 68import android.view.inputmethod.InputMethodManager; 69import android.widget.ScrollBarDrawable; 70 71import java.lang.ref.WeakReference; 72import java.lang.reflect.InvocationTargetException; 73import java.lang.reflect.Method; 74import java.util.ArrayList; 75import java.util.Arrays; 76import java.util.List; 77import java.util.WeakHashMap; 78 79/** 80 * <p> 81 * This class represents the basic building block for user interface components. A View 82 * occupies a rectangular area on the screen and is responsible for drawing and 83 * event handling. View is the base class for <em>widgets</em>, which are 84 * used to create interactive UI components (buttons, text fields, etc.). The 85 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which 86 * are invisible containers that hold other Views (or other ViewGroups) and define 87 * their layout properties. 88 * </p> 89 * 90 * <div class="special"> 91 * <p>For an introduction to using this class to develop your 92 * application's user interface, read the Developer Guide documentation on 93 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics 94 * include: 95 * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a> 96 * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a> 97 * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a> 98 * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a> 99 * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a> 100 * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a> 101 * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a> 102 * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>. 103 * </p> 104 * </div> 105 * 106 * <a name="Using"></a> 107 * <h3>Using Views</h3> 108 * <p> 109 * All of the views in a window are arranged in a single tree. You can add views 110 * either from code or by specifying a tree of views in one or more XML layout 111 * files. There are many specialized subclasses of views that act as controls or 112 * are capable of displaying text, images, or other content. 113 * </p> 114 * <p> 115 * Once you have created a tree of views, there are typically a few types of 116 * common operations you may wish to perform: 117 * <ul> 118 * <li><strong>Set properties:</strong> for example setting the text of a 119 * {@link android.widget.TextView}. The available properties and the methods 120 * that set them will vary among the different subclasses of views. Note that 121 * properties that are known at build time can be set in the XML layout 122 * files.</li> 123 * <li><strong>Set focus:</strong> The framework will handled moving focus in 124 * response to user input. To force focus to a specific view, call 125 * {@link #requestFocus}.</li> 126 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners 127 * that will be notified when something interesting happens to the view. For 128 * example, all views will let you set a listener to be notified when the view 129 * gains or loses focus. You can register such a listener using 130 * {@link #setOnFocusChangeListener}. Other view subclasses offer more 131 * specialized listeners. For example, a Button exposes a listener to notify 132 * clients when the button is clicked.</li> 133 * <li><strong>Set visibility:</strong> You can hide or show views using 134 * {@link #setVisibility}.</li> 135 * </ul> 136 * </p> 137 * <p><em> 138 * Note: The Android framework is responsible for measuring, laying out and 139 * drawing views. You should not call methods that perform these actions on 140 * views yourself unless you are actually implementing a 141 * {@link android.view.ViewGroup}. 142 * </em></p> 143 * 144 * <a name="Lifecycle"></a> 145 * <h3>Implementing a Custom View</h3> 146 * 147 * <p> 148 * To implement a custom view, you will usually begin by providing overrides for 149 * some of the standard methods that the framework calls on all views. You do 150 * not need to override all of these methods. In fact, you can start by just 151 * overriding {@link #onDraw(android.graphics.Canvas)}. 152 * <table border="2" width="85%" align="center" cellpadding="5"> 153 * <thead> 154 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr> 155 * </thead> 156 * 157 * <tbody> 158 * <tr> 159 * <td rowspan="2">Creation</td> 160 * <td>Constructors</td> 161 * <td>There is a form of the constructor that are called when the view 162 * is created from code and a form that is called when the view is 163 * inflated from a layout file. The second form should parse and apply 164 * any attributes defined in the layout file. 165 * </td> 166 * </tr> 167 * <tr> 168 * <td><code>{@link #onFinishInflate()}</code></td> 169 * <td>Called after a view and all of its children has been inflated 170 * from XML.</td> 171 * </tr> 172 * 173 * <tr> 174 * <td rowspan="3">Layout</td> 175 * <td><code>{@link #onMeasure}</code></td> 176 * <td>Called to determine the size requirements for this view and all 177 * of its children. 178 * </td> 179 * </tr> 180 * <tr> 181 * <td><code>{@link #onLayout}</code></td> 182 * <td>Called when this view should assign a size and position to all 183 * of its children. 184 * </td> 185 * </tr> 186 * <tr> 187 * <td><code>{@link #onSizeChanged}</code></td> 188 * <td>Called when the size of this view has changed. 189 * </td> 190 * </tr> 191 * 192 * <tr> 193 * <td>Drawing</td> 194 * <td><code>{@link #onDraw}</code></td> 195 * <td>Called when the view should render its content. 196 * </td> 197 * </tr> 198 * 199 * <tr> 200 * <td rowspan="4">Event processing</td> 201 * <td><code>{@link #onKeyDown}</code></td> 202 * <td>Called when a new key event occurs. 203 * </td> 204 * </tr> 205 * <tr> 206 * <td><code>{@link #onKeyUp}</code></td> 207 * <td>Called when a key up event occurs. 208 * </td> 209 * </tr> 210 * <tr> 211 * <td><code>{@link #onTrackballEvent}</code></td> 212 * <td>Called when a trackball motion event occurs. 213 * </td> 214 * </tr> 215 * <tr> 216 * <td><code>{@link #onTouchEvent}</code></td> 217 * <td>Called when a touch screen motion event occurs. 218 * </td> 219 * </tr> 220 * 221 * <tr> 222 * <td rowspan="2">Focus</td> 223 * <td><code>{@link #onFocusChanged}</code></td> 224 * <td>Called when the view gains or loses focus. 225 * </td> 226 * </tr> 227 * 228 * <tr> 229 * <td><code>{@link #onWindowFocusChanged}</code></td> 230 * <td>Called when the window containing the view gains or loses focus. 231 * </td> 232 * </tr> 233 * 234 * <tr> 235 * <td rowspan="3">Attaching</td> 236 * <td><code>{@link #onAttachedToWindow()}</code></td> 237 * <td>Called when the view is attached to a window. 238 * </td> 239 * </tr> 240 * 241 * <tr> 242 * <td><code>{@link #onDetachedFromWindow}</code></td> 243 * <td>Called when the view is detached from its window. 244 * </td> 245 * </tr> 246 * 247 * <tr> 248 * <td><code>{@link #onWindowVisibilityChanged}</code></td> 249 * <td>Called when the visibility of the window containing the view 250 * has changed. 251 * </td> 252 * </tr> 253 * </tbody> 254 * 255 * </table> 256 * </p> 257 * 258 * <a name="IDs"></a> 259 * <h3>IDs</h3> 260 * Views may have an integer id associated with them. These ids are typically 261 * assigned in the layout XML files, and are used to find specific views within 262 * the view tree. A common pattern is to: 263 * <ul> 264 * <li>Define a Button in the layout file and assign it a unique ID. 265 * <pre> 266 * <Button 267 * android:id="@+id/my_button" 268 * android:layout_width="wrap_content" 269 * android:layout_height="wrap_content" 270 * android:text="@string/my_button_text"/> 271 * </pre></li> 272 * <li>From the onCreate method of an Activity, find the Button 273 * <pre class="prettyprint"> 274 * Button myButton = (Button) findViewById(R.id.my_button); 275 * </pre></li> 276 * </ul> 277 * <p> 278 * View IDs need not be unique throughout the tree, but it is good practice to 279 * ensure that they are at least unique within the part of the tree you are 280 * searching. 281 * </p> 282 * 283 * <a name="Position"></a> 284 * <h3>Position</h3> 285 * <p> 286 * The geometry of a view is that of a rectangle. A view has a location, 287 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and 288 * two dimensions, expressed as a width and a height. The unit for location 289 * and dimensions is the pixel. 290 * </p> 291 * 292 * <p> 293 * It is possible to retrieve the location of a view by invoking the methods 294 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X, 295 * coordinate of the rectangle representing the view. The latter returns the 296 * top, or Y, coordinate of the rectangle representing the view. These methods 297 * both return the location of the view relative to its parent. For instance, 298 * when getLeft() returns 20, that means the view is located 20 pixels to the 299 * right of the left edge of its direct parent. 300 * </p> 301 * 302 * <p> 303 * In addition, several convenience methods are offered to avoid unnecessary 304 * computations, namely {@link #getRight()} and {@link #getBottom()}. 305 * These methods return the coordinates of the right and bottom edges of the 306 * rectangle representing the view. For instance, calling {@link #getRight()} 307 * is similar to the following computation: <code>getLeft() + getWidth()</code> 308 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.) 309 * </p> 310 * 311 * <a name="SizePaddingMargins"></a> 312 * <h3>Size, padding and margins</h3> 313 * <p> 314 * The size of a view is expressed with a width and a height. A view actually 315 * possess two pairs of width and height values. 316 * </p> 317 * 318 * <p> 319 * The first pair is known as <em>measured width</em> and 320 * <em>measured height</em>. These dimensions define how big a view wants to be 321 * within its parent (see <a href="#Layout">Layout</a> for more details.) The 322 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()} 323 * and {@link #getMeasuredHeight()}. 324 * </p> 325 * 326 * <p> 327 * The second pair is simply known as <em>width</em> and <em>height</em>, or 328 * sometimes <em>drawing width</em> and <em>drawing height</em>. These 329 * dimensions define the actual size of the view on screen, at drawing time and 330 * after layout. These values may, but do not have to, be different from the 331 * measured width and height. The width and height can be obtained by calling 332 * {@link #getWidth()} and {@link #getHeight()}. 333 * </p> 334 * 335 * <p> 336 * To measure its dimensions, a view takes into account its padding. The padding 337 * is expressed in pixels for the left, top, right and bottom parts of the view. 338 * Padding can be used to offset the content of the view by a specific amount of 339 * pixels. For instance, a left padding of 2 will push the view's content by 340 * 2 pixels to the right of the left edge. Padding can be set using the 341 * {@link #setPadding(int, int, int, int)} method and queried by calling 342 * {@link #getPaddingLeft()}, {@link #getPaddingTop()}, 343 * {@link #getPaddingRight()} and {@link #getPaddingBottom()}. 344 * </p> 345 * 346 * <p> 347 * Even though a view can define a padding, it does not provide any support for 348 * margins. However, view groups provide such a support. Refer to 349 * {@link android.view.ViewGroup} and 350 * {@link android.view.ViewGroup.MarginLayoutParams} for further information. 351 * </p> 352 * 353 * <a name="Layout"></a> 354 * <h3>Layout</h3> 355 * <p> 356 * Layout is a two pass process: a measure pass and a layout pass. The measuring 357 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal 358 * of the view tree. Each view pushes dimension specifications down the tree 359 * during the recursion. At the end of the measure pass, every view has stored 360 * its measurements. The second pass happens in 361 * {@link #layout(int,int,int,int)} and is also top-down. During 362 * this pass each parent is responsible for positioning all of its children 363 * using the sizes computed in the measure pass. 364 * </p> 365 * 366 * <p> 367 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and 368 * {@link #getMeasuredHeight()} values must be set, along with those for all of 369 * that view's descendants. A view's measured width and measured height values 370 * must respect the constraints imposed by the view's parents. This guarantees 371 * that at the end of the measure pass, all parents accept all of their 372 * children's measurements. A parent view may call measure() more than once on 373 * its children. For example, the parent may measure each child once with 374 * unspecified dimensions to find out how big they want to be, then call 375 * measure() on them again with actual numbers if the sum of all the children's 376 * unconstrained sizes is too big or too small. 377 * </p> 378 * 379 * <p> 380 * The measure pass uses two classes to communicate dimensions. The 381 * {@link MeasureSpec} class is used by views to tell their parents how they 382 * want to be measured and positioned. The base LayoutParams class just 383 * describes how big the view wants to be for both width and height. For each 384 * dimension, it can specify one of: 385 * <ul> 386 * <li> an exact number 387 * <li>MATCH_PARENT, which means the view wants to be as big as its parent 388 * (minus padding) 389 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to 390 * enclose its content (plus padding). 391 * </ul> 392 * There are subclasses of LayoutParams for different subclasses of ViewGroup. 393 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds 394 * an X and Y value. 395 * </p> 396 * 397 * <p> 398 * MeasureSpecs are used to push requirements down the tree from parent to 399 * child. A MeasureSpec can be in one of three modes: 400 * <ul> 401 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension 402 * of a child view. For example, a LinearLayout may call measure() on its child 403 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how 404 * tall the child view wants to be given a width of 240 pixels. 405 * <li>EXACTLY: This is used by the parent to impose an exact size on the 406 * child. The child must use this size, and guarantee that all of its 407 * descendants will fit within this size. 408 * <li>AT_MOST: This is used by the parent to impose a maximum size on the 409 * child. The child must gurantee that it and all of its descendants will fit 410 * within this size. 411 * </ul> 412 * </p> 413 * 414 * <p> 415 * To intiate a layout, call {@link #requestLayout}. This method is typically 416 * called by a view on itself when it believes that is can no longer fit within 417 * its current bounds. 418 * </p> 419 * 420 * <a name="Drawing"></a> 421 * <h3>Drawing</h3> 422 * <p> 423 * Drawing is handled by walking the tree and rendering each view that 424 * intersects the the invalid region. Because the tree is traversed in-order, 425 * this means that parents will draw before (i.e., behind) their children, with 426 * siblings drawn in the order they appear in the tree. 427 * If you set a background drawable for a View, then the View will draw it for you 428 * before calling back to its <code>onDraw()</code> method. 429 * </p> 430 * 431 * <p> 432 * Note that the framework will not draw views that are not in the invalid region. 433 * </p> 434 * 435 * <p> 436 * To force a view to draw, call {@link #invalidate()}. 437 * </p> 438 * 439 * <a name="EventHandlingThreading"></a> 440 * <h3>Event Handling and Threading</h3> 441 * <p> 442 * The basic cycle of a view is as follows: 443 * <ol> 444 * <li>An event comes in and is dispatched to the appropriate view. The view 445 * handles the event and notifies any listeners.</li> 446 * <li>If in the course of processing the event, the view's bounds may need 447 * to be changed, the view will call {@link #requestLayout()}.</li> 448 * <li>Similarly, if in the course of processing the event the view's appearance 449 * may need to be changed, the view will call {@link #invalidate()}.</li> 450 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called, 451 * the framework will take care of measuring, laying out, and drawing the tree 452 * as appropriate.</li> 453 * </ol> 454 * </p> 455 * 456 * <p><em>Note: The entire view tree is single threaded. You must always be on 457 * the UI thread when calling any method on any view.</em> 458 * If you are doing work on other threads and want to update the state of a view 459 * from that thread, you should use a {@link Handler}. 460 * </p> 461 * 462 * <a name="FocusHandling"></a> 463 * <h3>Focus Handling</h3> 464 * <p> 465 * The framework will handle routine focus movement in response to user input. 466 * This includes changing the focus as views are removed or hidden, or as new 467 * views become available. Views indicate their willingness to take focus 468 * through the {@link #isFocusable} method. To change whether a view can take 469 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below) 470 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode} 471 * and can change this via {@link #setFocusableInTouchMode(boolean)}. 472 * </p> 473 * <p> 474 * Focus movement is based on an algorithm which finds the nearest neighbor in a 475 * given direction. In rare cases, the default algorithm may not match the 476 * intended behavior of the developer. In these situations, you can provide 477 * explicit overrides by using these XML attributes in the layout file: 478 * <pre> 479 * nextFocusDown 480 * nextFocusLeft 481 * nextFocusRight 482 * nextFocusUp 483 * </pre> 484 * </p> 485 * 486 * 487 * <p> 488 * To get a particular view to take focus, call {@link #requestFocus()}. 489 * </p> 490 * 491 * <a name="TouchMode"></a> 492 * <h3>Touch Mode</h3> 493 * <p> 494 * When a user is navigating a user interface via directional keys such as a D-pad, it is 495 * necessary to give focus to actionable items such as buttons so the user can see 496 * what will take input. If the device has touch capabilities, however, and the user 497 * begins interacting with the interface by touching it, it is no longer necessary to 498 * always highlight, or give focus to, a particular view. This motivates a mode 499 * for interaction named 'touch mode'. 500 * </p> 501 * <p> 502 * For a touch capable device, once the user touches the screen, the device 503 * will enter touch mode. From this point onward, only views for which 504 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets. 505 * Other views that are touchable, like buttons, will not take focus when touched; they will 506 * only fire the on click listeners. 507 * </p> 508 * <p> 509 * Any time a user hits a directional key, such as a D-pad direction, the view device will 510 * exit touch mode, and find a view to take focus, so that the user may resume interacting 511 * with the user interface without touching the screen again. 512 * </p> 513 * <p> 514 * The touch mode state is maintained across {@link android.app.Activity}s. Call 515 * {@link #isInTouchMode} to see whether the device is currently in touch mode. 516 * </p> 517 * 518 * <a name="Scrolling"></a> 519 * <h3>Scrolling</h3> 520 * <p> 521 * The framework provides basic support for views that wish to internally 522 * scroll their content. This includes keeping track of the X and Y scroll 523 * offset as well as mechanisms for drawing scrollbars. See 524 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and 525 * {@link #awakenScrollBars()} for more details. 526 * </p> 527 * 528 * <a name="Tags"></a> 529 * <h3>Tags</h3> 530 * <p> 531 * Unlike IDs, tags are not used to identify views. Tags are essentially an 532 * extra piece of information that can be associated with a view. They are most 533 * often used as a convenience to store data related to views in the views 534 * themselves rather than by putting them in a separate structure. 535 * </p> 536 * 537 * <a name="Animation"></a> 538 * <h3>Animation</h3> 539 * <p> 540 * You can attach an {@link Animation} object to a view using 541 * {@link #setAnimation(Animation)} or 542 * {@link #startAnimation(Animation)}. The animation can alter the scale, 543 * rotation, translation and alpha of a view over time. If the animation is 544 * attached to a view that has children, the animation will affect the entire 545 * subtree rooted by that node. When an animation is started, the framework will 546 * take care of redrawing the appropriate views until the animation completes. 547 * </p> 548 * <p> 549 * Starting with Android 3.0, the preferred way of animating views is to use the 550 * {@link android.animation} package APIs. 551 * </p> 552 * 553 * <a name="Security"></a> 554 * <h3>Security</h3> 555 * <p> 556 * Sometimes it is essential that an application be able to verify that an action 557 * is being performed with the full knowledge and consent of the user, such as 558 * granting a permission request, making a purchase or clicking on an advertisement. 559 * Unfortunately, a malicious application could try to spoof the user into 560 * performing these actions, unaware, by concealing the intended purpose of the view. 561 * As a remedy, the framework offers a touch filtering mechanism that can be used to 562 * improve the security of views that provide access to sensitive functionality. 563 * </p><p> 564 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured} or set the 565 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework 566 * will discard touches that are received whenever the view's window is obscured by 567 * another visible window. As a result, the view will not receive touches whenever a 568 * toast, dialog or other window appears above the view's window. 569 * </p><p> 570 * For more fine-grained control over security, consider overriding the 571 * {@link #onFilterTouchEventForSecurity} method to implement your own security policy. 572 * See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}. 573 * </p> 574 * 575 * @attr ref android.R.styleable#View_alpha 576 * @attr ref android.R.styleable#View_background 577 * @attr ref android.R.styleable#View_clickable 578 * @attr ref android.R.styleable#View_contentDescription 579 * @attr ref android.R.styleable#View_drawingCacheQuality 580 * @attr ref android.R.styleable#View_duplicateParentState 581 * @attr ref android.R.styleable#View_id 582 * @attr ref android.R.styleable#View_fadingEdge 583 * @attr ref android.R.styleable#View_fadingEdgeLength 584 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 585 * @attr ref android.R.styleable#View_fitsSystemWindows 586 * @attr ref android.R.styleable#View_isScrollContainer 587 * @attr ref android.R.styleable#View_focusable 588 * @attr ref android.R.styleable#View_focusableInTouchMode 589 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 590 * @attr ref android.R.styleable#View_keepScreenOn 591 * @attr ref android.R.styleable#View_layerType 592 * @attr ref android.R.styleable#View_longClickable 593 * @attr ref android.R.styleable#View_minHeight 594 * @attr ref android.R.styleable#View_minWidth 595 * @attr ref android.R.styleable#View_nextFocusDown 596 * @attr ref android.R.styleable#View_nextFocusLeft 597 * @attr ref android.R.styleable#View_nextFocusRight 598 * @attr ref android.R.styleable#View_nextFocusUp 599 * @attr ref android.R.styleable#View_onClick 600 * @attr ref android.R.styleable#View_padding 601 * @attr ref android.R.styleable#View_paddingBottom 602 * @attr ref android.R.styleable#View_paddingLeft 603 * @attr ref android.R.styleable#View_paddingRight 604 * @attr ref android.R.styleable#View_paddingTop 605 * @attr ref android.R.styleable#View_saveEnabled 606 * @attr ref android.R.styleable#View_rotation 607 * @attr ref android.R.styleable#View_rotationX 608 * @attr ref android.R.styleable#View_rotationY 609 * @attr ref android.R.styleable#View_scaleX 610 * @attr ref android.R.styleable#View_scaleY 611 * @attr ref android.R.styleable#View_scrollX 612 * @attr ref android.R.styleable#View_scrollY 613 * @attr ref android.R.styleable#View_scrollbarSize 614 * @attr ref android.R.styleable#View_scrollbarStyle 615 * @attr ref android.R.styleable#View_scrollbars 616 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 617 * @attr ref android.R.styleable#View_scrollbarFadeDuration 618 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal 619 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal 620 * @attr ref android.R.styleable#View_scrollbarThumbVertical 621 * @attr ref android.R.styleable#View_scrollbarTrackVertical 622 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack 623 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack 624 * @attr ref android.R.styleable#View_soundEffectsEnabled 625 * @attr ref android.R.styleable#View_tag 626 * @attr ref android.R.styleable#View_transformPivotX 627 * @attr ref android.R.styleable#View_transformPivotY 628 * @attr ref android.R.styleable#View_translationX 629 * @attr ref android.R.styleable#View_translationY 630 * @attr ref android.R.styleable#View_visibility 631 * 632 * @see android.view.ViewGroup 633 */ 634public class View implements Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource { 635 private static final boolean DBG = false; 636 637 /** 638 * The logging tag used by this class with android.util.Log. 639 */ 640 protected static final String VIEW_LOG_TAG = "View"; 641 642 /** 643 * Used to mark a View that has no ID. 644 */ 645 public static final int NO_ID = -1; 646 647 /** 648 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when 649 * calling setFlags. 650 */ 651 private static final int NOT_FOCUSABLE = 0x00000000; 652 653 /** 654 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling 655 * setFlags. 656 */ 657 private static final int FOCUSABLE = 0x00000001; 658 659 /** 660 * Mask for use with setFlags indicating bits used for focus. 661 */ 662 private static final int FOCUSABLE_MASK = 0x00000001; 663 664 /** 665 * This view will adjust its padding to fit sytem windows (e.g. status bar) 666 */ 667 private static final int FITS_SYSTEM_WINDOWS = 0x00000002; 668 669 /** 670 * This view is visible. Use with {@link #setVisibility}. 671 */ 672 public static final int VISIBLE = 0x00000000; 673 674 /** 675 * This view is invisible, but it still takes up space for layout purposes. 676 * Use with {@link #setVisibility}. 677 */ 678 public static final int INVISIBLE = 0x00000004; 679 680 /** 681 * This view is invisible, and it doesn't take any space for layout 682 * purposes. Use with {@link #setVisibility}. 683 */ 684 public static final int GONE = 0x00000008; 685 686 /** 687 * Mask for use with setFlags indicating bits used for visibility. 688 * {@hide} 689 */ 690 static final int VISIBILITY_MASK = 0x0000000C; 691 692 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE}; 693 694 /** 695 * This view is enabled. Intrepretation varies by subclass. 696 * Use with ENABLED_MASK when calling setFlags. 697 * {@hide} 698 */ 699 static final int ENABLED = 0x00000000; 700 701 /** 702 * This view is disabled. Intrepretation varies by subclass. 703 * Use with ENABLED_MASK when calling setFlags. 704 * {@hide} 705 */ 706 static final int DISABLED = 0x00000020; 707 708 /** 709 * Mask for use with setFlags indicating bits used for indicating whether 710 * this view is enabled 711 * {@hide} 712 */ 713 static final int ENABLED_MASK = 0x00000020; 714 715 /** 716 * This view won't draw. {@link #onDraw} won't be called and further 717 * optimizations 718 * will be performed. It is okay to have this flag set and a background. 719 * Use with DRAW_MASK when calling setFlags. 720 * {@hide} 721 */ 722 static final int WILL_NOT_DRAW = 0x00000080; 723 724 /** 725 * Mask for use with setFlags indicating bits used for indicating whether 726 * this view is will draw 727 * {@hide} 728 */ 729 static final int DRAW_MASK = 0x00000080; 730 731 /** 732 * <p>This view doesn't show scrollbars.</p> 733 * {@hide} 734 */ 735 static final int SCROLLBARS_NONE = 0x00000000; 736 737 /** 738 * <p>This view shows horizontal scrollbars.</p> 739 * {@hide} 740 */ 741 static final int SCROLLBARS_HORIZONTAL = 0x00000100; 742 743 /** 744 * <p>This view shows vertical scrollbars.</p> 745 * {@hide} 746 */ 747 static final int SCROLLBARS_VERTICAL = 0x00000200; 748 749 /** 750 * <p>Mask for use with setFlags indicating bits used for indicating which 751 * scrollbars are enabled.</p> 752 * {@hide} 753 */ 754 static final int SCROLLBARS_MASK = 0x00000300; 755 756 /** 757 * Indicates that the view should filter touches when its window is obscured. 758 * Refer to the class comments for more information about this security feature. 759 * {@hide} 760 */ 761 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400; 762 763 // note flag value 0x00000800 is now available for next flags... 764 765 /** 766 * <p>This view doesn't show fading edges.</p> 767 * {@hide} 768 */ 769 static final int FADING_EDGE_NONE = 0x00000000; 770 771 /** 772 * <p>This view shows horizontal fading edges.</p> 773 * {@hide} 774 */ 775 static final int FADING_EDGE_HORIZONTAL = 0x00001000; 776 777 /** 778 * <p>This view shows vertical fading edges.</p> 779 * {@hide} 780 */ 781 static final int FADING_EDGE_VERTICAL = 0x00002000; 782 783 /** 784 * <p>Mask for use with setFlags indicating bits used for indicating which 785 * fading edges are enabled.</p> 786 * {@hide} 787 */ 788 static final int FADING_EDGE_MASK = 0x00003000; 789 790 /** 791 * <p>Indicates this view can be clicked. When clickable, a View reacts 792 * to clicks by notifying the OnClickListener.<p> 793 * {@hide} 794 */ 795 static final int CLICKABLE = 0x00004000; 796 797 /** 798 * <p>Indicates this view is caching its drawing into a bitmap.</p> 799 * {@hide} 800 */ 801 static final int DRAWING_CACHE_ENABLED = 0x00008000; 802 803 /** 804 * <p>Indicates that no icicle should be saved for this view.<p> 805 * {@hide} 806 */ 807 static final int SAVE_DISABLED = 0x000010000; 808 809 /** 810 * <p>Mask for use with setFlags indicating bits used for the saveEnabled 811 * property.</p> 812 * {@hide} 813 */ 814 static final int SAVE_DISABLED_MASK = 0x000010000; 815 816 /** 817 * <p>Indicates that no drawing cache should ever be created for this view.<p> 818 * {@hide} 819 */ 820 static final int WILL_NOT_CACHE_DRAWING = 0x000020000; 821 822 /** 823 * <p>Indicates this view can take / keep focus when int touch mode.</p> 824 * {@hide} 825 */ 826 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000; 827 828 /** 829 * <p>Enables low quality mode for the drawing cache.</p> 830 */ 831 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000; 832 833 /** 834 * <p>Enables high quality mode for the drawing cache.</p> 835 */ 836 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000; 837 838 /** 839 * <p>Enables automatic quality mode for the drawing cache.</p> 840 */ 841 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000; 842 843 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = { 844 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH 845 }; 846 847 /** 848 * <p>Mask for use with setFlags indicating bits used for the cache 849 * quality property.</p> 850 * {@hide} 851 */ 852 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000; 853 854 /** 855 * <p> 856 * Indicates this view can be long clicked. When long clickable, a View 857 * reacts to long clicks by notifying the OnLongClickListener or showing a 858 * context menu. 859 * </p> 860 * {@hide} 861 */ 862 static final int LONG_CLICKABLE = 0x00200000; 863 864 /** 865 * <p>Indicates that this view gets its drawable states from its direct parent 866 * and ignores its original internal states.</p> 867 * 868 * @hide 869 */ 870 static final int DUPLICATE_PARENT_STATE = 0x00400000; 871 872 /** 873 * The scrollbar style to display the scrollbars inside the content area, 874 * without increasing the padding. The scrollbars will be overlaid with 875 * translucency on the view's content. 876 */ 877 public static final int SCROLLBARS_INSIDE_OVERLAY = 0; 878 879 /** 880 * The scrollbar style to display the scrollbars inside the padded area, 881 * increasing the padding of the view. The scrollbars will not overlap the 882 * content area of the view. 883 */ 884 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000; 885 886 /** 887 * The scrollbar style to display the scrollbars at the edge of the view, 888 * without increasing the padding. The scrollbars will be overlaid with 889 * translucency. 890 */ 891 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000; 892 893 /** 894 * The scrollbar style to display the scrollbars at the edge of the view, 895 * increasing the padding of the view. The scrollbars will only overlap the 896 * background, if any. 897 */ 898 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000; 899 900 /** 901 * Mask to check if the scrollbar style is overlay or inset. 902 * {@hide} 903 */ 904 static final int SCROLLBARS_INSET_MASK = 0x01000000; 905 906 /** 907 * Mask to check if the scrollbar style is inside or outside. 908 * {@hide} 909 */ 910 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000; 911 912 /** 913 * Mask for scrollbar style. 914 * {@hide} 915 */ 916 static final int SCROLLBARS_STYLE_MASK = 0x03000000; 917 918 /** 919 * View flag indicating that the screen should remain on while the 920 * window containing this view is visible to the user. This effectively 921 * takes care of automatically setting the WindowManager's 922 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}. 923 */ 924 public static final int KEEP_SCREEN_ON = 0x04000000; 925 926 /** 927 * View flag indicating whether this view should have sound effects enabled 928 * for events such as clicking and touching. 929 */ 930 public static final int SOUND_EFFECTS_ENABLED = 0x08000000; 931 932 /** 933 * View flag indicating whether this view should have haptic feedback 934 * enabled for events such as long presses. 935 */ 936 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000; 937 938 /** 939 * <p>Indicates that the view hierarchy should stop saving state when 940 * it reaches this view. If state saving is initiated immediately at 941 * the view, it will be allowed. 942 * {@hide} 943 */ 944 static final int PARENT_SAVE_DISABLED = 0x20000000; 945 946 /** 947 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p> 948 * {@hide} 949 */ 950 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000; 951 952 /** 953 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 954 * should add all focusable Views regardless if they are focusable in touch mode. 955 */ 956 public static final int FOCUSABLES_ALL = 0x00000000; 957 958 /** 959 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 960 * should add only Views focusable in touch mode. 961 */ 962 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001; 963 964 /** 965 * Use with {@link #focusSearch}. Move focus to the previous selectable 966 * item. 967 */ 968 public static final int FOCUS_BACKWARD = 0x00000001; 969 970 /** 971 * Use with {@link #focusSearch}. Move focus to the next selectable 972 * item. 973 */ 974 public static final int FOCUS_FORWARD = 0x00000002; 975 976 /** 977 * Use with {@link #focusSearch}. Move focus to the left. 978 */ 979 public static final int FOCUS_LEFT = 0x00000011; 980 981 /** 982 * Use with {@link #focusSearch}. Move focus up. 983 */ 984 public static final int FOCUS_UP = 0x00000021; 985 986 /** 987 * Use with {@link #focusSearch}. Move focus to the right. 988 */ 989 public static final int FOCUS_RIGHT = 0x00000042; 990 991 /** 992 * Use with {@link #focusSearch}. Move focus down. 993 */ 994 public static final int FOCUS_DOWN = 0x00000082; 995 996 /** 997 * Bits of {@link #getMeasuredWidthAndState()} and 998 * {@link #getMeasuredWidthAndState()} that provide the actual measured size. 999 */ 1000 public static final int MEASURED_SIZE_MASK = 0x00ffffff; 1001 1002 /** 1003 * Bits of {@link #getMeasuredWidthAndState()} and 1004 * {@link #getMeasuredWidthAndState()} that provide the additional state bits. 1005 */ 1006 public static final int MEASURED_STATE_MASK = 0xff000000; 1007 1008 /** 1009 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits 1010 * for functions that combine both width and height into a single int, 1011 * such as {@link #getMeasuredState()} and the childState argument of 1012 * {@link #resolveSizeAndState(int, int, int)}. 1013 */ 1014 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16; 1015 1016 /** 1017 * Bit of {@link #getMeasuredWidthAndState()} and 1018 * {@link #getMeasuredWidthAndState()} that indicates the measured size 1019 * is smaller that the space the view would like to have. 1020 */ 1021 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000; 1022 1023 /** 1024 * Base View state sets 1025 */ 1026 // Singles 1027 /** 1028 * Indicates the view has no states set. States are used with 1029 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1030 * view depending on its state. 1031 * 1032 * @see android.graphics.drawable.Drawable 1033 * @see #getDrawableState() 1034 */ 1035 protected static final int[] EMPTY_STATE_SET; 1036 /** 1037 * Indicates the view is enabled. States are used with 1038 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1039 * view depending on its state. 1040 * 1041 * @see android.graphics.drawable.Drawable 1042 * @see #getDrawableState() 1043 */ 1044 protected static final int[] ENABLED_STATE_SET; 1045 /** 1046 * Indicates the view is focused. States are used with 1047 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1048 * view depending on its state. 1049 * 1050 * @see android.graphics.drawable.Drawable 1051 * @see #getDrawableState() 1052 */ 1053 protected static final int[] FOCUSED_STATE_SET; 1054 /** 1055 * Indicates the view is selected. States are used with 1056 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1057 * view depending on its state. 1058 * 1059 * @see android.graphics.drawable.Drawable 1060 * @see #getDrawableState() 1061 */ 1062 protected static final int[] SELECTED_STATE_SET; 1063 /** 1064 * Indicates the view is pressed. States are used with 1065 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1066 * view depending on its state. 1067 * 1068 * @see android.graphics.drawable.Drawable 1069 * @see #getDrawableState() 1070 * @hide 1071 */ 1072 protected static final int[] PRESSED_STATE_SET; 1073 /** 1074 * Indicates the view's window has focus. States are used with 1075 * {@link android.graphics.drawable.Drawable} to change the drawing of the 1076 * view depending on its state. 1077 * 1078 * @see android.graphics.drawable.Drawable 1079 * @see #getDrawableState() 1080 */ 1081 protected static final int[] WINDOW_FOCUSED_STATE_SET; 1082 // Doubles 1083 /** 1084 * Indicates the view is enabled and has the focus. 1085 * 1086 * @see #ENABLED_STATE_SET 1087 * @see #FOCUSED_STATE_SET 1088 */ 1089 protected static final int[] ENABLED_FOCUSED_STATE_SET; 1090 /** 1091 * Indicates the view is enabled and selected. 1092 * 1093 * @see #ENABLED_STATE_SET 1094 * @see #SELECTED_STATE_SET 1095 */ 1096 protected static final int[] ENABLED_SELECTED_STATE_SET; 1097 /** 1098 * Indicates the view is enabled and that its window has focus. 1099 * 1100 * @see #ENABLED_STATE_SET 1101 * @see #WINDOW_FOCUSED_STATE_SET 1102 */ 1103 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET; 1104 /** 1105 * Indicates the view is focused and selected. 1106 * 1107 * @see #FOCUSED_STATE_SET 1108 * @see #SELECTED_STATE_SET 1109 */ 1110 protected static final int[] FOCUSED_SELECTED_STATE_SET; 1111 /** 1112 * Indicates the view has the focus and that its window has the focus. 1113 * 1114 * @see #FOCUSED_STATE_SET 1115 * @see #WINDOW_FOCUSED_STATE_SET 1116 */ 1117 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET; 1118 /** 1119 * Indicates the view is selected and that its window has the focus. 1120 * 1121 * @see #SELECTED_STATE_SET 1122 * @see #WINDOW_FOCUSED_STATE_SET 1123 */ 1124 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET; 1125 // Triples 1126 /** 1127 * Indicates the view is enabled, focused and selected. 1128 * 1129 * @see #ENABLED_STATE_SET 1130 * @see #FOCUSED_STATE_SET 1131 * @see #SELECTED_STATE_SET 1132 */ 1133 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET; 1134 /** 1135 * Indicates the view is enabled, focused and its window has the focus. 1136 * 1137 * @see #ENABLED_STATE_SET 1138 * @see #FOCUSED_STATE_SET 1139 * @see #WINDOW_FOCUSED_STATE_SET 1140 */ 1141 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1142 /** 1143 * Indicates the view is enabled, selected and its window has the focus. 1144 * 1145 * @see #ENABLED_STATE_SET 1146 * @see #SELECTED_STATE_SET 1147 * @see #WINDOW_FOCUSED_STATE_SET 1148 */ 1149 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1150 /** 1151 * Indicates the view is focused, selected and its window has the focus. 1152 * 1153 * @see #FOCUSED_STATE_SET 1154 * @see #SELECTED_STATE_SET 1155 * @see #WINDOW_FOCUSED_STATE_SET 1156 */ 1157 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1158 /** 1159 * Indicates the view is enabled, focused, selected and its window 1160 * has the focus. 1161 * 1162 * @see #ENABLED_STATE_SET 1163 * @see #FOCUSED_STATE_SET 1164 * @see #SELECTED_STATE_SET 1165 * @see #WINDOW_FOCUSED_STATE_SET 1166 */ 1167 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1168 /** 1169 * Indicates the view is pressed and its window has the focus. 1170 * 1171 * @see #PRESSED_STATE_SET 1172 * @see #WINDOW_FOCUSED_STATE_SET 1173 */ 1174 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET; 1175 /** 1176 * Indicates the view is pressed and selected. 1177 * 1178 * @see #PRESSED_STATE_SET 1179 * @see #SELECTED_STATE_SET 1180 */ 1181 protected static final int[] PRESSED_SELECTED_STATE_SET; 1182 /** 1183 * Indicates the view is pressed, selected and its window has the focus. 1184 * 1185 * @see #PRESSED_STATE_SET 1186 * @see #SELECTED_STATE_SET 1187 * @see #WINDOW_FOCUSED_STATE_SET 1188 */ 1189 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1190 /** 1191 * Indicates the view is pressed and focused. 1192 * 1193 * @see #PRESSED_STATE_SET 1194 * @see #FOCUSED_STATE_SET 1195 */ 1196 protected static final int[] PRESSED_FOCUSED_STATE_SET; 1197 /** 1198 * Indicates the view is pressed, focused and its window has the focus. 1199 * 1200 * @see #PRESSED_STATE_SET 1201 * @see #FOCUSED_STATE_SET 1202 * @see #WINDOW_FOCUSED_STATE_SET 1203 */ 1204 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1205 /** 1206 * Indicates the view is pressed, focused and selected. 1207 * 1208 * @see #PRESSED_STATE_SET 1209 * @see #SELECTED_STATE_SET 1210 * @see #FOCUSED_STATE_SET 1211 */ 1212 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET; 1213 /** 1214 * Indicates the view is pressed, focused, selected and its window has the focus. 1215 * 1216 * @see #PRESSED_STATE_SET 1217 * @see #FOCUSED_STATE_SET 1218 * @see #SELECTED_STATE_SET 1219 * @see #WINDOW_FOCUSED_STATE_SET 1220 */ 1221 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1222 /** 1223 * Indicates the view is pressed and enabled. 1224 * 1225 * @see #PRESSED_STATE_SET 1226 * @see #ENABLED_STATE_SET 1227 */ 1228 protected static final int[] PRESSED_ENABLED_STATE_SET; 1229 /** 1230 * Indicates the view is pressed, enabled and its window has the focus. 1231 * 1232 * @see #PRESSED_STATE_SET 1233 * @see #ENABLED_STATE_SET 1234 * @see #WINDOW_FOCUSED_STATE_SET 1235 */ 1236 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET; 1237 /** 1238 * Indicates the view is pressed, enabled and selected. 1239 * 1240 * @see #PRESSED_STATE_SET 1241 * @see #ENABLED_STATE_SET 1242 * @see #SELECTED_STATE_SET 1243 */ 1244 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET; 1245 /** 1246 * Indicates the view is pressed, enabled, selected and its window has the 1247 * focus. 1248 * 1249 * @see #PRESSED_STATE_SET 1250 * @see #ENABLED_STATE_SET 1251 * @see #SELECTED_STATE_SET 1252 * @see #WINDOW_FOCUSED_STATE_SET 1253 */ 1254 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1255 /** 1256 * Indicates the view is pressed, enabled and focused. 1257 * 1258 * @see #PRESSED_STATE_SET 1259 * @see #ENABLED_STATE_SET 1260 * @see #FOCUSED_STATE_SET 1261 */ 1262 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET; 1263 /** 1264 * Indicates the view is pressed, enabled, focused and its window has the 1265 * focus. 1266 * 1267 * @see #PRESSED_STATE_SET 1268 * @see #ENABLED_STATE_SET 1269 * @see #FOCUSED_STATE_SET 1270 * @see #WINDOW_FOCUSED_STATE_SET 1271 */ 1272 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET; 1273 /** 1274 * Indicates the view is pressed, enabled, focused and selected. 1275 * 1276 * @see #PRESSED_STATE_SET 1277 * @see #ENABLED_STATE_SET 1278 * @see #SELECTED_STATE_SET 1279 * @see #FOCUSED_STATE_SET 1280 */ 1281 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET; 1282 /** 1283 * Indicates the view is pressed, enabled, focused, selected and its window 1284 * has the focus. 1285 * 1286 * @see #PRESSED_STATE_SET 1287 * @see #ENABLED_STATE_SET 1288 * @see #SELECTED_STATE_SET 1289 * @see #FOCUSED_STATE_SET 1290 * @see #WINDOW_FOCUSED_STATE_SET 1291 */ 1292 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET; 1293 1294 /** 1295 * The order here is very important to {@link #getDrawableState()} 1296 */ 1297 private static final int[][] VIEW_STATE_SETS; 1298 1299 static final int VIEW_STATE_WINDOW_FOCUSED = 1; 1300 static final int VIEW_STATE_SELECTED = 1 << 1; 1301 static final int VIEW_STATE_FOCUSED = 1 << 2; 1302 static final int VIEW_STATE_ENABLED = 1 << 3; 1303 static final int VIEW_STATE_PRESSED = 1 << 4; 1304 static final int VIEW_STATE_ACTIVATED = 1 << 5; 1305 static final int VIEW_STATE_ACCELERATED = 1 << 6; 1306 1307 static final int[] VIEW_STATE_IDS = new int[] { 1308 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED, 1309 R.attr.state_selected, VIEW_STATE_SELECTED, 1310 R.attr.state_focused, VIEW_STATE_FOCUSED, 1311 R.attr.state_enabled, VIEW_STATE_ENABLED, 1312 R.attr.state_pressed, VIEW_STATE_PRESSED, 1313 R.attr.state_activated, VIEW_STATE_ACTIVATED, 1314 R.attr.state_accelerated, VIEW_STATE_ACCELERATED, 1315 }; 1316 1317 static { 1318 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) { 1319 throw new IllegalStateException( 1320 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array"); 1321 } 1322 int[] orderedIds = new int[VIEW_STATE_IDS.length]; 1323 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) { 1324 int viewState = R.styleable.ViewDrawableStates[i]; 1325 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) { 1326 if (VIEW_STATE_IDS[j] == viewState) { 1327 orderedIds[i * 2] = viewState; 1328 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1]; 1329 } 1330 } 1331 } 1332 final int NUM_BITS = VIEW_STATE_IDS.length / 2; 1333 VIEW_STATE_SETS = new int[1 << NUM_BITS][]; 1334 for (int i = 0; i < VIEW_STATE_SETS.length; i++) { 1335 int numBits = Integer.bitCount(i); 1336 int[] set = new int[numBits]; 1337 int pos = 0; 1338 for (int j = 0; j < orderedIds.length; j += 2) { 1339 if ((i & orderedIds[j+1]) != 0) { 1340 set[pos++] = orderedIds[j]; 1341 } 1342 } 1343 VIEW_STATE_SETS[i] = set; 1344 } 1345 1346 EMPTY_STATE_SET = VIEW_STATE_SETS[0]; 1347 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED]; 1348 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED]; 1349 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1350 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED]; 1351 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED]; 1352 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1353 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED]; 1354 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1355 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED]; 1356 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1357 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1358 | VIEW_STATE_FOCUSED]; 1359 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED]; 1360 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1361 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED]; 1362 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1363 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED]; 1364 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1365 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1366 | VIEW_STATE_ENABLED]; 1367 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1368 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED]; 1369 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1370 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1371 | VIEW_STATE_ENABLED]; 1372 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1373 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1374 | VIEW_STATE_ENABLED]; 1375 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1376 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1377 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED]; 1378 1379 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED]; 1380 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1381 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED]; 1382 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1383 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED]; 1384 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1385 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1386 | VIEW_STATE_PRESSED]; 1387 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1388 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1389 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1390 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1391 | VIEW_STATE_PRESSED]; 1392 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1393 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1394 | VIEW_STATE_PRESSED]; 1395 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1396 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1397 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED]; 1398 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[ 1399 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1400 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1401 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED 1402 | VIEW_STATE_PRESSED]; 1403 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1404 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED 1405 | VIEW_STATE_PRESSED]; 1406 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1407 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1408 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1409 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1410 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED 1411 | VIEW_STATE_PRESSED]; 1412 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1413 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED 1414 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1415 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[ 1416 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED 1417 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED]; 1418 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[ 1419 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED 1420 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED 1421 | VIEW_STATE_PRESSED]; 1422 } 1423 1424 /** 1425 * Used by views that contain lists of items. This state indicates that 1426 * the view is showing the last item. 1427 * @hide 1428 */ 1429 protected static final int[] LAST_STATE_SET = {R.attr.state_last}; 1430 /** 1431 * Used by views that contain lists of items. This state indicates that 1432 * the view is showing the first item. 1433 * @hide 1434 */ 1435 protected static final int[] FIRST_STATE_SET = {R.attr.state_first}; 1436 /** 1437 * Used by views that contain lists of items. This state indicates that 1438 * the view is showing the middle item. 1439 * @hide 1440 */ 1441 protected static final int[] MIDDLE_STATE_SET = {R.attr.state_middle}; 1442 /** 1443 * Used by views that contain lists of items. This state indicates that 1444 * the view is showing only one item. 1445 * @hide 1446 */ 1447 protected static final int[] SINGLE_STATE_SET = {R.attr.state_single}; 1448 /** 1449 * Used by views that contain lists of items. This state indicates that 1450 * the view is pressed and showing the last item. 1451 * @hide 1452 */ 1453 protected static final int[] PRESSED_LAST_STATE_SET = {R.attr.state_last, R.attr.state_pressed}; 1454 /** 1455 * Used by views that contain lists of items. This state indicates that 1456 * the view is pressed and showing the first item. 1457 * @hide 1458 */ 1459 protected static final int[] PRESSED_FIRST_STATE_SET = {R.attr.state_first, R.attr.state_pressed}; 1460 /** 1461 * Used by views that contain lists of items. This state indicates that 1462 * the view is pressed and showing the middle item. 1463 * @hide 1464 */ 1465 protected static final int[] PRESSED_MIDDLE_STATE_SET = {R.attr.state_middle, R.attr.state_pressed}; 1466 /** 1467 * Used by views that contain lists of items. This state indicates that 1468 * the view is pressed and showing only one item. 1469 * @hide 1470 */ 1471 protected static final int[] PRESSED_SINGLE_STATE_SET = {R.attr.state_single, R.attr.state_pressed}; 1472 1473 /** 1474 * Temporary Rect currently for use in setBackground(). This will probably 1475 * be extended in the future to hold our own class with more than just 1476 * a Rect. :) 1477 */ 1478 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>(); 1479 1480 /** 1481 * Map used to store views' tags. 1482 */ 1483 private static WeakHashMap<View, SparseArray<Object>> sTags; 1484 1485 /** 1486 * Lock used to access sTags. 1487 */ 1488 private static final Object sTagsLock = new Object(); 1489 1490 /** 1491 * The animation currently associated with this view. 1492 * @hide 1493 */ 1494 protected Animation mCurrentAnimation = null; 1495 1496 /** 1497 * Width as measured during measure pass. 1498 * {@hide} 1499 */ 1500 @ViewDebug.ExportedProperty(category = "measurement") 1501 /*package*/ int mMeasuredWidth; 1502 1503 /** 1504 * Height as measured during measure pass. 1505 * {@hide} 1506 */ 1507 @ViewDebug.ExportedProperty(category = "measurement") 1508 /*package*/ int mMeasuredHeight; 1509 1510 /** 1511 * Flag to indicate that this view was marked INVALIDATED, or had its display list 1512 * invalidated, prior to the current drawing iteration. If true, the view must re-draw 1513 * its display list. This flag, used only when hw accelerated, allows us to clear the 1514 * flag while retaining this information until it's needed (at getDisplayList() time and 1515 * in drawChild(), when we decide to draw a view's children's display lists into our own). 1516 * 1517 * {@hide} 1518 */ 1519 boolean mRecreateDisplayList = false; 1520 1521 /** 1522 * The view's identifier. 1523 * {@hide} 1524 * 1525 * @see #setId(int) 1526 * @see #getId() 1527 */ 1528 @ViewDebug.ExportedProperty(resolveId = true) 1529 int mID = NO_ID; 1530 1531 /** 1532 * The view's tag. 1533 * {@hide} 1534 * 1535 * @see #setTag(Object) 1536 * @see #getTag() 1537 */ 1538 protected Object mTag; 1539 1540 // for mPrivateFlags: 1541 /** {@hide} */ 1542 static final int WANTS_FOCUS = 0x00000001; 1543 /** {@hide} */ 1544 static final int FOCUSED = 0x00000002; 1545 /** {@hide} */ 1546 static final int SELECTED = 0x00000004; 1547 /** {@hide} */ 1548 static final int IS_ROOT_NAMESPACE = 0x00000008; 1549 /** {@hide} */ 1550 static final int HAS_BOUNDS = 0x00000010; 1551 /** {@hide} */ 1552 static final int DRAWN = 0x00000020; 1553 /** 1554 * When this flag is set, this view is running an animation on behalf of its 1555 * children and should therefore not cancel invalidate requests, even if they 1556 * lie outside of this view's bounds. 1557 * 1558 * {@hide} 1559 */ 1560 static final int DRAW_ANIMATION = 0x00000040; 1561 /** {@hide} */ 1562 static final int SKIP_DRAW = 0x00000080; 1563 /** {@hide} */ 1564 static final int ONLY_DRAWS_BACKGROUND = 0x00000100; 1565 /** {@hide} */ 1566 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200; 1567 /** {@hide} */ 1568 static final int DRAWABLE_STATE_DIRTY = 0x00000400; 1569 /** {@hide} */ 1570 static final int MEASURED_DIMENSION_SET = 0x00000800; 1571 /** {@hide} */ 1572 static final int FORCE_LAYOUT = 0x00001000; 1573 /** {@hide} */ 1574 static final int LAYOUT_REQUIRED = 0x00002000; 1575 1576 private static final int PRESSED = 0x00004000; 1577 1578 /** {@hide} */ 1579 static final int DRAWING_CACHE_VALID = 0x00008000; 1580 /** 1581 * Flag used to indicate that this view should be drawn once more (and only once 1582 * more) after its animation has completed. 1583 * {@hide} 1584 */ 1585 static final int ANIMATION_STARTED = 0x00010000; 1586 1587 private static final int SAVE_STATE_CALLED = 0x00020000; 1588 1589 /** 1590 * Indicates that the View returned true when onSetAlpha() was called and that 1591 * the alpha must be restored. 1592 * {@hide} 1593 */ 1594 static final int ALPHA_SET = 0x00040000; 1595 1596 /** 1597 * Set by {@link #setScrollContainer(boolean)}. 1598 */ 1599 static final int SCROLL_CONTAINER = 0x00080000; 1600 1601 /** 1602 * Set by {@link #setScrollContainer(boolean)}. 1603 */ 1604 static final int SCROLL_CONTAINER_ADDED = 0x00100000; 1605 1606 /** 1607 * View flag indicating whether this view was invalidated (fully or partially.) 1608 * 1609 * @hide 1610 */ 1611 static final int DIRTY = 0x00200000; 1612 1613 /** 1614 * View flag indicating whether this view was invalidated by an opaque 1615 * invalidate request. 1616 * 1617 * @hide 1618 */ 1619 static final int DIRTY_OPAQUE = 0x00400000; 1620 1621 /** 1622 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}. 1623 * 1624 * @hide 1625 */ 1626 static final int DIRTY_MASK = 0x00600000; 1627 1628 /** 1629 * Indicates whether the background is opaque. 1630 * 1631 * @hide 1632 */ 1633 static final int OPAQUE_BACKGROUND = 0x00800000; 1634 1635 /** 1636 * Indicates whether the scrollbars are opaque. 1637 * 1638 * @hide 1639 */ 1640 static final int OPAQUE_SCROLLBARS = 0x01000000; 1641 1642 /** 1643 * Indicates whether the view is opaque. 1644 * 1645 * @hide 1646 */ 1647 static final int OPAQUE_MASK = 0x01800000; 1648 1649 /** 1650 * Indicates a prepressed state; 1651 * the short time between ACTION_DOWN and recognizing 1652 * a 'real' press. Prepressed is used to recognize quick taps 1653 * even when they are shorter than ViewConfiguration.getTapTimeout(). 1654 * 1655 * @hide 1656 */ 1657 private static final int PREPRESSED = 0x02000000; 1658 1659 /** 1660 * Indicates whether the view is temporarily detached. 1661 * 1662 * @hide 1663 */ 1664 static final int CANCEL_NEXT_UP_EVENT = 0x04000000; 1665 1666 /** 1667 * Indicates that we should awaken scroll bars once attached 1668 * 1669 * @hide 1670 */ 1671 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000; 1672 1673 /** 1674 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center 1675 * for transform operations 1676 * 1677 * @hide 1678 */ 1679 private static final int PIVOT_EXPLICITLY_SET = 0x20000000; 1680 1681 /** {@hide} */ 1682 static final int ACTIVATED = 0x40000000; 1683 1684 /** 1685 * Indicates that this view was specifically invalidated, not just dirtied because some 1686 * child view was invalidated. The flag is used to determine when we need to recreate 1687 * a view's display list (as opposed to just returning a reference to its existing 1688 * display list). 1689 * 1690 * @hide 1691 */ 1692 static final int INVALIDATED = 0x80000000; 1693 1694 /** 1695 * Always allow a user to over-scroll this view, provided it is a 1696 * view that can scroll. 1697 * 1698 * @see #getOverScrollMode() 1699 * @see #setOverScrollMode(int) 1700 */ 1701 public static final int OVER_SCROLL_ALWAYS = 0; 1702 1703 /** 1704 * Allow a user to over-scroll this view only if the content is large 1705 * enough to meaningfully scroll, provided it is a view that can scroll. 1706 * 1707 * @see #getOverScrollMode() 1708 * @see #setOverScrollMode(int) 1709 */ 1710 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1; 1711 1712 /** 1713 * Never allow a user to over-scroll this view. 1714 * 1715 * @see #getOverScrollMode() 1716 * @see #setOverScrollMode(int) 1717 */ 1718 public static final int OVER_SCROLL_NEVER = 2; 1719 1720 /** 1721 * View has requested the status bar to be visible (the default). 1722 * 1723 * @see #setSystemUiVisibility(int) 1724 */ 1725 public static final int STATUS_BAR_VISIBLE = 0; 1726 1727 /** 1728 * View has requested the status bar to be visible (the default). 1729 * 1730 * @see #setSystemUiVisibility(int) 1731 */ 1732 public static final int STATUS_BAR_HIDDEN = 0x00000001; 1733 1734 /** 1735 * Controls the over-scroll mode for this view. 1736 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)}, 1737 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}, 1738 * and {@link #OVER_SCROLL_NEVER}. 1739 */ 1740 private int mOverScrollMode; 1741 1742 /** 1743 * The parent this view is attached to. 1744 * {@hide} 1745 * 1746 * @see #getParent() 1747 */ 1748 protected ViewParent mParent; 1749 1750 /** 1751 * {@hide} 1752 */ 1753 AttachInfo mAttachInfo; 1754 1755 /** 1756 * {@hide} 1757 */ 1758 @ViewDebug.ExportedProperty(flagMapping = { 1759 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT, 1760 name = "FORCE_LAYOUT"), 1761 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED, 1762 name = "LAYOUT_REQUIRED"), 1763 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID, 1764 name = "DRAWING_CACHE_INVALID", outputIf = false), 1765 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true), 1766 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false), 1767 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"), 1768 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY") 1769 }) 1770 int mPrivateFlags; 1771 1772 /** 1773 * This view's request for the visibility of the status bar. 1774 * @hide 1775 */ 1776 int mSystemUiVisibility; 1777 1778 /** 1779 * Count of how many windows this view has been attached to. 1780 */ 1781 int mWindowAttachCount; 1782 1783 /** 1784 * The layout parameters associated with this view and used by the parent 1785 * {@link android.view.ViewGroup} to determine how this view should be 1786 * laid out. 1787 * {@hide} 1788 */ 1789 protected ViewGroup.LayoutParams mLayoutParams; 1790 1791 /** 1792 * The view flags hold various views states. 1793 * {@hide} 1794 */ 1795 @ViewDebug.ExportedProperty 1796 int mViewFlags; 1797 1798 /** 1799 * The transform matrix for the View. This transform is calculated internally 1800 * based on the rotation, scaleX, and scaleY properties. The identity matrix 1801 * is used by default. Do *not* use this variable directly; instead call 1802 * getMatrix(), which will automatically recalculate the matrix if necessary 1803 * to get the correct matrix based on the latest rotation and scale properties. 1804 */ 1805 private final Matrix mMatrix = new Matrix(); 1806 1807 /** 1808 * The transform matrix for the View. This transform is calculated internally 1809 * based on the rotation, scaleX, and scaleY properties. The identity matrix 1810 * is used by default. Do *not* use this variable directly; instead call 1811 * getInverseMatrix(), which will automatically recalculate the matrix if necessary 1812 * to get the correct matrix based on the latest rotation and scale properties. 1813 */ 1814 private Matrix mInverseMatrix; 1815 1816 /** 1817 * An internal variable that tracks whether we need to recalculate the 1818 * transform matrix, based on whether the rotation or scaleX/Y properties 1819 * have changed since the matrix was last calculated. 1820 */ 1821 private boolean mMatrixDirty = false; 1822 1823 /** 1824 * An internal variable that tracks whether we need to recalculate the 1825 * transform matrix, based on whether the rotation or scaleX/Y properties 1826 * have changed since the matrix was last calculated. 1827 */ 1828 private boolean mInverseMatrixDirty = true; 1829 1830 /** 1831 * A variable that tracks whether we need to recalculate the 1832 * transform matrix, based on whether the rotation or scaleX/Y properties 1833 * have changed since the matrix was last calculated. This variable 1834 * is only valid after a call to updateMatrix() or to a function that 1835 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix(). 1836 */ 1837 private boolean mMatrixIsIdentity = true; 1838 1839 /** 1840 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set. 1841 */ 1842 private Camera mCamera = null; 1843 1844 /** 1845 * This matrix is used when computing the matrix for 3D rotations. 1846 */ 1847 private Matrix matrix3D = null; 1848 1849 /** 1850 * These prev values are used to recalculate a centered pivot point when necessary. The 1851 * pivot point is only used in matrix operations (when rotation, scale, or translation are 1852 * set), so thes values are only used then as well. 1853 */ 1854 private int mPrevWidth = -1; 1855 private int mPrevHeight = -1; 1856 1857 private boolean mLastIsOpaque; 1858 1859 /** 1860 * Convenience value to check for float values that are close enough to zero to be considered 1861 * zero. 1862 */ 1863 private static final float NONZERO_EPSILON = .001f; 1864 1865 /** 1866 * The degrees rotation around the vertical axis through the pivot point. 1867 */ 1868 @ViewDebug.ExportedProperty 1869 private float mRotationY = 0f; 1870 1871 /** 1872 * The degrees rotation around the horizontal axis through the pivot point. 1873 */ 1874 @ViewDebug.ExportedProperty 1875 private float mRotationX = 0f; 1876 1877 /** 1878 * The degrees rotation around the pivot point. 1879 */ 1880 @ViewDebug.ExportedProperty 1881 private float mRotation = 0f; 1882 1883 /** 1884 * The amount of translation of the object away from its left property (post-layout). 1885 */ 1886 @ViewDebug.ExportedProperty 1887 private float mTranslationX = 0f; 1888 1889 /** 1890 * The amount of translation of the object away from its top property (post-layout). 1891 */ 1892 @ViewDebug.ExportedProperty 1893 private float mTranslationY = 0f; 1894 1895 /** 1896 * The amount of scale in the x direction around the pivot point. A 1897 * value of 1 means no scaling is applied. 1898 */ 1899 @ViewDebug.ExportedProperty 1900 private float mScaleX = 1f; 1901 1902 /** 1903 * The amount of scale in the y direction around the pivot point. A 1904 * value of 1 means no scaling is applied. 1905 */ 1906 @ViewDebug.ExportedProperty 1907 private float mScaleY = 1f; 1908 1909 /** 1910 * The amount of scale in the x direction around the pivot point. A 1911 * value of 1 means no scaling is applied. 1912 */ 1913 @ViewDebug.ExportedProperty 1914 private float mPivotX = 0f; 1915 1916 /** 1917 * The amount of scale in the y direction around the pivot point. A 1918 * value of 1 means no scaling is applied. 1919 */ 1920 @ViewDebug.ExportedProperty 1921 private float mPivotY = 0f; 1922 1923 /** 1924 * The opacity of the View. This is a value from 0 to 1, where 0 means 1925 * completely transparent and 1 means completely opaque. 1926 */ 1927 @ViewDebug.ExportedProperty 1928 private float mAlpha = 1f; 1929 1930 /** 1931 * The distance in pixels from the left edge of this view's parent 1932 * to the left edge of this view. 1933 * {@hide} 1934 */ 1935 @ViewDebug.ExportedProperty(category = "layout") 1936 protected int mLeft; 1937 /** 1938 * The distance in pixels from the left edge of this view's parent 1939 * to the right edge of this view. 1940 * {@hide} 1941 */ 1942 @ViewDebug.ExportedProperty(category = "layout") 1943 protected int mRight; 1944 /** 1945 * The distance in pixels from the top edge of this view's parent 1946 * to the top edge of this view. 1947 * {@hide} 1948 */ 1949 @ViewDebug.ExportedProperty(category = "layout") 1950 protected int mTop; 1951 /** 1952 * The distance in pixels from the top edge of this view's parent 1953 * to the bottom edge of this view. 1954 * {@hide} 1955 */ 1956 @ViewDebug.ExportedProperty(category = "layout") 1957 protected int mBottom; 1958 1959 /** 1960 * The offset, in pixels, by which the content of this view is scrolled 1961 * horizontally. 1962 * {@hide} 1963 */ 1964 @ViewDebug.ExportedProperty(category = "scrolling") 1965 protected int mScrollX; 1966 /** 1967 * The offset, in pixels, by which the content of this view is scrolled 1968 * vertically. 1969 * {@hide} 1970 */ 1971 @ViewDebug.ExportedProperty(category = "scrolling") 1972 protected int mScrollY; 1973 1974 /** 1975 * The left padding in pixels, that is the distance in pixels between the 1976 * left edge of this view and the left edge of its content. 1977 * {@hide} 1978 */ 1979 @ViewDebug.ExportedProperty(category = "padding") 1980 protected int mPaddingLeft; 1981 /** 1982 * The right padding in pixels, that is the distance in pixels between the 1983 * right edge of this view and the right edge of its content. 1984 * {@hide} 1985 */ 1986 @ViewDebug.ExportedProperty(category = "padding") 1987 protected int mPaddingRight; 1988 /** 1989 * The top padding in pixels, that is the distance in pixels between the 1990 * top edge of this view and the top edge of its content. 1991 * {@hide} 1992 */ 1993 @ViewDebug.ExportedProperty(category = "padding") 1994 protected int mPaddingTop; 1995 /** 1996 * The bottom padding in pixels, that is the distance in pixels between the 1997 * bottom edge of this view and the bottom edge of its content. 1998 * {@hide} 1999 */ 2000 @ViewDebug.ExportedProperty(category = "padding") 2001 protected int mPaddingBottom; 2002 2003 /** 2004 * Briefly describes the view and is primarily used for accessibility support. 2005 */ 2006 private CharSequence mContentDescription; 2007 2008 /** 2009 * Cache the paddingRight set by the user to append to the scrollbar's size. 2010 */ 2011 @ViewDebug.ExportedProperty(category = "padding") 2012 int mUserPaddingRight; 2013 2014 /** 2015 * Cache the paddingBottom set by the user to append to the scrollbar's size. 2016 */ 2017 @ViewDebug.ExportedProperty(category = "padding") 2018 int mUserPaddingBottom; 2019 2020 /** 2021 * Cache the paddingLeft set by the user to append to the scrollbar's size. 2022 */ 2023 @ViewDebug.ExportedProperty(category = "padding") 2024 int mUserPaddingLeft; 2025 2026 /** 2027 * @hide 2028 */ 2029 int mOldWidthMeasureSpec = Integer.MIN_VALUE; 2030 /** 2031 * @hide 2032 */ 2033 int mOldHeightMeasureSpec = Integer.MIN_VALUE; 2034 2035 private Resources mResources = null; 2036 2037 private Drawable mBGDrawable; 2038 2039 private int mBackgroundResource; 2040 private boolean mBackgroundSizeChanged; 2041 2042 /** 2043 * Listener used to dispatch focus change events. 2044 * This field should be made private, so it is hidden from the SDK. 2045 * {@hide} 2046 */ 2047 protected OnFocusChangeListener mOnFocusChangeListener; 2048 2049 /** 2050 * Listeners for layout change events. 2051 */ 2052 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners; 2053 2054 /** 2055 * Listener used to dispatch click events. 2056 * This field should be made private, so it is hidden from the SDK. 2057 * {@hide} 2058 */ 2059 protected OnClickListener mOnClickListener; 2060 2061 /** 2062 * Listener used to dispatch long click events. 2063 * This field should be made private, so it is hidden from the SDK. 2064 * {@hide} 2065 */ 2066 protected OnLongClickListener mOnLongClickListener; 2067 2068 /** 2069 * Listener used to build the context menu. 2070 * This field should be made private, so it is hidden from the SDK. 2071 * {@hide} 2072 */ 2073 protected OnCreateContextMenuListener mOnCreateContextMenuListener; 2074 2075 private OnKeyListener mOnKeyListener; 2076 2077 private OnTouchListener mOnTouchListener; 2078 2079 private OnDragListener mOnDragListener; 2080 2081 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener; 2082 2083 /** 2084 * The application environment this view lives in. 2085 * This field should be made private, so it is hidden from the SDK. 2086 * {@hide} 2087 */ 2088 protected Context mContext; 2089 2090 private ScrollabilityCache mScrollCache; 2091 2092 private int[] mDrawableState = null; 2093 2094 private Bitmap mDrawingCache; 2095 private Bitmap mUnscaledDrawingCache; 2096 private DisplayList mDisplayList; 2097 private HardwareLayer mHardwareLayer; 2098 2099 /** 2100 * When this view has focus and the next focus is {@link #FOCUS_LEFT}, 2101 * the user may specify which view to go to next. 2102 */ 2103 private int mNextFocusLeftId = View.NO_ID; 2104 2105 /** 2106 * When this view has focus and the next focus is {@link #FOCUS_RIGHT}, 2107 * the user may specify which view to go to next. 2108 */ 2109 private int mNextFocusRightId = View.NO_ID; 2110 2111 /** 2112 * When this view has focus and the next focus is {@link #FOCUS_UP}, 2113 * the user may specify which view to go to next. 2114 */ 2115 private int mNextFocusUpId = View.NO_ID; 2116 2117 /** 2118 * When this view has focus and the next focus is {@link #FOCUS_DOWN}, 2119 * the user may specify which view to go to next. 2120 */ 2121 private int mNextFocusDownId = View.NO_ID; 2122 2123 /** 2124 * When this view has focus and the next focus is {@link #FOCUS_FORWARD}, 2125 * the user may specify which view to go to next. 2126 */ 2127 int mNextFocusForwardId = View.NO_ID; 2128 2129 private CheckForLongPress mPendingCheckForLongPress; 2130 private CheckForTap mPendingCheckForTap = null; 2131 private PerformClick mPerformClick; 2132 2133 private UnsetPressedState mUnsetPressedState; 2134 2135 /** 2136 * Whether the long press's action has been invoked. The tap's action is invoked on the 2137 * up event while a long press is invoked as soon as the long press duration is reached, so 2138 * a long press could be performed before the tap is checked, in which case the tap's action 2139 * should not be invoked. 2140 */ 2141 private boolean mHasPerformedLongPress; 2142 2143 /** 2144 * The minimum height of the view. We'll try our best to have the height 2145 * of this view to at least this amount. 2146 */ 2147 @ViewDebug.ExportedProperty(category = "measurement") 2148 private int mMinHeight; 2149 2150 /** 2151 * The minimum width of the view. We'll try our best to have the width 2152 * of this view to at least this amount. 2153 */ 2154 @ViewDebug.ExportedProperty(category = "measurement") 2155 private int mMinWidth; 2156 2157 /** 2158 * The delegate to handle touch events that are physically in this view 2159 * but should be handled by another view. 2160 */ 2161 private TouchDelegate mTouchDelegate = null; 2162 2163 /** 2164 * Solid color to use as a background when creating the drawing cache. Enables 2165 * the cache to use 16 bit bitmaps instead of 32 bit. 2166 */ 2167 private int mDrawingCacheBackgroundColor = 0; 2168 2169 /** 2170 * Special tree observer used when mAttachInfo is null. 2171 */ 2172 private ViewTreeObserver mFloatingTreeObserver; 2173 2174 /** 2175 * Cache the touch slop from the context that created the view. 2176 */ 2177 private int mTouchSlop; 2178 2179 /** 2180 * Cache drag/drop state 2181 * 2182 */ 2183 boolean mCanAcceptDrop; 2184 2185 /** 2186 * Flag indicating that a drag can cross window boundaries 2187 * @hide 2188 */ 2189 public static final int DRAG_FLAG_GLOBAL = 1; 2190 2191 /** 2192 * Position of the vertical scroll bar. 2193 */ 2194 private int mVerticalScrollbarPosition; 2195 2196 /** 2197 * Position the scroll bar at the default position as determined by the system. 2198 */ 2199 public static final int SCROLLBAR_POSITION_DEFAULT = 0; 2200 2201 /** 2202 * Position the scroll bar along the left edge. 2203 */ 2204 public static final int SCROLLBAR_POSITION_LEFT = 1; 2205 2206 /** 2207 * Position the scroll bar along the right edge. 2208 */ 2209 public static final int SCROLLBAR_POSITION_RIGHT = 2; 2210 2211 /** 2212 * Indicates that the view does not have a layer. 2213 * 2214 * @see #getLayerType() 2215 * @see #setLayerType(int, android.graphics.Paint) 2216 * @see #LAYER_TYPE_SOFTWARE 2217 * @see #LAYER_TYPE_HARDWARE 2218 */ 2219 public static final int LAYER_TYPE_NONE = 0; 2220 2221 /** 2222 * <p>Indicates that the view has a software layer. A software layer is backed 2223 * by a bitmap and causes the view to be rendered using Android's software 2224 * rendering pipeline, even if hardware acceleration is enabled.</p> 2225 * 2226 * <p>Software layers have various usages:</p> 2227 * <p>When the application is not using hardware acceleration, a software layer 2228 * is useful to apply a specific color filter and/or blending mode and/or 2229 * translucency to a view and all its children.</p> 2230 * <p>When the application is using hardware acceleration, a software layer 2231 * is useful to render drawing primitives not supported by the hardware 2232 * accelerated pipeline. It can also be used to cache a complex view tree 2233 * into a texture and reduce the complexity of drawing operations. For instance, 2234 * when animating a complex view tree with a translation, a software layer can 2235 * be used to render the view tree only once.</p> 2236 * <p>Software layers should be avoided when the affected view tree updates 2237 * often. Every update will require to re-render the software layer, which can 2238 * potentially be slow (particularly when hardware acceleration is turned on 2239 * since the layer will have to be uploaded into a hardware texture after every 2240 * update.)</p> 2241 * 2242 * @see #getLayerType() 2243 * @see #setLayerType(int, android.graphics.Paint) 2244 * @see #LAYER_TYPE_NONE 2245 * @see #LAYER_TYPE_HARDWARE 2246 */ 2247 public static final int LAYER_TYPE_SOFTWARE = 1; 2248 2249 /** 2250 * <p>Indicates that the view has a hardware layer. A hardware layer is backed 2251 * by a hardware specific texture (generally Frame Buffer Objects or FBO on 2252 * OpenGL hardware) and causes the view to be rendered using Android's hardware 2253 * rendering pipeline, but only if hardware acceleration is turned on for the 2254 * view hierarchy. When hardware acceleration is turned off, hardware layers 2255 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p> 2256 * 2257 * <p>A hardware layer is useful to apply a specific color filter and/or 2258 * blending mode and/or translucency to a view and all its children.</p> 2259 * <p>A hardware layer can be used to cache a complex view tree into a 2260 * texture and reduce the complexity of drawing operations. For instance, 2261 * when animating a complex view tree with a translation, a hardware layer can 2262 * be used to render the view tree only once.</p> 2263 * <p>A hardware layer can also be used to increase the rendering quality when 2264 * rotation transformations are applied on a view. It can also be used to 2265 * prevent potential clipping issues when applying 3D transforms on a view.</p> 2266 * 2267 * @see #getLayerType() 2268 * @see #setLayerType(int, android.graphics.Paint) 2269 * @see #LAYER_TYPE_NONE 2270 * @see #LAYER_TYPE_SOFTWARE 2271 */ 2272 public static final int LAYER_TYPE_HARDWARE = 2; 2273 2274 @ViewDebug.ExportedProperty(category = "drawing", mapping = { 2275 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"), 2276 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"), 2277 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE") 2278 }) 2279 int mLayerType = LAYER_TYPE_NONE; 2280 Paint mLayerPaint; 2281 2282 /** 2283 * Simple constructor to use when creating a view from code. 2284 * 2285 * @param context The Context the view is running in, through which it can 2286 * access the current theme, resources, etc. 2287 */ 2288 public View(Context context) { 2289 mContext = context; 2290 mResources = context != null ? context.getResources() : null; 2291 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED; 2292 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop(); 2293 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS); 2294 } 2295 2296 /** 2297 * Constructor that is called when inflating a view from XML. This is called 2298 * when a view is being constructed from an XML file, supplying attributes 2299 * that were specified in the XML file. This version uses a default style of 2300 * 0, so the only attribute values applied are those in the Context's Theme 2301 * and the given AttributeSet. 2302 * 2303 * <p> 2304 * The method onFinishInflate() will be called after all children have been 2305 * added. 2306 * 2307 * @param context The Context the view is running in, through which it can 2308 * access the current theme, resources, etc. 2309 * @param attrs The attributes of the XML tag that is inflating the view. 2310 * @see #View(Context, AttributeSet, int) 2311 */ 2312 public View(Context context, AttributeSet attrs) { 2313 this(context, attrs, 0); 2314 } 2315 2316 /** 2317 * Perform inflation from XML and apply a class-specific base style. This 2318 * constructor of View allows subclasses to use their own base style when 2319 * they are inflating. For example, a Button class's constructor would call 2320 * this version of the super class constructor and supply 2321 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows 2322 * the theme's button style to modify all of the base view attributes (in 2323 * particular its background) as well as the Button class's attributes. 2324 * 2325 * @param context The Context the view is running in, through which it can 2326 * access the current theme, resources, etc. 2327 * @param attrs The attributes of the XML tag that is inflating the view. 2328 * @param defStyle The default style to apply to this view. If 0, no style 2329 * will be applied (beyond what is included in the theme). This may 2330 * either be an attribute resource, whose value will be retrieved 2331 * from the current theme, or an explicit style resource. 2332 * @see #View(Context, AttributeSet) 2333 */ 2334 public View(Context context, AttributeSet attrs, int defStyle) { 2335 this(context); 2336 2337 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View, 2338 defStyle, 0); 2339 2340 Drawable background = null; 2341 2342 int leftPadding = -1; 2343 int topPadding = -1; 2344 int rightPadding = -1; 2345 int bottomPadding = -1; 2346 2347 int padding = -1; 2348 2349 int viewFlagValues = 0; 2350 int viewFlagMasks = 0; 2351 2352 boolean setScrollContainer = false; 2353 2354 int x = 0; 2355 int y = 0; 2356 2357 float tx = 0; 2358 float ty = 0; 2359 float rotation = 0; 2360 float rotationX = 0; 2361 float rotationY = 0; 2362 float sx = 1f; 2363 float sy = 1f; 2364 boolean transformSet = false; 2365 2366 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY; 2367 2368 int overScrollMode = mOverScrollMode; 2369 final int N = a.getIndexCount(); 2370 for (int i = 0; i < N; i++) { 2371 int attr = a.getIndex(i); 2372 switch (attr) { 2373 case com.android.internal.R.styleable.View_background: 2374 background = a.getDrawable(attr); 2375 break; 2376 case com.android.internal.R.styleable.View_padding: 2377 padding = a.getDimensionPixelSize(attr, -1); 2378 break; 2379 case com.android.internal.R.styleable.View_paddingLeft: 2380 leftPadding = a.getDimensionPixelSize(attr, -1); 2381 break; 2382 case com.android.internal.R.styleable.View_paddingTop: 2383 topPadding = a.getDimensionPixelSize(attr, -1); 2384 break; 2385 case com.android.internal.R.styleable.View_paddingRight: 2386 rightPadding = a.getDimensionPixelSize(attr, -1); 2387 break; 2388 case com.android.internal.R.styleable.View_paddingBottom: 2389 bottomPadding = a.getDimensionPixelSize(attr, -1); 2390 break; 2391 case com.android.internal.R.styleable.View_scrollX: 2392 x = a.getDimensionPixelOffset(attr, 0); 2393 break; 2394 case com.android.internal.R.styleable.View_scrollY: 2395 y = a.getDimensionPixelOffset(attr, 0); 2396 break; 2397 case com.android.internal.R.styleable.View_alpha: 2398 setAlpha(a.getFloat(attr, 1f)); 2399 break; 2400 case com.android.internal.R.styleable.View_transformPivotX: 2401 setPivotX(a.getDimensionPixelOffset(attr, 0)); 2402 break; 2403 case com.android.internal.R.styleable.View_transformPivotY: 2404 setPivotY(a.getDimensionPixelOffset(attr, 0)); 2405 break; 2406 case com.android.internal.R.styleable.View_translationX: 2407 tx = a.getDimensionPixelOffset(attr, 0); 2408 transformSet = true; 2409 break; 2410 case com.android.internal.R.styleable.View_translationY: 2411 ty = a.getDimensionPixelOffset(attr, 0); 2412 transformSet = true; 2413 break; 2414 case com.android.internal.R.styleable.View_rotation: 2415 rotation = a.getFloat(attr, 0); 2416 transformSet = true; 2417 break; 2418 case com.android.internal.R.styleable.View_rotationX: 2419 rotationX = a.getFloat(attr, 0); 2420 transformSet = true; 2421 break; 2422 case com.android.internal.R.styleable.View_rotationY: 2423 rotationY = a.getFloat(attr, 0); 2424 transformSet = true; 2425 break; 2426 case com.android.internal.R.styleable.View_scaleX: 2427 sx = a.getFloat(attr, 1f); 2428 transformSet = true; 2429 break; 2430 case com.android.internal.R.styleable.View_scaleY: 2431 sy = a.getFloat(attr, 1f); 2432 transformSet = true; 2433 break; 2434 case com.android.internal.R.styleable.View_id: 2435 mID = a.getResourceId(attr, NO_ID); 2436 break; 2437 case com.android.internal.R.styleable.View_tag: 2438 mTag = a.getText(attr); 2439 break; 2440 case com.android.internal.R.styleable.View_fitsSystemWindows: 2441 if (a.getBoolean(attr, false)) { 2442 viewFlagValues |= FITS_SYSTEM_WINDOWS; 2443 viewFlagMasks |= FITS_SYSTEM_WINDOWS; 2444 } 2445 break; 2446 case com.android.internal.R.styleable.View_focusable: 2447 if (a.getBoolean(attr, false)) { 2448 viewFlagValues |= FOCUSABLE; 2449 viewFlagMasks |= FOCUSABLE_MASK; 2450 } 2451 break; 2452 case com.android.internal.R.styleable.View_focusableInTouchMode: 2453 if (a.getBoolean(attr, false)) { 2454 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE; 2455 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK; 2456 } 2457 break; 2458 case com.android.internal.R.styleable.View_clickable: 2459 if (a.getBoolean(attr, false)) { 2460 viewFlagValues |= CLICKABLE; 2461 viewFlagMasks |= CLICKABLE; 2462 } 2463 break; 2464 case com.android.internal.R.styleable.View_longClickable: 2465 if (a.getBoolean(attr, false)) { 2466 viewFlagValues |= LONG_CLICKABLE; 2467 viewFlagMasks |= LONG_CLICKABLE; 2468 } 2469 break; 2470 case com.android.internal.R.styleable.View_saveEnabled: 2471 if (!a.getBoolean(attr, true)) { 2472 viewFlagValues |= SAVE_DISABLED; 2473 viewFlagMasks |= SAVE_DISABLED_MASK; 2474 } 2475 break; 2476 case com.android.internal.R.styleable.View_duplicateParentState: 2477 if (a.getBoolean(attr, false)) { 2478 viewFlagValues |= DUPLICATE_PARENT_STATE; 2479 viewFlagMasks |= DUPLICATE_PARENT_STATE; 2480 } 2481 break; 2482 case com.android.internal.R.styleable.View_visibility: 2483 final int visibility = a.getInt(attr, 0); 2484 if (visibility != 0) { 2485 viewFlagValues |= VISIBILITY_FLAGS[visibility]; 2486 viewFlagMasks |= VISIBILITY_MASK; 2487 } 2488 break; 2489 case com.android.internal.R.styleable.View_drawingCacheQuality: 2490 final int cacheQuality = a.getInt(attr, 0); 2491 if (cacheQuality != 0) { 2492 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality]; 2493 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK; 2494 } 2495 break; 2496 case com.android.internal.R.styleable.View_contentDescription: 2497 mContentDescription = a.getString(attr); 2498 break; 2499 case com.android.internal.R.styleable.View_soundEffectsEnabled: 2500 if (!a.getBoolean(attr, true)) { 2501 viewFlagValues &= ~SOUND_EFFECTS_ENABLED; 2502 viewFlagMasks |= SOUND_EFFECTS_ENABLED; 2503 } 2504 break; 2505 case com.android.internal.R.styleable.View_hapticFeedbackEnabled: 2506 if (!a.getBoolean(attr, true)) { 2507 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED; 2508 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED; 2509 } 2510 break; 2511 case R.styleable.View_scrollbars: 2512 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE); 2513 if (scrollbars != SCROLLBARS_NONE) { 2514 viewFlagValues |= scrollbars; 2515 viewFlagMasks |= SCROLLBARS_MASK; 2516 initializeScrollbars(a); 2517 } 2518 break; 2519 case R.styleable.View_fadingEdge: 2520 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE); 2521 if (fadingEdge != FADING_EDGE_NONE) { 2522 viewFlagValues |= fadingEdge; 2523 viewFlagMasks |= FADING_EDGE_MASK; 2524 initializeFadingEdge(a); 2525 } 2526 break; 2527 case R.styleable.View_scrollbarStyle: 2528 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY); 2529 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 2530 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK; 2531 viewFlagMasks |= SCROLLBARS_STYLE_MASK; 2532 } 2533 break; 2534 case R.styleable.View_isScrollContainer: 2535 setScrollContainer = true; 2536 if (a.getBoolean(attr, false)) { 2537 setScrollContainer(true); 2538 } 2539 break; 2540 case com.android.internal.R.styleable.View_keepScreenOn: 2541 if (a.getBoolean(attr, false)) { 2542 viewFlagValues |= KEEP_SCREEN_ON; 2543 viewFlagMasks |= KEEP_SCREEN_ON; 2544 } 2545 break; 2546 case R.styleable.View_filterTouchesWhenObscured: 2547 if (a.getBoolean(attr, false)) { 2548 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED; 2549 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED; 2550 } 2551 break; 2552 case R.styleable.View_nextFocusLeft: 2553 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID); 2554 break; 2555 case R.styleable.View_nextFocusRight: 2556 mNextFocusRightId = a.getResourceId(attr, View.NO_ID); 2557 break; 2558 case R.styleable.View_nextFocusUp: 2559 mNextFocusUpId = a.getResourceId(attr, View.NO_ID); 2560 break; 2561 case R.styleable.View_nextFocusDown: 2562 mNextFocusDownId = a.getResourceId(attr, View.NO_ID); 2563 break; 2564 case R.styleable.View_nextFocusForward: 2565 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID); 2566 break; 2567 case R.styleable.View_minWidth: 2568 mMinWidth = a.getDimensionPixelSize(attr, 0); 2569 break; 2570 case R.styleable.View_minHeight: 2571 mMinHeight = a.getDimensionPixelSize(attr, 0); 2572 break; 2573 case R.styleable.View_onClick: 2574 if (context.isRestricted()) { 2575 throw new IllegalStateException("The android:onClick attribute cannot " 2576 + "be used within a restricted context"); 2577 } 2578 2579 final String handlerName = a.getString(attr); 2580 if (handlerName != null) { 2581 setOnClickListener(new OnClickListener() { 2582 private Method mHandler; 2583 2584 public void onClick(View v) { 2585 if (mHandler == null) { 2586 try { 2587 mHandler = getContext().getClass().getMethod(handlerName, 2588 View.class); 2589 } catch (NoSuchMethodException e) { 2590 int id = getId(); 2591 String idText = id == NO_ID ? "" : " with id '" 2592 + getContext().getResources().getResourceEntryName( 2593 id) + "'"; 2594 throw new IllegalStateException("Could not find a method " + 2595 handlerName + "(View) in the activity " 2596 + getContext().getClass() + " for onClick handler" 2597 + " on view " + View.this.getClass() + idText, e); 2598 } 2599 } 2600 2601 try { 2602 mHandler.invoke(getContext(), View.this); 2603 } catch (IllegalAccessException e) { 2604 throw new IllegalStateException("Could not execute non " 2605 + "public method of the activity", e); 2606 } catch (InvocationTargetException e) { 2607 throw new IllegalStateException("Could not execute " 2608 + "method of the activity", e); 2609 } 2610 } 2611 }); 2612 } 2613 break; 2614 case R.styleable.View_overScrollMode: 2615 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS); 2616 break; 2617 case R.styleable.View_verticalScrollbarPosition: 2618 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT); 2619 break; 2620 case R.styleable.View_layerType: 2621 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null); 2622 break; 2623 } 2624 } 2625 2626 setOverScrollMode(overScrollMode); 2627 2628 if (background != null) { 2629 setBackgroundDrawable(background); 2630 } 2631 2632 if (padding >= 0) { 2633 leftPadding = padding; 2634 topPadding = padding; 2635 rightPadding = padding; 2636 bottomPadding = padding; 2637 } 2638 2639 // If the user specified the padding (either with android:padding or 2640 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise 2641 // use the default padding or the padding from the background drawable 2642 // (stored at this point in mPadding*) 2643 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft, 2644 topPadding >= 0 ? topPadding : mPaddingTop, 2645 rightPadding >= 0 ? rightPadding : mPaddingRight, 2646 bottomPadding >= 0 ? bottomPadding : mPaddingBottom); 2647 2648 if (viewFlagMasks != 0) { 2649 setFlags(viewFlagValues, viewFlagMasks); 2650 } 2651 2652 // Needs to be called after mViewFlags is set 2653 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 2654 recomputePadding(); 2655 } 2656 2657 if (x != 0 || y != 0) { 2658 scrollTo(x, y); 2659 } 2660 2661 if (transformSet) { 2662 setTranslationX(tx); 2663 setTranslationY(ty); 2664 setRotation(rotation); 2665 setRotationX(rotationX); 2666 setRotationY(rotationY); 2667 setScaleX(sx); 2668 setScaleY(sy); 2669 } 2670 2671 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) { 2672 setScrollContainer(true); 2673 } 2674 2675 computeOpaqueFlags(); 2676 2677 a.recycle(); 2678 } 2679 2680 /** 2681 * Non-public constructor for use in testing 2682 */ 2683 View() { 2684 } 2685 2686 /** 2687 * <p> 2688 * Initializes the fading edges from a given set of styled attributes. This 2689 * method should be called by subclasses that need fading edges and when an 2690 * instance of these subclasses is created programmatically rather than 2691 * being inflated from XML. This method is automatically called when the XML 2692 * is inflated. 2693 * </p> 2694 * 2695 * @param a the styled attributes set to initialize the fading edges from 2696 */ 2697 protected void initializeFadingEdge(TypedArray a) { 2698 initScrollCache(); 2699 2700 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize( 2701 R.styleable.View_fadingEdgeLength, 2702 ViewConfiguration.get(mContext).getScaledFadingEdgeLength()); 2703 } 2704 2705 /** 2706 * Returns the size of the vertical faded edges used to indicate that more 2707 * content in this view is visible. 2708 * 2709 * @return The size in pixels of the vertical faded edge or 0 if vertical 2710 * faded edges are not enabled for this view. 2711 * @attr ref android.R.styleable#View_fadingEdgeLength 2712 */ 2713 public int getVerticalFadingEdgeLength() { 2714 if (isVerticalFadingEdgeEnabled()) { 2715 ScrollabilityCache cache = mScrollCache; 2716 if (cache != null) { 2717 return cache.fadingEdgeLength; 2718 } 2719 } 2720 return 0; 2721 } 2722 2723 /** 2724 * Set the size of the faded edge used to indicate that more content in this 2725 * view is available. Will not change whether the fading edge is enabled; use 2726 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled} 2727 * to enable the fading edge for the vertical or horizontal fading edges. 2728 * 2729 * @param length The size in pixels of the faded edge used to indicate that more 2730 * content in this view is visible. 2731 */ 2732 public void setFadingEdgeLength(int length) { 2733 initScrollCache(); 2734 mScrollCache.fadingEdgeLength = length; 2735 } 2736 2737 /** 2738 * Returns the size of the horizontal faded edges used to indicate that more 2739 * content in this view is visible. 2740 * 2741 * @return The size in pixels of the horizontal faded edge or 0 if horizontal 2742 * faded edges are not enabled for this view. 2743 * @attr ref android.R.styleable#View_fadingEdgeLength 2744 */ 2745 public int getHorizontalFadingEdgeLength() { 2746 if (isHorizontalFadingEdgeEnabled()) { 2747 ScrollabilityCache cache = mScrollCache; 2748 if (cache != null) { 2749 return cache.fadingEdgeLength; 2750 } 2751 } 2752 return 0; 2753 } 2754 2755 /** 2756 * Returns the width of the vertical scrollbar. 2757 * 2758 * @return The width in pixels of the vertical scrollbar or 0 if there 2759 * is no vertical scrollbar. 2760 */ 2761 public int getVerticalScrollbarWidth() { 2762 ScrollabilityCache cache = mScrollCache; 2763 if (cache != null) { 2764 ScrollBarDrawable scrollBar = cache.scrollBar; 2765 if (scrollBar != null) { 2766 int size = scrollBar.getSize(true); 2767 if (size <= 0) { 2768 size = cache.scrollBarSize; 2769 } 2770 return size; 2771 } 2772 return 0; 2773 } 2774 return 0; 2775 } 2776 2777 /** 2778 * Returns the height of the horizontal scrollbar. 2779 * 2780 * @return The height in pixels of the horizontal scrollbar or 0 if 2781 * there is no horizontal scrollbar. 2782 */ 2783 protected int getHorizontalScrollbarHeight() { 2784 ScrollabilityCache cache = mScrollCache; 2785 if (cache != null) { 2786 ScrollBarDrawable scrollBar = cache.scrollBar; 2787 if (scrollBar != null) { 2788 int size = scrollBar.getSize(false); 2789 if (size <= 0) { 2790 size = cache.scrollBarSize; 2791 } 2792 return size; 2793 } 2794 return 0; 2795 } 2796 return 0; 2797 } 2798 2799 /** 2800 * <p> 2801 * Initializes the scrollbars from a given set of styled attributes. This 2802 * method should be called by subclasses that need scrollbars and when an 2803 * instance of these subclasses is created programmatically rather than 2804 * being inflated from XML. This method is automatically called when the XML 2805 * is inflated. 2806 * </p> 2807 * 2808 * @param a the styled attributes set to initialize the scrollbars from 2809 */ 2810 protected void initializeScrollbars(TypedArray a) { 2811 initScrollCache(); 2812 2813 final ScrollabilityCache scrollabilityCache = mScrollCache; 2814 2815 if (scrollabilityCache.scrollBar == null) { 2816 scrollabilityCache.scrollBar = new ScrollBarDrawable(); 2817 } 2818 2819 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true); 2820 2821 if (!fadeScrollbars) { 2822 scrollabilityCache.state = ScrollabilityCache.ON; 2823 } 2824 scrollabilityCache.fadeScrollBars = fadeScrollbars; 2825 2826 2827 scrollabilityCache.scrollBarFadeDuration = a.getInt( 2828 R.styleable.View_scrollbarFadeDuration, ViewConfiguration 2829 .getScrollBarFadeDuration()); 2830 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt( 2831 R.styleable.View_scrollbarDefaultDelayBeforeFade, 2832 ViewConfiguration.getScrollDefaultDelay()); 2833 2834 2835 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize( 2836 com.android.internal.R.styleable.View_scrollbarSize, 2837 ViewConfiguration.get(mContext).getScaledScrollBarSize()); 2838 2839 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal); 2840 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track); 2841 2842 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal); 2843 if (thumb != null) { 2844 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb); 2845 } 2846 2847 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack, 2848 false); 2849 if (alwaysDraw) { 2850 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true); 2851 } 2852 2853 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical); 2854 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track); 2855 2856 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical); 2857 if (thumb != null) { 2858 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb); 2859 } 2860 2861 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack, 2862 false); 2863 if (alwaysDraw) { 2864 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true); 2865 } 2866 2867 // Re-apply user/background padding so that scrollbar(s) get added 2868 recomputePadding(); 2869 } 2870 2871 /** 2872 * <p> 2873 * Initalizes the scrollability cache if necessary. 2874 * </p> 2875 */ 2876 private void initScrollCache() { 2877 if (mScrollCache == null) { 2878 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this); 2879 } 2880 } 2881 2882 /** 2883 * Set the position of the vertical scroll bar. Should be one of 2884 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or 2885 * {@link #SCROLLBAR_POSITION_RIGHT}. 2886 * 2887 * @param position Where the vertical scroll bar should be positioned. 2888 */ 2889 public void setVerticalScrollbarPosition(int position) { 2890 if (mVerticalScrollbarPosition != position) { 2891 mVerticalScrollbarPosition = position; 2892 computeOpaqueFlags(); 2893 recomputePadding(); 2894 } 2895 } 2896 2897 /** 2898 * @return The position where the vertical scroll bar will show, if applicable. 2899 * @see #setVerticalScrollbarPosition(int) 2900 */ 2901 public int getVerticalScrollbarPosition() { 2902 return mVerticalScrollbarPosition; 2903 } 2904 2905 /** 2906 * Register a callback to be invoked when focus of this view changed. 2907 * 2908 * @param l The callback that will run. 2909 */ 2910 public void setOnFocusChangeListener(OnFocusChangeListener l) { 2911 mOnFocusChangeListener = l; 2912 } 2913 2914 /** 2915 * Add a listener that will be called when the bounds of the view change due to 2916 * layout processing. 2917 * 2918 * @param listener The listener that will be called when layout bounds change. 2919 */ 2920 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) { 2921 if (mOnLayoutChangeListeners == null) { 2922 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>(); 2923 } 2924 mOnLayoutChangeListeners.add(listener); 2925 } 2926 2927 /** 2928 * Remove a listener for layout changes. 2929 * 2930 * @param listener The listener for layout bounds change. 2931 */ 2932 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) { 2933 if (mOnLayoutChangeListeners == null) { 2934 return; 2935 } 2936 mOnLayoutChangeListeners.remove(listener); 2937 } 2938 2939 /** 2940 * Returns the focus-change callback registered for this view. 2941 * 2942 * @return The callback, or null if one is not registered. 2943 */ 2944 public OnFocusChangeListener getOnFocusChangeListener() { 2945 return mOnFocusChangeListener; 2946 } 2947 2948 /** 2949 * Register a callback to be invoked when this view is clicked. If this view is not 2950 * clickable, it becomes clickable. 2951 * 2952 * @param l The callback that will run 2953 * 2954 * @see #setClickable(boolean) 2955 */ 2956 public void setOnClickListener(OnClickListener l) { 2957 if (!isClickable()) { 2958 setClickable(true); 2959 } 2960 mOnClickListener = l; 2961 } 2962 2963 /** 2964 * Register a callback to be invoked when this view is clicked and held. If this view is not 2965 * long clickable, it becomes long clickable. 2966 * 2967 * @param l The callback that will run 2968 * 2969 * @see #setLongClickable(boolean) 2970 */ 2971 public void setOnLongClickListener(OnLongClickListener l) { 2972 if (!isLongClickable()) { 2973 setLongClickable(true); 2974 } 2975 mOnLongClickListener = l; 2976 } 2977 2978 /** 2979 * Register a callback to be invoked when the context menu for this view is 2980 * being built. If this view is not long clickable, it becomes long clickable. 2981 * 2982 * @param l The callback that will run 2983 * 2984 */ 2985 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) { 2986 if (!isLongClickable()) { 2987 setLongClickable(true); 2988 } 2989 mOnCreateContextMenuListener = l; 2990 } 2991 2992 /** 2993 * Call this view's OnClickListener, if it is defined. 2994 * 2995 * @return True there was an assigned OnClickListener that was called, false 2996 * otherwise is returned. 2997 */ 2998 public boolean performClick() { 2999 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED); 3000 3001 if (mOnClickListener != null) { 3002 playSoundEffect(SoundEffectConstants.CLICK); 3003 mOnClickListener.onClick(this); 3004 return true; 3005 } 3006 3007 return false; 3008 } 3009 3010 /** 3011 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the 3012 * OnLongClickListener did not consume the event. 3013 * 3014 * @return True if one of the above receivers consumed the event, false otherwise. 3015 */ 3016 public boolean performLongClick() { 3017 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED); 3018 3019 boolean handled = false; 3020 if (mOnLongClickListener != null) { 3021 handled = mOnLongClickListener.onLongClick(View.this); 3022 } 3023 if (!handled) { 3024 handled = showContextMenu(); 3025 } 3026 if (handled) { 3027 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); 3028 } 3029 return handled; 3030 } 3031 3032 /** 3033 * Bring up the context menu for this view. 3034 * 3035 * @return Whether a context menu was displayed. 3036 */ 3037 public boolean showContextMenu() { 3038 return getParent().showContextMenuForChild(this); 3039 } 3040 3041 /** 3042 * Start an action mode. 3043 * 3044 * @param callback Callback that will control the lifecycle of the action mode 3045 * @return The new action mode if it is started, null otherwise 3046 * 3047 * @see ActionMode 3048 */ 3049 public ActionMode startActionMode(ActionMode.Callback callback) { 3050 return getParent().startActionModeForChild(this, callback); 3051 } 3052 3053 /** 3054 * Register a callback to be invoked when a key is pressed in this view. 3055 * @param l the key listener to attach to this view 3056 */ 3057 public void setOnKeyListener(OnKeyListener l) { 3058 mOnKeyListener = l; 3059 } 3060 3061 /** 3062 * Register a callback to be invoked when a touch event is sent to this view. 3063 * @param l the touch listener to attach to this view 3064 */ 3065 public void setOnTouchListener(OnTouchListener l) { 3066 mOnTouchListener = l; 3067 } 3068 3069 /** 3070 * Register a callback to be invoked when a drag event is sent to this view. 3071 * @param l The drag listener to attach to this view 3072 */ 3073 public void setOnDragListener(OnDragListener l) { 3074 mOnDragListener = l; 3075 } 3076 3077 /** 3078 * Give this view focus. This will cause {@link #onFocusChanged} to be called. 3079 * 3080 * Note: this does not check whether this {@link View} should get focus, it just 3081 * gives it focus no matter what. It should only be called internally by framework 3082 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}. 3083 * 3084 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN, 3085 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which 3086 * focus moved when requestFocus() is called. It may not always 3087 * apply, in which case use the default View.FOCUS_DOWN. 3088 * @param previouslyFocusedRect The rectangle of the view that had focus 3089 * prior in this View's coordinate system. 3090 */ 3091 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) { 3092 if (DBG) { 3093 System.out.println(this + " requestFocus()"); 3094 } 3095 3096 if ((mPrivateFlags & FOCUSED) == 0) { 3097 mPrivateFlags |= FOCUSED; 3098 3099 if (mParent != null) { 3100 mParent.requestChildFocus(this, this); 3101 } 3102 3103 onFocusChanged(true, direction, previouslyFocusedRect); 3104 refreshDrawableState(); 3105 } 3106 } 3107 3108 /** 3109 * Request that a rectangle of this view be visible on the screen, 3110 * scrolling if necessary just enough. 3111 * 3112 * <p>A View should call this if it maintains some notion of which part 3113 * of its content is interesting. For example, a text editing view 3114 * should call this when its cursor moves. 3115 * 3116 * @param rectangle The rectangle. 3117 * @return Whether any parent scrolled. 3118 */ 3119 public boolean requestRectangleOnScreen(Rect rectangle) { 3120 return requestRectangleOnScreen(rectangle, false); 3121 } 3122 3123 /** 3124 * Request that a rectangle of this view be visible on the screen, 3125 * scrolling if necessary just enough. 3126 * 3127 * <p>A View should call this if it maintains some notion of which part 3128 * of its content is interesting. For example, a text editing view 3129 * should call this when its cursor moves. 3130 * 3131 * <p>When <code>immediate</code> is set to true, scrolling will not be 3132 * animated. 3133 * 3134 * @param rectangle The rectangle. 3135 * @param immediate True to forbid animated scrolling, false otherwise 3136 * @return Whether any parent scrolled. 3137 */ 3138 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) { 3139 View child = this; 3140 ViewParent parent = mParent; 3141 boolean scrolled = false; 3142 while (parent != null) { 3143 scrolled |= parent.requestChildRectangleOnScreen(child, 3144 rectangle, immediate); 3145 3146 // offset rect so next call has the rectangle in the 3147 // coordinate system of its direct child. 3148 rectangle.offset(child.getLeft(), child.getTop()); 3149 rectangle.offset(-child.getScrollX(), -child.getScrollY()); 3150 3151 if (!(parent instanceof View)) { 3152 break; 3153 } 3154 3155 child = (View) parent; 3156 parent = child.getParent(); 3157 } 3158 return scrolled; 3159 } 3160 3161 /** 3162 * Called when this view wants to give up focus. This will cause 3163 * {@link #onFocusChanged} to be called. 3164 */ 3165 public void clearFocus() { 3166 if (DBG) { 3167 System.out.println(this + " clearFocus()"); 3168 } 3169 3170 if ((mPrivateFlags & FOCUSED) != 0) { 3171 mPrivateFlags &= ~FOCUSED; 3172 3173 if (mParent != null) { 3174 mParent.clearChildFocus(this); 3175 } 3176 3177 onFocusChanged(false, 0, null); 3178 refreshDrawableState(); 3179 } 3180 } 3181 3182 /** 3183 * Called to clear the focus of a view that is about to be removed. 3184 * Doesn't call clearChildFocus, which prevents this view from taking 3185 * focus again before it has been removed from the parent 3186 */ 3187 void clearFocusForRemoval() { 3188 if ((mPrivateFlags & FOCUSED) != 0) { 3189 mPrivateFlags &= ~FOCUSED; 3190 3191 onFocusChanged(false, 0, null); 3192 refreshDrawableState(); 3193 } 3194 } 3195 3196 /** 3197 * Called internally by the view system when a new view is getting focus. 3198 * This is what clears the old focus. 3199 */ 3200 void unFocus() { 3201 if (DBG) { 3202 System.out.println(this + " unFocus()"); 3203 } 3204 3205 if ((mPrivateFlags & FOCUSED) != 0) { 3206 mPrivateFlags &= ~FOCUSED; 3207 3208 onFocusChanged(false, 0, null); 3209 refreshDrawableState(); 3210 } 3211 } 3212 3213 /** 3214 * Returns true if this view has focus iteself, or is the ancestor of the 3215 * view that has focus. 3216 * 3217 * @return True if this view has or contains focus, false otherwise. 3218 */ 3219 @ViewDebug.ExportedProperty(category = "focus") 3220 public boolean hasFocus() { 3221 return (mPrivateFlags & FOCUSED) != 0; 3222 } 3223 3224 /** 3225 * Returns true if this view is focusable or if it contains a reachable View 3226 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()" 3227 * is a View whose parents do not block descendants focus. 3228 * 3229 * Only {@link #VISIBLE} views are considered focusable. 3230 * 3231 * @return True if the view is focusable or if the view contains a focusable 3232 * View, false otherwise. 3233 * 3234 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS 3235 */ 3236 public boolean hasFocusable() { 3237 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable(); 3238 } 3239 3240 /** 3241 * Called by the view system when the focus state of this view changes. 3242 * When the focus change event is caused by directional navigation, direction 3243 * and previouslyFocusedRect provide insight into where the focus is coming from. 3244 * When overriding, be sure to call up through to the super class so that 3245 * the standard focus handling will occur. 3246 * 3247 * @param gainFocus True if the View has focus; false otherwise. 3248 * @param direction The direction focus has moved when requestFocus() 3249 * is called to give this view focus. Values are 3250 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT}, 3251 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}. 3252 * It may not always apply, in which case use the default. 3253 * @param previouslyFocusedRect The rectangle, in this view's coordinate 3254 * system, of the previously focused view. If applicable, this will be 3255 * passed in as finer grained information about where the focus is coming 3256 * from (in addition to direction). Will be <code>null</code> otherwise. 3257 */ 3258 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) { 3259 if (gainFocus) { 3260 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED); 3261 } 3262 3263 InputMethodManager imm = InputMethodManager.peekInstance(); 3264 if (!gainFocus) { 3265 if (isPressed()) { 3266 setPressed(false); 3267 } 3268 if (imm != null && mAttachInfo != null 3269 && mAttachInfo.mHasWindowFocus) { 3270 imm.focusOut(this); 3271 } 3272 onFocusLost(); 3273 } else if (imm != null && mAttachInfo != null 3274 && mAttachInfo.mHasWindowFocus) { 3275 imm.focusIn(this); 3276 } 3277 3278 invalidate(true); 3279 if (mOnFocusChangeListener != null) { 3280 mOnFocusChangeListener.onFocusChange(this, gainFocus); 3281 } 3282 3283 if (mAttachInfo != null) { 3284 mAttachInfo.mKeyDispatchState.reset(this); 3285 } 3286 } 3287 3288 /** 3289 * {@inheritDoc} 3290 */ 3291 public void sendAccessibilityEvent(int eventType) { 3292 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 3293 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType)); 3294 } 3295 } 3296 3297 /** 3298 * {@inheritDoc} 3299 */ 3300 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) { 3301 if (!isShown()) { 3302 return; 3303 } 3304 event.setClassName(getClass().getName()); 3305 event.setPackageName(getContext().getPackageName()); 3306 event.setEnabled(isEnabled()); 3307 event.setContentDescription(mContentDescription); 3308 3309 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) { 3310 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList; 3311 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL); 3312 event.setItemCount(focusablesTempList.size()); 3313 event.setCurrentItemIndex(focusablesTempList.indexOf(this)); 3314 focusablesTempList.clear(); 3315 } 3316 3317 dispatchPopulateAccessibilityEvent(event); 3318 3319 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event); 3320 } 3321 3322 /** 3323 * Dispatches an {@link AccessibilityEvent} to the {@link View} children 3324 * to be populated. 3325 * 3326 * @param event The event. 3327 * 3328 * @return True if the event population was completed. 3329 */ 3330 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 3331 return false; 3332 } 3333 3334 /** 3335 * Gets the {@link View} description. It briefly describes the view and is 3336 * primarily used for accessibility support. Set this property to enable 3337 * better accessibility support for your application. This is especially 3338 * true for views that do not have textual representation (For example, 3339 * ImageButton). 3340 * 3341 * @return The content descriptiopn. 3342 * 3343 * @attr ref android.R.styleable#View_contentDescription 3344 */ 3345 public CharSequence getContentDescription() { 3346 return mContentDescription; 3347 } 3348 3349 /** 3350 * Sets the {@link View} description. It briefly describes the view and is 3351 * primarily used for accessibility support. Set this property to enable 3352 * better accessibility support for your application. This is especially 3353 * true for views that do not have textual representation (For example, 3354 * ImageButton). 3355 * 3356 * @param contentDescription The content description. 3357 * 3358 * @attr ref android.R.styleable#View_contentDescription 3359 */ 3360 public void setContentDescription(CharSequence contentDescription) { 3361 mContentDescription = contentDescription; 3362 } 3363 3364 /** 3365 * Invoked whenever this view loses focus, either by losing window focus or by losing 3366 * focus within its window. This method can be used to clear any state tied to the 3367 * focus. For instance, if a button is held pressed with the trackball and the window 3368 * loses focus, this method can be used to cancel the press. 3369 * 3370 * Subclasses of View overriding this method should always call super.onFocusLost(). 3371 * 3372 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 3373 * @see #onWindowFocusChanged(boolean) 3374 * 3375 * @hide pending API council approval 3376 */ 3377 protected void onFocusLost() { 3378 resetPressedState(); 3379 } 3380 3381 private void resetPressedState() { 3382 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 3383 return; 3384 } 3385 3386 if (isPressed()) { 3387 setPressed(false); 3388 3389 if (!mHasPerformedLongPress) { 3390 removeLongPressCallback(); 3391 } 3392 } 3393 } 3394 3395 /** 3396 * Returns true if this view has focus 3397 * 3398 * @return True if this view has focus, false otherwise. 3399 */ 3400 @ViewDebug.ExportedProperty(category = "focus") 3401 public boolean isFocused() { 3402 return (mPrivateFlags & FOCUSED) != 0; 3403 } 3404 3405 /** 3406 * Find the view in the hierarchy rooted at this view that currently has 3407 * focus. 3408 * 3409 * @return The view that currently has focus, or null if no focused view can 3410 * be found. 3411 */ 3412 public View findFocus() { 3413 return (mPrivateFlags & FOCUSED) != 0 ? this : null; 3414 } 3415 3416 /** 3417 * Change whether this view is one of the set of scrollable containers in 3418 * its window. This will be used to determine whether the window can 3419 * resize or must pan when a soft input area is open -- scrollable 3420 * containers allow the window to use resize mode since the container 3421 * will appropriately shrink. 3422 */ 3423 public void setScrollContainer(boolean isScrollContainer) { 3424 if (isScrollContainer) { 3425 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) { 3426 mAttachInfo.mScrollContainers.add(this); 3427 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 3428 } 3429 mPrivateFlags |= SCROLL_CONTAINER; 3430 } else { 3431 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) { 3432 mAttachInfo.mScrollContainers.remove(this); 3433 } 3434 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED); 3435 } 3436 } 3437 3438 /** 3439 * Returns the quality of the drawing cache. 3440 * 3441 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 3442 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 3443 * 3444 * @see #setDrawingCacheQuality(int) 3445 * @see #setDrawingCacheEnabled(boolean) 3446 * @see #isDrawingCacheEnabled() 3447 * 3448 * @attr ref android.R.styleable#View_drawingCacheQuality 3449 */ 3450 public int getDrawingCacheQuality() { 3451 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 3452 } 3453 3454 /** 3455 * Set the drawing cache quality of this view. This value is used only when the 3456 * drawing cache is enabled 3457 * 3458 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 3459 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 3460 * 3461 * @see #getDrawingCacheQuality() 3462 * @see #setDrawingCacheEnabled(boolean) 3463 * @see #isDrawingCacheEnabled() 3464 * 3465 * @attr ref android.R.styleable#View_drawingCacheQuality 3466 */ 3467 public void setDrawingCacheQuality(int quality) { 3468 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 3469 } 3470 3471 /** 3472 * Returns whether the screen should remain on, corresponding to the current 3473 * value of {@link #KEEP_SCREEN_ON}. 3474 * 3475 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 3476 * 3477 * @see #setKeepScreenOn(boolean) 3478 * 3479 * @attr ref android.R.styleable#View_keepScreenOn 3480 */ 3481 public boolean getKeepScreenOn() { 3482 return (mViewFlags & KEEP_SCREEN_ON) != 0; 3483 } 3484 3485 /** 3486 * Controls whether the screen should remain on, modifying the 3487 * value of {@link #KEEP_SCREEN_ON}. 3488 * 3489 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 3490 * 3491 * @see #getKeepScreenOn() 3492 * 3493 * @attr ref android.R.styleable#View_keepScreenOn 3494 */ 3495 public void setKeepScreenOn(boolean keepScreenOn) { 3496 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 3497 } 3498 3499 /** 3500 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 3501 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 3502 * 3503 * @attr ref android.R.styleable#View_nextFocusLeft 3504 */ 3505 public int getNextFocusLeftId() { 3506 return mNextFocusLeftId; 3507 } 3508 3509 /** 3510 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}. 3511 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should 3512 * decide automatically. 3513 * 3514 * @attr ref android.R.styleable#View_nextFocusLeft 3515 */ 3516 public void setNextFocusLeftId(int nextFocusLeftId) { 3517 mNextFocusLeftId = nextFocusLeftId; 3518 } 3519 3520 /** 3521 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 3522 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 3523 * 3524 * @attr ref android.R.styleable#View_nextFocusRight 3525 */ 3526 public int getNextFocusRightId() { 3527 return mNextFocusRightId; 3528 } 3529 3530 /** 3531 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}. 3532 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should 3533 * decide automatically. 3534 * 3535 * @attr ref android.R.styleable#View_nextFocusRight 3536 */ 3537 public void setNextFocusRightId(int nextFocusRightId) { 3538 mNextFocusRightId = nextFocusRightId; 3539 } 3540 3541 /** 3542 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}. 3543 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 3544 * 3545 * @attr ref android.R.styleable#View_nextFocusUp 3546 */ 3547 public int getNextFocusUpId() { 3548 return mNextFocusUpId; 3549 } 3550 3551 /** 3552 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}. 3553 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should 3554 * decide automatically. 3555 * 3556 * @attr ref android.R.styleable#View_nextFocusUp 3557 */ 3558 public void setNextFocusUpId(int nextFocusUpId) { 3559 mNextFocusUpId = nextFocusUpId; 3560 } 3561 3562 /** 3563 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 3564 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 3565 * 3566 * @attr ref android.R.styleable#View_nextFocusDown 3567 */ 3568 public int getNextFocusDownId() { 3569 return mNextFocusDownId; 3570 } 3571 3572 /** 3573 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}. 3574 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should 3575 * decide automatically. 3576 * 3577 * @attr ref android.R.styleable#View_nextFocusDown 3578 */ 3579 public void setNextFocusDownId(int nextFocusDownId) { 3580 mNextFocusDownId = nextFocusDownId; 3581 } 3582 3583 /** 3584 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 3585 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically. 3586 * 3587 * @attr ref android.R.styleable#View_nextFocusForward 3588 */ 3589 public int getNextFocusForwardId() { 3590 return mNextFocusForwardId; 3591 } 3592 3593 /** 3594 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}. 3595 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should 3596 * decide automatically. 3597 * 3598 * @attr ref android.R.styleable#View_nextFocusForward 3599 */ 3600 public void setNextFocusForwardId(int nextFocusForwardId) { 3601 mNextFocusForwardId = nextFocusForwardId; 3602 } 3603 3604 /** 3605 * Returns the visibility of this view and all of its ancestors 3606 * 3607 * @return True if this view and all of its ancestors are {@link #VISIBLE} 3608 */ 3609 public boolean isShown() { 3610 View current = this; 3611 //noinspection ConstantConditions 3612 do { 3613 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 3614 return false; 3615 } 3616 ViewParent parent = current.mParent; 3617 if (parent == null) { 3618 return false; // We are not attached to the view root 3619 } 3620 if (!(parent instanceof View)) { 3621 return true; 3622 } 3623 current = (View) parent; 3624 } while (current != null); 3625 3626 return false; 3627 } 3628 3629 /** 3630 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag 3631 * is set 3632 * 3633 * @param insets Insets for system windows 3634 * 3635 * @return True if this view applied the insets, false otherwise 3636 */ 3637 protected boolean fitSystemWindows(Rect insets) { 3638 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 3639 mPaddingLeft = insets.left; 3640 mPaddingTop = insets.top; 3641 mPaddingRight = insets.right; 3642 mPaddingBottom = insets.bottom; 3643 requestLayout(); 3644 return true; 3645 } 3646 return false; 3647 } 3648 3649 /** 3650 * Determine if this view has the FITS_SYSTEM_WINDOWS flag set. 3651 * @return True if window has FITS_SYSTEM_WINDOWS set 3652 * 3653 * @hide 3654 */ 3655 public boolean isFitsSystemWindowsFlagSet() { 3656 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS; 3657 } 3658 3659 /** 3660 * Returns the visibility status for this view. 3661 * 3662 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 3663 * @attr ref android.R.styleable#View_visibility 3664 */ 3665 @ViewDebug.ExportedProperty(mapping = { 3666 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 3667 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 3668 @ViewDebug.IntToString(from = GONE, to = "GONE") 3669 }) 3670 public int getVisibility() { 3671 return mViewFlags & VISIBILITY_MASK; 3672 } 3673 3674 /** 3675 * Set the enabled state of this view. 3676 * 3677 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 3678 * @attr ref android.R.styleable#View_visibility 3679 */ 3680 @RemotableViewMethod 3681 public void setVisibility(int visibility) { 3682 setFlags(visibility, VISIBILITY_MASK); 3683 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false); 3684 } 3685 3686 /** 3687 * Returns the enabled status for this view. The interpretation of the 3688 * enabled state varies by subclass. 3689 * 3690 * @return True if this view is enabled, false otherwise. 3691 */ 3692 @ViewDebug.ExportedProperty 3693 public boolean isEnabled() { 3694 return (mViewFlags & ENABLED_MASK) == ENABLED; 3695 } 3696 3697 /** 3698 * Set the enabled state of this view. The interpretation of the enabled 3699 * state varies by subclass. 3700 * 3701 * @param enabled True if this view is enabled, false otherwise. 3702 */ 3703 @RemotableViewMethod 3704 public void setEnabled(boolean enabled) { 3705 if (enabled == isEnabled()) return; 3706 3707 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 3708 3709 /* 3710 * The View most likely has to change its appearance, so refresh 3711 * the drawable state. 3712 */ 3713 refreshDrawableState(); 3714 3715 // Invalidate too, since the default behavior for views is to be 3716 // be drawn at 50% alpha rather than to change the drawable. 3717 invalidate(true); 3718 } 3719 3720 /** 3721 * Set whether this view can receive the focus. 3722 * 3723 * Setting this to false will also ensure that this view is not focusable 3724 * in touch mode. 3725 * 3726 * @param focusable If true, this view can receive the focus. 3727 * 3728 * @see #setFocusableInTouchMode(boolean) 3729 * @attr ref android.R.styleable#View_focusable 3730 */ 3731 public void setFocusable(boolean focusable) { 3732 if (!focusable) { 3733 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 3734 } 3735 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 3736 } 3737 3738 /** 3739 * Set whether this view can receive focus while in touch mode. 3740 * 3741 * Setting this to true will also ensure that this view is focusable. 3742 * 3743 * @param focusableInTouchMode If true, this view can receive the focus while 3744 * in touch mode. 3745 * 3746 * @see #setFocusable(boolean) 3747 * @attr ref android.R.styleable#View_focusableInTouchMode 3748 */ 3749 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 3750 // Focusable in touch mode should always be set before the focusable flag 3751 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 3752 // which, in touch mode, will not successfully request focus on this view 3753 // because the focusable in touch mode flag is not set 3754 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 3755 if (focusableInTouchMode) { 3756 setFlags(FOCUSABLE, FOCUSABLE_MASK); 3757 } 3758 } 3759 3760 /** 3761 * Set whether this view should have sound effects enabled for events such as 3762 * clicking and touching. 3763 * 3764 * <p>You may wish to disable sound effects for a view if you already play sounds, 3765 * for instance, a dial key that plays dtmf tones. 3766 * 3767 * @param soundEffectsEnabled whether sound effects are enabled for this view. 3768 * @see #isSoundEffectsEnabled() 3769 * @see #playSoundEffect(int) 3770 * @attr ref android.R.styleable#View_soundEffectsEnabled 3771 */ 3772 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 3773 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 3774 } 3775 3776 /** 3777 * @return whether this view should have sound effects enabled for events such as 3778 * clicking and touching. 3779 * 3780 * @see #setSoundEffectsEnabled(boolean) 3781 * @see #playSoundEffect(int) 3782 * @attr ref android.R.styleable#View_soundEffectsEnabled 3783 */ 3784 @ViewDebug.ExportedProperty 3785 public boolean isSoundEffectsEnabled() { 3786 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 3787 } 3788 3789 /** 3790 * Set whether this view should have haptic feedback for events such as 3791 * long presses. 3792 * 3793 * <p>You may wish to disable haptic feedback if your view already controls 3794 * its own haptic feedback. 3795 * 3796 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 3797 * @see #isHapticFeedbackEnabled() 3798 * @see #performHapticFeedback(int) 3799 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 3800 */ 3801 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 3802 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 3803 } 3804 3805 /** 3806 * @return whether this view should have haptic feedback enabled for events 3807 * long presses. 3808 * 3809 * @see #setHapticFeedbackEnabled(boolean) 3810 * @see #performHapticFeedback(int) 3811 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 3812 */ 3813 @ViewDebug.ExportedProperty 3814 public boolean isHapticFeedbackEnabled() { 3815 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 3816 } 3817 3818 /** 3819 * If this view doesn't do any drawing on its own, set this flag to 3820 * allow further optimizations. By default, this flag is not set on 3821 * View, but could be set on some View subclasses such as ViewGroup. 3822 * 3823 * Typically, if you override {@link #onDraw} you should clear this flag. 3824 * 3825 * @param willNotDraw whether or not this View draw on its own 3826 */ 3827 public void setWillNotDraw(boolean willNotDraw) { 3828 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 3829 } 3830 3831 /** 3832 * Returns whether or not this View draws on its own. 3833 * 3834 * @return true if this view has nothing to draw, false otherwise 3835 */ 3836 @ViewDebug.ExportedProperty(category = "drawing") 3837 public boolean willNotDraw() { 3838 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 3839 } 3840 3841 /** 3842 * When a View's drawing cache is enabled, drawing is redirected to an 3843 * offscreen bitmap. Some views, like an ImageView, must be able to 3844 * bypass this mechanism if they already draw a single bitmap, to avoid 3845 * unnecessary usage of the memory. 3846 * 3847 * @param willNotCacheDrawing true if this view does not cache its 3848 * drawing, false otherwise 3849 */ 3850 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 3851 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 3852 } 3853 3854 /** 3855 * Returns whether or not this View can cache its drawing or not. 3856 * 3857 * @return true if this view does not cache its drawing, false otherwise 3858 */ 3859 @ViewDebug.ExportedProperty(category = "drawing") 3860 public boolean willNotCacheDrawing() { 3861 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 3862 } 3863 3864 /** 3865 * Indicates whether this view reacts to click events or not. 3866 * 3867 * @return true if the view is clickable, false otherwise 3868 * 3869 * @see #setClickable(boolean) 3870 * @attr ref android.R.styleable#View_clickable 3871 */ 3872 @ViewDebug.ExportedProperty 3873 public boolean isClickable() { 3874 return (mViewFlags & CLICKABLE) == CLICKABLE; 3875 } 3876 3877 /** 3878 * Enables or disables click events for this view. When a view 3879 * is clickable it will change its state to "pressed" on every click. 3880 * Subclasses should set the view clickable to visually react to 3881 * user's clicks. 3882 * 3883 * @param clickable true to make the view clickable, false otherwise 3884 * 3885 * @see #isClickable() 3886 * @attr ref android.R.styleable#View_clickable 3887 */ 3888 public void setClickable(boolean clickable) { 3889 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 3890 } 3891 3892 /** 3893 * Indicates whether this view reacts to long click events or not. 3894 * 3895 * @return true if the view is long clickable, false otherwise 3896 * 3897 * @see #setLongClickable(boolean) 3898 * @attr ref android.R.styleable#View_longClickable 3899 */ 3900 public boolean isLongClickable() { 3901 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 3902 } 3903 3904 /** 3905 * Enables or disables long click events for this view. When a view is long 3906 * clickable it reacts to the user holding down the button for a longer 3907 * duration than a tap. This event can either launch the listener or a 3908 * context menu. 3909 * 3910 * @param longClickable true to make the view long clickable, false otherwise 3911 * @see #isLongClickable() 3912 * @attr ref android.R.styleable#View_longClickable 3913 */ 3914 public void setLongClickable(boolean longClickable) { 3915 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 3916 } 3917 3918 /** 3919 * Sets the pressed state for this view. 3920 * 3921 * @see #isClickable() 3922 * @see #setClickable(boolean) 3923 * 3924 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 3925 * the View's internal state from a previously set "pressed" state. 3926 */ 3927 public void setPressed(boolean pressed) { 3928 if (pressed) { 3929 mPrivateFlags |= PRESSED; 3930 } else { 3931 mPrivateFlags &= ~PRESSED; 3932 } 3933 refreshDrawableState(); 3934 dispatchSetPressed(pressed); 3935 } 3936 3937 /** 3938 * Dispatch setPressed to all of this View's children. 3939 * 3940 * @see #setPressed(boolean) 3941 * 3942 * @param pressed The new pressed state 3943 */ 3944 protected void dispatchSetPressed(boolean pressed) { 3945 } 3946 3947 /** 3948 * Indicates whether the view is currently in pressed state. Unless 3949 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 3950 * the pressed state. 3951 * 3952 * @see #setPressed 3953 * @see #isClickable() 3954 * @see #setClickable(boolean) 3955 * 3956 * @return true if the view is currently pressed, false otherwise 3957 */ 3958 public boolean isPressed() { 3959 return (mPrivateFlags & PRESSED) == PRESSED; 3960 } 3961 3962 /** 3963 * Indicates whether this view will save its state (that is, 3964 * whether its {@link #onSaveInstanceState} method will be called). 3965 * 3966 * @return Returns true if the view state saving is enabled, else false. 3967 * 3968 * @see #setSaveEnabled(boolean) 3969 * @attr ref android.R.styleable#View_saveEnabled 3970 */ 3971 public boolean isSaveEnabled() { 3972 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 3973 } 3974 3975 /** 3976 * Controls whether the saving of this view's state is 3977 * enabled (that is, whether its {@link #onSaveInstanceState} method 3978 * will be called). Note that even if freezing is enabled, the 3979 * view still must have an id assigned to it (via {@link #setId setId()}) 3980 * for its state to be saved. This flag can only disable the 3981 * saving of this view; any child views may still have their state saved. 3982 * 3983 * @param enabled Set to false to <em>disable</em> state saving, or true 3984 * (the default) to allow it. 3985 * 3986 * @see #isSaveEnabled() 3987 * @see #setId(int) 3988 * @see #onSaveInstanceState() 3989 * @attr ref android.R.styleable#View_saveEnabled 3990 */ 3991 public void setSaveEnabled(boolean enabled) { 3992 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 3993 } 3994 3995 /** 3996 * Gets whether the framework should discard touches when the view's 3997 * window is obscured by another visible window. 3998 * Refer to the {@link View} security documentation for more details. 3999 * 4000 * @return True if touch filtering is enabled. 4001 * 4002 * @see #setFilterTouchesWhenObscured(boolean) 4003 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 4004 */ 4005 @ViewDebug.ExportedProperty 4006 public boolean getFilterTouchesWhenObscured() { 4007 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0; 4008 } 4009 4010 /** 4011 * Sets whether the framework should discard touches when the view's 4012 * window is obscured by another visible window. 4013 * Refer to the {@link View} security documentation for more details. 4014 * 4015 * @param enabled True if touch filtering should be enabled. 4016 * 4017 * @see #getFilterTouchesWhenObscured 4018 * @attr ref android.R.styleable#View_filterTouchesWhenObscured 4019 */ 4020 public void setFilterTouchesWhenObscured(boolean enabled) { 4021 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED, 4022 FILTER_TOUCHES_WHEN_OBSCURED); 4023 } 4024 4025 /** 4026 * Indicates whether the entire hierarchy under this view will save its 4027 * state when a state saving traversal occurs from its parent. The default 4028 * is true; if false, these views will not be saved unless 4029 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 4030 * 4031 * @return Returns true if the view state saving from parent is enabled, else false. 4032 * 4033 * @see #setSaveFromParentEnabled(boolean) 4034 */ 4035 public boolean isSaveFromParentEnabled() { 4036 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED; 4037 } 4038 4039 /** 4040 * Controls whether the entire hierarchy under this view will save its 4041 * state when a state saving traversal occurs from its parent. The default 4042 * is true; if false, these views will not be saved unless 4043 * {@link #saveHierarchyState(SparseArray)} is called directly on this view. 4044 * 4045 * @param enabled Set to false to <em>disable</em> state saving, or true 4046 * (the default) to allow it. 4047 * 4048 * @see #isSaveFromParentEnabled() 4049 * @see #setId(int) 4050 * @see #onSaveInstanceState() 4051 */ 4052 public void setSaveFromParentEnabled(boolean enabled) { 4053 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK); 4054 } 4055 4056 4057 /** 4058 * Returns whether this View is able to take focus. 4059 * 4060 * @return True if this view can take focus, or false otherwise. 4061 * @attr ref android.R.styleable#View_focusable 4062 */ 4063 @ViewDebug.ExportedProperty(category = "focus") 4064 public final boolean isFocusable() { 4065 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 4066 } 4067 4068 /** 4069 * When a view is focusable, it may not want to take focus when in touch mode. 4070 * For example, a button would like focus when the user is navigating via a D-pad 4071 * so that the user can click on it, but once the user starts touching the screen, 4072 * the button shouldn't take focus 4073 * @return Whether the view is focusable in touch mode. 4074 * @attr ref android.R.styleable#View_focusableInTouchMode 4075 */ 4076 @ViewDebug.ExportedProperty 4077 public final boolean isFocusableInTouchMode() { 4078 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 4079 } 4080 4081 /** 4082 * Find the nearest view in the specified direction that can take focus. 4083 * This does not actually give focus to that view. 4084 * 4085 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 4086 * 4087 * @return The nearest focusable in the specified direction, or null if none 4088 * can be found. 4089 */ 4090 public View focusSearch(int direction) { 4091 if (mParent != null) { 4092 return mParent.focusSearch(this, direction); 4093 } else { 4094 return null; 4095 } 4096 } 4097 4098 /** 4099 * This method is the last chance for the focused view and its ancestors to 4100 * respond to an arrow key. This is called when the focused view did not 4101 * consume the key internally, nor could the view system find a new view in 4102 * the requested direction to give focus to. 4103 * 4104 * @param focused The currently focused view. 4105 * @param direction The direction focus wants to move. One of FOCUS_UP, 4106 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 4107 * @return True if the this view consumed this unhandled move. 4108 */ 4109 public boolean dispatchUnhandledMove(View focused, int direction) { 4110 return false; 4111 } 4112 4113 /** 4114 * If a user manually specified the next view id for a particular direction, 4115 * use the root to look up the view. 4116 * @param root The root view of the hierarchy containing this view. 4117 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, 4118 * or FOCUS_BACKWARD. 4119 * @return The user specified next view, or null if there is none. 4120 */ 4121 View findUserSetNextFocus(View root, int direction) { 4122 switch (direction) { 4123 case FOCUS_LEFT: 4124 if (mNextFocusLeftId == View.NO_ID) return null; 4125 return findViewShouldExist(root, mNextFocusLeftId); 4126 case FOCUS_RIGHT: 4127 if (mNextFocusRightId == View.NO_ID) return null; 4128 return findViewShouldExist(root, mNextFocusRightId); 4129 case FOCUS_UP: 4130 if (mNextFocusUpId == View.NO_ID) return null; 4131 return findViewShouldExist(root, mNextFocusUpId); 4132 case FOCUS_DOWN: 4133 if (mNextFocusDownId == View.NO_ID) return null; 4134 return findViewShouldExist(root, mNextFocusDownId); 4135 case FOCUS_FORWARD: 4136 if (mNextFocusForwardId == View.NO_ID) return null; 4137 return findViewShouldExist(root, mNextFocusForwardId); 4138 case FOCUS_BACKWARD: { 4139 final int id = mID; 4140 return root.findViewByPredicate(new Predicate<View>() { 4141 @Override 4142 public boolean apply(View t) { 4143 return t.mNextFocusForwardId == id; 4144 } 4145 }); 4146 } 4147 } 4148 return null; 4149 } 4150 4151 private static View findViewShouldExist(View root, int childViewId) { 4152 View result = root.findViewById(childViewId); 4153 if (result == null) { 4154 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified " 4155 + "by user for id " + childViewId); 4156 } 4157 return result; 4158 } 4159 4160 /** 4161 * Find and return all focusable views that are descendants of this view, 4162 * possibly including this view if it is focusable itself. 4163 * 4164 * @param direction The direction of the focus 4165 * @return A list of focusable views 4166 */ 4167 public ArrayList<View> getFocusables(int direction) { 4168 ArrayList<View> result = new ArrayList<View>(24); 4169 addFocusables(result, direction); 4170 return result; 4171 } 4172 4173 /** 4174 * Add any focusable views that are descendants of this view (possibly 4175 * including this view if it is focusable itself) to views. If we are in touch mode, 4176 * only add views that are also focusable in touch mode. 4177 * 4178 * @param views Focusable views found so far 4179 * @param direction The direction of the focus 4180 */ 4181 public void addFocusables(ArrayList<View> views, int direction) { 4182 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 4183 } 4184 4185 /** 4186 * Adds any focusable views that are descendants of this view (possibly 4187 * including this view if it is focusable itself) to views. This method 4188 * adds all focusable views regardless if we are in touch mode or 4189 * only views focusable in touch mode if we are in touch mode depending on 4190 * the focusable mode paramater. 4191 * 4192 * @param views Focusable views found so far or null if all we are interested is 4193 * the number of focusables. 4194 * @param direction The direction of the focus. 4195 * @param focusableMode The type of focusables to be added. 4196 * 4197 * @see #FOCUSABLES_ALL 4198 * @see #FOCUSABLES_TOUCH_MODE 4199 */ 4200 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) { 4201 if (!isFocusable()) { 4202 return; 4203 } 4204 4205 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE && 4206 isInTouchMode() && !isFocusableInTouchMode()) { 4207 return; 4208 } 4209 4210 if (views != null) { 4211 views.add(this); 4212 } 4213 } 4214 4215 /** 4216 * Find and return all touchable views that are descendants of this view, 4217 * possibly including this view if it is touchable itself. 4218 * 4219 * @return A list of touchable views 4220 */ 4221 public ArrayList<View> getTouchables() { 4222 ArrayList<View> result = new ArrayList<View>(); 4223 addTouchables(result); 4224 return result; 4225 } 4226 4227 /** 4228 * Add any touchable views that are descendants of this view (possibly 4229 * including this view if it is touchable itself) to views. 4230 * 4231 * @param views Touchable views found so far 4232 */ 4233 public void addTouchables(ArrayList<View> views) { 4234 final int viewFlags = mViewFlags; 4235 4236 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 4237 && (viewFlags & ENABLED_MASK) == ENABLED) { 4238 views.add(this); 4239 } 4240 } 4241 4242 /** 4243 * Call this to try to give focus to a specific view or to one of its 4244 * descendants. 4245 * 4246 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false), 4247 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode}) 4248 * while the device is in touch mode. 4249 * 4250 * See also {@link #focusSearch}, which is what you call to say that you 4251 * have focus, and you want your parent to look for the next one. 4252 * 4253 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 4254 * {@link #FOCUS_DOWN} and <code>null</code>. 4255 * 4256 * @return Whether this view or one of its descendants actually took focus. 4257 */ 4258 public final boolean requestFocus() { 4259 return requestFocus(View.FOCUS_DOWN); 4260 } 4261 4262 4263 /** 4264 * Call this to try to give focus to a specific view or to one of its 4265 * descendants and give it a hint about what direction focus is heading. 4266 * 4267 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false), 4268 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode}) 4269 * while the device is in touch mode. 4270 * 4271 * See also {@link #focusSearch}, which is what you call to say that you 4272 * have focus, and you want your parent to look for the next one. 4273 * 4274 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 4275 * <code>null</code> set for the previously focused rectangle. 4276 * 4277 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 4278 * @return Whether this view or one of its descendants actually took focus. 4279 */ 4280 public final boolean requestFocus(int direction) { 4281 return requestFocus(direction, null); 4282 } 4283 4284 /** 4285 * Call this to try to give focus to a specific view or to one of its descendants 4286 * and give it hints about the direction and a specific rectangle that the focus 4287 * is coming from. The rectangle can help give larger views a finer grained hint 4288 * about where focus is coming from, and therefore, where to show selection, or 4289 * forward focus change internally. 4290 * 4291 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false), 4292 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode}) 4293 * while the device is in touch mode. 4294 * 4295 * A View will not take focus if it is not visible. 4296 * 4297 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()} 4298 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 4299 * 4300 * See also {@link #focusSearch}, which is what you call to say that you 4301 * have focus, and you want your parent to look for the next one. 4302 * 4303 * You may wish to override this method if your custom {@link View} has an internal 4304 * {@link View} that it wishes to forward the request to. 4305 * 4306 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 4307 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 4308 * to give a finer grained hint about where focus is coming from. May be null 4309 * if there is no hint. 4310 * @return Whether this view or one of its descendants actually took focus. 4311 */ 4312 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 4313 // need to be focusable 4314 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 4315 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 4316 return false; 4317 } 4318 4319 // need to be focusable in touch mode if in touch mode 4320 if (isInTouchMode() && 4321 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 4322 return false; 4323 } 4324 4325 // need to not have any parents blocking us 4326 if (hasAncestorThatBlocksDescendantFocus()) { 4327 return false; 4328 } 4329 4330 handleFocusGainInternal(direction, previouslyFocusedRect); 4331 return true; 4332 } 4333 4334 /** Gets the ViewRoot, or null if not attached. */ 4335 /*package*/ ViewRoot getViewRoot() { 4336 View root = getRootView(); 4337 return root != null ? (ViewRoot)root.getParent() : null; 4338 } 4339 4340 /** 4341 * Call this to try to give focus to a specific view or to one of its descendants. This is a 4342 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 4343 * touch mode to request focus when they are touched. 4344 * 4345 * @return Whether this view or one of its descendants actually took focus. 4346 * 4347 * @see #isInTouchMode() 4348 * 4349 */ 4350 public final boolean requestFocusFromTouch() { 4351 // Leave touch mode if we need to 4352 if (isInTouchMode()) { 4353 ViewRoot viewRoot = getViewRoot(); 4354 if (viewRoot != null) { 4355 viewRoot.ensureTouchMode(false); 4356 } 4357 } 4358 return requestFocus(View.FOCUS_DOWN); 4359 } 4360 4361 /** 4362 * @return Whether any ancestor of this view blocks descendant focus. 4363 */ 4364 private boolean hasAncestorThatBlocksDescendantFocus() { 4365 ViewParent ancestor = mParent; 4366 while (ancestor instanceof ViewGroup) { 4367 final ViewGroup vgAncestor = (ViewGroup) ancestor; 4368 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) { 4369 return true; 4370 } else { 4371 ancestor = vgAncestor.getParent(); 4372 } 4373 } 4374 return false; 4375 } 4376 4377 /** 4378 * @hide 4379 */ 4380 public void dispatchStartTemporaryDetach() { 4381 onStartTemporaryDetach(); 4382 } 4383 4384 /** 4385 * This is called when a container is going to temporarily detach a child, with 4386 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 4387 * It will either be followed by {@link #onFinishTemporaryDetach()} or 4388 * {@link #onDetachedFromWindow()} when the container is done. 4389 */ 4390 public void onStartTemporaryDetach() { 4391 removeUnsetPressCallback(); 4392 mPrivateFlags |= CANCEL_NEXT_UP_EVENT; 4393 } 4394 4395 /** 4396 * @hide 4397 */ 4398 public void dispatchFinishTemporaryDetach() { 4399 onFinishTemporaryDetach(); 4400 } 4401 4402 /** 4403 * Called after {@link #onStartTemporaryDetach} when the container is done 4404 * changing the view. 4405 */ 4406 public void onFinishTemporaryDetach() { 4407 } 4408 4409 /** 4410 * capture information of this view for later analysis: developement only 4411 * check dynamic switch to make sure we only dump view 4412 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set 4413 */ 4414 private static void captureViewInfo(String subTag, View v) { 4415 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) { 4416 return; 4417 } 4418 ViewDebug.dumpCapturedView(subTag, v); 4419 } 4420 4421 /** 4422 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 4423 * for this view's window. Returns null if the view is not currently attached 4424 * to the window. Normally you will not need to use this directly, but 4425 * just use the standard high-level event callbacks like {@link #onKeyDown}. 4426 */ 4427 public KeyEvent.DispatcherState getKeyDispatcherState() { 4428 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 4429 } 4430 4431 /** 4432 * Dispatch a key event before it is processed by any input method 4433 * associated with the view hierarchy. This can be used to intercept 4434 * key events in special situations before the IME consumes them; a 4435 * typical example would be handling the BACK key to update the application's 4436 * UI instead of allowing the IME to see it and close itself. 4437 * 4438 * @param event The key event to be dispatched. 4439 * @return True if the event was handled, false otherwise. 4440 */ 4441 public boolean dispatchKeyEventPreIme(KeyEvent event) { 4442 return onKeyPreIme(event.getKeyCode(), event); 4443 } 4444 4445 /** 4446 * Dispatch a key event to the next view on the focus path. This path runs 4447 * from the top of the view tree down to the currently focused view. If this 4448 * view has focus, it will dispatch to itself. Otherwise it will dispatch 4449 * the next node down the focus path. This method also fires any key 4450 * listeners. 4451 * 4452 * @param event The key event to be dispatched. 4453 * @return True if the event was handled, false otherwise. 4454 */ 4455 public boolean dispatchKeyEvent(KeyEvent event) { 4456 // If any attached key listener a first crack at the event. 4457 4458 //noinspection SimplifiableIfStatement,deprecation 4459 if (android.util.Config.LOGV) { 4460 captureViewInfo("captureViewKeyEvent", this); 4461 } 4462 4463 //noinspection SimplifiableIfStatement 4464 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 4465 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 4466 return true; 4467 } 4468 4469 return event.dispatch(this, mAttachInfo != null 4470 ? mAttachInfo.mKeyDispatchState : null, this); 4471 } 4472 4473 /** 4474 * Dispatches a key shortcut event. 4475 * 4476 * @param event The key event to be dispatched. 4477 * @return True if the event was handled by the view, false otherwise. 4478 */ 4479 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 4480 return onKeyShortcut(event.getKeyCode(), event); 4481 } 4482 4483 /** 4484 * Pass the touch screen motion event down to the target view, or this 4485 * view if it is the target. 4486 * 4487 * @param event The motion event to be dispatched. 4488 * @return True if the event was handled by the view, false otherwise. 4489 */ 4490 public boolean dispatchTouchEvent(MotionEvent event) { 4491 if (!onFilterTouchEventForSecurity(event)) { 4492 return false; 4493 } 4494 4495 //noinspection SimplifiableIfStatement 4496 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED && 4497 mOnTouchListener.onTouch(this, event)) { 4498 return true; 4499 } 4500 return onTouchEvent(event); 4501 } 4502 4503 /** 4504 * Filter the touch event to apply security policies. 4505 * 4506 * @param event The motion event to be filtered. 4507 * @return True if the event should be dispatched, false if the event should be dropped. 4508 * 4509 * @see #getFilterTouchesWhenObscured 4510 */ 4511 public boolean onFilterTouchEventForSecurity(MotionEvent event) { 4512 //noinspection RedundantIfStatement 4513 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0 4514 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) { 4515 // Window is obscured, drop this touch. 4516 return false; 4517 } 4518 return true; 4519 } 4520 4521 /** 4522 * Pass a trackball motion event down to the focused view. 4523 * 4524 * @param event The motion event to be dispatched. 4525 * @return True if the event was handled by the view, false otherwise. 4526 */ 4527 public boolean dispatchTrackballEvent(MotionEvent event) { 4528 //Log.i("view", "view=" + this + ", " + event.toString()); 4529 return onTrackballEvent(event); 4530 } 4531 4532 /** 4533 * Pass a generic motion event down to the focused view. 4534 * 4535 * @param event The motion event to be dispatched. 4536 * @return True if the event was handled by the view, false otherwise. 4537 */ 4538 public boolean dispatchGenericMotionEvent(MotionEvent event) { 4539 return onGenericMotionEvent(event); 4540 } 4541 4542 /** 4543 * Called when the window containing this view gains or loses window focus. 4544 * ViewGroups should override to route to their children. 4545 * 4546 * @param hasFocus True if the window containing this view now has focus, 4547 * false otherwise. 4548 */ 4549 public void dispatchWindowFocusChanged(boolean hasFocus) { 4550 onWindowFocusChanged(hasFocus); 4551 } 4552 4553 /** 4554 * Called when the window containing this view gains or loses focus. Note 4555 * that this is separate from view focus: to receive key events, both 4556 * your view and its window must have focus. If a window is displayed 4557 * on top of yours that takes input focus, then your own window will lose 4558 * focus but the view focus will remain unchanged. 4559 * 4560 * @param hasWindowFocus True if the window containing this view now has 4561 * focus, false otherwise. 4562 */ 4563 public void onWindowFocusChanged(boolean hasWindowFocus) { 4564 InputMethodManager imm = InputMethodManager.peekInstance(); 4565 if (!hasWindowFocus) { 4566 if (isPressed()) { 4567 setPressed(false); 4568 } 4569 if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 4570 imm.focusOut(this); 4571 } 4572 removeLongPressCallback(); 4573 removeTapCallback(); 4574 onFocusLost(); 4575 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 4576 imm.focusIn(this); 4577 } 4578 refreshDrawableState(); 4579 } 4580 4581 /** 4582 * Returns true if this view is in a window that currently has window focus. 4583 * Note that this is not the same as the view itself having focus. 4584 * 4585 * @return True if this view is in a window that currently has window focus. 4586 */ 4587 public boolean hasWindowFocus() { 4588 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 4589 } 4590 4591 /** 4592 * Dispatch a view visibility change down the view hierarchy. 4593 * ViewGroups should override to route to their children. 4594 * @param changedView The view whose visibility changed. Could be 'this' or 4595 * an ancestor view. 4596 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 4597 * {@link #INVISIBLE} or {@link #GONE}. 4598 */ 4599 protected void dispatchVisibilityChanged(View changedView, int visibility) { 4600 onVisibilityChanged(changedView, visibility); 4601 } 4602 4603 /** 4604 * Called when the visibility of the view or an ancestor of the view is changed. 4605 * @param changedView The view whose visibility changed. Could be 'this' or 4606 * an ancestor view. 4607 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 4608 * {@link #INVISIBLE} or {@link #GONE}. 4609 */ 4610 protected void onVisibilityChanged(View changedView, int visibility) { 4611 if (visibility == VISIBLE) { 4612 if (mAttachInfo != null) { 4613 initialAwakenScrollBars(); 4614 } else { 4615 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH; 4616 } 4617 } 4618 } 4619 4620 /** 4621 * Dispatch a hint about whether this view is displayed. For instance, when 4622 * a View moves out of the screen, it might receives a display hint indicating 4623 * the view is not displayed. Applications should not <em>rely</em> on this hint 4624 * as there is no guarantee that they will receive one. 4625 * 4626 * @param hint A hint about whether or not this view is displayed: 4627 * {@link #VISIBLE} or {@link #INVISIBLE}. 4628 */ 4629 public void dispatchDisplayHint(int hint) { 4630 onDisplayHint(hint); 4631 } 4632 4633 /** 4634 * Gives this view a hint about whether is displayed or not. For instance, when 4635 * a View moves out of the screen, it might receives a display hint indicating 4636 * the view is not displayed. Applications should not <em>rely</em> on this hint 4637 * as there is no guarantee that they will receive one. 4638 * 4639 * @param hint A hint about whether or not this view is displayed: 4640 * {@link #VISIBLE} or {@link #INVISIBLE}. 4641 */ 4642 protected void onDisplayHint(int hint) { 4643 } 4644 4645 /** 4646 * Dispatch a window visibility change down the view hierarchy. 4647 * ViewGroups should override to route to their children. 4648 * 4649 * @param visibility The new visibility of the window. 4650 * 4651 * @see #onWindowVisibilityChanged 4652 */ 4653 public void dispatchWindowVisibilityChanged(int visibility) { 4654 onWindowVisibilityChanged(visibility); 4655 } 4656 4657 /** 4658 * Called when the window containing has change its visibility 4659 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 4660 * that this tells you whether or not your window is being made visible 4661 * to the window manager; this does <em>not</em> tell you whether or not 4662 * your window is obscured by other windows on the screen, even if it 4663 * is itself visible. 4664 * 4665 * @param visibility The new visibility of the window. 4666 */ 4667 protected void onWindowVisibilityChanged(int visibility) { 4668 if (visibility == VISIBLE) { 4669 initialAwakenScrollBars(); 4670 } 4671 } 4672 4673 /** 4674 * Returns the current visibility of the window this view is attached to 4675 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 4676 * 4677 * @return Returns the current visibility of the view's window. 4678 */ 4679 public int getWindowVisibility() { 4680 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 4681 } 4682 4683 /** 4684 * Retrieve the overall visible display size in which the window this view is 4685 * attached to has been positioned in. This takes into account screen 4686 * decorations above the window, for both cases where the window itself 4687 * is being position inside of them or the window is being placed under 4688 * then and covered insets are used for the window to position its content 4689 * inside. In effect, this tells you the available area where content can 4690 * be placed and remain visible to users. 4691 * 4692 * <p>This function requires an IPC back to the window manager to retrieve 4693 * the requested information, so should not be used in performance critical 4694 * code like drawing. 4695 * 4696 * @param outRect Filled in with the visible display frame. If the view 4697 * is not attached to a window, this is simply the raw display size. 4698 */ 4699 public void getWindowVisibleDisplayFrame(Rect outRect) { 4700 if (mAttachInfo != null) { 4701 try { 4702 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 4703 } catch (RemoteException e) { 4704 return; 4705 } 4706 // XXX This is really broken, and probably all needs to be done 4707 // in the window manager, and we need to know more about whether 4708 // we want the area behind or in front of the IME. 4709 final Rect insets = mAttachInfo.mVisibleInsets; 4710 outRect.left += insets.left; 4711 outRect.top += insets.top; 4712 outRect.right -= insets.right; 4713 outRect.bottom -= insets.bottom; 4714 return; 4715 } 4716 Display d = WindowManagerImpl.getDefault().getDefaultDisplay(); 4717 outRect.set(0, 0, d.getWidth(), d.getHeight()); 4718 } 4719 4720 /** 4721 * Dispatch a notification about a resource configuration change down 4722 * the view hierarchy. 4723 * ViewGroups should override to route to their children. 4724 * 4725 * @param newConfig The new resource configuration. 4726 * 4727 * @see #onConfigurationChanged 4728 */ 4729 public void dispatchConfigurationChanged(Configuration newConfig) { 4730 onConfigurationChanged(newConfig); 4731 } 4732 4733 /** 4734 * Called when the current configuration of the resources being used 4735 * by the application have changed. You can use this to decide when 4736 * to reload resources that can changed based on orientation and other 4737 * configuration characterstics. You only need to use this if you are 4738 * not relying on the normal {@link android.app.Activity} mechanism of 4739 * recreating the activity instance upon a configuration change. 4740 * 4741 * @param newConfig The new resource configuration. 4742 */ 4743 protected void onConfigurationChanged(Configuration newConfig) { 4744 } 4745 4746 /** 4747 * Private function to aggregate all per-view attributes in to the view 4748 * root. 4749 */ 4750 void dispatchCollectViewAttributes(int visibility) { 4751 performCollectViewAttributes(visibility); 4752 } 4753 4754 void performCollectViewAttributes(int visibility) { 4755 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) { 4756 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) { 4757 mAttachInfo.mKeepScreenOn = true; 4758 } 4759 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility; 4760 if (mOnSystemUiVisibilityChangeListener != null) { 4761 mAttachInfo.mHasSystemUiListeners = true; 4762 } 4763 } 4764 } 4765 4766 void needGlobalAttributesUpdate(boolean force) { 4767 final AttachInfo ai = mAttachInfo; 4768 if (ai != null) { 4769 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0) 4770 || ai.mHasSystemUiListeners) { 4771 ai.mRecomputeGlobalAttributes = true; 4772 } 4773 } 4774 } 4775 4776 /** 4777 * Returns whether the device is currently in touch mode. Touch mode is entered 4778 * once the user begins interacting with the device by touch, and affects various 4779 * things like whether focus is always visible to the user. 4780 * 4781 * @return Whether the device is in touch mode. 4782 */ 4783 @ViewDebug.ExportedProperty 4784 public boolean isInTouchMode() { 4785 if (mAttachInfo != null) { 4786 return mAttachInfo.mInTouchMode; 4787 } else { 4788 return ViewRoot.isInTouchMode(); 4789 } 4790 } 4791 4792 /** 4793 * Returns the context the view is running in, through which it can 4794 * access the current theme, resources, etc. 4795 * 4796 * @return The view's Context. 4797 */ 4798 @ViewDebug.CapturedViewProperty 4799 public final Context getContext() { 4800 return mContext; 4801 } 4802 4803 /** 4804 * Handle a key event before it is processed by any input method 4805 * associated with the view hierarchy. This can be used to intercept 4806 * key events in special situations before the IME consumes them; a 4807 * typical example would be handling the BACK key to update the application's 4808 * UI instead of allowing the IME to see it and close itself. 4809 * 4810 * @param keyCode The value in event.getKeyCode(). 4811 * @param event Description of the key event. 4812 * @return If you handled the event, return true. If you want to allow the 4813 * event to be handled by the next receiver, return false. 4814 */ 4815 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 4816 return false; 4817 } 4818 4819 /** 4820 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent) 4821 * KeyEvent.Callback.onKeyDown()}: perform press of the view 4822 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 4823 * is released, if the view is enabled and clickable. 4824 * 4825 * @param keyCode A key code that represents the button pressed, from 4826 * {@link android.view.KeyEvent}. 4827 * @param event The KeyEvent object that defines the button action. 4828 */ 4829 public boolean onKeyDown(int keyCode, KeyEvent event) { 4830 boolean result = false; 4831 4832 switch (keyCode) { 4833 case KeyEvent.KEYCODE_DPAD_CENTER: 4834 case KeyEvent.KEYCODE_ENTER: { 4835 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 4836 return true; 4837 } 4838 // Long clickable items don't necessarily have to be clickable 4839 if (((mViewFlags & CLICKABLE) == CLICKABLE || 4840 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 4841 (event.getRepeatCount() == 0)) { 4842 setPressed(true); 4843 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 4844 postCheckForLongClick(0); 4845 } 4846 return true; 4847 } 4848 break; 4849 } 4850 } 4851 return result; 4852 } 4853 4854 /** 4855 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 4856 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 4857 * the event). 4858 */ 4859 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 4860 return false; 4861 } 4862 4863 /** 4864 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent) 4865 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view 4866 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 4867 * {@link KeyEvent#KEYCODE_ENTER} is released. 4868 * 4869 * @param keyCode A key code that represents the button pressed, from 4870 * {@link android.view.KeyEvent}. 4871 * @param event The KeyEvent object that defines the button action. 4872 */ 4873 public boolean onKeyUp(int keyCode, KeyEvent event) { 4874 boolean result = false; 4875 4876 switch (keyCode) { 4877 case KeyEvent.KEYCODE_DPAD_CENTER: 4878 case KeyEvent.KEYCODE_ENTER: { 4879 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 4880 return true; 4881 } 4882 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 4883 setPressed(false); 4884 4885 if (!mHasPerformedLongPress) { 4886 // This is a tap, so remove the longpress check 4887 removeLongPressCallback(); 4888 4889 result = performClick(); 4890 } 4891 } 4892 break; 4893 } 4894 } 4895 return result; 4896 } 4897 4898 /** 4899 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 4900 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 4901 * the event). 4902 * 4903 * @param keyCode A key code that represents the button pressed, from 4904 * {@link android.view.KeyEvent}. 4905 * @param repeatCount The number of times the action was made. 4906 * @param event The KeyEvent object that defines the button action. 4907 */ 4908 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 4909 return false; 4910 } 4911 4912 /** 4913 * Called on the focused view when a key shortcut event is not handled. 4914 * Override this method to implement local key shortcuts for the View. 4915 * Key shortcuts can also be implemented by setting the 4916 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 4917 * 4918 * @param keyCode The value in event.getKeyCode(). 4919 * @param event Description of the key event. 4920 * @return If you handled the event, return true. If you want to allow the 4921 * event to be handled by the next receiver, return false. 4922 */ 4923 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 4924 return false; 4925 } 4926 4927 /** 4928 * Check whether the called view is a text editor, in which case it 4929 * would make sense to automatically display a soft input window for 4930 * it. Subclasses should override this if they implement 4931 * {@link #onCreateInputConnection(EditorInfo)} to return true if 4932 * a call on that method would return a non-null InputConnection, and 4933 * they are really a first-class editor that the user would normally 4934 * start typing on when the go into a window containing your view. 4935 * 4936 * <p>The default implementation always returns false. This does 4937 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 4938 * will not be called or the user can not otherwise perform edits on your 4939 * view; it is just a hint to the system that this is not the primary 4940 * purpose of this view. 4941 * 4942 * @return Returns true if this view is a text editor, else false. 4943 */ 4944 public boolean onCheckIsTextEditor() { 4945 return false; 4946 } 4947 4948 /** 4949 * Create a new InputConnection for an InputMethod to interact 4950 * with the view. The default implementation returns null, since it doesn't 4951 * support input methods. You can override this to implement such support. 4952 * This is only needed for views that take focus and text input. 4953 * 4954 * <p>When implementing this, you probably also want to implement 4955 * {@link #onCheckIsTextEditor()} to indicate you will return a 4956 * non-null InputConnection. 4957 * 4958 * @param outAttrs Fill in with attribute information about the connection. 4959 */ 4960 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 4961 return null; 4962 } 4963 4964 /** 4965 * Called by the {@link android.view.inputmethod.InputMethodManager} 4966 * when a view who is not the current 4967 * input connection target is trying to make a call on the manager. The 4968 * default implementation returns false; you can override this to return 4969 * true for certain views if you are performing InputConnection proxying 4970 * to them. 4971 * @param view The View that is making the InputMethodManager call. 4972 * @return Return true to allow the call, false to reject. 4973 */ 4974 public boolean checkInputConnectionProxy(View view) { 4975 return false; 4976 } 4977 4978 /** 4979 * Show the context menu for this view. It is not safe to hold on to the 4980 * menu after returning from this method. 4981 * 4982 * You should normally not overload this method. Overload 4983 * {@link #onCreateContextMenu(ContextMenu)} or define an 4984 * {@link OnCreateContextMenuListener} to add items to the context menu. 4985 * 4986 * @param menu The context menu to populate 4987 */ 4988 public void createContextMenu(ContextMenu menu) { 4989 ContextMenuInfo menuInfo = getContextMenuInfo(); 4990 4991 // Sets the current menu info so all items added to menu will have 4992 // my extra info set. 4993 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 4994 4995 onCreateContextMenu(menu); 4996 if (mOnCreateContextMenuListener != null) { 4997 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 4998 } 4999 5000 // Clear the extra information so subsequent items that aren't mine don't 5001 // have my extra info. 5002 ((MenuBuilder)menu).setCurrentMenuInfo(null); 5003 5004 if (mParent != null) { 5005 mParent.createContextMenu(menu); 5006 } 5007 } 5008 5009 /** 5010 * Views should implement this if they have extra information to associate 5011 * with the context menu. The return result is supplied as a parameter to 5012 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 5013 * callback. 5014 * 5015 * @return Extra information about the item for which the context menu 5016 * should be shown. This information will vary across different 5017 * subclasses of View. 5018 */ 5019 protected ContextMenuInfo getContextMenuInfo() { 5020 return null; 5021 } 5022 5023 /** 5024 * Views should implement this if the view itself is going to add items to 5025 * the context menu. 5026 * 5027 * @param menu the context menu to populate 5028 */ 5029 protected void onCreateContextMenu(ContextMenu menu) { 5030 } 5031 5032 /** 5033 * Implement this method to handle trackball motion events. The 5034 * <em>relative</em> movement of the trackball since the last event 5035 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 5036 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 5037 * that a movement of 1 corresponds to the user pressing one DPAD key (so 5038 * they will often be fractional values, representing the more fine-grained 5039 * movement information available from a trackball). 5040 * 5041 * @param event The motion event. 5042 * @return True if the event was handled, false otherwise. 5043 */ 5044 public boolean onTrackballEvent(MotionEvent event) { 5045 return false; 5046 } 5047 5048 /** 5049 * Implement this method to handle generic motion events. 5050 * <p> 5051 * Generic motion events are dispatched to the focused view to describe 5052 * the motions of input devices such as joysticks. The 5053 * {@link MotionEvent#getSource() source} of the motion event specifies 5054 * the class of input that was received. Implementations of this method 5055 * must examine the bits in the source before processing the event. 5056 * The following code example shows how this is done. 5057 * </p> 5058 * <code> 5059 * public boolean onGenericMotionEvent(MotionEvent event) { 5060 * if ((event.getSource() & InputDevice.SOURCE_CLASS_JOYSTICK) != 0) { 5061 * float x = event.getX(); 5062 * float y = event.getY(); 5063 * // process the joystick motion 5064 * return true; 5065 * } 5066 * return super.onGenericMotionEvent(event); 5067 * } 5068 * </code> 5069 * 5070 * @param event The generic motion event being processed. 5071 * 5072 * @return Return true if you have consumed the event, false if you haven't. 5073 * The default implementation always returns false. 5074 */ 5075 public boolean onGenericMotionEvent(MotionEvent event) { 5076 return false; 5077 } 5078 5079 /** 5080 * Implement this method to handle touch screen motion events. 5081 * 5082 * @param event The motion event. 5083 * @return True if the event was handled, false otherwise. 5084 */ 5085 public boolean onTouchEvent(MotionEvent event) { 5086 final int viewFlags = mViewFlags; 5087 5088 if ((viewFlags & ENABLED_MASK) == DISABLED) { 5089 // A disabled view that is clickable still consumes the touch 5090 // events, it just doesn't respond to them. 5091 return (((viewFlags & CLICKABLE) == CLICKABLE || 5092 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 5093 } 5094 5095 if (mTouchDelegate != null) { 5096 if (mTouchDelegate.onTouchEvent(event)) { 5097 return true; 5098 } 5099 } 5100 5101 if (((viewFlags & CLICKABLE) == CLICKABLE || 5102 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 5103 switch (event.getAction()) { 5104 case MotionEvent.ACTION_UP: 5105 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0; 5106 if ((mPrivateFlags & PRESSED) != 0 || prepressed) { 5107 // take focus if we don't have it already and we should in 5108 // touch mode. 5109 boolean focusTaken = false; 5110 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 5111 focusTaken = requestFocus(); 5112 } 5113 5114 if (prepressed) { 5115 // The button is being released before we actually 5116 // showed it as pressed. Make it show the pressed 5117 // state now (before scheduling the click) to ensure 5118 // the user sees it. 5119 mPrivateFlags |= PRESSED; 5120 refreshDrawableState(); 5121 } 5122 5123 if (!mHasPerformedLongPress) { 5124 // This is a tap, so remove the longpress check 5125 removeLongPressCallback(); 5126 5127 // Only perform take click actions if we were in the pressed state 5128 if (!focusTaken) { 5129 // Use a Runnable and post this rather than calling 5130 // performClick directly. This lets other visual state 5131 // of the view update before click actions start. 5132 if (mPerformClick == null) { 5133 mPerformClick = new PerformClick(); 5134 } 5135 if (!post(mPerformClick)) { 5136 performClick(); 5137 } 5138 } 5139 } 5140 5141 if (mUnsetPressedState == null) { 5142 mUnsetPressedState = new UnsetPressedState(); 5143 } 5144 5145 if (prepressed) { 5146 postDelayed(mUnsetPressedState, 5147 ViewConfiguration.getPressedStateDuration()); 5148 } else if (!post(mUnsetPressedState)) { 5149 // If the post failed, unpress right now 5150 mUnsetPressedState.run(); 5151 } 5152 removeTapCallback(); 5153 } 5154 break; 5155 5156 case MotionEvent.ACTION_DOWN: 5157 if (mPendingCheckForTap == null) { 5158 mPendingCheckForTap = new CheckForTap(); 5159 } 5160 mPrivateFlags |= PREPRESSED; 5161 mHasPerformedLongPress = false; 5162 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 5163 break; 5164 5165 case MotionEvent.ACTION_CANCEL: 5166 mPrivateFlags &= ~PRESSED; 5167 refreshDrawableState(); 5168 removeTapCallback(); 5169 break; 5170 5171 case MotionEvent.ACTION_MOVE: 5172 final int x = (int) event.getX(); 5173 final int y = (int) event.getY(); 5174 5175 // Be lenient about moving outside of buttons 5176 if (!pointInView(x, y, mTouchSlop)) { 5177 // Outside button 5178 removeTapCallback(); 5179 if ((mPrivateFlags & PRESSED) != 0) { 5180 // Remove any future long press/tap checks 5181 removeLongPressCallback(); 5182 5183 // Need to switch from pressed to not pressed 5184 mPrivateFlags &= ~PRESSED; 5185 refreshDrawableState(); 5186 } 5187 } 5188 break; 5189 } 5190 return true; 5191 } 5192 5193 return false; 5194 } 5195 5196 /** 5197 * Remove the longpress detection timer. 5198 */ 5199 private void removeLongPressCallback() { 5200 if (mPendingCheckForLongPress != null) { 5201 removeCallbacks(mPendingCheckForLongPress); 5202 } 5203 } 5204 5205 /** 5206 * Remove the pending click action 5207 */ 5208 private void removePerformClickCallback() { 5209 if (mPerformClick != null) { 5210 removeCallbacks(mPerformClick); 5211 } 5212 } 5213 5214 /** 5215 * Remove the prepress detection timer. 5216 */ 5217 private void removeUnsetPressCallback() { 5218 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) { 5219 setPressed(false); 5220 removeCallbacks(mUnsetPressedState); 5221 } 5222 } 5223 5224 /** 5225 * Remove the tap detection timer. 5226 */ 5227 private void removeTapCallback() { 5228 if (mPendingCheckForTap != null) { 5229 mPrivateFlags &= ~PREPRESSED; 5230 removeCallbacks(mPendingCheckForTap); 5231 } 5232 } 5233 5234 /** 5235 * Cancels a pending long press. Your subclass can use this if you 5236 * want the context menu to come up if the user presses and holds 5237 * at the same place, but you don't want it to come up if they press 5238 * and then move around enough to cause scrolling. 5239 */ 5240 public void cancelLongPress() { 5241 removeLongPressCallback(); 5242 5243 /* 5244 * The prepressed state handled by the tap callback is a display 5245 * construct, but the tap callback will post a long press callback 5246 * less its own timeout. Remove it here. 5247 */ 5248 removeTapCallback(); 5249 } 5250 5251 /** 5252 * Sets the TouchDelegate for this View. 5253 */ 5254 public void setTouchDelegate(TouchDelegate delegate) { 5255 mTouchDelegate = delegate; 5256 } 5257 5258 /** 5259 * Gets the TouchDelegate for this View. 5260 */ 5261 public TouchDelegate getTouchDelegate() { 5262 return mTouchDelegate; 5263 } 5264 5265 /** 5266 * Set flags controlling behavior of this view. 5267 * 5268 * @param flags Constant indicating the value which should be set 5269 * @param mask Constant indicating the bit range that should be changed 5270 */ 5271 void setFlags(int flags, int mask) { 5272 int old = mViewFlags; 5273 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 5274 5275 int changed = mViewFlags ^ old; 5276 if (changed == 0) { 5277 return; 5278 } 5279 int privateFlags = mPrivateFlags; 5280 5281 /* Check if the FOCUSABLE bit has changed */ 5282 if (((changed & FOCUSABLE_MASK) != 0) && 5283 ((privateFlags & HAS_BOUNDS) !=0)) { 5284 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 5285 && ((privateFlags & FOCUSED) != 0)) { 5286 /* Give up focus if we are no longer focusable */ 5287 clearFocus(); 5288 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 5289 && ((privateFlags & FOCUSED) == 0)) { 5290 /* 5291 * Tell the view system that we are now available to take focus 5292 * if no one else already has it. 5293 */ 5294 if (mParent != null) mParent.focusableViewAvailable(this); 5295 } 5296 } 5297 5298 if ((flags & VISIBILITY_MASK) == VISIBLE) { 5299 if ((changed & VISIBILITY_MASK) != 0) { 5300 /* 5301 * If this view is becoming visible, set the DRAWN flag so that 5302 * the next invalidate() will not be skipped. 5303 */ 5304 mPrivateFlags |= DRAWN; 5305 5306 needGlobalAttributesUpdate(true); 5307 5308 // a view becoming visible is worth notifying the parent 5309 // about in case nothing has focus. even if this specific view 5310 // isn't focusable, it may contain something that is, so let 5311 // the root view try to give this focus if nothing else does. 5312 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 5313 mParent.focusableViewAvailable(this); 5314 } 5315 } 5316 } 5317 5318 /* Check if the GONE bit has changed */ 5319 if ((changed & GONE) != 0) { 5320 needGlobalAttributesUpdate(false); 5321 requestLayout(); 5322 invalidate(true); 5323 5324 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 5325 if (hasFocus()) clearFocus(); 5326 destroyDrawingCache(); 5327 } 5328 if (mAttachInfo != null) { 5329 mAttachInfo.mViewVisibilityChanged = true; 5330 } 5331 } 5332 5333 /* Check if the VISIBLE bit has changed */ 5334 if ((changed & INVISIBLE) != 0) { 5335 needGlobalAttributesUpdate(false); 5336 invalidate(true); 5337 5338 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) { 5339 // root view becoming invisible shouldn't clear focus 5340 if (getRootView() != this) { 5341 clearFocus(); 5342 } 5343 } 5344 if (mAttachInfo != null) { 5345 mAttachInfo.mViewVisibilityChanged = true; 5346 } 5347 } 5348 5349 if ((changed & VISIBILITY_MASK) != 0) { 5350 if (mParent instanceof ViewGroup) { 5351 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK)); 5352 ((View) mParent).invalidate(true); 5353 } 5354 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK)); 5355 } 5356 5357 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 5358 destroyDrawingCache(); 5359 } 5360 5361 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 5362 destroyDrawingCache(); 5363 mPrivateFlags &= ~DRAWING_CACHE_VALID; 5364 invalidateParentCaches(); 5365 } 5366 5367 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 5368 destroyDrawingCache(); 5369 mPrivateFlags &= ~DRAWING_CACHE_VALID; 5370 } 5371 5372 if ((changed & DRAW_MASK) != 0) { 5373 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 5374 if (mBGDrawable != null) { 5375 mPrivateFlags &= ~SKIP_DRAW; 5376 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 5377 } else { 5378 mPrivateFlags |= SKIP_DRAW; 5379 } 5380 } else { 5381 mPrivateFlags &= ~SKIP_DRAW; 5382 } 5383 requestLayout(); 5384 invalidate(true); 5385 } 5386 5387 if ((changed & KEEP_SCREEN_ON) != 0) { 5388 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 5389 mParent.recomputeViewAttributes(this); 5390 } 5391 } 5392 } 5393 5394 /** 5395 * Change the view's z order in the tree, so it's on top of other sibling 5396 * views 5397 */ 5398 public void bringToFront() { 5399 if (mParent != null) { 5400 mParent.bringChildToFront(this); 5401 } 5402 } 5403 5404 /** 5405 * This is called in response to an internal scroll in this view (i.e., the 5406 * view scrolled its own contents). This is typically as a result of 5407 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 5408 * called. 5409 * 5410 * @param l Current horizontal scroll origin. 5411 * @param t Current vertical scroll origin. 5412 * @param oldl Previous horizontal scroll origin. 5413 * @param oldt Previous vertical scroll origin. 5414 */ 5415 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 5416 mBackgroundSizeChanged = true; 5417 5418 final AttachInfo ai = mAttachInfo; 5419 if (ai != null) { 5420 ai.mViewScrollChanged = true; 5421 } 5422 } 5423 5424 /** 5425 * Interface definition for a callback to be invoked when the layout bounds of a view 5426 * changes due to layout processing. 5427 */ 5428 public interface OnLayoutChangeListener { 5429 /** 5430 * Called when the focus state of a view has changed. 5431 * 5432 * @param v The view whose state has changed. 5433 * @param left The new value of the view's left property. 5434 * @param top The new value of the view's top property. 5435 * @param right The new value of the view's right property. 5436 * @param bottom The new value of the view's bottom property. 5437 * @param oldLeft The previous value of the view's left property. 5438 * @param oldTop The previous value of the view's top property. 5439 * @param oldRight The previous value of the view's right property. 5440 * @param oldBottom The previous value of the view's bottom property. 5441 */ 5442 void onLayoutChange(View v, int left, int top, int right, int bottom, 5443 int oldLeft, int oldTop, int oldRight, int oldBottom); 5444 } 5445 5446 /** 5447 * This is called during layout when the size of this view has changed. If 5448 * you were just added to the view hierarchy, you're called with the old 5449 * values of 0. 5450 * 5451 * @param w Current width of this view. 5452 * @param h Current height of this view. 5453 * @param oldw Old width of this view. 5454 * @param oldh Old height of this view. 5455 */ 5456 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 5457 } 5458 5459 /** 5460 * Called by draw to draw the child views. This may be overridden 5461 * by derived classes to gain control just before its children are drawn 5462 * (but after its own view has been drawn). 5463 * @param canvas the canvas on which to draw the view 5464 */ 5465 protected void dispatchDraw(Canvas canvas) { 5466 } 5467 5468 /** 5469 * Gets the parent of this view. Note that the parent is a 5470 * ViewParent and not necessarily a View. 5471 * 5472 * @return Parent of this view. 5473 */ 5474 public final ViewParent getParent() { 5475 return mParent; 5476 } 5477 5478 /** 5479 * Return the scrolled left position of this view. This is the left edge of 5480 * the displayed part of your view. You do not need to draw any pixels 5481 * farther left, since those are outside of the frame of your view on 5482 * screen. 5483 * 5484 * @return The left edge of the displayed part of your view, in pixels. 5485 */ 5486 public final int getScrollX() { 5487 return mScrollX; 5488 } 5489 5490 /** 5491 * Return the scrolled top position of this view. This is the top edge of 5492 * the displayed part of your view. You do not need to draw any pixels above 5493 * it, since those are outside of the frame of your view on screen. 5494 * 5495 * @return The top edge of the displayed part of your view, in pixels. 5496 */ 5497 public final int getScrollY() { 5498 return mScrollY; 5499 } 5500 5501 /** 5502 * Return the width of the your view. 5503 * 5504 * @return The width of your view, in pixels. 5505 */ 5506 @ViewDebug.ExportedProperty(category = "layout") 5507 public final int getWidth() { 5508 return mRight - mLeft; 5509 } 5510 5511 /** 5512 * Return the height of your view. 5513 * 5514 * @return The height of your view, in pixels. 5515 */ 5516 @ViewDebug.ExportedProperty(category = "layout") 5517 public final int getHeight() { 5518 return mBottom - mTop; 5519 } 5520 5521 /** 5522 * Return the visible drawing bounds of your view. Fills in the output 5523 * rectangle with the values from getScrollX(), getScrollY(), 5524 * getWidth(), and getHeight(). 5525 * 5526 * @param outRect The (scrolled) drawing bounds of the view. 5527 */ 5528 public void getDrawingRect(Rect outRect) { 5529 outRect.left = mScrollX; 5530 outRect.top = mScrollY; 5531 outRect.right = mScrollX + (mRight - mLeft); 5532 outRect.bottom = mScrollY + (mBottom - mTop); 5533 } 5534 5535 /** 5536 * Like {@link #getMeasuredWidthAndState()}, but only returns the 5537 * raw width component (that is the result is masked by 5538 * {@link #MEASURED_SIZE_MASK}). 5539 * 5540 * @return The raw measured width of this view. 5541 */ 5542 public final int getMeasuredWidth() { 5543 return mMeasuredWidth & MEASURED_SIZE_MASK; 5544 } 5545 5546 /** 5547 * Return the full width measurement information for this view as computed 5548 * by the most recent call to {@link #measure}. This result is a bit mask 5549 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 5550 * This should be used during measurement and layout calculations only. Use 5551 * {@link #getWidth()} to see how wide a view is after layout. 5552 * 5553 * @return The measured width of this view as a bit mask. 5554 */ 5555 public final int getMeasuredWidthAndState() { 5556 return mMeasuredWidth; 5557 } 5558 5559 /** 5560 * Like {@link #getMeasuredHeightAndState()}, but only returns the 5561 * raw width component (that is the result is masked by 5562 * {@link #MEASURED_SIZE_MASK}). 5563 * 5564 * @return The raw measured height of this view. 5565 */ 5566 public final int getMeasuredHeight() { 5567 return mMeasuredHeight & MEASURED_SIZE_MASK; 5568 } 5569 5570 /** 5571 * Return the full height measurement information for this view as computed 5572 * by the most recent call to {@link #measure}. This result is a bit mask 5573 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 5574 * This should be used during measurement and layout calculations only. Use 5575 * {@link #getHeight()} to see how wide a view is after layout. 5576 * 5577 * @return The measured width of this view as a bit mask. 5578 */ 5579 public final int getMeasuredHeightAndState() { 5580 return mMeasuredHeight; 5581 } 5582 5583 /** 5584 * Return only the state bits of {@link #getMeasuredWidthAndState()} 5585 * and {@link #getMeasuredHeightAndState()}, combined into one integer. 5586 * The width component is in the regular bits {@link #MEASURED_STATE_MASK} 5587 * and the height component is at the shifted bits 5588 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}. 5589 */ 5590 public final int getMeasuredState() { 5591 return (mMeasuredWidth&MEASURED_STATE_MASK) 5592 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT) 5593 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT)); 5594 } 5595 5596 /** 5597 * The transform matrix of this view, which is calculated based on the current 5598 * roation, scale, and pivot properties. 5599 * 5600 * @see #getRotation() 5601 * @see #getScaleX() 5602 * @see #getScaleY() 5603 * @see #getPivotX() 5604 * @see #getPivotY() 5605 * @return The current transform matrix for the view 5606 */ 5607 public Matrix getMatrix() { 5608 updateMatrix(); 5609 return mMatrix; 5610 } 5611 5612 /** 5613 * Utility function to determine if the value is far enough away from zero to be 5614 * considered non-zero. 5615 * @param value A floating point value to check for zero-ness 5616 * @return whether the passed-in value is far enough away from zero to be considered non-zero 5617 */ 5618 private static boolean nonzero(float value) { 5619 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON); 5620 } 5621 5622 /** 5623 * Returns true if the transform matrix is the identity matrix. 5624 * Recomputes the matrix if necessary. 5625 * 5626 * @return True if the transform matrix is the identity matrix, false otherwise. 5627 */ 5628 final boolean hasIdentityMatrix() { 5629 updateMatrix(); 5630 return mMatrixIsIdentity; 5631 } 5632 5633 /** 5634 * Recomputes the transform matrix if necessary. 5635 */ 5636 private void updateMatrix() { 5637 if (mMatrixDirty) { 5638 // transform-related properties have changed since the last time someone 5639 // asked for the matrix; recalculate it with the current values 5640 5641 // Figure out if we need to update the pivot point 5642 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 5643 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) { 5644 mPrevWidth = mRight - mLeft; 5645 mPrevHeight = mBottom - mTop; 5646 mPivotX = mPrevWidth / 2f; 5647 mPivotY = mPrevHeight / 2f; 5648 } 5649 } 5650 mMatrix.reset(); 5651 if (!nonzero(mRotationX) && !nonzero(mRotationY)) { 5652 mMatrix.setTranslate(mTranslationX, mTranslationY); 5653 mMatrix.preRotate(mRotation, mPivotX, mPivotY); 5654 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY); 5655 } else { 5656 if (mCamera == null) { 5657 mCamera = new Camera(); 5658 matrix3D = new Matrix(); 5659 } 5660 mCamera.save(); 5661 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY); 5662 mCamera.rotateX(mRotationX); 5663 mCamera.rotateY(mRotationY); 5664 mCamera.rotateZ(-mRotation); 5665 mCamera.getMatrix(matrix3D); 5666 matrix3D.preTranslate(-mPivotX, -mPivotY); 5667 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY); 5668 mMatrix.postConcat(matrix3D); 5669 mCamera.restore(); 5670 } 5671 mMatrixDirty = false; 5672 mMatrixIsIdentity = mMatrix.isIdentity(); 5673 mInverseMatrixDirty = true; 5674 } 5675 } 5676 5677 /** 5678 * Utility method to retrieve the inverse of the current mMatrix property. 5679 * We cache the matrix to avoid recalculating it when transform properties 5680 * have not changed. 5681 * 5682 * @return The inverse of the current matrix of this view. 5683 */ 5684 final Matrix getInverseMatrix() { 5685 updateMatrix(); 5686 if (mInverseMatrixDirty) { 5687 if (mInverseMatrix == null) { 5688 mInverseMatrix = new Matrix(); 5689 } 5690 mMatrix.invert(mInverseMatrix); 5691 mInverseMatrixDirty = false; 5692 } 5693 return mInverseMatrix; 5694 } 5695 5696 /** 5697 * The degrees that the view is rotated around the pivot point. 5698 * 5699 * @see #getPivotX() 5700 * @see #getPivotY() 5701 * @return The degrees of rotation. 5702 */ 5703 public float getRotation() { 5704 return mRotation; 5705 } 5706 5707 /** 5708 * Sets the degrees that the view is rotated around the pivot point. Increasing values 5709 * result in clockwise rotation. 5710 * 5711 * @param rotation The degrees of rotation. 5712 * @see #getPivotX() 5713 * @see #getPivotY() 5714 * 5715 * @attr ref android.R.styleable#View_rotation 5716 */ 5717 public void setRotation(float rotation) { 5718 if (mRotation != rotation) { 5719 invalidateParentCaches(); 5720 // Double-invalidation is necessary to capture view's old and new areas 5721 invalidate(false); 5722 mRotation = rotation; 5723 mMatrixDirty = true; 5724 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5725 invalidate(false); 5726 } 5727 } 5728 5729 /** 5730 * The degrees that the view is rotated around the vertical axis through the pivot point. 5731 * 5732 * @see #getPivotX() 5733 * @see #getPivotY() 5734 * @return The degrees of Y rotation. 5735 */ 5736 public float getRotationY() { 5737 return mRotationY; 5738 } 5739 5740 /** 5741 * Sets the degrees that the view is rotated around the vertical axis through the pivot point. 5742 * Increasing values result in counter-clockwise rotation from the viewpoint of looking 5743 * down the y axis. 5744 * 5745 * @param rotationY The degrees of Y rotation. 5746 * @see #getPivotX() 5747 * @see #getPivotY() 5748 * 5749 * @attr ref android.R.styleable#View_rotationY 5750 */ 5751 public void setRotationY(float rotationY) { 5752 if (mRotationY != rotationY) { 5753 invalidateParentCaches(); 5754 // Double-invalidation is necessary to capture view's old and new areas 5755 invalidate(false); 5756 mRotationY = rotationY; 5757 mMatrixDirty = true; 5758 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5759 invalidate(false); 5760 } 5761 } 5762 5763 /** 5764 * The degrees that the view is rotated around the horizontal axis through the pivot point. 5765 * 5766 * @see #getPivotX() 5767 * @see #getPivotY() 5768 * @return The degrees of X rotation. 5769 */ 5770 public float getRotationX() { 5771 return mRotationX; 5772 } 5773 5774 /** 5775 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point. 5776 * Increasing values result in clockwise rotation from the viewpoint of looking down the 5777 * x axis. 5778 * 5779 * @param rotationX The degrees of X rotation. 5780 * @see #getPivotX() 5781 * @see #getPivotY() 5782 * 5783 * @attr ref android.R.styleable#View_rotationX 5784 */ 5785 public void setRotationX(float rotationX) { 5786 if (mRotationX != rotationX) { 5787 invalidateParentCaches(); 5788 // Double-invalidation is necessary to capture view's old and new areas 5789 invalidate(false); 5790 mRotationX = rotationX; 5791 mMatrixDirty = true; 5792 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5793 invalidate(false); 5794 } 5795 } 5796 5797 /** 5798 * The amount that the view is scaled in x around the pivot point, as a proportion of 5799 * the view's unscaled width. A value of 1, the default, means that no scaling is applied. 5800 * 5801 * <p>By default, this is 1.0f. 5802 * 5803 * @see #getPivotX() 5804 * @see #getPivotY() 5805 * @return The scaling factor. 5806 */ 5807 public float getScaleX() { 5808 return mScaleX; 5809 } 5810 5811 /** 5812 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of 5813 * the view's unscaled width. A value of 1 means that no scaling is applied. 5814 * 5815 * @param scaleX The scaling factor. 5816 * @see #getPivotX() 5817 * @see #getPivotY() 5818 * 5819 * @attr ref android.R.styleable#View_scaleX 5820 */ 5821 public void setScaleX(float scaleX) { 5822 if (mScaleX != scaleX) { 5823 invalidateParentCaches(); 5824 // Double-invalidation is necessary to capture view's old and new areas 5825 invalidate(false); 5826 mScaleX = scaleX; 5827 mMatrixDirty = true; 5828 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5829 invalidate(false); 5830 } 5831 } 5832 5833 /** 5834 * The amount that the view is scaled in y around the pivot point, as a proportion of 5835 * the view's unscaled height. A value of 1, the default, means that no scaling is applied. 5836 * 5837 * <p>By default, this is 1.0f. 5838 * 5839 * @see #getPivotX() 5840 * @see #getPivotY() 5841 * @return The scaling factor. 5842 */ 5843 public float getScaleY() { 5844 return mScaleY; 5845 } 5846 5847 /** 5848 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of 5849 * the view's unscaled width. A value of 1 means that no scaling is applied. 5850 * 5851 * @param scaleY The scaling factor. 5852 * @see #getPivotX() 5853 * @see #getPivotY() 5854 * 5855 * @attr ref android.R.styleable#View_scaleY 5856 */ 5857 public void setScaleY(float scaleY) { 5858 if (mScaleY != scaleY) { 5859 invalidateParentCaches(); 5860 // Double-invalidation is necessary to capture view's old and new areas 5861 invalidate(false); 5862 mScaleY = scaleY; 5863 mMatrixDirty = true; 5864 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5865 invalidate(false); 5866 } 5867 } 5868 5869 /** 5870 * The x location of the point around which the view is {@link #setRotation(float) rotated} 5871 * and {@link #setScaleX(float) scaled}. 5872 * 5873 * @see #getRotation() 5874 * @see #getScaleX() 5875 * @see #getScaleY() 5876 * @see #getPivotY() 5877 * @return The x location of the pivot point. 5878 */ 5879 public float getPivotX() { 5880 return mPivotX; 5881 } 5882 5883 /** 5884 * Sets the x location of the point around which the view is 5885 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}. 5886 * By default, the pivot point is centered on the object. 5887 * Setting this property disables this behavior and causes the view to use only the 5888 * explicitly set pivotX and pivotY values. 5889 * 5890 * @param pivotX The x location of the pivot point. 5891 * @see #getRotation() 5892 * @see #getScaleX() 5893 * @see #getScaleY() 5894 * @see #getPivotY() 5895 * 5896 * @attr ref android.R.styleable#View_transformPivotX 5897 */ 5898 public void setPivotX(float pivotX) { 5899 mPrivateFlags |= PIVOT_EXPLICITLY_SET; 5900 if (mPivotX != pivotX) { 5901 invalidateParentCaches(); 5902 // Double-invalidation is necessary to capture view's old and new areas 5903 invalidate(false); 5904 mPivotX = pivotX; 5905 mMatrixDirty = true; 5906 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5907 invalidate(false); 5908 } 5909 } 5910 5911 /** 5912 * The y location of the point around which the view is {@link #setRotation(float) rotated} 5913 * and {@link #setScaleY(float) scaled}. 5914 * 5915 * @see #getRotation() 5916 * @see #getScaleX() 5917 * @see #getScaleY() 5918 * @see #getPivotY() 5919 * @return The y location of the pivot point. 5920 */ 5921 public float getPivotY() { 5922 return mPivotY; 5923 } 5924 5925 /** 5926 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated} 5927 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object. 5928 * Setting this property disables this behavior and causes the view to use only the 5929 * explicitly set pivotX and pivotY values. 5930 * 5931 * @param pivotY The y location of the pivot point. 5932 * @see #getRotation() 5933 * @see #getScaleX() 5934 * @see #getScaleY() 5935 * @see #getPivotY() 5936 * 5937 * @attr ref android.R.styleable#View_transformPivotY 5938 */ 5939 public void setPivotY(float pivotY) { 5940 mPrivateFlags |= PIVOT_EXPLICITLY_SET; 5941 if (mPivotY != pivotY) { 5942 invalidateParentCaches(); 5943 // Double-invalidation is necessary to capture view's old and new areas 5944 invalidate(false); 5945 mPivotY = pivotY; 5946 mMatrixDirty = true; 5947 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 5948 invalidate(false); 5949 } 5950 } 5951 5952 /** 5953 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is 5954 * completely transparent and 1 means the view is completely opaque. 5955 * 5956 * <p>By default this is 1.0f. 5957 * @return The opacity of the view. 5958 */ 5959 public float getAlpha() { 5960 return mAlpha; 5961 } 5962 5963 /** 5964 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is 5965 * completely transparent and 1 means the view is completely opaque.</p> 5966 * 5967 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is 5968 * responsible for applying the opacity itself. Otherwise, calling this method is 5969 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and 5970 * setting a hardware layer.</p> 5971 * 5972 * @param alpha The opacity of the view. 5973 * 5974 * @see #setLayerType(int, android.graphics.Paint) 5975 * 5976 * @attr ref android.R.styleable#View_alpha 5977 */ 5978 public void setAlpha(float alpha) { 5979 mAlpha = alpha; 5980 invalidateParentCaches(); 5981 if (onSetAlpha((int) (alpha * 255))) { 5982 mPrivateFlags |= ALPHA_SET; 5983 // subclass is handling alpha - don't optimize rendering cache invalidation 5984 invalidate(true); 5985 } else { 5986 mPrivateFlags &= ~ALPHA_SET; 5987 invalidate(false); 5988 } 5989 } 5990 5991 /** 5992 * Top position of this view relative to its parent. 5993 * 5994 * @return The top of this view, in pixels. 5995 */ 5996 @ViewDebug.CapturedViewProperty 5997 public final int getTop() { 5998 return mTop; 5999 } 6000 6001 /** 6002 * Sets the top position of this view relative to its parent. This method is meant to be called 6003 * by the layout system and should not generally be called otherwise, because the property 6004 * may be changed at any time by the layout. 6005 * 6006 * @param top The top of this view, in pixels. 6007 */ 6008 public final void setTop(int top) { 6009 if (top != mTop) { 6010 updateMatrix(); 6011 if (mMatrixIsIdentity) { 6012 final ViewParent p = mParent; 6013 if (p != null && mAttachInfo != null) { 6014 final Rect r = mAttachInfo.mTmpInvalRect; 6015 int minTop; 6016 int yLoc; 6017 if (top < mTop) { 6018 minTop = top; 6019 yLoc = top - mTop; 6020 } else { 6021 minTop = mTop; 6022 yLoc = 0; 6023 } 6024 r.set(0, yLoc, mRight - mLeft, mBottom - minTop); 6025 p.invalidateChild(this, r); 6026 } 6027 } else { 6028 // Double-invalidation is necessary to capture view's old and new areas 6029 invalidate(true); 6030 } 6031 6032 int width = mRight - mLeft; 6033 int oldHeight = mBottom - mTop; 6034 6035 mTop = top; 6036 6037 onSizeChanged(width, mBottom - mTop, width, oldHeight); 6038 6039 if (!mMatrixIsIdentity) { 6040 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 6041 // A change in dimension means an auto-centered pivot point changes, too 6042 mMatrixDirty = true; 6043 } 6044 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6045 invalidate(true); 6046 } 6047 mBackgroundSizeChanged = true; 6048 invalidateParentIfNeeded(); 6049 } 6050 } 6051 6052 /** 6053 * Bottom position of this view relative to its parent. 6054 * 6055 * @return The bottom of this view, in pixels. 6056 */ 6057 @ViewDebug.CapturedViewProperty 6058 public final int getBottom() { 6059 return mBottom; 6060 } 6061 6062 /** 6063 * True if this view has changed since the last time being drawn. 6064 * 6065 * @return The dirty state of this view. 6066 */ 6067 public boolean isDirty() { 6068 return (mPrivateFlags & DIRTY_MASK) != 0; 6069 } 6070 6071 /** 6072 * Sets the bottom position of this view relative to its parent. This method is meant to be 6073 * called by the layout system and should not generally be called otherwise, because the 6074 * property may be changed at any time by the layout. 6075 * 6076 * @param bottom The bottom of this view, in pixels. 6077 */ 6078 public final void setBottom(int bottom) { 6079 if (bottom != mBottom) { 6080 updateMatrix(); 6081 if (mMatrixIsIdentity) { 6082 final ViewParent p = mParent; 6083 if (p != null && mAttachInfo != null) { 6084 final Rect r = mAttachInfo.mTmpInvalRect; 6085 int maxBottom; 6086 if (bottom < mBottom) { 6087 maxBottom = mBottom; 6088 } else { 6089 maxBottom = bottom; 6090 } 6091 r.set(0, 0, mRight - mLeft, maxBottom - mTop); 6092 p.invalidateChild(this, r); 6093 } 6094 } else { 6095 // Double-invalidation is necessary to capture view's old and new areas 6096 invalidate(true); 6097 } 6098 6099 int width = mRight - mLeft; 6100 int oldHeight = mBottom - mTop; 6101 6102 mBottom = bottom; 6103 6104 onSizeChanged(width, mBottom - mTop, width, oldHeight); 6105 6106 if (!mMatrixIsIdentity) { 6107 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 6108 // A change in dimension means an auto-centered pivot point changes, too 6109 mMatrixDirty = true; 6110 } 6111 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6112 invalidate(true); 6113 } 6114 mBackgroundSizeChanged = true; 6115 invalidateParentIfNeeded(); 6116 } 6117 } 6118 6119 /** 6120 * Left position of this view relative to its parent. 6121 * 6122 * @return The left edge of this view, in pixels. 6123 */ 6124 @ViewDebug.CapturedViewProperty 6125 public final int getLeft() { 6126 return mLeft; 6127 } 6128 6129 /** 6130 * Sets the left position of this view relative to its parent. This method is meant to be called 6131 * by the layout system and should not generally be called otherwise, because the property 6132 * may be changed at any time by the layout. 6133 * 6134 * @param left The bottom of this view, in pixels. 6135 */ 6136 public final void setLeft(int left) { 6137 if (left != mLeft) { 6138 updateMatrix(); 6139 if (mMatrixIsIdentity) { 6140 final ViewParent p = mParent; 6141 if (p != null && mAttachInfo != null) { 6142 final Rect r = mAttachInfo.mTmpInvalRect; 6143 int minLeft; 6144 int xLoc; 6145 if (left < mLeft) { 6146 minLeft = left; 6147 xLoc = left - mLeft; 6148 } else { 6149 minLeft = mLeft; 6150 xLoc = 0; 6151 } 6152 r.set(xLoc, 0, mRight - minLeft, mBottom - mTop); 6153 p.invalidateChild(this, r); 6154 } 6155 } else { 6156 // Double-invalidation is necessary to capture view's old and new areas 6157 invalidate(true); 6158 } 6159 6160 int oldWidth = mRight - mLeft; 6161 int height = mBottom - mTop; 6162 6163 mLeft = left; 6164 6165 onSizeChanged(mRight - mLeft, height, oldWidth, height); 6166 6167 if (!mMatrixIsIdentity) { 6168 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 6169 // A change in dimension means an auto-centered pivot point changes, too 6170 mMatrixDirty = true; 6171 } 6172 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6173 invalidate(true); 6174 } 6175 mBackgroundSizeChanged = true; 6176 invalidateParentIfNeeded(); 6177 } 6178 } 6179 6180 /** 6181 * Right position of this view relative to its parent. 6182 * 6183 * @return The right edge of this view, in pixels. 6184 */ 6185 @ViewDebug.CapturedViewProperty 6186 public final int getRight() { 6187 return mRight; 6188 } 6189 6190 /** 6191 * Sets the right position of this view relative to its parent. This method is meant to be called 6192 * by the layout system and should not generally be called otherwise, because the property 6193 * may be changed at any time by the layout. 6194 * 6195 * @param right The bottom of this view, in pixels. 6196 */ 6197 public final void setRight(int right) { 6198 if (right != mRight) { 6199 updateMatrix(); 6200 if (mMatrixIsIdentity) { 6201 final ViewParent p = mParent; 6202 if (p != null && mAttachInfo != null) { 6203 final Rect r = mAttachInfo.mTmpInvalRect; 6204 int maxRight; 6205 if (right < mRight) { 6206 maxRight = mRight; 6207 } else { 6208 maxRight = right; 6209 } 6210 r.set(0, 0, maxRight - mLeft, mBottom - mTop); 6211 p.invalidateChild(this, r); 6212 } 6213 } else { 6214 // Double-invalidation is necessary to capture view's old and new areas 6215 invalidate(true); 6216 } 6217 6218 int oldWidth = mRight - mLeft; 6219 int height = mBottom - mTop; 6220 6221 mRight = right; 6222 6223 onSizeChanged(mRight - mLeft, height, oldWidth, height); 6224 6225 if (!mMatrixIsIdentity) { 6226 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 6227 // A change in dimension means an auto-centered pivot point changes, too 6228 mMatrixDirty = true; 6229 } 6230 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6231 invalidate(true); 6232 } 6233 mBackgroundSizeChanged = true; 6234 invalidateParentIfNeeded(); 6235 } 6236 } 6237 6238 /** 6239 * The visual x position of this view, in pixels. This is equivalent to the 6240 * {@link #setTranslationX(float) translationX} property plus the current 6241 * {@link #getLeft() left} property. 6242 * 6243 * @return The visual x position of this view, in pixels. 6244 */ 6245 public float getX() { 6246 return mLeft + mTranslationX; 6247 } 6248 6249 /** 6250 * Sets the visual x position of this view, in pixels. This is equivalent to setting the 6251 * {@link #setTranslationX(float) translationX} property to be the difference between 6252 * the x value passed in and the current {@link #getLeft() left} property. 6253 * 6254 * @param x The visual x position of this view, in pixels. 6255 */ 6256 public void setX(float x) { 6257 setTranslationX(x - mLeft); 6258 } 6259 6260 /** 6261 * The visual y position of this view, in pixels. This is equivalent to the 6262 * {@link #setTranslationY(float) translationY} property plus the current 6263 * {@link #getTop() top} property. 6264 * 6265 * @return The visual y position of this view, in pixels. 6266 */ 6267 public float getY() { 6268 return mTop + mTranslationY; 6269 } 6270 6271 /** 6272 * Sets the visual y position of this view, in pixels. This is equivalent to setting the 6273 * {@link #setTranslationY(float) translationY} property to be the difference between 6274 * the y value passed in and the current {@link #getTop() top} property. 6275 * 6276 * @param y The visual y position of this view, in pixels. 6277 */ 6278 public void setY(float y) { 6279 setTranslationY(y - mTop); 6280 } 6281 6282 6283 /** 6284 * The horizontal location of this view relative to its {@link #getLeft() left} position. 6285 * This position is post-layout, in addition to wherever the object's 6286 * layout placed it. 6287 * 6288 * @return The horizontal position of this view relative to its left position, in pixels. 6289 */ 6290 public float getTranslationX() { 6291 return mTranslationX; 6292 } 6293 6294 /** 6295 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position. 6296 * This effectively positions the object post-layout, in addition to wherever the object's 6297 * layout placed it. 6298 * 6299 * @param translationX The horizontal position of this view relative to its left position, 6300 * in pixels. 6301 * 6302 * @attr ref android.R.styleable#View_translationX 6303 */ 6304 public void setTranslationX(float translationX) { 6305 if (mTranslationX != translationX) { 6306 invalidateParentCaches(); 6307 // Double-invalidation is necessary to capture view's old and new areas 6308 invalidate(false); 6309 mTranslationX = translationX; 6310 mMatrixDirty = true; 6311 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6312 invalidate(false); 6313 } 6314 } 6315 6316 /** 6317 * The horizontal location of this view relative to its {@link #getTop() top} position. 6318 * This position is post-layout, in addition to wherever the object's 6319 * layout placed it. 6320 * 6321 * @return The vertical position of this view relative to its top position, 6322 * in pixels. 6323 */ 6324 public float getTranslationY() { 6325 return mTranslationY; 6326 } 6327 6328 /** 6329 * Sets the vertical location of this view relative to its {@link #getTop() top} position. 6330 * This effectively positions the object post-layout, in addition to wherever the object's 6331 * layout placed it. 6332 * 6333 * @param translationY The vertical position of this view relative to its top position, 6334 * in pixels. 6335 * 6336 * @attr ref android.R.styleable#View_translationY 6337 */ 6338 public void setTranslationY(float translationY) { 6339 if (mTranslationY != translationY) { 6340 invalidateParentCaches(); 6341 // Double-invalidation is necessary to capture view's old and new areas 6342 invalidate(false); 6343 mTranslationY = translationY; 6344 mMatrixDirty = true; 6345 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6346 invalidate(false); 6347 } 6348 } 6349 6350 /** 6351 * Hit rectangle in parent's coordinates 6352 * 6353 * @param outRect The hit rectangle of the view. 6354 */ 6355 public void getHitRect(Rect outRect) { 6356 updateMatrix(); 6357 if (mMatrixIsIdentity || mAttachInfo == null) { 6358 outRect.set(mLeft, mTop, mRight, mBottom); 6359 } else { 6360 final RectF tmpRect = mAttachInfo.mTmpTransformRect; 6361 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY); 6362 mMatrix.mapRect(tmpRect); 6363 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop, 6364 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop); 6365 } 6366 } 6367 6368 /** 6369 * Determines whether the given point, in local coordinates is inside the view. 6370 */ 6371 /*package*/ final boolean pointInView(float localX, float localY) { 6372 return localX >= 0 && localX < (mRight - mLeft) 6373 && localY >= 0 && localY < (mBottom - mTop); 6374 } 6375 6376 /** 6377 * Utility method to determine whether the given point, in local coordinates, 6378 * is inside the view, where the area of the view is expanded by the slop factor. 6379 * This method is called while processing touch-move events to determine if the event 6380 * is still within the view. 6381 */ 6382 private boolean pointInView(float localX, float localY, float slop) { 6383 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) && 6384 localY < ((mBottom - mTop) + slop); 6385 } 6386 6387 /** 6388 * When a view has focus and the user navigates away from it, the next view is searched for 6389 * starting from the rectangle filled in by this method. 6390 * 6391 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your 6392 * view maintains some idea of internal selection, such as a cursor, or a selected row 6393 * or column, you should override this method and fill in a more specific rectangle. 6394 * 6395 * @param r The rectangle to fill in, in this view's coordinates. 6396 */ 6397 public void getFocusedRect(Rect r) { 6398 getDrawingRect(r); 6399 } 6400 6401 /** 6402 * If some part of this view is not clipped by any of its parents, then 6403 * return that area in r in global (root) coordinates. To convert r to local 6404 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x, 6405 * -globalOffset.y)) If the view is completely clipped or translated out, 6406 * return false. 6407 * 6408 * @param r If true is returned, r holds the global coordinates of the 6409 * visible portion of this view. 6410 * @param globalOffset If true is returned, globalOffset holds the dx,dy 6411 * between this view and its root. globalOffet may be null. 6412 * @return true if r is non-empty (i.e. part of the view is visible at the 6413 * root level. 6414 */ 6415 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 6416 int width = mRight - mLeft; 6417 int height = mBottom - mTop; 6418 if (width > 0 && height > 0) { 6419 r.set(0, 0, width, height); 6420 if (globalOffset != null) { 6421 globalOffset.set(-mScrollX, -mScrollY); 6422 } 6423 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 6424 } 6425 return false; 6426 } 6427 6428 public final boolean getGlobalVisibleRect(Rect r) { 6429 return getGlobalVisibleRect(r, null); 6430 } 6431 6432 public final boolean getLocalVisibleRect(Rect r) { 6433 Point offset = new Point(); 6434 if (getGlobalVisibleRect(r, offset)) { 6435 r.offset(-offset.x, -offset.y); // make r local 6436 return true; 6437 } 6438 return false; 6439 } 6440 6441 /** 6442 * Offset this view's vertical location by the specified number of pixels. 6443 * 6444 * @param offset the number of pixels to offset the view by 6445 */ 6446 public void offsetTopAndBottom(int offset) { 6447 if (offset != 0) { 6448 updateMatrix(); 6449 if (mMatrixIsIdentity) { 6450 final ViewParent p = mParent; 6451 if (p != null && mAttachInfo != null) { 6452 final Rect r = mAttachInfo.mTmpInvalRect; 6453 int minTop; 6454 int maxBottom; 6455 int yLoc; 6456 if (offset < 0) { 6457 minTop = mTop + offset; 6458 maxBottom = mBottom; 6459 yLoc = offset; 6460 } else { 6461 minTop = mTop; 6462 maxBottom = mBottom + offset; 6463 yLoc = 0; 6464 } 6465 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop); 6466 p.invalidateChild(this, r); 6467 } 6468 } else { 6469 invalidate(false); 6470 } 6471 6472 mTop += offset; 6473 mBottom += offset; 6474 6475 if (!mMatrixIsIdentity) { 6476 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6477 invalidate(false); 6478 } 6479 invalidateParentIfNeeded(); 6480 } 6481 } 6482 6483 /** 6484 * Offset this view's horizontal location by the specified amount of pixels. 6485 * 6486 * @param offset the numer of pixels to offset the view by 6487 */ 6488 public void offsetLeftAndRight(int offset) { 6489 if (offset != 0) { 6490 updateMatrix(); 6491 if (mMatrixIsIdentity) { 6492 final ViewParent p = mParent; 6493 if (p != null && mAttachInfo != null) { 6494 final Rect r = mAttachInfo.mTmpInvalRect; 6495 int minLeft; 6496 int maxRight; 6497 if (offset < 0) { 6498 minLeft = mLeft + offset; 6499 maxRight = mRight; 6500 } else { 6501 minLeft = mLeft; 6502 maxRight = mRight + offset; 6503 } 6504 r.set(0, 0, maxRight - minLeft, mBottom - mTop); 6505 p.invalidateChild(this, r); 6506 } 6507 } else { 6508 invalidate(false); 6509 } 6510 6511 mLeft += offset; 6512 mRight += offset; 6513 6514 if (!mMatrixIsIdentity) { 6515 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation 6516 invalidate(false); 6517 } 6518 invalidateParentIfNeeded(); 6519 } 6520 } 6521 6522 /** 6523 * Get the LayoutParams associated with this view. All views should have 6524 * layout parameters. These supply parameters to the <i>parent</i> of this 6525 * view specifying how it should be arranged. There are many subclasses of 6526 * ViewGroup.LayoutParams, and these correspond to the different subclasses 6527 * of ViewGroup that are responsible for arranging their children. 6528 * @return The LayoutParams associated with this view 6529 */ 6530 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 6531 public ViewGroup.LayoutParams getLayoutParams() { 6532 return mLayoutParams; 6533 } 6534 6535 /** 6536 * Set the layout parameters associated with this view. These supply 6537 * parameters to the <i>parent</i> of this view specifying how it should be 6538 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 6539 * correspond to the different subclasses of ViewGroup that are responsible 6540 * for arranging their children. 6541 * 6542 * @param params the layout parameters for this view 6543 */ 6544 public void setLayoutParams(ViewGroup.LayoutParams params) { 6545 if (params == null) { 6546 throw new NullPointerException("params == null"); 6547 } 6548 mLayoutParams = params; 6549 requestLayout(); 6550 } 6551 6552 /** 6553 * Set the scrolled position of your view. This will cause a call to 6554 * {@link #onScrollChanged(int, int, int, int)} and the view will be 6555 * invalidated. 6556 * @param x the x position to scroll to 6557 * @param y the y position to scroll to 6558 */ 6559 public void scrollTo(int x, int y) { 6560 if (mScrollX != x || mScrollY != y) { 6561 int oldX = mScrollX; 6562 int oldY = mScrollY; 6563 mScrollX = x; 6564 mScrollY = y; 6565 invalidateParentCaches(); 6566 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 6567 if (!awakenScrollBars()) { 6568 invalidate(true); 6569 } 6570 } 6571 } 6572 6573 /** 6574 * Move the scrolled position of your view. This will cause a call to 6575 * {@link #onScrollChanged(int, int, int, int)} and the view will be 6576 * invalidated. 6577 * @param x the amount of pixels to scroll by horizontally 6578 * @param y the amount of pixels to scroll by vertically 6579 */ 6580 public void scrollBy(int x, int y) { 6581 scrollTo(mScrollX + x, mScrollY + y); 6582 } 6583 6584 /** 6585 * <p>Trigger the scrollbars to draw. When invoked this method starts an 6586 * animation to fade the scrollbars out after a default delay. If a subclass 6587 * provides animated scrolling, the start delay should equal the duration 6588 * of the scrolling animation.</p> 6589 * 6590 * <p>The animation starts only if at least one of the scrollbars is 6591 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 6592 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 6593 * this method returns true, and false otherwise. If the animation is 6594 * started, this method calls {@link #invalidate()}; in that case the 6595 * caller should not call {@link #invalidate()}.</p> 6596 * 6597 * <p>This method should be invoked every time a subclass directly updates 6598 * the scroll parameters.</p> 6599 * 6600 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 6601 * and {@link #scrollTo(int, int)}.</p> 6602 * 6603 * @return true if the animation is played, false otherwise 6604 * 6605 * @see #awakenScrollBars(int) 6606 * @see #scrollBy(int, int) 6607 * @see #scrollTo(int, int) 6608 * @see #isHorizontalScrollBarEnabled() 6609 * @see #isVerticalScrollBarEnabled() 6610 * @see #setHorizontalScrollBarEnabled(boolean) 6611 * @see #setVerticalScrollBarEnabled(boolean) 6612 */ 6613 protected boolean awakenScrollBars() { 6614 return mScrollCache != null && 6615 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 6616 } 6617 6618 /** 6619 * Trigger the scrollbars to draw. 6620 * This method differs from awakenScrollBars() only in its default duration. 6621 * initialAwakenScrollBars() will show the scroll bars for longer than 6622 * usual to give the user more of a chance to notice them. 6623 * 6624 * @return true if the animation is played, false otherwise. 6625 */ 6626 private boolean initialAwakenScrollBars() { 6627 return mScrollCache != null && 6628 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true); 6629 } 6630 6631 /** 6632 * <p> 6633 * Trigger the scrollbars to draw. When invoked this method starts an 6634 * animation to fade the scrollbars out after a fixed delay. If a subclass 6635 * provides animated scrolling, the start delay should equal the duration of 6636 * the scrolling animation. 6637 * </p> 6638 * 6639 * <p> 6640 * The animation starts only if at least one of the scrollbars is enabled, 6641 * as specified by {@link #isHorizontalScrollBarEnabled()} and 6642 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 6643 * this method returns true, and false otherwise. If the animation is 6644 * started, this method calls {@link #invalidate()}; in that case the caller 6645 * should not call {@link #invalidate()}. 6646 * </p> 6647 * 6648 * <p> 6649 * This method should be invoked everytime a subclass directly updates the 6650 * scroll parameters. 6651 * </p> 6652 * 6653 * @param startDelay the delay, in milliseconds, after which the animation 6654 * should start; when the delay is 0, the animation starts 6655 * immediately 6656 * @return true if the animation is played, false otherwise 6657 * 6658 * @see #scrollBy(int, int) 6659 * @see #scrollTo(int, int) 6660 * @see #isHorizontalScrollBarEnabled() 6661 * @see #isVerticalScrollBarEnabled() 6662 * @see #setHorizontalScrollBarEnabled(boolean) 6663 * @see #setVerticalScrollBarEnabled(boolean) 6664 */ 6665 protected boolean awakenScrollBars(int startDelay) { 6666 return awakenScrollBars(startDelay, true); 6667 } 6668 6669 /** 6670 * <p> 6671 * Trigger the scrollbars to draw. When invoked this method starts an 6672 * animation to fade the scrollbars out after a fixed delay. If a subclass 6673 * provides animated scrolling, the start delay should equal the duration of 6674 * the scrolling animation. 6675 * </p> 6676 * 6677 * <p> 6678 * The animation starts only if at least one of the scrollbars is enabled, 6679 * as specified by {@link #isHorizontalScrollBarEnabled()} and 6680 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 6681 * this method returns true, and false otherwise. If the animation is 6682 * started, this method calls {@link #invalidate()} if the invalidate parameter 6683 * is set to true; in that case the caller 6684 * should not call {@link #invalidate()}. 6685 * </p> 6686 * 6687 * <p> 6688 * This method should be invoked everytime a subclass directly updates the 6689 * scroll parameters. 6690 * </p> 6691 * 6692 * @param startDelay the delay, in milliseconds, after which the animation 6693 * should start; when the delay is 0, the animation starts 6694 * immediately 6695 * 6696 * @param invalidate Wheter this method should call invalidate 6697 * 6698 * @return true if the animation is played, false otherwise 6699 * 6700 * @see #scrollBy(int, int) 6701 * @see #scrollTo(int, int) 6702 * @see #isHorizontalScrollBarEnabled() 6703 * @see #isVerticalScrollBarEnabled() 6704 * @see #setHorizontalScrollBarEnabled(boolean) 6705 * @see #setVerticalScrollBarEnabled(boolean) 6706 */ 6707 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 6708 final ScrollabilityCache scrollCache = mScrollCache; 6709 6710 if (scrollCache == null || !scrollCache.fadeScrollBars) { 6711 return false; 6712 } 6713 6714 if (scrollCache.scrollBar == null) { 6715 scrollCache.scrollBar = new ScrollBarDrawable(); 6716 } 6717 6718 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 6719 6720 if (invalidate) { 6721 // Invalidate to show the scrollbars 6722 invalidate(true); 6723 } 6724 6725 if (scrollCache.state == ScrollabilityCache.OFF) { 6726 // FIXME: this is copied from WindowManagerService. 6727 // We should get this value from the system when it 6728 // is possible to do so. 6729 final int KEY_REPEAT_FIRST_DELAY = 750; 6730 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 6731 } 6732 6733 // Tell mScrollCache when we should start fading. This may 6734 // extend the fade start time if one was already scheduled 6735 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 6736 scrollCache.fadeStartTime = fadeStartTime; 6737 scrollCache.state = ScrollabilityCache.ON; 6738 6739 // Schedule our fader to run, unscheduling any old ones first 6740 if (mAttachInfo != null) { 6741 mAttachInfo.mHandler.removeCallbacks(scrollCache); 6742 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 6743 } 6744 6745 return true; 6746 } 6747 6748 return false; 6749 } 6750 6751 /** 6752 * Mark the the area defined by dirty as needing to be drawn. If the view is 6753 * visible, {@link #onDraw} will be called at some point in the future. 6754 * This must be called from a UI thread. To call from a non-UI thread, call 6755 * {@link #postInvalidate()}. 6756 * 6757 * WARNING: This method is destructive to dirty. 6758 * @param dirty the rectangle representing the bounds of the dirty region 6759 */ 6760 public void invalidate(Rect dirty) { 6761 if (ViewDebug.TRACE_HIERARCHY) { 6762 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 6763 } 6764 6765 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 6766 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID || 6767 (mPrivateFlags & INVALIDATED) != INVALIDATED) { 6768 mPrivateFlags &= ~DRAWING_CACHE_VALID; 6769 mPrivateFlags |= INVALIDATED; 6770 final ViewParent p = mParent; 6771 final AttachInfo ai = mAttachInfo; 6772 //noinspection PointlessBooleanExpression,ConstantConditions 6773 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 6774 if (p != null && ai != null && ai.mHardwareAccelerated) { 6775 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 6776 // with a null dirty rect, which tells the ViewRoot to redraw everything 6777 p.invalidateChild(this, null); 6778 return; 6779 } 6780 } 6781 if (p != null && ai != null) { 6782 final int scrollX = mScrollX; 6783 final int scrollY = mScrollY; 6784 final Rect r = ai.mTmpInvalRect; 6785 r.set(dirty.left - scrollX, dirty.top - scrollY, 6786 dirty.right - scrollX, dirty.bottom - scrollY); 6787 mParent.invalidateChild(this, r); 6788 } 6789 } 6790 } 6791 6792 /** 6793 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn. 6794 * The coordinates of the dirty rect are relative to the view. 6795 * If the view is visible, {@link #onDraw} will be called at some point 6796 * in the future. This must be called from a UI thread. To call 6797 * from a non-UI thread, call {@link #postInvalidate()}. 6798 * @param l the left position of the dirty region 6799 * @param t the top position of the dirty region 6800 * @param r the right position of the dirty region 6801 * @param b the bottom position of the dirty region 6802 */ 6803 public void invalidate(int l, int t, int r, int b) { 6804 if (ViewDebug.TRACE_HIERARCHY) { 6805 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 6806 } 6807 6808 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 6809 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID || 6810 (mPrivateFlags & INVALIDATED) != INVALIDATED) { 6811 mPrivateFlags &= ~DRAWING_CACHE_VALID; 6812 mPrivateFlags |= INVALIDATED; 6813 final ViewParent p = mParent; 6814 final AttachInfo ai = mAttachInfo; 6815 //noinspection PointlessBooleanExpression,ConstantConditions 6816 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 6817 if (p != null && ai != null && ai.mHardwareAccelerated) { 6818 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 6819 // with a null dirty rect, which tells the ViewRoot to redraw everything 6820 p.invalidateChild(this, null); 6821 return; 6822 } 6823 } 6824 if (p != null && ai != null && l < r && t < b) { 6825 final int scrollX = mScrollX; 6826 final int scrollY = mScrollY; 6827 final Rect tmpr = ai.mTmpInvalRect; 6828 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY); 6829 p.invalidateChild(this, tmpr); 6830 } 6831 } 6832 } 6833 6834 /** 6835 * Invalidate the whole view. If the view is visible, {@link #onDraw} will 6836 * be called at some point in the future. This must be called from a 6837 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}. 6838 */ 6839 public void invalidate() { 6840 invalidate(true); 6841 } 6842 6843 /** 6844 * This is where the invalidate() work actually happens. A full invalidate() 6845 * causes the drawing cache to be invalidated, but this function can be called with 6846 * invalidateCache set to false to skip that invalidation step for cases that do not 6847 * need it (for example, a component that remains at the same dimensions with the same 6848 * content). 6849 * 6850 * @param invalidateCache Whether the drawing cache for this view should be invalidated as 6851 * well. This is usually true for a full invalidate, but may be set to false if the 6852 * View's contents or dimensions have not changed. 6853 */ 6854 private void invalidate(boolean invalidateCache) { 6855 if (ViewDebug.TRACE_HIERARCHY) { 6856 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 6857 } 6858 6859 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) || 6860 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) || 6861 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) { 6862 mLastIsOpaque = isOpaque(); 6863 mPrivateFlags &= ~DRAWN; 6864 if (invalidateCache) { 6865 mPrivateFlags |= INVALIDATED; 6866 mPrivateFlags &= ~DRAWING_CACHE_VALID; 6867 } 6868 final AttachInfo ai = mAttachInfo; 6869 final ViewParent p = mParent; 6870 //noinspection PointlessBooleanExpression,ConstantConditions 6871 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) { 6872 if (p != null && ai != null && ai.mHardwareAccelerated) { 6873 // fast-track for GL-enabled applications; just invalidate the whole hierarchy 6874 // with a null dirty rect, which tells the ViewRoot to redraw everything 6875 p.invalidateChild(this, null); 6876 return; 6877 } 6878 } 6879 6880 if (p != null && ai != null) { 6881 final Rect r = ai.mTmpInvalRect; 6882 r.set(0, 0, mRight - mLeft, mBottom - mTop); 6883 // Don't call invalidate -- we don't want to internally scroll 6884 // our own bounds 6885 p.invalidateChild(this, r); 6886 } 6887 } 6888 } 6889 6890 /** 6891 * Used to indicate that the parent of this view should clear its caches. This functionality 6892 * is used to force the parent to rebuild its display list (when hardware-accelerated), 6893 * which is necessary when various parent-managed properties of the view change, such as 6894 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only 6895 * clears the parent caches and does not causes an invalidate event. 6896 * 6897 * @hide 6898 */ 6899 protected void invalidateParentCaches() { 6900 if (mParent instanceof View) { 6901 ((View) mParent).mPrivateFlags |= INVALIDATED; 6902 } 6903 } 6904 6905 /** 6906 * Used to indicate that the parent of this view should be invalidated. This functionality 6907 * is used to force the parent to rebuild its display list (when hardware-accelerated), 6908 * which is necessary when various parent-managed properties of the view change, such as 6909 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate 6910 * an invalidation event to the parent. 6911 * 6912 * @hide 6913 */ 6914 protected void invalidateParentIfNeeded() { 6915 if (isHardwareAccelerated() && mParent instanceof View) { 6916 ((View) mParent).invalidate(true); 6917 } 6918 } 6919 6920 /** 6921 * Indicates whether this View is opaque. An opaque View guarantees that it will 6922 * draw all the pixels overlapping its bounds using a fully opaque color. 6923 * 6924 * Subclasses of View should override this method whenever possible to indicate 6925 * whether an instance is opaque. Opaque Views are treated in a special way by 6926 * the View hierarchy, possibly allowing it to perform optimizations during 6927 * invalidate/draw passes. 6928 * 6929 * @return True if this View is guaranteed to be fully opaque, false otherwise. 6930 */ 6931 @ViewDebug.ExportedProperty(category = "drawing") 6932 public boolean isOpaque() { 6933 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK && 6934 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD); 6935 } 6936 6937 /** 6938 * @hide 6939 */ 6940 protected void computeOpaqueFlags() { 6941 // Opaque if: 6942 // - Has a background 6943 // - Background is opaque 6944 // - Doesn't have scrollbars or scrollbars are inside overlay 6945 6946 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) { 6947 mPrivateFlags |= OPAQUE_BACKGROUND; 6948 } else { 6949 mPrivateFlags &= ~OPAQUE_BACKGROUND; 6950 } 6951 6952 final int flags = mViewFlags; 6953 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 6954 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) { 6955 mPrivateFlags |= OPAQUE_SCROLLBARS; 6956 } else { 6957 mPrivateFlags &= ~OPAQUE_SCROLLBARS; 6958 } 6959 } 6960 6961 /** 6962 * @hide 6963 */ 6964 protected boolean hasOpaqueScrollbars() { 6965 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS; 6966 } 6967 6968 /** 6969 * @return A handler associated with the thread running the View. This 6970 * handler can be used to pump events in the UI events queue. 6971 */ 6972 public Handler getHandler() { 6973 if (mAttachInfo != null) { 6974 return mAttachInfo.mHandler; 6975 } 6976 return null; 6977 } 6978 6979 /** 6980 * Causes the Runnable to be added to the message queue. 6981 * The runnable will be run on the user interface thread. 6982 * 6983 * @param action The Runnable that will be executed. 6984 * 6985 * @return Returns true if the Runnable was successfully placed in to the 6986 * message queue. Returns false on failure, usually because the 6987 * looper processing the message queue is exiting. 6988 */ 6989 public boolean post(Runnable action) { 6990 Handler handler; 6991 if (mAttachInfo != null) { 6992 handler = mAttachInfo.mHandler; 6993 } else { 6994 // Assume that post will succeed later 6995 ViewRoot.getRunQueue().post(action); 6996 return true; 6997 } 6998 6999 return handler.post(action); 7000 } 7001 7002 /** 7003 * Causes the Runnable to be added to the message queue, to be run 7004 * after the specified amount of time elapses. 7005 * The runnable will be run on the user interface thread. 7006 * 7007 * @param action The Runnable that will be executed. 7008 * @param delayMillis The delay (in milliseconds) until the Runnable 7009 * will be executed. 7010 * 7011 * @return true if the Runnable was successfully placed in to the 7012 * message queue. Returns false on failure, usually because the 7013 * looper processing the message queue is exiting. Note that a 7014 * result of true does not mean the Runnable will be processed -- 7015 * if the looper is quit before the delivery time of the message 7016 * occurs then the message will be dropped. 7017 */ 7018 public boolean postDelayed(Runnable action, long delayMillis) { 7019 Handler handler; 7020 if (mAttachInfo != null) { 7021 handler = mAttachInfo.mHandler; 7022 } else { 7023 // Assume that post will succeed later 7024 ViewRoot.getRunQueue().postDelayed(action, delayMillis); 7025 return true; 7026 } 7027 7028 return handler.postDelayed(action, delayMillis); 7029 } 7030 7031 /** 7032 * Removes the specified Runnable from the message queue. 7033 * 7034 * @param action The Runnable to remove from the message handling queue 7035 * 7036 * @return true if this view could ask the Handler to remove the Runnable, 7037 * false otherwise. When the returned value is true, the Runnable 7038 * may or may not have been actually removed from the message queue 7039 * (for instance, if the Runnable was not in the queue already.) 7040 */ 7041 public boolean removeCallbacks(Runnable action) { 7042 Handler handler; 7043 if (mAttachInfo != null) { 7044 handler = mAttachInfo.mHandler; 7045 } else { 7046 // Assume that post will succeed later 7047 ViewRoot.getRunQueue().removeCallbacks(action); 7048 return true; 7049 } 7050 7051 handler.removeCallbacks(action); 7052 return true; 7053 } 7054 7055 /** 7056 * Cause an invalidate to happen on a subsequent cycle through the event loop. 7057 * Use this to invalidate the View from a non-UI thread. 7058 * 7059 * @see #invalidate() 7060 */ 7061 public void postInvalidate() { 7062 postInvalidateDelayed(0); 7063 } 7064 7065 /** 7066 * Cause an invalidate of the specified area to happen on a subsequent cycle 7067 * through the event loop. Use this to invalidate the View from a non-UI thread. 7068 * 7069 * @param left The left coordinate of the rectangle to invalidate. 7070 * @param top The top coordinate of the rectangle to invalidate. 7071 * @param right The right coordinate of the rectangle to invalidate. 7072 * @param bottom The bottom coordinate of the rectangle to invalidate. 7073 * 7074 * @see #invalidate(int, int, int, int) 7075 * @see #invalidate(Rect) 7076 */ 7077 public void postInvalidate(int left, int top, int right, int bottom) { 7078 postInvalidateDelayed(0, left, top, right, bottom); 7079 } 7080 7081 /** 7082 * Cause an invalidate to happen on a subsequent cycle through the event 7083 * loop. Waits for the specified amount of time. 7084 * 7085 * @param delayMilliseconds the duration in milliseconds to delay the 7086 * invalidation by 7087 */ 7088 public void postInvalidateDelayed(long delayMilliseconds) { 7089 // We try only with the AttachInfo because there's no point in invalidating 7090 // if we are not attached to our window 7091 if (mAttachInfo != null) { 7092 Message msg = Message.obtain(); 7093 msg.what = AttachInfo.INVALIDATE_MSG; 7094 msg.obj = this; 7095 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds); 7096 } 7097 } 7098 7099 /** 7100 * Cause an invalidate of the specified area to happen on a subsequent cycle 7101 * through the event loop. Waits for the specified amount of time. 7102 * 7103 * @param delayMilliseconds the duration in milliseconds to delay the 7104 * invalidation by 7105 * @param left The left coordinate of the rectangle to invalidate. 7106 * @param top The top coordinate of the rectangle to invalidate. 7107 * @param right The right coordinate of the rectangle to invalidate. 7108 * @param bottom The bottom coordinate of the rectangle to invalidate. 7109 */ 7110 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 7111 int right, int bottom) { 7112 7113 // We try only with the AttachInfo because there's no point in invalidating 7114 // if we are not attached to our window 7115 if (mAttachInfo != null) { 7116 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 7117 info.target = this; 7118 info.left = left; 7119 info.top = top; 7120 info.right = right; 7121 info.bottom = bottom; 7122 7123 final Message msg = Message.obtain(); 7124 msg.what = AttachInfo.INVALIDATE_RECT_MSG; 7125 msg.obj = info; 7126 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds); 7127 } 7128 } 7129 7130 /** 7131 * Called by a parent to request that a child update its values for mScrollX 7132 * and mScrollY if necessary. This will typically be done if the child is 7133 * animating a scroll using a {@link android.widget.Scroller Scroller} 7134 * object. 7135 */ 7136 public void computeScroll() { 7137 } 7138 7139 /** 7140 * <p>Indicate whether the horizontal edges are faded when the view is 7141 * scrolled horizontally.</p> 7142 * 7143 * @return true if the horizontal edges should are faded on scroll, false 7144 * otherwise 7145 * 7146 * @see #setHorizontalFadingEdgeEnabled(boolean) 7147 * @attr ref android.R.styleable#View_fadingEdge 7148 */ 7149 public boolean isHorizontalFadingEdgeEnabled() { 7150 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 7151 } 7152 7153 /** 7154 * <p>Define whether the horizontal edges should be faded when this view 7155 * is scrolled horizontally.</p> 7156 * 7157 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 7158 * be faded when the view is scrolled 7159 * horizontally 7160 * 7161 * @see #isHorizontalFadingEdgeEnabled() 7162 * @attr ref android.R.styleable#View_fadingEdge 7163 */ 7164 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 7165 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 7166 if (horizontalFadingEdgeEnabled) { 7167 initScrollCache(); 7168 } 7169 7170 mViewFlags ^= FADING_EDGE_HORIZONTAL; 7171 } 7172 } 7173 7174 /** 7175 * <p>Indicate whether the vertical edges are faded when the view is 7176 * scrolled horizontally.</p> 7177 * 7178 * @return true if the vertical edges should are faded on scroll, false 7179 * otherwise 7180 * 7181 * @see #setVerticalFadingEdgeEnabled(boolean) 7182 * @attr ref android.R.styleable#View_fadingEdge 7183 */ 7184 public boolean isVerticalFadingEdgeEnabled() { 7185 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 7186 } 7187 7188 /** 7189 * <p>Define whether the vertical edges should be faded when this view 7190 * is scrolled vertically.</p> 7191 * 7192 * @param verticalFadingEdgeEnabled true if the vertical edges should 7193 * be faded when the view is scrolled 7194 * vertically 7195 * 7196 * @see #isVerticalFadingEdgeEnabled() 7197 * @attr ref android.R.styleable#View_fadingEdge 7198 */ 7199 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 7200 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 7201 if (verticalFadingEdgeEnabled) { 7202 initScrollCache(); 7203 } 7204 7205 mViewFlags ^= FADING_EDGE_VERTICAL; 7206 } 7207 } 7208 7209 /** 7210 * Returns the strength, or intensity, of the top faded edge. The strength is 7211 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 7212 * returns 0.0 or 1.0 but no value in between. 7213 * 7214 * Subclasses should override this method to provide a smoother fade transition 7215 * when scrolling occurs. 7216 * 7217 * @return the intensity of the top fade as a float between 0.0f and 1.0f 7218 */ 7219 protected float getTopFadingEdgeStrength() { 7220 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 7221 } 7222 7223 /** 7224 * Returns the strength, or intensity, of the bottom faded edge. The strength is 7225 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 7226 * returns 0.0 or 1.0 but no value in between. 7227 * 7228 * Subclasses should override this method to provide a smoother fade transition 7229 * when scrolling occurs. 7230 * 7231 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 7232 */ 7233 protected float getBottomFadingEdgeStrength() { 7234 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 7235 computeVerticalScrollRange() ? 1.0f : 0.0f; 7236 } 7237 7238 /** 7239 * Returns the strength, or intensity, of the left faded edge. The strength is 7240 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 7241 * returns 0.0 or 1.0 but no value in between. 7242 * 7243 * Subclasses should override this method to provide a smoother fade transition 7244 * when scrolling occurs. 7245 * 7246 * @return the intensity of the left fade as a float between 0.0f and 1.0f 7247 */ 7248 protected float getLeftFadingEdgeStrength() { 7249 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 7250 } 7251 7252 /** 7253 * Returns the strength, or intensity, of the right faded edge. The strength is 7254 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 7255 * returns 0.0 or 1.0 but no value in between. 7256 * 7257 * Subclasses should override this method to provide a smoother fade transition 7258 * when scrolling occurs. 7259 * 7260 * @return the intensity of the right fade as a float between 0.0f and 1.0f 7261 */ 7262 protected float getRightFadingEdgeStrength() { 7263 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 7264 computeHorizontalScrollRange() ? 1.0f : 0.0f; 7265 } 7266 7267 /** 7268 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 7269 * scrollbar is not drawn by default.</p> 7270 * 7271 * @return true if the horizontal scrollbar should be painted, false 7272 * otherwise 7273 * 7274 * @see #setHorizontalScrollBarEnabled(boolean) 7275 */ 7276 public boolean isHorizontalScrollBarEnabled() { 7277 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 7278 } 7279 7280 /** 7281 * <p>Define whether the horizontal scrollbar should be drawn or not. The 7282 * scrollbar is not drawn by default.</p> 7283 * 7284 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 7285 * be painted 7286 * 7287 * @see #isHorizontalScrollBarEnabled() 7288 */ 7289 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 7290 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 7291 mViewFlags ^= SCROLLBARS_HORIZONTAL; 7292 computeOpaqueFlags(); 7293 recomputePadding(); 7294 } 7295 } 7296 7297 /** 7298 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 7299 * scrollbar is not drawn by default.</p> 7300 * 7301 * @return true if the vertical scrollbar should be painted, false 7302 * otherwise 7303 * 7304 * @see #setVerticalScrollBarEnabled(boolean) 7305 */ 7306 public boolean isVerticalScrollBarEnabled() { 7307 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 7308 } 7309 7310 /** 7311 * <p>Define whether the vertical scrollbar should be drawn or not. The 7312 * scrollbar is not drawn by default.</p> 7313 * 7314 * @param verticalScrollBarEnabled true if the vertical scrollbar should 7315 * be painted 7316 * 7317 * @see #isVerticalScrollBarEnabled() 7318 */ 7319 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 7320 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 7321 mViewFlags ^= SCROLLBARS_VERTICAL; 7322 computeOpaqueFlags(); 7323 recomputePadding(); 7324 } 7325 } 7326 7327 /** 7328 * @hide 7329 */ 7330 protected void recomputePadding() { 7331 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 7332 } 7333 7334 /** 7335 * Define whether scrollbars will fade when the view is not scrolling. 7336 * 7337 * @param fadeScrollbars wheter to enable fading 7338 * 7339 */ 7340 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 7341 initScrollCache(); 7342 final ScrollabilityCache scrollabilityCache = mScrollCache; 7343 scrollabilityCache.fadeScrollBars = fadeScrollbars; 7344 if (fadeScrollbars) { 7345 scrollabilityCache.state = ScrollabilityCache.OFF; 7346 } else { 7347 scrollabilityCache.state = ScrollabilityCache.ON; 7348 } 7349 } 7350 7351 /** 7352 * 7353 * Returns true if scrollbars will fade when this view is not scrolling 7354 * 7355 * @return true if scrollbar fading is enabled 7356 */ 7357 public boolean isScrollbarFadingEnabled() { 7358 return mScrollCache != null && mScrollCache.fadeScrollBars; 7359 } 7360 7361 /** 7362 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 7363 * inset. When inset, they add to the padding of the view. And the scrollbars 7364 * can be drawn inside the padding area or on the edge of the view. For example, 7365 * if a view has a background drawable and you want to draw the scrollbars 7366 * inside the padding specified by the drawable, you can use 7367 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 7368 * appear at the edge of the view, ignoring the padding, then you can use 7369 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 7370 * @param style the style of the scrollbars. Should be one of 7371 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 7372 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 7373 * @see #SCROLLBARS_INSIDE_OVERLAY 7374 * @see #SCROLLBARS_INSIDE_INSET 7375 * @see #SCROLLBARS_OUTSIDE_OVERLAY 7376 * @see #SCROLLBARS_OUTSIDE_INSET 7377 */ 7378 public void setScrollBarStyle(int style) { 7379 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 7380 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 7381 computeOpaqueFlags(); 7382 recomputePadding(); 7383 } 7384 } 7385 7386 /** 7387 * <p>Returns the current scrollbar style.</p> 7388 * @return the current scrollbar style 7389 * @see #SCROLLBARS_INSIDE_OVERLAY 7390 * @see #SCROLLBARS_INSIDE_INSET 7391 * @see #SCROLLBARS_OUTSIDE_OVERLAY 7392 * @see #SCROLLBARS_OUTSIDE_INSET 7393 */ 7394 public int getScrollBarStyle() { 7395 return mViewFlags & SCROLLBARS_STYLE_MASK; 7396 } 7397 7398 /** 7399 * <p>Compute the horizontal range that the horizontal scrollbar 7400 * represents.</p> 7401 * 7402 * <p>The range is expressed in arbitrary units that must be the same as the 7403 * units used by {@link #computeHorizontalScrollExtent()} and 7404 * {@link #computeHorizontalScrollOffset()}.</p> 7405 * 7406 * <p>The default range is the drawing width of this view.</p> 7407 * 7408 * @return the total horizontal range represented by the horizontal 7409 * scrollbar 7410 * 7411 * @see #computeHorizontalScrollExtent() 7412 * @see #computeHorizontalScrollOffset() 7413 * @see android.widget.ScrollBarDrawable 7414 */ 7415 protected int computeHorizontalScrollRange() { 7416 return getWidth(); 7417 } 7418 7419 /** 7420 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 7421 * within the horizontal range. This value is used to compute the position 7422 * of the thumb within the scrollbar's track.</p> 7423 * 7424 * <p>The range is expressed in arbitrary units that must be the same as the 7425 * units used by {@link #computeHorizontalScrollRange()} and 7426 * {@link #computeHorizontalScrollExtent()}.</p> 7427 * 7428 * <p>The default offset is the scroll offset of this view.</p> 7429 * 7430 * @return the horizontal offset of the scrollbar's thumb 7431 * 7432 * @see #computeHorizontalScrollRange() 7433 * @see #computeHorizontalScrollExtent() 7434 * @see android.widget.ScrollBarDrawable 7435 */ 7436 protected int computeHorizontalScrollOffset() { 7437 return mScrollX; 7438 } 7439 7440 /** 7441 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 7442 * within the horizontal range. This value is used to compute the length 7443 * of the thumb within the scrollbar's track.</p> 7444 * 7445 * <p>The range is expressed in arbitrary units that must be the same as the 7446 * units used by {@link #computeHorizontalScrollRange()} and 7447 * {@link #computeHorizontalScrollOffset()}.</p> 7448 * 7449 * <p>The default extent is the drawing width of this view.</p> 7450 * 7451 * @return the horizontal extent of the scrollbar's thumb 7452 * 7453 * @see #computeHorizontalScrollRange() 7454 * @see #computeHorizontalScrollOffset() 7455 * @see android.widget.ScrollBarDrawable 7456 */ 7457 protected int computeHorizontalScrollExtent() { 7458 return getWidth(); 7459 } 7460 7461 /** 7462 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 7463 * 7464 * <p>The range is expressed in arbitrary units that must be the same as the 7465 * units used by {@link #computeVerticalScrollExtent()} and 7466 * {@link #computeVerticalScrollOffset()}.</p> 7467 * 7468 * @return the total vertical range represented by the vertical scrollbar 7469 * 7470 * <p>The default range is the drawing height of this view.</p> 7471 * 7472 * @see #computeVerticalScrollExtent() 7473 * @see #computeVerticalScrollOffset() 7474 * @see android.widget.ScrollBarDrawable 7475 */ 7476 protected int computeVerticalScrollRange() { 7477 return getHeight(); 7478 } 7479 7480 /** 7481 * <p>Compute the vertical offset of the vertical scrollbar's thumb 7482 * within the horizontal range. This value is used to compute the position 7483 * of the thumb within the scrollbar's track.</p> 7484 * 7485 * <p>The range is expressed in arbitrary units that must be the same as the 7486 * units used by {@link #computeVerticalScrollRange()} and 7487 * {@link #computeVerticalScrollExtent()}.</p> 7488 * 7489 * <p>The default offset is the scroll offset of this view.</p> 7490 * 7491 * @return the vertical offset of the scrollbar's thumb 7492 * 7493 * @see #computeVerticalScrollRange() 7494 * @see #computeVerticalScrollExtent() 7495 * @see android.widget.ScrollBarDrawable 7496 */ 7497 protected int computeVerticalScrollOffset() { 7498 return mScrollY; 7499 } 7500 7501 /** 7502 * <p>Compute the vertical extent of the horizontal scrollbar's thumb 7503 * within the vertical range. This value is used to compute the length 7504 * of the thumb within the scrollbar's track.</p> 7505 * 7506 * <p>The range is expressed in arbitrary units that must be the same as the 7507 * units used by {@link #computeVerticalScrollRange()} and 7508 * {@link #computeVerticalScrollOffset()}.</p> 7509 * 7510 * <p>The default extent is the drawing height of this view.</p> 7511 * 7512 * @return the vertical extent of the scrollbar's thumb 7513 * 7514 * @see #computeVerticalScrollRange() 7515 * @see #computeVerticalScrollOffset() 7516 * @see android.widget.ScrollBarDrawable 7517 */ 7518 protected int computeVerticalScrollExtent() { 7519 return getHeight(); 7520 } 7521 7522 /** 7523 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 7524 * scrollbars are painted only if they have been awakened first.</p> 7525 * 7526 * @param canvas the canvas on which to draw the scrollbars 7527 * 7528 * @see #awakenScrollBars(int) 7529 */ 7530 protected final void onDrawScrollBars(Canvas canvas) { 7531 // scrollbars are drawn only when the animation is running 7532 final ScrollabilityCache cache = mScrollCache; 7533 if (cache != null) { 7534 7535 int state = cache.state; 7536 7537 if (state == ScrollabilityCache.OFF) { 7538 return; 7539 } 7540 7541 boolean invalidate = false; 7542 7543 if (state == ScrollabilityCache.FADING) { 7544 // We're fading -- get our fade interpolation 7545 if (cache.interpolatorValues == null) { 7546 cache.interpolatorValues = new float[1]; 7547 } 7548 7549 float[] values = cache.interpolatorValues; 7550 7551 // Stops the animation if we're done 7552 if (cache.scrollBarInterpolator.timeToValues(values) == 7553 Interpolator.Result.FREEZE_END) { 7554 cache.state = ScrollabilityCache.OFF; 7555 } else { 7556 cache.scrollBar.setAlpha(Math.round(values[0])); 7557 } 7558 7559 // This will make the scroll bars inval themselves after 7560 // drawing. We only want this when we're fading so that 7561 // we prevent excessive redraws 7562 invalidate = true; 7563 } else { 7564 // We're just on -- but we may have been fading before so 7565 // reset alpha 7566 cache.scrollBar.setAlpha(255); 7567 } 7568 7569 7570 final int viewFlags = mViewFlags; 7571 7572 final boolean drawHorizontalScrollBar = 7573 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 7574 final boolean drawVerticalScrollBar = 7575 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 7576 && !isVerticalScrollBarHidden(); 7577 7578 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 7579 final int width = mRight - mLeft; 7580 final int height = mBottom - mTop; 7581 7582 final ScrollBarDrawable scrollBar = cache.scrollBar; 7583 7584 final int scrollX = mScrollX; 7585 final int scrollY = mScrollY; 7586 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 7587 7588 int left, top, right, bottom; 7589 7590 if (drawHorizontalScrollBar) { 7591 int size = scrollBar.getSize(false); 7592 if (size <= 0) { 7593 size = cache.scrollBarSize; 7594 } 7595 7596 scrollBar.setParameters(computeHorizontalScrollRange(), 7597 computeHorizontalScrollOffset(), 7598 computeHorizontalScrollExtent(), false); 7599 final int verticalScrollBarGap = drawVerticalScrollBar ? 7600 getVerticalScrollbarWidth() : 0; 7601 top = scrollY + height - size - (mUserPaddingBottom & inside); 7602 left = scrollX + (mPaddingLeft & inside); 7603 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 7604 bottom = top + size; 7605 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 7606 if (invalidate) { 7607 invalidate(left, top, right, bottom); 7608 } 7609 } 7610 7611 if (drawVerticalScrollBar) { 7612 int size = scrollBar.getSize(true); 7613 if (size <= 0) { 7614 size = cache.scrollBarSize; 7615 } 7616 7617 scrollBar.setParameters(computeVerticalScrollRange(), 7618 computeVerticalScrollOffset(), 7619 computeVerticalScrollExtent(), true); 7620 switch (mVerticalScrollbarPosition) { 7621 default: 7622 case SCROLLBAR_POSITION_DEFAULT: 7623 case SCROLLBAR_POSITION_RIGHT: 7624 left = scrollX + width - size - (mUserPaddingRight & inside); 7625 break; 7626 case SCROLLBAR_POSITION_LEFT: 7627 left = scrollX + (mUserPaddingLeft & inside); 7628 break; 7629 } 7630 top = scrollY + (mPaddingTop & inside); 7631 right = left + size; 7632 bottom = scrollY + height - (mUserPaddingBottom & inside); 7633 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 7634 if (invalidate) { 7635 invalidate(left, top, right, bottom); 7636 } 7637 } 7638 } 7639 } 7640 } 7641 7642 /** 7643 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 7644 * FastScroller is visible. 7645 * @return whether to temporarily hide the vertical scrollbar 7646 * @hide 7647 */ 7648 protected boolean isVerticalScrollBarHidden() { 7649 return false; 7650 } 7651 7652 /** 7653 * <p>Draw the horizontal scrollbar if 7654 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 7655 * 7656 * @param canvas the canvas on which to draw the scrollbar 7657 * @param scrollBar the scrollbar's drawable 7658 * 7659 * @see #isHorizontalScrollBarEnabled() 7660 * @see #computeHorizontalScrollRange() 7661 * @see #computeHorizontalScrollExtent() 7662 * @see #computeHorizontalScrollOffset() 7663 * @see android.widget.ScrollBarDrawable 7664 * @hide 7665 */ 7666 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar, 7667 int l, int t, int r, int b) { 7668 scrollBar.setBounds(l, t, r, b); 7669 scrollBar.draw(canvas); 7670 } 7671 7672 /** 7673 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 7674 * returns true.</p> 7675 * 7676 * @param canvas the canvas on which to draw the scrollbar 7677 * @param scrollBar the scrollbar's drawable 7678 * 7679 * @see #isVerticalScrollBarEnabled() 7680 * @see #computeVerticalScrollRange() 7681 * @see #computeVerticalScrollExtent() 7682 * @see #computeVerticalScrollOffset() 7683 * @see android.widget.ScrollBarDrawable 7684 * @hide 7685 */ 7686 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar, 7687 int l, int t, int r, int b) { 7688 scrollBar.setBounds(l, t, r, b); 7689 scrollBar.draw(canvas); 7690 } 7691 7692 /** 7693 * Implement this to do your drawing. 7694 * 7695 * @param canvas the canvas on which the background will be drawn 7696 */ 7697 protected void onDraw(Canvas canvas) { 7698 } 7699 7700 /* 7701 * Caller is responsible for calling requestLayout if necessary. 7702 * (This allows addViewInLayout to not request a new layout.) 7703 */ 7704 void assignParent(ViewParent parent) { 7705 if (mParent == null) { 7706 mParent = parent; 7707 } else if (parent == null) { 7708 mParent = null; 7709 } else { 7710 throw new RuntimeException("view " + this + " being added, but" 7711 + " it already has a parent"); 7712 } 7713 } 7714 7715 /** 7716 * This is called when the view is attached to a window. At this point it 7717 * has a Surface and will start drawing. Note that this function is 7718 * guaranteed to be called before {@link #onDraw}, however it may be called 7719 * any time before the first onDraw -- including before or after 7720 * {@link #onMeasure}. 7721 * 7722 * @see #onDetachedFromWindow() 7723 */ 7724 protected void onAttachedToWindow() { 7725 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) { 7726 mParent.requestTransparentRegion(this); 7727 } 7728 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) { 7729 initialAwakenScrollBars(); 7730 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH; 7731 } 7732 jumpDrawablesToCurrentState(); 7733 } 7734 7735 /** 7736 * This is called when the view is detached from a window. At this point it 7737 * no longer has a surface for drawing. 7738 * 7739 * @see #onAttachedToWindow() 7740 */ 7741 protected void onDetachedFromWindow() { 7742 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT; 7743 7744 removeUnsetPressCallback(); 7745 removeLongPressCallback(); 7746 removePerformClickCallback(); 7747 7748 destroyDrawingCache(); 7749 7750 if (mHardwareLayer != null) { 7751 mHardwareLayer.destroy(); 7752 mHardwareLayer = null; 7753 } 7754 7755 if (mDisplayList != null) { 7756 mDisplayList.invalidate(); 7757 } 7758 7759 if (mAttachInfo != null) { 7760 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this); 7761 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this); 7762 } 7763 7764 mCurrentAnimation = null; 7765 } 7766 7767 /** 7768 * @return The number of times this view has been attached to a window 7769 */ 7770 protected int getWindowAttachCount() { 7771 return mWindowAttachCount; 7772 } 7773 7774 /** 7775 * Retrieve a unique token identifying the window this view is attached to. 7776 * @return Return the window's token for use in 7777 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 7778 */ 7779 public IBinder getWindowToken() { 7780 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 7781 } 7782 7783 /** 7784 * Retrieve a unique token identifying the top-level "real" window of 7785 * the window that this view is attached to. That is, this is like 7786 * {@link #getWindowToken}, except if the window this view in is a panel 7787 * window (attached to another containing window), then the token of 7788 * the containing window is returned instead. 7789 * 7790 * @return Returns the associated window token, either 7791 * {@link #getWindowToken()} or the containing window's token. 7792 */ 7793 public IBinder getApplicationWindowToken() { 7794 AttachInfo ai = mAttachInfo; 7795 if (ai != null) { 7796 IBinder appWindowToken = ai.mPanelParentWindowToken; 7797 if (appWindowToken == null) { 7798 appWindowToken = ai.mWindowToken; 7799 } 7800 return appWindowToken; 7801 } 7802 return null; 7803 } 7804 7805 /** 7806 * Retrieve private session object this view hierarchy is using to 7807 * communicate with the window manager. 7808 * @return the session object to communicate with the window manager 7809 */ 7810 /*package*/ IWindowSession getWindowSession() { 7811 return mAttachInfo != null ? mAttachInfo.mSession : null; 7812 } 7813 7814 /** 7815 * @param info the {@link android.view.View.AttachInfo} to associated with 7816 * this view 7817 */ 7818 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 7819 //System.out.println("Attached! " + this); 7820 mAttachInfo = info; 7821 mWindowAttachCount++; 7822 // We will need to evaluate the drawable state at least once. 7823 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 7824 if (mFloatingTreeObserver != null) { 7825 info.mTreeObserver.merge(mFloatingTreeObserver); 7826 mFloatingTreeObserver = null; 7827 } 7828 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) { 7829 mAttachInfo.mScrollContainers.add(this); 7830 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 7831 } 7832 performCollectViewAttributes(visibility); 7833 onAttachedToWindow(); 7834 int vis = info.mWindowVisibility; 7835 if (vis != GONE) { 7836 onWindowVisibilityChanged(vis); 7837 } 7838 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) { 7839 // If nobody has evaluated the drawable state yet, then do it now. 7840 refreshDrawableState(); 7841 } 7842 } 7843 7844 void dispatchDetachedFromWindow() { 7845 //System.out.println("Detached! " + this); 7846 AttachInfo info = mAttachInfo; 7847 if (info != null) { 7848 int vis = info.mWindowVisibility; 7849 if (vis != GONE) { 7850 onWindowVisibilityChanged(GONE); 7851 } 7852 } 7853 7854 onDetachedFromWindow(); 7855 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) { 7856 mAttachInfo.mScrollContainers.remove(this); 7857 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED; 7858 } 7859 mAttachInfo = null; 7860 } 7861 7862 /** 7863 * Store this view hierarchy's frozen state into the given container. 7864 * 7865 * @param container The SparseArray in which to save the view's state. 7866 * 7867 * @see #restoreHierarchyState 7868 * @see #dispatchSaveInstanceState 7869 * @see #onSaveInstanceState 7870 */ 7871 public void saveHierarchyState(SparseArray<Parcelable> container) { 7872 dispatchSaveInstanceState(container); 7873 } 7874 7875 /** 7876 * Called by {@link #saveHierarchyState} to store the state for this view and its children. 7877 * May be overridden to modify how freezing happens to a view's children; for example, some 7878 * views may want to not store state for their children. 7879 * 7880 * @param container The SparseArray in which to save the view's state. 7881 * 7882 * @see #dispatchRestoreInstanceState 7883 * @see #saveHierarchyState 7884 * @see #onSaveInstanceState 7885 */ 7886 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 7887 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 7888 mPrivateFlags &= ~SAVE_STATE_CALLED; 7889 Parcelable state = onSaveInstanceState(); 7890 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 7891 throw new IllegalStateException( 7892 "Derived class did not call super.onSaveInstanceState()"); 7893 } 7894 if (state != null) { 7895 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 7896 // + ": " + state); 7897 container.put(mID, state); 7898 } 7899 } 7900 } 7901 7902 /** 7903 * Hook allowing a view to generate a representation of its internal state 7904 * that can later be used to create a new instance with that same state. 7905 * This state should only contain information that is not persistent or can 7906 * not be reconstructed later. For example, you will never store your 7907 * current position on screen because that will be computed again when a 7908 * new instance of the view is placed in its view hierarchy. 7909 * <p> 7910 * Some examples of things you may store here: the current cursor position 7911 * in a text view (but usually not the text itself since that is stored in a 7912 * content provider or other persistent storage), the currently selected 7913 * item in a list view. 7914 * 7915 * @return Returns a Parcelable object containing the view's current dynamic 7916 * state, or null if there is nothing interesting to save. The 7917 * default implementation returns null. 7918 * @see #onRestoreInstanceState 7919 * @see #saveHierarchyState 7920 * @see #dispatchSaveInstanceState 7921 * @see #setSaveEnabled(boolean) 7922 */ 7923 protected Parcelable onSaveInstanceState() { 7924 mPrivateFlags |= SAVE_STATE_CALLED; 7925 return BaseSavedState.EMPTY_STATE; 7926 } 7927 7928 /** 7929 * Restore this view hierarchy's frozen state from the given container. 7930 * 7931 * @param container The SparseArray which holds previously frozen states. 7932 * 7933 * @see #saveHierarchyState 7934 * @see #dispatchRestoreInstanceState 7935 * @see #onRestoreInstanceState 7936 */ 7937 public void restoreHierarchyState(SparseArray<Parcelable> container) { 7938 dispatchRestoreInstanceState(container); 7939 } 7940 7941 /** 7942 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its 7943 * children. May be overridden to modify how restoreing happens to a view's children; for 7944 * example, some views may want to not store state for their children. 7945 * 7946 * @param container The SparseArray which holds previously saved state. 7947 * 7948 * @see #dispatchSaveInstanceState 7949 * @see #restoreHierarchyState 7950 * @see #onRestoreInstanceState 7951 */ 7952 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 7953 if (mID != NO_ID) { 7954 Parcelable state = container.get(mID); 7955 if (state != null) { 7956 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 7957 // + ": " + state); 7958 mPrivateFlags &= ~SAVE_STATE_CALLED; 7959 onRestoreInstanceState(state); 7960 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 7961 throw new IllegalStateException( 7962 "Derived class did not call super.onRestoreInstanceState()"); 7963 } 7964 } 7965 } 7966 } 7967 7968 /** 7969 * Hook allowing a view to re-apply a representation of its internal state that had previously 7970 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 7971 * null state. 7972 * 7973 * @param state The frozen state that had previously been returned by 7974 * {@link #onSaveInstanceState}. 7975 * 7976 * @see #onSaveInstanceState 7977 * @see #restoreHierarchyState 7978 * @see #dispatchRestoreInstanceState 7979 */ 7980 protected void onRestoreInstanceState(Parcelable state) { 7981 mPrivateFlags |= SAVE_STATE_CALLED; 7982 if (state != BaseSavedState.EMPTY_STATE && state != null) { 7983 throw new IllegalArgumentException("Wrong state class, expecting View State but " 7984 + "received " + state.getClass().toString() + " instead. This usually happens " 7985 + "when two views of different type have the same id in the same hierarchy. " 7986 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 7987 + "other views do not use the same id."); 7988 } 7989 } 7990 7991 /** 7992 * <p>Return the time at which the drawing of the view hierarchy started.</p> 7993 * 7994 * @return the drawing start time in milliseconds 7995 */ 7996 public long getDrawingTime() { 7997 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 7998 } 7999 8000 /** 8001 * <p>Enables or disables the duplication of the parent's state into this view. When 8002 * duplication is enabled, this view gets its drawable state from its parent rather 8003 * than from its own internal properties.</p> 8004 * 8005 * <p>Note: in the current implementation, setting this property to true after the 8006 * view was added to a ViewGroup might have no effect at all. This property should 8007 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 8008 * 8009 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 8010 * property is enabled, an exception will be thrown.</p> 8011 * 8012 * <p>Note: if the child view uses and updates additionnal states which are unknown to the 8013 * parent, these states should not be affected by this method.</p> 8014 * 8015 * @param enabled True to enable duplication of the parent's drawable state, false 8016 * to disable it. 8017 * 8018 * @see #getDrawableState() 8019 * @see #isDuplicateParentStateEnabled() 8020 */ 8021 public void setDuplicateParentStateEnabled(boolean enabled) { 8022 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 8023 } 8024 8025 /** 8026 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 8027 * 8028 * @return True if this view's drawable state is duplicated from the parent, 8029 * false otherwise 8030 * 8031 * @see #getDrawableState() 8032 * @see #setDuplicateParentStateEnabled(boolean) 8033 */ 8034 public boolean isDuplicateParentStateEnabled() { 8035 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 8036 } 8037 8038 /** 8039 * <p>Specifies the type of layer backing this view. The layer can be 8040 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or 8041 * {@link #LAYER_TYPE_HARDWARE hardware}.</p> 8042 * 8043 * <p>A layer is associated with an optional {@link android.graphics.Paint} 8044 * instance that controls how the layer is composed on screen. The following 8045 * properties of the paint are taken into account when composing the layer:</p> 8046 * <ul> 8047 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li> 8048 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li> 8049 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li> 8050 * </ul> 8051 * 8052 * <p>If this view has an alpha value set to < 1.0 by calling 8053 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by 8054 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore 8055 * equivalent to setting a hardware layer on this view and providing a paint with 8056 * the desired alpha value.<p> 8057 * 8058 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled}, 8059 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware} 8060 * for more information on when and how to use layers.</p> 8061 * 8062 * @param layerType The ype of layer to use with this view, must be one of 8063 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 8064 * {@link #LAYER_TYPE_HARDWARE} 8065 * @param paint The paint used to compose the layer. This argument is optional 8066 * and can be null. It is ignored when the layer type is 8067 * {@link #LAYER_TYPE_NONE} 8068 * 8069 * @see #getLayerType() 8070 * @see #LAYER_TYPE_NONE 8071 * @see #LAYER_TYPE_SOFTWARE 8072 * @see #LAYER_TYPE_HARDWARE 8073 * @see #setAlpha(float) 8074 * 8075 * @attr ref android.R.styleable#View_layerType 8076 */ 8077 public void setLayerType(int layerType, Paint paint) { 8078 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) { 8079 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, " 8080 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE"); 8081 } 8082 8083 if (layerType == mLayerType) { 8084 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) { 8085 mLayerPaint = paint == null ? new Paint() : paint; 8086 invalidateParentCaches(); 8087 invalidate(true); 8088 } 8089 return; 8090 } 8091 8092 // Destroy any previous software drawing cache if needed 8093 switch (mLayerType) { 8094 case LAYER_TYPE_SOFTWARE: 8095 if (mDrawingCache != null) { 8096 mDrawingCache.recycle(); 8097 mDrawingCache = null; 8098 } 8099 8100 if (mUnscaledDrawingCache != null) { 8101 mUnscaledDrawingCache.recycle(); 8102 mUnscaledDrawingCache = null; 8103 } 8104 break; 8105 case LAYER_TYPE_HARDWARE: 8106 if (mHardwareLayer != null) { 8107 mHardwareLayer.destroy(); 8108 mHardwareLayer = null; 8109 } 8110 break; 8111 default: 8112 break; 8113 } 8114 8115 mLayerType = layerType; 8116 mLayerPaint = mLayerType == LAYER_TYPE_NONE ? null : (paint == null ? new Paint() : paint); 8117 8118 invalidateParentCaches(); 8119 invalidate(true); 8120 } 8121 8122 /** 8123 * Indicates what type of layer is currently associated with this view. By default 8124 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}. 8125 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)} 8126 * for more information on the different types of layers. 8127 * 8128 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or 8129 * {@link #LAYER_TYPE_HARDWARE} 8130 * 8131 * @see #setLayerType(int, android.graphics.Paint) 8132 * @see #LAYER_TYPE_NONE 8133 * @see #LAYER_TYPE_SOFTWARE 8134 * @see #LAYER_TYPE_HARDWARE 8135 */ 8136 public int getLayerType() { 8137 return mLayerType; 8138 } 8139 8140 /** 8141 * <p>Returns a hardware layer that can be used to draw this view again 8142 * without executing its draw method.</p> 8143 * 8144 * @return A HardwareLayer ready to render, or null if an error occurred. 8145 */ 8146 HardwareLayer getHardwareLayer() { 8147 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) { 8148 return null; 8149 } 8150 8151 final int width = mRight - mLeft; 8152 final int height = mBottom - mTop; 8153 8154 if (width == 0 || height == 0) { 8155 return null; 8156 } 8157 8158 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) { 8159 if (mHardwareLayer == null) { 8160 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer( 8161 width, height, isOpaque()); 8162 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) { 8163 mHardwareLayer.resize(width, height); 8164 } 8165 8166 Canvas currentCanvas = mAttachInfo.mHardwareCanvas; 8167 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas); 8168 mAttachInfo.mHardwareCanvas = canvas; 8169 try { 8170 canvas.setViewport(width, height); 8171 // TODO: We should pass the dirty rect 8172 canvas.onPreDraw(null); 8173 8174 final int restoreCount = canvas.save(); 8175 8176 computeScroll(); 8177 canvas.translate(-mScrollX, -mScrollY); 8178 8179 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 8180 8181 // Fast path for layouts with no backgrounds 8182 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 8183 mPrivateFlags &= ~DIRTY_MASK; 8184 dispatchDraw(canvas); 8185 } else { 8186 draw(canvas); 8187 } 8188 8189 canvas.restoreToCount(restoreCount); 8190 } finally { 8191 canvas.onPostDraw(); 8192 mHardwareLayer.end(currentCanvas); 8193 mAttachInfo.mHardwareCanvas = currentCanvas; 8194 } 8195 } 8196 8197 return mHardwareLayer; 8198 } 8199 8200 /** 8201 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 8202 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 8203 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 8204 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 8205 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 8206 * null.</p> 8207 * 8208 * <p>Enabling the drawing cache is similar to 8209 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware 8210 * acceleration is turned off. When hardware acceleration is turned on, enabling the 8211 * drawing cache has no effect on rendering because the system uses a different mechanism 8212 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even 8213 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)} 8214 * for information on how to enable software and hardware layers.</p> 8215 * 8216 * <p>This API can be used to manually generate 8217 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling 8218 * {@link #getDrawingCache()}.</p> 8219 * 8220 * @param enabled true to enable the drawing cache, false otherwise 8221 * 8222 * @see #isDrawingCacheEnabled() 8223 * @see #getDrawingCache() 8224 * @see #buildDrawingCache() 8225 * @see #setLayerType(int, android.graphics.Paint) 8226 */ 8227 public void setDrawingCacheEnabled(boolean enabled) { 8228 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 8229 } 8230 8231 /** 8232 * <p>Indicates whether the drawing cache is enabled for this view.</p> 8233 * 8234 * @return true if the drawing cache is enabled 8235 * 8236 * @see #setDrawingCacheEnabled(boolean) 8237 * @see #getDrawingCache() 8238 */ 8239 @ViewDebug.ExportedProperty(category = "drawing") 8240 public boolean isDrawingCacheEnabled() { 8241 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 8242 } 8243 8244 /** 8245 * Debugging utility which recursively outputs the dirty state of a view and its 8246 * descendants. 8247 * 8248 * @hide 8249 */ 8250 public void outputDirtyFlags(String indent, boolean clear, int clearMask) { 8251 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) + 8252 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" + 8253 (mPrivateFlags & View.DRAWING_CACHE_VALID) + 8254 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")"); 8255 if (clear) { 8256 mPrivateFlags &= clearMask; 8257 } 8258 if (this instanceof ViewGroup) { 8259 ViewGroup parent = (ViewGroup) this; 8260 final int count = parent.getChildCount(); 8261 for (int i = 0; i < count; i++) { 8262 final View child = parent.getChildAt(i); 8263 child.outputDirtyFlags(indent + " ", clear, clearMask); 8264 } 8265 } 8266 } 8267 8268 /** 8269 * This method is used by ViewGroup to cause its children to restore or recreate their 8270 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need 8271 * to recreate its own display list, which would happen if it went through the normal 8272 * draw/dispatchDraw mechanisms. 8273 * 8274 * @hide 8275 */ 8276 protected void dispatchGetDisplayList() {} 8277 8278 /** 8279 * A view that is not attached or hardware accelerated cannot create a display list. 8280 * This method checks these conditions and returns the appropriate result. 8281 * 8282 * @return true if view has the ability to create a display list, false otherwise. 8283 * 8284 * @hide 8285 */ 8286 public boolean canHaveDisplayList() { 8287 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) { 8288 return false; 8289 } 8290 return true; 8291 } 8292 8293 /** 8294 * <p>Returns a display list that can be used to draw this view again 8295 * without executing its draw method.</p> 8296 * 8297 * @return A DisplayList ready to replay, or null if caching is not enabled. 8298 * 8299 * @hide 8300 */ 8301 public DisplayList getDisplayList() { 8302 if (!canHaveDisplayList()) { 8303 return null; 8304 } 8305 8306 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || 8307 mDisplayList == null || !mDisplayList.isValid() || 8308 mRecreateDisplayList)) { 8309 // Don't need to recreate the display list, just need to tell our 8310 // children to restore/recreate theirs 8311 if (mDisplayList != null && mDisplayList.isValid() && 8312 !mRecreateDisplayList) { 8313 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 8314 mPrivateFlags &= ~DIRTY_MASK; 8315 dispatchGetDisplayList(); 8316 8317 return mDisplayList; 8318 } 8319 8320 // If we got here, we're recreating it. Mark it as such to ensure that 8321 // we copy in child display lists into ours in drawChild() 8322 mRecreateDisplayList = true; 8323 if (mDisplayList == null) { 8324 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList(this); 8325 // If we're creating a new display list, make sure our parent gets invalidated 8326 // since they will need to recreate their display list to account for this 8327 // new child display list. 8328 invalidateParentCaches(); 8329 } 8330 8331 final HardwareCanvas canvas = mDisplayList.start(); 8332 try { 8333 int width = mRight - mLeft; 8334 int height = mBottom - mTop; 8335 8336 canvas.setViewport(width, height); 8337 // The dirty rect should always be null for a display list 8338 canvas.onPreDraw(null); 8339 8340 final int restoreCount = canvas.save(); 8341 8342 computeScroll(); 8343 canvas.translate(-mScrollX, -mScrollY); 8344 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 8345 8346 // Fast path for layouts with no backgrounds 8347 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 8348 mPrivateFlags &= ~DIRTY_MASK; 8349 dispatchDraw(canvas); 8350 } else { 8351 draw(canvas); 8352 } 8353 8354 canvas.restoreToCount(restoreCount); 8355 } finally { 8356 canvas.onPostDraw(); 8357 8358 mDisplayList.end(); 8359 } 8360 } else { 8361 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID; 8362 mPrivateFlags &= ~DIRTY_MASK; 8363 } 8364 8365 return mDisplayList; 8366 } 8367 8368 /** 8369 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 8370 * 8371 * @return A non-scaled bitmap representing this view or null if cache is disabled. 8372 * 8373 * @see #getDrawingCache(boolean) 8374 */ 8375 public Bitmap getDrawingCache() { 8376 return getDrawingCache(false); 8377 } 8378 8379 /** 8380 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 8381 * is null when caching is disabled. If caching is enabled and the cache is not ready, 8382 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 8383 * draw from the cache when the cache is enabled. To benefit from the cache, you must 8384 * request the drawing cache by calling this method and draw it on screen if the 8385 * returned bitmap is not null.</p> 8386 * 8387 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 8388 * this method will create a bitmap of the same size as this view. Because this bitmap 8389 * will be drawn scaled by the parent ViewGroup, the result on screen might show 8390 * scaling artifacts. To avoid such artifacts, you should call this method by setting 8391 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 8392 * size than the view. This implies that your application must be able to handle this 8393 * size.</p> 8394 * 8395 * @param autoScale Indicates whether the generated bitmap should be scaled based on 8396 * the current density of the screen when the application is in compatibility 8397 * mode. 8398 * 8399 * @return A bitmap representing this view or null if cache is disabled. 8400 * 8401 * @see #setDrawingCacheEnabled(boolean) 8402 * @see #isDrawingCacheEnabled() 8403 * @see #buildDrawingCache(boolean) 8404 * @see #destroyDrawingCache() 8405 */ 8406 public Bitmap getDrawingCache(boolean autoScale) { 8407 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 8408 return null; 8409 } 8410 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 8411 buildDrawingCache(autoScale); 8412 } 8413 return autoScale ? mDrawingCache : mUnscaledDrawingCache; 8414 } 8415 8416 /** 8417 * <p>Frees the resources used by the drawing cache. If you call 8418 * {@link #buildDrawingCache()} manually without calling 8419 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 8420 * should cleanup the cache with this method afterwards.</p> 8421 * 8422 * @see #setDrawingCacheEnabled(boolean) 8423 * @see #buildDrawingCache() 8424 * @see #getDrawingCache() 8425 */ 8426 public void destroyDrawingCache() { 8427 if (mDrawingCache != null) { 8428 mDrawingCache.recycle(); 8429 mDrawingCache = null; 8430 } 8431 if (mUnscaledDrawingCache != null) { 8432 mUnscaledDrawingCache.recycle(); 8433 mUnscaledDrawingCache = null; 8434 } 8435 } 8436 8437 /** 8438 * Setting a solid background color for the drawing cache's bitmaps will improve 8439 * perfromance and memory usage. Note, though that this should only be used if this 8440 * view will always be drawn on top of a solid color. 8441 * 8442 * @param color The background color to use for the drawing cache's bitmap 8443 * 8444 * @see #setDrawingCacheEnabled(boolean) 8445 * @see #buildDrawingCache() 8446 * @see #getDrawingCache() 8447 */ 8448 public void setDrawingCacheBackgroundColor(int color) { 8449 if (color != mDrawingCacheBackgroundColor) { 8450 mDrawingCacheBackgroundColor = color; 8451 mPrivateFlags &= ~DRAWING_CACHE_VALID; 8452 } 8453 } 8454 8455 /** 8456 * @see #setDrawingCacheBackgroundColor(int) 8457 * 8458 * @return The background color to used for the drawing cache's bitmap 8459 */ 8460 public int getDrawingCacheBackgroundColor() { 8461 return mDrawingCacheBackgroundColor; 8462 } 8463 8464 /** 8465 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 8466 * 8467 * @see #buildDrawingCache(boolean) 8468 */ 8469 public void buildDrawingCache() { 8470 buildDrawingCache(false); 8471 } 8472 8473 /** 8474 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 8475 * 8476 * <p>If you call {@link #buildDrawingCache()} manually without calling 8477 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 8478 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 8479 * 8480 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 8481 * this method will create a bitmap of the same size as this view. Because this bitmap 8482 * will be drawn scaled by the parent ViewGroup, the result on screen might show 8483 * scaling artifacts. To avoid such artifacts, you should call this method by setting 8484 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 8485 * size than the view. This implies that your application must be able to handle this 8486 * size.</p> 8487 * 8488 * <p>You should avoid calling this method when hardware acceleration is enabled. If 8489 * you do not need the drawing cache bitmap, calling this method will increase memory 8490 * usage and cause the view to be rendered in software once, thus negatively impacting 8491 * performance.</p> 8492 * 8493 * @see #getDrawingCache() 8494 * @see #destroyDrawingCache() 8495 */ 8496 public void buildDrawingCache(boolean autoScale) { 8497 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ? 8498 mDrawingCache == null : mUnscaledDrawingCache == null)) { 8499 8500 if (ViewDebug.TRACE_HIERARCHY) { 8501 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE); 8502 } 8503 8504 int width = mRight - mLeft; 8505 int height = mBottom - mTop; 8506 8507 final AttachInfo attachInfo = mAttachInfo; 8508 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 8509 8510 if (autoScale && scalingRequired) { 8511 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 8512 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 8513 } 8514 8515 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 8516 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 8517 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache; 8518 8519 if (width <= 0 || height <= 0 || 8520 // Projected bitmap size in bytes 8521 (width * height * (opaque && !use32BitCache ? 2 : 4) > 8522 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) { 8523 destroyDrawingCache(); 8524 return; 8525 } 8526 8527 boolean clear = true; 8528 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache; 8529 8530 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 8531 Bitmap.Config quality; 8532 if (!opaque) { 8533 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 8534 case DRAWING_CACHE_QUALITY_AUTO: 8535 quality = Bitmap.Config.ARGB_8888; 8536 break; 8537 case DRAWING_CACHE_QUALITY_LOW: 8538 quality = Bitmap.Config.ARGB_4444; 8539 break; 8540 case DRAWING_CACHE_QUALITY_HIGH: 8541 quality = Bitmap.Config.ARGB_8888; 8542 break; 8543 default: 8544 quality = Bitmap.Config.ARGB_8888; 8545 break; 8546 } 8547 } else { 8548 // Optimization for translucent windows 8549 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 8550 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 8551 } 8552 8553 // Try to cleanup memory 8554 if (bitmap != null) bitmap.recycle(); 8555 8556 try { 8557 bitmap = Bitmap.createBitmap(width, height, quality); 8558 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 8559 if (autoScale) { 8560 mDrawingCache = bitmap; 8561 } else { 8562 mUnscaledDrawingCache = bitmap; 8563 } 8564 if (opaque && use32BitCache) bitmap.setHasAlpha(false); 8565 } catch (OutOfMemoryError e) { 8566 // If there is not enough memory to create the bitmap cache, just 8567 // ignore the issue as bitmap caches are not required to draw the 8568 // view hierarchy 8569 if (autoScale) { 8570 mDrawingCache = null; 8571 } else { 8572 mUnscaledDrawingCache = null; 8573 } 8574 return; 8575 } 8576 8577 clear = drawingCacheBackgroundColor != 0; 8578 } 8579 8580 Canvas canvas; 8581 if (attachInfo != null) { 8582 canvas = attachInfo.mCanvas; 8583 if (canvas == null) { 8584 canvas = new Canvas(); 8585 } 8586 canvas.setBitmap(bitmap); 8587 // Temporarily clobber the cached Canvas in case one of our children 8588 // is also using a drawing cache. Without this, the children would 8589 // steal the canvas by attaching their own bitmap to it and bad, bad 8590 // thing would happen (invisible views, corrupted drawings, etc.) 8591 attachInfo.mCanvas = null; 8592 } else { 8593 // This case should hopefully never or seldom happen 8594 canvas = new Canvas(bitmap); 8595 } 8596 8597 if (clear) { 8598 bitmap.eraseColor(drawingCacheBackgroundColor); 8599 } 8600 8601 computeScroll(); 8602 final int restoreCount = canvas.save(); 8603 8604 if (autoScale && scalingRequired) { 8605 final float scale = attachInfo.mApplicationScale; 8606 canvas.scale(scale, scale); 8607 } 8608 8609 canvas.translate(-mScrollX, -mScrollY); 8610 8611 mPrivateFlags |= DRAWN; 8612 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated || 8613 mLayerType != LAYER_TYPE_NONE) { 8614 mPrivateFlags |= DRAWING_CACHE_VALID; 8615 } 8616 8617 // Fast path for layouts with no backgrounds 8618 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 8619 if (ViewDebug.TRACE_HIERARCHY) { 8620 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 8621 } 8622 mPrivateFlags &= ~DIRTY_MASK; 8623 dispatchDraw(canvas); 8624 } else { 8625 draw(canvas); 8626 } 8627 8628 canvas.restoreToCount(restoreCount); 8629 8630 if (attachInfo != null) { 8631 // Restore the cached Canvas for our siblings 8632 attachInfo.mCanvas = canvas; 8633 } 8634 } 8635 } 8636 8637 /** 8638 * Create a snapshot of the view into a bitmap. We should probably make 8639 * some form of this public, but should think about the API. 8640 */ 8641 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) { 8642 int width = mRight - mLeft; 8643 int height = mBottom - mTop; 8644 8645 final AttachInfo attachInfo = mAttachInfo; 8646 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 8647 width = (int) ((width * scale) + 0.5f); 8648 height = (int) ((height * scale) + 0.5f); 8649 8650 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality); 8651 if (bitmap == null) { 8652 throw new OutOfMemoryError(); 8653 } 8654 8655 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 8656 8657 Canvas canvas; 8658 if (attachInfo != null) { 8659 canvas = attachInfo.mCanvas; 8660 if (canvas == null) { 8661 canvas = new Canvas(); 8662 } 8663 canvas.setBitmap(bitmap); 8664 // Temporarily clobber the cached Canvas in case one of our children 8665 // is also using a drawing cache. Without this, the children would 8666 // steal the canvas by attaching their own bitmap to it and bad, bad 8667 // things would happen (invisible views, corrupted drawings, etc.) 8668 attachInfo.mCanvas = null; 8669 } else { 8670 // This case should hopefully never or seldom happen 8671 canvas = new Canvas(bitmap); 8672 } 8673 8674 if ((backgroundColor & 0xff000000) != 0) { 8675 bitmap.eraseColor(backgroundColor); 8676 } 8677 8678 computeScroll(); 8679 final int restoreCount = canvas.save(); 8680 canvas.scale(scale, scale); 8681 canvas.translate(-mScrollX, -mScrollY); 8682 8683 // Temporarily remove the dirty mask 8684 int flags = mPrivateFlags; 8685 mPrivateFlags &= ~DIRTY_MASK; 8686 8687 // Fast path for layouts with no backgrounds 8688 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 8689 dispatchDraw(canvas); 8690 } else { 8691 draw(canvas); 8692 } 8693 8694 mPrivateFlags = flags; 8695 8696 canvas.restoreToCount(restoreCount); 8697 8698 if (attachInfo != null) { 8699 // Restore the cached Canvas for our siblings 8700 attachInfo.mCanvas = canvas; 8701 } 8702 8703 return bitmap; 8704 } 8705 8706 /** 8707 * Indicates whether this View is currently in edit mode. A View is usually 8708 * in edit mode when displayed within a developer tool. For instance, if 8709 * this View is being drawn by a visual user interface builder, this method 8710 * should return true. 8711 * 8712 * Subclasses should check the return value of this method to provide 8713 * different behaviors if their normal behavior might interfere with the 8714 * host environment. For instance: the class spawns a thread in its 8715 * constructor, the drawing code relies on device-specific features, etc. 8716 * 8717 * This method is usually checked in the drawing code of custom widgets. 8718 * 8719 * @return True if this View is in edit mode, false otherwise. 8720 */ 8721 public boolean isInEditMode() { 8722 return false; 8723 } 8724 8725 /** 8726 * If the View draws content inside its padding and enables fading edges, 8727 * it needs to support padding offsets. Padding offsets are added to the 8728 * fading edges to extend the length of the fade so that it covers pixels 8729 * drawn inside the padding. 8730 * 8731 * Subclasses of this class should override this method if they need 8732 * to draw content inside the padding. 8733 * 8734 * @return True if padding offset must be applied, false otherwise. 8735 * 8736 * @see #getLeftPaddingOffset() 8737 * @see #getRightPaddingOffset() 8738 * @see #getTopPaddingOffset() 8739 * @see #getBottomPaddingOffset() 8740 * 8741 * @since CURRENT 8742 */ 8743 protected boolean isPaddingOffsetRequired() { 8744 return false; 8745 } 8746 8747 /** 8748 * Amount by which to extend the left fading region. Called only when 8749 * {@link #isPaddingOffsetRequired()} returns true. 8750 * 8751 * @return The left padding offset in pixels. 8752 * 8753 * @see #isPaddingOffsetRequired() 8754 * 8755 * @since CURRENT 8756 */ 8757 protected int getLeftPaddingOffset() { 8758 return 0; 8759 } 8760 8761 /** 8762 * Amount by which to extend the right fading region. Called only when 8763 * {@link #isPaddingOffsetRequired()} returns true. 8764 * 8765 * @return The right padding offset in pixels. 8766 * 8767 * @see #isPaddingOffsetRequired() 8768 * 8769 * @since CURRENT 8770 */ 8771 protected int getRightPaddingOffset() { 8772 return 0; 8773 } 8774 8775 /** 8776 * Amount by which to extend the top fading region. Called only when 8777 * {@link #isPaddingOffsetRequired()} returns true. 8778 * 8779 * @return The top padding offset in pixels. 8780 * 8781 * @see #isPaddingOffsetRequired() 8782 * 8783 * @since CURRENT 8784 */ 8785 protected int getTopPaddingOffset() { 8786 return 0; 8787 } 8788 8789 /** 8790 * Amount by which to extend the bottom fading region. Called only when 8791 * {@link #isPaddingOffsetRequired()} returns true. 8792 * 8793 * @return The bottom padding offset in pixels. 8794 * 8795 * @see #isPaddingOffsetRequired() 8796 * 8797 * @since CURRENT 8798 */ 8799 protected int getBottomPaddingOffset() { 8800 return 0; 8801 } 8802 8803 /** 8804 * <p>Indicates whether this view is attached to an hardware accelerated 8805 * window or not.</p> 8806 * 8807 * <p>Even if this method returns true, it does not mean that every call 8808 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware 8809 * accelerated {@link android.graphics.Canvas}. For instance, if this view 8810 * is drawn onto an offscren {@link android.graphics.Bitmap} and its 8811 * window is hardware accelerated, 8812 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely 8813 * return false, and this method will return true.</p> 8814 * 8815 * @return True if the view is attached to a window and the window is 8816 * hardware accelerated; false in any other case. 8817 */ 8818 public boolean isHardwareAccelerated() { 8819 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated; 8820 } 8821 8822 /** 8823 * Manually render this view (and all of its children) to the given Canvas. 8824 * The view must have already done a full layout before this function is 8825 * called. When implementing a view, implement {@link #onDraw} instead of 8826 * overriding this method. If you do need to override this method, call 8827 * the superclass version. 8828 * 8829 * @param canvas The Canvas to which the View is rendered. 8830 */ 8831 public void draw(Canvas canvas) { 8832 if (ViewDebug.TRACE_HIERARCHY) { 8833 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 8834 } 8835 8836 final int privateFlags = mPrivateFlags; 8837 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE && 8838 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 8839 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN; 8840 8841 /* 8842 * Draw traversal performs several drawing steps which must be executed 8843 * in the appropriate order: 8844 * 8845 * 1. Draw the background 8846 * 2. If necessary, save the canvas' layers to prepare for fading 8847 * 3. Draw view's content 8848 * 4. Draw children 8849 * 5. If necessary, draw the fading edges and restore layers 8850 * 6. Draw decorations (scrollbars for instance) 8851 */ 8852 8853 // Step 1, draw the background, if needed 8854 int saveCount; 8855 8856 if (!dirtyOpaque) { 8857 final Drawable background = mBGDrawable; 8858 if (background != null) { 8859 final int scrollX = mScrollX; 8860 final int scrollY = mScrollY; 8861 8862 if (mBackgroundSizeChanged) { 8863 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 8864 mBackgroundSizeChanged = false; 8865 } 8866 8867 if ((scrollX | scrollY) == 0) { 8868 background.draw(canvas); 8869 } else { 8870 canvas.translate(scrollX, scrollY); 8871 background.draw(canvas); 8872 canvas.translate(-scrollX, -scrollY); 8873 } 8874 } 8875 } 8876 8877 // skip step 2 & 5 if possible (common case) 8878 final int viewFlags = mViewFlags; 8879 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 8880 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 8881 if (!verticalEdges && !horizontalEdges) { 8882 // Step 3, draw the content 8883 if (!dirtyOpaque) onDraw(canvas); 8884 8885 // Step 4, draw the children 8886 dispatchDraw(canvas); 8887 8888 // Step 6, draw decorations (scrollbars) 8889 onDrawScrollBars(canvas); 8890 8891 // we're done... 8892 return; 8893 } 8894 8895 /* 8896 * Here we do the full fledged routine... 8897 * (this is an uncommon case where speed matters less, 8898 * this is why we repeat some of the tests that have been 8899 * done above) 8900 */ 8901 8902 boolean drawTop = false; 8903 boolean drawBottom = false; 8904 boolean drawLeft = false; 8905 boolean drawRight = false; 8906 8907 float topFadeStrength = 0.0f; 8908 float bottomFadeStrength = 0.0f; 8909 float leftFadeStrength = 0.0f; 8910 float rightFadeStrength = 0.0f; 8911 8912 // Step 2, save the canvas' layers 8913 int paddingLeft = mPaddingLeft; 8914 int paddingTop = mPaddingTop; 8915 8916 final boolean offsetRequired = isPaddingOffsetRequired(); 8917 if (offsetRequired) { 8918 paddingLeft += getLeftPaddingOffset(); 8919 paddingTop += getTopPaddingOffset(); 8920 } 8921 8922 int left = mScrollX + paddingLeft; 8923 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 8924 int top = mScrollY + paddingTop; 8925 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop; 8926 8927 if (offsetRequired) { 8928 right += getRightPaddingOffset(); 8929 bottom += getBottomPaddingOffset(); 8930 } 8931 8932 final ScrollabilityCache scrollabilityCache = mScrollCache; 8933 int length = scrollabilityCache.fadingEdgeLength; 8934 8935 // clip the fade length if top and bottom fades overlap 8936 // overlapping fades produce odd-looking artifacts 8937 if (verticalEdges && (top + length > bottom - length)) { 8938 length = (bottom - top) / 2; 8939 } 8940 8941 // also clip horizontal fades if necessary 8942 if (horizontalEdges && (left + length > right - length)) { 8943 length = (right - left) / 2; 8944 } 8945 8946 if (verticalEdges) { 8947 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 8948 drawTop = topFadeStrength > 0.0f; 8949 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 8950 drawBottom = bottomFadeStrength > 0.0f; 8951 } 8952 8953 if (horizontalEdges) { 8954 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 8955 drawLeft = leftFadeStrength > 0.0f; 8956 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 8957 drawRight = rightFadeStrength > 0.0f; 8958 } 8959 8960 saveCount = canvas.getSaveCount(); 8961 8962 int solidColor = getSolidColor(); 8963 if (solidColor == 0) { 8964 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 8965 8966 if (drawTop) { 8967 canvas.saveLayer(left, top, right, top + length, null, flags); 8968 } 8969 8970 if (drawBottom) { 8971 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 8972 } 8973 8974 if (drawLeft) { 8975 canvas.saveLayer(left, top, left + length, bottom, null, flags); 8976 } 8977 8978 if (drawRight) { 8979 canvas.saveLayer(right - length, top, right, bottom, null, flags); 8980 } 8981 } else { 8982 scrollabilityCache.setFadeColor(solidColor); 8983 } 8984 8985 // Step 3, draw the content 8986 if (!dirtyOpaque) onDraw(canvas); 8987 8988 // Step 4, draw the children 8989 dispatchDraw(canvas); 8990 8991 // Step 5, draw the fade effect and restore layers 8992 final Paint p = scrollabilityCache.paint; 8993 final Matrix matrix = scrollabilityCache.matrix; 8994 final Shader fade = scrollabilityCache.shader; 8995 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 8996 8997 if (drawTop) { 8998 matrix.setScale(1, fadeHeight * topFadeStrength); 8999 matrix.postTranslate(left, top); 9000 fade.setLocalMatrix(matrix); 9001 canvas.drawRect(left, top, right, top + length, p); 9002 } 9003 9004 if (drawBottom) { 9005 matrix.setScale(1, fadeHeight * bottomFadeStrength); 9006 matrix.postRotate(180); 9007 matrix.postTranslate(left, bottom); 9008 fade.setLocalMatrix(matrix); 9009 canvas.drawRect(left, bottom - length, right, bottom, p); 9010 } 9011 9012 if (drawLeft) { 9013 matrix.setScale(1, fadeHeight * leftFadeStrength); 9014 matrix.postRotate(-90); 9015 matrix.postTranslate(left, top); 9016 fade.setLocalMatrix(matrix); 9017 canvas.drawRect(left, top, left + length, bottom, p); 9018 } 9019 9020 if (drawRight) { 9021 matrix.setScale(1, fadeHeight * rightFadeStrength); 9022 matrix.postRotate(90); 9023 matrix.postTranslate(right, top); 9024 fade.setLocalMatrix(matrix); 9025 canvas.drawRect(right - length, top, right, bottom, p); 9026 } 9027 9028 canvas.restoreToCount(saveCount); 9029 9030 // Step 6, draw decorations (scrollbars) 9031 onDrawScrollBars(canvas); 9032 } 9033 9034 /** 9035 * Override this if your view is known to always be drawn on top of a solid color background, 9036 * and needs to draw fading edges. Returning a non-zero color enables the view system to 9037 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 9038 * should be set to 0xFF. 9039 * 9040 * @see #setVerticalFadingEdgeEnabled 9041 * @see #setHorizontalFadingEdgeEnabled 9042 * 9043 * @return The known solid color background for this view, or 0 if the color may vary 9044 */ 9045 public int getSolidColor() { 9046 return 0; 9047 } 9048 9049 /** 9050 * Build a human readable string representation of the specified view flags. 9051 * 9052 * @param flags the view flags to convert to a string 9053 * @return a String representing the supplied flags 9054 */ 9055 private static String printFlags(int flags) { 9056 String output = ""; 9057 int numFlags = 0; 9058 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 9059 output += "TAKES_FOCUS"; 9060 numFlags++; 9061 } 9062 9063 switch (flags & VISIBILITY_MASK) { 9064 case INVISIBLE: 9065 if (numFlags > 0) { 9066 output += " "; 9067 } 9068 output += "INVISIBLE"; 9069 // USELESS HERE numFlags++; 9070 break; 9071 case GONE: 9072 if (numFlags > 0) { 9073 output += " "; 9074 } 9075 output += "GONE"; 9076 // USELESS HERE numFlags++; 9077 break; 9078 default: 9079 break; 9080 } 9081 return output; 9082 } 9083 9084 /** 9085 * Build a human readable string representation of the specified private 9086 * view flags. 9087 * 9088 * @param privateFlags the private view flags to convert to a string 9089 * @return a String representing the supplied flags 9090 */ 9091 private static String printPrivateFlags(int privateFlags) { 9092 String output = ""; 9093 int numFlags = 0; 9094 9095 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) { 9096 output += "WANTS_FOCUS"; 9097 numFlags++; 9098 } 9099 9100 if ((privateFlags & FOCUSED) == FOCUSED) { 9101 if (numFlags > 0) { 9102 output += " "; 9103 } 9104 output += "FOCUSED"; 9105 numFlags++; 9106 } 9107 9108 if ((privateFlags & SELECTED) == SELECTED) { 9109 if (numFlags > 0) { 9110 output += " "; 9111 } 9112 output += "SELECTED"; 9113 numFlags++; 9114 } 9115 9116 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) { 9117 if (numFlags > 0) { 9118 output += " "; 9119 } 9120 output += "IS_ROOT_NAMESPACE"; 9121 numFlags++; 9122 } 9123 9124 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) { 9125 if (numFlags > 0) { 9126 output += " "; 9127 } 9128 output += "HAS_BOUNDS"; 9129 numFlags++; 9130 } 9131 9132 if ((privateFlags & DRAWN) == DRAWN) { 9133 if (numFlags > 0) { 9134 output += " "; 9135 } 9136 output += "DRAWN"; 9137 // USELESS HERE numFlags++; 9138 } 9139 return output; 9140 } 9141 9142 /** 9143 * <p>Indicates whether or not this view's layout will be requested during 9144 * the next hierarchy layout pass.</p> 9145 * 9146 * @return true if the layout will be forced during next layout pass 9147 */ 9148 public boolean isLayoutRequested() { 9149 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT; 9150 } 9151 9152 /** 9153 * Assign a size and position to a view and all of its 9154 * descendants 9155 * 9156 * <p>This is the second phase of the layout mechanism. 9157 * (The first is measuring). In this phase, each parent calls 9158 * layout on all of its children to position them. 9159 * This is typically done using the child measurements 9160 * that were stored in the measure pass().</p> 9161 * 9162 * <p>Derived classes should not override this method. 9163 * Derived classes with children should override 9164 * onLayout. In that method, they should 9165 * call layout on each of their children.</p> 9166 * 9167 * @param l Left position, relative to parent 9168 * @param t Top position, relative to parent 9169 * @param r Right position, relative to parent 9170 * @param b Bottom position, relative to parent 9171 */ 9172 @SuppressWarnings({"unchecked"}) 9173 public void layout(int l, int t, int r, int b) { 9174 int oldL = mLeft; 9175 int oldT = mTop; 9176 int oldB = mBottom; 9177 int oldR = mRight; 9178 boolean changed = setFrame(l, t, r, b); 9179 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) { 9180 if (ViewDebug.TRACE_HIERARCHY) { 9181 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT); 9182 } 9183 9184 onLayout(changed, l, t, r, b); 9185 mPrivateFlags &= ~LAYOUT_REQUIRED; 9186 9187 if (mOnLayoutChangeListeners != null) { 9188 ArrayList<OnLayoutChangeListener> listenersCopy = 9189 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone(); 9190 int numListeners = listenersCopy.size(); 9191 for (int i = 0; i < numListeners; ++i) { 9192 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB); 9193 } 9194 } 9195 } 9196 mPrivateFlags &= ~FORCE_LAYOUT; 9197 } 9198 9199 /** 9200 * Called from layout when this view should 9201 * assign a size and position to each of its children. 9202 * 9203 * Derived classes with children should override 9204 * this method and call layout on each of 9205 * their children. 9206 * @param changed This is a new size or position for this view 9207 * @param left Left position, relative to parent 9208 * @param top Top position, relative to parent 9209 * @param right Right position, relative to parent 9210 * @param bottom Bottom position, relative to parent 9211 */ 9212 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 9213 } 9214 9215 /** 9216 * Assign a size and position to this view. 9217 * 9218 * This is called from layout. 9219 * 9220 * @param left Left position, relative to parent 9221 * @param top Top position, relative to parent 9222 * @param right Right position, relative to parent 9223 * @param bottom Bottom position, relative to parent 9224 * @return true if the new size and position are different than the 9225 * previous ones 9226 * {@hide} 9227 */ 9228 protected boolean setFrame(int left, int top, int right, int bottom) { 9229 boolean changed = false; 9230 9231 if (DBG) { 9232 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 9233 + right + "," + bottom + ")"); 9234 } 9235 9236 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 9237 changed = true; 9238 9239 // Remember our drawn bit 9240 int drawn = mPrivateFlags & DRAWN; 9241 9242 // Invalidate our old position 9243 invalidate(true); 9244 9245 9246 int oldWidth = mRight - mLeft; 9247 int oldHeight = mBottom - mTop; 9248 9249 mLeft = left; 9250 mTop = top; 9251 mRight = right; 9252 mBottom = bottom; 9253 9254 mPrivateFlags |= HAS_BOUNDS; 9255 9256 int newWidth = right - left; 9257 int newHeight = bottom - top; 9258 9259 if (newWidth != oldWidth || newHeight != oldHeight) { 9260 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) { 9261 // A change in dimension means an auto-centered pivot point changes, too 9262 mMatrixDirty = true; 9263 } 9264 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 9265 } 9266 9267 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) { 9268 // If we are visible, force the DRAWN bit to on so that 9269 // this invalidate will go through (at least to our parent). 9270 // This is because someone may have invalidated this view 9271 // before this call to setFrame came in, thereby clearing 9272 // the DRAWN bit. 9273 mPrivateFlags |= DRAWN; 9274 invalidate(true); 9275 } 9276 9277 // Reset drawn bit to original value (invalidate turns it off) 9278 mPrivateFlags |= drawn; 9279 9280 mBackgroundSizeChanged = true; 9281 } 9282 return changed; 9283 } 9284 9285 /** 9286 * Finalize inflating a view from XML. This is called as the last phase 9287 * of inflation, after all child views have been added. 9288 * 9289 * <p>Even if the subclass overrides onFinishInflate, they should always be 9290 * sure to call the super method, so that we get called. 9291 */ 9292 protected void onFinishInflate() { 9293 } 9294 9295 /** 9296 * Returns the resources associated with this view. 9297 * 9298 * @return Resources object. 9299 */ 9300 public Resources getResources() { 9301 return mResources; 9302 } 9303 9304 /** 9305 * Invalidates the specified Drawable. 9306 * 9307 * @param drawable the drawable to invalidate 9308 */ 9309 public void invalidateDrawable(Drawable drawable) { 9310 if (verifyDrawable(drawable)) { 9311 final Rect dirty = drawable.getBounds(); 9312 final int scrollX = mScrollX; 9313 final int scrollY = mScrollY; 9314 9315 invalidate(dirty.left + scrollX, dirty.top + scrollY, 9316 dirty.right + scrollX, dirty.bottom + scrollY); 9317 } 9318 } 9319 9320 /** 9321 * Schedules an action on a drawable to occur at a specified time. 9322 * 9323 * @param who the recipient of the action 9324 * @param what the action to run on the drawable 9325 * @param when the time at which the action must occur. Uses the 9326 * {@link SystemClock#uptimeMillis} timebase. 9327 */ 9328 public void scheduleDrawable(Drawable who, Runnable what, long when) { 9329 if (verifyDrawable(who) && what != null && mAttachInfo != null) { 9330 mAttachInfo.mHandler.postAtTime(what, who, when); 9331 } 9332 } 9333 9334 /** 9335 * Cancels a scheduled action on a drawable. 9336 * 9337 * @param who the recipient of the action 9338 * @param what the action to cancel 9339 */ 9340 public void unscheduleDrawable(Drawable who, Runnable what) { 9341 if (verifyDrawable(who) && what != null && mAttachInfo != null) { 9342 mAttachInfo.mHandler.removeCallbacks(what, who); 9343 } 9344 } 9345 9346 /** 9347 * Unschedule any events associated with the given Drawable. This can be 9348 * used when selecting a new Drawable into a view, so that the previous 9349 * one is completely unscheduled. 9350 * 9351 * @param who The Drawable to unschedule. 9352 * 9353 * @see #drawableStateChanged 9354 */ 9355 public void unscheduleDrawable(Drawable who) { 9356 if (mAttachInfo != null) { 9357 mAttachInfo.mHandler.removeCallbacksAndMessages(who); 9358 } 9359 } 9360 9361 /** 9362 * If your view subclass is displaying its own Drawable objects, it should 9363 * override this function and return true for any Drawable it is 9364 * displaying. This allows animations for those drawables to be 9365 * scheduled. 9366 * 9367 * <p>Be sure to call through to the super class when overriding this 9368 * function. 9369 * 9370 * @param who The Drawable to verify. Return true if it is one you are 9371 * displaying, else return the result of calling through to the 9372 * super class. 9373 * 9374 * @return boolean If true than the Drawable is being displayed in the 9375 * view; else false and it is not allowed to animate. 9376 * 9377 * @see #unscheduleDrawable 9378 * @see #drawableStateChanged 9379 */ 9380 protected boolean verifyDrawable(Drawable who) { 9381 return who == mBGDrawable; 9382 } 9383 9384 /** 9385 * This function is called whenever the state of the view changes in such 9386 * a way that it impacts the state of drawables being shown. 9387 * 9388 * <p>Be sure to call through to the superclass when overriding this 9389 * function. 9390 * 9391 * @see Drawable#setState 9392 */ 9393 protected void drawableStateChanged() { 9394 Drawable d = mBGDrawable; 9395 if (d != null && d.isStateful()) { 9396 d.setState(getDrawableState()); 9397 } 9398 } 9399 9400 /** 9401 * Call this to force a view to update its drawable state. This will cause 9402 * drawableStateChanged to be called on this view. Views that are interested 9403 * in the new state should call getDrawableState. 9404 * 9405 * @see #drawableStateChanged 9406 * @see #getDrawableState 9407 */ 9408 public void refreshDrawableState() { 9409 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 9410 drawableStateChanged(); 9411 9412 ViewParent parent = mParent; 9413 if (parent != null) { 9414 parent.childDrawableStateChanged(this); 9415 } 9416 } 9417 9418 /** 9419 * Return an array of resource IDs of the drawable states representing the 9420 * current state of the view. 9421 * 9422 * @return The current drawable state 9423 * 9424 * @see Drawable#setState 9425 * @see #drawableStateChanged 9426 * @see #onCreateDrawableState 9427 */ 9428 public final int[] getDrawableState() { 9429 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) { 9430 return mDrawableState; 9431 } else { 9432 mDrawableState = onCreateDrawableState(0); 9433 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY; 9434 return mDrawableState; 9435 } 9436 } 9437 9438 /** 9439 * Generate the new {@link android.graphics.drawable.Drawable} state for 9440 * this view. This is called by the view 9441 * system when the cached Drawable state is determined to be invalid. To 9442 * retrieve the current state, you should use {@link #getDrawableState}. 9443 * 9444 * @param extraSpace if non-zero, this is the number of extra entries you 9445 * would like in the returned array in which you can place your own 9446 * states. 9447 * 9448 * @return Returns an array holding the current {@link Drawable} state of 9449 * the view. 9450 * 9451 * @see #mergeDrawableStates 9452 */ 9453 protected int[] onCreateDrawableState(int extraSpace) { 9454 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 9455 mParent instanceof View) { 9456 return ((View) mParent).onCreateDrawableState(extraSpace); 9457 } 9458 9459 int[] drawableState; 9460 9461 int privateFlags = mPrivateFlags; 9462 9463 int viewStateIndex = 0; 9464 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED; 9465 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED; 9466 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED; 9467 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED; 9468 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED; 9469 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED; 9470 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested) { 9471 // This is set if HW acceleration is requested, even if the current 9472 // process doesn't allow it. This is just to allow app preview 9473 // windows to better match their app. 9474 viewStateIndex |= VIEW_STATE_ACCELERATED; 9475 } 9476 9477 drawableState = VIEW_STATE_SETS[viewStateIndex]; 9478 9479 //noinspection ConstantIfStatement 9480 if (false) { 9481 Log.i("View", "drawableStateIndex=" + viewStateIndex); 9482 Log.i("View", toString() 9483 + " pressed=" + ((privateFlags & PRESSED) != 0) 9484 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 9485 + " fo=" + hasFocus() 9486 + " sl=" + ((privateFlags & SELECTED) != 0) 9487 + " wf=" + hasWindowFocus() 9488 + ": " + Arrays.toString(drawableState)); 9489 } 9490 9491 if (extraSpace == 0) { 9492 return drawableState; 9493 } 9494 9495 final int[] fullState; 9496 if (drawableState != null) { 9497 fullState = new int[drawableState.length + extraSpace]; 9498 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 9499 } else { 9500 fullState = new int[extraSpace]; 9501 } 9502 9503 return fullState; 9504 } 9505 9506 /** 9507 * Merge your own state values in <var>additionalState</var> into the base 9508 * state values <var>baseState</var> that were returned by 9509 * {@link #onCreateDrawableState}. 9510 * 9511 * @param baseState The base state values returned by 9512 * {@link #onCreateDrawableState}, which will be modified to also hold your 9513 * own additional state values. 9514 * 9515 * @param additionalState The additional state values you would like 9516 * added to <var>baseState</var>; this array is not modified. 9517 * 9518 * @return As a convenience, the <var>baseState</var> array you originally 9519 * passed into the function is returned. 9520 * 9521 * @see #onCreateDrawableState 9522 */ 9523 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 9524 final int N = baseState.length; 9525 int i = N - 1; 9526 while (i >= 0 && baseState[i] == 0) { 9527 i--; 9528 } 9529 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 9530 return baseState; 9531 } 9532 9533 /** 9534 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()} 9535 * on all Drawable objects associated with this view. 9536 */ 9537 public void jumpDrawablesToCurrentState() { 9538 if (mBGDrawable != null) { 9539 mBGDrawable.jumpToCurrentState(); 9540 } 9541 } 9542 9543 /** 9544 * Sets the background color for this view. 9545 * @param color the color of the background 9546 */ 9547 @RemotableViewMethod 9548 public void setBackgroundColor(int color) { 9549 if (mBGDrawable instanceof ColorDrawable) { 9550 ((ColorDrawable) mBGDrawable).setColor(color); 9551 } else { 9552 setBackgroundDrawable(new ColorDrawable(color)); 9553 } 9554 } 9555 9556 /** 9557 * Set the background to a given resource. The resource should refer to 9558 * a Drawable object or 0 to remove the background. 9559 * @param resid The identifier of the resource. 9560 * @attr ref android.R.styleable#View_background 9561 */ 9562 @RemotableViewMethod 9563 public void setBackgroundResource(int resid) { 9564 if (resid != 0 && resid == mBackgroundResource) { 9565 return; 9566 } 9567 9568 Drawable d= null; 9569 if (resid != 0) { 9570 d = mResources.getDrawable(resid); 9571 } 9572 setBackgroundDrawable(d); 9573 9574 mBackgroundResource = resid; 9575 } 9576 9577 /** 9578 * Set the background to a given Drawable, or remove the background. If the 9579 * background has padding, this View's padding is set to the background's 9580 * padding. However, when a background is removed, this View's padding isn't 9581 * touched. If setting the padding is desired, please use 9582 * {@link #setPadding(int, int, int, int)}. 9583 * 9584 * @param d The Drawable to use as the background, or null to remove the 9585 * background 9586 */ 9587 public void setBackgroundDrawable(Drawable d) { 9588 boolean requestLayout = false; 9589 9590 mBackgroundResource = 0; 9591 9592 /* 9593 * Regardless of whether we're setting a new background or not, we want 9594 * to clear the previous drawable. 9595 */ 9596 if (mBGDrawable != null) { 9597 mBGDrawable.setCallback(null); 9598 unscheduleDrawable(mBGDrawable); 9599 } 9600 9601 if (d != null) { 9602 Rect padding = sThreadLocal.get(); 9603 if (padding == null) { 9604 padding = new Rect(); 9605 sThreadLocal.set(padding); 9606 } 9607 if (d.getPadding(padding)) { 9608 setPadding(padding.left, padding.top, padding.right, padding.bottom); 9609 } 9610 9611 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 9612 // if it has a different minimum size, we should layout again 9613 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() || 9614 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) { 9615 requestLayout = true; 9616 } 9617 9618 d.setCallback(this); 9619 if (d.isStateful()) { 9620 d.setState(getDrawableState()); 9621 } 9622 d.setVisible(getVisibility() == VISIBLE, false); 9623 mBGDrawable = d; 9624 9625 if ((mPrivateFlags & SKIP_DRAW) != 0) { 9626 mPrivateFlags &= ~SKIP_DRAW; 9627 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 9628 requestLayout = true; 9629 } 9630 } else { 9631 /* Remove the background */ 9632 mBGDrawable = null; 9633 9634 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) { 9635 /* 9636 * This view ONLY drew the background before and we're removing 9637 * the background, so now it won't draw anything 9638 * (hence we SKIP_DRAW) 9639 */ 9640 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND; 9641 mPrivateFlags |= SKIP_DRAW; 9642 } 9643 9644 /* 9645 * When the background is set, we try to apply its padding to this 9646 * View. When the background is removed, we don't touch this View's 9647 * padding. This is noted in the Javadocs. Hence, we don't need to 9648 * requestLayout(), the invalidate() below is sufficient. 9649 */ 9650 9651 // The old background's minimum size could have affected this 9652 // View's layout, so let's requestLayout 9653 requestLayout = true; 9654 } 9655 9656 computeOpaqueFlags(); 9657 9658 if (requestLayout) { 9659 requestLayout(); 9660 } 9661 9662 mBackgroundSizeChanged = true; 9663 invalidate(true); 9664 } 9665 9666 /** 9667 * Gets the background drawable 9668 * @return The drawable used as the background for this view, if any. 9669 */ 9670 public Drawable getBackground() { 9671 return mBGDrawable; 9672 } 9673 9674 /** 9675 * Sets the padding. The view may add on the space required to display 9676 * the scrollbars, depending on the style and visibility of the scrollbars. 9677 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 9678 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 9679 * from the values set in this call. 9680 * 9681 * @attr ref android.R.styleable#View_padding 9682 * @attr ref android.R.styleable#View_paddingBottom 9683 * @attr ref android.R.styleable#View_paddingLeft 9684 * @attr ref android.R.styleable#View_paddingRight 9685 * @attr ref android.R.styleable#View_paddingTop 9686 * @param left the left padding in pixels 9687 * @param top the top padding in pixels 9688 * @param right the right padding in pixels 9689 * @param bottom the bottom padding in pixels 9690 */ 9691 public void setPadding(int left, int top, int right, int bottom) { 9692 boolean changed = false; 9693 9694 mUserPaddingLeft = left; 9695 mUserPaddingRight = right; 9696 mUserPaddingBottom = bottom; 9697 9698 final int viewFlags = mViewFlags; 9699 9700 // Common case is there are no scroll bars. 9701 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 9702 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 9703 // TODO Determine what to do with SCROLLBAR_POSITION_DEFAULT based on RTL settings. 9704 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0 9705 ? 0 : getVerticalScrollbarWidth(); 9706 switch (mVerticalScrollbarPosition) { 9707 case SCROLLBAR_POSITION_DEFAULT: 9708 case SCROLLBAR_POSITION_RIGHT: 9709 right += offset; 9710 break; 9711 case SCROLLBAR_POSITION_LEFT: 9712 left += offset; 9713 break; 9714 } 9715 } 9716 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) { 9717 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 9718 ? 0 : getHorizontalScrollbarHeight(); 9719 } 9720 } 9721 9722 if (mPaddingLeft != left) { 9723 changed = true; 9724 mPaddingLeft = left; 9725 } 9726 if (mPaddingTop != top) { 9727 changed = true; 9728 mPaddingTop = top; 9729 } 9730 if (mPaddingRight != right) { 9731 changed = true; 9732 mPaddingRight = right; 9733 } 9734 if (mPaddingBottom != bottom) { 9735 changed = true; 9736 mPaddingBottom = bottom; 9737 } 9738 9739 if (changed) { 9740 requestLayout(); 9741 } 9742 } 9743 9744 /** 9745 * Returns the top padding of this view. 9746 * 9747 * @return the top padding in pixels 9748 */ 9749 public int getPaddingTop() { 9750 return mPaddingTop; 9751 } 9752 9753 /** 9754 * Returns the bottom padding of this view. If there are inset and enabled 9755 * scrollbars, this value may include the space required to display the 9756 * scrollbars as well. 9757 * 9758 * @return the bottom padding in pixels 9759 */ 9760 public int getPaddingBottom() { 9761 return mPaddingBottom; 9762 } 9763 9764 /** 9765 * Returns the left padding of this view. If there are inset and enabled 9766 * scrollbars, this value may include the space required to display the 9767 * scrollbars as well. 9768 * 9769 * @return the left padding in pixels 9770 */ 9771 public int getPaddingLeft() { 9772 return mPaddingLeft; 9773 } 9774 9775 /** 9776 * Returns the right padding of this view. If there are inset and enabled 9777 * scrollbars, this value may include the space required to display the 9778 * scrollbars as well. 9779 * 9780 * @return the right padding in pixels 9781 */ 9782 public int getPaddingRight() { 9783 return mPaddingRight; 9784 } 9785 9786 /** 9787 * Changes the selection state of this view. A view can be selected or not. 9788 * Note that selection is not the same as focus. Views are typically 9789 * selected in the context of an AdapterView like ListView or GridView; 9790 * the selected view is the view that is highlighted. 9791 * 9792 * @param selected true if the view must be selected, false otherwise 9793 */ 9794 public void setSelected(boolean selected) { 9795 if (((mPrivateFlags & SELECTED) != 0) != selected) { 9796 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0); 9797 if (!selected) resetPressedState(); 9798 invalidate(true); 9799 refreshDrawableState(); 9800 dispatchSetSelected(selected); 9801 } 9802 } 9803 9804 /** 9805 * Dispatch setSelected to all of this View's children. 9806 * 9807 * @see #setSelected(boolean) 9808 * 9809 * @param selected The new selected state 9810 */ 9811 protected void dispatchSetSelected(boolean selected) { 9812 } 9813 9814 /** 9815 * Indicates the selection state of this view. 9816 * 9817 * @return true if the view is selected, false otherwise 9818 */ 9819 @ViewDebug.ExportedProperty 9820 public boolean isSelected() { 9821 return (mPrivateFlags & SELECTED) != 0; 9822 } 9823 9824 /** 9825 * Changes the activated state of this view. A view can be activated or not. 9826 * Note that activation is not the same as selection. Selection is 9827 * a transient property, representing the view (hierarchy) the user is 9828 * currently interacting with. Activation is a longer-term state that the 9829 * user can move views in and out of. For example, in a list view with 9830 * single or multiple selection enabled, the views in the current selection 9831 * set are activated. (Um, yeah, we are deeply sorry about the terminology 9832 * here.) The activated state is propagated down to children of the view it 9833 * is set on. 9834 * 9835 * @param activated true if the view must be activated, false otherwise 9836 */ 9837 public void setActivated(boolean activated) { 9838 if (((mPrivateFlags & ACTIVATED) != 0) != activated) { 9839 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0); 9840 invalidate(true); 9841 refreshDrawableState(); 9842 dispatchSetActivated(activated); 9843 } 9844 } 9845 9846 /** 9847 * Dispatch setActivated to all of this View's children. 9848 * 9849 * @see #setActivated(boolean) 9850 * 9851 * @param activated The new activated state 9852 */ 9853 protected void dispatchSetActivated(boolean activated) { 9854 } 9855 9856 /** 9857 * Indicates the activation state of this view. 9858 * 9859 * @return true if the view is activated, false otherwise 9860 */ 9861 @ViewDebug.ExportedProperty 9862 public boolean isActivated() { 9863 return (mPrivateFlags & ACTIVATED) != 0; 9864 } 9865 9866 /** 9867 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 9868 * observer can be used to get notifications when global events, like 9869 * layout, happen. 9870 * 9871 * The returned ViewTreeObserver observer is not guaranteed to remain 9872 * valid for the lifetime of this View. If the caller of this method keeps 9873 * a long-lived reference to ViewTreeObserver, it should always check for 9874 * the return value of {@link ViewTreeObserver#isAlive()}. 9875 * 9876 * @return The ViewTreeObserver for this view's hierarchy. 9877 */ 9878 public ViewTreeObserver getViewTreeObserver() { 9879 if (mAttachInfo != null) { 9880 return mAttachInfo.mTreeObserver; 9881 } 9882 if (mFloatingTreeObserver == null) { 9883 mFloatingTreeObserver = new ViewTreeObserver(); 9884 } 9885 return mFloatingTreeObserver; 9886 } 9887 9888 /** 9889 * <p>Finds the topmost view in the current view hierarchy.</p> 9890 * 9891 * @return the topmost view containing this view 9892 */ 9893 public View getRootView() { 9894 if (mAttachInfo != null) { 9895 final View v = mAttachInfo.mRootView; 9896 if (v != null) { 9897 return v; 9898 } 9899 } 9900 9901 View parent = this; 9902 9903 while (parent.mParent != null && parent.mParent instanceof View) { 9904 parent = (View) parent.mParent; 9905 } 9906 9907 return parent; 9908 } 9909 9910 /** 9911 * <p>Computes the coordinates of this view on the screen. The argument 9912 * must be an array of two integers. After the method returns, the array 9913 * contains the x and y location in that order.</p> 9914 * 9915 * @param location an array of two integers in which to hold the coordinates 9916 */ 9917 public void getLocationOnScreen(int[] location) { 9918 getLocationInWindow(location); 9919 9920 final AttachInfo info = mAttachInfo; 9921 if (info != null) { 9922 location[0] += info.mWindowLeft; 9923 location[1] += info.mWindowTop; 9924 } 9925 } 9926 9927 /** 9928 * <p>Computes the coordinates of this view in its window. The argument 9929 * must be an array of two integers. After the method returns, the array 9930 * contains the x and y location in that order.</p> 9931 * 9932 * @param location an array of two integers in which to hold the coordinates 9933 */ 9934 public void getLocationInWindow(int[] location) { 9935 if (location == null || location.length < 2) { 9936 throw new IllegalArgumentException("location must be an array of " 9937 + "two integers"); 9938 } 9939 9940 location[0] = mLeft + (int) (mTranslationX + 0.5f); 9941 location[1] = mTop + (int) (mTranslationY + 0.5f); 9942 9943 ViewParent viewParent = mParent; 9944 while (viewParent instanceof View) { 9945 final View view = (View)viewParent; 9946 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX; 9947 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY; 9948 viewParent = view.mParent; 9949 } 9950 9951 if (viewParent instanceof ViewRoot) { 9952 // *cough* 9953 final ViewRoot vr = (ViewRoot)viewParent; 9954 location[1] -= vr.mCurScrollY; 9955 } 9956 } 9957 9958 /** 9959 * {@hide} 9960 * @param id the id of the view to be found 9961 * @return the view of the specified id, null if cannot be found 9962 */ 9963 protected View findViewTraversal(int id) { 9964 if (id == mID) { 9965 return this; 9966 } 9967 return null; 9968 } 9969 9970 /** 9971 * {@hide} 9972 * @param tag the tag of the view to be found 9973 * @return the view of specified tag, null if cannot be found 9974 */ 9975 protected View findViewWithTagTraversal(Object tag) { 9976 if (tag != null && tag.equals(mTag)) { 9977 return this; 9978 } 9979 return null; 9980 } 9981 9982 /** 9983 * {@hide} 9984 * @param predicate The predicate to evaluate. 9985 * @return The first view that matches the predicate or null. 9986 */ 9987 protected View findViewByPredicateTraversal(Predicate<View> predicate) { 9988 if (predicate.apply(this)) { 9989 return this; 9990 } 9991 return null; 9992 } 9993 9994 /** 9995 * Look for a child view with the given id. If this view has the given 9996 * id, return this view. 9997 * 9998 * @param id The id to search for. 9999 * @return The view that has the given id in the hierarchy or null 10000 */ 10001 public final View findViewById(int id) { 10002 if (id < 0) { 10003 return null; 10004 } 10005 return findViewTraversal(id); 10006 } 10007 10008 /** 10009 * Look for a child view with the given tag. If this view has the given 10010 * tag, return this view. 10011 * 10012 * @param tag The tag to search for, using "tag.equals(getTag())". 10013 * @return The View that has the given tag in the hierarchy or null 10014 */ 10015 public final View findViewWithTag(Object tag) { 10016 if (tag == null) { 10017 return null; 10018 } 10019 return findViewWithTagTraversal(tag); 10020 } 10021 10022 /** 10023 * {@hide} 10024 * Look for a child view that matches the specified predicate. 10025 * If this view matches the predicate, return this view. 10026 * 10027 * @param predicate The predicate to evaluate. 10028 * @return The first view that matches the predicate or null. 10029 */ 10030 public final View findViewByPredicate(Predicate<View> predicate) { 10031 return findViewByPredicateTraversal(predicate); 10032 } 10033 10034 /** 10035 * Sets the identifier for this view. The identifier does not have to be 10036 * unique in this view's hierarchy. The identifier should be a positive 10037 * number. 10038 * 10039 * @see #NO_ID 10040 * @see #getId 10041 * @see #findViewById 10042 * 10043 * @param id a number used to identify the view 10044 * 10045 * @attr ref android.R.styleable#View_id 10046 */ 10047 public void setId(int id) { 10048 mID = id; 10049 } 10050 10051 /** 10052 * {@hide} 10053 * 10054 * @param isRoot true if the view belongs to the root namespace, false 10055 * otherwise 10056 */ 10057 public void setIsRootNamespace(boolean isRoot) { 10058 if (isRoot) { 10059 mPrivateFlags |= IS_ROOT_NAMESPACE; 10060 } else { 10061 mPrivateFlags &= ~IS_ROOT_NAMESPACE; 10062 } 10063 } 10064 10065 /** 10066 * {@hide} 10067 * 10068 * @return true if the view belongs to the root namespace, false otherwise 10069 */ 10070 public boolean isRootNamespace() { 10071 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0; 10072 } 10073 10074 /** 10075 * Returns this view's identifier. 10076 * 10077 * @return a positive integer used to identify the view or {@link #NO_ID} 10078 * if the view has no ID 10079 * 10080 * @see #setId 10081 * @see #findViewById 10082 * @attr ref android.R.styleable#View_id 10083 */ 10084 @ViewDebug.CapturedViewProperty 10085 public int getId() { 10086 return mID; 10087 } 10088 10089 /** 10090 * Returns this view's tag. 10091 * 10092 * @return the Object stored in this view as a tag 10093 * 10094 * @see #setTag(Object) 10095 * @see #getTag(int) 10096 */ 10097 @ViewDebug.ExportedProperty 10098 public Object getTag() { 10099 return mTag; 10100 } 10101 10102 /** 10103 * Sets the tag associated with this view. A tag can be used to mark 10104 * a view in its hierarchy and does not have to be unique within the 10105 * hierarchy. Tags can also be used to store data within a view without 10106 * resorting to another data structure. 10107 * 10108 * @param tag an Object to tag the view with 10109 * 10110 * @see #getTag() 10111 * @see #setTag(int, Object) 10112 */ 10113 public void setTag(final Object tag) { 10114 mTag = tag; 10115 } 10116 10117 /** 10118 * Returns the tag associated with this view and the specified key. 10119 * 10120 * @param key The key identifying the tag 10121 * 10122 * @return the Object stored in this view as a tag 10123 * 10124 * @see #setTag(int, Object) 10125 * @see #getTag() 10126 */ 10127 public Object getTag(int key) { 10128 SparseArray<Object> tags = null; 10129 synchronized (sTagsLock) { 10130 if (sTags != null) { 10131 tags = sTags.get(this); 10132 } 10133 } 10134 10135 if (tags != null) return tags.get(key); 10136 return null; 10137 } 10138 10139 /** 10140 * Sets a tag associated with this view and a key. A tag can be used 10141 * to mark a view in its hierarchy and does not have to be unique within 10142 * the hierarchy. Tags can also be used to store data within a view 10143 * without resorting to another data structure. 10144 * 10145 * The specified key should be an id declared in the resources of the 10146 * application to ensure it is unique (see the <a 10147 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>). 10148 * Keys identified as belonging to 10149 * the Android framework or not associated with any package will cause 10150 * an {@link IllegalArgumentException} to be thrown. 10151 * 10152 * @param key The key identifying the tag 10153 * @param tag An Object to tag the view with 10154 * 10155 * @throws IllegalArgumentException If they specified key is not valid 10156 * 10157 * @see #setTag(Object) 10158 * @see #getTag(int) 10159 */ 10160 public void setTag(int key, final Object tag) { 10161 // If the package id is 0x00 or 0x01, it's either an undefined package 10162 // or a framework id 10163 if ((key >>> 24) < 2) { 10164 throw new IllegalArgumentException("The key must be an application-specific " 10165 + "resource id."); 10166 } 10167 10168 setTagInternal(this, key, tag); 10169 } 10170 10171 /** 10172 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 10173 * framework id. 10174 * 10175 * @hide 10176 */ 10177 public void setTagInternal(int key, Object tag) { 10178 if ((key >>> 24) != 0x1) { 10179 throw new IllegalArgumentException("The key must be a framework-specific " 10180 + "resource id."); 10181 } 10182 10183 setTagInternal(this, key, tag); 10184 } 10185 10186 private static void setTagInternal(View view, int key, Object tag) { 10187 SparseArray<Object> tags = null; 10188 synchronized (sTagsLock) { 10189 if (sTags == null) { 10190 sTags = new WeakHashMap<View, SparseArray<Object>>(); 10191 } else { 10192 tags = sTags.get(view); 10193 } 10194 } 10195 10196 if (tags == null) { 10197 tags = new SparseArray<Object>(2); 10198 synchronized (sTagsLock) { 10199 sTags.put(view, tags); 10200 } 10201 } 10202 10203 tags.put(key, tag); 10204 } 10205 10206 /** 10207 * @param consistency The type of consistency. See ViewDebug for more information. 10208 * 10209 * @hide 10210 */ 10211 protected boolean dispatchConsistencyCheck(int consistency) { 10212 return onConsistencyCheck(consistency); 10213 } 10214 10215 /** 10216 * Method that subclasses should implement to check their consistency. The type of 10217 * consistency check is indicated by the bit field passed as a parameter. 10218 * 10219 * @param consistency The type of consistency. See ViewDebug for more information. 10220 * 10221 * @throws IllegalStateException if the view is in an inconsistent state. 10222 * 10223 * @hide 10224 */ 10225 protected boolean onConsistencyCheck(int consistency) { 10226 boolean result = true; 10227 10228 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0; 10229 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0; 10230 10231 if (checkLayout) { 10232 if (getParent() == null) { 10233 result = false; 10234 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 10235 "View " + this + " does not have a parent."); 10236 } 10237 10238 if (mAttachInfo == null) { 10239 result = false; 10240 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 10241 "View " + this + " is not attached to a window."); 10242 } 10243 } 10244 10245 if (checkDrawing) { 10246 // Do not check the DIRTY/DRAWN flags because views can call invalidate() 10247 // from their draw() method 10248 10249 if ((mPrivateFlags & DRAWN) != DRAWN && 10250 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) { 10251 result = false; 10252 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 10253 "View " + this + " was invalidated but its drawing cache is valid."); 10254 } 10255 } 10256 10257 return result; 10258 } 10259 10260 /** 10261 * Prints information about this view in the log output, with the tag 10262 * {@link #VIEW_LOG_TAG}. 10263 * 10264 * @hide 10265 */ 10266 public void debug() { 10267 debug(0); 10268 } 10269 10270 /** 10271 * Prints information about this view in the log output, with the tag 10272 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 10273 * indentation defined by the <code>depth</code>. 10274 * 10275 * @param depth the indentation level 10276 * 10277 * @hide 10278 */ 10279 protected void debug(int depth) { 10280 String output = debugIndent(depth - 1); 10281 10282 output += "+ " + this; 10283 int id = getId(); 10284 if (id != -1) { 10285 output += " (id=" + id + ")"; 10286 } 10287 Object tag = getTag(); 10288 if (tag != null) { 10289 output += " (tag=" + tag + ")"; 10290 } 10291 Log.d(VIEW_LOG_TAG, output); 10292 10293 if ((mPrivateFlags & FOCUSED) != 0) { 10294 output = debugIndent(depth) + " FOCUSED"; 10295 Log.d(VIEW_LOG_TAG, output); 10296 } 10297 10298 output = debugIndent(depth); 10299 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 10300 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 10301 + "} "; 10302 Log.d(VIEW_LOG_TAG, output); 10303 10304 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 10305 || mPaddingBottom != 0) { 10306 output = debugIndent(depth); 10307 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 10308 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 10309 Log.d(VIEW_LOG_TAG, output); 10310 } 10311 10312 output = debugIndent(depth); 10313 output += "mMeasureWidth=" + mMeasuredWidth + 10314 " mMeasureHeight=" + mMeasuredHeight; 10315 Log.d(VIEW_LOG_TAG, output); 10316 10317 output = debugIndent(depth); 10318 if (mLayoutParams == null) { 10319 output += "BAD! no layout params"; 10320 } else { 10321 output = mLayoutParams.debug(output); 10322 } 10323 Log.d(VIEW_LOG_TAG, output); 10324 10325 output = debugIndent(depth); 10326 output += "flags={"; 10327 output += View.printFlags(mViewFlags); 10328 output += "}"; 10329 Log.d(VIEW_LOG_TAG, output); 10330 10331 output = debugIndent(depth); 10332 output += "privateFlags={"; 10333 output += View.printPrivateFlags(mPrivateFlags); 10334 output += "}"; 10335 Log.d(VIEW_LOG_TAG, output); 10336 } 10337 10338 /** 10339 * Creates an string of whitespaces used for indentation. 10340 * 10341 * @param depth the indentation level 10342 * @return a String containing (depth * 2 + 3) * 2 white spaces 10343 * 10344 * @hide 10345 */ 10346 protected static String debugIndent(int depth) { 10347 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 10348 for (int i = 0; i < (depth * 2) + 3; i++) { 10349 spaces.append(' ').append(' '); 10350 } 10351 return spaces.toString(); 10352 } 10353 10354 /** 10355 * <p>Return the offset of the widget's text baseline from the widget's top 10356 * boundary. If this widget does not support baseline alignment, this 10357 * method returns -1. </p> 10358 * 10359 * @return the offset of the baseline within the widget's bounds or -1 10360 * if baseline alignment is not supported 10361 */ 10362 @ViewDebug.ExportedProperty(category = "layout") 10363 public int getBaseline() { 10364 return -1; 10365 } 10366 10367 /** 10368 * Call this when something has changed which has invalidated the 10369 * layout of this view. This will schedule a layout pass of the view 10370 * tree. 10371 */ 10372 public void requestLayout() { 10373 if (ViewDebug.TRACE_HIERARCHY) { 10374 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT); 10375 } 10376 10377 mPrivateFlags |= FORCE_LAYOUT; 10378 mPrivateFlags |= INVALIDATED; 10379 10380 if (mParent != null && !mParent.isLayoutRequested()) { 10381 mParent.requestLayout(); 10382 } 10383 } 10384 10385 /** 10386 * Forces this view to be laid out during the next layout pass. 10387 * This method does not call requestLayout() or forceLayout() 10388 * on the parent. 10389 */ 10390 public void forceLayout() { 10391 mPrivateFlags |= FORCE_LAYOUT; 10392 mPrivateFlags |= INVALIDATED; 10393 } 10394 10395 /** 10396 * <p> 10397 * This is called to find out how big a view should be. The parent 10398 * supplies constraint information in the width and height parameters. 10399 * </p> 10400 * 10401 * <p> 10402 * The actual mesurement work of a view is performed in 10403 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 10404 * {@link #onMeasure(int, int)} can and must be overriden by subclasses. 10405 * </p> 10406 * 10407 * 10408 * @param widthMeasureSpec Horizontal space requirements as imposed by the 10409 * parent 10410 * @param heightMeasureSpec Vertical space requirements as imposed by the 10411 * parent 10412 * 10413 * @see #onMeasure(int, int) 10414 */ 10415 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 10416 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT || 10417 widthMeasureSpec != mOldWidthMeasureSpec || 10418 heightMeasureSpec != mOldHeightMeasureSpec) { 10419 10420 // first clears the measured dimension flag 10421 mPrivateFlags &= ~MEASURED_DIMENSION_SET; 10422 10423 if (ViewDebug.TRACE_HIERARCHY) { 10424 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE); 10425 } 10426 10427 // measure ourselves, this should set the measured dimension flag back 10428 onMeasure(widthMeasureSpec, heightMeasureSpec); 10429 10430 // flag not set, setMeasuredDimension() was not invoked, we raise 10431 // an exception to warn the developer 10432 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) { 10433 throw new IllegalStateException("onMeasure() did not set the" 10434 + " measured dimension by calling" 10435 + " setMeasuredDimension()"); 10436 } 10437 10438 mPrivateFlags |= LAYOUT_REQUIRED; 10439 } 10440 10441 mOldWidthMeasureSpec = widthMeasureSpec; 10442 mOldHeightMeasureSpec = heightMeasureSpec; 10443 } 10444 10445 /** 10446 * <p> 10447 * Measure the view and its content to determine the measured width and the 10448 * measured height. This method is invoked by {@link #measure(int, int)} and 10449 * should be overriden by subclasses to provide accurate and efficient 10450 * measurement of their contents. 10451 * </p> 10452 * 10453 * <p> 10454 * <strong>CONTRACT:</strong> When overriding this method, you 10455 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 10456 * measured width and height of this view. Failure to do so will trigger an 10457 * <code>IllegalStateException</code>, thrown by 10458 * {@link #measure(int, int)}. Calling the superclass' 10459 * {@link #onMeasure(int, int)} is a valid use. 10460 * </p> 10461 * 10462 * <p> 10463 * The base class implementation of measure defaults to the background size, 10464 * unless a larger size is allowed by the MeasureSpec. Subclasses should 10465 * override {@link #onMeasure(int, int)} to provide better measurements of 10466 * their content. 10467 * </p> 10468 * 10469 * <p> 10470 * If this method is overridden, it is the subclass's responsibility to make 10471 * sure the measured height and width are at least the view's minimum height 10472 * and width ({@link #getSuggestedMinimumHeight()} and 10473 * {@link #getSuggestedMinimumWidth()}). 10474 * </p> 10475 * 10476 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 10477 * The requirements are encoded with 10478 * {@link android.view.View.MeasureSpec}. 10479 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 10480 * The requirements are encoded with 10481 * {@link android.view.View.MeasureSpec}. 10482 * 10483 * @see #getMeasuredWidth() 10484 * @see #getMeasuredHeight() 10485 * @see #setMeasuredDimension(int, int) 10486 * @see #getSuggestedMinimumHeight() 10487 * @see #getSuggestedMinimumWidth() 10488 * @see android.view.View.MeasureSpec#getMode(int) 10489 * @see android.view.View.MeasureSpec#getSize(int) 10490 */ 10491 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 10492 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 10493 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 10494 } 10495 10496 /** 10497 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the 10498 * measured width and measured height. Failing to do so will trigger an 10499 * exception at measurement time.</p> 10500 * 10501 * @param measuredWidth The measured width of this view. May be a complex 10502 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 10503 * {@link #MEASURED_STATE_TOO_SMALL}. 10504 * @param measuredHeight The measured height of this view. May be a complex 10505 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and 10506 * {@link #MEASURED_STATE_TOO_SMALL}. 10507 */ 10508 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 10509 mMeasuredWidth = measuredWidth; 10510 mMeasuredHeight = measuredHeight; 10511 10512 mPrivateFlags |= MEASURED_DIMENSION_SET; 10513 } 10514 10515 /** 10516 * Merge two states as returned by {@link #getMeasuredState()}. 10517 * @param curState The current state as returned from a view or the result 10518 * of combining multiple views. 10519 * @param newState The new view state to combine. 10520 * @return Returns a new integer reflecting the combination of the two 10521 * states. 10522 */ 10523 public static int combineMeasuredStates(int curState, int newState) { 10524 return curState | newState; 10525 } 10526 10527 /** 10528 * Version of {@link #resolveSizeAndState(int, int, int)} 10529 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result. 10530 */ 10531 public static int resolveSize(int size, int measureSpec) { 10532 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK; 10533 } 10534 10535 /** 10536 * Utility to reconcile a desired size and state, with constraints imposed 10537 * by a MeasureSpec. Will take the desired size, unless a different size 10538 * is imposed by the constraints. The returned value is a compound integer, 10539 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and 10540 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting 10541 * size is smaller than the size the view wants to be. 10542 * 10543 * @param size How big the view wants to be 10544 * @param measureSpec Constraints imposed by the parent 10545 * @return Size information bit mask as defined by 10546 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}. 10547 */ 10548 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) { 10549 int result = size; 10550 int specMode = MeasureSpec.getMode(measureSpec); 10551 int specSize = MeasureSpec.getSize(measureSpec); 10552 switch (specMode) { 10553 case MeasureSpec.UNSPECIFIED: 10554 result = size; 10555 break; 10556 case MeasureSpec.AT_MOST: 10557 if (specSize < size) { 10558 result = specSize | MEASURED_STATE_TOO_SMALL; 10559 } else { 10560 result = size; 10561 } 10562 break; 10563 case MeasureSpec.EXACTLY: 10564 result = specSize; 10565 break; 10566 } 10567 return result | (childMeasuredState&MEASURED_STATE_MASK); 10568 } 10569 10570 /** 10571 * Utility to return a default size. Uses the supplied size if the 10572 * MeasureSpec imposed no contraints. Will get larger if allowed 10573 * by the MeasureSpec. 10574 * 10575 * @param size Default size for this view 10576 * @param measureSpec Constraints imposed by the parent 10577 * @return The size this view should be. 10578 */ 10579 public static int getDefaultSize(int size, int measureSpec) { 10580 int result = size; 10581 int specMode = MeasureSpec.getMode(measureSpec); 10582 int specSize = MeasureSpec.getSize(measureSpec); 10583 10584 switch (specMode) { 10585 case MeasureSpec.UNSPECIFIED: 10586 result = size; 10587 break; 10588 case MeasureSpec.AT_MOST: 10589 case MeasureSpec.EXACTLY: 10590 result = specSize; 10591 break; 10592 } 10593 return result; 10594 } 10595 10596 /** 10597 * Returns the suggested minimum height that the view should use. This 10598 * returns the maximum of the view's minimum height 10599 * and the background's minimum height 10600 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 10601 * <p> 10602 * When being used in {@link #onMeasure(int, int)}, the caller should still 10603 * ensure the returned height is within the requirements of the parent. 10604 * 10605 * @return The suggested minimum height of the view. 10606 */ 10607 protected int getSuggestedMinimumHeight() { 10608 int suggestedMinHeight = mMinHeight; 10609 10610 if (mBGDrawable != null) { 10611 final int bgMinHeight = mBGDrawable.getMinimumHeight(); 10612 if (suggestedMinHeight < bgMinHeight) { 10613 suggestedMinHeight = bgMinHeight; 10614 } 10615 } 10616 10617 return suggestedMinHeight; 10618 } 10619 10620 /** 10621 * Returns the suggested minimum width that the view should use. This 10622 * returns the maximum of the view's minimum width) 10623 * and the background's minimum width 10624 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 10625 * <p> 10626 * When being used in {@link #onMeasure(int, int)}, the caller should still 10627 * ensure the returned width is within the requirements of the parent. 10628 * 10629 * @return The suggested minimum width of the view. 10630 */ 10631 protected int getSuggestedMinimumWidth() { 10632 int suggestedMinWidth = mMinWidth; 10633 10634 if (mBGDrawable != null) { 10635 final int bgMinWidth = mBGDrawable.getMinimumWidth(); 10636 if (suggestedMinWidth < bgMinWidth) { 10637 suggestedMinWidth = bgMinWidth; 10638 } 10639 } 10640 10641 return suggestedMinWidth; 10642 } 10643 10644 /** 10645 * Sets the minimum height of the view. It is not guaranteed the view will 10646 * be able to achieve this minimum height (for example, if its parent layout 10647 * constrains it with less available height). 10648 * 10649 * @param minHeight The minimum height the view will try to be. 10650 */ 10651 public void setMinimumHeight(int minHeight) { 10652 mMinHeight = minHeight; 10653 } 10654 10655 /** 10656 * Sets the minimum width of the view. It is not guaranteed the view will 10657 * be able to achieve this minimum width (for example, if its parent layout 10658 * constrains it with less available width). 10659 * 10660 * @param minWidth The minimum width the view will try to be. 10661 */ 10662 public void setMinimumWidth(int minWidth) { 10663 mMinWidth = minWidth; 10664 } 10665 10666 /** 10667 * Get the animation currently associated with this view. 10668 * 10669 * @return The animation that is currently playing or 10670 * scheduled to play for this view. 10671 */ 10672 public Animation getAnimation() { 10673 return mCurrentAnimation; 10674 } 10675 10676 /** 10677 * Start the specified animation now. 10678 * 10679 * @param animation the animation to start now 10680 */ 10681 public void startAnimation(Animation animation) { 10682 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 10683 setAnimation(animation); 10684 invalidateParentCaches(); 10685 invalidate(true); 10686 } 10687 10688 /** 10689 * Cancels any animations for this view. 10690 */ 10691 public void clearAnimation() { 10692 if (mCurrentAnimation != null) { 10693 mCurrentAnimation.detach(); 10694 } 10695 mCurrentAnimation = null; 10696 invalidateParentIfNeeded(); 10697 } 10698 10699 /** 10700 * Sets the next animation to play for this view. 10701 * If you want the animation to play immediately, use 10702 * startAnimation. This method provides allows fine-grained 10703 * control over the start time and invalidation, but you 10704 * must make sure that 1) the animation has a start time set, and 10705 * 2) the view will be invalidated when the animation is supposed to 10706 * start. 10707 * 10708 * @param animation The next animation, or null. 10709 */ 10710 public void setAnimation(Animation animation) { 10711 mCurrentAnimation = animation; 10712 if (animation != null) { 10713 animation.reset(); 10714 } 10715 } 10716 10717 /** 10718 * Invoked by a parent ViewGroup to notify the start of the animation 10719 * currently associated with this view. If you override this method, 10720 * always call super.onAnimationStart(); 10721 * 10722 * @see #setAnimation(android.view.animation.Animation) 10723 * @see #getAnimation() 10724 */ 10725 protected void onAnimationStart() { 10726 mPrivateFlags |= ANIMATION_STARTED; 10727 } 10728 10729 /** 10730 * Invoked by a parent ViewGroup to notify the end of the animation 10731 * currently associated with this view. If you override this method, 10732 * always call super.onAnimationEnd(); 10733 * 10734 * @see #setAnimation(android.view.animation.Animation) 10735 * @see #getAnimation() 10736 */ 10737 protected void onAnimationEnd() { 10738 mPrivateFlags &= ~ANIMATION_STARTED; 10739 } 10740 10741 /** 10742 * Invoked if there is a Transform that involves alpha. Subclass that can 10743 * draw themselves with the specified alpha should return true, and then 10744 * respect that alpha when their onDraw() is called. If this returns false 10745 * then the view may be redirected to draw into an offscreen buffer to 10746 * fulfill the request, which will look fine, but may be slower than if the 10747 * subclass handles it internally. The default implementation returns false. 10748 * 10749 * @param alpha The alpha (0..255) to apply to the view's drawing 10750 * @return true if the view can draw with the specified alpha. 10751 */ 10752 protected boolean onSetAlpha(int alpha) { 10753 return false; 10754 } 10755 10756 /** 10757 * This is used by the RootView to perform an optimization when 10758 * the view hierarchy contains one or several SurfaceView. 10759 * SurfaceView is always considered transparent, but its children are not, 10760 * therefore all View objects remove themselves from the global transparent 10761 * region (passed as a parameter to this function). 10762 * 10763 * @param region The transparent region for this ViewRoot (window). 10764 * 10765 * @return Returns true if the effective visibility of the view at this 10766 * point is opaque, regardless of the transparent region; returns false 10767 * if it is possible for underlying windows to be seen behind the view. 10768 * 10769 * {@hide} 10770 */ 10771 public boolean gatherTransparentRegion(Region region) { 10772 final AttachInfo attachInfo = mAttachInfo; 10773 if (region != null && attachInfo != null) { 10774 final int pflags = mPrivateFlags; 10775 if ((pflags & SKIP_DRAW) == 0) { 10776 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 10777 // remove it from the transparent region. 10778 final int[] location = attachInfo.mTransparentLocation; 10779 getLocationInWindow(location); 10780 region.op(location[0], location[1], location[0] + mRight - mLeft, 10781 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 10782 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) { 10783 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 10784 // exists, so we remove the background drawable's non-transparent 10785 // parts from this transparent region. 10786 applyDrawableToTransparentRegion(mBGDrawable, region); 10787 } 10788 } 10789 return true; 10790 } 10791 10792 /** 10793 * Play a sound effect for this view. 10794 * 10795 * <p>The framework will play sound effects for some built in actions, such as 10796 * clicking, but you may wish to play these effects in your widget, 10797 * for instance, for internal navigation. 10798 * 10799 * <p>The sound effect will only be played if sound effects are enabled by the user, and 10800 * {@link #isSoundEffectsEnabled()} is true. 10801 * 10802 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 10803 */ 10804 public void playSoundEffect(int soundConstant) { 10805 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 10806 return; 10807 } 10808 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 10809 } 10810 10811 /** 10812 * BZZZTT!!1! 10813 * 10814 * <p>Provide haptic feedback to the user for this view. 10815 * 10816 * <p>The framework will provide haptic feedback for some built in actions, 10817 * such as long presses, but you may wish to provide feedback for your 10818 * own widget. 10819 * 10820 * <p>The feedback will only be performed if 10821 * {@link #isHapticFeedbackEnabled()} is true. 10822 * 10823 * @param feedbackConstant One of the constants defined in 10824 * {@link HapticFeedbackConstants} 10825 */ 10826 public boolean performHapticFeedback(int feedbackConstant) { 10827 return performHapticFeedback(feedbackConstant, 0); 10828 } 10829 10830 /** 10831 * BZZZTT!!1! 10832 * 10833 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 10834 * 10835 * @param feedbackConstant One of the constants defined in 10836 * {@link HapticFeedbackConstants} 10837 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 10838 */ 10839 public boolean performHapticFeedback(int feedbackConstant, int flags) { 10840 if (mAttachInfo == null) { 10841 return false; 10842 } 10843 //noinspection SimplifiableIfStatement 10844 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 10845 && !isHapticFeedbackEnabled()) { 10846 return false; 10847 } 10848 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant, 10849 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 10850 } 10851 10852 /** 10853 * Request that the visibility of the status bar be changed. 10854 */ 10855 public void setSystemUiVisibility(int visibility) { 10856 if (visibility != mSystemUiVisibility) { 10857 mSystemUiVisibility = visibility; 10858 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 10859 mParent.recomputeViewAttributes(this); 10860 } 10861 } 10862 } 10863 10864 /** 10865 * Returns the status bar visibility that this view has requested. 10866 */ 10867 public int getSystemUiVisibility() { 10868 return mSystemUiVisibility; 10869 } 10870 10871 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) { 10872 mOnSystemUiVisibilityChangeListener = l; 10873 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) { 10874 mParent.recomputeViewAttributes(this); 10875 } 10876 } 10877 10878 /** 10879 */ 10880 public void dispatchSystemUiVisibilityChanged(int visibility) { 10881 mSystemUiVisibility = visibility; 10882 if (mOnSystemUiVisibilityChangeListener != null) { 10883 mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(visibility); 10884 } 10885 } 10886 10887 /** 10888 * !!! TODO: real docs 10889 * 10890 * The base class implementation makes the shadow the same size and appearance 10891 * as the view itself, and positions it with its center at the touch point. 10892 */ 10893 public static class DragShadowBuilder { 10894 private final WeakReference<View> mView; 10895 10896 /** 10897 * Construct a shadow builder object for use with the given View object. The 10898 * default implementation will construct a drag shadow the same size and 10899 * appearance as the supplied View. 10900 * 10901 * @param view A view within the application's layout whose appearance 10902 * should be replicated as the drag shadow. 10903 */ 10904 public DragShadowBuilder(View view) { 10905 mView = new WeakReference<View>(view); 10906 } 10907 10908 /** 10909 * Construct a shadow builder object with no associated View. This 10910 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)} 10911 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order 10912 * to supply the drag shadow's dimensions and appearance without 10913 * reference to any View object. 10914 */ 10915 public DragShadowBuilder() { 10916 mView = new WeakReference<View>(null); 10917 } 10918 10919 /** 10920 * Returns the View object that had been passed to the 10921 * {@link #View.DragShadowBuilder(View)} 10922 * constructor. If that View parameter was {@code null} or if the 10923 * {@link #View.DragShadowBuilder()} 10924 * constructor was used to instantiate the builder object, this method will return 10925 * null. 10926 * 10927 * @return The View object associate with this builder object. 10928 */ 10929 final public View getView() { 10930 return mView.get(); 10931 } 10932 10933 /** 10934 * Provide the draggable-shadow metrics for the operation: the dimensions of 10935 * the shadow image itself, and the point within that shadow that should 10936 * be centered under the touch location while dragging. 10937 * <p> 10938 * The default implementation sets the dimensions of the shadow to be the 10939 * same as the dimensions of the View object that had been supplied to the 10940 * {@link #View.DragShadowBuilder(View)} constructor 10941 * when the builder object was instantiated, and centers the shadow under the touch 10942 * point. 10943 * 10944 * @param shadowSize The application should set the {@code x} member of this 10945 * parameter to the desired shadow width, and the {@code y} member to 10946 * the desired height. 10947 * @param shadowTouchPoint The application should set this point to be the 10948 * location within the shadow that should track directly underneath 10949 * the touch point on the screen during a drag. 10950 */ 10951 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) { 10952 final View view = mView.get(); 10953 if (view != null) { 10954 shadowSize.set(view.getWidth(), view.getHeight()); 10955 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2); 10956 } else { 10957 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view"); 10958 } 10959 } 10960 10961 /** 10962 * Draw the shadow image for the upcoming drag. The shadow canvas was 10963 * created with the dimensions supplied by the 10964 * {@link #onProvideShadowMetrics(Point, Point)} callback. 10965 * <p> 10966 * The default implementation replicates the appearance of the View object 10967 * that had been supplied to the 10968 * {@link #View.DragShadowBuilder(View)} 10969 * constructor when the builder object was instantiated. 10970 * 10971 * @param canvas 10972 */ 10973 public void onDrawShadow(Canvas canvas) { 10974 final View view = mView.get(); 10975 if (view != null) { 10976 view.draw(canvas); 10977 } else { 10978 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view"); 10979 } 10980 } 10981 } 10982 10983 /** 10984 * Drag and drop. App calls startDrag(), then callbacks to the shadow builder's 10985 * {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} and 10986 * {@link DragShadowBuilder#onDrawShadow(Canvas)} methods happen, then the drag 10987 * operation is handed over to the OS. 10988 * !!! TODO: real docs 10989 * 10990 * @param data !!! TODO 10991 * @param shadowBuilder !!! TODO 10992 * @param myLocalState An arbitrary object that will be passed as part of every DragEvent 10993 * delivered to the calling application during the course of the current drag operation. 10994 * This object is private to the application that called startDrag(), and is not 10995 * visible to other applications. It provides a lightweight way for the application to 10996 * propagate information from the initiator to the recipient of a drag within its own 10997 * application; for example, to help disambiguate between 'copy' and 'move' semantics. 10998 * @param flags Flags affecting the drag operation. At present no flags are defined; 10999 * pass 0 for this parameter. 11000 * @return {@code true} if the drag operation was initiated successfully; {@code false} if 11001 * an error prevented the drag from taking place. 11002 */ 11003 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder, 11004 Object myLocalState, int flags) { 11005 if (ViewDebug.DEBUG_DRAG) { 11006 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags); 11007 } 11008 boolean okay = false; 11009 11010 Point shadowSize = new Point(); 11011 Point shadowTouchPoint = new Point(); 11012 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint); 11013 11014 if ((shadowSize.x < 0) || (shadowSize.y < 0) || 11015 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) { 11016 throw new IllegalStateException("Drag shadow dimensions must not be negative"); 11017 } 11018 11019 if (ViewDebug.DEBUG_DRAG) { 11020 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y 11021 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y); 11022 } 11023 Surface surface = new Surface(); 11024 try { 11025 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow, 11026 flags, shadowSize.x, shadowSize.y, surface); 11027 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token 11028 + " surface=" + surface); 11029 if (token != null) { 11030 Canvas canvas = surface.lockCanvas(null); 11031 try { 11032 canvas.drawColor(0, PorterDuff.Mode.CLEAR); 11033 shadowBuilder.onDrawShadow(canvas); 11034 } finally { 11035 surface.unlockCanvasAndPost(canvas); 11036 } 11037 11038 final ViewRoot root = getViewRoot(); 11039 11040 // Cache the local state object for delivery with DragEvents 11041 root.setLocalDragState(myLocalState); 11042 11043 // repurpose 'shadowSize' for the last touch point 11044 root.getLastTouchPoint(shadowSize); 11045 11046 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token, 11047 shadowSize.x, shadowSize.y, 11048 shadowTouchPoint.x, shadowTouchPoint.y, data); 11049 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay); 11050 } 11051 } catch (Exception e) { 11052 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e); 11053 surface.destroy(); 11054 } 11055 11056 return okay; 11057 } 11058 11059 /** 11060 * Drag-and-drop event dispatch. The event.getAction() verb is one of the DragEvent 11061 * constants DRAG_STARTED_EVENT, DRAG_EVENT, DROP_EVENT, and DRAG_ENDED_EVENT. 11062 * 11063 * For DRAG_STARTED_EVENT, event.getClipDescription() describes the content 11064 * being dragged. onDragEvent() should return 'true' if the view can handle 11065 * a drop of that content. A view that returns 'false' here will receive no 11066 * further calls to onDragEvent() about the drag/drop operation. 11067 * 11068 * For DRAG_ENTERED, event.getClipDescription() describes the content being 11069 * dragged. This will be the same content description passed in the 11070 * DRAG_STARTED_EVENT invocation. 11071 * 11072 * For DRAG_EXITED, event.getClipDescription() describes the content being 11073 * dragged. This will be the same content description passed in the 11074 * DRAG_STARTED_EVENT invocation. The view should return to its approriate 11075 * drag-acceptance visual state. 11076 * 11077 * For DRAG_LOCATION_EVENT, event.getX() and event.getY() give the location in View 11078 * coordinates of the current drag point. The view must return 'true' if it 11079 * can accept a drop of the current drag content, false otherwise. 11080 * 11081 * For DROP_EVENT, event.getX() and event.getY() give the location of the drop 11082 * within the view; also, event.getClipData() returns the full data payload 11083 * being dropped. The view should return 'true' if it consumed the dropped 11084 * content, 'false' if it did not. 11085 * 11086 * For DRAG_ENDED_EVENT, the 'event' argument may be null. The view should return 11087 * to its normal visual state. 11088 */ 11089 public boolean onDragEvent(DragEvent event) { 11090 return false; 11091 } 11092 11093 /** 11094 * Views typically don't need to override dispatchDragEvent(); it just calls 11095 * onDragEvent(event) and passes the result up appropriately. 11096 */ 11097 public boolean dispatchDragEvent(DragEvent event) { 11098 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 11099 && mOnDragListener.onDrag(this, event)) { 11100 return true; 11101 } 11102 return onDragEvent(event); 11103 } 11104 11105 /** 11106 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 11107 * it is ever exposed at all. 11108 * @hide 11109 */ 11110 public void onCloseSystemDialogs(String reason) { 11111 } 11112 11113 /** 11114 * Given a Drawable whose bounds have been set to draw into this view, 11115 * update a Region being computed for {@link #gatherTransparentRegion} so 11116 * that any non-transparent parts of the Drawable are removed from the 11117 * given transparent region. 11118 * 11119 * @param dr The Drawable whose transparency is to be applied to the region. 11120 * @param region A Region holding the current transparency information, 11121 * where any parts of the region that are set are considered to be 11122 * transparent. On return, this region will be modified to have the 11123 * transparency information reduced by the corresponding parts of the 11124 * Drawable that are not transparent. 11125 * {@hide} 11126 */ 11127 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 11128 if (DBG) { 11129 Log.i("View", "Getting transparent region for: " + this); 11130 } 11131 final Region r = dr.getTransparentRegion(); 11132 final Rect db = dr.getBounds(); 11133 final AttachInfo attachInfo = mAttachInfo; 11134 if (r != null && attachInfo != null) { 11135 final int w = getRight()-getLeft(); 11136 final int h = getBottom()-getTop(); 11137 if (db.left > 0) { 11138 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 11139 r.op(0, 0, db.left, h, Region.Op.UNION); 11140 } 11141 if (db.right < w) { 11142 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 11143 r.op(db.right, 0, w, h, Region.Op.UNION); 11144 } 11145 if (db.top > 0) { 11146 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 11147 r.op(0, 0, w, db.top, Region.Op.UNION); 11148 } 11149 if (db.bottom < h) { 11150 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 11151 r.op(0, db.bottom, w, h, Region.Op.UNION); 11152 } 11153 final int[] location = attachInfo.mTransparentLocation; 11154 getLocationInWindow(location); 11155 r.translate(location[0], location[1]); 11156 region.op(r, Region.Op.INTERSECT); 11157 } else { 11158 region.op(db, Region.Op.DIFFERENCE); 11159 } 11160 } 11161 11162 private void postCheckForLongClick(int delayOffset) { 11163 mHasPerformedLongPress = false; 11164 11165 if (mPendingCheckForLongPress == null) { 11166 mPendingCheckForLongPress = new CheckForLongPress(); 11167 } 11168 mPendingCheckForLongPress.rememberWindowAttachCount(); 11169 postDelayed(mPendingCheckForLongPress, 11170 ViewConfiguration.getLongPressTimeout() - delayOffset); 11171 } 11172 11173 /** 11174 * Inflate a view from an XML resource. This convenience method wraps the {@link 11175 * LayoutInflater} class, which provides a full range of options for view inflation. 11176 * 11177 * @param context The Context object for your activity or application. 11178 * @param resource The resource ID to inflate 11179 * @param root A view group that will be the parent. Used to properly inflate the 11180 * layout_* parameters. 11181 * @see LayoutInflater 11182 */ 11183 public static View inflate(Context context, int resource, ViewGroup root) { 11184 LayoutInflater factory = LayoutInflater.from(context); 11185 return factory.inflate(resource, root); 11186 } 11187 11188 /** 11189 * Scroll the view with standard behavior for scrolling beyond the normal 11190 * content boundaries. Views that call this method should override 11191 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the 11192 * results of an over-scroll operation. 11193 * 11194 * Views can use this method to handle any touch or fling-based scrolling. 11195 * 11196 * @param deltaX Change in X in pixels 11197 * @param deltaY Change in Y in pixels 11198 * @param scrollX Current X scroll value in pixels before applying deltaX 11199 * @param scrollY Current Y scroll value in pixels before applying deltaY 11200 * @param scrollRangeX Maximum content scroll range along the X axis 11201 * @param scrollRangeY Maximum content scroll range along the Y axis 11202 * @param maxOverScrollX Number of pixels to overscroll by in either direction 11203 * along the X axis. 11204 * @param maxOverScrollY Number of pixels to overscroll by in either direction 11205 * along the Y axis. 11206 * @param isTouchEvent true if this scroll operation is the result of a touch event. 11207 * @return true if scrolling was clamped to an over-scroll boundary along either 11208 * axis, false otherwise. 11209 */ 11210 protected boolean overScrollBy(int deltaX, int deltaY, 11211 int scrollX, int scrollY, 11212 int scrollRangeX, int scrollRangeY, 11213 int maxOverScrollX, int maxOverScrollY, 11214 boolean isTouchEvent) { 11215 final int overScrollMode = mOverScrollMode; 11216 final boolean canScrollHorizontal = 11217 computeHorizontalScrollRange() > computeHorizontalScrollExtent(); 11218 final boolean canScrollVertical = 11219 computeVerticalScrollRange() > computeVerticalScrollExtent(); 11220 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS || 11221 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal); 11222 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS || 11223 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical); 11224 11225 int newScrollX = scrollX + deltaX; 11226 if (!overScrollHorizontal) { 11227 maxOverScrollX = 0; 11228 } 11229 11230 int newScrollY = scrollY + deltaY; 11231 if (!overScrollVertical) { 11232 maxOverScrollY = 0; 11233 } 11234 11235 // Clamp values if at the limits and record 11236 final int left = -maxOverScrollX; 11237 final int right = maxOverScrollX + scrollRangeX; 11238 final int top = -maxOverScrollY; 11239 final int bottom = maxOverScrollY + scrollRangeY; 11240 11241 boolean clampedX = false; 11242 if (newScrollX > right) { 11243 newScrollX = right; 11244 clampedX = true; 11245 } else if (newScrollX < left) { 11246 newScrollX = left; 11247 clampedX = true; 11248 } 11249 11250 boolean clampedY = false; 11251 if (newScrollY > bottom) { 11252 newScrollY = bottom; 11253 clampedY = true; 11254 } else if (newScrollY < top) { 11255 newScrollY = top; 11256 clampedY = true; 11257 } 11258 11259 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY); 11260 11261 return clampedX || clampedY; 11262 } 11263 11264 /** 11265 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to 11266 * respond to the results of an over-scroll operation. 11267 * 11268 * @param scrollX New X scroll value in pixels 11269 * @param scrollY New Y scroll value in pixels 11270 * @param clampedX True if scrollX was clamped to an over-scroll boundary 11271 * @param clampedY True if scrollY was clamped to an over-scroll boundary 11272 */ 11273 protected void onOverScrolled(int scrollX, int scrollY, 11274 boolean clampedX, boolean clampedY) { 11275 // Intentionally empty. 11276 } 11277 11278 /** 11279 * Returns the over-scroll mode for this view. The result will be 11280 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 11281 * (allow over-scrolling only if the view content is larger than the container), 11282 * or {@link #OVER_SCROLL_NEVER}. 11283 * 11284 * @return This view's over-scroll mode. 11285 */ 11286 public int getOverScrollMode() { 11287 return mOverScrollMode; 11288 } 11289 11290 /** 11291 * Set the over-scroll mode for this view. Valid over-scroll modes are 11292 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS} 11293 * (allow over-scrolling only if the view content is larger than the container), 11294 * or {@link #OVER_SCROLL_NEVER}. 11295 * 11296 * Setting the over-scroll mode of a view will have an effect only if the 11297 * view is capable of scrolling. 11298 * 11299 * @param overScrollMode The new over-scroll mode for this view. 11300 */ 11301 public void setOverScrollMode(int overScrollMode) { 11302 if (overScrollMode != OVER_SCROLL_ALWAYS && 11303 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS && 11304 overScrollMode != OVER_SCROLL_NEVER) { 11305 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode); 11306 } 11307 mOverScrollMode = overScrollMode; 11308 } 11309 11310 /** 11311 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 11312 * Each MeasureSpec represents a requirement for either the width or the height. 11313 * A MeasureSpec is comprised of a size and a mode. There are three possible 11314 * modes: 11315 * <dl> 11316 * <dt>UNSPECIFIED</dt> 11317 * <dd> 11318 * The parent has not imposed any constraint on the child. It can be whatever size 11319 * it wants. 11320 * </dd> 11321 * 11322 * <dt>EXACTLY</dt> 11323 * <dd> 11324 * The parent has determined an exact size for the child. The child is going to be 11325 * given those bounds regardless of how big it wants to be. 11326 * </dd> 11327 * 11328 * <dt>AT_MOST</dt> 11329 * <dd> 11330 * The child can be as large as it wants up to the specified size. 11331 * </dd> 11332 * </dl> 11333 * 11334 * MeasureSpecs are implemented as ints to reduce object allocation. This class 11335 * is provided to pack and unpack the <size, mode> tuple into the int. 11336 */ 11337 public static class MeasureSpec { 11338 private static final int MODE_SHIFT = 30; 11339 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 11340 11341 /** 11342 * Measure specification mode: The parent has not imposed any constraint 11343 * on the child. It can be whatever size it wants. 11344 */ 11345 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 11346 11347 /** 11348 * Measure specification mode: The parent has determined an exact size 11349 * for the child. The child is going to be given those bounds regardless 11350 * of how big it wants to be. 11351 */ 11352 public static final int EXACTLY = 1 << MODE_SHIFT; 11353 11354 /** 11355 * Measure specification mode: The child can be as large as it wants up 11356 * to the specified size. 11357 */ 11358 public static final int AT_MOST = 2 << MODE_SHIFT; 11359 11360 /** 11361 * Creates a measure specification based on the supplied size and mode. 11362 * 11363 * The mode must always be one of the following: 11364 * <ul> 11365 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 11366 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 11367 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 11368 * </ul> 11369 * 11370 * @param size the size of the measure specification 11371 * @param mode the mode of the measure specification 11372 * @return the measure specification based on size and mode 11373 */ 11374 public static int makeMeasureSpec(int size, int mode) { 11375 return size + mode; 11376 } 11377 11378 /** 11379 * Extracts the mode from the supplied measure specification. 11380 * 11381 * @param measureSpec the measure specification to extract the mode from 11382 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 11383 * {@link android.view.View.MeasureSpec#AT_MOST} or 11384 * {@link android.view.View.MeasureSpec#EXACTLY} 11385 */ 11386 public static int getMode(int measureSpec) { 11387 return (measureSpec & MODE_MASK); 11388 } 11389 11390 /** 11391 * Extracts the size from the supplied measure specification. 11392 * 11393 * @param measureSpec the measure specification to extract the size from 11394 * @return the size in pixels defined in the supplied measure specification 11395 */ 11396 public static int getSize(int measureSpec) { 11397 return (measureSpec & ~MODE_MASK); 11398 } 11399 11400 /** 11401 * Returns a String representation of the specified measure 11402 * specification. 11403 * 11404 * @param measureSpec the measure specification to convert to a String 11405 * @return a String with the following format: "MeasureSpec: MODE SIZE" 11406 */ 11407 public static String toString(int measureSpec) { 11408 int mode = getMode(measureSpec); 11409 int size = getSize(measureSpec); 11410 11411 StringBuilder sb = new StringBuilder("MeasureSpec: "); 11412 11413 if (mode == UNSPECIFIED) 11414 sb.append("UNSPECIFIED "); 11415 else if (mode == EXACTLY) 11416 sb.append("EXACTLY "); 11417 else if (mode == AT_MOST) 11418 sb.append("AT_MOST "); 11419 else 11420 sb.append(mode).append(" "); 11421 11422 sb.append(size); 11423 return sb.toString(); 11424 } 11425 } 11426 11427 class CheckForLongPress implements Runnable { 11428 11429 private int mOriginalWindowAttachCount; 11430 11431 public void run() { 11432 if (isPressed() && (mParent != null) 11433 && mOriginalWindowAttachCount == mWindowAttachCount) { 11434 if (performLongClick()) { 11435 mHasPerformedLongPress = true; 11436 } 11437 } 11438 } 11439 11440 public void rememberWindowAttachCount() { 11441 mOriginalWindowAttachCount = mWindowAttachCount; 11442 } 11443 } 11444 11445 private final class CheckForTap implements Runnable { 11446 public void run() { 11447 mPrivateFlags &= ~PREPRESSED; 11448 mPrivateFlags |= PRESSED; 11449 refreshDrawableState(); 11450 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 11451 postCheckForLongClick(ViewConfiguration.getTapTimeout()); 11452 } 11453 } 11454 } 11455 11456 private final class PerformClick implements Runnable { 11457 public void run() { 11458 performClick(); 11459 } 11460 } 11461 11462 /** @hide */ 11463 public void hackTurnOffWindowResizeAnim(boolean off) { 11464 mAttachInfo.mTurnOffWindowResizeAnim = off; 11465 } 11466 11467 /** 11468 * Interface definition for a callback to be invoked when a key event is 11469 * dispatched to this view. The callback will be invoked before the key 11470 * event is given to the view. 11471 */ 11472 public interface OnKeyListener { 11473 /** 11474 * Called when a key is dispatched to a view. This allows listeners to 11475 * get a chance to respond before the target view. 11476 * 11477 * @param v The view the key has been dispatched to. 11478 * @param keyCode The code for the physical key that was pressed 11479 * @param event The KeyEvent object containing full information about 11480 * the event. 11481 * @return True if the listener has consumed the event, false otherwise. 11482 */ 11483 boolean onKey(View v, int keyCode, KeyEvent event); 11484 } 11485 11486 /** 11487 * Interface definition for a callback to be invoked when a touch event is 11488 * dispatched to this view. The callback will be invoked before the touch 11489 * event is given to the view. 11490 */ 11491 public interface OnTouchListener { 11492 /** 11493 * Called when a touch event is dispatched to a view. This allows listeners to 11494 * get a chance to respond before the target view. 11495 * 11496 * @param v The view the touch event has been dispatched to. 11497 * @param event The MotionEvent object containing full information about 11498 * the event. 11499 * @return True if the listener has consumed the event, false otherwise. 11500 */ 11501 boolean onTouch(View v, MotionEvent event); 11502 } 11503 11504 /** 11505 * Interface definition for a callback to be invoked when a view has been clicked and held. 11506 */ 11507 public interface OnLongClickListener { 11508 /** 11509 * Called when a view has been clicked and held. 11510 * 11511 * @param v The view that was clicked and held. 11512 * 11513 * @return true if the callback consumed the long click, false otherwise. 11514 */ 11515 boolean onLongClick(View v); 11516 } 11517 11518 /** 11519 * Interface definition for a callback to be invoked when a drag is being dispatched 11520 * to this view. The callback will be invoked before the hosting view's own 11521 * onDrag(event) method. If the listener wants to fall back to the hosting view's 11522 * onDrag(event) behavior, it should return 'false' from this callback. 11523 */ 11524 public interface OnDragListener { 11525 /** 11526 * Called when a drag event is dispatched to a view. This allows listeners 11527 * to get a chance to override base View behavior. 11528 * 11529 * @param v The view the drag has been dispatched to. 11530 * @param event The DragEvent object containing full information 11531 * about the event. 11532 * @return true if the listener consumed the DragEvent, false in order to fall 11533 * back to the view's default handling. 11534 */ 11535 boolean onDrag(View v, DragEvent event); 11536 } 11537 11538 /** 11539 * Interface definition for a callback to be invoked when the focus state of 11540 * a view changed. 11541 */ 11542 public interface OnFocusChangeListener { 11543 /** 11544 * Called when the focus state of a view has changed. 11545 * 11546 * @param v The view whose state has changed. 11547 * @param hasFocus The new focus state of v. 11548 */ 11549 void onFocusChange(View v, boolean hasFocus); 11550 } 11551 11552 /** 11553 * Interface definition for a callback to be invoked when a view is clicked. 11554 */ 11555 public interface OnClickListener { 11556 /** 11557 * Called when a view has been clicked. 11558 * 11559 * @param v The view that was clicked. 11560 */ 11561 void onClick(View v); 11562 } 11563 11564 /** 11565 * Interface definition for a callback to be invoked when the context menu 11566 * for this view is being built. 11567 */ 11568 public interface OnCreateContextMenuListener { 11569 /** 11570 * Called when the context menu for this view is being built. It is not 11571 * safe to hold onto the menu after this method returns. 11572 * 11573 * @param menu The context menu that is being built 11574 * @param v The view for which the context menu is being built 11575 * @param menuInfo Extra information about the item for which the 11576 * context menu should be shown. This information will vary 11577 * depending on the class of v. 11578 */ 11579 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 11580 } 11581 11582 /** 11583 * Interface definition for a callback to be invoked when the status bar changes 11584 * visibility. 11585 * 11586 * @see #setOnSystemUiVisibilityChangeListener 11587 */ 11588 public interface OnSystemUiVisibilityChangeListener { 11589 /** 11590 * Called when the status bar changes visibility because of a call to 11591 * {@link #setSystemUiVisibility}. 11592 * 11593 * @param visibility {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}. 11594 */ 11595 public void onSystemUiVisibilityChange(int visibility); 11596 } 11597 11598 private final class UnsetPressedState implements Runnable { 11599 public void run() { 11600 setPressed(false); 11601 } 11602 } 11603 11604 /** 11605 * Base class for derived classes that want to save and restore their own 11606 * state in {@link android.view.View#onSaveInstanceState()}. 11607 */ 11608 public static class BaseSavedState extends AbsSavedState { 11609 /** 11610 * Constructor used when reading from a parcel. Reads the state of the superclass. 11611 * 11612 * @param source 11613 */ 11614 public BaseSavedState(Parcel source) { 11615 super(source); 11616 } 11617 11618 /** 11619 * Constructor called by derived classes when creating their SavedState objects 11620 * 11621 * @param superState The state of the superclass of this view 11622 */ 11623 public BaseSavedState(Parcelable superState) { 11624 super(superState); 11625 } 11626 11627 public static final Parcelable.Creator<BaseSavedState> CREATOR = 11628 new Parcelable.Creator<BaseSavedState>() { 11629 public BaseSavedState createFromParcel(Parcel in) { 11630 return new BaseSavedState(in); 11631 } 11632 11633 public BaseSavedState[] newArray(int size) { 11634 return new BaseSavedState[size]; 11635 } 11636 }; 11637 } 11638 11639 /** 11640 * A set of information given to a view when it is attached to its parent 11641 * window. 11642 */ 11643 static class AttachInfo { 11644 interface Callbacks { 11645 void playSoundEffect(int effectId); 11646 boolean performHapticFeedback(int effectId, boolean always); 11647 } 11648 11649 /** 11650 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 11651 * to a Handler. This class contains the target (View) to invalidate and 11652 * the coordinates of the dirty rectangle. 11653 * 11654 * For performance purposes, this class also implements a pool of up to 11655 * POOL_LIMIT objects that get reused. This reduces memory allocations 11656 * whenever possible. 11657 */ 11658 static class InvalidateInfo implements Poolable<InvalidateInfo> { 11659 private static final int POOL_LIMIT = 10; 11660 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool( 11661 Pools.finitePool(new PoolableManager<InvalidateInfo>() { 11662 public InvalidateInfo newInstance() { 11663 return new InvalidateInfo(); 11664 } 11665 11666 public void onAcquired(InvalidateInfo element) { 11667 } 11668 11669 public void onReleased(InvalidateInfo element) { 11670 } 11671 }, POOL_LIMIT) 11672 ); 11673 11674 private InvalidateInfo mNext; 11675 11676 View target; 11677 11678 int left; 11679 int top; 11680 int right; 11681 int bottom; 11682 11683 public void setNextPoolable(InvalidateInfo element) { 11684 mNext = element; 11685 } 11686 11687 public InvalidateInfo getNextPoolable() { 11688 return mNext; 11689 } 11690 11691 static InvalidateInfo acquire() { 11692 return sPool.acquire(); 11693 } 11694 11695 void release() { 11696 sPool.release(this); 11697 } 11698 } 11699 11700 final IWindowSession mSession; 11701 11702 final IWindow mWindow; 11703 11704 final IBinder mWindowToken; 11705 11706 final Callbacks mRootCallbacks; 11707 11708 Canvas mHardwareCanvas; 11709 11710 /** 11711 * The top view of the hierarchy. 11712 */ 11713 View mRootView; 11714 11715 IBinder mPanelParentWindowToken; 11716 Surface mSurface; 11717 11718 boolean mHardwareAccelerated; 11719 boolean mHardwareAccelerationRequested; 11720 HardwareRenderer mHardwareRenderer; 11721 11722 /** 11723 * Scale factor used by the compatibility mode 11724 */ 11725 float mApplicationScale; 11726 11727 /** 11728 * Indicates whether the application is in compatibility mode 11729 */ 11730 boolean mScalingRequired; 11731 11732 /** 11733 * If set, ViewRoot doesn't use its lame animation for when the window resizes. 11734 */ 11735 boolean mTurnOffWindowResizeAnim; 11736 11737 /** 11738 * Left position of this view's window 11739 */ 11740 int mWindowLeft; 11741 11742 /** 11743 * Top position of this view's window 11744 */ 11745 int mWindowTop; 11746 11747 /** 11748 * Indicates whether views need to use 32-bit drawing caches 11749 */ 11750 boolean mUse32BitDrawingCache; 11751 11752 /** 11753 * For windows that are full-screen but using insets to layout inside 11754 * of the screen decorations, these are the current insets for the 11755 * content of the window. 11756 */ 11757 final Rect mContentInsets = new Rect(); 11758 11759 /** 11760 * For windows that are full-screen but using insets to layout inside 11761 * of the screen decorations, these are the current insets for the 11762 * actual visible parts of the window. 11763 */ 11764 final Rect mVisibleInsets = new Rect(); 11765 11766 /** 11767 * The internal insets given by this window. This value is 11768 * supplied by the client (through 11769 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 11770 * be given to the window manager when changed to be used in laying 11771 * out windows behind it. 11772 */ 11773 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 11774 = new ViewTreeObserver.InternalInsetsInfo(); 11775 11776 /** 11777 * All views in the window's hierarchy that serve as scroll containers, 11778 * used to determine if the window can be resized or must be panned 11779 * to adjust for a soft input area. 11780 */ 11781 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 11782 11783 final KeyEvent.DispatcherState mKeyDispatchState 11784 = new KeyEvent.DispatcherState(); 11785 11786 /** 11787 * Indicates whether the view's window currently has the focus. 11788 */ 11789 boolean mHasWindowFocus; 11790 11791 /** 11792 * The current visibility of the window. 11793 */ 11794 int mWindowVisibility; 11795 11796 /** 11797 * Indicates the time at which drawing started to occur. 11798 */ 11799 long mDrawingTime; 11800 11801 /** 11802 * Indicates whether or not ignoring the DIRTY_MASK flags. 11803 */ 11804 boolean mIgnoreDirtyState; 11805 11806 /** 11807 * Indicates whether the view's window is currently in touch mode. 11808 */ 11809 boolean mInTouchMode; 11810 11811 /** 11812 * Indicates that ViewRoot should trigger a global layout change 11813 * the next time it performs a traversal 11814 */ 11815 boolean mRecomputeGlobalAttributes; 11816 11817 /** 11818 * Set during a traveral if any views want to keep the screen on. 11819 */ 11820 boolean mKeepScreenOn; 11821 11822 /** 11823 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility(). 11824 */ 11825 int mSystemUiVisibility; 11826 11827 /** 11828 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener 11829 * attached. 11830 */ 11831 boolean mHasSystemUiListeners; 11832 11833 /** 11834 * Set if the visibility of any views has changed. 11835 */ 11836 boolean mViewVisibilityChanged; 11837 11838 /** 11839 * Set to true if a view has been scrolled. 11840 */ 11841 boolean mViewScrollChanged; 11842 11843 /** 11844 * Global to the view hierarchy used as a temporary for dealing with 11845 * x/y points in the transparent region computations. 11846 */ 11847 final int[] mTransparentLocation = new int[2]; 11848 11849 /** 11850 * Global to the view hierarchy used as a temporary for dealing with 11851 * x/y points in the ViewGroup.invalidateChild implementation. 11852 */ 11853 final int[] mInvalidateChildLocation = new int[2]; 11854 11855 11856 /** 11857 * Global to the view hierarchy used as a temporary for dealing with 11858 * x/y location when view is transformed. 11859 */ 11860 final float[] mTmpTransformLocation = new float[2]; 11861 11862 /** 11863 * The view tree observer used to dispatch global events like 11864 * layout, pre-draw, touch mode change, etc. 11865 */ 11866 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 11867 11868 /** 11869 * A Canvas used by the view hierarchy to perform bitmap caching. 11870 */ 11871 Canvas mCanvas; 11872 11873 /** 11874 * A Handler supplied by a view's {@link android.view.ViewRoot}. This 11875 * handler can be used to pump events in the UI events queue. 11876 */ 11877 final Handler mHandler; 11878 11879 /** 11880 * Identifier for messages requesting the view to be invalidated. 11881 * Such messages should be sent to {@link #mHandler}. 11882 */ 11883 static final int INVALIDATE_MSG = 0x1; 11884 11885 /** 11886 * Identifier for messages requesting the view to invalidate a region. 11887 * Such messages should be sent to {@link #mHandler}. 11888 */ 11889 static final int INVALIDATE_RECT_MSG = 0x2; 11890 11891 /** 11892 * Temporary for use in computing invalidate rectangles while 11893 * calling up the hierarchy. 11894 */ 11895 final Rect mTmpInvalRect = new Rect(); 11896 11897 /** 11898 * Temporary for use in computing hit areas with transformed views 11899 */ 11900 final RectF mTmpTransformRect = new RectF(); 11901 11902 /** 11903 * Temporary list for use in collecting focusable descendents of a view. 11904 */ 11905 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24); 11906 11907 /** 11908 * Creates a new set of attachment information with the specified 11909 * events handler and thread. 11910 * 11911 * @param handler the events handler the view must use 11912 */ 11913 AttachInfo(IWindowSession session, IWindow window, 11914 Handler handler, Callbacks effectPlayer) { 11915 mSession = session; 11916 mWindow = window; 11917 mWindowToken = window.asBinder(); 11918 mHandler = handler; 11919 mRootCallbacks = effectPlayer; 11920 } 11921 } 11922 11923 /** 11924 * <p>ScrollabilityCache holds various fields used by a View when scrolling 11925 * is supported. This avoids keeping too many unused fields in most 11926 * instances of View.</p> 11927 */ 11928 private static class ScrollabilityCache implements Runnable { 11929 11930 /** 11931 * Scrollbars are not visible 11932 */ 11933 public static final int OFF = 0; 11934 11935 /** 11936 * Scrollbars are visible 11937 */ 11938 public static final int ON = 1; 11939 11940 /** 11941 * Scrollbars are fading away 11942 */ 11943 public static final int FADING = 2; 11944 11945 public boolean fadeScrollBars; 11946 11947 public int fadingEdgeLength; 11948 public int scrollBarDefaultDelayBeforeFade; 11949 public int scrollBarFadeDuration; 11950 11951 public int scrollBarSize; 11952 public ScrollBarDrawable scrollBar; 11953 public float[] interpolatorValues; 11954 public View host; 11955 11956 public final Paint paint; 11957 public final Matrix matrix; 11958 public Shader shader; 11959 11960 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 11961 11962 private static final float[] OPAQUE = { 255 }; 11963 private static final float[] TRANSPARENT = { 0.0f }; 11964 11965 /** 11966 * When fading should start. This time moves into the future every time 11967 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 11968 */ 11969 public long fadeStartTime; 11970 11971 11972 /** 11973 * The current state of the scrollbars: ON, OFF, or FADING 11974 */ 11975 public int state = OFF; 11976 11977 private int mLastColor; 11978 11979 public ScrollabilityCache(ViewConfiguration configuration, View host) { 11980 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 11981 scrollBarSize = configuration.getScaledScrollBarSize(); 11982 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 11983 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 11984 11985 paint = new Paint(); 11986 matrix = new Matrix(); 11987 // use use a height of 1, and then wack the matrix each time we 11988 // actually use it. 11989 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 11990 11991 paint.setShader(shader); 11992 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 11993 this.host = host; 11994 } 11995 11996 public void setFadeColor(int color) { 11997 if (color != 0 && color != mLastColor) { 11998 mLastColor = color; 11999 color |= 0xFF000000; 12000 12001 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 12002 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 12003 12004 paint.setShader(shader); 12005 // Restore the default transfer mode (src_over) 12006 paint.setXfermode(null); 12007 } 12008 } 12009 12010 public void run() { 12011 long now = AnimationUtils.currentAnimationTimeMillis(); 12012 if (now >= fadeStartTime) { 12013 12014 // the animation fades the scrollbars out by changing 12015 // the opacity (alpha) from fully opaque to fully 12016 // transparent 12017 int nextFrame = (int) now; 12018 int framesCount = 0; 12019 12020 Interpolator interpolator = scrollBarInterpolator; 12021 12022 // Start opaque 12023 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE); 12024 12025 // End transparent 12026 nextFrame += scrollBarFadeDuration; 12027 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT); 12028 12029 state = FADING; 12030 12031 // Kick off the fade animation 12032 host.invalidate(true); 12033 } 12034 } 12035 12036 } 12037} 12038