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